test-kitchen 1.6.0 → 1.7.0

data/lib/kitchen/state_file.rb

@@ -1,120 +1,120 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2013, Fletcher Nichol
-#
-# 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.
-
-if RUBY_VERSION <= "1.9.3"
-  # ensure that Psych and not Syck is used for Ruby 1.9.2
-  require "yaml"
-  YAML::ENGINE.yamler = "psych"
-end
-require "safe_yaml/load"
-
-module Kitchen
-
-  # Exception class for any exceptions raised when reading and parsing a state
-  # file from disk
-  class StateFileLoadError < StandardError; end
-
-  # State persistence manager for instances between actions and invocations.
-  #
-  # @author Fletcher Nichol <fnichol@nichol.ca>
-  class StateFile
-
-    # Constructs an new instance taking the kitchen root and instance name.
-    #
-    # @param kitchen_root [String] path to the Kitchen project's root directory
-    # @param name [String] name of the instance representing this state
-    def initialize(kitchen_root, name)
-      @file_name = File.expand_path(
-        File.join(kitchen_root, ".kitchen", "#{name}.yml")
-      )
-    end
-
-    # Reads and loads an instance's state into a Hash data structure which is
-    # returned.
-    #
-    # @return [Hash] a hash representation of an instance's state
-    # @raise [StateFileLoadError] if there is a problem loading the state file
-    #   from disk and loading it into a Hash
-    def read
-      if File.exist?(file_name) && !File.zero?(file_name)
-        Util.symbolized_hash(deserialize_string(read_file))
-      else
-        Hash.new
-      end
-    end
-
-    # Serializes the state hash and writes a state file to disk.
-    #
-    # @param state [Hash] the current state of the instance
-    def write(state)
-      dir = File.dirname(file_name)
-      serialized_string = serialize_hash(Util.stringified_hash(state))
-
-      FileUtils.mkdir_p(dir) if !File.directory?(dir)
-      File.open(file_name, "wb") { |f| f.write(serialized_string) }
-    end
-
-    # Destroys a state file on disk if it exists.
-    def destroy
-      FileUtils.rm_f(file_name) if File.exist?(file_name)
-    end
-
-    # Returns a Hash of configuration and other useful diagnostic information.
-    #
-    # @return [Hash] a diagnostic hash
-    def diagnose
-      raw = read
-      result = Hash.new
-      raw.keys.sort.each { |k| result[k] = raw[k] }
-      result
-    end
-
-    private
-
-    # @return [String] absolute path to the yaml state file on disk
-    # @api private
-    attr_reader :file_name
-
-    # @return [String] a string representation of the yaml state file
-    # @api private
-    def read_file
-      IO.read(file_name)
-    end
-
-    # Parses a YAML string and returns a Hash.
-    #
-    # @param string [String] a yaml document as a string
-    # @return [Hash] a hash
-    # @raise [StateFileLoadError] if the string document cannot be parsed
-    # @api private
-    def deserialize_string(string)
-      SafeYAML.load(string)
-    rescue SyntaxError, Psych::SyntaxError => ex
-      raise StateFileLoadError, "Error parsing #{file_name} (#{ex.message})"
-    end
-
-    # Serializes a Hash into a YAML string.
-    #
-    # @param hash [Hash] a hash
-    # @return [String] a yaml document as a string
-    # @api private
-    def serialize_hash(hash)
-      ::YAML.dump(hash)
-    end
-  end
-end
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# 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.
+
+if RUBY_VERSION <= "1.9.3"
+  # ensure that Psych and not Syck is used for Ruby 1.9.2
+  require "yaml"
+  YAML::ENGINE.yamler = "psych"
+end
+require "safe_yaml/load"
+
+module Kitchen
+
+  # Exception class for any exceptions raised when reading and parsing a state
+  # file from disk
+  class StateFileLoadError < StandardError; end
+
+  # State persistence manager for instances between actions and invocations.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class StateFile
+
+    # Constructs an new instance taking the kitchen root and instance name.
+    #
+    # @param kitchen_root [String] path to the Kitchen project's root directory
+    # @param name [String] name of the instance representing this state
+    def initialize(kitchen_root, name)
+      @file_name = File.expand_path(
+        File.join(kitchen_root, ".kitchen", "#{name}.yml")
+      )
+    end
+
+    # Reads and loads an instance's state into a Hash data structure which is
+    # returned.
+    #
+    # @return [Hash] a hash representation of an instance's state
+    # @raise [StateFileLoadError] if there is a problem loading the state file
+    #   from disk and loading it into a Hash
+    def read
+      if File.exist?(file_name) && !File.zero?(file_name)
+        Util.symbolized_hash(deserialize_string(read_file))
+      else
+        Hash.new
+      end
+    end
+
+    # Serializes the state hash and writes a state file to disk.
+    #
+    # @param state [Hash] the current state of the instance
+    def write(state)
+      dir = File.dirname(file_name)
+      serialized_string = serialize_hash(Util.stringified_hash(state))
+
+      FileUtils.mkdir_p(dir) if !File.directory?(dir)
+      File.open(file_name, "wb") { |f| f.write(serialized_string) }
+    end
+
+    # Destroys a state file on disk if it exists.
+    def destroy
+      FileUtils.rm_f(file_name) if File.exist?(file_name)
+    end
+
+    # Returns a Hash of configuration and other useful diagnostic information.
+    #
+    # @return [Hash] a diagnostic hash
+    def diagnose
+      raw = read
+      result = Hash.new
+      raw.keys.sort.each { |k| result[k] = raw[k] }
+      result
+    end
+
+    private
+
+    # @return [String] absolute path to the yaml state file on disk
+    # @api private
+    attr_reader :file_name
+
+    # @return [String] a string representation of the yaml state file
+    # @api private
+    def read_file
+      IO.read(file_name)
+    end
+
+    # Parses a YAML string and returns a Hash.
+    #
+    # @param string [String] a yaml document as a string
+    # @return [Hash] a hash
+    # @raise [StateFileLoadError] if the string document cannot be parsed
+    # @api private
+    def deserialize_string(string)
+      SafeYAML.load(string)
+    rescue SyntaxError, Psych::SyntaxError => ex
+      raise StateFileLoadError, "Error parsing #{file_name} (#{ex.message})"
+    end
+
+    # Serializes a Hash into a YAML string.
+    #
+    # @param hash [Hash] a hash
+    # @return [String] a yaml document as a string
+    # @api private
+    def serialize_hash(hash)
+      ::YAML.dump(hash)
+    end
+  end
+end

