AWS CodeCommit samples (AWS SDK for JavaScript v3) (#1934)

* update s3 tests

* add S3 copy object example

* add S3 copy object example

* add S3 copy object example

* add S3 copy object example

* Add AWS CodeCommit examples (Node.js)

* Add AWS CodeCommit examples (Node.js)

* fixing broken snippets tags

* fixing broken snippets tags

Co-authored-by: Irene Smith <[email protected]>

Author: brmur

javascriptv3/example_code/codecommit/README.md

@@ -0,0 +1,49 @@
+#  AWS CodeCommit JavaScript SDK v3 code examples
+AWS CodeCommit is a fully-managed source control service that makes it easy for companies to host secure and highly scalable private Git repositories.
+## Code examples
+This is a workspace where you can find the following AWS SDK for JavaScript version 3 (v3) AWS CodeBuild examples: 
+
+- [Create a branch](src/createBranch.js)
+- [Commit changes to repo](src/createCommit.js)
+- [Create a pull request](src/createPullRequest.js)
+- [Create a repository](src/createRepository.js)
+- [Delete a branch](src/deleteBranch.js)
+- [Delete a repository](src/deleteRepository.js)
+- [Describe pull request events](src/describePullRequestEvents.js)
+- [Get merge options](src/getMergeOptions.js)
+- [Get informtion about a pull request](src/getPullRequest.js)
+- [Get informatino about a repository](src/getRepository.js)
+- [List your repositories](src/listRepositories.js)
+- [Merge branches](src/mergeBranches.js)
+
+
+**Note**: All code examples are written in ECMAscript 6 (ES6). For guidelines on converting to CommonJS, see 
+[JavaScript ES6/CommonJS syntax](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/sdk-examples-javascript-syntax.html).
+
+## Getting started
+
+1. Clone the [AWS SDK Code Samples repo](https://github.com/awsdocs/aws-doc-sdk-examples) to your local environment. See [the Github documentation](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) for instructions.
+
+2. Install the dependencies listed in the package.json.
+
+```
+npm install node -g
+cd javascriptv3/example_code/codecommit
+npm install
+```
+3. In your text editor, update user variables specified in the ```Inputs``` section of the sample file.
+
+4. Run sample code:
+```
+cd src
+node [example name].js
+```
+
+## Unit tests
+For more information see, the [README](../README.rst).
+
+## Resources
+- [AWS SDK for JavaScript v3 repo](https://github.com/aws/aws-sdk-js-v3)
+- [AWS SDK for JavaScript v3 Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/s3-examples.html)
+- [AWS SDK for JavaScript v3 API Reference Guide](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-codecommit/index.html) 
+- [AWS CodeCommit user guide](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html)

javascriptv3/example_code/codecommit/src/createBranch.js

@@ -0,0 +1,43 @@
+/* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+SPDX-License-Identifier: Apache-2.0
+ABOUT THIS NODE.JS EXAMPLE: This example works with AWS SDK for JavaScript version 3 (v3),
+which is available at https://github.com/aws/aws-sdk-js-v3. For information about how AWS CodeCommit works,
+see https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html.
+
+Purpose:
+createBranch.js creates a branch in a repository and points the branch to a commit..
+
+Inputs (replace in code):
+- BRANCH_NAME
+- COMMIT_ID
+- REPOSITORY_NAME
+
+Running the code:
+node createRepository.js
+*/
+// snippet-start:[codeCommit.JavaScript.createRepositoryV3]
+// Get service clients module and commands using ES6 syntax.
+import { CreateBranchCommand } from "@aws-sdk/client-codecommit";
+import { codeCommitClient } from "./libs/codeCommitClient.js";
+
+// Set the parameters.
+
+export const params = {
+    branchName: 'BRANCH_NAME', /* required */
+    commitId: 'COMMIT_ID', /* required. The ID of the commit to point the new branch to. */
+    repositoryName: 'REPOSITORY_NAME' /* required */
+};
+
+// Create the AWS CodeDeploy branch.
+export const run = async () => {
+    try {
+        const data = await codeCommitClient.send(new CreateBranchCommand(params));
+        console.log("Success", data);
+        return data; // For unit tests.
+    } catch (err) {
+        console.log("Error", err);
+    }
+};
+run();
+// snippet-end:[codeCommit.JavaScript.createRepositoryV3]
+

javascriptv3/example_code/codecommit/src/createCommit.js

@@ -0,0 +1,80 @@
+/* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+SPDX-License-Identifier: Apache-2.0
+ABOUT THIS NODE.JS EXAMPLE: This example works with AWS SDK for JavaScript version 3 (v3),
+which is available at https://github.com/aws/aws-sdk-js-v3. For information about how AWS CodeCommit works,
+see https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html.
+
+Purpose:
+putFile.js adds or updates a file in a branch in an AWS CodeCommit repository,
+and generates a commit for the addition in the specified branch.
+
+Inputs (replace in code):
+- BRANCH
+- REPOSITORY_NAME
+- PATH_AND_FILENAME_WITHIN_REPO
+- SOURCE_PATH_AND_FILENAME (optional)
+
+Running the code:
+node putFile.js
+*/
+// snippet-start:[codeCommit.JavaScript.putFileV3]
+// Get service clients module and commands using ES6 syntax.
+import {
+  CreateCommitCommand,
+  GetBranchCommand,
+} from "@aws-sdk/client-codecommit";
+import { codeCommitClient } from "./libs/codeCommitClient.js";
+
+const BRANCH = "BRANCH";
+const REPO = "REPO_NAME";
+
+export const getBranchParams = {
+  branchName: BRANCH,
+  repositoryName: REPO,
+};
+
+// Add or update the file.
+export const run = async () => {
+  try {
+    const data = await codeCommitClient.send(
+      new GetBranchCommand(getBranchParams)
+    );
+    return data; // For unit tests.
+    const COMMIT_ID = data.branch.commitId;
+   const createCommitParams = {
+      branchName: BRANCH /* required */,
+      repositoryName: REPO /* required */,
+      parentCommitId: COMMIT_ID /* required */,
+      putFiles: [
+        {
+          /* Required. The full path to the file in the repository,
+          including the name of the file. For example, 'js/index.js'  */
+          filePath: "PATH_AND_FILENAME_WITHIN_REPO",
+          /* Content to be committed to the file. Required if sourceFile is not specified.*/
+           fileContent: Buffer.from("STRING"),
+          /* The name and full path of the file that contains the
+          changes you want to make as part of the commit. Required if fileContent
+          is not specified.*/
+          sourceFile: {
+            /* Required. The full path to the file, including the name of the file. */
+            filePath: "SOURCE_PATH_AND_FILENAME",
+          },
+        },
+        /* more items */
+      ],
+    };
+    try {
+      const data = await codeCommitClient.send(
+        new CreateCommitCommand(createCommitParams)
+      );
+      console.log("Success", data.branch.commitId);
+      return data; // For unit tests.
+    } catch (err) {
+      console.log("Error", err);
+    }
+  } catch (err) {
+    console.log("Error", err);
+  }
+};
+run();
+// snippet-end:[codeCommit.JavaScript.putFileV3]

javascriptv3/example_code/codecommit/src/createPullRequest.js

@@ -0,0 +1,44 @@
+/* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+SPDX-License-Identifier: Apache-2.0
+ABOUT THIS NODE.JS EXAMPLE: This example works with AWS SDK for JavaScript version 3 (v3),
+which is available at https://github.com/aws/aws-sdk-js-v3. For information about how AWS CodeCommit works,
+see https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html.
+
+Purpose:
+createProject.js Creates a pull request in the specified repository using AWS CodeCommit.
+
+Inputs (replace in code):
+- REPOSITORY_NAME
+- SOURCE_REFERENCE
+- DESTINATION_REFERENCE
+
+
+Running the code:
+node createPullRequest.js
+*/
+// snippet-start:[codeCommit.JavaScript.createPRV3]
+// Get service clients module and commands using ES6 syntax.
+import { CreatePullRequestCommand } from "@aws-sdk/client-codecommit";
+import { codeCommitClient } from "./libs/codeCommitClient.js";
+
+// Set the parameters.
+
+export const params = {
+    repositoryName: 'STRING_VALUE', /* required */
+    sourceReference: 'STRING_VALUE', /* required. The branch of the repository that contains the changes for the pull request. */
+    destinationReference: 'STRING_VALUE' /* The branch of the repository where the pull request changes are merged. */
+};
+
+// Create the AWS CodeDeploy repository.
+export const run = async () => {
+    try {
+        const data = await codeCommitClient.send(new CreatePullRequestCommand(params));
+        console.log("Success", data);
+        return data; // For unit tests.
+    } catch (err) {
+        console.log("Error", err);
+    }
+};
+run();
+// snippet-end:[codeCommit.JavaScript.createPRV3]
+

javascriptv3/example_code/codecommit/src/createRepository.js

@@ -0,0 +1,39 @@
+/* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+SPDX-License-Identifier: Apache-2.0
+ABOUT THIS NODE.JS EXAMPLE: This example works with AWS SDK for JavaScript version 3 (v3),
+which is available at https://github.com/aws/aws-sdk-js-v3. For information about how AWS CodeCommit works,
+see https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html.
+
+Purpose:
+createRepository.js demonstrates how to create an AWS CodeCommit repository.
+
+Inputs (replace in code):
+- REPOSITORY_NAME
+
+Running the code:
+node createRepository.js
+*/
+// snippet-start:[codeCommit.JavaScript.createRepoV3]
+// Get service clients module and commands using ES6 syntax.
+import { CreateRepositoryCommand } from "@aws-sdk/client-codecommit";
+import { codeCommitClient } from "./libs/codeCommitClient.js";
+
+// Set the parameters.
+
+export const params = {
+    repositoryName: "REPOSITORY_NAME"
+};
+
+// Create the AWS CodeDeploy repository.
+export const run = async () => {
+    try {
+        const data = await codeCommitClient.send(new CreateRepositoryCommand(params));
+        console.log("Success", data);
+        return data; // For unit tests.
+    } catch (err) {
+        console.log("Error", err);
+    }
+};
+run();
+// snippet-end:[codeCommit.JavaScript.createRepoV3]
+

javascriptv3/example_code/codecommit/src/deleteBranch.js

@@ -0,0 +1,42 @@
+/* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+SPDX-License-Identifier: Apache-2.0
+ABOUT THIS NODE.JS EXAMPLE: This example works with AWS SDK for JavaScript version 3 (v3),
+which is available at https://github.com/aws/aws-sdk-js-v3. For information about how AWS CodeCommit works,
+see https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html.
+
+Purpose:
+deleteBranch.js deletes a branch from a repository, unless that branch is the default branch for the repository.
+
+Inputs (replace in code):
+- BRANCH_NAME
+- REPOSITORY_NAME
+
+Running the code:
+node deleteBranch.js
+*/
+
+// snippet-start:[codeCommit.JavaScript.deleteBranchV3]
+// Get service clients module and commands using ES6 syntax.
+import { DeleteBranchCommand } from "@aws-sdk/client-codecommit";
+import { codeCommitClient } from "./libs/codeCommitClient.js";
+
+// Set the parameters.
+
+export const params = {
+    branchName: 'BRANCH_NAME', /* required */
+    repositoryName: 'REPOSITORY_NAME' /* required */
+};
+
+// Delete the branch.
+export const run = async () => {
+    try {
+        const data = await codeCommitClient.send(new DeleteBranchCommand(params));
+        console.log("Success", data);
+        return data; // For unit tests.
+    } catch (err) {
+        console.log("Error", err);
+    }
+};
+run();
+// snippet-end:[codeCommit.JavaScript.deleteBranchV3]
+

javascriptv3/example_code/codecommit/src/deleteRepository.js

@@ -0,0 +1,38 @@
+/* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+SPDX-License-Identifier: Apache-2.0
+ABOUT THIS NODE.JS EXAMPLE: This example works with AWS SDK for JavaScript version 3 (v3),
+which is available at https://github.com/aws/aws-sdk-js-v3. For information about how AWS CodeCommit works,
+see https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html.
+
+Purpose:
+deleteRepository.js demonstrates how to delete an AWS CodeBuild repo.
+
+Inputs (replace in code):
+- REPOSITORY_NAME
+
+Running the code:
+node deleteRepository.js
+*/
+// snippet-start:[codeCommit.JavaScript.deleteRepoV3]
+// Get service clients module and commands using ES6 syntax.
+import { DeleteRepositoryCommand } from "@aws-sdk/client-codecommit";
+import { codeCommitClient } from "./libs/codeCommitClient.js";
+
+// Set the parameters.
+export const params = {
+    repositoryName: "REPOSITORY_NAME"
+};
+
+// Delete the AWS CodeDeploy repository.
+export const run = async () => {
+    try {
+        const data = await codeCommitClient.send(new DeleteRepositoryCommand(params));
+        console.log("Success", data);
+        return data; // For unit tests.
+    } catch (err) {
+        console.log("Error", err);
+    }
+};
+run();
+// snippet-end:[codeCommit.JavaScript.deleteRepoV3]
+

javascriptv3/example_code/codecommit/src/describePullRequestEvents.js

@@ -0,0 +1,44 @@
+/* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+SPDX-License-Identifier: Apache-2.0
+ABOUT THIS NODE.JS EXAMPLE: This example works with AWS SDK for JavaScript version 3 (v3),
+which is available at https://github.com/aws/aws-sdk-js-v3. For information about how AWS CodeCommit works,
+see https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html.
+
+Purpose:
+describePullRequestEvents.js returns information about one or more pull request events.
+
+Inputs (replace in code):
+- PULL_REQUEST_ID
+- EVENT_TYPE (optional)
+
+Running the code:
+node describePullRequestEvents.js
+*/
+// snippet-start:[codeCommit.JavaScript.describePREventsV3]
+// Get service clients module and commands using ES6 syntax.
+import { DescribePullRequestEventsCommand } from "@aws-sdk/client-codecommit";
+import { codeCommitClient } from "./libs/codeCommitClient.js";
+
+// Set the parameters.
+
+export const params = {
+    pullRequestId: 'PULL_REQUEST_ID', /* required */
+    /* Optional. Options include PULL_REQUEST_CREATED | PULL_REQUEST_STATUS_CHANGED | PULL_REQUEST_SOURCE_REFERENCE_UPDATED |
+    PULL_REQUEST_MERGE_STATE_CHANGED | PULL_REQUEST_APPROVAL_RULE_CREATED | PULL_REQUEST_APPROVAL_RULE_UPDATED |
+    PULL_REQUEST_APPROVAL_RULE_DELETED | PULL_REQUEST_APPROVAL_RULE_OVERRIDDEN | PULL_REQUEST_APPROVAL_STATE_CHANGED */
+    pullRequestEventType: 'EVENT_TYPE'
+};
+
+// Describe the PR event.
+export const run = async () => {
+    try {
+        const data = await codeCommitClient.send(new DescribePullRequestEventsCommand(params));
+        console.log("Success", data);
+        return data; // For unit tests.
+    } catch (err) {
+        console.log("Error", err);
+    }
+};
+run();
+// snippet-end:[codeCommit.JavaScript.describePREventsV3]
+