From 4ec507df6251bc1dae5204fdc6aaf14ddbb268f6 Mon Sep 17 00:00:00 2001 From: crupest Date: Sat, 18 Jan 2020 00:50:31 +0800 Subject: ... --- Timeline/Controllers/UserController.cs | 64 +++++----------------------------- 1 file changed, 9 insertions(+), 55 deletions(-) (limited to 'Timeline/Controllers/UserController.cs') diff --git a/Timeline/Controllers/UserController.cs b/Timeline/Controllers/UserController.cs index 0d950cd7..956865dc 100644 --- a/Timeline/Controllers/UserController.cs +++ b/Timeline/Controllers/UserController.cs @@ -1,7 +1,7 @@ using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Logging; -using System.Globalization; +using System; using System.Threading.Tasks; using Timeline.Auth; using Timeline.Helpers; @@ -11,43 +11,6 @@ using Timeline.Models.Validation; using Timeline.Services; using static Timeline.Resources.Controllers.UserController; -namespace Timeline -{ - public static partial class ErrorCodes - { - public static partial class Http - { - public static class User // bbb = 002 - { - public static class Get // cc = 01 - { - public const int NotExist = 10020101; // dd = 01 - } - - public static class Patch // cc = 03 - { - public const int NotExist = 10020301; // dd = 01 - } - - public static class Op // cc = 1x - { - public static class ChangeUsername // cc = 11 - { - public const int NotExist = 10021101; // dd = 01 - public const int AlreadyExist = 10021102; // dd = 02 - } - - public static class ChangePassword // cc = 12 - { - public const int BadOldPassword = 10021201; // dd = 01 - } - } - - } - } - } -} - namespace Timeline.Controllers { [ApiController] @@ -76,7 +39,7 @@ namespace Timeline.Controllers if (user == null) { _logger.LogInformation(Log.Format(LogGetUserNotExist, ("Username", username))); - return NotFound(new CommonResponse(ErrorCodes.Http.User.Get.NotExist, ErrorGetUserNotExist)); + return NotFound(ErrorResponse.UserCommon.NotExist()); } return Ok(user); } @@ -88,13 +51,11 @@ namespace Timeline.Controllers switch (result) { case PutResult.Create: - _logger.LogInformation(Log.Format(LogPutCreate, ("Username", username))); return CreatedAtAction("Get", new { username }, CommonPutResponse.Create()); case PutResult.Modify: - _logger.LogInformation(Log.Format(LogPutModify, ("Username", username))); return Ok(CommonPutResponse.Modify()); default: - throw new InvalidBranchException(); + throw new Exception(ExceptionUnknownPutResult); } } @@ -109,7 +70,7 @@ namespace Timeline.Controllers catch (UserNotExistException e) { _logger.LogInformation(e, Log.Format(LogPatchUserNotExist, ("Username", username))); - return NotFound(new CommonResponse(ErrorCodes.Http.User.Patch.NotExist, ErrorPatchUserNotExist)); + return NotFound(ErrorResponse.UserCommon.NotExist()); } } @@ -119,12 +80,10 @@ namespace Timeline.Controllers try { await _userService.DeleteUser(username); - _logger.LogInformation(Log.Format(LogDeleteDelete, ("Username", username))); return Ok(CommonDeleteResponse.Delete()); } - catch (UserNotExistException e) + catch (UserNotExistException) { - _logger.LogInformation(e, Log.Format(LogDeleteNotExist, ("Username", username))); return Ok(CommonDeleteResponse.NotExist()); } } @@ -135,22 +94,19 @@ namespace Timeline.Controllers try { await _userService.ChangeUsername(request.OldUsername, request.NewUsername); - _logger.LogInformation(Log.Format(LogChangeUsernameSuccess, - ("Old Username", request.OldUsername), ("New Username", request.NewUsername))); return Ok(); } catch (UserNotExistException e) { _logger.LogInformation(e, Log.Format(LogChangeUsernameNotExist, ("Old Username", request.OldUsername), ("New Username", request.NewUsername))); - return BadRequest(new CommonResponse(ErrorCodes.Http.User.Op.ChangeUsername.NotExist, - string.Format(CultureInfo.CurrentCulture, ErrorChangeUsernameNotExist, request.OldUsername))); + return BadRequest(ErrorResponse.UserCommon.NotExist()); } catch (UsernameConfictException e) { - _logger.LogInformation(e, Log.Format(LogChangeUsernameAlreadyExist, + _logger.LogInformation(e, Log.Format(LogChangeUsernameConflict, ("Old Username", request.OldUsername), ("New Username", request.NewUsername))); - return BadRequest(new CommonResponse(ErrorCodes.Http.User.Op.ChangeUsername.AlreadyExist, ErrorChangeUsernameAlreadyExist)); + return BadRequest(ErrorResponse.UserController.ChangeUsername_Conflict()); } // there is no need to catch bad format exception because it is already checked in model validation. } @@ -161,15 +117,13 @@ namespace Timeline.Controllers try { await _userService.ChangePassword(User.Identity.Name!, request.OldPassword, request.NewPassword); - _logger.LogInformation(Log.Format(LogChangePasswordSuccess, ("Username", User.Identity.Name))); return Ok(); } catch (BadPasswordException e) { _logger.LogInformation(e, Log.Format(LogChangePasswordBadPassword, ("Username", User.Identity.Name), ("Old Password", request.OldPassword))); - return BadRequest(new CommonResponse(ErrorCodes.Http.User.Op.ChangePassword.BadOldPassword, - ErrorChangePasswordBadPassword)); + return BadRequest(ErrorResponse.UserController.ChangePassword_BadOldPassword()); } // User can't be non-existent or the token is bad. } -- cgit v1.2.3 From 747bf829351c30069647a44f98ac19f1a214370f Mon Sep 17 00:00:00 2001 From: crupest Date: Tue, 21 Jan 2020 01:11:17 +0800 Subject: ... --- Timeline.Tests/Controllers/TokenControllerTest.cs | 6 +- Timeline.Tests/Controllers/UserControllerTest.cs | 4 +- Timeline.Tests/DatabaseTest.cs | 4 +- Timeline.Tests/Helpers/TestDatabase.cs | 6 +- Timeline.Tests/IntegratedTests/UserTest.cs | 6 +- Timeline.Tests/Services/UserAvatarServiceTest.cs | 6 +- Timeline.Tests/Services/UserDetailServiceTest.cs | 2 +- Timeline/Controllers/TokenController.cs | 6 +- Timeline/Controllers/UserController.cs | 6 +- Timeline/Entities/DatabaseContext.cs | 10 +- Timeline/Entities/TimelineEntity.cs | 2 +- Timeline/Entities/TimelineMemberEntity.cs | 2 +- Timeline/Entities/TimelinePostEntity.cs | 2 +- Timeline/Entities/User.cs | 42 ------ Timeline/Entities/UserAvatar.cs | 28 ---- Timeline/Entities/UserAvatarEntity.cs | 28 ++++ Timeline/Entities/UserDetail.cs | 21 --- Timeline/Entities/UserDetailEntity.cs | 17 +++ Timeline/Entities/UserEntity.cs | 42 ++++++ Timeline/Models/Http/Token.cs | 4 +- Timeline/Models/Http/User.cs | 6 + Timeline/Models/UserConvert.cs | 67 ---------- Timeline/Models/UserInfo.cs | 23 +--- Timeline/Models/UserRoleConvert.cs | 44 ++++++ Timeline/Resources/Services/Exception.Designer.cs | 96 +++++++------- Timeline/Resources/Services/Exception.resx | 46 +++---- Timeline/Services/DatabaseExtensions.cs | 2 +- Timeline/Services/JwtService.cs | 132 ------------------ .../Services/JwtUserTokenBadFormatException.cs | 48 +++++++ Timeline/Services/JwtVerifyException.cs | 59 --------- Timeline/Services/UserAvatarService.cs | 2 +- Timeline/Services/UserDetailService.cs | 2 +- Timeline/Services/UserService.cs | 68 +++------- Timeline/Services/UserTokenException.cs | 71 ++++++++++ Timeline/Services/UserTokenManager.cs | 93 +++++++++++++ Timeline/Services/UserTokenService.cs | 147 +++++++++++++++++++++ Timeline/Services/UsernameBadFormatException.cs | 2 +- Timeline/Startup.cs | 2 +- 38 files changed, 632 insertions(+), 522 deletions(-) delete mode 100644 Timeline/Entities/User.cs delete mode 100644 Timeline/Entities/UserAvatar.cs create mode 100644 Timeline/Entities/UserAvatarEntity.cs delete mode 100644 Timeline/Entities/UserDetail.cs create mode 100644 Timeline/Entities/UserDetailEntity.cs create mode 100644 Timeline/Entities/UserEntity.cs delete mode 100644 Timeline/Models/UserConvert.cs create mode 100644 Timeline/Models/UserRoleConvert.cs delete mode 100644 Timeline/Services/JwtService.cs create mode 100644 Timeline/Services/JwtUserTokenBadFormatException.cs delete mode 100644 Timeline/Services/JwtVerifyException.cs create mode 100644 Timeline/Services/UserTokenException.cs create mode 100644 Timeline/Services/UserTokenManager.cs create mode 100644 Timeline/Services/UserTokenService.cs (limited to 'Timeline/Controllers/UserController.cs') diff --git a/Timeline.Tests/Controllers/TokenControllerTest.cs b/Timeline.Tests/Controllers/TokenControllerTest.cs index 2b3547ea..740d8377 100644 --- a/Timeline.Tests/Controllers/TokenControllerTest.cs +++ b/Timeline.Tests/Controllers/TokenControllerTest.cs @@ -97,9 +97,9 @@ namespace Timeline.Tests.Controllers public static IEnumerable Verify_BadRequest_Data() { - yield return new object[] { new JwtVerifyException(JwtVerifyException.ErrorCodes.Expired), ErrorCodes.TokenController.Verify_TimeExpired }; - yield return new object[] { new JwtVerifyException(JwtVerifyException.ErrorCodes.IdClaimBadFormat), ErrorCodes.TokenController.Verify_BadFormat }; - yield return new object[] { new JwtVerifyException(JwtVerifyException.ErrorCodes.OldVersion), ErrorCodes.TokenController.Verify_OldVersion }; + yield return new object[] { new JwtUserTokenBadFormatException(JwtUserTokenBadFormatException.ErrorCodes.Expired), ErrorCodes.TokenController.Verify_TimeExpired }; + yield return new object[] { new JwtUserTokenBadFormatException(JwtUserTokenBadFormatException.ErrorCodes.IdClaimBadFormat), ErrorCodes.TokenController.Verify_BadFormat }; + yield return new object[] { new JwtUserTokenBadFormatException(JwtUserTokenBadFormatException.ErrorCodes.OldVersion), ErrorCodes.TokenController.Verify_OldVersion }; yield return new object[] { new UserNotExistException(), ErrorCodes.TokenController.Verify_UserNotExist }; } diff --git a/Timeline.Tests/Controllers/UserControllerTest.cs b/Timeline.Tests/Controllers/UserControllerTest.cs index 043062c3..262dbe11 100644 --- a/Timeline.Tests/Controllers/UserControllerTest.cs +++ b/Timeline.Tests/Controllers/UserControllerTest.cs @@ -46,7 +46,7 @@ namespace Timeline.Tests.Controllers public async Task Get_Success() { const string username = "aaa"; - _mockUserService.Setup(s => s.GetUser(username)).ReturnsAsync(MockUser.User.Info); + _mockUserService.Setup(s => s.GetUserByUsername(username)).ReturnsAsync(MockUser.User.Info); var action = await _controller.Get(username); action.Result.Should().BeAssignableTo() .Which.Value.Should().BeEquivalentTo(MockUser.User.Info); @@ -56,7 +56,7 @@ namespace Timeline.Tests.Controllers public async Task Get_NotFound() { const string username = "aaa"; - _mockUserService.Setup(s => s.GetUser(username)).Returns(Task.FromResult(null)); + _mockUserService.Setup(s => s.GetUserByUsername(username)).Returns(Task.FromResult(null)); var action = await _controller.Get(username); action.Result.Should().BeAssignableTo() .Which.Value.Should().BeAssignableTo() diff --git a/Timeline.Tests/DatabaseTest.cs b/Timeline.Tests/DatabaseTest.cs index a7b97c16..a15823a9 100644 --- a/Timeline.Tests/DatabaseTest.cs +++ b/Timeline.Tests/DatabaseTest.cs @@ -28,7 +28,7 @@ namespace Timeline.Tests { var user = _context.Users.First(); _context.UserAvatars.Count().Should().Be(0); - _context.UserAvatars.Add(new UserAvatar + _context.UserAvatars.Add(new UserAvatarEntity { Data = null, Type = null, @@ -48,7 +48,7 @@ namespace Timeline.Tests { var user = _context.Users.First(); _context.UserDetails.Count().Should().Be(0); - _context.UserDetails.Add(new UserDetail + _context.UserDetails.Add(new UserDetailEntity { Nickname = null, UserId = user.Id diff --git a/Timeline.Tests/Helpers/TestDatabase.cs b/Timeline.Tests/Helpers/TestDatabase.cs index 9560f353..3163279a 100644 --- a/Timeline.Tests/Helpers/TestDatabase.cs +++ b/Timeline.Tests/Helpers/TestDatabase.cs @@ -14,9 +14,9 @@ namespace Timeline.Tests.Helpers // currently password service is thread safe, so we share a static one. private static PasswordService PasswordService { get; } = new PasswordService(); - private static User CreateEntityFromMock(MockUser user) + private static UserEntity CreateEntityFromMock(MockUser user) { - return new User + return new UserEntity { Name = user.Username, EncryptedPassword = PasswordService.HashPassword(user.Password), @@ -25,7 +25,7 @@ namespace Timeline.Tests.Helpers }; } - private static IEnumerable CreateDefaultMockEntities() + private static IEnumerable CreateDefaultMockEntities() { // emmmmmmm. Never reuse the user instances because EF Core uses them, which will cause strange things. yield return CreateEntityFromMock(MockUser.User); diff --git a/Timeline.Tests/IntegratedTests/UserTest.cs b/Timeline.Tests/IntegratedTests/UserTest.cs index fbef6da3..ea9f1177 100644 --- a/Timeline.Tests/IntegratedTests/UserTest.cs +++ b/Timeline.Tests/IntegratedTests/UserTest.cs @@ -24,7 +24,7 @@ namespace Timeline.Tests.IntegratedTests using var client = await CreateClientAsAdmin(); var res = await client.GetAsync("users"); res.Should().HaveStatusCode(200) - .And.HaveJsonBody() + .And.HaveJsonBody() .Which.Should().BeEquivalentTo(MockUser.UserInfoList); } @@ -34,7 +34,7 @@ namespace Timeline.Tests.IntegratedTests using var client = await CreateClientAsAdmin(); var res = await client.GetAsync("users/" + MockUser.User.Username); res.Should().HaveStatusCode(200) - .And.HaveJsonBody() + .And.HaveJsonBody() .Which.Should().BeEquivalentTo(MockUser.User.Info); } @@ -77,7 +77,7 @@ namespace Timeline.Tests.IntegratedTests { var res = await client.GetAsync("users/" + username); res.Should().HaveStatusCode(200) - .And.HaveJsonBody() + .And.HaveJsonBody() .Which.Administrator.Should().Be(administrator); } diff --git a/Timeline.Tests/Services/UserAvatarServiceTest.cs b/Timeline.Tests/Services/UserAvatarServiceTest.cs index 2729aa6f..d4371c48 100644 --- a/Timeline.Tests/Services/UserAvatarServiceTest.cs +++ b/Timeline.Tests/Services/UserAvatarServiceTest.cs @@ -78,7 +78,7 @@ namespace Timeline.Tests.Services public class UserAvatarServiceTest : IDisposable { - private UserAvatar CreateMockAvatarEntity(string key) => new UserAvatar + private UserAvatarEntity CreateMockAvatarEntity(string key) => new UserAvatarEntity { Type = $"image/test{key}", Data = Encoding.ASCII.GetBytes($"mock{key}"), @@ -102,7 +102,7 @@ namespace Timeline.Tests.Services Data = Encoding.ASCII.GetBytes($"mock{key}") }; - private static Avatar ToAvatar(UserAvatar entity) + private static Avatar ToAvatar(UserAvatarEntity entity) { return new Avatar { @@ -111,7 +111,7 @@ namespace Timeline.Tests.Services }; } - private static AvatarInfo ToAvatarInfo(UserAvatar entity) + private static AvatarInfo ToAvatarInfo(UserAvatarEntity entity) { return new AvatarInfo { diff --git a/Timeline.Tests/Services/UserDetailServiceTest.cs b/Timeline.Tests/Services/UserDetailServiceTest.cs index 9a869c89..e6eabadf 100644 --- a/Timeline.Tests/Services/UserDetailServiceTest.cs +++ b/Timeline.Tests/Services/UserDetailServiceTest.cs @@ -52,7 +52,7 @@ namespace Timeline.Tests.Services { var context = _testDatabase.Context; var userId = (await context.Users.Where(u => u.Name == MockUser.User.Username).Select(u => new { u.Id }).SingleAsync()).Id; - context.UserDetails.Add(new UserDetail + context.UserDetails.Add(new UserDetailEntity { Nickname = nickname, UserId = userId diff --git a/Timeline/Controllers/TokenController.cs b/Timeline/Controllers/TokenController.cs index 67001e87..851c7606 100644 --- a/Timeline/Controllers/TokenController.cs +++ b/Timeline/Controllers/TokenController.cs @@ -94,16 +94,16 @@ namespace Timeline.Controllers User = result }); } - catch (JwtVerifyException e) + catch (JwtUserTokenBadFormatException e) { - if (e.ErrorCode == JwtVerifyException.ErrorCodes.Expired) + if (e.ErrorCode == JwtUserTokenBadFormatException.ErrorCodes.Expired) { var innerException = e.InnerException as SecurityTokenExpiredException; LogFailure(LogVerifyExpire, e, ("Expires", innerException?.Expires), ("Current Time", _clock.GetCurrentTime())); return BadRequest(ErrorResponse.TokenController.Verify_TimeExpired()); } - else if (e.ErrorCode == JwtVerifyException.ErrorCodes.OldVersion) + else if (e.ErrorCode == JwtUserTokenBadFormatException.ErrorCodes.OldVersion) { var innerException = e.InnerException as JwtBadVersionException; LogFailure(LogVerifyOldVersion, e, diff --git a/Timeline/Controllers/UserController.cs b/Timeline/Controllers/UserController.cs index 956865dc..65ee3a0f 100644 --- a/Timeline/Controllers/UserController.cs +++ b/Timeline/Controllers/UserController.cs @@ -27,15 +27,15 @@ namespace Timeline.Controllers } [HttpGet("users"), AdminAuthorize] - public async Task> List() + public async Task> List() { return Ok(await _userService.ListUsers()); } [HttpGet("users/{username}"), AdminAuthorize] - public async Task> Get([FromRoute][Username] string username) + public async Task> Get([FromRoute][Username] string username) { - var user = await _userService.GetUser(username); + var user = await _userService.GetUserByUsername(username); if (user == null) { _logger.LogInformation(Log.Format(LogGetUserNotExist, ("Username", username))); diff --git a/Timeline/Entities/DatabaseContext.cs b/Timeline/Entities/DatabaseContext.cs index ffb6158a..738440b2 100644 --- a/Timeline/Entities/DatabaseContext.cs +++ b/Timeline/Entities/DatabaseContext.cs @@ -13,13 +13,13 @@ namespace Timeline.Entities [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods")] protected override void OnModelCreating(ModelBuilder modelBuilder) { - modelBuilder.Entity().Property(e => e.Version).HasDefaultValue(0); - modelBuilder.Entity().HasIndex(e => e.Name).IsUnique(); + modelBuilder.Entity().Property(e => e.Version).HasDefaultValue(0); + modelBuilder.Entity().HasIndex(e => e.Name).IsUnique(); } - public DbSet Users { get; set; } = default!; - public DbSet UserAvatars { get; set; } = default!; - public DbSet UserDetails { get; set; } = default!; + public DbSet Users { get; set; } = default!; + public DbSet UserAvatars { get; set; } = default!; + public DbSet UserDetails { get; set; } = default!; public DbSet Timelines { get; set; } = default!; public DbSet TimelinePosts { get; set; } = default!; public DbSet TimelineMembers { get; set; } = default!; diff --git a/Timeline/Entities/TimelineEntity.cs b/Timeline/Entities/TimelineEntity.cs index 9cacfcae..2bfd6107 100644 --- a/Timeline/Entities/TimelineEntity.cs +++ b/Timeline/Entities/TimelineEntity.cs @@ -26,7 +26,7 @@ namespace Timeline.Entities public long OwnerId { get; set; } [ForeignKey(nameof(OwnerId))] - public User Owner { get; set; } = default!; + public UserEntity Owner { get; set; } = default!; [Column("visibility")] public TimelineVisibility Visibility { get; set; } diff --git a/Timeline/Entities/TimelineMemberEntity.cs b/Timeline/Entities/TimelineMemberEntity.cs index dbe861bd..e76f2099 100644 --- a/Timeline/Entities/TimelineMemberEntity.cs +++ b/Timeline/Entities/TimelineMemberEntity.cs @@ -13,7 +13,7 @@ namespace Timeline.Entities public long UserId { get; set; } [ForeignKey(nameof(UserId))] - public User User { get; set; } = default!; + public UserEntity User { get; set; } = default!; [Column("timeline")] public long TimelineId { get; set; } diff --git a/Timeline/Entities/TimelinePostEntity.cs b/Timeline/Entities/TimelinePostEntity.cs index efef3ab5..a615c61f 100644 --- a/Timeline/Entities/TimelinePostEntity.cs +++ b/Timeline/Entities/TimelinePostEntity.cs @@ -20,7 +20,7 @@ namespace Timeline.Entities public long AuthorId { get; set; } [ForeignKey(nameof(AuthorId))] - public User Author { get; set; } = default!; + public UserEntity Author { get; set; } = default!; [Column("content")] public string? Content { get; set; } diff --git a/Timeline/Entities/User.cs b/Timeline/Entities/User.cs deleted file mode 100644 index e725a69a..00000000 --- a/Timeline/Entities/User.cs +++ /dev/null @@ -1,42 +0,0 @@ -using System.Collections.Generic; -using System.ComponentModel.DataAnnotations; -using System.ComponentModel.DataAnnotations.Schema; - -namespace Timeline.Entities -{ - public static class UserRoles - { - public const string Admin = "admin"; - public const string User = "user"; - } - - [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "This is an entity class.")] - [Table("users")] - public class User - { - [Column("id"), Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)] - public long Id { get; set; } - - [Column("name"), MaxLength(26), Required] - public string Name { get; set; } = default!; - - [Column("password"), Required] - public string EncryptedPassword { get; set; } = default!; - - [Column("roles"), Required] - public string RoleString { get; set; } = default!; - - [Column("version"), Required] - public long Version { get; set; } - - public UserAvatar? Avatar { get; set; } - - public UserDetail? Detail { get; set; } - - public List Timelines { get; set; } = default!; - - public List TimelinePosts { get; set; } = default!; - - public List TimelinesJoined { get; set; } = default!; - } -} diff --git a/Timeline/Entities/UserAvatar.cs b/Timeline/Entities/UserAvatar.cs deleted file mode 100644 index 114246f3..00000000 --- a/Timeline/Entities/UserAvatar.cs +++ /dev/null @@ -1,28 +0,0 @@ -using System; -using System.ComponentModel.DataAnnotations; -using System.ComponentModel.DataAnnotations.Schema; - -namespace Timeline.Entities -{ - [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1819:Properties should not return arrays", Justification = "This is data base entity.")] - [Table("user_avatars")] - public class UserAvatar - { - [Column("id"), Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)] - public long Id { get; set; } - - [Column("data")] - public byte[]? Data { get; set; } - - [Column("type")] - public string? Type { get; set; } - - [Column("etag"), MaxLength(30)] - public string? ETag { get; set; } - - [Column("last_modified"), Required] - public DateTime LastModified { get; set; } - - public long UserId { get; set; } - } -} diff --git a/Timeline/Entities/UserAvatarEntity.cs b/Timeline/Entities/UserAvatarEntity.cs new file mode 100644 index 00000000..eed819bc --- /dev/null +++ b/Timeline/Entities/UserAvatarEntity.cs @@ -0,0 +1,28 @@ +using System; +using System.ComponentModel.DataAnnotations; +using System.ComponentModel.DataAnnotations.Schema; + +namespace Timeline.Entities +{ + [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1819:Properties should not return arrays", Justification = "This is data base entity.")] + [Table("user_avatars")] + public class UserAvatarEntity + { + [Column("id"), Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)] + public long Id { get; set; } + + [Column("data")] + public byte[]? Data { get; set; } + + [Column("type")] + public string? Type { get; set; } + + [Column("etag"), MaxLength(30)] + public string? ETag { get; set; } + + [Column("last_modified"), Required] + public DateTime LastModified { get; set; } + + public long UserId { get; set; } + } +} diff --git a/Timeline/Entities/UserDetail.cs b/Timeline/Entities/UserDetail.cs deleted file mode 100644 index 45f87e2b..00000000 --- a/Timeline/Entities/UserDetail.cs +++ /dev/null @@ -1,21 +0,0 @@ -using System; -using System.Collections.Generic; -using System.ComponentModel.DataAnnotations; -using System.ComponentModel.DataAnnotations.Schema; -using System.Linq; -using System.Threading.Tasks; - -namespace Timeline.Entities -{ - [Table("user_details")] - public class UserDetail - { - [Column("id"), Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)] - public long Id { get; set; } - - [Column("nickname"), MaxLength(26)] - public string? Nickname { get; set; } - - public long UserId { get; set; } - } -} diff --git a/Timeline/Entities/UserDetailEntity.cs b/Timeline/Entities/UserDetailEntity.cs new file mode 100644 index 00000000..7a525294 --- /dev/null +++ b/Timeline/Entities/UserDetailEntity.cs @@ -0,0 +1,17 @@ +using System.ComponentModel.DataAnnotations; +using System.ComponentModel.DataAnnotations.Schema; + +namespace Timeline.Entities +{ + [Table("user_details")] + public class UserDetailEntity + { + [Column("id"), Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)] + public long Id { get; set; } + + [Column("nickname"), MaxLength(26)] + public string? Nickname { get; set; } + + public long UserId { get; set; } + } +} diff --git a/Timeline/Entities/UserEntity.cs b/Timeline/Entities/UserEntity.cs new file mode 100644 index 00000000..83ef5621 --- /dev/null +++ b/Timeline/Entities/UserEntity.cs @@ -0,0 +1,42 @@ +using System.Collections.Generic; +using System.ComponentModel.DataAnnotations; +using System.ComponentModel.DataAnnotations.Schema; + +namespace Timeline.Entities +{ + public static class UserRoles + { + public const string Admin = "admin"; + public const string User = "user"; + } + + [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "This is an entity class.")] + [Table("users")] + public class UserEntity + { + [Column("id"), Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)] + public long Id { get; set; } + + [Column("name"), MaxLength(26), Required] + public string Name { get; set; } = default!; + + [Column("password"), Required] + public string EncryptedPassword { get; set; } = default!; + + [Column("roles"), Required] + public string RoleString { get; set; } = default!; + + [Column("version"), Required] + public long Version { get; set; } + + public UserAvatarEntity? Avatar { get; set; } + + public UserDetailEntity? Detail { get; set; } + + public List Timelines { get; set; } = default!; + + public List TimelinePosts { get; set; } = default!; + + public List TimelinesJoined { get; set; } = default!; + } +} diff --git a/Timeline/Models/Http/Token.cs b/Timeline/Models/Http/Token.cs index ea8b59ed..0649f1d1 100644 --- a/Timeline/Models/Http/Token.cs +++ b/Timeline/Models/Http/Token.cs @@ -16,7 +16,7 @@ namespace Timeline.Models.Http public class CreateTokenResponse { public string Token { get; set; } = default!; - public UserInfo User { get; set; } = default!; + public User User { get; set; } = default!; } public class VerifyTokenRequest @@ -27,6 +27,6 @@ namespace Timeline.Models.Http public class VerifyTokenResponse { - public UserInfo User { get; set; } = default!; + public User User { get; set; } = default!; } } diff --git a/Timeline/Models/Http/User.cs b/Timeline/Models/Http/User.cs index 516c1329..69bfacf2 100644 --- a/Timeline/Models/Http/User.cs +++ b/Timeline/Models/Http/User.cs @@ -3,6 +3,12 @@ using Timeline.Models.Validation; namespace Timeline.Models.Http { + public class User + { + public string Username { get; set; } = default!; + public bool Administrator { get; set; } + } + public class UserPutRequest { [Required] diff --git a/Timeline/Models/UserConvert.cs b/Timeline/Models/UserConvert.cs deleted file mode 100644 index 5b132421..00000000 --- a/Timeline/Models/UserConvert.cs +++ /dev/null @@ -1,67 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using Timeline.Entities; -using Timeline.Services; - -namespace Timeline.Models -{ - public static class UserConvert - { - public static UserInfo CreateUserInfo(User user) - { - if (user == null) - throw new ArgumentNullException(nameof(user)); - return new UserInfo(user.Name, UserRoleConvert.ToBool(user.RoleString)); - } - - internal static UserCache CreateUserCache(User user) - { - if (user == null) - throw new ArgumentNullException(nameof(user)); - return new UserCache - { - Username = user.Name, - Administrator = UserRoleConvert.ToBool(user.RoleString), - Version = user.Version - }; - } - } - - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "No need.")] - public static class UserRoleConvert - { - public const string UserRole = UserRoles.User; - public const string AdminRole = UserRoles.Admin; - - public static string[] ToArray(bool administrator) - { - return administrator ? new string[] { UserRole, AdminRole } : new string[] { UserRole }; - } - - public static string[] ToArray(string s) - { - return s.Split(',').ToArray(); - } - - public static bool ToBool(IReadOnlyCollection roles) - { - return roles.Contains(AdminRole); - } - - public static string ToString(IReadOnlyCollection roles) - { - return string.Join(',', roles); - } - - public static string ToString(bool administrator) - { - return administrator ? UserRole + "," + AdminRole : UserRole; - } - - public static bool ToBool(string s) - { - return s.Contains("admin", StringComparison.InvariantCulture); - } - } -} diff --git a/Timeline/Models/UserInfo.cs b/Timeline/Models/UserInfo.cs index b60bdfa2..eff47329 100644 --- a/Timeline/Models/UserInfo.cs +++ b/Timeline/Models/UserInfo.cs @@ -1,23 +1,10 @@ -namespace Timeline.Models +namespace Timeline.Models { - public sealed class UserInfo + public class UserInfo { - public UserInfo() - { - } - - public UserInfo(string username, bool administrator) - { - Username = username; - Administrator = administrator; - } - + public long Id { get; set; } + public long Version { get; set; } public string Username { get; set; } = default!; - public bool Administrator { get; set; } = default!; - - public override string ToString() - { - return $"Username: {Username} ; Administrator: {Administrator}"; - } + public bool Administrator { get; set; } } } diff --git a/Timeline/Models/UserRoleConvert.cs b/Timeline/Models/UserRoleConvert.cs new file mode 100644 index 00000000..ade9a799 --- /dev/null +++ b/Timeline/Models/UserRoleConvert.cs @@ -0,0 +1,44 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using Timeline.Entities; + +namespace Timeline.Models +{ + [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "No need.")] + public static class UserRoleConvert + { + public const string UserRole = UserRoles.User; + public const string AdminRole = UserRoles.Admin; + + public static string[] ToArray(bool administrator) + { + return administrator ? new string[] { UserRole, AdminRole } : new string[] { UserRole }; + } + + public static string[] ToArray(string s) + { + return s.Split(',').ToArray(); + } + + public static bool ToBool(IReadOnlyCollection roles) + { + return roles.Contains(AdminRole); + } + + public static string ToString(IReadOnlyCollection roles) + { + return string.Join(',', roles); + } + + public static string ToString(bool administrator) + { + return administrator ? UserRole + "," + AdminRole : UserRole; + } + + public static bool ToBool(string s) + { + return s.Contains("admin", StringComparison.InvariantCulture); + } + } +} diff --git a/Timeline/Resources/Services/Exception.Designer.cs b/Timeline/Resources/Services/Exception.Designer.cs index 1b46f9e9..0a3325d4 100644 --- a/Timeline/Resources/Services/Exception.Designer.cs +++ b/Timeline/Resources/Services/Exception.Designer.cs @@ -178,92 +178,65 @@ namespace Timeline.Resources.Services { } /// - /// Looks up a localized string similar to The version of the jwt token is old.. + /// Looks up a localized string similar to The token didn't pass verification because {0}.. /// - internal static string JwtBadVersionException { + internal static string JwtUserTokenBadFormatException { get { - return ResourceManager.GetString("JwtBadVersionException", resourceCulture); + return ResourceManager.GetString("JwtUserTokenBadFormatException", resourceCulture); } } /// - /// Looks up a localized string similar to The token didn't pass verification because {0}, see inner exception for information.. + /// Looks up a localized string similar to id claim is not a number. /// - internal static string JwtVerifyException { + internal static string JwtUserTokenBadFormatExceptionIdBadFormat { get { - return ResourceManager.GetString("JwtVerifyException", resourceCulture); + return ResourceManager.GetString("JwtUserTokenBadFormatExceptionIdBadFormat", resourceCulture); } } /// - /// Looks up a localized string similar to token is expired.. + /// Looks up a localized string similar to id claim does not exist. /// - internal static string JwtVerifyExceptionExpired { + internal static string JwtUserTokenBadFormatExceptionIdMissing { get { - return ResourceManager.GetString("JwtVerifyExceptionExpired", resourceCulture); + return ResourceManager.GetString("JwtUserTokenBadFormatExceptionIdMissing", resourceCulture); } } /// - /// Looks up a localized string similar to id claim is not a number.. + /// Looks up a localized string similar to other error, see inner exception for information. /// - internal static string JwtVerifyExceptionIdClaimBadFormat { + internal static string JwtUserTokenBadFormatExceptionOthers { get { - return ResourceManager.GetString("JwtVerifyExceptionIdClaimBadFormat", resourceCulture); + return ResourceManager.GetString("JwtUserTokenBadFormatExceptionOthers", resourceCulture); } } /// - /// Looks up a localized string similar to id claim does not exist.. - /// - internal static string JwtVerifyExceptionNoIdClaim { - get { - return ResourceManager.GetString("JwtVerifyExceptionNoIdClaim", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to version claim does not exist.. - /// - internal static string JwtVerifyExceptionNoVersionClaim { - get { - return ResourceManager.GetString("JwtVerifyExceptionNoVersionClaim", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to version of token is old.. - /// - internal static string JwtVerifyExceptionOldVersion { - get { - return ResourceManager.GetString("JwtVerifyExceptionOldVersion", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to uncommon error.. + /// Looks up a localized string similar to unknown error. /// - internal static string JwtVerifyExceptionOthers { + internal static string JwtUserTokenBadFormatExceptionUnknown { get { - return ResourceManager.GetString("JwtVerifyExceptionOthers", resourceCulture); + return ResourceManager.GetString("JwtUserTokenBadFormatExceptionUnknown", resourceCulture); } } /// - /// Looks up a localized string similar to unknown error code.. + /// Looks up a localized string similar to version claim is not a number.. /// - internal static string JwtVerifyExceptionUnknown { + internal static string JwtUserTokenBadFormatExceptionVersionBadFormat { get { - return ResourceManager.GetString("JwtVerifyExceptionUnknown", resourceCulture); + return ResourceManager.GetString("JwtUserTokenBadFormatExceptionVersionBadFormat", resourceCulture); } } /// - /// Looks up a localized string similar to version claim is not a number.. + /// Looks up a localized string similar to version claim does not exist.. /// - internal static string JwtVerifyExceptionVersionClaimBadFormat { + internal static string JwtUserTokenBadFormatExceptionVersionMissing { get { - return ResourceManager.GetString("JwtVerifyExceptionVersionClaimBadFormat", resourceCulture); + return ResourceManager.GetString("JwtUserTokenBadFormatExceptionVersionMissing", resourceCulture); } } @@ -356,5 +329,32 @@ namespace Timeline.Resources.Services { return ResourceManager.GetString("UserNotExistException", resourceCulture); } } + + /// + /// Looks up a localized string similar to The token is of bad format, which means it may not be created by the server.. + /// + internal static string UserTokenBadFormatException { + get { + return ResourceManager.GetString("UserTokenBadFormatException", resourceCulture); + } + } + + /// + /// Looks up a localized string similar to The token is of bad version.. + /// + internal static string UserTokenBadVersionException { + get { + return ResourceManager.GetString("UserTokenBadVersionException", resourceCulture); + } + } + + /// + /// Looks up a localized string similar to The token is expired because its expiration time has passed.. + /// + internal static string UserTokenTimeExpireException { + get { + return ResourceManager.GetString("UserTokenTimeExpireException", resourceCulture); + } + } } } diff --git a/Timeline/Resources/Services/Exception.resx b/Timeline/Resources/Services/Exception.resx index 1d9c0037..bc96248d 100644 --- a/Timeline/Resources/Services/Exception.resx +++ b/Timeline/Resources/Services/Exception.resx @@ -156,36 +156,27 @@ Unknown format marker. - - The version of the jwt token is old. + + The token didn't pass verification because {0}. - - The token didn't pass verification because {0}, see inner exception for information. + + id claim is not a number - - token is expired. + + id claim does not exist - - id claim is not a number. + + other error, see inner exception for information - - id claim does not exist. - - - version claim does not exist. - - - version of token is old. - - - uncommon error. - - - unknown error code. + + unknown error - + version claim is not a number. + + version claim does not exist. + The timeline with that name already exists. @@ -216,4 +207,13 @@ The user does not exist. + + The token is of bad format, which means it may not be created by the server. + + + The token is of bad version. + + + The token is expired because its expiration time has passed. + \ No newline at end of file diff --git a/Timeline/Services/DatabaseExtensions.cs b/Timeline/Services/DatabaseExtensions.cs index 140c3146..c5c96d8c 100644 --- a/Timeline/Services/DatabaseExtensions.cs +++ b/Timeline/Services/DatabaseExtensions.cs @@ -19,7 +19,7 @@ namespace Timeline.Services /// Thrown if is null. /// Thrown if is of bad format. /// Thrown if user does not exist. - internal static async Task CheckAndGetUser(DbSet userDbSet, string? username) + internal static async Task CheckAndGetUser(DbSet userDbSet, string? username) { if (username == null) throw new ArgumentNullException(nameof(username)); diff --git a/Timeline/Services/JwtService.cs b/Timeline/Services/JwtService.cs deleted file mode 100644 index bf92966a..00000000 --- a/Timeline/Services/JwtService.cs +++ /dev/null @@ -1,132 +0,0 @@ -using Microsoft.Extensions.Options; -using Microsoft.IdentityModel.Tokens; -using System; -using System.Globalization; -using System.IdentityModel.Tokens.Jwt; -using System.Security.Claims; -using System.Text; -using Timeline.Configs; - -namespace Timeline.Services -{ - public class TokenInfo - { - public long Id { get; set; } - public long Version { get; set; } - } - - public interface IJwtService - { - /// - /// Create a JWT token for a given token info. - /// - /// The info to generate token. - /// The expire time. If null then use current time with offset in config. - /// Return the generated token. - /// Thrown when is null. - string GenerateJwtToken(TokenInfo tokenInfo, DateTime? expires = null); - - /// - /// Verify a JWT token. - /// Return null is is null. - /// - /// The token string to verify. - /// Return the saved info in token. - /// Thrown when is null. - /// Thrown when the token is invalid. - TokenInfo VerifyJwtToken(string token); - - } - - public class JwtService : IJwtService - { - private const string VersionClaimType = "timeline_version"; - - private readonly IOptionsMonitor _jwtConfig; - private readonly JwtSecurityTokenHandler _tokenHandler = new JwtSecurityTokenHandler(); - private readonly IClock _clock; - - public JwtService(IOptionsMonitor jwtConfig, IClock clock) - { - _jwtConfig = jwtConfig; - _clock = clock; - } - - public string GenerateJwtToken(TokenInfo tokenInfo, DateTime? expires = null) - { - if (tokenInfo == null) - throw new ArgumentNullException(nameof(tokenInfo)); - - var config = _jwtConfig.CurrentValue; - - var identity = new ClaimsIdentity(); - identity.AddClaim(new Claim(ClaimTypes.NameIdentifier, tokenInfo.Id.ToString(CultureInfo.InvariantCulture.NumberFormat), ClaimValueTypes.Integer64)); - identity.AddClaim(new Claim(VersionClaimType, tokenInfo.Version.ToString(CultureInfo.InvariantCulture.NumberFormat), ClaimValueTypes.Integer64)); - - var tokenDescriptor = new SecurityTokenDescriptor() - { - Subject = identity, - Issuer = config.Issuer, - Audience = config.Audience, - SigningCredentials = new SigningCredentials( - new SymmetricSecurityKey(Encoding.ASCII.GetBytes(config.SigningKey)), SecurityAlgorithms.HmacSha384), - IssuedAt = _clock.GetCurrentTime(), - Expires = expires.GetValueOrDefault(_clock.GetCurrentTime().AddSeconds(config.DefaultExpireOffset)), - NotBefore = _clock.GetCurrentTime() // I must explicitly set this or it will use the current time by default and mock is not work in which case test will not pass. - }; - - var token = _tokenHandler.CreateToken(tokenDescriptor); - var tokenString = _tokenHandler.WriteToken(token); - - return tokenString; - } - - - public TokenInfo VerifyJwtToken(string token) - { - if (token == null) - throw new ArgumentNullException(nameof(token)); - - var config = _jwtConfig.CurrentValue; - try - { - var principal = _tokenHandler.ValidateToken(token, new TokenValidationParameters - { - ValidateIssuer = true, - ValidateAudience = true, - ValidateIssuerSigningKey = true, - ValidateLifetime = true, - ValidIssuer = config.Issuer, - ValidAudience = config.Audience, - IssuerSigningKey = new SymmetricSecurityKey(Encoding.ASCII.GetBytes(config.SigningKey)) - }, out _); - - var idClaim = principal.FindFirstValue(ClaimTypes.NameIdentifier); - if (idClaim == null) - throw new JwtVerifyException(JwtVerifyException.ErrorCodes.NoIdClaim); - if (!long.TryParse(idClaim, out var id)) - throw new JwtVerifyException(JwtVerifyException.ErrorCodes.IdClaimBadFormat); - - var versionClaim = principal.FindFirstValue(VersionClaimType); - if (versionClaim == null) - throw new JwtVerifyException(JwtVerifyException.ErrorCodes.NoVersionClaim); - if (!long.TryParse(versionClaim, out var version)) - throw new JwtVerifyException(JwtVerifyException.ErrorCodes.VersionClaimBadFormat); - - return new TokenInfo - { - Id = id, - Version = version - }; - } - catch (SecurityTokenExpiredException e) - { - throw new JwtVerifyException(e, JwtVerifyException.ErrorCodes.Expired); - } - catch (Exception e) - { - throw new JwtVerifyException(e, JwtVerifyException.ErrorCodes.Others); - } - } - } -} diff --git a/Timeline/Services/JwtUserTokenBadFormatException.cs b/Timeline/Services/JwtUserTokenBadFormatException.cs new file mode 100644 index 00000000..c528c3e3 --- /dev/null +++ b/Timeline/Services/JwtUserTokenBadFormatException.cs @@ -0,0 +1,48 @@ +using System; +using System.Globalization; +using static Timeline.Resources.Services.Exception; + +namespace Timeline.Services +{ + [Serializable] + public class JwtUserTokenBadFormatException : UserTokenBadFormatException + { + public enum ErrorKind + { + NoIdClaim, + IdClaimBadFormat, + NoVersionClaim, + VersionClaimBadFormat, + Other + } + + public JwtUserTokenBadFormatException() : this("", ErrorKind.Other) { } + public JwtUserTokenBadFormatException(string message) : base(message) { } + public JwtUserTokenBadFormatException(string message, Exception inner) : base(message, inner) { } + + public JwtUserTokenBadFormatException(string token, ErrorKind type) : base(token, GetErrorMessage(type)) { ErrorType = type; } + public JwtUserTokenBadFormatException(string token, ErrorKind type, Exception inner) : base(token, GetErrorMessage(type), inner) { ErrorType = type; } + public JwtUserTokenBadFormatException(string token, ErrorKind type, string message, Exception inner) : base(token, message, inner) { ErrorType = type; } + protected JwtUserTokenBadFormatException( + System.Runtime.Serialization.SerializationInfo info, + System.Runtime.Serialization.StreamingContext context) : base(info, context) { } + + public ErrorKind ErrorType { get; set; } + + private static string GetErrorMessage(ErrorKind type) + { + var reason = type switch + { + ErrorKind.NoIdClaim => JwtUserTokenBadFormatExceptionIdMissing, + ErrorKind.IdClaimBadFormat => JwtUserTokenBadFormatExceptionIdBadFormat, + ErrorKind.NoVersionClaim => JwtUserTokenBadFormatExceptionVersionMissing, + ErrorKind.VersionClaimBadFormat => JwtUserTokenBadFormatExceptionVersionBadFormat, + ErrorKind.Other => JwtUserTokenBadFormatExceptionOthers, + _ => JwtUserTokenBadFormatExceptionUnknown + }; + + return string.Format(CultureInfo.CurrentCulture, + Resources.Services.Exception.JwtUserTokenBadFormatException, reason); + } + } +} diff --git a/Timeline/Services/JwtVerifyException.cs b/Timeline/Services/JwtVerifyException.cs deleted file mode 100644 index a915b51a..00000000 --- a/Timeline/Services/JwtVerifyException.cs +++ /dev/null @@ -1,59 +0,0 @@ -using Microsoft.IdentityModel.Tokens; -using System; -using System.Globalization; -using static Timeline.Resources.Services.Exception; - -namespace Timeline.Services -{ - [Serializable] - public class JwtVerifyException : Exception - { - public static class ErrorCodes - { - // Codes in -1000 ~ -1999 usually means the user provides a token that is not created by this server. - - public const int Others = -1001; - public const int NoIdClaim = -1002; - public const int IdClaimBadFormat = -1003; - public const int NoVersionClaim = -1004; - public const int VersionClaimBadFormat = -1005; - - /// - /// Corresponds to . - /// - public const int Expired = -2001; - public const int OldVersion = -2002; - } - - public JwtVerifyException() : base(GetErrorMessage(0)) { } - public JwtVerifyException(string message) : base(message) { } - public JwtVerifyException(string message, Exception inner) : base(message, inner) { } - - public JwtVerifyException(int code) : base(GetErrorMessage(code)) { ErrorCode = code; } - public JwtVerifyException(string message, int code) : base(message) { ErrorCode = code; } - public JwtVerifyException(Exception inner, int code) : base(GetErrorMessage(code), inner) { ErrorCode = code; } - public JwtVerifyException(string message, Exception inner, int code) : base(message, inner) { ErrorCode = code; } - protected JwtVerifyException( - System.Runtime.Serialization.SerializationInfo info, - System.Runtime.Serialization.StreamingContext context) : base(info, context) { } - - public int ErrorCode { get; set; } - - private static string GetErrorMessage(int errorCode) - { - var reason = errorCode switch - { - ErrorCodes.Others => JwtVerifyExceptionOthers, - ErrorCodes.NoIdClaim => JwtVerifyExceptionNoIdClaim, - ErrorCodes.IdClaimBadFormat => JwtVerifyExceptionIdClaimBadFormat, - ErrorCodes.NoVersionClaim => JwtVerifyExceptionNoVersionClaim, - ErrorCodes.VersionClaimBadFormat => JwtVerifyExceptionVersionClaimBadFormat, - ErrorCodes.Expired => JwtVerifyExceptionExpired, - ErrorCodes.OldVersion => JwtVerifyExceptionOldVersion, - _ => JwtVerifyExceptionUnknown - }; - - return string.Format(CultureInfo.InvariantCulture, Resources.Services.Exception.JwtVerifyException, reason); - } - } -} diff --git a/Timeline/Services/UserAvatarService.cs b/Timeline/Services/UserAvatarService.cs index 01201864..ac7dd857 100644 --- a/Timeline/Services/UserAvatarService.cs +++ b/Timeline/Services/UserAvatarService.cs @@ -275,7 +275,7 @@ namespace Timeline.Services var create = avatarEntity == null; if (create) { - avatarEntity = new UserAvatar(); + avatarEntity = new UserAvatarEntity(); } avatarEntity!.Type = avatar.Type; avatarEntity.Data = avatar.Data; diff --git a/Timeline/Services/UserDetailService.cs b/Timeline/Services/UserDetailService.cs index 0b24e4e2..4f4a7942 100644 --- a/Timeline/Services/UserDetailService.cs +++ b/Timeline/Services/UserDetailService.cs @@ -77,7 +77,7 @@ namespace Timeline.Services var create = userDetail == null; if (create) { - userDetail = new UserDetail + userDetail = new UserDetailEntity { UserId = userId }; diff --git a/Timeline/Services/UserService.cs b/Timeline/Services/UserService.cs index 4012539f..db2350a2 100644 --- a/Timeline/Services/UserService.cs +++ b/Timeline/Services/UserService.cs @@ -11,47 +11,37 @@ using Timeline.Models.Validation; namespace Timeline.Services { - public class CreateTokenResult - { - public string Token { get; set; } = default!; - public UserInfo User { get; set; } = default!; - } - public interface IUserService { /// - /// Try to anthenticate with the given username and password. - /// If success, create a token and return the user info. + /// Try to verify the given username and password. /// - /// The username of the user to anthenticate. - /// The password of the user to anthenticate. - /// The expired time point. Null then use default. See for what is default. - /// An containing the created token and user info. + /// The username of the user to verify. + /// The password of the user to verify. + /// The user info. /// Thrown when or is null. /// Thrown when username is of bad format. /// Thrown when the user with given username does not exist. /// Thrown when password is wrong. - Task CreateToken(string username, string password, DateTime? expires = null); + Task VerifyCredential(string username, string password); /// - /// Verify the given token. - /// If success, return the user info. + /// Try to get a user by id. /// - /// The token to verify. - /// The user info specified by the token. - /// Thrown when is null. - /// Thrown when the token is of bad format. Thrown by . - /// Thrown when the user specified by the token does not exist. Usually it has been deleted after the token was issued. - Task VerifyToken(string token); + /// The id of the user. + /// The user info. + /// Thrown when the user with given id does not exist. + Task GetUserById(long id); /// /// Get the user info of given username. /// /// Username of the user. - /// The info of the user. Null if the user of given username does not exists. + /// The info of the user. /// Thrown when is null. /// Thrown when is of bad format. - Task GetUser(string username); + /// Thrown when the user with given username does not exist. + Task GetUserByUsername(string username); /// /// List all users. @@ -120,39 +110,24 @@ namespace Timeline.Services Task ChangeUsername(string oldUsername, string newUsername); } - internal class UserCache - { - public string Username { get; set; } = default!; - public bool Administrator { get; set; } - public long Version { get; set; } - - public UserInfo ToUserInfo() - { - return new UserInfo(Username, Administrator); - } - } - public class UserService : IUserService { private readonly ILogger _logger; - private readonly IMemoryCache _memoryCache; private readonly DatabaseContext _databaseContext; - private readonly IJwtService _jwtService; + private readonly IMemoryCache _memoryCache; + private readonly IPasswordService _passwordService; - private readonly UsernameValidator _usernameValidator; + private readonly UsernameValidator _usernameValidator = new UsernameValidator(); - public UserService(ILogger logger, IMemoryCache memoryCache, DatabaseContext databaseContext, IJwtService jwtService, IPasswordService passwordService) + public UserService(ILogger logger, IMemoryCache memoryCache, DatabaseContext databaseContext, IPasswordService passwordService) { _logger = logger; _memoryCache = memoryCache; _databaseContext = databaseContext; - _jwtService = jwtService; _passwordService = passwordService; - - _usernameValidator = new UsernameValidator(); } private static string GenerateCacheKeyByUserId(long id) => $"user:{id}"; @@ -176,12 +151,13 @@ namespace Timeline.Services } } - public async Task CreateToken(string username, string password, DateTime? expires) + public async Task CheckCredential(string username, string password) { if (username == null) throw new ArgumentNullException(nameof(username)); if (password == null) throw new ArgumentNullException(nameof(password)); + CheckUsernameFormat(username); // We need password info, so always check the database. @@ -231,12 +207,12 @@ namespace Timeline.Services } if (tokenInfo.Version != cache.Version) - throw new JwtVerifyException(new JwtBadVersionException(tokenInfo.Version, cache.Version), JwtVerifyException.ErrorCodes.OldVersion); + throw new JwtUserTokenBadFormatException(new JwtBadVersionException(tokenInfo.Version, cache.Version), JwtUserTokenBadFormatException.ErrorCodes.OldVersion); return cache.ToUserInfo(); } - public async Task GetUser(string username) + public async Task GetUserByUsername(string username) { if (username == null) throw new ArgumentNullException(nameof(username)); @@ -267,7 +243,7 @@ namespace Timeline.Services if (user == null) { - var newUser = new User + var newUser = new UserEntity { Name = username, EncryptedPassword = _passwordService.HashPassword(password), diff --git a/Timeline/Services/UserTokenException.cs b/Timeline/Services/UserTokenException.cs new file mode 100644 index 00000000..e63305b1 --- /dev/null +++ b/Timeline/Services/UserTokenException.cs @@ -0,0 +1,71 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; + +namespace Timeline.Services +{ + + [Serializable] + public class UserTokenException : Exception + { + public UserTokenException() { } + public UserTokenException(string message) : base(message) { } + public UserTokenException(string message, Exception inner) : base(message, inner) { } + public UserTokenException(string token, string message) : base(message) { Token = token; } + public UserTokenException(string token, string message, Exception inner) : base(message, inner) { Token = token; } + protected UserTokenException( + System.Runtime.Serialization.SerializationInfo info, + System.Runtime.Serialization.StreamingContext context) : base(info, context) { } + + public string Token { get; private set; } = ""; + } + + + [Serializable] + public class UserTokenTimeExpireException : UserTokenException + { + public UserTokenTimeExpireException() : base(Resources.Services.Exception.UserTokenTimeExpireException) { } + public UserTokenTimeExpireException(string message) : base(message) { } + public UserTokenTimeExpireException(string message, Exception inner) : base(message, inner) { } + public UserTokenTimeExpireException(string token, DateTime expireTime, DateTime verifyTime) : base(token, Resources.Services.Exception.UserTokenTimeExpireException) { ExpireTime = expireTime; VerifyTime = verifyTime; } + public UserTokenTimeExpireException(string token, DateTime expireTime, DateTime verifyTime, Exception inner) : base(token, Resources.Services.Exception.UserTokenTimeExpireException, inner) { ExpireTime = expireTime; VerifyTime = verifyTime; } + protected UserTokenTimeExpireException( + System.Runtime.Serialization.SerializationInfo info, + System.Runtime.Serialization.StreamingContext context) : base(info, context) { } + + public DateTime ExpireTime { get; private set; } = default; + + public DateTime VerifyTime { get; private set; } = default; + } + + [Serializable] + public class UserTokenBadVersionException : UserTokenException + { + public UserTokenBadVersionException() : base(Resources.Services.Exception.UserTokenBadVersionException) { } + public UserTokenBadVersionException(string message) : base(message) { } + public UserTokenBadVersionException(string message, Exception inner) : base(message, inner) { } + public UserTokenBadVersionException(string token, long tokenVersion, long requiredVersion) : base(token, Resources.Services.Exception.UserTokenBadVersionException) { TokenVersion = tokenVersion; RequiredVersion = requiredVersion; } + public UserTokenBadVersionException(string token, long tokenVersion, long requiredVersion, Exception inner) : base(token, Resources.Services.Exception.UserTokenBadVersionException, inner) { TokenVersion = tokenVersion; RequiredVersion = requiredVersion; } + protected UserTokenBadVersionException( + System.Runtime.Serialization.SerializationInfo info, + System.Runtime.Serialization.StreamingContext context) : base(info, context) { } + + public long TokenVersion { get; set; } + + public long RequiredVersion { get; set; } + } + + [Serializable] + public class UserTokenBadFormatException : UserTokenException + { + public UserTokenBadFormatException() : base(Resources.Services.Exception.UserTokenBadFormatException) { } + public UserTokenBadFormatException(string token) : base(token, Resources.Services.Exception.UserTokenBadFormatException) { } + public UserTokenBadFormatException(string token, string message) : base(token, message) { } + public UserTokenBadFormatException(string token, Exception inner) : base(token, Resources.Services.Exception.UserTokenBadFormatException, inner) { } + public UserTokenBadFormatException(string token, string message, Exception inner) : base(token, message, inner) { } + protected UserTokenBadFormatException( + System.Runtime.Serialization.SerializationInfo info, + System.Runtime.Serialization.StreamingContext context) : base(info, context) { } + } +} diff --git a/Timeline/Services/UserTokenManager.cs b/Timeline/Services/UserTokenManager.cs new file mode 100644 index 00000000..c3cb51c9 --- /dev/null +++ b/Timeline/Services/UserTokenManager.cs @@ -0,0 +1,93 @@ +using Microsoft.Extensions.Logging; +using System; +using System.Threading.Tasks; +using Timeline.Models; + +namespace Timeline.Services +{ + public class UserTokenCreateResult + { + public string Token { get; set; } = default!; + public UserInfo User { get; set; } = default!; + } + + public interface IUserTokenManager + { + /// + /// Try to create a token for given username and password. + /// + /// The username. + /// The password. + /// The expire time of the token. + /// The created token and the user info. + /// Thrown when or is null. + /// Thrown when is of bad format. + /// Thrown when the user with does not exist. + /// Thrown when is wrong. + public Task CreateToken(string username, string password, DateTime? expireAt = null); + + /// + /// Verify a token and get the saved user info. This also check the database for existence of the user. + /// + /// The token. + /// The user stored in token. + /// Thrown when is null. + /// Thrown when the token is expired. + /// Thrown when the token is of bad version. + /// Thrown when the token is of bad format. + /// Thrown when the user specified by the token does not exist. Usually the user had been deleted after the token was issued. + public Task VerifyToken(string token); + } + + public class UserTokenManager : IUserTokenManager + { + private readonly ILogger _logger; + private readonly IUserService _userService; + private readonly IUserTokenService _userTokenService; + private readonly IClock _clock; + + public UserTokenManager(ILogger logger, IUserService userService, IUserTokenService userTokenService, IClock clock) + { + _logger = logger; + _userService = userService; + _userTokenService = userTokenService; + _clock = clock; + } + + public async Task CreateToken(string username, string password, DateTime? expireAt = null) + { + if (username == null) + throw new ArgumentNullException(nameof(username)); + if (password == null) + throw new ArgumentNullException(nameof(password)); + + var user = await _userService.VerifyCredential(username, password); + var token = _userTokenService.GenerateToken(new UserTokenInfo { Id = user.Id, Version = user.Version, ExpireAt = expireAt }); + + return new UserTokenCreateResult { Token = token, User = user }; + } + + + public async Task VerifyToken(string token) + { + if (token == null) + throw new ArgumentNullException(nameof(token)); + + var tokenInfo = _userTokenService.VerifyToken(token); + + if (tokenInfo.ExpireAt.HasValue) + { + var currentTime = _clock.GetCurrentTime(); + if (tokenInfo.ExpireAt < currentTime) + throw new UserTokenTimeExpireException(token, tokenInfo.ExpireAt.Value, currentTime); + } + + var user = await _userService.GetUserById(tokenInfo.Id); + + if (tokenInfo.Version < user.Version) + throw new UserTokenBadVersionException(token, tokenInfo.Version, user.Version); + + return user; + } + } +} diff --git a/Timeline/Services/UserTokenService.cs b/Timeline/Services/UserTokenService.cs new file mode 100644 index 00000000..c246fdff --- /dev/null +++ b/Timeline/Services/UserTokenService.cs @@ -0,0 +1,147 @@ +using Microsoft.Extensions.Options; +using Microsoft.IdentityModel.Tokens; +using System; +using System.Globalization; +using System.IdentityModel.Tokens.Jwt; +using System.Security.Claims; +using System.Text; +using Timeline.Configs; + +namespace Timeline.Services +{ + public class UserTokenInfo + { + public long Id { get; set; } + public long Version { get; set; } + public DateTime? ExpireAt { get; set; } + } + + public interface IUserTokenService + { + /// + /// Create a token for a given token info. + /// + /// The info to generate token. + /// Return the generated token. + /// Thrown when is null. + string GenerateToken(UserTokenInfo tokenInfo); + + /// + /// Verify a token and get the saved info. + /// + /// The token to verify. + /// The saved info in token. + /// Thrown when is null. + /// Thrown when the token is of bad format. + /// + /// If this method throw , it usually means the token is not created by this service. + /// + UserTokenInfo VerifyToken(string token); + } + + public class JwtUserTokenService : IUserTokenService + { + private const string VersionClaimType = "timeline_version"; + + private readonly IOptionsMonitor _jwtConfig; + private readonly IClock _clock; + + private readonly JwtSecurityTokenHandler _tokenHandler = new JwtSecurityTokenHandler(); + private SymmetricSecurityKey _tokenSecurityKey; + + [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "")] + public JwtUserTokenService(IOptionsMonitor jwtConfig, IClock clock) + { + _jwtConfig = jwtConfig; + _clock = clock; + + _tokenSecurityKey = new SymmetricSecurityKey(Encoding.ASCII.GetBytes(jwtConfig.CurrentValue.SigningKey)); + jwtConfig.OnChange(config => + { + _tokenSecurityKey = new SymmetricSecurityKey(Encoding.ASCII.GetBytes(config.SigningKey)); + }); + } + + public string GenerateToken(UserTokenInfo tokenInfo) + { + if (tokenInfo == null) + throw new ArgumentNullException(nameof(tokenInfo)); + + var config = _jwtConfig.CurrentValue; + + var identity = new ClaimsIdentity(); + identity.AddClaim(new Claim(ClaimTypes.NameIdentifier, tokenInfo.Id.ToString(CultureInfo.InvariantCulture.NumberFormat), ClaimValueTypes.Integer64)); + identity.AddClaim(new Claim(VersionClaimType, tokenInfo.Version.ToString(CultureInfo.InvariantCulture.NumberFormat), ClaimValueTypes.Integer64)); + + var tokenDescriptor = new SecurityTokenDescriptor() + { + Subject = identity, + Issuer = config.Issuer, + Audience = config.Audience, + SigningCredentials = new SigningCredentials( + new SymmetricSecurityKey(Encoding.ASCII.GetBytes(config.SigningKey)), SecurityAlgorithms.HmacSha384), + IssuedAt = _clock.GetCurrentTime(), + Expires = tokenInfo.ExpireAt.GetValueOrDefault(_clock.GetCurrentTime().AddSeconds(config.DefaultExpireOffset)), + NotBefore = _clock.GetCurrentTime() // I must explicitly set this or it will use the current time by default and mock is not work in which case test will not pass. + }; + + var token = _tokenHandler.CreateToken(tokenDescriptor); + var tokenString = _tokenHandler.WriteToken(token); + + return tokenString; + } + + + public UserTokenInfo VerifyToken(string token) + { + if (token == null) + throw new ArgumentNullException(nameof(token)); + + var config = _jwtConfig.CurrentValue; + try + { + var principal = _tokenHandler.ValidateToken(token, new TokenValidationParameters + { + ValidateIssuer = true, + ValidateAudience = true, + ValidateIssuerSigningKey = true, + ValidateLifetime = false, + ValidIssuer = config.Issuer, + ValidAudience = config.Audience, + IssuerSigningKey = _tokenSecurityKey + }, out var t); + + var idClaim = principal.FindFirstValue(ClaimTypes.NameIdentifier); + if (idClaim == null) + throw new JwtUserTokenBadFormatException(token, JwtUserTokenBadFormatException.ErrorKind.NoIdClaim); + if (!long.TryParse(idClaim, out var id)) + throw new JwtUserTokenBadFormatException(token, JwtUserTokenBadFormatException.ErrorKind.IdClaimBadFormat); + + var versionClaim = principal.FindFirstValue(VersionClaimType); + if (versionClaim == null) + throw new JwtUserTokenBadFormatException(token, JwtUserTokenBadFormatException.ErrorKind.NoVersionClaim); + if (!long.TryParse(versionClaim, out var version)) + throw new JwtUserTokenBadFormatException(token, JwtUserTokenBadFormatException.ErrorKind.VersionClaimBadFormat); + + var decodedToken = (JwtSecurityToken)t; + var exp = decodedToken.Payload.Exp; + DateTime? expireAt = null; + if (exp.HasValue) + { + expireAt = EpochTime.DateTime(exp.Value); + } + + return new UserTokenInfo + { + Id = id, + Version = version, + ExpireAt = expireAt + }; + } + catch (Exception e) when (e is SecurityTokenException || e is ArgumentException) + { + throw new JwtUserTokenBadFormatException(token, JwtUserTokenBadFormatException.ErrorKind.Other, e); + } + } + } +} diff --git a/Timeline/Services/UsernameBadFormatException.cs b/Timeline/Services/UsernameBadFormatException.cs index d82bf962..991be7df 100644 --- a/Timeline/Services/UsernameBadFormatException.cs +++ b/Timeline/Services/UsernameBadFormatException.cs @@ -22,6 +22,6 @@ namespace Timeline.Services /// /// Username of bad format. /// - public string? Username { get; private set; } + public string Username { get; private set; } = ""; } } diff --git a/Timeline/Startup.cs b/Timeline/Startup.cs index 5b6499a4..c1e73182 100644 --- a/Timeline/Startup.cs +++ b/Timeline/Startup.cs @@ -84,7 +84,7 @@ namespace Timeline }); services.AddScoped(); - services.AddScoped(); + services.AddScoped(); services.AddTransient(); services.AddTransient(); services.AddUserAvatarService(); -- cgit v1.2.3 From 42215e7d28d6144e5a19f77ddc060c42b7afdad5 Mon Sep 17 00:00:00 2001 From: crupest Date: Thu, 23 Jan 2020 20:51:02 +0800 Subject: ... --- Timeline.Tests/Controllers/TokenControllerTest.cs | 35 +++++++++--- Timeline.Tests/Controllers/UserControllerTest.cs | 21 +++++-- Timeline.Tests/Helpers/MockUser.cs | 10 ++-- Timeline/Auth/MyAuthenticationHandler.cs | 10 ++-- Timeline/Controllers/TokenController.cs | 60 ++++++++++---------- Timeline/Controllers/UserController.cs | 11 ++-- Timeline/Entities/UserAvatarEntity.cs | 4 ++ Timeline/Entities/UserDetailEntity.cs | 4 ++ Timeline/GlobalSuppressions.cs | 6 +- Timeline/Services/JwtBadVersionException.cs | 36 ------------ Timeline/Services/UserService.cs | 67 +++++++++++------------ Timeline/Services/UsernameBadFormatException.cs | 11 ++-- Timeline/Startup.cs | 3 +- 13 files changed, 142 insertions(+), 136 deletions(-) delete mode 100644 Timeline/Services/JwtBadVersionException.cs (limited to 'Timeline/Controllers/UserController.cs') diff --git a/Timeline.Tests/Controllers/TokenControllerTest.cs b/Timeline.Tests/Controllers/TokenControllerTest.cs index 740d8377..61fbe950 100644 --- a/Timeline.Tests/Controllers/TokenControllerTest.cs +++ b/Timeline.Tests/Controllers/TokenControllerTest.cs @@ -6,6 +6,7 @@ using System; using System.Collections.Generic; using System.Threading.Tasks; using Timeline.Controllers; +using Timeline.Models; using Timeline.Models.Http; using Timeline.Services; using Timeline.Tests.Helpers; @@ -15,7 +16,7 @@ namespace Timeline.Tests.Controllers { public class TokenControllerTest : IDisposable { - private readonly Mock _mockUserService = new Mock(); + private readonly Mock _mockUserService = new Mock(); private readonly TestClock _mockClock = new TestClock(); @@ -38,12 +39,18 @@ namespace Timeline.Tests.Controllers { var mockCurrentTime = DateTime.Now; _mockClock.MockCurrentTime = mockCurrentTime; - var createResult = new CreateTokenResult + var mockCreateResult = new UserTokenCreateResult { Token = "mocktokenaaaaa", - User = MockUser.User.Info + User = new UserInfo + { + Id = 1, + Username = MockUser.User.Username, + Administrator = MockUser.User.Administrator, + Version = 1 + } }; - _mockUserService.Setup(s => s.CreateToken("u", "p", expire == null ? null : (DateTime?)mockCurrentTime.AddDays(expire.Value))).ReturnsAsync(createResult); + _mockUserService.Setup(s => s.CreateToken("u", "p", expire == null ? null : (DateTime?)mockCurrentTime.AddDays(expire.Value))).ReturnsAsync(mockCreateResult); var action = await _controller.Create(new CreateTokenRequest { Username = "u", @@ -51,7 +58,11 @@ namespace Timeline.Tests.Controllers Expire = expire }); action.Result.Should().BeAssignableTo() - .Which.Value.Should().BeEquivalentTo(createResult); + .Which.Value.Should().BeEquivalentTo(new CreateTokenResponse + { + Token = mockCreateResult.Token, + User = MockUser.User.Info + }); } [Fact] @@ -88,7 +99,13 @@ namespace Timeline.Tests.Controllers public async Task Verify_Ok() { const string token = "aaaaaaaaaaaaaa"; - _mockUserService.Setup(s => s.VerifyToken(token)).ReturnsAsync(MockUser.User.Info); + _mockUserService.Setup(s => s.VerifyToken(token)).ReturnsAsync(new UserInfo + { + Id = 1, + Username = MockUser.User.Username, + Administrator = MockUser.User.Administrator, + Version = 1 + }); var action = await _controller.Verify(new VerifyTokenRequest { Token = token }); action.Result.Should().BeAssignableTo() .Which.Value.Should().BeAssignableTo() @@ -97,9 +114,9 @@ namespace Timeline.Tests.Controllers public static IEnumerable Verify_BadRequest_Data() { - yield return new object[] { new JwtUserTokenBadFormatException(JwtUserTokenBadFormatException.ErrorCodes.Expired), ErrorCodes.TokenController.Verify_TimeExpired }; - yield return new object[] { new JwtUserTokenBadFormatException(JwtUserTokenBadFormatException.ErrorCodes.IdClaimBadFormat), ErrorCodes.TokenController.Verify_BadFormat }; - yield return new object[] { new JwtUserTokenBadFormatException(JwtUserTokenBadFormatException.ErrorCodes.OldVersion), ErrorCodes.TokenController.Verify_OldVersion }; + yield return new object[] { new UserTokenTimeExpireException(), ErrorCodes.TokenController.Verify_TimeExpired }; + yield return new object[] { new UserTokenBadVersionException(), ErrorCodes.TokenController.Verify_OldVersion }; + yield return new object[] { new UserTokenBadFormatException(), ErrorCodes.TokenController.Verify_BadFormat }; yield return new object[] { new UserNotExistException(), ErrorCodes.TokenController.Verify_UserNotExist }; } diff --git a/Timeline.Tests/Controllers/UserControllerTest.cs b/Timeline.Tests/Controllers/UserControllerTest.cs index 262dbe11..a1035675 100644 --- a/Timeline.Tests/Controllers/UserControllerTest.cs +++ b/Timeline.Tests/Controllers/UserControllerTest.cs @@ -4,6 +4,7 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Logging.Abstractions; using Moq; using System; +using System.Collections.Generic; using System.Linq; using System.Security.Claims; using System.Threading.Tasks; @@ -35,18 +36,28 @@ namespace Timeline.Tests.Controllers [Fact] public async Task GetList_Success() { - var array = MockUser.UserInfoList.ToArray(); - _mockUserService.Setup(s => s.ListUsers()).ReturnsAsync(array); + var mockUserList = new UserInfo[] { + new UserInfo { Id = 1, Username = "aaa", Administrator = true, Version = 1 }, + new UserInfo { Id = 2, Username = "bbb", Administrator = false, Version = 1 } + }; + _mockUserService.Setup(s => s.ListUsers()).ReturnsAsync(mockUserList); var action = await _controller.List(); action.Result.Should().BeAssignableTo() - .Which.Value.Should().BeEquivalentTo(array); + .Which.Value.Should().BeEquivalentTo( + mockUserList.Select(u => new User { Username = u.Username, Administrator = u.Administrator }).ToArray()); } [Fact] public async Task Get_Success() { const string username = "aaa"; - _mockUserService.Setup(s => s.GetUserByUsername(username)).ReturnsAsync(MockUser.User.Info); + _mockUserService.Setup(s => s.GetUserByUsername(username)).ReturnsAsync(new UserInfo + { + Id = 1, + Username = MockUser.User.Username, + Administrator = MockUser.User.Administrator, + Version = 1 + }); var action = await _controller.Get(username); action.Result.Should().BeAssignableTo() .Which.Value.Should().BeEquivalentTo(MockUser.User.Info); @@ -56,7 +67,7 @@ namespace Timeline.Tests.Controllers public async Task Get_NotFound() { const string username = "aaa"; - _mockUserService.Setup(s => s.GetUserByUsername(username)).Returns(Task.FromResult(null)); + _mockUserService.Setup(s => s.GetUserByUsername(username)).ThrowsAsync(new UserNotExistException()); var action = await _controller.Get(username); action.Result.Should().BeAssignableTo() .Which.Value.Should().BeAssignableTo() diff --git a/Timeline.Tests/Helpers/MockUser.cs b/Timeline.Tests/Helpers/MockUser.cs index 8d738525..49576842 100644 --- a/Timeline.Tests/Helpers/MockUser.cs +++ b/Timeline.Tests/Helpers/MockUser.cs @@ -1,17 +1,17 @@ using System.Collections.Generic; -using Timeline.Models; - +using Timeline.Models.Http; + namespace Timeline.Tests.Helpers { public class MockUser { public MockUser(string username, string password, bool administrator) { - Info = new UserInfo(username, administrator); + Info = new User { Username = username, Administrator = administrator }; Password = password; } - public UserInfo Info { get; set; } + public User Info { get; set; } public string Username => Info.Username; public string Password { get; set; } public bool Administrator => Info.Administrator; @@ -19,6 +19,6 @@ namespace Timeline.Tests.Helpers public static MockUser User { get; } = new MockUser("user", "userpassword", false); public static MockUser Admin { get; } = new MockUser("admin", "adminpassword", true); - public static IReadOnlyList UserInfoList { get; } = new List { User.Info, Admin.Info }; + public static IReadOnlyList UserInfoList { get; } = new List { User.Info, Admin.Info }; } } diff --git a/Timeline/Auth/MyAuthenticationHandler.cs b/Timeline/Auth/MyAuthenticationHandler.cs index f5dcd697..5bae5117 100644 --- a/Timeline/Auth/MyAuthenticationHandler.cs +++ b/Timeline/Auth/MyAuthenticationHandler.cs @@ -3,6 +3,7 @@ using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; using Microsoft.Net.Http.Headers; using System; +using System.Globalization; using System.Linq; using System.Security.Claims; using System.Text.Encodings.Web; @@ -30,13 +31,13 @@ namespace Timeline.Auth public class MyAuthenticationHandler : AuthenticationHandler { private readonly ILogger _logger; - private readonly IUserService _userService; + private readonly IUserTokenManager _userTokenManager; - public MyAuthenticationHandler(IOptionsMonitor options, ILoggerFactory logger, UrlEncoder encoder, ISystemClock clock, IUserService userService) + public MyAuthenticationHandler(IOptionsMonitor options, ILoggerFactory logger, UrlEncoder encoder, ISystemClock clock, IUserTokenManager userTokenManager) : base(options, logger, encoder, clock) { _logger = logger.CreateLogger(); - _userService = userService; + _userTokenManager = userTokenManager; } // return null if no token is found @@ -78,9 +79,10 @@ namespace Timeline.Auth try { - var userInfo = await _userService.VerifyToken(token); + var userInfo = await _userTokenManager.VerifyToken(token); var identity = new ClaimsIdentity(AuthenticationConstants.Scheme); + identity.AddClaim(new Claim(ClaimTypes.NameIdentifier, userInfo.Id.ToString(CultureInfo.InvariantCulture), ClaimValueTypes.Integer64)); identity.AddClaim(new Claim(identity.NameClaimType, userInfo.Username, ClaimValueTypes.String)); identity.AddClaims(UserRoleConvert.ToArray(userInfo.Administrator).Select(role => new Claim(identity.RoleClaimType, role, ClaimValueTypes.String))); diff --git a/Timeline/Controllers/TokenController.cs b/Timeline/Controllers/TokenController.cs index 851c7606..a96b6fa9 100644 --- a/Timeline/Controllers/TokenController.cs +++ b/Timeline/Controllers/TokenController.cs @@ -1,11 +1,11 @@ using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Logging; -using Microsoft.IdentityModel.Tokens; using System; using System.Globalization; using System.Threading.Tasks; using Timeline.Helpers; +using Timeline.Models; using Timeline.Models.Http; using Timeline.Services; using static Timeline.Resources.Controllers.TokenController; @@ -16,13 +16,22 @@ namespace Timeline.Controllers [ApiController] public class TokenController : Controller { - private readonly IUserService _userService; + private readonly IUserTokenManager _userTokenManager; private readonly ILogger _logger; private readonly IClock _clock; - public TokenController(IUserService userService, ILogger logger, IClock clock) + private static User CreateUserFromUserInfo(UserInfo userInfo) { - _userService = userService; + return new User + { + Username = userInfo.Username, + Administrator = userInfo.Administrator + }; + } + + public TokenController(IUserTokenManager userTokenManager, ILogger logger, IClock clock) + { + _userTokenManager = userTokenManager; _logger = logger; _clock = clock; } @@ -47,7 +56,7 @@ namespace Timeline.Controllers if (request.Expire != null) expireTime = _clock.GetCurrentTime().AddDays(request.Expire.Value); - var result = await _userService.CreateToken(request.Username, request.Password, expireTime); + var result = await _userTokenManager.CreateToken(request.Username, request.Password, expireTime); _logger.LogInformation(Log.Format(LogCreateSuccess, ("Username", request.Username), @@ -56,7 +65,7 @@ namespace Timeline.Controllers return Ok(new CreateTokenResponse { Token = result.Token, - User = result.User + User = CreateUserFromUserInfo(result.User) }); } catch (UserNotExistException e) @@ -86,36 +95,29 @@ namespace Timeline.Controllers try { - var result = await _userService.VerifyToken(request.Token); + var result = await _userTokenManager.VerifyToken(request.Token); _logger.LogInformation(Log.Format(LogVerifySuccess, ("Username", result.Username), ("Token", request.Token))); return Ok(new VerifyTokenResponse { - User = result + User = CreateUserFromUserInfo(result) }); } - catch (JwtUserTokenBadFormatException e) + catch (UserTokenTimeExpireException e) { - if (e.ErrorCode == JwtUserTokenBadFormatException.ErrorCodes.Expired) - { - var innerException = e.InnerException as SecurityTokenExpiredException; - LogFailure(LogVerifyExpire, e, ("Expires", innerException?.Expires), - ("Current Time", _clock.GetCurrentTime())); - return BadRequest(ErrorResponse.TokenController.Verify_TimeExpired()); - } - else if (e.ErrorCode == JwtUserTokenBadFormatException.ErrorCodes.OldVersion) - { - var innerException = e.InnerException as JwtBadVersionException; - LogFailure(LogVerifyOldVersion, e, - ("Token Version", innerException?.TokenVersion), - ("Required Version", innerException?.RequiredVersion)); - return BadRequest(ErrorResponse.TokenController.Verify_OldVersion()); - } - else - { - LogFailure(LogVerifyBadFormat, e); - return BadRequest(ErrorResponse.TokenController.Verify_BadFormat()); - } + LogFailure(LogVerifyExpire, e, ("Expire Time", e.ExpireTime), ("Verify Time", e.VerifyTime)); + return BadRequest(ErrorResponse.TokenController.Verify_TimeExpired()); + } + catch (UserTokenBadVersionException e) + { + LogFailure(LogVerifyOldVersion, e, ("Token Version", e.TokenVersion), ("Required Version", e.RequiredVersion)); + return BadRequest(ErrorResponse.TokenController.Verify_OldVersion()); + + } + catch (UserTokenBadFormatException e) + { + LogFailure(LogVerifyBadFormat, e); + return BadRequest(ErrorResponse.TokenController.Verify_BadFormat()); } catch (UserNotExistException e) { diff --git a/Timeline/Controllers/UserController.cs b/Timeline/Controllers/UserController.cs index 65ee3a0f..5f1b7bd7 100644 --- a/Timeline/Controllers/UserController.cs +++ b/Timeline/Controllers/UserController.cs @@ -35,13 +35,16 @@ namespace Timeline.Controllers [HttpGet("users/{username}"), AdminAuthorize] public async Task> Get([FromRoute][Username] string username) { - var user = await _userService.GetUserByUsername(username); - if (user == null) + try + { + var user = await _userService.GetUserByUsername(username); + return Ok(user); + } + catch (UserNotExistException e) { - _logger.LogInformation(Log.Format(LogGetUserNotExist, ("Username", username))); + _logger.LogInformation(e, Log.Format(LogGetUserNotExist, ("Username", username))); return NotFound(ErrorResponse.UserCommon.NotExist()); } - return Ok(user); } [HttpPut("users/{username}"), AdminAuthorize] diff --git a/Timeline/Entities/UserAvatarEntity.cs b/Timeline/Entities/UserAvatarEntity.cs index eed819bc..6cecce1a 100644 --- a/Timeline/Entities/UserAvatarEntity.cs +++ b/Timeline/Entities/UserAvatarEntity.cs @@ -23,6 +23,10 @@ namespace Timeline.Entities [Column("last_modified"), Required] public DateTime LastModified { get; set; } + [Column("user"), Required] public long UserId { get; set; } + + [ForeignKey(nameof(UserId))] + public UserEntity User { get; set; } = default!; } } diff --git a/Timeline/Entities/UserDetailEntity.cs b/Timeline/Entities/UserDetailEntity.cs index 7a525294..1d9957f9 100644 --- a/Timeline/Entities/UserDetailEntity.cs +++ b/Timeline/Entities/UserDetailEntity.cs @@ -12,6 +12,10 @@ namespace Timeline.Entities [Column("nickname"), MaxLength(26)] public string? Nickname { get; set; } + [Column("user")] public long UserId { get; set; } + + [ForeignKey(nameof(UserId))] + public UserEntity User { get; set; } = default!; } } diff --git a/Timeline/GlobalSuppressions.cs b/Timeline/GlobalSuppressions.cs index 076c2005..c0754071 100644 --- a/Timeline/GlobalSuppressions.cs +++ b/Timeline/GlobalSuppressions.cs @@ -7,6 +7,6 @@ [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1034:Nested types should not be visible", Justification = "This is not bad.")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "No need to check the null because it's ASP.Net's duty.", Scope = "namespaceanddescendants", Target = "Timeline.Controllers")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "Migrations code are auto generated.", Scope = "namespaceanddescendants", Target = "Timeline.Migrations")] -[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1707:Identifiers should not contain underscores", Justification = "Error code constant identifiers.", Scope = "type", Target = "Timeline.ErrorCodes")] -[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1716:Identifiers should not match keywords", Justification = "Error code constant identifiers.", Scope = "type", Target = "Timeline.ErrorCodes")] -[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1724:Type names should not match namespaces", Justification = "Error code constant identifiers.", Scope = "type", Target = "Timeline.ErrorCodes")] +[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1707:Identifiers should not contain underscores", Justification = "Generated error response identifiers.", Scope = "type", Target = "Timeline.Models.Http.ErrorResponse")] +[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1724:Type names should not match namespaces", Justification = "Generated error response identifiers.", Scope = "type", Target = "Timeline.Models.Http.ErrorResponse")] +[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Globalization", "CA1305:Specify IFormatProvider", Justification = "Generated error response.", Scope = "type", Target = "Timeline.Models.Http.ErrorResponse")] diff --git a/Timeline/Services/JwtBadVersionException.cs b/Timeline/Services/JwtBadVersionException.cs deleted file mode 100644 index 4ce17710..00000000 --- a/Timeline/Services/JwtBadVersionException.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System; -using Timeline.Helpers; - -namespace Timeline.Services -{ - [Serializable] - public class JwtBadVersionException : Exception - { - public JwtBadVersionException() : base(Resources.Services.Exception.JwtBadVersionException) { } - public JwtBadVersionException(string message) : base(message) { } - public JwtBadVersionException(string message, Exception inner) : base(message, inner) { } - - public JwtBadVersionException(long tokenVersion, long requiredVersion) - : base(Log.Format(Resources.Services.Exception.JwtBadVersionException, - ("Token Version", tokenVersion), - ("Required Version", requiredVersion))) - { - TokenVersion = tokenVersion; - RequiredVersion = requiredVersion; - } - - protected JwtBadVersionException( - System.Runtime.Serialization.SerializationInfo info, - System.Runtime.Serialization.StreamingContext context) : base(info, context) { } - - /// - /// The version in the token. - /// - public long? TokenVersion { get; set; } - - /// - /// The version required. - /// - public long? RequiredVersion { get; set; } - } -} diff --git a/Timeline/Services/UserService.cs b/Timeline/Services/UserService.cs index db2350a2..104db1b0 100644 --- a/Timeline/Services/UserService.cs +++ b/Timeline/Services/UserService.cs @@ -139,19 +139,30 @@ namespace Timeline.Services _logger.LogInformation(Log.Format(Resources.Services.UserService.LogCacheRemove, ("Key", key))); } - private void CheckUsernameFormat(string username, string? additionalMessage = null) + private void CheckUsernameFormat(string username, string? message = null) { - var (result, message) = _usernameValidator.Validate(username); + var (result, validationMessage) = _usernameValidator.Validate(username); if (!result) { - if (additionalMessage == null) - throw new UsernameBadFormatException(username, message); + if (message == null) + throw new UsernameBadFormatException(username, validationMessage); else - throw new UsernameBadFormatException(username, additionalMessage + message); + throw new UsernameBadFormatException(username, validationMessage, message); } } - public async Task CheckCredential(string username, string password) + private static UserInfo CreateUserInfoFromEntity(UserEntity user) + { + return new UserInfo + { + Id = user.Id, + Username = user.Name, + Administrator = UserRoleConvert.ToBool(user.RoleString), + Version = user.Version + }; + } + + public async Task VerifyCredential(string username, string password) { if (username == null) throw new ArgumentNullException(nameof(username)); @@ -169,30 +180,13 @@ namespace Timeline.Services if (!_passwordService.VerifyPassword(user.EncryptedPassword, password)) throw new BadPasswordException(password); - var token = _jwtService.GenerateJwtToken(new TokenInfo - { - Id = user.Id, - Version = user.Version - }, expires); - - return new CreateTokenResult - { - Token = token, - User = UserConvert.CreateUserInfo(user) - }; + return CreateUserInfoFromEntity(user); } - public async Task VerifyToken(string token) + public async Task GetUserById(long id) { - if (token == null) - throw new ArgumentNullException(nameof(token)); - - TokenInfo tokenInfo; - tokenInfo = _jwtService.VerifyJwtToken(token); - - var id = tokenInfo.Id; var key = GenerateCacheKeyByUserId(id); - if (!_memoryCache.TryGetValue(key, out var cache)) + if (!_memoryCache.TryGetValue(key, out var cache)) { // no cache, check the database var user = await _databaseContext.Users.Where(u => u.Id == id).SingleOrDefaultAsync(); @@ -201,34 +195,35 @@ namespace Timeline.Services throw new UserNotExistException(id); // create cache - cache = UserConvert.CreateUserCache(user); + cache = CreateUserInfoFromEntity(user); _memoryCache.CreateEntry(key).SetValue(cache); _logger.LogInformation(Log.Format(Resources.Services.UserService.LogCacheCreate, ("Key", key))); } - if (tokenInfo.Version != cache.Version) - throw new JwtUserTokenBadFormatException(new JwtBadVersionException(tokenInfo.Version, cache.Version), JwtUserTokenBadFormatException.ErrorCodes.OldVersion); - - return cache.ToUserInfo(); + return cache; } public async Task GetUserByUsername(string username) { if (username == null) throw new ArgumentNullException(nameof(username)); + CheckUsernameFormat(username); - return await _databaseContext.Users + var entity = await _databaseContext.Users .Where(user => user.Name == username) - .Select(user => UserConvert.CreateUserInfo(user)) .SingleOrDefaultAsync(); + + if (entity == null) + throw new UserNotExistException(username); + + return CreateUserInfoFromEntity(entity); } public async Task ListUsers() { - return await _databaseContext.Users - .Select(user => UserConvert.CreateUserInfo(user)) - .ToArrayAsync(); + var entities = await _databaseContext.Users.ToArrayAsync(); + return entities.Select(user => CreateUserInfoFromEntity(user)).ToArray(); } public async Task PutUser(string username, string password, bool administrator) diff --git a/Timeline/Services/UsernameBadFormatException.cs b/Timeline/Services/UsernameBadFormatException.cs index 991be7df..ad0350b5 100644 --- a/Timeline/Services/UsernameBadFormatException.cs +++ b/Timeline/Services/UsernameBadFormatException.cs @@ -9,11 +9,12 @@ namespace Timeline.Services public class UsernameBadFormatException : Exception { public UsernameBadFormatException() : base(Resources.Services.Exception.UsernameBadFormatException) { } - public UsernameBadFormatException(string username) : this() { Username = username; } - public UsernameBadFormatException(string username, Exception inner) : base(Resources.Services.Exception.UsernameBadFormatException, inner) { Username = username; } + public UsernameBadFormatException(string message) : base(message) { } + public UsernameBadFormatException(string message, Exception inner) : base(message, inner) { } - public UsernameBadFormatException(string username, string message) : base(message) { Username = username; } - public UsernameBadFormatException(string username, string message, Exception inner) : base(message, inner) { Username = username; } + public UsernameBadFormatException(string username, string validationMessage) : this() { Username = username; ValidationMessage = validationMessage; } + + public UsernameBadFormatException(string username, string validationMessage, string message) : this(message) { Username = username; ValidationMessage = validationMessage; } protected UsernameBadFormatException( System.Runtime.Serialization.SerializationInfo info, @@ -23,5 +24,7 @@ namespace Timeline.Services /// Username of bad format. /// public string Username { get; private set; } = ""; + + public string ValidationMessage { get; private set; } = ""; } } diff --git a/Timeline/Startup.cs b/Timeline/Startup.cs index c1e73182..379ce6ea 100644 --- a/Timeline/Startup.cs +++ b/Timeline/Startup.cs @@ -84,7 +84,8 @@ namespace Timeline }); services.AddScoped(); - services.AddScoped(); + services.AddScoped(); + services.AddScoped(); services.AddTransient(); services.AddTransient(); services.AddUserAvatarService(); -- cgit v1.2.3 From 81c261b59016e15d320ad963882afe4d9c7b5f7d Mon Sep 17 00:00:00 2001 From: crupest Date: Wed, 29 Jan 2020 18:38:41 +0800 Subject: ... --- Timeline.Tests/Controllers/UserControllerTest.cs | 4 +- Timeline/Auth/MyAuthenticationHandler.cs | 4 +- Timeline/Controllers/UserController.cs | 4 +- Timeline/Models/User.cs | 1 + Timeline/Models/Validation/NicknameValidator.cs | 26 ++ Timeline/Resources/Messages.zh.resx | 189 --------------- Timeline/Resources/Models/Http/Common.zh.resx | 132 ----------- .../Validation/NicknameValidator.Designer.cs | 72 ++++++ .../Models/Validation/NicknameValidator.resx | 123 ++++++++++ .../Validation/PasswordValidator.Designer.cs | 72 ------ .../Models/Validation/PasswordValidator.resx | 123 ---------- .../Models/Validation/PasswordValidator.zh.resx | 123 ---------- .../Models/Validation/UsernameValidator.zh.resx | 129 ---------- .../Resources/Models/Validation/Validator.zh.resx | 129 ---------- Timeline/Resources/Services/Exception.Designer.cs | 18 +- Timeline/Resources/Services/Exception.resx | 6 +- .../Resources/Services/UserManager.Designer.cs | 72 ------ Timeline/Resources/Services/UserManager.resx | 123 ---------- .../Resources/Services/UserService.Designer.cs | 36 +-- Timeline/Resources/Services/UserService.resx | 18 +- Timeline/Services/ConfictException.cs | 21 ++ Timeline/Services/UserService.cs | 263 +++++++++++++-------- Timeline/Services/UserTokenException.cs | 3 - Timeline/Services/UserTokenManager.cs | 4 +- Timeline/Services/UsernameConfictException.cs | 25 -- Timeline/Startup.cs | 19 -- Timeline/Timeline.csproj | 17 +- 27 files changed, 454 insertions(+), 1302 deletions(-) create mode 100644 Timeline/Models/Validation/NicknameValidator.cs delete mode 100644 Timeline/Resources/Messages.zh.resx delete mode 100644 Timeline/Resources/Models/Http/Common.zh.resx create mode 100644 Timeline/Resources/Models/Validation/NicknameValidator.Designer.cs create mode 100644 Timeline/Resources/Models/Validation/NicknameValidator.resx delete mode 100644 Timeline/Resources/Models/Validation/PasswordValidator.Designer.cs delete mode 100644 Timeline/Resources/Models/Validation/PasswordValidator.resx delete mode 100644 Timeline/Resources/Models/Validation/PasswordValidator.zh.resx delete mode 100644 Timeline/Resources/Models/Validation/UsernameValidator.zh.resx delete mode 100644 Timeline/Resources/Models/Validation/Validator.zh.resx delete mode 100644 Timeline/Resources/Services/UserManager.Designer.cs delete mode 100644 Timeline/Resources/Services/UserManager.resx create mode 100644 Timeline/Services/ConfictException.cs delete mode 100644 Timeline/Services/UsernameConfictException.cs (limited to 'Timeline/Controllers/UserController.cs') diff --git a/Timeline.Tests/Controllers/UserControllerTest.cs b/Timeline.Tests/Controllers/UserControllerTest.cs index 192d53dd..3890712a 100644 --- a/Timeline.Tests/Controllers/UserControllerTest.cs +++ b/Timeline.Tests/Controllers/UserControllerTest.cs @@ -40,7 +40,7 @@ namespace Timeline.Tests.Controllers new Models.User { Id = 1, Username = "aaa", Administrator = true, Version = 1 }, new Models.User { Id = 2, Username = "bbb", Administrator = false, Version = 1 } }; - _mockUserService.Setup(s => s.ListUsers()).ReturnsAsync(mockUserList); + _mockUserService.Setup(s => s.GetUsers()).ReturnsAsync(mockUserList); var action = await _controller.List(); action.Result.Should().BeAssignableTo() .Which.Value.Should().BeEquivalentTo( @@ -165,7 +165,7 @@ namespace Timeline.Tests.Controllers [Theory] [InlineData(typeof(UserNotExistException), ErrorCodes.UserCommon.NotExist)] - [InlineData(typeof(UsernameConfictException), ErrorCodes.UserController.ChangeUsername_Conflict)] + [InlineData(typeof(ConfictException), ErrorCodes.UserController.ChangeUsername_Conflict)] public async Task Op_ChangeUsername_Failure(Type exceptionType, int code) { const string oldUsername = "aaa"; diff --git a/Timeline/Auth/MyAuthenticationHandler.cs b/Timeline/Auth/MyAuthenticationHandler.cs index 5bae5117..e6b26c4b 100644 --- a/Timeline/Auth/MyAuthenticationHandler.cs +++ b/Timeline/Auth/MyAuthenticationHandler.cs @@ -82,9 +82,9 @@ namespace Timeline.Auth var userInfo = await _userTokenManager.VerifyToken(token); var identity = new ClaimsIdentity(AuthenticationConstants.Scheme); - identity.AddClaim(new Claim(ClaimTypes.NameIdentifier, userInfo.Id.ToString(CultureInfo.InvariantCulture), ClaimValueTypes.Integer64)); + identity.AddClaim(new Claim(ClaimTypes.NameIdentifier, userInfo.Id!.Value.ToString(CultureInfo.InvariantCulture), ClaimValueTypes.Integer64)); identity.AddClaim(new Claim(identity.NameClaimType, userInfo.Username, ClaimValueTypes.String)); - identity.AddClaims(UserRoleConvert.ToArray(userInfo.Administrator).Select(role => new Claim(identity.RoleClaimType, role, ClaimValueTypes.String))); + identity.AddClaims(UserRoleConvert.ToArray(userInfo.Administrator!.Value).Select(role => new Claim(identity.RoleClaimType, role, ClaimValueTypes.String))); var principal = new ClaimsPrincipal(); principal.AddIdentity(identity); diff --git a/Timeline/Controllers/UserController.cs b/Timeline/Controllers/UserController.cs index 5f1b7bd7..3305952a 100644 --- a/Timeline/Controllers/UserController.cs +++ b/Timeline/Controllers/UserController.cs @@ -29,7 +29,7 @@ namespace Timeline.Controllers [HttpGet("users"), AdminAuthorize] public async Task> List() { - return Ok(await _userService.ListUsers()); + return Ok(await _userService.GetUsers()); } [HttpGet("users/{username}"), AdminAuthorize] @@ -105,7 +105,7 @@ namespace Timeline.Controllers ("Old Username", request.OldUsername), ("New Username", request.NewUsername))); return BadRequest(ErrorResponse.UserCommon.NotExist()); } - catch (UsernameConfictException e) + catch (ConfictException e) { _logger.LogInformation(e, Log.Format(LogChangeUsernameConflict, ("Old Username", request.OldUsername), ("New Username", request.NewUsername))); diff --git a/Timeline/Models/User.cs b/Timeline/Models/User.cs index 05395022..2cead892 100644 --- a/Timeline/Models/User.cs +++ b/Timeline/Models/User.cs @@ -12,6 +12,7 @@ namespace Timeline.Models #region secret + public long? Id { get; set; } public string? Password { get; set; } public long? Version { get; set; } #endregion secret diff --git a/Timeline/Models/Validation/NicknameValidator.cs b/Timeline/Models/Validation/NicknameValidator.cs new file mode 100644 index 00000000..f6626a2a --- /dev/null +++ b/Timeline/Models/Validation/NicknameValidator.cs @@ -0,0 +1,26 @@ +using System; +using static Timeline.Resources.Models.Validation.NicknameValidator; + +namespace Timeline.Models.Validation +{ + public class NicknameValidator : Validator + { + [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "Already checked in base.")] + protected override (bool, string) DoValidate(string value) + { + if (value.Length > 10) + return (false, MessageTooLong); + + return (true, GetSuccessMessage()); + } + } + + [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Parameter, AllowMultiple = false)] + public class NicknameAttribute : ValidateWithAttribute + { + public NicknameAttribute() : base(typeof(NicknameValidator)) + { + + } + } +} diff --git a/Timeline/Resources/Messages.zh.resx b/Timeline/Resources/Messages.zh.resx deleted file mode 100644 index 6e52befd..00000000 --- a/Timeline/Resources/Messages.zh.resx +++ /dev/null @@ -1,189 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - text/microsoft-resx - - - 2.0 - - - System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - 请求体太大。它不能超过{0}. - - - 实际的请求体长度比头中指示的大。 - - - 实际的请求体长度比头中指示的小。 - - - 你没有权限做此操作。 - - - 请求头Content-Length缺失或者格式不对。 - - - 请求头Content-Length不能为0。 - - - 请求头Content-Type缺失。 - - - 请求头If-Non-Match格式不对。 - - - 请求模型格式不对。 - - - 第{0}个做{1}操作的用户名格式错误。 - - - 第{0}个做{1}操作的用户不存在。 - - - 要删除的消息不存在。 - - - 用户名或密码错误。 - - - 符号格式错误。这个符号可能不是这个服务器创建的。 - - - 符号是一个旧版本。用户可能已经更新了信息。 - - - 符号过期了。 - - - 用户不存在。管理员可能已经删除了这个用户。 - - - 图片不是正方形。 - - - 解码图片失败。 - - - 图片格式与请求头中指示的不一样。 - - - 要操作的用户不存在。 - - - 旧密码错误。 - - - 新用户名已经存在。 - - \ No newline at end of file diff --git a/Timeline/Resources/Models/Http/Common.zh.resx b/Timeline/Resources/Models/Http/Common.zh.resx deleted file mode 100644 index de74ac3b..00000000 --- a/Timeline/Resources/Models/Http/Common.zh.resx +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - text/microsoft-resx - - - 2.0 - - - System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - 删除了一个项目。 - - - 要删除的项目不存在，什么都没有修改。 - - - 创建了一个新项目。 - - - 修改了一个已存在的项目。 - - \ No newline at end of file diff --git a/Timeline/Resources/Models/Validation/NicknameValidator.Designer.cs b/Timeline/Resources/Models/Validation/NicknameValidator.Designer.cs new file mode 100644 index 00000000..522f305a --- /dev/null +++ b/Timeline/Resources/Models/Validation/NicknameValidator.Designer.cs @@ -0,0 +1,72 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// Runtime Version:4.0.30319.42000 +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +namespace Timeline.Resources.Models.Validation { + using System; + + + /// + /// A strongly-typed resource class, for looking up localized strings, etc. + /// + // This class was auto-generated by the StronglyTypedResourceBuilder + // class via a tool like ResGen or Visual Studio. + // To add or remove a member, edit your .ResX file then rerun ResGen + // with the /str option, or rebuild your VS project. + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")] + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] + internal class NicknameValidator { + + private static global::System.Resources.ResourceManager resourceMan; + + private static global::System.Globalization.CultureInfo resourceCulture; + + [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] + internal NicknameValidator() { + } + + /// + /// Returns the cached ResourceManager instance used by this class. + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Resources.ResourceManager ResourceManager { + get { + if (object.ReferenceEquals(resourceMan, null)) { + global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Timeline.Resources.Models.Validation.NicknameValidator", typeof(NicknameValidator).Assembly); + resourceMan = temp; + } + return resourceMan; + } + } + + /// + /// Overrides the current thread's CurrentUICulture property for all + /// resource lookups using this strongly typed resource class. + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Globalization.CultureInfo Culture { + get { + return resourceCulture; + } + set { + resourceCulture = value; + } + } + + /// + /// Looks up a localized string similar to Nickname is too long.. + /// + internal static string MessageTooLong { + get { + return ResourceManager.GetString("MessageTooLong", resourceCulture); + } + } + } +} diff --git a/Timeline/Resources/Models/Validation/NicknameValidator.resx b/Timeline/Resources/Models/Validation/NicknameValidator.resx new file mode 100644 index 00000000..b191b505 --- /dev/null +++ b/Timeline/Resources/Models/Validation/NicknameValidator.resx @@ -0,0 +1,123 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + Nickname is too long. + + \ No newline at end of file diff --git a/Timeline/Resources/Models/Validation/PasswordValidator.Designer.cs b/Timeline/Resources/Models/Validation/PasswordValidator.Designer.cs deleted file mode 100644 index e7630d26..00000000 --- a/Timeline/Resources/Models/Validation/PasswordValidator.Designer.cs +++ /dev/null @@ -1,72 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// Runtime Version:4.0.30319.42000 -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -namespace Timeline.Resources.Models.Validation { - using System; - - - /// - /// A strongly-typed resource class, for looking up localized strings, etc. - /// - // This class was auto-generated by the StronglyTypedResourceBuilder - // class via a tool like ResGen or Visual Studio. - // To add or remove a member, edit your .ResX file then rerun ResGen - // with the /str option, or rebuild your VS project. - [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")] - [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] - [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] - internal class PasswordValidator { - - private static global::System.Resources.ResourceManager resourceMan; - - private static global::System.Globalization.CultureInfo resourceCulture; - - [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] - internal PasswordValidator() { - } - - /// - /// Returns the cached ResourceManager instance used by this class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Resources.ResourceManager ResourceManager { - get { - if (object.ReferenceEquals(resourceMan, null)) { - global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Timeline.Resources.Models.Validation.PasswordValidator", typeof(PasswordValidator).Assembly); - resourceMan = temp; - } - return resourceMan; - } - } - - /// - /// Overrides the current thread's CurrentUICulture property for all - /// resource lookups using this strongly typed resource class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Globalization.CultureInfo Culture { - get { - return resourceCulture; - } - set { - resourceCulture = value; - } - } - - /// - /// Looks up a localized string similar to Password can't be empty.. - /// - internal static string MessageEmptyString { - get { - return ResourceManager.GetString("MessageEmptyString", resourceCulture); - } - } - } -} diff --git a/Timeline/Resources/Models/Validation/PasswordValidator.resx b/Timeline/Resources/Models/Validation/PasswordValidator.resx deleted file mode 100644 index f445cc75..00000000 --- a/Timeline/Resources/Models/Validation/PasswordValidator.resx +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - text/microsoft-resx - - - 2.0 - - - System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - Password can't be empty. - - \ No newline at end of file diff --git a/Timeline/Resources/Models/Validation/PasswordValidator.zh.resx b/Timeline/Resources/Models/Validation/PasswordValidator.zh.resx deleted file mode 100644 index 9eab7b4e..00000000 --- a/Timeline/Resources/Models/Validation/PasswordValidator.zh.resx +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - text/microsoft-resx - - - 2.0 - - - System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - 密码不能为空。 - - \ No newline at end of file diff --git a/Timeline/Resources/Models/Validation/UsernameValidator.zh.resx b/Timeline/Resources/Models/Validation/UsernameValidator.zh.resx deleted file mode 100644 index 89d519b0..00000000 --- a/Timeline/Resources/Models/Validation/UsernameValidator.zh.resx +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - text/microsoft-resx - - - 2.0 - - - System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - 空字符串是不允许的。 - - - 无效的字符，只能使用字母、数字、下划线和连字符。 - - - 太长了，不能大于26个字符。 - - \ No newline at end of file diff --git a/Timeline/Resources/Models/Validation/Validator.zh.resx b/Timeline/Resources/Models/Validation/Validator.zh.resx deleted file mode 100644 index 2f98e7e3..00000000 --- a/Timeline/Resources/Models/Validation/Validator.zh.resx +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - text/microsoft-resx - - - 2.0 - - - System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - 值不是类型{0}的实例。 - - - 值不能为null. - - - 验证成功。 - - \ No newline at end of file diff --git a/Timeline/Resources/Services/Exception.Designer.cs b/Timeline/Resources/Services/Exception.Designer.cs index 671c4b93..cada1788 100644 --- a/Timeline/Resources/Services/Exception.Designer.cs +++ b/Timeline/Resources/Services/Exception.Designer.cs @@ -114,6 +114,15 @@ namespace Timeline.Resources.Services { } } + /// + /// Looks up a localized string similar to A present resource conflicts with the given resource.. + /// + internal static string ConfictException { + get { + return ResourceManager.GetString("ConfictException", resourceCulture); + } + } + /// /// Looks up a localized string similar to The hashes password is of bad format. It might not be created by server.. /// @@ -312,15 +321,6 @@ namespace Timeline.Resources.Services { } } - /// - /// Looks up a localized string similar to The username already exists.. - /// - internal static string UsernameConfictException { - get { - return ResourceManager.GetString("UsernameConfictException", resourceCulture); - } - } - /// /// Looks up a localized string similar to The user does not exist.. /// diff --git a/Timeline/Resources/Services/Exception.resx b/Timeline/Resources/Services/Exception.resx index 3ae14d4e..2cb0f11a 100644 --- a/Timeline/Resources/Services/Exception.resx +++ b/Timeline/Resources/Services/Exception.resx @@ -135,6 +135,9 @@ The password is wrong. + + A present resource conflicts with the given resource. + The hashes password is of bad format. It might not be created by server. @@ -201,9 +204,6 @@ The use is not a member of the timeline. - - The username already exists. - The user does not exist. diff --git a/Timeline/Resources/Services/UserManager.Designer.cs b/Timeline/Resources/Services/UserManager.Designer.cs deleted file mode 100644 index 424499f8..00000000 --- a/Timeline/Resources/Services/UserManager.Designer.cs +++ /dev/null @@ -1,72 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// Runtime Version:4.0.30319.42000 -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -namespace Timeline.Resources.Services { - using System; - - - /// - /// A strongly-typed resource class, for looking up localized strings, etc. - /// - // This class was auto-generated by the StronglyTypedResourceBuilder - // class via a tool like ResGen or Visual Studio. - // To add or remove a member, edit your .ResX file then rerun ResGen - // with the /str option, or rebuild your VS project. - [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")] - [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] - [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] - internal class UserManager { - - private static global::System.Resources.ResourceManager resourceMan; - - private static global::System.Globalization.CultureInfo resourceCulture; - - [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] - internal UserManager() { - } - - /// - /// Returns the cached ResourceManager instance used by this class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Resources.ResourceManager ResourceManager { - get { - if (object.ReferenceEquals(resourceMan, null)) { - global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Timeline.Resources.Services.UserManager", typeof(UserManager).Assembly); - resourceMan = temp; - } - return resourceMan; - } - } - - /// - /// Overrides the current thread's CurrentUICulture property for all - /// resource lookups using this strongly typed resource class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Globalization.CultureInfo Culture { - get { - return resourceCulture; - } - set { - resourceCulture = value; - } - } - - /// - /// Looks up a localized string similar to A user has been created.. - /// - internal static string LogUserCreate { - get { - return ResourceManager.GetString("LogUserCreate", resourceCulture); - } - } - } -} diff --git a/Timeline/Resources/Services/UserManager.resx b/Timeline/Resources/Services/UserManager.resx deleted file mode 100644 index ecb89179..00000000 --- a/Timeline/Resources/Services/UserManager.resx +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - text/microsoft-resx - - - 2.0 - - - System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - A user has been created. - - \ No newline at end of file diff --git a/Timeline/Resources/Services/UserService.Designer.cs b/Timeline/Resources/Services/UserService.Designer.cs index 1b85546d..cdf7f390 100644 --- a/Timeline/Resources/Services/UserService.Designer.cs +++ b/Timeline/Resources/Services/UserService.Designer.cs @@ -69,6 +69,15 @@ namespace Timeline.Resources.Services { } } + /// + /// Looks up a localized string similar to Nickname is of bad format, because {}.. + /// + internal static string ExceptionNicknameBadFormat { + get { + return ResourceManager.GetString("ExceptionNicknameBadFormat", resourceCulture); + } + } + /// /// Looks up a localized string similar to Old username is of bad format.. /// @@ -88,11 +97,11 @@ namespace Timeline.Resources.Services { } /// - /// Looks up a localized string similar to Password can't be null or empty.. + /// Looks up a localized string similar to Password can't be null.. /// - internal static string ExceptionPasswordNullOrEmpty { + internal static string ExceptionPasswordNull { get { - return ResourceManager.GetString("ExceptionPasswordNullOrEmpty", resourceCulture); + return ResourceManager.GetString("ExceptionPasswordNull", resourceCulture); } } @@ -106,29 +115,20 @@ namespace Timeline.Resources.Services { } /// - /// Looks up a localized string similar to Username can't be null or empty.. - /// - internal static string ExceptionUsernameNullOrEmpty { - get { - return ResourceManager.GetString("ExceptionUsernameNullOrEmpty", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to A cache entry is created.. + /// Looks up a localized string similar to A user with given username already exists.. /// - internal static string LogCacheCreate { + internal static string ExceptionUsernameConflict { get { - return ResourceManager.GetString("LogCacheCreate", resourceCulture); + return ResourceManager.GetString("ExceptionUsernameConflict", resourceCulture); } } /// - /// Looks up a localized string similar to A cache entry is removed.. + /// Looks up a localized string similar to Username can't be null.. /// - internal static string LogCacheRemove { + internal static string ExceptionUsernameNull { get { - return ResourceManager.GetString("LogCacheRemove", resourceCulture); + return ResourceManager.GetString("ExceptionUsernameNull", resourceCulture); } } diff --git a/Timeline/Resources/Services/UserService.resx b/Timeline/Resources/Services/UserService.resx index 26221770..09bd4abb 100644 --- a/Timeline/Resources/Services/UserService.resx +++ b/Timeline/Resources/Services/UserService.resx @@ -120,26 +120,26 @@ New username is of bad format. + + Nickname is of bad format, because {}. + Old username is of bad format. Password can't be empty. - - Password can't be null or empty. + + Password can't be null. Username is of bad format, because {}. - - Username can't be null or empty. - - - A cache entry is created. + + A user with given username already exists. - - A cache entry is removed. + + Username can't be null. A new user entry is added to the database. diff --git a/Timeline/Services/ConfictException.cs b/Timeline/Services/ConfictException.cs new file mode 100644 index 00000000..dcd77366 --- /dev/null +++ b/Timeline/Services/ConfictException.cs @@ -0,0 +1,21 @@ +using System; + +namespace Timeline.Services +{ + /// + /// Thrown when a resource already exists and conflicts with the given resource. + /// + /// + /// For example a username already exists and conflicts with the given username. + /// + [Serializable] + public class ConfictException : Exception + { + public ConfictException() : base(Resources.Services.Exception.ConfictException) { } + public ConfictException(string message) : base(message) { } + public ConfictException(string message, Exception inner) : base(message, inner) { } + protected ConfictException( + System.Runtime.Serialization.SerializationInfo info, + System.Runtime.Serialization.StreamingContext context) : base(info, context) { } + } +} diff --git a/Timeline/Services/UserService.cs b/Timeline/Services/UserService.cs index c5595c99..616e70ba 100644 --- a/Timeline/Services/UserService.cs +++ b/Timeline/Services/UserService.cs @@ -21,7 +21,7 @@ namespace Timeline.Services /// The password of the user to verify. /// The user info and auth info. /// Thrown when or is null. - /// Thrown when username is of bad format. + /// Thrown when is of bad format or is empty. /// Thrown when the user with given username does not exist. /// Thrown when password is wrong. Task VerifyCredential(string username, string password); @@ -48,7 +48,7 @@ namespace Timeline.Services /// List all users. /// /// The user info of users. - Task ListUsers(); + Task GetUsers(); /// /// Create a user with given info. @@ -58,11 +58,12 @@ namespace Timeline.Services /// The id of the new user. /// Thrown when is null. /// Thrown when some fields in is bad. - /// Thrown when a user with given username already exists. + /// Thrown when a user with given username already exists. /// /// must not be null and must be a valid username. /// must not be null or empty. /// is false by default (null). + /// must be a valid nickname if set. It is empty by default. /// Other fields are ignored. /// Task CreateUser(User info); @@ -75,61 +76,70 @@ namespace Timeline.Services /// Thrown when some fields in is bad. /// Thrown when user with given id does not exist. /// - /// Only , and will be used. + /// Only , , and will be used. /// If null, then not change. /// Other fields are ignored. /// After modified, even if nothing is changed, version will increase. /// - /// can't be empty. + /// must be a valid username if set. + /// can't be empty if set. + /// must be a valid nickname if set. /// /// Note: Whether is set or not, version will increase and not set to the specified value if there is one. /// + /// Task ModifyUser(long id, User? info); /// - /// Partially modify a user of given username. + /// Modify a user's info. + /// + /// The username of the user. + /// The new info. May be null. + /// Thrown when is null. + /// Thrown when is of bad format or some fields in is bad. + /// Thrown when user with given id does not exist. + /// + /// Only , and will be used. + /// If null, then not change. + /// Other fields are ignored. + /// After modified, even if nothing is changed, version will increase. + /// + /// must be a valid username if set. + /// can't be empty if set. + /// must be a valid nickname if set. /// - /// Note that whether actually modified or not, Version of the user will always increase. + /// Note: Whether is set or not, version will increase and not set to the specified value if there is one. + /// + /// + Task ModifyUser(string username, User? info); + + /// + /// Delete a user of given id. /// - /// Username of the user to modify. Can't be null. - /// New password. Null if not modify. - /// Whether the user is administrator. Null if not modify. - /// Thrown if is null. - /// Thrown when is of bad format. - /// Thrown if the user with given username does not exist. - Task PatchUser(string username, string? password, bool? administrator); + /// Id of the user to delete. + /// True if user is deleted, false if user not exist. + Task DeleteUser(long id); /// /// Delete a user of given username. /// - /// Username of thet user to delete. Can't be null. + /// Username of the user to delete. Can't be null. + /// True if user is deleted, false if user not exist. /// Thrown if is null. - /// Thrown when is of bad format. - /// Thrown if the user with given username does not exist. - Task DeleteUser(string username); + /// Thrown when is of bad format. + Task DeleteUser(string username); /// /// Try to change a user's password with old password. /// - /// The name of user to change password of. - /// The user's old password. - /// The user's new password. - /// Thrown if or or is null. - /// Thrown when is of bad format. + /// The id of user to change password of. + /// Old password. + /// New password. + /// Thrown if or is null. + /// Thrown if or is empty. /// Thrown if the user with given username does not exist. /// Thrown if the old password is wrong. - Task ChangePassword(string username, string oldPassword, string newPassword); - - /// - /// Change a user's username. - /// - /// The user's old username. - /// The new username. - /// Thrown if or is null. - /// Thrown if the user with old username does not exist. - /// Thrown if the or is of bad format. - /// Thrown if user with the new username already exists. - Task ChangeUsername(string oldUsername, string newUsername); + Task ChangePassword(long id, string oldPassword, string newPassword); } public class UserService : IUserService @@ -138,11 +148,10 @@ namespace Timeline.Services private readonly DatabaseContext _databaseContext; - private readonly IPasswordService _passwordService; private readonly UsernameValidator _usernameValidator = new UsernameValidator(); - + private readonly NicknameValidator _nicknameValidator = new NicknameValidator(); public UserService(ILogger logger, DatabaseContext databaseContext, IPasswordService passwordService) { _logger = logger; @@ -150,17 +159,35 @@ namespace Timeline.Services _passwordService = passwordService; } - private void CheckUsernameFormat(string username, string? paramName, Func? messageBuilder = null) + private void CheckUsernameFormat(string username, string? paramName) { if (!_usernameValidator.Validate(username, out var message)) { - if (messageBuilder == null) - throw new ArgumentException(string.Format(CultureInfo.CurrentCulture, ExceptionUsernameBadFormat, message), paramName); - else - throw new ArgumentException(messageBuilder(message), paramName); + throw new ArgumentException(string.Format(CultureInfo.CurrentCulture, ExceptionUsernameBadFormat, message), paramName); + } + } + + private static void CheckPasswordFormat(string password, string? paramName) + { + if (password.Length == 0) + { + throw new ArgumentException(ExceptionPasswordEmpty, paramName); } } + private void CheckNicknameFormat(string nickname, string? paramName) + { + if (!_nicknameValidator.Validate(nickname, out var message)) + { + throw new ArgumentException(string.Format(CultureInfo.CurrentCulture, ExceptionNicknameBadFormat, message), paramName); + } + } + + private static void ThrowUsernameConflict() + { + throw new ConfictException(ExceptionUsernameConflict); + } + private static User CreateUserFromEntity(UserEntity entity) { return new User @@ -168,6 +195,7 @@ namespace Timeline.Services Username = entity.Username, Administrator = UserRoleConvert.ToBool(entity.Roles), Nickname = string.IsNullOrEmpty(entity.Nickname) ? entity.Username : entity.Nickname, + Id = entity.Id, Version = entity.Version }; } @@ -180,6 +208,7 @@ namespace Timeline.Services throw new ArgumentNullException(nameof(password)); CheckUsernameFormat(username, nameof(username)); + CheckPasswordFormat(password, nameof(password)); var entity = await _databaseContext.Users.Where(u => u.Username == username).SingleOrDefaultAsync(); @@ -217,7 +246,7 @@ namespace Timeline.Services return CreateUserFromEntity(entity); } - public async Task ListUsers() + public async Task GetUsers() { var entities = await _databaseContext.Users.ToArrayAsync(); return entities.Select(user => CreateUserFromEntity(user)).ToArray(); @@ -228,20 +257,22 @@ namespace Timeline.Services if (info == null) throw new ArgumentNullException(nameof(info)); - if (string.IsNullOrEmpty(info.Username)) - throw new ArgumentException(ExceptionUsernameNullOrEmpty, nameof(info)); - + if (info.Username == null) + throw new ArgumentException(ExceptionUsernameNull, nameof(info)); CheckUsernameFormat(info.Username, nameof(info)); - if (string.IsNullOrEmpty(info.Password)) - throw new ArgumentException(ExceptionPasswordNullOrEmpty); + if (info.Password == null) + throw new ArgumentException(ExceptionPasswordNull, nameof(info)); + CheckPasswordFormat(info.Password, nameof(info)); + + if (info.Nickname != null) + CheckNicknameFormat(info.Nickname, nameof(info)); var username = info.Username; var conflict = await _databaseContext.Users.AnyAsync(u => u.Username == username); - if (conflict) - throw new UsernameConfictException(username); + ThrowUsernameConflict(); var administrator = info.Administrator ?? false; var password = info.Password; @@ -262,17 +293,35 @@ namespace Timeline.Services return newEntity.Id; } - public async Task ModifyUser(long id, User? info) + private void ValidateModifyUserInfo(User? info) { - if (info != null && info.Password != null && info.Password.Length == 0) - throw new ArgumentException(ExceptionPasswordEmpty, nameof(info)); + if (info != null) + { + if (info.Username != null) + CheckUsernameFormat(info.Username, nameof(info)); - var entity = await _databaseContext.Users.Where(u => u.Id == id).SingleOrDefaultAsync(); - if (entity == null) - throw new UserNotExistException(id); + if (info.Password != null) + CheckPasswordFormat(info.Password, nameof(info)); + + if (info.Nickname != null) + CheckNicknameFormat(info.Nickname, nameof(info)); + } + } + private async Task UpdateUserEntity(UserEntity entity, User? info) + { if (info != null) { + var username = info.Username; + if (username != null) + { + var conflict = await _databaseContext.Users.AnyAsync(u => u.Username == username); + if (conflict) + ThrowUsernameConflict(); + + entity.Username = username; + } + var password = info.Password; if (password != null) { @@ -293,82 +342,90 @@ namespace Timeline.Services } entity.Version += 1; + } + + + public async Task ModifyUser(long id, User? info) + { + ValidateModifyUserInfo(info); + + var entity = await _databaseContext.Users.Where(u => u.Id == id).SingleOrDefaultAsync(); + if (entity == null) + throw new UserNotExistException(id); + + await UpdateUserEntity(entity, info); await _databaseContext.SaveChangesAsync(); _logger.LogInformation(LogDatabaseUpdate, ("Id", id)); } - public async Task DeleteUser(string username) + public async Task ModifyUser(string username, User? info) { if (username == null) throw new ArgumentNullException(nameof(username)); - CheckUsernameFormat(username); + CheckUsernameFormat(username, nameof(username)); - var user = await _databaseContext.Users.Where(u => u.Username == username).SingleOrDefaultAsync(); - if (user == null) + ValidateModifyUserInfo(info); + + var entity = await _databaseContext.Users.Where(u => u.Username == username).SingleOrDefaultAsync(); + if (entity == null) throw new UserNotExistException(username); - _databaseContext.Users.Remove(user); + await UpdateUserEntity(entity, info); + await _databaseContext.SaveChangesAsync(); - _logger.LogInformation(Log.Format(Resources.Services.UserService.LogDatabaseRemove, - ("Id", user.Id))); + _logger.LogInformation(LogDatabaseUpdate, ("Username", username)); + } + + public async Task DeleteUser(long id) + { + var user = await _databaseContext.Users.Where(u => u.Id == id).SingleOrDefaultAsync(); + if (user == null) + return false; - //clear cache - await _cache.RemoveCache(user.Id); + _databaseContext.Users.Remove(user); + await _databaseContext.SaveChangesAsync(); + _logger.LogInformation(Log.Format(LogDatabaseRemove, ("Id", id), ("Username", user.Username))); + return true; } - public async Task ChangePassword(string username, string oldPassword, string newPassword) + public async Task DeleteUser(string username) { if (username == null) throw new ArgumentNullException(nameof(username)); - if (oldPassword == null) - throw new ArgumentNullException(nameof(oldPassword)); - if (newPassword == null) - throw new ArgumentNullException(nameof(newPassword)); - CheckUsernameFormat(username); + CheckUsernameFormat(username, nameof(username)); var user = await _databaseContext.Users.Where(u => u.Username == username).SingleOrDefaultAsync(); if (user == null) - throw new UserNotExistException(username); - - var verifyResult = _passwordService.VerifyPassword(user.Password, oldPassword); - if (!verifyResult) - throw new BadPasswordException(oldPassword); + return false; - user.Password = _passwordService.HashPassword(newPassword); - user.Version += 1; + _databaseContext.Users.Remove(user); await _databaseContext.SaveChangesAsync(); - _logger.LogInformation(Log.Format(Resources.Services.UserService.LogDatabaseUpdate, - ("Id", user.Id), ("Operation", "Change password"))); - //clear cache - await _cache.RemoveCache(user.Id); + _logger.LogInformation(Log.Format(LogDatabaseRemove, ("Id", user.Id), ("Username", username))); + return true; } - public async Task ChangeUsername(string oldUsername, string newUsername) + public async Task ChangePassword(long id, string oldPassword, string newPassword) { - if (oldUsername == null) - throw new ArgumentNullException(nameof(oldUsername)); - if (newUsername == null) - throw new ArgumentNullException(nameof(newUsername)); - CheckUsernameFormat(oldUsername, Resources.Services.UserService.ExceptionOldUsernameBadFormat); - CheckUsernameFormat(newUsername, Resources.Services.UserService.ExceptionNewUsernameBadFormat); - - var user = await _databaseContext.Users.Where(u => u.Username == oldUsername).SingleOrDefaultAsync(); - if (user == null) - throw new UserNotExistException(oldUsername); + if (oldPassword == null) + throw new ArgumentNullException(nameof(oldPassword)); + if (newPassword == null) + throw new ArgumentNullException(nameof(newPassword)); + CheckPasswordFormat(oldPassword, nameof(oldPassword)); + CheckPasswordFormat(newPassword, nameof(newPassword)); - var conflictUser = await _databaseContext.Users.Where(u => u.Username == newUsername).SingleOrDefaultAsync(); - if (conflictUser != null) - throw new UsernameConfictException(newUsername); + var entity = await _databaseContext.Users.Where(u => u.Id == id).SingleOrDefaultAsync(); - user.Username = newUsername; - user.Version += 1; - await _databaseContext.SaveChangesAsync(); - _logger.LogInformation(Log.Format(Resources.Services.UserService.LogDatabaseUpdate, - ("Id", user.Id), ("Old Username", oldUsername), ("New Username", newUsername))); - await _cache.RemoveCache(user.Id); - } + if (entity == null) + throw new UserNotExistException(id); + if (!_passwordService.VerifyPassword(entity.Password, oldPassword)) + throw new BadPasswordException(oldPassword); + entity.Password = _passwordService.HashPassword(newPassword); + entity.Version += 1; + await _databaseContext.SaveChangesAsync(); + _logger.LogInformation(Log.Format(LogDatabaseUpdate, ("Id", id), ("Operation", "Change password"))); + } } } diff --git a/Timeline/Services/UserTokenException.cs b/Timeline/Services/UserTokenException.cs index e63305b1..ed0bae1a 100644 --- a/Timeline/Services/UserTokenException.cs +++ b/Timeline/Services/UserTokenException.cs @@ -1,7 +1,4 @@ using System; -using System.Collections.Generic; -using System.Linq; -using System.Threading.Tasks; namespace Timeline.Services { diff --git a/Timeline/Services/UserTokenManager.cs b/Timeline/Services/UserTokenManager.cs index a2c2980d..3e9ef3d4 100644 --- a/Timeline/Services/UserTokenManager.cs +++ b/Timeline/Services/UserTokenManager.cs @@ -62,7 +62,7 @@ namespace Timeline.Services throw new ArgumentNullException(nameof(password)); var user = await _userService.VerifyCredential(username, password); - var token = _userTokenService.GenerateToken(new UserTokenInfo { Id = user.Id, Version = user.Version, ExpireAt = expireAt }); + var token = _userTokenService.GenerateToken(new UserTokenInfo { Id = user.Id!.Value, Version = user.Version!.Value, ExpireAt = expireAt }); return new UserTokenCreateResult { Token = token, User = user }; } @@ -85,7 +85,7 @@ namespace Timeline.Services var user = await _userService.GetUserById(tokenInfo.Id); if (tokenInfo.Version < user.Version) - throw new UserTokenBadVersionException(token, tokenInfo.Version, user.Version); + throw new UserTokenBadVersionException(token, tokenInfo.Version, user.Version.Value); return user; } diff --git a/Timeline/Services/UsernameConfictException.cs b/Timeline/Services/UsernameConfictException.cs deleted file mode 100644 index fde1eda6..00000000 --- a/Timeline/Services/UsernameConfictException.cs +++ /dev/null @@ -1,25 +0,0 @@ -using System; -using Timeline.Helpers; - -namespace Timeline.Services -{ - /// - /// Thrown when the user already exists. - /// - [Serializable] - public class UsernameConfictException : Exception - { - public UsernameConfictException() : base(Resources.Services.Exception.UsernameConfictException) { } - public UsernameConfictException(string username) : base(Log.Format(Resources.Services.Exception.UsernameConfictException, ("Username", username))) { Username = username; } - public UsernameConfictException(string username, string message) : base(message) { Username = username; } - public UsernameConfictException(string message, Exception inner) : base(message, inner) { } - protected UsernameConfictException( - System.Runtime.Serialization.SerializationInfo info, - System.Runtime.Serialization.StreamingContext context) : base(info, context) { } - - /// - /// The username that already exists. - /// - public string? Username { get; set; } - } -} diff --git a/Timeline/Startup.cs b/Timeline/Startup.cs index 379ce6ea..091a16e5 100644 --- a/Timeline/Startup.cs +++ b/Timeline/Startup.cs @@ -1,14 +1,11 @@ using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; using Microsoft.AspNetCore.HttpOverrides; -using Microsoft.AspNetCore.Localization; using Microsoft.EntityFrameworkCore; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; using System; -using System.Collections.Generic; -using System.Globalization; using System.Text.Json.Serialization; using Timeline.Auth; using Timeline.Configs; @@ -89,7 +86,6 @@ namespace Timeline services.AddTransient(); services.AddTransient(); services.AddUserAvatarService(); - services.AddScoped(); services.AddScoped(); @@ -113,8 +109,6 @@ namespace Timeline options.UseMySql(databaseConfig.ConnectionString); }); } - - services.AddMemoryCache(); } @@ -128,19 +122,6 @@ namespace Timeline app.UseRouting(); - var supportedCultures = new List - { - new CultureInfo("en"), - new CultureInfo("zh") - }; - - app.UseRequestLocalization(new RequestLocalizationOptions - { - DefaultRequestCulture = new RequestCulture("en"), - SupportedCultures = supportedCultures, - SupportedUICultures = supportedCultures - }); - app.UseCors(); app.UseAuthentication(); diff --git a/Timeline/Timeline.csproj b/Timeline/Timeline.csproj index 195252d9..82b45094 100644 --- a/Timeline/Timeline.csproj +++ b/Timeline/Timeline.csproj @@ -82,10 +82,10 @@ True Common.resx - + True True - PasswordValidator.resx + NicknameValidator.resx True @@ -117,11 +117,6 @@ True UserDetailService.resx - - True - True - UserManager.resx - True True @@ -167,9 +162,9 @@ ResXFileCodeGenerator Common.Designer.cs - + ResXFileCodeGenerator - PasswordValidator.Designer.cs + NicknameValidator.Designer.cs ResXFileCodeGenerator @@ -195,10 +190,6 @@ ResXFileCodeGenerator UserDetailService.Designer.cs - - ResXFileCodeGenerator - UserManager.Designer.cs - ResXFileCodeGenerator UserService.Designer.cs -- cgit v1.2.3 From abde51b167f17301c25e32ae247e7909c0dc9367 Mon Sep 17 00:00:00 2001 From: crupest Date: Wed, 29 Jan 2020 23:13:15 +0800 Subject: ... --- Timeline/Controllers/ControllerAuthExtensions.cs | 30 +++++++ Timeline/Controllers/UserController.cs | 99 +++++++++++++----------- Timeline/Models/Http/User.cs | 41 ---------- Timeline/Models/Http/UserController.cs | 27 +++++++ Timeline/Models/PutResult.cs | 17 ---- Timeline/Models/User.cs | 20 ----- Timeline/Models/UserRoleConvert.cs | 44 ----------- Timeline/Resources/Messages.Designer.cs | 36 +++++++++ Timeline/Resources/Messages.resx | 12 +++ Timeline/Services/User.cs | 49 ++++++++++++ Timeline/Services/UserRoleConvert.cs | 44 +++++++++++ Timeline/Services/UserService.cs | 1 - 12 files changed, 250 insertions(+), 170 deletions(-) create mode 100644 Timeline/Controllers/ControllerAuthExtensions.cs delete mode 100644 Timeline/Models/Http/User.cs create mode 100644 Timeline/Models/Http/UserController.cs delete mode 100644 Timeline/Models/PutResult.cs delete mode 100644 Timeline/Models/User.cs delete mode 100644 Timeline/Models/UserRoleConvert.cs create mode 100644 Timeline/Services/User.cs create mode 100644 Timeline/Services/UserRoleConvert.cs (limited to 'Timeline/Controllers/UserController.cs') diff --git a/Timeline/Controllers/ControllerAuthExtensions.cs b/Timeline/Controllers/ControllerAuthExtensions.cs new file mode 100644 index 00000000..81fd2428 --- /dev/null +++ b/Timeline/Controllers/ControllerAuthExtensions.cs @@ -0,0 +1,30 @@ +using Microsoft.AspNetCore.Mvc; +using System.Security.Claims; +using Timeline.Auth; +using System; + +namespace Timeline.Controllers +{ + public static class ControllerAuthExtensions + { + public static bool IsAdministrator(this ControllerBase controller) + { + return controller.User != null && controller.User.IsAdministrator(); + } + + public static long GetUserId(this ControllerBase controller) + { + if (controller.User == null) + throw new InvalidOperationException("Failed to get user id because User is null."); + + var claim = controller.User.FindFirst(ClaimTypes.NameIdentifier); + if (claim == null) + throw new InvalidOperationException("Failed to get user id because User has no NameIdentifier claim."); + + if (long.TryParse(claim.Value, out var value)) + return value; + + throw new InvalidOperationException("Failed to get user id because NameIdentifier claim is not a number."); + } + } +} diff --git a/Timeline/Controllers/UserController.cs b/Timeline/Controllers/UserController.cs index 3305952a..4c585198 100644 --- a/Timeline/Controllers/UserController.cs +++ b/Timeline/Controllers/UserController.cs @@ -1,15 +1,16 @@ using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Logging; -using System; +using System.Linq; using System.Threading.Tasks; using Timeline.Auth; using Timeline.Helpers; -using Timeline.Models; using Timeline.Models.Http; using Timeline.Models.Validation; using Timeline.Services; using static Timeline.Resources.Controllers.UserController; +using static Timeline.Resources.Messages; namespace Timeline.Controllers { @@ -26,19 +27,20 @@ namespace Timeline.Controllers _userService = userService; } - [HttpGet("users"), AdminAuthorize] + [HttpGet("users")] public async Task> List() { - return Ok(await _userService.GetUsers()); + var users = await _userService.GetUsers(); + return Ok(users.Select(u => u.EraseSecretAndFinalFill(Url, this.IsAdministrator())).ToArray()); } - [HttpGet("users/{username}"), AdminAuthorize] + [HttpGet("users/{username}")] public async Task> Get([FromRoute][Username] string username) { try { var user = await _userService.GetUserByUsername(username); - return Ok(user); + return Ok(user.EraseSecretAndFinalFill(Url, this.IsAdministrator())); } catch (UserNotExistException e) { @@ -47,33 +49,53 @@ namespace Timeline.Controllers } } - [HttpPut("users/{username}"), AdminAuthorize] - public async Task> Put([FromBody] UserPutRequest request, [FromRoute][Username] string username) + [HttpPatch("users/{username}"), Authorize] + public async Task Patch([FromBody] UserPatchRequest body, [FromRoute][Username] string username) { - var result = await _userService.PutUser(username, request.Password, request.Administrator!.Value); - switch (result) + static User Convert(UserPatchRequest body) { - case PutResult.Create: - return CreatedAtAction("Get", new { username }, CommonPutResponse.Create()); - case PutResult.Modify: - return Ok(CommonPutResponse.Modify()); - default: - throw new Exception(ExceptionUnknownPutResult); + return new User + { + Username = body.Username, + Password = body.Password, + Administrator = body.Administrator, + Nickname = body.Nickname + }; } - } - [HttpPatch("users/{username}"), AdminAuthorize] - public async Task Patch([FromBody] UserPatchRequest request, [FromRoute][Username] string username) - { - try + if (this.IsAdministrator()) { - await _userService.PatchUser(username, request.Password, request.Administrator); - return Ok(); + try + { + await _userService.ModifyUser(username, Convert(body)); + return Ok(); + } + catch (UserNotExistException e) + { + _logger.LogInformation(e, Log.Format(LogPatchUserNotExist, ("Username", username))); + return NotFound(ErrorResponse.UserCommon.NotExist()); + } } - catch (UserNotExistException e) + else { - _logger.LogInformation(e, Log.Format(LogPatchUserNotExist, ("Username", username))); - return NotFound(ErrorResponse.UserCommon.NotExist()); + if (User.Identity.Name != username) + return StatusCode(StatusCodes.Status403Forbidden, + ErrorResponse.Common.CustomMessage_Forbid(Common_Forbid_NotSelf)); + + if (body.Username != null) + return StatusCode(StatusCodes.Status403Forbidden, + ErrorResponse.Common.CustomMessage_Forbid(UserController_Patch_Forbid_Username)); + + if (body.Password != null) + return StatusCode(StatusCodes.Status403Forbidden, + ErrorResponse.Common.CustomMessage_Forbid(UserController_Patch_Forbid_Password)); + + if (body.Administrator != null) + return StatusCode(StatusCodes.Status403Forbidden, + ErrorResponse.Common.CustomMessage_Forbid(UserController_Patch_Forbid_Administrator)); + + await _userService.ModifyUser(this.GetUserId(), Convert(body)); + return Ok(); } } @@ -91,27 +113,10 @@ namespace Timeline.Controllers } } - [HttpPost("userop/changeusername"), AdminAuthorize] - public async Task ChangeUsername([FromBody] ChangeUsernameRequest request) + [HttpPost("userop/create"), AdminAuthorize] + public async Task CreateUser([FromBody] User body) { - try - { - await _userService.ChangeUsername(request.OldUsername, request.NewUsername); - return Ok(); - } - catch (UserNotExistException e) - { - _logger.LogInformation(e, Log.Format(LogChangeUsernameNotExist, - ("Old Username", request.OldUsername), ("New Username", request.NewUsername))); - return BadRequest(ErrorResponse.UserCommon.NotExist()); - } - catch (ConfictException e) - { - _logger.LogInformation(e, Log.Format(LogChangeUsernameConflict, - ("Old Username", request.OldUsername), ("New Username", request.NewUsername))); - return BadRequest(ErrorResponse.UserController.ChangeUsername_Conflict()); - } - // there is no need to catch bad format exception because it is already checked in model validation. + } [HttpPost("userop/changepassword"), Authorize] @@ -119,7 +124,7 @@ namespace Timeline.Controllers { try { - await _userService.ChangePassword(User.Identity.Name!, request.OldPassword, request.NewPassword); + await _userService.ChangePassword(this.GetUserId(), request.OldPassword, request.NewPassword); return Ok(); } catch (BadPasswordException e) diff --git a/Timeline/Models/Http/User.cs b/Timeline/Models/Http/User.cs deleted file mode 100644 index b3812f48..00000000 --- a/Timeline/Models/Http/User.cs +++ /dev/null @@ -1,41 +0,0 @@ -using System; -using System.ComponentModel.DataAnnotations; -using Timeline.Models.Validation; - -namespace Timeline.Models.Http -{ - [Obsolete("Remove this.")] - public class UserPutRequest - { - [Required] - public string Password { get; set; } = default!; - [Required] - public bool? Administrator { get; set; } - } - - [Obsolete("Remove this.")] - public class UserPatchRequest - { - public string? Password { get; set; } - public bool? Administrator { get; set; } - } - - public class ChangeUsernameRequest - { - [Required] - [Username] - public string OldUsername { get; set; } = default!; - - [Required] - [Username] - public string NewUsername { get; set; } = default!; - } - - public class ChangePasswordRequest - { - [Required] - public string OldPassword { get; set; } = default!; - [Required] - public string NewPassword { get; set; } = default!; - } -} diff --git a/Timeline/Models/Http/UserController.cs b/Timeline/Models/Http/UserController.cs new file mode 100644 index 00000000..229ca1e5 --- /dev/null +++ b/Timeline/Models/Http/UserController.cs @@ -0,0 +1,27 @@ +using System.ComponentModel.DataAnnotations; +using Timeline.Models.Validation; + +namespace Timeline.Models.Http +{ + public class UserPatchRequest + { + [Username] + public string? Username { get; set; } + + [MinLength(1)] + public string? Password { get; set; } + + [Nickname] + public string? Nickname { get; set; } + + public bool? Administrator { get; set; } + } + + public class ChangePasswordRequest + { + [Required(AllowEmptyStrings = false)] + public string OldPassword { get; set; } = default!; + [Required(AllowEmptyStrings = false)] + public string NewPassword { get; set; } = default!; + } +} diff --git a/Timeline/Models/PutResult.cs b/Timeline/Models/PutResult.cs deleted file mode 100644 index cecf86e6..00000000 --- a/Timeline/Models/PutResult.cs +++ /dev/null @@ -1,17 +0,0 @@ -namespace Timeline.Models -{ - /// - /// Represents the result of a "put" operation. - /// - public enum PutResult - { - /// - /// Indicates the item did not exist and now is created. - /// - Create, - /// - /// Indicates the item exists already and is modified. - /// - Modify - } -} diff --git a/Timeline/Models/User.cs b/Timeline/Models/User.cs deleted file mode 100644 index 2cead892..00000000 --- a/Timeline/Models/User.cs +++ /dev/null @@ -1,20 +0,0 @@ -using Timeline.Models.Validation; - -namespace Timeline.Models -{ - public class User - { - [Username] - public string? Username { get; set; } - public bool? Administrator { get; set; } - public string? Nickname { get; set; } - public string? AvatarUrl { get; set; } - - - #region secret - public long? Id { get; set; } - public string? Password { get; set; } - public long? Version { get; set; } - #endregion secret - } -} diff --git a/Timeline/Models/UserRoleConvert.cs b/Timeline/Models/UserRoleConvert.cs deleted file mode 100644 index ade9a799..00000000 --- a/Timeline/Models/UserRoleConvert.cs +++ /dev/null @@ -1,44 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using Timeline.Entities; - -namespace Timeline.Models -{ - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "No need.")] - public static class UserRoleConvert - { - public const string UserRole = UserRoles.User; - public const string AdminRole = UserRoles.Admin; - - public static string[] ToArray(bool administrator) - { - return administrator ? new string[] { UserRole, AdminRole } : new string[] { UserRole }; - } - - public static string[] ToArray(string s) - { - return s.Split(',').ToArray(); - } - - public static bool ToBool(IReadOnlyCollection roles) - { - return roles.Contains(AdminRole); - } - - public static string ToString(IReadOnlyCollection roles) - { - return string.Join(',', roles); - } - - public static string ToString(bool administrator) - { - return administrator ? UserRole + "," + AdminRole : UserRole; - } - - public static bool ToBool(string s) - { - return s.Contains("admin", StringComparison.InvariantCulture); - } - } -} diff --git a/Timeline/Resources/Messages.Designer.cs b/Timeline/Resources/Messages.Designer.cs index 8c13374f..15101661 100644 --- a/Timeline/Resources/Messages.Designer.cs +++ b/Timeline/Resources/Messages.Designer.cs @@ -96,6 +96,15 @@ namespace Timeline.Resources { } } + /// + /// Looks up a localized string similar to You are not the resource owner.. + /// + internal static string Common_Forbid_NotSelf { + get { + return ResourceManager.GetString("Common_Forbid_NotSelf", resourceCulture); + } + } + /// /// Looks up a localized string similar to Header Content-Length is missing or of bad format.. /// @@ -266,5 +275,32 @@ namespace Timeline.Resources { return ResourceManager.GetString("UserController_ChangeUsername_Conflict", resourceCulture); } } + + /// + /// Looks up a localized string similar to You can't set permission unless you are administrator.. + /// + internal static string UserController_Patch_Forbid_Administrator { + get { + return ResourceManager.GetString("UserController_Patch_Forbid_Administrator", resourceCulture); + } + } + + /// + /// Looks up a localized string similar to You can't set password unless you are administrator. If you want to change password, use /userop/changepassword .. + /// + internal static string UserController_Patch_Forbid_Password { + get { + return ResourceManager.GetString("UserController_Patch_Forbid_Password", resourceCulture); + } + } + + /// + /// Looks up a localized string similar to You can't set username unless you are administrator.. + /// + internal static string UserController_Patch_Forbid_Username { + get { + return ResourceManager.GetString("UserController_Patch_Forbid_Username", resourceCulture); + } + } } } diff --git a/Timeline/Resources/Messages.resx b/Timeline/Resources/Messages.resx index c5228ed5..db56ed02 100644 --- a/Timeline/Resources/Messages.resx +++ b/Timeline/Resources/Messages.resx @@ -129,6 +129,9 @@ You have no permission to do the operation. + + You are not the resource owner. + Header Content-Length is missing or of bad format. @@ -186,4 +189,13 @@ The new username already exists. + + You can't set permission unless you are administrator. + + + You can't set password unless you are administrator. If you want to change password, use /userop/changepassword . + + + You can't set username unless you are administrator. + \ No newline at end of file diff --git a/Timeline/Services/User.cs b/Timeline/Services/User.cs new file mode 100644 index 00000000..f63a374e --- /dev/null +++ b/Timeline/Services/User.cs @@ -0,0 +1,49 @@ +using Microsoft.AspNetCore.Mvc; +using System; +using Timeline.Controllers; + +namespace Timeline.Services +{ + public class User + { + public string? Username { get; set; } + public string? Nickname { get; set; } + public string? AvatarUrl { get; set; } + + #region adminsecret + public bool? Administrator { get; set; } + #endregion adminsecret + + #region secret + public long? Id { get; set; } + public string? Password { get; set; } + public long? Version { get; set; } + #endregion secret + } + + public static class UserExtensions + { + public static User EraseSecretAndFinalFill(this User user, IUrlHelper urlHelper, bool adminstrator) + { + if (user == null) + throw new ArgumentNullException(nameof(user)); + + var result = new User + { + Username = user.Username, + Nickname = user.Nickname, + AvatarUrl = urlHelper.ActionLink(action: nameof(UserAvatarController.Get), controller: nameof(UserAvatarController), values: new + { + user.Username + }) + }; + + if (adminstrator) + { + result.Administrator = user.Administrator; + } + + return result; + } + } +} diff --git a/Timeline/Services/UserRoleConvert.cs b/Timeline/Services/UserRoleConvert.cs new file mode 100644 index 00000000..4fa4a7b8 --- /dev/null +++ b/Timeline/Services/UserRoleConvert.cs @@ -0,0 +1,44 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using Timeline.Entities; + +namespace Timeline.Services +{ + [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "No need.")] + public static class UserRoleConvert + { + public const string UserRole = UserRoles.User; + public const string AdminRole = UserRoles.Admin; + + public static string[] ToArray(bool administrator) + { + return administrator ? new string[] { UserRole, AdminRole } : new string[] { UserRole }; + } + + public static string[] ToArray(string s) + { + return s.Split(',').ToArray(); + } + + public static bool ToBool(IReadOnlyCollection roles) + { + return roles.Contains(AdminRole); + } + + public static string ToString(IReadOnlyCollection roles) + { + return string.Join(',', roles); + } + + public static string ToString(bool administrator) + { + return administrator ? UserRole + "," + AdminRole : UserRole; + } + + public static bool ToBool(string s) + { + return s.Contains("admin", StringComparison.InvariantCulture); + } + } +} diff --git a/Timeline/Services/UserService.cs b/Timeline/Services/UserService.cs index 616e70ba..ff2306c5 100644 --- a/Timeline/Services/UserService.cs +++ b/Timeline/Services/UserService.cs @@ -6,7 +6,6 @@ using System.Linq; using System.Threading.Tasks; using Timeline.Entities; using Timeline.Helpers; -using Timeline.Models; using Timeline.Models.Validation; using static Timeline.Resources.Services.UserService; -- cgit v1.2.3 From 52acf41e331ddbd66befed4692c804b754ba7d5c Mon Sep 17 00:00:00 2001 From: crupest Date: Thu, 30 Jan 2020 20:26:52 +0800 Subject: ... --- Timeline.ErrorCodes/ErrorCodes.cs | 4 +- .../Controllers/PersonalTimelineControllerTest.cs | 388 ------------------- Timeline.Tests/Controllers/TokenControllerTest.cs | 135 ------- Timeline.Tests/Controllers/UserControllerTest.cs | 228 ----------- .../Controllers/UserDetailControllerTest.cs | 98 ----- Timeline.Tests/DatabaseTest.cs | 63 --- Timeline.Tests/GlobalSuppressions.cs | 2 + Timeline.Tests/Helpers/MockUser.cs | 24 -- Timeline.Tests/Helpers/PrincipalHelper.cs | 23 -- Timeline.Tests/Helpers/ResponseAssertions.cs | 14 +- Timeline.Tests/Helpers/TestApplication.cs | 15 +- Timeline.Tests/Helpers/TestClock.cs | 15 - Timeline.Tests/Helpers/TestDatabase.cs | 89 ----- Timeline.Tests/Helpers/UseCultureAttribute.cs | 94 ----- .../IntegratedTests/AuthorizationTest.cs | 4 +- Timeline.Tests/IntegratedTests/I18nTest.cs | 59 --- .../IntegratedTests/IntegratedTestBase.cs | 117 ++++-- .../IntegratedTests/PersonalTimelineTest.cs | 37 +- Timeline.Tests/IntegratedTests/TokenTest.cs | 18 +- Timeline.Tests/IntegratedTests/UserAvatarTest.cs | 45 ++- Timeline.Tests/IntegratedTests/UserDetailTest.cs | 154 -------- Timeline.Tests/IntegratedTests/UserTest.cs | 427 ++++++++++++++------- Timeline.Tests/Services/UserAvatarServiceTest.cs | 280 -------------- Timeline.Tests/Services/UserDetailServiceTest.cs | 107 ------ Timeline.Tests/Services/UserTokenManagerTest.cs | 163 -------- Timeline.Tests/Timeline.Tests.csproj | 1 - Timeline/Auth/MyAuthenticationHandler.cs | 1 - Timeline/Controllers/ControllerAuthExtensions.cs | 15 + Timeline/Controllers/PersonalTimelineController.cs | 111 +++--- .../Controllers/Testing/TestingI18nController.cs | 36 -- Timeline/Controllers/TokenController.cs | 18 +- Timeline/Controllers/UserAvatarController.cs | 89 +++-- Timeline/Controllers/UserController.cs | 58 +-- Timeline/Entities/DatabaseContext.cs | 2 - Timeline/Entities/TimelineEntity.cs | 2 +- Timeline/Filters/Header.cs | 2 - Timeline/Filters/Timeline.cs | 1 - Timeline/Filters/User.cs | 68 ---- Timeline/Formatters/StringInputFormatter.cs | 1 - Timeline/GlobalSuppressions.cs | 1 + Timeline/Helpers/InvalidModelResponseFactory.cs | 1 - .../Models/Converters/JsonDateTimeConverter.cs | 1 - Timeline/Models/Http/ErrorResponse.cs | 18 +- Timeline/Models/Http/Timeline.cs | 42 -- Timeline/Models/Http/TimelineCommon.cs | 44 +++ Timeline/Models/Http/TimelineController.cs | 20 + Timeline/Models/Http/Token.cs | 32 -- Timeline/Models/Http/TokenController.cs | 32 ++ Timeline/Models/Http/UserController.cs | 26 ++ Timeline/Models/Http/UserInfo.cs | 58 +++ Timeline/Models/Timeline.cs | 55 --- Timeline/Models/Validation/NicknameValidator.cs | 1 - Timeline/Models/Validation/UsernameValidator.cs | 1 - .../Testing/TestingI18nController.Designer.cs | 72 ---- .../Controllers/Testing/TestingI18nController.resx | 123 ------ .../Testing/TestingI18nController.zh.resx | 123 ------ Timeline/Resources/Messages.Designer.cs | 27 +- Timeline/Resources/Messages.resx | 9 +- Timeline/Resources/Services/Exception.Designer.cs | 49 +-- Timeline/Resources/Services/Exception.resx | 17 +- .../Resources/Services/TimelineService.Designer.cs | 81 ++++ Timeline/Resources/Services/TimelineService.resx | 126 ++++++ Timeline/Resources/Services/UserCache.Designer.cs | 99 ----- Timeline/Resources/Services/UserCache.resx | 132 ------- .../Services/UserDetailService.Designer.cs | 99 ----- Timeline/Resources/Services/UserDetailService.resx | 132 ------- Timeline/Services/ConfictException.cs | 21 - Timeline/Services/ConflictException.cs | 21 + Timeline/Services/DatabaseExtensions.cs | 36 -- Timeline/Services/TimelineAlreadyExistException.cs | 17 - .../TimelineMemberOperationUserException.cs | 37 -- .../Services/TimelineNameBadFormatException.cs | 21 - Timeline/Services/TimelineService.cs | 363 ++++++------------ Timeline/Services/User.cs | 33 +- Timeline/Services/UserAvatarService.cs | 48 +-- Timeline/Services/UserRoleConvert.cs | 1 - Timeline/Services/UserService.cs | 36 +- Timeline/Services/UserTokenService.cs | 1 - Timeline/Startup.cs | 12 +- Timeline/Timeline.csproj | 60 ++- 80 files changed, 1232 insertions(+), 3904 deletions(-) delete mode 100644 Timeline.Tests/Controllers/PersonalTimelineControllerTest.cs delete mode 100644 Timeline.Tests/Controllers/TokenControllerTest.cs delete mode 100644 Timeline.Tests/Controllers/UserControllerTest.cs delete mode 100644 Timeline.Tests/Controllers/UserDetailControllerTest.cs delete mode 100644 Timeline.Tests/DatabaseTest.cs delete mode 100644 Timeline.Tests/Helpers/MockUser.cs delete mode 100644 Timeline.Tests/Helpers/PrincipalHelper.cs delete mode 100644 Timeline.Tests/Helpers/TestClock.cs delete mode 100644 Timeline.Tests/Helpers/TestDatabase.cs delete mode 100644 Timeline.Tests/Helpers/UseCultureAttribute.cs delete mode 100644 Timeline.Tests/IntegratedTests/I18nTest.cs delete mode 100644 Timeline.Tests/IntegratedTests/UserDetailTest.cs delete mode 100644 Timeline.Tests/Services/UserAvatarServiceTest.cs delete mode 100644 Timeline.Tests/Services/UserDetailServiceTest.cs delete mode 100644 Timeline.Tests/Services/UserTokenManagerTest.cs delete mode 100644 Timeline/Controllers/Testing/TestingI18nController.cs delete mode 100644 Timeline/Filters/User.cs delete mode 100644 Timeline/Models/Http/Timeline.cs create mode 100644 Timeline/Models/Http/TimelineCommon.cs create mode 100644 Timeline/Models/Http/TimelineController.cs delete mode 100644 Timeline/Models/Http/Token.cs create mode 100644 Timeline/Models/Http/TokenController.cs create mode 100644 Timeline/Models/Http/UserInfo.cs delete mode 100644 Timeline/Models/Timeline.cs delete mode 100644 Timeline/Resources/Controllers/Testing/TestingI18nController.Designer.cs delete mode 100644 Timeline/Resources/Controllers/Testing/TestingI18nController.resx delete mode 100644 Timeline/Resources/Controllers/Testing/TestingI18nController.zh.resx create mode 100644 Timeline/Resources/Services/TimelineService.Designer.cs create mode 100644 Timeline/Resources/Services/TimelineService.resx delete mode 100644 Timeline/Resources/Services/UserCache.Designer.cs delete mode 100644 Timeline/Resources/Services/UserCache.resx delete mode 100644 Timeline/Resources/Services/UserDetailService.Designer.cs delete mode 100644 Timeline/Resources/Services/UserDetailService.resx delete mode 100644 Timeline/Services/ConfictException.cs create mode 100644 Timeline/Services/ConflictException.cs delete mode 100644 Timeline/Services/DatabaseExtensions.cs delete mode 100644 Timeline/Services/TimelineAlreadyExistException.cs delete mode 100644 Timeline/Services/TimelineMemberOperationUserException.cs delete mode 100644 Timeline/Services/TimelineNameBadFormatException.cs (limited to 'Timeline/Controllers/UserController.cs') diff --git a/Timeline.ErrorCodes/ErrorCodes.cs b/Timeline.ErrorCodes/ErrorCodes.cs index 730f42e0..ea74cf0e 100644 --- a/Timeline.ErrorCodes/ErrorCodes.cs +++ b/Timeline.ErrorCodes/ErrorCodes.cs @@ -45,7 +45,7 @@ public static class UserController { - public const int ChangeUsername_Conflict = 1_102_01_01; + public const int UsernameConflict = 1_102_01_01; public const int ChangePassword_BadOldPassword = 1_102_02_01; } @@ -58,7 +58,7 @@ public static class TimelineController { - public const int PostOperationDelete_NotExist = 1_104_01_01; + public const int MemberPut_NotExist = 1_104_01_01; } } } diff --git a/Timeline.Tests/Controllers/PersonalTimelineControllerTest.cs b/Timeline.Tests/Controllers/PersonalTimelineControllerTest.cs deleted file mode 100644 index bbc8ba75..00000000 --- a/Timeline.Tests/Controllers/PersonalTimelineControllerTest.cs +++ /dev/null @@ -1,388 +0,0 @@ -using FluentAssertions; -using Microsoft.AspNetCore.Authorization; -using Microsoft.AspNetCore.Http; -using Microsoft.AspNetCore.Mvc; -using Microsoft.Extensions.Logging.Abstractions; -using Moq; -using System; -using System.Collections.Generic; -using System.Reflection; -using System.Threading.Tasks; -using Timeline.Controllers; -using Timeline.Filters; -using Timeline.Models; -using Timeline.Models.Http; -using Timeline.Models.Validation; -using Timeline.Services; -using Timeline.Tests.Helpers; -using Xunit; - -namespace Timeline.Tests.Controllers -{ - public class PersonalTimelineControllerTest : IDisposable - { - private readonly Mock _service; - - private readonly PersonalTimelineController _controller; - - public PersonalTimelineControllerTest() - { - _service = new Mock(); - _controller = new PersonalTimelineController(NullLogger.Instance, _service.Object); - } - - public void Dispose() - { - _controller.Dispose(); - } - - [Fact] - public void AttributeTest() - { - static void AssertUsernameParameter(MethodInfo m) - { - m.GetParameter("username") - .Should().BeDecoratedWith() - .And.BeDecoratedWith(); - } - - static void AssertBodyParamter(MethodInfo m) - { - var p = m.GetParameter("body"); - p.Should().BeDecoratedWith(); - p.ParameterType.Should().Be(typeof(TBody)); - } - - var type = typeof(PersonalTimelineController); - type.Should().BeDecoratedWith(); - - { - var m = type.GetMethod(nameof(PersonalTimelineController.TimelineGet)); - m.Should().BeDecoratedWith() - .And.BeDecoratedWith(); - AssertUsernameParameter(m); - } - - { - var m = type.GetMethod(nameof(PersonalTimelineController.PostListGet)); - m.Should().BeDecoratedWith() - .And.BeDecoratedWith(); - AssertUsernameParameter(m); - } - - { - var m = type.GetMethod(nameof(PersonalTimelineController.PostOperationCreate)); - m.Should().BeDecoratedWith() - .And.BeDecoratedWith() - .And.BeDecoratedWith(); - AssertUsernameParameter(m); - AssertBodyParamter(m); - } - - { - var m = type.GetMethod(nameof(PersonalTimelineController.PostOperationDelete)); - m.Should().BeDecoratedWith() - .And.BeDecoratedWith() - .And.BeDecoratedWith(); - AssertUsernameParameter(m); - AssertBodyParamter(m); - } - - { - var m = type.GetMethod(nameof(PersonalTimelineController.TimelineChangeProperty)); - m.Should().BeDecoratedWith() - .And.BeDecoratedWith() - .And.BeDecoratedWith() - .And.BeDecoratedWith(); - AssertUsernameParameter(m); - AssertBodyParamter(m); - } - - { - var m = type.GetMethod(nameof(PersonalTimelineController.TimelineChangeMember)); - m.Should().BeDecoratedWith() - .And.BeDecoratedWith() - .And.BeDecoratedWith() - .And.BeDecoratedWith(); - AssertUsernameParameter(m); - AssertBodyParamter(m); - } - } - - const string authUsername = "authuser"; - private void SetUser(bool administrator) - { - _controller.ControllerContext = new ControllerContext - { - HttpContext = new DefaultHttpContext - { - User = PrincipalHelper.Create(authUsername, administrator) - } - }; - } - - [Fact] - public async Task TimelineGet() - { - const string username = "username"; - var timelineInfo = new BaseTimelineInfo(); - _service.Setup(s => s.GetTimeline(username)).ReturnsAsync(timelineInfo); - (await _controller.TimelineGet(username)).Value.Should().Be(timelineInfo); - _service.VerifyAll(); - } - - [Fact] - public async Task PostListGet_Forbid() - { - const string username = "username"; - SetUser(false); - _service.Setup(s => s.HasReadPermission(username, authUsername)).ReturnsAsync(false); - var result = (await _controller.PostListGet(username)).Result - .Should().BeAssignableTo() - .Which; - result.StatusCode.Should().Be(StatusCodes.Status403Forbidden); - result.Value.Should().BeAssignableTo() - .Which.Code.Should().Be(ErrorCodes.Common.Forbid); - _service.VerifyAll(); - } - - [Fact] - public async Task PostListGet_Admin_Success() - { - const string username = "username"; - SetUser(true); - _service.Setup(s => s.GetPosts(username)).ReturnsAsync(new List()); - (await _controller.PostListGet(username)).Value - .Should().BeAssignableTo>() - .Which.Should().NotBeNull().And.BeEmpty(); - _service.VerifyAll(); - } - - [Fact] - public async Task PostListGet_User_Success() - { - const string username = "username"; - SetUser(false); - _service.Setup(s => s.HasReadPermission(username, authUsername)).ReturnsAsync(true); - _service.Setup(s => s.GetPosts(username)).ReturnsAsync(new List()); - (await _controller.PostListGet(username)).Value - .Should().BeAssignableTo>() - .Which.Should().NotBeNull().And.BeEmpty(); - _service.VerifyAll(); - } - - [Fact] - public async Task PostOperationCreate_Forbid() - { - const string username = "username"; - const string content = "cccc"; - SetUser(false); - _service.Setup(s => s.IsMemberOf(username, authUsername)).ReturnsAsync(false); - var result = (await _controller.PostOperationCreate(username, new TimelinePostCreateRequest - { - Content = content, - Time = null - })).Result.Should().NotBeNull().And.BeAssignableTo().Which; - result.StatusCode.Should().Be(StatusCodes.Status403Forbidden); - result.Value.Should().BeAssignableTo() - .Which.Code.Should().Be(ErrorCodes.Common.Forbid); - _service.VerifyAll(); - } - - [Fact] - public async Task PostOperationCreate_Admin_Success() - { - const string username = "username"; - const string content = "cccc"; - var response = new TimelinePostCreateResponse - { - Id = 3, - Time = DateTime.Now - }; - SetUser(true); - _service.Setup(s => s.CreatePost(username, authUsername, content, null)).ReturnsAsync(response); - var resultValue = (await _controller.PostOperationCreate(username, new TimelinePostCreateRequest - { - Content = content, - Time = null - })).Value; - resultValue.Should().NotBeNull() - .And.BeAssignableTo() - .And.BeEquivalentTo(response); - _service.VerifyAll(); - } - - [Fact] - public async Task PostOperationCreate_User_Success() - { - const string username = "username"; - const string content = "cccc"; - var response = new TimelinePostCreateResponse - { - Id = 3, - Time = DateTime.Now - }; - SetUser(false); - _service.Setup(s => s.IsMemberOf(username, authUsername)).ReturnsAsync(true); - _service.Setup(s => s.CreatePost(username, authUsername, content, null)).ReturnsAsync(response); - var resultValue = (await _controller.PostOperationCreate(username, new TimelinePostCreateRequest - { - Content = content, - Time = null - })).Value; - resultValue.Should().NotBeNull() - .And.BeAssignableTo() - .And.BeEquivalentTo(response); - _service.VerifyAll(); - } - - [Fact] - public async Task PostOperationDelete_Forbid() - { - const string username = "username"; - const long postId = 2; - SetUser(false); - _service.Setup(s => s.HasPostModifyPermission(username, postId, authUsername)).ReturnsAsync(false); - var result = (await _controller.PostOperationDelete(username, new TimelinePostDeleteRequest - { - Id = postId - })).Should().NotBeNull().And.BeAssignableTo().Which; - result.StatusCode.Should().Be(StatusCodes.Status403Forbidden); - result.Value.Should().BeAssignableTo() - .Which.Code.Should().Be(ErrorCodes.Common.Forbid); - _service.VerifyAll(); - } - - [Fact] - public async Task PostOperationDelete_NotExist() - { - const string username = "username"; - const long postId = 2; - SetUser(true); - _service.Setup(s => s.DeletePost(username, postId)).ThrowsAsync(new TimelinePostNotExistException()); - var result = (await _controller.PostOperationDelete(username, new TimelinePostDeleteRequest - { - Id = postId - })).Should().NotBeNull().And.BeAssignableTo().Which; - result.StatusCode.Should().Be(StatusCodes.Status400BadRequest); - result.Value.Should().BeAssignableTo() - .Which.Code.Should().Be(ErrorCodes.TimelineController.PostOperationDelete_NotExist); - _service.VerifyAll(); - } - - [Fact] - public async Task PostOperationDelete_Admin_Success() - { - const string username = "username"; - const long postId = 2; - SetUser(true); - _service.Setup(s => s.DeletePost(username, postId)).Returns(Task.CompletedTask); - var result = await _controller.PostOperationDelete(username, new TimelinePostDeleteRequest - { - Id = postId - }); - result.Should().NotBeNull().And.BeAssignableTo(); - _service.VerifyAll(); - } - - [Fact] - public async Task PostOperationDelete_User_Success() - { - const string username = "username"; - const long postId = 2; - SetUser(false); - _service.Setup(s => s.DeletePost(username, postId)).Returns(Task.CompletedTask); - _service.Setup(s => s.HasPostModifyPermission(username, postId, authUsername)).ReturnsAsync(true); - var result = await _controller.PostOperationDelete(username, new TimelinePostDeleteRequest - { - Id = postId - }); - result.Should().NotBeNull().And.BeAssignableTo(); - _service.VerifyAll(); - } - - [Fact] - public async Task TimelineChangeProperty_Success() - { - const string username = "username"; - var req = new TimelinePropertyChangeRequest - { - Description = "", - Visibility = TimelineVisibility.Private - }; - _service.Setup(s => s.ChangeProperty(username, req)).Returns(Task.CompletedTask); - var result = await _controller.TimelineChangeProperty(username, req); - result.Should().NotBeNull().And.BeAssignableTo(); - _service.VerifyAll(); - } - - [Fact] - public async Task TimelineChangeMember_Success() - { - const string username = "username"; - var add = new List { "aaa" }; - var remove = new List { "rrr" }; - _service.Setup(s => s.ChangeMember(username, add, remove)).Returns(Task.CompletedTask); - var result = await _controller.TimelineChangeMember(username, new TimelineMemberChangeRequest - { - Add = add, - Remove = remove - }); - result.Should().NotBeNull().And.BeAssignableTo(); - _service.VerifyAll(); - } - - [Fact] - public async Task TimelineChangeMember_UsernameBadFormat() - { - const string username = "username"; - var add = new List { "aaa" }; - var remove = new List { "rrr" }; - _service.Setup(s => s.ChangeMember(username, add, remove)).ThrowsAsync( - new TimelineMemberOperationUserException("test", new UsernameBadFormatException())); - var result = await _controller.TimelineChangeMember(username, new TimelineMemberChangeRequest - { - Add = add, - Remove = remove - }); - result.Should().NotBeNull().And.BeAssignableTo() - .Which.Value.Should().BeAssignableTo() - .Which.Code.Should().Be(ErrorCodes.Common.InvalidModel); - _service.VerifyAll(); - } - - [Fact] - public async Task TimelineChangeMember_AddNotExist() - { - const string username = "username"; - var add = new List { "aaa" }; - var remove = new List { "rrr" }; - _service.Setup(s => s.ChangeMember(username, add, remove)).ThrowsAsync( - new TimelineMemberOperationUserException("test", new UserNotExistException())); - var result = await _controller.TimelineChangeMember(username, new TimelineMemberChangeRequest - { - Add = add, - Remove = remove - }); - result.Should().NotBeNull().And.BeAssignableTo() - .Which.Value.Should().BeAssignableTo() - .Which.Code.Should().Be(ErrorCodes.UserCommon.NotExist); - _service.VerifyAll(); - } - - [Fact] - public async Task TimelineChangeMember_UnknownTimelineMemberOperationUserException() - { - const string username = "username"; - var add = new List { "aaa" }; - var remove = new List { "rrr" }; - _service.Setup(s => s.ChangeMember(username, add, remove)).ThrowsAsync( - new TimelineMemberOperationUserException("test", null)); - await _controller.Awaiting(c => c.TimelineChangeMember(username, new TimelineMemberChangeRequest - { - Add = add, - Remove = remove - })).Should().ThrowAsync(); // Should rethrow. - } - } -} diff --git a/Timeline.Tests/Controllers/TokenControllerTest.cs b/Timeline.Tests/Controllers/TokenControllerTest.cs deleted file mode 100644 index 43e1a413..00000000 --- a/Timeline.Tests/Controllers/TokenControllerTest.cs +++ /dev/null @@ -1,135 +0,0 @@ -using FluentAssertions; -using Microsoft.AspNetCore.Mvc; -using Microsoft.Extensions.Logging.Abstractions; -using Moq; -using System; -using System.Collections.Generic; -using System.Threading.Tasks; -using Timeline.Controllers; -using Timeline.Models; -using Timeline.Models.Http; -using Timeline.Services; -using Timeline.Tests.Helpers; -using Xunit; - -namespace Timeline.Tests.Controllers -{ - public class TokenControllerTest : IDisposable - { - private readonly Mock _mockUserService = new Mock(); - private readonly TestClock _mockClock = new TestClock(); - - - private readonly TokenController _controller; - - public TokenControllerTest() - { - _controller = new TokenController(_mockUserService.Object, NullLogger.Instance, _mockClock); - } - - public void Dispose() - { - _controller.Dispose(); - } - - [Theory] - [InlineData(null)] - [InlineData(100)] - public async Task Create_Ok(int? expire) - { - var mockCurrentTime = DateTime.Now; - _mockClock.MockCurrentTime = mockCurrentTime; - var mockCreateResult = new UserTokenCreateResult - { - Token = "mocktokenaaaaa", - User = new Models.User - { - Id = 1, - Username = MockUser.User.Username, - Administrator = MockUser.User.Administrator, - Version = 1 - } - }; - _mockUserService.Setup(s => s.CreateToken("u", "p", expire == null ? null : (DateTime?)mockCurrentTime.AddDays(expire.Value))).ReturnsAsync(mockCreateResult); - var action = await _controller.Create(new CreateTokenRequest - { - Username = "u", - Password = "p", - Expire = expire - }); - action.Result.Should().BeAssignableTo() - .Which.Value.Should().BeEquivalentTo(new CreateTokenResponse - { - Token = mockCreateResult.Token, - User = MockUser.User.Info - }); - } - - [Fact] - public async Task Create_UserNotExist() - { - _mockUserService.Setup(s => s.CreateToken("u", "p", null)).ThrowsAsync(new UserNotExistException("u")); - var action = await _controller.Create(new CreateTokenRequest - { - Username = "u", - Password = "p", - Expire = null - }); - action.Result.Should().BeAssignableTo() - .Which.Value.Should().BeAssignableTo() - .Which.Code.Should().Be(ErrorCodes.TokenController.Create_BadCredential); - } - - [Fact] - public async Task Create_BadPassword() - { - _mockUserService.Setup(s => s.CreateToken("u", "p", null)).ThrowsAsync(new BadPasswordException("u")); - var action = await _controller.Create(new CreateTokenRequest - { - Username = "u", - Password = "p", - Expire = null - }); - action.Result.Should().BeAssignableTo() - .Which.Value.Should().BeAssignableTo() - .Which.Code.Should().Be(ErrorCodes.TokenController.Create_BadCredential); - } - - [Fact] - public async Task Verify_Ok() - { - const string token = "aaaaaaaaaaaaaa"; - _mockUserService.Setup(s => s.VerifyToken(token)).ReturnsAsync(new Models.User - { - Id = 1, - Username = MockUser.User.Username, - Administrator = MockUser.User.Administrator, - Version = 1 - }); - var action = await _controller.Verify(new VerifyTokenRequest { Token = token }); - action.Result.Should().BeAssignableTo() - .Which.Value.Should().BeAssignableTo() - .Which.User.Should().BeEquivalentTo(MockUser.User.Info); - } - - public static IEnumerable Verify_BadRequest_Data() - { - yield return new object[] { new UserTokenTimeExpireException(), ErrorCodes.TokenController.Verify_TimeExpired }; - yield return new object[] { new UserTokenBadVersionException(), ErrorCodes.TokenController.Verify_OldVersion }; - yield return new object[] { new UserTokenBadFormatException(), ErrorCodes.TokenController.Verify_BadFormat }; - yield return new object[] { new UserNotExistException(), ErrorCodes.TokenController.Verify_UserNotExist }; - } - - [Theory] - [MemberData(nameof(Verify_BadRequest_Data))] - public async Task Verify_BadRequest(Exception e, int code) - { - const string token = "aaaaaaaaaaaaaa"; - _mockUserService.Setup(s => s.VerifyToken(token)).ThrowsAsync(e); - var action = await _controller.Verify(new VerifyTokenRequest { Token = token }); - action.Result.Should().BeAssignableTo() - .Which.Value.Should().BeAssignableTo() - .Which.Code.Should().Be(code); - } - } -} diff --git a/Timeline.Tests/Controllers/UserControllerTest.cs b/Timeline.Tests/Controllers/UserControllerTest.cs deleted file mode 100644 index 3890712a..00000000 --- a/Timeline.Tests/Controllers/UserControllerTest.cs +++ /dev/null @@ -1,228 +0,0 @@ -using FluentAssertions; -using Microsoft.AspNetCore.Http; -using Microsoft.AspNetCore.Mvc; -using Microsoft.Extensions.Logging.Abstractions; -using Moq; -using System; -using System.Collections.Generic; -using System.Linq; -using System.Security.Claims; -using System.Threading.Tasks; -using Timeline.Controllers; -using Timeline.Models; -using Timeline.Models.Http; -using Timeline.Services; -using Timeline.Tests.Helpers; -using Xunit; - -namespace Timeline.Tests.Controllers -{ - public class UserControllerTest : IDisposable - { - private readonly Mock _mockUserService = new Mock(); - - private readonly UserController _controller; - - public UserControllerTest() - { - _controller = new UserController(NullLogger.Instance, _mockUserService.Object); - } - - public void Dispose() - { - _controller.Dispose(); - } - - [Fact] - public async Task GetList_Success() - { - var mockUserList = new Models.User[] { - new Models.User { Id = 1, Username = "aaa", Administrator = true, Version = 1 }, - new Models.User { Id = 2, Username = "bbb", Administrator = false, Version = 1 } - }; - _mockUserService.Setup(s => s.GetUsers()).ReturnsAsync(mockUserList); - var action = await _controller.List(); - action.Result.Should().BeAssignableTo() - .Which.Value.Should().BeEquivalentTo( - mockUserList.Select(u => new User { Username = u.Username, Administrator = u.Administrator }).ToArray()); - } - - [Fact] - public async Task Get_Success() - { - const string username = "aaa"; - _mockUserService.Setup(s => s.GetUserByUsername(username)).ReturnsAsync(new Models.User - { - Id = 1, - Username = MockUser.User.Username, - Administrator = MockUser.User.Administrator, - Version = 1 - }); - var action = await _controller.Get(username); - action.Result.Should().BeAssignableTo() - .Which.Value.Should().BeEquivalentTo(MockUser.User.Info); - } - - [Fact] - public async Task Get_NotFound() - { - const string username = "aaa"; - _mockUserService.Setup(s => s.GetUserByUsername(username)).ThrowsAsync(new UserNotExistException()); - var action = await _controller.Get(username); - action.Result.Should().BeAssignableTo() - .Which.Value.Should().BeAssignableTo() - .Which.Code.Should().Be(ErrorCodes.UserCommon.NotExist); - } - - [Theory] - [InlineData(PutResult.Create, true)] - [InlineData(PutResult.Modify, false)] - public async Task Put_Success(PutResult result, bool create) - { - const string username = "aaa"; - const string password = "ppp"; - const bool administrator = true; - _mockUserService.Setup(s => s.PutUser(username, password, administrator)).ReturnsAsync(result); - var action = await _controller.Put(new UserPutRequest - { - Password = password, - Administrator = administrator - }, username); - var response = action.Result.Should().BeAssignableTo() - .Which.Value.Should().BeAssignableTo() - .Which; - response.Code.Should().Be(0); - response.Data.Create.Should().Be(create); - } - - [Fact] - public async Task Patch_Success() - { - const string username = "aaa"; - const string password = "ppp"; - const bool administrator = true; - _mockUserService.Setup(s => s.PatchUser(username, password, administrator)).Returns(Task.CompletedTask); - var action = await _controller.Patch(new UserPatchRequest - { - Password = password, - Administrator = administrator - }, username); - action.Should().BeAssignableTo(); - } - - [Fact] - public async Task Patch_NotExist() - { - const string username = "aaa"; - const string password = "ppp"; - const bool administrator = true; - _mockUserService.Setup(s => s.PatchUser(username, password, administrator)).ThrowsAsync(new UserNotExistException()); - var action = await _controller.Patch(new UserPatchRequest - { - Password = password, - Administrator = administrator - }, username); - action.Should().BeAssignableTo() - .Which.Value.Should().BeAssignableTo() - .Which.Code.Should().Be(ErrorCodes.UserCommon.NotExist); - } - - [Fact] - public async Task Delete_Delete() - { - const string username = "aaa"; - _mockUserService.Setup(s => s.DeleteUser(username)).Returns(Task.CompletedTask); - var action = await _controller.Delete(username); - var body = action.Result.Should().BeAssignableTo() - .Which.Value.Should().BeAssignableTo() - .Which; - body.Code.Should().Be(0); - body.Data.Delete.Should().BeTrue(); - } - - [Fact] - public async Task Delete_NotExist() - { - const string username = "aaa"; - _mockUserService.Setup(s => s.DeleteUser(username)).ThrowsAsync(new UserNotExistException()); - var action = await _controller.Delete(username); - var body = action.Result.Should().BeAssignableTo() - .Which.Value.Should().BeAssignableTo() - .Which; - body.Code.Should().Be(0); - body.Data.Delete.Should().BeFalse(); - } - - [Fact] - public async Task Op_ChangeUsername_Success() - { - const string oldUsername = "aaa"; - const string newUsername = "bbb"; - _mockUserService.Setup(s => s.ChangeUsername(oldUsername, newUsername)).Returns(Task.CompletedTask); - var action = await _controller.ChangeUsername(new ChangeUsernameRequest { OldUsername = oldUsername, NewUsername = newUsername }); - action.Should().BeAssignableTo(); - } - - [Theory] - [InlineData(typeof(UserNotExistException), ErrorCodes.UserCommon.NotExist)] - [InlineData(typeof(ConfictException), ErrorCodes.UserController.ChangeUsername_Conflict)] - public async Task Op_ChangeUsername_Failure(Type exceptionType, int code) - { - const string oldUsername = "aaa"; - const string newUsername = "bbb"; - _mockUserService.Setup(s => s.ChangeUsername(oldUsername, newUsername)).ThrowsAsync(Activator.CreateInstance(exceptionType) as Exception); - var action = await _controller.ChangeUsername(new ChangeUsernameRequest { OldUsername = oldUsername, NewUsername = newUsername }); - action.Should().BeAssignableTo() - .Which.Value.Should().BeAssignableTo() - .Which.Code.Should().Be(code); - } - - [Fact] - public async Task Op_ChangePassword_Success() - { - const string username = "aaa"; - const string oldPassword = "aaa"; - const string newPassword = "bbb"; - _mockUserService.Setup(s => s.ChangePassword(username, oldPassword, newPassword)).Returns(Task.CompletedTask); - - _controller.ControllerContext = new ControllerContext() - { - HttpContext = new DefaultHttpContext() - { - User = new ClaimsPrincipal(new ClaimsIdentity(new Claim[] - { - new Claim(ClaimTypes.Name, username) - }, "TestAuthType")) - } - }; - - var action = await _controller.ChangePassword(new ChangePasswordRequest { OldPassword = oldPassword, NewPassword = newPassword }); - action.Should().BeAssignableTo(); - } - - [Fact] - public async Task Op_ChangePassword_BadPassword() - { - const string username = "aaa"; - const string oldPassword = "aaa"; - const string newPassword = "bbb"; - _mockUserService.Setup(s => s.ChangePassword(username, oldPassword, newPassword)).ThrowsAsync(new BadPasswordException()); - - _controller.ControllerContext = new ControllerContext() - { - HttpContext = new DefaultHttpContext() - { - User = new ClaimsPrincipal(new ClaimsIdentity(new Claim[] - { - new Claim(ClaimTypes.Name, username) - }, "TestAuthType")) - } - }; - - var action = await _controller.ChangePassword(new ChangePasswordRequest { OldPassword = oldPassword, NewPassword = newPassword }); - action.Should().BeAssignableTo() - .Which.Value.Should().BeAssignableTo() - .Which.Code.Should().Be(ErrorCodes.UserController.ChangePassword_BadOldPassword); - } - } -} diff --git a/Timeline.Tests/Controllers/UserDetailControllerTest.cs b/Timeline.Tests/Controllers/UserDetailControllerTest.cs deleted file mode 100644 index ffd88790..00000000 --- a/Timeline.Tests/Controllers/UserDetailControllerTest.cs +++ /dev/null @@ -1,98 +0,0 @@ -using FluentAssertions; -using Microsoft.AspNetCore.Authorization; -using Microsoft.AspNetCore.Mvc; -using Moq; -using System; -using System.ComponentModel.DataAnnotations; -using System.Threading.Tasks; -using Timeline.Controllers; -using Timeline.Filters; -using Timeline.Models.Validation; -using Timeline.Services; -using Timeline.Tests.Helpers; -using Xunit; - -namespace Timeline.Tests.Controllers -{ - public class UserDetailControllerTest : IDisposable - { - private readonly Mock _mockUserDetailService; - private readonly UserDetailController _controller; - - public UserDetailControllerTest() - { - _mockUserDetailService = new Mock(); - _controller = new UserDetailController(_mockUserDetailService.Object); - } - - public void Dispose() - { - _controller.Dispose(); - } - - [Fact] - public void AttributeTest() - { - typeof(UserDetailController).Should().BeDecoratedWith(); - - var getNickname = typeof(UserDetailController).GetMethod(nameof(UserDetailController.GetNickname)); - getNickname.Should().BeDecoratedWith() - .And.BeDecoratedWith(); - getNickname.GetParameter("username").Should().BeDecoratedWith() - .And.BeDecoratedWith(); - - var putNickname = typeof(UserDetailController).GetMethod(nameof(UserDetailController.PutNickname)); - putNickname.Should().BeDecoratedWith() - .And.BeDecoratedWith() - .And.BeDecoratedWith() - .And.BeDecoratedWith(); - putNickname.GetParameter("username").Should().BeDecoratedWith() - .And.BeDecoratedWith(); - var stringLengthAttributeOnPutBody = putNickname.GetParameter("body").Should().BeDecoratedWith() - .And.BeDecoratedWith() - .Which; - stringLengthAttributeOnPutBody.MinimumLength.Should().Be(1); - stringLengthAttributeOnPutBody.MaximumLength.Should().Be(10); - - var deleteNickname = typeof(UserDetailController).GetMethod(nameof(UserDetailController.DeleteNickname)); - deleteNickname.Should().BeDecoratedWith() - .And.BeDecoratedWith() - .And.BeDecoratedWith() - .And.BeDecoratedWith(); - deleteNickname.GetParameter("username").Should().BeDecoratedWith() - .And.BeDecoratedWith(); - } - - [Fact] - public async Task GetNickname_ShouldWork() - { - const string username = "uuu"; - const string nickname = "nnn"; - _mockUserDetailService.Setup(s => s.GetNickname(username)).ReturnsAsync(nickname); - var actionResult = await _controller.GetNickname(username); - actionResult.Result.Should().BeAssignableTo(nickname); - _mockUserDetailService.VerifyAll(); - } - - [Fact] - public async Task PutNickname_ShouldWork() - { - const string username = "uuu"; - const string nickname = "nnn"; - _mockUserDetailService.Setup(s => s.SetNickname(username, nickname)).Returns(Task.CompletedTask); - var actionResult = await _controller.PutNickname(username, nickname); - actionResult.Should().BeAssignableTo(); - _mockUserDetailService.VerifyAll(); - } - - [Fact] - public async Task DeleteNickname_ShouldWork() - { - const string username = "uuu"; - _mockUserDetailService.Setup(s => s.SetNickname(username, null)).Returns(Task.CompletedTask); - var actionResult = await _controller.DeleteNickname(username); - actionResult.Should().BeAssignableTo(); - _mockUserDetailService.VerifyAll(); - } - } -} diff --git a/Timeline.Tests/DatabaseTest.cs b/Timeline.Tests/DatabaseTest.cs deleted file mode 100644 index a15823a9..00000000 --- a/Timeline.Tests/DatabaseTest.cs +++ /dev/null @@ -1,63 +0,0 @@ -using FluentAssertions; -using System; -using System.Linq; -using Timeline.Entities; -using Timeline.Tests.Helpers; -using Xunit; - -namespace Timeline.Tests -{ - public class DatabaseTest : IDisposable - { - private readonly TestDatabase _database; - private readonly DatabaseContext _context; - - public DatabaseTest() - { - _database = new TestDatabase(); - _context = _database.Context; - } - - public void Dispose() - { - _database.Dispose(); - } - - [Fact] - public void DeleteUserShouldAlsoDeleteAvatar() - { - var user = _context.Users.First(); - _context.UserAvatars.Count().Should().Be(0); - _context.UserAvatars.Add(new UserAvatarEntity - { - Data = null, - Type = null, - ETag = null, - LastModified = DateTime.Now, - UserId = user.Id - }); - _context.SaveChanges(); - _context.UserAvatars.Count().Should().Be(1); - _context.Users.Remove(user); - _context.SaveChanges(); - _context.UserAvatars.Count().Should().Be(0); - } - - [Fact] - public void DeleteUserShouldAlsoDeleteDetail() - { - var user = _context.Users.First(); - _context.UserDetails.Count().Should().Be(0); - _context.UserDetails.Add(new UserDetailEntity - { - Nickname = null, - UserId = user.Id - }); - _context.SaveChanges(); - _context.UserDetails.Count().Should().Be(1); - _context.Users.Remove(user); - _context.SaveChanges(); - _context.UserDetails.Count().Should().Be(0); - } - } -} diff --git a/Timeline.Tests/GlobalSuppressions.cs b/Timeline.Tests/GlobalSuppressions.cs index 1d1d294b..0f873033 100644 --- a/Timeline.Tests/GlobalSuppressions.cs +++ b/Timeline.Tests/GlobalSuppressions.cs @@ -12,3 +12,5 @@ [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA1816:Dispose methods should call SuppressFinalize", Justification = "Test classes do not need to implement it that way.")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2234:Pass system uri objects instead of strings", Justification = "I really don't understand this rule.")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Globalization", "CA1303:Do not pass literals as localized parameters", Justification = "Tests do not need make strings resources.")] +[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1054:Uri parameters should not be strings", Justification = "That's unnecessary.")] +[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1056:Uri properties should not be strings", Justification = "That's unnecessary.")] diff --git a/Timeline.Tests/Helpers/MockUser.cs b/Timeline.Tests/Helpers/MockUser.cs deleted file mode 100644 index 49576842..00000000 --- a/Timeline.Tests/Helpers/MockUser.cs +++ /dev/null @@ -1,24 +0,0 @@ -using System.Collections.Generic; -using Timeline.Models.Http; - -namespace Timeline.Tests.Helpers -{ - public class MockUser - { - public MockUser(string username, string password, bool administrator) - { - Info = new User { Username = username, Administrator = administrator }; - Password = password; - } - - public User Info { get; set; } - public string Username => Info.Username; - public string Password { get; set; } - public bool Administrator => Info.Administrator; - - public static MockUser User { get; } = new MockUser("user", "userpassword", false); - public static MockUser Admin { get; } = new MockUser("admin", "adminpassword", true); - - public static IReadOnlyList UserInfoList { get; } = new List { User.Info, Admin.Info }; - } -} diff --git a/Timeline.Tests/Helpers/PrincipalHelper.cs b/Timeline.Tests/Helpers/PrincipalHelper.cs deleted file mode 100644 index 89f3f7b1..00000000 --- a/Timeline.Tests/Helpers/PrincipalHelper.cs +++ /dev/null @@ -1,23 +0,0 @@ -using System.Linq; -using System.Security.Claims; -using Timeline.Models; - -namespace Timeline.Tests.Helpers -{ - public static class PrincipalHelper - { - internal const string AuthScheme = "TESTAUTH"; - - internal static ClaimsPrincipal Create(string username, bool administrator) - { - var identity = new ClaimsIdentity(AuthScheme); - identity.AddClaim(new Claim(identity.NameClaimType, username, ClaimValueTypes.String)); - identity.AddClaims(UserRoleConvert.ToArray(administrator).Select(role => new Claim(identity.RoleClaimType, role, ClaimValueTypes.String))); - - var principal = new ClaimsPrincipal(); - principal.AddIdentity(identity); - - return principal; - } - } -} diff --git a/Timeline.Tests/Helpers/ResponseAssertions.cs b/Timeline.Tests/Helpers/ResponseAssertions.cs index be0043dc..f01a0677 100644 --- a/Timeline.Tests/Helpers/ResponseAssertions.cs +++ b/Timeline.Tests/Helpers/ResponseAssertions.cs @@ -125,6 +125,13 @@ namespace Timeline.Tests.Helpers return assertions.HaveJsonBody(because, becauseArgs); } + public static void HaveCommonBody(this HttpResponseMessageAssertions assertions, int code, string message = null, params object[] messageArgs) + { + message = string.IsNullOrEmpty(message) ? "" : ", " + string.Format(CultureInfo.CurrentCulture, message, messageArgs); + var body = assertions.HaveCommonBody("Response body should be CommonResponse{0}", message).Which; + body.Code.Should().Be(code, "Response body code is not the specified one{0}", message); + } + public static AndWhichConstraint> HaveCommonDataBody(this HttpResponseMessageAssertions assertions, string because = "", params object[] becauseArgs) { return assertions.HaveJsonBody>(because, becauseArgs); @@ -148,13 +155,6 @@ namespace Timeline.Tests.Helpers body.Data.Delete.Should().Be(delete); } - public static void HaveCommonResponseBody(this HttpResponseMessageAssertions assertions, int code, string message = null, params object[] messageArgs) - { - message = string.IsNullOrEmpty(message) ? "" : ", " + string.Format(CultureInfo.CurrentCulture, message, messageArgs); - var body = assertions.HaveJsonBody("Response body should be CommonResponse{0}", message).Which; - body.Code.Should().Be(code, "Response body code is not the specified one{0}", message); - } - public static void BeInvalidModel(this HttpResponseMessageAssertions assertions, string message = null) { message = string.IsNullOrEmpty(message) ? "" : ", " + message; diff --git a/Timeline.Tests/Helpers/TestApplication.cs b/Timeline.Tests/Helpers/TestApplication.cs index d18f2848..14cafea3 100644 --- a/Timeline.Tests/Helpers/TestApplication.cs +++ b/Timeline.Tests/Helpers/TestApplication.cs @@ -1,4 +1,6 @@ using Microsoft.AspNetCore.Mvc.Testing; +using Microsoft.AspNetCore.TestHost; +using Microsoft.Data.Sqlite; using Microsoft.EntityFrameworkCore; using Microsoft.Extensions.DependencyInjection; using System; @@ -8,19 +10,21 @@ namespace Timeline.Tests.Helpers { public class TestApplication : IDisposable { - public TestDatabase Database { get; } = new TestDatabase(); + public SqliteConnection DatabaseConnection { get; } + public WebApplicationFactory Factory { get; } public TestApplication(WebApplicationFactory factory) { + DatabaseConnection = new SqliteConnection("Data Source=:memory:;"); + Factory = factory.WithWebHostBuilder(builder => { - builder.ConfigureServices(services => + builder.ConfigureTestServices(services => { - services.AddEntityFrameworkSqlite(); services.AddDbContext(options => { - options.UseSqlite(Database.Connection); + options.UseSqlite(DatabaseConnection); }); }); }); @@ -28,7 +32,8 @@ namespace Timeline.Tests.Helpers public void Dispose() { - Database.Dispose(); + DatabaseConnection.Close(); + DatabaseConnection.Dispose(); } } } diff --git a/Timeline.Tests/Helpers/TestClock.cs b/Timeline.Tests/Helpers/TestClock.cs deleted file mode 100644 index 12b320d3..00000000 --- a/Timeline.Tests/Helpers/TestClock.cs +++ /dev/null @@ -1,15 +0,0 @@ -using System; -using Timeline.Services; - -namespace Timeline.Tests.Helpers -{ - public class TestClock : IClock - { - public DateTime? MockCurrentTime { get; set; } = null; - - public DateTime GetCurrentTime() - { - return MockCurrentTime.GetValueOrDefault(DateTime.Now); - } - } -} diff --git a/Timeline.Tests/Helpers/TestDatabase.cs b/Timeline.Tests/Helpers/TestDatabase.cs deleted file mode 100644 index e29a71fa..00000000 --- a/Timeline.Tests/Helpers/TestDatabase.cs +++ /dev/null @@ -1,89 +0,0 @@ -using Microsoft.Data.Sqlite; -using Microsoft.EntityFrameworkCore; -using System; -using System.Collections.Generic; -using System.Linq; -using Timeline.Entities; -using Timeline.Models; -using Timeline.Services; - -namespace Timeline.Tests.Helpers -{ - public class TestDatabase : IDisposable - { - // currently password service is thread safe, so we share a static one. - private static PasswordService PasswordService { get; } = new PasswordService(); - - private static UserEntity CreateEntityFromMock(MockUser user) - { - return new UserEntity - { - Username = user.Username, - Password = PasswordService.HashPassword(user.Password), - Roles = UserRoleConvert.ToString(user.Administrator), - Avatar = null - }; - } - - private static IEnumerable CreateDefaultMockEntities() - { - // emmmmmmm. Never reuse the user instances because EF Core uses them, which will cause strange things. - yield return CreateEntityFromMock(MockUser.User); - yield return CreateEntityFromMock(MockUser.Admin); - } - - private static void InitDatabase(DatabaseContext context) - { - context.Database.EnsureCreated(); - context.Users.AddRange(CreateDefaultMockEntities()); - context.SaveChanges(); - } - - public SqliteConnection Connection { get; } - public DatabaseContext Context { get; } - - public TestDatabase() - { - Connection = new SqliteConnection("Data Source=:memory:;"); - Connection.Open(); - - var options = new DbContextOptionsBuilder() - .UseSqlite(Connection) - .Options; - - Context = new DevelopmentDatabaseContext(options); - - InitDatabase(Context); - } - - private List _extraMockUsers; - - public IReadOnlyList ExtraMockUsers => _extraMockUsers; - - public void CreateExtraMockUsers(int count) - { - if (count <= 0) - throw new ArgumentOutOfRangeException(nameof(count), count, "Additional user count must be bigger than 0."); - if (_extraMockUsers != null) - throw new InvalidOperationException("Already create mock users."); - - _extraMockUsers = new List(); - for (int i = 0; i < count; i++) - { - _extraMockUsers.Add(new MockUser($"user{i}", $"password", false)); - } - - Context.AddRange(_extraMockUsers.Select(u => CreateEntityFromMock(u))); - Context.SaveChanges(); - } - - public void Dispose() - { - Context.Dispose(); - - Connection.Close(); - Connection.Dispose(); - } - - } -} diff --git a/Timeline.Tests/Helpers/UseCultureAttribute.cs b/Timeline.Tests/Helpers/UseCultureAttribute.cs deleted file mode 100644 index 017d77a8..00000000 --- a/Timeline.Tests/Helpers/UseCultureAttribute.cs +++ /dev/null @@ -1,94 +0,0 @@ -using System; -using System.Globalization; -using System.Reflection; -using System.Threading; -using Xunit.Sdk; - - -namespace Timeline.Tests.Helpers -{ - // Copied from https://github.com/xunit/samples.xunit/blob/master/UseCulture/UseCultureAttribute.cs - - /// - /// Apply this attribute to your test method to replace the - /// and - /// with another culture. - /// - [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)] - public class UseCultureAttribute : BeforeAfterTestAttribute - { - readonly Lazy culture; - readonly Lazy uiCulture; - - CultureInfo originalCulture; - CultureInfo originalUICulture; - - /// - /// Replaces the culture and UI culture of the current thread with - /// - /// - /// The name of the culture. - /// - /// - /// This constructor overload uses for both - /// and . - /// - /// - public UseCultureAttribute(string culture) - : this(culture, culture) { } - - /// - /// Replaces the culture and UI culture of the current thread with - /// and - /// - /// The name of the culture. - /// The name of the UI culture. - public UseCultureAttribute(string culture, string uiCulture) - { - this.culture = new Lazy(() => new CultureInfo(culture, false)); - this.uiCulture = new Lazy(() => new CultureInfo(uiCulture, false)); - } - - /// - /// Gets the culture. - /// - public CultureInfo Culture { get { return culture.Value; } } - - /// - /// Gets the UI culture. - /// - public CultureInfo UICulture { get { return uiCulture.Value; } } - - /// - /// Stores the current - /// and - /// and replaces them with the new cultures defined in the constructor. - /// - /// The method under test - public override void Before(MethodInfo methodUnderTest) - { - originalCulture = Thread.CurrentThread.CurrentCulture; - originalUICulture = Thread.CurrentThread.CurrentUICulture; - - Thread.CurrentThread.CurrentCulture = Culture; - Thread.CurrentThread.CurrentUICulture = UICulture; - - CultureInfo.CurrentCulture.ClearCachedData(); - CultureInfo.CurrentUICulture.ClearCachedData(); - } - - /// - /// Restores the original and - /// to - /// - /// The method under test - public override void After(MethodInfo methodUnderTest) - { - Thread.CurrentThread.CurrentCulture = originalCulture; - Thread.CurrentThread.CurrentUICulture = originalUICulture; - - CultureInfo.CurrentCulture.ClearCachedData(); - CultureInfo.CurrentUICulture.ClearCachedData(); - } - } -} diff --git a/Timeline.Tests/IntegratedTests/AuthorizationTest.cs b/Timeline.Tests/IntegratedTests/AuthorizationTest.cs index 0bc094af..4aa6b3ae 100644 --- a/Timeline.Tests/IntegratedTests/AuthorizationTest.cs +++ b/Timeline.Tests/IntegratedTests/AuthorizationTest.cs @@ -22,7 +22,7 @@ namespace Timeline.Tests.IntegratedTests [Fact] public async Task UnauthenticationTest() { - using var client = await CreateClientWithNoAuth(); + using var client = await CreateDefaultClient(); var response = await client.GetAsync(AuthorizeUrl); response.Should().HaveStatusCode(HttpStatusCode.Unauthorized); } @@ -48,7 +48,7 @@ namespace Timeline.Tests.IntegratedTests [Fact] public async Task AdminAuthorizationTest() { - using var client = await CreateClientAsAdmin(); + using var client = await CreateClientAsAdministrator(); var response1 = await client.GetAsync(UserUrl); response1.Should().HaveStatusCode(HttpStatusCode.OK); var response2 = await client.GetAsync(AdminUrl); diff --git a/Timeline.Tests/IntegratedTests/I18nTest.cs b/Timeline.Tests/IntegratedTests/I18nTest.cs deleted file mode 100644 index 855179af..00000000 --- a/Timeline.Tests/IntegratedTests/I18nTest.cs +++ /dev/null @@ -1,59 +0,0 @@ -using FluentAssertions; -using Microsoft.AspNetCore.Mvc.Testing; -using System; -using System.Net.Http; -using System.Net.Http.Headers; -using System.Threading.Tasks; -using Timeline.Tests.Helpers; -using Xunit; - -namespace Timeline.Tests.IntegratedTests -{ - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1054:Uri parameters should not be strings")] - public class I18nTest : IntegratedTestBase - { - private readonly HttpClient _client; - - public I18nTest(WebApplicationFactory factory) - : base(factory) - { - _client = Factory.CreateDefaultClient(); - } - - protected override void OnDispose() - { - _client.Dispose(); - } - - private const string DirectUrl = "testing/i18n/direct"; - private const string LocalizerUrl = "testing/i18n/localizer"; - - [Theory] - [InlineData(DirectUrl)] - [InlineData(LocalizerUrl)] - public async Task DefaultShouldReturnEnglish(string url) - { - (await _client.GetStringAsync(url)).Should().ContainEquivalentOf("English"); - } - - [Theory] - [InlineData(DirectUrl, "en", true)] - [InlineData(LocalizerUrl, "en", true)] - [InlineData(DirectUrl, "en-US", true)] - [InlineData(LocalizerUrl, "en-US", true)] - [InlineData(DirectUrl, "zh", false)] - [InlineData(LocalizerUrl, "zh", false)] - public async Task ShouldWork(string url, string acceptLanguage, bool english) - { - var request = new HttpRequestMessage - { - Method = HttpMethod.Get, - RequestUri = new Uri(url, UriKind.RelativeOrAbsolute) - }; - request.Headers.AcceptLanguage.Add(new StringWithQualityHeaderValue(acceptLanguage)); - var body = await (await _client.SendAsync(request)).Content.ReadAsStringAsync(); - body.Should().ContainEquivalentOf(english ? "English" : "中文"); - request.Dispose(); - } - } -} diff --git a/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs b/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs index 242a452d..721a25af 100644 --- a/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs +++ b/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs @@ -1,36 +1,17 @@ -using Microsoft.AspNetCore.Mvc.Testing; +using AutoMapper; +using Microsoft.AspNetCore.Mvc.Testing; +using Microsoft.Extensions.DependencyInjection; using System; -using System.Collections.Generic; +using System.Collections.Generic; using System.Net.Http; using System.Threading.Tasks; using Timeline.Models.Http; +using Timeline.Services; using Timeline.Tests.Helpers; using Xunit; namespace Timeline.Tests.IntegratedTests { - public enum AuthType - { - None, - User, - Admin - } - - public static class AuthTypeExtensions - { - public static MockUser GetMockUser(this AuthType authType) - { - return authType switch - { - AuthType.None => null, - AuthType.User => MockUser.User, - AuthType.Admin => MockUser.Admin, - _ => throw new InvalidOperationException("Unknown auth type.") - }; - } - - public static string GetUsername(this AuthType authType) => authType.GetMockUser().Username; - } public abstract class IntegratedTestBase : IClassFixture>, IDisposable { @@ -38,14 +19,62 @@ namespace Timeline.Tests.IntegratedTests protected WebApplicationFactory Factory => TestApp.Factory; - public IntegratedTestBase(WebApplicationFactory factory) + public IntegratedTestBase(WebApplicationFactory factory) : this(factory, 1) + { + + } + + public IntegratedTestBase(WebApplicationFactory factory, int userCount) { + if (userCount < 0) + throw new ArgumentOutOfRangeException(nameof(userCount), userCount, "User count can't be negative."); + TestApp = new TestApplication(factory); + + using (var scope = Factory.Services.CreateScope()) + { + var users = new List() + { + new User + { + Username = "admin", + Password = "adminpw", + Administrator = true, + Nickname = "administrator" + } + }; + + for (int i = 1; i <= userCount; i++) + { + users.Add(new User + { + Username = $"user{i}", + Password = $"user{i}pw", + Administrator = false, + Nickname = $"imuser{i}" + }); + } + + var userInfoList = new List(); + var userInfoForAdminList = new List(); + + var userService = scope.ServiceProvider.GetRequiredService(); + var mapper = scope.ServiceProvider.GetRequiredService(); + + foreach (var user in users) + { + userService.CreateUser(user); + userInfoList.Add(mapper.Map(user)); + userInfoForAdminList.Add(mapper.Map(user)); + } + + UserInfoList = userInfoList; + UserInfoForAdminList = userInfoForAdminList; + } } protected virtual void OnDispose() { - } public void Dispose() @@ -54,14 +83,11 @@ namespace Timeline.Tests.IntegratedTests TestApp.Dispose(); } - protected void CreateExtraMockUsers(int count) - { - TestApp.Database.CreateExtraMockUsers(count); - } + public IReadOnlyList UserInfoList { get; } - protected IReadOnlyList ExtraMockUsers => TestApp.Database.ExtraMockUsers; + public IReadOnlyList UserInfoForAdminList { get; } - public Task CreateClientWithNoAuth() + public Task CreateDefaultClient() { return Task.FromResult(Factory.CreateDefaultClient()); } @@ -77,18 +103,25 @@ namespace Timeline.Tests.IntegratedTests return client; } - public Task CreateClientAs(MockUser user) + public Task CreateClientAs(int userNumber) { - if (user == null) - return CreateClientWithNoAuth(); - return CreateClientWithCredential(user.Username, user.Password); - } - - public Task CreateClientAs(AuthType authType) => CreateClientAs(authType.GetMockUser()); - + if (userNumber < 0) + throw new ArgumentOutOfRangeException(nameof(userNumber), "User number can't be negative."); - public Task CreateClientAsUser() => CreateClientAs(MockUser.User); - public Task CreateClientAsAdmin() => CreateClientAs(MockUser.Admin); + if (userNumber == 0) + return CreateClientWithCredential("admin", "adminpw"); + else + return CreateClientWithCredential($"user{userNumber}", $"user{userNumber}pw"); + } + public Task CreateClientAsAdministrator() + { + return CreateClientAs(0); + } + + public Task CreateClientAsUser() + { + return CreateClientAs(1); + } } } diff --git a/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs b/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs index 51e2d05e..14600659 100644 --- a/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs +++ b/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs @@ -5,7 +5,6 @@ using System.Collections.Generic; using System.Linq; using System.Net.Http; using System.Threading.Tasks; -using Timeline.Models; using Timeline.Models.Http; using Timeline.Tests.Helpers; using Xunit; @@ -15,7 +14,7 @@ namespace Timeline.Tests.IntegratedTests public class PersonalTimelineTest : IntegratedTestBase { public PersonalTimelineTest(WebApplicationFactory factory) - : base(factory) + : base(factory, 3) { } @@ -23,11 +22,11 @@ namespace Timeline.Tests.IntegratedTests [Fact] public async Task TimelineGet_Should_Work() { - using var client = await CreateClientWithNoAuth(); - var res = await client.GetAsync("users/user/timeline"); + using var client = await CreateDefaultClient(); + var res = await client.GetAsync("users/user1/timeline"); var body = res.Should().HaveStatusCode(200) .And.HaveJsonBody().Which; - body.Owner.Should().Be("user"); + body.Owner.Should().BeEquivalentTo(UserInfoList[1]); body.Visibility.Should().Be(TimelineVisibility.Register); body.Description.Should().Be(""); body.Members.Should().NotBeNull().And.BeEmpty(); @@ -40,7 +39,7 @@ namespace Timeline.Tests.IntegratedTests async Task AssertDescription(string description) { - var res = await client.GetAsync("users/user/timeline"); + var res = await client.GetAsync("users/user1/timeline"); var body = res.Should().HaveStatusCode(200) .And.HaveJsonBody() .Which.Description.Should().Be(description); @@ -50,20 +49,20 @@ namespace Timeline.Tests.IntegratedTests await AssertDescription(""); { - var res = await client.PostAsJsonAsync("users/user/timeline/op/property", - new TimelinePropertyChangeRequest { Description = mockDescription }); + var res = await client.PatchAsJsonAsync("users/user1/timeline", + new TimelinePatchRequest { Description = mockDescription }); res.Should().HaveStatusCode(200); await AssertDescription(mockDescription); } { - var res = await client.PostAsJsonAsync("users/user/timeline/op/property", - new TimelinePropertyChangeRequest { Description = null }); + var res = await client.PatchAsJsonAsync("users/user1/timeline", + new TimelinePatchRequest { Description = null }); res.Should().HaveStatusCode(200); await AssertDescription(mockDescription); } { - var res = await client.PostAsJsonAsync("users/user/timeline/op/property", - new TimelinePropertyChangeRequest { Description = "" }); + var res = await client.PatchAsJsonAsync("users/user1/timeline", + new TimelinePatchRequest { Description = "" }); res.Should().HaveStatusCode(200); await AssertDescription(""); } @@ -141,13 +140,13 @@ namespace Timeline.Tests.IntegratedTests { var res = await client.PostAsJsonAsync("users/user/timeline/op/property", - new TimelinePropertyChangeRequest { Description = "hahaha" }); + new TimelinePatchRequest { Description = "hahaha" }); res.Should().HaveStatusCode(opPropertyUser); } { var res = await client.PostAsJsonAsync("users/admin/timeline/op/property", - new TimelinePropertyChangeRequest { Description = "hahaha" }); + new TimelinePatchRequest { Description = "hahaha" }); res.Should().HaveStatusCode(opPropertyAdmin); } @@ -193,7 +192,7 @@ namespace Timeline.Tests.IntegratedTests { using var client = await CreateClientAsUser(); var res = await client.PostAsJsonAsync("users/user/timeline/op/property", - new TimelinePropertyChangeRequest { Visibility = TimelineVisibility.Public }); + new TimelinePatchRequest { Visibility = TimelineVisibility.Public }); res.Should().HaveStatusCode(200); } { @@ -208,12 +207,12 @@ namespace Timeline.Tests.IntegratedTests using var client = await CreateClientAsAdmin(); { var res = await client.PostAsJsonAsync("users/user/timeline/op/property", - new TimelinePropertyChangeRequest { Visibility = TimelineVisibility.Private }); + new TimelinePatchRequest { Visibility = TimelineVisibility.Private }); res.Should().HaveStatusCode(200); } { var res = await client.PostAsJsonAsync("users/admin/timeline/op/property", - new TimelinePropertyChangeRequest { Visibility = TimelineVisibility.Private }); + new TimelinePatchRequest { Visibility = TimelineVisibility.Private }); res.Should().HaveStatusCode(200); } } @@ -331,7 +330,7 @@ namespace Timeline.Tests.IntegratedTests } { // self can delete self - var postId = await CreatePost(MockUser.User, "user"); + var postId = await CreatePost(MockUser.Ordinary, "user"); using var client = await CreateClientAsUser(); var res = await client.PostAsJsonAsync("users/user/timeline/postop/delete", new TimelinePostDeleteRequest { Id = postId }); @@ -339,7 +338,7 @@ namespace Timeline.Tests.IntegratedTests } { // admin can delete any - var postId = await CreatePost(MockUser.User, "user"); + var postId = await CreatePost(MockUser.Ordinary, "user"); using var client = await CreateClientAsAdmin(); var res = await client.PostAsJsonAsync("users/user/timeline/postop/delete", new TimelinePostDeleteRequest { Id = postId }); diff --git a/Timeline.Tests/IntegratedTests/TokenTest.cs b/Timeline.Tests/IntegratedTests/TokenTest.cs index ecd5d0b8..8ee19999 100644 --- a/Timeline.Tests/IntegratedTests/TokenTest.cs +++ b/Timeline.Tests/IntegratedTests/TokenTest.cs @@ -53,7 +53,7 @@ namespace Timeline.Tests.IntegratedTests public static IEnumerable CreateToken_UserCredential_Data() { yield return new[] { "usernotexist", "p" }; - yield return new[] { MockUser.User.Username, "???" }; + yield return new[] { MockUser.Ordinary.Username, "???" }; } [Theory] @@ -73,11 +73,11 @@ namespace Timeline.Tests.IntegratedTests { using var client = await CreateClientWithNoAuth(); var response = await client.PostAsJsonAsync(CreateTokenUrl, - new CreateTokenRequest { Username = MockUser.User.Username, Password = MockUser.User.Password }); + new CreateTokenRequest { Username = MockUser.Ordinary.Username, Password = MockUser.Ordinary.Password }); var body = response.Should().HaveStatusCode(200) .And.HaveJsonBody().Which; body.Token.Should().NotBeNullOrWhiteSpace(); - body.User.Should().BeEquivalentTo(MockUser.User.Info); + body.User.Should().BeEquivalentTo(MockUser.Ordinary.Info); } [Fact] @@ -103,13 +103,13 @@ namespace Timeline.Tests.IntegratedTests public async Task VerifyToken_OldVersion() { using var client = await CreateClientWithNoAuth(); - var token = (await CreateUserTokenAsync(client, MockUser.User.Username, MockUser.User.Password)).Token; + var token = (await CreateUserTokenAsync(client, MockUser.Ordinary.Username, MockUser.Ordinary.Password)).Token; using (var scope = Factory.Server.Host.Services.CreateScope()) // UserService is scoped. { // create a user for test var userService = scope.ServiceProvider.GetRequiredService(); - await userService.PatchUser(MockUser.User.Username, null, null); + await userService.PatchUser(MockUser.Ordinary.Username, null, null); } (await client.PostAsJsonAsync(VerifyTokenUrl, @@ -123,12 +123,12 @@ namespace Timeline.Tests.IntegratedTests public async Task VerifyToken_UserNotExist() { using var client = await CreateClientWithNoAuth(); - var token = (await CreateUserTokenAsync(client, MockUser.User.Username, MockUser.User.Password)).Token; + var token = (await CreateUserTokenAsync(client, MockUser.Ordinary.Username, MockUser.Ordinary.Password)).Token; using (var scope = Factory.Server.Host.Services.CreateScope()) // UserService is scoped. { var userService = scope.ServiceProvider.GetRequiredService(); - await userService.DeleteUser(MockUser.User.Username); + await userService.DeleteUser(MockUser.Ordinary.Username); } (await client.PostAsJsonAsync(VerifyTokenUrl, @@ -160,12 +160,12 @@ namespace Timeline.Tests.IntegratedTests public async Task VerifyToken_Success() { using var client = await CreateClientWithNoAuth(); - var createTokenResult = await CreateUserTokenAsync(client, MockUser.User.Username, MockUser.User.Password); + var createTokenResult = await CreateUserTokenAsync(client, MockUser.Ordinary.Username, MockUser.Ordinary.Password); var response = await client.PostAsJsonAsync(VerifyTokenUrl, new VerifyTokenRequest { Token = createTokenResult.Token }); response.Should().HaveStatusCode(200) .And.HaveJsonBody() - .Which.User.Should().BeEquivalentTo(MockUser.User.Info); + .Which.User.Should().BeEquivalentTo(MockUser.Ordinary.Info); } } } diff --git a/Timeline.Tests/IntegratedTests/UserAvatarTest.cs b/Timeline.Tests/IntegratedTests/UserAvatarTest.cs index a4e10634..989207e2 100644 --- a/Timeline.Tests/IntegratedTests/UserAvatarTest.cs +++ b/Timeline.Tests/IntegratedTests/UserAvatarTest.cs @@ -29,7 +29,6 @@ namespace Timeline.Tests.IntegratedTests } [Fact] - [System.Diagnostics.CodeAnalysis.SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "HttpMessageRequest should be disposed ???")] public async Task Test() { Avatar mockAvatar = new Avatar @@ -61,7 +60,7 @@ namespace Timeline.Tests.IntegratedTests EntityTagHeaderValue eTag; { - var res = await client.GetAsync($"users/user/avatar"); + var res = await client.GetAsync($"users/user1/avatar"); res.Should().HaveStatusCode(200); res.Content.Headers.ContentType.MediaType.Should().Be("image/png"); var body = await res.Content.ReadAsByteArrayAsync(); @@ -78,7 +77,7 @@ namespace Timeline.Tests.IntegratedTests { var request = new HttpRequestMessage() { - RequestUri = new Uri(client.BaseAddress, "users/user/avatar"), + RequestUri = new Uri(client.BaseAddress, "users/user1/avatar"), Method = HttpMethod.Get, }; request.Headers.TryAddWithoutValidation("If-None-Match", "\"dsdfd"); @@ -90,7 +89,7 @@ namespace Timeline.Tests.IntegratedTests { var request = new HttpRequestMessage() { - RequestUri = new Uri(client.BaseAddress, "users/user/avatar"), + RequestUri = new Uri(client.BaseAddress, "users/user1/avatar"), Method = HttpMethod.Get, }; request.Headers.TryAddWithoutValidation("If-None-Match", "\"aaa\""); @@ -101,7 +100,7 @@ namespace Timeline.Tests.IntegratedTests { var request = new HttpRequestMessage() { - RequestUri = new Uri(client.BaseAddress, "users/user/avatar"), + RequestUri = new Uri(client.BaseAddress, "users/user1/avatar"), Method = HttpMethod.Get, }; request.Headers.Add("If-None-Match", eTag.ToString()); @@ -112,7 +111,7 @@ namespace Timeline.Tests.IntegratedTests { var content = new ByteArrayContent(new[] { (byte)0x00 }); content.Headers.ContentType = new MediaTypeHeaderValue("image/png"); - var res = await client.PutAsync("users/user/avatar", content); + var res = await client.PutAsync("users/user1/avatar", content); res.Should().HaveStatusCode(HttpStatusCode.BadRequest) .And.HaveCommonBody().Which.Code.Should().Be(ErrorCodes.Common.Header.ContentLength_Missing); ; } @@ -120,7 +119,7 @@ namespace Timeline.Tests.IntegratedTests { var content = new ByteArrayContent(new[] { (byte)0x00 }); content.Headers.ContentLength = 1; - var res = await client.PutAsync("users/user/avatar", content); + var res = await client.PutAsync("users/user1/avatar", content); res.Should().HaveStatusCode(HttpStatusCode.BadRequest) .And.HaveCommonBody().Which.Code.Should().Be(ErrorCodes.Common.Header.ContentType_Missing); } @@ -129,13 +128,13 @@ namespace Timeline.Tests.IntegratedTests var content = new ByteArrayContent(new[] { (byte)0x00 }); content.Headers.ContentLength = 0; content.Headers.ContentType = new MediaTypeHeaderValue("image/png"); - var res = await client.PutAsync("users/user/avatar", content); + var res = await client.PutAsync("users/user1/avatar", content); res.Should().HaveStatusCode(HttpStatusCode.BadRequest) .And.HaveCommonBody().Which.Code.Should().Be(ErrorCodes.Common.Header.ContentLength_Zero); } { - var res = await client.PutByteArrayAsync("users/user/avatar", new[] { (byte)0x00 }, "image/notaccept"); + var res = await client.PutByteArrayAsync("users/user1/avatar", new[] { (byte)0x00 }, "image/notaccept"); res.Should().HaveStatusCode(HttpStatusCode.UnsupportedMediaType); } @@ -143,7 +142,7 @@ namespace Timeline.Tests.IntegratedTests var content = new ByteArrayContent(new[] { (byte)0x00 }); content.Headers.ContentLength = 1000 * 1000 * 11; content.Headers.ContentType = new MediaTypeHeaderValue("image/png"); - var res = await client.PutAsync("users/user/avatar", content); + var res = await client.PutAsync("users/user1/avatar", content); res.Should().HaveStatusCode(HttpStatusCode.BadRequest) .And.HaveCommonBody().Which.Code.Should().Be(ErrorCodes.Common.Content.TooBig); } @@ -152,7 +151,7 @@ namespace Timeline.Tests.IntegratedTests var content = new ByteArrayContent(new[] { (byte)0x00 }); content.Headers.ContentLength = 2; content.Headers.ContentType = new MediaTypeHeaderValue("image/png"); - var res = await client.PutAsync("users/user/avatar", content); + var res = await client.PutAsync("users/user1/avatar", content); res.Should().HaveStatusCode(HttpStatusCode.BadRequest) .And.HaveCommonBody().Which.Code.Should().Be(ErrorCodes.Common.Content.UnmatchedLength_Smaller); } @@ -161,34 +160,34 @@ namespace Timeline.Tests.IntegratedTests var content = new ByteArrayContent(new[] { (byte)0x00, (byte)0x01 }); content.Headers.ContentLength = 1; content.Headers.ContentType = new MediaTypeHeaderValue("image/png"); - var res = await client.PutAsync("users/user/avatar", content); + var res = await client.PutAsync("users/user1/avatar", content); res.Should().HaveStatusCode(HttpStatusCode.BadRequest) .And.HaveCommonBody().Which.Code.Should().Be(ErrorCodes.Common.Content.UnmatchedLength_Bigger); } { - var res = await client.PutByteArrayAsync("users/user/avatar", new[] { (byte)0x00 }, "image/png"); + var res = await client.PutByteArrayAsync("users/user1/avatar", new[] { (byte)0x00 }, "image/png"); res.Should().HaveStatusCode(HttpStatusCode.BadRequest) .And.HaveCommonBody().Which.Code.Should().Be(ErrorCodes.UserAvatar.BadFormat_CantDecode); } { - var res = await client.PutByteArrayAsync("users/user/avatar", mockAvatar.Data, "image/jpeg"); + var res = await client.PutByteArrayAsync("users/user1/avatar", mockAvatar.Data, "image/jpeg"); res.Should().HaveStatusCode(HttpStatusCode.BadRequest) .And.HaveCommonBody().Which.Code.Should().Be(ErrorCodes.UserAvatar.BadFormat_UnmatchedFormat); } { - var res = await client.PutByteArrayAsync("users/user/avatar", ImageHelper.CreatePngWithSize(100, 200), "image/png"); + var res = await client.PutByteArrayAsync("users/user1/avatar", ImageHelper.CreatePngWithSize(100, 200), "image/png"); res.Should().HaveStatusCode(HttpStatusCode.BadRequest) .And.HaveCommonBody().Which.Code.Should().Be(ErrorCodes.UserAvatar.BadFormat_BadSize); } { - var res = await client.PutByteArrayAsync("users/user/avatar", mockAvatar.Data, mockAvatar.Type); + var res = await client.PutByteArrayAsync("users/user1/avatar", mockAvatar.Data, mockAvatar.Type); res.Should().HaveStatusCode(HttpStatusCode.OK); - var res2 = await client.GetAsync("users/user/avatar"); + var res2 = await client.GetAsync("users/user1/avatar"); res2.Should().HaveStatusCode(200); res2.Content.Headers.ContentType.MediaType.Should().Be(mockAvatar.Type); var body = await res2.Content.ReadAsByteArrayAsync(); @@ -204,7 +203,7 @@ namespace Timeline.Tests.IntegratedTests foreach ((var mimeType, var format) in formats) { - var res = await client.PutByteArrayAsync("users/user/avatar", ImageHelper.CreateImageWithSize(100, 100, format), mimeType); + var res = await client.PutByteArrayAsync("users/user1/avatar", ImageHelper.CreateImageWithSize(100, 100, format), mimeType); res.Should().HaveStatusCode(HttpStatusCode.OK); } @@ -222,22 +221,22 @@ namespace Timeline.Tests.IntegratedTests for (int i = 0; i < 2; i++) // double delete should work. { - var res = await client.DeleteAsync("users/user/avatar"); + var res = await client.DeleteAsync("users/user1/avatar"); res.Should().HaveStatusCode(200); await GetReturnDefault(); } } // Authorization check. - using (var client = await CreateClientAsAdmin()) + using (var client = await CreateClientAsAdministrator()) { { - var res = await client.PutByteArrayAsync("users/user/avatar", mockAvatar.Data, mockAvatar.Type); + var res = await client.PutByteArrayAsync("users/user1/avatar", mockAvatar.Data, mockAvatar.Type); res.Should().HaveStatusCode(HttpStatusCode.OK); } { - var res = await client.DeleteAsync("users/user/avatar"); + var res = await client.DeleteAsync("users/user1/avatar"); res.Should().HaveStatusCode(HttpStatusCode.OK); } @@ -256,7 +255,7 @@ namespace Timeline.Tests.IntegratedTests } // bad username check - using (var client = await CreateClientAsAdmin()) + using (var client = await CreateClientAsAdministrator()) { { var res = await client.GetAsync("users/u!ser/avatar"); diff --git a/Timeline.Tests/IntegratedTests/UserDetailTest.cs b/Timeline.Tests/IntegratedTests/UserDetailTest.cs deleted file mode 100644 index 3781a816..00000000 --- a/Timeline.Tests/IntegratedTests/UserDetailTest.cs +++ /dev/null @@ -1,154 +0,0 @@ -using FluentAssertions; -using Microsoft.AspNetCore.Mvc.Testing; -using System.Net; -using System.Net.Http.Headers; -using System.Net.Mime; -using System.Threading.Tasks; -using Timeline.Models.Http; -using Timeline.Tests.Helpers; -using Xunit; - -namespace Timeline.Tests.IntegratedTests -{ - public class UserDetailTest : IntegratedTestBase - { - public UserDetailTest(WebApplicationFactory factory) - : base(factory) - { - - } - - [Fact] - public async Task PermissionTest() - { - { // unauthorize - using var client = await CreateClientWithNoAuth(); - { // GET - var res = await client.GetAsync($"users/{MockUser.User.Username}/nickname"); - res.Should().HaveStatusCode(HttpStatusCode.OK); - } - { // PUT - var res = await client.PutStringAsync($"users/{MockUser.User.Username}/nickname", "aaa"); - res.Should().HaveStatusCode(HttpStatusCode.Unauthorized); - } - { // DELETE - var res = await client.DeleteAsync($"users/{MockUser.User.Username}/nickname"); - res.Should().HaveStatusCode(HttpStatusCode.Unauthorized); - } - } - { // user - using var client = await CreateClientAsUser(); - { // GET - var res = await client.GetAsync($"users/{MockUser.User.Username}/nickname"); - res.Should().HaveStatusCode(HttpStatusCode.OK); - } - { // PUT self - var res = await client.PutStringAsync($"users/{MockUser.User.Username}/nickname", "aaa"); - res.Should().HaveStatusCode(HttpStatusCode.OK); - } - { // PUT other - var res = await client.PutStringAsync($"users/{MockUser.Admin.Username}/nickname", "aaa"); - res.Should().HaveStatusCode(HttpStatusCode.Forbidden); - } - { // DELETE self - var res = await client.DeleteAsync($"users/{MockUser.User.Username}/nickname"); - res.Should().HaveStatusCode(HttpStatusCode.OK); - } - { // DELETE other - var res = await client.DeleteAsync($"users/{MockUser.Admin.Username}/nickname"); - res.Should().HaveStatusCode(HttpStatusCode.Forbidden); - } - } - { // user - using var client = await CreateClientAsAdmin(); - { // PUT other - var res = await client.PutStringAsync($"users/{MockUser.User.Username}/nickname", "aaa"); - res.Should().HaveStatusCode(HttpStatusCode.OK); - } - { // DELETE other - var res = await client.DeleteAsync($"users/{MockUser.User.Username}/nickname"); - res.Should().HaveStatusCode(HttpStatusCode.OK); - } - } - } - - [Fact] - public async Task FunctionTest() - { - var url = $"users/{MockUser.User.Username}/nickname"; - var userNotExistUrl = "users/usernotexist/nickname"; - { - using var client = await CreateClientAsUser(); - { - var res = await client.GetAsync(userNotExistUrl); - res.Should().HaveStatusCode(HttpStatusCode.NotFound) - .And.HaveCommonBody() - .Which.Code.Should().Be(ErrorCodes.UserCommon.NotExist); - - } - { - var res = await client.GetAsync(url); - res.Should().HaveStatusCode(HttpStatusCode.OK); - res.Content.Headers.ContentType.Should().Be(new MediaTypeHeaderValue(MediaTypeNames.Text.Plain) { CharSet = "utf-8" }); - var body = await res.Content.ReadAsStringAsync(); - body.Should().Be(MockUser.User.Username); - } - { - var res = await client.PutStringAsync(url, ""); - res.Should().BeInvalidModel(); - } - { - var res = await client.PutStringAsync(url, new string('a', 11)); - res.Should().BeInvalidModel(); - } - var nickname1 = "nnn"; - var nickname2 = "nn2"; - { - var res = await client.PutStringAsync(url, nickname1); - res.Should().HaveStatusCode(HttpStatusCode.OK); - (await client.GetStringAsync(url)).Should().Be(nickname1); - } - { - var res = await client.PutStringAsync(url, nickname2); - res.Should().HaveStatusCode(HttpStatusCode.OK); - (await client.GetStringAsync(url)).Should().Be(nickname2); - } - { - var res = await client.DeleteAsync(url); - res.Should().HaveStatusCode(HttpStatusCode.OK); - (await client.GetStringAsync(url)).Should().Be(MockUser.User.Username); - } - { - var res = await client.DeleteAsync(url); - res.Should().HaveStatusCode(HttpStatusCode.OK); - } - } - { - using var client = await CreateClientAsAdmin(); - { - var res = await client.PutStringAsync(userNotExistUrl, "aaa"); - res.Should().HaveStatusCode(HttpStatusCode.BadRequest) - .And.HaveCommonBody() - .Which.Code.Should().Be(ErrorCodes.UserCommon.NotExist); - } - { - var res = await client.DeleteAsync(userNotExistUrl); - res.Should().HaveStatusCode(HttpStatusCode.BadRequest) - .And.HaveCommonBody() - .Which.Code.Should().Be(ErrorCodes.UserCommon.NotExist); - } - var nickname = "nnn"; - { - var res = await client.PutStringAsync(url, nickname); - res.Should().HaveStatusCode(HttpStatusCode.OK); - (await client.GetStringAsync(url)).Should().Be(nickname); - } - { - var res = await client.DeleteAsync(url); - res.Should().HaveStatusCode(HttpStatusCode.OK); - (await client.GetStringAsync(url)).Should().Be(MockUser.User.Username); - } - } - } - } -} diff --git a/Timeline.Tests/IntegratedTests/UserTest.cs b/Timeline.Tests/IntegratedTests/UserTest.cs index ea9f1177..4c2ccf7a 100644 --- a/Timeline.Tests/IntegratedTests/UserTest.cs +++ b/Timeline.Tests/IntegratedTests/UserTest.cs @@ -1,9 +1,9 @@ using FluentAssertions; using Microsoft.AspNetCore.Mvc.Testing; using System.Collections.Generic; +using System.Net; using System.Net.Http; using System.Threading.Tasks; -using Timeline.Models; using Timeline.Models.Http; using Timeline.Tests.Helpers; using Xunit; @@ -19,102 +19,144 @@ namespace Timeline.Tests.IntegratedTests } [Fact] - public async Task Get_List_Success() + public async Task GetList_NoAuth() { - using var client = await CreateClientAsAdmin(); - var res = await client.GetAsync("users"); + using var client = await CreateDefaultClient(); + var res = await client.GetAsync("/users"); res.Should().HaveStatusCode(200) - .And.HaveJsonBody() - .Which.Should().BeEquivalentTo(MockUser.UserInfoList); + .And.HaveJsonBody() + .Which.Should().BeEquivalentTo(UserInfoList); } [Fact] - public async Task Get_Single_Success() + public async Task GetList_User() { - using var client = await CreateClientAsAdmin(); - var res = await client.GetAsync("users/" + MockUser.User.Username); + using var client = await CreateClientAsUser(); + var res = await client.GetAsync("/users"); res.Should().HaveStatusCode(200) - .And.HaveJsonBody() - .Which.Should().BeEquivalentTo(MockUser.User.Info); + .And.HaveJsonBody() + .Which.Should().BeEquivalentTo(UserInfoList); } [Fact] - public async Task Get_InvalidModel() + public async Task GetList_Admin() { - using var client = await CreateClientAsAdmin(); - var res = await client.GetAsync("users/aaa!a"); - res.Should().BeInvalidModel(); + using var client = await CreateClientAsAdministrator(); + var res = await client.GetAsync("/users"); + res.Should().HaveStatusCode(200) + .And.HaveJsonBody() + .Which.Should().BeEquivalentTo(UserInfoForAdminList); } [Fact] - public async Task Get_Users_404() + public async Task Get_NoAuth() { - using var client = await CreateClientAsAdmin(); - var res = await client.GetAsync("users/usernotexist"); - res.Should().HaveStatusCode(404) - .And.HaveCommonBody() - .Which.Code.Should().Be(ErrorCodes.UserCommon.NotExist); + using var client = await CreateDefaultClient(); + var res = await client.GetAsync($"/users/admin"); + res.Should().HaveStatusCode(200) + .And.HaveJsonBody() + .Which.Should().BeEquivalentTo(UserInfoList[0]); } - public static IEnumerable Put_InvalidModel_Data() + [Fact] + public async Task Get_User() { - yield return new object[] { "aaa", null, false }; - yield return new object[] { "aaa", "p", null }; - yield return new object[] { "aa!a", "p", false }; + using var client = await CreateClientAsUser(); + var res = await client.GetAsync($"/users/admin"); + res.Should().HaveStatusCode(200) + .And.HaveJsonBody() + .Which.Should().BeEquivalentTo(UserInfoList[0]); } - [Theory] - [MemberData(nameof(Put_InvalidModel_Data))] - public async Task Put_InvalidModel(string username, string password, bool? administrator) + [Fact] + public async Task Get_Admin() { - using var client = await CreateClientAsAdmin(); - (await client.PutAsJsonAsync("users/" + username, - new UserPutRequest { Password = password, Administrator = administrator })) - .Should().BeInvalidModel(); + using var client = await CreateClientAsAdministrator(); + var res = await client.GetAsync($"/users/user1"); + res.Should().HaveStatusCode(200) + .And.HaveJsonBody() + .Which.Should().BeEquivalentTo(UserInfoForAdminList[1]); } - private async Task CheckAdministrator(HttpClient client, string username, bool administrator) + [Fact] + public async Task Get_InvalidModel() { - var res = await client.GetAsync("users/" + username); - res.Should().HaveStatusCode(200) - .And.HaveJsonBody() - .Which.Administrator.Should().Be(administrator); + using var client = await CreateClientAsUser(); + var res = await client.GetAsync("/users/aaa!a"); + res.Should().BeInvalidModel(); } [Fact] - public async Task Put_Modiefied() + public async Task Get_404() { - using var client = await CreateClientAsAdmin(); - var res = await client.PutAsJsonAsync("users/" + MockUser.User.Username, new UserPutRequest + using var client = await CreateClientAsUser(); + var res = await client.GetAsync("/users/usernotexist"); + res.Should().HaveStatusCode(404) + .And.HaveCommonBody(ErrorCodes.UserCommon.NotExist); + } + + [Fact] + public async Task Patch_User() + { + using var client = await CreateClientAsUser(); { - Password = "password", - Administrator = false - }); - res.Should().BePut(false); - await CheckAdministrator(client, MockUser.User.Username, false); + var res = await client.PatchAsJsonAsync("/users/user1", + new UserPatchRequest { Nickname = "aaa" }); + res.Should().HaveStatusCode(200); + } + + { + var res = await client.GetAsync("/users/user1"); + res.Should().HaveStatusCode(200) + .And.HaveJsonBody() + .Which.Nickname.Should().Be("aaa"); + } } [Fact] - public async Task Put_Created() + public async Task Patch_Admin() { - using var client = await CreateClientAsAdmin(); - const string username = "puttest"; - const string url = "users/" + username; + using var client = await CreateClientAsAdministrator(); + using var userClient = await CreateClientAsUser(); + + { + var res = await client.PatchAsJsonAsync("/users/user1", + new UserPatchRequest + { + Username = "newuser", + Password = "newpw", + Administrator = true, + Nickname = "aaa" + }); + res.Should().HaveStatusCode(200); + } - var res = await client.PutAsJsonAsync(url, new UserPutRequest { - Password = "password", - Administrator = false - }); - res.Should().BePut(true); - await CheckAdministrator(client, username, false); + var res = await client.GetAsync("/users/newuser"); + var body = res.Should().HaveStatusCode(200) + .And.HaveJsonBody() + .Which; + body.Administrator.Should().Be(true); + body.Nickname.Should().Be("aaa"); + } + + { + // Token should expire. + var res = await userClient.GetAsync("/users"); + res.Should().HaveStatusCode(HttpStatusCode.Unauthorized); + } + + { + // Check password. + (await CreateClientWithCredential("newuser", "newpw")).Dispose(); + } } [Fact] public async Task Patch_NotExist() { - using var client = await CreateClientAsAdmin(); - var res = await client.PatchAsJsonAsync("users/usernotexist", new UserPatchRequest { }); + using var client = await CreateClientAsAdministrator(); + var res = await client.PatchAsJsonAsync("/users/usernotexist", new UserPatchRequest { }); res.Should().HaveStatusCode(404) .And.HaveCommonBody() .Which.Code.Should().Be(ErrorCodes.UserCommon.NotExist); @@ -123,114 +165,239 @@ namespace Timeline.Tests.IntegratedTests [Fact] public async Task Patch_InvalidModel() { - using var client = await CreateClientAsAdmin(); - var res = await client.PatchAsJsonAsync("users/aaa!a", new UserPatchRequest { }); + using var client = await CreateClientAsAdministrator(); + var res = await client.PatchAsJsonAsync("/users/aaa!a", new UserPatchRequest { }); + res.Should().BeInvalidModel(); + } + + public static IEnumerable Patch_InvalidModel_Body_Data() + { + yield return new[] { new UserPatchRequest { Username = "aaa!a" } }; + yield return new[] { new UserPatchRequest { Password = "" } }; + yield return new[] { new UserPatchRequest { Nickname = new string('a', 50) } }; + } + + [Theory] + [MemberData(nameof(Patch_InvalidModel_Body_Data))] + public async Task Patch_InvalidModel_Body(UserPatchRequest body) + { + using var client = await CreateClientAsAdministrator(); + var res = await client.PatchAsJsonAsync("/users/user1", body); res.Should().BeInvalidModel(); } [Fact] - public async Task Patch_Success() + public async Task Patch_UsernameConflict() { - using var client = await CreateClientAsAdmin(); - { - var res = await client.PatchAsJsonAsync("users/" + MockUser.User.Username, - new UserPatchRequest { Administrator = false }); - res.Should().HaveStatusCode(200); - await CheckAdministrator(client, MockUser.User.Username, false); - } + using var client = await CreateClientAsAdministrator(); + var res = await client.PatchAsJsonAsync("/users/user1", new UserPatchRequest { Username = "admin" }); + res.Should().HaveStatusCode(400) + .And.HaveCommonBody(ErrorCodes.UserController.UsernameConflict); } [Fact] - public async Task Delete_InvalidModel() + public async Task Patch_NoAuth_Unauthorized() { - using var client = await CreateClientAsAdmin(); - var url = "users/aaa!a"; - var res = await client.DeleteAsync(url); - res.Should().BeInvalidModel(); + using var client = await CreateClientAsUser(); + var res = await client.PatchAsJsonAsync("/users/user1", new UserPatchRequest { Nickname = "aaa" }); + res.Should().HaveStatusCode(HttpStatusCode.Unauthorized); + } + + [Fact] + public async Task Patch_User_Forbid() + { + using var client = await CreateClientAsUser(); + var res = await client.PatchAsJsonAsync("/users/admin", new UserPatchRequest { Nickname = "aaa" }); + res.Should().HaveStatusCode(HttpStatusCode.Forbidden); + } + + [Fact] + public async Task Patch_Username_Forbid() + { + using var client = await CreateClientAsUser(); + var res = await client.PatchAsJsonAsync("/users/user1", new UserPatchRequest { Username = "aaa" }); + res.Should().HaveStatusCode(HttpStatusCode.Forbidden); + } + + [Fact] + public async Task Patch_Password_Forbid() + { + using var client = await CreateClientAsUser(); + var res = await client.PatchAsJsonAsync("/users/user1", new UserPatchRequest { Password = "aaa" }); + res.Should().HaveStatusCode(HttpStatusCode.Forbidden); + } + + [Fact] + public async Task Patch_Administrator_Forbid() + { + using var client = await CreateClientAsUser(); + var res = await client.PatchAsJsonAsync("/users/user1", new UserPatchRequest { Administrator = true }); + res.Should().HaveStatusCode(HttpStatusCode.Forbidden); } [Fact] public async Task Delete_Deleted() { - using var client = await CreateClientAsAdmin(); - var url = "users/" + MockUser.User.Username; - var res = await client.DeleteAsync(url); - res.Should().BeDelete(true); + using var client = await CreateClientAsAdministrator(); + { + var res = await client.DeleteAsync("/users/user1"); + res.Should().BeDelete(true); + } - var res2 = await client.GetAsync(url); - res2.Should().HaveStatusCode(404); + { + var res = await client.GetAsync("/users/user1"); + res.Should().HaveStatusCode(404); + } } [Fact] public async Task Delete_NotExist() { - using var client = await CreateClientAsAdmin(); - var res = await client.DeleteAsync("users/usernotexist"); + using var client = await CreateClientAsAdministrator(); + var res = await client.DeleteAsync("/users/usernotexist"); res.Should().BeDelete(false); } - private const string changeUsernameUrl = "userop/changeusername"; + [Fact] + public async Task Delete_InvalidModel() + { + using var client = await CreateClientAsAdministrator(); + var res = await client.DeleteAsync("/users/aaa!a"); + res.Should().BeInvalidModel(); + } - public static IEnumerable Op_ChangeUsername_InvalidModel_Data() + [Fact] + public async Task Delete_NoAuth_Unauthorized() { - yield return new[] { null, "uuu" }; - yield return new[] { "uuu", null }; - yield return new[] { "a!a", "uuu" }; - yield return new[] { "uuu", "a!a" }; + using var client = await CreateDefaultClient(); + var res = await client.DeleteAsync("/users/aaa!a"); + res.Should().HaveStatusCode(HttpStatusCode.Unauthorized); } - [Theory] - [MemberData(nameof(Op_ChangeUsername_InvalidModel_Data))] - public async Task Op_ChangeUsername_InvalidModel(string oldUsername, string newUsername) + [Fact] + public async Task Delete_User_Forbid() { - using var client = await CreateClientAsAdmin(); - (await client.PostAsJsonAsync(changeUsernameUrl, - new ChangeUsernameRequest { OldUsername = oldUsername, NewUsername = newUsername })) - .Should().BeInvalidModel(); + using var client = await CreateClientAsUser(); + var res = await client.DeleteAsync("/users/aaa!a"); + res.Should().HaveStatusCode(HttpStatusCode.Forbidden); } + private const string createUserUrl = "/userop/createuser"; + [Fact] - public async Task Op_ChangeUsername_UserNotExist() + public async Task Op_CreateUser() { - using var client = await CreateClientAsAdmin(); - var res = await client.PostAsJsonAsync(changeUsernameUrl, - new ChangeUsernameRequest { OldUsername = "usernotexist", NewUsername = "newUsername" }); - res.Should().HaveStatusCode(400) - .And.HaveCommonBody() - .Which.Code.Should().Be(ErrorCodes.UserCommon.NotExist); + using var client = await CreateClientAsAdministrator(); + { + var res = await client.PostAsJsonAsync(createUserUrl, new CreateUserRequest + { + Username = "aaa", + Password = "bbb", + Administrator = true, + Nickname = "ccc" + }); + res.Should().HaveStatusCode(200); + } + { + var res = await client.GetAsync("users/aaa"); + var body = res.Should().HaveStatusCode(200) + .And.HaveJsonBody().Which; + body.Username.Should().Be("aaa"); + body.Nickname.Should().Be("ccc"); + body.Administrator.Should().BeTrue(); + } + { + // Test password. + (await CreateClientWithCredential("aaa", "bbb")).Dispose(); + } + } + + public static IEnumerable Op_CreateUser_InvalidModel_Data() + { + yield return new[] { new CreateUserRequest { Username = "aaa", Password = "bbb" } }; + yield return new[] { new CreateUserRequest { Username = "aaa", Administrator = true } }; + yield return new[] { new CreateUserRequest { Password = "bbb", Administrator = true } }; + yield return new[] { new CreateUserRequest { Username = "a!a", Password = "bbb", Administrator = true } }; + yield return new[] { new CreateUserRequest { Username = "aaa", Password = "", Administrator = true } }; + yield return new[] { new CreateUserRequest { Username = "aaa", Password = "bbb", Administrator = true, Nickname = new string('a', 40) } }; + } + + [Theory] + [MemberData(nameof(Op_CreateUser_InvalidModel_Data))] + public async Task Op_CreateUser_InvalidModel(CreateUserRequest body) + { + using var client = await CreateClientAsAdministrator(); + { + var res = await client.PostAsJsonAsync(createUserUrl, body); + res.Should().BeInvalidModel(); + } } [Fact] - public async Task Op_ChangeUsername_UserAlreadyExist() + public async Task Op_CreateUser_UsernameConflict() { - using var client = await CreateClientAsAdmin(); - var res = await client.PostAsJsonAsync(changeUsernameUrl, - new ChangeUsernameRequest { OldUsername = MockUser.User.Username, NewUsername = MockUser.Admin.Username }); - res.Should().HaveStatusCode(400) - .And.HaveCommonBody() - .Which.Code.Should().Be(ErrorCodes.UserController.ChangeUsername_Conflict); + using var client = await CreateClientAsAdministrator(); + { + var res = await client.PostAsJsonAsync(createUserUrl, new CreateUserRequest + { + Username = "user1", + Password = "bbb", + Administrator = false + }); + res.Should().HaveStatusCode(400) + .And.HaveCommonBody(ErrorCodes.UserController.UsernameConflict); + } } - private async Task TestLogin(string username, string password) + [Fact] + public async Task Op_CreateUser_NoAuth_Unauthorized() { - using var client = await CreateClientWithNoAuth(); - var response = await client.PostAsJsonAsync("token/create", new CreateTokenRequest { Username = username, Password = password }); - response.Should().HaveStatusCode(200) - .And.HaveJsonBody(); + using var client = await CreateDefaultClient(); + { + var res = await client.PostAsJsonAsync(createUserUrl, new CreateUserRequest + { + Username = "aaa", + Password = "bbb", + Administrator = false + }); + res.Should().HaveStatusCode(HttpStatusCode.Unauthorized); + } } [Fact] - public async Task Op_ChangeUsername_Success() + public async Task Op_CreateUser_User_Forbid() { - using var client = await CreateClientAsAdmin(); - const string newUsername = "hahaha"; - var res = await client.PostAsJsonAsync(changeUsernameUrl, - new ChangeUsernameRequest { OldUsername = MockUser.User.Username, NewUsername = newUsername }); - res.Should().HaveStatusCode(200); - await TestLogin(newUsername, MockUser.User.Password); + using var client = await CreateClientAsUser(); + { + var res = await client.PostAsJsonAsync(createUserUrl, new CreateUserRequest + { + Username = "aaa", + Password = "bbb", + Administrator = false + }); + res.Should().HaveStatusCode(HttpStatusCode.Forbidden); + } } - private const string changePasswordUrl = "userop/changepassword"; + private const string changePasswordUrl = "/userop/changepassword"; + + [Fact] + public async Task Op_ChangePassword() + { + using var client = await CreateClientAsUser(); + { + var res = await client.PostAsJsonAsync(changePasswordUrl, + new ChangePasswordRequest { OldPassword = "user1pw", NewPassword = "newpw" }); + res.Should().HaveStatusCode(200); + } + { + var res = await client.PatchAsJsonAsync("/users/user1", new UserPatchRequest { }); + res.Should().HaveStatusCode(HttpStatusCode.Unauthorized); + } + { + (await CreateClientWithCredential("user1", "newpw")).Dispose(); + } + } public static IEnumerable Op_ChangePassword_InvalidModel_Data() { @@ -243,9 +410,9 @@ namespace Timeline.Tests.IntegratedTests public async Task Op_ChangePassword_InvalidModel(string oldPassword, string newPassword) { using var client = await CreateClientAsUser(); - (await client.PostAsJsonAsync(changePasswordUrl, - new ChangePasswordRequest { OldPassword = oldPassword, NewPassword = newPassword })) - .Should().BeInvalidModel(); + var res = await client.PostAsJsonAsync(changePasswordUrl, + new ChangePasswordRequest { OldPassword = oldPassword, NewPassword = newPassword }); + res.Should().BeInvalidModel(); } [Fact] @@ -254,19 +421,15 @@ namespace Timeline.Tests.IntegratedTests using var client = await CreateClientAsUser(); var res = await client.PostAsJsonAsync(changePasswordUrl, new ChangePasswordRequest { OldPassword = "???", NewPassword = "???" }); res.Should().HaveStatusCode(400) - .And.HaveCommonBody() - .Which.Code.Should().Be(ErrorCodes.UserController.ChangePassword_BadOldPassword); + .And.HaveCommonBody(ErrorCodes.UserController.ChangePassword_BadOldPassword); } [Fact] - public async Task Op_ChangePassword_Success() + public async Task Op_ChangePassword_NoAuth_Unauthorized() { - using var client = await CreateClientAsUser(); - const string newPassword = "new"; - var res = await client.PostAsJsonAsync(changePasswordUrl, - new ChangePasswordRequest { OldPassword = MockUser.User.Password, NewPassword = newPassword }); - res.Should().HaveStatusCode(200); - await TestLogin(MockUser.User.Username, newPassword); + using var client = await CreateDefaultClient(); + var res = await client.PostAsJsonAsync(changePasswordUrl, new ChangePasswordRequest { OldPassword = "???", NewPassword = "???" }); + res.Should().HaveStatusCode(HttpStatusCode.Unauthorized); } } } diff --git a/Timeline.Tests/Services/UserAvatarServiceTest.cs b/Timeline.Tests/Services/UserAvatarServiceTest.cs deleted file mode 100644 index 2dca7ccf..00000000 --- a/Timeline.Tests/Services/UserAvatarServiceTest.cs +++ /dev/null @@ -1,280 +0,0 @@ -using FluentAssertions; -using Microsoft.EntityFrameworkCore; -using Microsoft.Extensions.Logging.Abstractions; -using Moq; -using SixLabors.ImageSharp.Formats.Png; -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; -using Timeline.Entities; -using Timeline.Services; -using Timeline.Tests.Helpers; -using Xunit; - -namespace Timeline.Tests.Services -{ - public class UserAvatarValidatorTest : IClassFixture - { - private readonly UserAvatarValidator _validator; - - public UserAvatarValidatorTest(UserAvatarValidator validator) - { - _validator = validator; - } - - [Fact] - public void CantDecode() - { - Avatar avatar = new Avatar - { - Data = Encoding.ASCII.GetBytes("This is not a image."), - Type = "image/png" - }; - _validator.Awaiting(v => v.Validate(avatar)) - .Should().Throw() - .Where(e => e.Avatar == avatar && e.Error == AvatarFormatException.ErrorReason.CantDecode); - } - - [Fact] - public void UnmatchedFormat() - { - Avatar avatar = new Avatar - { - Data = ImageHelper.CreatePngWithSize(100, 100), - Type = "image/jpeg" - }; - _validator.Awaiting(v => v.Validate(avatar)) - .Should().Throw() - .Where(e => e.Avatar == avatar && e.Error == AvatarFormatException.ErrorReason.UnmatchedFormat); - } - - [Fact] - public void BadSize() - { - Avatar avatar = new Avatar - { - Data = ImageHelper.CreatePngWithSize(100, 200), - Type = PngFormat.Instance.DefaultMimeType - }; - _validator.Awaiting(v => v.Validate(avatar)) - .Should().Throw() - .Where(e => e.Avatar == avatar && e.Error == AvatarFormatException.ErrorReason.BadSize); - } - - [Fact] - public void Success() - { - Avatar avatar = new Avatar - { - Data = ImageHelper.CreatePngWithSize(100, 100), - Type = PngFormat.Instance.DefaultMimeType - }; - _validator.Awaiting(v => v.Validate(avatar)) - .Should().NotThrow(); - } - } - - public class UserAvatarServiceTest : IDisposable - { - private UserAvatarEntity CreateMockAvatarEntity(string key) => new UserAvatarEntity - { - Type = $"image/test{key}", - Data = Encoding.ASCII.GetBytes($"mock{key}"), - ETag = $"etag{key}", - LastModified = DateTime.Now - }; - - private AvatarInfo CreateMockAvatarInfo(string key) => new AvatarInfo - { - Avatar = new Avatar - { - Type = $"image/test{key}", - Data = Encoding.ASCII.GetBytes($"mock{key}") - }, - LastModified = DateTime.Now - }; - - private Avatar CreateMockAvatar(string key) => new Avatar - { - Type = $"image/test{key}", - Data = Encoding.ASCII.GetBytes($"mock{key}") - }; - - private static Avatar ToAvatar(UserAvatarEntity entity) - { - return new Avatar - { - Data = entity.Data, - Type = entity.Type - }; - } - - private static AvatarInfo ToAvatarInfo(UserAvatarEntity entity) - { - return new AvatarInfo - { - Avatar = ToAvatar(entity), - LastModified = entity.LastModified - }; - } - - private readonly Mock _mockDefaultAvatarProvider; - private readonly Mock _mockValidator; - private readonly Mock _mockETagGenerator; - private readonly Mock _mockClock; - - private readonly TestDatabase _database; - - private readonly UserAvatarService _service; - - public UserAvatarServiceTest() - { - _mockDefaultAvatarProvider = new Mock(); - _mockValidator = new Mock(); - _mockETagGenerator = new Mock(); - _mockClock = new Mock(); - - _database = new TestDatabase(); - - _service = new UserAvatarService(NullLogger.Instance, _database.Context, _mockDefaultAvatarProvider.Object, _mockValidator.Object, _mockETagGenerator.Object, _mockClock.Object); - } - - public void Dispose() - { - _database.Dispose(); - } - - [Theory] - [InlineData(null, typeof(ArgumentNullException))] - [InlineData("", typeof(UsernameBadFormatException))] - [InlineData("a!a", typeof(UsernameBadFormatException))] - [InlineData("usernotexist", typeof(UserNotExistException))] - public async Task GetAvatarETag_ShouldThrow(string username, Type exceptionType) - { - await _service.Awaiting(s => s.GetAvatarETag(username)).Should().ThrowAsync(exceptionType); - } - - [Fact] - public async Task GetAvatarETag_ShouldReturn_Default() - { - const string etag = "aaaaaa"; - _mockDefaultAvatarProvider.Setup(p => p.GetDefaultAvatarETag()).ReturnsAsync(etag); - (await _service.GetAvatarETag(MockUser.User.Username)).Should().Be(etag); - } - - [Fact] - public async Task GetAvatarETag_ShouldReturn_Data() - { - string username = MockUser.User.Username; - var mockAvatarEntity = CreateMockAvatarEntity("aaa"); - { - var context = _database.Context; - var user = await context.Users.Where(u => u.Username == username).Include(u => u.Avatar).SingleAsync(); - user.Avatar = mockAvatarEntity; - await context.SaveChangesAsync(); - } - (await _service.GetAvatarETag(username)).Should().BeEquivalentTo(mockAvatarEntity.ETag); - } - - [Theory] - [InlineData(null, typeof(ArgumentNullException))] - [InlineData("", typeof(UsernameBadFormatException))] - [InlineData("a!a", typeof(UsernameBadFormatException))] - [InlineData("usernotexist", typeof(UserNotExistException))] - public async Task GetAvatar_ShouldThrow(string username, Type exceptionType) - { - await _service.Awaiting(s => s.GetAvatar(username)).Should().ThrowAsync(exceptionType); - - } - - [Fact] - public async Task GetAvatar_ShouldReturn_Default() - { - var mockAvatar = CreateMockAvatarInfo("aaa"); - _mockDefaultAvatarProvider.Setup(p => p.GetDefaultAvatar()).ReturnsAsync(mockAvatar); - string username = MockUser.User.Username; - (await _service.GetAvatar(username)).Should().BeEquivalentTo(mockAvatar); - } - - [Fact] - public async Task GetAvatar_ShouldReturn_Data() - { - string username = MockUser.User.Username; - var mockAvatarEntity = CreateMockAvatarEntity("aaa"); - { - var context = _database.Context; - var user = await context.Users.Where(u => u.Username == username).Include(u => u.Avatar).SingleAsync(); - user.Avatar = mockAvatarEntity; - await context.SaveChangesAsync(); - } - - (await _service.GetAvatar(username)).Should().BeEquivalentTo(ToAvatarInfo(mockAvatarEntity)); - } - - public static IEnumerable SetAvatar_ShouldThrow_Data() - { - yield return new object[] { null, null, typeof(ArgumentNullException) }; - yield return new object[] { "", null, typeof(UsernameBadFormatException) }; - yield return new object[] { "u!u", null, typeof(UsernameBadFormatException) }; - yield return new object[] { null, new Avatar { Type = null, Data = new[] { (byte)0x00 } }, typeof(ArgumentException) }; - yield return new object[] { null, new Avatar { Type = "", Data = new[] { (byte)0x00 } }, typeof(ArgumentException) }; - yield return new object[] { null, new Avatar { Type = "aaa", Data = null }, typeof(ArgumentException) }; - yield return new object[] { "usernotexist", null, typeof(UserNotExistException) }; - } - - [Theory] - [MemberData(nameof(SetAvatar_ShouldThrow_Data))] - public async Task SetAvatar_ShouldThrow(string username, Avatar avatar, Type exceptionType) - { - await _service.Awaiting(s => s.SetAvatar(username, avatar)).Should().ThrowAsync(exceptionType); - } - - [Fact] - public async Task SetAvatar_Should_Work() - { - string username = MockUser.User.Username; - - var user = await _database.Context.Users.Where(u => u.Username == username).Include(u => u.Avatar).SingleAsync(); - - var avatar1 = CreateMockAvatar("aaa"); - var avatar2 = CreateMockAvatar("bbb"); - - string etag1 = "etagaaa"; - string etag2 = "etagbbb"; - - DateTime dateTime1 = DateTime.Now.AddSeconds(2); - DateTime dateTime2 = DateTime.Now.AddSeconds(10); - DateTime dateTime3 = DateTime.Now.AddSeconds(20); - - // create - _mockETagGenerator.Setup(g => g.Generate(avatar1.Data)).ReturnsAsync(etag1); - _mockClock.Setup(c => c.GetCurrentTime()).Returns(dateTime1); - await _service.SetAvatar(username, avatar1); - user.Avatar.Should().NotBeNull(); - user.Avatar.Type.Should().Be(avatar1.Type); - user.Avatar.Data.Should().Equal(avatar1.Data); - user.Avatar.ETag.Should().Be(etag1); - user.Avatar.LastModified.Should().Be(dateTime1); - - // modify - _mockETagGenerator.Setup(g => g.Generate(avatar2.Data)).ReturnsAsync(etag2); - _mockClock.Setup(c => c.GetCurrentTime()).Returns(dateTime2); - await _service.SetAvatar(username, avatar2); - user.Avatar.Should().NotBeNull(); - user.Avatar.Type.Should().Be(avatar2.Type); - user.Avatar.Data.Should().Equal(avatar2.Data); - user.Avatar.ETag.Should().Be(etag2); - user.Avatar.LastModified.Should().Be(dateTime2); - - // delete - _mockClock.Setup(c => c.GetCurrentTime()).Returns(dateTime3); - await _service.SetAvatar(username, null); - user.Avatar.Type.Should().BeNull(); - user.Avatar.Data.Should().BeNull(); - user.Avatar.ETag.Should().BeNull(); - user.Avatar.LastModified.Should().Be(dateTime3); - } - } -} diff --git a/Timeline.Tests/Services/UserDetailServiceTest.cs b/Timeline.Tests/Services/UserDetailServiceTest.cs deleted file mode 100644 index dbff2705..00000000 --- a/Timeline.Tests/Services/UserDetailServiceTest.cs +++ /dev/null @@ -1,107 +0,0 @@ -using FluentAssertions; -using Microsoft.EntityFrameworkCore; -using Microsoft.Extensions.Logging.Abstractions; -using System; -using System.Linq; -using System.Threading.Tasks; -using Timeline.Entities; -using Timeline.Services; -using Timeline.Tests.Helpers; -using Xunit; - -namespace Timeline.Tests.Services -{ - public class UserDetailServiceTest : IDisposable - { - private readonly TestDatabase _testDatabase; - - private readonly UserDetailService _service; - - public UserDetailServiceTest() - { - _testDatabase = new TestDatabase(); - _service = new UserDetailService(_testDatabase.Context, NullLogger.Instance); - } - - public void Dispose() - { - _testDatabase.Dispose(); - } - - [Theory] - [InlineData(null, typeof(ArgumentNullException))] - [InlineData("", typeof(UsernameBadFormatException))] - [InlineData("a!a", typeof(UsernameBadFormatException))] - [InlineData("usernotexist", typeof(UserNotExistException))] - public async Task GetNickname_ShouldThrow(string username, Type exceptionType) - { - await _service.Awaiting(s => s.GetNickname(username)).Should().ThrowAsync(exceptionType); - } - - [Fact] - public async Task GetNickname_ShouldReturnUsername() - { - var result = await _service.GetNickname(MockUser.User.Username); - result.Should().Be(MockUser.User.Username); - } - - [Fact] - public async Task GetNickname_ShouldReturnData() - { - const string nickname = "aaaaaa"; - { - var context = _testDatabase.Context; - var userId = (await context.Users.Where(u => u.Username == MockUser.User.Username).Select(u => new { u.Id }).SingleAsync()).Id; - context.UserDetails.Add(new UserDetailEntity - { - Nickname = nickname, - UserId = userId - }); - await context.SaveChangesAsync(); - } - var result = await _service.GetNickname(MockUser.User.Username); - result.Should().Be(nickname); - } - - [Theory] - [InlineData(null, typeof(ArgumentNullException))] - [InlineData("", typeof(UsernameBadFormatException))] - [InlineData("a!a", typeof(UsernameBadFormatException))] - [InlineData("usernotexist", typeof(UserNotExistException))] - public async Task SetNickname_ShouldThrow(string username, Type exceptionType) - { - await _service.Awaiting(s => s.SetNickname(username, null)).Should().ThrowAsync(exceptionType); - } - - [Fact] - public async Task SetNickname_ShouldThrow_ArgumentException() - { - await _service.Awaiting(s => s.SetNickname("uuu", new string('a', 50))).Should().ThrowAsync(); - } - - [Fact] - public async Task SetNickname_ShouldWork() - { - var username = MockUser.User.Username; - var user = await _testDatabase.Context.Users.Where(u => u.Username == username).Include(u => u.Detail).SingleAsync(); - - var nickname1 = "nickname1"; - var nickname2 = "nickname2"; - - await _service.SetNickname(username, null); - user.Detail.Should().BeNull(); - - await _service.SetNickname(username, nickname1); - user.Detail.Should().NotBeNull(); - user.Detail.Nickname.Should().Be(nickname1); - - await _service.SetNickname(username, nickname2); - user.Detail.Should().NotBeNull(); - user.Detail.Nickname.Should().Be(nickname2); - - await _service.SetNickname(username, null); - user.Detail.Should().NotBeNull(); - user.Detail.Nickname.Should().BeNull(); - } - } -} diff --git a/Timeline.Tests/Services/UserTokenManagerTest.cs b/Timeline.Tests/Services/UserTokenManagerTest.cs deleted file mode 100644 index e649fbab..00000000 --- a/Timeline.Tests/Services/UserTokenManagerTest.cs +++ /dev/null @@ -1,163 +0,0 @@ -using FluentAssertions; -using Microsoft.Extensions.Logging.Abstractions; -using Moq; -using System; -using System.Threading.Tasks; -using Timeline.Models; -using Timeline.Services; -using Timeline.Tests.Helpers; -using Xunit; - -namespace Timeline.Tests.Services -{ - public class UserTokenManagerTest - { - private readonly UserTokenManager _service; - - private readonly Mock _mockUserService; - private readonly Mock _mockUserTokenService; - private readonly TestClock _mockClock; - - public UserTokenManagerTest() - { - _mockUserService = new Mock(); - _mockUserTokenService = new Mock(); - _mockClock = new TestClock(); - - _service = new UserTokenManager(NullLogger.Instance, _mockUserService.Object, _mockUserTokenService.Object, _mockClock); - } - - [Theory] - [InlineData(null, "aaa", "username")] - [InlineData("aaa", null, "password")] - public void CreateToken_NullArgument(string username, string password, string paramName) - { - _service.Invoking(s => s.CreateToken(username, password)).Should().Throw() - .Which.ParamName.Should().Be(paramName); - } - - [Theory] - [InlineData(typeof(UsernameBadFormatException))] - [InlineData(typeof(UserNotExistException))] - [InlineData(typeof(BadPasswordException))] - public async Task CreateToken_VerifyCredential_Throw(Type exceptionType) - { - const string username = "uuu"; - const string password = "ppp"; - _mockUserService.Setup(s => s.VerifyCredential(username, password)).ThrowsAsync((Exception)Activator.CreateInstance(exceptionType)); - await _service.Awaiting(s => s.CreateToken(username, password)).Should().ThrowAsync(exceptionType); - } - - [Theory] - [InlineData(false)] - [InlineData(true)] - public async Task CreateToken_Success(bool setExpireTime) - { - const string username = "uuu"; - const string password = "ppp"; - var mockExpireTime = setExpireTime ? (DateTime?)DateTime.Now : null; - var mockUserInfo = new User - { - Id = 1, - Username = username, - Administrator = false, - Version = 1 - }; - const string mockToken = "mocktokenaaaaaaa"; - - _mockUserService.Setup(s => s.VerifyCredential(username, password)).ReturnsAsync(mockUserInfo); - _mockUserTokenService.Setup(s => s.GenerateToken( - It.Is(userTokenInfo => - userTokenInfo.Id == mockUserInfo.Id && - userTokenInfo.Version == mockUserInfo.Version && - userTokenInfo.ExpireAt == mockExpireTime))).Returns(mockToken); - (await _service.CreateToken(username, password, mockExpireTime)) - .Should().BeEquivalentTo(new UserTokenCreateResult - { - Token = mockToken, - User = mockUserInfo - }); - } - - [Fact] - public void VerifyToken_NullArgument() - { - _service.Invoking(s => s.VerifyToken(null)).Should().ThrowAsync(); - } - - [Fact] - public async Task VerifyToken_BadFormat() - { - const string mockToken = "mocktokenaaaaaa"; - _mockUserTokenService.Setup(s => s.VerifyToken(mockToken)).Throws(new UserTokenBadFormatException()); - - await _service.Awaiting(s => s.VerifyToken(mockToken)).Should().ThrowAsync(); - } - - [Fact] - public async Task VerifyToken_TimeExpire() - { - const string mockToken = "mocktokenaaaaaa"; - var mockTime = DateTime.Now; - _mockClock.MockCurrentTime = mockTime; - var mockTokenInfo = new UserTokenInfo - { - Id = 1, - Version = 1, - ExpireAt = mockTime.AddDays(-1) - }; - _mockUserTokenService.Setup(s => s.VerifyToken(mockToken)).Returns(mockTokenInfo); - - await _service.Awaiting(s => s.VerifyToken(mockToken)).Should().ThrowAsync(); - } - - [Fact] - public async Task VerifyToken_BadVersion() - { - const string mockToken = "mocktokenaaaaaa"; - var mockTime = DateTime.Now; - _mockClock.MockCurrentTime = mockTime; - var mockTokenInfo = new UserTokenInfo - { - Id = 1, - Version = 1, - ExpireAt = mockTime.AddDays(1) - }; - _mockUserTokenService.Setup(s => s.VerifyToken(mockToken)).Returns(mockTokenInfo); - _mockUserService.Setup(s => s.GetUserById(1)).ReturnsAsync(new User - { - Id = 1, - Username = "aaa", - Administrator = false, - Version = 2 - }); - - await _service.Awaiting(s => s.VerifyToken(mockToken)).Should().ThrowAsync(); - } - - [Fact] - public async Task VerifyToken_Success() - { - const string mockToken = "mocktokenaaaaaa"; - var mockTime = DateTime.Now; - _mockClock.MockCurrentTime = mockTime; - var mockTokenInfo = new UserTokenInfo - { - Id = 1, - Version = 1, - ExpireAt = mockTime.AddDays(1) - }; - var mockUserInfo = new User - { - Id = 1, - Username = "aaa", - Administrator = false, - Version = 1 - }; - _mockUserTokenService.Setup(s => s.VerifyToken(mockToken)).Returns(mockTokenInfo); - _mockUserService.Setup(s => s.GetUserById(1)).ReturnsAsync(mockUserInfo); - - (await _service.VerifyToken(mockToken)).Should().BeEquivalentTo(mockUserInfo); - } - } -} diff --git a/Timeline.Tests/Timeline.Tests.csproj b/Timeline.Tests/Timeline.Tests.csproj index bde4f430..40e8cda2 100644 --- a/Timeline.Tests/Timeline.Tests.csproj +++ b/Timeline.Tests/Timeline.Tests.csproj @@ -18,7 +18,6 @@ all runtime; build; native; contentfiles; analyzers; buildtransitive - diff --git a/Timeline/Auth/MyAuthenticationHandler.cs b/Timeline/Auth/MyAuthenticationHandler.cs index e6b26c4b..3c97c329 100644 --- a/Timeline/Auth/MyAuthenticationHandler.cs +++ b/Timeline/Auth/MyAuthenticationHandler.cs @@ -8,7 +8,6 @@ using System.Linq; using System.Security.Claims; using System.Text.Encodings.Web; using System.Threading.Tasks; -using Timeline.Models; using Timeline.Services; using static Timeline.Resources.Authentication.AuthHandler; diff --git a/Timeline/Controllers/ControllerAuthExtensions.cs b/Timeline/Controllers/ControllerAuthExtensions.cs index 81fd2428..90da8a93 100644 --- a/Timeline/Controllers/ControllerAuthExtensions.cs +++ b/Timeline/Controllers/ControllerAuthExtensions.cs @@ -26,5 +26,20 @@ namespace Timeline.Controllers throw new InvalidOperationException("Failed to get user id because NameIdentifier claim is not a number."); } + + public static long? GetOptionalUserId(this ControllerBase controller) + { + if (controller.User == null) + return null; + + var claim = controller.User.FindFirst(ClaimTypes.NameIdentifier); + if (claim == null) + throw new InvalidOperationException("Failed to get user id because User has no NameIdentifier claim."); + + if (long.TryParse(claim.Value, out var value)) + return value; + + throw new InvalidOperationException("Failed to get user id because NameIdentifier claim is not a number."); + } } } diff --git a/Timeline/Controllers/PersonalTimelineController.cs b/Timeline/Controllers/PersonalTimelineController.cs index 2c70fad1..27618c41 100644 --- a/Timeline/Controllers/PersonalTimelineController.cs +++ b/Timeline/Controllers/PersonalTimelineController.cs @@ -4,45 +4,21 @@ using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Logging; using System.Collections.Generic; using System.Threading.Tasks; -using Timeline.Auth; using Timeline.Filters; -using Timeline.Models; using Timeline.Models.Http; using Timeline.Models.Validation; using Timeline.Services; -using static Timeline.Resources.Controllers.TimelineController; -using static Timeline.Resources.Messages; namespace Timeline.Controllers { [ApiController] + [CatchTimelineNotExistException] public class PersonalTimelineController : Controller { private readonly ILogger _logger; private readonly IPersonalTimelineService _service; - private bool IsAdmin() - { - if (User != null) - { - return User.IsAdministrator(); - } - return false; - } - - private string? GetAuthUsername() - { - if (User == null) - { - return null; - } - else - { - return User.Identity.Name; - } - } - public PersonalTimelineController(ILogger logger, IPersonalTimelineService service) { _logger = logger; @@ -50,17 +26,15 @@ namespace Timeline.Controllers } [HttpGet("users/{username}/timeline")] - [CatchTimelineNotExistException] public async Task> TimelineGet([FromRoute][Username] string username) { return await _service.GetTimeline(username); } [HttpGet("users/{username}/timeline/posts")] - [CatchTimelineNotExistException] public async Task>> PostListGet([FromRoute][Username] string username) { - if (!IsAdmin() && !await _service.HasReadPermission(username, GetAuthUsername())) + if (!this.IsAdministrator() && !await _service.HasReadPermission(username, this.GetOptionalUserId())) { return StatusCode(StatusCodes.Status403Forbidden, ErrorResponse.Common.Forbid()); } @@ -68,77 +42,88 @@ namespace Timeline.Controllers return await _service.GetPosts(username); } - [HttpPost("users/{username}/timeline/postop/create")] + [HttpPost("users/{username}/timeline/posts")] [Authorize] - [CatchTimelineNotExistException] - public async Task> PostOperationCreate([FromRoute][Username] string username, [FromBody] TimelinePostCreateRequest body) + public async Task> PostPost([FromRoute][Username] string username, [FromBody] TimelinePostCreateRequest body) { - if (!IsAdmin() && !await _service.IsMemberOf(username, GetAuthUsername()!)) + var id = this.GetUserId(); + if (!this.IsAdministrator() && !await _service.IsMemberOf(username, id)) { return StatusCode(StatusCodes.Status403Forbidden, ErrorResponse.Common.Forbid()); } - var res = await _service.CreatePost(username, User.Identity.Name!, body.Content, body.Time); + var res = await _service.CreatePost(username, id, body.Content, body.Time); return res; } - [HttpPost("users/{username}/timeline/postop/delete")] + [HttpDelete("users/{username}/timeline/posts/{id}")] [Authorize] - [CatchTimelineNotExistException] - public async Task PostOperationDelete([FromRoute][Username] string username, [FromBody] TimelinePostDeleteRequest body) + public async Task PostDelete([FromRoute][Username] string username, [FromRoute] long id) { try { - var postId = body.Id!.Value; - if (!IsAdmin() && !await _service.HasPostModifyPermission(username, postId, GetAuthUsername()!)) + if (!this.IsAdministrator() && !await _service.HasPostModifyPermission(username, id, this.GetUserId())) { return StatusCode(StatusCodes.Status403Forbidden, ErrorResponse.Common.Forbid()); } - await _service.DeletePost(username, postId); + await _service.DeletePost(username, id); + return Ok(CommonDeleteResponse.Delete()); } catch (TimelinePostNotExistException) { - return BadRequest(ErrorResponse.TimelineController.PostOperationDelete_NotExist()); + return Ok(CommonDeleteResponse.NotExist()); } - return Ok(); } - [HttpPost("users/{username}/timeline/op/property")] + [HttpPatch("users/{username}/timeline")] [Authorize] - [SelfOrAdmin] - [CatchTimelineNotExistException] - public async Task TimelineChangeProperty([FromRoute][Username] string username, [FromBody] TimelinePropertyChangeRequest body) + public async Task TimelinePatch([FromRoute][Username] string username, [FromBody] TimelinePatchRequest body) { + if (!this.IsAdministrator() && !(User.Identity.Name == username)) + { + return StatusCode(StatusCodes.Status403Forbidden, ErrorResponse.Common.Forbid()); + } await _service.ChangeProperty(username, body); return Ok(); } - [HttpPost("users/{username}/timeline/op/member")] + [HttpPut("users/{username}/timeline/members/{member}")] [Authorize] - [SelfOrAdmin] - [CatchTimelineNotExistException] - public async Task TimelineChangeMember([FromRoute][Username] string username, [FromBody] TimelineMemberChangeRequest body) + public async Task TimelineMemberPut([FromRoute][Username] string username, [FromRoute][Username] string member) { + if (!this.IsAdministrator() && !(User.Identity.Name == username)) + { + return StatusCode(StatusCodes.Status403Forbidden, ErrorResponse.Common.Forbid()); + } + try { - await _service.ChangeMember(username, body.Add, body.Remove); + await _service.ChangeMember(username, new List { member }, null); return Ok(); } - catch (TimelineMemberOperationUserException e) + catch (UserNotExistException) { - if (e.InnerException is UsernameBadFormatException) - { - return BadRequest(ErrorResponse.Common.CustomMessage_InvalidModel( - TimelineController_ChangeMember_UsernameBadFormat, e.Index, e.Operation)); - } - else if (e.InnerException is UserNotExistException) - { - return BadRequest(ErrorResponse.UserCommon.CustomMessage_NotExist( - TimelineController_ChangeMember_UserNotExist, e.Index, e.Operation)); - } + return BadRequest(ErrorResponse.TimelineController.MemberPut_NotExist()); + } + } + + [HttpDelete("users/{username}/timeline/members/{member}")] + [Authorize] + public async Task TimelineMemberDelete([FromRoute][Username] string username, [FromRoute][Username] string member) + { + if (!this.IsAdministrator() && !(User.Identity.Name == username)) + { + return StatusCode(StatusCodes.Status403Forbidden, ErrorResponse.Common.Forbid()); + } - _logger.LogError(e, LogUnknownTimelineMemberOperationUserException); - throw; + try + { + await _service.ChangeMember(username, null, new List { member }); + return Ok(CommonDeleteResponse.Delete()); + } + catch (UserNotExistException) + { + return Ok(CommonDeleteResponse.NotExist()); } } } diff --git a/Timeline/Controllers/Testing/TestingI18nController.cs b/Timeline/Controllers/Testing/TestingI18nController.cs deleted file mode 100644 index febb56a5..00000000 --- a/Timeline/Controllers/Testing/TestingI18nController.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Threading.Tasks; -using Microsoft.AspNetCore.Mvc; -using Microsoft.Extensions.Localization; - -// For more information on enabling Web API for empty projects, visit https://go.microsoft.com/fwlink/?LinkID=397860 - -namespace Timeline.Controllers.Testing -{ - [Route("testing/i18n")] - [ApiController] - public class TestingI18nController : Controller - { - private readonly IStringLocalizer _stringLocalizer; - - public TestingI18nController(IStringLocalizer stringLocalizer) - { - _stringLocalizer = stringLocalizer; - } - - [HttpGet("direct")] - [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1822:Mark members as static")] - public ActionResult Direct() - { - return Resources.Controllers.Testing.TestingI18nController.TestString; - } - - [HttpGet("localizer")] - public ActionResult Localizer() - { - return _stringLocalizer["TestString"].Value; - } - } -} diff --git a/Timeline/Controllers/TokenController.cs b/Timeline/Controllers/TokenController.cs index 9724c1a6..a7f5fbde 100644 --- a/Timeline/Controllers/TokenController.cs +++ b/Timeline/Controllers/TokenController.cs @@ -1,3 +1,4 @@ +using AutoMapper; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Logging; @@ -5,7 +6,6 @@ using System; using System.Globalization; using System.Threading.Tasks; using Timeline.Helpers; -using Timeline.Models; using Timeline.Models.Http; using Timeline.Services; using static Timeline.Resources.Controllers.TokenController; @@ -20,20 +20,14 @@ namespace Timeline.Controllers private readonly ILogger _logger; private readonly IClock _clock; - private static Models.Http.User CreateUserFromUserInfo(Models.User userInfo) - { - return new Models.Http.User - { - Username = userInfo.Username, - Administrator = userInfo.Administrator - }; - } + private readonly IMapper _mapper; - public TokenController(IUserTokenManager userTokenManager, ILogger logger, IClock clock) + public TokenController(IUserTokenManager userTokenManager, ILogger logger, IClock clock, IMapper mapper) { _userTokenManager = userTokenManager; _logger = logger; _clock = clock; + _mapper = mapper; } [HttpPost("create")] @@ -65,7 +59,7 @@ namespace Timeline.Controllers return Ok(new CreateTokenResponse { Token = result.Token, - User = CreateUserFromUserInfo(result.User) + User = _mapper.Map(result.User) }); } catch (UserNotExistException e) @@ -100,7 +94,7 @@ namespace Timeline.Controllers ("Username", result.Username), ("Token", request.Token))); return Ok(new VerifyTokenResponse { - User = CreateUserFromUserInfo(result) + User = _mapper.Map(result) }); } catch (UserTokenTimeExpireException e) diff --git a/Timeline/Controllers/UserAvatarController.cs b/Timeline/Controllers/UserAvatarController.cs index 62f1d78c..ab0ad8e7 100644 --- a/Timeline/Controllers/UserAvatarController.cs +++ b/Timeline/Controllers/UserAvatarController.cs @@ -21,11 +21,13 @@ namespace Timeline.Controllers { private readonly ILogger _logger; + private readonly IUserService _userService; private readonly IUserAvatarService _service; - public UserAvatarController(ILogger logger, IUserAvatarService service) + public UserAvatarController(ILogger logger, IUserService userService, IUserAvatarService service) { _logger = logger; + _userService = userService; _service = service; } @@ -33,46 +35,50 @@ namespace Timeline.Controllers [ResponseCache(NoStore = false, Location = ResponseCacheLocation.None, Duration = 0)] public async Task Get([FromRoute][Username] string username) { - const string IfNonMatchHeaderKey = "If-None-Match"; - + long id; try { - var eTagValue = $"\"{await _service.GetAvatarETag(username)}\""; - var eTag = new EntityTagHeaderValue(eTagValue); - - if (Request.Headers.TryGetValue(IfNonMatchHeaderKey, out var value)) - { - if (!EntityTagHeaderValue.TryParseStrictList(value, out var eTagList)) - { - _logger.LogInformation(Log.Format(LogGetBadIfNoneMatch, - ("Username", username), ("If-None-Match", value))); - return BadRequest(ErrorResponse.Common.Header.IfNonMatch_BadFormat()); - } - - if (eTagList.FirstOrDefault(e => e.Equals(eTag)) != null) - { - Response.Headers.Add("ETag", eTagValue); - _logger.LogInformation(Log.Format(LogGetReturnNotModify, ("Username", username))); - return StatusCode(StatusCodes.Status304NotModified); - } - } - - var avatarInfo = await _service.GetAvatar(username); - var avatar = avatarInfo.Avatar; - - _logger.LogInformation(Log.Format(LogGetReturnData, ("Username", username))); - return File(avatar.Data, avatar.Type, new DateTimeOffset(avatarInfo.LastModified), eTag); + id = await _userService.GetUserIdByUsername(username); } catch (UserNotExistException e) { _logger.LogInformation(e, Log.Format(LogGetUserNotExist, ("Username", username))); return NotFound(ErrorResponse.UserCommon.NotExist()); } + + const string IfNonMatchHeaderKey = "If-None-Match"; + + var eTagValue = $"\"{await _service.GetAvatarETag(id)}\""; + var eTag = new EntityTagHeaderValue(eTagValue); + + if (Request.Headers.TryGetValue(IfNonMatchHeaderKey, out var value)) + { + if (!EntityTagHeaderValue.TryParseStrictList(value, out var eTagList)) + { + _logger.LogInformation(Log.Format(LogGetBadIfNoneMatch, + ("Username", username), ("If-None-Match", value))); + return BadRequest(ErrorResponse.Common.Header.IfNonMatch_BadFormat()); + } + + if (eTagList.FirstOrDefault(e => e.Equals(eTag)) != null) + { + Response.Headers.Add("ETag", eTagValue); + _logger.LogInformation(Log.Format(LogGetReturnNotModify, ("Username", username))); + return StatusCode(StatusCodes.Status304NotModified); + } + } + + var avatarInfo = await _service.GetAvatar(id); + var avatar = avatarInfo.Avatar; + + _logger.LogInformation(Log.Format(LogGetReturnData, ("Username", username))); + return File(avatar.Data, avatar.Type, new DateTimeOffset(avatarInfo.LastModified), eTag); + } [HttpPut("users/{username}/avatar")] [Authorize] - [RequireContentType, RequireContentLength] + [RequireContentLength] [Consumes("image/png", "image/jpeg", "image/gif", "image/webp")] public async Task Put([FromRoute][Username] string username) { @@ -87,6 +93,17 @@ namespace Timeline.Controllers return StatusCode(StatusCodes.Status403Forbidden, ErrorResponse.Common.Forbid()); } + long id; + try + { + id = await _userService.GetUserIdByUsername(username); + } + catch (UserNotExistException e) + { + _logger.LogInformation(e, Log.Format(LogPutUserNotExist, ("Username", username))); + return BadRequest(ErrorResponse.UserCommon.NotExist()); + } + try { var data = new byte[contentLength]; @@ -99,7 +116,7 @@ namespace Timeline.Controllers if (await Request.Body.ReadAsync(extraByte) != 0) return BadRequest(ErrorResponse.Common.Content.UnmatchedLength_Bigger()); - await _service.SetAvatar(username, new Avatar + await _service.SetAvatar(id, new Avatar { Data = data, Type = Request.ContentType @@ -109,11 +126,6 @@ namespace Timeline.Controllers ("Username", username), ("Mime Type", Request.ContentType))); return Ok(); } - catch (UserNotExistException e) - { - _logger.LogInformation(e, Log.Format(LogPutUserNotExist, ("Username", username))); - return BadRequest(ErrorResponse.UserCommon.NotExist()); - } catch (AvatarFormatException e) { _logger.LogInformation(e, Log.Format(LogPutUserBadFormat, ("Username", username))); @@ -139,16 +151,19 @@ namespace Timeline.Controllers return StatusCode(StatusCodes.Status403Forbidden, ErrorResponse.Common.Forbid()); } + long id; try { - await _service.SetAvatar(username, null); - return Ok(); + id = await _userService.GetUserIdByUsername(username); } catch (UserNotExistException e) { _logger.LogInformation(e, Log.Format(LogDeleteNotExist, ("Username", username))); return BadRequest(ErrorResponse.UserCommon.NotExist()); } + + await _service.SetAvatar(id, null); + return Ok(); } } } diff --git a/Timeline/Controllers/UserController.cs b/Timeline/Controllers/UserController.cs index 4c585198..400a518c 100644 --- a/Timeline/Controllers/UserController.cs +++ b/Timeline/Controllers/UserController.cs @@ -1,3 +1,4 @@ +using AutoMapper; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc; @@ -17,30 +18,40 @@ namespace Timeline.Controllers [ApiController] public class UserController : Controller { - private readonly ILogger _logger; private readonly IUserService _userService; + private readonly IMapper _mapper; - public UserController(ILogger logger, IUserService userService) + public UserController(ILogger logger, IUserService userService, IMapper mapper) { _logger = logger; _userService = userService; + _mapper = mapper; + } + + private IUserInfo ConvertToUserInfo(User user, bool administrator) + { + if (administrator) + return _mapper.Map(user); + else + return _mapper.Map(user); } [HttpGet("users")] - public async Task> List() + public async Task> List() { var users = await _userService.GetUsers(); - return Ok(users.Select(u => u.EraseSecretAndFinalFill(Url, this.IsAdministrator())).ToArray()); + var administrator = this.IsAdministrator(); + return Ok(users.Select(u => ConvertToUserInfo(u, administrator)).ToArray()); } [HttpGet("users/{username}")] - public async Task> Get([FromRoute][Username] string username) + public async Task> Get([FromRoute][Username] string username) { try { var user = await _userService.GetUserByUsername(username); - return Ok(user.EraseSecretAndFinalFill(Url, this.IsAdministrator())); + return Ok(ConvertToUserInfo(user, this.IsAdministrator())); } catch (UserNotExistException e) { @@ -52,22 +63,11 @@ namespace Timeline.Controllers [HttpPatch("users/{username}"), Authorize] public async Task Patch([FromBody] UserPatchRequest body, [FromRoute][Username] string username) { - static User Convert(UserPatchRequest body) - { - return new User - { - Username = body.Username, - Password = body.Password, - Administrator = body.Administrator, - Nickname = body.Nickname - }; - } - if (this.IsAdministrator()) { try { - await _userService.ModifyUser(username, Convert(body)); + await _userService.ModifyUser(username, _mapper.Map(body)); return Ok(); } catch (UserNotExistException e) @@ -75,6 +75,10 @@ namespace Timeline.Controllers _logger.LogInformation(e, Log.Format(LogPatchUserNotExist, ("Username", username))); return NotFound(ErrorResponse.UserCommon.NotExist()); } + catch (ConflictException) + { + return BadRequest(ErrorResponse.UserController.UsernameConflict()); + } } else { @@ -94,7 +98,7 @@ namespace Timeline.Controllers return StatusCode(StatusCodes.Status403Forbidden, ErrorResponse.Common.CustomMessage_Forbid(UserController_Patch_Forbid_Administrator)); - await _userService.ModifyUser(this.GetUserId(), Convert(body)); + await _userService.ModifyUser(this.GetUserId(), _mapper.Map(body)); return Ok(); } } @@ -113,10 +117,18 @@ namespace Timeline.Controllers } } - [HttpPost("userop/create"), AdminAuthorize] - public async Task CreateUser([FromBody] User body) + [HttpPost("userop/createuser"), AdminAuthorize] + public async Task CreateUser([FromBody] CreateUserRequest body) { - + try + { + await _userService.CreateUser(_mapper.Map(body)); + return Ok(); + } + catch (ConflictException) + { + return BadRequest(ErrorResponse.UserController.UsernameConflict()); + } } [HttpPost("userop/changepassword"), Authorize] @@ -133,7 +145,7 @@ namespace Timeline.Controllers ("Username", User.Identity.Name), ("Old Password", request.OldPassword))); return BadRequest(ErrorResponse.UserController.ChangePassword_BadOldPassword()); } - // User can't be non-existent or the token is bad. + // User can't be non-existent or the token is bad. } } } diff --git a/Timeline/Entities/DatabaseContext.cs b/Timeline/Entities/DatabaseContext.cs index ac4ad7b2..cac33379 100644 --- a/Timeline/Entities/DatabaseContext.cs +++ b/Timeline/Entities/DatabaseContext.cs @@ -10,7 +10,6 @@ namespace Timeline.Entities } - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods")] protected override void OnModelCreating(ModelBuilder modelBuilder) { modelBuilder.Entity().Property(e => e.Version).HasDefaultValue(0); @@ -19,7 +18,6 @@ namespace Timeline.Entities public DbSet Users { get; set; } = default!; public DbSet UserAvatars { get; set; } = default!; - public DbSet UserDetails { get; set; } = default!; public DbSet Timelines { get; set; } = default!; public DbSet TimelinePosts { get; set; } = default!; public DbSet TimelineMembers { get; set; } = default!; diff --git a/Timeline/Entities/TimelineEntity.cs b/Timeline/Entities/TimelineEntity.cs index 2bfd6107..c50fe6dd 100644 --- a/Timeline/Entities/TimelineEntity.cs +++ b/Timeline/Entities/TimelineEntity.cs @@ -2,7 +2,7 @@ using System.Collections.Generic; using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations.Schema; -using Timeline.Models; +using Timeline.Models.Http; namespace Timeline.Entities { diff --git a/Timeline/Filters/Header.cs b/Timeline/Filters/Header.cs index 843a619d..0db11faf 100644 --- a/Timeline/Filters/Header.cs +++ b/Timeline/Filters/Header.cs @@ -6,7 +6,6 @@ namespace Timeline.Filters { public class RequireContentTypeAttribute : ActionFilterAttribute { - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods")] public override void OnActionExecuting(ActionExecutingContext context) { if (context.HttpContext.Request.ContentType == null) @@ -31,7 +30,6 @@ namespace Timeline.Filters public bool RequireNonZero { get; set; } - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods")] public override void OnActionExecuting(ActionExecutingContext context) { if (context.HttpContext.Request.ContentLength == null) diff --git a/Timeline/Filters/Timeline.cs b/Timeline/Filters/Timeline.cs index bc142db0..729dbec7 100644 --- a/Timeline/Filters/Timeline.cs +++ b/Timeline/Filters/Timeline.cs @@ -7,7 +7,6 @@ namespace Timeline.Filters { public class CatchTimelineNotExistExceptionAttribute : ExceptionFilterAttribute { - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods")] public override void OnException(ExceptionContext context) { if (context.Exception is TimelineNotExistException e) diff --git a/Timeline/Filters/User.cs b/Timeline/Filters/User.cs deleted file mode 100644 index 12ed6155..00000000 --- a/Timeline/Filters/User.cs +++ /dev/null @@ -1,68 +0,0 @@ -using Microsoft.AspNetCore.Http; -using Microsoft.AspNetCore.Mvc; -using Microsoft.AspNetCore.Mvc.Filters; -using Microsoft.Extensions.DependencyInjection; -using Microsoft.Extensions.Logging; -using System; -using Timeline.Auth; -using Timeline.Models.Http; -using Timeline.Services; -using static Timeline.Resources.Filters; - -namespace Timeline.Filters -{ - public class SelfOrAdminAttribute : ActionFilterAttribute - { - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods")] - public override void OnActionExecuting(ActionExecutingContext context) - { - var logger = context.HttpContext.RequestServices.GetRequiredService>(); - - var user = context.HttpContext.User; - - if (user == null) - { - logger.LogError(LogSelfOrAdminNoUser); - return; - } - - if (context.ModelState.TryGetValue("username", out var model)) - { - if (model.RawValue is string username) - { - if (!user.IsAdministrator() && user.Identity.Name != username) - { - context.Result = new ObjectResult(ErrorResponse.Common.Forbid()) - { StatusCode = StatusCodes.Status403Forbidden }; - } - } - else - { - logger.LogError(LogSelfOrAdminUsernameNotString); - } - } - else - { - logger.LogError(LogSelfOrAdminNoUsername); - } - } - } - - [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)] - public class CatchUserNotExistExceptionAttribute : ExceptionFilterAttribute - { - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "ASP.Net already checked.")] - public override void OnException(ExceptionContext context) - { - if (context.Exception is UserNotExistException) - { - var body = ErrorResponse.UserCommon.NotExist(); - - if (context.HttpContext.Request.Method == "GET") - context.Result = new NotFoundObjectResult(body); - else - context.Result = new BadRequestObjectResult(body); - } - } - } -} diff --git a/Timeline/Formatters/StringInputFormatter.cs b/Timeline/Formatters/StringInputFormatter.cs index 90847e36..b1924268 100644 --- a/Timeline/Formatters/StringInputFormatter.cs +++ b/Timeline/Formatters/StringInputFormatter.cs @@ -15,7 +15,6 @@ namespace Timeline.Formatters SupportedEncodings.Add(Encoding.UTF8); } - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods")] public override async Task ReadRequestBodyAsync(InputFormatterContext context, Encoding effectiveEncoding) { var request = context.HttpContext.Request; diff --git a/Timeline/GlobalSuppressions.cs b/Timeline/GlobalSuppressions.cs index d27b3c16..2b0da576 100644 --- a/Timeline/GlobalSuppressions.cs +++ b/Timeline/GlobalSuppressions.cs @@ -11,3 +11,4 @@ [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1724:Type names should not match namespaces", Justification = "Generated error response identifiers.", Scope = "type", Target = "Timeline.Models.Http.ErrorResponse")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Globalization", "CA1305:Specify IFormatProvider", Justification = "Generated error response.", Scope = "type", Target = "Timeline.Models.Http.ErrorResponse")] [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1056:Uri properties should not be strings", Justification = "That's unnecessary.")] +[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "Adundant")] diff --git a/Timeline/Helpers/InvalidModelResponseFactory.cs b/Timeline/Helpers/InvalidModelResponseFactory.cs index 71ee44a9..9b253e7d 100644 --- a/Timeline/Helpers/InvalidModelResponseFactory.cs +++ b/Timeline/Helpers/InvalidModelResponseFactory.cs @@ -6,7 +6,6 @@ namespace Timeline.Helpers { public static class InvalidModelResponseFactory { - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods")] public static IActionResult Factory(ActionContext context) { var modelState = context.ModelState; diff --git a/Timeline/Models/Converters/JsonDateTimeConverter.cs b/Timeline/Models/Converters/JsonDateTimeConverter.cs index 69af53c1..ef129a01 100644 --- a/Timeline/Models/Converters/JsonDateTimeConverter.cs +++ b/Timeline/Models/Converters/JsonDateTimeConverter.cs @@ -6,7 +6,6 @@ using System.Text.Json.Serialization; namespace Timeline.Models.Converters { - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods")] public class JsonDateTimeConverter : JsonConverter { public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) diff --git a/Timeline/Models/Http/ErrorResponse.cs b/Timeline/Models/Http/ErrorResponse.cs index 6a53e0c3..87516638 100644 --- a/Timeline/Models/Http/ErrorResponse.cs +++ b/Timeline/Models/Http/ErrorResponse.cs @@ -184,14 +184,14 @@ namespace Timeline.Models.Http public static class UserController { - public static CommonResponse ChangeUsername_Conflict(params object?[] formatArgs) + public static CommonResponse UsernameConflict(params object?[] formatArgs) { - return new CommonResponse(ErrorCodes.UserController.ChangeUsername_Conflict, string.Format(UserController_ChangeUsername_Conflict, formatArgs)); + return new CommonResponse(ErrorCodes.UserController.UsernameConflict, string.Format(UserController_UsernameConflict, formatArgs)); } - public static CommonResponse CustomMessage_ChangeUsername_Conflict(string message, params object?[] formatArgs) + public static CommonResponse CustomMessage_UsernameConflict(string message, params object?[] formatArgs) { - return new CommonResponse(ErrorCodes.UserController.ChangeUsername_Conflict, string.Format(message, formatArgs)); + return new CommonResponse(ErrorCodes.UserController.UsernameConflict, string.Format(message, formatArgs)); } public static CommonResponse ChangePassword_BadOldPassword(params object?[] formatArgs) @@ -244,18 +244,18 @@ namespace Timeline.Models.Http public static class TimelineController { - public static CommonResponse PostOperationDelete_NotExist(params object?[] formatArgs) + public static CommonResponse MemberPut_NotExist(params object?[] formatArgs) { - return new CommonResponse(ErrorCodes.TimelineController.PostOperationDelete_NotExist, string.Format(TimelineController_PostOperationDelete_NotExist, formatArgs)); + return new CommonResponse(ErrorCodes.TimelineController.MemberPut_NotExist, string.Format(TimelineController_MemberPut_NotExist, formatArgs)); } - public static CommonResponse CustomMessage_PostOperationDelete_NotExist(string message, params object?[] formatArgs) + public static CommonResponse CustomMessage_MemberPut_NotExist(string message, params object?[] formatArgs) { - return new CommonResponse(ErrorCodes.TimelineController.PostOperationDelete_NotExist, string.Format(message, formatArgs)); + return new CommonResponse(ErrorCodes.TimelineController.MemberPut_NotExist, string.Format(message, formatArgs)); } } } -} +} \ No newline at end of file diff --git a/Timeline/Models/Http/Timeline.cs b/Timeline/Models/Http/Timeline.cs deleted file mode 100644 index 3029434e..00000000 --- a/Timeline/Models/Http/Timeline.cs +++ /dev/null @@ -1,42 +0,0 @@ -using System; -using System.Collections.Generic; -using System.ComponentModel.DataAnnotations; - -namespace Timeline.Models.Http -{ - public class TimelinePostCreateRequest - { - [Required(AllowEmptyStrings = true)] - public string Content { get; set; } = default!; - - public DateTime? Time { get; set; } - } - - public class TimelinePostCreateResponse - { - public long Id { get; set; } - - public DateTime Time { get; set; } - } - - public class TimelinePostDeleteRequest - { - [Required] - public long? Id { get; set; } - } - - public class TimelinePropertyChangeRequest - { - public string? Description { get; set; } - - public TimelineVisibility? Visibility { get; set; } - } - - [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "This is a DTO class.")] - public class TimelineMemberChangeRequest - { - public List? Add { get; set; } - - public List? Remove { get; set; } - } -} diff --git a/Timeline/Models/Http/TimelineCommon.cs b/Timeline/Models/Http/TimelineCommon.cs new file mode 100644 index 00000000..febb8186 --- /dev/null +++ b/Timeline/Models/Http/TimelineCommon.cs @@ -0,0 +1,44 @@ +using System; +using System.Collections.Generic; + +namespace Timeline.Models.Http +{ + public enum TimelineVisibility + { + /// + /// All people including those without accounts. + /// + Public, + /// + /// Only people signed in. + /// + Register, + /// + /// Only member. + /// + Private + } + + public class TimelinePostInfo + { + public long Id { get; set; } + public string Content { get; set; } = default!; + public DateTime Time { get; set; } + public UserInfo Author { get; set; } = default!; + public DateTime LastUpdated { get; set; } = default!; + } + + [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "This is a DTO class.")] + public class BaseTimelineInfo + { + public string Description { get; set; } = default!; + public UserInfo Owner { get; set; } = default!; + public TimelineVisibility Visibility { get; set; } + public List Members { get; set; } = default!; + } + + public class TimelineInfo : BaseTimelineInfo + { + public string Name { get; set; } = default!; + } +} diff --git a/Timeline/Models/Http/TimelineController.cs b/Timeline/Models/Http/TimelineController.cs new file mode 100644 index 00000000..f9a4d3e5 --- /dev/null +++ b/Timeline/Models/Http/TimelineController.cs @@ -0,0 +1,20 @@ +using System; +using System.ComponentModel.DataAnnotations; + +namespace Timeline.Models.Http +{ + public class TimelinePostCreateRequest + { + [Required(AllowEmptyStrings = true)] + public string Content { get; set; } = default!; + + public DateTime? Time { get; set; } + } + + public class TimelinePatchRequest + { + public string? Description { get; set; } + + public TimelineVisibility? Visibility { get; set; } + } +} diff --git a/Timeline/Models/Http/Token.cs b/Timeline/Models/Http/Token.cs deleted file mode 100644 index 0649f1d1..00000000 --- a/Timeline/Models/Http/Token.cs +++ /dev/null @@ -1,32 +0,0 @@ -using System.ComponentModel.DataAnnotations; - -namespace Timeline.Models.Http -{ - public class CreateTokenRequest - { - [Required] - public string Username { get; set; } = default!; - [Required] - public string Password { get; set; } = default!; - // in days, optional - [Range(1, 365)] - public int? Expire { get; set; } - } - - public class CreateTokenResponse - { - public string Token { get; set; } = default!; - public User User { get; set; } = default!; - } - - public class VerifyTokenRequest - { - [Required] - public string Token { get; set; } = default!; - } - - public class VerifyTokenResponse - { - public User User { get; set; } = default!; - } -} diff --git a/Timeline/Models/Http/TokenController.cs b/Timeline/Models/Http/TokenController.cs new file mode 100644 index 00000000..383b2965 --- /dev/null +++ b/Timeline/Models/Http/TokenController.cs @@ -0,0 +1,32 @@ +using System.ComponentModel.DataAnnotations; + +namespace Timeline.Models.Http +{ + public class CreateTokenRequest + { + [Required] + public string Username { get; set; } = default!; + [Required] + public string Password { get; set; } = default!; + // in days, optional + [Range(1, 365)] + public int? Expire { get; set; } + } + + public class CreateTokenResponse + { + public string Token { get; set; } = default!; + public UserInfoForAdmin User { get; set; } = default!; + } + + public class VerifyTokenRequest + { + [Required] + public string Token { get; set; } = default!; + } + + public class VerifyTokenResponse + { + public UserInfoForAdmin User { get; set; } = default!; + } +} diff --git a/Timeline/Models/Http/UserController.cs b/Timeline/Models/Http/UserController.cs index 229ca1e5..e4c95cbd 100644 --- a/Timeline/Models/Http/UserController.cs +++ b/Timeline/Models/Http/UserController.cs @@ -1,5 +1,7 @@ +using AutoMapper; using System.ComponentModel.DataAnnotations; using Timeline.Models.Validation; +using Timeline.Services; namespace Timeline.Models.Http { @@ -17,6 +19,21 @@ namespace Timeline.Models.Http public bool? Administrator { get; set; } } + public class CreateUserRequest + { + [Required, Username] + public string Username { get; set; } = default!; + + [Required, MinLength(1)] + public string Password { get; set; } = default!; + + [Required] + public bool? Administrator { get; set; } + + [Nickname] + public string? Nickname { get; set; } + } + public class ChangePasswordRequest { [Required(AllowEmptyStrings = false)] @@ -24,4 +41,13 @@ namespace Timeline.Models.Http [Required(AllowEmptyStrings = false)] public string NewPassword { get; set; } = default!; } + + public class UserControllerAutoMapperProfile : Profile + { + public UserControllerAutoMapperProfile() + { + CreateMap(MemberList.Source); + CreateMap(MemberList.Source); + } + } } diff --git a/Timeline/Models/Http/UserInfo.cs b/Timeline/Models/Http/UserInfo.cs new file mode 100644 index 00000000..6029b8aa --- /dev/null +++ b/Timeline/Models/Http/UserInfo.cs @@ -0,0 +1,58 @@ +using AutoMapper; +using Microsoft.AspNetCore.Mvc; +using Microsoft.AspNetCore.Mvc.Infrastructure; +using Microsoft.AspNetCore.Mvc.Routing; +using Timeline.Controllers; +using Timeline.Services; + +namespace Timeline.Models.Http +{ + public interface IUserInfo + { + string Username { get; set; } + string Nickname { get; set; } + string AvatarUrl { get; set; } + } + + public class UserInfo : IUserInfo + { + public string Username { get; set; } = default!; + public string Nickname { get; set; } = default!; + public string AvatarUrl { get; set; } = default!; + } + + public class UserInfoForAdmin : IUserInfo + { + public string Username { get; set; } = default!; + public string Nickname { get; set; } = default!; + public string AvatarUrl { get; set; } = default!; + public bool Administrator { get; set; } + } + + public class UserInfoSetAvatarUrlAction : IMappingAction + { + private readonly IActionContextAccessor _actionContextAccessor; + private readonly IUrlHelperFactory _urlHelperFactory; + + public UserInfoSetAvatarUrlAction(IActionContextAccessor actionContextAccessor, IUrlHelperFactory urlHelperFactory) + { + _actionContextAccessor = actionContextAccessor; + _urlHelperFactory = urlHelperFactory; + } + + public void Process(object source, IUserInfo destination, ResolutionContext context) + { + var urlHelper = _urlHelperFactory.GetUrlHelper(_actionContextAccessor.ActionContext); + destination.AvatarUrl = urlHelper.ActionLink(nameof(UserAvatarController.Get), nameof(UserAvatarController), new { destination.Username }); + } + } + + public class UserInfoAutoMapperProfile : Profile + { + public UserInfoAutoMapperProfile() + { + CreateMap().AfterMap(); + CreateMap().AfterMap(); + } + } +} diff --git a/Timeline/Models/Timeline.cs b/Timeline/Models/Timeline.cs deleted file mode 100644 index 752c698d..00000000 --- a/Timeline/Models/Timeline.cs +++ /dev/null @@ -1,55 +0,0 @@ -using System; -using System.Collections.Generic; - -namespace Timeline.Models -{ - public enum TimelineVisibility - { - /// - /// All people including those without accounts. - /// - Public, - /// - /// Only people signed in. - /// - Register, - /// - /// Only member. - /// - Private - } - - public class TimelinePostInfo - { - public long Id { get; set; } - - public string? Content { get; set; } - - public DateTime Time { get; set; } - - /// - /// The username of the author. - /// - public string Author { get; set; } = default!; - } - - [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2227:Collection properties should be read only", Justification = "This is a DTO class.")] - public class BaseTimelineInfo - { - public string? Description { get; set; } - - /// - /// The username of the owner. - /// - public string Owner { get; set; } = default!; - - public TimelineVisibility Visibility { get; set; } - - public List Members { get; set; } = default!; - } - - public class TimelineInfo : BaseTimelineInfo - { - public string Name { get; set; } = default!; - } -} diff --git a/Timeline/Models/Validation/NicknameValidator.cs b/Timeline/Models/Validation/NicknameValidator.cs index f6626a2a..53a2916b 100644 --- a/Timeline/Models/Validation/NicknameValidator.cs +++ b/Timeline/Models/Validation/NicknameValidator.cs @@ -5,7 +5,6 @@ namespace Timeline.Models.Validation { public class NicknameValidator : Validator { - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "Already checked in base.")] protected override (bool, string) DoValidate(string value) { if (value.Length > 10) diff --git a/Timeline/Models/Validation/UsernameValidator.cs b/Timeline/Models/Validation/UsernameValidator.cs index fc6cdf37..d8f3bdc0 100644 --- a/Timeline/Models/Validation/UsernameValidator.cs +++ b/Timeline/Models/Validation/UsernameValidator.cs @@ -8,7 +8,6 @@ namespace Timeline.Models.Validation { public const int MaxLength = 26; - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "Already checked in base class.")] protected override (bool, string) DoValidate(string value) { if (value.Length == 0) diff --git a/Timeline/Resources/Controllers/Testing/TestingI18nController.Designer.cs b/Timeline/Resources/Controllers/Testing/TestingI18nController.Designer.cs deleted file mode 100644 index e015c5fc..00000000 --- a/Timeline/Resources/Controllers/Testing/TestingI18nController.Designer.cs +++ /dev/null @@ -1,72 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// Runtime Version:4.0.30319.42000 -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -namespace Timeline.Resources.Controllers.Testing { - using System; - - - /// - /// A strongly-typed resource class, for looking up localized strings, etc. - /// - // This class was auto-generated by the StronglyTypedResourceBuilder - // class via a tool like ResGen or Visual Studio. - // To add or remove a member, edit your .ResX file then rerun ResGen - // with the /str option, or rebuild your VS project. - [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")] - [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] - [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] - internal class TestingI18nController { - - private static global::System.Resources.ResourceManager resourceMan; - - private static global::System.Globalization.CultureInfo resourceCulture; - - [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] - internal TestingI18nController() { - } - - /// - /// Returns the cached ResourceManager instance used by this class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Resources.ResourceManager ResourceManager { - get { - if (object.ReferenceEquals(resourceMan, null)) { - global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Timeline.Resources.Controllers.Testing.TestingI18nController", typeof(TestingI18nController).Assembly); - resourceMan = temp; - } - return resourceMan; - } - } - - /// - /// Overrides the current thread's CurrentUICulture property for all - /// resource lookups using this strongly typed resource class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Globalization.CultureInfo Culture { - get { - return resourceCulture; - } - set { - resourceCulture = value; - } - } - - /// - /// Looks up a localized string similar to English test string.. - /// - internal static string TestString { - get { - return ResourceManager.GetString("TestString", resourceCulture); - } - } - } -} diff --git a/Timeline/Resources/Controllers/Testing/TestingI18nController.resx b/Timeline/Resources/Controllers/Testing/TestingI18nController.resx deleted file mode 100644 index 57dfd5b9..00000000 --- a/Timeline/Resources/Controllers/Testing/TestingI18nController.resx +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - text/microsoft-resx - - - 2.0 - - - System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - English test string. - - \ No newline at end of file diff --git a/Timeline/Resources/Controllers/Testing/TestingI18nController.zh.resx b/Timeline/Resources/Controllers/Testing/TestingI18nController.zh.resx deleted file mode 100644 index 6931cdf6..00000000 --- a/Timeline/Resources/Controllers/Testing/TestingI18nController.zh.resx +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - text/microsoft-resx - - - 2.0 - - - System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - 中文测试字符串。 - - \ No newline at end of file diff --git a/Timeline/Resources/Messages.Designer.cs b/Timeline/Resources/Messages.Designer.cs index 15101661..332c8817 100644 --- a/Timeline/Resources/Messages.Designer.cs +++ b/Timeline/Resources/Messages.Designer.cs @@ -168,6 +168,15 @@ namespace Timeline.Resources { } } + /// + /// Looks up a localized string similar to The user to set as member does not exist.. + /// + internal static string TimelineController_MemberPut_NotExist { + get { + return ResourceManager.GetString("TimelineController_MemberPut_NotExist", resourceCulture); + } + } + /// /// Looks up a localized string similar to The post to delete does not exist.. /// @@ -267,15 +276,6 @@ namespace Timeline.Resources { } } - /// - /// Looks up a localized string similar to The new username already exists.. - /// - internal static string UserController_ChangeUsername_Conflict { - get { - return ResourceManager.GetString("UserController_ChangeUsername_Conflict", resourceCulture); - } - } - /// /// Looks up a localized string similar to You can't set permission unless you are administrator.. /// @@ -302,5 +302,14 @@ namespace Timeline.Resources { return ResourceManager.GetString("UserController_Patch_Forbid_Username", resourceCulture); } } + + /// + /// Looks up a localized string similar to A user with given username already exists.. + /// + internal static string UserController_UsernameConflict { + get { + return ResourceManager.GetString("UserController_UsernameConflict", resourceCulture); + } + } } } diff --git a/Timeline/Resources/Messages.resx b/Timeline/Resources/Messages.resx index db56ed02..cb6c3891 100644 --- a/Timeline/Resources/Messages.resx +++ b/Timeline/Resources/Messages.resx @@ -153,6 +153,9 @@ The {0}-st user to do operation {1} on does not exist. + + The user to set as member does not exist. + The post to delete does not exist. @@ -186,9 +189,6 @@ Old password is wrong. - - The new username already exists. - You can't set permission unless you are administrator. @@ -198,4 +198,7 @@ You can't set username unless you are administrator. + + A user with given username already exists. + \ No newline at end of file diff --git a/Timeline/Resources/Services/Exception.Designer.cs b/Timeline/Resources/Services/Exception.Designer.cs index cada1788..e6806873 100644 --- a/Timeline/Resources/Services/Exception.Designer.cs +++ b/Timeline/Resources/Services/Exception.Designer.cs @@ -117,9 +117,9 @@ namespace Timeline.Resources.Services { /// /// Looks up a localized string similar to A present resource conflicts with the given resource.. /// - internal static string ConfictException { + internal static string ConflictException { get { - return ResourceManager.GetString("ConfictException", resourceCulture); + return ResourceManager.GetString("ConflictException", resourceCulture); } } @@ -258,42 +258,6 @@ namespace Timeline.Resources.Services { } } - /// - /// Looks up a localized string similar to The timeline with that name already exists.. - /// - internal static string TimelineAlreadyExistException { - get { - return ResourceManager.GetString("TimelineAlreadyExistException", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to An exception happened when add or remove member on timeline.. - /// - internal static string TimelineMemberOperationException { - get { - return ResourceManager.GetString("TimelineMemberOperationException", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to An exception happened when do operation {0} on the {1} member on timeline.. - /// - internal static string TimelineMemberOperationExceptionDetail { - get { - return ResourceManager.GetString("TimelineMemberOperationExceptionDetail", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Timeline name is of bad format. If this is a personal timeline, it means the username is of bad format and inner exception should be a UsernameBadFormatException.. - /// - internal static string TimelineNameBadFormatException { - get { - return ResourceManager.GetString("TimelineNameBadFormatException", resourceCulture); - } - } - /// /// Looks up a localized string similar to Timeline does not exist. If this is a personal timeline, it means the user does not exist and inner exception should be a UserNotExistException.. /// @@ -312,15 +276,6 @@ namespace Timeline.Resources.Services { } } - /// - /// Looks up a localized string similar to The use is not a member of the timeline.. - /// - internal static string TimelineUserNotMemberException { - get { - return ResourceManager.GetString("TimelineUserNotMemberException", resourceCulture); - } - } - /// /// Looks up a localized string similar to The user does not exist.. /// diff --git a/Timeline/Resources/Services/Exception.resx b/Timeline/Resources/Services/Exception.resx index 2cb0f11a..11ae5f27 100644 --- a/Timeline/Resources/Services/Exception.resx +++ b/Timeline/Resources/Services/Exception.resx @@ -135,7 +135,7 @@ The password is wrong. - + A present resource conflicts with the given resource. @@ -183,27 +183,12 @@ Password is of bad format. - - The timeline with that name already exists. - - - An exception happened when add or remove member on timeline. - - - An exception happened when do operation {0} on the {1} member on timeline. - - - Timeline name is of bad format. If this is a personal timeline, it means the username is of bad format and inner exception should be a UsernameBadFormatException. - Timeline does not exist. If this is a personal timeline, it means the user does not exist and inner exception should be a UserNotExistException. The timeline post does not exist. You can't do operation on it. - - The use is not a member of the timeline. - The user does not exist. diff --git a/Timeline/Resources/Services/TimelineService.Designer.cs b/Timeline/Resources/Services/TimelineService.Designer.cs new file mode 100644 index 00000000..8212c252 --- /dev/null +++ b/Timeline/Resources/Services/TimelineService.Designer.cs @@ -0,0 +1,81 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// Runtime Version:4.0.30319.42000 +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +namespace Timeline.Resources.Services { + using System; + + + /// + /// A strongly-typed resource class, for looking up localized strings, etc. + /// + // This class was auto-generated by the StronglyTypedResourceBuilder + // class via a tool like ResGen or Visual Studio. + // To add or remove a member, edit your .ResX file then rerun ResGen + // with the /str option, or rebuild your VS project. + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")] + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] + internal class TimelineService { + + private static global::System.Resources.ResourceManager resourceMan; + + private static global::System.Globalization.CultureInfo resourceCulture; + + [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] + internal TimelineService() { + } + + /// + /// Returns the cached ResourceManager instance used by this class. + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Resources.ResourceManager ResourceManager { + get { + if (object.ReferenceEquals(resourceMan, null)) { + global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Timeline.Resources.Services.TimelineService", typeof(TimelineService).Assembly); + resourceMan = temp; + } + return resourceMan; + } + } + + /// + /// Overrides the current thread's CurrentUICulture property for all + /// resource lookups using this strongly typed resource class. + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Globalization.CultureInfo Culture { + get { + return resourceCulture; + } + set { + resourceCulture = value; + } + } + + /// + /// Looks up a localized string similar to The number {0} username is invalid.. + /// + internal static string ExceptionChangeMemberUsernameBadFormat { + get { + return ResourceManager.GetString("ExceptionChangeMemberUsernameBadFormat", resourceCulture); + } + } + + /// + /// Looks up a localized string similar to The owner username of personal timeline is of bad format.. + /// + internal static string ExceptionFindTimelineUsernameBadFormat { + get { + return ResourceManager.GetString("ExceptionFindTimelineUsernameBadFormat", resourceCulture); + } + } + } +} diff --git a/Timeline/Resources/Services/TimelineService.resx b/Timeline/Resources/Services/TimelineService.resx new file mode 100644 index 00000000..0429a2f8 --- /dev/null +++ b/Timeline/Resources/Services/TimelineService.resx @@ -0,0 +1,126 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + The number {0} username is invalid. + + + The owner username of personal timeline is of bad format. + + \ No newline at end of file diff --git a/Timeline/Resources/Services/UserCache.Designer.cs b/Timeline/Resources/Services/UserCache.Designer.cs deleted file mode 100644 index 28a74a6c..00000000 --- a/Timeline/Resources/Services/UserCache.Designer.cs +++ /dev/null @@ -1,99 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// Runtime Version:4.0.30319.42000 -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -namespace Timeline.Resources.Services { - using System; - - - /// - /// A strongly-typed resource class, for looking up localized strings, etc. - /// - // This class was auto-generated by the StronglyTypedResourceBuilder - // class via a tool like ResGen or Visual Studio. - // To add or remove a member, edit your .ResX file then rerun ResGen - // with the /str option, or rebuild your VS project. - [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")] - [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] - [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] - internal class UserCache { - - private static global::System.Resources.ResourceManager resourceMan; - - private static global::System.Globalization.CultureInfo resourceCulture; - - [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] - internal UserCache() { - } - - /// - /// Returns the cached ResourceManager instance used by this class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Resources.ResourceManager ResourceManager { - get { - if (object.ReferenceEquals(resourceMan, null)) { - global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Timeline.Resources.Services.UserCache", typeof(UserCache).Assembly); - resourceMan = temp; - } - return resourceMan; - } - } - - /// - /// Overrides the current thread's CurrentUICulture property for all - /// resource lookups using this strongly typed resource class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Globalization.CultureInfo Culture { - get { - return resourceCulture; - } - set { - resourceCulture = value; - } - } - - /// - /// Looks up a localized string similar to Found user info from cache. Entry: {0} .. - /// - internal static string LogGetCacheExist { - get { - return ResourceManager.GetString("LogGetCacheExist", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to User info not exist in cache. Id: {0} .. - /// - internal static string LogGetCacheNotExist { - get { - return ResourceManager.GetString("LogGetCacheNotExist", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to User info remove in cache. Id: {0} .. - /// - internal static string LogRemoveCache { - get { - return ResourceManager.GetString("LogRemoveCache", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to User info set in cache. Entry: {0} .. - /// - internal static string LogSetCache { - get { - return ResourceManager.GetString("LogSetCache", resourceCulture); - } - } - } -} diff --git a/Timeline/Resources/Services/UserCache.resx b/Timeline/Resources/Services/UserCache.resx deleted file mode 100644 index 1102108b..00000000 --- a/Timeline/Resources/Services/UserCache.resx +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - text/microsoft-resx - - - 2.0 - - - System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - Found user info from cache. Entry: {0} . - - - User info not exist in cache. Id: {0} . - - - User info remove in cache. Id: {0} . - - - User info set in cache. Entry: {0} . - - \ No newline at end of file diff --git a/Timeline/Resources/Services/UserDetailService.Designer.cs b/Timeline/Resources/Services/UserDetailService.Designer.cs deleted file mode 100644 index 2f586b36..00000000 --- a/Timeline/Resources/Services/UserDetailService.Designer.cs +++ /dev/null @@ -1,99 +0,0 @@ -//------------------------------------------------------------------------------ -// -// This code was generated by a tool. -// Runtime Version:4.0.30319.42000 -// -// Changes to this file may cause incorrect behavior and will be lost if -// the code is regenerated. -// -//------------------------------------------------------------------------------ - -namespace Timeline.Resources.Services { - using System; - - - /// - /// A strongly-typed resource class, for looking up localized strings, etc. - /// - // This class was auto-generated by the StronglyTypedResourceBuilder - // class via a tool like ResGen or Visual Studio. - // To add or remove a member, edit your .ResX file then rerun ResGen - // with the /str option, or rebuild your VS project. - [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")] - [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] - [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] - internal class UserDetailService { - - private static global::System.Resources.ResourceManager resourceMan; - - private static global::System.Globalization.CultureInfo resourceCulture; - - [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] - internal UserDetailService() { - } - - /// - /// Returns the cached ResourceManager instance used by this class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Resources.ResourceManager ResourceManager { - get { - if (object.ReferenceEquals(resourceMan, null)) { - global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("Timeline.Resources.Services.UserDetailService", typeof(UserDetailService).Assembly); - resourceMan = temp; - } - return resourceMan; - } - } - - /// - /// Overrides the current thread's CurrentUICulture property for all - /// resource lookups using this strongly typed resource class. - /// - [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] - internal static global::System.Globalization.CultureInfo Culture { - get { - return resourceCulture; - } - set { - resourceCulture = value; - } - } - - /// - /// Looks up a localized string similar to Length of nickname can't be bigger than 10.. - /// - internal static string ExceptionNicknameTooLong { - get { - return ResourceManager.GetString("ExceptionNicknameTooLong", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to A user_details entity has been created. User id is {0}. Nickname is {1}.. - /// - internal static string LogEntityNicknameCreate { - get { - return ResourceManager.GetString("LogEntityNicknameCreate", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Nickname of a user_details entity has been updated to a new value. User id is {0}. New value is {1}.. - /// - internal static string LogEntityNicknameSetNotNull { - get { - return ResourceManager.GetString("LogEntityNicknameSetNotNull", resourceCulture); - } - } - - /// - /// Looks up a localized string similar to Nickname of a user_details entity has been updated to null. User id is {0}.. - /// - internal static string LogEntityNicknameSetToNull { - get { - return ResourceManager.GetString("LogEntityNicknameSetToNull", resourceCulture); - } - } - } -} diff --git a/Timeline/Resources/Services/UserDetailService.resx b/Timeline/Resources/Services/UserDetailService.resx deleted file mode 100644 index ea32aeda..00000000 --- a/Timeline/Resources/Services/UserDetailService.resx +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - text/microsoft-resx - - - 2.0 - - - System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - - - Length of nickname can't be bigger than 10. - - - A user_details entity has been created. User id is {0}. Nickname is {1}. - - - Nickname of a user_details entity has been updated to a new value. User id is {0}. New value is {1}. - - - Nickname of a user_details entity has been updated to null. User id is {0}. - - \ No newline at end of file diff --git a/Timeline/Services/ConfictException.cs b/Timeline/Services/ConfictException.cs deleted file mode 100644 index dcd77366..00000000 --- a/Timeline/Services/ConfictException.cs +++ /dev/null @@ -1,21 +0,0 @@ -using System; - -namespace Timeline.Services -{ - /// - /// Thrown when a resource already exists and conflicts with the given resource. - /// - /// - /// For example a username already exists and conflicts with the given username. - /// - [Serializable] - public class ConfictException : Exception - { - public ConfictException() : base(Resources.Services.Exception.ConfictException) { } - public ConfictException(string message) : base(message) { } - public ConfictException(string message, Exception inner) : base(message, inner) { } - protected ConfictException( - System.Runtime.Serialization.SerializationInfo info, - System.Runtime.Serialization.StreamingContext context) : base(info, context) { } - } -} diff --git a/Timeline/Services/ConflictException.cs b/Timeline/Services/ConflictException.cs new file mode 100644 index 00000000..6ede183a --- /dev/null +++ b/Timeline/Services/ConflictException.cs @@ -0,0 +1,21 @@ +using System; + +namespace Timeline.Services +{ + /// + /// Thrown when a resource already exists and conflicts with the given resource. + /// + /// + /// For example a username already exists and conflicts with the given username. + /// + [Serializable] + public class ConflictException : Exception + { + public ConflictException() : base(Resources.Services.Exception.ConflictException) { } + public ConflictException(string message) : base(message) { } + public ConflictException(string message, Exception inner) : base(message, inner) { } + protected ConflictException( + System.Runtime.Serialization.SerializationInfo info, + System.Runtime.Serialization.StreamingContext context) : base(info, context) { } + } +} diff --git a/Timeline/Services/DatabaseExtensions.cs b/Timeline/Services/DatabaseExtensions.cs deleted file mode 100644 index e77dd01a..00000000 --- a/Timeline/Services/DatabaseExtensions.cs +++ /dev/null @@ -1,36 +0,0 @@ -using Microsoft.EntityFrameworkCore; -using System; -using System.Linq; -using System.Threading.Tasks; -using Timeline.Entities; -using Timeline.Models.Validation; - -namespace Timeline.Services -{ - internal static class DatabaseExtensions - { - private static readonly UsernameValidator usernameValidator = new UsernameValidator(); - - /// - /// Check the existence and get the id of the user. - /// - /// The username of the user. - /// The user id. - /// Thrown if is null. - /// Thrown if is of bad format. - /// Thrown if user does not exist. - internal static async Task CheckAndGetUser(DbSet userDbSet, string? username) - { - if (username == null) - throw new ArgumentNullException(nameof(username)); - var (result, message) = usernameValidator.Validate(username); - if (!result) - throw new UsernameBadFormatException(username, message); - - var userId = await userDbSet.Where(u => u.Username == username).Select(u => u.Id).SingleOrDefaultAsync(); - if (userId == 0) - throw new UserNotExistException(username); - return userId; - } - } -} diff --git a/Timeline/Services/TimelineAlreadyExistException.cs b/Timeline/Services/TimelineAlreadyExistException.cs deleted file mode 100644 index c2dea1f9..00000000 --- a/Timeline/Services/TimelineAlreadyExistException.cs +++ /dev/null @@ -1,17 +0,0 @@ -using System; - -namespace Timeline.Services -{ - [Serializable] - public class TimelineAlreadyExistException : Exception - { - public TimelineAlreadyExistException() : base(Resources.Services.Exception.TimelineAlreadyExistException) { } - public TimelineAlreadyExistException(string name) : base(Resources.Services.Exception.TimelineAlreadyExistException) { Name = name; } - public TimelineAlreadyExistException(string name, Exception inner) : base(Resources.Services.Exception.TimelineAlreadyExistException, inner) { Name = name; } - protected TimelineAlreadyExistException( - System.Runtime.Serialization.SerializationInfo info, - System.Runtime.Serialization.StreamingContext context) : base(info, context) { } - - public string? Name { get; set; } - } -} diff --git a/Timeline/Services/TimelineMemberOperationUserException.cs b/Timeline/Services/TimelineMemberOperationUserException.cs deleted file mode 100644 index 543ee160..00000000 --- a/Timeline/Services/TimelineMemberOperationUserException.cs +++ /dev/null @@ -1,37 +0,0 @@ -using System; -using System.Globalization; - -namespace Timeline.Services -{ - [Serializable] - public class TimelineMemberOperationUserException : Exception - { - public enum MemberOperation - { - Add, - Remove - } - - public TimelineMemberOperationUserException() : base(Resources.Services.Exception.TimelineMemberOperationException) { } - public TimelineMemberOperationUserException(string message) : base(message) { } - public TimelineMemberOperationUserException(string message, Exception inner) : base(message, inner) { } - protected TimelineMemberOperationUserException( - System.Runtime.Serialization.SerializationInfo info, - System.Runtime.Serialization.StreamingContext context) : base(info, context) { } - - public TimelineMemberOperationUserException(int index, MemberOperation operation, string username, Exception inner) - : base(MakeMessage(operation, index), inner) { Operation = operation; Index = index; Username = username; } - - private static string MakeMessage(MemberOperation operation, int index) => string.Format(CultureInfo.CurrentCulture, - Resources.Services.Exception.TimelineMemberOperationExceptionDetail, operation, index); - - public MemberOperation? Operation { get; set; } - - /// - /// The index of the member on which the operation failed. - /// - public int? Index { get; set; } - - public string? Username { get; set; } - } -} diff --git a/Timeline/Services/TimelineNameBadFormatException.cs b/Timeline/Services/TimelineNameBadFormatException.cs deleted file mode 100644 index 5120a175..00000000 --- a/Timeline/Services/TimelineNameBadFormatException.cs +++ /dev/null @@ -1,21 +0,0 @@ -using System; - -namespace Timeline.Services -{ - [Serializable] - public class TimelineNameBadFormatException : Exception - { - public TimelineNameBadFormatException() - : base(Resources.Services.Exception.TimelineNameBadFormatException) { } - public TimelineNameBadFormatException(string name) - : base(Resources.Services.Exception.TimelineNameBadFormatException) { Name = name; } - public TimelineNameBadFormatException(string name, Exception inner) - : base(Resources.Services.Exception.TimelineNameBadFormatException, inner) { Name = name; } - - protected TimelineNameBadFormatException( - System.Runtime.Serialization.SerializationInfo info, - System.Runtime.Serialization.StreamingContext context) : base(info, context) { } - - public string? Name { get; set; } - } -} diff --git a/Timeline/Services/TimelineService.cs b/Timeline/Services/TimelineService.cs index f43d2de5..89936aa2 100644 --- a/Timeline/Services/TimelineService.cs +++ b/Timeline/Services/TimelineService.cs @@ -1,13 +1,15 @@ -using Microsoft.EntityFrameworkCore; +using AutoMapper; +using Microsoft.EntityFrameworkCore; using Microsoft.Extensions.Logging; using System; using System.Collections.Generic; +using System.Globalization; using System.Linq; using System.Threading.Tasks; using Timeline.Entities; -using Timeline.Models; using Timeline.Models.Http; using Timeline.Models.Validation; +using static Timeline.Resources.Services.TimelineService; namespace Timeline.Services { @@ -28,12 +30,7 @@ namespace Timeline.Services /// Username or the timeline name. See remarks of . /// A list of all posts. /// Thrown when is null. - /// - /// Thrown when timeline name is of bad format. - /// For normal timeline, it means name is an empty string. - /// For personal timeline, it means the username is of bad format, - /// the inner exception should be a . - /// + /// Thrown when is illegal. It is not a valid timeline name (for normal timeline service) or a valid username (for personal timeline service). /// /// Thrown when timeline does not exist. /// For normal timeline, it means the name does not exist. @@ -46,26 +43,20 @@ namespace Timeline.Services /// Create a new post in timeline. /// /// Username or the timeline name. See remarks of . - /// The author's username. + /// The author's id. /// The content. /// The time of the post. If null, then use current time. /// The info of the created post. - /// Thrown when or or is null. - /// - /// Thrown when timeline name is of bad format. - /// For normal timeline, it means name is an empty string. - /// For personal timeline, it means the username is of bad format, - /// the inner exception should be a . - /// + /// Thrown when or is null. + /// Thrown when is illegal. It is not a valid timeline name (for normal timeline service) or a valid username (for personal timeline service). /// /// Thrown when timeline does not exist. /// For normal timeline, it means the name does not exist. /// For personal timeline, it means the user of that username does not exist /// and the inner exception should be a . /// - /// Thrown if is of bad format. - /// Thrown if does not exist. - Task CreatePost(string name, string author, string content, DateTime? time); + /// Thrown if user with does not exist. + Task CreatePost(string name, long authorId, string content, DateTime? time); /// /// Delete a post @@ -73,12 +64,7 @@ namespace Timeline.Services /// Username or the timeline name. See remarks of . /// The id of the post to delete. /// Thrown when or is null. - /// - /// Thrown when timeline name is of bad format. - /// For normal timeline, it means name is an empty string. - /// For personal timeline, it means the username is of bad format, - /// the inner exception should be a . - /// + /// Thrown when is illegal. It is not a valid timeline name (for normal timeline service) or a valid username (for personal timeline service). /// /// Thrown when timeline does not exist. /// For normal timeline, it means the name does not exist. @@ -100,19 +86,14 @@ namespace Timeline.Services /// Username or the timeline name. See remarks of . /// The new properties. Null member means not to change. /// Thrown when or is null. - /// - /// Thrown when timeline name is of bad format. - /// For normal timeline, it means name is an empty string. - /// For personal timeline, it means the username is of bad format, - /// the inner exception should be a . - /// + /// Thrown when is illegal. It is not a valid timeline name (for normal timeline service) or a valid username (for personal timeline service). /// /// Thrown when timeline does not exist. /// For normal timeline, it means the name does not exist. /// For personal timeline, it means the user of that username does not exist /// and the inner exception should be a . /// - Task ChangeProperty(string name, TimelinePropertyChangeRequest newProperties); + Task ChangeProperty(string name, TimelinePatchRequest newProperties); /// /// Remove members to a timeline. @@ -121,24 +102,16 @@ namespace Timeline.Services /// A list of usernames of members to add. May be null. /// A list of usernames of members to remove. May be null. /// Thrown when is null. - /// - /// Thrown when timeline name is of bad format. - /// For normal timeline, it means name is an empty string. - /// For personal timeline, it means the username is of bad format, - /// the inner exception should be a . - /// + /// Thrown when is illegal. It is not a valid timeline name (for normal timeline service) or a valid username (for personal timeline service). + /// Thrown when names in or is not a valid username. /// /// Thrown when timeline does not exist. /// For normal timeline, it means the name does not exist. /// For personal timeline, it means the user of that username does not exist /// and the inner exception should be a . /// - /// - /// Thrown when an exception occurs on the user list. - /// The inner exception is - /// when one of the username is invalid. - /// The inner exception is - /// when one of the user to change does not exist. + /// + /// Thrown when one of the user to change does not exist. /// /// /// Operating on a username that is of bad format or does not exist always throws. @@ -153,42 +126,30 @@ namespace Timeline.Services /// Verify whether a visitor has the permission to read a timeline. /// /// Username or the timeline name. See remarks of . - /// The user to check on. Null means visitor without account. + /// The id of the user to check on. Null means visitor without account. /// True if can read, false if can't read. /// Thrown when is null. - /// - /// Thrown when timeline name is of bad format. - /// For normal timeline, it means name is an empty string. - /// For personal timeline, it means the username is of bad format, - /// the inner exception should be a . - /// + /// Thrown when is illegal. It is not a valid timeline name (for normal timeline service) or a valid username (for personal timeline service). /// /// Thrown when timeline does not exist. /// For normal timeline, it means the name does not exist. /// For personal timeline, it means the user of that username does not exist /// and the inner exception should be a . /// - /// - /// Thrown when is of bad format. - /// - /// - /// Thrown when does not exist. - /// - Task HasReadPermission(string name, string? username); + /// + /// This method does not check whether visitor is administrator. + /// Return false if user with visitor id does not exist. + /// + Task HasReadPermission(string name, long? visitorId); /// /// Verify whether a user has the permission to modify a post. /// /// Username or the timeline name. See remarks of . - /// The user to check on. + /// The id of the user to check on. /// True if can modify, false if can't modify. - /// Thrown when or is null. - /// - /// Thrown when timeline name is of bad format. - /// For normal timeline, it means name is an empty string. - /// For personal timeline, it means the username is of bad format, - /// the inner exception should be a . - /// + /// Thrown when is null. + /// Thrown when is illegal. It is not a valid timeline name (for normal timeline service) or a valid username (for personal timeline service). /// /// Thrown when timeline does not exist. /// For normal timeline, it means the name does not exist. @@ -198,47 +159,32 @@ namespace Timeline.Services /// /// Thrown when the post with given id does not exist or is deleted already. /// - /// - /// Thrown when is of bad format. - /// - /// - /// Thrown when does not exist. - /// /// /// This method does not check whether the user is administrator. /// It only checks whether he is the author of the post or the owner of the timeline. + /// Return false when user with modifier id does not exist. /// - Task HasPostModifyPermission(string name, long id, string username); + Task HasPostModifyPermission(string name, long id, long modifierId); /// /// Verify whether a user is member of a timeline. /// /// Username or the timeline name. See remarks of . - /// The user to check on. + /// The id of user to check on. /// True if it is a member, false if not. - /// Thrown when or is null. - /// - /// Thrown when timeline name is of bad format. - /// For normal timeline, it means name is an empty string. - /// For personal timeline, it means the username is of bad format, - /// the inner exception should be a . - /// + /// Thrown when is null. + /// Thrown when is illegal. It is not a valid timeline name (for normal timeline service) or a valid username (for personal timeline service). /// /// Thrown when timeline does not exist. /// For normal timeline, it means the name does not exist. /// For personal timeline, it means the user of that username does not exist /// and the inner exception should be a . /// - /// - /// Thrown when is not a valid username. - /// - /// - /// Thrown when user does not exist. - /// /// /// Timeline owner is also considered as a member. + /// Return false when user with user id does not exist. /// - Task IsMemberOf(string name, string username); + Task IsMemberOf(string name, long userId); } /// @@ -252,7 +198,7 @@ namespace Timeline.Services /// The name of the timeline. /// The timeline info. /// Thrown when is null. - /// + /// /// Thrown when timeline name is invalid. Currently it means it is an empty string. /// /// @@ -264,20 +210,12 @@ namespace Timeline.Services /// Create a timeline. /// /// The name of the timeline. - /// The owner of the timeline. + /// The id of owner of the timeline. /// Thrown when or is null. - /// - /// Thrown when timeline name is invalid. Currently it means it is an empty string. - /// - /// - /// Thrown when the timeline already exists. - /// - /// - /// Thrown when the username of the owner is not valid. - /// - /// - /// Thrown when the owner user does not exist. - Task CreateTimeline(string name, string owner); + /// Thrown when timeline name is invalid. Currently it means it is an empty string. + /// Thrown when the timeline already exists. + /// Thrown when the owner user does not exist. + Task CreateTimeline(string name, long owner); } public interface IPersonalTimelineService : IBaseTimelineService @@ -290,8 +228,8 @@ namespace Timeline.Services /// /// Thrown when is null. /// - /// - /// Thrown when is of bad format. Inner exception MUST be . + /// + /// Thrown when is of bad format. /// /// /// Thrown when the user does not exist. Inner exception MUST be . @@ -301,10 +239,12 @@ namespace Timeline.Services public abstract class BaseTimelineService : IBaseTimelineService { - protected BaseTimelineService(ILoggerFactory loggerFactory, DatabaseContext database, IClock clock) + protected BaseTimelineService(ILoggerFactory loggerFactory, DatabaseContext database, IUserService userService, IMapper mapper, IClock clock) { Clock = clock; Database = database; + UserService = userService; + Mapper = mapper; } protected IClock Clock { get; } @@ -313,6 +253,10 @@ namespace Timeline.Services protected DatabaseContext Database { get; } + protected IUserService UserService { get; } + + protected IMapper Mapper { get; } + /// /// Find the timeline id by the name. /// For details, see remarks. @@ -320,12 +264,7 @@ namespace Timeline.Services /// The username or the timeline name. See remarks. /// The id of the timeline entity. /// Thrown when is null. - /// - /// Thrown when timeline name is of bad format. - /// For normal timeline, it means name is an empty string. - /// For personal timeline, it means the username is of bad format, - /// the inner exception should be a . - /// + /// Thrown when is illegal. It is not a valid timeline name (for normal timeline service) or a valid username (for personal timeline service). /// /// Thrown when timeline does not exist. /// For normal timeline, it means the name does not exist. @@ -347,66 +286,60 @@ namespace Timeline.Services if (name == null) throw new ArgumentNullException(nameof(name)); + var timelineId = await FindTimelineId(name); var postEntities = await Database.TimelinePosts.OrderBy(p => p.Time).Where(p => p.TimelineId == timelineId && p.Content != null).ToListAsync(); + var posts = new List(); foreach (var entity in postEntities) { - posts.Add(new TimelinePostInfo + if (entity.Content != null) // otherwise it is deleted { - Id = entity.Id, - Content = entity.Content, - Author = (await Database.Users.Where(u => u.Id == entity.AuthorId).Select(u => new { u.Username }).SingleAsync()).Name, - Time = entity.Time - }); + var author = Mapper.Map(UserService.GetUserById(entity.AuthorId)); + posts.Add(new TimelinePostInfo + { + Id = entity.Id, + Content = entity.Content, + Author = author, + Time = entity.Time, + LastUpdated = entity.LastUpdated + }); + } } return posts; } - public async Task CreatePost(string name, string author, string content, DateTime? time) + public async Task CreatePost(string name, long authorId, string content, DateTime? time) { if (name == null) throw new ArgumentNullException(nameof(name)); - if (author == null) - throw new ArgumentNullException(nameof(author)); if (content == null) throw new ArgumentNullException(nameof(content)); - { - var (result, message) = UsernameValidator.Validate(author); - if (!result) - { - throw new UsernameBadFormatException(author, message); - } - } - var timelineId = await FindTimelineId(name); - - var authorEntity = Database.Users.Where(u => u.Username == author).Select(u => new { u.Id }).SingleOrDefault(); - if (authorEntity == null) - { - throw new UserNotExistException(author); - } - var authorId = authorEntity.Id; + var author = Mapper.Map(await UserService.GetUserById(authorId)); var currentTime = Clock.GetCurrentTime(); + var finalTime = time ?? currentTime; var postEntity = new TimelinePostEntity { Content = content, AuthorId = authorId, TimelineId = timelineId, - Time = time ?? currentTime, + Time = finalTime, LastUpdated = currentTime }; - Database.TimelinePosts.Add(postEntity); await Database.SaveChangesAsync(); - return new TimelinePostCreateResponse + return new TimelinePostInfo { Id = postEntity.Id, - Time = postEntity.Time + Content = content, + Author = author, + Time = finalTime, + LastUpdated = currentTime }; } @@ -426,7 +359,7 @@ namespace Timeline.Services await Database.SaveChangesAsync(); } - public async Task ChangeProperty(string name, TimelinePropertyChangeRequest newProperties) + public async Task ChangeProperty(string name, TimelinePatchRequest newProperties) { if (name == null) throw new ArgumentNullException(nameof(name)); @@ -455,27 +388,23 @@ namespace Timeline.Services if (name == null) throw new ArgumentNullException(nameof(name)); - // remove duplication and check the format of each username. - // Return a username->index map. - Dictionary? RemoveDuplicateAndCheckFormat(IList? list, TimelineMemberOperationUserException.MemberOperation operation) + List? RemoveDuplicateAndCheckFormat(IList? list, string paramName) { if (list != null) { - Dictionary result = new Dictionary(); + List result = new List(); var count = list.Count; for (var index = 0; index < count; index++) { var username = list[index]; - if (result.ContainsKey(username)) + if (result.Contains(username)) { continue; } var (validationResult, message) = UsernameValidator.Validate(username); if (!validationResult) - throw new TimelineMemberOperationUserException( - index, operation, username, - new UsernameBadFormatException(username, message)); - result.Add(username, index); + throw new ArgumentException(string.Format(CultureInfo.CurrentCulture, ExceptionChangeMemberUsernameBadFormat, index), nameof(paramName)); + result.Add(username); } return result; } @@ -484,13 +413,13 @@ namespace Timeline.Services return null; } } - var simplifiedAdd = RemoveDuplicateAndCheckFormat(add, TimelineMemberOperationUserException.MemberOperation.Add); - var simplifiedRemove = RemoveDuplicateAndCheckFormat(remove, TimelineMemberOperationUserException.MemberOperation.Remove); + var simplifiedAdd = RemoveDuplicateAndCheckFormat(add, nameof(add)); + var simplifiedRemove = RemoveDuplicateAndCheckFormat(remove, nameof(remove)); // remove those both in add and remove if (simplifiedAdd != null && simplifiedRemove != null) { - var usersToClean = simplifiedRemove.Keys.Where(u => simplifiedAdd.ContainsKey(u)); + var usersToClean = simplifiedRemove.Where(u => simplifiedAdd.Contains(u)).ToList(); foreach (var u in usersToClean) { simplifiedAdd.Remove(u); @@ -500,26 +429,20 @@ namespace Timeline.Services var timelineId = await FindTimelineId(name); - async Task?> CheckExistenceAndGetId(Dictionary? map, TimelineMemberOperationUserException.MemberOperation operation) + async Task?> CheckExistenceAndGetId(List? list) { - if (map == null) + if (list == null) return null; List result = new List(); - foreach (var (username, index) in map) + foreach (var username in list) { - var user = await Database.Users.Where(u => u.Username == username).Select(u => new { u.Id }).SingleOrDefaultAsync(); - if (user == null) - { - throw new TimelineMemberOperationUserException(index, operation, username, - new UserNotExistException(username)); - } - result.Add(user.Id); + result.Add(await UserService.GetUserIdByUsername(username)); } return result; } - var userIdsAdd = await CheckExistenceAndGetId(simplifiedAdd, TimelineMemberOperationUserException.MemberOperation.Add); - var userIdsRemove = await CheckExistenceAndGetId(simplifiedRemove, TimelineMemberOperationUserException.MemberOperation.Remove); + var userIdsAdd = await CheckExistenceAndGetId(simplifiedAdd); + var userIdsRemove = await CheckExistenceAndGetId(simplifiedRemove); if (userIdsAdd != null) { @@ -536,30 +459,11 @@ namespace Timeline.Services await Database.SaveChangesAsync(); } - public async Task HasReadPermission(string name, string? username) + public async Task HasReadPermission(string name, long? visitorId) { if (name == null) throw new ArgumentNullException(nameof(name)); - long? userId = null; - if (username != null) - { - var (result, message) = UsernameValidator.Validate(username); - if (!result) - { - throw new UsernameBadFormatException(username); - } - - var user = await Database.Users.Where(u => u.Username == username).Select(u => new { u.Id }).SingleOrDefaultAsync(); - - if (user == null) - { - throw new UserNotExistException(username); - } - - userId = user.Id; - } - var timelineId = await FindTimelineId(name); var timelineEntity = await Database.Timelines.Where(t => t.Id == timelineId).Select(t => new { t.Visibility }).SingleAsync(); @@ -567,43 +471,24 @@ namespace Timeline.Services if (timelineEntity.Visibility == TimelineVisibility.Public) return true; - if (timelineEntity.Visibility == TimelineVisibility.Register && username != null) + if (timelineEntity.Visibility == TimelineVisibility.Register && visitorId != null) return true; - if (userId == null) + if (visitorId == null) { return false; } else { - var memberEntity = await Database.TimelineMembers.Where(m => m.UserId == userId && m.TimelineId == timelineId).SingleOrDefaultAsync(); + var memberEntity = await Database.TimelineMembers.Where(m => m.UserId == visitorId && m.TimelineId == timelineId).SingleOrDefaultAsync(); return memberEntity != null; } } - public async Task HasPostModifyPermission(string name, long id, string username) + public async Task HasPostModifyPermission(string name, long id, long modifierId) { if (name == null) throw new ArgumentNullException(nameof(name)); - if (username == null) - throw new ArgumentNullException(nameof(username)); - - { - var (result, message) = UsernameValidator.Validate(username); - if (!result) - { - throw new UsernameBadFormatException(username); - } - } - - var user = await Database.Users.Where(u => u.Username == username).Select(u => new { u.Id }).SingleOrDefaultAsync(); - - if (user == null) - { - throw new UserNotExistException(username); - } - - var userId = user.Id; var timelineId = await FindTimelineId(name); @@ -614,32 +499,13 @@ namespace Timeline.Services if (postEntity == null) throw new TimelinePostNotExistException(id); - return timelineEntity.OwnerId == userId || postEntity.AuthorId == userId; + return timelineEntity.OwnerId == modifierId || postEntity.AuthorId == modifierId; } - public async Task IsMemberOf(string name, string username) + public async Task IsMemberOf(string name, long userId) { if (name == null) throw new ArgumentNullException(nameof(name)); - if (username == null) - throw new ArgumentNullException(nameof(username)); - - { - var (result, message) = UsernameValidator.Validate(username); - if (!result) - { - throw new UsernameBadFormatException(username); - } - } - - var user = await Database.Users.Where(u => u.Username == username).Select(u => new { u.Id }).SingleOrDefaultAsync(); - - if (user == null) - { - throw new UserNotExistException(username); - } - - var userId = user.Id; var timelineId = await FindTimelineId(name); @@ -648,38 +514,33 @@ namespace Timeline.Services if (userId == timelineEntity.OwnerId) return true; - var timelineMemberEntity = await Database.TimelineMembers.Where(m => m.TimelineId == timelineId && m.UserId == userId).SingleOrDefaultAsync(); - - return timelineMemberEntity != null; + return await Database.TimelineMembers.AnyAsync(m => m.TimelineId == timelineId && m.UserId == userId); } } public class PersonalTimelineService : BaseTimelineService, IPersonalTimelineService { - public PersonalTimelineService(ILoggerFactory loggerFactory, DatabaseContext database, IClock clock) - : base(loggerFactory, database, clock) + public PersonalTimelineService(ILoggerFactory loggerFactory, DatabaseContext database, IUserService userService, IMapper mapper, IClock clock) + : base(loggerFactory, database, userService, mapper, clock) { } protected override async Task FindTimelineId(string name) { + long userId; + try { - var (result, message) = UsernameValidator.Validate(name); - if (!result) - { - throw new TimelineNameBadFormatException(name, new UsernameBadFormatException(name, message)); - } + userId = await UserService.GetUserIdByUsername(name); } - - var userEntity = await Database.Users.Where(u => u.Username == name).Select(u => new { u.Id }).SingleOrDefaultAsync(); - - if (userEntity == null) + catch (ArgumentException e) { - throw new TimelineNotExistException(name, new UserNotExistException(name)); + throw new ArgumentException(ExceptionFindTimelineUsernameBadFormat, nameof(name), e); + } + catch (UserNotExistException e) + { + throw new TimelineNotExistException(name, e); } - - var userId = userEntity.Id; var timelineEntity = await Database.Timelines.Where(t => t.OwnerId == userId && t.Name == null).Select(t => new { t.Id }).SingleOrDefaultAsync(); @@ -715,16 +576,20 @@ namespace Timeline.Services var timelineMemberEntities = await Database.TimelineMembers.Where(m => m.TimelineId == timelineId).Select(m => new { m.UserId }).ToListAsync(); - var memberUsernameTasks = timelineMemberEntities.Select(m => Database.Users.Where(u => u.Id == m.UserId).Select(u => u.Username).SingleAsync()).ToArray(); + var owner = Mapper.Map(await UserService.GetUserById(timelineEntity.OwnerId)); - var memberUsernames = await Task.WhenAll(memberUsernameTasks); + var members = new List(); + foreach (var memberEntity in timelineMemberEntities) + { + members.Add(Mapper.Map(await UserService.GetUserById(memberEntity.UserId))); + } return new BaseTimelineInfo { Description = timelineEntity.Description ?? "", - Owner = username, + Owner = owner, Visibility = timelineEntity.Visibility, - Members = memberUsernames.ToList() + Members = members }; } diff --git a/Timeline/Services/User.cs b/Timeline/Services/User.cs index f63a374e..09a472e5 100644 --- a/Timeline/Services/User.cs +++ b/Timeline/Services/User.cs @@ -1,14 +1,9 @@ -using Microsoft.AspNetCore.Mvc; -using System; -using Timeline.Controllers; - -namespace Timeline.Services +namespace Timeline.Services { public class User { public string? Username { get; set; } public string? Nickname { get; set; } - public string? AvatarUrl { get; set; } #region adminsecret public bool? Administrator { get; set; } @@ -20,30 +15,4 @@ namespace Timeline.Services public long? Version { get; set; } #endregion secret } - - public static class UserExtensions - { - public static User EraseSecretAndFinalFill(this User user, IUrlHelper urlHelper, bool adminstrator) - { - if (user == null) - throw new ArgumentNullException(nameof(user)); - - var result = new User - { - Username = user.Username, - Nickname = user.Nickname, - AvatarUrl = urlHelper.ActionLink(action: nameof(UserAvatarController.Get), controller: nameof(UserAvatarController), values: new - { - user.Username - }) - }; - - if (adminstrator) - { - result.Administrator = user.Administrator; - } - - return result; - } - } } diff --git a/Timeline/Services/UserAvatarService.cs b/Timeline/Services/UserAvatarService.cs index ac7dd857..39b408e6 100644 --- a/Timeline/Services/UserAvatarService.cs +++ b/Timeline/Services/UserAvatarService.cs @@ -11,7 +11,6 @@ using System.Linq; using System.Threading.Tasks; using Timeline.Entities; using Timeline.Helpers; -using Timeline.Models.Validation; namespace Timeline.Services { @@ -61,36 +60,27 @@ namespace Timeline.Services public interface IUserAvatarService { /// - /// Get the etag of a user's avatar. + /// Get the etag of a user's avatar. Warning: This method does not check the user existence. /// - /// The username of the user to get avatar etag of. + /// The id of the user to get avatar etag of. /// The etag. - /// Thrown if is null. - /// Thrown if the is of bad format. - /// Thrown if the user does not exist. - Task GetAvatarETag(string username); + Task GetAvatarETag(long id); /// - /// Get avatar of a user. If the user has no avatar set, a default one is returned. + /// Get avatar of a user. If the user has no avatar set, a default one is returned. Warning: This method does not check the user existence. /// - /// The username of the user to get avatar of. + /// The id of the user to get avatar of. /// The avatar info. - /// Thrown if is null. - /// Thrown if the is of bad format. - /// Thrown if the user does not exist. - Task GetAvatar(string username); + Task GetAvatar(long id); /// - /// Set avatar for a user. + /// Set avatar for a user. Warning: This method does not check the user existence. /// - /// The username of the user to set avatar for. + /// The id of the user to set avatar for. /// The avatar. Can be null to delete the saved avatar. - /// Throw if is null. /// Thrown if any field in is null when is not null. - /// Thrown if the is of bad format. - /// Thrown if the user does not exist. /// Thrown if avatar is of bad format. - Task SetAvatar(string username, Avatar? avatar); + Task SetAvatar(long id, Avatar? avatar); } // TODO! : Make this configurable. @@ -104,7 +94,6 @@ namespace Timeline.Services private DateTime _cacheLastModified; private string _cacheETag = default!; - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "DI.")] public DefaultUserAvatarProvider(IWebHostEnvironment environment, IETagGenerator eTagGenerator) { _avatarPath = Path.Combine(environment.ContentRootPath, "default-avatar.png"); @@ -195,22 +184,18 @@ namespace Timeline.Services _clock = clock; } - public async Task GetAvatarETag(string username) + public async Task GetAvatarETag(long id) { - var userId = await DatabaseExtensions.CheckAndGetUser(_database.Users, username); - - var eTag = (await _database.UserAvatars.Where(a => a.UserId == userId).Select(a => new { a.ETag }).SingleOrDefaultAsync())?.ETag; + var eTag = (await _database.UserAvatars.Where(a => a.UserId == id).Select(a => new { a.ETag }).SingleOrDefaultAsync())?.ETag; if (eTag == null) return await _defaultUserAvatarProvider.GetDefaultAvatarETag(); else return eTag; } - public async Task GetAvatar(string username) + public async Task GetAvatar(long id) { - var userId = await DatabaseExtensions.CheckAndGetUser(_database.Users, username); - - var avatarEntity = await _database.UserAvatars.Where(a => a.UserId == userId).Select(a => new { a.Type, a.Data, a.LastModified }).SingleOrDefaultAsync(); + var avatarEntity = await _database.UserAvatars.Where(a => a.UserId == id).Select(a => new { a.Type, a.Data, a.LastModified }).SingleOrDefaultAsync(); if (avatarEntity != null) { @@ -240,7 +225,7 @@ namespace Timeline.Services return defaultAvatar; } - public async Task SetAvatar(string username, Avatar? avatar) + public async Task SetAvatar(long id, Avatar? avatar) { if (avatar != null) { @@ -250,8 +235,7 @@ namespace Timeline.Services throw new ArgumentException(Resources.Services.UserAvatarService.ExceptionAvatarTypeNullOrEmpty, nameof(avatar)); } - var userId = await DatabaseExtensions.CheckAndGetUser(_database.Users, username); - var avatarEntity = await _database.UserAvatars.Where(a => a.UserId == userId).SingleOrDefaultAsync(); + var avatarEntity = await _database.UserAvatars.Where(a => a.UserId == id).SingleOrDefaultAsync(); if (avatar == null) { @@ -281,7 +265,7 @@ namespace Timeline.Services avatarEntity.Data = avatar.Data; avatarEntity.ETag = await _eTagGenerator.Generate(avatar.Data); avatarEntity.LastModified = _clock.GetCurrentTime(); - avatarEntity.UserId = userId; + avatarEntity.UserId = id; if (create) { _database.UserAvatars.Add(avatarEntity); diff --git a/Timeline/Services/UserRoleConvert.cs b/Timeline/Services/UserRoleConvert.cs index 4fa4a7b8..f27ee1bb 100644 --- a/Timeline/Services/UserRoleConvert.cs +++ b/Timeline/Services/UserRoleConvert.cs @@ -5,7 +5,6 @@ using Timeline.Entities; namespace Timeline.Services { - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "No need.")] public static class UserRoleConvert { public const string UserRole = UserRoles.User; diff --git a/Timeline/Services/UserService.cs b/Timeline/Services/UserService.cs index ff2306c5..1197bb73 100644 --- a/Timeline/Services/UserService.cs +++ b/Timeline/Services/UserService.cs @@ -43,6 +43,16 @@ namespace Timeline.Services /// Thrown when the user with given username does not exist. Task GetUserByUsername(string username); + /// + /// Get the user id of given username. + /// + /// Username of the user. + /// The id of the user. + /// Thrown when is null. + /// Thrown when is of bad format. + /// Thrown when the user with given username does not exist. + Task GetUserIdByUsername(string username); + /// /// List all users. /// @@ -57,7 +67,7 @@ namespace Timeline.Services /// The id of the new user. /// Thrown when is null. /// Thrown when some fields in is bad. - /// Thrown when a user with given username already exists. + /// Thrown when a user with given username already exists. /// /// must not be null and must be a valid username. /// must not be null or empty. @@ -78,13 +88,12 @@ namespace Timeline.Services /// Only , , and will be used. /// If null, then not change. /// Other fields are ignored. - /// After modified, even if nothing is changed, version will increase. + /// Version will increase if password is changed. /// /// must be a valid username if set. /// can't be empty if set. /// must be a valid nickname if set. /// - /// Note: Whether is set or not, version will increase and not set to the specified value if there is one. /// /// Task ModifyUser(long id, User? info); @@ -97,6 +106,7 @@ namespace Timeline.Services /// Thrown when is null. /// Thrown when is of bad format or some fields in is bad. /// Thrown when user with given id does not exist. + /// Thrown when user with the newusername already exist. /// /// Only , and will be used. /// If null, then not change. @@ -184,7 +194,7 @@ namespace Timeline.Services private static void ThrowUsernameConflict() { - throw new ConfictException(ExceptionUsernameConflict); + throw new ConflictException(ExceptionUsernameConflict); } private static User CreateUserFromEntity(UserEntity entity) @@ -245,6 +255,21 @@ namespace Timeline.Services return CreateUserFromEntity(entity); } + public async Task GetUserIdByUsername(string username) + { + if (username == null) + throw new ArgumentNullException(nameof(username)); + + CheckUsernameFormat(username, nameof(username)); + + var entity = await _databaseContext.Users.Where(user => user.Username == username).Select(u => new { u.Id }).SingleOrDefaultAsync(); + + if (entity == null) + throw new UserNotExistException(username); + + return entity.Id; + } + public async Task GetUsers() { var entities = await _databaseContext.Users.ToArrayAsync(); @@ -325,6 +350,7 @@ namespace Timeline.Services if (password != null) { entity.Password = _passwordService.HashPassword(password); + entity.Version += 1; } var administrator = info.Administrator; @@ -339,8 +365,6 @@ namespace Timeline.Services entity.Nickname = nickname; } } - - entity.Version += 1; } diff --git a/Timeline/Services/UserTokenService.cs b/Timeline/Services/UserTokenService.cs index c246fdff..cf7286f4 100644 --- a/Timeline/Services/UserTokenService.cs +++ b/Timeline/Services/UserTokenService.cs @@ -49,7 +49,6 @@ namespace Timeline.Services private readonly JwtSecurityTokenHandler _tokenHandler = new JwtSecurityTokenHandler(); private SymmetricSecurityKey _tokenSecurityKey; - [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "")] public JwtUserTokenService(IOptionsMonitor jwtConfig, IClock clock) { _jwtConfig = jwtConfig; diff --git a/Timeline/Startup.cs b/Timeline/Startup.cs index 091a16e5..998b5c44 100644 --- a/Timeline/Startup.cs +++ b/Timeline/Startup.cs @@ -1,3 +1,4 @@ +using AutoMapper; using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; using Microsoft.AspNetCore.HttpOverrides; @@ -47,7 +48,6 @@ namespace Timeline }); services.Configure(Configuration.GetSection(nameof(JwtConfig))); - var jwtConfig = Configuration.GetSection(nameof(JwtConfig)).Get(); services.AddAuthentication(AuthenticationConstants.Scheme) .AddScheme(AuthenticationConstants.Scheme, AuthenticationConstants.DisplayName, o => { }); services.AddAuthorization(); @@ -75,16 +75,14 @@ namespace Timeline }); } - services.AddLocalization(options => - { - options.ResourcesPath = "Resources"; - }); + services.AddAutoMapper(GetType().Assembly); + + services.AddTransient(); + services.AddTransient(); services.AddScoped(); services.AddScoped(); services.AddScoped(); - services.AddTransient(); - services.AddTransient(); services.AddUserAvatarService(); services.AddScoped(); diff --git a/Timeline/Timeline.csproj b/Timeline/Timeline.csproj index 82b45094..25d73068 100644 --- a/Timeline/Timeline.csproj +++ b/Timeline/Timeline.csproj @@ -15,6 +15,8 @@ + + all runtime; build; native; contentfiles; analyzers; buildtransitive @@ -26,14 +28,14 @@ all runtime; build; native; contentfiles; analyzers; buildtransitive - + - + @@ -42,11 +44,6 @@ True AuthHandler.resx - - True - True - TestingI18nController.resx - True True @@ -73,9 +70,9 @@ Filters.resx - True - True - Messages.resx + True + True + Messages.resx True @@ -83,9 +80,9 @@ Common.resx - True - True - NicknameValidator.resx + True + True + NicknameValidator.resx True @@ -102,20 +99,15 @@ True Exception.resx - - True - True - UserAvatarService.resx - - + True True - UserCache.resx + TimelineService.resx - + True True - UserDetailService.resx + UserAvatarService.resx True @@ -129,10 +121,6 @@ ResXFileCodeGenerator AuthHandler.Designer.cs - - ResXFileCodeGenerator - TestingI18nController.Designer.cs - ResXFileCodeGenerator TimelineController.Designer.cs @@ -155,16 +143,16 @@ Filters.Designer.cs - ResXFileCodeGenerator - Messages.Designer.cs + ResXFileCodeGenerator + Messages.Designer.cs ResXFileCodeGenerator Common.Designer.cs - ResXFileCodeGenerator - NicknameValidator.Designer.cs + ResXFileCodeGenerator + NicknameValidator.Designer.cs ResXFileCodeGenerator @@ -178,17 +166,13 @@ ResXFileCodeGenerator Exception.Designer.cs - - ResXFileCodeGenerator - UserAvatarService.Designer.cs - - + ResXFileCodeGenerator - UserCache.Designer.cs + TimelineService.Designer.cs - + ResXFileCodeGenerator - UserDetailService.Designer.cs + UserAvatarService.Designer.cs ResXFileCodeGenerator -- cgit v1.2.3 From 49bd47fb0eb81a88cce135f7ff7c25637790e63b Mon Sep 17 00:00:00 2001 From: crupest Date: Thu, 30 Jan 2020 23:49:02 +0800 Subject: Finish reafctor, TODO: Database migration. --- Timeline.Tests/Helpers/TestApplication.cs | 12 +++++++++- .../IntegratedTests/IntegratedTestBase.cs | 2 +- .../IntegratedTests/PersonalTimelineTest.cs | 28 +++++++++++----------- Timeline.Tests/IntegratedTests/UserAvatarTest.cs | 2 +- Timeline.Tests/IntegratedTests/UserTest.cs | 8 +++---- Timeline.Tests/UsernameValidatorUnitTest.cs | 8 +------ Timeline/Controllers/ControllerAuthExtensions.cs | 2 +- Timeline/Controllers/UserAvatarController.cs | 2 +- Timeline/Controllers/UserController.cs | 18 +++++++------- Timeline/Entities/UserEntity.cs | 2 +- Timeline/Models/Http/UserInfo.cs | 21 +++++++++++----- Timeline/Models/Validation/NicknameValidator.cs | 2 +- Timeline/Services/TimelineService.cs | 2 +- Timeline/Services/UserService.cs | 2 ++ 14 files changed, 64 insertions(+), 47 deletions(-) (limited to 'Timeline/Controllers/UserController.cs') diff --git a/Timeline.Tests/Helpers/TestApplication.cs b/Timeline.Tests/Helpers/TestApplication.cs index 14cafea3..bc5deeec 100644 --- a/Timeline.Tests/Helpers/TestApplication.cs +++ b/Timeline.Tests/Helpers/TestApplication.cs @@ -17,10 +17,20 @@ namespace Timeline.Tests.Helpers public TestApplication(WebApplicationFactory factory) { DatabaseConnection = new SqliteConnection("Data Source=:memory:;"); + DatabaseConnection.Open(); + + var options = new DbContextOptionsBuilder() + .UseSqlite(DatabaseConnection) + .Options; + + using (var context = new DevelopmentDatabaseContext(options)) + { + context.Database.EnsureCreated(); + } Factory = factory.WithWebHostBuilder(builder => { - builder.ConfigureTestServices(services => + builder.ConfigureServices(services => { services.AddDbContext(options => { diff --git a/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs b/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs index af3e0c2f..242e96cd 100644 --- a/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs +++ b/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs @@ -63,7 +63,7 @@ namespace Timeline.Tests.IntegratedTests foreach (var user in users) { - userService.CreateUser(user); + userService.CreateUser(user).Wait(); userInfoList.Add(mapper.Map(user)); userInfoForAdminList.Add(mapper.Map(user)); } diff --git a/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs b/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs index 5c472e52..d787d87d 100644 --- a/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs +++ b/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs @@ -103,12 +103,12 @@ namespace Timeline.Tests.IntegratedTests } await AssertMembers(new List { UserInfoList[2] }); { - var res = await client.DeleteAsync("/users/users1/timeline/members/users2"); + var res = await client.DeleteAsync("/users/user1/timeline/members/user2"); res.Should().BeDelete(true); } await AssertEmptyMembers(); { - var res = await client.DeleteAsync("/users/users1/timeline/members/users2"); + var res = await client.DeleteAsync("/users/user1/timeline/members/users2"); res.Should().BeDelete(false); } await AssertEmptyMembers(); @@ -137,22 +137,22 @@ namespace Timeline.Tests.IntegratedTests } { - var res = await client.PutAsync("users/user1/timeline/member/user2", null); + var res = await client.PutAsync("users/user1/timeline/members/user2", null); res.Should().HaveStatusCode(opMemberUser); } { - var res = await client.DeleteAsync("users/user1/timeline/member/user2"); + var res = await client.DeleteAsync("users/user1/timeline/members/user2"); res.Should().HaveStatusCode(opMemberUser); } { - var res = await client.PutAsync("users/admin/timeline/member/user2", null); + var res = await client.PutAsync("users/admin/timeline/members/user2", null); res.Should().HaveStatusCode(opMemberAdmin); } { - var res = await client.DeleteAsync("users/admin/timeline/member/user2"); + var res = await client.DeleteAsync("users/admin/timeline/members/user2"); res.Should().HaveStatusCode(opMemberAdmin); } } @@ -244,7 +244,7 @@ namespace Timeline.Tests.IntegratedTests { using (var client = await CreateClientAsUser()) { - var res = await client.PutAsync("users/user/timeline/members/user2", null); + var res = await client.PutAsync("users/user1/timeline/members/user2", null); res.Should().HaveStatusCode(200); } @@ -283,7 +283,7 @@ namespace Timeline.Tests.IntegratedTests using (var client = await CreateClientAs(2)) { { // post as member - var res = await client.PostAsJsonAsync("users/user1/timeline/postop/create", + var res = await client.PostAsJsonAsync("users/user1/timeline/posts", new TimelinePostCreateRequest { Content = "aaa" }); res.Should().HaveStatusCode(200); } @@ -296,7 +296,7 @@ namespace Timeline.Tests.IntegratedTests async Task CreatePost(int userNumber) { using var client = await CreateClientAs(userNumber); - var res = await client.PostAsJsonAsync($"users/user1/timeline/postop/create", + var res = await client.PostAsJsonAsync($"users/user1/timeline/posts", new TimelinePostCreateRequest { Content = "aaa" }); return res.Should().HaveStatusCode(200) .And.HaveJsonBody() @@ -383,7 +383,7 @@ namespace Timeline.Tests.IntegratedTests .Which; body.Should().NotBeNull(); body.Content.Should().Be(mockContent); - body.Author.Should().Be(UserInfoList[1]); + body.Author.Should().BeEquivalentTo(UserInfoList[1]); createRes = body; } { @@ -402,9 +402,9 @@ namespace Timeline.Tests.IntegratedTests .And.HaveJsonBody() .Which; body.Should().NotBeNull(); - body.Content.Should().Be(mockContent); - body.Author.Should().Be(UserInfoList[1]); - body.Time.Should().Be(mockTime2); + body.Content.Should().Be(mockContent2); + body.Author.Should().BeEquivalentTo(UserInfoList[1]); + body.Time.Should().BeCloseTo(mockTime2, 1000); createRes2 = body; } { @@ -450,7 +450,7 @@ namespace Timeline.Tests.IntegratedTests var id2 = await CreatePost(now); { - var res = await client.GetAsync("users/user/timeline/posts"); + var res = await client.GetAsync("users/user1/timeline/posts"); res.Should().HaveStatusCode(200) .And.HaveJsonBody() .Which.Select(p => p.Id).Should().Equal(id1, id2, id0); diff --git a/Timeline.Tests/IntegratedTests/UserAvatarTest.cs b/Timeline.Tests/IntegratedTests/UserAvatarTest.cs index 989207e2..67c2dd9a 100644 --- a/Timeline.Tests/IntegratedTests/UserAvatarTest.cs +++ b/Timeline.Tests/IntegratedTests/UserAvatarTest.cs @@ -49,7 +49,7 @@ namespace Timeline.Tests.IntegratedTests var env = Factory.Server.Host.Services.GetRequiredService(); var defaultAvatarData = await File.ReadAllBytesAsync(Path.Combine(env.ContentRootPath, "default-avatar.png")); - async Task GetReturnDefault(string username = "user") + async Task GetReturnDefault(string username = "user1") { var res = await client.GetAsync($"users/{username}/avatar"); res.Should().HaveStatusCode(200); diff --git a/Timeline.Tests/IntegratedTests/UserTest.cs b/Timeline.Tests/IntegratedTests/UserTest.cs index 4c2ccf7a..1b9733ff 100644 --- a/Timeline.Tests/IntegratedTests/UserTest.cs +++ b/Timeline.Tests/IntegratedTests/UserTest.cs @@ -44,7 +44,7 @@ namespace Timeline.Tests.IntegratedTests using var client = await CreateClientAsAdministrator(); var res = await client.GetAsync("/users"); res.Should().HaveStatusCode(200) - .And.HaveJsonBody() + .And.HaveJsonBody() .Which.Should().BeEquivalentTo(UserInfoForAdminList); } @@ -74,7 +74,7 @@ namespace Timeline.Tests.IntegratedTests using var client = await CreateClientAsAdministrator(); var res = await client.GetAsync($"/users/user1"); res.Should().HaveStatusCode(200) - .And.HaveJsonBody() + .And.HaveJsonBody() .Which.Should().BeEquivalentTo(UserInfoForAdminList[1]); } @@ -142,7 +142,7 @@ namespace Timeline.Tests.IntegratedTests { // Token should expire. - var res = await userClient.GetAsync("/users"); + var res = await userClient.GetAsync("/testing/auth/Authorize"); res.Should().HaveStatusCode(HttpStatusCode.Unauthorized); } @@ -198,7 +198,7 @@ namespace Timeline.Tests.IntegratedTests [Fact] public async Task Patch_NoAuth_Unauthorized() { - using var client = await CreateClientAsUser(); + using var client = await CreateDefaultClient(); var res = await client.PatchAsJsonAsync("/users/user1", new UserPatchRequest { Nickname = "aaa" }); res.Should().HaveStatusCode(HttpStatusCode.Unauthorized); } diff --git a/Timeline.Tests/UsernameValidatorUnitTest.cs b/Timeline.Tests/UsernameValidatorUnitTest.cs index 1a09d477..0f844452 100644 --- a/Timeline.Tests/UsernameValidatorUnitTest.cs +++ b/Timeline.Tests/UsernameValidatorUnitTest.cs @@ -21,12 +21,6 @@ namespace Timeline.Tests return message; } - [Fact] - public void Null() - { - FailAndMessage(null).Should().ContainEquivalentOf("null"); - } - [Fact] public void NotString() { @@ -58,6 +52,7 @@ namespace Timeline.Tests } [Theory] + [InlineData(null)] [InlineData("abc")] [InlineData("-abc")] [InlineData("_abc")] @@ -68,7 +63,6 @@ namespace Timeline.Tests [InlineData("a-b_c")] public void Success(string value) { - var (result, _) = _validator.Validate(value); result.Should().BeTrue(); } diff --git a/Timeline/Controllers/ControllerAuthExtensions.cs b/Timeline/Controllers/ControllerAuthExtensions.cs index 90da8a93..34fd4d99 100644 --- a/Timeline/Controllers/ControllerAuthExtensions.cs +++ b/Timeline/Controllers/ControllerAuthExtensions.cs @@ -34,7 +34,7 @@ namespace Timeline.Controllers var claim = controller.User.FindFirst(ClaimTypes.NameIdentifier); if (claim == null) - throw new InvalidOperationException("Failed to get user id because User has no NameIdentifier claim."); + return null; if (long.TryParse(claim.Value, out var value)) return value; diff --git a/Timeline/Controllers/UserAvatarController.cs b/Timeline/Controllers/UserAvatarController.cs index ab0ad8e7..2dd279a8 100644 --- a/Timeline/Controllers/UserAvatarController.cs +++ b/Timeline/Controllers/UserAvatarController.cs @@ -78,7 +78,7 @@ namespace Timeline.Controllers [HttpPut("users/{username}/avatar")] [Authorize] - [RequireContentLength] + [RequireContentType, RequireContentLength] [Consumes("image/png", "image/jpeg", "image/gif", "image/webp")] public async Task Put([FromRoute][Username] string username) { diff --git a/Timeline/Controllers/UserController.cs b/Timeline/Controllers/UserController.cs index 400a518c..fa73c6f9 100644 --- a/Timeline/Controllers/UserController.cs +++ b/Timeline/Controllers/UserController.cs @@ -42,7 +42,13 @@ namespace Timeline.Controllers { var users = await _userService.GetUsers(); var administrator = this.IsAdministrator(); - return Ok(users.Select(u => ConvertToUserInfo(u, administrator)).ToArray()); + // Note: the (object) explicit conversion. If not convert, + // then result is a IUserInfo array and JsonSerializer will + // treat all element as IUserInfo and deserialize only properties + // in IUserInfo. So we convert it to object to make an object + // array so that JsonSerializer use the runtime type. + var result = users.Select(u => (object)ConvertToUserInfo(u, administrator)).ToArray(); + return Ok(result); } [HttpGet("users/{username}")] @@ -106,15 +112,11 @@ namespace Timeline.Controllers [HttpDelete("users/{username}"), AdminAuthorize] public async Task> Delete([FromRoute][Username] string username) { - try - { - await _userService.DeleteUser(username); + var delete = await _userService.DeleteUser(username); + if (delete) return Ok(CommonDeleteResponse.Delete()); - } - catch (UserNotExistException) - { + else return Ok(CommonDeleteResponse.NotExist()); - } } [HttpPost("userop/createuser"), AdminAuthorize] diff --git a/Timeline/Entities/UserEntity.cs b/Timeline/Entities/UserEntity.cs index dae6979f..946c3fa2 100644 --- a/Timeline/Entities/UserEntity.cs +++ b/Timeline/Entities/UserEntity.cs @@ -29,7 +29,7 @@ namespace Timeline.Entities [Column("version"), Required] public long Version { get; set; } - [Column("nickname"), MaxLength(40)] + [Column("nickname"), MaxLength(100)] public string? Nickname { get; set; } public UserAvatarEntity? Avatar { get; set; } diff --git a/Timeline/Models/Http/UserInfo.cs b/Timeline/Models/Http/UserInfo.cs index 6029b8aa..62d989a2 100644 --- a/Timeline/Models/Http/UserInfo.cs +++ b/Timeline/Models/Http/UserInfo.cs @@ -29,21 +29,30 @@ namespace Timeline.Models.Http public bool Administrator { get; set; } } - public class UserInfoSetAvatarUrlAction : IMappingAction + public class UserInfoAvatarUrlValueResolver : IValueResolver { private readonly IActionContextAccessor _actionContextAccessor; private readonly IUrlHelperFactory _urlHelperFactory; - public UserInfoSetAvatarUrlAction(IActionContextAccessor actionContextAccessor, IUrlHelperFactory urlHelperFactory) + public UserInfoAvatarUrlValueResolver() + { + } + + public UserInfoAvatarUrlValueResolver(IActionContextAccessor actionContextAccessor, IUrlHelperFactory urlHelperFactory) { _actionContextAccessor = actionContextAccessor; _urlHelperFactory = urlHelperFactory; } - public void Process(object source, IUserInfo destination, ResolutionContext context) + public string Resolve(User source, IUserInfo destination, string destMember, ResolutionContext context) { + if (_actionContextAccessor == null) + { + return $"/users/{destination.Username}/avatar"; + } + var urlHelper = _urlHelperFactory.GetUrlHelper(_actionContextAccessor.ActionContext); - destination.AvatarUrl = urlHelper.ActionLink(nameof(UserAvatarController.Get), nameof(UserAvatarController), new { destination.Username }); + return urlHelper.ActionLink(nameof(UserAvatarController.Get), nameof(UserAvatarController), new { destination.Username }); } } @@ -51,8 +60,8 @@ namespace Timeline.Models.Http { public UserInfoAutoMapperProfile() { - CreateMap().AfterMap(); - CreateMap().AfterMap(); + CreateMap().ForMember(u => u.AvatarUrl, opt => opt.MapFrom()); + CreateMap().ForMember(u => u.AvatarUrl, opt => opt.MapFrom()); } } } diff --git a/Timeline/Models/Validation/NicknameValidator.cs b/Timeline/Models/Validation/NicknameValidator.cs index 53a2916b..1d6ab163 100644 --- a/Timeline/Models/Validation/NicknameValidator.cs +++ b/Timeline/Models/Validation/NicknameValidator.cs @@ -7,7 +7,7 @@ namespace Timeline.Models.Validation { protected override (bool, string) DoValidate(string value) { - if (value.Length > 10) + if (value.Length > 25) return (false, MessageTooLong); return (true, GetSuccessMessage()); diff --git a/Timeline/Services/TimelineService.cs b/Timeline/Services/TimelineService.cs index 89936aa2..16402f3e 100644 --- a/Timeline/Services/TimelineService.cs +++ b/Timeline/Services/TimelineService.cs @@ -295,7 +295,7 @@ namespace Timeline.Services { if (entity.Content != null) // otherwise it is deleted { - var author = Mapper.Map(UserService.GetUserById(entity.AuthorId)); + var author = Mapper.Map(await UserService.GetUserById(entity.AuthorId)); posts.Add(new TimelinePostInfo { Id = entity.Id, diff --git a/Timeline/Services/UserService.cs b/Timeline/Services/UserService.cs index 1197bb73..d2dc969e 100644 --- a/Timeline/Services/UserService.cs +++ b/Timeline/Services/UserService.cs @@ -300,12 +300,14 @@ namespace Timeline.Services var administrator = info.Administrator ?? false; var password = info.Password; + var nickname = info.Nickname; var newEntity = new UserEntity { Username = username, Password = _passwordService.HashPassword(password), Roles = UserRoleConvert.ToString(administrator), + Nickname = nickname, Version = 1 }; _databaseContext.Users.Add(newEntity); -- cgit v1.2.3 From 0dc8b59b435f978428c73bc28e2a424bc413c562 Mon Sep 17 00:00:00 2001 From: crupest Date: Fri, 31 Jan 2020 15:21:58 +0800 Subject: Combine two user info types. --- .../IntegratedTests/IntegratedTestBase.cs | 15 ++++---- .../IntegratedTests/PersonalTimelineTest.cs | 8 ++-- Timeline.Tests/IntegratedTests/TokenTest.cs | 4 +- Timeline.Tests/IntegratedTests/UserTest.cs | 20 +++++----- Timeline/Controllers/TokenController.cs | 4 +- Timeline/Controllers/UserController.cs | 22 +++-------- Timeline/Models/Http/TokenController.cs | 4 +- Timeline/Models/Http/UserInfo.cs | 45 ++++++++++------------ 8 files changed, 54 insertions(+), 68 deletions(-) (limited to 'Timeline/Controllers/UserController.cs') diff --git a/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs b/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs index 242e96cd..59af5eab 100644 --- a/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs +++ b/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs @@ -15,6 +15,12 @@ namespace Timeline.Tests.IntegratedTests public abstract class IntegratedTestBase : IClassFixture>, IDisposable { + static IntegratedTestBase() + { + FluentAssertions.AssertionOptions.AssertEquivalencyUsing(options => + options.Excluding(m => m.RuntimeType == typeof(UserInfo) && m.SelectedMemberPath == "_links")); + } + protected TestApplication TestApp { get; } protected WebApplicationFactory Factory => TestApp.Factory; @@ -56,7 +62,6 @@ namespace Timeline.Tests.IntegratedTests } var userInfoList = new List(); - var userInfoForAdminList = new List(); var userService = scope.ServiceProvider.GetRequiredService(); var mapper = scope.ServiceProvider.GetRequiredService(); @@ -65,11 +70,9 @@ namespace Timeline.Tests.IntegratedTests { userService.CreateUser(user).Wait(); userInfoList.Add(mapper.Map(user)); - userInfoForAdminList.Add(mapper.Map(user)); } - UserInfoList = userInfoList; - UserInfoForAdminList = userInfoForAdminList; + UserInfos = userInfoList; } } @@ -83,9 +86,7 @@ namespace Timeline.Tests.IntegratedTests TestApp.Dispose(); } - public IReadOnlyList UserInfoList { get; } - - public IReadOnlyList UserInfoForAdminList { get; } + public IReadOnlyList UserInfos { get; } public Task CreateDefaultClient() { diff --git a/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs b/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs index dacfea62..f3d6b172 100644 --- a/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs +++ b/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs @@ -26,7 +26,7 @@ namespace Timeline.Tests.IntegratedTests var res = await client.GetAsync("users/user1/timeline"); var body = res.Should().HaveStatusCode(200) .And.HaveJsonBody().Which; - body.Owner.Should().BeEquivalentTo(UserInfoList[1]); + body.Owner.Should().BeEquivalentTo(UserInfos[1]); body.Visibility.Should().Be(TimelineVisibility.Register); body.Description.Should().Be(""); body.Members.Should().NotBeNull().And.BeEmpty(); @@ -169,7 +169,7 @@ namespace Timeline.Tests.IntegratedTests var res = await client.PutAsync("/users/user1/timeline/members/user2", null); res.Should().HaveStatusCode(200); } - await AssertMembers(new List { UserInfoList[2] }); + await AssertMembers(new List { UserInfos[2] }); { var res = await client.DeleteAsync("/users/user1/timeline/members/user2"); res.Should().BeDelete(true); @@ -452,7 +452,7 @@ namespace Timeline.Tests.IntegratedTests .Which; body.Should().NotBeNull(); body.Content.Should().Be(mockContent); - body.Author.Should().BeEquivalentTo(UserInfoList[1]); + body.Author.Should().BeEquivalentTo(UserInfos[1]); createRes = body; } { @@ -472,7 +472,7 @@ namespace Timeline.Tests.IntegratedTests .Which; body.Should().NotBeNull(); body.Content.Should().Be(mockContent2); - body.Author.Should().BeEquivalentTo(UserInfoList[1]); + body.Author.Should().BeEquivalentTo(UserInfos[1]); body.Time.Should().BeCloseTo(mockTime2, 1000); createRes2 = body; } diff --git a/Timeline.Tests/IntegratedTests/TokenTest.cs b/Timeline.Tests/IntegratedTests/TokenTest.cs index ec7514ff..928d546c 100644 --- a/Timeline.Tests/IntegratedTests/TokenTest.cs +++ b/Timeline.Tests/IntegratedTests/TokenTest.cs @@ -77,7 +77,7 @@ namespace Timeline.Tests.IntegratedTests var body = response.Should().HaveStatusCode(200) .And.HaveJsonBody().Which; body.Token.Should().NotBeNullOrWhiteSpace(); - body.User.Should().BeEquivalentTo(UserInfoForAdminList[1]); + body.User.Should().BeEquivalentTo(UserInfos[1]); } [Fact] @@ -165,7 +165,7 @@ namespace Timeline.Tests.IntegratedTests new VerifyTokenRequest { Token = createTokenResult.Token }); response.Should().HaveStatusCode(200) .And.HaveJsonBody() - .Which.User.Should().BeEquivalentTo(UserInfoForAdminList[1]); + .Which.User.Should().BeEquivalentTo(UserInfos[1]); } } } diff --git a/Timeline.Tests/IntegratedTests/UserTest.cs b/Timeline.Tests/IntegratedTests/UserTest.cs index 1b9733ff..bbeb6ad6 100644 --- a/Timeline.Tests/IntegratedTests/UserTest.cs +++ b/Timeline.Tests/IntegratedTests/UserTest.cs @@ -25,7 +25,7 @@ namespace Timeline.Tests.IntegratedTests var res = await client.GetAsync("/users"); res.Should().HaveStatusCode(200) .And.HaveJsonBody() - .Which.Should().BeEquivalentTo(UserInfoList); + .Which.Should().BeEquivalentTo(UserInfos); } [Fact] @@ -35,7 +35,7 @@ namespace Timeline.Tests.IntegratedTests var res = await client.GetAsync("/users"); res.Should().HaveStatusCode(200) .And.HaveJsonBody() - .Which.Should().BeEquivalentTo(UserInfoList); + .Which.Should().BeEquivalentTo(UserInfos); } [Fact] @@ -44,8 +44,8 @@ namespace Timeline.Tests.IntegratedTests using var client = await CreateClientAsAdministrator(); var res = await client.GetAsync("/users"); res.Should().HaveStatusCode(200) - .And.HaveJsonBody() - .Which.Should().BeEquivalentTo(UserInfoForAdminList); + .And.HaveJsonBody() + .Which.Should().BeEquivalentTo(UserInfos); } [Fact] @@ -55,7 +55,7 @@ namespace Timeline.Tests.IntegratedTests var res = await client.GetAsync($"/users/admin"); res.Should().HaveStatusCode(200) .And.HaveJsonBody() - .Which.Should().BeEquivalentTo(UserInfoList[0]); + .Which.Should().BeEquivalentTo(UserInfos[0]); } [Fact] @@ -65,7 +65,7 @@ namespace Timeline.Tests.IntegratedTests var res = await client.GetAsync($"/users/admin"); res.Should().HaveStatusCode(200) .And.HaveJsonBody() - .Which.Should().BeEquivalentTo(UserInfoList[0]); + .Which.Should().BeEquivalentTo(UserInfos[0]); } [Fact] @@ -74,8 +74,8 @@ namespace Timeline.Tests.IntegratedTests using var client = await CreateClientAsAdministrator(); var res = await client.GetAsync($"/users/user1"); res.Should().HaveStatusCode(200) - .And.HaveJsonBody() - .Which.Should().BeEquivalentTo(UserInfoForAdminList[1]); + .And.HaveJsonBody() + .Which.Should().BeEquivalentTo(UserInfos[1]); } [Fact] @@ -134,7 +134,7 @@ namespace Timeline.Tests.IntegratedTests { var res = await client.GetAsync("/users/newuser"); var body = res.Should().HaveStatusCode(200) - .And.HaveJsonBody() + .And.HaveJsonBody() .Which; body.Administrator.Should().Be(true); body.Nickname.Should().Be("aaa"); @@ -301,7 +301,7 @@ namespace Timeline.Tests.IntegratedTests { var res = await client.GetAsync("users/aaa"); var body = res.Should().HaveStatusCode(200) - .And.HaveJsonBody().Which; + .And.HaveJsonBody().Which; body.Username.Should().Be("aaa"); body.Nickname.Should().Be("ccc"); body.Administrator.Should().BeTrue(); diff --git a/Timeline/Controllers/TokenController.cs b/Timeline/Controllers/TokenController.cs index a7f5fbde..1fb0b17a 100644 --- a/Timeline/Controllers/TokenController.cs +++ b/Timeline/Controllers/TokenController.cs @@ -59,7 +59,7 @@ namespace Timeline.Controllers return Ok(new CreateTokenResponse { Token = result.Token, - User = _mapper.Map(result.User) + User = _mapper.Map(result.User) }); } catch (UserNotExistException e) @@ -94,7 +94,7 @@ namespace Timeline.Controllers ("Username", result.Username), ("Token", request.Token))); return Ok(new VerifyTokenResponse { - User = _mapper.Map(result) + User = _mapper.Map(result) }); } catch (UserTokenTimeExpireException e) diff --git a/Timeline/Controllers/UserController.cs b/Timeline/Controllers/UserController.cs index fa73c6f9..4572296b 100644 --- a/Timeline/Controllers/UserController.cs +++ b/Timeline/Controllers/UserController.cs @@ -29,35 +29,23 @@ namespace Timeline.Controllers _mapper = mapper; } - private IUserInfo ConvertToUserInfo(User user, bool administrator) - { - if (administrator) - return _mapper.Map(user); - else - return _mapper.Map(user); - } + private UserInfo ConvertToUserInfo(User user) => _mapper.Map(user); [HttpGet("users")] - public async Task> List() + public async Task> List() { var users = await _userService.GetUsers(); - var administrator = this.IsAdministrator(); - // Note: the (object) explicit conversion. If not convert, - // then result is a IUserInfo array and JsonSerializer will - // treat all element as IUserInfo and deserialize only properties - // in IUserInfo. So we convert it to object to make an object - // array so that JsonSerializer use the runtime type. - var result = users.Select(u => (object)ConvertToUserInfo(u, administrator)).ToArray(); + var result = users.Select(u => ConvertToUserInfo(u)).ToArray(); return Ok(result); } [HttpGet("users/{username}")] - public async Task> Get([FromRoute][Username] string username) + public async Task> Get([FromRoute][Username] string username) { try { var user = await _userService.GetUserByUsername(username); - return Ok(ConvertToUserInfo(user, this.IsAdministrator())); + return Ok(ConvertToUserInfo(user)); } catch (UserNotExistException e) { diff --git a/Timeline/Models/Http/TokenController.cs b/Timeline/Models/Http/TokenController.cs index 383b2965..ea8b59ed 100644 --- a/Timeline/Models/Http/TokenController.cs +++ b/Timeline/Models/Http/TokenController.cs @@ -16,7 +16,7 @@ namespace Timeline.Models.Http public class CreateTokenResponse { public string Token { get; set; } = default!; - public UserInfoForAdmin User { get; set; } = default!; + public UserInfo User { get; set; } = default!; } public class VerifyTokenRequest @@ -27,6 +27,6 @@ namespace Timeline.Models.Http public class VerifyTokenResponse { - public UserInfoForAdmin User { get; set; } = default!; + public UserInfo User { get; set; } = default!; } } diff --git a/Timeline/Models/Http/UserInfo.cs b/Timeline/Models/Http/UserInfo.cs index 07ac0aad..5890a7a6 100644 --- a/Timeline/Models/Http/UserInfo.cs +++ b/Timeline/Models/Http/UserInfo.cs @@ -7,54 +7,52 @@ using Timeline.Services; namespace Timeline.Models.Http { - public interface IUserInfo - { - string Username { get; set; } - string Nickname { get; set; } - string AvatarUrl { get; set; } - } - - public class UserInfo : IUserInfo + public class UserInfo { public string Username { get; set; } = default!; public string Nickname { get; set; } = default!; - public string AvatarUrl { get; set; } = default!; + public bool? Administrator { get; set; } = default!; +#pragma warning disable CA1707 + public UserInfoLinks? _links { get; set; } +#pragma warning restore CA1707 } - public class UserInfoForAdmin : IUserInfo + public class UserInfoLinks { - public string Username { get; set; } = default!; - public string Nickname { get; set; } = default!; - public string AvatarUrl { get; set; } = default!; - public bool Administrator { get; set; } + public string Avatar { get; set; } = default!; + public string Timeline { get; set; } = default!; } - public class UserInfoAvatarUrlValueResolver : IValueResolver + public class UserInfoLinksValueResolver : IValueResolver { private readonly IActionContextAccessor? _actionContextAccessor; private readonly IUrlHelperFactory? _urlHelperFactory; - public UserInfoAvatarUrlValueResolver() + public UserInfoLinksValueResolver() { _actionContextAccessor = null; _urlHelperFactory = null; } - public UserInfoAvatarUrlValueResolver(IActionContextAccessor actionContextAccessor, IUrlHelperFactory urlHelperFactory) + public UserInfoLinksValueResolver(IActionContextAccessor actionContextAccessor, IUrlHelperFactory urlHelperFactory) { _actionContextAccessor = actionContextAccessor; _urlHelperFactory = urlHelperFactory; } - public string Resolve(User source, IUserInfo destination, string destMember, ResolutionContext context) + public UserInfoLinks? Resolve(User source, UserInfo destination, UserInfoLinks? destMember, ResolutionContext context) { - if (_actionContextAccessor == null) + if (_actionContextAccessor == null || _urlHelperFactory == null) { - return $"/users/{destination.Username}/avatar"; + return null; } - var urlHelper = _urlHelperFactory!.GetUrlHelper(_actionContextAccessor.ActionContext); - return urlHelper.ActionLink(nameof(UserAvatarController.Get), nameof(UserAvatarController), new { destination.Username }); + var urlHelper = _urlHelperFactory.GetUrlHelper(_actionContextAccessor.ActionContext); + return new UserInfoLinks + { + Avatar = urlHelper.ActionLink(nameof(UserAvatarController.Get), nameof(UserAvatarController), new { destination.Username }), + Timeline = urlHelper.ActionLink(nameof(PersonalTimelineController.TimelineGet), nameof(PersonalTimelineController), new { destination.Username }) + }; } } @@ -62,8 +60,7 @@ namespace Timeline.Models.Http { public UserInfoAutoMapperProfile() { - CreateMap().ForMember(u => u.AvatarUrl, opt => opt.MapFrom()); - CreateMap().ForMember(u => u.AvatarUrl, opt => opt.MapFrom()); + CreateMap().ForMember(u => u._links, opt => opt.MapFrom()); } } } -- cgit v1.2.3 From b892622e7ffdf4220f6631ec58f7a6692881dd35 Mon Sep 17 00:00:00 2001 From: crupest Date: Fri, 31 Jan 2020 21:57:09 +0800 Subject: Fix test bugs in user info mapper. Make create user action return created user info. --- Timeline.Tests/IntegratedTests/IntegratedTestBase.cs | 3 +-- Timeline.Tests/IntegratedTests/UserTest.cs | 6 +++++- Timeline/Controllers/UserController.cs | 6 +++--- Timeline/Models/Http/UserInfo.cs | 14 +++----------- Timeline/Services/UserService.cs | 8 ++++---- 5 files changed, 16 insertions(+), 21 deletions(-) (limited to 'Timeline/Controllers/UserController.cs') diff --git a/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs b/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs index 59af5eab..dfde2ea5 100644 --- a/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs +++ b/Timeline.Tests/IntegratedTests/IntegratedTestBase.cs @@ -12,13 +12,12 @@ using Xunit; namespace Timeline.Tests.IntegratedTests { - public abstract class IntegratedTestBase : IClassFixture>, IDisposable { static IntegratedTestBase() { FluentAssertions.AssertionOptions.AssertEquivalencyUsing(options => - options.Excluding(m => m.RuntimeType == typeof(UserInfo) && m.SelectedMemberPath == "_links")); + options.Excluding(m => m.RuntimeType == typeof(UserInfoLinks))); } protected TestApplication TestApp { get; } diff --git a/Timeline.Tests/IntegratedTests/UserTest.cs b/Timeline.Tests/IntegratedTests/UserTest.cs index bbeb6ad6..f863eb6c 100644 --- a/Timeline.Tests/IntegratedTests/UserTest.cs +++ b/Timeline.Tests/IntegratedTests/UserTest.cs @@ -296,7 +296,11 @@ namespace Timeline.Tests.IntegratedTests Administrator = true, Nickname = "ccc" }); - res.Should().HaveStatusCode(200); + var body = res.Should().HaveStatusCode(200) + .And.HaveJsonBody().Which; + body.Username.Should().Be("aaa"); + body.Nickname.Should().Be("ccc"); + body.Administrator.Should().BeTrue(); } { var res = await client.GetAsync("users/aaa"); diff --git a/Timeline/Controllers/UserController.cs b/Timeline/Controllers/UserController.cs index 4572296b..26e63f63 100644 --- a/Timeline/Controllers/UserController.cs +++ b/Timeline/Controllers/UserController.cs @@ -108,12 +108,12 @@ namespace Timeline.Controllers } [HttpPost("userop/createuser"), AdminAuthorize] - public async Task CreateUser([FromBody] CreateUserRequest body) + public async Task> CreateUser([FromBody] CreateUserRequest body) { try { - await _userService.CreateUser(_mapper.Map(body)); - return Ok(); + var user = await _userService.CreateUser(_mapper.Map(body)); + return Ok(ConvertToUserInfo(user)); } catch (ConflictException) { diff --git a/Timeline/Models/Http/UserInfo.cs b/Timeline/Models/Http/UserInfo.cs index fee53ade..0d1d702b 100644 --- a/Timeline/Models/Http/UserInfo.cs +++ b/Timeline/Models/Http/UserInfo.cs @@ -25,14 +25,8 @@ namespace Timeline.Models.Http public class UserInfoLinksValueResolver : IValueResolver { - private readonly IActionContextAccessor? _actionContextAccessor; - private readonly IUrlHelperFactory? _urlHelperFactory; - - public UserInfoLinksValueResolver() - { - _actionContextAccessor = null; - _urlHelperFactory = null; - } + private readonly IActionContextAccessor _actionContextAccessor; + private readonly IUrlHelperFactory _urlHelperFactory; public UserInfoLinksValueResolver(IActionContextAccessor actionContextAccessor, IUrlHelperFactory urlHelperFactory) { @@ -42,10 +36,8 @@ namespace Timeline.Models.Http public UserInfoLinks? Resolve(User source, UserInfo destination, UserInfoLinks? destMember, ResolutionContext context) { - if (_actionContextAccessor == null || _urlHelperFactory == null) - { + if (_actionContextAccessor.ActionContext == null) return null; - } var urlHelper = _urlHelperFactory.GetUrlHelper(_actionContextAccessor.ActionContext); var result = new UserInfoLinks diff --git a/Timeline/Services/UserService.cs b/Timeline/Services/UserService.cs index d2dc969e..93d92740 100644 --- a/Timeline/Services/UserService.cs +++ b/Timeline/Services/UserService.cs @@ -64,7 +64,7 @@ namespace Timeline.Services /// /// The info of new user. /// The password, can't be null or empty. - /// The id of the new user. + /// The the new user. /// Thrown when is null. /// Thrown when some fields in is bad. /// Thrown when a user with given username already exists. @@ -75,7 +75,7 @@ namespace Timeline.Services /// must be a valid nickname if set. It is empty by default. /// Other fields are ignored. /// - Task CreateUser(User info); + Task CreateUser(User info); /// /// Modify a user's info. @@ -276,7 +276,7 @@ namespace Timeline.Services return entities.Select(user => CreateUserFromEntity(user)).ToArray(); } - public async Task CreateUser(User info) + public async Task CreateUser(User info) { if (info == null) throw new ArgumentNullException(nameof(info)); @@ -316,7 +316,7 @@ namespace Timeline.Services _logger.LogInformation(Log.Format(LogDatabaseCreate, ("Id", newEntity.Id), ("Username", username), ("Administrator", administrator))); - return newEntity.Id; + return CreateUserFromEntity(newEntity); } private void ValidateModifyUserInfo(User? info) -- cgit v1.2.3 From 873d0d8df10e1d6403b7a4eac1980f874dfe1d05 Mon Sep 17 00:00:00 2001 From: crupest Date: Fri, 31 Jan 2020 22:46:17 +0800 Subject: Make all patch return the new entity. --- .../IntegratedTests/PersonalTimelineTest.cs | 9 ++++-- Timeline.Tests/IntegratedTests/UserTest.cs | 10 +++++-- Timeline/Controllers/PersonalTimelineController.cs | 5 ++-- Timeline/Controllers/UserController.cs | 10 +++---- Timeline/Services/TimelineService.cs | 32 ++++++++++++---------- Timeline/Services/UserService.cs | 14 +++++++--- 6 files changed, 49 insertions(+), 31 deletions(-) (limited to 'Timeline/Controllers/UserController.cs') diff --git a/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs b/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs index f3d6b172..81446fd8 100644 --- a/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs +++ b/Timeline.Tests/IntegratedTests/PersonalTimelineTest.cs @@ -119,19 +119,22 @@ namespace Timeline.Tests.IntegratedTests { var res = await client.PatchAsJsonAsync("users/user1/timeline", new TimelinePatchRequest { Description = mockDescription }); - res.Should().HaveStatusCode(200); + res.Should().HaveStatusCode(200) + .And.HaveJsonBody().Which.Description.Should().Be(mockDescription); await AssertDescription(mockDescription); } { var res = await client.PatchAsJsonAsync("users/user1/timeline", new TimelinePatchRequest { Description = null }); - res.Should().HaveStatusCode(200); + res.Should().HaveStatusCode(200) + .And.HaveJsonBody().Which.Description.Should().Be(mockDescription); await AssertDescription(mockDescription); } { var res = await client.PatchAsJsonAsync("users/user1/timeline", new TimelinePatchRequest { Description = "" }); - res.Should().HaveStatusCode(200); + res.Should().HaveStatusCode(200) + .And.HaveJsonBody().Which.Description.Should().Be(""); await AssertDescription(""); } } diff --git a/Timeline.Tests/IntegratedTests/UserTest.cs b/Timeline.Tests/IntegratedTests/UserTest.cs index f863eb6c..8ce76299 100644 --- a/Timeline.Tests/IntegratedTests/UserTest.cs +++ b/Timeline.Tests/IntegratedTests/UserTest.cs @@ -102,7 +102,9 @@ namespace Timeline.Tests.IntegratedTests { var res = await client.PatchAsJsonAsync("/users/user1", new UserPatchRequest { Nickname = "aaa" }); - res.Should().HaveStatusCode(200); + res.Should().HaveStatusCode(200) + .And.HaveJsonBody() + .Which.Nickname.Should().Be("aaa"); } { @@ -128,7 +130,11 @@ namespace Timeline.Tests.IntegratedTests Administrator = true, Nickname = "aaa" }); - res.Should().HaveStatusCode(200); + var body = res.Should().HaveStatusCode(200) + .And.HaveJsonBody() + .Which; + body.Administrator.Should().Be(true); + body.Nickname.Should().Be("aaa"); } { diff --git a/Timeline/Controllers/PersonalTimelineController.cs b/Timeline/Controllers/PersonalTimelineController.cs index 27618c41..11353bb5 100644 --- a/Timeline/Controllers/PersonalTimelineController.cs +++ b/Timeline/Controllers/PersonalTimelineController.cs @@ -77,14 +77,15 @@ namespace Timeline.Controllers [HttpPatch("users/{username}/timeline")] [Authorize] - public async Task TimelinePatch([FromRoute][Username] string username, [FromBody] TimelinePatchRequest body) + public async Task> TimelinePatch([FromRoute][Username] string username, [FromBody] TimelinePatchRequest body) { if (!this.IsAdministrator() && !(User.Identity.Name == username)) { return StatusCode(StatusCodes.Status403Forbidden, ErrorResponse.Common.Forbid()); } await _service.ChangeProperty(username, body); - return Ok(); + var timeline = await _service.GetTimeline(username); + return Ok(timeline); } [HttpPut("users/{username}/timeline/members/{member}")] diff --git a/Timeline/Controllers/UserController.cs b/Timeline/Controllers/UserController.cs index 26e63f63..a3e8d816 100644 --- a/Timeline/Controllers/UserController.cs +++ b/Timeline/Controllers/UserController.cs @@ -55,14 +55,14 @@ namespace Timeline.Controllers } [HttpPatch("users/{username}"), Authorize] - public async Task Patch([FromBody] UserPatchRequest body, [FromRoute][Username] string username) + public async Task> Patch([FromBody] UserPatchRequest body, [FromRoute][Username] string username) { if (this.IsAdministrator()) { try { - await _userService.ModifyUser(username, _mapper.Map(body)); - return Ok(); + var user = await _userService.ModifyUser(username, _mapper.Map(body)); + return Ok(ConvertToUserInfo(user)); } catch (UserNotExistException e) { @@ -92,8 +92,8 @@ namespace Timeline.Controllers return StatusCode(StatusCodes.Status403Forbidden, ErrorResponse.Common.CustomMessage_Forbid(UserController_Patch_Forbid_Administrator)); - await _userService.ModifyUser(this.GetUserId(), _mapper.Map(body)); - return Ok(); + var user = await _userService.ModifyUser(this.GetUserId(), _mapper.Map(body)); + return Ok(ConvertToUserInfo(user)); } } diff --git a/Timeline/Services/TimelineService.cs b/Timeline/Services/TimelineService.cs index 85445973..0ea68265 100644 --- a/Timeline/Services/TimelineService.cs +++ b/Timeline/Services/TimelineService.cs @@ -80,21 +80,6 @@ namespace Timeline.Services /// Task DeletePost(string name, long id); - /// - /// Set the properties of a timeline. - /// - /// Username or the timeline name. See remarks of . - /// The new properties. Null member means not to change. - /// Thrown when or is null. - /// Thrown when is illegal. It is not a valid timeline name (for normal timeline service) or a valid username (for personal timeline service). - /// - /// Thrown when timeline does not exist. - /// For normal timeline, it means the name does not exist. - /// For personal timeline, it means the user of that username does not exist - /// and the inner exception should be a . - /// - Task ChangeProperty(string name, TimelinePatchRequest newProperties); - /// /// Remove members to a timeline. /// @@ -235,6 +220,23 @@ namespace Timeline.Services /// Thrown when the user does not exist. Inner exception MUST be . /// Task GetTimeline(string username); + + /// + /// Set the properties of a timeline. + /// + /// Username or the timeline name. See remarks of . + /// The new properties. Null member means not to change. + /// + /// Thrown when is null. + /// + /// + /// Thrown when is of bad format. + /// + /// + /// Thrown when the user does not exist. Inner exception MUST be . + /// + Task ChangeProperty(string name, TimelinePatchRequest newProperties); + } public abstract class BaseTimelineService : IBaseTimelineService diff --git a/Timeline/Services/UserService.cs b/Timeline/Services/UserService.cs index 93d92740..7dc7159d 100644 --- a/Timeline/Services/UserService.cs +++ b/Timeline/Services/UserService.cs @@ -82,6 +82,7 @@ namespace Timeline.Services /// /// The id of the user. /// The new info. May be null. + /// The new user info. /// Thrown when some fields in is bad. /// Thrown when user with given id does not exist. /// @@ -96,13 +97,14 @@ namespace Timeline.Services /// /// /// - Task ModifyUser(long id, User? info); + Task ModifyUser(long id, User? info); /// /// Modify a user's info. /// /// The username of the user. /// The new info. May be null. + /// The new user info. /// Thrown when is null. /// Thrown when is of bad format or some fields in is bad. /// Thrown when user with given id does not exist. @@ -120,7 +122,7 @@ namespace Timeline.Services /// Note: Whether is set or not, version will increase and not set to the specified value if there is one. /// /// - Task ModifyUser(string username, User? info); + Task ModifyUser(string username, User? info); /// /// Delete a user of given id. @@ -370,7 +372,7 @@ namespace Timeline.Services } - public async Task ModifyUser(long id, User? info) + public async Task ModifyUser(long id, User? info) { ValidateModifyUserInfo(info); @@ -382,9 +384,11 @@ namespace Timeline.Services await _databaseContext.SaveChangesAsync(); _logger.LogInformation(LogDatabaseUpdate, ("Id", id)); + + return CreateUserFromEntity(entity); } - public async Task ModifyUser(string username, User? info) + public async Task ModifyUser(string username, User? info) { if (username == null) throw new ArgumentNullException(nameof(username)); @@ -400,6 +404,8 @@ namespace Timeline.Services await _databaseContext.SaveChangesAsync(); _logger.LogInformation(LogDatabaseUpdate, ("Username", username)); + + return CreateUserFromEntity(entity); } public async Task DeleteUser(long id) -- cgit v1.2.3