vagrant-bolt 0.1.0

data/lib/vagrant-bolt/config.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module VagrantBolt::Config
+  require_relative 'config/global'
+  require_relative 'config/bolt'
+end

data/lib/vagrant-bolt/config/bolt.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+class VagrantBolt::Config::Bolt < VagrantBolt::Config::Global
+  # @!attribute [rw] args
+  # @return [String] Additional arguments for the bolt command
+  attr_accessor :args
+
+  # @!attribute [rw] name
+  # @return [String] The name of task or plan to run
+  attr_accessor :name
+
+  # @!attribute [rw] nodes
+  # Note: The `node_list` will override this setting.
+  # @return [Array<String, Symbol>, "ALL"] The nodes to run the task or plan on.
+  # Valid values are an array of machine names or the string "ALL".
+  attr_accessor :nodes
+
+  # @!attribute [rw] excludes
+  # Note: The `node_list` will override this setting.
+  # Note: This will be merged with `nodes`, with `excludes` taking precidence.
+  # @return [Array<String, Symbol>] The nodes to exclude from running this task or plan on.
+  # Valid values are an array of machine names.
+  attr_accessor :excludes
+
+  # @!attribute [rw] node_list
+  # This setting overrides `nodes` and needs to be in the `protocol://ipaddress:port` URI format.
+  # @return [String] The bolt node list. This defaults to the currnet node.
+  attr_accessor :node_list
+
+  # @!attribute [rw] params
+  # @return [Hash] The paramater hash for the task or plan
+  attr_accessor :params
+
+  # @!attribute [rw] command
+  # @return [Symbol] Which command bolt should use. task, plan, command
+  attr_accessor :command
+
+  # @!attribute [rw] noop
+  # @return [Boolean] If the command should be run with noop. Only valid with tasks and apply.
+  attr_accessor :noop
+
+  def initialize
+    super
+    @args         = UNSET_VALUE
+    @name         = UNSET_VALUE
+    @nodes        = []
+    @excludes     = []
+    @node_list    = UNSET_VALUE
+    @params       = UNSET_VALUE
+    @command      = UNSET_VALUE
+  end
+
+  def finalize!
+    @bolt_exe       = nil if @bolt_exe == UNSET_VALUE
+    @boltdir        = nil if @boltdir == UNSET_VALUE
+    @host_key_check = nil if @host_key_check == UNSET_VALUE
+    @modulepath     = nil if @modulepath == UNSET_VALUE
+    @port           = nil if @port == UNSET_VALUE
+    @password       = nil if @password == UNSET_VALUE
+    @private_key    = nil if @private_key == UNSET_VALUE
+    @run_as         = nil if @run_as == UNSET_VALUE
+    @ssl            = nil if @ssl == UNSET_VALUE
+    @ssl_verify     = nil if @ssl_verify == UNSET_VALUE
+    @sudo_password  = nil if @sudo_password == UNSET_VALUE
+    @tmpdir         = nil if @tmpdir == UNSET_VALUE
+    @user           = nil if @user == UNSET_VALUE
+    @verbose        = nil if @verbose == UNSET_VALUE
+    @debug          = nil if @debug == UNSET_VALUE
+
+    @args           = nil if @args == UNSET_VALUE
+    @name           = nil if @name == UNSET_VALUE
+    @node_list      = nil if @node_list == UNSET_VALUE
+    @params         = nil if @params == UNSET_VALUE
+    @command        = nil if @command == UNSET_VALUE
+    @noop           = nil if @noop == UNSET_VALUE
+  end
+
+  def merge(other)
+    super.tap do |result|
+      new_excludes = (excludes + other.excludes.dup).flatten.uniq
+      result.instance_variable_set(:@excludes, new_excludes.to_a)
+      unless nodes.to_s.casecmp("all").zero?
+        new_nodes = (nodes + other.nodes.dup).flatten.uniq
+        result.instance_variable_set(:@nodes, new_nodes.to_a)
+      end
+    end
+  end
+
+  def validate(_machine)
+    errors = _detected_errors
+    errors << I18n.t('vagrant-bolt.config.bolt.errors.invalid_command', command: @command.to_s) if !@command.nil? && !['task', 'plan', 'command'].include?(@command.to_s)
+
+    if @nodes.nil? || (!(@nodes.is_a? Array) && !@nodes.to_s.casecmp("all").zero?)
+      errors << I18n.t('vagrant-bolt.config.bolt.errors.invalid_data_command',
+                       item: 'nodes',
+                       command: 'array')
+    end
+
+    if @excludes.nil? || !(@excludes.is_a? Array)
+      errors << I18n.t('vagrant-bolt.config.bolt.errors.invalid_data_command',
+                       item: 'excludes',
+                       command: 'array')
+    end
+
+    if @command.nil? && !@name.nil?
+      errors << I18n.t('vagrant-bolt.config.bolt.errors.command_not_specified')
+    elsif !@command.nil? && @name.nil?
+      errors << I18n.t('vagrant-bolt.config.bolt.errors.no_task_or_plan')
+    end
+
+    if @command.to_s != 'task' && @noop
+      errors << I18n.t('vagrant-bolt.config.bolt.errors.noop_compatibility',
+                       command: @command)
+    end
+
+    { "Bolt" => errors }
+  end
+
+  # Return a list of settings that are not applicable to the bolt command line options
+  # @return [Array<String>] An array of settings to ignore when creating a bolt command
+  def blacklist
+    [
+      'nodes',
+      'excludes',
+      'node_list',
+      'bolt_exe',
+      'args',
+      'command',
+      'name',
+      'vars',
+      'facts',
+      'features',
+    ]
+  end
+end

