refactor: drop dependency on execa (#131)

Author: JustinBeckwith

security-center/snippets/package.json

@@ -13,7 +13,6 @@
   },
   "devDependencies": {
     "chai": "^4.2.0",
-    "execa": "^1.0.0",
     "mocha": "^6.0.2"
   }
 }

security-center/snippets/system-test/.eslintrc.yml

@@ -3,4 +3,3 @@ env:
   mocha: true
 rules:
   node/no-unpublished-require: off
-  no-empty: off

security-center/snippets/system-test/v1/assetSecurityMarks.test.js

@@ -1,4 +1,4 @@
-// Copyright 2019 Google LLC
+// Copyright 2019, Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -11,19 +11,19 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+
 'use strict';
 
+const {SecurityCenterClient} = require('@google-cloud/security-center');
 const {assert} = require('chai');
-const execa = require('execa');
-const exec = async cmd => (await execa.shell(cmd)).stdout;
+const {execSync} = require('child_process');
+const exec = cmd => execSync(cmd, {encoding: 'utf8'});
 
 const organizationId = process.env['GCLOUD_ORGANIZATION'];
 
 describe('client with security marks for assets', async () => {
   let data;
   before(async () => {
-    const {SecurityCenterClient} = require('@google-cloud/security-center');
-
     // Creates a new client.
     const client = new SecurityCenterClient();
 
@@ -39,53 +39,47 @@ describe('client with security marks for assets', async () => {
     };
     console.log('data %j', data);
   });
-  it('client can add security marks to asset.', async () => {
-    const output = await exec(`node v1/addSecurityMarks.js ${data.assetName}`);
-    assert.match(output, new RegExp(data.assetName));
+  it('client can add security marks to asset.', () => {
+    const output = exec(`node v1/addSecurityMarks.js ${data.assetName}`);
+    assert.include(output, data.assetName);
     assert.match(output, /key_a/);
     assert.match(output, /value_a/);
     assert.match(output, /key_b/);
     assert.match(output, /value_b/);
     assert.notMatch(output, /undefined/);
   });
 
-  it('client can add and delete security marks', async () => {
+  it('client can add and delete security marks', () => {
     // Ensure marks are set.
-    await exec(`node v1/addSecurityMarks.js ${data.assetName}`);
+    exec(`node v1/addSecurityMarks.js ${data.assetName}`);
 
-    const output = await exec(
-      `node v1/addDeleteSecurityMarks.js ${data.assetName}`
-    );
+    const output = exec(`node v1/addDeleteSecurityMarks.js ${data.assetName}`);
     assert.match(output, /key_a/);
     assert.match(output, /new_value_a/);
     assert.notMatch(output, /key_b/);
     assert.notMatch(output, /undefined/);
   });
 
-  it('client can delete security marks', async () => {
+  it('client can delete security marks', () => {
     // Ensure marks are set.
-    await exec(`node v1/addSecurityMarks.js ${data.assetName}`);
+    exec(`node v1/addSecurityMarks.js ${data.assetName}`);
 
-    const output = await exec(
-      `node v1/deleteSecurityMarks.js ${data.assetName}`
-    );
+    const output = exec(`node v1/deleteSecurityMarks.js ${data.assetName}`);
     assert.notMatch(output, /key_a/);
     assert.notMatch(output, /value_a/);
     assert.notMatch(output, /key_b/);
     assert.notMatch(output, /value_b/);
-    assert.match(output, new RegExp(data.assetName));
-    assert.match(output, new RegExp(data.assetName));
+    assert.include(output, data.assetName);
+    assert.include(output, data.assetName);
     assert.notMatch(output, /undefined/);
   });
 
-  it('client can list assets with security marks', async () => {
+  it('client can list assets with security marks', () => {
     // Ensure marks are set.
-    await exec(`node v1/addSecurityMarks.js ${data.assetName}`);
+    exec(`node v1/addSecurityMarks.js ${data.assetName}`);
 
-    const output = await exec(
-      `node v1/listAssetsWithSecurityMarks.js ${data.orgId}`
-    );
-    assert.match(output, new RegExp(data.assetName));
+    const output = exec(`node v1/listAssetsWithSecurityMarks.js ${data.orgId}`);
+    assert.include(output, data.assetName);
     assert.notMatch(output, /undefined/);
   });
 });

security-center/snippets/system-test/v1/findings.test.js

@@ -11,22 +11,21 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+
 'use strict';
 
+const {SecurityCenterClient} = require('@google-cloud/security-center');
 const {assert} = require('chai');
-const execa = require('execa');
-const exec = async cmd => (await execa.shell(cmd)).stdout;
+const {execSync} = require('child_process');
+const exec = cmd => execSync(cmd, {encoding: 'utf8'});
 
 const organizationId = process.env['GCLOUD_ORGANIZATION'];
 
 describe('Client with SourcesAndFindings', async () => {
   let data;
   before(async () => {
-    const {SecurityCenterClient} = require('@google-cloud/security-center');
-
     // Creates a new client.
     const client = new SecurityCenterClient();
-
     const [source] = await client
       .createSource({
         source: {
@@ -69,95 +68,104 @@ describe('Client with SourcesAndFindings', async () => {
     };
     console.log('my data %j', data);
   });
-  it('client can create source', async () => {
-    const output = await exec(`node v1/createSource.js ${data.orgId}`);
+
+  it('client can create source', () => {
+    const output = exec(`node v1/createSource.js ${data.orgId}`);
     assert.match(output, new RegExp(data.orgId));
     assert.match(output, /New Source/);
     assert.notMatch(output, /undefined/);
   });
-  it('client can get source', async () => {
-    const output = await exec(`node v1/getSource.js ${data.sourceName}`);
+
+  it('client can get source', () => {
+    const output = exec(`node v1/getSource.js ${data.sourceName}`);
     assert.match(output, new RegExp(data.sourceName));
     assert.match(output, /Source/);
     assert.match(output, /"description":"A new custom source that does X"/);
     assert.notMatch(output, /undefined/);
   });
-  it('client can list all sources', async () => {
-    const output = await exec(`node v1/listAllSources.js ${data.orgId}`);
+
+  it('client can list all sources', () => {
+    const output = exec(`node v1/listAllSources.js ${data.orgId}`);
     assert.match(output, new RegExp(data.sourceName));
     assert.match(output, /Sources/);
     assert.notMatch(output, /undefined/);
   });
-  it('client can update a source', async () => {
-    const output = await exec(`node v1/updateSource.js ${data.sourceName}`);
+
+  it('client can update a source', () => {
+    const output = exec(`node v1/updateSource.js ${data.sourceName}`);
     assert.match(output, new RegExp(data.sourceName));
     assert.match(output, /New Display Name/);
     assert.match(output, /source that does X/);
     assert.notMatch(output, /undefined/);
   });
-  it('client can create a finding', async () => {
-    const output = await exec(`node v1/createFinding.js ${data.sourceName}`);
+
+  it('client can create a finding', () => {
+    const output = exec(`node v1/createFinding.js ${data.sourceName}`);
     assert.match(output, new RegExp(data.sourceName));
     assert.match(output, /New finding created/);
     assert.notMatch(output, /undefined/);
   });
-  it('client can create a finding with source properties', async () => {
-    const output = await exec(
+
+  it('client can create a finding with source properties', () => {
+    const output = exec(
       `node v1/createFindingSourceProperties.js ${data.sourceName}`
     );
     assert.match(output, new RegExp(data.sourceName));
     assert.match(output, /New finding created/);
     assert.match(output, /n_value/);
     assert.notMatch(output, /undefined/);
   });
-  it('client can update a findings source properties', async () => {
-    const output = await exec(
+
+  it('client can update a findings source properties', () => {
+    const output = exec(
       `node v1/updateFindingSourceProperties.js ${data.findingName}`
     );
     assert.match(output, new RegExp(data.findingName));
     assert.match(output, /Updated Finding/);
     assert.match(output, /new_string_example/);
     assert.notMatch(output, /undefined/);
   });
-  it('client can set finding state', async () => {
-    const output = await exec(`node v1/setFindingState.js ${data.findingName}`);
+
+  it('client can set finding state', () => {
+    const output = exec(`node v1/setFindingState.js ${data.findingName}`);
     assert.match(output, new RegExp(data.findingName));
     assert.match(output, /INACTIVE/);
     assert.notMatch(output, /undefined/);
   });
-  it('client can test IAM privileges', async () => {
-    const output = await exec(`node v1/testIam.js ${data.sourceName}`);
+
+  it('client can test IAM privileges', () => {
+    const output = exec(`node v1/testIam.js ${data.sourceName}`);
     assert.equal(
       (output.match(/true/g) || []).length,
       2,
       `${output} contains true twice`
     );
     assert.notMatch(output, /undefined/);
   });
-  it('client can list all findings', async () => {
-    const output = await exec(`node v1/listAllFindings.js ${data.orgId}`);
+
+  it('client can list all findings', () => {
+    const output = exec(`node v1/listAllFindings.js ${data.orgId}`);
     assert.match(output, new RegExp(data.findingName));
     assert.match(output, new RegExp(data.untouchedFindingName));
     assert.notMatch(output, /undefined/);
   });
-  it('client can list only some findings', async () => {
-    const output = await exec(
-      `node v1/listFilteredFindings.js ${data.sourceName}`
-    );
+
+  it('client can list only some findings', () => {
+    const output = exec(`node v1/listFilteredFindings.js ${data.sourceName}`);
     assert.match(output, new RegExp(data.findingName));
     assert.notMatch(output, new RegExp(data.untouchedFindingName));
     assert.notMatch(output, /undefined/);
   });
-  it('client can list findings at a time.', async () => {
-    const output = await exec(
-      `node v1/listFindingsAtTime.js ${data.sourceName}`
-    );
+
+  it('client can list findings at a time.', () => {
+    const output = exec(`node v1/listFindingsAtTime.js ${data.sourceName}`);
     // Nothing was created for the source more then a few minutes ago, so
     // days ago should return nothing.
     assert.equal(output, '');
   });
-  it('client can add security marks to finding', async () => {
-    const output = await exec(
+
+  it('client can add security marks to finding', () => {
+    const output = exec(
       `node v1/addFindingSecurityMarks.js ${data.findingName}`
     );
     assert.match(output, new RegExp(data.findingName));
@@ -167,29 +175,29 @@ describe('Client with SourcesAndFindings', async () => {
     assert.match(output, /value_b/);
     assert.notMatch(output, /undefined/);
   });
-  it('client can list findings withe security marks', async () => {
-    // Ensure marks are set.
-    await exec(`node v1/addFindingSecurityMarks.js ${data.findingName}`);
 
-    const output = await exec(
+  it('client can list findings withe security marks', () => {
+    // Ensure marks are set.
+    exec(`node v1/addFindingSecurityMarks.js ${data.findingName}`);
+    const output = exec(
       `node v1/listFindingsWithSecurityMarks.js ${data.sourceName}`
     );
     assert.notMatch(output, new RegExp(data.findingName));
     assert.match(output, new RegExp(data.untouchedFindingName));
     assert.notMatch(output, /undefined/);
   });
-  it('client can get a sources policy', async () => {
-    const output = await exec(`node v1/getSourceIam.js ${data.sourceName}`);
+
+  it('client can get a sources policy', () => {
+    const output = exec(`node v1/getSourceIam.js ${data.sourceName}`);
     assert.match(output, /Current policy/);
     assert.notMatch(output, /undefined/);
   });
-  it('client set a sources policy', async () => {
+
+  it('client set a sources policy', () => {
     const user = 'csccclienttest@gmail.com';
-    const output = await exec(
-      `node v1/setSourceIam.js ${data.sourceName} ${user}`
-    );
+    const output = exec(`node v1/setSourceIam.js ${data.sourceName} ${user}`);
     assert.match(output, /Updated policy/);
-    assert.match(output, new RegExp(user));
+    assert.include(output, user);
     assert.notMatch(output, /undefined/);
   });
 });

security-center/snippets/system-test/v1/listAllAssets.test.js

@@ -1,27 +1,28 @@
-/*
- * Copyright 2019, Google, LLC.
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
 
 const {assert} = require('chai');
-const execa = require('execa');
-const exec = async cmd => (await execa.shell(cmd)).stdout;
+const {execSync} = require('child_process');
+const exec = cmd => execSync(cmd, {encoding: 'utf8'});
 
 const organization_id = process.env['GCLOUD_ORGANIZATION'];
 
 describe('listAllAssets', () => {
-  it('should print all assets in org', async () => {
-    const output = await exec(`node v1/listAllAssets.js ${organization_id}`);
+  it('should print all assets in org', () => {
+    const output = exec(`node v1/listAllAssets.js ${organization_id}`);
     assert.isAtLeast(output.match(/\n/g).length + 1, 62);
     assert.notMatch(output, /undefined/);
   });