dockerspec 0.2.0 → 0.3.0

data/lib/dockerspec/engine/base.rb

@@ -0,0 +1,156 @@
+# 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.
+#
+
+module Dockerspec
+  #
+  # The classes behind this namespace are Testing Engines. These are the
+  # frameworks used below to run the tests. For example `Specinfra` (used by
+  # `Serverspec`).
+  #
+  module Engine
+    #
+    # A basic class with the minimal skeleton to create a Testing Engine.
+    #
+    class Base
+      #
+      # Constructs the engine.
+      #
+      # Saves the runner and the options.
+      #
+      # @param runner [Dockerspec::Runner::Base] The class that is being used
+      #   to run the Docker Containers.
+      #
+      # @return [Dockerspec::Engine::Base] The engine.
+      #
+      # @api public
+      #
+      def initialize(runner)
+        @runner = runner
+      end
+
+      #
+      # Runs the engine setup just before running docker.
+      #
+      # Also run when there is a change in the testing target like changing the
+      # container you want to run the tests into with Docker Compose.
+      #
+      # Usually this is implemented to clean configurations from previous tests.
+      #
+      # Does nothing by default.
+      #
+      # @param args [Mixed] The passed arguments.
+      #
+      # @return void
+      #
+      # @api public
+      #
+      def before_running(*args); end
+
+      #
+      # Saves the engine status internally after starting the docker container.
+      #
+      # Does nothing by default.
+      #
+      # @param args [Mixed] The passed arguments.
+      #
+      # @return void
+      #
+      # @api public
+      #
+      def when_running(*args); end
+
+      #
+      # Runs when the container to test is ready.
+      #
+      # This is mainly used with Docker Compose to know when the container to
+      # test is selected.
+      #
+      # Without Docker Compose this is called just after calling
+      # {#when_running}.
+      #
+      # Does nothing by default.
+      #
+      # @param args [Mixed] The passed arguments.
+      #
+      # @return void
+      #
+      # @api public
+      #
+      def when_container_ready(*args); end
+
+      #
+      # Restores the engine internal status after running tests on other
+      # containers.
+      #
+      # This is used to avoid the engine running against the last started
+      # container if you are testing multiple containers at the same time.
+      #
+      # Does nothing by default.
+      #
+      # @param args [Mixed] The passed arguments.
+      #
+      # @return void
+      #
+      # @api public
+      #
+      def restore(*args); end
+
+      protected
+
+      #
+      # Gets the configuration options from the runner.
+      #
+      # @return [Hash] Options list.
+      #
+      # @api private
+      #
+      def options
+        @runner.options
+      end
+
+      #
+      # Gets the Container Name.
+      #
+      # @return [String, nil] Container name.
+      #
+      # @raise [Dockerspec::RunnerError] When the `#container` method is no
+      #   implemented in the subclass or cannot select the container to test.
+      #
+      # @api private
+      #
+      def container_name
+        @runner.container_name
+      end
+
+      #
+      # Gets the Docker Container IP address.
+      #
+      # @return [String] IP address.
+      #
+      # @raise [Dockerspec::RunnerError] When the `#container` method is no
+      #   implemented in the subclass or cannot select the container to test.
+      #
+      # @api private
+      #
+      def ipaddress
+        @runner.ipaddress
+      end
+    end
+  end
+end

data/lib/dockerspec/engine/infrataster.rb

@@ -0,0 +1,87 @@
+# 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 'infrataster/rspec'
+require 'dockerspec/engine/base'
+require 'securerandom'
+
+module Dockerspec
+  module Engine
+    #
+    # The Infrataster testing engine implementation.
+    #
+    class Infrataster < Base
+      include ::Infrataster::Helpers::ResourceHelper
+
+      #
+      # Constructs a testing engine to use Infrataster.
+      #
+      # @param runner [Dockerspec::Runner::Base] The class that is being used
+      #   to run the Docker Containers.
+      #
+      # @return [Dockerspec::Engine::Specinfra] The engine.
+      #
+      # @api public
+      #
+      def initialize(runner)
+        super
+        @definitions = {}
+      end
+
+      #
+      # Sets up Infrataster.
+      #
+      # @return void
+      #
+      # @raise [Dockerspec::RunnerError] When the `#container` method is no
+      #   implemented in the subclass or cannot select the container to test.
+      #
+      # @api public
+      #
+      def when_container_ready
+        define_server
+      end
+
+      protected
+
+      #
+      # Defines the Infrataster server to test.
+      #
+      # It calls {Infrataster::Server.define} reading the internal IP address
+      # from the Docker metadata.
+      #
+      # @return void
+      #
+      # @raise [Dockerspec::RunnerError] When the `#container` method is no
+      #   implemented in the subclass or cannot select the container to test.
+      #
+      # @api private
+      #
+      def define_server
+        return if @definitions.key?(container_name)
+        ::Infrataster::Server.define(
+          container_name.to_sym,
+          ipaddress,
+          options
+        )
+        @definitions[container_name] = ipaddress
+      end
+    end
+  end
+end

data/lib/dockerspec/engine/specinfra.rb

