puppet 2.6.18 → 2.7.1

data/spec/shared_behaviours/things_that_declare_options.rb

@@ -0,0 +1,150 @@
+# encoding: UTF-8
+shared_examples_for "things that declare options" do
+  it "should support options without arguments" do
+    thing = add_options_to { option "--bar" }
+    thing.should be_option :bar
+  end
+
+  it "should support options with an empty block" do
+    thing = add_options_to do
+      option "--foo" do
+        # this section deliberately left blank
+      end
+    end
+    thing.should be
+    thing.should be_option :foo
+  end
+
+  { "--foo=" => :foo }.each do |input, option|
+    it "should accept #{name.inspect}" do
+      thing = add_options_to { option input }
+      thing.should be_option option
+    end
+  end
+
+  it "should support option documentation" do
+    text = "Sturm und Drang (German pronunciation: [ˈʃtʊʁm ʊnt ˈdʁaŋ]) …"
+
+    thing = add_options_to do
+      option "--foo" do
+        desc text
+        description text
+        summary text
+      end
+    end
+
+    thing.get_option(:foo).desc.should == text
+  end
+
+  it "should list all the options" do
+    thing = add_options_to do
+      option "--foo"
+      option "--bar", '-b'
+      option "-q", "--quux"
+      option "-f"
+      option "--baz"
+    end
+    thing.options.should == [:foo, :bar, :b, :q, :quux, :f, :baz]
+  end
+
+  it "should detect conflicts in long options" do
+    expect {
+      add_options_to do
+        option "--foo"
+        option "--foo"
+      end
+    }.should raise_error ArgumentError, /Option foo conflicts with existing option foo/i
+  end
+
+  it "should detect conflicts in short options" do
+    expect {
+      add_options_to do
+        option "-f"
+        option "-f"
+      end
+    }.should raise_error ArgumentError, /Option f conflicts with existing option f/
+  end
+
+  ["-f", "--foo"].each do |option|
+    ["", " FOO", "=FOO", " [FOO]", "=[FOO]"].each do |argument|
+      input = option + argument
+      it "should detect conflicts within a single option like #{input.inspect}" do
+        expect {
+          add_options_to do
+            option input, input
+          end
+        }.should raise_error ArgumentError, /duplicates existing alias/
+      end
+    end
+  end
+
+
+  # Verify the range of interesting conflicts to check for ordering causing
+  # the behaviour to change, or anything exciting like that.
+  [ %w{--foo}, %w{-f}, %w{-f --foo}, %w{--baz -f},
+    %w{-f --baz}, %w{-b --foo}, %w{--foo -b}
+  ].each do |conflict|
+    base = %w{--foo -f}
+    it "should detect conflicts between #{base.inspect} and #{conflict.inspect}" do
+      expect {
+        add_options_to do
+          option *base
+          option *conflict
+        end
+      }.should raise_error ArgumentError, /conflicts with existing option/
+    end
+  end
+
+  it "should fail if we are not consistent about taking an argument" do
+    expect { add_options_to do option "--foo=bar", "--bar" end }.
+      should raise_error ArgumentError, /inconsistent about taking an argument/
+  end
+
+  it "should not accept optional arguments" do
+    expect do
+      thing = add_options_to do option "--foo=[baz]", "--bar=[baz]" end
+      [:foo, :bar].each do |name|
+        thing.should be_option name
+      end
+    end.to raise_error(ArgumentError, /optional arguments are not supported/)
+  end
+
+  describe "#takes_argument?" do
+    it "should detect an argument being absent" do
+      thing = add_options_to do option "--foo" end
+      thing.get_option(:foo).should_not be_takes_argument
+    end
+    ["=FOO", " FOO"].each do |input|
+      it "should detect an argument given #{input.inspect}" do
+        thing = add_options_to do option "--foo#{input}" end
+        thing.get_option(:foo).should be_takes_argument
+      end
+    end
+  end
+
+  describe "#optional_argument?" do
+    it "should be false if no argument is present" do
+      option = add_options_to do option "--foo" end.get_option(:foo)
+      option.should_not be_takes_argument
+      option.should_not be_optional_argument
+    end
+
+    ["=FOO", " FOO"].each do |input|
+      it "should be false if the argument is mandatory (like #{input.inspect})" do
+        option = add_options_to do option "--foo#{input}" end.get_option(:foo)
+      option.should be_takes_argument
+      option.should_not be_optional_argument
+      end
+    end
+
+    ["=[FOO]", " [FOO]"].each do |input|
+      it "should fail if the argument is optional (like #{input.inspect})" do
+        expect do
+          option = add_options_to do option "--foo#{input}" end.get_option(:foo)
+          option.should be_takes_argument
+          option.should be_optional_argument
+        end.to raise_error(ArgumentError, /optional arguments are not supported/)
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -1,6 +1,4 @@
 --format
 s
 --colour
