Fix #3552 single executable should display usage

Added some tests to make the single executable command behavior
explicit.
Added logic to display the usage message if we're on a tty and no
arguments are passed.

Signed-off-by: Jesse Wolfe <jes5199@gmail.com>
This commit is contained in:
Jesse Wolfe 2010-04-13 14:53:44 -07:00 коммит произвёл test branch
Родитель 722a27fd49
Коммит 1d8bd0d930
5 изменённых файлов: 91 добавлений и 163 удалений

Просмотреть файл

@ -1,71 +0,0 @@
#!/usr/bin/env ruby
#
# = Synopsis
#
# Run a stand-alone +puppet+ manifest.
#
# = Usage
#
# puppet [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose] [-e|--execute]
# [--detailed-exitcodes] [-l|--logdest <file>] <file>
#
# = Description
#
# This is the standalone puppet execution tool; use it to execute
# individual manifests that you write. If you need to execute site-wide
# manifests, use +puppetd+ and +puppetmasterd+.
#
# = Options
#
# Note that any configuration parameter that's valid in the configuration file
# is also a valid long argument. For example, 'ssldir' is a valid configuration
# parameter, so you can specify '--ssldir <directory>' as an argument.
#
# See the configuration file documentation at
# http://reductivelabs.com/trac/puppet/wiki/ConfigurationReference for
# the full list of acceptable parameters. A commented list of all
# configuration options can also be generated by running puppet with
# '--genconfig'.
#
# debug::
# Enable full debugging.
#
# detailed-exitcodes::
# Provide transaction information via exit codes. If this is enabled, an exit
# code of '2' means there were changes, and an exit code of '4' means that there
# were failures during the transaction.
#
# help::
# Print this help message
#
# loadclasses::
# Load any stored classes. +puppetd+ caches configured classes (usually at
# /etc/puppet/classes.txt), and setting this option causes all of those classes
# to be set in your +puppet+ manifest.
#
# logdest::
# Where to send messages. Choose between syslog, the console, and a log file.
# Defaults to sending messages to the console.
#
# execute::
# Execute a specific piece of Puppet code
#
# verbose::
# Print extra information.
#
# = Example
#
# puppet -l /tmp/manifest.log manifest.pp
#
# = Author
#
# Luke Kanies
#
# = Copyright
#
# Copyright (c) 2005 Reductive Labs, LLC
# Licensed under the GNU Public License
require 'puppet/application/main'
Puppet::Application[:main].run

Просмотреть файл

@ -4,7 +4,7 @@ require 'puppet/configurer'
require 'puppet/network/handler'
require 'puppet/network/client'
Puppet::Application.new(:main) do
Puppet::Application.new(:apply) do
should_parse_config

Просмотреть файл

@ -2,12 +2,10 @@ module Puppet
module Util
module CommandLine
def self.shift_subcommand_from_argv( argv = ARGV, stdin = STDIN )
if ! argv.first
"main" unless stdin.tty? # ttys get usage info
elsif argv.first =~ /^-|\.pp$|\.rb$/
"main"
else
argv.shift
case argv.first
when nil; "apply" unless stdin.tty? # ttys get usage info
when /^-|\.pp$|\.rb$/; "apply"
else argv.shift
end
end
end

Просмотреть файл

