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/Models/UserDetail.cs | 31 +++++++++++++++++++++++ Timeline/Models/Validation/UserDetailValidator.cs | 11 ++++++++ 2 files changed, 42 insertions(+) create mode 100644 Timeline/Models/UserDetail.cs create mode 100644 Timeline/Models/Validation/UserDetailValidator.cs (limited to 'Timeline/Models') diff --git a/Timeline/Models/UserDetail.cs b/Timeline/Models/UserDetail.cs new file mode 100644 index 00000000..91439c6a --- /dev/null +++ b/Timeline/Models/UserDetail.cs @@ -0,0 +1,31 @@ +using Timeline.Entities; + +namespace Timeline.Models +{ + public class UserDetail + { + public string QQ { get; set; } + public string EMail { get; set; } + public string PhoneNumber { get; set; } + public string Description { get; set; } + + private static string CoerceEmptyToNull(string value) + { + if (string.IsNullOrEmpty(value)) + return null; + else + return value; + } + + public static UserDetail From(UserDetailEntity entity) + { + return new UserDetail + { + QQ = CoerceEmptyToNull(entity.QQ), + EMail = CoerceEmptyToNull(entity.EMail), + PhoneNumber = CoerceEmptyToNull(entity.PhoneNumber), + Description = CoerceEmptyToNull(entity.Description) + }; + } + } +} diff --git a/Timeline/Models/Validation/UserDetailValidator.cs b/Timeline/Models/Validation/UserDetailValidator.cs new file mode 100644 index 00000000..5fdaec00 --- /dev/null +++ b/Timeline/Models/Validation/UserDetailValidator.cs @@ -0,0 +1,11 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; + +namespace Timeline.Models.Validation +{ + public class UserDetailValidator + { + } +} -- cgit v1.2.3 From e7714754d8f59bb8dc29aeb6340380e93310175b Mon Sep 17 00:00:00 2001 From: 杨宇千 Date: Wed, 21 Aug 2019 23:55:42 +0800 Subject: Add validators. --- Timeline.Tests/UserDetailValidatorTest.cs | 97 +++++++++++++++++++ Timeline.Tests/UsernameValidatorUnitTest.cs | 1 - Timeline/Entities/UserDetail.cs | 2 +- Timeline/Models/UserDetail.cs | 7 ++ Timeline/Models/Validation/UserDetailValidator.cs | 113 +++++++++++++++++++++- 5 files changed, 214 insertions(+), 6 deletions(-) create mode 100644 Timeline.Tests/UserDetailValidatorTest.cs (limited to 'Timeline/Models') diff --git a/Timeline.Tests/UserDetailValidatorTest.cs b/Timeline.Tests/UserDetailValidatorTest.cs new file mode 100644 index 00000000..9b112946 --- /dev/null +++ b/Timeline.Tests/UserDetailValidatorTest.cs @@ -0,0 +1,97 @@ +using FluentAssertions; +using System.Collections.Generic; +using Timeline.Models.Validation; +using Xunit; + +namespace Timeline.Tests +{ + public static class UserDetailValidatorsTest + { + private static void SucceedWith(object value) where TValidator : class, IValidator, new() + { + var result = new TValidator().Validate(value, out var message); + result.Should().BeTrue(); + message.Should().Equals(ValidationConstants.SuccessMessage); + } + + private static void FailWith(object value, params string[] messageContains) where TValidator : class, IValidator, new() + { + var result = new TValidator().Validate(value, out var message); + result.Should().BeFalse(); + + foreach (var m in messageContains) + { + message.Should().ContainEquivalentOf(m); + } + } + + public class QQ + { + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData("12345678")] + public void Success(object qq) + { + SucceedWith(qq); + } + + [Theory] + [InlineData(123, "type")] + [InlineData("123", "short")] + [InlineData("111111111111111111111111111111111111", "long")] + [InlineData("aaaaaaaa", "digit")] + public void Fail(object qq, string messageContains) + { + FailWith(qq, messageContains); + } + } + + public class EMail + { + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData("aaa@aaa.net")] + public void Success(object email) + { + SucceedWith(email); + } + + public static IEnumerable FailTestData() + { + yield return new object[] { 123, "type" }; + yield return new object[] { new string('a', 100), "long" }; + yield return new object[] { "aaaaaaaa", "format" }; + } + + [Theory] + [MemberData(nameof(FailTestData))] + public void Fail(object email, string messageContains) + { + FailWith(email, messageContains); + } + } + + public class PhoneNumber + { + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData("12345678910")] + public void Success(object phoneNumber) + { + SucceedWith(phoneNumber); + } + + [Theory] + [InlineData(123, "type")] + [InlineData("111111111111111111111111111111111111", "long")] + [InlineData("aaaaaaaa", "digit")] + public void Fail(object phoneNumber, string messageContains) + { + FailWith(phoneNumber, messageContains); + } + } + } +} diff --git a/Timeline.Tests/UsernameValidatorUnitTest.cs b/Timeline.Tests/UsernameValidatorUnitTest.cs index 20558d0e..6a635ba1 100644 --- a/Timeline.Tests/UsernameValidatorUnitTest.cs +++ b/Timeline.Tests/UsernameValidatorUnitTest.cs @@ -1,5 +1,4 @@ using FluentAssertions; -using System; using Timeline.Models.Validation; using Xunit; diff --git a/Timeline/Entities/UserDetail.cs b/Timeline/Entities/UserDetail.cs index ee829717..9bc6f5e5 100644 --- a/Timeline/Entities/UserDetail.cs +++ b/Timeline/Entities/UserDetail.cs @@ -12,7 +12,7 @@ namespace Timeline.Entities [Column("qq"), MaxLength(15)] public string QQ { get; set; } - [Column("email"), MaxLength(30)] + [Column("email"), MaxLength(50)] public string EMail { get; set; } [Column("phone_number"), MaxLength(15)] diff --git a/Timeline/Models/UserDetail.cs b/Timeline/Models/UserDetail.cs index 91439c6a..4af88450 100644 --- a/Timeline/Models/UserDetail.cs +++ b/Timeline/Models/UserDetail.cs @@ -1,12 +1,19 @@ using Timeline.Entities; +using Timeline.Models.Validation; namespace Timeline.Models { public class UserDetail { + [ValidateWith(typeof(UserDetailValidators.QQValidator))] public string QQ { get; set; } + + [ValidateWith(typeof(UserDetailValidators.EMailValidator))] public string EMail { get; set; } + + [ValidateWith(typeof(UserDetailValidators.PhoneNumberValidator))] public string PhoneNumber { get; set; } + public string Description { get; set; } private static string CoerceEmptyToNull(string value) diff --git a/Timeline/Models/Validation/UserDetailValidator.cs b/Timeline/Models/Validation/UserDetailValidator.cs index 5fdaec00..19c82edb 100644 --- a/Timeline/Models/Validation/UserDetailValidator.cs +++ b/Timeline/Models/Validation/UserDetailValidator.cs @@ -1,11 +1,116 @@ using System; -using System.Collections.Generic; -using System.Linq; -using System.Threading.Tasks; +using System.Net.Mail; namespace Timeline.Models.Validation { - public class UserDetailValidator + public abstract class OptionalStringValidator : IValidator { + public bool Validate(object value, out string message) + { + if (value == null) + { + message = ValidationConstants.SuccessMessage; + return true; + } + + if (value is string s) + { + if (s.Length == 0) + { + message = ValidationConstants.SuccessMessage; + return true; + } + return DoValidate(s, out message); + } + else + { + message = "Value is not of type string."; + return false; + } + } + + protected abstract bool DoValidate(string value, out string message); + } + + public static class UserDetailValidators + { + + public class QQValidator : OptionalStringValidator + { + protected override bool DoValidate(string value, out string message) + { + if (value.Length < 5) + { + message = "QQ is too short."; + return false; + } + + if (value.Length > 11) + { + message = "QQ is too long."; + return false; + } + + foreach (var c in value) + { + if (!char.IsDigit(c)) + { + message = "QQ must only contain digit."; + return false; + } + } + + message = ValidationConstants.SuccessMessage; + return true; + } + } + + public class EMailValidator : OptionalStringValidator + { + protected override bool DoValidate(string value, out string message) + { + if (value.Length > 50) + { + message = "E-Mail is too long."; + return false; + } + + try + { + var _ = new MailAddress(value); + } + catch (FormatException) + { + message = "The format of E-Mail is bad."; + return false; + } + message = ValidationConstants.SuccessMessage; + return true; + } + } + + public class PhoneNumberValidator : OptionalStringValidator + { + protected override bool DoValidate(string value, out string message) + { + if (value.Length > 14) + { + message = "Phone number is too long."; + return false; + } + + foreach (var c in value) + { + if (!char.IsDigit(c)) + { + message = "Phone number can only contain digit."; + return false; + } + } + + message = ValidationConstants.SuccessMessage; + return true; + } + } } } -- 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/Models') 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