Class: Kitchen::Provisioner::Chef::Policyfile

Inherits:
Object
  • Object
show all
Includes:
Logging, ShellOut, Which
Defined in:
lib/kitchen/provisioner/chef/policyfile.rb

Overview

Chef cookbook resolver that uses Policyfiles to calculate dependencies.

Author:

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ShellOut

#run_command

Methods included from Logging

#banner, #debug, #error, #fatal, #info, #warn

Constructor Details

#initialize(policyfile, path, logger: Kitchen.logger, always_update: false, policy_group: nil) ⇒ Policyfile

Creates a new cookbook resolver.

Parameters:

  • policyfile (String)

    path to a Policyfile

  • path (String)

    path in which to vendor the resulting cookbooks

  • logger (Kitchen::Logger) (defaults to: Kitchen.logger)

    a logger to use for output, defaults to `Kitchen.logger`


44
45
46
47
48
49
50
# File 'lib/kitchen/provisioner/chef/policyfile.rb', line 44

def initialize(policyfile, path, logger: Kitchen.logger, always_update: false, policy_group: nil)
  @policyfile    = policyfile
  @path          = path
  @logger        = logger
  @always_update = always_update
  @policy_group  = policy_group
end

Class Method Details

.load!(logger: Kitchen.logger) ⇒ Object

Loads the library code required to use the resolver.

Parameters:

  • logger (Kitchen::Logger) (defaults to: Kitchen.logger)

    a logger to use for output, defaults to `Kitchen.logger`


56
57
58
# File 'lib/kitchen/provisioner/chef/policyfile.rb', line 56

def self.load!(logger: Kitchen.logger)
  # intentionally left blank
end

Instance Method Details

#compileObject

Runs `chef install` to determine the correct cookbook set and generate the policyfile lock.


74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/kitchen/provisioner/chef/policyfile.rb', line 74

def compile
  if File.exist?(lockfile)
    info("Installing cookbooks for Policyfile #{policyfile} using `#{cli_path} install`")
  else
    info("Policy lock file doesn't exist, running `#{cli_path} install` for Policyfile #{policyfile}...")
  end
  run_command("#{cli_path} install #{escape_path(policyfile)}")

  if always_update
    info("Updating policy lock using `#{cli_path} update`")
    run_command("#{cli_path} update #{escape_path(policyfile)}")
  end
end

#lockfileString

Return the path to the lockfile corresponding to this policyfile.

Returns:

  • (String)

91
92
93
# File 'lib/kitchen/provisioner/chef/policyfile.rb', line 91

def lockfile
  policyfile.gsub(/\.rb\Z/, ".lock.json")
end

#resolveObject

Performs the cookbook resolution and vendors the resulting cookbooks in the desired path.


62
63
64
65
66
67
68
69
70
# File 'lib/kitchen/provisioner/chef/policyfile.rb', line 62

def resolve
  if policy_group
    info("Exporting cookbook dependencies from Policyfile #{path} with policy_group #{policy_group} using `#{cli_path} export`...")
    run_command("#{cli_path} export #{escape_path(policyfile)} #{escape_path(path)} --policy_group #{policy_group} --force")
  else
    info("Exporting cookbook dependencies from Policyfile #{path} using `#{cli_path} export`...")
    run_command("#{cli_path} export #{escape_path(policyfile)} #{escape_path(path)} --force")
  end
end