Merge pull request #1773 from nunit/package-content

Define PackageContent in Script

Author: CharliePoole

KnownExtensions.cake

@@ -0,0 +1,50 @@
+using System.Reflection;
+
+// Static class holding information about known extensions.
+public static class KnownExtensions
+{
+    // Static Variables representing well-known Extensions with the latest tested version
+    public static ExtensionSpecifier NUnitV2Driver = new ExtensionSpecifier(
+        "NUnit.Extension.NUnitV2Driver", "nunit-extension-nunit-v2-driver", "3.9.0");
+    public static ExtensionSpecifier NUnitProjectLoader = new ExtensionSpecifier(
+        "NUnit.Extension.NUnitProjectLoader", "nunit-extension-nunit-project-loader", "4.0.0-dev00016");
+    public static ExtensionSpecifier VSProjectLoader = new ExtensionSpecifier(
+        "NUnit.Extension.VSProjectLoader", "nunit-extension-vs-project-loader", "3.9.0");
+    public static ExtensionSpecifier NUnitV2ResultWriter = new ExtensionSpecifier(
+        "NUnit.Extension.NUnitV2ResultWriter", "nunit-extension-nunit-v2-result-writer", "4.0.0-beta.1");
+    public static ExtensionSpecifier Net462PluggableAgent = new ExtensionSpecifier(
+        "NUnit.Extension.Net462PluggableAgent", "nunit-extension-net462-pluggable-agent", "4.1.0-alpha.5");
+    public static ExtensionSpecifier Net80PluggableAgent = new ExtensionSpecifier(
+        "NUnit.Extension.Net80PluggableAgent", "nunit-extension-net80-pluggable-agent", "4.1.0-alpha.6");
+    public static ExtensionSpecifier Net90PluggableAgent = new ExtensionSpecifier(
+        "NUnit.Extension.Net90PluggableAgent", "nunit-extension-net90-pluggable-agent", "4.1.0-alpha.4");
+
+    private static ExtensionSpecifier[] BundledAgents =>
+    [
+        Net462PluggableAgent,
+        Net80PluggableAgent,
+        Net90PluggableAgent
+    ];
+
+    public static IEnumerable<PackageReference> BundledNuGetAgents =>
+        BundledAgents.Select(a => a.NuGetPackage);
+
+    public static IEnumerable<PackageReference> BundledChocolateyAgents =>
+        BundledAgents.Select(a => a.ChocoPackage);
+}
+
+Task("InstallNuGetAgents")
+    .Description("Installs just the NuGet agents we bundle with the GUI runner in the BIN  directory for testing.")
+    .Does(() =>
+    {
+        foreach (var agent in KnownExtensions.BundledNuGetAgents)
+            agent.Install(BuildSettings.ProjectDirectory + "bin");
+    });
+
+Task("InstallChocolateyAgents")
+    .Description("Installs just the Chocolatey agents we bundle with the GUI runner in the BIN  directory for testing.")
+    .Does(() =>
+    {
+        foreach (var agent in KnownExtensions.BundledNuGetAgents)
+            agent.Install(BuildSettings.ProjectDirectory + "bin");
+    });

NUnitConsole.sln

@@ -21,6 +21,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		GitReleaseManager.yaml = GitReleaseManager.yaml
 		GitVersion.yml = GitVersion.yml
 		global.json = global.json
+		KnownExtensions.cake = KnownExtensions.cake
 		LICENSE.txt = LICENSE.txt
 		MixedTests.nunit = MixedTests.nunit
 		NetCoreTests.nunit = NetCoreTests.nunit

build.cake

@@ -1,10 +1,11 @@
 // Load the recipe
-#load nuget:?package=NUnit.Cake.Recipe&version=1.6.0-alpha.6
+#load nuget:?package=NUnit.Cake.Recipe&version=1.6.0-alpha.8
 // Comment out above line and uncomment below for local tests of recipe changes
 //#load ../NUnit.Cake.Recipe/recipe/*.cake
 
 // Load additional cake files
 #load package-tests.cake
