environments_controller_spec.rb

#
# Author:: Tim Hinderliter (<tim@opscode.com>)
# Copyright:: Copyright (c) 2011 Opscode, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
require File.expand_path(File.dirname(__FILE__) + '/../spec_model_helper')
require 'chef/node'
require 'pp'

describe "Environments controller" do
  before do
    Merb.logger.set_log(StringIO.new)

    @env1 = make_environment("env1")

    @filtered_cookbook_list_env1 = make_filtered_cookbook_hash(make_cookbook("cookbook1", "1.0.0"),
                                                               make_cookbook("cookbook2", "1.0.0"))
    @filtered_cookbook_list_env1["cookbook_noversions"] = Array.new

    @filtered_cookbook_list_env2 = make_filtered_cookbook_hash(make_cookbook("cookbook1", "2.0.0"),
                                                               make_cookbook("cookbook2", "2.0.0"))

    @filtered_cookbook_list_env_many_versions = make_filtered_cookbook_hash(make_cookbook("cookbook1", "1.0.0"),
                                                                            make_cookbook("cookbook1", "2.0.0"),
                                                                            make_cookbook("cookbook1", "3.0.0"),
                                                                            make_cookbook("cookbook1", "4.0.0"))

    @cookbook_deps_on_nosuch = make_cookbook("cookbook_deps_on_nosuch", "1.0.0")
    @cookbook_deps_on_nosuch.metadata.depends("cookbook_nosuch")

    @cookbook_deps_on_badver = make_cookbook("cookbook_deps_on_badver", "1.0.0")
    @cookbook_deps_on_badver.metadata.depends("cookbook1", ">= 3.0.0")
  end

  describe "when handling Environments API calls" do
    it "should expand the passed-in run_list using the correct environment: one run_list item" do

      # Env1 pins both versions at 1.0.0. Expect only the one we ask for, cookbook1,
      # back in the result.
      Chef::Environment.should_receive(:cdb_load_filtered_cookbook_versions).with("env1", nil).and_return(@filtered_cookbook_list_env1)
      response = post_json("/environments/env1/cookbook_versions", {"run_list" => ["recipe[cookbook1]"]})
      response.should be_kind_of(Hash)
      response.keys.size.should == 1
      response["cookbook1"].should_not == nil
      response["cookbook1"]['version'].should == "1.0.0"
    end

    it "should expect the passed-in run_list using the correct environment: two run_list items" do
      # Ask for both cookbook1 and cookbook2 back. Expect version 2.0.0 for
      # each, as those are what's appropriate for the environment.
      Chef::Environment.should_receive(:cdb_load_filtered_cookbook_versions).with("env2", nil).and_return(@filtered_cookbook_list_env2)
      response = post_json("/environments/env2/cookbook_versions", {"run_list" => ["recipe[cookbook2]", "recipe[cookbook1]"]})
      response.should be_kind_of(Hash)
      response.keys.size.should == 2
      response["cookbook1"].should_not == nil
      response["cookbook1"]['version'].should == "2.0.0"
      response["cookbook2"].should_not == nil
      response["cookbook2"]['version'].should == "2.0.0"
    end

    it "should return the newest version of a cookbook when given multiple versions" do
      Chef::Environment.should_receive(:cdb_load_filtered_cookbook_versions).with("env_many_versions", nil).and_return(@filtered_cookbook_list_env_many_versions)
      response = post_json("/environments/env_many_versions/cookbook_versions", {"run_list" => ["recipe[cookbook1]"]})

      response.should be_kind_of(Hash)
      response.keys.size.should == 1
      response["cookbook1"].should_not == nil
      response["cookbook1"]['version'].should == "4.0.0"
    end

    it "should return the asked-for, older version of a cookbook if the version is specified in the run_list" do
      Chef::Environment.should_receive(:cdb_load_filtered_cookbook_versions).with("env_many_versions", nil).and_return(@filtered_cookbook_list_env_many_versions)
      response = post_json("/environments/env_many_versions/cookbook_versions", {"run_list" => ["recipe[cookbook1@1.0.0]"]})

      response.should be_kind_of(Hash)
      response.keys.size.should == 1
      response["cookbook1"].should_not == nil
      response["cookbook1"]['version'].should == "1.0.0"
    end

    it "should report no_such_cookbook if given a dependency on a non-existant cookbook" do
      Chef::Environment.should_receive(:cdb_load_filtered_cookbook_versions).with("env1", nil).and_return(@filtered_cookbook_list_env1)
      expected_error = {
        "message" => "Run list contains invalid items: no such cookbook cookbook_nosuch.",
        "non_existent_cookbooks" => ["cookbook_nosuch"],
        "cookbooks_with_no_versions" => []
      }.to_json

      lambda {
        response = post_json("/environments/env1/cookbook_versions", {"run_list" => ["recipe[cookbook_nosuch]"]})
      }.should raise_error(Merb::ControllerExceptions::PreconditionFailed, expected_error)
    end

    it "should report no_such_version if given a dependency on a cookbook that doesn't have any valid versions for an environment" do
      Chef::Environment.should_receive(:cdb_load_filtered_cookbook_versions).with("env1", nil).and_return(@filtered_cookbook_list_env1)
      expected_error = {
        "message" => "Run list contains invalid items: no versions match the constraints on cookbook cookbook_noversions.",
        "non_existent_cookbooks" => [],
        "cookbooks_with_no_versions" => ["cookbook_noversions"]
      }.to_json

      lambda {
        response = post_json("/environments/env1/cookbook_versions", {"run_list" => ["recipe[cookbook_noversions]"]})
      }.should raise_error(Merb::ControllerExceptions::PreconditionFailed, expected_error)
    end

    # TODO; have top-level cookbooks depend on other, non-existent cookbooks,
    # to get the other kind of exceptions.
    it "should report multiple failures (compound exceptions) if there is more than one error in dependencies" do
      Chef::Environment.should_receive(:cdb_load_filtered_cookbook_versions).with("env1", nil).and_return(@filtered_cookbook_list_env1)

      expected_error = {
        "message" => "Run list contains invalid items: no such cookbooks cookbook_nosuch_1, cookbook_nosuch_2; no versions match the constraints on cookbook cookbook_noversions.",
        "non_existent_cookbooks" => ["cookbook_nosuch_1", "cookbook_nosuch_2"],
        "cookbooks_with_no_versions" => ["cookbook_noversions"]
      }.to_json

      lambda {
        response = post_json("/environments/env1/cookbook_versions",
                             {"run_list" => ["recipe[cookbook_nosuch_1]", "recipe[cookbook_nosuch_2]", "recipe[cookbook_noversions]"]})
      }.should raise_error(Merb::ControllerExceptions::PreconditionFailed, expected_error)
    end
  end
end