chef-cli 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f07d3f568a94bf70e402ec732f96521233dafdf566b60bdc0ef9fad586e29af
-  data.tar.gz: 6b060133bceeb79fde35c38a41b7c4b6e4a71520f1f631cf37d4f0942838c0ed
+  metadata.gz: 296f2275d23de7dca838ca9919a2ef33f99fcafab1876d3bea25d7c314738a77
+  data.tar.gz: 320ea6193c4d7af2754e88528f9916615e35f383392eef8cfdcfaa89c456cf45
 SHA512:
-  metadata.gz: c429fdd87a900cd5c9178e44edc2eccf48a517a96aa0dd58de2adf5d1d9cdb0ddac522efeacb5676b9a12284bda262030fe8f5e65909ed40e21b5d3fb23845aa
-  data.tar.gz: db8f7b5d1a073a314489315aa35db2554575bba13e37f1ac28c99f0795eb57233d0ae0beb1989f7aa98d0970ed0826cd96849367b1161ecf144d76fc224e9167
+  metadata.gz: 75673a37567263db2076636caa828cfa56ef03fc90b1fb0dbbc2eceaccf5d5b5ca8a39056b12363b3ef4d7eb1237c35919a7d8d5955771299c9826c759d7ad89
+  data.tar.gz: 8aed49647cc53678c60feae466ef554402420ec0df840565af1839cccf96e8cad8bb3ac422f249d87354ac1d091055334df94e21dc7677489de595183b65c4fe

data/lib/chef-cli/cookbook_metadata.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2018 Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/chef-cli/exceptions.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2019 Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -71,6 +71,18 @@ module ChefCLI
   class MissingCookbookLockData < StandardError
   end
 
+  class PolicyfileMissingCookbookMetadata < StandardError
+    def initialize(cookbook_root)
+      super("Policyfile specified to use cookbook metadata, but neither #{cookbook_root}/metadata.rb or #{cookbook_root}/metadata.json was found.")
+    end
+  end
+
+  class PolicyfileBadCookbookMetadata < StandardError
+    def initialize(cookbook_root, e)
+      super("Cookbook metadata for cookbook at #{cookbook_root} could not be parsed:\n    Original Exception: #{e}")
+    end
+  end
+
   class InvalidLockfile < StandardError
   end
 

data/lib/chef-cli/policyfile/dsl.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2019, Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -138,6 +138,21 @@ module ChefCLI
         end
       end
 
+      def metadata
+        cookbook_root = storage_config.relative_paths_root
+        unless File.exist?(File.join(cookbook_root, "metadata.rb")) || File.exist?(File.join(cookbook_root, "metadata.json"))
+          raise PolicyfileMissingCookbookMetadata.new(cookbook_root)
+        end
+
+        begin
+          cookbook_name = CookbookMetadata.from_path(cookbook_root).cookbook_name
+        rescue Exception => e
+          raise PolicyfileBadCookbookMetadata.new(cookbook_root, e)
+        end
+        name cookbook_name if name.nil?
+        cookbook(cookbook_name, path: ".")
+      end
+
       def default
         @node_attributes.default
       end

data/lib/chef-cli/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefCLI
-  VERSION = "5.2.0".freeze
+  VERSION = "5.3.0".freeze
 end

data/spec/unit/cookbook_metadata_spec.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2018 Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -80,6 +80,25 @@ describe ChefCLI::CookbookMetadata do
 
     end
 
+    context "and the cookbook has both a metadata.json and an (invalid) metadata.rb" do
+
+      let(:cookbook_root) { File.join(fixtures_path, "example_cookbook_both_metadata") }
+
+      it "has a name" do
+        expect(cookbook.name).to eq("example_cookbook")
+        expect(cookbook.cookbook_name).to eq("example_cookbook")
+      end
+
+      it "has a version" do
+        expect(cookbook.version).to eq("0.1.0")
+      end
+
+      it "has a map of dependencies" do
+        expect(cookbook.dependencies).to eq({})
+      end
+
+    end
+
     context "and the cookbook has no metadata" do
 
       let(:cookbook_root) { File.join(fixtures_path, "example_cookbook_no_metadata") }

data/spec/unit/fixtures/example_cookbook_both_metadata/.gitignore

