percheron 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 275f1a0fa8f2b50676a512e6f06a1ee4831766a5
-  data.tar.gz: 99c850dc1bc237a36496a0abc97544c643fc1bc3
+  metadata.gz: 15de7f98c12439599c7f39ba23c9667d3114d493
+  data.tar.gz: e5efd6cf80b855d2bc6a477db9406165708f0b9d
 SHA512:
-  metadata.gz: 24428f1616dfacdf8f6d593634b262ba32e1a57502970fc45722985f94154bc6f89f7426ff15fdb2cf45300b60bb55469c0830900f78d8643b99a6b6806a6dfb
-  data.tar.gz: 6be1aaa7380e32af478b7f08414edea06a17165d977d6e983ce69eda7cffc724356583461e62f01c5f42aea82902e5776564802a8a711c03a3a74089523df3b9
+  metadata.gz: ad718e1b22ec751f618b29d0bd37e716fea413291152738d692746dbd9fec849190f78e324de88608271c138455c682d02ef15b3cdcbb23b70593b9b7cc6878b
+  data.tar.gz: 77b283bb036e996e2847ebfb5fe6c77ce11351fd6061ae1352e319d9fd464cef506dbfd30c8cccdbe395bfc44d199d2ed007be08f9dd9402355704ef71ba7a51

data/.travis.yml

@@ -6,6 +6,5 @@ branches:
     - master
     - wip
 script:
-  - bundle exec cane
-  - bundle exec rubocop
+  - bundle exec rake test:style
   - bundle exec rake spec:unit

data/README.md

@@ -8,6 +8,21 @@
 
 Organise your Docker containers with muscle and intelligence.
 
+## Features
+
+* Single, easy to write `.percheron.yml` controls everything
+* Supports building, creating and starting of containers and their dependancies
+* Supports building using a Dockerfile or pulling a Docker image from Docker Hub
+* Build 'base' images as a dependancy and then build from there
+* Support for pre-build and post-start scripts when generating images and starting containers
+* Version control of building images and containers
+* Written in Ruby :)
+
+## Supported platforms
+
+* Linux
+* MacOS 10.9+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -31,7 +46,8 @@ $ gem install percheron
 ## Requirements
 
 * Ruby 2.x
