Skip to content

Commit

Permalink
Load cookbook versions correctly for knife
Browse files Browse the repository at this point in the history 
Fixes chef#4934

Signed-off-by: Thom May <thom@may.lt>
  • Loading branch information
Thom May committed May 16, 2016
1 parent fb6e8bd commit 949c563
Show file tree
Hide file tree
Showing 2 changed files with 95 additions and 100 deletions.
16 changes: 6 additions & 10 deletions lib/chef/knife/cookbook_show.rb
View file
Expand Up @@ -51,6 +51,10 @@ class CookbookShow < Knife
:description => "Show corresponding URIs"

def run
cookbook_name, cookbook_version, segment, filename = @name_args

cookbook = Chef::CookbookVersion.load(cookbook_name, cookbook_version) unless cookbook_version.nil?

case @name_args.length
when 4 # We are showing a specific file
node = Hash.new
Expand All @@ -64,10 +68,6 @@ def attribute?(name)
end
end

cookbook_name, segment, filename = @name_args[0], @name_args[2], @name_args[3]
cookbook_version = @name_args[1] == "latest" ? "_latest" : @name_args[1]

cookbook = rest.get("cookbooks/#{cookbook_name}/#{cookbook_version}")
manifest_entry = cookbook.preferred_manifest_record(node, segment, filename)
temp_file = rest.streaming_request(manifest_entry[:url])

Expand All @@ -76,14 +76,10 @@ def attribute?(name)
pretty_print(temp_file.read)

when 3 # We are showing a specific part of the cookbook
cookbook_version = @name_args[1] == "latest" ? "_latest" : @name_args[1]
result = rest.get("cookbooks/#{@name_args[0]}/#{cookbook_version}")
output(result.manifest[@name_args[2]])
output(cookbook.manifest[segment])
when 2 # We are showing the whole cookbook data
cookbook_version = @name_args[1] == "latest" ? "_latest" : @name_args[1]
output(rest.get("cookbooks/#{@name_args[0]}/#{cookbook_version}"))
output(cookbook)
when 1 # We are showing the cookbook versions (all of them)
cookbook_name = @name_args[0]
env = config[:environment]
api_endpoint = env ? "environments/#{env}/cookbooks/#{cookbook_name}" : "cookbooks/#{cookbook_name}"
output(format_cookbook_list_for_display(rest.get(api_endpoint)))
Expand Down
179 changes: 89 additions & 90 deletions spec/unit/knife/cookbook_show_spec.rb
View file
Expand Up @@ -20,30 +20,57 @@
require "spec_helper"

describe Chef::Knife::CookbookShow do
before(:each) do
before do
Chef::Config[:node_name] = "webmonkey.example.com"
@knife = Chef::Knife::CookbookShow.new
@knife.config = {}
@knife.name_args = [ "cookbook_name" ]
@rest = double(Chef::ServerAPI)
allow(@knife).to receive(:rest).and_return(@rest)
allow(@knife).to receive(:pretty_print).and_return(true)
allow(@knife).to receive(:output).and_return(true)
allow(knife).to receive(:rest).and_return(rest)
allow(knife).to receive(:pretty_print).and_return(true)
allow(knife).to receive(:output).and_return(true)
allow(Chef::CookbookVersion).to receive(:load).and_return(cb)
end

let (:knife) do
knife = Chef::Knife::CookbookShow.new
knife.config = {}
knife.name_args = [ "cookbook_name" ]
knife
end

let (:cb) do
cb = Chef::CookbookVersion.new("cookbook_name")
cb.manifest = manifest
cb
end

let (:rest) { double(Chef::ServerAPI) }

let (:content) { "Example recipe text" }

let (:manifest) do
{
"recipes" => [
{
:name => "default.rb",
:path => "recipes/default.rb",
:checksum => "1234",
:url => "http://example.org/files/default.rb",
},
],
}
end

describe "run" do
describe "with 0 arguments: help" do
it "should should print usage and exit when given no arguments" do
@knife.name_args = []
expect(@knife).to receive(:show_usage)
expect(@knife.ui).to receive(:fatal)
expect { @knife.run }.to raise_error(SystemExit)
knife.name_args = []
expect(knife).to receive(:show_usage)
expect(knife.ui).to receive(:fatal)
expect { knife.run }.to raise_error(SystemExit)
end
end

