Merge pull request #3 from astar-development/features/add-tests

Add the required tests

Author: jbarden

src/AStar.Dev.Utilities/AStar.Dev.Utilities.csproj

@@ -29,12 +29,12 @@
 	<RepositoryType>git</RepositoryType>
 	<PackageProjectUrl>https://github.com/jbarden/astar-dev-utilities</PackageProjectUrl>
 	<Description>A collection of useful utilities.</Description>
-	<Version>1.5.0</Version>
+	<Version>1.5.1</Version>
 	<Authors>AStar Development, Jason Barden</Authors>
 	<DocumentationFile>$(AssemblyName).xml</DocumentationFile>
 	<PackageIcon>AStar.png</PackageIcon>
 	<PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
-	<PackageReleaseNotes>version 1.5.0 contains the initial code port from the jbarden NuGet / GitHub organisations.</PackageReleaseNotes>
+	<PackageReleaseNotes>version 1.5.1 adds the missing tests, no functionality is affected.</PackageReleaseNotes>
   </PropertyGroup>
 
   <ItemGroup>

src/AStar.Dev.Utilities/AStar.Dev.Utilities.xml

@@ -1,6 +1,6 @@
 using System.Text.Json;
 
-namespace AStar.Utilities;
+namespace AStar.Dev.Utilities;
 
 /// <summary>
 /// The <see href="Constants"></see>see> class contains static / constant properties to simplify and centralise various settings.

src/AStar.Dev.Utilities/Constants.cs

@@ -1,15 +1,16 @@
-namespace AStar.Utilities;
+namespace AStar.Dev.Utilities;
 
 /// <summary>
 ///
 /// </summary>
 public static class EnumExtensions
 {
     /// <summary>
-    ///
+    /// The ParseEnum method will parse the supplied string and return the matching enum value.
     /// </summary>
-    /// <typeparam name="T"></typeparam>
-    /// <param name="value"></param>
-    /// <returns></returns>
+    /// <typeparam name="T">The typeof of the expected enum.</typeparam>
+    /// <param name="value">The value to parse to the enum.</param>
+    /// <returns>The parsed value as the matching enum value.</returns>
+    /// <exception cref="ArgumentException">Thrown when the string is not a valid enum value.</exception>
     public static T ParseEnum<T>(this string value) => (T)Enum.Parse(typeof(T), value, true);
 }

src/AStar.Dev.Utilities/EnumExtensions.cs

@@ -1,6 +1,6 @@
 using System.Text.Json;
 
-namespace AStar.Utilities;
+namespace AStar.Dev.Utilities;
 
 /// <summary>
 /// The <see cref="ObjectExtensions" /> class contains some useful methods to enable various tasks

src/AStar.Dev.Utilities/ObjectExtensions.cs

@@ -1,6 +1,6 @@
 using System.Text.Json;
 
-namespace AStar.Utilities;
+namespace AStar.Dev.Utilities;
 
 /// <summary>
 /// The <see cref="StringExtensions" /> class contains some useful methods to enable checks to be

src/AStar.Dev.Utilities/StringExtensions.cs

@@ -14,6 +14,7 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
+    <PackageReference Include="FluentAssertions" Version="6.12.1" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
     <PackageReference Include="xunit" Version="2.9.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2">
@@ -27,6 +28,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <Using Include="FluentAssertions" />
     <Using Include="Xunit" />
   </ItemGroup>
 

tests/unit/AStar.Dev.Utilities.Unit.Tests/AStar.Dev.Utilities.Unit.Tests.csproj

@@ -0,0 +1,8 @@
+namespace AStar.Dev.Utilities.Unit.Tests;
+
+internal class AnyClass
+{
+    public int AnyInt { get; set; }
+
+    public string AnyString { get; set; } = string.Empty;
+}

tests/unit/AStar.Dev.Utilities.Unit.Tests/AnyClass.cs

@@ -0,0 +1,7 @@
+namespace AStar.Dev.Utilities.Unit.Tests;
+
+internal enum AnyEnum
+{
+    NotDefined,
+    Defined
+}

tests/unit/AStar.Dev.Utilities.Unit.Tests/AnyEnum.cs

@@ -0,0 +1,11 @@
+namespace AStar.Dev.Utilities.Unit.Tests;
+
+public class ConstantsShould
+{
+    [Fact]
+    public void ContainTheExpectedWebDeserialisationSettingsSetting()
+        => Constants.WebDeserialisationSettings
+                        .ToJson()
+                        .Should()
+                        .Be("{\"Converters\":[],\"TypeInfoResolver\":null,\"TypeInfoResolverChain\":[],\"AllowTrailingCommas\":false,\"DefaultBufferSize\":16384,\"Encoder\":null,\"DictionaryKeyPolicy\":null,\"IgnoreNullValues\":false,\"DefaultIgnoreCondition\":0,\"NumberHandling\":1,\"PreferredObjectCreationHandling\":0,\"IgnoreReadOnlyProperties\":false,\"IgnoreReadOnlyFields\":false,\"IncludeFields\":false,\"MaxDepth\":0,\"PropertyNamingPolicy\":{},\"PropertyNameCaseInsensitive\":true,\"ReadCommentHandling\":0,\"UnknownTypeHandling\":0,\"UnmappedMemberHandling\":0,\"WriteIndented\":false,\"ReferenceHandler\":null,\"IsReadOnly\":false}");
+}