kitchen-microwave 0.1.0

data/lib/kitchen/loader/microwave.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+#
+# Author:: Jonathan Hartman (<jonathan.hartman@socrata.com>)
+#
+# Copyright (C) 2018, Socrata, Inc.
+#
+# 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 'fileutils'
+require 'kitchen/loader/yaml'
+require 'kitchen/util'
+require 'vendor/hash_recursive_merge'
+require 'yaml'
+require_relative '../microwave/driver'
+require_relative '../microwave/platforms'
+require_relative '../microwave/provisioner'
+require_relative '../microwave/suites'
+require_relative '../microwave/transport'
+require_relative '../microwave/verifier'
+
+module Kitchen
+  module Loader
+    # A customized version of Test Kitchen's YAML loader to allow
+    # auto-generating a config.
+    #
+    # @author Jonathan Hartman <jonathan.hartman@socrata.com>
+    class Microwave < YAML
+      #
+      # Write out the generated hash for this loader after instantiating it.
+      #
+      # (see Kitchen::Loader::YAML.initialize)
+      #
+      def initialize(options = {})
+        super
+        write!
+      end
+
+      #
+      # Don't bother raising an error if the .kitchen.yml doesn't exist.
+      #
+      # (see Kitchen::Loader::YAML#read)
+      #
+      def read
+        Util.symbolized_hash(combined_hash)
+      end
+
+      #
+      # Write the merged config out to a file for easier debugging.
+      #
+      def write!
+        path = File.expand_path('.kitchen/.microwave.yml',
+                                File.dirname(@config_file))
+        FileUtils.mkdir_p(File.dirname(path))
+        File.write(path, Util.stringified_hash(read).to_yaml)
+      end
+
+      #
+      # Add a fourth layer of config at the top and then merge the regular
+      # three layers of .kitchen.ymls into it. Then delete any excluded
+      # platforms that have been set globally via:
+      #
+      # ---
+      # microwave:
+      #   excludes:
+      #     - platform: ubuntu
+      #       version: 14.04
+      #       chef: 14
+      #     - platform: debian
+      #       # version: implicit "all"
+      #       # chef: implicit "all"
+      #
+      # (see Kitchen::Loader::YAML#combined_hash)
+      #
+      def combined_hash
+        hsh = microwave_hash.rmerge(super)
+        @excludes = hsh['microwave']['excludes']
+        hsh
+      end
+
+      #
+      # Return the new top layer we're going to merge all the traditional YAML
+      # layers into. The new layer should have:
+      #
+      # * An empty set of platforms to be excluded
+      # * A static, simple driver config for dokken
+      # * A static, simple transport config for dokken
+      # * A static, simple provisioner config for dokken
+      # * A static, simple verifier config for dokken
+      # * A set of platforms generated from metadata.rb's supported
+      #   platforms*Chef versions
+      # * A set of suites generated from recipes present in the `test` wrapper
+      #   cookbook
+      #
+      # @return [Hash] the top-level Microwave hash for the config
+      def microwave_hash
+        path = File.dirname(@config_file)
+        normalize(
+          'microwave' => { 'excludes' => [] },
+          'driver' => Kitchen::Microwave::Driver.new,
+          'transport' => Kitchen::Microwave::Transport.new,
+          'provisioner' => Kitchen::Microwave::Provisioner.new,
+          'verifier' => Kitchen::Microwave::Verifier.new,
+          'platforms' => Kitchen::Microwave::Platforms.new(path, @excludes),
+          'suites' => Kitchen::Microwave::Suites.new(path)
+        )
+      end
+    end
+  end
+end

data/lib/kitchen/microwave/driver.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+#
+# Author:: Jonathan Hartman (<jonathan.hartman@socrata.com>)
+#
+# Copyright (C) 2018, Socrata, Inc.
+#
+# 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
+  module Microwave
+    # The driver config is just a hash with a couple static values.
+    #
+    # @author Jonathan Hartman <jonathan.hartman@socrata.com>
+    class Driver < Hash
+      #
+      # Configure the driver section to use dokken. We do enough with
+      # networking that requires privileged mode to default it to true.
+      #
+      # @return [Kitchen::Microwave::Driver] the new driver object
+      #
+      def initialize
+        self['name'] = 'dokken'
+        self['privileged'] = true
+      end
+    end
+  end
+end

