Add ProjectLoader tests

xt0rted · xt0rted · commit f2eb3b76547d · 2022-03-26T00:17:16.000-04:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -48,15 +48,18 @@ jobs:
         uses: actions/setup-dotnet@v2.0.0
         with:
           source-url: https://nuget.pkg.github.com/xt0rted/index.json
-          dotnet-version: 6.0.x
+          dotnet-version: |
+            3.1.x
+            5.0.x
+            6.0.x
         env:
           NUGET_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - run: dotnet tool restore
 
       - run: dotnet r build
 
-      - run: dotnet r test --if-present
+      - run: dotnet r test
 
       - run: dotnet r pack -- --version-suffix ${{ env.VERSION_SUFFIX }}
 
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -30,7 +30,10 @@ jobs:
         uses: actions/setup-dotnet@v2.0.0
         with:
           source-url: https://nuget.pkg.github.com/xt0rted/index.json
-          dotnet-version: 6.0.x
+          dotnet-version: |
+            3.1.x
+            5.0.x
+            6.0.x
         env:
           NUGET_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -44,7 +47,7 @@ jobs:
 
       - run: dotnet r build
 
-      - run: dotnet r test --if-present
+      - run: dotnet r test
 
       - run: dotnet r pack
 
diff --git a/.gitignore b/.gitignore
@@ -301,7 +301,7 @@ node_modules/
 *.dsw
 *.dsp
 
-# Visual Studio 6 technical files 
+# Visual Studio 6 technical files
 *.ncb
 *.aps
 
@@ -396,3 +396,6 @@ FodyWeavers.xsd
 
 # JetBrains Rider
 *.sln.iml
+
+# Verify snapshots
+*.received.*
diff --git a/global.json b/global.json
@@ -9,6 +9,9 @@
     "prebuild": "dotnet r clean",
     "build": "dotnet build",
     "test": "dotnet test --no-build --logger \"trx\" --results-directory \"./.coverage\"",
+    "test:31": "dotnet r test -- --framework netcoreapp3.1",
+    "test:5": "dotnet r test -- --framework net5.0",
+    "test:6": "dotnet r test -- --framework net6.0",
     "pack": "dotnet pack --no-build --output ./artifacts",
 
     "build:release": "dotnet r build -- --configuration Release",
diff --git a/run-script.sln b/run-script.sln
@@ -19,6 +19,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		README.md = README.md
 	EndProjectSection
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tests", "test\Tests.csproj", "{0A834097-CB5A-4E14-845D-1AA0E8EBEA29}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -29,6 +31,10 @@ Global
 		{AEF0FF86-3911-45DE-9291-EDC8E96329F4}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{AEF0FF86-3911-45DE-9291-EDC8E96329F4}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{AEF0FF86-3911-45DE-9291-EDC8E96329F4}.Release|Any CPU.Build.0 = Release|Any CPU
+		{0A834097-CB5A-4E14-845D-1AA0E8EBEA29}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{0A834097-CB5A-4E14-845D-1AA0E8EBEA29}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{0A834097-CB5A-4E14-845D-1AA0E8EBEA29}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{0A834097-CB5A-4E14-845D-1AA0E8EBEA29}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
diff --git a/src/ProjectLoader.cs b/src/ProjectLoader.cs
@@ -53,13 +53,20 @@ public class ProjectLoader
     {
         var json = await File.ReadAllTextAsync(jsonPath);
 
-        return JsonSerializer.Deserialize<Project>(
-            json,
-            new JsonSerializerOptions
-                {
-                    PropertyNameCaseInsensitive = true,
-                    ReadCommentHandling = JsonCommentHandling.Skip,
-                });
+        try
+        {
+            var globalJson = JsonSerializer.Deserialize<Project>(json, new JsonSerializerOptions
+            {
+                PropertyNameCaseInsensitive = true,
+                ReadCommentHandling = JsonCommentHandling.Skip,
+            });
+
+            return globalJson;
+        }
+        catch
+        {
+            return null;
+        }
     }
 
     private static Dictionary<string, string?> LoadScripts(Project project)
