dockerspec 0.2.0 → 0.3.0

data/lib/dockerspec/runner/serverspec/compose.rb

@@ -0,0 +1,106 @@
+# 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 'serverspec'
+require 'specinfra/backend/docker_compose_lxc'
+require 'dockerspec/runner/compose'
+require 'dockerspec/runner/serverspec/base'
+require 'dockerspec/runner/serverspec/rspec'
+
+module Dockerspec
+  module Runner
+    module Serverspec
+      #
+      # Runs Docker Compose using [Serverspec](http://serverspec.org/).
+      #
+      class Compose < Dockerspec::Runner::Compose
+        include Base
+        #
+        # Constructs a Serverspec runner class to run Docker Compose.
+        #
+        # @example From a Directory
+        #   Dockerspec::Runner::Serverspec::Compose.new('directory1')
+        #     #=> #<Dockerspec::Runner::Serverspec::Compose:0x0124>
+        #
+        # @example From a YAML File
+        #   Dockerspec::Runner::Serverspec::Compose.new('my/docker-compose.yml')
+        #     #=> #<Dockerspec::Runner::Serverspec::Compose:0x0124>
+        #
+        # @example From a Directory or File Using Hash Format
+        #   Dockerspec::Runner::Serverspec::Compose.new(file: 'file.yml')
+        #     #=> #<Dockerspec::Runner::Serverspec::Compose:0x0124>
+        #
+        # @param opts [String, Hash] The `:file` or a list of options.
+        #
+        # @option opts [String] :file The compose YAML file or a directory
+        #   containing the `'docker-compose.yml'` file.
+        # @option opts [Boolean] :rm (calculated) Whether to remove the Docker
+        #   containers afterwards.
+        # @option opts [Symbol, String] :family (calculated) The OS family if
+        #   is the the same for all the containers.
+        #   It's automatically detected by default, but can be used to
+        #   **speed up the tests**. Some possible values:
+        #   `:alpine`, `:arch`, `:coreos`, `:debian`, `:gentoo`, `:nixos`,
+        #   `:plamo`, `:poky`, `:redhat`, `:suse`.
+        # @option opts [Symbol] :backend (calculated) Docker backend to use:
+        #   `:docker`, `:lxc`.
+        #
+        # @return [Dockerspec::Runner::Serverspec::Compose] Runner object.
+        #
+        # @api public
+        #
+        def initialize(*opts)
+          super
+          calculate_docker_backend_name('docker_compose')
+        end
+
+        protected
+
+        #
+        # Gets the internal {DockerCompose} object.
+        #
+        # @return [DockerCompose] The compose object.
+        #
+        # @api private
+        #
+        def compose
+          @cached_compose ||= begin
+            backend = Engine::Specinfra::Backend.new(backend_name)
+            backend.backend_instance_attribute(:compose)
+          end
+        end
+
+        #
+        # Sets the Specinfra configuration and the engines.
+        #
+        # - Sets up the testing engines.
+        # - Configures the compose file to use.
+        #
+        # @return void
+        #
+        # @api private
+        #
+        def before_running
+          super
+          Specinfra.configuration.docker_compose_file(@options[:file])
+        end
+      end
+    end
+  end
+end

data/lib/dockerspec/runner/serverspec/docker.rb

