vagrant-bolt 0.1.0

data/acceptance/skeletons/base/modules/facts/plans/info.pp

@@ -0,0 +1,16 @@
+# A plan that prints basic OS information for the specified nodes. It first
+# runs the facts task to retrieve facts from the nodes, then compiles the
+# desired OS information from the os fact value of each nodes.
+#
+# The $nodes parameter is a list of the nodes for which to print the OS
+# information. This plan primarily provides readable formatting, and ignores
+# nodes that error.
+plan facts::info(TargetSpec $nodes) {
+  return run_task('facts', $nodes, '_catch_errors' => true).reduce([]) |$info, $r| {
+    if ($r.ok) {
+      $info + "${r.target.name}: ${r[os][name]} ${r[os][release][full]} (${r[os][family]})"
+    } else {
+      $info # don't include any info for nodes which failed
+    }
+  }
+}

data/acceptance/skeletons/base/modules/facts/plans/init.pp

@@ -0,0 +1,13 @@
+# A plan that retrieves facts and stores in the inventory for the
+# specified nodes.
+#
+# The $nodes parameter is a list of nodes to retrieve the facts for.
+plan facts(TargetSpec $nodes) {
+  $result_set = run_task('facts', $nodes)
+
+  $result_set.each |$result| {
+    add_facts($result.target, $result.value)
+  }
+
+  return $result_set
+}

data/acceptance/skeletons/base/modules/facts/tasks/bash.json

@@ -0,0 +1,5 @@
+{
+  "description": "Gather system facts using bash",
+  "input_method": "environment",
+  "parameters": {}
+}

data/acceptance/skeletons/base/modules/facts/tasks/bash.sh

@@ -0,0 +1,93 @@
+#!/usr/bin/env bash
+
+# Delegate to facter if available
+export PATH="$PATH:/opt/puppetlabs/bin"
+command -v facter > /dev/null 2>&1 && exec facter -p --json --show-legacy
+
+minor () {
+    minor="${*#*.}"
+    [ "$minor" == "$*" ] || echo "${minor%%.*}"
+}
+
+# Determine the OS name
+if [ -f /etc/redhat-release ]; then
+    if egrep -iq centos /etc/redhat-release; then
+        name=CentOS
+    elif egrep -iq 'Fedora release' /etc/redhat-release; then
+        name=Fedora
+    fi
+    release=$(sed -r -e 's/^.* release ([0-9]+(\.[0-9]+)?).*$/\1/' \
+                  /etc/redhat-release)
+fi
+
+if [ -z "${name}" ]; then
+    LSB_RELEASE=$(command -v lsb_release)
+    if [ -n "$LSB_RELEASE" ]; then
+        if [ -z "$name" ]; then
+            name=$($LSB_RELEASE -i | sed -re 's/^.*:[ \t]*//')
+        fi
+        release=$($LSB_RELEASE -r | sed -re 's/^.*:[ \t]*//')
+    fi
+fi
+
+# if lsb not available try os-release
+if [ -z "${name}" ]; then
+    if [ -e /etc/os-release ]; then
+        name=$(grep "^NAME" /etc/os-release | cut -d'=' -f2 | sed "s/\"//g")
+        release=$(grep "^VERSION_ID" /etc/os-release | cut -d'=' -f2 | sed "s/\"//g")
+    elif [-e /usr/lib/os-release ]; then
+        name=$(grep "^NAME" /usr/lib/os-release | cut -d'=' -f2 | sed "s/\"//g")
+        release=$(grep "^VERSION_ID" /usr/lib/os-release | cut -d'=' -f2 | sed "s/\"//g")
+    fi
+    if [ -n "${name}" ]; then
+        if echo "${name}" | egrep -iq "(.*red)(.*hat)"; then
+            name="RedHat"
+        elif echo "${name}" | egrep -iq "debian"; then
+            name="Debian"
+        fi
+    fi
+fi
+
+if [ -z "${name}" ]; then
+    name=$(uname)
+    release=$(uname -r)
+fi
+
+case $name in
+    RedHat|Fedora|CentOS|Scientific|SLC|Ascendos|CloudLinux)
+        family=RedHat;;
+    HuaweiOS|LinuxMint|Ubuntu|Debian)
+        family=Debian;;
+    *)
+        family=$name;;
+esac
+
+# Print it all out
+if [ -z "$name" ]; then
+    cat <<JSON
+{
+  "_error": {
+    "kind": "facts/noname",
+    "msg": "Could not determine OS name"
+  }
+}
+JSON
+else
+    cat <<JSON
+{
+  "os": {
+    "name": "${name}",
+JSON
+    [ -n "$release" ] && cat <<JSON
+    "release": {
+      "full": "${release}",
+      "major": "${release%%.*}",
+      "minor": "`minor "${release}"`"
+    },
+JSON
+    cat <<JSON
+    "family": "${family}"
+  }
+}
+JSON
+fi