-* Docker 1.6.x
+* [Docker 1.6.x](https://docs.docker.com/installation/) / [Boot2Docker v1.6.x+](https://docs.docker.com/installation)
+* [Docker client](https://docs.docker.com/installation) (nice to have)
 
 ## Usage
 
@@ -39,29 +55,29 @@ TODO
 
 ## Examples
 
-* Rails - https://github.com/ashmckenzie/percheron-rails#quickstart
-* Torrent - https://github.com/ashmckenzie/percheron-torrent#quickstart
-* SaltStack - https://github.com/ashmckenzie/percheron-saltstack#quickstart
+* [Rails](https://github.com/ashmckenzie/percheron-rails#quickstart) - Rails 4.2, PostgreSQL, redis, HAProxy and postfix
+* [Torrent](https://github.com/ashmckenzie/percheron-torrent#quickstart) - Tracker (chihaya), seeder (aria2) and three peers (aria2)
+* [SaltStack](https://github.com/ashmckenzie/percheron-saltstack#quickstart) - SaltStack v2015.2.0rc2 with master and minion
 
 ## Testing
 
 All (cane, RuboCop, unit and integration):
 
 ```shell
-bundle exec test
+bundle exec rake test
 ```
 
 Style (cane and RuboCop):
 
 ```shell
-bundle exec test:style
+bundle exec rake test:style
 ```
 
-
 ## Contributing
 
 1. Fork it ( https://github.com/ashmckenzie/percheron/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+4. Run `bundle exec rake test`
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/lib/percheron/actions/shell.rb

@@ -4,6 +4,7 @@ module Percheron
       include Base
 
       DEFAULT_SHELL = '/bin/sh'
+      DOCKER_CLIENT = 'docker'
 
       def initialize(container, shell: DEFAULT_SHELL)
         @container = container
@@ -11,7 +12,8 @@ module Percheron
       end
 
       def execute!
-        $logger.debug "Executing a bash shell on '#{container.name}' container"
+        Validators::DockerClient.new.validate_docker_client_available!
+        $logger.debug "Executing #{shell} on '#{container.name}' container"
         exec!
       end
 
@@ -20,7 +22,7 @@ module Percheron
         attr_reader :container, :shell
 
         def exec!
-          system('docker exec -ti %s %s' % [ container.full_name, shell ])
+          system('%s exec -ti %s %s' % [ DOCKER_CLIENT, container.full_name, shell ])
         end
     end
   end

data/lib/percheron/commands/shell.rb

@@ -10,6 +10,8 @@ module Percheron
       def execute
         super
         stack.shell!(container_name, shell: shell)
+      rescue Errors::DockerClientInvalid => e
+        signal_usage_error(e.message)
       end
     end
   end

data/lib/percheron/errors.rb

@@ -4,5 +4,6 @@ module Percheron
     class StackInvalid < StandardError; end
     class ContainerInvalid < StandardError; end
     class ContainerDoesNotExist < StandardError; end
+    class DockerClientInvalid < StandardError; end
   end
 end

data/lib/percheron/validators/config.rb

@@ -8,18 +8,17 @@ module Percheron
 
       def valid?
         message = rules.return { |rule| send(rule) }
-
-        if message
-          fail Errors::ConfigFileInvalid, message
-        else
-          true
-        end
+        message ? fail(Errors::ConfigFileInvalid, formatted_message(message)) : true
       end
 
       private
 
         attr_reader :config_file
 
+        def formatted_message(message)
+          "Config is invalid: #{message}"
+        end
+
         def rules
           [
             :validate_config_file_defined,
@@ -34,24 +33,21 @@ module Percheron
         end
 
         def validate_config_file_defined
-          'Config file is not defined' if config_file.nil?
+          'Is not defined' if config_file.nil?
         end
 
         def validate_config_file_existence
-          "#{base_message} does not exist" unless config_file.exist?
+          'Does not exist' unless config_file.exist?
         end
 
         def validate_config_file_not_empty
-          "#{base_message} is empty" if config_file_contents.empty?
+          'Is empty' if config_file_contents.empty?
         end
 
         def validate_config_file_contents
-          "#{base_message} is invalid" unless config_file_contents.docker
+          'Is invalid' unless config_file_contents.docker
         end
 
-        def base_message
-          "Config file '#{config_file}'"
-        end
     end
   end
 end

data/lib/percheron/validators/container.rb

@@ -8,12 +8,7 @@ module Percheron
 
       def valid?
         message = rules.return { |rule| send(rule) }
-
-        if message
-          fail Errors::ContainerInvalid, formatted_message(message)
-        else
-          true
-        end
+        message ? fail(Errors::ContainerInvalid, formatted_message(message)) : true
       end
 
       private
@@ -41,25 +36,25 @@ module Percheron
         # rubocop:disable Style/GuardClause
         def validate_name
           if container.name.nil? || !container.name.to_s.match(/[\w]{3,}/)
-            'Container name is invalid'
+            'Name is invalid'
           end
         end
 
         def validate_dockerfile_and_image_name
           if container.dockerfile.nil? && container.docker_image.nil?
-            'Container Dockerfile OR image name not provided'
+            'Dockerfile OR image name not provided'
           end
         end
 
         def validate_dockerfile
           if !container.dockerfile.nil? && !File.exist?(container.dockerfile)
-            'Container Dockerfile is invalid'
+            'Dockerfile is invalid'
           end
         end
 
         def validate_image
           if !container.docker_image.nil? && !container.docker_image.match(/^.+:.+$/)
-            'Container Docker image is invalid'
+            'Docker image is invalid'
           end
         end
         # rubocop:enable Style/GuardClause
@@ -67,7 +62,7 @@ module Percheron
         def validate_version
           container.version ? nil : fail(ArgumentError)
         rescue ArgumentError
-          'Container version is invalid'
+          'Version is invalid'
         end
 
     end

data/lib/percheron/validators/docker_client.rb

@@ -0,0 +1,56 @@
+module Percheron
+  module Validators
+    class DockerClient
+
+      def valid?
+        message = rules.return { |rule| send(rule) }
+        message ? fail(Errors::DockerClientInvalid, formatted_message(message)) : true
+      end
+
+      private
+
+        def formatted_message(message)
+          "Docker client is invalid: #{message}"
+        end
+
+        def rules
+          [
+            :validate_existence,
+            :validate_version
+          ]
+        end
+
+        def validate_existence
+          return nil if docker_client_exists?
+          'Is not in your PATH'
+        end
+
+        def validate_version
+          return nil if docker_client_exists? &&
+                        Semantic::Version.new(current_version) >= minimum_version
+          "Version is insufficient, need #{minimum_version}"
+        end
+
+        def paths
+          ENV['PATH'].split(File::PATH_SEPARATOR)
+        end
+
+        def docker_client_exists?
+          paths.each do |path|
+            exe = File.join(path, Actions::Shell::DOCKER_CLIENT)
+            return true if File.executable?(exe) && !File.directory?(exe)
+          end
+          false
+        end
+
+        def minimum_version
+          @minimum_version ||= Semantic::Version.new('1.6.0')
+        end
+
+        def current_version
+          `#{Actions::Shell::DOCKER_CLIENT} --version`.chomp.match(/version (.+),/)[1]
+        end
+
+    end
+  end
+end

data/lib/percheron/validators/stack.rb

@@ -8,24 +8,24 @@ module Percheron
 
       def valid?
         message = rules.return { |rule| send(rule) }
-
-        if message
-          fail Errors::StackInvalid, message
-        else
-          true
-        end
+        message ? fail(Errors::StackInvalid, formatted_message(message)) : true
       end
 
       private
 
         attr_reader :stack
 
+        def formatted_message(message)
+          "Stack is invalid: #{message}"
+        end
+
         def rules
           [ :validate_name ]
         end
 
         def validate_name
-          'Stack name is invalid' if stack.name.nil? || !stack.name.to_s.match(/[\w\d]{3,}/)
+          return nil if !stack.name.nil? && stack.name.to_s.match(/\w{3,}/)
+          'Name is invalid'
         end
 
     end

data/lib/percheron/validators.rb

@@ -1,6 +1,7 @@
 require 'percheron/validators/config'
 require 'percheron/validators/stack'
 require 'percheron/validators/container'
+require 'percheron/validators/docker_client'
 
 module Percheron
   module Validators

data/lib/percheron/version.rb

@@ -1,3 +1,3 @@
 module Percheron
-  VERSION = '0.7.1'
+  VERSION = '0.7.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percheron
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Ash McKenzie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -314,6 +314,7 @@ files:
 - lib/percheron/validators.rb
 - lib/percheron/validators/config.rb
 - lib/percheron/validators/container.rb
+- lib/percheron/validators/docker_client.rb
 - lib/percheron/validators/stack.rb
 - lib/percheron/version.rb
 - percheron.gemspec