@@ -0,0 +1,116 @@
+# encoding: UTF-8
+#
+# Author:: Xabier de Zuazo (<xabier@zuazo.org>)
+# Copyright:: Copyright (c) 2015-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 'serverspec'
+require 'specinfra/backend/docker_lxc'
+require 'dockerspec/runner/docker'
+require 'dockerspec/runner/serverspec/base'
+require 'dockerspec/runner/serverspec/rspec'
+
+module Dockerspec
+  module Runner
+    module Serverspec
+      #
+      # Runs a Docker container using [Serverspec](http://serverspec.org/).
+      #
+      class Docker < Dockerspec::Runner::Docker
+        include Base
+
+        #
+        # Constructs a Docker Serverspec runner class to run Docker images.
+        #
+        # @example From a Docker Container Image Tag
+        #   Dockerspec::Runner::Serverspec::Docker.new('myapp')
+        #     #=> #<Dockerspec::Runner::Serverspec::Docker:0x0124>
+        #
+        # @example From a Docker Container Image Tag Using Hash Format
+        #   Dockerspec::Runner::Serverspec::Docker.new(tag: 'myapp')
+        #     #=> #<Dockerspec::Runner::Serverspec::Docker:0x0124>
+        #
+        # @example From a Running Docker Container ID
+        #   Dockerspec::Runner::Serverspec::Docker.new(id: 'c51f86c28340')
+        #     #=> #<Dockerspec::Runner::Serverspec::Docker:0x0125>
+        #
+        # @param opts [String, Hash] The `:tag` or a list of options.
+        #
+        # @option opts [String] :tag The Docker image tag name to run.
+        # @option opts [String] :id The Docker container ID to use instead of
+        #   starting a new container.
+        # @option opts [Boolean] :rm (calculated) Whether to remove the Docker
+        #   container afterwards.
+        # @option opts [String] :path The environment `PATH` value of the
+        #   container.
+        # @option opts [Hash, Array] :env Some `ENV` instructions to add to the
+        #   container.
+        # @option opts [Symbol, String] :family (calculated) The OS family.
+        #   It's automatically detected by default, but can be used to
+        #   **speed up the tests**. Some possible values:
+        #   `:alpine`, `:arch`, `:coreos`, `:debian`, `:gentoo`, `:nixos`,
+        #   `:plamo`, `:poky`, `:redhat`, `:suse`.
+        # @option opts [Integer] :wait Time to wait before running the tests.
+        # @option opts [Symbol] :backend (calculated) Docker backend to use:
+        #   `:docker`, `:lxc`.
+        #
+        # @return [Dockerspec::Runner::Serverspec::Docker] Runner object.
+        #
+        # @api public
+        #
+        def initialize(*opts)
+          super
+          calculate_docker_backend_name('docker')
+        end
+
+        #
+        # Gets the internal {Docker::Container} object.
+        #
+        # @return [Docker::Container] The container.
+        #
+        # @api public
+        #
+        def container
+          @cached_container ||= begin
+            backend = Engine::Specinfra::Backend.new(backend_name)
+            backend.backend_instance_attribute(:container)
+          end
+        end
+
+        protected
+
+        #
+        # Sets the engines and the Specinfra configuration.
+        #
+        # Sets the `:docker_image` or `:docker_container`.
+        #
+        # @return void
+        #
+        # @api private
+        #
+        def before_running
+          super
+          Specinfra.configuration.env(options[:env]) if options.key?(:env)
+          if source == :id
+            Specinfra.configuration.docker_container(id)
+          else
+            Specinfra.configuration.docker_image(image_id)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dockerspec/runner/serverspec/rspec.rb

@@ -0,0 +1,20 @@
+# 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/serverspec/rspec/settings'

data/lib/dockerspec/{serverspec/rspec_settings.rb → runner/serverspec/rspec/settings.rb}

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 #
 # Author:: Xabier de Zuazo (<xabier@zuazo.org>)
-# Copyright:: Copyright (c) 2015 Xabier de Zuazo
+# Copyright:: Copyright (c) 2015-2016 Xabier de Zuazo
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/dockerspec/serverspec.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 #
 # Author:: Xabier de Zuazo (<xabier@zuazo.org>)
-# Copyright:: Copyright (c) 2015 Xabier de Zuazo
+# Copyright:: Copyright (c) 2015-2016 Xabier de Zuazo
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,4 +17,14 @@
 # limitations under the License.
 #
 
-require 'dockerspec/serverspec/rspec_resources'
+require 'dockerspec'
+require 'dockerspec/runner/serverspec'
+require 'dockerspec/engine/specinfra'
+
+#
+# Use Serverpec to start the containers (runner) and to run the tests (engine).
+#
+Dockerspec::Configuration.docker_runner = Dockerspec::Runner::Serverspec::Docker
+Dockerspec::Configuration.compose_runner =
+  Dockerspec::Runner::Serverspec::Compose
+Dockerspec::Configuration.add_engine Dockerspec::Engine::Specinfra

data/lib/dockerspec/version.rb

