Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/devenes/maven-server-automation

Purpose of the this hands-on project is to have understanding about how to use Maven with Java as a build tool.
https://github.com/devenes/maven-server-automation

aws cloudformation java jdk maven maven-plugin maven-pom maven-repository terraform

Last synced: 9 days ago
JSON representation

Purpose of the this hands-on project is to have understanding about how to use Maven with Java as a build tool.

Host: GitHub
URL: https://github.com/devenes/maven-server-automation
Owner: devenes
License: apache-2.0
Created: 2022-05-23T17:27:51.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2022-05-26T19:27:31.000Z (over 2 years ago)
Last Synced: 2024-11-09T07:35:09.748Z (2 months ago)
Topics: aws, cloudformation, java, jdk, maven, maven-plugin, maven-pom, maven-repository, terraform
Language: Java
Homepage: https://devenes.github.io/maven-server-automation/
Size: 5.78 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Maven As a Build Tool

[![pages-build-deployment](https://github.com/devenes/maven-server-automation/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/devenes/maven-server-automation/actions/workflows/pages/pages-build-deployment) Github top language

## :dart: About ##

Purpose of the this hands-on project is to have the understanding about how to use Maven with Java as a build tool.

## :rocket: Technologies ##

The following tools were used in this project:

- [Java](https://www.java.com/en/download/)
- [Maven](https://maven.apache.org/)
- [Git](https://git-scm.com/)
- [Terraform](https://www.terraform.io/)

## :white_check_mark: Requirements ##

Before starting :checkered_flag:, you need to have [Java](https://www.java.com/), [Maven](https://maven.apache.org/) and [Git](https://git-scm.com/) installed.

## :checkered_flag: Starting ##

### Learning Outcomes

At the end of the this hands-on training, you will be able to;

- install Maven and Java-11 on Amazon Linux 2 EC2 instance

- explain various build phases of a Java Application

- use Maven's clean, compile, package, install and site commands

## Outline

- Part 1 - Launch Amazon Linux 2 EC2 Instance with Cloudformation Template

- Part 2 - Generate a Java application using Maven's Archetype Plugin

- Part 3 - Run Maven Commands

## Part 1 - Launch Amazon Linux 2 EC2 Instance and Connect with SSH

- Launch an EC2 instance using ```maven-java-template.yml``` file located in this folder.
- This template will create an EC2 instance with Java-11 and Maven.

- Connect to your instance with SSH.

- Check if you can see the Maven's binary directory under ```/home/ec2-user/```.

- Run the command below to check if Java is available.

```bash
java -version
```

- Cat ```~/.bash_profile``` file to check if Maven's path is correctly transferred. If not paste the necessary lines manually.

```
# Append the lines below into ~/.bash_profile file by making necessary changes.
M2_HOME=/home/ec2-user/
export PATH=$PATH:$M2_HOME/bin
```

- Run the command below to check if mvn commands are available.

```bash
mvn --version
```

- If not, run the command below and wait for the EC2 machine to get ready.

```bash
sudo reboot
```

## Part 2 - Generate a Java application using Maven's Archetype Plugin

- Run the command below to produce an outline of a Java project with Maven.

```bash
mvn archetype:generate -DgroupId=com.devenes.maven -DartifactId=maven-experiment -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
```

- Cd into the project folder.

- Run the command below to be able to use tree command.

```bash
sudo yum install -y tree
```

- Run the command below to show the directory structure of the project.

```bash
tree
```

- Go into the folder where App.java resides and ```cat``` the auto generated ```hello world``` application in Java.

- Replace the content of the App.java file with the content of the App.java file in this repo.

- Go into the project's root folder.

- Replace the content of the ```pom.xml``` file with the content of the pom.xml file in this repo.

- Since we've install Java-11 on the EC2 machine, uncomment the ```properties``` tag of the new pom.xml file.

- Explain that the ```maven.compiler.source``` property specifies the version of source code accepted and the ```maven.compiler.target``` generates class files compatible with the specified version of JVM.

- Explain that ```dependencyManagement``` section in the pom file will import multiple dependencies with compatible versions.

## Part 3 - Run Maven Commands

>### mvn compile

- Run the command below.

```bash
mvn compile
```

- Go into the folder ```/target/classes/``` and show the class file.

- Run the command below to show how to test a Maven project.

>### mvn clean test

```bash
mvn clean test
```

- Show that there is a new folder named ```target``` in the project root.

- inspect the target folder with tree command.

- Show the content of the file ```/target/surefire-report/com.devenes.maven.AppTest.txt``` as the output of the test.

>### mvn package

- Run the command below.

```bash
mvn clean package
```

- Go into the folder ```/target/``` and show the ```maven-experiment-1.0-SNAPSHOT.jar``` file as the output of the ```mvn package``` command.

- Run the command below to start the application.

```bash
java -jar maven-experiment-1.0-SNAPSHOT.jar
```

- Explain the error in the standard output.
- Maven's jar file is not an executable jar file. The jar file does not have both the ```Main Class``` and the necessary packages to run the application.

- Add the plugin below to the pom file and run ```mvn clean package``` command again.

```xml

org.apache.maven.plugins
maven-assembly-plugin

package

single

com.devenes.maven.App

jar-with-dependencies

```

```bash
mvn clean package
```

>### Run The Application

- Now, open up a fresh terminal on your local computer and run the command below.

```bash
scp -i -r /.aws ec2-user@:/home/ec2-user/
```

- Check if the the credentials are transferred to EC2 instance.

- Go into your target folder.

- Run the command below to start the application. This time we are running the executable jar file with suffix ```jar-with-dependencies```.

```bash
java -jar maven-experiment-1.0-SNAPSHOT-jar-with-dependencies.jar
```

- Explain what the application does in the background.
- Note that to be able see the object and the S3 bucket, we should comment the lines 142 and 150.

>### mvn install

- Run the command below to install our own package into .m2 folder.

```bash
mvn install
```

- Go into ```~/.m2/repository``` folder and show where our package is installed.

>### mvn site

- Add two more plugins to run the command ```mvn site```

```xml

org.apache.maven.plugins
maven-site-plugin
3.7.1

org.apache.maven.plugins
maven-project-info-reports-plugin
3.0.0

```

- Run the command below.

```bash
mvn clean site
```

- Show the output ```site``` directory under target directory.

- Run the command below to install Apache Server.

```bash
sudo yum install -y httpd
sudo systemctl start httpd
sudo systemctl enable httpd
```

- Run the command below to copy the contents of the site folder under ```/var/www/html``` folder.

```bash
sudo cp -a site/. /var/www/html
```

or start the server with the command below.

```bash
python3 -m http.server
```

## Run the Application on AWS

```java
java -jar maven-experiment-1.0-SNAPSHOT-jar-with-dependencies.jar
```

- Output:

```bash
===========================================
Getting Started with Amazon S3
===========================================

Creating bucket my-first-s3-bucket-d7b250f9-be4d-4534-bc22-9c32d83dc3b1

Listing buckets
- cf-templates-1qe8zcgon5jhvi2-us-east-1
- my-first-s3-bucket-d7b250f9-be4d-4534-bc22-9c32d83dc3b1
- terraform-12321env-bucket

Uploading a new object to S3 from a file

May 26, 2022 2:19:30 PM com.amazonaws.util.Base64 warn
WARNING: JAXB is unavailable. Will fallback to SDK implementation which may be less performant.If you are using Java 9+, you will need to include javax.xml.bind:jaxb-api as a dependency.
Downloading an object
Content-Type: text/plain
abcdefghijklmnopqrstuvwxyz
01234567890112345678901234
!@#$%^&*()-=[]{};':',.<>/?
01234567890112345678901234
abcdefghijklmnopqrstuvwxyz

Listing objects
- MyObjectKey (size = 135)

Deleting an object

Deleting bucket my-first-s3-bucket-d7b250f9-be4d-4534-bc22-9c32d83dc3b1
```

## :memo: License ##

This project is under license from Apache. For more details, see the [LICENSE](LICENSE) file.

Made with :heart: by devenes