chore(build): refactor tarball creation to packaging MONGOSH-630 (#709)

Author: rose-m

packages/build/src/compile/run-compile.ts

@@ -1,4 +1,4 @@
-import type { PackageInformation } from '../tarball';
+import type { PackageInformation } from '../packaging/package';
 import { generateBundle } from './generate-bundle';
 import { SignableCompiler } from './signable-compiler';
 

packages/build/src/compile/signable-compiler.ts

@@ -6,7 +6,7 @@ import path from 'path';
 import childProcess from 'child_process';
 import { once } from 'events';
 import { Platform } from '../config';
-import type { PackageInformation } from '../tarball';
+import type { PackageInformation } from '../packaging/package';
 import { compileJSFileAsBinary } from 'boxednode';
 
 async function preCompileHook(nodeSourceTree: string) {

packages/build/src/config/config.ts

@@ -1,4 +1,4 @@
-import type { PackageInformation } from '../tarball';
+import type { PackageInformation } from '../packaging/package';
 import { BuildVariant } from './build-variant';
 
 /**

packages/build/src/download-mongodb.ts

@@ -1,4 +1,5 @@
 /* eslint-disable camelcase, complexity, @typescript-eslint/no-non-null-assertion, no-return-assign, no-empty */
+/* istanbul ignore file */
 import fetch from 'node-fetch';
 import semver from 'semver';
 import { promisify } from 'util';

packages/build/src/package/index.ts

@@ -1,3 +1,4 @@
+/* istanbul ignore file */
 import path from 'path';
 import { promises as fs, constants as fsConstants } from 'fs';
 import { downloadMongoDb } from '../download-mongodb';

packages/build/src/package/download-mongocryptd.ts renamed to packages/build/src/packaging/download-mongocryptd.ts

@@ -0,0 +1,7 @@
+export * from './run-package';
+
+export {
+  getPackageFile,
+  PackageFile,
+  PackageInformation
+} from './package';

packages/build/src/packaging/index.ts

@@ -0,0 +1,63 @@
+import { expect } from 'chai';
+import sinon from 'sinon';
+import { Config } from '../config';
+import { macOSSignAndNotarize } from './macos-sign';
+
+describe('packaging macos-sign', () => {
+  describe('macOSSignAndNotarize', () => {
+    let config: Config;
+    let signStub: sinon.SinonStub;
+    let notarizeStub: sinon.SinonStub;
+    let runCreatePackageStub: sinon.SinonStub;
+
+    before(() => {
+      config = {
+        appleCodesignIdentity: 'signingIdentity',
+        appleCodesignEntitlementsFile: 'entitlementsFile',
+        appleNotarizationBundleId: 'bundleId',
+        appleNotarizationUsername: 'username',
+        appleNotarizationApplicationPassword: 'password'
+      } as Config;
+
+      signStub = sinon.stub().resolves();
+      notarizeStub = sinon.stub().resolves();
+      runCreatePackageStub = sinon.stub().resolves({
+        path: 'package/path',
+        contentType: 'pkg'
+      });
+    });
+
+    context('processes the package', () => {
+      before(async() => {
+        await macOSSignAndNotarize(
+          [
+            'executable1', 'executable2'
+          ],
+          config,
+          runCreatePackageStub,
+          signStub,
+          notarizeStub
+        );
+      });
+
+      it('signs all executables', () => {
+        expect(signStub).to.have.been.calledTwice;
+        expect(signStub).to.have.been.calledWith('executable1', config.appleCodesignIdentity, config.appleCodesignEntitlementsFile);
+        expect(signStub).to.have.been.calledWith('executable2', config.appleCodesignIdentity, config.appleCodesignEntitlementsFile);
+      });
+
+      it('creates the package', () => {
+        expect(runCreatePackageStub).to.have.been.called;
+      });
+
+      it('notarizes the package', () => {
+        expect(notarizeStub).to.have.been.calledWith(
+          config.appleNotarizationBundleId,
+          'package/path',
+          config.appleNotarizationUsername,
+          config.appleNotarizationApplicationPassword
+        );
+      });
+    });
+  });
+});

packages/build/src/packaging/macos-sign.spec.ts

@@ -2,20 +2,22 @@ import { notarize as nodeNotarize } from 'electron-notarize';
 import codesign from 'node-codesign';
 import util from 'util';
 import { Config } from '../config';
-import { TarballFile } from '../tarball';
+import { PackageFile } from './package';
 
 export async function macOSSignAndNotarize(
   executables: string[],
   config: Config,
-  runCreateTarball: () => Promise<TarballFile>
-): Promise<TarballFile> {
+  runCreatePackage: () => Promise<PackageFile>,
+  signFn: typeof sign = sign,
+  notarizeFn: typeof notarize = notarize,
+): Promise<PackageFile> {
   for (const executable of executables) {
     console.info('mongosh: signing:', executable);
-    await sign(executable, config.appleCodesignIdentity || '', config.appleCodesignEntitlementsFile || '');
+    await signFn(executable, config.appleCodesignIdentity || '', config.appleCodesignEntitlementsFile || '');
   }
-  const artifact = await runCreateTarball();
+  const artifact = await runCreatePackage();
   console.info('mongosh: notarizing and creating tarball:', artifact.path);
-  await notarize(
+  await notarizeFn(
     config.appleNotarizationBundleId || '',
     artifact.path,
     config.appleNotarizationUsername || '',

packages/build/src/package/macos-sign.ts renamed to packages/build/src/packaging/macos-sign.ts

@@ -0,0 +1,51 @@
+import { expect } from 'chai';
+import sinon from 'sinon';
+import { withTempPackageEach } from '../../../test/helpers';
+import { ALL_BUILD_VARIANTS } from '../../config';
+import { createPackage } from './create-package';
+
+describe('archive create-archive', () => {
+  describe('can create an archive for all build variants', () => {
+    const tmpPkg = withTempPackageEach();
+
+    let createPosixArchiveStub: sinon.SinonStub;
+    let createRedhatArchiveStub: sinon.SinonStub;
+    let createDebianArchiveStub: sinon.SinonStub;
+    let createMSIArchiveStub:sinon.SinonStub;
+    let createZipArchiveStub:sinon.SinonStub;
+
+    beforeEach(() => {
+      createPosixArchiveStub = sinon.stub();
+      createRedhatArchiveStub = sinon.stub();
+      createDebianArchiveStub = sinon.stub();
+      createMSIArchiveStub = sinon.stub();
+      createZipArchiveStub = sinon.stub();
+    });
+
+    ALL_BUILD_VARIANTS.forEach(variant => {
+      it(`can create a tarball for ${variant}`, async() => {
+        const result = await createPackage(
+          tmpPkg.tarballDir,
+          variant,
+          tmpPkg.pkgConfig,
+          createPosixArchiveStub,
+          createRedhatArchiveStub,
+          createDebianArchiveStub,
+          createMSIArchiveStub,
+          createZipArchiveStub
+        );
+        expect(result).to.not.be.undefined;
+      });
+    });
+
+    it('throws an error for an unknown variant', async() => {
+      try {
+        await createPackage(tmpPkg.tarballDir, 'nope' as any, tmpPkg.pkgConfig);
+      } catch (e) {
+        expect(e).to.not.be.undefined;
+        return;
+      }
+      expect.fail('Expected error');
+    });
+  });
+});