Class: Berkshelf::Berksfile
- Inherits:
-
Object
- Object
- Berkshelf::Berksfile
- Extended by:
- Forwardable
- Includes:
- Mixin::Logging, Cleanroom
- Defined in:
- lib/berkshelf/berksfile.rb
Constant Summary collapse
- DEFAULT_API_URL =
"https://supermarket.chef.io".freeze
- EXCLUDED_VCS_FILES_WHEN_VENDORING =
Don’t vendor VCS files. Reference GNU tar –exclude-vcs: www.gnu.org/software/tar/manual/html_section/tar_49.html
['.arch-ids', '{arch}', '.bzr', '.bzrignore', '.bzrtags', 'CVS', '.cvsignore', '_darcs', '.git', '.hg', '.hgignore', '.hgrags', 'RCS', 'SCCS', '.svn', '**/.git'].freeze
Instance Attribute Summary collapse
-
#filepath ⇒ String
readonly
The path on disk to the file representing this instance of Berksfile.
-
#preferred_solver ⇒ Symbol
readonly
The solver engine preferred by this instance of Berksfile.
-
#required_solver ⇒ Symbol
readonly
The solver engine required by this instance of Berksfile.
Attributes included from Mixin::Logging
Class Method Summary collapse
- .from_file(file, options = {}) ⇒ Berksfile
-
.from_options(options = {}) ⇒ Object
Instantiate a Berksfile from the given options.
Instance Method Summary collapse
- #[](name) ⇒ Dependency (also: #get_dependency)
-
#add_dependency(name, constraint = nil, options = {}) ⇒ Array<Dependency]
Add a dependency of the given name and constraint to the array of dependencies.
- #chef_api(*args) ⇒ Object
-
#cookbook(*args) ⇒ Object
Add a cookbook dependency to the Berksfile to be retrieved and have its dependencies recursively retrieved and resolved.
-
#cookbooks ⇒ Array<CachedCookbook>
Behaves the same as #dependencies, but this method returns an array of CachedCookbook objects instead of dependency objects.
- #dependencies ⇒ Array<Dependency>
-
#extension(name) ⇒ true
Activate a Berkshelf extension at runtime.
-
#find(name) ⇒ Dependency?
Find a dependency defined in this berksfile by name.
- #group(*args) ⇒ Object
-
#groups ⇒ Hash
A hash containing group names as keys and an array of Dependencies that are a member of that group as values.
-
#has_dependency?(dependency) ⇒ Boolean
Check if the Berksfile has the given dependency, taking into account
group
and –only/–except flags. -
#initialize(path, options = {}) ⇒ Berksfile
constructor
Create a new Berksfile object.
-
#install ⇒ Array<CachedCookbook>
Install the dependencies listed in the Berksfile, respecting the locked versions in the Berksfile.lock.
-
#list ⇒ Hash<Dependency, CachedCookbook>
The cached cookbooks installed by this Berksfile.
-
#lockfile ⇒ Lockfile
Get the lockfile corresponding to this Berksfile.
-
#metadata(options = {}) ⇒ Object
Use a Cookbook metadata file to determine additional cookbook dependencies to retrieve.
-
#outdated(*names) ⇒ Hash
List of all the cookbooks which have a newer version found at a source that satisfies the constraints of your dependencies.
-
#package(path) ⇒ String
Package the given cookbook for distribution outside of berkshelf.
-
#retrieve_locked(dependency) ⇒ CachedCookbook
Retrieve information about a given cookbook that is installed by this Berksfile.
- #site(*args) ⇒ Object
-
#solver(name, precedence = :preferred) ⇒ Object
Configure a specific engine for the ‘solve’ gem to use when computing dependencies.
-
#source(api_url) ⇒ Array<Source>
Add a Berkshelf API source to use when building the index of known cookbooks.
- #source_for(name, version) ⇒ Object
- #sources ⇒ Array<Source>
-
#update(*names) ⇒ Object
Update the given set of dependencies (or all if no names are given).
-
#upload(*args) ⇒ Array<CachedCookbook>
Upload the cookbooks installed by this Berksfile.
-
#vendor(destination) ⇒ String?
Install the Berksfile or Berksfile.lock and then sync the cached cookbooks into directories within the given destination matching their name.
-
#verify ⇒ Object
Perform a validation with ‘Validator#validate` on each cached cookbook associated with the Lockfile of this Berksfile.
-
#viz(outfile = nil, format = 'png') ⇒ String
Visualize the current Berksfile as a “graph” using DOT.
Constructor Details
#initialize(path, options = {}) ⇒ Berksfile
Create a new Berksfile object.
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/berkshelf/berksfile.rb', line 63 def initialize(path, = {}) @filepath = File.(path) @dependencies = Hash.new @sources = Hash.new @delete = [:delete] # defaults for what solvers to use @required_solver = nil @preferred_solver = :gecode if [:except] && [:only] raise ArgumentError, 'Cannot specify both :except and :only!' elsif [:except] except = Array([:except]).collect(&:to_sym) @filter = ->(dependency) { (except & dependency.groups).empty? } elsif [:only] only = Array([:only]).collect(&:to_sym) @filter = ->(dependency) { !(only & dependency.groups).empty? } else @filter = ->(dependency) { true } end end |
Instance Attribute Details
#filepath ⇒ String (readonly)
Returns The path on disk to the file representing this instance of Berksfile.
42 43 44 |
# File 'lib/berkshelf/berksfile.rb', line 42 def filepath @filepath end |
#preferred_solver ⇒ Symbol (readonly)
Returns The solver engine preferred by this instance of Berksfile.
50 51 52 |
# File 'lib/berkshelf/berksfile.rb', line 50 def preferred_solver @preferred_solver end |
#required_solver ⇒ Symbol (readonly)
Returns The solver engine required by this instance of Berksfile.
46 47 48 |
# File 'lib/berkshelf/berksfile.rb', line 46 def required_solver @required_solver end |
Class Method Details
.from_file(file, options = {}) ⇒ Berksfile
19 20 21 22 23 24 25 26 27 |
# File 'lib/berkshelf/berksfile.rb', line 19 def from_file(file, = {}) raise BerksfileNotFound.new(file) unless File.exist?(file) begin new(file, ).evaluate_file(file) rescue => ex raise BerksfileReadError.new(ex) end end |
.from_options(options = {}) ⇒ Object
Instantiate a Berksfile from the given options. This method is used heavily by the CLI to reduce duplication.
10 11 12 13 |
# File 'lib/berkshelf/berksfile.rb', line 10 def ( = {}) [:berksfile] ||= File.join(Dir.pwd, Berkshelf::DEFAULT_FILENAME) from_file([:berksfile], .slice(:except, :only, :delete)) end |
Instance Method Details
#[](name) ⇒ Dependency Also known as: get_dependency
390 391 392 |
# File 'lib/berkshelf/berksfile.rb', line 390 def [](name) @dependencies[name] end |
#add_dependency(name, constraint = nil, options = {}) ⇒ Array<Dependency]
Add a dependency of the given name and constraint to the array of dependencies.
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 |
# File 'lib/berkshelf/berksfile.rb', line 299 def add_dependency(name, constraint = nil, = {}) if @dependencies[name] # Only raise an exception if the dependency is a true duplicate groups = ([:group].nil? || [:group].empty?) ? [:default] : [:group] if !(@dependencies[name].groups & groups).empty? raise DuplicateDependencyDefined.new(name) end end if [:path] = File.join([:path], 'metadata.rb') end [:constraint] = constraint @dependencies[name] = Dependency.new(self, name, ) end |
#chef_api(*args) ⇒ Object
remove in Berkshelf 4.0
274 275 276 277 278 |
# File 'lib/berkshelf/berksfile.rb', line 274 def chef_api(*args) raise DeprecatedError.new "Your Berksfile contains a chef_api location. Chef API locations have " + " been replaced by the source location. Please remove your site location and try again. For more " + " information visit https://github.com/berkshelf/berkshelf/wiki/deprecated-locations" end |
#cookbook(name, version_constraint, options = {}) ⇒ Object #cookbook(name, options = {}) ⇒ Object
Add a cookbook dependency to the Berksfile to be retrieved and have its dependencies recursively retrieved and resolved.
144 145 146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/berkshelf/berksfile.rb', line 144 def cookbook(*args) = args.last.is_a?(Hash) ? args.pop : Hash.new name, constraint = args [:path] &&= File.([:path], File.dirname(filepath)) [:group] = Array([:group]) if @active_group [:group] += @active_group end add_dependency(name, constraint, ) end |
#cookbooks ⇒ Array<CachedCookbook>
Behaves the same as #dependencies, but this method returns an array of CachedCookbook objects instead of dependency objects. This method relies on the #retrieve_locked method to load the proper cached cookbook from the Berksfile + lockfile combination.
347 348 349 |
# File 'lib/berkshelf/berksfile.rb', line 347 def cookbooks dependencies.map { |dependency| retrieve_locked(dependency) } end |
#dependencies ⇒ Array<Dependency>
330 331 332 |
# File 'lib/berkshelf/berksfile.rb', line 330 def dependencies @dependencies.values.sort.select(&@filter) end |
#extension(name) ⇒ true
Activate a Berkshelf extension at runtime.
98 99 100 101 102 103 104 |
# File 'lib/berkshelf/berksfile.rb', line 98 def extension(name) require "berkshelf/#{name}" true rescue LoadError raise LoadError, "Could not load an extension by the name `#{name}'. " \ "Please make sure it is installed." end |
#find(name) ⇒ Dependency?
Find a dependency defined in this berksfile by name.
357 358 359 |
# File 'lib/berkshelf/berksfile.rb', line 357 def find(name) @dependencies[name] end |
#group(*args) ⇒ Object
159 160 161 162 163 |
# File 'lib/berkshelf/berksfile.rb', line 159 def group(*args) @active_group = args yield @active_group = nil end |
#groups ⇒ Hash
Returns a hash containing group names as keys and an array of Dependencies that are a member of that group as values
Example:
{
nautilus: [
#<Dependency: nginx (~> 1.0.0)>,
#<Dependency: mysql (~> 1.2.4)>
],
skarner: [
#<Dependency: nginx (~> 1.0.0)>
]
}.
375 376 377 378 379 380 381 382 383 384 |
# File 'lib/berkshelf/berksfile.rb', line 375 def groups {}.tap do |groups| dependencies.each do |dependency| dependency.groups.each do |group| groups[group] ||= [] groups[group] << dependency end end end end |
#has_dependency?(dependency) ⇒ Boolean
Check if the Berksfile has the given dependency, taking into account group
and –only/–except flags.
324 325 326 327 |
# File 'lib/berkshelf/berksfile.rb', line 324 def has_dependency?(dependency) name = Dependency.name(dependency) dependencies.map(&:name).include?(name) end |
#install ⇒ Array<CachedCookbook>
Install the dependencies listed in the Berksfile, respecting the locked versions in the Berksfile.lock.
-
Check that a lockfile exists. If a lockfile does not exist, all dependencies are considered to be “unlocked”. If a lockfile is specified, a definition is created via the following algorithm:
-
For each source, see if there exists a locked version that still satisfies the version constraint in the Berksfile. If there exists such a source, remove it from the list of unlocked sources. If not, then either a version constraint has changed, or a new source has been added to the Berksfile. In the event that a locked_source exists, but it no longer satisfies the constraint, this method will raise a OutdatedCookbookSource, and inform the user to run
berks update COOKBOOK
to remedy the issue. -
Remove any locked sources that no longer exist in the Berksfile (i.e. a cookbook source was removed from the Berksfile).
-
-
Resolve the collection of locked and unlocked dependencies.
-
Write out a new lockfile.
421 422 423 |
# File 'lib/berkshelf/berksfile.rb', line 421 def install Installer.new(self).run end |
#list ⇒ Hash<Dependency, CachedCookbook>
The cached cookbooks installed by this Berksfile.
477 478 479 480 481 482 483 |
# File 'lib/berkshelf/berksfile.rb', line 477 def list validate_lockfile_present! validate_lockfile_trusted! validate_dependencies_installed! lockfile.graph.locks.values end |
#lockfile ⇒ Lockfile
Get the lockfile corresponding to this Berksfile. This is necessary because the user can specify a different path to the Berksfile. So assuming the lockfile is named “Berksfile.lock” is a poor assumption.
721 722 723 |
# File 'lib/berkshelf/berksfile.rb', line 721 def lockfile @lockfile ||= Lockfile.from_berksfile(self) end |
#metadata(options = {}) ⇒ Object
Use a Cookbook metadata file to determine additional cookbook dependencies to retrieve. All dependencies found in the metadata will use the default locations set in the Berksfile (if any are set) or the default locations defined by Berkshelf.
174 175 176 177 178 179 180 |
# File 'lib/berkshelf/berksfile.rb', line 174 def ( = {}) path = [:path] || File.dirname(filepath) = File.(File.join(path, 'metadata.rb')) = Ridley::Chef::Cookbook::Metadata.from_file() add_dependency(.name, nil, path: path, metadata: true) end |
#outdated(*names) ⇒ Hash
List of all the cookbooks which have a newer version found at a source that satisfies the constraints of your dependencies.
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 |
# File 'lib/berkshelf/berksfile.rb', line 503 def outdated(*names) validate_lockfile_present! validate_lockfile_trusted! validate_dependencies_installed! validate_cookbook_names!(names) lockfile.graph.locks.inject({}) do |hash, (name, dependency)| sources.each do |source| cookbooks = source.versions(name) latest = cookbooks.select do |cookbook| dependency.version_constraint.satisfies?(cookbook.version) && Semverse::Version.coerce(cookbook.version) > dependency.locked_version end.sort_by { |cookbook| cookbook.version }.last unless latest.nil? hash[name] ||= { 'local' => dependency.locked_version, 'remote' => { source => Semverse::Version.coerce(latest.version) } } end end hash end end |
#package(path) ⇒ String
Package the given cookbook for distribution outside of berkshelf. If the name attribute is not given, all cookbooks in the Berksfile will be packaged.
607 608 609 610 611 612 613 614 615 616 617 618 |
# File 'lib/berkshelf/berksfile.rb', line 607 def package(path) packager = Packager.new(path) packager.validate! outdir = Dir.mktmpdir do |temp_dir| Berkshelf.ui.mute { vendor(File.join(temp_dir, 'cookbooks')) } packager.run(temp_dir) end Berkshelf.formatter.package(outdir) outdir end |
#retrieve_locked(dependency) ⇒ CachedCookbook
Retrieve information about a given cookbook that is installed by this Berksfile. Unlike #find, which returns a dependency, this method returns the corresponding CachedCookbook for the given name.
464 465 466 |
# File 'lib/berkshelf/berksfile.rb', line 464 def retrieve_locked(dependency) lockfile.retrieve(dependency) end |
#site(*args) ⇒ Object
remove in Berkshelf 4.0
255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'lib/berkshelf/berksfile.rb', line 255 def site(*args) if args.first == :opscode Berkshelf.formatter.deprecation "Your Berksfile contains a site location pointing to the Opscode Community " + "Site (site :opscode). Site locations have been replaced by the source location. Change this to: " + "'source \"https://supermarket.chef.io\"' to remove this warning. For more information visit " + "https://github.com/berkshelf/berkshelf/wiki/deprecated-locations" source(DEFAULT_API_URL) return end raise DeprecatedError.new "Your Berksfile contains a site location. Site locations have been " + " replaced by the source location. Please remove your site location and try again. For more information " + " visit https://github.com/berkshelf/berkshelf/wiki/deprecated-locations" end |
#solver(name, precedence = :preferred) ⇒ Object
Configure a specific engine for the ‘solve’ gem to use when computing dependencies. You may optionally specify how strong a requirement this is. If omitted, the default precedence is :preferred.
If :required is specified and cannot be loaded, Resolver#resolve will raise an ArgumentError. If :preferred is specified and cannot be loaded, Resolver#resolve silently catch any errors and use whatever default method the ‘solve’ gem provides (as of 2.0.1, solve defaults to :ruby).
226 227 228 229 230 231 232 233 234 |
# File 'lib/berkshelf/berksfile.rb', line 226 def solver(name, precedence = :preferred) if name && precedence == :required @required_solver = name elsif name && precedence == :preferred @preferred_solver = name else raise ArgumentError, "Invalid solver precedence ':#{precedence}'" end end |
#source(api_url) ⇒ Array<Source>
Add a Berkshelf API source to use when building the index of known cookbooks. The indexes will be searched in the order they are added. If a cookbook is found in the first source then a cookbook in a second source would not be used.
197 198 199 |
# File 'lib/berkshelf/berksfile.rb', line 197 def source(api_url) @sources[api_url] = Source.new(api_url) end |
#source_for(name, version) ⇒ Object
248 249 250 |
# File 'lib/berkshelf/berksfile.rb', line 248 def source_for(name, version) sources.find { |source| source.cookbook(name, version) } end |
#sources ⇒ Array<Source>
238 239 240 241 242 243 244 |
# File 'lib/berkshelf/berksfile.rb', line 238 def sources if @sources.empty? raise NoAPISourcesDefined else @sources.values end end |
#update(*names) ⇒ Object
Update the given set of dependencies (or all if no names are given).
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 |
# File 'lib/berkshelf/berksfile.rb', line 429 def update(*names) validate_lockfile_present! validate_cookbook_names!(names) Berkshelf.log.info "Updating cookbooks" # Calculate the list of cookbooks to unlock if names.empty? Berkshelf.log.debug " Unlocking all the things!" lockfile.unlock_all else names.each do |name| Berkshelf.log.debug " Unlocking #{name}" lockfile.unlock(name, true) end end # NOTE: We intentionally do NOT pass options to the installer self.install end |
#upload(names = []) ⇒ Array<CachedCookbook> #upload(names = [], options = {}) ⇒ Array<CachedCookbook>
Upload the cookbooks installed by this Berksfile
588 589 590 591 592 593 594 |
# File 'lib/berkshelf/berksfile.rb', line 588 def upload(*args) validate_lockfile_present! validate_lockfile_trusted! validate_dependencies_installed! Uploader.new(self, *args).run end |
#vendor(destination) ⇒ String?
Install the Berksfile or Berksfile.lock and then sync the cached cookbooks into directories within the given destination matching their name.
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 |
# File 'lib/berkshelf/berksfile.rb', line 628 def vendor(destination) Dir.mktmpdir('vendor') do |scratch| chefignore = nil cached_cookbooks = install = [] return nil if cached_cookbooks.empty? cached_cookbooks.each do |cookbook| Berkshelf.formatter.vendor(cookbook, destination) cookbook_destination = File.join(scratch, cookbook.cookbook_name) FileUtils.mkdir_p(cookbook_destination) # Dir.glob does not support backslash as a File separator src = cookbook.path.to_s.gsub('\\', '/') files = FileSyncer.glob(File.join(src, '*')) chefignore = Ridley::Chef::Chefignore.new(cookbook.path.to_s) rescue nil chefignore.apply!(files) if chefignore unless cookbook. cookbook.(cookbook_destination) end << File::join(cookbook.cookbook_name, 'metadata.rb') FileUtils.cp_r(files, cookbook_destination) end # Don't vendor the raw metadata (metadata.rb). The raw metadata is # unecessary for the client, and this is required until compiled metadata # (metadata.json) takes precedence over raw metadata in the Chef-Client. # # We can change back to including the raw metadata in the future after # this has been fixed or just remove these comments. There is no # circumstance that I can currently think of where raw metadata should # ever be read by the client. # # - Jamie # # See the following tickets for more information: # # * https://tickets.opscode.com/browse/CHEF-4811 # * https://tickets.opscode.com/browse/CHEF-4810 FileSyncer.sync(scratch, destination, exclude: + EXCLUDED_VCS_FILES_WHEN_VENDORING, delete: @delete) end destination end |
#verify ⇒ Object
Perform a validation with ‘Validator#validate` on each cached cookbook associated with the Lockfile of this Berksfile.
This function will return true or raise the first errors encountered.
682 683 684 685 686 687 688 |
# File 'lib/berkshelf/berksfile.rb', line 682 def verify validate_lockfile_present! validate_lockfile_trusted! Berkshelf.formatter.msg "Verifying (#{lockfile.cached.length}) cookbook(s)..." Validator.validate(lockfile.cached) true end |
#viz(outfile = nil, format = 'png') ⇒ String
Visualize the current Berksfile as a “graph” using DOT.
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 |
# File 'lib/berkshelf/berksfile.rb', line 697 def viz(outfile = nil, format = 'png') outfile = File.join(Dir.pwd, outfile || 'graph.png') validate_lockfile_present! validate_lockfile_trusted! vizualiser = Visualizer.from_lockfile(lockfile) case format when 'dot' vizualiser.to_dot_file(outfile) when 'png' vizualiser.to_png(outfile) else raise ConfigurationError, "Vizualiser format #{format} not recognised." end end |