@ -2,33 +2,33 @@
require File.dirname(__FILE__) + '/../../spec_helper'
require 'puppet/application/main'
require 'puppet/application/apply'
describe "Puppet" do
before :each do
@main = Puppet::Application[:main]
@apply = Puppet::Application[:apply]
Puppet::Util::Log.stubs(:newdestination)
Puppet::Util::Log.stubs(:level=)
end
[:debug,:loadclasses,:verbose,:use_nodes,:detailed_exitcodes].each do |option|
it "should declare handle_#{option} method" do
@main.should respond_to("handle_#{option}".to_sym)
@apply.should respond_to("handle_#{option}".to_sym)
end
it "should store argument value when calling handle_#{option}" do
@main.options.expects(:[]=).with(option, 'arg')
@main.send("handle_#{option}".to_sym, 'arg')
@apply.options.expects(:[]=).with(option, 'arg')
@apply.send("handle_#{option}".to_sym, 'arg')
end
end
it "should set the code to the provided code when :execute is used" do
@main.options.expects(:[]=).with(:code, 'arg')
@main.send("handle_execute".to_sym, 'arg')
@apply.options.expects(:[]=).with(:code, 'arg')
@apply.send("handle_execute".to_sym, 'arg')
end
it "should ask Puppet::Application to parse Puppet configuration file" do
@main.should_parse_config?.should be_true
@apply.should_parse_config?.should be_true
end
describe "when applying options" do
@ -36,13 +36,13 @@ describe "Puppet" do
it "should set the log destination with --logdest" do
Puppet::Log.expects(:newdestination).with("console")
@main.handle_logdest("console")
@apply.handle_logdest("console")
end
it "should put the logset options to true" do
@main.options.expects(:[]=).with(:logset,true)
@apply.options.expects(:[]=).with(:logset,true)
@main.handle_logdest("console")
@apply.handle_logdest("console")
end
end
@ -53,10 +53,11 @@ describe "Puppet" do
Puppet.stubs(:trap)
Puppet::Log.stubs(:level=)
Puppet.stubs(:parse_config)
require 'lib/puppet/file_bucket/dipper'
Puppet::FileBucket::Dipper.stubs(:new)
STDIN.stubs(:read)
@main.options.stubs(:[]).with(any_parameters)
@apply.options.stubs(:[]).with(any_parameters)
end
it "should set show_diff on --noop" do
@ -66,50 +67,50 @@ describe "Puppet" do
Puppet.expects(:[]=).with(:show_diff, true)
@main.run_setup
@apply.run_setup
end
it "should set console as the log destination if logdest option wasn't provided" do
Puppet::Log.expects(:newdestination).with(:console)
@main.run_setup
@apply.run_setup
end
it "should set INT trap" do
@main.expects(:trap).with(:INT)
@apply.expects(:trap).with(:INT)
@main.run_setup
@apply.run_setup
end
it "should set log level to debug if --debug was passed" do
@main.options.stubs(:[]).with(:debug).returns(true)
@apply.options.stubs(:[]).with(:debug).returns(true)
Puppet::Log.expects(:level=).with(:debug)
@main.run_setup
@apply.run_setup
end
it "should set log level to info if --verbose was passed" do
@main.options.stubs(:[]).with(:verbose).returns(true)
@apply.options.stubs(:[]).with(:verbose).returns(true)
Puppet::Log.expects(:level=).with(:info)
@main.run_setup
@apply.run_setup
end
it "should print puppet config if asked to in Puppet config" do
@main.stubs(:exit)
@apply.stubs(:exit)
Puppet.settings.stubs(:print_configs?).returns(true)
Puppet.settings.expects(:print_configs)
@main.run_setup
@apply.run_setup
end
it "should exit after printing puppet config if asked to in Puppet config" do
Puppet.settings.stubs(:print_configs?).returns(true)
lambda { @main.run_setup }.should raise_error(SystemExit)
lambda { @apply.run_setup }.should raise_error(SystemExit)
end
end
@ -117,23 +118,23 @@ describe "Puppet" do
describe "when executing" do
it "should dispatch to parseonly if parseonly is set" do
@main.stubs(:options).returns({})
@apply.stubs(:options).returns({})
Puppet.stubs(:[]).with(:parseonly).returns(true)
@main.get_command.should == :parseonly
@apply.get_command.should == :parseonly
end
it "should dispatch to 'apply' if it was called with 'apply'" do
@main.options[:catalog] = "foo"
@apply.options[:catalog] = "foo"
@main.get_command.should == :apply
@apply.get_command.should == :apply
end
it "should dispatch to main if parseonly is not set" do
@main.stubs(:options).returns({})
@apply.stubs(:options).returns({})
Puppet.stubs(:[]).with(:parseonly).returns(false)
@main.get_command.should == :main
@apply.get_command.should == :main
end
describe "the parseonly command" do
@ -141,26 +142,26 @@ describe "Puppet" do
Puppet.stubs(:[]).with(:environment)
Puppet.stubs(:[]).with(:manifest).returns("site.pp")
Puppet.stubs(:err)
@main.stubs(:exit)
@main.options.stubs(:[]).with(:code).returns "some code"
@apply.stubs(:exit)
@apply.options.stubs(:[]).with(:code).returns "some code"
@collection = stub_everything
Puppet::Resource::TypeCollection.stubs(:new).returns(@collection)
end
it "should use a Puppet Resource Type Collection to parse the file" do
@collection.expects(:perform_initial_import)
@main.parseonly
@apply.parseonly
end
it "should exit with exit code 0 if no error" do
@main.expects(:exit).with(0)
@main.parseonly
@apply.expects(:exit).with(0)
@apply.parseonly
end
it "should exit with exit code 1 if error" do
@collection.stubs(:perform_initial_import).raises(Puppet::ParseError)
@main.expects(:exit).with(1)
@main.parseonly
@apply.expects(:exit).with(1)
@apply.parseonly
end
end
@ -172,7 +173,7 @@ describe "Puppet" do
Puppet.stubs(:[]).with(:postrun_command).returns ""
Puppet.stubs(:[]).with(:trace).returns(true)
@main.options.stubs(:[])
@apply.options.stubs(:[])
@facts = stub_everything 'facts'
Puppet::Node::Facts.stubs(:find).returns(@facts)
@ -189,14 +190,14 @@ describe "Puppet" do
@transaction = stub_everything 'transaction'
@catalog.stubs(:apply).returns(@transaction)
@main.stubs(:exit)
@apply.stubs(:exit)
end
it "should set the code to run from --code" do
@main.options.stubs(:[]).with(:code).returns("code to run")
@apply.options.stubs(:[]).with(:code).returns("code to run")
Puppet.expects(:[]=).with(:code,"code to run")
@main.main
@apply.main
end
it "should set the code to run from STDIN if no arguments" do
@ -205,7 +206,7 @@ describe "Puppet" do
Puppet.expects(:[]=).with(:code,"code to run")
@main.main
@apply.main
end
it "should set the manifest if some files are passed on command line" do
@ -214,31 +215,31 @@ describe "Puppet" do
Puppet.expects(:[]=).with(:manifest,"site.pp")
@main.main
@apply.main
end
it "should collect the node facts" do
Puppet::Node::Facts.expects(:find).returns(@facts)
@main.main
@apply.main
end
it "should raise an error if we can't find the node" do
Puppet::Node::Facts.expects(:find).returns(nil)
lambda { @main.main }.should raise_error
lambda { @apply.main }.should raise_error
end
it "should find the node" do
Puppet::Node.expects(:find).returns(@node)
@main.main
@apply.main
end
it "should raise an error if we can't find the node" do
Puppet::Node.expects(:find).returns(nil)
lambda { @main.main }.should raise_error
lambda { @apply.main }.should raise_error
end
it "should merge in our node the loaded facts" do
@ -246,11 +247,11 @@ describe "Puppet" do
@node.expects(:merge).with("values")
@main.main
@apply.main
end
it "should load custom classes if loadclasses" do
@main.options.stubs(:[]).with(:loadclasses).returns(true)
@apply.options.stubs(:[]).with(:loadclasses).returns(true)
Puppet.stubs(:[]).with(:classfile).returns("/etc/puppet/classes.txt")
FileTest.stubs(:exists?).with("/etc/puppet/classes.txt").returns(true)
FileTest.stubs(:readable?).with("/etc/puppet/classes.txt").returns(true)
@ -258,26 +259,26 @@ describe "Puppet" do
@node.expects(:classes=)
@main.main
@apply.main
end
it "should compile the catalog" do
Puppet::Resource::Catalog.expects(:find).returns(@catalog)
@main.main
@apply.main
end
it "should transform the catalog to ral" do
@catalog.expects(:to_ral).returns(@catalog)
@main.main
@apply.main
end
it "should finalize the catalog" do
@catalog.expects(:finalize)
@main.main
@apply.main
end
it "should call the prerun and postrun commands on a Configurer instance" do
@ -287,87 +288,87 @@ describe "Puppet" do
configurer.expects(:execute_prerun_command)
configurer.expects(:execute_postrun_command)
@main.main
@apply.main
end
it "should apply the catalog" do
@catalog.expects(:apply)
@main.main
@apply.main
end
describe "with detailed_exitcodes" do
it "should exit with report's computed exit status" do
Puppet.stubs(:[]).with(:noop).returns(false)
@main.options.stubs(:[]).with(:detailed_exitcodes).returns(true)
@apply.options.stubs(:[]).with(:detailed_exitcodes).returns(true)
report = stub 'report', :exit_status => 666
@transaction.stubs(:report).returns(report)
@main.expects(:exit).with(666)
@apply.expects(:exit).with(666)
@main.main
@apply.main
end
it "should always exit with 0 if option is disabled" do
Puppet.stubs(:[]).with(:noop).returns(false)
@main.options.stubs(:[]).with(:detailed_exitcodes).returns(false)
@apply.options.stubs(:[]).with(:detailed_exitcodes).returns(false)
report = stub 'report', :exit_status => 666
@transaction.stubs(:report).returns(report)
@main.expects(:exit).with(0)
@apply.expects(:exit).with(0)
@main.main
@apply.main
end
it "should always exit with 0 if --noop" do
Puppet.stubs(:[]).with(:noop).returns(true)
@main.options.stubs(:[]).with(:detailed_exitcodes).returns(true)
@apply.options.stubs(:[]).with(:detailed_exitcodes).returns(true)
report = stub 'report', :exit_status => 666
@transaction.stubs(:report).returns(report)
@main.expects(:exit).with(0)
@apply.expects(:exit).with(0)
@main.main
@apply.main
end
end
end
describe "the 'apply' command" do
it "should read the catalog in from disk if a file name is provided" do
@main.options[:catalog] = "/my/catalog.pson"
@apply.options[:catalog] = "/my/catalog.pson"
File.expects(:read).with("/my/catalog.pson").returns "something"
Puppet::Resource::Catalog.stubs(:convert_from).with(:pson,'something').returns Puppet::Resource::Catalog.new
@main.apply
@apply.apply
end
it "should read the catalog in from stdin if '-' is provided" do
@main.options[:catalog] = "-"
@apply.options[:catalog] = "-"
$stdin.expects(:read).returns "something"
Puppet::Resource::Catalog.stubs(:convert_from).with(:pson,'something').returns Puppet::Resource::Catalog.new
@main.apply
@apply.apply
end
it "should deserialize the catalog from the default format" do
@main.options[:catalog] = "/my/catalog.pson"
@apply.options[:catalog] = "/my/catalog.pson"
File.stubs(:read).with("/my/catalog.pson").returns "something"
Puppet::Resource::Catalog.stubs(:default_format).returns :rot13_piglatin
Puppet::Resource::Catalog.stubs(:convert_from).with(:rot13_piglatin,'something').returns Puppet::Resource::Catalog.new
@main.apply
@apply.apply
end
it "should fail helpfully if deserializing fails" do
@main.options[:catalog] = "/my/catalog.pson"
@apply.options[:catalog] = "/my/catalog.pson"
File.stubs(:read).with("/my/catalog.pson").returns "something syntacically invalid"
lambda { @main.apply }.should raise_error(Puppet::Error)
lambda { @apply.apply }.should raise_error(Puppet::Error)
end
it "should convert plain data structures into a catalog if deserialization does not do so" do
@main.options[:catalog] = "/my/catalog.pson"
@apply.options[:catalog] = "/my/catalog.pson"
File.stubs(:read).with("/my/catalog.pson").returns "something"
Puppet::Resource::Catalog.stubs(:convert_from).with(:pson,"something").returns({:foo => "bar"})
Puppet::Resource::Catalog.expects(:pson_create).with({:foo => "bar"}).returns(Puppet::Resource::Catalog.new)
@main.apply
@apply.apply
end
it "should convert the catalog to a RAL catalog and use a Configurer instance to apply it" do
@main.options[:catalog] = "/my/catalog.pson"
@apply.options[:catalog] = "/my/catalog.pson"
File.stubs(:read).with("/my/catalog.pson").returns "something"
catalog = Puppet::Resource::Catalog.new
Puppet::Resource::Catalog.stubs(:convert_from).with(:pson,'something').returns catalog
@ -377,7 +378,7 @@ describe "Puppet" do
Puppet::Configurer.expects(:new).returns configurer
configurer.expects(:run).with(:catalog => "mycatalog")
@main.apply
@apply.apply
end
end
end

