chore: migrate core/common tests to jest

Author: pearigee

core/common/.gitignore

@@ -1,7 +1,6 @@
 **/*.log
 **/node_modules
-.coverage
-.nyc_output
+coverage/
 docs/
 out/
 system-test/secrets.js

core/common/.mocharc.js

@@ -0,0 +1,17 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['<rootDir>/test/*.ts'],
+  testPathIgnorePatterns: ['/node_modules/', '/build/'],
+  collectCoverage: true,
+  coverageDirectory: 'coverage',
+  coverageReporters: ['text', 'lcov'],
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        tsconfig: 'tsconfig.json',
+      },
+    ],
+  },
+};

core/common/.nycrc

@@ -0,0 +1,14 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['<rootDir>/system-test/*.ts'],
+  testPathIgnorePatterns: ['/node_modules/', '/build/'],
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        tsconfig: 'tsconfig.json',
+      },
+    ],
+  },
+};

core/common/jest.config.js

@@ -20,18 +20,16 @@
   ],
   "scripts": {
     "docs": "jsdoc -c .jsdoc.js",
-    "test": "c8 mocha build/test",
+    "test": "node --experimental-vm-modules node_modules/.bin/jest",
     "prepare": "npm run compile",
     "pretest": "npm run compile",
     "compile": "tsc -p .",
     "fix": "gts fix",
     "lint": "gts check",
     "presystem-test": "npm run compile",
-    "system-test": "mocha build/system-test",
-    "samples-test": "cd samples/ && npm link ../ && npm test && cd ../",
+    "system-test": "node --experimental-vm-modules node_modules/.bin/jest --config jest.config.system.js --runInBand",
     "docs-test": "linkinator docs",
     "predocs-test": "npm run docs",
-    "prelint": "cd samples; npm link ../; npm install",
     "clean": "gts clean",
     "precompile": "gts clean"
   },
@@ -49,28 +47,23 @@
   "devDependencies": {
     "@types/ent": "^2.2.8",
     "@types/extend": "^3.0.4",
-    "@types/mocha": "^10.0.10",
+    "@types/jest": "^29.5.12",
     "@types/mv": "^2.1.4",
     "@types/ncp": "^2.0.8",
     "@types/node": "^22.13.5",
-    "@types/proxyquire": "^1.3.31",
     "@types/request": "^2.48.12",
-    "@types/sinon": "^17.0.4",
     "@types/tmp": "^0.2.6",
-    "c8": "^10.1.3",
-    "codecov": "^3.8.3",
     "gts": "^6.0.2",
+    "jest": "^29.7.0",
     "jsdoc": "^4.0.4",
     "jsdoc-fresh": "^3.0.0",
     "jsdoc-region-tag": "^3.0.0",
     "linkinator": "^6.1.2",
-    "mocha": "^11.1.0",
     "mv": "^2.1.1",
     "ncp": "^2.0.0",
     "nock": "^14.0.1",
-    "proxyquire": "^2.1.3",
-    "sinon": "^19.0.2",
     "tmp": "^0.2.3",
+    "ts-jest": "^29.2.5",
     "typescript": "^5.8.2"
   },
   "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/core/common"

core/common/jest.config.system.js

@@ -12,31 +12,53 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import {before, describe, it} from 'mocha';
-import * as assert from 'assert';
 import * as http from 'http';
-
 import * as common from '../src';