---loadby
-mtime
 --backtrace

data/spec/spec_helper.rb

@@ -1,12 +1,5 @@
-unless defined?(SPEC_HELPER_IS_LOADED)
-SPEC_HELPER_IS_LOADED = 1
-
 dir = File.expand_path(File.dirname(__FILE__))
-
-$LOAD_PATH.unshift("#{dir}/")
-$LOAD_PATH.unshift("#{dir}/lib") # a spec-specific test lib dir
-$LOAD_PATH.unshift("#{dir}/../lib")
-$LOAD_PATH.unshift("#{dir}/../test/lib")
+$LOAD_PATH.unshift File.join(dir, 'lib')
 
 # Don't want puppet getting the command line arguments for rake or autotest
 ARGV.clear
@@ -14,18 +7,20 @@ ARGV.clear
 require 'puppet'
 require 'mocha'
 gem 'rspec', '>=2.0.0'
+require 'rspec/expectations'
 
 # So everyone else doesn't have to include this base constant.
 module PuppetSpec
   FIXTURE_DIR = File.join(dir = File.expand_path(File.dirname(__FILE__)), "fixtures") unless defined?(FIXTURE_DIR)
 end
 
-module PuppetTest
-end
-
 require 'pathname'
-require 'lib/puppet_spec/verbose'
-require 'lib/puppet_spec/files'
+require 'tmpdir'
+
+require 'puppet_spec/verbose'
+require 'puppet_spec/files'
+require 'puppet_spec/fixtures'
+require 'puppet_spec/matchers'
 require 'monkey_patches/alias_should_to_must'
 require 'monkey_patches/publicize_methods'
 
@@ -34,73 +29,21 @@ Pathname.glob("#{dir}/shared_behaviours/**/*.rb") do |behaviour|
 end
 
 RSpec.configure do |config|
-  config.mock_with :mocha
-
-  config.after :each do
-    Puppet.settings.clear
-    Puppet::Node::Environment.clear
-    Puppet::Util::Storage.clear
-    Puppet::Util::ExecutionStub.reset
+  include PuppetSpec::Fixtures
 
-    if defined?($tmpfiles)
-      $tmpfiles.each do |file|
-        file = File.expand_path(file)
-        if Puppet.features.posix? and file !~ /^\/tmp/ and file !~ /^\/var\/folders/
-          puts "Not deleting tmpfile #{file} outside of /tmp or /var/folders"
-          next
-        elsif Puppet.features.microsoft_windows?
-          tempdir = File.expand_path(File.join(Dir::LOCAL_APPDATA, "Temp"))
-          if file !~ /^#{tempdir}/
-            puts "Not deleting tmpfile #{file} outside of #{tempdir}"
-            next
-          end
-        end
-        if FileTest.exist?(file)
-          system("chmod -R 755 '#{file}'")
-          system("rm -rf '#{file}'")
-        end
-      end
-      $tmpfiles.clear
-    end
-
-
-    # Some tests can cause us to connect, in which case the lingering
-    # connection is a resource that can cause unexpected failure in later
-    # tests, as well as sharing state accidentally.
-    # We're testing if ActiveRecord::Base is defined because some test cases
-    # may stub Puppet.features.rails? which is how we should normally
-    # introspect for this functionality.
-    ActiveRecord::Base.remove_connection if defined?(ActiveRecord::Base)
-
-    @logs.clear
-    Puppet::Util::Log.close_all
-
-    # Restore the terminuses to the defaults in case they were changed
-    indirections = Puppet::Indirector::Indirection.send(:class_variable_get, :@@indirections)
-    indirections.each do |indirector|
-      $saved_indirection_state.fetch(indirector.name, {}).each do |variable, value|
-        indirector.instance_variable_set(variable, value)
-      end
-    end
-    $saved_indirection_state = nil
-  end
+  config.mock_with :mocha
 
   config.before :each do
