This sample code helps get you started with a simple Java web application deployed by AWS CodeDeploy to an Amazon EC2 server.
This sample includes:
- README.md - this file
- appspec.yml - this file is used by AWS CodeDeploy when deploying the web application to EC2
- buildspec.yml - this file is used by AWS CodeBuild to build the web application
- pom.xml - this file is the Maven Project Object Model for the web application
- src/main - this directory contains your Java service source files
- src/test - this directory contains your Java service unit test files
- scripts/ - this directory contains scripts used by AWS CodeDeploy when installing and deploying your application on the Amazon EC2 instance
These directions assume you want to develop on your local computer, and not from the Amazon EC2 instance itself. If you're on the Amazon EC2 instance, the virtual environment is already set up for you, and you can start working on the code.
To work on the sample code, you'll need to clone your project's repository to your local computer. If you haven't, do that first. You can find instructions in the AWS CodeStar user guide.
-
Install maven. See https://maven.apache.org/install.html for details.
-
Install tomcat. See https://tomcat.apache.org/tomcat-7.0-doc/setup.html for details.
-
Build the application.
$ mvn -f pom.xml compile $ mvn -f pom.xml package -
Copy the built application to the Tomcat webapp directory. The actual location of that directory will vary depending on your platform and installation.
$ cp target/ROOT.war <tomcat webapp directory> -
Restart your tomcat server
-
Open http://127.0.0.1:8080/ in a web browser to view your application.
Once you have a virtual environment running, you can start making changes to the sample Java web application. We suggest making a small change to /src/main/webapp/WEB-INF/views/index.jsp first, so you can see how changes pushed to your project's repository are automatically picked up by your project pipeline and deployed to the Amazon EC2 instance. (You can watch the pipeline progress on your project dashboard.) Once you've seen how that works, start developing your own code, and have fun!
To run your tests locally, go to the root directory of the sample code and run the
mvn clean compile test command, which AWS CodeBuild also runs through your buildspec.yml file.
To test your new code during the release process, modify the existing tests or add tests to the tests directory. AWS CodeBuild will run the tests during the build stage of your project pipeline. You can find the test results in the AWS CodeBuild console.
Learn more about Maven's Standard Directory Layout.
Learn more about AWS CodeBuild and how it builds and tests your application here: https://docs.aws.amazon.com/codebuild/latest/userguide/concepts.html
Learn more about AWS CodeStar by reading the user guide. Ask questions or make suggestions on our forum.
User Guide: http://docs.aws.amazon.com/codestar/latest/userguide/welcome.html