Codeship Pro NodeJS Express Example

Overview

The following repository is a todo API example developed with NodeJS and the Express framework.

This repo serves two main goals:

1. Example application using Codeship Pro
2. A Todo Backend community project.

The following README is a guide to build and deploy with Codeship Pro You will also be able to run this project locally, and use it as a starter app for NodeJS Docker projects.

Be sure to star/watch this repo to stay up-to-date with any changes. If you have any questions or suggestions regarding this example , please submit an issue here.

Getting Started

There are a few resources to make sure you have available during this guide.

This section makes the assumption that you will be following along from start to finish. If you wish to skip the deployment to Heroku, ignore step 5.

1. Docker CE - Container service everything will run on
2. A public, cloud based Github/Gitlab/Bitbucket Account - Git Repository service

• These must be cloud based, and not on your own servers.
• You must be an admin for the repo

3. Codeship Account - CI/CD service

• You can signup using any of the 3rd party logins or email/password

4. Codeship Jet CLI - CLI tool for testing builds locally

• This can also be installed with brew cask install jet

5. Heroku Account - App hosting

Signup for each of these is free, and should only take you a few minutes if you don't already have one. You can use your current accounts if you already have one available.

Once you have everything ready to go, you can move on to the next step.

Continuous Integration with Codeship

Continuous Integration requires developers to integrate code to a repository that is then verified by an automated build.

This project uses Jest integration testing of the todo api, and eslint for code linting. Every commit into the shared repo will be tested to verify the code is working correctly before allowing it to be merged.

In this section, you will set up your repository, create a Codeship project, and test the build locally using Jet CLI.

Fork repo

Using the account you set up in the Getting Started section, you will now create your own repository to connect to Codeship.

Since this repository is on Github, you can fork this repo and move on to the next step. If you are using Bitbucket/Gitlab, you will need to perform a few additional steps.

1. Create a new repository
2. Bitbucket
3. Gitlab
4. Download this repo's source zip file
5. Extract the zip, and navigate to the source code folder.
6. Use the following terminal commands (assuming you are using Git)

git init
git remote add origin REPOSITORY_CLONE_URL
git add .
git commit
git push -u origin master

Make sure to copy the 'Repository Clone URL' link for the next step, you will use it to set up the project in Codeship.

You now should have a remote repository that is publicly accessible in your account.

Create project in Codeship

Now that your repository is setup, the next step is to create the project in Codeship, so when you push to the remote, tests will run automatically, making continuous integration easy.

1. Login to Codeship (if not already)
2. Navigate to Projects screen, then click the New Project button

• You should now be in the project setup screen

3. Connect Your SCM: Select the source code management (SCM) tool you set up in the previous step.

• if you originally signed up with an SCM different than above, we will connect to the service during this step

4. Choose Your Repository: Copy/Paste the Repository Clone URL link from previous step
5. Click the Connect button
6. Configure Project: Click the Select Pro Project button

• The setup instructions displayed can be ignored for now, but will be here to remind you in the future

Your project is set up at this time, and any code commited and pushed to the repository will now run builds automatically, based on our current setup.

Note: The current setup will attempt to deploy on master, which will fail until we set these up. We will test the build locally without the deployment first.

Download Codeship encryption key

While you are in the Codeship project, there is an encryption key you will be using for other steps that can be downloaded now. The encryption key can be used to encrypt sensitive data so it can be safely committed.

1. In project settings, click General in the left menu
2. Download the AES key, and move it to your project's root folder
3. Rename the file to codeship.aes

Alternatively, you can create the file codeship.aes and copy paste the key directly into that file.

Test locally with Jet CLI

In the first part of this tutorial, you should have installed the Jet CLI. If not, make sure you do that now. If you run jet in your terminal you should see the following output

Usage:
  jet [command]
....

If everything is working properly, you can now test the build.

1. Run jet steps

• The output is exactly what you will see in Codeship

2. After the build runs, you should end up with the following output in your terminal:

...
...
{StepFinished=step_name:"tests" type:STEP_FINISHED_TYPE_SUCCESS}
{StepFinished=step_name:"deploy" type:STEP_FINISHED_TYPE_SKIPPED}

At this point, this build will work in Codeship. The deploy step was skipped because the local build was not tagged. If you run jet steps --tag master you would see the build process start immediately following. This will fail because there are a couple more steps to finalize.

Let's move on and do that now.

If you want to avoid running the deployment step and push the current code into your repository, you can create a new branch. This will bypass the deployment in Codeship and only run the build.

Continuous Deployment to Heroku with Codeship

Much like continuous integration, continuous deployment is the practice of shipping code to production on a frequent basis. With Codeship, you can add a deployment step that runs when all tests pass. You can also filter based on specific criteria like tags, which this repo does. When the branch is master and all tests pass, we deploy immediately following to Heroku.

Let's get the app set up, and start deploying code.

Create Heroku app

1. Login to Heroku (if not already)
2. Click New -> Create New App

• You can leave the defaults, or change them as needed

3. Click the Create App button

This app uses PostgreSQL as it's database, and Heroku has a free add-on you can use.

1. Click Resources
2. Under Add-ons, search for postgres
3. In the results drop down, click on "Heroku Postgres"
4. Leave the selction as Hobby Dev - Free, then click the Provision button.

Copy the new application name for use later.

Get Your Heroku API key

1. Click on your avatar in the upper right, then click Account Settings
2. Near the bottom, you will find API key. Click the Reveal button
3. Copy the API key
4. In the project files on your local machine, open deployment.env.sample and change your_api_key_here to your api key without any qutes.
5. Rename deployment.env.sample to deployment.env

Create encrypted files

In a previous step, you should have created the codeship.aes file. This encryption key can be used to encrypt sensitive data so it can be safely committed.

In this step, we will be encrypting the Heroku api key file you just created.

1. In your terminal, navigate to your project's root folder.
2. Ensure the codeship.aes and deployment.env files.
3. Run the command jet encrypt deployment.env deployment.env.encrypted

This will encrypt the file with your api key from Heroku. the unencrypted deployment.env, and codeship.aes key are both in the .gitignore file and will not be commited to the repository.

Commit changes and push

At this point, you have everything you need to test and deploy the project.

To simplify the deployment to Heroku, Codeship provides a Docker image called codeship/heroku-deployment. We will be using this to deploy.

1. Open the codeship-steps.yml file
2. Locate the line command: codeship_heroku deploy /deploy nodejs-express-todoapp
3. Replace nodejs-express-todoapp with your Heroku application name.
4. Make sure all files are added, and commit your changes.
5. Push to the master branch of your remote repository.
6. Open your Codeship project in a browser.
7. Click the build to watch it happen.

When complete and the build is green, you should now be able to navigate to the app with the Heroku provided url yourappname.heroku.com.

If you run into trouble at any point, please submit an issue here.