data/lib/kitchen/suite.rb

@@ -1,51 +1,51 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2012, Fletcher Nichol
-#
-# 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 Kitchen
-
-  # A logical configuration representing a test case or fixture that will be
-  # executed on a platform.
-  #
-  # @author Fletcher Nichol <fnichol@nichol.ca>
-  class Suite
-
-    # @return [String] logical name of this suite
-    attr_reader :name
-
-    # @return [Array] Array of names of excluded platforms
-    attr_reader :excludes
-
-    # @return [Array] Array of names of only included platforms
-    attr_reader :includes
-
-    # Constructs a new suite.
-    #
-    # @param [Hash] options configuration for a new suite
-    # @option options [String] :name logical name of this suit (**Required**)
-    # @option options [String] :excludes Array of names of excluded platforms
-    # @option options [String] :includes Array of names of only included
-    #   platforms
-    def initialize(options = {})
-      @name = options.fetch(:name) do
-        raise ClientError, "Suite#new requires option :name"
-      end
-      @excludes = options.fetch(:excludes, [])
-      @includes = options.fetch(:includes, [])
-    end
-  end
-end
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, Fletcher Nichol
+#
+# 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 Kitchen
+
+  # A logical configuration representing a test case or fixture that will be
+  # executed on a platform.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class Suite
+
+    # @return [String] logical name of this suite
+    attr_reader :name
+
+    # @return [Array] Array of names of excluded platforms
+    attr_reader :excludes
+
+    # @return [Array] Array of names of only included platforms
+    attr_reader :includes
+
+    # Constructs a new suite.
+    #
+    # @param [Hash] options configuration for a new suite
+    # @option options [String] :name logical name of this suit (**Required**)
+    # @option options [String] :excludes Array of names of excluded platforms
+    # @option options [String] :includes Array of names of only included
+    #   platforms
+    def initialize(options = {})
+      @name = options.fetch(:name) do
+        raise ClientError, "Suite#new requires option :name"
+      end
+      @excludes = options.fetch(:excludes, [])
+      @includes = options.fetch(:includes, [])
+    end
+  end
+end

data/lib/kitchen/thor_tasks.rb

@@ -1,66 +1,66 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2012, Fletcher Nichol
-#
-# 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 "thor"
-
-require "kitchen"
-
-module Kitchen
-
-  # Kitchen Thor task generator.
-  #
-  # @author Fletcher Nichol <fnichol@nichol.ca>
-  class ThorTasks < Thor
-
-    namespace :kitchen
-
-    # Creates Kitchen Thor tasks and allows the callee to configure it.
-    #
-    # @yield [self] gives itself to the block
-    def initialize(*args)
-      super
-      @config = Kitchen::Config.new
-      Kitchen.logger = Kitchen.default_file_logger(nil, false)
-      yield self if block_given?
-      define
-    end
-
-    private
-
-    # @return [Config] a Kitchen::Config
-    attr_reader :config
-
-    # Generates a test Thor task for each instance and one to test all
-    # instances in serial.
-    #
-    # @api private
-    def define
-      config.instances.each do |instance|
-        self.class.desc instance.name, "Run #{instance.name} test instance"
-        self.class.send(:define_method, instance.name.gsub(/-/, "_")) do
-          instance.test(:always)
-        end
-      end
-
-      self.class.desc "all", "Run all test instances"
-      self.class.send(:define_method, :all) do
-        config.instances.each { |i| invoke i.name.gsub(/-/, "_") }
-      end
-    end
-  end
-end
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, Fletcher Nichol
+#
+# 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 "thor"
+
+require "kitchen"
+
+module Kitchen
+
+  # Kitchen Thor task generator.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class ThorTasks < Thor
+
+    namespace :kitchen
+
+    # Creates Kitchen Thor tasks and allows the callee to configure it.
+    #
+    # @yield [self] gives itself to the block
+    def initialize(*args)
+      super
+      @config = Kitchen::Config.new
+      Kitchen.logger = Kitchen.default_file_logger(nil, false)
+      yield self if block_given?
+      define
+    end
+
+    private
+
+    # @return [Config] a Kitchen::Config
+    attr_reader :config
+
+    # Generates a test Thor task for each instance and one to test all
+    # instances in serial.
+    #
+    # @api private
+    def define
+      config.instances.each do |instance|
+        self.class.desc instance.name, "Run #{instance.name} test instance"
+        self.class.send(:define_method, instance.name.gsub(/-/, "_")) do
+          instance.test(:always)
+        end
+      end
+
+      self.class.desc "all", "Run all test instances"
+      self.class.send(:define_method, :all) do
+        config.instances.each { |i| invoke i.name.gsub(/-/, "_") }
+      end
+    end
+  end
+end