1 <?xml version="1.0" encoding="iso-8859-1"?>
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8 <title>Class: MCollective::Shell</title>
9 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10 <meta http-equiv="Content-Script-Type" content="text/javascript" />
11 <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
12 <script type="text/javascript">
15 function popupCode( url ) {
16 window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
19 function toggleCode( id ) {
20 if ( document.getElementById )
21 elem = document.getElementById( id );
22 else if ( document.all )
23 elem = eval( "document.all." + id );
27 elemStyle = elem.style;
29 if ( elemStyle.display != "block" ) {
30 elemStyle.display = "block"
32 elemStyle.display = "none"
38 // Make codeblocks hidden by default
39 document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
49 <div id="classHeader">
50 <table class="header-table">
51 <tr class="top-aligned-row">
52 <td><strong>Class</strong></td>
53 <td class="class-name-in-header">MCollective::Shell</td>
55 <tr class="top-aligned-row">
56 <td><strong>In:</strong></td>
58 <a href="../../files/lib/mcollective/shell_rb.html">
59 lib/mcollective/shell.rb
65 <tr class="top-aligned-row">
66 <td><strong>Parent:</strong></td>
73 <!-- banner header -->
75 <div id="bodyContent">
79 <div id="contextContent">
81 <div id="description">
83 Wrapper around systemu that handles executing of system commands in a way
84 that makes stdout, stderr and status available. Supports timeouts and sets
85 a default sane environment.
88 s = Shell.new("date", opts)
92 puts s.status.exitstatus
95 Options hash can have:
98 cwd - the working directory the command will be run from
99 stdin - a string that will be sent to stdin of the program
100 stdout - a variable that will receive stdout, must support <<
101 stderr - a variable that will receive stdin, must support <<
102 environment - the shell environment, defaults to include LC_ALL=C
103 set to nil to clear the environment even of LC_ALL
111 <div id="method-list">
112 <h3 class="section-bar">Methods</h3>
114 <div class="name-list">
115 <a href="#M000371">new</a>
116 <a href="#M000372">runcommand</a>
131 <div id="attribute-list">
132 <h3 class="section-bar">Attributes</h3>
134 <div class="name-list">
136 <tr class="top-aligned-row context-row">
137 <td class="context-item-name">command</td>
138 <td class="context-item-value"> [R] </td>
139 <td class="context-item-desc"></td>
141 <tr class="top-aligned-row context-row">
142 <td class="context-item-name">cwd</td>
143 <td class="context-item-value"> [R] </td>
144 <td class="context-item-desc"></td>
146 <tr class="top-aligned-row context-row">
147 <td class="context-item-name">environment</td>
148 <td class="context-item-value"> [R] </td>
149 <td class="context-item-desc"></td>
151 <tr class="top-aligned-row context-row">
152 <td class="context-item-name">status</td>
153 <td class="context-item-value"> [R] </td>
154 <td class="context-item-desc"></td>
156 <tr class="top-aligned-row context-row">
157 <td class="context-item-name">stderr</td>
158 <td class="context-item-value"> [R] </td>
159 <td class="context-item-desc"></td>
161 <tr class="top-aligned-row context-row">
162 <td class="context-item-name">stdin</td>
163 <td class="context-item-value"> [R] </td>
164 <td class="context-item-desc"></td>
166 <tr class="top-aligned-row context-row">
167 <td class="context-item-name">stdout</td>
168 <td class="context-item-value"> [R] </td>
169 <td class="context-item-desc"></td>
177 <!-- if method_list -->
179 <h3 class="section-bar">Public Class methods</h3>
181 <div id="method-M000371" class="method-detail">
182 <a name="M000371"></a>
184 <div class="method-heading">
185 <a href="#M000371" class="method-signature">
186 <span class="method-name">new</span><span class="method-args">(command, options={})</span>
190 <div class="method-description">
191 <p><a class="source-toggle" href="#"
192 onclick="toggleCode('M000371-source');return false;">[Source]</a></p>
193 <div class="method-source-code" id="M000371-source">
195 <span class="ruby-comment cmt"># File lib/mcollective/shell.rb, line 24</span>
196 24: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">options</span>={})
197 25: <span class="ruby-ivar">@environment</span> = {<span class="ruby-value str">"LC_ALL"</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"C"</span>}
198 26: <span class="ruby-ivar">@command</span> = <span class="ruby-identifier">command</span>
199 27: <span class="ruby-ivar">@status</span> = <span class="ruby-keyword kw">nil</span>
200 28: <span class="ruby-ivar">@stdout</span> = <span class="ruby-value str">""</span>
201 29: <span class="ruby-ivar">@stderr</span> = <span class="ruby-value str">""</span>
202 30: <span class="ruby-ivar">@stdin</span> = <span class="ruby-keyword kw">nil</span>
203 31: <span class="ruby-ivar">@cwd</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">tmpdir</span>
205 33: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">opt</span>, <span class="ruby-identifier">val</span><span class="ruby-operator">|</span>
206 34: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">opt</span>.<span class="ruby-identifier">to_s</span>
207 35: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"stdout"</span>
208 36: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"stdout should support <<"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"<<"</span>)
209 37: <span class="ruby-ivar">@stdout</span> = <span class="ruby-identifier">val</span>
211 39: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"stderr"</span>
212 40: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"stderr should support <<"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">"<<"</span>)
213 41: <span class="ruby-ivar">@stderr</span> = <span class="ruby-identifier">val</span>
215 43: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"stdin"</span>
216 44: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"stdin should be a String"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
217 45: <span class="ruby-ivar">@stdin</span> = <span class="ruby-identifier">val</span>
219 47: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"cwd"</span>
220 48: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Directory #{val} does not exist"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">val</span>)
221 49: <span class="ruby-ivar">@cwd</span> = <span class="ruby-identifier">val</span>
223 51: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">"environment"</span>
224 52: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">nil?</span>
225 53: <span class="ruby-ivar">@environment</span> = {}
226 54: <span class="ruby-keyword kw">else</span>
227 55: <span class="ruby-ivar">@environment</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">val</span>.<span class="ruby-identifier">dup</span>)
228 56: <span class="ruby-keyword kw">end</span>
229 57: <span class="ruby-keyword kw">end</span>
230 58: <span class="ruby-keyword kw">end</span>
231 59: <span class="ruby-keyword kw">end</span>
237 <h3 class="section-bar">Public Instance methods</h3>
239 <div id="method-M000372" class="method-detail">
240 <a name="M000372"></a>
242 <div class="method-heading">
243 <a href="#M000372" class="method-signature">
244 <span class="method-name">runcommand</span><span class="method-args">()</span>
248 <div class="method-description">
250 Actually does the systemu call passing in the correct environment, stdout
253 <p><a class="source-toggle" href="#"
254 onclick="toggleCode('M000372-source');return false;">[Source]</a></p>
255 <div class="method-source-code" id="M000372-source">
257 <span class="ruby-comment cmt"># File lib/mcollective/shell.rb, line 62</span>
258 62: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">runcommand</span>
259 63: <span class="ruby-identifier">opts</span> = {<span class="ruby-value str">"env"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@environment</span>,
260 64: <span class="ruby-value str">"stdout"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@stdout</span>,
261 65: <span class="ruby-value str">"stderr"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@stderr</span>,
262 66: <span class="ruby-value str">"cwd"</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@cwd</span>}
264 68: <span class="ruby-identifier">opts</span>[<span class="ruby-value str">"stdin"</span>] = <span class="ruby-ivar">@stdin</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@stdin</span>
266 70: <span class="ruby-comment cmt"># Check if the parent thread is alive. If it should die,</span>
267 71: <span class="ruby-comment cmt"># and the process spawned by systemu is still alive,</span>
268 72: <span class="ruby-comment cmt"># fire off a blocking waitpid and wait for the process to</span>
269 73: <span class="ruby-comment cmt"># finish so that we can avoid zombies.</span>
270 74: <span class="ruby-identifier">thread</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>
271 75: <span class="ruby-ivar">@status</span> = <span class="ruby-identifier">systemu</span>(<span class="ruby-ivar">@command</span>, <span class="ruby-identifier">opts</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">cid</span><span class="ruby-operator">|</span>
272 76: <span class="ruby-keyword kw">begin</span>
273 77: <span class="ruby-keyword kw">while</span>(<span class="ruby-identifier">thread</span>.<span class="ruby-identifier">alive?</span>)
274 78: <span class="ruby-identifier">sleep</span> <span class="ruby-value">0</span><span class="ruby-value">.1</span>
275 79: <span class="ruby-keyword kw">end</span>
277 81: <span class="ruby-constant">Process</span>.<span class="ruby-identifier">waitpid</span>(<span class="ruby-identifier">cid</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Process</span>.<span class="ruby-identifier">getpgid</span>(<span class="ruby-identifier">cid</span>)
278 82: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">SystemExit</span>
279 83: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ESRCH</span>
280 84: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ECHILD</span>
281 85: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
282 86: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">info</span>(<span class="ruby-node">"Unexpected exception received while waiting for child process: #{e.class}: #{e}"</span>)
283 87: <span class="ruby-keyword kw">end</span>
284 88: <span class="ruby-keyword kw">end</span>
285 89: <span class="ruby-keyword kw">end</span>
298 <div id="validator-badges">
299 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>