ncu-ci: replace --markdown with --copy

nodejs · joyeecheung · Jun 1, 2018 · Mar 20, 2018 · Jan 30, 2018 · May 31, 2018
commit ee5b43bd3719b39121e174ab0aa27aa0dead4f73
diff --git a/bin/ncu-ci b/bin/ncu-ci
@@ -5,6 +5,7 @@
 const {
   PRBuild, BenchmarkRun, CommitBuild, jobCache, parseJobFromURL, constants
 } = require('../lib/ci');
+const clipboardy = require('clipboardy');
 
 const {
   PR, COMMIT, BENCHMARK
@@ -70,17 +71,16 @@ const argv = yargs
     handler
   })
   .demandCommand(1, 'must provide a valid command')
-  .option('markdown', {
-    alias: 'm',
-    type: 'string',
-    describe: 'file to write results in markdown'
+  .option('copy', {
+    default: false,
+    describe: 'Write the results as markdown to clipboard'
   })
   .help()
   .argv;
 
 async function getResults(cli, request, job) {
   let build;
-  const { type, jobid, markdown } = job;
+  const { type, jobid } = job;
   if (type === PR) {
     build = new PRBuild(cli, request, jobid);
     await build.getResults();
@@ -94,12 +94,6 @@ async function getResults(cli, request, job) {
     yargs.showHelp();
     return;
   }
-
-  build.display();
-
-  if (markdown) {
-    build.appendToMarkdown(markdown);
-  }
   return build;
 }
 
@@ -135,7 +129,16 @@ async function main(command, argv) {
   }
 
   for (let job of queue) {
-    await getResults(cli, request, job);
+    const build = await getResults(cli, request, job);
+    build.display();
+
+    if (argv.copy) {
+      clipboardy.writeSync(build.formatAsMarkdown());
+    }
+
+    cli.separator('');
+    cli.log(`Written markdown to clipboard`);
+    return build;
   }
 }
 

diff --git a/lib/ci.js b/lib/ci.js
@@ -1,7 +1,6 @@
 'use strict';
 
 const Cache = require('./cache');
-const { appendFile } = require('./file');
 
 const qs = require('querystring');
 const chalk = require('chalk');
@@ -402,9 +401,9 @@ class CommitBuild extends Job {
     }
   }
 
-  appendToMarkdown(file) {
-    const { failures, cli } = this;
-    let output = this.jobUrl + '\n\n';
+  formatAsMarkdown() {
+    const { failures } = this;
+    let output = `Failures in job ${this.jobUrl} \n\n`;
     for (const failure of failures) {
       output += `#### [${getNodeName(failure.url)}](${failure.url})`;
       if (!failure.reason.includes('\n') && failure.reason.length < 20) {
@@ -414,9 +413,7 @@ class CommitBuild extends Job {
         output += fold('See failures', failure.reason) + '\n\n';
       }
     }
-    appendFile(file, output);
-    cli.separator('', SEP_LENGTH);
-    cli.log(`Written markdown to ${file}`);
+    return output;
   }
 }
 
@@ -452,8 +449,8 @@ class PRBuild extends Job {
     this.commitBuild.display();
   }
 
-  appendToMarkdown(file) {
-    this.commitBuild.appendToMarkdown(file);
+  formatAsMarkdown() {
+    return this.commitBuild.formatAsMarkdown();
   }
 }
 
@@ -722,14 +719,11 @@ class BenchmarkRun extends Job {
     cli.log(significantResults);
   }
 
-  appendToMarkdown(file) {
-    const { cli, results, significantResults } = this;
+  formatAsMarkdown() {
+    const { results, significantResults } = this;
     const output = (fold('Benchmark results', results) + '\n\n' +
                     fold('Significant impact', significantResults) + '\n');
-
-    appendFile(file, output);
-    cli.separator('', SEP_LENGTH);
-    cli.log(`Written markdown to ${file}`);
+    return output;
   }
 }
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -33,6 +33,7 @@
   "dependencies": {
     "chalk": "^2.3.1",
     "cheerio": "^1.0.0-rc.2",
+    "clipboardy": "^1.2.3",
     "core-validate-commit": "^3.5.0",
     "execa": "^0.10.0",
     "figures": "^2.0.0",

diff --git a/test/fixtures/jenkins/normal-failure/expected.md b/test/fixtures/jenkins/normal-failure/expected.md
@@ -1,4 +1,4 @@
-https://ci.nodejs.org/job/node-test-commit/17507/
+Failures in job https://ci.nodejs.org/job/node-test-commit/17507/ 
 
 #### [ppcle-ubuntu1404](https://ci.nodejs.org/job/node-test-commit-plinux/nodes=ppcle-ubuntu1404/16673/console)
 

diff --git a/test/unit/ci.test.js b/test/unit/ci.test.js
@@ -88,13 +88,11 @@ describe('Jenkins', () => {
     );
     assert.deepStrictEqual(prBuild.commitBuild.failures, expectedJson);
 
-    const actualPath = path.join(tmpdir.path, 'actual.md');
     const expectedPath = path.join(fixturesDir, 'expected.md');
 
-    commitBuild.appendToMarkdown(actualPath);
+    const markdown = commitBuild.formatAsMarkdown();
     const expected = fs.readFileSync(expectedPath, 'utf8');
-    const actual = fs.readFileSync(actualPath, 'utf8');
-    assert.strictEqual(actual, expected);
+    assert.strictEqual(markdown, expected);
   });
 
   it('should get benchmark run', async() => {
@@ -112,17 +110,10 @@ describe('Jenkins', () => {
     const run = new BenchmarkRun(cli, request, 150);
     await run.getResults();
 
-    const actualPath = path.join(tmpdir.path, 'actual.md');
     const expectedPath = path.join(fixturesDir, 'expected.md');
 
-    run.appendToMarkdown(actualPath);
-    let expected = fs.readFileSync(expectedPath, 'utf8');
-    let actual = fs.readFileSync(actualPath, 'utf8');
-    assert.strictEqual(actual, expected);
-
-    run.appendToMarkdown(actualPath);
-    expected += expected;
-    actual = fs.readFileSync(actualPath, 'utf8');
-    assert.strictEqual(actual, expected);
+    const markdown = run.formatAsMarkdown();
+    const expected = fs.readFileSync(expectedPath, 'utf8');
+    assert.strictEqual(markdown, expected);
   });
 });