dockerspec 0.1.0

data/lib/dockerspec/builder/logger.rb

@@ -0,0 +1,56 @@
+# encoding: UTF-8
+#
+# Author:: Xabier de Zuazo (<xabier@zuazo.org>)
+# Copyright:: Copyright (c) 2015 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/builder/logger/silent'
+require 'dockerspec/builder/logger/ci'
+require 'dockerspec/builder/logger/info'
+require 'dockerspec/builder/logger/debug'
+
+module Dockerspec
+  class Builder
+    #
+    # Creates an output logger for the {Dockerspec::Builder}.
+    #
+    class Logger
+      #
+      # Creates a logger object.
+      #
+      # @param type [Fixnum, Symbol] The logger to create. Possible values:
+      #    `:silent` or `0` (no output),
+      #    `:ci` or `1` (enables some outputs recommended for CI environments),
+      #    `:info` or `2` (gives information about main build steps),
+      #    `:debug` or `3` (outputs all the provided information in its raw
+      #      original form).
+      #
+      # @return [Dockerspec::Builder::Logger] The logger.
+      #
+      # @api public
+      #
+      def self.instance(type)
+        case type.to_s.downcase
+        when '0', 'silent' then Silent.new
+        when '1', 'ci' then CI.new
+        when '2', 'info' then Info.new
+        else
+          Debug.new
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# encoding: UTF-8
+#
+# Author:: Xabier de Zuazo (<xabier@zuazo.org>)
+# Copyright:: Copyright (c) 2015 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/builder/logger/info'
+
+module Dockerspec
+  class Builder
+    class Logger
+      #
+      # A {Dockerspec::Builder} logger recommended for CI environments with
+      # output timeouts.
+      #
+      class CI < Info
+        #
+        # Creates a CI logger instance.
+        #
+        # @param output [IO] the output stream.
+        #
+        # @api public
+        #
+        def initialize(output = STDOUT)
+          super
+          @buffer = ''
+          @skip = false
+        end
+
+        protected
+
+        #
+        # Print a Docker build stream in the proper format.
+        #
+        # @param stream [String] The stream in raw.
+        #
+        # @return void
+        #
+        # @api private
+        #
+        def print_stream(stream)
+          if stream.match(/^Step /)
+            @buffer = stream
+            @skip = true
+          else
+            @buffer += stream
+            @skip = false if stream.match(/^ ---> (Running in|\[Warning\]) /)
+          end
+          return if @skip
+          @output.puts @buffer
+          @buffer = ''
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# encoding: UTF-8
+#
+# Author:: Xabier de Zuazo (<xabier@zuazo.org>)
+# Copyright:: Copyright (c) 2015 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/builder/logger/info'
+
+module Dockerspec
+  class Builder
+    class Logger
+      #
+      # A {Dockerspec::Builder} logger to output all the provided information in
+      # its raw original form.
+      #
+      class Debug < Info
+        #
+        # Prints the docker build chunk in raw.
+        #
+        # @param chunk [Hash] The docker build chunk.
+        #
+        # @return void
+        #
+        # @api public
+        #
+        def print_chunk(chunk)
+          chunk_json = parse_chunk(chunk)
+          print_status(chunk_json.delete('status'))
+          @output.puts chunk_json.inspect
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+# encoding: UTF-8
+#
+# Author:: Xabier de Zuazo (<xabier@zuazo.org>)
+# Copyright:: Copyright (c) 2015 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.
+#
+
+module Dockerspec
+  class Builder
+    class Logger
+      #
+      # A {Dockerspec::Builder} logger that gives information about main build
+      # steps.
+      #
+      class Info
+        #
+        # Creates a Info logger instance.
+        #
+        # @param output [IO] the output stream.
+        #
+        # @api public
+        #
+        def initialize(output = STDOUT)
+          @output = output
+          @status = nil
+        end
+
+        #
+        # Prints the Docker build chunk.
+        #
+        # @param chunk [Hash] The docker build chunk.
+        #
+        # @return void
+        #
+        # @api public
+        #
+        def print_chunk(chunk)
+          chunk_json = parse_chunk(chunk)
+          print_status(chunk_json['status'])
+          return unless chunk_json.key?('stream')
+          print_stream(chunk_json['stream'])
+        end
+
+        protected
+
+        #
+        # Parses the Docker build process chunk.
+        #
+        # @param chunk [String] The chunk in JSON.
+        #
+        # @return [Hash] The chunk parsed as a Hash.
+        #
+        # @api private
+        #
+        def parse_chunk(chunk)
+          return chunk if chunk.is_a?(Hash)
+          JSON.parse(chunk)
+        rescue JSON::ParserError
+          { 'stream' => chunk }
+        end
+
+        #
+        # Prints progress status in a shorter format.
+        #
+        # For example: `'Downloading.....\nExtracting..`'.
+        #
+        # @param status [String] The name of the current status.
+        #
+        # @return void
+        #
+        # @api private
+        #
+        def print_status(status)
+          if status != @status
+            @output.puts
+            @status = status
+            @output.print "#{status}." unless status.nil?
+          elsif !status.nil?
+            @output.print '.'
+          end
+          @output.flush
+        end
+
+        #
+        # Prints the stream.
+        #
+        # @param stream [String] The text to print.
+        #
+        # @return void
+        #
+        # @api private
+        #
+        def print_stream(stream)
+          @output.puts stream
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# encoding: UTF-8
+#
+# Author:: Xabier de Zuazo (<xabier@zuazo.org>)
+# Copyright:: Copyright (c) 2015 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.
+#
+
+module Dockerspec
+  class Builder
+    class Logger
+      #
+      # A {Dockerspec::Builder} logger that outputs nothing.
+      #
+      class Silent
+        #
+        # Creates a Silent logger instance.
+        #
+        # @param _args [Mixed] ignored.
+        #
+        # @return void
+        #
+        # @api private
+        #
+        def initialize(*_args); end
+
+        #
+        # Prints nothing.
+        #
+        # @param _chunk [Mixed] ignored.
+        #
+        # @return void
+        #
+        # @api private
+        #
+        def print_chunk(_chunk); end
+      end
+    end
+  end
+end