+    GC.disable
+
     # these globals are set by Application
     $puppet_application_mode = nil
     $puppet_application_name = nil
-    Signal.stubs(:trap)
-
-    # Save off the current terminuses so we can restore them afterward
-    $saved_indirection_state = {}
-    indirections = Puppet::Indirector::Indirection.send(:class_variable_get, :@@indirections)
-    indirections.each do |indirector|
-      $saved_indirection_state[indirector.name] = {
-          :@terminus_class => indirector.instance_variable_get(:@terminus_class),
-          :@cache_class    => indirector.instance_variable_get(:@cache_class)
-      }
-    end
 
+    # REVISIT: I think this conceals other bad tests, but I don't have time to
+    # fully diagnose those right now.  When you read this, please come tell me
+    # I suck for letting this float. --daniel 2011-04-21
+    Signal.stubs(:trap)
 
     # Set the confdir and vardir to gibberish so that tests
     # have to be correctly mocked.
@@ -111,8 +54,23 @@ RSpec.configure do |config|
     Puppet.settings[:bindaddress] = "127.0.0.1"
 
     @logs = []
-    Puppet::Util::Log.newdestination(@logs)
+    Puppet::Util::Log.newdestination(Puppet::Test::LogCollector.new(@logs))
+
+    @log_level = Puppet::Util::Log.level
   end
-end
 
+  config.after :each do
+    Puppet.settings.clear
+    Puppet::Node::Environment.clear
+    Puppet::Util::Storage.clear
+    Puppet::Util::ExecutionStub.reset
+
+    PuppetSpec::Files.cleanup
+
+    @logs.clear
+    Puppet::Util::Log.close_all
+    Puppet::Util::Log.level = @log_level
+
+    GC.enable
+  end
 end

data/spec/unit/agent/locker_spec.rb

@@ -1,6 +1,5 @@
-#!/usr/bin/env ruby
-
-require File.dirname(__FILE__) + '/../../spec_helper'
+#!/usr/bin/env rspec
+require 'spec_helper'
 require 'puppet/agent'
 require 'puppet/agent/locker'
 

data/spec/unit/agent_spec.rb

@@ -1,9 +1,9 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env rspec
 #
 #  Created by Luke Kanies on 2007-11-12.
 #  Copyright (c) 2007. All rights reserved.
 
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 require 'puppet/agent'
 
 class AgentTestClient

data/spec/unit/application/agent_spec.rb

@@ -1,12 +1,11 @@
-#!/usr/bin/env ruby
-
-require File.dirname(__FILE__) + '/../../spec_helper'
+#!/usr/bin/env rspec
+require 'spec_helper'
 
 require 'puppet/agent'
 require 'puppet/application/agent'
 require 'puppet/network/server'
-require 'puppet/network/handler'
 require 'puppet/daemon'
+require 'puppet/network/handler'
 
 describe Puppet::Application::Agent do
   before :each do
@@ -14,15 +13,15 @@ describe Puppet::Application::Agent do
     @puppetd.stubs(:puts)
     @daemon = stub_everything 'daemon'
     Puppet::Daemon.stubs(:new).returns(@daemon)
+    Puppet[:daemonize] = false
     @agent = stub_everything 'agent'
     Puppet::Agent.stubs(:new).returns(@agent)
     @puppetd.preinit
     Puppet::Util::Log.stubs(:newdestination)
