dtf 0.2.6 → 0.2.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. data/bin/dtf +1 -1
  2. data/doc/AnalysisCase.html +1 -1
  3. data/doc/CaseTest.html +1 -1
  4. data/doc/Dtf.html +5 -3
  5. data/doc/Dtf/{DtfCommands.html → Command.html} +327 -103
  6. data/doc/Dtf/HelpSystem.html +128 -0
  7. data/doc/User.html +1 -1
  8. data/doc/VerificationSuite.html +1 -1
  9. data/doc/_index.html +17 -2
  10. data/doc/class_list.html +1 -1
  11. data/doc/file.README.html +1 -1
  12. data/doc/index.html +1 -1
  13. data/doc/method_list.html +16 -8
  14. data/doc/top-level-namespace.html +11 -23
  15. data/lib/dtf.rb +65 -11
  16. data/lib/dtf/error_system.rb +4 -4
  17. data/lib/dtf/help_system.rb +48 -44
  18. data/lib/dtf/version.rb +1 -1
  19. metadata +4 -3
data/doc/Dtf/HelpSystem.html ADDED
@@ -0,0 +1,128 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Module: Dtf::HelpSystem
8
+
9
+ &mdash; Documentation by YARD 0.8.2.1
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (H)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Dtf.html" title="Dtf (module)">Dtf</a></span></span>
36
+ &raquo;
37
+ <span class="title">HelpSystem</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Module: Dtf::HelpSystem
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+ <dt class="r1 last">Defined in:</dt>
82
+ <dd class="r1 last">lib/dtf/help_system.rb</dd>
83
+
84
+ </dl>
85
+ <div class="clear"></div>
86
+
87
+
88
+ <h2>Constant Summary</h2>
89
+
90
+ <dl class="constants">
91
+
92
+ <dt id="SUB_COMMANDS-constant" class="">SUB_COMMANDS =
93
+ <div class="docstring">
94
+ <div class="discussion">
95
+
96
+ <p>List of all sub-commands known within the Help System</p>
97
+
98
+
99
+ </div>
100
+ </div>
101
+ <div class="tags">
102
+
103
+
104
+ </div>
105
+ </dt>
106
+ <dd><pre class="code"><span class='qwords_beg'>%w(</span><span class='tstring_content'>create_user</span><span class='words_sep'> </span><span class='tstring_content'>delete_user</span><span class='words_sep'> </span><span class='tstring_content'>create_vs</span><span class='words_sep'> </span><span class='tstring_content'>delete_vs</span><span class='words_sep'>)</span></pre></dd>
107
+
108
+ </dl>
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+ </div>
120
+
121
+ <div id="footer">
122
+ Generated on Sun Sep 16 12:04:53 2012 by
123
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
124
+ 0.8.2.1 (ruby-1.9.3).
125
+ </div>
126
+
127
+ </body>
128
+ </html>
data/doc/User.html CHANGED
@@ -114,7 +114,7 @@
114
114
  </div>
115
115
 
116
116
  <div id="footer">
117
- Generated on Fri Sep 14 22:41:21 2012 by
117
+ Generated on Sun Sep 16 12:04:53 2012 by
118
118
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
119
119
  0.8.2.1 (ruby-1.9.3).
120
120
  </div>
data/doc/VerificationSuite.html CHANGED
@@ -114,7 +114,7 @@
114
114
  </div>
115
115
 
116
116
  <div id="footer">
117
- Generated on Fri Sep 14 22:41:21 2012 by
117
+ Generated on Sun Sep 16 12:04:53 2012 by
118
118
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
119
119
  0.8.2.1 (ruby-1.9.3).
120
120
  </div>
data/doc/_index.html CHANGED
@@ -104,6 +104,13 @@
104
104
 
105
105
  </li>
106
106
 
107
+ <li>
108
+ <span class='object_link'><a href="Dtf/Command.html" title="Dtf::Command (class)">Command</a></span>
109
+
110
+ <small>(Dtf)</small>
111
+
112
+ </li>
113
+
107
114
  </ul>
108
115
  </ul>
109
116
 
@@ -117,8 +124,16 @@
117
124
 
118
125
  </li>
119
126
 
127
+ </ul>
128
+ </ul>
129
+
130
+
131
+ <ul id="alpha_H" class="alpha">
132
+ <li class="letter">H</li>
133
+ <ul>
134
+
120
135
  <li>
121
- <span class='object_link'><a href="Dtf/Commands.html" title="Dtf::Commands (class)">Commands</a></span>
136
+ <span class='object_link'><a href="Dtf/HelpSystem.html" title="Dtf::HelpSystem (module)">HelpSystem</a></span>
122
137
 