Просмотреть файл

@ -19,35 +19,35 @@ describe Puppet::Util::CommandLine do
args.should == %w( --help whatever.pp )
end
it "should use main if the first argument looks like a .pp file" do
it "should use 'apply' if the first argument looks like a .pp file" do
args = %w( whatever.pp )
command = Puppet::Util::CommandLine.shift_subcommand_from_argv( args, @tty )
command.should == "main"
command.should == "apply"
args.should == %w( whatever.pp )
end
it "should use main if the first argument looks like a .rb file" do
it "should use 'apply' if the first argument looks like a .rb file" do
args = %w( whatever.rb )
command = Puppet::Util::CommandLine.shift_subcommand_from_argv( args, @tty )
command.should == "main"
command.should == "apply"
args.should == %w( whatever.rb )
end
it "should use main if the first argument looks like a flag" do
it "should use 'apply' if the first argument looks like a flag" do
args = %w( --debug )
command = Puppet::Util::CommandLine.shift_subcommand_from_argv( args, @tty )
command.should == "main"
command.should == "apply"
args.should == %w( --debug )
end
it "should use main if the first argument is -" do
it "should use 'apply' if the first argument is -" do
args = %w( - )
command = Puppet::Util::CommandLine.shift_subcommand_from_argv( args, @tty )
command.should == "main"
command.should == "apply"
args.should == %w( - )
end
@ -59,11 +59,11 @@ describe Puppet::Util::CommandLine do
args.should == []
end
it "should use main if there are no arguments on a pipe" do
it "should use 'apply' if there are no arguments on a pipe" do
args = []
command = Puppet::Util::CommandLine.shift_subcommand_from_argv( args, @pipe )
command.should == "main"
command.should == "apply"
args.should == []
end