JavaScript (v3): S3 - Replace hard coded bucket names with env vars or allowable name.

cpyle0819 · cpyle0819 · commit aa5bd47d6f18 · 2024-09-30T13:38:48.000-04:00
diff --git a/javascriptv3/example_code/s3/actions/copy-object.js b/javascriptv3/example_code/s3/actions/copy-object.js
@@ -54,28 +54,28 @@ export const main = async ({
 // snippet-end:[s3.JavaScript.buckets.copyObjectV3]
 
 // Call function if run directly
-import { fileURLToPath } from "url";
 import { parseArgs } from "util";
+import { isMain } from "@aws-doc-sdk-examples/lib/utils/util-node.js";
 
-if (process.argv[1] === fileURLToPath(import.meta.url)) {
+const loadArgs = () => {
   const options = {
-    sourceBucket: {
+    sourceBucketName: {
       type: "string",
-      default: "source-bucket",
     },
     sourceKey: {
       type: "string",
-      default: "todo.txt",
     },
     destinationBucket: {
       type: "string",
-      default: "destination-bucket",
     },
     destinationKey: {
       type: "string",
-      default: "todo.txt",
     },
   };
-  const { values } = parseArgs({ options });
+  return parseArgs({ options });
+};
+
+if (isMain(import.meta.url)) {
+  const { values } = loadArgs();
   main(values);
 }
diff --git a/javascriptv3/example_code/s3/actions/create-bucket.js b/javascriptv3/example_code/s3/actions/create-bucket.js
@@ -56,7 +56,6 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "bucket-name",
     },
   };
   const { values } = parseArgs({ options });
diff --git a/javascriptv3/example_code/s3/actions/delete-bucket-policy.js b/javascriptv3/example_code/s3/actions/delete-bucket-policy.js
@@ -49,7 +49,6 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
   };
   const { values } = parseArgs({ options });
diff --git a/javascriptv3/example_code/s3/actions/delete-bucket-website.js b/javascriptv3/example_code/s3/actions/delete-bucket-website.js
@@ -53,7 +53,6 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
   };
   const { values } = parseArgs({ options });
diff --git a/javascriptv3/example_code/s3/actions/delete-object.js b/javascriptv3/example_code/s3/actions/delete-object.js
@@ -59,11 +59,9 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
     key: {
       type: "string",
-      default: "todo.txt",
     },
   };
   const { values } = parseArgs({ options });
diff --git a/javascriptv3/example_code/s3/actions/delete-objects.js b/javascriptv3/example_code/s3/actions/delete-objects.js
@@ -67,7 +67,6 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
   };
   const { values, positionals } = parseArgs({
diff --git a/javascriptv3/example_code/s3/actions/get-bucket-acl.js b/javascriptv3/example_code/s3/actions/get-bucket-acl.js
@@ -50,7 +50,6 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
   };
   const { values } = parseArgs({ options });
diff --git a/javascriptv3/example_code/s3/actions/get-bucket-cors.js b/javascriptv3/example_code/s3/actions/get-bucket-cors.js
@@ -60,7 +60,6 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
   };
   const { values } = parseArgs({ options });
diff --git a/javascriptv3/example_code/s3/actions/get-bucket-policy.js b/javascriptv3/example_code/s3/actions/get-bucket-policy.js
@@ -49,7 +49,6 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
   };
   const { values } = parseArgs({ options });
diff --git a/javascriptv3/example_code/s3/actions/get-bucket-website.js b/javascriptv3/example_code/s3/actions/get-bucket-website.js
@@ -51,7 +51,6 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
   };
   const { values } = parseArgs({ options });
diff --git a/javascriptv3/example_code/s3/actions/get-object-legal-hold.js b/javascriptv3/example_code/s3/actions/get-object-legal-hold.js
@@ -51,11 +51,9 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
     key: {
       type: "string",
-      default: "foo.txt",
     },
   };
   const { values } = parseArgs({ options });
diff --git a/javascriptv3/example_code/s3/actions/get-object-lock-configuration.js b/javascriptv3/example_code/s3/actions/get-object-lock-configuration.js
@@ -50,7 +50,6 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
   };
   const { values } = parseArgs({ options });
diff --git a/javascriptv3/example_code/s3/actions/get-object-retention.js b/javascriptv3/example_code/s3/actions/get-object-retention.js
@@ -50,11 +50,9 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
     key: {
       type: "string",
-      default: "foo.txt",
     },
   };
   const { values } = parseArgs({ options });
diff --git a/javascriptv3/example_code/s3/actions/get-object.js b/javascriptv3/example_code/s3/actions/get-object.js
@@ -50,11 +50,9 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
     key: {
       type: "string",
-      default: "foo.txt",
     },
   };
   const { values } = parseArgs({ options });
