Add arguments for verbose output to installer script

Author: matherm-aboehm

__tests__/installer.test.ts

@@ -251,6 +251,72 @@ describe('installer tests', () => {
         }
       );
 
+      it(`should supply 'verbose' argument to the installation script if verbose input is set to true`, async () => {
+        const inputVersion = '10.0.101';
+        const inputQuality = '' as QualityOptions;
+        const inputVerbose = true;
+        const stdout = `Fictitious dotnet version ${inputVersion} is installed`;
+
+        getExecOutputSpy.mockImplementation(() => {
+          return Promise.resolve({
+            exitCode: 0,
+            stdout: `${stdout}`,
+            stderr: ''
+          });
+        });
+        maxSatisfyingSpy.mockImplementation(() => inputVersion);
+
+        const dotnetInstaller = new installer.DotnetCoreInstaller(
+          inputVersion,
+          inputQuality,
+          undefined,
+          inputVerbose
+        );
+
+        await dotnetInstaller.installDotnet();
+
+        const scriptArguments = getExecOutputSpy.mock.calls.map(call =>
+          (call[1] as string[]).join(' ')
+        );
+        const expectedArgument = IS_WINDOWS ? '-Verbose' : '--verbose';
+
+        expect(scriptArguments[0]).toContain(expectedArgument);
+        expect(scriptArguments[1]).toContain(expectedArgument);
+      });
+
+      it(`should not supply 'verbose' argument to the installation script if verbose input is set to false`, async () => {
+        const inputVersion = '10.0.101';
+        const inputQuality = '' as QualityOptions;
+        const inputVerbose = false;
+        const stdout = `Fictitious dotnet version ${inputVersion} is installed`;
+
+        getExecOutputSpy.mockImplementation(() => {
+          return Promise.resolve({
+            exitCode: 0,
+            stdout: `${stdout}`,
+            stderr: ''
+          });
+        });
+        maxSatisfyingSpy.mockImplementation(() => inputVersion);
+
+        const dotnetInstaller = new installer.DotnetCoreInstaller(
+          inputVersion,
+          inputQuality,
+          undefined,
+          inputVerbose
+        );
+
+        await dotnetInstaller.installDotnet();
+
+        const scriptArguments = getExecOutputSpy.mock.calls.map(call =>
+          (call[1] as string[]).join(' ')
+        );
+        const expectedArgument = IS_WINDOWS ? '-Verbose' : '--verbose';
+
+        expect(scriptArguments[0]).not.toContain(expectedArgument);
+        expect(scriptArguments[1]).not.toContain(expectedArgument);
+      });
+
       if (IS_WINDOWS) {
         it(`should supply '-ProxyAddress' argument to the installation script if env.variable 'https_proxy' is set`, async () => {
           process.env['https_proxy'] = 'https://proxy.com';

action.yml

@@ -20,7 +20,7 @@ inputs:
   cache:
     description: 'Optional input to enable caching of the NuGet global-packages folder'
     required: false
-    default: false
+    default: 'false'
   cache-dependency-path:
     description: 'Used to specify the path to a dependency file: packages.lock.json. Supports wildcards or a list of file names for caching multiple dependencies.'
     required: false
@@ -30,6 +30,10 @@ inputs:
   architecture:
     description: 'Optional architecture for the .NET install. Supported values: x64, x86, arm64, amd64, arm, s390x, ppc64le, riscv64. If not set, the installer auto-detects the current system architecture.'
     required: false
+  verbose:
+    description: 'Optional input to enable verbose output of installer script'
+    required: false
+    default: 'false'
 outputs:
   cache-hit:
     description: 'A boolean value to indicate if a cache was hit.'

dist/setup/index.js

@@ -54938,6 +54938,12 @@ class DotnetInstallScript {
         }
         return this;
     }
+    useVerbose(verbose) {
+        if (verbose) {
+            this.useArguments(utils_1.IS_WINDOWS ? '-Verbose' : '--verbose');
+        }
+        return this;
+    }
     async execute() {
         const getExecOutputOptions = {
             ignoreReturnCode: true,
@@ -54987,13 +54993,15 @@ class DotnetCoreInstaller {
     version;
     quality;
     architecture;
+    verbose;
     static {
         DotnetInstallDir.setEnvironmentVariable();
     }
-    constructor(version, quality, architecture) {
+    constructor(version, quality, architecture, verbose) {
         this.version = version;
         this.quality = quality;
         this.architecture = architecture;
+        this.verbose = verbose;
     }
     async installDotnet() {
         const versionResolver = new DotnetVersionResolver(this.version);
@@ -55020,6 +55028,8 @@ class DotnetCoreInstaller {
             // Use latest stable version
             .useArguments(utils_1.IS_WINDOWS ? '-Channel' : '--channel', 'LTS')
             .useArguments(...architectureArguments)
+            // Enable verbose output depending on user input
+            .useVerbose(this.verbose)
             .execute();
         if (runtimeInstallOutput.exitCode) {
             /**
@@ -55039,6 +55049,8 @@ class DotnetCoreInstaller {
             // Use version provided by user
             .useVersion(dotnetVersion, this.quality)
             .useArguments(...architectureArguments)
+            // Enable verbose output depending on user input
+            .useVerbose(this.verbose)
             .execute();
         if (dotnetInstallOutput.exitCode) {
             throw new Error(`Failed to install dotnet, exit code: ${dotnetInstallOutput.exitCode}. ${dotnetInstallOutput.stderr}`);
@@ -55167,13 +55179,14 @@ async function run() {
         }
         if (versions.length) {
             const quality = core.getInput('dotnet-quality');
+            const verbose = core.getBooleanInput('verbose');
             if (quality && !qualityOptions.includes(quality)) {
                 throw new Error(`Value '${quality}' is not supported for the 'dotnet-quality' option. Supported values are: daily, signed, validated, preview, ga.`);
             }
             let dotnetInstaller;
             const uniqueVersions = new Set(versions);
             for (const version of uniqueVersions) {
-                dotnetInstaller = new installer_1.DotnetCoreInstaller(version, quality, architecture);
+                dotnetInstaller = new installer_1.DotnetCoreInstaller(version, quality, architecture, verbose);
                 const installedVersion = await dotnetInstaller.installDotnet();
                 installedDotnetVersions.push(installedVersion);
             }

src/installer.ts

@@ -213,6 +213,14 @@ export class DotnetInstallScript {
     return this;
   }
 
+  public useVerbose(verbose?: boolean) {
+    if (verbose) {
+      this.useArguments(IS_WINDOWS ? '-Verbose' : '--verbose');
+    }
+
+    return this;
+  }
+
   public async execute() {
     const getExecOutputOptions = {
       ignoreReturnCode: true,
@@ -279,7 +287,8 @@ export class DotnetCoreInstaller {
   constructor(
     private version: string,
     private quality: QualityOptions,
-    private architecture?: string
+    private architecture?: string,
+    private verbose?: boolean
   ) {}
 
   public async installDotnet(): Promise<string | null> {
@@ -311,6 +320,8 @@ export class DotnetCoreInstaller {
       // Use latest stable version
       .useArguments(IS_WINDOWS ? '-Channel' : '--channel', 'LTS')
       .useArguments(...architectureArguments)
+      // Enable verbose output depending on user input
+      .useVerbose(this.verbose)
       .execute();
 
     if (runtimeInstallOutput.exitCode) {
@@ -336,6 +347,8 @@ export class DotnetCoreInstaller {
       // Use version provided by user
       .useVersion(dotnetVersion, this.quality)
       .useArguments(...architectureArguments)
+      // Enable verbose output depending on user input
+      .useVerbose(this.verbose)
       .execute();
 
     if (dotnetInstallOutput.exitCode) {

src/setup-dotnet.ts

@@ -77,6 +77,7 @@ export async function run() {
 
     if (versions.length) {
       const quality = core.getInput('dotnet-quality') as QualityOptions;
+      const verbose = core.getBooleanInput('verbose');
 
       if (quality && !qualityOptions.includes(quality)) {
         throw new Error(
@@ -90,7 +91,8 @@ export async function run() {
         dotnetInstaller = new DotnetCoreInstaller(
           version,
           quality,
-          architecture
+          architecture,
+          verbose
         );
         const installedVersion = await dotnetInstaller.installDotnet();
         installedDotnetVersions.push(installedVersion);