Add more tests (#1100)

Author: ecraig12345

change/beachball-c029339d-1dac-463d-89c0-1eb4f3cfdddb.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "Allow writeChangeFiles to work outside a git repo for testing",
+  "packageName": "beachball",
+  "email": "elcraig@microsoft.com",
+  "dependentChangeType": "patch"
+}

src/__fixtures__/changeFiles.ts

@@ -30,7 +30,7 @@ export function getChange(
 
 /**
  * Generates and writes change files for the given packages.
- * Also commits if `options.commit` is true.
+ * Also commits if `options.commit` is true and the context is a git repo.
  * @param changes Array of package names or partial change files (which must include `packageName`).
  * Default values:
  * - `type: 'minor'`

src/__fixtures__/createTestFileStructure.ts

@@ -18,3 +18,28 @@ export function createTestFileStructure(files: Record<string, string | object>):
 
   return testFolderPath.replace(/\\/g, '/');
 }
+
+/**
+ * Create a test file structure for a named fixture (similar to the ones in `RepositoryFactory`).
+ */
+export function createTestFileStructureType(type: 'monorepo'): string {
+  switch (type) {
+    case 'monorepo':
+      return createTestFileStructure({
+        'package.json': {
+          name: 'monorepo-fixture',
+          version: '1.0.0',
+          private: true,
+          workspaces: ['packages/*', 'packages/grouped/*'],
+        },
+        'packages/foo/package.json': { name: 'foo', version: '1.0.0', dependencies: { bar: '^1.3.4' } },
+        'packages/bar/package.json': { name: 'bar', version: '1.3.4', dependencies: { baz: '^1.3.4' } },
+        'packages/baz/package.json': { name: 'baz', version: '1.3.4' },
+        'packages/grouped/a/package.json': { name: 'a', version: '3.1.2' },
+        'packages/grouped/b/package.json': { name: 'b', version: '3.1.2' },
+        'yarn.lock': '',
+      });
+    default:
+      throw new Error(`Unknown test file structure type: ${type}`);
+  }
+}

src/__fixtures__/mockProcessExit.ts

@@ -0,0 +1,11 @@
+import { jest } from '@jest/globals';
+import type { MockLogs } from './mockLogs';
+
+/**
+ * Throw an error when `process.exit()` is called. The message will include any error logs.
+ */
+export function mockProcessExit(logs: MockLogs) {
+  return jest.spyOn(process, 'exit').mockImplementation(code => {
+    throw new Error(`process.exit(${code ?? ''}) called. Logged errors:\n${logs.getMockLines('error')}`);
+  });
+}

src/__fixtures__/packageInfos.ts

@@ -1,12 +1,16 @@
+import path from 'path';
+import type { PackageInfo as WSPackageInfo } from 'workspace-tools';
 import type { PackageInfo, PackageInfos } from '../types/PackageInfo';
 import { getPackageInfosWithOptions } from '../options/getPackageInfosWithOptions';
 import type { CliOptions, RepoOptions } from '../types/BeachballOptions';
 import { defaultRemoteBranchName } from './gitDefaults';
 
+export type PartialPackageInfo = Omit<Partial<PackageInfo>, 'combinedOptions' | 'packageOptions'> & {
+  beachball?: PackageInfo['packageOptions'];
+};
+
 export type PartialPackageInfos = {
-  [name: string]: Omit<Partial<PackageInfo>, 'combinedOptions' | 'packageOptions'> & {
-    beachball?: PackageInfo['packageOptions'];
-  };
+  [name: string]: PartialPackageInfo;
 };
 
 /**
@@ -16,31 +20,70 @@ export type PartialPackageInfos = {
  *   name: '<key>',
  *   version: '1.0.0',
  *   private: false,
- *   packageJsonPath: ''
+ *   packageJsonPath: `${cliOptions.path || ''}/packages/<basename>/package.json`,
  * }
  * ```
  * Other defaults and values are filled by the actual logic in `getPackageInfosWithOptions`,
  * including the overrides in `repoOptions` merged in realistic order.
+ * @param repoOptions Extra repo options. A `branch` option is included automatically (to prevent lookup).
+ * @param cliOptions CLI options. Use `path` to specify the CWD.
  */
 export function makePackageInfos(
   packageInfos: PartialPackageInfos,
   repoOptions?: Partial<RepoOptions>,
   cliOptions?: Partial<CliOptions>
 ): PackageInfos {
+  const cwd = cliOptions?.path || '';
   return getPackageInfosWithOptions(
-    Object.entries(packageInfos).map(([name, info]) => {
-      return {
+    Object.entries(packageInfos).map(
+      ([name, info]): WSPackageInfo => ({
         name,
         version: '1.0.0',
         private: false,
-        packageOptions: {},
-        packageJsonPath: '',
+        packageJsonPath: path.join(cwd, 'packages', path.basename(name), 'package.json'),
         ...info,
-      };
-    }),
+      })
+    ),
     {
       repoOptions: { branch: defaultRemoteBranchName, ...repoOptions },
-      cliOptions: { path: '', command: '', ...cliOptions },
+      cliOptions: { path: cwd, command: '', ...cliOptions },
     }
   );
 }
+
+/**
+ * Makes a properly typed PackageInfos object from a partial object, filling in defaults:
+ * ```js
+ * {
+ *   name: '<folder basename>',
+ *   version: '1.0.0',
+ *   private: false,
+ *   packageJsonPath: `${cwd}/${key}/package.json`,
+ * }
+ * ```
+ * Other defaults and values are filled by the actual logic in `getPackageInfosWithOptions`,
+ * including the overrides in `repoOptions` merged in realistic order.
+ */
+export function makePackageInfosByFolder(params: {
+  packages: { [folder: string]: PartialPackageInfo };
+  cwd: string;
+  /** Extra repo options. A `branch` option is included automatically (to prevent lookup). */
+  repoOptions?: Partial<RepoOptions>;
+  /** Extra CLI options */
+  cliOptions?: Partial<Omit<CliOptions, 'path'>>;
+}): PackageInfos {
+  const { packages, cwd, repoOptions, cliOptions } = params;
+  return makePackageInfos(
+    Object.fromEntries(
+      Object.entries(packages).map(([folder, info]) => [
+        path.basename(folder),
+        {
+          packageJsonPath: path.join(cwd, folder, 'package.json'),
+          ...info,
+        },
+      ])
+    ),
+    repoOptions,
+    { ...cliOptions, path: cwd }
+  );
+}

src/__fixtures__/repository.ts

@@ -1,6 +1,6 @@
 import path from 'path';
 import * as fs from 'fs-extra';
-import { tmpdir } from './tmpdir';
+import { removeTempDir, tmpdir } from './tmpdir';
 import { git, type GitProcessOutput } from 'workspace-tools';
 import {
   defaultBranchName,
@@ -9,7 +9,6 @@ import {
   optsWithLang,
   setDefaultBranchName,
 } from './gitDefaults';
-import { env } from '../env';
 
 /**
  * Clone options. See the docs for details on behavior and interaction of these options.
@@ -223,15 +222,7 @@ ${gitResult.stderr.toString()}`);
    * and the agents are wiped after each job, so manually deleting the files just slows things down.
    */
   cleanUp(): void {
-    try {
-      // This occasionally throws on Windows with "resource busy"
-      if (this.root && !env.isCI) {
-        fs.removeSync(this.root);
-      }
-    } catch (err) {
-      // This is non-fatal since the temp dir will eventually be cleaned up automatically
-      console.warn(`Could not clean up repository: ${err}`);
-    }
+    removeTempDir(this.root);
     this.root = undefined;
   }
 }

src/__fixtures__/repositoryFactory.ts

@@ -3,10 +3,9 @@ import path from 'path';
 import type { PackageJson } from '../types/PackageInfo';
 import { Repository, type RepositoryCloneOptions } from './repository';
 import type { BeachballOptions } from '../types/BeachballOptions';
-import { tmpdir } from './tmpdir';
+import { removeTempDir, tmpdir } from './tmpdir';
 import { gitFailFast } from 'workspace-tools';
 import { setDefaultBranchName } from './gitDefaults';
-import { env } from '../env';
 import { cloneObject } from '../object/cloneObject';
 
 /**
@@ -262,16 +261,9 @@ export class RepositoryFactory {
   cleanUp(): void {
     if (!this.root) return;
 
-    try {
-      // This occasionally throws on Windows with "resource busy"
-      if (this.root && !env.isCI) {
-        fs.removeSync(this.root);
-      }
-    } catch (err) {
-      // This is non-fatal since the temp dir will eventually be cleaned up automatically
-      console.warn(`Could not clean up factory: ${err}`);
-    }
+    removeTempDir(this.root);
     this.root = undefined;
+
     for (const repo of this.childRepos) {
       repo.cleanUp();
     }

src/__fixtures__/tmpdir.ts

@@ -3,6 +3,7 @@ import * as tmp from 'tmp';
 import { normalizedTmpdir } from 'normalized-tmpdir';
 // import console to ensure that warnings are always logged if needed (no mocking)
 import realConsole from 'console';
+import { env } from '../env';
 
 // tmp is supposed to be able to clean up automatically, but this doesn't always work within jest.
 // So we attempt to use its built-in cleanup mechanisms, but tests should ideally do their own cleanup too.
@@ -27,11 +28,20 @@ export function tmpdir(options?: tmp.DirOptions): string {
   }).name;
 }
 
-/** Remove the temp directory, ignoring errors */
-export function removeTempDir(dir: string): void {
+/**
+ * Clean up the folder if this is a local build.
+ *
+ * Doing this in CI is unnecessary because all the fixtures use unique temp directories (no collisions)
+ * and the agents are wiped after each job, so manually deleting the files just slows things down.
+ */
+export function removeTempDir(dir: string | undefined): void {
   try {
-    fs.rmSync(dir, { force: true });
-  } catch {
-    // ignore
+    // This occasionally throws on Windows with "resource busy"
+    if (dir && !env.isCI) {
+      fs.removeSync(dir);
+    }
+  } catch (err) {
+    // This is non-fatal since the temp dir will eventually be cleaned up automatically
+    console.warn(`Could not clean up temp folder ${dir}:\n${err}`);
   }
 }