Factor out global chai setup.

raineorshine · Sep 16, 2023 · d2c10b0 · d2c10b0
1 parent aed727c
commit d2c10b0
Show file tree

Hide file tree

Showing 40 changed files with 103 additions and 195 deletions.
diff --git a/test/bin.test.ts b/test/bin.test.ts
@@ -1,19 +1,13 @@
-import chai from 'chai'
-import chaiAsPromised from 'chai-as-promised'
-import chaiString from 'chai-string'
 import fs from 'fs/promises'
 import os from 'os'
 import path from 'path'
 import spawn from 'spawn-please'
 import { Index } from '../src/types/IndexType'
 import { Version } from '../src/types/Version'
+import chaiSetup from './helpers/chaiSetup'
 import stubNpmView from './helpers/stubNpmView'
 
-chai.should()
-chai.use(chaiAsPromised)
-chai.use(chaiString)
-
-process.env.NCU_TESTS = 'true'
+chaiSetup()
 
 const bin = path.join(__dirname, '../build/src/bin/cli.js')
 

diff --git a/test/cache.test.ts b/test/cache.test.ts
@@ -1,16 +1,13 @@
-import chai, { expect } from 'chai'
-import chaiString from 'chai-string'
+import { expect } from 'chai'
 import fs from 'fs/promises'
 import { rimraf } from 'rimraf'
 import ncu from '../src/'
 import { CACHE_DELIMITER, resolvedDefaultCacheFile } from '../src/lib/cache'
 import { CacheData } from '../src/types/Cacher'
+import chaiSetup from './helpers/chaiSetup'
 import stubNpmView from './helpers/stubNpmView'
 
