create new homebrew package scripts

Author: rose-m

packages/build/src/homebrew/generate-formula.ts

@@ -0,0 +1,35 @@
+import { httpsSha256 } from './utils';
+
+export async function generateHomebrewFormula(version: string): Promise<string> {
+  const url = `https://registry.npmjs.org/@mongosh/cli-repl/-/cli-repl-${version}.tgz`;
+  const sha = await httpsSha256(url);
+  return renderFormula({ version, sha });
+}
+
+function renderFormula(context: { version: string, sha: string }): string {
+  return `require "language/node"
+
+class Mongosh < Formula
+  desc "The MongoDB Shell"
+
+  homepage "https://github.com/mongodb-js/mongosh#readme"
+  url "https://registry.npmjs.org/@mongosh/cli-repl/-/cli-repl-${context.version}.tgz"
+  version "${context.version}"
+
+  # This is the checksum of the archive. Can be obtained with:
+  # curl -s https://registry.npmjs.org/@mongosh/cli-repl/-/cli-repl-${context.version}.tgz | shasum -a 256
+  sha256 "${context.sha}"
+
+  depends_on "node@14"
+
+  def install
+    system "#{Formula["node@14"].bin}/npm", "install", *Language::Node.std_npm_install_args(libexec)
+    (bin/"mongosh").write_env_script libexec/"bin/mongosh", :PATH => "#{Formula["node@14"].opt_bin}:$PATH"
+  end
+
+  test do
+    system "#{bin}/mongosh --version"
+  end
+end
+`;
+}

packages/build/src/homebrew/index.ts

@@ -0,0 +1,52 @@
+import { execSync } from 'child_process';
+import { readFileSync, writeFileSync } from 'fs-extra';
+import path from 'path';
+import { expect, useTmpdir } from '../../../cli-repl/test/repl-helpers';
+import { updateMongoDBTap } from './update-mongodb-tap';
+
+describe('Homebrew update-mongodb-tap', () => {
+  const repoDir = useTmpdir();
+  const tmpDir = useTmpdir();
+
+  let mongoBrewFormulaDir: string;
+  let mongoshFormulaFile: string;
+
+  beforeEach(() => {
+    execSync('git init', { cwd: repoDir.path });
+
+    mongoBrewFormulaDir = path.resolve(repoDir.path, 'Formula');
+    mongoshFormulaFile = path.resolve(mongoBrewFormulaDir, 'mongosh.rb');
+
+    execSync(`mkdir -p ${mongoBrewFormulaDir}`);
+    writeFileSync(mongoshFormulaFile, 'formula', 'utf-8');
+    execSync('git add . && git commit -m "add mongosh formula"', { cwd: repoDir.path });
+  });
+
+  it('writes updated formula and pushes changes', async() => {
+    const updated = await updateMongoDBTap({
+      tmpDir: tmpDir.path,
+      packageVersion: '1.0.0',
+      packageSha: 'sha',
+      homebrewFormula: 'updated formula',
+      mongoHomebrewRepoUrl: `file://${repoDir.path}`
+    });
+    expect(updated).to.equal(true);
+
+    execSync('git checkout mongosh-1.0.0-sha', { cwd: repoDir.path });
+    expect(readFileSync(mongoshFormulaFile, 'utf-8')).to.equal('updated formula');
+  });
+
+  it('does not push changes if formula is same', async() => {
+    const updated = await updateMongoDBTap({
+      tmpDir: tmpDir.path,
+      packageVersion: '1.0.0',
+      packageSha: 'sha',
+      homebrewFormula: 'formula',
+      mongoHomebrewRepoUrl: `file://${repoDir.path}`
+    });
+    expect(updated).to.equal(false);
+
+    const branches = execSync('git branch -a', { cwd: repoDir.path }).toString().trim();
+    expect(branches).to.equal('* master');
+  });
+});

packages/build/src/homebrew/update-mongodb-tap.spec.ts