data/acceptance/skeletons/base/modules/facts/tasks/init.json

@@ -0,0 +1,10 @@
+{
+  "description": "Gather system facts",
+  "parameters": {},
+  "input_method": "environment",
+  "implementations": [
+    {"name": "ruby.rb", "requirements": ["puppet-agent"]},
+    {"name": "powershell.ps1", "requirements": ["powershell"]},
+    {"name": "bash.sh", "requirements": ["shell"]}
+  ]
+}

data/acceptance/skeletons/base/modules/facts/tasks/powershell.json

@@ -0,0 +1,4 @@
+{
+  "description": "Gather system facts using powershell",
+  "parameters": {}
+}

data/acceptance/skeletons/base/modules/facts/tasks/powershell.ps1

@@ -0,0 +1,56 @@
+#!powershell.exe
+
+# Delegate to facter if available
+if (Get-Command facter -ErrorAction SilentlyContinue) {
+    facter -p --json --show-legacy
+}
+else {
+    # The number 2 in the condition below is the value of
+    # the [System.PlatformID]::Win32NT constant. We don't
+    # use the constant here as it doesn't work on Windows
+    # Server Core.
+    if ([System.Environment]::OSVersion.Platform -gt 2) {
+        @'
+{
+  "_error": {
+    "kind": "facts/noname",
+    "msg": "Could not determine OS name"
+  }
+}
+'@
+    }
+    else {
+        $release = [System.Environment]::OSVersion.Version.ToString() -replace '\.[^.]*\z'
+        $version = $release -replace '\.[^.]*\z'
+
+        # This fails for regular users unless explicitly enabled
+        $os = Get-CimInstance Win32_OperatingSystem -ErrorAction SilentlyContinue
+        $consumerrel = $os.ProductType -eq '1'
+
+        $release = switch($version){
+            '10.0'{ if ($consumerrel) { '10' } else { '2016' } }
+            '6.3' { if ($consumerrel) { '8.1' } else { '2012 R2' } }
+            '6.2' { if ($consumerrel) { '8' } else { '2012' } }
+            '6.1' { if ($consumerrel) { '7' } else { '2008 R2' } }
+            '6.0' { if ($consumerrel) { 'Vista' } else { '2008' } }
+            '5.2' { 
+                if ($consumerrel) { 'XP' } else {
+                    if ($os.OtherTypeDescription -eq 'R2') { '2003 R2' } else { '2003' }
+                }
+            }
+        }
+
+        @"
+{
+  "os": {
+    "name": "windows",
+    "release": {
+      "full": "$release",
+      "major": "$release"
+    },
+    "family": "windows"
+  }
+}
+"@
+    }
+}

data/acceptance/skeletons/base/modules/facts/tasks/ruby.json

@@ -0,0 +1,4 @@
+{
+  "description": "Gather system facts using ruby and facter",
+  "parameters": {}
+}

