Gradle LocalStack Plugin User Guide

buildscript {
    repositories {
        gradlePluginPortal()
    }
    dependencies {
        classpath 'com.nike.pdm.localstack:1.0.0'
    }
}

apply plugin: 'com.nike.pdm.localstack'

plugins {
    id "com.nike.pdm.localstack"    version "1.0.0"
}

task createAppStack(type: CreateCFStackTask) {
    stackName = 'catalog-products-v1'
    cfTemplate = file("cloudformation/catalog-products-resources-v1.yml")
}

./gradlew deleteCFStack --stackName=catalog-products-v1

./gradlew listCFStacks

package example.buildsrc.dynamodb;

import com.amazonaws.services.dynamodbv2.AmazonDynamoDB;
import com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBHashKey;
import com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapper;
import com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBTable;
import org.apache.commons.lang3.StringUtils;

/**
 * Loads test products into the localstack dynamodb "catalog.products" table.
 */
public class ProductTableInitializer {

    private final DynamoDBMapper mapper;

    /**
     * Creates an instance of {@link ProductTableInitializer}.
     *
     * The LocalStack Gradle plugin requires a constructor that accepts the dynamodb client
     * as a single argument.
     *
     * @param dynamoClient
     */
    public ProductTableInitializer(AmazonDynamoDB dynamoClient) {
        this.mapper = new DynamoDBMapper(dynamoClient);
    }

    /**
     * Initializes the table.
     *
     * The LocalStack Gradle plugin requires a single void method named "run" that does not
     * accept any arguments.
     */
    public void run() {
        for (int i = 0; i < 10; i++) {
            final Product product = new Product();
            product.setId(StringUtils.leftPad(Integer.toString(i), 5, "0"));
            product.setName(String.format("Widget-%s", i));
            product.setDescription(String.format("Description for Widget-%s", i));
            product.setActive(true);
            product.setCreatedAt(System.currentTimeMillis());

            mapper.save(product);
        }
    }

    /**
     * Product record to load into dynamo table.
     */
    @DynamoDBTable(tableName = "catalog.products")
    public static class Product {

        @DynamoDBHashKey
        private String id;

        private String name;
        private String description;
        private boolean active;
        private long createdAt;

        public String getId() {
            return id;
        }

        public void setId(String id) {
            this.id = id;
        }

        public String getName() {
            return name;
        }

        public void setName(String name) {
            this.name = name;
        }

        public String getDescription() {
            return description;
        }

        public void setDescription(String description) {
            this.description = description;
        }

        public boolean isActive() {
            return active;
        }

        public void setActive(boolean active) {
            this.active = active;
        }

        public long getCreatedAt() {
            return createdAt;
        }

        public void setCreatedAt(long createdAt) {
            this.createdAt = createdAt;
        }
    }
}

task setupLocalTable(type: CreateDynamoDbTableTask) {
    tableName = 'catalog.products'
    keySchema = [
            new KeySchemaElement("id", KeyType.HASH)
    ]
    attributeDefinitions = [
            new AttributeDefinition("id", ScalarAttributeType.S)
    ]
    initializer = 'example.buildsrc.dynamodb.ProductTableInitializer'
}

task setupLocalTable(type: CreateDynamoDbTableTask) {
    tableName = 'catalog.products'
    keySchema = [
            new KeySchemaElement("id", KeyType.HASH)
    ]
    attributeDefinitions = [
            new AttributeDefinition("id", ScalarAttributeType.S)
    ]
}

./gradlew deleteDynamoDbTable --tableName=catalog.products

./gradlew listDynamoDbTables

task setupS3Bucket(type: CreateS3BucketsTask) {
    buckets = [ 'catalog-product-bucket' ]
}

./gradlew deleteS3Buckets --buckets=bucket1,bucket2

./gradlew listS3Buckets

./gradlew deleteS3Buckets --buckets=bucket1,bucket2

task setupLocalQueue(type: CreateSqsQueuesTask) {
    queueNames = [ 'catalog-product-change-notification' ]
    queueAttributes = [
            VisibilityTimeout: '10'
    ]
}

task setupLocalQueue(type: CreateSqsQueueWithDlqTask) {
    queueName = 'catalog-product-change-notification'
}

./gradlew listSqsQueues

./gradlew publishSqs --queueNames="queue1,queue2" --messages="{path to message file, directory, or archive}"

./gradlew purgeSqsQueues --queueNames=queue1,queue2

task setupLocalTopic(type: CreateSnsTopicWithSqsEndpointTask) {
    topicName = 'catalog-product-drops'
}

./gradlew deleteSnsTopic --topicName=catalog-product-drops

./gradlew listSnsTopics

./gradlew listSnsTopicSubscriptions --topicName=catalog-product-drops