data/lib/vagrant-bolt/config/global.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+class VagrantBolt::Config::Global < Vagrant.plugin('2', :config)
+  # @!attribute [rw] bolt_exe
+  # @return [String] The full path to the bolt command. If not passed in, the default from PATH will be used.
+  attr_accessor :bolt_exe
+
+  # @!attribute [rw] boltdir
+  # @return [String] The bolt working directory. Defaults to `.`
+  attr_accessor :boltdir
+
+  # @!attribute [rw] host_key_check
+  # @return [Boolean] If the connection should check the host key on the remote host (linux)
+  attr_accessor :host_key_check
+
+  # @!attribute [rw] modulepath
+  # @return [String] The path to the modules. Defaults to `modules`.
+  attr_accessor :modulepath
+
+  # @!attribute [rw] user
+  # @return [String] The user to authenticate on the machine.
+  attr_accessor :user
+
+  # @!attribute [rw] password
+  # @return [String] The password to authenticate on the machine.
+  attr_accessor :password
+
+  # @!attribute [rw] port
+  # @return [String] The port to connect to the machine.
+  attr_accessor :port
+
+  # @!attribute [rw] private_key
+  # @return [String] The path of the private_key to authenticate on the machine.
+  attr_accessor :private_key
+
+  # @!attribute [rw] run_as
+  # @return [String] User to run as using privilege escalation.
+  attr_accessor :run_as
+
+  # @!attribute [rw] sudo_password
+  # @return [String] The password to authenticate sudo on the machine.
+  attr_accessor :sudo_password
+
+  # @!attribute [rw] ssl
+  # @return [Boolean] If the connection should use SSL on with WinRM (Windows)
+  attr_accessor :ssl
+
+  # @!attribute [rw] ssl_verify
+  # @return [Boolean] If the connection should verify SSL on with WinRM (Windows)
+  attr_accessor :ssl_verify
+
+  # @!attribute [rw] tmpdir
+  # @return [String] The directory to upload and execute temporary files on the target
+  attr_accessor :tmpdir
+
+  # @!attribute [rw] verbose
+  # @return [Boolean] Shows verbose logging
+  attr_accessor :verbose
+
+  # @!attribute [rw] debug
+  # @return [Boolean] Shows debug logging
+  attr_accessor :debug
+
+  # @!attribute [rw] facts
+  # @return [Hash] A hash of facts for the machine
+  attr_accessor :facts
+
+  # @!attribute [rw] vars
+  # @return [Hash] A hash of vars for the machine
+  attr_accessor :vars
+
+  # @!attribute [rw] features
+  # @return [Array<String>] An array containing the features for this machine
+  attr_accessor :features
+
+  def initialize
+    @bolt_exe       = UNSET_VALUE
+    @boltdir        = UNSET_VALUE
+    @host_key_check = UNSET_VALUE
+    @modulepath     = UNSET_VALUE
+    @password       = UNSET_VALUE
+    @port           = UNSET_VALUE
+    @private_key    = UNSET_VALUE
+    @run_as         = UNSET_VALUE
+    @ssl            = UNSET_VALUE
+    @ssl_verify     = UNSET_VALUE
+    @sudo_password  = UNSET_VALUE
+    @tmpdir         = UNSET_VALUE
+    @user           = UNSET_VALUE
+    @verbose        = UNSET_VALUE
+    @debug          = UNSET_VALUE
+    @facts          = UNSET_VALUE
+    @vars           = UNSET_VALUE
+    @features       = UNSET_VALUE
+  end
+
+  def finalize!
+    @bolt_exe       = 'bolt' if @bolt_exe == UNSET_VALUE
+    @boltdir        = '.' if @boltdir == UNSET_VALUE
+    @host_key_check = nil if @host_key_check == UNSET_VALUE
+    @modulepath     = 'modules' if @modulepath == UNSET_VALUE
+    @port           = nil if @port == UNSET_VALUE
+    @password       = nil if @password == UNSET_VALUE
+    @private_key    = nil if @private_key == UNSET_VALUE
+    @run_as         = nil if @run_as == UNSET_VALUE
+    @ssl            = nil if @ssl == UNSET_VALUE
+    @ssl_verify     = nil if @ssl_verify == UNSET_VALUE
+    @sudo_password  = nil if @sudo_password == UNSET_VALUE
+    @tmpdir         = nil if @tmpdir == UNSET_VALUE
+    @user           = nil if @user == UNSET_VALUE
+    @verbose        = nil if @verbose == UNSET_VALUE
+    @debug          = nil if @debug == UNSET_VALUE
+    @facts          = nil if @facts == UNSET_VALUE
+    @features       = nil if @features == UNSET_VALUE
+    @vars           = nil if @vars == UNSET_VALUE
+  end
+
+  def validate(_machine)
+    errors = _detected_errors
+
+    { "GlobalBolt" => errors }
+  end
+
+  # Generate a bolt inventory config hash for this config
+  # @return [Hash] A bolt inventory config hash containing the configured params
+  def inventory_config
+    group_objects = ['facts', 'features', 'vars']
+    config = {}
+    instance_variables_hash.each do |key, value|
+      next if value.nil?
+
+      if group_objects.include?(key)
+        config[key] = value
+      else
+        setting_map.each do |transport, settings|
+          next unless settings.include?(key)
+
+          config['config'] ||= {}
+          config['config'][transport.to_s] ||= {}
+          config['config'][transport.to_s][key.tr('_', '-')] = value
+        end
+      end
+    end
+    config
+  end
+
+  # Return the setting map for the config hash
+  # @return [Hash] A map of the settings to the transport
+  def setting_map
+    {
+      'ssh': [
+        'user',
+        'password',
+        'run_as',
+        'port',
+        'private_key',
+        'host_key_check',
+        'sudo_password',
+        'tmpdir',
+      ],
+      'winrm': [
+        'user',
+        'password',
+        'run_as',
+        'ssl',
+        'ssl_verify',
+        'port',
+        'tmpdir',
+      ],
+    }
+  end
+end