data/lib/kitchen/microwave/platforms/amazonlinux/1.json

@@ -0,0 +1,8 @@
+{
+  "driver": {
+    "intermediate_instructions": [
+      "RUN yum -y install upstart initscripts"
+    ],
+    "pid_one_command": "/sbin/init"
+  }
+}

data/lib/kitchen/microwave/platforms/amazonlinux/2.json

@@ -0,0 +1,8 @@
+{
+  "driver": {
+    "intermediate_instructions": [
+      "RUN yum -y install systemd"
+    ],
+    "pid_one_command": "/lib/systemd/systemd"
+  }
+}

data/lib/kitchen/microwave/platforms/centos/6.json

@@ -0,0 +1,8 @@
+{
+  "driver": {
+    "intermediate_instructions": [
+      "RUN yum -y install upstart initscripts"
+    ],
+    "pid_one_command": "/sbin/init"
+  }
+}

data/lib/kitchen/microwave/platforms/centos/7.json

@@ -0,0 +1,6 @@
+{
+  "driver": {
+    "intermediate_instructions": [],
+    "pid_one_command": "/lib/systemd/systemd"
+  }
+}

data/lib/kitchen/microwave/platforms/debian/8.json

@@ -0,0 +1,8 @@
+{
+  "driver": {
+    "intermediate_instructions": [
+      "RUN echo DISTRIB_CODENAME=jessie > /etc/lsb-release"
+    ],
+    "pid_one_command": "/lib/systemd/systemd"
+  }
+}

data/lib/kitchen/microwave/platforms/debian/9.json

@@ -0,0 +1,10 @@
+{
+  "driver": {
+    "intermediate_instructions": [
+      "RUN echo DISTRIB_CODENAME=stretch > /etc/lsb-release",
+      "RUN apt-get update",
+      "RUN apt-get -y install systemd"
+    ],
+    "pid_one_command": "/lib/systemd/systemd"
+  }
+}

data/lib/kitchen/microwave/platforms/fedora/28.json

@@ -0,0 +1,8 @@
+{
+  "driver": {
+    "intermediate_instructions": [
+      "RUN dnf -y install procps"
+    ],
+    "pid_one_command": "/lib/systemd/systemd"
+  }
+}

data/lib/kitchen/microwave/platforms/ubuntu/14.04.json

@@ -0,0 +1,9 @@
+{
+  "driver": {
+    "intermediate_instructions": [
+      "RUN dpkg-divert --remove /sbin/initctl",
+      "RUN ln -sf /sbin/initctl.distrib /sbin/initctl"
+    ],
+    "pid_one_command": "/sbin/init"
+  }
+}

data/lib/kitchen/microwave/platforms/ubuntu/16.04.json

@@ -0,0 +1,6 @@
+{
+  "driver": {
+    "intermediate_instructions": [],
+    "pid_one_command": "/lib/systemd/systemd"
+  }
+}

data/lib/kitchen/microwave/platforms/ubuntu/18.04.json

@@ -0,0 +1,10 @@
+{
+  "driver": {
+    "intermediate_instructions": [
+      "RUN apt-get update",
+      "RUN apt-get -y install systemd"
+
+    ],
+    "pid_one_command": "/lib/systemd/systemd"
+  }
+}