-chai.should()
-chai.use(chaiString)
-
-process.env.NCU_TESTS = 'true'
+chaiSetup()
 
 describe('cache', () => {
   it('cache latest versions', async () => {

diff --git a/test/cli-options.test.ts b/test/cli-options.test.ts
@@ -1,7 +1,7 @@
-import chai from 'chai'
 import cliOptions from '../src/cli-options'
+import chaiSetup from './helpers/chaiSetup'
 
-chai.should()
+chaiSetup()
 
 describe('cli-options', () => {
   it('require long and description properties', () => {

diff --git a/test/deep.test.ts b/test/deep.test.ts
@@ -1,17 +1,14 @@
-import chai from 'chai'
-import chaiAsPromised from 'chai-as-promised'
+import { expect } from 'chai'
 import fs from 'fs/promises'
 import os from 'os'
 import path from 'path'
 import spawn from 'spawn-please'
 import ncu from '../src/'
 import mergeOptions from '../src/lib/mergeOptions'
+import chaiSetup from './helpers/chaiSetup'
 import stubNpmView from './helpers/stubNpmView'
 
-chai.should()
-chai.use(chaiAsPromised)
-
-process.env.NCU_TESTS = 'true'
+chaiSetup()
 
 const bin = path.join(__dirname, '../build/src/bin/cli.js')
 
@@ -220,7 +217,7 @@ describe('mergeOptions', function () {
       o1: Record<string, unknown> | null,
       o2: Record<string, unknown> | null,
       result: Record<string, unknown>,
-    ) => chai.expect(mergeOptions(o1, o2)).to.deep.equal(result)
+    ) => expect(mergeOptions(o1, o2)).to.deep.equal(result)
 
     // trivial cases
     eq(null, null, {})

diff --git a/test/dep.test.ts b/test/dep.test.ts
@@ -1,17 +1,11 @@
-import chai from 'chai'
-import chaiAsPromised from 'chai-as-promised'
-import chaiString from 'chai-string'
 import fs from 'fs/promises'
 import os from 'os'
 import path from 'path'
 import ncu from '../src/'
+import chaiSetup from './helpers/chaiSetup'
 import stubNpmView from './helpers/stubNpmView'
 
-chai.should()
-chai.use(chaiAsPromised)
-chai.use(chaiString)
-
-process.env.NCU_TESTS = 'true'
+chaiSetup()
 
 const packageData = JSON.stringify({
   dependencies: {

diff --git a/test/determinePackageManager.test.ts b/test/determinePackageManager.test.ts
@@ -1,7 +1,7 @@
-import chai from 'chai'
 import determinePackageManager from '../src/lib/determinePackageManager'
+import chaiSetup from './helpers/chaiSetup'
 
-chai.should()
+chaiSetup()
 
 const isWindows = process.platform === 'win32'
 

diff --git a/test/doctor.test.ts b/test/doctor.test.ts
@@ -1,6 +1,3 @@
-import chai from 'chai'
-import chaiAsPromised from 'chai-as-promised'
-import chaiString from 'chai-string'
 import fs from 'fs/promises'
 import os from 'os'
 import path from 'path'
@@ -9,13 +6,10 @@ import spawn from 'spawn-please'
 import { cliOptionsMap } from '../src/cli-options'
 import { chalkInit } from '../src/lib/chalk'
 import { PackageManagerName } from '../src/types/PackageManagerName'
+import chaiSetup from './helpers/chaiSetup'
 import stubNpmView from './helpers/stubNpmView'
 
-chai.should()
-chai.use(chaiAsPromised)
-chai.use(chaiString)
-
-process.env.NCU_TESTS = 'true'
+chaiSetup()
 
 const bin = path.join(__dirname, '../build/src/bin/cli.js')
 const doctorTests = path.join(__dirname, 'test-data/doctor')

diff --git a/test/enginesNode.test.ts b/test/enginesNode.test.ts
@@ -1,10 +1,9 @@
-import chai from 'chai'
 import ncu from '../src/'
 import { Index } from '../src/types/IndexType'
 import { VersionSpec } from '../src/types/VersionSpec'
+import chaiSetup from './helpers/chaiSetup'
 
-chai.should()
-process.env.NCU_TESTS = 'true'
+chaiSetup()
 
 describe('enginesNode', () => {
   it("update packages that satisfy the project's engines.node", async () => {

diff --git a/test/filter.test.ts b/test/filter.test.ts
@@ -1,15 +1,12 @@
-import chai from 'chai'
-import chaiAsPromised from 'chai-as-promised'
 import fs from 'fs/promises'
 import path from 'path'
 import spawn from 'spawn-please'
 import ncu from '../src'
 import { Index } from '../src/types/IndexType'
+import chaiSetup from './helpers/chaiSetup'
 import stubNpmView from './helpers/stubNpmView'
 
-chai.should()
-chai.use(chaiAsPromised)
-process.env.NCU_TESTS = 'true'
+chaiSetup()
 
 const bin = path.join(__dirname, '../build/src/bin/cli.js')
 

diff --git a/test/filterResults.test.ts b/test/filterResults.test.ts
@@ -1,15 +1,12 @@
-import chai, { expect } from 'chai'
-import chaiAsPromised from 'chai-as-promised'
-import chaiString from 'chai-string'
+import { expect } from 'chai'
 import fs from 'fs/promises'
 import os from 'os'
 import path from 'path'
 import ncu from '../src/'
+import chaiSetup from './helpers/chaiSetup'
 import stubNpmView from './helpers/stubNpmView'
 
-chai.should()
-chai.use(chaiAsPromised)
-chai.use(chaiString)
+chaiSetup()
 
 describe('filterResults', () => {
   it('should return only major versions updated', async () => {

diff --git a/test/filterVersion.test.ts b/test/filterVersion.test.ts
@@ -1,13 +1,10 @@
-import chai from 'chai'
-import chaiAsPromised from 'chai-as-promised'
 import path from 'path'
 import spawn from 'spawn-please'
 import ncu from '../src'
+import chaiSetup from './helpers/chaiSetup'
 import stubNpmView from './helpers/stubNpmView'
 
-chai.should()
-chai.use(chaiAsPromised)
-process.env.NCU_TESTS = 'true'
+chaiSetup()
 
 const bin = path.join(__dirname, '../build/src/bin/cli.js')
 

diff --git a/test/format.test.ts b/test/format.test.ts
@@ -1,15 +1,12 @@
-import chai, { expect } from 'chai'
-import chaiString from 'chai-string'
+import { expect } from 'chai'
 import fs from 'fs/promises'
 import os from 'os'
 import path from 'path'
 import spawn from 'spawn-please'
+import chaiSetup from './helpers/chaiSetup'
 import stubNpmView from './helpers/stubNpmView'
 
-chai.should()
-chai.use(chaiString)
-
-process.env.NCU_TESTS = 'true'
+chaiSetup()
 
 const bin = path.join(__dirname, '../build/src/bin/cli.js')
 

diff --git a/test/getAllPackages.test.ts b/test/getAllPackages.test.ts
@@ -1,12 +1,10 @@
-import chai from 'chai'
-import chaiAsPromised from 'chai-as-promised'
 import path from 'path'
 import getAllPackages from '../src/lib/getAllPackages'
 import { Options } from '../src/types/Options'
 import { PackageInfo } from '../src/types/PackageInfo'
+import chaiSetup from './helpers/chaiSetup'
 
-chai.should()
-chai.use(chaiAsPromised)
+chaiSetup()
 
 /** forces path to a posix version (windows-style) */
 function asPosixPath(filepath: string): string {

diff --git a/test/getCurrentDependencies.test.ts b/test/getCurrentDependencies.test.ts
@@ -1,9 +1,9 @@
-import chai from 'chai'
 import { SemVer } from 'semver-utils'
 import getCurrentDependencies from '../src/lib/getCurrentDependencies'
 import { PackageFile } from '../src/types/PackageFile'
+import chaiSetup from './helpers/chaiSetup'
 
-chai.should()
+chaiSetup()
 
 describe('getCurrentDependencies', () => {
   let deps: PackageFile

diff --git a/test/getIgnoredUpgrades.test.ts b/test/getIgnoredUpgrades.test.ts
@@ -1,8 +1,7 @@
-import chai from 'chai'
 import getIgnoredUpgrades from '../src/lib/getIgnoredUpgrades'
+import chaiSetup from './helpers/chaiSetup'
 
-chai.should()
-process.env.NCU_TESTS = 'true'
+chaiSetup()
 
 describe('getIgnoredUpgrades', function () {
   it('ncu-test-peer-update', async () => {

diff --git a/test/getPeerDependenciesFromRegistry.test.ts b/test/getPeerDependenciesFromRegistry.test.ts
@@ -1,9 +1,8 @@
-import chai from 'chai'
 import { chalkInit } from '../src/lib/chalk'
 import getPeerDependenciesFromRegistry from '../src/lib/getPeerDependenciesFromRegistry'
+import chaiSetup from './helpers/chaiSetup'
 
-chai.should()
-process.env.NCU_TESTS = 'true'
+chaiSetup()
 
 describe('getPeerDependenciesFromRegistry', function () {
   it('single package', async () => {

diff --git a/test/getPreferredWildcard.test.ts b/test/getPreferredWildcard.test.ts
@@ -1,8 +1,7 @@
-import chai from 'chai'
 import getPreferredWildcard from '../src/lib/getPreferredWildcard'
+import chaiSetup from './helpers/chaiSetup'
 
-const should = chai.should()
-process.env.NCU_TESTS = 'true'
+const should = chaiSetup()
 
 describe('getPreferredWildcard', () => {
   it('identify ^ when it is preferred', () => {

diff --git a/test/getRepoUrl.test.ts b/test/getRepoUrl.test.ts
@@ -1,7 +1,7 @@
-import chai from 'chai'
 import getRepoUrl from '../src/lib/getRepoUrl'
+import chaiSetup from './helpers/chaiSetup'
 
-const should = chai.should()
+const should = chaiSetup()
 
 describe('getRepoUrl', () => {
   it('return null if package is not installed', async () => {

diff --git a/test/github-urls.test.ts b/test/github-urls.test.ts
@@ -1,8 +1,7 @@
-import chai from 'chai'
 import ncu from '../src'
+import chaiSetup from './helpers/chaiSetup'
 
-chai.should()
-process.env.NCU_TESTS = 'true'
+chaiSetup()
 
 describe('github urls', () => {
   it('upgrade github https urls', async () => {

diff --git a/test/global.test.ts b/test/global.test.ts
@@ -1,7 +1,8 @@
 import path from 'path'
 import spawn from 'spawn-please'
+import chaiSetup from './helpers/chaiSetup'
 
-process.env.NCU_TESTS = 'true'
+chaiSetup()
 
 const bin = path.join(__dirname, '../build/src/bin/cli.js')
 

diff --git a/test/group.test.ts b/test/group.test.ts
@@ -1,16 +1,12 @@
-import chai from 'chai'
-import chaiAsPromised from 'chai-as-promised'
-import chaiString from 'chai-string'
 import fs from 'fs/promises'
 import os from 'os'
 import path from 'path'
 import spawn from 'spawn-please'
 import { GroupFunction } from '../src/types/GroupFunction'
+import chaiSetup from './helpers/chaiSetup'
 import stubNpmView from './helpers/stubNpmView'
 
-chai.should()
-chai.use(chaiAsPromised)
-chai.use(chaiString)
+chaiSetup()
 
 const bin = path.join(__dirname, '../build/src/bin/cli.js')
 

diff --git a/test/helpers/chaiSetup.ts b/test/helpers/chaiSetup.ts
@@ -0,0 +1,19 @@
+import chai from 'chai'
+import chaiAsPromised from 'chai-as-promised'
+import chaiString from 'chai-string'
+
+/** Global chai setup. */
+const chaiSetup = () => {
+  const should = chai.should()
+  chai.use(chaiAsPromised)
+  chai.use(chaiString)
+
+  // do not truncate strings in error messages
+  chai.config.truncateThreshold = 0
+
+  process.env.NCU_TESTS = 'true'
+
+  return should
+}
+
+export default chaiSetup
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -1,17 +1,11 @@
-import chai from 'chai'
-import chaiAsPromised from 'chai-as-promised'
-import chaiString from 'chai-string'
 import fs from 'fs/promises'
 import os from 'os'
 import path from 'path'
 import ncu from '../src/'
+import chaiSetup from './helpers/chaiSetup'
 import stubNpmView from './helpers/stubNpmView'
 
-chai.should()
-chai.use(chaiAsPromised)
-chai.use(chaiString)
-
-process.env.NCU_TESTS = 'true'
+chaiSetup()
 
 describe('run', function () {
   it('return jsonUpgraded by default', async () => {

diff --git a/test/install.test.ts b/test/install.test.ts
@@ -1,18 +1,15 @@
 /* eslint-disable no-unused-expressions */
 // eslint doesn't like .to.be.false syntax
-import chai, { expect } from 'chai'
-import chaiString from 'chai-string'
+import { expect } from 'chai'
 import fs from 'fs/promises'
 import os from 'os'
 import path from 'path'
 import spawn from 'spawn-please'
 import exists from '../src/lib/exists'
+import chaiSetup from './helpers/chaiSetup'
 import stubNpmView from './helpers/stubNpmView'
 
-chai.should()
-chai.use(chaiString)
-
-process.env.NCU_TESTS = 'true'
+chaiSetup()
 
 const bin = path.join(__dirname, '../build/src/bin/cli.js')