-    Puppet::Util::Log.stubs(:level=)
 
-    Puppet::Node.stubs(:terminus_class=)
-    Puppet::Node.stubs(:cache_class=)
-    Puppet::Node::Facts.stubs(:terminus_class=)
+    Puppet::Node.indirection.stubs(:terminus_class=)
+    Puppet::Node.indirection.stubs(:cache_class=)
+    Puppet::Node::Facts.indirection.stubs(:terminus_class=)
   end
 
   it "should operate in agent run_mode" do
@@ -172,17 +171,13 @@ describe Puppet::Application::Agent do
       @puppetd.options.stubs(:[])
       Puppet.stubs(:info)
       FileTest.stubs(:exists?).returns(true)
-      Puppet.stubs(:[])
-      Puppet.stubs(:[]=)
-      Puppet.stubs(:[]).with(:libdir).returns("/dev/null/lib")
-      Puppet.settings.stubs(:print_config?)
-      Puppet.settings.stubs(:print_config)
+      Puppet[:libdir] = "/dev/null/lib"
       Puppet::SSL::Host.stubs(:ca_location=)
-      Puppet::Transaction::Report.stubs(:terminus_class=)
-      Puppet::Transaction::Report.stubs(:cache_class=)
-      Puppet::Resource::Catalog.stubs(:terminus_class=)
-      Puppet::Resource::Catalog.stubs(:cache_class=)
-      Puppet::Node::Facts.stubs(:terminus_class=)
+      Puppet::Transaction::Report.indirection.stubs(:terminus_class=)
+      Puppet::Transaction::Report.indirection.stubs(:cache_class=)
+      Puppet::Resource::Catalog.indirection.stubs(:terminus_class=)
+      Puppet::Resource::Catalog.indirection.stubs(:cache_class=)
+      Puppet::Node::Facts.indirection.stubs(:terminus_class=)
       @host = stub_everything 'host'
       Puppet::SSL::Host.stubs(:new).returns(@host)
       Puppet.stubs(:settraps)
@@ -190,7 +185,7 @@ describe Puppet::Application::Agent do
 
     describe "with --test" do
       before :each do
-        Puppet.settings.stubs(:handlearg)
+        #Puppet.settings.stubs(:handlearg)
         @puppetd.options.stubs(:[]=)
       end
 
@@ -205,8 +200,9 @@ describe Puppet::Application::Agent do
         @puppetd.setup_test
       end
       it "should set options[:onetime] to true" do
-        Puppet.expects(:[]=).with(:onetime,true)
+        Puppet[:onetime] = false
         @puppetd.setup_test
+        Puppet[:onetime].should == true
       end
       it "should set options[:detailed_exitcodes] to true" do
         @puppetd.options.expects(:[]=).with(:detailed_exitcodes,true)
@@ -226,18 +222,14 @@ describe Puppet::Application::Agent do
 
       it "should set log level to debug if --debug was passed" do
         @puppetd.options.stubs(:[]).with(:debug).returns(true)
-
-        Puppet::Util::Log.expects(:level=).with(:debug)
-
         @puppetd.setup_logs
+        Puppet::Util::Log.level.should == :debug
       end
 
       it "should set log level to info if --verbose was passed" do
         @puppetd.options.stubs(:[]).with(:verbose).returns(true)
-
-        Puppet::Util::Log.expects(:level=).with(:info)
-
         @puppetd.setup_logs
+        Puppet::Util::Log.level.should == :info
       end
 
       [:verbose, :debug].each do |level|
@@ -261,23 +253,21 @@ describe Puppet::Application::Agent do
     end
 
     it "should print puppet config if asked to in Puppet config" do
-      @puppetd.stubs(:exit)
-      Puppet.settings.stubs(:print_configs?).returns(true)
-
-      Puppet.settings.expects(:print_configs)
-
-      @puppetd.setup
+      Puppet[:configprint] = "pluginsync"
+      Puppet.settings.expects(:print_configs).returns true
+      expect { @puppetd.setup }.to exit_with 0
     end
 
     it "should exit after printing puppet config if asked to in Puppet config" do
