dockerspec 0.2.0 → 0.3.0

data/lib/dockerspec.rb

@@ -18,5 +18,4 @@
 #
 
 require 'dockerspec/version'
-require 'dockerspec/rspec_resources'
-require 'dockerspec/rspec_configuration'
+require 'dockerspec/rspec'

data/lib/dockerspec/builder.rb

@@ -83,7 +83,7 @@ module Dockerspec
     #    `:debug` or `3` (outputs all the provided information in its raw
     #      original form).
     #
-    # @see Dockerspec::RSpecResources#docker_build
+    # @see Dockerspec::RSpec::Resources#docker_build
     #
     # @api public
     #
@@ -117,6 +117,8 @@ module Dockerspec
     #
     # @return [String] Docker image ID.
     #
+    # @raise [Dockerspec::DockerError] For underlaying docker errors.
+    #
     # @api public
     #
     def build
@@ -173,7 +175,7 @@ module Dockerspec
     #
     # @api private
     #
-    alias_method :description_from_template, :description_from_file
+    alias description_from_template description_from_file
 
     #
     # Sets or gets the Docker image.
@@ -201,7 +203,7 @@ module Dockerspec
     # @api private
     #
     def rspec_options
-      config = RSpec.configuration
+      config = ::RSpec.configuration
       {}.tap do |opts|
         opts[:path] = config.dockerfile_path if config.dockerfile_path?
         opts[:rm] = config.rm_build if config.rm_build?
@@ -313,11 +315,13 @@ module Dockerspec
     #
     # @return void
     #
+    # @raise [Dockerspec::DockerError] For underlaying docker errors.
+    #
     # @api private
     #
     def build_from_dir(dir)
       image(::Docker::Image.build_from_dir(dir, &build_block))
-      add_respository_tag
+      add_repository_tag
     rescue ::Docker::Error::DockerError => e
       DockerExceptionParser.new(e)
     end
@@ -370,13 +374,16 @@ module Dockerspec
     #
     # @return void
     #
+    # @raise [Dockerspec::DockerError] For underlaying docker errors.
+    #
     # @api private
     #
     def build_from_id(id)
       @image = ::Docker::Image.get(id)
-      add_respository_tag
+      add_repository_tag
     rescue ::Docker::Error::NotFoundError
       @image = ::Docker::Image.create('fromImage' => id)
+      add_repository_tag
     rescue ::Docker::Error::DockerError => e
       DockerExceptionParser.new(e)
     end
@@ -388,7 +395,7 @@ module Dockerspec
     #
     # @api private
     #
-    def add_respository_tag
+    def add_repository_tag
       return unless @options.key?(:tag)
       repo, repo_tag = @options[:tag].split(':', 2)
       @image.tag(repo: repo, tag: repo_tag, force: true)

data/lib/dockerspec/builder/config_helpers.rb

@@ -24,7 +24,7 @@ module Dockerspec
     #
     # **Note:** Keep in mind that not all the available Dockerfile instructions
     # can be checked in the docker image. You should use
-    # {Dockerspec::Serverspec::RSpecResources#docker_run} to check some
+    # {Dockerspec::Serverspec::RSpec::Resources#docker_run} to check some
     # instructions like `FROM`, `RUN`, `ADD` and `COPY` (see the examples
     # there).
     #
@@ -72,7 +72,7 @@ module Dockerspec
         @image.json['Architecture']
       end
 
-      alias_method :arch, :architecture
+      alias arch architecture
 
       #
       # Returns the image Operating System.
@@ -194,6 +194,11 @@ module Dockerspec
       #     it { should have_expose '80' }
       #   end
       #
+      # @example RSpec Example Using *Have* Matchers with Integer Valuess
+      #   describe docker_build(path: '.') do
+      #     it { should have_expose 80 }
+      #   end
+      #
       # @example RSpec Example Using Regular Expressions
       #   describe docker_build(path: '.') do
       #     it { should have_expose(/80$/) }
@@ -253,7 +258,7 @@ module Dockerspec
           end
       end
 
-      alias_method :env, :envs
+      alias env envs
 
       #
       # Returns the image entrypoint (`ENTRYPOINT`).

data/lib/dockerspec/builder/logger/ci.rb

@@ -52,12 +52,12 @@ module Dockerspec
         # @api private
         #
         def print_stream(stream)
-          if stream.match(/^Step /)
+          if stream =~ /^Step /
             @buffer = stream
             @skip = true
           else
             @buffer += stream
