Initial commit

.github/actions/ci-setup/action.yml

@@ -0,0 +1,22 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: 'setup'
+description: 'CI setup, such as installing JDK'
+
+runs:
+  using: "composite"
+  steps:
+    - name: Set up JDK
+      uses: QubitPi/jersey-webservice-deployment-actions/.github/actions/jdk-setup@master

.github/pull_request_template.md

@@ -0,0 +1,21 @@
+Changelog
+---------
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+Checklist
+---------
+
+- [ ] Test
+- [ ] Self-review
+- [ ] Documentation

.github/workflows/ci-cd.yml

@@ -0,0 +1,126 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+---
+name: Template CI/CD
+
+"on":
+  pull_request:
+  push:
+    branches:
+      - master
+
+env:
+  JDK_VERSION: 17
+  JDK_DISTRIBUTION: 'adopt'
+  USER: QubitPi
+  EMAIL: jack20220723@gmail.com
+
+jobs:
+  yml-md-style-and-link-checks:
+    uses: QubitPi/hashicorp-aws/.github/workflows/yml-md-style-and-link-checks.yml@master
+
+  tests:
+    name: Unit & Integration Tests
+    needs: yml-md-style-and-link-checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Test environment setup
+        uses: ./.github/actions/ci-setup
+      - name: Set up Docker for Integration Tests
+        uses: docker-practice/actions-setup-docker@master
+      - name: Run unit & integration tests
+        run: mvn -B clean verify
+
+  documentation:
+    name: Test & Release Documentation (including Javadoc)
+    needs: tests
+    outputs:
+      outcome: ${{ job.status }}
+    continue-on-error: true
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Test environment setup
+        uses: ./.github/actions/ci-setup
+      - name: Install dependencies
+        working-directory: docs
+        run: yarn
+      - name: Build documentations
+        working-directory: docs
+        run: yarn build
+      - name: Generate Javadoc
+        run: mvn -B clean javadoc:javadoc
+      - name: Move Javadoc into documentation directory
+        if: github.ref == 'refs/heads/master'
+        run: mv target/site/apidocs/ docs/build/apidocs/
+      - name: Deploy documentation (including Javadoc) to GitHub Pages
+        if: github.ref == 'refs/heads/master'
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build
+          enable_jekyll: false
+          user_name: ${{ env.USER }}
+          user_email: ${{ env.EMAIL }}
+
+  docker-image:
+    name: Build Test & Release Development Docker Image
+    needs: tests
+    outputs:
+      outcome: ${{ job.status }}
+    continue-on-error: true
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Test environment setup
+        uses: ./.github/actions/ci-setup
+      - name: Build App WAR file so that Docker can pickup during image build
+        run: mvn clean package
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Test image build
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: false
+      - name: Login to DockerHub
+        if: github.ref == 'refs/heads/master'
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Push image to DockerHub
+        if: github.ref == 'refs/heads/master'
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true
+          tags: ${{ secrets.DOCKERHUB_USERNAME }}/jersey-webservice-template:latest
+
+  slack-notification:
+    name: Send Slack Notification
+    if: ${{ always() }}
+    needs: [documentation, docker-image]
+    uses: QubitPi/hashicorp-aws/.github/workflows/slack-notification.yml@master
+    with:
+      job-status: ${{ (needs.documentation.outputs.outcome == 'success' && needs.docker-image.outputs.outcome == 'success') && 'success' || 'failure' }}
+    secrets:
+      slack-webhook-url: ${{ secrets.SLACK_WEBHOOK_URL }}

.gitignore

@@ -0,0 +1,68 @@
+*.iml
+.idea/
+target/
+.DS_Store
+
+# Created by https://www.toptal.com/developers/gitignore/api/packer,terraform
+# Edit at https://www.toptal.com/developers/gitignore?templates=packer,terraform
+
+### Packer ###
+# Cache objects
+packer_cache/
+
+# Crash log
+crash.log
+
+# https://www.packer.io/guides/hcl/variables
+# Exclude all .pkrvars.hcl files, which are likely to contain sensitive data,
+# such as password, private keys, and other secrets. These should not be part of
+# version control as they are data points which are potentially sensitive and
+# subject to change depending on the environment.
+#
+*.pkrvars.hcl
+
+# For built boxes
+*.box
+
+### Packer Patch ###
+# ignore temporary output files
+output-*/
+
+### Terraform ###
+# Local .terraform directories
+**/.terraform/*
+
+# .tfstate files
+*.tfstate
+*.tfstate.*
+
+# Crash log files
+crash.*.log
+
+# Exclude all .tfvars files, which are likely to contain sensitive data, such as
+# password, private keys, and other secrets. These should not be part of version
+# control as they are data points which are potentially sensitive and subject
+# to change depending on the environment.
+*.tfvars
+*.tfvars.json
+
+# Ignore override files as they are usually used to override resources locally and so
+# are not checked in
+override.tf
+override.tf.json
+*_override.tf
+*_override.tf.json
+
+# Include override files you do wish to add to version control using negated pattern
+# !example_override.tf
+
+# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
+# example: *tfplan*
+
+# Ignore CLI configuration files
+.terraformrc
+terraform.rc
+
+.terraform.lock.hcl
+
+# End of https://www.toptal.com/developers/gitignore/api/packer,terraform

.lycheeignore

@@ -0,0 +1,4 @@
+file:///*
+https://querydsl.com/*
+https://uel.java.net/
+https://www.openapis.org/

Dockerfile

@@ -0,0 +1,47 @@
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+FROM ubuntu:22.04
+
+LABEL maintainer="Jiaqi (Jack) Liu"
+LABEL maintainer-email="jack20220723@gmail.com"
+
+ARG WS_VERSION=1.0-SNAPSHOT
+
+ENV JAVA_HOME /usr/lib/jvm/java-17-openjdk-amd64
+
+ENV JETTY_VERSION 11.0.15
+ENV JETTY_BASE /jetty-base
+ENV JETTY_HOME /jetty-home-$JETTY_VERSION
+ENV JETTY_WEBAPPS_DIR $JETTY_BASE/webapps
+
+RUN apt update
+RUN apt upgrade -y
+RUN apt install software-properties-common -y
+RUN apt install wget
+
+# Install JDK 17 - https://www.rosehosting.com/blog/how-to-install-java-17-lts-on-ubuntu-20-04/
+RUN apt update -y
+RUN apt install openjdk-17-jdk -y
+
+# Install and configure Jetty (for JDK 17) container
+RUN wget https://repo1.maven.org/maven2/org/eclipse/jetty/jetty-home/$JETTY_VERSION/jetty-home-$JETTY_VERSION.tar.gz
+RUN tar -xzvf jetty-home-$JETTY_VERSION.tar.gz
+RUN rm jetty-home-$JETTY_VERSION.tar.gz
+RUN mkdir jetty-base
+RUN cd jetty-base && java -jar $JETTY_HOME/start.jar --add-module=annotations,server,http,deploy,servlet,webapp,resources,jsp
+
+COPY ./target/jersey-webservice-template-$WS_VERSION.war $JETTY_WEBAPPS_DIR/ROOT.war
+
+COPY ./Dockerfile-startup.sh /Dockerfile-startup.sh
+CMD [ "/Dockerfile-startup.sh" ]

Dockerfile-startup.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+set -x
+set -e
+
+# Copyright Jiaqi Liu
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+cd $JETTY_BASE
+java -jar $JETTY_HOME/start.jar