chore: migrate assessed sample as requested by techwriting

dlp/redactText.js

@@ -0,0 +1,80 @@
+// Copyright 2020 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
+//
+//      http://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.
+
+// sample-metadata:
+//  title: Redact Text
+//  description: Redact sensitive data from text using the Data Loss Prevention API.
+//  usage: node redactText.js my-project string minLikelihood infoTypes
+
+function main(projectId, string, minLikelihood, infoTypes) {
+  infoTypes = transformCLI(infoTypes);
+  // [START dlp_redact_text]
+  // Imports the Google Cloud Data Loss Prevention library
+  const DLP = require('@google-cloud/dlp');
+
+  // Instantiates a client
+  const dlp = new DLP.DlpServiceClient();
+
+  // The project ID to run the API call under
+  // const projectId = 'my-project';
+
+  // Construct transformation config which replaces sensitive info with its info type.
+  // E.g., "Her email is [email protected]" => "Her email is [EMAIL_ADDRESS]"
+  const replaceWithInfoTypeTransformation = {
+    primitiveTransformation: {
+      replaceWithInfoTypeConfig: {},
+    },
+  };
+
+  async function redactText() {
+    // Construct redaction request
+    const request = {
+      parent: `projects/${projectId}/locations/global`,
+      item: {
+        value: string,
+      },
+      deidentifyConfig: {
+        infoTypeTransformations: {
+          transformations: [replaceWithInfoTypeTransformation],
+        },
+      },
+      inspectConfig: {
+        minLikelihood: minLikelihood,
+        infoTypes: infoTypes,
+      },
+    };
+
+    // Run string redaction
+    const [response] = await dlp.deidentifyContent(request);
+    const resultString = response.item.value;
+    console.log(`Redacted text: ${resultString}`);
+  }
+  redactText();
+  // [END dlp_redact_text]
+}
+
+main(...process.argv.slice(2));
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+
+function transformCLI(infoTypes) {
+  infoTypes = infoTypes
+    ? infoTypes.split(',').map(type => {
+        return {name: type};
+      })
+    : undefined;
+  return infoTypes;
+}

dlp/system-test/redact.test.js

@@ -0,0 +1,135 @@
+// Copyright 2018 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
+//
+//      http://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 {describe, it, before} = require('mocha');
+const fs = require('fs');
+const cp = require('child_process');
+const {PNG} = require('pngjs');
+const pixelmatch = require('pixelmatch');
+const DLP = require('@google-cloud/dlp');
+
+const execSync = cmd => cp.execSync(cmd, {encoding: 'utf-8'});
+
+const testImage = 'resources/test.png';
+const testResourcePath = 'system-test/resources';
+
+const client = new DLP.DlpServiceClient();
+
+async function readImage(filePath) {
+  return new Promise((resolve, reject) => {
+    fs.createReadStream(filePath)
+      .pipe(new PNG())
+      .on('error', reject)
+      .on('parsed', function () {
+        resolve(this);
+      });
+  });
+}
+
+async function getImageDiffPercentage(image1Path, image2Path) {
+  const image1 = await readImage(image1Path);
+  const image2 = await readImage(image2Path);
+  const diff = new PNG({width: image1.width, height: image1.height});
+
+  const diffPixels = pixelmatch(
+    image1.data,
+    image2.data,
+    diff.data,
+    image1.width,
+    image1.height
+  );
+  return diffPixels / (diff.width * diff.height);
+}
+describe('redact', () => {
+  let projectId;
+
+  before(async () => {
+    projectId = await client.getProjectId();
+  });
+  // redact_text
+  it('should redact a single sensitive data type from a string', () => {
+    const output = execSync(
+      `node redactText.js ${projectId} "My email is [email protected]" -t EMAIL_ADDRESS`
+    );
+    assert.match(output, /My email is \[EMAIL_ADDRESS\]/);
+  });
+
+  it('should redact multiple sensitive data types from a string', () => {
+    const output = execSync(
+      `node redactText.js ${projectId} "I am 29 years old and my email is [email protected]" LIKELIHOOD_UNSPECIFIED 'EMAIL_ADDRESS,AGE'`
+    );
+    assert.match(output, /I am \[AGE\] and my email is \[EMAIL_ADDRESS\]/);
+  });
+
+  it('should handle string with no sensitive data', () => {
+    const output = execSync(
+      `node redactText.js ${projectId} "No sensitive data to redact here" LIKELIHOOD_UNSPECIFIED 'EMAIL_ADDRESS,AGE'`
+    );
+    assert.match(output, /No sensitive data to redact here/);
+  });
+
+  // redact_image
+  it('should redact a single sensitive data type from an image', async () => {
+    const testName = 'redact-single-type';
+    const output = execSync(
+      `node redactImage.js ${projectId} ${testImage} 'LIKELIHOOD_UNSPECIFIED' 'PHONE_NUMBER' ${testName}.actual.png`
+    );
+    assert.match(output, /Saved image redaction results to path/);
+    const difference = await getImageDiffPercentage(
+      `${testName}.actual.png`,
+      `${testResourcePath}/${testName}.expected.png`
+    );
+    assert.isBelow(difference, 0.1);
+  });
+
+  it('should redact multiple sensitive data types from an image', async () => {
+    const testName = 'redact-multiple-types';
+    const output = execSync(
+      `node redactImage.js ${projectId} ${testImage} LIKELIHOOD_UNSPECIFIED 'PHONE_NUMBER,EMAIL_ADDRESS' ${testName}.actual.png`
+    );
+    assert.match(output, /Saved image redaction results to path/);
+    const difference = await getImageDiffPercentage(
+      `${testName}.actual.png`,
+      `${testResourcePath}/${testName}.expected.png`
+    );
+    assert.isBelow(difference, 0.1);
+  });
+
+  it('should report info type errors', () => {
+    let output;
+    try {
+      output = execSync(
+        `node redactText.js ${projectId} "My email is [email protected]" LIKELIHOOD_UNSPECIFIED 'NONEXISTENT'`
+      );
+    } catch (err) {
+      output = err.message;
+    }
+    assert.include(output, 'INVALID_ARGUMENT');
+  });
+
+  it('should report image redaction handling errors', () => {
+    let output;
+    try {
+      output = execSync(
+        `node redactImage.js ${projectId} ${testImage} output.png BAD_TYPE`
+      );
+    } catch (err) {
+      output = err.message;
+    }
+    assert.include(output, 'INVALID_ARGUMENT');
+  });
+});