rspec_helpers.rb

module ChefSpec
  module RSpecHelpers

    def assert_example_generated(cookbook_name, recipe_name)
      check_directory_presence ["#{cookbook_name}/spec"], true
      check_file_presence ["#{cookbook_name}/spec/#{recipe_name}_spec.rb"], true
      check_file_content "#{cookbook_name}/spec/#{recipe_name}_spec.rb",
        "describe '#{cookbook_name}::#{recipe_name}'", true
    end

    def assert_no_examples_run
      run_simple('rspec my_new_cookbook')
      assert_partial_output 'No examples found.', all_output
    end

    def run_examples_successfully
      run_simple 'rspec cookbooks/example/spec/'
      assert_success(true)
      assert_partial_output ', 0 failures', all_output
    end

    def run_examples_unsuccessfully(failure_message)
      run_simple 'rspec cookbooks/example/spec/', false
      assert_success(false)
      assert_partial_output 'No such file or directory', all_output
    end

    def spec_already_exists
      write_file 'cookbooks/my_existing_cookbook/recipes/default.rb', %q{
        execute "print_hello_world" do
          command "echo Hello World!"
          action :run
        end
      }
      write_file 'cookbooks/my_existing_cookbook/spec/default_spec.rb', %q{
        require "chefspec"

        # I am an existing example - please don't overwrite me!
        describe "my_existing_cookbook::default" do
          let(:chef_run) {ChefSpec::ChefRunner.new.converge 'example::default'}
          it "should print hello world" do
            chef_run.should execute_command 'echo Hello World!'
          end
        end
      }
    end

    def spec_example_is_pending?
      run_simple 'rspec my_new_cookbook'
      ["Pending", "my_new_cookbook::default should do something",
        "# Your recipe examples go here.", "1 example, 0 failures, 1 pending"].all? do |content|
        all_output.include? content
      end
    end

    def spec_existing_example_not_overwritten?
      check_file_content "cookbooks/my_existing_cookbook/spec/default_spec.rb",
        "# I am an existing example - please don't overwrite me!", true
    end

    def spec_expects_command
      write_file 'cookbooks/example/spec/default_spec.rb', %q{
        require "chefspec"

        describe "example::default" do
          let(:chef_run) {ChefSpec::ChefRunner.new.converge 'example::default'}
          it "should print hello world" do
            chef_run.should execute_command 'echo Hello World!'
          end
        end
      }
    end

    def spec_expects_directory
      write_file 'cookbooks/example/spec/default_spec.rb', %q{
        require "chefspec"

        describe "example::default" do
          let(:chef_run) {ChefSpec::ChefRunner.new.converge 'example::default'}
          it "should create the directory" do
            chef_run.should create_directory 'foo'
          end
        end
      }
    end

    def spec_expects_directory_to_be_deleted
      write_file 'cookbooks/example/spec/default_spec.rb', %q{
        require "chefspec"

        describe "example::default" do
          let(:chef_run) {ChefSpec::ChefRunner.new.converge 'example::default'}
          it "should delete the directory" do
            chef_run.should delete_directory 'foo'
          end
        end
      }
    end

    def spec_expects_directory_with_ownership
      write_file 'cookbooks/example/spec/default_spec.rb', %q{
        require "chefspec"

        describe "example::default" do
          let(:chef_run) {ChefSpec::ChefRunner.new.converge 'example::default'}
          it "should set directory ownership" do
            chef_run.directory('foo').should be_owned_by('user', 'group')
          end
        end
      }
    end

    def spec_expects_file(resource_type, path = 'hello-world.txt')
      write_file 'cookbooks/example/spec/default_spec.rb', %Q{
        require "chefspec"

        describe "example::default" do
          let(:chef_run) {ChefSpec::ChefRunner.new.converge 'example::default'}
          it "should create hello-world.txt" do
            chef_run.should create_#{resource_type.to_s} '#{path}'
          end
        end
      }
    end

    def spec_expects_file_to_be_deleted
      write_file 'cookbooks/example/spec/default_spec.rb', %q{
        require "chefspec"

        describe "example::default" do
          let(:chef_run) {ChefSpec::ChefRunner.new.converge 'example::default'}
          it "should delete hello-world.txt" do
            chef_run.should delete_file 'hello-world.txt'
          end
        end
      }
    end

    def spec_expects_file_with_content
      write_file 'cookbooks/example/spec/default_spec.rb', %q{
        require "chefspec"

        describe "example::default" do
          let(:chef_run) {ChefSpec::ChefRunner.new.converge 'example::default'}
          it "should create hello-world.txt" do
            chef_run.should create_file_with_content 'hello-world.txt', 'hello world'
          end
        end
      }
    end

    def spec_expects_file_with_rendered_content
      write_file 'cookbooks/example/spec/default_spec.rb', %q{
        require "chefspec"

        describe "example::default" do
          let(:chef_run) {ChefSpec::ChefRunner.new.converge 'example::default'}
          it "should create a file with the node platform" do
            expected_content = <<-EOF.gsub /^\s*/, ''
              # Config file generated by Chef
              platform: chefspec
            EOF
            chef_run.should create_file_with_content('/etc/config_file', expected_content)
          end
        end
      }
    end

    def spec_expects_file_with_ownership(resource_type)
      write_file 'cookbooks/example/spec/default_spec.rb', %Q{
        require "chefspec"

        describe "example::default" do
          let(:chef_run) { ChefSpec::ChefRunner.new.converge 'example::default' }
          it "should set file ownership" do
            chef_run.#{resource_type.to_s}('hello-world.txt').should be_owned_by('user', 'group')
          end
        end
      }
    end

    def spec_expects_gem_action(action)
      write_file 'cookbooks/example/spec/default_spec.rb', %Q{
        require "chefspec"

        describe "example::default" do
          let (:chef_run) { ChefSpec::ChefRunner.new.converge 'example::default' }
          it "should #{action.to_s} package_does_not_exist" do
            chef_run.should #{action.to_s}_gem_package 'gem_package_does_not_exist'
          end
        end
      }
    end

    def spec_expects_gem_at_specific_version
      write_file 'cookbooks/example/spec/default_spec.rb', %q{
        require "chefspec"

        describe "example::default" do
          let (:chef_run) {ChefSpec::ChefRunner.new.converge 'example::default'}
          it "should install gem_package_does_not_exist at a specific version" do
            chef_run.should install_gem_package_at_version 'gem_package_does_not_exist', '1.2.3'
          end
        end
      }
    end

    def spec_expects_package_action(action)
      write_file 'cookbooks/example/spec/default_spec.rb', %Q{
        require "chefspec"

        describe "example::default" do
          let (:chef_run) { ChefSpec::ChefRunner.new.converge 'example::default' }
          it "should #{action.to_s} package_does_not_exist" do
            chef_run.should #{action.to_s}_package 'package_does_not_exist'
          end
        end
      }
    end

    def spec_expects_package_at_specific_version
      write_file 'cookbooks/example/spec/default_spec.rb', %q{
        require "chefspec"

        describe "example::default" do
          let (:chef_run) {ChefSpec::ChefRunner.new.converge 'example::default'}
          it "should install package_does_not_exist at a specific version" do
            chef_run.should install_package_at_version 'package_does_not_exist', '1.2.3'
          end
        end
      }
    end

    def spec_expects_service_action(action)
      write_file 'cookbooks/example/spec/default_spec.rb', %Q{
        require "chefspec"

        describe "example::default" do
          let(:chef_run) { ChefSpec::ChefRunner.new.converge 'example::default' }
          it "should #{action.to_s} the food service" do
            chef_run.should #{action.to_s}_service 'food'
          end
        end
      }
    end

    def spec_expects_service_to_be_started_and_enabled
      write_file 'cookbooks/example/spec/default_spec.rb', %q{
        require "chefspec"

        describe "example::default" do
          let(:chef_run) { ChefSpec::ChefRunner.new.converge 'example::default' }
          it "should ensure the food service is started and enabled" do
            chef_run.should start_service 'food'
            chef_run.should set_service_to_start_on_boot 'food'
          end
        end
      }
    end

    def spec_generate_examples(type)
      run_simple("knife cookbook create_specs -o . my_#{type.to_s}_cookbook")
      assert_success(true)
    end

    def spec_overrides_operating_system(operating_system)
      @operating_system = operating_system
      write_file 'cookbooks/example/spec/default_spec.rb', %Q{
        require "chefspec"

        describe "example::default" do
          let(:chef_run) { ChefSpec::ChefRunner.new(:log_level => :debug) }
          it "should log the node platform" do
            chef_run.node.automatic_attrs[:platform] = '#{operating_system}'
            chef_run.converge('example::default').should log 'I am running on the #{operating_system} platform.'
          end
        end
      }
    end

    def spec_sets_node_attribute
      write_file 'cookbooks/example/spec/default_spec.rb', %q{
        require "chefspec"

        describe "example::default" do
          let(:chef_run) do
            ChefSpec::ChefRunner.new(:log_level => :debug) do |node|
              node.foo = 'bar'
            end.converge 'example::default'
          end
          it "should log the node foo" do
            chef_run.should log "The value of node.foo is: bar"
          end
        end
      }
    end

  end
end