diff --git a/javascriptv3/example_code/s3/actions/list-objects.js b/javascriptv3/example_code/s3/actions/list-objects.js
@@ -58,7 +58,6 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
     pageSize: {
       type: "string",
diff --git a/javascriptv3/example_code/s3/actions/put-bucket-acl.js b/javascriptv3/example_code/s3/actions/put-bucket-acl.js
@@ -76,7 +76,6 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
     granteeCanonicalUserId: {
       type: "string",
diff --git a/javascriptv3/example_code/s3/actions/put-bucket-cors.js b/javascriptv3/example_code/s3/actions/put-bucket-cors.js
@@ -69,7 +69,6 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
     options: {
       bucketName: {
         type: "string",
-        default: "amzn-s3-demo-bucket",
       },
     },
   });
diff --git a/javascriptv3/example_code/s3/actions/put-bucket-policy.js b/javascriptv3/example_code/s3/actions/put-bucket-policy.js
@@ -67,7 +67,6 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
     iamRoleArn: {
       type: "string",
diff --git a/javascriptv3/example_code/s3/actions/put-bucket-website.js b/javascriptv3/example_code/s3/actions/put-bucket-website.js
@@ -65,7 +65,6 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
   };
   const { values } = parseArgs({ options });
diff --git a/javascriptv3/example_code/s3/actions/put-object-legal-hold.js b/javascriptv3/example_code/s3/actions/put-object-legal-hold.js
@@ -59,11 +59,9 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
     objectKey: {
       type: "string",
-      default: "file.txt",
     },
     legalHoldStatus: {
       type: "string",
diff --git a/javascriptv3/example_code/s3/actions/put-object.js b/javascriptv3/example_code/s3/actions/put-object.js
@@ -59,11 +59,9 @@ if (process.argv[1] === fileURLToPath(import.meta.url)) {
   const options = {
     bucketName: {
       type: "string",
-      default: "amzn-s3-demo-bucket",
     },
     key: {
       type: "string",
-      default: "demo-key.txt",
     },
   };
   const { values, positionals } = parseArgs({
diff --git a/javascriptv3/example_code/s3/tests/copy-object.unit.test.js b/javascriptv3/example_code/s3/tests/copy-object.unit.test.js
@@ -19,9 +19,9 @@ vi.doMock("@aws-sdk/client-s3", async () => {
 const { main } = await import("../actions/copy-object.js");
 
 describe("copy-object", () => {
-  const sourceBucket = "my-old-bucket";
+  const sourceBucket = "amzn-s3-demo-bucket";
   const sourceKey = "todo.txt";
-  const destinationBucket = "my-new-bucket";
+  const destinationBucket = "amzn-s3-demo-bucket1";
   const destinationKey = "updated-todo.txt";
 
   it("should log the response from the service", async () => {
diff --git a/javascriptv3/example_code/s3/tests/create-bucket.unit.test.js b/javascriptv3/example_code/s3/tests/create-bucket.unit.test.js
@@ -27,7 +27,7 @@ describe("create-bucket", () => {
 
     const spy = vi.spyOn(console, "log");
 
-    await main({ bucketName: "bucket-name" });
+    await main({ bucketName: "amzn-s3-demo-bucket" });
 
     expect(spy).toHaveBeenCalledWith("Bucket created with location foo");
   });
@@ -38,10 +38,10 @@ describe("create-bucket", () => {
 
     const spy = vi.spyOn(console, "error");
 
-    await main({ bucketName: "bucket-name" });
+    await main({ bucketName: "amzn-s3-demo-bucket" });
 
     expect(spy).toHaveBeenCalledWith(
-      `The bucket "bucket-name" already exists in another AWS account. Bucket names must be globally unique.`,
+      `The bucket "amzn-s3-demo-bucket" already exists in another AWS account. Bucket names must be globally unique.`,
     );
   });
 
@@ -51,10 +51,10 @@ describe("create-bucket", () => {
 
     const spy = vi.spyOn(console, "error");
 
-    await main({ bucketName: "bucket-name" });
+    await main({ bucketName: "amzn-s3-demo-bucket" });
 
     expect(spy).toHaveBeenCalledWith(
-      `The bucket "bucket-name" already exists in this AWS account.`,
+      `The bucket "amzn-s3-demo-bucket" already exists in this AWS account.`,
     );
   });
 });
diff --git a/javascriptv3/example_code/s3/tests/get-object-legal-hold.integration.test.js b/javascriptv3/example_code/s3/tests/get-object-legal-hold.integration.test.js
@@ -13,7 +13,9 @@ import { main as getObjectLegalHold } from "../actions/get-object-legal-hold.js"
 import { legallyEmptyAndDeleteBuckets } from "../libs/s3Utils.js";
 
 const client = new S3Client({});
-const bucketName = getUniqueName("test");
+const bucketName = getUniqueName(
+  process.env["S3_BUCKET_NAME"] ?? "get-object-legal-hold",
+);
 const objectKey = "test-object";
 
 describe("get-object-legal-hold.js Integration Test", () => {
diff --git a/javascriptv3/example_code/s3/tests/get-object-lock-configuration.integration.test.js b/javascriptv3/example_code/s3/tests/get-object-lock-configuration.integration.test.js
@@ -15,7 +15,9 @@ import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
 import { legallyEmptyAndDeleteBuckets } from "../libs/s3Utils.js";
 
 const client = new S3Client({});
-const bucketName = getUniqueName("code-example");
+const bucketName = getUniqueName(
+  process.env["S3_BUCKET_NAME"] ?? "get-object-lock",
+);
 
 describe("get-object-lock-configuration.js Integration Test", () => {
   afterAll(async () => {
diff --git a/javascriptv3/example_code/s3/tests/get-object-retention.integration.test.js b/javascriptv3/example_code/s3/tests/get-object-retention.integration.test.js
@@ -14,7 +14,9 @@ import { main as getObjectRetention } from "../actions/get-object-retention.js";
 import { legallyEmptyAndDeleteBuckets } from "../libs/s3Utils.js";
 
 const client = new S3Client({});
-const bucketName = getUniqueName("test-bucket");
+const bucketName = getUniqueName(
+  process.env["S3_BUCKET_NAME"] ?? "get-object-retention",
+);
 const objectKey = "test-object";
 
 describe("get-object-retention.js Integration Test", () => {
diff --git a/javascriptv3/example_code/s3/tests/put-default-object-lock-configuration.integration.test.js b/javascriptv3/example_code/s3/tests/put-default-object-lock-configuration.integration.test.js
@@ -15,7 +15,9 @@ import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
 import { legallyEmptyAndDeleteBuckets } from "../libs/s3Utils.js";
 
 const client = new S3Client({});
-const bucketName = getUniqueName("test-bucket");
+const bucketName = getUniqueName(
+  process.env["S3_BUCKET_NAME"] ?? "put-default-lock",
+);
 
 describe("put-default-object-lock-configuration.js Integration Test", () => {
   afterAll(async () => {
diff --git a/javascriptv3/example_code/s3/tests/put-object-legal-hold.integration.test.js b/javascriptv3/example_code/s3/tests/put-object-legal-hold.integration.test.js
@@ -13,7 +13,9 @@ import { main as putObjectLegalHold } from "../actions/put-object-legal-hold.js"
 import { legallyEmptyAndDeleteBuckets } from "../libs/s3Utils.js";
 
 const client = new S3Client({});
-const bucketName = getUniqueName("code-example");
+const bucketName = getUniqueName(
+  process.env["S3_BUCKET_NAME"] ?? "put-object-legal",
+);
 const objectKey = "file.txt";
 
 describe("put-object-legal-hold.js Integration Test", () => {
diff --git a/javascriptv3/example_code/s3/tests/put-object-lock-configuration.integration.test.js b/javascriptv3/example_code/s3/tests/put-object-lock-configuration.integration.test.js
@@ -16,7 +16,7 @@ import { legallyEmptyAndDeleteBuckets } from "../libs/s3Utils.js";
 
 const client = new S3Client({});
 const bucketName = getUniqueName(
-  process.env["S3_BUCKET_NAME"] || "object-lock-integ",
+  process.env["S3_BUCKET_NAME"] ?? "object-lock-integ",
 );
 
 describe("put-object-lock-configuration.js Integration Test", () => {
diff --git a/javascriptv3/example_code/s3/tests/put-object-retention.integration.test.js b/javascriptv3/example_code/s3/tests/put-object-retention.integration.test.js
@@ -13,7 +13,9 @@ import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
 import { legallyEmptyAndDeleteBuckets } from "../libs/s3Utils.js";
 
 const client = new S3Client({});
-const bucketName = getUniqueName("code-example");
+const bucketName = getUniqueName(
+  process.env["S3_BUCKET_NAME"] ?? "put-object-retention",
+);
 const objectKey = "test-object";
 
 describe("put-object-retention.js Integration Test", () => {
diff --git a/javascriptv3/example_code/s3/tests/s3-hello.integration.test.js b/javascriptv3/example_code/s3/tests/s3-hello.integration.test.js
@@ -4,10 +4,13 @@
 import { S3Client } from "@aws-sdk/client-s3";
 import { describe, it, expect, beforeAll, afterAll } from "vitest";
 import { CreateBucketCommand, DeleteBucketCommand } from "@aws-sdk/client-s3";
+
+import { getUniqueName } from "@aws-doc-sdk-examples/lib/utils/util-string.js";
+
 import { helloS3 } from "../hello.js";
 
 describe("helloS3", () => {
-  const bucketName = `hello-s3-bucket-${Math.ceil(Math.random() * 1000000)}`;
+  const bucketName = getUniqueName(process.env["S3_BUCKET_NAME"] ?? "hello");
   const s3Client = new S3Client({});
 
   beforeAll(async () => {
