Merge pull request #88 from TrueSparrowSystems/milestone/v0.2.0

New API Endpoints, AWS Secrets and Security Updates

.github/workflows/run_tests.yaml

@@ -4,15 +4,51 @@ on:
   pull_request:
     branches:
       - master
+      - milestone/*
+
 env:
   ENVIRONMENT: test
-  AWS_ACCESS_KEY_ID: local
-  AWS_SECRET_ACCESS_KEY: local
+  AWS_ACCESS_KEY_ID: ${{ secrets.PLG_PROD_ACCESS_KEY }}
+  AWS_SECRET_ACCESS_KEY: ${{ secrets.PLG_PROD_SECRET_KEY }}
   AWS_REGION: us-east-1
 
 jobs:
   test:
     runs-on: ubuntu-latest
+    services:
+      memcached:
+        image: memcached:1.6.21
+        ports:
+          - 11211:11211
+
+      dynamodb:
+        image: amazon/dynamodb-local:latest
+        ports:
+          - 8000:8000
+
     steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v2
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+
+      - name: Build Custom docker file for KMS
+        run: |
+          echo "Building docker image"
+          docker build -t local-kms -f Dockerfile.github .
+          echo "Starting docker container for local-kms"
+          docker run -d --name localkms -p 4599:8080 -e AWS_ACCESS_KEY_ID=${{ env.AWS_ACCESS_KEY_ID }} -e AWS_SECRET_ACCESS_KEY=${{ env.AWS_SECRET_ACCESS_KEY }} -e AWS_REGION=us-east-1 -e KMS_ACCOUNT_ID=111122223333 -e KMS_REGION=us-east-1 -e KMS_SEED_PATH=seed.yaml local-kms
+
+      - name: Log into Docker Container
+        run: |
+          echo "Checking seed path"
+          seed_path=$(docker exec localkms ls /init)
+          echo "Seed path: $seed_path"
+
       - run: |-
-          echo "Running test cases"
+          echo "Start: run test cases"
+          sh ./mvnw clean test
+          echo "Done: run test cases"

.gitignore

@@ -38,6 +38,8 @@ build/
 ### Environment Variables ###
 .env
 set*_env_vars.sh
+secrets.json
+test.secrets.json
 
 ### Logs files ###
 *.log

Dockerfile.github

@@ -0,0 +1,7 @@
+FROM nsmithuk/local-kms
+
+EXPOSE 8080
+
+# Add a file to the image
+WORKDIR /init
+COPY init/seed.yaml /init

Dockerfile.local

@@ -1,14 +1,19 @@
-FROM openjdk:17-jdk-alpine
-# Set working directory
+# Use the openjdk 17 with alpine as a base image
+FROM openjdk:17-jdk-alpine as builder
 
+# Create and set the working directory inside the container
 RUN mkdir -p /app
 WORKDIR /app
 
-COPY . /app
+# Install bash for Alpine and other necessary tools
+RUN apk add --no-cache bash maven
 
-# Expose port 8080 for the app to listen on
-EXPOSE 8080
-# Start the app
-RUN apk add --no-cache bash
+# Copy the pom.xml and download dependencies
+COPY ./pom.xml ./pom.xml
+RUN mvn dependency:go-offline
 
-CMD ["sh", "-c", "start_local.sh"]
+# Copy the rest of the application
+COPY ./ ./
+
+# Expose the port 8080 for the application
+EXPOSE 8080

README.md

@@ -3,17 +3,26 @@
 This repository contains salessparrow apis.
 
 ## Local Setup
-Please follow the steps in [LOCAL_SETUP](LOCAL_SETUP.md) to setup the project locally.
+Follow the steps in [LOCAL_SETUP](repo-docs/LOCAL_SETUP.md) to setup the project locally.
+
+## Environment Variables
+Refer to [ENVIRONMENT_VARS](repo-docs/ENVIRONMENT_VARS.md) for detailed descriptions for the environment variables.
 
 ## Project Structure
-Please refer to [PROJECT_STRUCTURE](PROJECT_STRUCTURE.md) for details on the project structure.
+Refer to [PROJECT_STRUCTURE](repo-docs/PROJECT_STRUCTURE.md) for details on the project structure.
+
+## Changelog
+Stay up-to-date with the latest changes and improvements in our API by referring to our [CHANGELOG](repo-docs/CHANGELOG.md).
+
+## Release Process
+Refer to [RELEASE_PROCESS](repo-docs/RELEASE_PROCESS.md) to ensure smooth and consistent software releases. This process outlines the steps to prepare, package, and distribute new versions of our software.
 
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
 
 ## Contributing
-Contributions to the project are welcome! Please see our guidelines on how to [CONTRIBUTE](CONTRIBUTING.md).
+Contributions to the project are welcome! Please see our guidelines on how to [CONTRIBUTE](repo-docs/CONTRIBUTING.md).
 
 ## Code of Conduct
-This project has a code of conduct that outlines expected behavior for contributors and users. Please read the [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) file before getting involved.
+This project has a code of conduct that outlines expected behavior for contributors and users. Please read the [CODE_OF_CONDUCT](repo-docs/CODE_OF_CONDUCT.md) file before getting involved.

docker-compose.yml

@@ -1,38 +1,83 @@
-version: '3'
+version: "3"
 services:
-  # App server provisioning
   api:
     build:
       context: .
       dockerfile: Dockerfile.local
     ports:
-      - '8080:8080'
+      - "8080:8080"
     networks:
       - localdev
     volumes:
-      - './:/app'
-    command: bash -c 'sh start_local.sh'
+      - "./:/app"
+      - "~/.m2:/root/.m2"
+    environment:
+      - ENVIRONMENT=development
+      - AWS_ACCESS_KEY_ID=local
+      - AWS_SECRET_ACCESS_KEY=local
+      - AWS_REGION=us-east-1
+    command: ["./mvnw", "spring-boot:run"]
+    depends_on:
+      - dynamodb
+      - localkms
+      - memcached
+
+  test:
+    build:
+      context: .
+      dockerfile: Dockerfile.local
+    ports:
+      - "8080:8080"
+    networks:
+      - localdev
+    volumes:
+      - "./:/app"
+      - "~/.m2:/root/.m2"
+    environment:
+      - ENVIRONMENT=local-test
+      - AWS_ACCESS_KEY_ID=local
+      - AWS_SECRET_ACCESS_KEY=local
+      - AWS_REGION=us-east-1
+    command: ["./mvnw", "clean", "test", "jacoco:report"]
+    depends_on:
+      - dynamodb
+      - localkms
+      - memcached
 
-  # Memcached provisioning
   memcached:
     image: memcached
     ports:
-      - '11211:11211'
+      - "11211:11211"
     networks:
       - localdev
-
-  # DynamoDB provisioning
+
+  localkms:
+    image: nsmithuk/local-kms
+    ports:
+      - "4599:8080"
+    volumes:
+      - ./init:/init
+    networks:
+      - localdev
+    environment:
+      - AWS_ACCESS_KEY_ID='local'
+      - AWS_SECRET_ACCESS_KEY='local'
+      - AWS_REGION='us-east-1'
+      - KMS_ACCOUNT_ID='111122223333'
+      - KMS_REGION='us-east-1'
+      - KMS_SEED_PATH=init/seed.yaml
+
   dynamodb:
     image: amazon/dynamodb-local:latest
     ports:
-      - '8000:8000'
+      - "8000:8000"
     networks:
       - localdev
     volumes:
-     - "./docker/dynamodb:/home/dynamodblocal/data"
+      - "./docker/dynamodb:/home/dynamodblocal/data"
     working_dir: /home/dynamodblocal
-    command: '-jar DynamoDBLocal.jar -sharedDb -dbPath ./data'
+    command: "-jar DynamoDBLocal.jar -sharedDb -dbPath ./data"
 
 networks:
   localdev:
-    driver: bridge
+    driver: bridge

init/seed.yaml

@@ -0,0 +1,17 @@
+# This file is used to seed the local KMS instance with keys and aliases.
+# The keys and aliases defined here will be created when the KMS instance is
+# first started.  If the keys or aliases already exist, they will not be
+# modified.
+# This is for testing purposes only.
+
+Keys:
+  Symmetric:
+    Aes:
+      - Metadata:
+          KeyId: bc436485-5092-42b8-92a3-0aa8b93536dc
+        BackingKeys:
+          - 5cdaead27fe7da2de47945d73cd6d79e36494e73802f3cd3869f1d2cb0b5d7a9
+
+Aliases:
+  - AliasName: alias/testing
+    TargetKeyId: bc436485-5092-42b8-92a3-0aa8b93536dc