ContextQMD
Back to Aws Doc Sdk Examples

AWS CodeCommit Java code examples

javav2/example_code/codecommit/README.md

latest4.6 KB
Original Source

AWS CodeCommit Java code examples

This README discusses how to run and test the Java code examples for AWS CodeCommit.

Running the AWS CodeCommit Java files

IMPORTANT

The Java examples perform AWS operations for the account and AWS Region for which you've specified credentials, and you may incur AWS service charges by running them. See the AWS Pricing page for details about the charges you can expect for a given service and operation.

Some of these examples perform destructive operations on AWS resources, such as deleting a branch. Be very careful when running an operation that deletes or modifies AWS resources in your account. It's best to create separate test-only resources when experimenting with these examples.

To run these examples, you can setup your development environment to use Apache Maven or Gradle to configure and build AWS SDK for Java projects. For more information, see Get started with the AWS SDK for Java 2.x.

Testing the AWS CodeCommit files

You can test the Java code examples for AWS CodeCommit by running a test file named CodeCommitTest. This file uses JUnit 5 to run the JUnit tests and is located in the src/test/java folder. For more information, see https://junit.org/junit5/.

You can execute the JUnit tests from a Java IDE, such as IntelliJ, or from the command line by using Maven. As each test is ran, you can view messages that inform you if the various tests succeed or fail. For example, the following message informs you that Test 3 passed.

Test 3 passed

WARNING: Running these JUnit tests manipulates real Amazon resources and may incur charges on your account.

Properties file

Before running the AWS CodeCommit JUnit tests, you must define values in the config.properties file located in the resources folder. This file contains values that are required to execute the JUnit tests. For example, you define a repository name. If you do not define all values, the JUnit tests fail.

Define these values to successfully run the JUnit tests:

  • newRepoName - The name of a new repository to create.
  • existingRepoName – The name of an existing repository (if one does not exist, create it using the AWS Web Console).
  • targetBranch – The branch where the merge is applied.
  • newBranchName – The name of a new branch.
  • existingBranchName – The name of an existing branch (if one does not exist, create it using the AWS Web Console).
  • filePath – The location of the file on the local drive (i.e., C:\AWS\uploadGlacier.txt).
  • email – The email of the user whom uploads the file.
  • name – The name of the user.
  • repoPath – The location in the repository to store the file for the PutFile test (for example, /uploadGlacier.txt).
  • branchCommitId – The full commit ID of the head commit in the branch (you can obtain from value from the CodeCommit section located in the AWS Console).
  • prID – The id of the pull request.

Note: If the branchCommitId value is not the latest ID value, the tests will fail.

Command line

To execute the JUnit tests from the command line, you can use the following command.

	mvn test

You will see output from the JUnit tests, as shown here.

[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
[INFO] Running CodeCommitTest
Test 1 passed
Test 2 passed
...
Done!
[INFO] Results:
[INFO]
[INFO] Tests run: 12, Failures: 0, Errors: 0, Skipped: 0
[INFO]
INFO] --------------------------------------------
[INFO] BUILD SUCCESS
[INFO]--------------------------------------------
[INFO] Total time:  12.003 s
[INFO] Finished at: 2020-02-10T14:25:08-05:00
[INFO] --------------------------------------------

Unsuccessful tests

If you do not define the correct values in the properties file, your JUnit tests are not successful. You will see an error message such as the following. You need to double-check the values that you set in the properties file and run the tests again.

[INFO]
[INFO] --------------------------------------
[INFO] BUILD FAILURE
[INFO] --------------------------------------
[INFO] Total time:  19.038 s
[INFO] Finished at: 2020-02-10T14:41:51-05:00
[INFO] ---------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:2.22.1:test (default-test) on project S3J2Project:  There are test failures.
[ERROR];