Class: ChefDK::PolicyfileCompiler

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/chef-dk/policyfile_compiler.rb

Constant Summary collapse

DEFAULT_DEMAND_CONSTRAINT = 
'>= 0.0.0'.freeze
SOURCE_TYPES_WITH_FIXED_VERSIONS =

Cookbooks from these sources lock that cookbook to exactly one version

[:git, :path].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ui: nil) ⇒ PolicyfileCompiler

Returns a new instance of PolicyfileCompiler.



55
56
57
58
59
60
61
62
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 55

def initialize(ui: nil)
  @storage_config = Policyfile::StorageConfig.new
  @dsl = Policyfile::DSL.new(storage_config)
  @artifact_server_cookbook_location_specs = {}

  @ui = ui || UI.null
  @install_report = Policyfile::Reports::Install.new(ui: @ui, policyfile_compiler: self)
end

Instance Attribute Details

#dsl ⇒ Object (readonly)

Returns the value of attribute dsl.



51
52
53
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 51

def dsl
  @dsl
end

#install_report ⇒ Object (readonly)

Returns the value of attribute install_report.



53
54
55
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 53

def install_report
  @install_report
end

#storage_config ⇒ Object (readonly)

Returns the value of attribute storage_config.



52
53
54
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 52

def storage_config
  @storage_config
end

Class Method Details

.evaluate(policyfile_string, policyfile_filename, ui: nil) ⇒ Object 



39
40
41
42
43
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 39

def self.evaluate(policyfile_string, policyfile_filename, ui: nil)
  compiler = new(ui: ui)
  compiler.evaluate_policyfile(policyfile_string, policyfile_filename)
  compiler
end

Instance Method Details

#all_cookbook_location_specs ⇒ Object 



107
108
109
110
111
112
113
114
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 107

def all_cookbook_location_specs
  # in the installation proces, we create "artifact_server_cookbook_location_specs"
  # for any cookbook that isn't sourced from a single-version source (e.g.,
  # path and git only support one version at a time), but we might have
  # specs for them to track additional version constraint demands. Merging
  # in this order ensures the artifact_server_cookbook_location_specs "win".
  cookbook_location_specs.merge(@artifact_server_cookbook_location_specs)
end

#artifacts_graph ⇒ Object 



166
167
168
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 166

def artifacts_graph
  remote_artifacts_graph.merge(local_artifacts_graph)
end

#build {|@dsl| ... } ⇒ Object

Yields:



212
213
214
215
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 212

def build
  yield @dsl
  self
end

#cookbook_location_spec_for(cookbook_name) ⇒ Object 



70
71
72
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 70

def cookbook_location_spec_for(cookbook_name)
  cookbook_location_specs[cookbook_name]
end

#cookbook_version_fixed?(cookbook_name) ⇒ Boolean

Returns:

  • (Boolean) 


199
200
201
202
203
204
205
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 199

def cookbook_version_fixed?(cookbook_name)
  if cookbook_location_spec = cookbook_location_spec_for(cookbook_name)
    cookbook_location_spec.version_fixed?
  else
    false
  end
end

#cookbooks_in_run_list ⇒ Object 



207
208
209
210
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 207

def cookbooks_in_run_list
  recipes = expanded_run_list.map {|recipe| recipe.name }
  recipes.map { |r| r[/^([^:]+)/, 1] }
end

#create_spec_for_cookbook(cookbook_name, version) ⇒ Object 



101
102
103
104
105
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 101

def create_spec_for_cookbook(cookbook_name, version)
  source_options = default_source.source_options_for(cookbook_name, version)
  spec = Policyfile::CookbookLocationSpecification.new(cookbook_name, "= #{version}", source_options, storage_config)
  @artifact_server_cookbook_location_specs[cookbook_name] = spec
end

#error! ⇒ Object 



64
65
66
67
68
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 64

def error!
  unless errors.empty?
    raise PolicyfileError, errors.join("\n")
  end
end

#evaluate_policyfile(policyfile_string, policyfile_filename) ⇒ Object 



217
218
219
220
221
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 217

def evaluate_policyfile(policyfile_string, policyfile_filename)
  storage_config.use_policyfile(policyfile_filename)
  @dsl.eval_policyfile(policyfile_string)
  self