123
138
  <small>(Dtf)</small>
124
139
 
@@ -162,7 +177,7 @@
162
177
  </div>
163
178
 
164
179
  <div id="footer">
165
- Generated on Fri Sep 14 22:41:20 2012 by
180
+ Generated on Sun Sep 16 12:04:53 2012 by
166
181
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
167
182
  0.8.2.1 (ruby-1.9.3).
168
183
  </div>
data/doc/class_list.html CHANGED
@@ -45,7 +45,7 @@
45
45
 
46
46
  <ul id="full_list" class="class">
47
47
  <li><span class='object_link'><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></span></li>
48
- <li><span class='object_link'><a href="AnalysisCase.html" title="AnalysisCase (class)">AnalysisCase</a></span> &lt; Base<small class='search_info'>Top Level Namespace</small></li><li><span class='object_link'><a href="CaseTest.html" title="CaseTest (class)">CaseTest</a></span> &lt; Base<small class='search_info'>Top Level Namespace</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Dtf.html" title="Dtf (module)">Dtf</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="Dtf/Commands.html" title="Dtf::Commands (class)">Commands</a></span> &lt; Object<small class='search_info'>Dtf</small></li></ul><li><span class='object_link'><a href="User.html" title="User (class)">User</a></span> &lt; Base<small class='search_info'>Top Level Namespace</small></li><li><span class='object_link'><a href="VerificationSuite.html" title="VerificationSuite (class)">VerificationSuite</a></span> &lt; Base<small class='search_info'>Top Level Namespace</small></li>
48
+ <li><span class='object_link'><a href="AnalysisCase.html" title="AnalysisCase (class)">AnalysisCase</a></span> &lt; Base<small class='search_info'>Top Level Namespace</small></li><li><span class='object_link'><a href="CaseTest.html" title="CaseTest (class)">CaseTest</a></span> &lt; Base<small class='search_info'>Top Level Namespace</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Dtf.html" title="Dtf (module)">Dtf</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="Dtf/Command.html" title="Dtf::Command (class)">Command</a></span> &lt; Object<small class='search_info'>Dtf</small></li><li><span class='object_link'><a href="Dtf/HelpSystem.html" title="Dtf::HelpSystem (module)">HelpSystem</a></span><small class='search_info'>Dtf</small></li></ul><li><span class='object_link'><a href="User.html" title="User (class)">User</a></span> &lt; Base<small class='search_info'>Top Level Namespace</small></li><li><span class='object_link'><a href="VerificationSuite.html" title="VerificationSuite (class)">VerificationSuite</a></span> &lt; Base<small class='search_info'>Top Level Namespace</small></li>
49
49
 
50
50
  </ul>
51
51
  </div>
data/doc/file.README.html CHANGED
@@ -247,7 +247,7 @@ Options:
247
247
  </div></div>
248
248
 
249
249
  <div id="footer">
250
- Generated on Fri Sep 14 22:41:20 2012 by
250
+ Generated on Sun Sep 16 12:04:53 2012 by
251
251
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
252
252
  0.8.2.1 (ruby-1.9.3).
253
253
  </div>
data/doc/index.html CHANGED
@@ -247,7 +247,7 @@ Options:
247
247
  </div></div>
248
248
 
249
249
  <div id="footer">
250
- Generated on Fri Sep 14 22:41:20 2012 by
250
+ Generated on Sun Sep 16 12:04:53 2012 by
251
251
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
252
252
  0.8.2.1 (ruby-1.9.3).
253
253
  </div>
data/doc/method_list.html CHANGED
@@ -47,33 +47,33 @@
47
47
 
48
48
 
49
49
  <li class="r1 ">
50
- <span class='object_link'><a href="Dtf/Commands.html#create_user-class_method" title="Dtf::Commands.create_user (method)">create_user</a></span>
50
+ <span class='object_link'><a href="Dtf/Command.html#create_user-class_method" title="Dtf::Command.create_user (method)">create_user</a></span>
51
51
 
52
- <small>Dtf::Commands</small>
52
+ <small>Dtf::Command</small>
53
53
 
54
54
  </li>
55
55
 
56
56
 
57
57
  <li class="r2 ">
58
- <span class='object_link'><a href="Dtf/Commands.html#create_vs-class_method" title="Dtf::Commands.create_vs (method)">create_vs</a></span>
58
+ <span class='object_link'><a href="Dtf/Command.html#create_vs-class_method" title="Dtf::Command.create_vs (method)">create_vs</a></span>
59
59
 