data/lib/vagrant-bolt/config_builder.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'config_builder/model'
+
+module VagrantBolt::ConfigBuilder
+  # Enable config builder loading of this plugin
+
+  require_relative 'config_builder/provisioner'
+  require_relative 'config_builder/config'
+  require_relative 'config_builder/triggers'
+end

data/lib/vagrant-bolt/config_builder/config.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require 'config_builder/model'
+require_relative 'monkey_patches'
+
+class VagrantBolt::ConfigBuilder::Config < ConfigBuilder::Model::Base
+  # @!attribute [rw] args
+  # @return [String] Additional arguments for the bolt command
+  def_model_attribute :args
+
+  # @!attribute [rw] bolt_exe
+  # @return [String] The full path to the bolt command. If not passed in, the default from PATH will be used.
+  def_model_attribute :bolt_exe
+
+  # @!attribute [rw] boltdir
+  # @return [String] The bolt working directory. Defaults to `.`
+  def_model_attribute :boltdir
+
+  # @!attribute [rw] debug
+  # @return [Boolean] Shows debug logging
+  def_model_attribute :debug
+
+  # @!attribute [rw] host_key_check
+  # @return [Boolean] If the connection should check the host key on the remote host (linux)
+  def_model_attribute :host_key_check
+
+  # @!attribute [rw] modulepath
+  # @return [String] The path to the modules. Defaults to `modules`.
+  def_model_attribute :modulepath
+
+  # @!attribute [rw] name
+  # @return [String] The name of task or plan to run
+  def_model_attribute :name
+
+  # @!attribute [rw] nodes
+  # Note: The `node_list` will override this setting.
+  # @return [Array<String, Symbol>, "ALL"] The nodes to run the task or plan on.
+  # Valid values are an array of machine names or the string "ALL".
+  def_model_attribute :nodes
+
+  # @!attribute [rw] excludes
+  # Note: The `node_list` will override this setting.
+  # Note: This will be merged with `nodes`, with `excludes` taking precidence.
+  # @return [Array<String, Symbol>] The nodes to exclude from running this task or plan on.
+  # Valid values are an array of machine names.
+  def_model_attribute :excludes
+
+  # @!attribute [rw] node_list
+  # This setting overrides `nodes` and needs to be in the `protocol://ipaddress:port` URI format
+  # @return [String] The bolt node list. This defaults to the currnet node.
+  def_model_attribute :node_list
+
+  # @!attribute [rw] noop
+  # @return [Boolean] If the command should be run with noop. Only valid with tasks and apply.
+  def_model_attribute :noop
+
+  # @!attribute [rw] params
+  # @return [Hash] The paramater hash for the task or plan
+  def_model_attribute :params
+
+  # @!attribute [rw] command
+  # @return [Symbol] Whether bolt should use a task or plan
+  def_model_attribute :command
+
+  # @!attribute [rw] user
+  # @return [String] The user to authenticate on the machine.
+  def_model_attribute :user
+
+  # @!attribute [rw] password
+  # @return [String] The password to authenticate on the machine.
+  def_model_attribute :password
+
+  # @!attribute [rw] port
+  # @return [String] The port to connect to the machine.
+  def_model_attribute :port
+
+  # @!attribute [rw] private_key
+  # @return [String] The path of the private_key to authenticate on the machine.
+  def_model_attribute :private_key
+
+  # @!attribute [rw] run_as
+  # @return [String] User to run as using privilege escalation.
+  def_model_attribute :run_as
+
+  # @!attribute [rw] sudo_password
+  # @return [String] The password to authenticate sudo on the machine.
+  def_model_attribute :sudo_password
+
+  # @!attribute [rw] ssl
+  # @return [Boolean] If the connection should use SSL on with WinRM (Windows)
+  def_model_attribute :ssl
+
+  # @!attribute [rw] ssl_verify
+  # @return [Boolean] If the connection should verify SSL on with WinRM (Windows)
+  def_model_attribute :ssl_verify
+
+  # @!attribute [rw] tmpdir
+  # @return [String] The directory to upload and execute temporary files on the target
+  def_model_attribute :tmpdir
+
+  # @!attribute [rw] verbose
+  # @return [Boolean] Shows verbose logging
+  def_model_attribute :verbose
+
+  # @!attribute [rw] facts
+  # @return [Hash] A hash of facts for the machine
+  def_model_attribute :facts
+
+  # @!attribute [rw] vars
+  # @return [Hash] A hash of vars for the machine
+  def_model_attribute :vars
+
+  # @!attribute [rw] features
+  # @return [Array<String>] An array containing the features for this machine
+  def_model_attribute :features
+
+  # rubocop:disable Metrics/BlockLength
+  def to_proc
+    proc do |config|
+      bolt = config.bolt
+      with_attr(:args)           { |val| bolt.args           = val }
+      with_attr(:bolt_exe)       { |val| bolt.bolt_exe       = val }
+      with_attr(:command)        { |val| bolt.command        = val }
+      with_attr(:boltdir)        { |val| bolt.boltdir        = val }
+      with_attr(:debug)          { |val| bolt.debug          = val }
+      with_attr(:host_key_check) { |val| bolt.host_key_check = val }
+      with_attr(:modulepath)     { |val| bolt.modulepath     = val }
+      with_attr(:name)           { |val| bolt.name           = val }
+      with_attr(:nodes)          { |val| bolt.nodes          = val }
+      with_attr(:noop)           { |val| bolt.noop           = val }
+      with_attr(:excludes)       { |val| bolt.excludes       = val }
+      with_attr(:node_list)      { |val| bolt.node_list      = val }
+      with_attr(:params)         { |val| bolt.params         = val }
+      with_attr(:user)           { |val| bolt.user           = val }
+      with_attr(:password)       { |val| bolt.password       = val }
+      with_attr(:port)           { |val| bolt.port           = val }
+      with_attr(:private_key)    { |val| bolt.private_key    = val }
+      with_attr(:run_as)         { |val| bolt.run_as         = val }
+      with_attr(:sudo_password)  { |val| bolt.sudo_password  = val }
+      with_attr(:ssl)            { |val| bolt.ssl            = val }
+      with_attr(:ssl_verify)     { |val| bolt.ssl_verify     = val }
+      with_attr(:tmpdir)         { |val| bolt.tmpdir         = val }
+      with_attr(:verbose)        { |val| bolt.verbose        = val }
+      with_attr(:facts)          { |val| bolt.facts          = val }
+      with_attr(:features)       { |val| bolt.features       = val }
+      with_attr(:vars)           { |val| bolt.vars           = val }
+    end
+  end
+  # rubocop:enable Metrics/BlockLength
+end