Class: Kitchen::Provisioner::ChefBase
- Defined in:
- lib/kitchen/provisioner/chef_base.rb
Overview
Common implementation details for Chef-related provisioners.
Instance Attribute Summary
Attributes included from Configurable
Instance Method Summary collapse
-
#check_license ⇒ Object
Certain products that Test Kitchen uses to provision require accepting a license to use.
-
#create_sandbox ⇒ Object
Creates a temporary directory on the local workstation into which provisioner related files and directories can be copied or created.
- #doctor(state) ⇒ Object
-
#init_command ⇒ String
Generates a command string which will perform any data initialization or configuration required after the provisioner software is installed but before the sandbox has been transferred to the instance.
-
#initialize(config = {}) ⇒ ChefBase
constructor
Reads the local Chef::Config object (if present).
-
#install_command ⇒ String
Generates a command string which will install and configure the provisioner software on an instance.
-
#product_version ⇒ String, ...
gives us the product version from either require_chef_omnibus or product_version If the non-default (true) value of require_chef_omnibus is present use that otherwise use config which defaults to :latest and is the actual default for chef provisioners.
Methods inherited from Base
#call, #cleanup_sandbox, kitchen_provisioner_api_version, #prepare_command, #run_command, #sandbox_path
Methods included from Logging
#banner, #debug, #error, #fatal, #info, #warn
Methods included from Configurable
#[], #bourne_shell?, #calculate_path, #config_keys, #diagnose, #diagnose_plugin, #finalize_config!, included, #name, #powershell_shell?, #remote_path_join, #unix_os?, #verify_dependencies, #windows_os?
Constructor Details
#initialize(config = {}) ⇒ ChefBase
Reads the local Chef::Config object (if present). We do this because we want to start bring Chef config and ChefDK tool config closer together. For example, we want to configure proxy settings in 1 location instead of 3 configuration files.
231 232 233 234 235 236 237 238 239 240 |
# File 'lib/kitchen/provisioner/chef_base.rb', line 231 def initialize(config = {}) super(config) if defined?(ChefConfig::WorkstationConfigLoader) ChefConfig::WorkstationConfigLoader.new(config[:config_path]).load end # This exports any proxy config present in the Chef config to # appropriate environment variables, which Test Kitchen respects ChefConfig::Config.export_proxies if defined?(ChefConfig::Config.export_proxies) end |
Instance Method Details
#check_license ⇒ Object
Certain products that Test Kitchen uses to provision require accepting a license to use. Overwrite this method in the specific provisioner to implement this check.
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/kitchen/provisioner/chef_base.rb', line 266 def check_license name = config[:product_name] || "chef" version = product_version debug("Checking if we need to prompt for license acceptance on product: #{name} version: #{version}.") acceptor = LicenseAcceptance::Acceptor.new(logger: Kitchen.logger, provided: config[:chef_license]) if acceptor.license_required?(name, version) debug("License acceptance required for #{name} version: #{version}. Prompting") license_id = acceptor.id_from_mixlib(name) begin acceptor.check_and_persist(license_id, version.to_s) rescue LicenseAcceptance::LicenseNotAcceptedError => e error("Cannot converge without accepting the #{e.product.pretty_name} License. Set it in your kitchen.yml or using the CHEF_LICENSE environment variable") raise end config[:chef_license] ||= acceptor.acceptance_value end end |
#create_sandbox ⇒ Object
Creates a temporary directory on the local workstation into which provisioner related files and directories can be copied or created. The contents of this directory will be copied over to the instance before invoking the provisioner’s run command. After this method completes, it is expected that the contents of the sandbox is complete and ready for copy to the remote instance.
Note: any subclasses would be well advised to call super first when overriding this method, for example:
286 287 288 289 290 |
# File 'lib/kitchen/provisioner/chef_base.rb', line 286 def create_sandbox super Chef::CommonSandbox.new(config, sandbox_path, instance).populate end |
#doctor(state) ⇒ Object
242 243 244 245 246 |
# File 'lib/kitchen/provisioner/chef_base.rb', line 242 def doctor(state) deprecated_config.each do |attr, msg| info("**** #{attr} deprecated\n#{msg}") end end |
#init_command ⇒ String
Generates a command string which will perform any data initialization or configuration required after the provisioner software is installed but before the sandbox has been transferred to the instance. If no work is required, then ‘nil` will be returned.
293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/kitchen/provisioner/chef_base.rb', line 293 def init_command dirs = %w{ cookbooks data data_bags environments roles clients encrypted_data_bag_secret }.sort.map { |dir| remote_path_join(config[:root_path], dir) } vars = if powershell_shell? init_command_vars_for_powershell(dirs) else init_command_vars_for_bourne(dirs) end prefix_command(shell_code_from_file(vars, "chef_base_init_command")) end |
#install_command ⇒ String
Generates a command string which will install and configure the provisioner software on an instance. If no work is required, then ‘nil` will be returned.
309 310 311 312 313 |
# File 'lib/kitchen/provisioner/chef_base.rb', line 309 def install_command return unless config[:require_chef_omnibus] || config[:product_name] return if config[:product_name] && config[:install_strategy] == "skip" prefix_command(sudo(install_script_contents)) end |
#product_version ⇒ String, ...
gives us the product version from either require_chef_omnibus or product_version If the non-default (true) value of require_chef_omnibus is present use that otherwise use config which defaults to :latest and is the actual default for chef provisioners
254 255 256 257 258 259 260 261 262 263 |
# File 'lib/kitchen/provisioner/chef_base.rb', line 254 def product_version case config[:require_chef_omnibus] when FalseClass nil when TrueClass config[:product_version] else config[:require_chef_omnibus] end end |