60
- <small>Dtf::Commands</small>
60
+ <small>Dtf::Command</small>
61
61
 
62
62
  </li>
63
63
 
64
64
 
65
65
  <li class="r1 ">
66
- <span class='object_link'><a href="Dtf/Commands.html#delete_user-class_method" title="Dtf::Commands.delete_user (method)">delete_user</a></span>
66
+ <span class='object_link'><a href="Dtf/Command.html#delete_user-class_method" title="Dtf::Command.delete_user (method)">delete_user</a></span>
67
67
 
68
- <small>Dtf::Commands</small>
68
+ <small>Dtf::Command</small>
69
69
 
70
70
  </li>
71
71
 
72
72
 
73
73
  <li class="r2 ">
74
- <span class='object_link'><a href="Dtf/Commands.html#delete_vs-class_method" title="Dtf::Commands.delete_vs (method)">delete_vs</a></span>
74
+ <span class='object_link'><a href="Dtf/Command.html#delete_vs-class_method" title="Dtf::Command.delete_vs (method)">delete_vs</a></span>
75
75
 
76
- <small>Dtf::Commands</small>
76
+ <small>Dtf::Command</small>
77
77
 
78
78
  </li>
79
79
 
@@ -87,6 +87,14 @@
87
87
 
88
88
 
89
89
  <li class="r2 ">
90
+ <span class='object_link'><a href="Dtf/Command.html#process-class_method" title="Dtf::Command.process (method)">process</a></span>
91
+
92
+ <small>Dtf::Command</small>
93
+
94
+ </li>
95
+
96
+
97
+ <li class="r1 ">
90
98
  <span class='object_link'><a href="#raise_error-instance_method" title="#raise_error (method)">#raise_error</a></span>
91
99
 
92
100
  <small>Top Level Namespace</small>
data/doc/top-level-namespace.html CHANGED
@@ -94,18 +94,6 @@
94
94
 
95
95
  </p>
96
96
 
97
- <h2>Constant Summary</h2>
98
-
99
- <dl class="constants">
100
-
101
- <dt id="SUB_COMMANDS-constant" class="">SUB_COMMANDS =
102
-
103
- </dt>
104
- <dd><pre class="code"><span class='qwords_beg'>%w(</span><span class='tstring_content'>create_user</span><span class='words_sep'> </span><span class='tstring_content'>delete_user</span><span class='words_sep'> </span><span class='tstring_content'>create_vs</span><span class='words_sep'> </span><span class='tstring_content'>delete_vs</span><span class='words_sep'>)</span></pre></dd>
105
-
106
- </dl>
107
-
108
-
109
97
 
110
98
 
111
99
 
@@ -123,7 +111,7 @@
123
111
  <li class="public ">
124
112
  <span class="summary_signature">
125
113
 
126
- <a href="#display_errors-instance_method" title="#display_errors (instance method)">- (Object) <strong>display_errors</strong> </a>
114
+ <a href="#display_errors-instance_method" title="#display_errors (instance method)">- (Object) <strong>display_errors</strong>(cmd) </a>
127
115
 
128
116
 
129
117
 
@@ -145,7 +133,7 @@
145
133
  <li class="public ">
146
134
  <span class="summary_signature">
147
135
 
148
- <a href="#raise_error-instance_method" title="#raise_error (instance method)">- (Object) <strong>raise_error</strong> </a>
136
+ <a href="#raise_error-instance_method" title="#raise_error (instance method)">- (Object) <strong>raise_error</strong>(cmd) </a>
149
137
 
150
138
 
151
139
 
@@ -178,7 +166,7 @@
178
166
  <div class="method_details first">
179
167
  <h3 class="signature first" id="display_errors-instance_method">
180
168
 
181
- - (<tt>Object</tt>) <strong>display_errors</strong>
169
+ - (<tt>Object</tt>) <strong>display_errors</strong>(cmd)
182
170
 
183
171
 
184
172
 
@@ -196,9 +184,9 @@
196
184
  16</pre>
197
185
  </td>
198
186
  <td>
199
- <pre class="code"><span class="info file"># File 'lib/dtf/dtf_error_system.rb', line 13</span>
187
+ <pre class="code"><span class="info file"># File 'lib/dtf/error_system.rb', line 13</span>
200
188
 
201
- <span class='kw'>def</span> <span class='id identifier rubyid_display_errors'>display_errors</span><span class='lparen'>(</span><span class='rparen'>)</span>
189
+ <span class='kw'>def</span> <span class='id identifier rubyid_display_errors'>display_errors</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rparen'>)</span>
202
190
  <span class='comment'># TODO: Refactor error display to take sub-command as an arg
