dromedary 🐪

Sample app to demonstrate a working pipeline using AWS Code Services

The Demo App 🐪

The Dromedary demo app is a simple nodejs application that displays a pie chart to users. The data that describes the pie chart (eg: the colors and their values) is served by the application.

If a user clicks on a particular color segment in the chart, the frontend will send a request to the backend to increment the value for that color and update the chart with the new value.

The frontend will also poll the backend for changes to values of the colors of the pie chart and update the chart appropriately. If it detects that a new version of the app has been deployed, it will reload the page.

Directions are provided to run this demo in AWS and locally.

Running in AWS 🐪

DISCLAIMER: Executing the following will create billable AWS resources in your account. Be sure to clean up Dromedary resources after you are done to minimize charges

PLEASE NOTE: This demo is an exercise in Infrastructure as Code, and is meant to demonstrate neither best practices in highly available nor highly secure deployments in AWS. details that go against best practices!

You'll need the AWS CLI tools installed and configured to start.

You'll also need to create a hosted zone in Route53. This hosted zone does not necessarily need to be publicly available and a registered domain3](https://aws.amazon.com/route53/). This hosted zone does not necessarily need to be publicly available and a registered domain3](https://aws.amazon.com/route53/). This hosted zone does not necessarily need to be publicly available and a registered domain.

After cloning the repo, run the bootstrap script to create the environment in which Dromedary will be deployed:

./bin/bootstrap-all.sh PRODHOST.HOSTED.ZONE`

The bootstrap script requires a hostname to be passed as argument. This hostname represents the "production" host which will be updated at the last step of the pipeline.

After the bootstrap script completes, you'll need to make one manual update to the CodePipeline it created:

Go to the CodePipeline console
Click on the new pipeline just created - it should be named DromedaryPRODHOST
Click the Edit button
Edit the Source step that is initialized as Amazon S3
Change the Source Provider to Github
Click the Connect to Github button
Enter: 1. stelligent/dromedary in the Repository text box (or, if you fork it: USERNAME/dromedary) 1. master in the Branch text box 1. DromedarySource in the Output artifact #1 text box
Click the Update button
Click the Save pipeline changes button

Shortly after you confirm the pipeline changes, CodePipeline will kick off an execution of the pipeline.

Upon completion of a successful pipeline execution, Dromedary will be available at the hostname you specified to the bootstrap script. If that hosted zone is not a publicly registered domain, you access Dromedary via IP address. The ip address can be queried by viewing the EIP output of the eni CloudFormation stack.

Every time changes are pushed to Github, CodePipeline will test and deploy those changes.

To delete (nearly) all Dromedary resources, execute the delete script:

./bin/delete-all.sh

The only resources that remain and require manual deletion is the Dromedary S3 bucket.

Running Locally 🐪

Install Prerequisites

Ensure nodejs and npm are installed

On Mac OS X, this can be done via Homebrew: brew install node
On Amazon Linux, packages are available via the EPEL yum repo: yum install -y nodejs npm --enablerepo=epel

Java must be installed so that DynamoDB Local can run
Install dependencies: npm install

NOTE: Dromedary relies on gulp for local development and build tasks. You may need to install gulp globally: npm install -g gulp

If gulp is not globally installed, ensure ./node_modules/.bin/ is in your PATH.

Local Server

The default task will start dynamodb-local on port 8079 and a node server listening on port 8080:

Run gulp - this downloads and starts DynamoDB Local and starts Node
Point your webbrowser to http://localhost:8080

Executing Unit Tests

Unit tests located in test/ were written using Mocha and Chai, and can be executed using the test task:

Run gulp test

Executing Acceptance Tests

Acceptance tests located in tests-functional/ require Dromedary to be running (eg: gulp), and can be executed using the test-functional task:

Run gulp test-functional

These tests (which, at this time are closer to integration tests than functional tests) exercise the API endpoints defined in app.js.

Building a Distributable Archive

The dist task copies relevant files to dist/ and installs only dependencies required to run the standalone app:

Run gulp dist

dist/archive.tar.gz will be created if this task run successfully.

aguy/dromedary