kitchen-habitat-config 0.7.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d827805ebbab6bc3db302384f92bff7c1a1610dc7dd32a6a6f52f27505a4aa7
+  data.tar.gz: cc8957e1f7fd71f75504e62fd3ff671ade16e2c14437e55908c9f25007d3e305
+SHA512:
+  metadata.gz: abef29edd561dbe7442dd923be831c38eec7e1220bc48171478fabf416d967b3688708a0517f2b0afa317d62ee4941ee169c481cc2ce922b8e89937e4c513d8c
+  data.tar.gz: c04c5fcea8007b1d6d61b2ab2d55a9a59a32c48c3d3a230d195cf542862906e708678eb788e54746562605b918623e0222c042e6989274a9aaaa8e990eadfdfa

data/README.md

@@ -0,0 +1,153 @@
+[![Gem Version](https://badge.fury.io/rb/kitchen-habitat.svg)](http://badge.fury.io/rb/kitchen-habitat)
+
+# kitchen-habitat
+A Test Kitchen Provisioner for [Habitat](https://habitat.sh)
+
+## Requirements
+
+
+## Installation & Setup
+You'll need the test-kitchen & kitchen-habitat gems installed in your system, along with kitchen-vagrant or some other suitable driver for test-kitchen.
+
+## Configuration Settings
+
+### Depot settings
+
+* `depot_url`
+  * Target Habitat Depot to use to install packages.
+  * Defaults to `nil` (which will use the default depot settings for the `hab` CLI from ~/.hab/etc/cli.toml).
+
+### Supervisor Settings
+
+* `hab_sup_origin`
+  * Package identification for the supervisor to use.
+  * Defaults to `core`, or, if `hab_sup_artifact_name` is supplied, the `hab_sup_origin` will be parsed from the filename of the hart file.
+* `hab_sup_name`
+  * Name of the supervisor package
+  * Defaults to `hab-sup`, or, if `hab_sup_artifact_name` is supplied, the `hab_sup_name` will be parsed from the filename of the hart file.
+* `hab_sup_version`
+  * Version number of `hab-sup` to run
+  * Defaults to `nil`, or, if `hab_sup_artifact_name` is supplied, the `hab_sup_version` will be parsed from the filename of the hart file.
+* `hab_sup_release`
+  * Release of the `hab-sup` package to run
+  * Defaults to `nil`, or, if `hab_sup_artifact_name` is supplied, the `hab_sup_release` will be parsed from the filename of the hart file.
+* `hab_sup_artifact_name`
+  * Artifact package name for a custom supervisor to run
+  * Used to upload and test a local supervisor.
+  * Package should be located in the `results_directory`
+  * Defaults to `nil
+* `hab_sup_listen_http`
+  * Port for the supervisor's sidecar to listen on.
+  * Defaults to `nil`
+* `hab_sup_listen_gossip`
+  * Port for the supervisor's gossip communication
+  * Defaults to `nil`
+* `hab_sup_group`
+  * Service group for the supervisor to belong do.
+  * Default is `default`
+* `hab_sup_bind`
+  * Service group for the supervisor to bind to.
+  * Default is `[]`
+* `hab_sup_peer`
+  * IP and port (e.g. `192.168.1.86:9010`) of the supervisor of which to connect to join the ring.
+  * Default is `[]`
+
+### Package Settings
+
+* `artifact_name`
+  * Artifact package filename to install and run.
+  * Used to upload and test a local artifact.
+  * Package should be located in the `results_directory`
+  * Example - `core-jq-static-1.5-20170127185151-x86_64-linux.hart`
+  * Defaults to `nil`
+* `results_directory`
+  * Directory (relative to the location of the .kitchen.yml) containing package artifacts (harts) to copy to the remote system
+  * Defaults to checking the local directory for a `results` directory, then its parent (`../results`) and grandparent (`../../results`), which should accomodate most studio layouts.
+* `package_origin`
+  * Origin for the package to run.
+  * Defaults to `core`, or, if `artifact_name` is supplied, the `package_origin` will be parsed from the filename of the hart file.
+* `package_name`
+  * Package name for the supervisor to run.
+  * Defaults to the suite name or, if `artifact_name` is supplied, the `package_name` will be parsed from the filename of the hart file.
+* `package_version`
+  * Package version of the package to be run.
+  * Defaults to `nil` or if `artifact_name` is supplied, the `package_version` will be parsed from the filename of the hart file.
+* `package_release`
+  * Package release of the package to be run.
+  * Defaults to `nil` or if `artifact_name` is supplied, the `package_release` will be parsed from the filename of the hart file.
+* `service_topology`
+  * The topology for the service to run in.  Valid values are `nil`, `standalone`, `leader`
+  * Defaults to `nil` which is `standalone`
+* `service_update_strategy`
+  * Describes how package updates are to be applied.  Valid values are `nil`, `at-once`, `rolling`.
+  * Default is `nil`, which does not check for package updates.
+* `config_directory`
+  * Directory containing a user.toml or/and a default.toml, hooks, and configuration files to be passed to the service under test.
+  * Defaults to `nil`
+* `override_package_config`
+  * Tell the supervisor to load the the configuration files and hooks from `config_directory` instead of what was packaged with the service.  (Uses `--config-from` via the `hab-sup` CLI.)
+* `user_toml_name`
+  * Name of the file to be used as the user.toml for the service under test.
+  * Defaults to `user.toml`
+* `install_latest_artifact`
+  * Choose to install latest artifact.
+  * Must specify `artifact_name` or `package_origin` and `package_name`
+  * `package_version` and `package_release` will be ignored
+  * Defaults to `false`
+
+## Examples
+
+Run the core-redis package
+
+```yaml
+driver:
+  name: vagrant
+
+provisioner:
+  name: habitat
+  hab_sup_origin: core
+  hab_sup_name: sup
+  package_origin: core
+  package_name: redis
+
+platforms:
+  - name: ubuntu-16.04
+
+suites:
+  - name: default
+```
+
+Two node: elasticsearch and kibana 
+
+```yaml
+driver:
+  name: docker
+
+provisioner:
+  name: habitat
+  hab_sup_origin: core
+  hab_sup_name: sup
+
+platforms:
+  - name: ubuntu-16.04
+
+suites:
+  - name: elasticsearch
+    provisioner:
+      package_origin: core
+      package_name: elasticsearch
+    driver:
+      instance_name: elastic
+
+  - name: kibana
+    provisioner:
+      package_origin: core
+      package_name: kibana
+      hab_sup_peer:
+        - elastic
+      hab_sup_bind:
+        - elasticsearch:elasticsearch.default
+    driver:
+      instance_name: kibana
+      links: elastic:elastic  
+```

data/kitchen-habitat.gemspec

@@ -0,0 +1,38 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "kitchen-habitat/version"
+
+Gem::Specification.new do |s|
+  s.name              = "kitchen-habitat-config"
+  s.version           = Kitchen::Habitat::VERSION
+  s.authors           = ["Steven Murawski"]
+  s.email             = ["smurawski@chef.io"]
+  s.homepage          = "https://github.com/test-kitchen/kitchen-habitat"
+  s.summary           = "Habitat provisioner for test-kitchen"
+  candidates          = Dir.glob("lib/**/*") + ["README.md", "kitchen-habitat.gemspec"]
+  s.files             = candidates.sort
+  s.platform          = Gem::Platform::RUBY
+  s.require_paths     = ["lib"]
+  s.rubyforge_project = "[none]"
+  s.license           = "Apache 2"
+  s.description       = <<-EOF
+== DESCRIPTION:
+
+Habitat Provisioner for Test Kitchen
+
+== FEATURES:
+
+TBD
+
+EOF
+  s.add_dependency "test-kitchen", "~> 1.4"
+
+  s.add_development_dependency "countloc", "~> 0.4"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec",     "~> 3.2"
+  s.add_development_dependency "simplecov", "~> 0.9"
+
+  # style and complexity libraries are tightly version pinned as newer releases
+  # may introduce new and undesireable style choices which would be immediately
+  # enforced in CI
+  s.add_development_dependency "chefstyle"
+end

data/lib/kitchen-habitat/version.rb

@@ -0,0 +1,5 @@
+module Kitchen
+  module Habitat
+    VERSION = '0.7.2'.freeze
+  end
+end

data/lib/kitchen/provisioner/habitat.rb

@@ -0,0 +1,337 @@
+#
+# Author:: Steven Murawski (<steven.murawski@gmail.com>)
+#
+# Copyright (C) 2017 Steven Murawski
+#
+# Licensed under the MIT License.
+# See LICENSE for more details
+
+require 'fileutils'
+require 'pathname'
+require 'kitchen/provisioner/base'
+require 'kitchen/util'
+
+module Kitchen
+  module Provisioner
+    class Habitat < Base
+      kitchen_provisioner_api_version 2
+
+      default_config :depot_url, nil
+      default_config :hab_sup_origin, 'core'
+      default_config :hab_sup_name, 'hab-sup'
+      default_config :hab_sup_version, nil
+      default_config :hab_sup_release, nil
+      default_config :hab_sup_artifact_name, nil
+
+      # hab-sup manager options
+      default_config :hab_sup_listen_http, nil
+      default_config :hab_sup_listen_gossip, nil
+      default_config :hab_sup_peer, []
+      default_config :hab_sup_bind, []
+      default_config :hab_sup_group, nil
+
+      # hab-sup service options
+      default_config :install_latest_artifact, false
+      default_config :artifact_name, nil
+      default_config :package_origin, 'core'
+      default_config :package_name
+      default_config :package_version, nil
+      default_config :package_release, nil
+      default_config :service_topology, nil
+      default_config :service_update_strategy, nil
+      default_config :channel, 'stable'
+
+      # local stuffs to copy
+      default_config :results_directory, nil
+      default_config :config_directory, nil
+      default_config :user_toml_name, 'user.toml'
+      default_config :override_package_config, false
+
+      # experimental
+      default_config :use_screen, false
+
+      def finalize_config!(instance)
+        # Check to see if a package ident was specified for package name and be helpful
+        unless config[:package_name].nil? || (config[:package_name] =~ /\//).nil?
+          config[:package_origin], config[:package_name], config[:package_version], config[:package_release] = config[:package_name].split('/')
+        end
+
+        unless config[:hab_sup_artifact_name].nil?
+          ident = artifact_name_to_package_ident_regex.match(config[:hab_sup_artifact_name])
+          config[:hab_sup_origin] = ident['origin']
+          config[:hab_sup_name] = ident['name']
+          config[:hab_sup_version] = ident['version']
+          config[:hab_sup_release] = ident['release']
+        end
+
+        unless config[:artifact_name].nil?
+          ident = artifact_name_to_package_ident_regex.match(config[:artifact_name])
+          config[:package_origin] = ident['origin']
+          config[:package_name] = ident['name']
+          config[:package_version] = ident['version']
+          config[:package_release] = ident['release']
+        end
+        super(instance)
+      end
+
+      def install_command
+        raise "Need to fill in some implementation here." if instance.platform == "windows"
+        wrap_shell_code <<-BASH
+        #{export_hab_origin}
+        if command -v hab >/dev/null 2>&1
+        then
+          echo "Habitat CLI already installed."
+        else
+          curl 'https://raw.githubusercontent.com/habitat-sh/habitat/master/components/hab/install.sh' | sudo bash
+        fi
+        BASH
+      end
+
+      def init_command
+        wrap_shell_code <<-EOH
+          id -u hab >/dev/null 2>&1 || sudo useradd hab >/dev/null 2>&1
+          rm -rf /tmp/kitchen
+          mkdir -p /tmp/kitchen/results
+          #{'mkdir -p /tmp/kitchen/config' unless config[:override_package_config]}
+        EOH
+      end
+
+      def create_sandbox
+        super
+        copy_results_to_sandbox
+        copy_user_toml_to_sandbox
+        copy_package_config_from_override_to_sandbox
+      end
+
+      def prepare_command
+        wrap_shell_code <<-EOH
+          #{export_hab_origin}
+          #{install_supervisor_command}
+          #{binlink_supervisor_command}
+          #{install_service_package}
+          #{remove_previous_user_toml}
+          #{copy_user_toml_to_service_directory}
+          EOH
+      end
+
+      def run_command
+        run = <<-RUN
+        #{export_hab_origin}
+        #{clean_up_screen_sessions}
+        #{clean_up_previous_supervisor}
+        echo "Running #{package_ident}."
+        sudo hab pkg install #{package_ident}
+        #{run_package_in_background}
+        RUN
+
+        wrap_shell_code run
+      end
+
+      private
+
+      def clean_up_screen_sessions
+        return unless config[:use_screen]
+        <<-CLEAN
+        if sudo screen -ls | grep -q #{clean_package_name}
+          then
+            echo "Killing previous supervisor session."
+            sudo screen -S \"#{clean_package_name}\" -X quit > /dev/null
+            echo "Removing dead session."
+            sudo screen -wipe > /dev/null
+        fi
+        CLEAN
+      end
+
+      def clean_up_previous_supervisor
+        return if config[:use_screen]
+        <<-EOH
+        [ -f ./run.pid ] && echo "Removing previous supervisor. "
+        [ -f ./run.pid ] && sudo kill $(cat run.pid)
+        [ -f ./run.pid ] && sleep 5
+        EOH
+      end
+
+      def run_package_in_background
+        if config[:use_screen]
+          "sudo screen -mdS \"#{clean_package_name}\" hab start #{package_ident} #{supervisor_options}"
+        else
+          <<-RUN
+          [ -f ./run.pid ] && rm -f run.pid
+          [ -f ./nohup.out ] && rm -f nohup.out
+          nohup sudo hab sup run #{sup_run_options} & echo $! > run.pid
+
+          until sudo hab svc status
+          do
+            sleep 1
+          done
+
+          sudo hab svc load #{package_ident} #{supervisor_options}
+
+          until sudo hab svc status | grep #{package_ident}
+          do
+            sleep 1
+          done
+
+          [ -f ./nohup.out ] && cat nohup.out || (echo "Failed to start the supervisor." && exit 1)
+          RUN
+        end
+      end
+
+      def resolve_results_directory
+        return config[:results_directory] unless config[:results_directory].nil?
+
+        results_in_current = File.join(config[:kitchen_root], "results")
+        results_in_parent = File.join(config[:kitchen_root], "../results")
+        results_in_grandparent = File.join(config[:kitchen_root], "../../results")
+
+        if Dir.exist?(results_in_current)
+          results_in_current
+        elsif Dir.exist?(results_in_parent)
+          results_in_parent
+        elsif Dir.exist?(results_in_grandparent)
+          results_in_grandparent
+        end
+      end
+
+      def copy_package_config_from_override_to_sandbox
+        return if config[:config_directory].nil?
+        return unless config[:override_package_config]
+        local_config_dir = File.join(config[:kitchen_root], config[:config_directory])
+        return unless Dir.exist?(local_config_dir)
+
+        sandbox_config_dir = File.join(sandbox_path, "config")
+        FileUtils.copy_entry(local_config_dir, sandbox_config_dir)
+      end
+
+      def copy_results_to_sandbox
+        return if config[:artifact_name].nil? && !config[:install_latest_artifact]
+        results_dir = resolve_results_directory
+        return if results_dir.nil?
+        FileUtils.mkdir_p(File.join(sandbox_path, "results"))
+        FileUtils.cp(
+          File.join(results_dir, config[:install_latest_artifact] ? latest_artifact_name : config[:artifact_name]),
+          File.join(sandbox_path, "results"),
+          preserve: true
+        )
+      end
+
+      def full_user_toml_path
+        File.join(File.join(config[:kitchen_root], config[:config_directory]), config[:user_toml_name])
+      end
+
+      def sandbox_user_toml_path
+        File.join(File.join(sandbox_path, "config"), "user.toml")
+      end
+
+      def copy_user_toml_to_sandbox
+        return if config[:config_directory].nil?
+        return unless File.exist?(full_user_toml_path)
+        FileUtils.mkdir_p(File.join(sandbox_path, "config"))
+        debug("Copying user.toml from #{full_user_toml_path} to #{sandbox_user_toml_path}")
+        FileUtils.cp(full_user_toml_path, sandbox_user_toml_path)
+      end
+
+      def install_service_package
+        return unless config[:install_latest_artifact] || !config[:artifact_name].nil?
+
+        artifact_name = ""
+        if config[:install_latest_artifact]
+          artifact_name = latest_artifact_name
+        elsif !config[:install_latest_artifact] && !config[:artifact_name].nil?
+          artifact_name = config[:artifact_name]
+        else
+          return
+        end
+
+        artifact_path = File.join(File.join(config[:root_path], "results"), artifact_name)
+        "sudo hab pkg install #{artifact_path}"
+      end
+
+      def latest_artifact_name
+        results_dir = resolve_results_directory
+        return if results_dir.nil?
+
+        artifact_path = Dir.glob(File.join(results_dir, "#{config[:package_origin]}-#{config[:package_name]}-*.hart")).max_by { |f| File.mtime(f) }
+
+        File.basename(artifact_path)
+      end
+
+      def copy_user_toml_to_service_directory
+        return unless !config[:config_directory].nil? && File.exist?(full_user_toml_path)
+        <<-EOH
+          sudo mkdir -p /hab/svc/#{config[:package_name]}
+          sudo cp #{File.join(File.join(config[:root_path], 'config'), 'user.toml')} /hab/svc/#{config[:package_name]}/user.toml
+        EOH
+      end
+
+      def remove_previous_user_toml
+        <<-REMOVE
+        if [ -d "/hab/svc/#{config[:package_name]}" ]; then
+          sudo find /hab/svc/#{config[:package_name]} -name user.toml -delete
+        fi
+        REMOVE
+      end
+
+      def export_hab_origin
+        return if config[:depot_url].nil?
+        "export HAB_ORIGIN=#{config[:depot_url]}"
+      end
+
+      def install_supervisor_command
+        "sudo hab pkg install #{hab_sup_ident}"
+      end
+
+      def binlink_supervisor_command
+        "sudo hab pkg binlink #{hab_sup_ident} hab-sup"
+      end
+
+      def artifact_name_to_package_ident_regex
+        /(?<origin>\w+)-(?<name>.*)-(?<version>(\d+)?(\.\d+)?(\.\d+)?(\.\d+)?)-(?<release>\d+)-(?<target>.*)\.hart$/
+      end
+
+      def hab_sup_ident
+        ident = "#{config[:hab_sup_origin]}/" \
+                "#{config[:hab_sup_name]}/" \
+                "#{config[:hab_sup_version]}/" \
+                "#{config[:hab_sup_release]}".chomp("/").chomp("/")
+        @sup_ident ||= ident
+      end
+
+      def package_ident
+        ident = "#{config[:package_origin]}/" \
+                "#{config[:package_name]}/" \
+                "#{config[:package_version]}/" \
+                "#{config[:package_release]}".chomp("/").chomp("/")
+        @pkg_ident ||= ident
+      end
+
+      def clean_package_name
+        @clean_name ||= "#{config[:package_origin]}-#{config[:package_name]}"
+      end
+
+      def sup_run_options
+        options = ''
+        options += " --listen-gossip #{config[:hab_sup_listen_gossip]}" unless config[:hab_sup_listen_gossip].nil?
+        options += " --config-from #{File.join(config[:root_path], 'config/')}" if config[:override_package_config]
+        options += config[:hab_sup_bind].map { |b| " --bind #{b}" }.join(" ") if config[:hab_sup_bind].any?
+        options += config[:hab_sup_peer].map { |p| " --peer #{p}" }.join(" ") if config[:hab_sup_peer].any?
+
+        options
+      end
+
+      def supervisor_options
+        options = ''
+        options += " --listen-gossip #{config[:hab_sup_listen_gossip]}" unless config[:hab_sup_listen_gossip].nil?
+        options += " --config-from #{File.join(config[:root_path], 'config/')}" if config[:override_package_config]
+        options += config[:hab_sup_bind].map { |b| " --bind #{b}" }.join(" ") if config[:hab_sup_bind].any?
+        # options += config[:hab_sup_peer].map { |p| " --peer #{p}" }.join(" ") if config[:hab_sup_peer].any?
+        options += " --group #{config[:hab_sup_group]}" unless config[:hab_sup_group].nil?
+        options += " --topology #{config[:service_topology]}" unless config[:service_topology].nil?
+        options += " --strategy #{config[:service_update_strategy]}" unless config[:service_update_strategy].nil?
+        options += " --channel #{config[:channel]}" unless config[:channel].nil?
+
+        options
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-habitat-config
+version: !ruby/object:Gem::Version
+  version: 0.7.2
+platform: ruby
+authors:
+- Steven Murawski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: countloc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: chefstyle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |+
+  == DESCRIPTION:
+
+  Habitat Provisioner for Test Kitchen
+
+  == FEATURES:
+
+  TBD
+
+email:
+- smurawski@chef.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- kitchen-habitat.gemspec
+- lib/kitchen-habitat/version.rb
+- lib/kitchen/provisioner/habitat.rb
+homepage: https://github.com/test-kitchen/kitchen-habitat
+licenses:
+- Apache 2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: "[none]"
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Habitat provisioner for test-kitchen
+test_files: []