add homebrew publish to build/publish

Author: rose-m

packages/build/src/github-repo.ts

@@ -115,8 +115,9 @@ export class GithubRepo {
       .catch(this._ignoreAlreadyExistsError);
   }
 
-  // Creates release notes and uploads assets if they are not yet uploaded to
-  // Github.
+  /**
+   * Creates release notes and uploads assets if they are not yet uploaded to Github.
+   */
   async releaseToGithub(artifact: TarballFile, config: Config): Promise<void> {
     const tag = `v${config.version}`;
 
@@ -208,6 +209,27 @@ export class GithubRepo {
     return `https://jira.mongodb.org/issues/?jql=project%20%3D%20MONGOSH%20AND%20fixVersion%20%3D%20${version}`;
   }
 
+  async createPullRequest(title: string, fromBranch: string, toBaseBranch: string): Promise<{prNumber: number, url: string}> {
+    const response = await this.octokit.pulls.create({
+      ...this.repo,
+      base: toBaseBranch,
+      head: fromBranch,
+      title
+    });
+
+    return {
+      prNumber: response.data.number,
+      url: response.data.html_url
+    };
+  }
+
+  async mergePullRequest(prNumber: number): Promise<void> {
+    await this.octokit.pulls.merge({
+      ...this.repo,
+      pull_number: prNumber
+    });
+  }
+
   private _ignoreAlreadyExistsError(): (error: any) => Promise<void> {
     return (error: any): Promise<void> => {
       if (this._isAlreadyExistsError(error)) {

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

@@ -1,12 +1,5 @@
-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 {
+export function generateFormula(context: { version: string, sha: string }): string {
   return `require "language/node"
 
 class Mongosh < Formula

packages/build/src/homebrew/index.ts

@@ -0,0 +1,2 @@
+
+export * from './publish-to-homebrew';

packages/build/src/homebrew/publish-to-homebrew.ts

@@ -0,0 +1,27 @@
+import { GithubRepo } from '../github-repo';
+import { generateFormula } from './generate-formula';
+import { updateMongoDBTap } from './update-mongodb-tap';
+import { httpsSha256 } from './utils';
+
+const MONGO_HOMEBREW_REPO_URL = '[email protected]:mongodb/homebrew-brew.git';
+
+export async function publishToHomebrew(tmpDir: string, mongoHomebrewRepo: GithubRepo, packageVersion: string): Promise<void> {
+  const cliReplPackageUrl = `https://registry.npmjs.org/@mongosh/cli-repl/-/cli-repl-${packageVersion}.tgz`;
+  const packageSha = await httpsSha256(cliReplPackageUrl);
+
+  const homebrewFormula = generateFormula({ version: packageVersion, sha: packageSha });
+  const tapBranch = await updateMongoDBTap({
+    tmpDir, packageVersion, packageSha, homebrewFormula,
+    mongoHomebrewRepoUrl: MONGO_HOMEBREW_REPO_URL
+  });
+
+  if (!tapBranch) {
+    console.warn('There are no changes to the homebrew formula');
+    return;
+  }
+
+  const pr = await mongoHomebrewRepo.createPullRequest(`mongosh ${packageVersion}`, tapBranch, 'master');
+  console.info(`Created PR #${pr.prNumber} in mongodb/homebrew-brew: ${pr.url}`);
+  await mongoHomebrewRepo.mergePullRequest(pr.prNumber);
+  console.info('-> Merged, homebrew formula is released');
+}

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

@@ -30,7 +30,7 @@ describe('Homebrew update-mongodb-tap', () => {
       homebrewFormula: 'updated formula',
       mongoHomebrewRepoUrl: `file://${repoDir.path}`
     });
-    expect(updated).to.equal(true);
+    expect(updated).to.equal('mongosh-1.0.0-sha');
 
     execSync('git checkout mongosh-1.0.0-sha', { cwd: repoDir.path });
     expect(readFileSync(mongoshFormulaFile, 'utf-8')).to.equal('updated formula');
@@ -44,7 +44,7 @@ describe('Homebrew update-mongodb-tap', () => {
       homebrewFormula: 'formula',
       mongoHomebrewRepoUrl: `file://${repoDir.path}`
     });
-    expect(updated).to.equal(false);
+    expect(updated).to.equal(undefined);
 
     const branches = execSync('git branch -a', { cwd: repoDir.path }).toString().trim();
     expect(branches).to.equal('* master');

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

@@ -9,11 +9,15 @@ export interface UpdateMongoDBTapParameters {
     packageSha: string;
     homebrewFormula: string;
     tmpDir: string;
-    mongoHomebrewRepoUrl?: string;
+    mongoHomebrewRepoUrl: string;
 }
 
-export async function updateMongoDBTap(params: UpdateMongoDBTapParameters): Promise<boolean> {
-  const repoUrl = params.mongoHomebrewRepoUrl || '[email protected]:mongodb/homebrew-brew.git';
+/**
+ * Updates the mongosh formula in the given homebrew tap repository and returns the
+ * name of the branch pushed to the repository.
+ */
+export async function updateMongoDBTap(params: UpdateMongoDBTapParameters): Promise<string | undefined> {
+  const repoUrl = params.mongoHomebrewRepoUrl;
   const cloneDir = path.resolve(params.tmpDir, 'homebrew-brew');
   cloneRepository(cloneDir, repoUrl);
 
@@ -24,14 +28,13 @@ export async function updateMongoDBTap(params: UpdateMongoDBTapParameters): Prom
 
   const currentContent = await fs.readFile(formulaPath, 'utf-8');
   if (currentContent === params.homebrewFormula) {
-    console.warn('There are no changes to the homebrew formula');
-    return false;
+    return undefined;
   }
 
   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;
+  return branchName;
 }

packages/build/src/publish.spec.ts

@@ -1,12 +1,13 @@
-import { GithubRepo } from './github-repo';
-import publish from './publish';
 import chai, { expect } from 'chai';
-import Config from './config';
 import path from 'path';
 import sinon from 'ts-sinon';
 import type writeAnalyticsConfigType from './analytics';
-import type { publishNpmPackages as publishNpmPackagesType } from './npm-packages';
+import Config from './config';
 import type uploadDownloadCenterConfigType from './download-center';
+import { GithubRepo } from './github-repo';
+import type { publishToHomebrew as publishToHomebrewType } from './homebrew';
+import type { publishNpmPackages as publishNpmPackagesType } from './npm-packages';
+import publish from './publish';
 
 chai.use(require('sinon-chai'));
 
@@ -19,7 +20,9 @@ describe('publish', () => {
   let uploadDownloadCenterConfig: typeof uploadDownloadCenterConfigType;
   let publishNpmPackages: typeof publishNpmPackagesType;
   let writeAnalyticsConfig: typeof writeAnalyticsConfigType;
+  let publishToHomebrew: typeof publishToHomebrewType;
   let githubRepo: GithubRepo;
+  let mongoHomebrewRepo: GithubRepo;
 
   beforeEach(() => {
     config = {
@@ -55,7 +58,9 @@ describe('publish', () => {
     uploadDownloadCenterConfig = sinon.spy();
     publishNpmPackages = sinon.spy();
     writeAnalyticsConfig = sinon.spy();
+    publishToHomebrew = sinon.spy();
     githubRepo = createStubRepo();
+    mongoHomebrewRepo = createStubRepo();
   });
 
   context('if is a public release', () => {
@@ -69,9 +74,11 @@ describe('publish', () => {
       await publish(
         config,
         githubRepo,
+        mongoHomebrewRepo,
         uploadDownloadCenterConfig,
         publishNpmPackages,
-        writeAnalyticsConfig
+        writeAnalyticsConfig,
+        publishToHomebrew
       );
 
       expect(uploadDownloadCenterConfig).to.have.been.calledWith(
@@ -85,9 +92,11 @@ describe('publish', () => {
       await publish(
         config,
         githubRepo,
+        mongoHomebrewRepo,
         uploadDownloadCenterConfig,
         publishNpmPackages,
-        writeAnalyticsConfig
+        writeAnalyticsConfig,
+        publishToHomebrew
       );
 
       expect(githubRepo.promoteRelease).to.have.been.calledWith(config);
@@ -97,9 +106,11 @@ describe('publish', () => {
       await publish(
         config,
         githubRepo,
+        mongoHomebrewRepo,
         uploadDownloadCenterConfig,
         publishNpmPackages,
-        writeAnalyticsConfig
+        writeAnalyticsConfig,
+        publishToHomebrew
       );
 
       expect(writeAnalyticsConfig).to.have.been.calledOnceWith(
@@ -109,6 +120,24 @@ describe('publish', () => {
       expect(publishNpmPackages).to.have.been.calledWith();
       expect(publishNpmPackages).to.have.been.calledAfter(writeAnalyticsConfig as any);
     });
+    it('publishes to homebrew', async() => {
+      await publish(
+        config,
+        githubRepo,
+        mongoHomebrewRepo,
+        uploadDownloadCenterConfig,
+        publishNpmPackages,
+        writeAnalyticsConfig,
+        publishToHomebrew
+      );
+
+      expect(publishToHomebrew).to.have.been.calledWith(
+        path.resolve(config.rootDir, 'tmp'),
+        mongoHomebrewRepo,
+        config.version
+      );
+      expect(publishToHomebrew).to.have.been.calledAfter(githubRepo.promoteRelease as any);
+    });
   });
 
   context('if is not a public release', () => {
@@ -122,9 +151,11 @@ describe('publish', () => {
       await publish(
         config,
         githubRepo,
+        mongoHomebrewRepo,
         uploadDownloadCenterConfig,
         publishNpmPackages,
-        writeAnalyticsConfig
+        writeAnalyticsConfig,
+        publishToHomebrew
       );
 
       expect(uploadDownloadCenterConfig).not.to.have.been.called;
@@ -134,9 +165,11 @@ describe('publish', () => {
       await publish(
         config,
         githubRepo,
+        mongoHomebrewRepo,
         uploadDownloadCenterConfig,
         publishNpmPackages,
-        writeAnalyticsConfig
+        writeAnalyticsConfig,
+        publishToHomebrew
       );
 
       expect(githubRepo.promoteRelease).not.to.have.been.called;
@@ -146,12 +179,28 @@ describe('publish', () => {
       await publish(
         config,
         githubRepo,
+        mongoHomebrewRepo,
         uploadDownloadCenterConfig,
         publishNpmPackages,
-        writeAnalyticsConfig
+        writeAnalyticsConfig,
+        publishToHomebrew
       );
 
       expect(publishNpmPackages).not.to.have.been.called;
     });
+
+    it('does not publish to homebrew', async() => {
+      await publish(
+        config,
+        githubRepo,
+        mongoHomebrewRepo,
+        uploadDownloadCenterConfig,
+        publishNpmPackages,
+        writeAnalyticsConfig,
+        publishToHomebrew
+      );
+
+      expect(publishToHomebrew).not.to.have.been.called;
+    });
   });
 });

packages/build/src/publish.ts

@@ -1,31 +1,41 @@
-import { GithubRepo } from './github-repo';
-import Config from './config';
-import { redactConfig } from './redact-config';
+import path from 'path';
 import type writeAnalyticsConfigType from './analytics';
-import type { publishNpmPackages as publishNpmPackagesType } from './npm-packages';
+import Config from './config';
 import type uploadDownloadCenterConfigType from './download-center';
+import { GithubRepo } from './github-repo';
+import type { publishToHomebrew as publishToHomebrewType } from './homebrew';
+import type { publishNpmPackages as publishNpmPackagesType } from './npm-packages';
+import { redactConfig } from './redact-config';
 
 export default async function publish(
   config: Config,
-  githubRepo: GithubRepo,
+  mongoshGithubRepo: GithubRepo,
+  mongoHomebrewGithubRepo: GithubRepo,
   uploadDownloadCenterConfig: typeof uploadDownloadCenterConfigType,
   publishNpmPackages: typeof publishNpmPackagesType,
-  writeAnalyticsConfig: typeof writeAnalyticsConfigType
+  writeAnalyticsConfig: typeof writeAnalyticsConfigType,
+  publishToHomebrew: typeof publishToHomebrewType
 ): Promise<void> {
   console.info(
     'mongosh: beginning publish release with config:',
     redactConfig(config)
   );
 
-  if (!await githubRepo.shouldDoPublicRelease(config)) return;
+  if (!await mongoshGithubRepo.shouldDoPublicRelease(config)) return;
 
   await uploadDownloadCenterConfig(
     config.version,
     config.downloadCenterAwsKey || '',
     config.downloadCenterAwsSecret || ''
   );
 
-  await githubRepo.promoteRelease(config);
+  await mongoshGithubRepo.promoteRelease(config);
+
+  await publishToHomebrew(
+    path.resolve(config.rootDir, 'tmp'),
+    mongoHomebrewGithubRepo,
+    config.version
+  );
 
   // ensures the segment api key to be present in the published packages
   await writeAnalyticsConfig(