data/acceptance/skeletons/base/modules/facts/tasks/ruby.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+def facter_executable
+  if Gem.win_platform?
+    require 'win32/registry'
+    installed_dir =
+      begin
+        Win32::Registry::HKEY_LOCAL_MACHINE.open('SOFTWARE\Puppet Labs\Puppet') do |reg|
+          # rubocop:disable Style/RescueModifier
+          # Rescue missing key
+          dir = reg['RememberedInstallDir64'] rescue ''
+          # Both keys may exist, make sure the dir exists
+          break dir if File.exist?(dir)
+
+          # Rescue missing key
+          reg['RememberedInstallDir'] rescue ''
+          # rubocop:enable Style/RescueModifier
+        end
+      rescue Win32::Registry::Error
+        # Rescue missing registry path
+        ''
+      end
+
+    facter =
+      if installed_dir.empty?
+        ''
+      else
+        File.join(installed_dir, 'bin', 'facter')
+      end
+  else
+    facter = '/opt/puppetlabs/puppet/bin/facter'
+  end
+
+  # Fall back to PATH lookup if puppet-agent isn't installed
+  File.exist?(facter) ? facter : 'facter'
+end
+
+# Delegate to facter
+exec(facter_executable, '-p', '--json', '--show-legacy')

data/acceptance/skeletons/provisioner/Vagrantfile

@@ -0,0 +1,19 @@
+require 'vagrant-spec/which'
+Vagrant.configure('2') do |config|
+  config.bolt.bolt_exe = Vagrant::Spec::Which.which('bolt')
+  config.vm.box = 'box'
+  config.vm.define 'server' do |node|
+    node.vm.provision :bolt do |bolt|
+      bolt.command = :task
+      bolt.name    = "facts"
+    end
+    node.vm.provision :bolt do |bolt|
+      bolt.command = :plan
+      bolt.name    = "facts"
+    end
+    node.vm.provision :bolt do |bolt|
+      bolt.command = :command
+      bolt.name    = "hostname"
+    end
+  end
+end

data/acceptance/skeletons/trigger/Vagrantfile

@@ -0,0 +1,22 @@
+require 'vagrant-spec/which'
+Vagrant.configure('2') do |config|
+  config.bolt.bolt_exe = Vagrant::Spec::Which.which('bolt')
+  config.vm.box = 'box'
+  config.vm.define 'server' do |node|
+    node.trigger.after :up do |trigger|
+      trigger.ruby do |env, machine|
+        VagrantBolt.task("facts", env, machine)
+      end
+    end
+    node.trigger.after :up do |trigger|
+      trigger.ruby do |env, machine|
+        VagrantBolt.plan("facts", env, machine)
+      end
+    end
+    node.trigger.after :up do |trigger|
+      trigger.ruby do |env, machine|
+        VagrantBolt.command("hostname", env, machine)
+      end
+    end
+  end
+end

data/acceptance/vagrant-spec.config.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'vagrant-bolt'
+require 'vagrant-spec/acceptance'
+
+# Prevent tests from attempting to load plugins from a Vagrant install
+# that may exist on the host system. We load required plugins below.
+ENV['VAGRANT_DISABLE_PLUGIN_INIT'] = '1'
+
+Vagrant::Spec::Acceptance.configure do |c|
+  acceptance_dir = Pathname.new File.expand_path(__dir__)
+
+  c.component_paths = [(acceptance_dir + 'components').to_s]
+  c.skeleton_paths = [(acceptance_dir + 'skeletons').to_s]
+
+  c.provider 'virtualbox',
+             box: (acceptance_dir + 'artifacts' + 'virtualbox.box').to_s,
+             env_vars: {
+               'VBOX_USER_HOME' => '{{homedir}}',
+             }
+end

