Skip to content

Latest commit

 

History

History
46 lines (38 loc) · 1.58 KB

TESTING.md

File metadata and controls

46 lines (38 loc) · 1.58 KB
Raw

Prerequisites

To develop on this gem, you must the following installed:

  • a sane Ruby 1.9+ environment with bundler
$ gem install bundler
  • Docker v1.3.1 or greater

Getting Started

  1. Clone the git repository from Github:
$ git clone [email protected]:upserve/docker-api.git
  1. Install the dependencies using Bundler
$ bundle install
  1. Create a branch for your changes
$ git checkout -b my_bug_fix
  1. Make any changes
  2. Write tests to support those changes.
  3. Run the tests:
  • bundle exec rake
  1. Assuming the tests pass, open a Pull Request on Github.

Using Rakefile Commands

This repository comes with five Rake commands to assist in your testing of the code.

rake rspec

This command will run Rspec tests normally on your local system. You must have all the required base images pulled.

rake unpack

Pulls down all the required base images for testing.

Setting Up Environment Variables

Certain Rspec tests will require your credentials to the Docker Hub. If you do not have a Docker Hub account, you can sign up for one here. To avoid hard-coding credentials into the code the test suite leverages three Environment Variables: DOCKER_API_USER, DOCKER_API_PASS, and DOCKER_API_EMAIL. You will need to configure your work environment (shell profile, IDE, etc) with these values in order to successfully run certain tests.

export DOCKER_API_USER='your_docker_hub_user'
export DOCKER_API_PASS='your_docker_hub_password'
export DOCKER_API_EMAIL='your_docker_hub_email_address'