@@ -25,5 +25,5 @@ module Dockerspec
   #
   # Dockerspec Ruby Gem version.
   #
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'.freeze
 end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 #
 # Author:: Xabier de Zuazo (<xabier@zuazo.org>)
-# Copyright:: Copyright (c) 2015 Xabier de Zuazo
+# Copyright:: Copyright (c) 2015-2016 Xabier de Zuazo
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,8 +26,8 @@ SimpleCov.start do
   add_filter '/spec/'
 end
 
-require 'dockerspec'
 require 'dockerspec/serverspec'
+require 'dockerspec/infrataster'
 require 'support/dockerspec_tests'
 
 require 'should_not/rspec'
@@ -42,4 +42,8 @@ RSpec.configure do |config|
 
   config.color = true
   config.tty = true
+
+  config.include DockerspecTests
 end
+
+DockerspecTests.init_engines

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerspec
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Xabier de Zuazo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: docker-compose-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.24'
+- !ruby/object:Gem::Dependency
+  name: infrataster
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: specinfra-backend-docker_lxc
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: specinfra-backend-docker_compose
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -198,14 +240,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.0
+        version: 0.37.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.0
+        version: 0.37.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -220,8 +262,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: A small gem to run RSpec and Serverspec tests against Dockerfiles or
-  Docker images easily.
+- !ruby/object:Gem::Dependency
+  name: infrataster-plugin-mysql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: A small gem to run RSpec, Serverspec, Infrataster and Capybara tests
+  against Dockerfiles or Docker images easily.
 email: xabier@zuazo.org
 executables: []
 extensions: []
@@ -246,24 +302,37 @@ files:
 - lib/dockerspec/builder/logger/silent.rb
 - lib/dockerspec/builder/matchers.rb
 - lib/dockerspec/builder/matchers/helpers.rb
+- lib/dockerspec/configuration.rb
 - lib/dockerspec/docker_exception_parser.rb
 - lib/dockerspec/docker_gem.rb
+- lib/dockerspec/engine/base.rb
+- lib/dockerspec/engine/infrataster.rb
+- lib/dockerspec/engine/specinfra.rb
+- lib/dockerspec/engine/specinfra/backend.rb
+- lib/dockerspec/engine/specinfra/backend_hack.rb
+- lib/dockerspec/engine_list.rb
 - lib/dockerspec/exceptions.rb
 - lib/dockerspec/helper/ci.rb
 - lib/dockerspec/helper/docker.rb
 - lib/dockerspec/helper/multiple_sources_description.rb
 - lib/dockerspec/helper/rspec_example_helpers.rb
-- lib/dockerspec/rspec_assertions.rb
-- lib/dockerspec/rspec_configuration.rb
-- lib/dockerspec/rspec_resources.rb
-- lib/dockerspec/rspec_settings.rb
+- lib/dockerspec/infrataster.rb
+- lib/dockerspec/rspec.rb
+- lib/dockerspec/rspec/configuration.rb
+- lib/dockerspec/rspec/resources.rb
+- lib/dockerspec/rspec/resources/its_container.rb
+- lib/dockerspec/rspec/settings.rb
 - lib/dockerspec/runner.rb
+- lib/dockerspec/runner/base.rb
+- lib/dockerspec/runner/compose.rb
+- lib/dockerspec/runner/docker.rb
+- lib/dockerspec/runner/serverspec.rb
+- lib/dockerspec/runner/serverspec/base.rb
+- lib/dockerspec/runner/serverspec/compose.rb
+- lib/dockerspec/runner/serverspec/docker.rb
+- lib/dockerspec/runner/serverspec/rspec.rb
+- lib/dockerspec/runner/serverspec/rspec/settings.rb
 - lib/dockerspec/serverspec.rb
-- lib/dockerspec/serverspec/rspec_resources.rb
-- lib/dockerspec/serverspec/rspec_settings.rb
-- lib/dockerspec/serverspec/runner.rb
-- lib/dockerspec/serverspec/specinfra_backend.rb
-- lib/dockerspec/serverspec/specinfra_hack.rb
 - lib/dockerspec/version.rb
 - spec/spec_helper.rb
 homepage: https://github.com/zuazo/dockerspec