@@ -0,0 +1,37 @@
+import { execSync } from 'child_process';
+import { version } from 'os';
+import path from 'path';
+import { promises as fs } from 'fs';
+import { cloneRepository } from './utils';
+
+export interface UpdateMongoDBTapParameters {
+    packageVersion: string;
+    packageSha: string;
+    homebrewFormula: string;
+    tmpDir: string;
+    mongoHomebrewRepoUrl?: string;
+}
+
+export async function updateMongoDBTap(params: UpdateMongoDBTapParameters): Promise<boolean> {
+  const repoUrl = params.mongoHomebrewRepoUrl || '[email protected]:mongodb/homebrew-brew.git';
+  const cloneDir = path.resolve(params.tmpDir, 'homebrew-brew');
+  cloneRepository(cloneDir, repoUrl);
+
+  const branchName = `mongosh-${params.packageVersion}-${params.packageSha}`;
+  execSync(`git checkout -b ${branchName}`, { cwd: cloneDir, stdio: 'inherit' });
+
+  const formulaPath = path.resolve(cloneDir, 'Formula', 'mongosh.rb');
+
+  const currentContent = await fs.readFile(formulaPath, 'utf-8');
+  if (currentContent === params.homebrewFormula) {
+    console.warn('There are no changes to the homebrew formula');
+    return false;
+  }
+
+  await fs.writeFile( formulaPath, params.homebrewFormula, 'utf-8');
+
+  execSync('git add .', { cwd: cloneDir, stdio: 'inherit' });
+  execSync(`git commit -m "mongosh ${version}"`, { cwd: cloneDir, stdio: 'inherit' });
+  execSync(`git push origin ${branchName}`, { cwd: cloneDir, stdio: 'inherit' });
+  return true;
+}

packages/build/src/homebrew/update-mongodb-tap.ts

@@ -0,0 +1,26 @@
+import { execSync } from 'child_process';
+import { expect, useTmpdir } from '../../../cli-repl/test/repl-helpers';
+import { cloneRepository } from './utils';
+
+describe('Homebrew Utils', () => {
+  const repoDir = useTmpdir();
+  const tmpDir = useTmpdir();
+
+  beforeEach(() => {
+    execSync('git init', { cwd: repoDir.path });
+    execSync('touch empty.txt', { cwd: repoDir.path });
+    execSync('git add . && git commit -m "commit1"', { cwd: repoDir.path });
+    execSync('touch another.txt', { cwd: repoDir.path });
+    execSync('git add . && git commit -m "commit2"', { cwd: repoDir.path });
+  });
+
+  describe('cloneRepository', () => {
+    it('clones shallow as requested', () => {
+      cloneRepository(tmpDir.path, `file://${repoDir.path}`);
+      const output = execSync('git log -2 --oneline', { cwd: tmpDir.path }).toString();
+      const lines = output.split('\n').filter(l => !!l);
+      expect(lines.length).to.equal(1);
+      expect(lines[0]).to.match(/ commit2$/);
+    });
+  });
+});

packages/build/src/homebrew/utils.spec.ts

@@ -0,0 +1,19 @@
+import { execSync } from 'child_process';
+import crypto from 'crypto';
+import https from 'https';
+
+export function httpsSha256(url: string): Promise<string> {
+  return new Promise((resolve, reject) => {
+    https.get(url, (stream) => {
+      const hash = crypto.createHash('sha256');
+      stream.on('error', err => reject(err));
+      stream.on('data', chunk => hash.update(chunk));
+      stream.on('end', () => resolve(hash.digest('hex')));
+    });
+  });
+}
+
+export function cloneRepository(cloneDir: string, repositoryUrl: string): void {
+  execSync(`git clone "${repositoryUrl}" "${cloneDir}" --depth 1`, { stdio: 'inherit' });
+}
+

packages/build/src/homebrew/utils.ts

@@ -17,11 +17,15 @@ chai.use(chaiAsPromised);
 // to wait for these to finish.
 const tick = promisify(setImmediate);
 
+// We keep an additional index as we might create two temp directories
+// at the same time stamp leading to conflicts
+let tmpDirsIndex = 1;
+
 function useTmpdir(): { readonly path: string } {
   let tmpdir: string;
 
   beforeEach(async() => {
-    tmpdir = path.resolve(__dirname, '..', '..', '..', 'tmp', 'test', `repltest-${Date.now()}`);
+    tmpdir = path.resolve(__dirname, '..', '..', '..', 'tmp', 'test', `repltest-${Date.now()}-${tmpDirsIndex++}`);
     await fs.mkdir(tmpdir, { recursive: true });
   });