data/lib/vagrant-bolt.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module VagrantBolt
+  require 'vagrant-bolt/version'
+  require 'vagrant-bolt/plugin'
+  require 'vagrant-bolt/runner'
+
+  # Runs a bolt task with the specified parameters
+  #
+  # @param [String] task The name of the bolt task to run
+  # @param [Object] env The environment
+  # @param [Object] machine The machine
+  # @param [Hash] args A optional hash of bolt config overrides. No merging will be done with these overrides.
+  # @return [nil]
+  # @example
+  #   VagrantBolt.task('facts', env, machine, run_as: "root", params: {taskparam: "value"})
+  def self.task(task, env, machine, **args)
+    runner = VagrantBolt::Runner.new(env, machine)
+    runner.run(:task, task, **args)
+  end
+
+  # Run a bolt plan with the specified parameters
+  #
+  # @param [String] plan The name of the bolt plan to run
+  # @param [Object] env The environment
+  # @param [Object] machine The machine
+  # @param [Hash] args A optional hash of bolt config overrides. No merging will be done with these overrides.
+  # @return [nil]
+  # @example
+  #    VagrantBolt.plan('facts', env, machine, run_as: "root", params: {planparam: "value"})
+  def self.plan(plan, env, machine, **args)
+    runner = VagrantBolt::Runner.new(env, machine)
+    runner.run(:plan, plan, **args)
+  end
+
+  # Run a bolt command with the specified parameters
+  #
+  # @param [String] command The command to run
+  # @param [Object] env The environment
+  # @param [Object] machine The machine
+  # @param [Hash] args A optional hash of bolt config overrides. No merging will be done with these overrides.
+  # @return [nil]
+  # @example
+  #   VagrantBolt.command('/bin/echo "test"', env, machine, run_as: "root")
+  def self.command(command, env, machine, **args)
+    runner = VagrantBolt::Runner.new(env, machine)
+    runner.run(:command, command, **args)
+  end
+
+  # Return the root directory of the source
+  # @return [String] the source root path
+  def self.source_root
+    @source_root ||= File.expand_path(__DIR__)
+  end
+end
+
+I18n.load_path << File.expand_path('../templates/locales/en.yml', File.dirname(__FILE__))

data/lib/vagrant-bolt/command.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative 'util/bolt'
+require_relative 'util/machine'
+require_relative 'util/config'
+
+class VagrantBolt::Command < Vagrant.plugin('2', :command)
+  def self.synopsis
+    "Calls the bolt executable with the given options"
+  end
+
+  def execute
+    options = {}
+    options[:update] = false
+
+    parser = OptionParser.new do |o|
+      o.banner = "Usage: vagrant bolt <options> [bolt options]"
+      o.separator ""
+      o.separator "Options:"
+      o.separator ""
+
+      o.on("-u", "--[no-]updateinventory", "Update the inventory file (defaults to false)") do |u|
+        options[:update] = u
+      end
+    end
+
+    # This is a hack. We are passing everything to bolt, but still allow for bolt options.
+    # We just remove them from @argv here and use the rest.
+    # This allows for not having to define a seperator as long as there are no argument colisions
+    return if @argv.empty?
+
+    args = @argv.dup
+    begin
+      parser.parse!(args)
+    rescue OptionParser::InvalidOption
+      retry
+    end
+    bolt_args = @argv - ['-u', '--updateinventory', '--no-updateinventory']
+
+    VagrantBolt::Util::Bolt.update_inventory_file(@env) if options[:update]
+
+    execute_bolt_command(bolt_args)
+  end
+
+  # Run a bolt command with the inventory path, module path, and boltdir
+  # @param args [Array<String>] An array containing the bolt arguments
+  def execute_bolt_command(args)
+    bolt_exe = @env.vagrantfile.config.bolt.bolt_exe
+    modulepath = VagrantBolt::Util::Config.full_path(@env.vagrantfile.config.bolt.modulepath, @env.root_path)
+    boltdir = VagrantBolt::Util::Config.full_path(@env.vagrantfile.config.bolt.boltdir, @env.root_path)
+    inventoryfile = VagrantBolt::Util::Bolt.inventory_file(@env)
+
+    quoted_args = args.flatten.compact.map { |a| "'#{a}'" }
+    command = [
+      "\'#{bolt_exe}\'",
+      quoted_args,
+      '--modulepath',
+      "\'#{modulepath}\'",
+      '--boltdir',
+      "\'#{boltdir}\'",
+    ]
+    command << ['--inventoryfile', "\'#{inventoryfile}\'"] if File.exist?(inventoryfile)
+    VagrantBolt::Util::Machine.run_command(command.flatten.join(" "), @env.ui)
+  end
+end