Merge pull request OmniSharp#1049 from manandre/npm-ci

Add npm to CI build

Author: JoeRobich

.build/Build.cs

@@ -3,9 +3,11 @@
 using Nuke.Common.Execution;
 using Nuke.Common.Git;
 using Nuke.Common.IO;
+using Nuke.Common.Tooling;
 using Nuke.Common.Tools.DotNet;
 using Nuke.Common.Tools.GitVersion;
 using Nuke.Common.Tools.MSBuild;
+using Nuke.Common.Tools.Npm;
 using Rocket.Surgery.Nuke.DotNetCore;
 
 namespace Build;
@@ -61,11 +63,25 @@ public sealed partial class Solution : NukeBuild,
 
     public Target Test => _ => _.Inherit<ICanTestWithDotNetCore>(x => x.CoreTest);
 
+    public Target NpmInstall => _ => _
+        .Executes(() =>
+            NpmTasks.NpmCi(s => s
+                .SetProcessWorkingDirectory(VscodeTestExtensionProjectDirectory)));
+
+    public Target TestVscodeExtension => _ => _
+        .DependsOn(NpmInstall)
+        .Executes(() =>
+            NpmTasks.NpmRun(s => s
+                .SetProcessWorkingDirectory(VscodeTestExtensionProjectDirectory)
+                .SetCommand("test")));
+
     public Target BuildVersion => _ => _.Inherit<IHaveBuildVersion>(x => x.BuildVersion)
                                         .Before(Default)
                                         .Before(Clean);
 
     [Parameter("Configuration to build")] public Configuration Configuration { get; } = IsLocalBuild ? Configuration.Debug : Configuration.Release;
 
     AbsolutePath ICanUpdateReadme.ReadmeFilePath => RootDirectory / "README.md";
+
+    private const string VscodeTestExtensionProjectDirectory = "vscode-testextension";
 }

.build/Solution.cs

@@ -102,10 +102,32 @@ RocketSurgeonGitHubActionsConfiguration configuration
             .ConfigureStep<CheckoutStep>(step => step.FetchDepth = 0)
             .UseDotNetSdks("3.1", "7.0")
             .AddNuGetCache()
+            .AddVscodeExtensionTests()
             .PublishLogs<Solution>()
             .PublishArtifacts<Solution>()
             .FailFast = false;
 
         return configuration;
     }
 }
+
+public static class Extensions
+{
+    public static RocketSurgeonsGithubActionsJob AddVscodeExtensionTests(this RocketSurgeonsGithubActionsJob job)
+    {
+        return job
+            .AddStep(new RunStep("Npm install") {
+                Run = string.Join(Environment.NewLine, [
+                    "cd vscode-testextension",
+                    "npm ci",
+                    "cd .."
+                ])
+            })
+            .AddStep(new UsingStep("Vscode extension tests") {
+                Uses = "coactions/setup-xvfb@v1",
+                With = {
+                    ["run"] = "npm run test",
+                    ["working-directory"] = "vscode-testextension"
+            }});
+    }
+}

.github/workflows/ci.yml

@@ -117,6 +117,16 @@ jobs:
         id: pack
         run: |
           dotnet nuke Pack --skip
+      - name: Npm install
+        run: |
+          cd vscode-testextension
+          npm ci
+          cd ..
+      - name: 🚦 Vscode extension tests
+        uses: coactions/setup-xvfb@v1
+        with:
+          run: 'npm run test'
+          working-directory: 'vscode-testextension'
       - name: 🏺 Publish coverage data
         if: always()
         uses: actions/upload-artifact@v3

.nuke/build.schema.json

@@ -103,9 +103,11 @@
               "GenerateCodeCoverageReportCobertura",
               "GenerateCodeCoverageSummary",
               "GenerateReadme",
+              "NpmInstall",
               "Pack",
               "Restore",
               "Test",
+              "TestVscodeTestExtension",
               "Trigger_Code_Coverage_Reports",
               "TriggerCodeCoverageReports"
             ]
@@ -140,9 +142,11 @@
               "GenerateCodeCoverageReportCobertura",
               "GenerateCodeCoverageSummary",
               "GenerateReadme",
+              "NpmInstall",
               "Pack",
               "Restore",
               "Test",
+              "TestVscodeTestExtension",
               "Trigger_Code_Coverage_Reports",
               "TriggerCodeCoverageReports"
             ]

vscode-testextension/package-lock.json

@@ -55,6 +55,7 @@
         "glob": "^10.3.10",
         "mocha": "^10.2.0",
         "source-map-support": "^0.5.21",
+        "tmp-promise": "^3.0.3",
         "typescript": "^5.2.2"
     },
     "dependencies": {

vscode-testextension/package.json

@@ -1,4 +1,5 @@
 import * as path from 'path';
+import * as tmp from 'tmp-promise';
 
 import { runTests } from '@vscode/test-electron';
 
@@ -12,10 +13,25 @@ async function main() {
 		// Passed to --extensionTestsPath
 		const extensionTestsPath = path.resolve(__dirname, './suite/index');
 
-		// Download VS Code, unzip it and run the integration test
-		await runTests({ extensionDevelopmentPath, extensionTestsPath });
+		// The path to  the user data directory used by vscode
+		// As the default one is too long (> 103 characters) on some CI setups, forcing it to a temporary and hopefully shorter one.
+		const userDataDir = await tmp.dir({ unsafeCleanup: true });
+
+		try {
+			// Download VS Code, unzip it and run the integration test
+			await runTests({
+				extensionDevelopmentPath,
+				extensionTestsPath,
+				launchArgs: ["--user-data-dir", userDataDir.path]
+			});
+		}
+		finally
+		{
+			await userDataDir.cleanup();
+		}
 	} catch (err) {
 		console.error('Failed to run tests');
+		console.error(err);
 		process.exit(1);
 	}
 }