-      Puppet.settings.stubs(:print_configs?).returns(true)
-
-      lambda { @puppetd.setup }.should raise_error(SystemExit)
+      Puppet[:modulepath] = '/my/path'
+      Puppet[:configprint] = "modulepath"
+      Puppet::Util::Settings.any_instance.expects(:puts).with('/my/path')
+      expect { @puppetd.setup }.to exit_with 0
     end
 
     it "should set a central log destination with --centrallogs" do
       @puppetd.options.stubs(:[]).with(:centrallogs).returns(true)
-      Puppet.stubs(:[]).with(:server).returns("puppet.reductivelabs.com")
+      Puppet[:server] = "puppet.reductivelabs.com"
       Puppet::Util::Log.stubs(:newdestination).with(:syslog)
 
       Puppet::Util::Log.expects(:newdestination).with("puppet.reductivelabs.com")
@@ -305,32 +295,34 @@ describe Puppet::Application::Agent do
     end
 
     it "should tell the report handler to use REST" do
-      Puppet::Transaction::Report.expects(:terminus_class=).with(:rest)
+      Puppet::Transaction::Report.indirection.expects(:terminus_class=).with(:rest)
 
       @puppetd.setup
     end
 
     it "should tell the report handler to cache locally as yaml" do
-      Puppet::Transaction::Report.expects(:cache_class=).with(:yaml)
+      Puppet::Transaction::Report.indirection.expects(:cache_class=).with(:yaml)
 
       @puppetd.setup
     end
 
     it "should change the catalog_terminus setting to 'rest'" do
-      Puppet.expects(:[]=).with(:catalog_terminus, :rest)
+      Puppet[:catalog_terminus] = :foo
       @puppetd.setup
+      Puppet[:catalog_terminus].should ==  :rest
     end
 
     it "should tell the catalog handler to use cache" do
-      Puppet::Resource::Catalog.expects(:cache_class=).with(:yaml)
+      Puppet::Resource::Catalog.indirection.expects(:cache_class=).with(:yaml)
 
       @puppetd.setup
     end
 
     it "should change the facts_terminus setting to 'facter'" do
-      Puppet.expects(:[]=).with(:facts_terminus, :facter)
+      Puppet[:facts_terminus] = :foo
 
       @puppetd.setup
+      Puppet[:facts_terminus].should == :facter
     end
 
     it "should create an agent" do
@@ -351,17 +343,14 @@ describe Puppet::Application::Agent do
     describe "when enabling or disabling agent" do
       [:enable, :disable].each do |action|
         it "should call client.#{action}" do
-          @puppetd.stubs(:exit)
           @puppetd.options.stubs(:[]).with(action).returns(true)
-
           @agent.expects(action)
-
-          @puppetd.enable_disable_client(@agent)
+          expect { @puppetd.enable_disable_client(@agent) }.to exit_with 0
         end
       end
 
       it "should finally exit" do
-        lambda { @puppetd.enable_disable_client(@agent) }.should raise_error(SystemExit)
+        expect { @puppetd.enable_disable_client(@agent) }.to exit_with 0
       end
     end
 
@@ -378,7 +367,7 @@ describe Puppet::Application::Agent do
     end
 
     it "should daemonize if needed" do
-      Puppet.stubs(:[]).with(:daemonize).returns(true)
+      Puppet[:daemonize] = true
 
       @daemon.expects(:daemonize)
 
@@ -401,7 +390,7 @@ describe Puppet::Application::Agent do
     end
 
     it "should setup listen if told to and not onetime" do
-      Puppet.stubs(:[]).with(:listen).returns(true)
+      Puppet[:listen] = true
       @puppetd.options.stubs(:[]).with(:onetime).returns(false)
 
       @puppetd.expects(:setup_listen)
@@ -411,11 +400,10 @@ describe Puppet::Application::Agent do
 
     describe "when setting up listen" do
       before :each do
