fix: refactor stubConsole and restoreConsole methods in repo-tools wi…

…th sinon dependency (#1600)

appengine/building-an-app/update/package.json

@@ -24,6 +24,7 @@
   },
   "devDependencies": {
     "@google-cloud/nodejs-repo-tools": "^3.3.0",
-    "mocha": "^7.0.0"
+    "mocha": "^7.0.0",
+    "sinon": "^8.0.0"
   }
 }

appengine/building-an-app/update/test/server.test.js

@@ -16,15 +16,34 @@
 const path = require('path');
 const assert = require('assert');
 const utils = require('@google-cloud/nodejs-repo-tools');
+const sinon = require('sinon');
 
 const cwd = path.join(__dirname, '../');
 const requestObj = utils.getRequest({
   cwd: cwd,
   cmd: 'server',
 });
 
-beforeEach(utils.stubConsole);
-afterEach(utils.restoreConsole);
+const stubConsole = function() {
+  sinon.stub(console, `error`);
+  sinon.stub(console, `log`).callsFake((a, b) => {
+    if (
+      typeof a === `string` &&
+      a.indexOf(`\u001b`) !== -1 &&
+      typeof b === `string`
+    ) {
+      console.log.apply(console, arguments);
+    }
+  });
+};
+
+const restoreConsole = function() {
+  console.log.restore();
+  console.error.restore();
+};
+
+beforeEach(stubConsole);
+afterEach(restoreConsole);
 
 it('should send greetings', async () => {
   await requestObj

appengine/cloudsql/test/createTables.test.js

@@ -18,7 +18,6 @@ const assert = require('assert');
 const path = require('path');
 const proxyquire = require('proxyquire').noPreserveCache();
 const sinon = require('sinon');
-const tools = require('@google-cloud/nodejs-repo-tools');
 
 const SAMPLE_PATH = path.join(__dirname, '../createTables.js');
 
@@ -57,8 +56,27 @@ const getSample = () => {
   };
 };
 
-beforeEach(tools.stubConsole);
-afterEach(tools.restoreConsole);
+const stubConsole = function() {
+  /* eslint-disable no-console */
+  sinon.stub(console, `error`);
+  sinon.stub(console, `log`).callsFake((a, b) => {
+    if (
+      typeof a === `string` &&
+      a.indexOf(`\u001b`) !== -1 &&
+      typeof b === `string`
+    ) {
+      console.log.apply(console, arguments);
+    }
+  });
+};
+
+const restoreConsole = function() {
+  console.log.restore();
+  console.error.restore();
+};
+
+beforeEach(stubConsole);
+afterEach(restoreConsole);
 
 describe('gae_flex_mysql_create_tables', () => {
   it('should create a table', async () => {

appengine/cloudsql/test/server.test.js

@@ -20,7 +20,6 @@ const proxyquire = require('proxyquire').noCallThru();
 const request = require('supertest');
 const sinon = require('sinon');
 const assert = require('assert');
-const tools = require('@google-cloud/nodejs-repo-tools');
 
 const SAMPLE_PATH = path.join(__dirname, '../server.js');
 
@@ -73,9 +72,6 @@ const getSample = () => {
   };
 };
 
-beforeEach(tools.stubConsole);
-afterEach(tools.restoreConsole);
-
 describe('gae_flex_mysql_connect', () => {
   it('should set up sample in Postgres', () => {
     const sample = getSample();

appengine/cloudsql_postgresql/test/createTables.test.js

@@ -18,7 +18,6 @@ const assert = require('assert');
 const path = require('path');
 const proxyquire = require('proxyquire').noPreserveCache();
 const sinon = require('sinon');
-const tools = require('@google-cloud/nodejs-repo-tools');
 
 const SAMPLE_PATH = path.join(__dirname, '../createTables.js');
 
@@ -57,8 +56,26 @@ const getSample = () => {
   };
 };
 
-beforeEach(tools.stubConsole);
-afterEach(tools.restoreConsole);
+const stubConsole = function() {
+  sinon.stub(console, `error`);
+  sinon.stub(console, `log`).callsFake((a, b) => {
+    if (
+      typeof a === `string` &&
+      a.indexOf(`\u001b`) !== -1 &&
+      typeof b === `string`
+    ) {
+      console.log.apply(console, arguments);
+    }
+  });
+};
+
+const restoreConsole = function() {
+  console.log.restore();
+  console.error.restore();
+};
+
+beforeEach(stubConsole);
+afterEach(restoreConsole);
 
 describe('gae_flex_postgres_create_tables', () => {
   it('should create a table', async () => {

appengine/cloudsql_postgresql/test/server.test.js

@@ -20,7 +20,6 @@ const proxyquire = require('proxyquire').noCallThru();
 const request = require('supertest');
 const sinon = require('sinon');
 const assert = require('assert');
-const tools = require('@google-cloud/nodejs-repo-tools');
 
 const SAMPLE_PATH = path.join(__dirname, '../server.js');
 
@@ -73,9 +72,6 @@ const getSample = () => {
   };
 };
 
-beforeEach(tools.stubConsole);
-afterEach(tools.restoreConsole);
-
 it('gae_flex_postgres_connect should set up sample in Postgres', () => {
   const sample = getSample();
 

appengine/endpoints/test/app.test.js

@@ -20,7 +20,6 @@ const proxyquire = require('proxyquire').noCallThru();
 const request = require('supertest');
 const sinon = require('sinon');
 const assert = require('assert');
-const tools = require('@google-cloud/nodejs-repo-tools');
 
 const SAMPLE_PATH = path.join(__dirname, '../app.js');
 
@@ -39,8 +38,16 @@ const getSample = () => {
   };
 };
 
-beforeEach(tools.stubConsole);
-afterEach(tools.restoreConsole);
+const stubConsole = function() {
+  sinon.stub(console, `error`);
+};
+
+const restoreConsole = function() {
+  console.error.restore();
+};
+
+beforeEach(stubConsole);
+afterEach(restoreConsole);
 
 it(`sets up the sample`, done => {
   const sample = getSample();

endpoints/getting-started/test/app.test.js

@@ -20,7 +20,6 @@ const proxyquire = require('proxyquire').noPreserveCache();
 const request = require('supertest');
 const sinon = require('sinon');
 const assert = require('assert');
-const tools = require('@google-cloud/nodejs-repo-tools');
 
 const SAMPLE_PATH = path.join(__dirname, '../app.js');
 
@@ -40,8 +39,17 @@ const getSample = () => {
   };
 };
 
-beforeEach(tools.stubConsole);
-afterEach(tools.restoreConsole);
+const stubConsole = function() {
+  sinon.stub(console, `error`);
+};
+
+//Restore console
+const restoreConsole = function() {
+  console.error.restore();
+};
+
+beforeEach(stubConsole);
+afterEach(restoreConsole);
 
 it('should echo a message', async () => {
   await request(getSample().app)

functions/firebase/test/index.test.js

@@ -17,7 +17,6 @@
 const proxyquire = require('proxyquire').noCallThru();
 const sinon = require('sinon');
 const assert = require('assert');
-const tools = require('@google-cloud/nodejs-repo-tools');
 
 const getSample = () => {
   const firestoreMock = {
@@ -35,8 +34,26 @@ const getSample = () => {
   };
 };
 
-beforeEach(tools.stubConsole);
-afterEach(tools.restoreConsole);
+const stubConsole = function() {
+  sinon.stub(console, `error`);
+  sinon.stub(console, `log`).callsFake((a, b) => {
+    if (
+      typeof a === `string` &&
+      a.indexOf(`\u001b`) !== -1 &&
+      typeof b === `string`
+    ) {
+      console.log.apply(console, arguments);
+    }
+  });
+};
+
+const restoreConsole = function() {
+  console.log.restore();
+  console.error.restore();
+};
+
+beforeEach(stubConsole);
+afterEach(restoreConsole);
 
 describe('functions_firebase_rtdb', () => {
   it('should listen to RTDB', () => {

functions/helloworld/test/index.test.js

@@ -201,12 +201,8 @@ describe('index.test.js', () => {
 
   describe('functions_helloworld_error', () => {
     describe('Error handling (unit tests)', () => {
-      // Silence dummy console calls in the samples
-      before(tools.stubConsole);
-      after(tools.restoreConsole);
-
       it('helloError: should throw an error', () => {
-        assert.throws(program.helloError, 'I failed you');
+        assert.throws(program.helloError, 'Error: I failed you');
       });
 
       it('helloError2: should throw a value', () => {

functions/helloworld/test/sample.unit.pubsub.test.js

@@ -17,11 +17,31 @@ describe('functions_helloworld_pubsub', () => {
   const assert = require('assert');
   const uuid = require('uuid');
   const utils = require('@google-cloud/nodejs-repo-tools');
+  const sinon = require('sinon');
 
   const {helloPubSub} = require('..');
 
-  beforeEach(utils.stubConsole);
-  afterEach(utils.restoreConsole);
+  const stubConsole = function() {
+    sinon.stub(console, `error`);
+    sinon.stub(console, `log`).callsFake((a, b) => {
+      if (
+        typeof a === `string` &&
+        a.indexOf(`\u001b`) !== -1 &&
+        typeof b === `string`
+      ) {
+        console.log('e');
+        console.log.apply(console, arguments);
+      }
+    });
+  };
+
+  const restoreConsole = function() {
+    console.log.restore();
+    console.error.restore();
+  };
+
+  beforeEach(stubConsole);
+  afterEach(restoreConsole);
 
   it('helloPubSub: should print a name', () => {
     // Create mock Pub/Sub event

functions/helloworld/test/sample.unit.storage.test.js

@@ -17,11 +17,31 @@ describe('functions_helloworld_storage', () => {
   const assert = require('assert');
   const uuid = require('uuid');
   const utils = require('@google-cloud/nodejs-repo-tools');
+  const sinon = require('sinon');
 
   const {helloGCS} = require('..');
 
-  beforeEach(utils.stubConsole);
-  afterEach(utils.restoreConsole);
+  const stubConsole = function() {
+    sinon.stub(console, `error`);
+    sinon.stub(console, `log`).callsFake((a, b) => {
+      if (
+        typeof a === `string` &&
+        a.indexOf(`\u001b`) !== -1 &&
+        typeof b === `string`
+      ) {
+        console.log('e');
+        console.log.apply(console, arguments);
+      }
+    });
+  };
+
+  const restoreConsole = function() {
+    console.log.restore();
+    console.error.restore();
+  };
+
+  beforeEach(stubConsole);
+  afterEach(restoreConsole);
 
   it('helloGCS: should print uploaded message', () => {
     // Initialize mocks

functions/http/test/index.test.js

@@ -18,7 +18,6 @@ const proxyquire = require('proxyquire').noCallThru();
 const sinon = require('sinon');
 const assert = require('assert');
 const uuid = require('uuid');
-const tools = require('@google-cloud/nodejs-repo-tools');
 
 const getSample = () => {
   const requestPromise = sinon
@@ -66,8 +65,16 @@ const getMocks = () => {
   };
 };
 
-beforeEach(tools.stubConsole);
-afterEach(tools.restoreConsole);
+const stubConsole = function() {
+  sinon.stub(console, `error`);
+};
+
+const restoreConsole = function() {
+  console.error.restore();
+};
+
+beforeEach(stubConsole);
+afterEach(restoreConsole);
 
 describe('functions_http_method', () => {
   it('http:helloHttp: should handle GET', () => {

functions/imagemagick/test/index.test.js

@@ -15,10 +15,10 @@
 'use strict';
 
 const assert = require('assert');
-const tools = require('@google-cloud/nodejs-repo-tools');
 const execPromise = require('child-process-promise').exec;
 const path = require('path');
 const {Storage} = require('@google-cloud/storage');
+const sinon = require('sinon');
 
 const storage = new Storage();
 
@@ -83,8 +83,16 @@ describe('functions/imagemagick tests', () => {
     };
   });
 
-  beforeEach(tools.stubConsole);
-  afterEach(tools.restoreConsole);
+  const stubConsole = function() {
+    sinon.stub(console, `error`);
+  };
+
+  const restoreConsole = function() {
+    console.error.restore();
+  };
+
+  beforeEach(stubConsole);
+  afterEach(restoreConsole);
 
   describe('functions_imagemagick_analyze', () => {
     it('blurOffensiveImages detects safe images using Cloud Vision', async () => {