data/lib/dockerspec/builder/matchers.rb

@@ -0,0 +1,134 @@
+# encoding: UTF-8
+#
+# Author:: Xabier de Zuazo (<xabier@zuazo.org>)
+# Copyright:: Copyright (c) 2015 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 'rspec/expectations'
+require 'dockerspec/builder/matchers/helpers'
+
+module Dockerspec
+  class Builder
+    #
+    # Creates some RSpec *have_* matchers for Docker builds.
+    #
+    module Matchers
+      extend RSpec::Matchers::DSL
+
+      #
+      # The matcher list with the type it belongs to.
+      #
+      # This is based on [the official *Dockerfile* parser code]
+      # (https://github.com/docker/docker/tree/master/builder/dockerfile/parser)
+      # .
+      #
+      # The possible types are:
+      #
+      # - `:string`: A simple string. For example the `MAINTAINER` instruction.
+      # - `:json`: Can in JSON (a Ruby array) or in string format. For example
+      #     the `CMD` or the `ENTRYPOINT` instructions.
+      # - `:hash`: A hash. For example the `ENV` or the `LABEL` instructions.
+      # - `:array`: A array of values. For example the `EXPOSE` instruction.
+      #
+      PREDICATE_TYPES = {
+        maintainer: :string,
+        cmd: :json,
+        label: :hash,
+        expose: :array,
+        env: :hash,
+        entrypoint: :json,
+        volume: :array,
+        user: :string,
+        workdir: :string,
+        onbuild: :array,
+        stopsignal: :string
+      }
+
+      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? }
+
+            failure_message do |actual|
+              "expected `#{name.upcase}` to match `#{expected.inspect}`, "\
+                "got `#{actual.send(name)}`"
+            end
+
+            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) }
+
+            failure_message do |actual|
+              "expected `#{name.upcase}` to be `#{expected.inspect}`, "\
+                "got `#{actual.send(name)}`"
+            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
+
+            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")
+              break sub_hash?(actual, expected) if expected.is_a?(Hash)
+              !actual.keys.grep(expected).empty?
+            end
+
+            failure_message do |actual|
+              "expected `#{name.upcase}` to contain `#{expected.inspect}`, "\
+                "got `#{actual.send("#{name}s")}`"
+            end
+
+            failure_message_when_negated do |actual|
+              "expected `#{name.upcase}` not to contain "\
+              "`#{expected.inspect}`, got `#{actual.send("#{name}s")}`"
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure { |c| c.include(Dockerspec::Builder::Matchers) }