1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
#
# Author:: Adam Jacob (<adam@opscode.com>)
# Copyright:: Copyright (c) 2008 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.join(File.dirname(__FILE__), "..", "spec_helper"))
describe Mixlib::CLI do
after(:each) do
TestCLI.options = {}
TestCLI.banner("Usage: #{$0} (options)")
end
describe "class method" do
describe "option" do
it "should allow you to set a config option with a hash" do
TestCLI.option(:config_file, :short => '-c CONFIG').should == { :short => '-c CONFIG' }
end
end
describe "options" do
it "should return the current options hash" do
TestCLI.option(:config_file, :short => '-c CONFIG')
TestCLI.options.should == { :config_file => { :short => '-c CONFIG' } }
end
end
describe "options=" do
it "should allow you to set the full options with a single hash" do
TestCLI.options = { :config_file => { :short => '-c CONFIG' } }
TestCLI.options.should == { :config_file => { :short => '-c CONFIG' } }
end
end
describe "banner" do
it "should have a default value" do
TestCLI.banner.should =~ /^Usage: (.+) \(options\)$/
end
it "should allow you to set the banner" do
TestCLI.banner("Usage: foo")
TestCLI.banner.should == "Usage: foo"
end
end
end
describe "instance methods" do
before(:each) do
@cli = TestCLI.new
end
describe "initialize" do
it "should set the banner to the class defined banner" do
@cli.banner.should == TestCLI.banner
end
it "should set the options to the class defined options, plus defaults" do
TestCLI.option(:config_file, :short => "-l LOG")
cli = TestCLI.new
cli.options.should == {
:config_file => {
:short => "-l LOG",
:on => :on,
:boolean => false,
:required => false,
:proc => nil,
:show_options => false,
:exit => nil
}
}
end
it "should set the default config value for any options that include it" do
TestCLI.option(:config_file, :short => "-l LOG", :default => :debug)
@cli = TestCLI.new
@cli.config[:config_file].should == :debug
end
end
describe "parse_options" do
it "should set the banner in opt_parse" do
@cli.parse_options([])
@cli.opt_parser.banner.should == @cli.banner
end
it "should present the arguments in the banner" do
TestCLI.option(:config_file, :short => "-l LOG")
@cli = TestCLI.new
@cli.parse_options([])
@cli.opt_parser.to_s.should =~ /-l LOG/
end
it "should honor :on => :tail options in the banner" do
TestCLI.option(:config_file, :short => "-l LOG")
TestCLI.option(:help, :short => "-h", :boolean => true, :on => :tail)
@cli = TestCLI.new
@cli.parse_options([])
@cli.opt_parser.to_s.split("\n").last.should =~ /-h/
end
it "should honor :on => :head options in the banner" do
TestCLI.option(:config_file, :short => "-l LOG")
TestCLI.option(:help, :short => "-h", :boolean => true, :on => :head)
@cli = TestCLI.new
@cli.parse_options([])
@cli.opt_parser.to_s.split("\n")[1].should =~ /-h/
end
it "should present the arguments in alphabetical order in the banner" do
TestCLI.option(:alpha, :short => "-a ALPHA")
TestCLI.option(:beta, :short => "-b BETA")
TestCLI.option(:zeta, :short => "-z ZETA")
@cli = TestCLI.new
@cli.parse_options([])
output_lines = @cli.opt_parser.to_s.split("\n")
output_lines[1].should =~ /-a ALPHA/
output_lines[2].should =~ /-b BETA/
output_lines[3].should =~ /-z ZETA/
end
it "should set the corresponding config value for non-boolean arguments" do
TestCLI.option(:config_file, :short => "-c CONFIG")
@cli = TestCLI.new
@cli.parse_options([ '-c', 'foo.rb' ])
@cli.config[:config_file].should == 'foo.rb'
end
it "should set the corresponding config value according to a supplied proc" do
TestCLI.option(:number,
:short => "-n NUMBER",
:proc => Proc.new { |config| config.to_i + 2 }
)
@cli = TestCLI.new
@cli.parse_options([ "-n", "2" ])
@cli.config[:number].should == 4
end
it "should set the corresponding config value to true for boolean arguments" do
TestCLI.option(:i_am_boolean, :short => "-i", :boolean => true)
@cli = TestCLI.new
@cli.parse_options([ '-i' ])
@cli.config[:i_am_boolean].should == true
end
it "should exit if a config option has :exit set" do
TestCLI.option(:i_am_exit, :short => "-x", :boolean => true, :exit => 0)
@cli = TestCLI.new
lambda { @cli.parse_options(["-x"]) }.should raise_error(SystemExit)
end
it "should exit if a required option is missing" do
TestCLI.option(:require_me, :short => "-r", :boolean => true, :required => true)
@cli = TestCLI.new
lambda { @cli.parse_options([]) }.should raise_error(SystemExit)
end
end
end
end
# option :config_file,
# :short => "-c CONFIG",
# :long => "--config CONFIG",
# :default => 'config.rb',
# :description => "The configuration file to use"
#
# option :log_level,
# :short => "-l LEVEL",
# :long => "--log_level LEVEL",
# :description => "Set the log level (debug, info, warn, error, fatal)",
# :required => true,
# :proc => nil
#
# option :help,
# :short => "-h",
# :long => "--help",
# :description => "Show this message",
# :on => :tail,
# :boolean => true,
# :show_options => true,
# :exit => 0
|