@@ -0,0 +1,17 @@
+.vagrant
+Berksfile.lock
+*~
+*#
+.#*
+\#*#
+.*.sw[a-z]
+*.un~
+/cookbooks
+
+# Bundler
+Gemfile.lock
+bin/*
+.bundle/*
+
+.kitchen/
+.kitchen.local.yml

data/spec/unit/fixtures/example_cookbook_both_metadata/.kitchen.yml

@@ -0,0 +1,16 @@
+---
+driver:
+  name: vagrant
+
+provisioner:
+  name: chef_solo
+
+platforms:
+  - name: ubuntu-12.04
+  - name: centos-6.4
+
+suites:
+  - name: default
+    run_list:
+      - recipe[bar::default]
+    attributes:

data/spec/unit/fixtures/example_cookbook_both_metadata/Berksfile

@@ -0,0 +1,3 @@
+source "https://supermarket.getchef.com"
+
+metadata

data/spec/unit/fixtures/example_cookbook_both_metadata/README.md

@@ -0,0 +1,4 @@
+# bar-cookbook
+
+TODO: Enter the cookbook description here.
+

data/spec/unit/fixtures/example_cookbook_both_metadata/chefignore

@@ -0,0 +1,96 @@
+# Put files/directories that should be ignored in this file when uploading
+# or sharing to the community site.
+# Lines that start with '# ' are comments.
+
+# OS generated files #
+######################
+.DS_Store
+Icon?
+nohup.out
+ehthumbs.db
+Thumbs.db
+
+# SASS #
+########
+.sass-cache
+
+# EDITORS #
+###########
+\#*
+.#*
+*~
+*.sw[a-z]
+*.bak
+REVISION
+TAGS*
+tmtags
+*_flymake.*
+*_flymake
+*.tmproj
+.project
+.settings
+mkmf.log
+
+## COMPILED ##
+##############
+a.out
+*.o
+*.pyc
+*.so
+*.com
+*.class
+*.dll
+*.exe
+*/rdoc/
+
+# Testing #
+###########
+.watchr
+.rspec
+spec/*
+spec/fixtures/*
+test/*
+features/*
+Guardfile
+Procfile
+
+# SCM #
+#######
+.git
+*/.git
+.gitignore
+.gitmodules
+.gitconfig
+.gitattributes
+.svn
+*/.bzr/*
+*/.hg/*
+*/.svn/*
+
+# Berkshelf #
+#############
+Berksfile
+Berksfile.lock
+cookbooks/*
+tmp
+
+# Cookbooks #
+#############
+CONTRIBUTING
+CHANGELOG*
+
+# Strainer #
+############
+Colanderfile
+Strainerfile
+.colander
+.strainer
+
+# Vagrant #
+###########
+.vagrant
+Vagrantfile
+
+# Travis #
+##########
+.travis.yml

data/spec/unit/fixtures/example_cookbook_both_metadata/metadata.json

@@ -0,0 +1,5 @@
+{
+  "name": "example_cookbook",
+  "version": "0.1.0"
+}
+

data/spec/unit/fixtures/example_cookbook_both_metadata/metadata.rb

@@ -0,0 +1,9 @@
+# This is vitally important for cookbooks that ship with context-dependent
+# metadata.rb (to do things like auto incrementing semantic versioning) where
+# the metadata.json means the cookbook is 'finalized' and must be authoritative.
+# We need to never try to parse metadata.rb if the metadata.json exists.  It isn't
+# sufficient to simply not use the metadata.rb file, but we must allow the
+# metadata.rb to have an invalid parse due to LoadErrors in the environment where
+# the cookbook is being loaded.
+
+raise "we never want to read the metadata.rb if metadata.json exists"

data/spec/unit/fixtures/example_cookbook_both_metadata/recipes/default.rb

@@ -0,0 +1,8 @@
+#
+# Cookbook Name:: example_cookbook
+# Recipe:: default
+#
+# Copyright (C) 2014 
+#
+# 
+#

data/spec/unit/policyfile_evaluation_spec.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014-2018, Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -555,6 +555,72 @@ describe ChefCLI::PolicyfileCompiler do
 
     end
 
+    describe "the metadata DSL keyword used in a cookbook with metadata" do
+      let(:policyfile_rb) do
+        <<-EOH
+          run_list "foo"
+          metadata
+        EOH
+      end
+      it "reads the metadata from the current cookbook" do
+        expect(File).to receive(:exist?).with("./metadata.rb").and_return(true)
+        expect(ChefCLI::CookbookMetadata).to receive(:from_path).and_return(double(cookbook_name: "foo"))
+        expect(policyfile.errors.size).to eq(0)
+        expect(policyfile.errors.first).to eq(nil)
+      end
+    end
+
+    describe "the metadata DSL keyword used in a cookbook without metadata" do
+      let(:policyfile_rb) do
+        <<-EOH
+          run_list "foo"
+          metadata
+        EOH
+      end
+      it "throws a missing cookbook metadata error" do
+        expected = <<~EOH
+         Evaluation of policyfile 'TestPolicyfile.rb' raised an exception
+           Exception: ChefCLI::PolicyfileMissingCookbookMetadata "Policyfile specified to use cookbook metadata, but neither ./metadata.rb or ./metadata.json was found."
+
+           Relevant Code:
+             2: metadata
+
+           Backtrace:
+             TestPolicyfile.rb:2:in `eval_policyfile'
+        EOH
+        expect(File).to receive(:exist?).with("./metadata.rb").and_return(false)
+        expect(File).to receive(:exist?).with("./metadata.json").and_return(false)
+        expect(policyfile.errors.size).to eq(1)
+        expect(policyfile.errors.first).to eq(expected)
+      end
+    end
+
+    describe "the metadata DSL keyword used in a cookbook with bad metadata" do
+      let(:policyfile_rb) do
+        <<-EOH
+          run_list "foo"
+          metadata
+        EOH
+      end
+      it "throws a bad cookbook metadata error" do
+        expected = <<~EOH
+         Evaluation of policyfile 'TestPolicyfile.rb' raised an exception
+           Exception: ChefCLI::PolicyfileBadCookbookMetadata "Cookbook metadata for cookbook at . could not be parsed:
+             Original Exception: No such file or directory @ rb_sysopen - ./metadata.json"
+
+           Relevant Code:
+             2: metadata
+
+           Backtrace:
+             TestPolicyfile.rb:2:in `eval_policyfile'
+        EOH
+        expect(File).to receive(:exist?).with("./metadata.rb").and_return(true)
+        expect(File).to receive(:exist?).with("./metadata.json").and_return(true)
+        expect(policyfile.errors.size).to eq(1)
+        expect(policyfile.errors.first).to eq(expected)
+      end
+    end
+
     describe "defining attributes" do
 
       let(:policyfile_rb) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-cli
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Chef Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-01 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
@@ -485,6 +485,14 @@ files:
 - spec/unit/fixtures/example_cookbook/chefignore
 - spec/unit/fixtures/example_cookbook/metadata.rb
 - spec/unit/fixtures/example_cookbook/recipes/default.rb
+- spec/unit/fixtures/example_cookbook_both_metadata/.gitignore
+- spec/unit/fixtures/example_cookbook_both_metadata/.kitchen.yml
+- spec/unit/fixtures/example_cookbook_both_metadata/Berksfile
+- spec/unit/fixtures/example_cookbook_both_metadata/README.md
+- spec/unit/fixtures/example_cookbook_both_metadata/chefignore
+- spec/unit/fixtures/example_cookbook_both_metadata/metadata.json
+- spec/unit/fixtures/example_cookbook_both_metadata/metadata.rb
+- spec/unit/fixtures/example_cookbook_both_metadata/recipes/default.rb
 - spec/unit/fixtures/example_cookbook_metadata_json_only/.gitignore
 - spec/unit/fixtures/example_cookbook_metadata_json_only/.kitchen.yml
 - spec/unit/fixtures/example_cookbook_metadata_json_only/Berksfile
@@ -700,6 +708,14 @@ test_files:
 - spec/unit/fixtures/example_cookbook/chefignore
 - spec/unit/fixtures/example_cookbook/metadata.rb
 - spec/unit/fixtures/example_cookbook/recipes/default.rb
+- spec/unit/fixtures/example_cookbook_both_metadata/.gitignore
+- spec/unit/fixtures/example_cookbook_both_metadata/.kitchen.yml
+- spec/unit/fixtures/example_cookbook_both_metadata/Berksfile
+- spec/unit/fixtures/example_cookbook_both_metadata/README.md
+- spec/unit/fixtures/example_cookbook_both_metadata/chefignore
+- spec/unit/fixtures/example_cookbook_both_metadata/metadata.json
+- spec/unit/fixtures/example_cookbook_both_metadata/metadata.rb
+- spec/unit/fixtures/example_cookbook_both_metadata/recipes/default.rb
 - spec/unit/fixtures/example_cookbook_metadata_json_only/.gitignore
 - spec/unit/fixtures/example_cookbook_metadata_json_only/.kitchen.yml
 - spec/unit/fixtures/example_cookbook_metadata_json_only/Berksfile