summaryrefslogtreecommitdiff
path: root/spec
diff options
context:
space:
mode:
authordanielsdeleo <dan@getchef.com>2014-08-07 16:32:02 -0700
committerdanielsdeleo <dan@getchef.com>2014-08-12 11:03:10 -0700
commit2577c6f8f503dd6484ca656c9b3780c52cc6e038 (patch)
treef6f53cb2ac2d03305c9ca849e30cecb99303b0c9 /spec
parent89427a59886b0724a5a1101dde7ea1a1def1c67a (diff)
downloadchef-2577c6f8f503dd6484ca656c9b3780c52cc6e038.tar.gz
Make `name` a required attribute in metadata
Diffstat (limited to 'spec')
-rw-r--r--spec/data/cookbooks/angrybash/metadata.rb2
-rw-r--r--spec/data/cookbooks/apache2/metadata.rb2
-rw-r--r--spec/data/cookbooks/borken/metadata.rb2
-rw-r--r--spec/data/cookbooks/ignorken/metadata.rb2
-rw-r--r--spec/data/cookbooks/java/metadata.rb2
-rw-r--r--spec/data/cookbooks/preseed/metadata.rb2
-rw-r--r--spec/data/incomplete-metadata-chef-repo/incomplete-metadata/README.md4
-rw-r--r--spec/data/incomplete-metadata-chef-repo/incomplete-metadata/metadata.rb13
-rw-r--r--spec/data/incomplete-metadata-chef-repo/incomplete-metadata/recipes/default.rb8
-rw-r--r--spec/unit/cookbook/cookbook_version_loader_spec.rb39
-rw-r--r--spec/unit/cookbook/syntax_check_spec.rb5
11 files changed, 78 insertions, 3 deletions
diff --git a/spec/data/cookbooks/angrybash/metadata.rb b/spec/data/cookbooks/angrybash/metadata.rb
new file mode 100644
index 0000000000..720b8085be
--- /dev/null
+++ b/spec/data/cookbooks/angrybash/metadata.rb
@@ -0,0 +1,2 @@
+name "angrybash"
+version "1.0.0"
diff --git a/spec/data/cookbooks/apache2/metadata.rb b/spec/data/cookbooks/apache2/metadata.rb
new file mode 100644
index 0000000000..1273d20d79
--- /dev/null
+++ b/spec/data/cookbooks/apache2/metadata.rb
@@ -0,0 +1,2 @@
+name "apache2"
+version "0.0.1"
diff --git a/spec/data/cookbooks/borken/metadata.rb b/spec/data/cookbooks/borken/metadata.rb
new file mode 100644
index 0000000000..58700b2d8e
--- /dev/null
+++ b/spec/data/cookbooks/borken/metadata.rb
@@ -0,0 +1,2 @@
+name "borken"
+version "1.0.0"
diff --git a/spec/data/cookbooks/ignorken/metadata.rb b/spec/data/cookbooks/ignorken/metadata.rb
new file mode 100644
index 0000000000..f91d92de32
--- /dev/null
+++ b/spec/data/cookbooks/ignorken/metadata.rb
@@ -0,0 +1,2 @@
+name "ignorken"
+version "1.0.0"
diff --git a/spec/data/cookbooks/java/metadata.rb b/spec/data/cookbooks/java/metadata.rb
new file mode 100644
index 0000000000..7c5585304c
--- /dev/null
+++ b/spec/data/cookbooks/java/metadata.rb
@@ -0,0 +1,2 @@
+name "java"
+version "0.0.1"
diff --git a/spec/data/cookbooks/preseed/metadata.rb b/spec/data/cookbooks/preseed/metadata.rb
new file mode 100644
index 0000000000..a48deec08b
--- /dev/null
+++ b/spec/data/cookbooks/preseed/metadata.rb
@@ -0,0 +1,2 @@
+name "preseed"
+version "1.0.0"
diff --git a/spec/data/incomplete-metadata-chef-repo/incomplete-metadata/README.md b/spec/data/incomplete-metadata-chef-repo/incomplete-metadata/README.md
new file mode 100644
index 0000000000..3ac2a4f90c
--- /dev/null
+++ b/spec/data/incomplete-metadata-chef-repo/incomplete-metadata/README.md
@@ -0,0 +1,4 @@
+# incomplete-metadata
+
+TODO: Enter the cookbook description here.
+
diff --git a/spec/data/incomplete-metadata-chef-repo/incomplete-metadata/metadata.rb b/spec/data/incomplete-metadata-chef-repo/incomplete-metadata/metadata.rb
new file mode 100644
index 0000000000..50284be3dd
--- /dev/null
+++ b/spec/data/incomplete-metadata-chef-repo/incomplete-metadata/metadata.rb
@@ -0,0 +1,13 @@
+# ## INCOMPLETE METADATA ##
+# This cookbook is invalid b/c it does not set the `name' of the cookbook.
+
+# Commented out for illustrative purposes
+# name 'incomplete-metadata'
+
+maintainer ''
+maintainer_email ''
+license ''
+description 'Installs/Configures incomplete-metadata'
+long_description 'Installs/Configures incomplete-metadata'
+version '0.1.0'
+
diff --git a/spec/data/incomplete-metadata-chef-repo/incomplete-metadata/recipes/default.rb b/spec/data/incomplete-metadata-chef-repo/incomplete-metadata/recipes/default.rb
new file mode 100644
index 0000000000..65ae049ce8
--- /dev/null
+++ b/spec/data/incomplete-metadata-chef-repo/incomplete-metadata/recipes/default.rb
@@ -0,0 +1,8 @@
+#
+# Cookbook Name:: incomplete-metadata
+# Recipe:: default
+#
+# Copyright (C) 2014
+#
+#
+#
diff --git a/spec/unit/cookbook/cookbook_version_loader_spec.rb b/spec/unit/cookbook/cookbook_version_loader_spec.rb
index c8292de762..ad10f24573 100644
--- a/spec/unit/cookbook/cookbook_version_loader_spec.rb
+++ b/spec/unit/cookbook/cookbook_version_loader_spec.rb
@@ -108,7 +108,7 @@ describe Chef::Cookbook::CookbookVersionLoader do
end
- context "when a cookbook has an invalid metadata file [CHEF-2923]" do
+ context "when a cookbook has a metadata file with a ruby error [CHEF-2923]" do
let(:cookbook_path) { File.join(CHEF_SPEC_DATA, "invalid-metadata-chef-repo/invalid-metadata") }
@@ -136,6 +136,43 @@ describe Chef::Cookbook::CookbookVersionLoader do
end
+ context "when a cookbook has a metadata file with invalid metadata" do
+
+ let(:cookbook_path) { File.join(CHEF_SPEC_DATA, "incomplete-metadata-chef-repo/incomplete-metadata") }
+
+ let(:error_message) do
+ "Cookbook loaded at path(s) [#{cookbook_path}] has invalid metadata: The `name' attribute is required in cookbook metadata"
+ end
+
+ it "raises an error when loading with #load!" do
+ expect { cookbook_loader.load! }.to raise_error(Chef::Exceptions::MetadataNotValid, error_message)
+ end
+
+ it "raises an error when called with #load" do
+ expect { cookbook_loader.load }.to raise_error(Chef::Exceptions::MetadataNotValid, error_message)
+ end
+
+ it "uses the inferred cookbook name [CHEF-2923]" do
+ # This behavior is intended to support the CHEF-2923 feature where
+ # invalid metadata doesn't prevent you from uploading other cookbooks.
+ #
+ # The metadata is the definitive source of the cookbook name, but if
+ # the metadata is incomplete/invalid, we can't read the name from it.
+ #
+ # The CookbookLoader stores CookbookVersionLoaders in a Hash with
+ # cookbook names as the keys, and finds the loader in this Hash to call
+ # #load on it when the user runs a command like `knife cookbook upload specific-cookbook`
+ #
+ # Most of the time this will work, but if the user tries to upload a
+ # specific cookbook by name, has customized that cookbook's name (so it
+ # doesn't match the inferred name), and that metadata file has a syntax
+ # error, we might report a "cookbook not found" error instead of the
+ # metadata syntax error that is the actual cause.
+ expect(cookbook_loader.cookbook_name).to eq(:"incomplete-metadata")
+ end
+
+ end
+
end
end
diff --git a/spec/unit/cookbook/syntax_check_spec.rb b/spec/unit/cookbook/syntax_check_spec.rb
index 7f7a914115..b83bffe1c9 100644
--- a/spec/unit/cookbook/syntax_check_spec.rb
+++ b/spec/unit/cookbook/syntax_check_spec.rb
@@ -147,7 +147,8 @@ describe Chef::Cookbook::SyntaxCheck do
it "does not remove the invalid file from the list of untested files" do
syntax_check.untested_ruby_files.should include(File.join(cookbook_path, 'recipes', 'default.rb'))
- lambda { syntax_check.validate_ruby_files }.should_not change(syntax_check, :untested_ruby_files)
+ syntax_check.validate_ruby_files
+ syntax_check.untested_ruby_files.should include(File.join(cookbook_path, 'recipes', 'default.rb'))
end
it "indicates that a template file has a syntax error" do
@@ -166,7 +167,7 @@ describe Chef::Cookbook::SyntaxCheck do
cookbook_path = File.join(CHEF_SPEC_DATA, 'cookbooks', 'ignorken')
Chef::Config[:cookbook_path] = File.dirname(cookbook_path)
syntax_check.cookbook_path.replace(cookbook_path)
- @ruby_files = [File.join(cookbook_path, 'recipes/default.rb')]
+ @ruby_files = [File.join(cookbook_path, 'metadata.rb'), File.join(cookbook_path, 'recipes/default.rb')]
end
it "shows that ignored ruby files do not require a syntax check" do