203
191
  </span> <span class='comment'># and display obj.errors.messages.each properly for each arg type.
204
192
  </span><span class='kw'>end</span></pre>
@@ -210,7 +198,7 @@
210
198
  <div class="method_details ">
211
199
  <h3 class="signature " id="raise_error-instance_method">
212
200
 
213
- - (<tt>Object</tt>) <strong>raise_error</strong>
201
+ - (<tt>Object</tt>) <strong>raise_error</strong>(cmd)
214
202
 
215
203
 
216
204
 
@@ -244,13 +232,13 @@
244
232
  11</pre>
245
233
  </td>
246
234
  <td>
247
- <pre class="code"><span class="info file"># File 'lib/dtf/dtf_error_system.rb', line 3</span>
235
+ <pre class="code"><span class="info file"># File 'lib/dtf/error_system.rb', line 3</span>
248
236
 
249
- <span class='kw'>def</span> <span class='id identifier rubyid_raise_error'>raise_error</span>
237
+ <span class='kw'>def</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rparen'>)</span>
250
238
  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span>
251
239
  <span class='kw'>rescue</span>
252
- <span class='gvar'>$stderr</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ERROR! </span><span class='embexpr_beg'>#{</span><span class='ivar'>@cmd</span><span class='rbrace'>}</span><span class='tstring_content'> did not receive all required options.</span><span class='tstring_end'>&quot;</span></span>
253
- <span class='gvar'>$stderr</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>See 'dtf </span><span class='embexpr_beg'>#{</span><span class='ivar'>@cmd</span><span class='rbrace'>}</span><span class='tstring_content'> -h' for help with this sub-command</span><span class='tstring_end'>&quot;</span></span>
240
+ <span class='gvar'>$stderr</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ERROR! </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rbrace'>}</span><span class='tstring_content'> did not receive all required options.</span><span class='tstring_end'>&quot;</span></span>
241
+ <span class='gvar'>$stderr</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>See 'dtf </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rbrace'>}</span><span class='tstring_content'> -h' for help with this sub-command</span><span class='tstring_end'>&quot;</span></span>
254
242
 
255
243
  <span class='comment'># Set non-zero exit value on error, for scripting use.
256
244
  </span> <span class='id identifier rubyid_abort'>abort</span><span class='lparen'>(</span><span class='rparen'>)</span>
@@ -265,7 +253,7 @@
265
253
  </div>
266
254
 
267
255
  <div id="footer">
268
- Generated on Fri Sep 14 22:41:21 2012 by
256
+ Generated on Sun Sep 16 12:04:53 2012 by
269
257
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
270
258
  0.8.2.1 (ruby-1.9.3).
271
259
  </div>
data/lib/dtf.rb CHANGED
@@ -5,18 +5,27 @@ require "dtf/version"
5
5
  module Dtf
6
6
  load "#{File.join(File.dirname(__FILE__), "/config/environment.rb")}"
7
7
 
8
- class Commands
8
+ # Dtf::Command contains all sub-commands availabe in the DTF master gem.
9
+ # All methods recieve the @cmd and @cmd_opts parsed from the command-line.
10
+ # They are what was captured in the ivars in Dtf::HelpSystem
11
+ class Command
9
12
 
10
- def process(cmd, cmd_opts)
13
+ # Process both the requested command and all/any parameters.
14
+ # NOTE: This method is the 'master' method. It parses @cmd for which sub-command to execute and then hands
15
+ # off to the appropriate method. All methods are a 1:1 match in their name.
16
+ # e.g 'create_user' sub-command is matched to the 'create_user' method of this class.
17
+ #
18
+ # This method requires, and processes, 2 arguments. The 'cmd' to process, and any 'cmd_opts' of that sub-command.
19
+ def self.process(cmd, cmd_opts)
11
20
  case cmd
12
21
  when "create_user"
13
- create_user(cmd_opts)
22
+ create_user(cmd, cmd_opts)
14
23
 
15
24
  when "delete_user"
16
25
  delete_user(cmd, cmd_opts)
17
26
 
18
27
  when "create_vs"
19
- create_vs(cmd_opts)
28
+ create_vs(cmd, cmd_opts)
20
29
 
21
30
  when "delete_vs"
22
31
  delete_vs(cmd, cmd_opts)
@@ -27,7 +36,15 @@ module Dtf
27
36
  end
28
37
  end
29
38
 