end

#expanded_run_list ⇒ Object 



74
75
76
77
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 74

def expanded_run_list
  # doesn't support roles yet...
  Chef::RunList.new(*run_list)
end

#fixed_version_cookbooks_specs ⇒ Object 



223
224
225
226
227
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 223

def fixed_version_cookbooks_specs
  @fixed_version_cookbooks_specs ||= cookbook_location_specs.select do |_cookbook_name, cookbook_location_spec|
    cookbook_location_spec.version_fixed?
  end
end

#graph ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 126

def graph
  @graph ||= Solve::Graph.new.tap do |g|
    artifacts_graph.each do |name, dependencies_by_version|
      dependencies_by_version.each do |version, dependencies|
        artifact = g.artifact(name, version)
        dependencies.each do |dep_name, constraint|
          artifact.dependency(dep_name, constraint)
        end
      end
    end
  end
end

#graph_demands ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 153

def graph_demands
  cookbooks_for_demands.map do |cookbook_name|
    spec = cookbook_location_spec_for(cookbook_name)
    if spec.nil?
      [ cookbook_name, DEFAULT_DEMAND_CONSTRAINT ]
    elsif spec.version_fixed?
      [ cookbook_name, "= #{spec.version}" ]
    else
      [ cookbook_name, spec.version_constraint.to_s ]
    end
  end
end

#graph_solution ⇒ Object

Compilation Methods



120
121
122
123
124
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 120

def graph_solution
  return @solution if @solution
  cache_fixed_version_cookbooks
  @solution = Solve.it!(graph, graph_demands)
end

#install ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 88

def install
  ensure_cache_dir_exists

  graph_solution.each do |cookbook_name, version|
    spec = cookbook_location_spec_for(cookbook_name)
    if spec.nil? or !spec.version_fixed?
      spec = create_spec_for_cookbook(cookbook_name, version)
      install_report.installing_cookbook(spec)
      spec.ensure_cached
    end
  end
end

#local_artifacts_graph ⇒ Object

Gives a dependency graph for cookbooks that are source from an alternate location. These cookbooks could have a different set of dependencies compared to an unmodified copy upstream. For example, the community site may have a cookbook “apache2” at version “1.10.4”, which the user has forked on github and modified the dependencies without changing the version number. To accomodate this, the local_artifacts_graph should be merged over the upstream’s artifacts graph.



177
178
179
180
181
182
183
184
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 177

def local_artifacts_graph
  cookbook_location_specs.inject({}) do |local_artifacts, (cookbook_name, cookbook_location_spec)|
    if cookbook_location_spec.version_fixed?
      local_artifacts[cookbook_name] = { cookbook_location_spec.version => cookbook_location_spec.dependencies }
    end
    local_artifacts
  end
end

#lock ⇒ Object 



84
85
86
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 84

def lock
  @policyfile_lock ||= PolicyfileLock.build_from_compiler(self, storage_config)
end

#normalized_run_list ⇒ Object

copy of the expanded_run_list, properly formatted for use in a lockfile



80
81
82
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 80

def normalized_run_list
  expanded_run_list.map { |i| normalize_recipe(i) }
end

#remote_artifacts_graph ⇒ Object 



186
187
188
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 186

def remote_artifacts_graph
  default_source.universe_graph
end

#solution_dependencies ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 139

def solution_dependencies
  solution_deps = Policyfile::SolutionDependencies.new

  all_cookbook_location_specs.each do |name, spec|
    solution_deps.add_policyfile_dep(name, spec.version_constraint)
  end

  graph_solution.each do |name, version|
    transitive_deps = artifacts_graph[name][version]
    solution_deps.add_cookbook_dep(name, version, transitive_deps)
  end
  solution_deps
end

#version_constraint_for(cookbook_name) ⇒ Object 



190
191
192
193
194
195
196
197
 
# File 'lib/chef-dk/policyfile_compiler.rb', line 190

def version_constraint_for(cookbook_name)
  if (cookbook_location_spec = cookbook_location_spec_for(cookbook_name)) and cookbook_location_spec.version_fixed?
    version = cookbook_location_spec.version
    "= #{version}"
  else
    DEFAULT_DEMAND_CONSTRAINT
  end
end