@@ -0,0 +1,130 @@
+# 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/engine/base'
+require 'dockerspec/engine/specinfra/backend'
+
+module Dockerspec
+  module Engine
+    #
+    # The Specinfra (Serverspec) testing engine implementation.
+    #
+    class Specinfra < Base
+      #
+      # Constructs a testing engine to use Specinfra (used by Serverspec).
+      #
+      # @param runner [Dockerspec::Runner::Base] The class that is being used
+      #   to run the Docker Containers.
+      #
+      # @return [Dockerspec::Engine::Specinfra] The engine.
+      #
+      # @api public
+      #
+      def initialize(runner)
+        super
+        @backend = nil
+      end
+
+      #
+      # Sets the Specinfra configuration.
+      #
+      # - Resets the internal Specinfra backend reference.
+      # - Sets the chosen container name with Docker Compose.
+      # - Sets the `:family`.
+      #
+      # @return void
+      #
+      # @api private
+      #
+      def before_running
+        if @backend.nil?
+          @backend = Backend.new(backend_name)
+          @backend.reset
+        end
+        setup_container_name
+        setup_family
+      end
+
+      #
+      # Saves the Specinfra backend reference internally to restore it later.
+      #
+      # @return void
+      #
+      # @api private
+      #
+      def when_running
+        @backend.save
+      end
+
+      #
+      # Restores the Specinfra backend instance to point to this object's
+      # container.
+      #
+      # This is used to avoid Serverspec running against the previous started
+      # container if you are testing multiple containers at the same time.
+      #
+      # @return void
+      #
+      # @api private
+      #
+      def restore
+        @backend.restore
+        setup_container_name
+        setup_family
+      end
+
+      protected
+
+      #
+      # Gets the Specinfra backend name from the runner.
+      #
+      # @return [String] The backend name.
+      #
+      # @api private
+      #
+      def backend_name
+        @runner.backend_name
+      end
+
+      #
+      # Sets up the OS family.
+      #
+      # @return void
+      #
+      # @api private
+      #
+      def setup_family
+        return unless options.key?(:family)
+        ::Specinfra.configuration.os(family: options[:family])
+      end
+
+      #
+      # Selects the container to test.
+      #
+      # @return void
+      #
+      # @api private
+      #
+      def setup_container_name
+        return unless options.key?(:container)
+        @backend.restore_container(options[:container])
+      end
+    end
+  end
+end

data/lib/dockerspec/engine/specinfra/backend.rb

@@ -0,0 +1,163 @@
+# 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 'specinfra/backend/base'
+require 'dockerspec/engine/specinfra/backend_hack'
+
+module Dockerspec
+  module Engine
+    class Specinfra < Base
+      #
+      # A class to handle the underlying Specinfra backend.
+      #
+      # This class saves Specinfra instance in internally and then it is able
+      # to recover it from there and setup the running environment accordingly.
+      #
+      # This class uses a small hack in the Specinfra class to reset its
+      # internal singleton instance.
+      #
+      class Backend
+        #
+        # The Specinfra backend constructor.
+        #
+        # @param backend [Symbol, Specinfra::Backend::Base, Class] The backend
+        #   can be the backend name as a symbol, a Specinfra backend object or
+        #   a Specinfra backend class.
+        #
+        # @api public
+        #
+        def initialize(backend)
+          @backend = backend
+        end
+
+        #
+        # Saves the Specinfra backend instance reference internally.
+        #
+        # @return void
+        #
+        # @api public
+        #
+        def save
+          @saved_backend_name = ::Specinfra.configuration.backend
+          @saved_backend_instance = backend_instance
+        end
+
+        #
+        # Restores the Specinfra backend instance.
+        #
+        # @return void
+        #
+        # @api public
+        #
+        def restore
+          instance_set(@saved_backend_instance)
+          ::Specinfra.configuration.backend = @saved_backend_name
+        end
+
+        #
+        # Restores the testing context for a container.
+        #
+        # Used with Docker Compose to choose the container to test.
+        #
+        # @param container_name [String, Symbol] The name of the container.
+        #
+        # @return void
+        #
+        # @api public
+        #
+        def restore_container(container_name)
+          current_container_name =
+            ::Specinfra.configuration.docker_compose_container
+          return if current_container_name == container_name
+          ::Specinfra.configuration.docker_compose_container(container_name)
+          # TODO: Save the host family instead of always reseting it:
+          backend_class.host_reset
+        end
+
+        #
+        # Resets the Specinfra backend.
+        #
+        # @return void
+        #
+        # @api public
+        #
+        def reset
+          instance_set(nil)
+        end
+
+        #
+        # Gets the internal attribute value from the Specinfra backend object.
+        #
+        # Used mainly to get information from the running containers like their
+        # name or their IP address.
+        #
+        # @return [Mixed] The value of the attribute to read.
+        #
+        # @api public
+        #
+        def backend_instance_attribute(name)
+          backend_instance.instance_variable_get("@#{name}".to_sym)
+        end
+
+        protected
+
+        #
+        # Sets the Specinfra backend.
+        #
+        # Used by {.load}.
+        #
+        # @param instance [Specinfra::Backend::Base] The Specinfra backend
+        #   object.
+        #
+        # @return void
+        #
+        # @api private
+        #
+        def instance_set(instance)
+          backend_class.instance_set(instance)
+        end
+
+        #
+        # Returns the current Specinfra backend object.
+        #
+        # @return [Specinfra::Backend::Base] The Specinfra backend object.
+        #
+        # @api private
+        #
+        def backend_instance
+          backend_class.instance
+        end
+
+        #
+        # Returns the current Specinfra backend class.
+        #
+        # @return [Class] The Specinfra backend class.
+        #
+        # @api private
+        #
+        def backend_class
+          @backend_class ||= begin
+            return @backend.class if @backend.is_a?(::Specinfra::Backend::Base)
+            ::Specinfra::Backend.const_get(@backend.to_s.to_camel_case)
+          end
+        end
+      end
+    end
+  end
+end