30
- def self.create_user(cmd_opts)
39
+ # This sub-command is used to add a User to the Test Framework system
40
+ #
41
+ # Required Parameters are:
42
+ # --user-name [String], --full-name [String], --email-address [String]
43
+ #
44
+ # '--user-name' is used to specify the user_name of the created User, and *must* be unique in the system.
45
+ # '--full-name' is the Real Name of the created User.
46
+ # '--email-address' is the email address of the created User, and *must* be unique in the system.
47
+ def self.create_user(cmd, cmd_opts)
31
48
  if [:user_name_given, :full_name_given, :email_address_given].all? { |sym| cmd_opts.key?(sym) } then
32
49
  user = User.where(user_name: cmd_opts[:user_name],
33
50
  full_name: cmd_opts[:full_name],
@@ -46,10 +63,26 @@ module Dtf
46
63
  abort()
47
64
  end
48
65
  else
49
- raise_error # This error here is thrown when not all params are provided
66
+ raise_error(cmd) # This error here is thrown when not all params are provided
50
67
  end
51
68
  end
52
69
 
70
+ # This sub-command removes a User from the Testing Framework system
71
+ #
72
+ # Required Parameters are:
73
+ # --user-name [String]
74
+ #
75
+ # '--user-name' is the assigned user_name of the User you wish to delete.
76
+ #
77
+ # Optional Flags are:
78
+ # --delete-all|--no-delete-all
79
+ #
80
+ # By default this command will delete *all* Verification Suites owned by the deleted user.
81
+ # The default behaviour is as if the sub-command had been invoked passing the '--delete-all' flag explicitly.
82
+ #
83
+ # To delete the user, but *keep* their VS, pass the '--no-delete-all' flag.
84
+ # This flag will find all Verification Suites owned by the user being deleted, and reassign them
85
+ # to 'Library Owner' (user_name: library_owner) which is the generic in-house User shipped with DTF.
53
86
  def self.delete_user(cmd, cmd_opts)
54
87
  if [:user_name_given, :delete_all].all? { |sym| cmd_opts.key?(sym) } then
55
88
  # NOTE: :delete_all is 'true' by default. passing '--no-delete-all' sets it to false,
@@ -76,11 +109,25 @@ module Dtf
76
109
  end
77
110
  end
78
111
  else
79
- raise_error
112
+ raise_error(cmd)
80
113
  end
81
114
  end
82
115
 
83
- def self.create_vs(cmd_opts)
116
+ # This sub-command generates, adds, and associates a Verification Suite in the Testing Framework system.
117
+ #
118
+ # Required Parameters are:
119
+ # --user-name [String], --name [String]
120
+ #
121
+ # '--user-name' is the user_name of the User that should own this Verification Suite.
122
+ # '--name' is the descriptive name of the Verification Suite.
123
+ #
124
+ # Options are:
125
+ # --description [String]
126
+ #
127
+ # This *optional* parameter is for providing a description of the Verification Suite's use.
128
+ # e.g. --description "RSpec Verification"
129
+ #
130
+ def self.create_vs(cmd, cmd_opts)
84
131
  if [:user_name_given, :name_given].all? { |sym| cmd_opts.key?(sym) } then
85
132
  user = User.find_by_user_name(cmd_opts[:user_name])
86
133
  vs = user.verification_suites.create(name: cmd_opts[:name], description: cmd_opts[:description])
@@ -91,10 +138,17 @@ module Dtf
91
138
  abort()
92
139
  end
93
140
  else
94
- raise_error
141
+ raise_error(cmd)
95
142
  end
96
143
  end
97
-
144
+
145
+ # This sub-command removes a Verification Suite from the Testing Framework system
146
+ #
147
+ # Required Parameters are:
148
+ # --user-name [String], --id [Integer]
149
+ #
150
+ # The '--user-name' parameter is the user_name of the User that owns the Verification Suite you wish to delete
151
+ # The '--id' parameter is the ID # of the Verification Suite you wish to delete, as provided by @vs.id
98
152
  def self.delete_vs(cmd, cmd_opts)
99
153
  if [:user_name_given, :id_given].all? { |sym| cmd_opts.key?(sym) } then
100
154
  puts "#{cmd} called! Deleting #{cmd_opts[:user_name]}\'s VS with ID \'#{cmd_opts[:id]}\'"
@@ -102,7 +156,7 @@ module Dtf
102
156
  vs = user.verification_suites.find(cmd_opts[:id])
103
157
  VerificationSuite.delete(vs)
104
158
  else
105
- raise_error
159
+ raise_error(cmd)
106
160
  end
107
161
  end
108
162