-            @skip = false if stream.match(/^ ---> (Running in|\[Warning\]) /)
+            @skip = false if stream =~ /^ ---> (Running in|\[Warning\]) /
           end
           return if @skip
           @output.puts @buffer

data/lib/dockerspec/builder/matchers.rb

@@ -55,78 +55,59 @@ module Dockerspec
         workdir: :string,
         onbuild: :array,
         stopsignal: :string
-      }
+      }.freeze
 
       PREDICATE_TYPES.each do |name, type|
         matcher_name = "have_#{name}".to_sym
 
-        case type
-        when :string
-          matcher matcher_name do |expected|
-            match { |actual| !expected.match(actual.send(name)).nil? }
+        value_method = name
+        verb = 'be'
+        matcher matcher_name do |expected|
+          case type
+          when :string
+            verb = 'match'
 
-            failure_message do |actual|
-              "expected `#{name.upcase}` to match `#{expected.inspect}`, "\
-                "got `#{actual.send(name)}`"
-            end
+            match { |actual| !expected.match(actual.send(value_method)).nil? }
+          when :json
+            verb = 'be'
 
-            failure_message_when_negated do |actual|
-              "expected `#{name.upcase}` not to match `#{expected.inspect}`, "\
-                "got `#{actual.send(name)}`"
-            end
-          end
-        when :json
-          matcher matcher_name do |expected|
             include MatcherHelpers
 
-            match { |actual| maybe_json?(actual.send(name), expected) }
+            match { |actual| maybe_json?(actual.send(value_method), expected) }
+          when :array
+            value_method = "#{name}s"
+            verb = 'include'
 
-            failure_message do |actual|
-              "expected `#{name.upcase}` to be `#{expected.inspect}`, "\
-                "got `#{actual.send(name)}`"
+            # Allow ports to be passed as integer:
+            if matcher_name == :have_expose && expected.is_a?(Numeric)
+              expected = expected.to_s
             end
 
-            failure_message_when_negated do |actual|
-              "expected `#{name.upcase}` not to be `#{expected.inspect}`, "\
-                "got `#{actual.send(name)}`"
-            end
-          end
-        when :array
-          matcher matcher_name do |expected|
-            match { |actual| !actual.send("#{name}s").grep(expected).empty? }
-
-            failure_message do |actual|
-              "expected `#{name.upcase}` to include `#{expected.inspect}`, "\
-                "got `#{actual.send("#{name}s").inspect}`"
-            end
+            match { |actual| !actual.send(value_method).grep(expected).empty? }
+          when :hash
+            value_method = "#{name}s"
+            verb = 'contain'
 
-            failure_message_when_negated do |actual|
-              "expected `#{name.upcase}` not to include "\
-              "`#{expected.inspect}`, got `#{actual.send("#{name}s").inspect}`"
-            end
-          end
-        when :hash
-          matcher matcher_name do |expected|
             include MatcherHelpers
 
             match do |actual|
-              actual = actual.send("#{name}s")
+              actual = actual.send(value_method)
               break sub_hash?(actual, expected) if expected.is_a?(Hash)
               !actual.keys.grep(expected).empty?
             end
+          end # case type
 
-            failure_message do |actual|
-              "expected `#{name.upcase}` to contain `#{expected.inspect}`, "\
-                "got `#{actual.send("#{name}s")}`"
-            end
+          failure_message do |actual|
+            "expected `#{name.upcase}` to #{verb} `#{expected.inspect}`, "\
+              "got `#{actual.send(value_method).inspect}`"
+          end
 
-            failure_message_when_negated do |actual|
-              "expected `#{name.upcase}` not to contain "\
-              "`#{expected.inspect}`, got `#{actual.send("#{name}s")}`"
-            end
+          failure_message_when_negated do |actual|
+            "expected `#{name.upcase}` not to #{verb} "\
+            "`#{expected.inspect}`, got `#{actual.send(value_method).inspect}`"
           end
-        end
-      end
+        end # matcher
+      end # PREDICATE_TYPES each
     end
   end
 end

data/lib/dockerspec/configuration.rb

