docker-rails 0.10.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0366030b589abebd5315e8fbf308739ed751ab0
-  data.tar.gz: 13156b0a24820cfe5a5be649c6ae00e64a419983
+  metadata.gz: 61e25183a59f695d855dcfdc3d1b5caa4b6418d5
+  data.tar.gz: 9e3059dd5e309a69d48e45d8ea86858e8052ed85
 SHA512:
-  metadata.gz: b6a2232fc2f1574603a87dc42a635a38bd9124b0c4749ad12060210ca499c6192b0d7106949f813963b7073002a345501f392358a5e2aacdedfa0792e751c458
-  data.tar.gz: c97c362d3a8bd2d67157375484902fcedf03e49913bede0d45a8fe7e56c459907103e276a89763c18df14d9ef15379781e4b886fc1ad0229cb1fb6f4e796b81d
+  metadata.gz: 069b90234e74e45219f8160a316adfd112ce700cf42ccc745186b8d786f1f2334d810544d14b74c4b539762b19ea91f347763100a994602c30f1144268191bc1
+  data.tar.gz: fb2274af2b37723c53f79fb259810700fd5c66897eab81f4e5d762a0464ff19fba03da26a0f3825f1bc4e3a8b457bc8aee6569aa515aec8fd397fc20b9cbb41f

data/README.md