diff --git a/src/run-script.csproj b/src/run-script.csproj
@@ -1,6 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
+    <RootNamespace>RunScript</RootNamespace>
     <OutputType>Exe</OutputType>
     <DebugSymbols>true</DebugSymbols>
     <DebugType>embedded</DebugType>
diff --git a/test/.editorconfig b/test/.editorconfig
@@ -0,0 +1,3 @@
+[*.cs]
+# RCS1046: Asynchronous method name should end with 'Async'
+dotnet_diagnostic.RCS1046.severity = none
diff --git a/test/ProjectLoaderTests.Should_find_in_root.verified.txt b/test/ProjectLoaderTests.Should_find_in_root.verified.txt
@@ -0,0 +1,5 @@
+﻿{
+  Scripts: {
+    test: echo "dir1" && exit 1
+  }
+}
diff --git a/test/ProjectLoaderTests.Should_look_up_the_tree.verified.txt b/test/ProjectLoaderTests.Should_look_up_the_tree.verified.txt
@@ -0,0 +1,5 @@
+﻿{
+  Scripts: {
+    test: echo "dir1" && exit 1
+  }
+}
diff --git a/test/ProjectLoaderTests.Should_treat_script_names_as_lowercase.verified.txt b/test/ProjectLoaderTests.Should_treat_script_names_as_lowercase.verified.txt
@@ -0,0 +1,7 @@
+﻿{
+  Scripts: {
+    bUiLD: build,
+    pack: pack,
+    TEST: test
+  }
+}
diff --git a/test/ProjectLoaderTests.cs b/test/ProjectLoaderTests.cs
@@ -0,0 +1,136 @@
+namespace RunScript;
+
+[UsesVerify]
+public class ProjectLoaderTests
+{
+    [Fact]
+    public void Should_throw_if_no_globaljson_found_in_tree()
+    {
+        // Given
+        var projectLoader = new ProjectLoader();
+
+        // When
+        var action = async () => await projectLoader.LoadAsync(Path.GetTempPath());
+
+        // Then
+        var ex = action.ShouldThrow<RunScriptException>();
+        ex.Message.ShouldBe("No global.json found in folder path");
+    }
+
+    [Fact]
+    public void Should_throw_if_malformed_file()
+    {
+        // Given
+        var testPath = TestPath("malformed");
+        var projectLoader = new ProjectLoader();
+
+        // When
+        var action = async () => await projectLoader.LoadAsync(testPath);
+
+        // Then
+        var ex = action.ShouldThrow<RunScriptException>();
+        ex.Message.ShouldBe("Error parsing global.json");
+    }
+
+    [Fact]
+    public void Should_throw_if_no_scripts_found()
+    {
+        // Given
+        var testPath = TestPath("no-scripts");
+        var projectLoader = new ProjectLoader();
+
+        // When
+        var action = async () => await projectLoader.LoadAsync(testPath);
+
+        // Then
+        var ex = action.ShouldThrow<RunScriptException>();
+        ex.Message.ShouldBe("No scripts found in the global.json");
+    }
+
+    [Fact]
+    public async Task Should_find_in_root()
+    {
+        // Given
+        var testPath = TestPath("dir1");
+        var projectLoader = new ProjectLoader();
+
+        // When
+        var (project, scripts, workingDirectory) = await projectLoader.LoadAsync(testPath);
+
+        // Then
+        project.ShouldNotBeNull();
+
+        await Verify(project);
+
+        scripts.ShouldBeEquivalentTo(
+            new Dictionary<string, string>
+            {
+                { "test", "echo \"dir1\" && exit 1" },
+            });
+
+        workingDirectory.ShouldBe(TestPath("dir1"));
+    }
+
+    [Fact]
+    public async Task Should_look_up_the_tree()
+    {
+        // Given
+        var testPath = TestPath("dir1", "dir2", "dir3");
+        var projectLoader = new ProjectLoader();
+
+        // When
+        var (project, scripts, workingDirectory) = await projectLoader.LoadAsync(testPath);
+
+        // Then
+        project.ShouldNotBeNull();
+
+        await Verify(project);
+
+        scripts.ShouldBeEquivalentTo(
+            new Dictionary<string, string>
+            {
+                { "test", "echo \"dir1\" && exit 1" },
+            });
+        workingDirectory.ShouldBe(TestPath("dir1"));
+    }
+
+    [Fact]
+    public async Task Should_treat_script_names_as_lowercase()
+    {
+        // Given
+        var testPath = TestPath("script-names");
+        var projectLoader = new ProjectLoader();
+
+        // When
+        var (project, scripts, _) = await projectLoader.LoadAsync(testPath);
+
+        // Then
+        project.Scripts.ShouldNotBeNull();
+
+        project.Scripts["bUiLD"].ShouldBe("build");
+        project.Scripts["TEST"].ShouldBe("test");
+        project.Scripts["pack"].ShouldBe("pack");
+
+        await Verify(project);
+
+        scripts["build"].ShouldBe("build");
+        scripts["test"].ShouldBe("test");
+        scripts["pack"].ShouldBe("pack");
+    }
+
+    private string TestPath(params string[] folders)
+    {
+        return Path.Join(segments().ToArray());
+
+        IEnumerable<string> segments()
+        {
+            yield return AttributeReader.GetProjectDirectory(GetType().Assembly);
+            yield return "test-configs";
+
+            foreach (var folder in folders)
+            {
+                yield return folder;
+            }
+        }
+    }
+}
diff --git a/test/Tests.csproj b/test/Tests.csproj
@@ -0,0 +1,36 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <RootNamespace>RunScript</RootNamespace>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Using Include="FakeItEasy" />
+    <Using Include="Shouldly" />
+    <Using Include="Xunit" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="coverlet.collector" Version="3.1.2">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+    <PackageReference Include="FakeItEasy" Version="7.3.1" />
+    <PackageReference Include="FakeItEasy.Analyzer.CSharp" Version="6.1.0">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" />
+    <PackageReference Include="Shouldly" Version="4.0.3" />
+    <PackageReference Include="Verify.Xunit" Version="16.4.3" />
+    <PackageReference Include="xunit" Version="2.4.1" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\src\run-script.csproj" />
+  </ItemGroup>
+</Project>
diff --git a/test/test-configs/dir1/dir2/dir3/.gitignore b/test/test-configs/dir1/dir2/dir3/.gitignore
diff --git a/test/test-configs/dir1/global.json b/test/test-configs/dir1/global.json
@@ -0,0 +1,5 @@
+{
+  "scripts": {
+    "test": "echo \"dir1\" && exit 1"
+  }
+}
diff --git a/test/test-configs/malformed/global.json b/test/test-configs/malformed/global.json
@@ -0,0 +1,5 @@
+{
+  "scripts": {
+    "test": "echo \"malformed\" && exit 1",
+  },
+}
diff --git a/test/test-configs/no-scripts/global.json b/test/test-configs/no-scripts/global.json
@@ -0,0 +1,3 @@
+{
+  "sdk": "1.2.3"
+}
diff --git a/test/test-configs/script-names/global.json b/test/test-configs/script-names/global.json
@@ -0,0 +1,7 @@
+{
+  "scripts": {
+    "bUiLD": "build",
+    "TEST": "test",
+    "pack": "pack"
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[*.cs]`
	`2`	`+# RCS1046: Asynchronous method name should end with 'Async'`
	`3`	`+dotnet_diagnostic.RCS1046.severity = none`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  Scripts: {
 +    test: echo "dir1" && exit 1
 +  }
 +}