-        Puppet.stubs(:[]).with(:rest_authconfig).returns('auth')
+        Puppet[:authconfig] = 'auth'
         FileTest.stubs(:exists?).with('auth').returns(true)
         File.stubs(:exist?).returns(true)
         @puppetd.options.stubs(:[]).with(:serve).returns([])
-        @puppetd.stubs(:exit)
         @server = stub_everything 'server'
         Puppet::Network::Server.stubs(:new).returns(@server)
       end
@@ -423,11 +411,8 @@ describe Puppet::Application::Agent do
 
       it "should exit if no authorization file" do
         Puppet.stubs(:err)
-        FileTest.stubs(:exists?).with('auth').returns(false)
-
-        @puppetd.expects(:exit)
-
-        @puppetd.setup_listen
+        FileTest.stubs(:exists?).with(Puppet[:authconfig]).returns(false)
+        expect { @puppetd.setup_listen }.to exit_with 14
       end
 
       it "should create a server to listen on at least the Runner handler" do
@@ -444,9 +429,9 @@ describe Puppet::Application::Agent do
       end
 
       it "should use puppet default port" do
-        Puppet.stubs(:[]).with(:puppetport).returns(:port)
+        Puppet[:puppetport] = 32768
 
-        Puppet::Network::Server.expects(:new).with { |args| args[:port] == :port }
+        Puppet::Network::Server.expects(:new).with { |args| args[:port] == 32768 }
 
         @puppetd.setup_listen
       end
@@ -488,35 +473,27 @@ describe Puppet::Application::Agent do
         @agent.stubs(:run).returns(:report)
         @puppetd.options.stubs(:[]).with(:client).returns(:client)
         @puppetd.options.stubs(:[]).with(:detailed_exitcodes).returns(false)
-        @puppetd.stubs(:exit).with(0)
         Puppet.stubs(:newservice)
       end
 
       it "should exit if no defined --client" do
         $stderr.stubs(:puts)
         @puppetd.options.stubs(:[]).with(:client).returns(nil)
-
-        @puppetd.expects(:exit).with(43)
-
-        @puppetd.onetime
+        expect { @puppetd.onetime }.to exit_with 43
       end
 
       it "should setup traps" do
         @daemon.expects(:set_signal_traps)
-
-        @puppetd.onetime
+        expect { @puppetd.onetime }.to exit_with 0
       end
 
       it "should let the agent run" do
         @agent.expects(:run).returns(:report)
-
-        @puppetd.onetime
+        expect { @puppetd.onetime }.to exit_with 0
       end
 
       it "should finish by exiting with 0 error code" do
-        @puppetd.expects(:exit).with(0)
-
-        @puppetd.onetime
+        expect { @puppetd.onetime }.to exit_with 0
       end
 
       describe "and --detailed-exitcodes" do
@@ -525,21 +502,19 @@ describe Puppet::Application::Agent do
         end
 
         it "should exit with report's computed exit status" do
-          Puppet.stubs(:[]).with(:noop).returns(false)
+          Puppet[:noop] = false
           report = stub 'report', :exit_status => 666
           @agent.stubs(:run).returns(report)
-          @puppetd.expects(:exit).with(666)
 
-          @puppetd.onetime
+          expect { @puppetd.onetime }.to exit_with 666
         end
 
         it "should exit with the report's computer exit status, even if --noop is set." do
-          Puppet.stubs(:[]).with(:noop).returns(true)
+          Puppet[:noop] = true
           report = stub 'report', :exit_status => 666
           @agent.stubs(:run).returns(report)
-          @puppetd.expects(:exit).with(666)
 
-          @puppetd.onetime
+          expect { @puppetd.onetime }.to exit_with 666
         end
       end
     end
@@ -570,7 +545,7 @@ describe Puppet::Application::Agent do
         @host.stubs(:certificate).returns(@cert)
         @cert.stubs(:fingerprint).with(:MD5).returns("DIGEST")
 
-        @puppetd.expects(:puts).with "DIGEST"
+        Puppet.expects(:notice).with("DIGEST")
 
         @puppetd.fingerprint
       end