refactor(build-env): rename utils functions add test

tooling/build-env/src/executors/kill-process/executor.ts

@@ -2,7 +2,7 @@ import { type ExecutorContext, logger } from '@nx/devkit';
 
 import type { KillProcessExecutorOptions } from './schema';
 import { join } from 'node:path';
-import { killProcessFromPid } from '../../internal/utils/process';
+import { killProcessFromPid } from '../../internal/utils/kill-process';
 import { normalizeOptions } from '../internal/normalize-options';
 
 export type ExecutorOutput = {

tooling/build-env/src/executors/npm-install/executor.ts

@@ -3,9 +3,9 @@ import { type ExecutorContext, logger, readJsonFile } from '@nx/devkit';
 import type { NpmInstallExecutorOptions } from './schema';
 import { join } from 'node:path';
 import { executeProcess } from '../../internal/utils/execute-process';
-import { objectToCliArgs } from '../../internal/utils/terminal-command';
+import { objectToCliArgs } from '../../internal/utils/terminal';
 import type { PackageJson } from 'nx/src/utils/package-json';
-import { getBuildOutput } from '../../internal/utils/utils';
+import { getTargetOutputPath } from '../../internal/utils/target';
 import { normalizeOptions } from '../internal/normalize-options';
 
 export type NpmInstallExecutorOutput = {
@@ -24,7 +24,7 @@ export default async function runNpmInstallExecutor(
     options: opt,
   } = normalizeOptions(context, options);
 
-  const packageDistPath = getBuildOutput(
+  const packageDistPath = getTargetOutputPath(
     projectsConfigurations.projects[projectName]?.targets['build']
   );
   const { name: packageName, version } = readJsonFile<PackageJson>(

tooling/build-env/src/executors/npm-publish/executor.ts

@@ -3,8 +3,8 @@ import { type ExecutorContext, logger } from '@nx/devkit';
 import type { NpmPublishExecutorOptions } from './schema';
 import { join, relative } from 'node:path';
 import { executeProcess } from '../../internal/utils/execute-process';
-import { objectToCliArgs } from '../../internal/utils/terminal-command';
-import { getBuildOutput } from '../../internal/utils/utils';
+import { objectToCliArgs } from '../../internal/utils/terminal';
+import { getTargetOutputPath } from '../../internal/utils/target';
 import { normalizeOptions } from '../internal/normalize-options';
 
 export type NpmPublishExecutorOutput = {
@@ -28,7 +28,7 @@ export default async function runNpmPublishExecutor(
   const { environmentRoot } = opt;
 
   const { targets } = projectsConfigurations.projects[projectName];
-  const packageDistPath = getBuildOutput(targets['build']);
+  const packageDistPath = getTargetOutputPath(targets['build']);
   const userconfig = join(
     relativeFromDist(packageDistPath),
     join(environmentRoot, '.npmrc')

tooling/build-env/src/executors/setup/executor.ts

@@ -3,11 +3,12 @@ import { join } from 'node:path';
 import runBuildExecutor from '../bootstrap/executor';
 import runKillProcessExecutor from '../kill-process/executor';
 import { executeProcess } from '../../internal/utils/execute-process';
-import { objectToCliArgs } from '../../internal/utils/terminal-command';
+import { objectToCliArgs } from '../../internal/utils/terminal';
 import type { VerdaccioProcessResult } from '../../internal/verdaccio/verdaccio-registry';
 import type { SetupEnvironmentExecutorOptions } from './schema';
 import { normalizeOptions } from '../internal/normalize-options';
-import { VERDACCIO_REGISTRY_JSON } from '../../internal/verdaccio/verdaccio-npm-env';
+
+import { VERDACCIO_REGISTRY_JSON } from '../../internal/verdaccio/constants';
 
 export type ExecutorOutput = {
   success: boolean;
@@ -33,7 +34,11 @@ export default async function runSetupEnvironmentExecutor(
       },
       context
     );
-    const {environmentRoot, keepServerRunning, verbose = true} = normalizedOptions;
+    const {
+      environmentRoot,
+      keepServerRunning,
+      verbose = true,
+    } = normalizedOptions;
 
     await executeProcess({
       command: 'nx',
@@ -50,15 +55,12 @@ export default async function runSetupEnvironmentExecutor(
       await runKillProcessExecutor(
         {
           ...normalizedOptions,
-          filePath: join(
-            environmentRoot,
-            VERDACCIO_REGISTRY_JSON
-          ),
+          filePath: join(environmentRoot, VERDACCIO_REGISTRY_JSON),
         },
         context
       );
     } else {
-      const {url} = readJsonFile<VerdaccioProcessResult>(
+      const { url } = readJsonFile<VerdaccioProcessResult>(
         join(environmentRoot, VERDACCIO_REGISTRY_JSON)
       );
       logger.info(`Verdaccio server kept running under : ${url}`);

tooling/build-env/src/internal/utils/utils.ts → tooling/build-env/src/internal/utils/target.ts

@@ -1,15 +1,10 @@
-import { mkdir } from 'node:fs/promises';
 import type { TargetConfiguration } from '@nx/devkit';
 
-export function getBuildOutput(target?: TargetConfiguration) {
+export function getTargetOutputPath(target?: TargetConfiguration) {
   const { options } = target ?? {};
   const { outputPath } = options ?? {};
   if (!outputPath) {
     throw new Error('outputPath is required');
   }
   return outputPath;
 }
-
-export function uniquePort(): number {
-  return Number((6000 + Number(Math.random() * 1000)).toFixed(0));
-}

tooling/build-env/src/internal/utils/target.unit-test.ts

@@ -0,0 +1,25 @@
+import { getTargetOutputPath } from './target';
+
+describe('getTargetOutputPath', () => {
+  it('should return output path of the build target if given', () => {
+    expect(
+      getTargetOutputPath({
+        options: {
+          outputPath: 'out-dir',
+        },
+      })
+    ).toBe('out-dir');
+  });
+
+  it('should throw if no outputPath is given in options', () => {
+    expect(
+      getTargetOutputPath({
+        options: {},
+      })
+    ).toThrow('outputPath is required');
+  });
+
+  it('should throw if empty onject is passed', () => {
+    expect(getTargetOutputPath({})).toThrow('outputPath is required');
+  });
+});

tooling/build-env/src/internal/utils/unique-port.ts

@@ -0,0 +1,3 @@
+export function uniquePort(): number {
+  return Number((6000 + Number(Math.random() * 1000)).toFixed(0));
+}

tooling/build-env/src/internal/utils/unique-port.unit-test.ts

@@ -0,0 +1,12 @@
+import { uniquePort } from './unique-port';
+
+describe('uniquePort', () => {
+  it('should return a different number on every call', () => {
+    const portsArray = new Array(100).fill(0).map(() => uniquePort());
+    expect(portsArray.length).toBe(new Set(portsArray).size);
+  });
+
+  it('should return random number bigger then 6000', () => {
+    expect(uniquePort()).toBeGreaterThan(6000);
+  });
+});

tooling/build-env/src/internal/verdaccio/constants.ts

@@ -0,0 +1 @@
+export const VERDACCIO_REGISTRY_JSON = 'verdaccio-registry.json';

tooling/build-env/src/plugin/plugin.ts

@@ -7,7 +7,8 @@ import {
 import { dirname, join } from 'node:path';
 import { DEFAULT_ENVIRONMENTS_OUTPUT_DIR } from '../internal/constants';
 import type { StarVerdaccioOptions } from '../internal/verdaccio/verdaccio-registry';
-import { VERDACCIO_REGISTRY_JSON } from '../internal/verdaccio/verdaccio-npm-env';
+
+import { VERDACCIO_REGISTRY_JSON } from '../internal/verdaccio/constants';
 
 export function isPublishable(tags: string[]): boolean {
   return tags.some((target) => target === 'publishable');