DLP: Added sample for create and get job (#3361)

* DLP: Added sample for create and get job
Added unit test cases for same

* fixes test failures

* Updated infoTypes in the createJob sample

---------

Co-authored-by: Patti Shin <[email protected]>

Author: dinesh-crest

dlp/createJob.js

@@ -0,0 +1,82 @@
+// Copyright 2023 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';
+
+// sample-metadata:
+//  title: Create an inspection job
+//  description: Create an inspection job
+//  usage: node createJob.js my-project bucket-url
+function main(projectId, cloudFileUrl) {
+  // [START dlp_create_job]
+  // Imports the Google Cloud Data Loss Prevention library
+  const DLP = require('@google-cloud/dlp');
+
+  // Initialize google DLP Client
+  const dlp = new DLP.DlpServiceClient();
+
+  async function jobsCreate() {
+    // Construct cloud storage configuration
+    const cloudStorageConfig = {
+      cloudStorageOptions: {
+        fileSet: {
+          url: cloudFileUrl,
+        },
+      },
+      timespanConfig: {
+        enableAutoPopulationOfTimespanConfig: true,
+      },
+    };
+
+    // Construct inspect job configuration
+    const inspectJob = {
+      storageConfig: cloudStorageConfig,
+    };
+
+    // Construct inspect configuration
+    const inspectConfig = {
+      infoTypes: [
+        {name: 'EMAIL_ADDRESS'},
+        {name: 'PERSON_NAME'},
+        {name: 'LOCATION'},
+        {name: 'PHONE_NUMBER'},
+      ],
+      includeQuote: true,
+      minLikelihood: DLP.protos.google.privacy.dlp.v2.Likelihood.LIKELY,
+      excludeInfoTypes: false,
+    };
+
+    // Combine configurations into a request for the service.
+    const request = {
+      parent: `projects/${projectId}/locations/global`,
+      inspectJob: inspectJob,
+      inspectConfig: inspectConfig,
+    };
+
+    // Send the request and receive response from the service
+    const [response] = await dlp.createDlpJob(request);
+    // Print the results
+    console.log(`Job created successfully: ${response.name}`);
+  }
+
+  jobsCreate();
+  // [END dlp_create_job]
+}
+
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+
+main(...process.argv.slice(2));

dlp/getJob.js

@@ -0,0 +1,54 @@
+// Copyright 2023 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';
+
+// sample-metadata:
+//  title: Get an inspection job
+//  description: Get DLP inspection job using job name.
+//  usage: node getJob.js jobName
+function main(jobName) {
+  // [START dlp_get_job]
+  // Imports the Google Cloud Data Loss Prevention library
+  const DLP = require('@google-cloud/dlp');
+
+  // Instantiates a client
+  const dlp = new DLP.DlpServiceClient();
+
+  // Job name to look for
+  // const jobName = 'your-job-name';
+
+  async function getJob() {
+    // Construct request for finding job using job name.
+    const request = {
+      name: jobName,
+    };
+
+    // Send the request and receive response from the service
+    const [job] = await dlp.getDlpJob(request);
+
+    // Print results.
+    console.log(`Job ${job.name} status: ${job.state}`);
+  }
+
+  getJob();
+  // [END dlp_get_job]
+}
+
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+
+main(...process.argv.slice(2));

dlp/system-test/jobs.test.js

@@ -27,6 +27,7 @@ const testTableProjectId = 'bigquery-public-data';
 const testDatasetId = 'san_francisco';
 const testTableId = 'bikeshare_trips';
 const testColumnName = 'zip_code';
+const bucketName = 'nodejs-dlp-test-bucket';
 
 const client = new DLP.DlpServiceClient();
 
@@ -156,4 +157,42 @@ describe('test', () => {
     console.log(output);
     assert.match(output, /Error in deleteJob/);
   });
+
+  // dlp_create_job
+  it('should create job', () => {
+    const output = execSync(
+      `node createJob.js ${projectId} gs://${bucketName}/test.txt`
+    );
+    assert.match(output, /Job created successfully:/);
+  });
+
+  it('should handle job creation errors', () => {
+    let output;
+    try {
+      output = execSync(
+        `node createJob.js BAD_PROJECT_IDgs://${bucketName}/test.txt `
+      );
+    } catch (err) {
+      output = err.message;
+    }
+    assert.include(output, 'INVALID_ARGUMENT');
+  });
+
+  // dlp_get_job
+  it('should get job details using job name', async () => {
+    const jobName = await createTestJob();
+    const output = execSync(`node getJob.js ${jobName}`);
+    assert.match(output, /Job .+ status: \w/);
+    await client.deleteDlpJob({name: jobName});
+  });
+
+  it('should handle error while fetching job details', () => {
+    let output;
+    try {
+      output = execSync('node getJob.js INVALID_JOB');
+    } catch (err) {
+      output = err.message;
+    }
+    assert.include(output, 'INVALID_ARGUMENT');
+  });
 });