From 62a3557ab62e1fa188e7498643d7cf0221a18322 Mon Sep 17 00:00:00 2001 From: 杨宇千 Date: Wed, 21 Aug 2019 18:33:07 +0800 Subject: Add database entity and service. --- Timeline/Services/UserDetailService.cs | 90 ++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 Timeline/Services/UserDetailService.cs (limited to 'Timeline/Services/UserDetailService.cs') diff --git a/Timeline/Services/UserDetailService.cs b/Timeline/Services/UserDetailService.cs new file mode 100644 index 00000000..c3a2a1af --- /dev/null +++ b/Timeline/Services/UserDetailService.cs @@ -0,0 +1,90 @@ +using Microsoft.EntityFrameworkCore; +using Microsoft.Extensions.Logging; +using System; +using System.Linq; +using System.Threading.Tasks; +using Timeline.Entities; +using Timeline.Models; + +namespace Timeline.Services +{ + public interface IUserDetailService + { + /// + /// Get the detail of user. + /// + /// The username to get user detail of. + /// The user detail. + /// Thrown if is null or empty. + /// Thrown if user doesn't exist. + Task GetUserDetail(string username); + + /// + /// Update the detail of user. This function does not do data check. + /// + /// The username to get user detail of. + /// The detail to update. Can't be null. Any null member means not set. + /// Thrown if is null or empty or is null. + /// Thrown if user doesn't exist. + Task UpdateUserDetail(string username, UserDetail detail); + } + + public class UserDetailService : IUserDetailService + { + private readonly ILogger _logger; + + private readonly DatabaseContext _databaseContext; + + public UserDetailService(ILogger logger, DatabaseContext databaseContext) + { + _logger = logger; + _databaseContext = databaseContext; + } + + // Check the existence of user detail entry + private async Task CheckAndInit(long userId) + { + var detail = await _databaseContext.UserDetails.Where(e => e.UserId == userId).SingleOrDefaultAsync(); + if (detail == null) + { + detail = new UserDetailEntity() + { + UserId = userId + }; + _databaseContext.UserDetails.Add(detail); + await _databaseContext.SaveChangesAsync(); + } + return detail; + } + + public async Task GetUserDetail(string username) + { + var userId = await DatabaseExtensions.CheckAndGetUser(_databaseContext.Users, username); + var detailEntity = await CheckAndInit(userId); + return UserDetail.From(detailEntity); + } + + public async Task UpdateUserDetail(string username, UserDetail detail) + { + if (detail == null) + throw new ArgumentNullException(nameof(detail)); + + var userId = await DatabaseExtensions.CheckAndGetUser(_databaseContext.Users, username); + var detailEntity = await CheckAndInit(userId); + + if (detail.QQ != null) + detailEntity.QQ = detail.QQ; + + if (detail.EMail != null) + detailEntity.EMail = detail.EMail; + + if (detail.PhoneNumber != null) + detailEntity.PhoneNumber = detail.PhoneNumber; + + if (detail.Description != null) + detailEntity.Description = detail.Description; + + await _databaseContext.SaveChangesAsync(); + } + } +} -- cgit v1.2.3 From dbc8d78dc0f21f423a0fe2db9dd782da43b5b468 Mon Sep 17 00:00:00 2001 From: 杨宇千 Date: Wed, 21 Aug 2019 22:36:04 +0800 Subject: Add database test for user detail. --- Timeline.Tests/DatabaseTest.cs | 17 ++++++++++++++++- Timeline/Services/UserDetailService.cs | 2 ++ 2 files changed, 18 insertions(+), 1 deletion(-) (limited to 'Timeline/Services/UserDetailService.cs') diff --git a/Timeline.Tests/DatabaseTest.cs b/Timeline.Tests/DatabaseTest.cs index e280637c..f75ab71b 100644 --- a/Timeline.Tests/DatabaseTest.cs +++ b/Timeline.Tests/DatabaseTest.cs @@ -1,5 +1,4 @@ using FluentAssertions; -using Microsoft.EntityFrameworkCore; using System; using System.Linq; using Timeline.Entities; @@ -33,5 +32,21 @@ namespace Timeline.Tests _context.SaveChanges(); _context.UserAvatars.Count().Should().Be(1); } + + [Fact] + public void DeleteUserShouldAlsoDeleteDetail() + { + var user = _context.Users.First(); + _context.UserDetails.Add(new UserDetailEntity + { + 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/Services/UserDetailService.cs b/Timeline/Services/UserDetailService.cs index c3a2a1af..d1fdc040 100644 --- a/Timeline/Services/UserDetailService.cs +++ b/Timeline/Services/UserDetailService.cs @@ -53,6 +53,7 @@ namespace Timeline.Services }; _databaseContext.UserDetails.Add(detail); await _databaseContext.SaveChangesAsync(); + _logger.LogInformation("An entity is created in user_details."); } return detail; } @@ -85,6 +86,7 @@ namespace Timeline.Services detailEntity.Description = detail.Description; await _databaseContext.SaveChangesAsync(); + _logger.LogInformation("An entity is updated in user_details."); } } } -- cgit v1.2.3 From 1934e2d6ade6115bdb8f7f90f590b557ec96323d Mon Sep 17 00:00:00 2001 From: 杨宇千 Date: Thu, 22 Aug 2019 14:32:37 +0800 Subject: Add user detail controller. --- Timeline.Tests/IntegratedTests/UserDetailTest.cs | 123 +++++++++++++++++++++++ Timeline/Controllers/UserDetailController.cs | 75 ++++++++++++++ Timeline/Services/UserDetailService.cs | 9 ++ Timeline/Startup.cs | 1 + 4 files changed, 208 insertions(+) create mode 100644 Timeline.Tests/IntegratedTests/UserDetailTest.cs create mode 100644 Timeline/Controllers/UserDetailController.cs (limited to 'Timeline/Services/UserDetailService.cs') diff --git a/Timeline.Tests/IntegratedTests/UserDetailTest.cs b/Timeline.Tests/IntegratedTests/UserDetailTest.cs new file mode 100644 index 00000000..571f200f --- /dev/null +++ b/Timeline.Tests/IntegratedTests/UserDetailTest.cs @@ -0,0 +1,123 @@ +using FluentAssertions; +using Microsoft.AspNetCore.Mvc.Testing; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Net; +using System.Threading.Tasks; +using Timeline.Controllers; +using Timeline.Models; +using Timeline.Models.Http; +using Timeline.Tests.Helpers; +using Timeline.Tests.Helpers.Authentication; +using Timeline.Tests.Mock.Data; +using Xunit; +using Xunit.Abstractions; + +namespace Timeline.Tests.IntegratedTests +{ + public class UserDetailTest : IClassFixture>, IDisposable + { + private readonly WebApplicationFactory _factory; + private readonly Action _disposeAction; + + public UserDetailTest(MyWebApplicationFactory factory, ITestOutputHelper outputHelper) + { + _factory = factory.WithTestConfig(outputHelper, out _disposeAction); + } + + public void Dispose() + { + _disposeAction(); + } + + [Fact] + public async Task TestAsUser() + { + using (var client = await _factory.CreateClientAsUser()) + { + { + var res = await client.GetAsync($"users/usernotexist/details"); + res.Should().HaveStatusCodeNotFound() + .And.Should().HaveBodyAsCommonResponseWithCode(UserDetailController.ErrorCodes.Get_UserNotExist); + } + + async Task GetAndTest(UserDetail d) + { + var res = await client.GetAsync($"users/{MockUsers.UserUsername}/details"); + res.Should().HaveStatusCodeOk() + .And.Should().HaveBodyAsJson() + .Which.Should().BeEquivalentTo(d); + } + + await GetAndTest(new UserDetail()); + + { + var res = await client.PatchAsJsonAsync($"users/{MockUsers.AdminUsername}/details", new UserDetail()); + res.Should().HaveStatusCode(HttpStatusCode.Forbidden) + .And.Should().HaveBodyAsCommonResponseWithCode(UserDetailController.ErrorCodes.Patch_Forbid); + } + + { + var res = await client.PatchAsJsonAsync($"users/{MockUsers.UserUsername}/details", new UserDetail + { + QQ = "aaaaaaa", + EMail = "aaaaaa" + }); + res.Should().HaveStatusCode(HttpStatusCode.BadRequest) + .And.Should().HaveBodyAsCommonResponseWithCode(CommonResponse.ErrorCodes.InvalidModel); + } + + var detail = new UserDetail + { + QQ = "1234567", + EMail = "aaaa@aaa.net", + Description = "aaaaaaaaa" + }; + + { + var res = await client.PatchAsJsonAsync($"users/{MockUsers.UserUsername}/details", detail); + res.Should().HaveStatusCodeOk(); + await GetAndTest(detail); + } + + var detail2 = new UserDetail + { + QQ = "", + PhoneNumber = "12345678910", + Description = "bbbbbbbb" + }; + + { + var res = await client.PatchAsJsonAsync($"users/{MockUsers.UserUsername}/details", detail2); + res.Should().HaveStatusCodeOk(); + await GetAndTest(new UserDetail + { + QQ = null, + EMail = detail.EMail, + PhoneNumber = detail2.PhoneNumber, + Description = detail2.Description + }); + } + } + } + + [Fact] + public async Task TestAsAdmin() + { + using (var client = await _factory.CreateClientAsAdmin()) + { + { + var res = await client.PatchAsJsonAsync($"users/{MockUsers.UserUsername}/details", new UserDetail()); + res.Should().HaveStatusCodeOk(); + } + + { + var res = await client.PatchAsJsonAsync($"users/usernotexist/details", new UserDetail()); + res.Should().HaveStatusCodeNotFound() + .And.Should().HaveBodyAsCommonResponseWithCode(UserDetailController.ErrorCodes.Patch_UserNotExist); + } + } + } + } +} \ No newline at end of file diff --git a/Timeline/Controllers/UserDetailController.cs b/Timeline/Controllers/UserDetailController.cs new file mode 100644 index 00000000..9e1d5483 --- /dev/null +++ b/Timeline/Controllers/UserDetailController.cs @@ -0,0 +1,75 @@ +using Microsoft.AspNetCore.Authorization; +using Microsoft.AspNetCore.Http; +using Microsoft.AspNetCore.Mvc; +using Microsoft.Extensions.Logging; +using System.Threading.Tasks; +using Timeline.Authenticate; +using Timeline.Models; +using Timeline.Models.Http; +using Timeline.Services; + +namespace Timeline.Controllers +{ + [Route("users/{username}/details")] + [ProducesErrorResponseType(typeof(CommonResponse))] + [ApiController] + public class UserDetailController : Controller + { + public static class ErrorCodes + { + public const int Get_UserNotExist = -1001; + + public const int Patch_Forbid = -2001; + public const int Patch_UserNotExist = -2002; + + } + + private readonly ILogger _logger; + private readonly IUserDetailService _service; + + public UserDetailController(ILogger logger, IUserDetailService service) + { + _logger = logger; + _service = service; + } + + [HttpGet()] + [UserAuthorize] + [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(UserDetail))] + [ProducesResponseType(StatusCodes.Status404NotFound)] + public async Task Get([FromRoute] string username) + { + try + { + var detail = await _service.GetUserDetail(username); + return Ok(detail); + } + catch (UserNotExistException) + { + return NotFound(new CommonResponse(ErrorCodes.Get_UserNotExist, "The user does not exist.")); + } + } + + [HttpPatch()] + [Authorize] + [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(void))] + [ProducesResponseType(StatusCodes.Status400BadRequest)] + [ProducesResponseType(StatusCodes.Status403Forbidden)] + [ProducesResponseType(StatusCodes.Status404NotFound)] + public async Task Patch([FromRoute] string username, [FromBody] UserDetail detail) + { + if (!User.IsAdmin() && User.Identity.Name != username) + return StatusCode(StatusCodes.Status403Forbidden, new CommonResponse(ErrorCodes.Patch_Forbid, "You can't change other's details unless you are admin.")); + + try + { + await _service.UpdateUserDetail(username, detail); + return Ok(); + } + catch (UserNotExistException) + { + return NotFound(new CommonResponse(ErrorCodes.Patch_UserNotExist, "The user does not exist.")); + } + } + } +} diff --git a/Timeline/Services/UserDetailService.cs b/Timeline/Services/UserDetailService.cs index d1fdc040..0bb745f3 100644 --- a/Timeline/Services/UserDetailService.cs +++ b/Timeline/Services/UserDetailService.cs @@ -1,4 +1,5 @@ using Microsoft.EntityFrameworkCore; +using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; using System; using System.Linq; @@ -89,4 +90,12 @@ namespace Timeline.Services _logger.LogInformation("An entity is updated in user_details."); } } + + public static class UserDetailServiceCollectionExtensions + { + public static void AddUserDetailService(this IServiceCollection services) + { + services.AddScoped(); + } + } } diff --git a/Timeline/Startup.cs b/Timeline/Startup.cs index 66f648c3..b5a5106b 100644 --- a/Timeline/Startup.cs +++ b/Timeline/Startup.cs @@ -46,6 +46,7 @@ namespace Timeline services.AddTransient(); services.AddUserAvatarService(); + services.AddUserDetailService(); var databaseConfig = Configuration.GetSection(nameof(DatabaseConfig)).Get(); -- cgit v1.2.3 From 9112f288f638f34aab48fdb965ff9703a99adb4d Mon Sep 17 00:00:00 2001 From: 杨宇千 Date: Thu, 22 Aug 2019 14:54:47 +0800 Subject: Add nickname. Step 1. --- Timeline.Tests/UserDetailServiceTest.cs | 70 +++++++++++++++++++++++++++++++-- Timeline/Entities/UserDetail.cs | 3 ++ Timeline/Models/UserDetail.cs | 7 +++- Timeline/Services/UserDetailService.cs | 48 ++++++++++++++++++---- 4 files changed, 117 insertions(+), 11 deletions(-) (limited to 'Timeline/Services/UserDetailService.cs') diff --git a/Timeline.Tests/UserDetailServiceTest.cs b/Timeline.Tests/UserDetailServiceTest.cs index 292b528b..f9170c42 100644 --- a/Timeline.Tests/UserDetailServiceTest.cs +++ b/Timeline.Tests/UserDetailServiceTest.cs @@ -34,6 +34,68 @@ namespace Timeline.Tests _database.Dispose(); } + [Fact] + public void GetNickname_ShouldThrow_ArgumentException() + { + // no need to await because arguments are checked syncronizedly. + _service.Invoking(s => s.GetUserNickname(null)).Should().Throw() + .Where(e => e.ParamName == "username" && e.Message.Contains("null", StringComparison.OrdinalIgnoreCase)); + _service.Invoking(s => s.GetUserNickname("")).Should().Throw() + .Where(e => e.ParamName == "username" && e.Message.Contains("empty", StringComparison.OrdinalIgnoreCase)); + } + + [Fact] + public void GetNickname_ShouldThrow_UserNotExistException() + { + const string username = "usernotexist"; + _service.Awaiting(s => s.GetUserNickname(username)).Should().Throw() + .Where(e => e.Username == username); + } + + [Fact] + public async Task GetNickname_Should_Create_And_ReturnDefault() + { + { + var nickname = await _service.GetUserNickname(MockUsers.UserUsername); + nickname.Should().BeNull(); + } + + { + var context = _database.DatabaseContext; + var userId = await DatabaseExtensions.CheckAndGetUser(context.Users, MockUsers.UserUsername); + var detail = context.UserDetails.Where(e => e.UserId == userId).Single(); + detail.Nickname.Should().BeNullOrEmpty(); + detail.QQ.Should().BeNullOrEmpty(); + detail.EMail.Should().BeNullOrEmpty(); + detail.PhoneNumber.Should().BeNullOrEmpty(); + detail.Description.Should().BeNullOrEmpty(); + } + } + + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData("nickname")] + public async Task GetNickname_Should_ReturnData(string nickname) + { + { + var context = _database.DatabaseContext; + var userId = await DatabaseExtensions.CheckAndGetUser(context.Users, MockUsers.UserUsername); + var entity = new UserDetailEntity + { + Nickname = nickname, + UserId = userId + }; + context.Add(entity); + await context.SaveChangesAsync(); + } + + { + var n = await _service.GetUserNickname(MockUsers.UserUsername); + n.Should().Equals(string.IsNullOrEmpty(nickname) ? null : nickname); + } + } + [Fact] public void GetDetail_ShouldThrow_ArgumentException() { @@ -64,6 +126,7 @@ namespace Timeline.Tests var context = _database.DatabaseContext; var userId = await DatabaseExtensions.CheckAndGetUser(context.Users, MockUsers.UserUsername); var detail = context.UserDetails.Where(e => e.UserId == userId).Single(); + detail.Nickname.Should().BeNullOrEmpty(); detail.QQ.Should().BeNullOrEmpty(); detail.EMail.Should().BeNullOrEmpty(); detail.PhoneNumber.Should().BeNullOrEmpty(); @@ -77,12 +140,11 @@ namespace Timeline.Tests const string email = "ha@aaa.net"; const string description = "hahaha"; - var context = _database.DatabaseContext; - UserDetailEntity entity; { + var context = _database.DatabaseContext; var userId = await DatabaseExtensions.CheckAndGetUser(context.Users, MockUsers.UserUsername); - entity = new UserDetailEntity + var entity = new UserDetailEntity { EMail = email, Description = description, @@ -130,6 +192,7 @@ namespace Timeline.Tests var context = _database.DatabaseContext; var userId = await DatabaseExtensions.CheckAndGetUser(context.Users, MockUsers.UserUsername); var entity = context.UserDetails.Where(e => e.UserId == userId).Single(); + entity.Nickname.Should().BeNullOrEmpty(); entity.QQ.Should().BeNullOrEmpty(); entity.EMail.Should().BeNullOrEmpty(); entity.PhoneNumber.Should().BeNullOrEmpty(); @@ -137,6 +200,7 @@ namespace Timeline.Tests } [Theory] + [InlineData(nameof(UserDetail.Nickname), nameof(UserDetailEntity.Nickname), "aaaa", "bbbb")] [InlineData(nameof(UserDetail.QQ), nameof(UserDetailEntity.QQ), "12345678910", "987654321")] [InlineData(nameof(UserDetail.EMail), nameof(UserDetailEntity.EMail), "aaa@aaa.aaa", "bbb@bbb.bbb")] [InlineData(nameof(UserDetail.PhoneNumber), nameof(UserDetailEntity.PhoneNumber), "12345678910", "987654321")] diff --git a/Timeline/Entities/UserDetail.cs b/Timeline/Entities/UserDetail.cs index 9bc6f5e5..6e582234 100644 --- a/Timeline/Entities/UserDetail.cs +++ b/Timeline/Entities/UserDetail.cs @@ -9,6 +9,9 @@ namespace Timeline.Entities [Column("id"), Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)] public long Id { get; set; } + [Column("nickname"), MaxLength(15)] + public string Nickname { get; set; } + [Column("qq"), MaxLength(15)] public string QQ { get; set; } diff --git a/Timeline/Models/UserDetail.cs b/Timeline/Models/UserDetail.cs index 4af88450..86866d8b 100644 --- a/Timeline/Models/UserDetail.cs +++ b/Timeline/Models/UserDetail.cs @@ -1,10 +1,14 @@ -using Timeline.Entities; +using System.ComponentModel.DataAnnotations; +using Timeline.Entities; using Timeline.Models.Validation; namespace Timeline.Models { public class UserDetail { + [MaxLength(10)] + public string Nickname { get; set; } + [ValidateWith(typeof(UserDetailValidators.QQValidator))] public string QQ { get; set; } @@ -28,6 +32,7 @@ namespace Timeline.Models { return new UserDetail { + Nickname = CoerceEmptyToNull(entity.Nickname), QQ = CoerceEmptyToNull(entity.QQ), EMail = CoerceEmptyToNull(entity.EMail), PhoneNumber = CoerceEmptyToNull(entity.PhoneNumber), diff --git a/Timeline/Services/UserDetailService.cs b/Timeline/Services/UserDetailService.cs index 0bb745f3..a8ed662b 100644 --- a/Timeline/Services/UserDetailService.cs +++ b/Timeline/Services/UserDetailService.cs @@ -11,6 +11,15 @@ namespace Timeline.Services { public interface IUserDetailService { + /// + /// Get the nickname of user. + /// + /// The username to get nickname of. + /// The user's nickname. Null if not set. + /// Thrown if is null or empty. + /// Thrown if user doesn't exist. + Task GetUserNickname(string username); + /// /// Get the detail of user. /// @@ -42,23 +51,45 @@ namespace Timeline.Services _databaseContext = databaseContext; } + private async Task CreateEntity(long userId) + { + var entity = new UserDetailEntity() + { + UserId = userId + }; + _databaseContext.UserDetails.Add(entity); + await _databaseContext.SaveChangesAsync(); + _logger.LogInformation("An entity is created in user_details."); + return entity; + } + // Check the existence of user detail entry private async Task CheckAndInit(long userId) { var detail = await _databaseContext.UserDetails.Where(e => e.UserId == userId).SingleOrDefaultAsync(); if (detail == null) { - detail = new UserDetailEntity() - { - UserId = userId - }; - _databaseContext.UserDetails.Add(detail); - await _databaseContext.SaveChangesAsync(); - _logger.LogInformation("An entity is created in user_details."); + detail = await CreateEntity(userId); } return detail; } + public async Task GetUserNickname(string username) + { + var userId = await DatabaseExtensions.CheckAndGetUser(_databaseContext.Users, username); + var detail = await _databaseContext.UserDetails.Where(e => e.UserId == userId).Select(e => new { e.Nickname }).SingleOrDefaultAsync(); + if (detail == null) + { + var entity = await CreateEntity(userId); + return null; + } + else + { + var nickname = detail.Nickname; + return string.IsNullOrEmpty(nickname) ? null : nickname; + } + } + public async Task GetUserDetail(string username) { var userId = await DatabaseExtensions.CheckAndGetUser(_databaseContext.Users, username); @@ -74,6 +105,9 @@ namespace Timeline.Services var userId = await DatabaseExtensions.CheckAndGetUser(_databaseContext.Users, username); var detailEntity = await CheckAndInit(userId); + if (detail.Nickname != null) + detailEntity.Nickname = detail.Nickname; + if (detail.QQ != null) detailEntity.QQ = detail.QQ; -- cgit v1.2.3