data/lib/kitchen/microwave/platforms.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+#
+# Author:: Jonathan Hartman (<jonathan.hartman@socrata.com>)
+#
+# Copyright (C) 2018, Socrata, Inc.
+#
+# 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 'chef/cookbook/metadata'
+require 'json'
+require 'vendor/hash_recursive_merge'
+
+module Kitchen
+  module Microwave
+    # The platforms config is more complex, needs to be generated based on what
+    # the cookbook metadata advertises support for.
+    #
+    # @author Jonathan Hartman <jonathan.hartman@socrata.com>
+    class Platforms < Array
+      # The major Chef versions we could potentially test against in cookbooks
+      # that support them.
+      POTENTIAL_CHEFS ||= %w[14 13 12].freeze
+
+      # The platforms and versions we could potentiall test against in cookbooks
+      # that support them.
+      POTENTIAL_PLATFORMS ||= {
+        'ubuntu' => %w[18.04 16.04 14.04],
+        'debian' => %w[9 8],
+        'centos' => %w[7 6],
+        'amazonlinux' => %w[2 1],
+        'fedora' => %w[28]
+      }.freeze
+
+      #
+      # Build a set of platforms based on the metadata's advertised supported
+      # platforms*Chef versions. Each platform gets a config to install the
+      # appropriate init system and start it as PID 1, and do anything else
+      # that might be common to make it behave enough like a regular VM for
+      # testing.
+      #
+      # Instantiating requires a path to the cookdook under test and can
+      # accept an optional set of excluded platforms of the format:
+      #
+      #   [
+      #     {
+      #       'name' => 'ubuntu',
+      #       'version' => '14.04',
+      #       'chef' => '14'
+      #     },
+      #     {
+      #       'name' => 'debian',
+      #       # 'version' => 'implicit "all"'
+      #       # 'chef' => 'implicit "all"'
+      #     }
+      #
+      #
+      # @param [String] cookbook_dir path to the cookbook under test
+      # @param [Array<Hash>] an array of platform information to exclude
+      #
+      # @return [Kitchen::Microwave::Platforms] the new platforms object
+      #
+      def initialize(cookbook_dir, excludes = [])
+        @cookbook_dir = cookbook_dir
+        @excludes = excludes || []
+
+        supported_chefs.each do |chef|
+          supported_platforms.each do |name, versions|
+            versions.each do |version|
+              self << platform_for(name, version, chef) unless \
+                excluded?(name, version, chef)
+            end
+          end
+        end
+      end
+
+      #
+      # Build the stanza for a single platform+version+Chef version, including
+      # any intermediate steps we use to make the Docker container behave more
+      # like a real VM.
+      #
+      # @param [String] name the platform name
+      # @param [String] version the platform version
+      # @param [String] chef the Chef version
+      #
+      # @return [Hash] a single platform stanza
+      #
+      def platform_for(name, version, chef)
+        file = File.expand_path("platforms/#{name}/#{version}.json", __dir__)
+        data = JSON.parse(File.read(file))
+        {
+          'name' => "#{name}-#{version}-chef-#{chef}",
+          'driver' => {
+            'image' => "#{name}:#{version}",
+            'chef_version' => chef
+          }
+        }.rmerge(data)
+      end
+
+      #
+      # Determine if a particular platform name, version, and chef combo is
+      # globally excluded.
+      #
+      # @param [String] name the platform name
+      # @param [String] version the platform version
+      # @param [String] chef the Chef version
+      #
+      # @return [TrueClass, FalseClass] whether it is excluded
+      #
+      def excluded?(name, version, chef)
+        @excludes.each do |exc|
+          return true if ['', name].include?(exc['name'].to_s) && \
+                         ['', version].include?(exc['version'].to_s) && \
+                         ['', chef].include?(exc['chef'].to_s)
+        end
+        false
+      end
+
+      #
+      # Look at the supported platforms in the metadata and figure out what
+      # platforms and versions should be tested.
+      #
+      # @return [Hash] a hash of platform => [version1, version2...]
+      #
+      def supported_platforms
+        @supported_platforms ||= metadata_platforms
+                                 .each_with_object({}) do |(name, req), hsh|
+          req = Gem::Requirement.new(req)
+          POTENTIAL_PLATFORMS[name].to_a.each do |version|
+            hsh[name] ||= []
+            hsh[name] << version if req.satisfied_by?(Gem::Version.new(version))
+          end
+        end
+      end
+
+      #
+      # Look at the supported Chef versions in the metadata to figure out which
+      # should be tested against.
+      #
+      # @return [Array<String>] an array of major Chef versions/Docker images
+      #
+      def supported_chefs
+        @supported_chefs ||= POTENTIAL_CHEFS.select do |chef|
+          metadata.chef_versions.find do |cv|
+            # The Docker tag e.g. "14" should always be the newest release of
+            # that major version and satisfy e.g. "~> 14.2".
+            Gem::Requirement.new(cv.requirement.to_s.split('.').first)
+                            .satisfied_by?(Gem::Version.new(chef))
+          end
+        end
+      end
+
+      #
+      # Pull the supported platforms out of the metadata and do any required
+      # transformations to them.
+      #
+      # @return [Hash] a hash of platform_name => requirement_string
+      #
+      def metadata_platforms
+        @metadata_platforms ||= begin
+          metadata.platforms.each_with_object({}) do |(name, req), hsh|
+            # Amazon Linux is named "amazon" in Chef metadata but "amazonlinux"
+            # in Docker Hub.
+            name = 'amazonlinux' if name == 'amazon'
+
+            # Assume that CentOS' e.g. "7" tag in Docker Hub will satisfy an
+            # e.g. "~> 7.4" requirement string.
+            req = req.split('.').first if name == 'centos'
+
+            hsh[name] = req
+          end
+        end
+      end
+
+      #
+      # Read and store the local cookbook's metadata.
+      #
+      # @return [Chef::Cookbook::Metadata] the cookbook metadata
+      #
+      def metadata
+        @metadata ||= begin
+          md = Chef::Cookbook::Metadata.new
+          md.from_file(File.join(@cookbook_dir, 'metadata.rb'))
+          md
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/microwave/provisioner.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+#
+# Author:: Jonathan Hartman (<jonathan.hartman@socrata.com>)
+#
+# Copyright (C) 2018, Socrata, Inc.
+#
+# 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
+  module Microwave
+    # The provisioner config is just a hash with a single static value.
+    #
+    # @author Jonathan Hartman <jonathan.hartman@socrata.com>
+    class Provisioner < Hash
+      #
+      # Configure the provisioner section to use dokken.
+      #
+      # @return [Kitchen::Microwave::Provisioner] the new provisioner object
+      #
+      def initialize
+        self['name'] = 'dokken'
+      end
+    end
+  end
+end

