fix(dotnet): prevent "false" being incorrectly passed to dotnet command

nx-dotnet · Jan 17, 2024 · e04924a · e04924a
1 parent b673b2f
commit e04924a
Show file tree

Hide file tree

Showing 6 changed files with 105 additions and 6 deletions.
diff --git a/packages/dotnet/src/lib/core/dotnet.client.spec.ts b/packages/dotnet/src/lib/core/dotnet.client.spec.ts
@@ -484,4 +484,50 @@ ASP.NET Core gRPC Service                         grpc            [C#]
       `);
     });
   });
+
+  describe('test', () => {
+    it('should call test command', () => {
+      const dotnetClient = new DotNetClient(mockDotnetFactory('6.0.0'));
+      const spy = jest
+        .spyOn(dotnetClient, 'logAndExecute')
+        .mockImplementation(() => ({}));
+      dotnetClient.test('my-project', false, {
+        blame: false,
+      });
+      expect(spy).toHaveBeenCalledTimes(1);
+      expect(spy.mock.calls).toMatchInlineSnapshot(`
+        [
+          [
+            [
+              "test",
+              "my-project",
+            ],
+          ],
+        ]
+      `);
+    });
+  });
+
+  describe('build', () => {
+    it('should call build command', () => {
+      const dotnetClient = new DotNetClient(mockDotnetFactory('6.0.0'));
+      const spy = jest
+        .spyOn(dotnetClient, 'logAndExecute')
+        .mockImplementation(() => ({}));
+      dotnetClient.build('my-project', {
+        noDependencies: false,
+      });
+      expect(spy).toHaveBeenCalledTimes(1);
+      expect(spy.mock.calls).toMatchInlineSnapshot(`
+        [
+          [
+            [
+              "build",
+              "my-project",
+            ],
+          ],
+        ]
+      `);
+    });
+  });
 });
diff --git a/packages/dotnet/src/lib/core/dotnet.client.ts b/packages/dotnet/src/lib/core/dotnet.client.ts
@@ -1,7 +1,11 @@
 import { ChildProcess, spawn, spawnSync } from 'child_process';
 import * as semver from 'semver';
 
-import { getSpawnParameterArray, swapKeysUsingMap } from '@nx-dotnet/utils';
+import {
+  getSpawnParameterArray,
+  swapExplicitFalseKeys,
+  swapKeysUsingMap,
+} from '@nx-dotnet/utils';
 
 import {
   addPackageKeyMap,
@@ -14,6 +18,7 @@ import {
   dotnetRunOptions,
   DotnetTemplate,
   dotnetTestOptions,
+  formatExplicitFalseFlags,
   formatKeyMap,
   KnownDotnetTemplates,
   newKeyMap,
@@ -260,7 +265,12 @@ export class DotNetClient {
       params.push(project);
       if (parameters) {
         params.push(
-          ...getSpawnParameterArray(swapKeysUsingMap(parameters, formatKeyMap)),
+          ...getSpawnParameterArray(
+            swapKeysUsingMap(
+              swapExplicitFalseKeys(parameters, formatExplicitFalseFlags),
+              formatKeyMap,
+            ),
+          ),
         );
       }
       return this.logAndExecute(params);

diff --git a/packages/dotnet/src/lib/models/dotnet-format/dotnet-format-flags.ts b/packages/dotnet/src/lib/models/dotnet-format/dotnet-format-flags.ts
@@ -21,3 +21,9 @@ export const formatKeyMap: Partial<{ [key in dotnetFormatFlags]: string }> = {
   fixAnalyzers: 'fix-analyzers',
   verifyNoChanges: 'verify-no-changes',
 };
+
+export const formatExplicitFalseFlags: readonly dotnetFormatFlags[] = [
+  'fixAnalyzers',
+  'fixStyle',
+  'fixWhitespace',
+];
diff --git a/packages/utils/src/lib/utility-functions/args.spec.ts b/packages/utils/src/lib/utility-functions/args.spec.ts
@@ -1,4 +1,4 @@
-import { isDryRun } from './args';
+import { isDryRun, swapExplicitFalseKeys } from './args';
 
 describe('Args util functions', () => {
   describe('isDryRun', () => {
@@ -9,4 +9,26 @@ describe('Args util functions', () => {
       expect({ before, after }).toStrictEqual({ before: false, after: true });
     });
   });
+
+  describe('swapExplicitFalseKeys', () => {
+    it('should change a value to the string "false" if in the explicit false list', () => {
+      const result = swapExplicitFalseKeys(
+        {
+          fixWhitespace: false,
+          fixStyle: true,
+          fixAnalyzers: false,
+          noBuild: false,
+          noDependencies: true,
+        },
+        ['fixWhitespace', 'fixStyle', 'fixAnalyzers'],
+      );
+      expect(result).toStrictEqual({
+        fixWhitespace: 'false',
+        fixStyle: true,
+        fixAnalyzers: 'false',
+        noBuild: false,
+        noDependencies: true,
+      });
+    });
+  });
 });
diff --git a/packages/utils/src/lib/utility-functions/args.ts b/packages/utils/src/lib/utility-functions/args.ts
@@ -13,3 +13,17 @@ export function swapKeysUsingMap(
     ]),
   );
 }
+
+export function swapExplicitFalseKeys<
+  TRecord extends Record<string, string | boolean>,
+>(
+  object: TRecord,
+  explicitFalseKeys: readonly (keyof TRecord)[],
+): Record<string, string | boolean> {
+  return Object.fromEntries(
+    Object.entries(object).map(([key, value]) => [
+      key,
+      explicitFalseKeys.includes(key) && value === false ? 'false' : value,
+    ]),
+  ) as Record<string, string | boolean>;
+}
diff --git a/packages/utils/src/lib/utility-functions/parameters.ts b/packages/utils/src/lib/utility-functions/parameters.ts
@@ -29,9 +29,10 @@ export function getSpawnParameterArray(
 ): string[] {
   const spawnArray: string[] = [];
   for (const [key, value] of Object.entries(parameters)) {
-    // true booleans are flags, explicit false booleans follow regular key-value pattern
-    if (typeof value === 'boolean' && value) {
-      spawnArray.push(`--${key}`);
+    if (typeof value === 'boolean') {
+      if (value) {
+        spawnArray.push(`--${key}`);
+      }
     } else if (value !== undefined && value !== null) {
       spawnArray.push(`--${key}`, value.toString());
     }