describe "with 1 argument: versions" do
before(:each) do
@response = {
let (:response) do
{
"cookbook_name" => {
"url" => "http://url/cookbooks/cookbook_name",
"versions" => [
Expand All @@ -56,87 +83,60 @@
end

it "should show the raw cookbook data" do
expect(@rest).to receive(:get).with("cookbooks/cookbook_name").and_return(@response)
expect(@knife).to receive(:format_cookbook_list_for_display).with(@response)
@knife.run
expect(rest).to receive(:get).with("cookbooks/cookbook_name").and_return(response)
expect(knife).to receive(:format_cookbook_list_for_display).with(response)
knife.run
end

it "should respect the user-supplied environment" do
@knife.config[:environment] = "foo"
expect(@rest).to receive(:get).with("environments/foo/cookbooks/cookbook_name").and_return(@response)
expect(@knife).to receive(:format_cookbook_list_for_display).with(@response)
@knife.run
knife.config[:environment] = "foo"
expect(rest).to receive(:get).with("environments/foo/cookbooks/cookbook_name").and_return(response)
expect(knife).to receive(:format_cookbook_list_for_display).with(response)
knife.run
end
end

describe "with 2 arguments: name and version" do
before(:each) do
@knife.name_args << "0.1.0"
@response = { "0.1.0" => { "recipes" => { "default.rb" => "" } } }
before do
knife.name_args << "0.1.0"
end

it "should show the specific part of a cookbook" do
expect(@rest).to receive(:get).with("cookbooks/cookbook_name/0.1.0").and_return(@response)
expect(@knife).to receive(:output).with(@response)
@knife.run
expect(Chef::CookbookVersion).to receive(:load).with("cookbook_name", "0.1.0").and_return(cb)
expect(knife).to receive(:output).with(cb)
knife.run
end
end

describe "with 3 arguments: name, version, and segment" do
before(:each) do
@knife.name_args = [ "cookbook_name", "0.1.0", "recipes" ]
@cookbook_response = Chef::CookbookVersion.new("cookbook_name")
@manifest = {
"recipes" => [
{
:name => "default.rb",
:path => "recipes/default.rb",
:checksum => "1234",
:url => "http://example.org/files/default.rb",
},
],
}
@cookbook_response.manifest = @manifest
@response = { "name" => "default.rb", "url" => "http://example.org/files/default.rb", "checksum" => "1234", "path" => "recipes/default.rb" }
knife.name_args = [ "cookbook_name", "0.1.0", "recipes" ]
end

it "should print the json of the part" do
expect(@rest).to receive(:get).with("cookbooks/cookbook_name/0.1.0").and_return(@cookbook_response)
expect(@knife).to receive(:output).with(@cookbook_response.manifest["recipes"])
@knife.run
expect(Chef::CookbookVersion).to receive(:load).with("cookbook_name", "0.1.0").and_return(cb)
expect(knife).to receive(:output).with(cb.manifest["recipes"])
knife.run
end
end

describe "with 4 arguments: name, version, segment and filename" do
before(:each) do
@knife.name_args = [ "cookbook_name", "0.1.0", "recipes", "default.rb" ]
@cookbook_response = Chef::CookbookVersion.new("cookbook_name")
@cookbook_response.manifest = {
"recipes" => [
{
:name => "default.rb",
:path => "recipes/default.rb",
:checksum => "1234",
:url => "http://example.org/files/default.rb",
},
],
}
@response = "Example recipe text"
knife.name_args = [ "cookbook_name", "0.1.0", "recipes", "default.rb" ]
end

it "should print the raw result of the request (likely a file!)" do
expect(@rest).to receive(:get).with("cookbooks/cookbook_name/0.1.0").and_return(@cookbook_response)
expect(@rest).to receive(:streaming_request).with("http://example.org/files/default.rb").and_return(StringIO.new(@response))
expect(@knife).to receive(:pretty_print).with(@response)
@knife.run
expect(Chef::CookbookVersion).to receive(:load).with("cookbook_name", "0.1.0").and_return(cb)
expect(rest).to receive(:streaming_request).with("http://example.org/files/default.rb").and_return(StringIO.new(content))
expect(knife).to receive(:pretty_print).with(content)
knife.run
end
end

describe "with 4 arguments: name, version, segment and filename -- with specificity" do
before(:each) do
@knife.name_args = [ "cookbook_name", "0.1.0", "files", "afile.rb" ]
@cookbook_response = Chef::CookbookVersion.new("cookbook_name")
@cookbook_response.manifest = {
knife.name_args = [ "cookbook_name", "0.1.0", "files", "afile.rb" ]
cb.manifest = {
"files" => [
{
:name => "afile.rb",
Expand Down Expand Up @@ -169,51 +169,50 @@
],
}

@response = "Example recipe text"
end

describe "with --fqdn" do
it "should pass the fqdn" do
@knife.config[:platform] = "example_platform"
@knife.config[:platform_version] = "1.0"
@knife.config[:fqdn] = "examplehost.example.org"
expect(@rest).to receive(:get).with("cookbooks/cookbook_name/0.1.0").and_return(@cookbook_response)
expect(@rest).to receive(:streaming_request).with("http://example.org/files/1111").and_return(StringIO.new(@response))
expect(@knife).to receive(:pretty_print).with(@response)
@knife.run
knife.config[:platform] = "example_platform"
knife.config[:platform_version] = "1.0"
knife.config[:fqdn] = "examplehost.example.org"
expect(Chef::CookbookVersion).to receive(:load).with("cookbook_name", "0.1.0").and_return(cb)
expect(rest).to receive(:streaming_request).with("http://example.org/files/1111").and_return(StringIO.new(content))
expect(knife).to receive(:pretty_print).with(content)
knife.run
end
end

describe "and --platform" do
it "should pass the platform" do
@knife.config[:platform] = "ubuntu"
@knife.config[:platform_version] = "1.0"
@knife.config[:fqdn] = "differenthost.example.org"
expect(@rest).to receive(:get).with("cookbooks/cookbook_name/0.1.0").and_return(@cookbook_response)
expect(@rest).to receive(:streaming_request).with("http://example.org/files/3333").and_return(StringIO.new(@response))
expect(@knife).to receive(:pretty_print).with(@response)
@knife.run
knife.config[:platform] = "ubuntu"
knife.config[:platform_version] = "1.0"
knife.config[:fqdn] = "differenthost.example.org"
expect(Chef::CookbookVersion).to receive(:load).with("cookbook_name", "0.1.0").and_return(cb)
expect(rest).to receive(:streaming_request).with("http://example.org/files/3333").and_return(StringIO.new(content))
expect(knife).to receive(:pretty_print).with(content)
knife.run
end
end

describe "and --platform-version" do
it "should pass the platform" do
@knife.config[:platform] = "ubuntu"
@knife.config[:platform_version] = "9.10"
@knife.config[:fqdn] = "differenthost.example.org"
expect(@rest).to receive(:get).with("cookbooks/cookbook_name/0.1.0").and_return(@cookbook_response)
expect(@rest).to receive(:streaming_request).with("http://example.org/files/2222").and_return(StringIO.new(@response))
expect(@knife).to receive(:pretty_print).with(@response)
@knife.run
knife.config[:platform] = "ubuntu"
knife.config[:platform_version] = "9.10"
knife.config[:fqdn] = "differenthost.example.org"
expect(Chef::CookbookVersion).to receive(:load).with("cookbook_name", "0.1.0").and_return(cb)
expect(rest).to receive(:streaming_request).with("http://example.org/files/2222").and_return(StringIO.new(content))
expect(knife).to receive(:pretty_print).with(content)
knife.run
end
end

describe "with none of the arguments, it should use the default" do
it "should pass them all" do
expect(@rest).to receive(:get).with("cookbooks/cookbook_name/0.1.0").and_return(@cookbook_response)
expect(@rest).to receive(:streaming_request).with("http://example.org/files/4444").and_return(StringIO.new(@response))
expect(@knife).to receive(:pretty_print).with(@response)
@knife.run
expect(Chef::CookbookVersion).to receive(:load).with("cookbook_name", "0.1.0").and_return(cb)
expect(rest).to receive(:streaming_request).with("http://example.org/files/4444").and_return(StringIO.new(content))
expect(knife).to receive(:pretty_print).with(content)
knife.run
end
end

Expand Down

0 comments on commit 949c563

Please sign in to comment.