data/lib/kitchen/microwave/suites.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+#
+# Author:: Jonathan Hartman (<jonathan.hartman@socrata.com>)
+#
+# Copyright (C) 2018, Socrata, Inc.
+#
+# 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
+  module Microwave
+    # The suites config can be generated by examining the `test` wrapper
+    # cookbook.
+    #
+    # @author Jonathan Hartman <jonathan.hartman@socrata.com>
+    class Suites < Array
+      #
+      # Examine the cookbook's test harness and consider any public (i.e. not
+      # named with a leading "_") recipe to be a test suite.
+      #
+      # @param [String] cookbook_dir path to the cookbook under test
+      #
+      # @return [Kitchen::Microwave::Suites] the new suites object
+      #
+      def initialize(cookbook_dir)
+        glob = File.join(cookbook_dir,
+                         'test/fixtures/cookbooks/test/recipes/[a-z0-9]*.rb')
+        Dir.glob(glob).sort.each do |ste|
+          self << {
+            'name' => File.basename(ste, '.rb'),
+            'run_list' => %W[recipe[test::#{File.basename(ste, '.rb')}]]
+          }
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/microwave/transport.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+#
+# Author:: Jonathan Hartman (<jonathan.hartman@socrata.com>)
+#
+# Copyright (C) 2018, Socrata, Inc.
+#
+# 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
+  module Microwave
+    # The transport config is just a hash with a single static value.
+    #
+    # @author Jonathan Hartman <jonathan.hartman@socrata.com>
+    class Transport < Hash
+      #
+      # Configure the transport section to use dokken.
+      #
+      # @return [Kitchen::Microwave::Transport] the new transport object
+      #
+      def initialize
+        self['name'] = 'dokken'
+      end
+    end
+  end
+end

data/lib/kitchen/microwave/verifier.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+#
+# Author:: Jonathan Hartman (<jonathan.hartman@socrata.com>)
+#
+# Copyright (C) 2018, Socrata, Inc.
+#
+# 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
+  module Microwave
+    # The verifier config is just a hash with a couple static values.
+    #
+    # @author Jonathan Hartman <jonathan.hartman@socrata.com>
+    class Verifier < Hash
+      #
+      # Configure the verifier section to use inspec and point at
+      # `/opt/verifier` for Dokken.
+      #
+      # @return [Kitchen::Microwave::Verifier] the new verifier object
+      #
+      def initialize
+        self['name'] = 'inspec'
+        self['root_path'] = '/opt/verifier'
+      end
+    end
+  end
+end

data/lib/kitchen/microwave/version.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+#
+# Author:: Jonathan Hartman (<jonathan.hartman@socrata.com>)
+#
+# Copyright (C) 2018, Socrata, Inc.
+#
+# 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
+  # Microwave's VERSION information.
+  module Microwave
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    VERSION = [MAJOR, MINOR, PATCH].join('.')
+  end
+end