+#load KnownExtensions.cake
 
 // Initialize BuildSettings
 BuildSettings.Initialize(
@@ -20,6 +21,10 @@ BuildSettings.Initialize(
 //////////////////////////////////////////////////////////////////////
 
 var THIS_VERSION = BuildSettings.PackageVersion;
+var RUNNER_DESCRIPTION =
+      "This package includes the console runner and test engine for version 3 and higher of the NUnit unit-testing framework." +
+      "\r\n\nAny extensions, if needed, may be installed as separate packages.";
+
 PackageDefinition NUnitExtensibilityApiPackage = new NuGetPackage(
     id: "NUnit.Extensibility.Api",
     source: BuildSettings.SourceDirectory + "NUnitCommon/nunit.extensibility.api/nunit.extensibility.api.csproj",
@@ -144,49 +149,52 @@ PackageDefinition NUnitConsoleRunnerDotNetToolPackage = new DotNetToolPackage(
 // 1. NUnit.ConsoleRunner needs to use it to specify the bundled pluggable agents
 PackageDefinition NUnitConsoleRunnerNuGetPackage = new NuGetPackage(
     id: "NUnit.ConsoleRunner",
-    source: BuildSettings.NuGetDirectory + "runners/nunit.console-runner.nuspec",
+    description: RUNNER_DESCRIPTION,
+    packageContent: new PackageContent()
+        .WithRootFiles("../../LICENSE.txt", "../../NOTICES.txt", "../../nunit_256.png")
+        .WithDirectories(
+            new DirectoryContent("tools").WithFiles(
+                "net462/nunit-console.exe", "net462/nunit-console.exe.config", "net462/nunit.engine.dll",
+                "net462/nunit.extensibility.dll", "net462/nunit.extensibility.api.dll", "net462/nunit.common.dll",
+                "net462/nunit-console.pdb", "net462/nunit.engine.pdb", "net462/nunit.engine.api.pdb",
+                "net462/nunit.extensibility.pdb", "net462/nunit.extensibility.api.pdb", "net462/nunit.common.pdb",
+                "net462/nunit.engine.api.dll", "net462/testcentric.metadata.dll"))
+        .WithDependencies(KnownExtensions.BundledNuGetAgents),
+    // Keeping separate check for dependencies until PackageContent automatic verification handles them
     checks: new PackageCheck[] {
-        HasFiles("LICENSE.txt", "NOTICES.txt"),
-        HasDirectory("tools").WithFiles(
-            "nunit-console.exe", "nunit-console.exe.config", "nunit.engine.dll",
-            "nunit.extensibility.dll", "nunit.extensibility.api.dll", "nunit.common.dll",
-            "nunit.engine.api.dll", "testcentric.metadata.dll"),
-        HasDependency("NUnit.Extension.Net462PluggableAgent", "4.1.0-alpha.5"),
-        HasDependency("NUnit.Extension.Net80PluggableAgent", "4.1.0-alpha.6"),
-        HasDependency("NUnit.Extension.Net90PluggableAgent", "4.1.0-alpha.4")
-    },
-    symbols: new PackageCheck[] {
-        HasDirectory("tools").WithFiles(
-            "nunit.engine.pdb", "nunit.extensibility.pdb", "nunit.extensibility.api.pdb",
-            "nunit.common.pdb", "nunit.engine.api.pdb", "nunit-console.pdb"),
+        HasDependencies(KnownExtensions.BundledNuGetAgents)
     },
     testRunner: new ConsoleRunnerSelfTester(BuildSettings.NuGetTestDirectory
         + $"NUnit.ConsoleRunner.{BuildSettings.PackageVersion}/tools/nunit-console.exe"),
     tests: StandardRunnerTests);
 
-// 2. NUnit.Console is a meta-package
-PackageDefinition NUnitConsoleNuGetPackage = new NuGetPackage(
-    id: "NUnit.Console",
-    source: BuildSettings.NuGetDirectory + "runners/nunit.console-runner-with-extensions.nuspec",
-    checks: new PackageCheck[] { HasFile("LICENSE.txt") });
-
 // 3. The chocolatey console runner has to follow special chocolatey conventions
 PackageDefinition NUnitConsoleRunnerChocolateyPackage = new ChocolateyPackage(
     id: "nunit-console-runner",
-    source: BuildSettings.ChocolateyDirectory + "nunit-console-runner.nuspec",
+    description: RUNNER_DESCRIPTION,
+    packageContent: new PackageContent()
+        .WithDirectories(
+            new DirectoryContent("tools").WithFiles(
+                "../../LICENSE.txt", "../../NOTICES.txt", "../../choco/VERIFICATION.txt",
+                "net462/nunit-console.exe", "net462/nunit-console.exe.config",
+                "net462/nunit.engine.dll", "net462/nunit.extensibility.dll", "net462/nunit.extensibility.api.dll",
+                "net462/nunit.common.dll", "net462/nunit.engine.api.dll", "net462/testcentric.metadata.dll") )
+        .WithDependencies(KnownExtensions.BundledChocolateyAgents),
+    // Keeping separate check for dependencies until PackageContent automatic verification handles them
     checks: new PackageCheck[] {
-        HasDirectory("tools").WithFiles(
-            "LICENSE.txt", "NOTICES.txt", "VERIFICATION.txt", "nunit-console.exe", "nunit-console.exe.config",
-            "nunit.engine.dll", "nunit.extensibility.dll", "nunit.extensibility.api.dll",
-            "nunit.common.dll", "nunit.engine.api.dll", "testcentric.metadata.dll"),
-        HasDependency("nunit-extension-net462-pluggable-agent", "4.1.0-alpha.5"),
-        HasDependency("nunit-extension-net80-pluggable-agent", "4.1.0-alpha.6"),
-        HasDependency("nunit-extension-net90-pluggable-agent", "4.1.0-alpha.4")
+        HasDependencies(KnownExtensions.BundledChocolateyAgents)
     },
     testRunner: new ConsoleRunnerSelfTester(BuildSettings.ChocolateyTestDirectory
         + $"nunit-console-runner.{BuildSettings.PackageVersion}/tools/nunit-console.exe"),
     tests: StandardRunnerTests);
 
+// NUnit.Console is a meta-package and is built using a nuspec file
+PackageDefinition NUnitConsoleNuGetPackage = new NuGetPackage(
+    id: "NUnit.Console",
+    source: BuildSettings.NuGetDirectory + "runners/nunit.console-runner-with-extensions.nuspec",
+    basePath: BuildSettings.ProjectDirectory,
+    checks: new PackageCheck[] { HasFile("LICENSE.txt") });
+
 // Add all packages to BuildSettings in order they should be build.
 // Dependencies must precede all the packages that depend on them.
 BuildSettings.Packages.AddRange(new PackageDefinition[] {
@@ -268,19 +276,6 @@ public class DirectTestAgentRunner : TestRunner, IPackageTestRunner
     }
 }
 
-//////////////////////////////////////////////////////////////////////
-// ADDITIONAL TARGETS USED IN DEVELOPMENT
-//////////////////////////////////////////////////////////////////////
-
-Task("InstallBundledAgents")
-    .Description("Installs just the agents we bundle with the GUI runner.")
-    .Does(() =>
-    {
-        new PackageReference("NUnit.Extension.Net462PluggableAgent", "4.1.0-alpha.5").Install(BuildSettings.ProjectDirectory + "bin");
-        new PackageReference("NUnit.Extension.Net80PluggableAgent", "4.1.0-alpha.6").Install(BuildSettings.ProjectDirectory + "bin");
-        new PackageReference("NUnit.Extension.Net90PluggableAgent", "4.1.0-alpha.4").Install(BuildSettings.ProjectDirectory + "bin");
-    });
-
 //////////////////////////////////////////////////////////////////////
 // EXECUTION
 //////////////////////////////////////////////////////////////////////

nuget/runners/nunit.console-runner-with-extensions.nuspec

@@ -10,7 +10,7 @@
     <projectUrl>https://nunit.org</projectUrl>
     <repository type="git" url="https://github.com/nunit/nunit-console"/>
     <iconUrl>https://cdn.rawgit.com/nunit/resources/master/images/icon/nunit_256.png</iconUrl>
-    <icon>images\nunit_256.png</icon>
+    <icon>nunit_256.png</icon>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <summary>Console runner for the NUnit unit-testing framework with selected extensions.</summary>
     <description>
@@ -35,7 +35,7 @@
     </dependencies>
   </metadata>
   <files>
-    <file src="../../LICENSE.txt" />
-    <file src="../../nunit_256.png" target="images" />
+    <file src="LICENSE.txt" />
+    <file src="nunit_256.png" />
   </files>
 </package>