+import {util} from '../src/util';
 
 describe('Common', () => {
   const MOCK_HOST_PORT = 8118;
   const MOCK_HOST = `http://localhost:${MOCK_HOST_PORT}`;
 
   describe('Service', () => {
     let service: common.Service;
+    let mockServer: http.Server | undefined;
+
+    beforeAll(() => {
+      jest.spyOn(util, 'makeAuthenticatedRequestFactory').mockImplementation((config: any) => {
+        const makeAuthenticatedRequest: any = (reqOpts: any, callback: any) => {
+          if (typeof callback === 'function') {
+            return util.makeRequest(reqOpts, config, callback);
+          }
+          return util.makeRequest(reqOpts, config, () => {});
+        };
+        makeAuthenticatedRequest.authClient = {
+            getProjectId: async () => 'project-id'
+        };
+        return makeAuthenticatedRequest;
+      });
 
-    before(() => {
       service = new common.Service({
         baseUrl: MOCK_HOST,
         apiEndpoint: MOCK_HOST,
         scopes: [],
         packageJson: {name: 'tests', version: '1.0.0'},
+        projectIdRequired: false,
       });
     });
 
+    afterEach(done => {
+      if (mockServer) {
+        mockServer.close(() => done());
+        mockServer = undefined;
+      } else {
+        done();
+      }
+    });
+
     it('should send a request and receive a response', done => {
       const mockResponse = 'response';
-      const mockServer = new http.Server((req, res) => {
+      mockServer = new http.Server((req, res) => {
         res.end(mockResponse);
       });
 
@@ -47,19 +69,21 @@ describe('Common', () => {
           uri: '/mock-endpoint',
         },
         (err, resp) => {
-          assert.ifError(err);
-          assert.strictEqual(resp, mockResponse);
-          mockServer.close(done);
+          try {
+            expect(err).toBeNull();
+            expect(resp).toBe(mockResponse);
+            done();
+          } catch (e) {
+            done(e);
+          }
         },
       );
     });
 
-    it('should retry a request', function (done) {
-      this.timeout(60 * 1000);
-
+    it('should retry a request', done => {
       let numRequestAttempts = 0;
 
-      const mockServer = new http.Server((req, res) => {
+      mockServer = new http.Server((req, res) => {
         numRequestAttempts++;
         res.statusCode = 408;
         res.end();
@@ -70,18 +94,21 @@ describe('Common', () => {
       service.request(
         {
           uri: '/mock-endpoint-retry',
+          maxRetries: 4,
         },
         err => {
-          assert.strictEqual((err! as common.ApiError).code, 408);
-          assert.strictEqual(numRequestAttempts, 4);
-          mockServer.close(done);
+          try {
+            expect((err! as common.ApiError).code).toBe(408);
+            expect(numRequestAttempts).toBe(4);
+            done();
+          } catch (e) {
+            done(e);
+          }
         },
       );
-    });
-
-    it('should retry non-responsive hosts', function (done) {
-      this.timeout(60 * 1000);
+    }, 60000);
 
+    it('should retry non-responsive hosts', done => {
       function getMinimumRetryDelay(retryNumber: number) {
         return Math.pow(2, retryNumber) * 1000;
       }
@@ -100,12 +127,16 @@ describe('Common', () => {
           uri: '/mock-endpoint-no-response',
         },
         err => {
-          assert(err?.message.includes('ECONNREFUSED'));
-          const timeResponse = Date.now();
-          assert(timeResponse - timeRequest > minExpectedResponseTime);
-          done();
+          try {
+            expect(err?.message).toMatch(/ECONNREFUSED|ENOTFOUND|failed, reason:/);
+            const timeResponse = Date.now();
+            expect(timeResponse - timeRequest).toBeGreaterThan(minExpectedResponseTime);
+            done();
+          } catch (e) {
+            done(e);
+          }
         },
       );
-    });
+    }, 60000);
   });
 });

core/common/package.json

@@ -18,15 +18,14 @@ import {ncp} from 'ncp';
 import * as os from 'os';
 import * as tmp from 'tmp';
 import {promisify} from 'util';
-import {describe, it, after} from 'mocha';
 
-const mvp = promisify(mv) as {} as (...args: string[]) => Promise<void>;
+const mvp = promisify(mv) as any as (...args: string[]) => Promise<void>;
 const ncpp = promisify(ncp);
 const keep = !!process.env.KEEP_TEMPDIRS;
 const stagingDir = tmp.dirSync({keep, unsafeCleanup: true});
 const stagingPath = stagingDir.name;
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const pkg = require('../../package.json');
+const pkg = require('../package.json');
 const pkgName = 'google-cloud-common';
 const npm = os.platform() === 'win32' ? 'npm.cmd' : 'npm';
 
@@ -62,12 +61,12 @@ describe('install tests', () => {
     await mvp(tarball, `${stagingPath}/${pkgName}.tgz`);
     await ncpp('system-test/fixtures/kitchen', `${stagingPath}/`);
     await spawnp(npm, ['install'], {cwd: `${stagingPath}/`});
-  }).timeout(120000);
+  }, 120000);
 
   /**
    * CLEAN UP - remove the staging directory when done.
    */
-  after('cleanup staging', async () => {
+  afterAll(async () => {
     if (!keep) {
       stagingDir.removeCallback();
     }

core/common/system-test/common.ts

@@ -12,15 +12,13 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import * as assert from 'assert';
-import {describe, it} from 'mocha';
 import {Operation, Service, ServiceObject, util} from '../src';
 
 describe('common', () => {
   it('should correctly export the common modules', () => {
-    assert(Operation);
-    assert(Service);
-    assert(ServiceObject);
-    assert(util);
+    expect(Operation).toBeDefined();
+    expect(Service).toBeDefined();
+    expect(ServiceObject).toBeDefined();
+    expect(util).toBeDefined();
   });
 });