@@ -0,0 +1,188 @@
+# encoding: UTF-8
+#
+# Author:: Xabier de Zuazo (<xabier@zuazo.org>)
+# Copyright:: Copyright (c) 2016 Xabier de Zuazo
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'dockerspec/runner/docker'
+require 'dockerspec/runner/compose'
+
+module Dockerspec
+  #
+  # Saves internal configuration for {Dockerspec}.
+  #
+  # - The test engines to Run: Specinfra, ...
+  # - The internal library used to run Docker.
+  #
+  class Configuration
+    #
+    # The {Dockerspec::Runner} class used to run Docker.
+    #
+    # @return [Class] The {Dockerspec::Runner::Base} class.
+    #
+    attr_accessor :docker_runner
+
+    #
+    # The {Dockerspec::Runner::Compose} class used to run Docker Compose.
+    #
+    # @return [Class] The {Dockerspec::Runner::Compose} class.
+    #
+    attr_accessor :compose_runner
+
+    #
+    # A list of test engines used to run the tests.
+    #
+    # @return [Array<Class>] A list of {Dockerspec::Engine::Base} classes.
+    #
+    attr_reader :engines
+
+    class << self
+      #
+      # Adds a class to use as engine to run the tests.
+      #
+      # @example
+      #   Dockerspec.Configuration.add_engine Dockerspec::Engine::Specinfra
+      #
+      # @param engine [Class] A {Dockerspec::Engine::Base} subclass.
+      #
+      # @return void
+      #
+      # @api public
+      #
+      def add_engine(engine)
+        instance.add_engine(engine)
+      end
+
+      #
+      # Gets the engine classes used to run the tests.
+      #
+      # @return [Array<Class>] A list of {Dockerspec::Engine::Base} subclasses.
+      #
+      # @api public
+      #
+      def engines
+        instance.engines
+      end
+
+      #
+      # Sets the class used to create and start Docker Containers.
+      #
+      # @example
+      #   Dockerspec.Configuration.docker_runner = Dockerspec::Runner::Docker
+      #
+      # @param runner [Class] A {Dockerspec::Runner::Base} subclass.
+      #
+      # @return void
+      #
+      # @api public
+      #
+      def docker_runner=(runner)
+        instance.docker_runner = runner
+      end
+
+      #
+      # Gets the class used to create and start Docker Containers.
+      #
+      # @return [Class] A {Dockerspec::Runner::Base} subclass.
+      #
+      # @api public
+      #
+      def docker_runner
+        instance.docker_runner
+      end
+
+      #
+      # Sets the class used to start Docker Compose.
+      #
+      # @example
+      #   Dockerspec.Configuration.compose_runner = Dockerspec::Runner::Compose
+      #
+      # @param runner [Class] A {Dockerspec::Runner::Compose::Base} subclass.
+      #
+      # @return void
+      #
+      # @api public
+      #
+      def compose_runner=(runner)
+        instance.compose_runner = runner
+      end
+
+      #
+      # Gets the class used to start Docker Compose.
+      #
+      # @return [Class] A {Dockerspec::Runner::Compose::Base} subclass.
+      #
+      # @api public
+      #
+      def compose_runner
+        instance.compose_runner
+      end
+
+      #
+      # Resets the internal Configuration singleton object.
+      #
+      # @return void
+      #
+      # @api public
+      #
+      def reset
+        @instance = nil
+      end
+
+      protected
+
+      #
+      # Creates the Configuration singleton instance.
+      #
+      # @return void
+      #
+      # @api private
+      #
+      def instance
+        @instance ||= new
+      end
+    end
+
+    #
+    # Adds a class to use as engine to run the tests.
+    #
+    # @param engine [Class] A {Dockerspec::Engine::Base} subclass.
+    #
+    # @return void
+    #
+    # @api private
+    #
+    def add_engine(engine)
+      @engines << engine
+      @engines.uniq!
+    end
+
+    protected
+
+    #
+    # Constructs a configuration object.
+    #
+    # @return [Dockerspec::Configuretion] The configuration object.
+    #
+    # @api private
+    #
+    def initialize
+      @docker_runner = Runner::Docker
+      @compose_runner = Runner::Compose
+      @engines = []
+    end
+  end
+end

data/lib/dockerspec/docker_exception_parser.rb

@@ -45,7 +45,7 @@ module Dockerspec
     def initialize(e)
       e_ary = parse_exception(e)
       raise_docker_error_exception(e_ary)
-      fail e
+      raise e
     end
 
     protected
@@ -153,7 +153,7 @@ module Dockerspec
       output = parse_streams(e_ary)
       error_msg = parse_error_detail(e_ary)
       return if error_msg.nil?
-      fail DockerError, generate_error_message(error_msg, output)
+      raise DockerError, generate_error_message(error_msg, output)
     end
   end
 end