TaskPlanner for AWS

A simple task planner API for listing tasks grouped by lists and managing them

Stack

• Kotlin, Java with GraalVM (for native compilation)
• Quarkus, the Supersonic Subatomic Java Framework.
• TestContainers, RESTEasy, RESTAssured
• AWS Lambda, AWS API Gateway, AWS Dynamodb
• AWS SAM CLI (for local testing and AWS Deploy): SAM = Serverless Application Model

Project status - Sonar analysis

Build and Deploy

There are two deploy options available: JVM and native executables. Bellow are the instructions for each one

Option 1 - Building and deploying native executable

Creating a native executable

You can create a native executable using:

./gradlew build -Dquarkus.package.type=native

Or, if you don't have GraalVM installed, you can run the native executable build in a container using:

./gradlew build -Dquarkus.package.type=native -Dquarkus.native.container-build=true

Deploying a native executable

• You can then test the executable locally with sam local sam local start-api --template build/sam.native.yaml

• To deploy to AWS Lambda: sam deploy -t build/sam.native.yaml -g

Option 2 - Building and deploying JVM executable

Creating a JVM executable

You can create a native executable using:

./gradlew build

Deploying a JVM executable

• You can then test the executable locally with sam local sam local start-api --template build/sam.jvm.yaml

• To deploy to AWS Lambda: sam deploy -t build/sam.jvm.yaml -g

Deploy error tips

If you get an error similar to this one: "An error occurred (SignatureDoesNotMatch) when calling the CreateChangeSet operation: Signature expired: 20220619T193119Z is now earlier than 20220619T193604Z (20220619T194104Z - 5 min.)" run following command to sync your PC date and time:

sudo date -s "$(wget -qSO- --max-redirect=0 google.com 2>&1 | grep Date: | cut -d' ' -f5-8)Z"

Running the application in dev mode

As this is a quarkus application, you can run it using its developer mode that enables live coding using:

./gradlew quarkusDev

or in debug mode

./gradlew quarkusDev --debug

Running dynamoDb locally in dev mode

docker run --publish 8000:8000 amazon/dynamodb-local:1.11.477 -jar DynamoDBLocal.jar -inMemory -sharedDb

This starts a DynamoDB instance that is accessible on port 8000. You can check it’s running by accessing the web shell on http://localhost:8000/shell. Open "http://localhost:8000/shell" in your browser.

Copy and paste the following code to the shell and run it:

var params = {
TableName: 'TaskLists',
KeySchema: [{ AttributeName: 'id', KeyType: 'HASH' }],
AttributeDefinitions: [{  AttributeName: 'id', AttributeType: 'S', }],
ProvisionedThroughput: { ReadCapacityUnits: 1, WriteCapacityUnits: 1, }
};

dynamodb.createTable(params, function(err, data) {
if (err) ppJson(err);
else ppJson(data);

});

params = {
TableName: 'Tasks',
KeySchema: [{ AttributeName: 'id', KeyType: 'HASH' }],
AttributeDefinitions: [{  AttributeName: 'id', AttributeType: 'S', }],
ProvisionedThroughput: { ReadCapacityUnits: 1, WriteCapacityUnits: 1, }
};

dynamodb.createTable(params, function(err, data) {
if (err) ppJson(err);
else ppJson(data);

});

params = {
TableName: 'Quotations',
KeySchema: [{ AttributeName: 'id', KeyType: 'HASH' }],
AttributeDefinitions: [{  AttributeName: 'id', AttributeType: 'S', }],
ProvisionedThroughput: { ReadCapacityUnits: 1, WriteCapacityUnits: 1, }
};

dynamodb.createTable(params, function(err, data) {
if (err) ppJson(err);
else ppJson(data);

});

accessing swagger UI

http://localhost:8080/q/swagger-ui

accessing OpenAPI definition

http://localhost:8080/q/openapi

creating dynamodb table on your aws:

aws dynamodb create-table --table-name TaskLists \
--attribute-definitions AttributeName=id,AttributeType=S \
--key-schema AttributeName=id,KeyType=HASH \
--provisioned-throughput ReadCapacityUnits=1,WriteCapacityUnits=1

aws dynamodb create-table --table-name Tasks \
--attribute-definitions AttributeName=id,AttributeType=S \
--key-schema AttributeName=id,KeyType=HASH \
--provisioned-throughput ReadCapacityUnits=1,WriteCapacityUnits=1

aws dynamodb create-table --table-name Quotations \
--attribute-definitions AttributeName=id,AttributeType=S \
--key-schema AttributeName=id,KeyType=HASH \
--provisioned-throughput ReadCapacityUnits=1,WriteCapacityUnits=1

SonarCloud Integration:

Change sonarqube properties on build.gradle file to your SonarCloud configs

To generate JaCoCo coverage reports, run:

./gradlew test

To upload coverage data to SonarCloud:

export SONAR_TOKEN=YOUR_SONAR_KEY

./gradlew sonarqube