docs: add Live Stream assets and pools samples and tests (#3383)

irataxy · kweinmeister · pattishin · web-flow · commit 372d5481c459 · 2023-08-08T10:34:46.000-07:00
* docs: add Live Stream assets and pools samples and tests

* fix license check

---------

Co-authored-by: Karl Weinmeister &lt;11586922+kweinmeister@users.noreply.github.com&gt;
Co-authored-by: Patti Shin &lt;pattishin@users.noreply.github.com&gt;
diff --git a/media/livestream/createAsset.js b/media/livestream/createAsset.js
@@ -0,0 +1,62 @@
+/**
+ * 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';
+
+function main(projectId, location, assetId, assetUri) {
+  // [START livestream_create_asset]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // projectId = 'my-project-id';
+  // location = 'us-central1';
+  // assetId = 'my-asset';
+  // assetUri = 'gs://my-bucket/my-video.mp4';
+
+  // Imports the Livestream library
+  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;
+
+  // Instantiates a client
+  const livestreamServiceClient = new LivestreamServiceClient();
+
+  async function createAsset() {
+    // Construct request
+    const request = {
+      parent: livestreamServiceClient.locationPath(projectId, location),
+      assetId: assetId,
+      asset: {
+        video: {
+          uri: assetUri,
+        },
+      },
+    };
+
+    // Run request
+    const [operation] = await livestreamServiceClient.createAsset(request);
+    const response = await operation.promise();
+    const [asset] = response;
+    console.log(`Asset: ${asset.name}`);
+  }
+
+  createAsset();
+  // [END livestream_create_asset]
+}
+
+// node createAsset.js <projectId> <location> <assetId> <assetUri>
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+main(...process.argv.slice(2));
diff --git a/media/livestream/deleteAsset.js b/media/livestream/deleteAsset.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';
+
+function main(projectId, location, assetId) {
+  // [START livestream_delete_asset]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // projectId = 'my-project-id';
+  // location = 'us-central1';
+  // assetId = 'my-asset';
+
+  // Imports the Livestream library
+  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;
+
+  // Instantiates a client
+  const livestreamServiceClient = new LivestreamServiceClient();
+
+  async function deleteAsset() {
+    // Construct request
+    const request = {
+      name: livestreamServiceClient.assetPath(projectId, location, assetId),
+    };
+
+    // Run request
+    const [operation] = await livestreamServiceClient.deleteAsset(request);
+    await operation.promise();
+    console.log('Deleted asset');
+  }
+
+  deleteAsset();
+  // [END livestream_delete_asset]
+}
+
+// node deleteAsset.js <projectId> <location> <assetId>
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+main(...process.argv.slice(2));
diff --git a/media/livestream/getAsset.js b/media/livestream/getAsset.js
@@ -0,0 +1,51 @@
+/**
+ * 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';
+
+function main(projectId, location, assetId) {
+  // [START livestream_get_asset]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // projectId = 'my-project-id';
+  // location = 'us-central1';
+  // assetId = 'my-asset';
+
+  // Imports the Livestream library
+  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;
+
+  // Instantiates a client
+  const livestreamServiceClient = new LivestreamServiceClient();
+
+  async function getAsset() {
+    // Construct request
+    const request = {
+      name: livestreamServiceClient.assetPath(projectId, location, assetId),
+    };
+    const [asset] = await livestreamServiceClient.getAsset(request);
+    console.log(`Asset: ${asset.name}`);
+  }
+
+  getAsset();
+  // [END livestream_get_asset]
+}
+
+// node getAsset.js <projectId> <location> <assetId>
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+main(...process.argv.slice(2));
diff --git a/media/livestream/getPool.js b/media/livestream/getPool.js
@@ -0,0 +1,51 @@
+/**
+ * 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';
+
+function main(projectId, location, poolId) {
+  // [START livestream_get_pool]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // projectId = 'my-project-id';
+  // location = 'us-central1';
+  // poolId = 'my-pool';
+
+  // Imports the Livestream library
+  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;
+
+  // Instantiates a client
+  const livestreamServiceClient = new LivestreamServiceClient();
+
+  async function getPool() {
+    // Construct request
+    const request = {
+      name: livestreamServiceClient.poolPath(projectId, location, poolId),
+    };
+    const [pool] = await livestreamServiceClient.getPool(request);
+    console.log(`Pool: ${pool.name}`);
+  }
+
+  getPool();
+  // [END livestream_get_pool]
+}
+
+// node getPool.js <projectId> <location> <poolId>
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+main(...process.argv.slice(2));
diff --git a/media/livestream/listAssets.js b/media/livestream/listAssets.js
@@ -0,0 +1,51 @@
+/**
+ * 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';
+
+function main(projectId, location) {
+  // [START livestream_list_assets]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // projectId = 'my-project-id';
+  // location = 'us-central1';
+
+  // Imports the Livestream library
+  const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;
+
+  // Instantiates a client
+  const livestreamServiceClient = new LivestreamServiceClient();
+
+  async function listAssets() {
+    const iterable = await livestreamServiceClient.listAssetsAsync({
+      parent: livestreamServiceClient.locationPath(projectId, location),
+    });
+    console.info('Assets:');
+    for await (const response of iterable) {
+      console.log(response.name);
+    }
+  }
+
+  listAssets();
+  // [END livestream_list_assets]
+}
+
+// node listAssets.js <projectId> <location>
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+main(...process.argv.slice(2));
diff --git a/media/livestream/test/livestream.test.js b/media/livestream/test/livestream.test.js
@@ -1,5 +1,5 @@
 /**
- * Copyright 2022, Google, Inc.
+ * 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
@@ -34,11 +34,16 @@ const channelId = `nodejs-test-livestream-channel-${uniqueID}`;
 const channelName = `projects/${projectId}/locations/${location}/channels/${channelId}`;
 const eventId = `nodejs-test-livestream-event-${uniqueID}`;
 const eventName = `projects/${projectId}/locations/${location}/channels/${channelId}/events/${eventId}`;
+const assetId = `nodejs-test-livestream-asset-${uniqueID}`;
+const assetName = `projects/${projectId}/locations/${location}/assets/${assetId}`;
+const assetUri = 'gs://cloud-samples-data/media/ForBiggerEscapes.mp4';
 const outputUri = `gs://${bucketName}/test-output-channel/`;
+const poolId = 'default';
+const poolName = `projects/${projectId}/locations/${location}/pools/${poolId}`;
 const cwd = path.join(__dirname, '..');
 
 before(async () => {
-  // Delete outstanding channels and inputs created more than 3 hours ago
+  // Delete outstanding channels, inputs, and assets created more than 3 hours ago
   const {LivestreamServiceClient} = require('@google-cloud/livestream').v1;
   const livestreamServiceClient = new LivestreamServiceClient();
   const THREE_HOURS_IN_SEC = 60 * 60 * 3;
@@ -87,6 +92,17 @@ before(async () => {
       await livestreamServiceClient.deleteInput(request);
     }
   }
+  const [assets] = await livestreamServiceClient.listAssets({
+    parent: livestreamServiceClient.locationPath(projectId, location),
+  });
+  for (const asset of assets) {
+    if (asset.createTime.seconds < DATE_NOW_SEC - THREE_HOURS_IN_SEC) {
+      const request = {
+        name: asset.name,
+      };
+      await livestreamServiceClient.deleteAsset(request);
+    }
+  }
 });
 
 describe('Input functions', () => {
@@ -304,3 +320,54 @@ describe('Channel event functions', () => {
     assert.ok(output.includes('Deleted channel event'));
   });
 });
+
+describe('Asset functions', () => {
+  it('should create an asset', () => {
+    const output = execSync(
+      `node createAsset.js ${projectId} ${location} ${assetId} ${assetUri}`,
+      {cwd}
+    );
+    assert.ok(output.includes(assetName));
+  });
+
+  it('should show a list of assets', () => {
+    const output = execSync(`node listAssets.js ${projectId} ${location}`, {
+      cwd,
+    });
+    assert.ok(output.includes(assetName));
+  });
+
+  it('should get an asset', () => {
+    const output = execSync(
+      `node getAsset.js ${projectId} ${location} ${assetId}`,
+      {cwd}
+    );
+    assert.ok(output.includes(assetName));
+  });
+
+  it('should delete an asset', () => {
+    const output = execSync(
+      `node deleteAsset.js ${projectId} ${location} ${assetId}`,
+      {cwd}
+    );
+    assert.ok(output.includes('Deleted asset'));
+  });
+});
+
+describe('Pool functions', () => {
+  it('should get a pool', () => {
+    const output = execSync(
+      `node getPool.js ${projectId} ${location} ${poolId}`,
+      {cwd}
+    );
+    assert.ok(output.includes(poolName));
+  });
+
+  it('should update a pool', () => {
+    const output = execSync(
+      `node updatePool.js ${projectId} ${location} ${poolId} ''`,
+      {cwd}
+    );
+    assert.ok(output.includes(poolName));
+  });
+});
diff --git a/media/livestream/updatePool.js b/media/livestream/updatePool.js
