Share test utilities (#843)

steveukx · web-flow · commit 6b3e05c99a42 · 2022-08-13T10:45:44.000+01:00
Split test fixtures into `@simple-git/test-utils`, depend on the package directly in integration tests and share through unit tests fixtures
Remove outer fixtures, reuse `@simple-git/test-utils` in unit test fixtures
diff --git a/.changeset/heavy-pumpkins-work.md b/.changeset/heavy-pumpkins-work.md
@@ -0,0 +1,6 @@
+---
+'@simple-git/test-utils': major
+'simple-git': patch
+---
+
+Use shared test utilities bundle in simple-git tests, to enable consistent testing across packages in the future
diff --git a/packages/test-utils/index.ts b/packages/test-utils/index.ts
@@ -0,0 +1,9 @@
+export * from './src/create-test-context';
+export * from './src/expectations';
+export * from './src/instance';
+export * from './src/like';
+export * from './src/wait';
+
+export * from './src/setup/setup-conflicted';
+export * from './src/setup/setup-files';
+export * from './src/setup/setup-init';
diff --git a/packages/test-utils/package.json b/packages/test-utils/package.json
@@ -0,0 +1,8 @@
+{
+  "name": "@simple-git/test-utils",
+  "version": "0.0.0",
+  "private": true,
+  "peerDependencies": {
+    "simple-git": "^3.12.0"
+  }
+}
diff --git a/packages/test-utils/src/create-test-context.ts b/packages/test-utils/src/create-test-context.ts
@@ -1,7 +1,6 @@
 import { join } from 'path';
 import { existsSync, mkdir, mkdtemp, realpathSync, writeFile, WriteFileOptions } from 'fs';
-import { SimpleGit } from '../../typings';
-import { newSimpleGit } from './instance';
+import { simpleGit, SimpleGit } from 'simple-git';
 
 export interface SimpleGitTestContext {
    /** Creates a directory under the repo root at the given path(s) */
@@ -85,7 +84,7 @@ export async function createTestContext(): Promise<SimpleGitTestContext> {
          return realpathSync(context.root);
       },
       get git() {
-         return newSimpleGit(root);
+         return simpleGit(root);
       },
    };
 
diff --git a/packages/test-utils/src/expectations.ts b/packages/test-utils/src/expectations.ts
@@ -1,5 +1,4 @@
-import { GitError } from '../../src/lib/errors/git-error';
-import { GitResponseError } from '../../src/lib/errors/git-response-error';
+import { GitError, GitResponseError } from "simple-git";
 
 /**
  * Convenience for asserting the type and message of a `GitError`
@@ -15,12 +14,8 @@ import { GitResponseError } from '../../src/lib/errors/git-response-error';
 export function assertGitError(
    errorInstance: Error | unknown,
    message: string | RegExp,
-   errorConstructor?: any
+   errorConstructor: any = GitError
 ) {
-   if (!errorConstructor) {
-      errorConstructor = GitError;
-   }
-
    expect(errorInstance).toBeInstanceOf(errorConstructor);
    expect(errorInstance).toHaveProperty('message', expect.stringMatching(message));
 }
diff --git a/packages/test-utils/src/instance.ts b/packages/test-utils/src/instance.ts
@@ -0,0 +1,3 @@
+import { simpleGit as newSimpleGit } from 'simple-git';
+
+export { newSimpleGit };
diff --git a/packages/test-utils/src/like.ts b/packages/test-utils/src/like.ts
diff --git a/packages/test-utils/src/setup/setup-conflicted.ts b/packages/test-utils/src/setup/setup-conflicted.ts
@@ -1,4 +1,4 @@
-import { SimpleGitTestContext } from './create-test-context';
+import { SimpleGitTestContext } from '../create-test-context';
 
 export const FIRST_BRANCH = 'first';
 export const SECOND_BRANCH = 'second';
diff --git a/packages/test-utils/src/setup/setup-files.ts b/packages/test-utils/src/setup/setup-files.ts
@@ -1,4 +1,4 @@
-import { SimpleGitTestContext } from './create-test-context';
+import { SimpleGitTestContext } from '../create-test-context';
 
 export async function setUpFilesAdded(
    { git, files }: SimpleGitTestContext,
diff --git a/packages/test-utils/src/setup/setup-init.ts b/packages/test-utils/src/setup/setup-init.ts
@@ -1,5 +1,5 @@
-import { SimpleGit } from '../../typings';
-import { SimpleGitTestContext } from './create-test-context';
+import { SimpleGit } from 'simple-git';
+import { SimpleGitTestContext } from '../create-test-context';
 
 export const GIT_USER_NAME = 'Simple Git Tests';
 export const GIT_USER_EMAIL = 'tests@simple-git.dev';
diff --git a/packages/test-utils/src/wait.ts b/packages/test-utils/src/wait.ts
diff --git a/simple-git/package.json b/simple-git/package.json
@@ -21,6 +21,7 @@
   "devDependencies": {
     "@kwsites/promise-result": "^1.1.0",
     "@simple-git/babel-config": "^1.0.0",
+    "@simple-git/test-utils": "^0.0.0",
     "@types/debug": "^4.1.5",
     "@types/jest": "^27.0.3",
     "@types/node": "^14.14.10",
diff --git a/simple-git/test/__fixtures__/index.ts b/simple-git/test/__fixtures__/index.ts
diff --git a/simple-git/test/__fixtures__/instance.ts b/simple-git/test/__fixtures__/instance.ts
diff --git a/simple-git/test/integration/add.spec.ts b/simple-git/test/integration/add.spec.ts
@@ -4,7 +4,7 @@ import {
    newSimpleGit,
    setUpInit,
    SimpleGitTestContext,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 
 describe('add', () => {
    let context: SimpleGitTestContext;
diff --git a/simple-git/test/integration/bad-initial-path.spec.ts b/simple-git/test/integration/bad-initial-path.spec.ts
@@ -4,7 +4,7 @@ import {
    like,
    newSimpleGit,
    SimpleGitTestContext,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 
 import { GitConstructError } from '../..';
 
diff --git a/simple-git/test/integration/branches.spec.ts b/simple-git/test/integration/branches.spec.ts
@@ -6,7 +6,7 @@ import {
    newSimpleGit,
    setUpInit,
    SimpleGitTestContext,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 
 describe('branches', () => {
    let context: SimpleGitTestContext;
diff --git a/simple-git/test/integration/broken-chains.spec.ts b/simple-git/test/integration/broken-chains.spec.ts
@@ -1,11 +1,6 @@
-import { isPromiseFailure, promiseError, promiseResult } from '@kwsites/promise-result';
-import {
-   assertGitError,
-   createTestContext,
-   newSimpleGit,
-   SimpleGitTestContext,
-} from '../__fixtures__';
-import { SimpleGit } from '../../typings';
+import { isPromiseFailure, promiseError, promiseResult } from "@kwsites/promise-result";
+import { assertGitError, createTestContext, newSimpleGit, SimpleGitTestContext } from "@simple-git/test-utils";
+import { SimpleGit } from "../../typings";
 
 /*
    The broken chains test assures the behaviour of both standard and Promise wrapped versions
diff --git a/simple-git/test/integration/change-directory.spec.ts b/simple-git/test/integration/change-directory.spec.ts
@@ -5,7 +5,7 @@ import {
    newSimpleGit,
    SimpleGitTestContext,
    wait,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 import { SimpleGit } from '../../typings';
 
 describe('change-directory', () => {
diff --git a/simple-git/test/integration/check-is-repo.spec.ts b/simple-git/test/integration/check-is-repo.spec.ts
@@ -3,7 +3,7 @@ import {
    createTestContext,
    newSimpleGit,
    SimpleGitTestContext,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 
 import { CheckRepoActions } from '../../src/lib/tasks/check-is-repo';
 
diff --git a/simple-git/test/integration/checkout.spec.ts b/simple-git/test/integration/checkout.spec.ts
@@ -1,4 +1,9 @@
-import { createTestContext, newSimpleGit, setUpInit, SimpleGitTestContext } from '../__fixtures__';
+import {
+   createTestContext,
+   newSimpleGit,
+   setUpInit,
+   SimpleGitTestContext,
+} from '@simple-git/test-utils';
 import { SimpleGit } from '../../typings';
 import { promiseError } from '@kwsites/promise-result';
 
diff --git a/simple-git/test/integration/clean.spec.ts b/simple-git/test/integration/clean.spec.ts
@@ -7,7 +7,7 @@ import {
    setUpFilesAdded,
    setUpInit,
    SimpleGitTestContext,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 
 import { CleanOptions } from '../../src/lib/tasks/clean';
 
diff --git a/simple-git/test/integration/commit.spec.ts b/simple-git/test/integration/commit.spec.ts
@@ -1,4 +1,9 @@
-import { createTestContext, newSimpleGit, setUpInit, SimpleGitTestContext } from '../__fixtures__';
+import {
+   createTestContext,
+   newSimpleGit,
+   setUpInit,
+   SimpleGitTestContext,
+} from '@simple-git/test-utils';
 
 describe('commit', () => {
    let context: SimpleGitTestContext;
diff --git a/simple-git/test/integration/completion-plugin.spec.ts b/simple-git/test/integration/completion-plugin.spec.ts
@@ -1,5 +1,5 @@
 import { promiseError } from '@kwsites/promise-result';
-import { createTestContext, newSimpleGit, SimpleGitTestContext } from '../__fixtures__';
+import { createTestContext, newSimpleGit, SimpleGitTestContext } from '@simple-git/test-utils';
 
 describe('progress-monitor', () => {
    let context: SimpleGitTestContext;
diff --git a/simple-git/test/integration/concurrent-commands.spec.ts b/simple-git/test/integration/concurrent-commands.spec.ts
@@ -4,7 +4,7 @@ import {
    setUpFilesAdded,
    setUpInit,
    SimpleGitTestContext,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 
 describe('concurrent commands', () => {
    let contexts: { first: SimpleGitTestContext; second: SimpleGitTestContext };
diff --git a/simple-git/test/integration/config.spec.ts b/simple-git/test/integration/config.spec.ts
@@ -1,4 +1,9 @@
-import { createTestContext, newSimpleGit, setUpInit, SimpleGitTestContext } from '../__fixtures__';
+import {
+   createTestContext,
+   newSimpleGit,
+   setUpInit,
+   SimpleGitTestContext,
+} from '@simple-git/test-utils';
 import { GitConfigScope } from '../..';
 import { SimpleGit } from '../../typings';
 
diff --git a/simple-git/test/integration/diff.spec.ts b/simple-git/test/integration/diff.spec.ts
@@ -5,7 +5,7 @@ import {
    setUpFilesAdded,
    setUpInit,
    SimpleGitTestContext,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 
 describe('diff', function () {
    const nameWithTrailingSpaces = 'name-with-trailing-spaces  ';
diff --git a/simple-git/test/integration/exec.spec.ts b/simple-git/test/integration/exec.spec.ts
@@ -1,4 +1,4 @@
-import { createTestContext, newSimpleGit, SimpleGitTestContext } from '../__fixtures__';
+import { createTestContext, newSimpleGit, SimpleGitTestContext } from '@simple-git/test-utils';
 
 describe('exec', () => {
    let context: SimpleGitTestContext;
diff --git a/simple-git/test/integration/fetch.spec.ts b/simple-git/test/integration/fetch.spec.ts
@@ -1,4 +1,9 @@
-import { createTestContext, newSimpleGit, setUpInit, SimpleGitTestContext } from '../__fixtures__';
+import {
+   createTestContext,
+   newSimpleGit,
+   setUpInit,
+   SimpleGitTestContext,
+} from '@simple-git/test-utils';
 
 describe('fetch', () => {
    let context: SimpleGitTestContext;
@@ -70,6 +75,7 @@ describe('fetch', () => {
       await git.raw('checkout', '-b', 'bravo');
       await git.raw('checkout', '-b', 'charlie');
    }
+
    /**
     * Configure the remote with changes to be retrieved when using fetch on the local
     */
diff --git a/simple-git/test/integration/grep.spec.ts b/simple-git/test/integration/grep.spec.ts
@@ -1,4 +1,4 @@
-import { createTestContext, newSimpleGit, SimpleGitTestContext } from '../__fixtures__';
+import { createTestContext, newSimpleGit, SimpleGitTestContext } from '@simple-git/test-utils';
 import { grepQueryBuilder } from '../..';
 
 describe('grep', () => {
diff --git a/simple-git/test/integration/log.spec.ts b/simple-git/test/integration/log.spec.ts
@@ -8,7 +8,7 @@ import {
    setUpFilesAdded,
    setUpInit,
    SimpleGitTestContext,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 import type { DiffResultTextFile } from '../../typings';
 
 describe('log', () => {
diff --git a/simple-git/test/integration/merge-integration.spec.ts b/simple-git/test/integration/merge-integration.spec.ts
@@ -11,7 +11,7 @@ import {
    setUpConflicted,
    setUpInit,
    SimpleGitTestContext,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 
 describe('merge', () => {
    let context: SimpleGitTestContext;
diff --git a/simple-git/test/integration/progress-plugin.spec.ts b/simple-git/test/integration/progress-plugin.spec.ts
@@ -1,4 +1,4 @@
-import { createTestContext, newSimpleGit, SimpleGitTestContext } from '../__fixtures__';
+import { createTestContext, newSimpleGit, SimpleGitTestContext } from '@simple-git/test-utils';
 import { SimpleGitOptions } from '../../src/lib/types';
 
 describe('progress-monitor', () => {
diff --git a/simple-git/test/integration/promise-from-root.spec.ts b/simple-git/test/integration/promise-from-root.spec.ts
@@ -1,4 +1,4 @@
-import { createTestContext, newSimpleGit, SimpleGitTestContext } from '../__fixtures__';
+import { createTestContext, newSimpleGit, SimpleGitTestContext } from '@simple-git/test-utils';
 
 describe('promises-from-root', () => {
    let context: SimpleGitTestContext;
diff --git a/simple-git/test/integration/promise.spec.ts b/simple-git/test/integration/promise.spec.ts
@@ -1,4 +1,9 @@
-import { createTestContext, newSimpleGit, setUpInit, SimpleGitTestContext } from '../__fixtures__';
+import {
+   createTestContext,
+   newSimpleGit,
+   setUpInit,
+   SimpleGitTestContext,
+} from '@simple-git/test-utils';
 
 import { InitSummary } from '../../src/lib/responses/InitSummary';
 import { StatusSummary } from '../../src/lib/responses/StatusSummary';
diff --git a/simple-git/test/integration/pull-fails-ff.spec.ts b/simple-git/test/integration/pull-fails-ff.spec.ts
@@ -6,7 +6,7 @@ import {
    newSimpleGit,
    setUpInit,
    SimpleGitTestContext,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 
 describe('pull --ff-only', () => {
    let context: SimpleGitTestContext;
diff --git a/simple-git/test/integration/remote.spec.ts b/simple-git/test/integration/remote.spec.ts
@@ -1,4 +1,9 @@
-import { createTestContext, newSimpleGit, setUpInit, SimpleGitTestContext } from '../__fixtures__';
+import {
+   createTestContext,
+   newSimpleGit,
+   setUpInit,
+   SimpleGitTestContext,
+} from '@simple-git/test-utils';
 
 describe('remote', () => {
    let context: SimpleGitTestContext;
diff --git a/simple-git/test/integration/reset.spec.ts b/simple-git/test/integration/reset.spec.ts
@@ -6,7 +6,7 @@ import {
    setUpFilesAdded,
    setUpInit,
    SimpleGitTestContext,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 
 import { ResetMode } from '../../src/lib/tasks/reset';
 
diff --git a/simple-git/test/integration/rev-parse.spec.ts b/simple-git/test/integration/rev-parse.spec.ts
@@ -4,7 +4,7 @@ import {
    setUpFilesAdded,
    setUpInit,
    SimpleGitTestContext,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 
 describe('rev-parse', () => {
    let context: SimpleGitTestContext;
diff --git a/simple-git/test/integration/status.spec.ts b/simple-git/test/integration/status.spec.ts
@@ -5,7 +5,7 @@ import {
    setUpFilesAdded,
    setUpInit,
    SimpleGitTestContext,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 
 describe('status', () => {
    let context: SimpleGitTestContext;
diff --git a/simple-git/test/integration/tag.spec.ts b/simple-git/test/integration/tag.spec.ts
@@ -5,7 +5,7 @@ import {
    setUpFilesAdded,
    setUpInit,
    SimpleGitTestContext,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 
 describe('tag', () => {
    let context: SimpleGitTestContext;
diff --git a/simple-git/test/integration/timeout-plugin.spec.ts b/simple-git/test/integration/timeout-plugin.spec.ts
@@ -4,7 +4,7 @@ import {
    createTestContext,
    newSimpleGit,
    SimpleGitTestContext,
-} from '../__fixtures__';
+} from '@simple-git/test-utils';
 
 import { GitPluginError } from '../..';
 
diff --git a/simple-git/test/unit/__fixtures__/child-processes.ts b/simple-git/test/unit/__fixtures__/child-processes.ts
@@ -1,5 +1,5 @@
 import { MockChildProcess, mockChildProcessModule } from '../__mocks__/mock-child-process';
-import { wait } from '../../__fixtures__';
+import { wait } from '@simple-git/test-utils';
 
 const EXIT_CODE_SUCCESS = 0;
 const EXIT_CODE_ERROR = 1;
diff --git a/simple-git/test/unit/__fixtures__/index.ts b/simple-git/test/unit/__fixtures__/index.ts
@@ -11,7 +11,4 @@ export * from './responses/merge';
 export * from './responses/remote-messages';
 export * from './responses/status';
 
-export * from '../../__fixtures__/expectations';
-export * from '../../__fixtures__/instance';
-export * from '../../__fixtures__/like';
-export * from '../../__fixtures__/wait';
+export * from '@simple-git/test-utils';
diff --git a/simple-git/test/unit/__mocks__/mock-child-process.ts b/simple-git/test/unit/__mocks__/mock-child-process.ts
diff --git a/simple-git/test/unit/apply-patch.spec.ts b/simple-git/test/unit/apply-patch.spec.ts
diff --git a/simple-git/test/unit/clean.spec.ts b/simple-git/test/unit/clean.spec.ts
diff --git a/simple-git/test/unit/completion-detection-plugin.spec.ts b/simple-git/test/unit/completion-detection-plugin.spec.ts
diff --git a/simple-git/test/unit/grep.spec.ts b/simple-git/test/unit/grep.spec.ts
diff --git a/simple-git/test/unit/logging.spec.ts b/simple-git/test/unit/logging.spec.ts
diff --git a/simple-git/tsconfig.json b/simple-git/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { simpleGit as newSimpleGit } from 'simple-git';`
	`2`	`+`
	`3`	`+export { newSimpleGit };`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { SimpleGitTestContext } from './create-test-context';`
	`1`	`+import { SimpleGitTestContext } from '../create-test-context';`
`2`	`2`
`3`	`3`	`export const FIRST_BRANCH = 'first';`
`4`	`4`	`export const SECOND_BRANCH = 'second';`