@@ -3,7 +3,11 @@
 [![Build Status](https://travis-ci.org/alienfast/docker-rails.svg)](https://travis-ci.org/alienfast/docker-rails)
 [![Code Climate](https://codeclimate.com/github/alienfast/docker-rails/badges/gpa.svg)](https://codeclimate.com/github/alienfast/docker-rails)
 
-A simplified pattern to execute rails applications within Docker (with a CI build emphasis).
+A simplified pattern to execute rails applications within Docker (with a CI build emphasis).  
+
+Uses **version: '2'** of `docker-compose` syntax
+
+Note: The only item that is rails-specific is the `db_check`, otherwise this can be useful for other CI situations as well.  Perhaps we should have chosen a different name?
 
 ## Features
 - DRY declarative `docker-rails.yml` allowing multiple environments to be defined with an inherited docker `compose` configuration
@@ -81,6 +85,7 @@ Commands:
   docker-rails ps <target>                             # List containers for the target compose configuration e.g. docker-rails ps --build=222 development
   docker-rails ps_all                                  # List all remaining containers regardless of state e.g. docker-rails ps_all
   docker-rails rm_dangling                             # Remove danging images e.g. docker-rails rm_dangling
+  docker-rails rm_exited                               # Remove exited containers e.g. docker-rails rm_exited
   docker-rails rm_volumes <target>                     # Stop all running containers and remove corresponding volumes for the given build/target e.g. docker-rails rm_volumes --build=222 development
   docker-rails stop <target>                           # Stop all running containers for the given build/target e.g. docker-rails stop --build=222 development
   docker-rails up <target>                             # Up the docker-compose configuration for the given build/target. Use -d for detached mode. e.g. docker-rails up -d --build=222 test
@@ -108,19 +113,148 @@ Or install it yourself as:
 
 ### 1. Add a Dockerfile
 
+This is a _real world example_ (**not a minimal example**) of a rails engine called `acme` with a `dummy` application used for testing.  Other notable items:
+ - installs node
+ - uses [`dockito/vault`](https://github.com/dockito/vault) via `ONVAULT` to execute `npm` with private key access without exposing the npm key to the layer
+ - runs `npm build` to transpile the `dummy` application UI
+ - allows for use of a private npm registry
+
 ```bash
-FIXME
+FROM convox/ruby
+
+# mysql client, nodejs, clean up APT when done.
+# - libelf1 for flow-bin
+# - libfontconfig for phantomjs
+RUN apt-get update -qq && apt-get install -qy \
+  vim \
+  wget \
+  libelf1 \
+  libfontconfig \
+  libmysqlclient-dev \
+  mysql-client \
+  git \
+  curl \
+  && curl -L https://raw.githubusercontent.com/dockito/vault/master/ONVAULT > /usr/local/bin/ONVAULT \
+  && chmod +x /usr/local/bin/ONVAULT \
+  && rm -rf /var/lib/apt/lists/* \
+  && apt-get -y autoclean
+
+# Install nodejs - see dockerfile - https://github.com/nodejs/docker-node/blob/master/6.2/Dockerfile
+# gpg keys listed at https://github.com/nodejs/node
+RUN set -ex \
+  && for key in \
+    9554F04D7259F04124DE6B476D5A82AC7E37093B \
+    94AE36675C464D64BAFA68DD7434390BDBE9B9C5 \
+    0034A06D9D9B0064CE8ADF6BF1747F4AD2306D93 \
+    FD3A5288F042B6850C66B31F09FE44734EB7990E \
+    71DCFD284A79C3B38668286BC97EC7A07EDE3FC1 \
+    DD8F2338BAE7501E3DD5AC78C273792F7D83545D \
+    B9AE9905FFD7803F25714661B63B535A4C206CA9 \
+    C4F0DFFF4E8C1A8236409D08E73BC641CC11F4C8 \
+  ; do \
+    gpg --keyserver ha.pool.sks-keyservers.net --recv-keys "$key"; \
+  done
+
+ENV NPM_CONFIG_LOGLEVEL error
+ENV NODE_VERSION 6.8.1
+
+RUN curl -SLO "https://nodejs.org/dist/v$NODE_VERSION/node-v$NODE_VERSION-linux-x64.tar.xz" \
+  && curl -SLO "https://nodejs.org/dist/v$NODE_VERSION/SHASUMS256.txt.asc" \
+  && gpg --batch --decrypt --output SHASUMS256.txt SHASUMS256.txt.asc \
+  && grep " node-v$NODE_VERSION-linux-x64.tar.xz\$" SHASUMS256.txt | sha256sum -c - \
+  && tar -xJf "node-v$NODE_VERSION-linux-x64.tar.xz" -C /usr/local --strip-components=1 \
+  && rm "node-v$NODE_VERSION-linux-x64.tar.xz" SHASUMS256.txt.asc SHASUMS256.txt
+
+# Set an environment variable to store where the app is installed to inside of the Docker image.
+ENV INSTALL_PATH /app
+RUN mkdir -p $INSTALL_PATH
+WORKDIR $INSTALL_PATH
+
+# Ensure gems are cached they are less likely to change than node modules
+COPY acme.gemspec               acme.gemspec
+COPY Gemfile                  Gemfile
+COPY Gemfile_shared.rb        Gemfile_shared.rb
+COPY spec/dummy/Gemfile       spec/dummy/Gemfile
+# This is only here to trigger re-bundle when lock changes, we actually only use the ImageGemfile.lock so that we are
+#   always doing a fresh bundle anytime the source lock changes.
+COPY Gemfile.lock             Gemfile.lock
+
+# Bundle acme and the dummy app
+RUN \
+  bundle install --jobs 12 --retry 3 --without development \
+  && mv Gemfile.lock ImageGemfile.lock \
+  && cd spec/dummy \
+  && bundle install --jobs 12 --retry 3 --without development \
+  && mv Gemfile.lock ImageGemfile.lock
+
+# Ensure node_modules are cached next, they are less likely to change than source code
+WORKDIR $INSTALL_PATH
+COPY package.json             package.json
+COPY spec/dummy/package.json  spec/dummy/package.json
+
+# https://docs.npmjs.com/private-modules/docker-and-private-modules
+ARG NPM_TOKEN
+
+# npm install with:
+#   - private keys accessible
+#   - skip optional dependencies like fsevents
+#   - production (**turned off because we need eslint etc devDependencies)
+#   - link dummy's node_modules to acme for a faster install
+#   - add the authorized host key for github (avoids "Host key verification failed")
+RUN \
+  #echo "Using NPM_TOKEN: ${NPM_TOKEN}" \
+  echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > .npmrc \
+  && ONVAULT npm install --no-optional \
+  && rm .npmrc \
+  && cd spec/dummy \
+  && ln -s $INSTALL_PATH/node_modules node_modules
+
+# add all the test hosts to localhost to skip xip.io
+RUN echo "127.0.0.1	localhost dummy.com.127.0.0.1.xip.io" >> /etc/hosts
+
+#--------------
+# NOTE: we evidently must include the VOLUME command **after** the npm install so that we can read the installed modules
+#--------------
+# Bypass the union file system for better performance (this is important for read/write of spec/test files)
+# https://docs.docker.com/engine/reference/builder/#volume
+# https://docs.docker.com/userguide/dockervolumes/
+VOLUME $INSTALL_PATH
+
+# Copy the project files into the container (again, better performance).
+#   Use `extract` in the docker-rails.yml to obtain files such as test results.
+#   NOTE: make sure all unwanted files are listed in the .dockerignore!  i.e. lock files in the case of an engine!
+COPY . .
+
+#
+# - Overwrite the source lock files with the image lock files (so we ensure a fresher bundle _and_ that we have the bundled gems in the lock file)
+# - Run npm build on dummy
+RUN \
+  mv ImageGemfile.lock Gemfile.lock \
+  && cd spec/dummy \
+  && mv ImageGemfile.lock Gemfile.lock \
+  && npm run build
 ```
 
 ### 2. Add a docker-rails.yml
 
 Environment variables will be interpolated, so feel free to use them. 
-The _rails engine_ example below shows an example with all of the environments `ssh_test | development | test | parallel_tests | staging` to show reuse of the primary `compose` configuration. 
+The _rails engine_ example below shows an example with all of the environments `ssh_test | test | parallel_tests | sysbench*` to show reuse of the primary `compose` configuration. 
 
 ```yaml
 verbose: true
+before_command: >
+  bash -c "
+  rm -Rf target
+  && rm -Rf spec/dummy/log
+  && mkdir -p target
+  "
 exit_code: web
-before_command: bash -c "rm -Rf target && rm -Rf spec/dummy/log"
+
+# ---
+# Run a dockito vault container during the build to allow it to access secrets (e.g. github clone)
+dockito:
+  vault:
+    enabled: true
 
 # ---
 # Declare a reusable extract set
@@ -130,167 +264,197 @@ extractions: &extractions
       - '/app/target'
       - '/app/vcr'
       - '/app/spec/dummy/log:spec/dummy'
-      - '/app/tmp/parallel_runtime_cucumber.log:./tmp'
-      - '/app/tmp/parallel_runtime_rspec.log:./tmp'
 
-      
-# ---
-# Declare a reusable elasticsearch container, staging/production connects to existing running instance.
+# local environments need elasticsearch, staging/production connects to existing running instance.
 elasticsearch: &elasticsearch
   elasticsearch:
     image: library/elasticsearch:1.7
     ports:
       - "9200"
-      
-# ---
-# Base docker-compose configuration for all environments.  Anything under the `compose` element must be standard docker-compose syntax.
-compose:
-  web:
-    build: .
-    working_dir: /app/spec/dummy
-    ports:
-      - "3000"
-    links:
-      - db
-    volumes:
-      # make keys and known_hosts available
-      - ~/.ssh:/root/.ssh      
-
-  db:
-    # https://github.com/docker-library/docs/tree/master/mysql
-    image: library/mysql:5.7.6
-    ports:
-      - "3306"
-
-    # https://github.com/docker-library/docs/tree/master/mysql#environment-variables
-    environment:
-      - MYSQL_ALLOW_EMPTY_PASSWORD=true      
 
-# ---
-# Overrides based on the named targets ssh_test | development | test | parallel_tests | staging       
-ssh_test:
+test:
+  <<: *extractions
   compose:
-    web:
-      command: bash -c "ssh -T git@bitbucket.org"      
+    services:
+      <<: *elasticsearch
+      web:
+        links:
+          - elasticsearch # standard yaml doesn't merge arrays so we have to add this explicitly
+        environment:
+          - RAILS_ENV=test
+          - CI=true
+        command: >
+          bash -c "
+            cd ../.. \
+            && gem list aws-sdk \
+            && bundle exec rake -T \
+            && npm run validate \
+            && cd spec/dummy \
+            && echo 'Check and wait for database connection' \
+            && bundle exec docker-rails db_check mysql \
+            && echo 'DB rebuild' \
+            && bundle exec rake db:rebuild_test \
+            && echo 'Tests' \
+            && cd ../.. \
+            && bundle exec rake spec SPEC=spec/app/models/plan_spec.rb cucumber FEATURE=features/public_pages.feature
+          "
 
-development:
+parallel_tests:
+  <<: *extractions
   compose:
-    <<: *elasticsearch
+    services:
+      <<: *elasticsearch
+      web:
+        links:
+          - elasticsearch # standard yaml doesn't merge arrays so we have to add this explicitly
+        environment:
+          - RAILS_ENV=test
+          - CI=true
+        command: >
+          bash -c "
+            cd ../.. \
+            && npm run validate \
+            && cd spec/dummy \
+            && echo 'Check and wait for database connection' \
+            && bundle exec docker-rails db_check mysql \
+            && echo 'DB rebuild' \
+            && bundle exec rake db:rebuild_test[true] \
+            && echo 'Tests' \
+            && cd ../.. \
+            && bundle exec rake parallel:spec parallel:features
+          "
+
+compose:
+  version: '2'
+  services:
     web:
+      build:
+        context: .
+        args:
+          - NPM_TOKEN
+      working_dir: /app/spec/dummy
+      ports:
+        - "3000"
+        - "4000"
       links:
-        - elasticsearch # standard yaml doesn't merge arrays so we have to add this explicitly
+        - db
+#      volumes:
+#        # make keys and known_hosts available
+#        - ~/.ssh:/root/.ssh
+    db:
+      # https://github.com/docker-library/docs/tree/master/mysql
+      image: library/mysql:5.7
+      ports:
+        - "3306"
+      volumes:
+        - ./db/mysql:/etc/mysql/conf.d
+      # https://github.com/docker-library/docs/tree/master/mysql#environment-variables
       environment:
-        - RAILS_ENV=development
-      command: >
-        bash -c "
-
-        echo 'Bundling gems'
-        && bundle install --jobs 4 --retry 3
-
-        && echo 'Generating Spring binstubs'
-        && bundle exec spring binstub --all
-
-        && echo 'Clearing logs and tmp dirs'
-        && bundle exec rake log:clear tmp:clear
+        - MYSQL_ALLOW_EMPTY_PASSWORD=true
 
-        && echo 'Check and wait for database connection'
-        && bundle exec docker-rails db_check mysql
 
-        && echo 'Setting up new db if one doesn't exist'
-        && bundle exec rake db:version || { bundle exec rake db:setup; }
-
-        && echo "Starting app server"
-        && bundle exec rails s -p 3000
-
-        && echo 'Setup and start foreman'
-        && gem install foreman
-        && foreman start
-        "
+# --------------------------
+# test cases below here
+ssh_test:
+  compose:
+    services:
+      web:
+        command: bash -c "ssh -T git@github.com"
 
-test:
-  <<: *extractions
+sysbench_all:
   compose:
-    <<: *elasticsearch
-    web:
-      links:
-        - elasticsearch # standard yaml doesn't merge arrays so we have to add this explicitly
-      environment:
-        - RAILS_ENV=test
-      command: >
-        bash -c "
-        echo 'Bundling gems'
-        && bundle install --jobs 4 --retry 3
+    services:
+      <<: *elasticsearch
 
-        && echo 'Clearing logs and tmp dirs'
-        && bundle exec rake log:clear tmp:clear
+      web:
+        command: >
+          bash -c "
 
-        && echo 'Check and wait for database connection'
-        && bundle exec docker-rails db_check mysql
+          echo 'Benchmarking CPU'
+          && sysbench --test=cpu --cpu-max-prime=20000 run
 
-        && echo 'Setting up new db if one doesn't exist'
-        && bundle exec rake db:version || { bundle exec rake db:setup; }
+          && echo 'Creating file for IO benchmark'
+          && sysbench --test=fileio --file-total-size=2G prepare
 
-        && echo 'Tests'
-        && cd ../..
-        && xvfb-run -a bundle exec rake spec cucumber
-        "
+          && echo 'Benchmarking IO'
+          && sysbench --test=fileio --file-total-size=2G --file-test-mode=rndrw --init-rng=on --max-time=300 --max-requests=0 run
 
-parallel_tests:
-  <<: *extractions
-  compose:
-    <<: *elasticsearch
-    web:
-      links:
-        - elasticsearch # standard yaml doesn't merge arrays so we have to add this explicitly
-      environment:
-        - RAILS_ENV=test
-      command: >
-        bash -c "
+          && echo 'Cleaning up file for IO benchmark'
+          && sysbench --test=fileio --file-total-size=2G cleanup
 
-        echo 'Bundling gems'
-        && bundle install --jobs 4 --retry 3
+          && echo 'Bundling gems'
+          && bundle install --jobs 4 --retry 3
 
-        && echo 'Clearing logs and tmp dirs'
-        && bundle exec rake log:clear tmp:clear
+          && echo 'Check and wait for database connection'
+          && bundle exec docker-rails db_check mysql
 
-        && echo 'Check and wait for database connection'
-        && bundle exec docker-rails db_check mysql
+          && echo 'Create test database'
+          && mysql -h db -u root -e 'create database test'
 
-        && echo 'Setting up new db if one doesn't exist'
-        && bundle exec rake parallel:drop parallel:create parallel:migrate parallel:seed
+          && echo 'Preparing MySQL benchmark'
+          && sysbench --test=oltp --oltp-table-size=1000000 --mysql-db=test --mysql-user=root --mysql-host=db prepare
 
-        && echo 'Tests'
-        && cd ../..
-        && xvfb-run -a bundle exec rake parallel:spec parallel:features
-        "
+          && echo 'Benchmarking MySQL'
+          && sysbench --test=oltp --oltp-table-size=1000000 --mysql-db=test --mysql-user=root --mysql-host=db --max-time=60 --oltp-read-only=on --max-requests=0 --num-threads=8 run
 
-staging:
+          && echo 'Cleaning up MySQL benchmark'
+          && sysbench --test=oltp --mysql-db=test --mysql-user=root --mysql-host=db cleanup
+          "
+
+sysbench_db:
   compose:
-    web:
-      environment:
-        - RAILS_ENV=staging
-      command: >
-        bash -c "
+    services:
+      <<: *elasticsearch
+      web:
+        command: >
+          bash -c "
 
-        echo 'Bundling gems'
-        && bundle install --jobs 4 --retry 3
+          echo 'Bundling gems'
+          && bundle install --jobs 4 --retry 3
 
-        && echo 'Clearing logs and tmp dirs'
-        && bundle exec rake log:clear tmp:clear
+          && echo 'Check and wait for database connection'
+          && bundle exec docker-rails db_check mysql
 
-        && echo 'Check and wait for database connection'
-        && bundle exec docker-rails db_check mysql
+          && echo 'Create test database'
+          && mysql -h db -u root -e 'create database test'
 
-        && echo 'Setting up new db if one doesn't exist'
-        && bundle exec rake db:migrate
+          && echo 'Preparing MySQL benchmark'
+          && sysbench --test=oltp --oltp-table-size=1000000 --mysql-db=test --mysql-user=root --mysql-host=db prepare
 
-        && echo "Starting app server"
-        && bundle exec rails s -p 3000
+          && echo 'Benchmarking MySQL'
+          && sysbench --test=oltp --oltp-table-size=1000000 --mysql-db=test --mysql-user=root --mysql-host=db --max-time=60 --oltp-read-only=on --max-requests=0 --num-threads=8 run
 
-        && echo 'Setup and start foreman'
-        && gem install foreman
-        && foreman start
-        "
+          && echo 'Cleaning up MySQL benchmark'
+          && sysbench --test=oltp --mysql-db=test --mysql-user=root --mysql-host=db cleanup
+          "
+
+sysbench_io:
+  compose:
+    services:
+      <<: *elasticsearch
+      web:
+        command: >
+          bash -c "
+          echo 'Creating file for IO benchmark'
+          && sysbench --test=fileio --file-total-size=2G prepare
+
+          && echo 'Benchmarking IO'
+          && sysbench --test=fileio --file-total-size=2G --file-test-mode=rndrw --init-rng=on --max-time=300 --max-requests=0 run
+
+          && echo 'Cleaning up file for IO benchmark'
+          && sysbench --test=fileio --file-total-size=2G cleanup
+          "
+
+sysbench_cpu:
+  compose:
+    services:
+      <<: *elasticsearch
+      web:
+        command: >
+          bash -c "
+          echo 'Benchmarking CPU'
+          && sysbench --test=cpu --cpu-max-prime=20000 run
+          "
 ```
 
 ## CI setup
@@ -339,14 +503,10 @@ source ~/.bash_profile
 docker-rails cleanup --build=$bamboo_buildNumber parallel_tests
 ```
 
-## Work in progress - contributions welcome
-Open to pull requests. Open to refactoring. It can be expanded to suit many different configurations.
-
-TODO:
-- **DB versatility** - expand to different db status detection as-needed e.g. postgres. CLI is now modularized to allow for this.
-
 ## Contributing
 
+Yes please.
+
 1. Fork it ( https://github.com/[my-github-username]/docker-rails/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
@@ -354,4 +514,4 @@ TODO:
 5. Create a new Pull Request
 
 ## License and Attributions
-MIT license, inspired by many but certainly a [useful blog post by AtlasHealth](http://www.atlashealth.com/blog/2014/09/persistent-ruby-gems-docker-container). 
+MIT license 

data/lib/docker/rails/app.rb

@@ -83,7 +83,7 @@ module Docker
 
         # check the exit_code
         if @config['exit_code'].nil?
-          first_defined_service = @compose_config.keys[0]
+          first_defined_service = @compose_config.services.keys[0]
           puts "exit_code not set in configuration, using exit code from first defined service: #{first_defined_service}"
           @config['exit_code'] = first_defined_service
         end
@@ -107,7 +107,7 @@ module Docker
         #         - '/project/tmp/parallel_runtime_cucumber.log:./tmp'
         #         - '/project/tmp/parallel_runtime_rspec.log:./tmp'
 
-        @compose_config.each_key do |service_name|
+        @compose_config.services.each_key do |service_name|
           service_config = @config[service_name]
           extractions = service_config[:extract] unless service_config.nil?
           next if extractions.nil?

data/lib/docker/rails/version.rb

@@ -1,5 +1,5 @@
 module Docker
   module Rails
-    VERSION = '0.10.0'
+    VERSION = '1.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-rails
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Kevin Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2016-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler