Debian Codegraph @

docs/extract.html

raw
1 <!DOCTYPE html>
2 <html>
3 <head>
4 <meta http-equiv="content-type" content="text/html;charset=utf-8">
5 <title>extract.pp</title>
6 <link rel="stylesheet" href="http://jashkenas.github.com/docco/resources/docco.css">
7 </head>
8 <body>
9 <div id='container'>
10 <div id="background"></div>
11 <div id="jump_to">
12 Jump To &hellip;
13 <div id="jump_wrapper">
14 <div id="jump_page">
15 <a class="source" href="deploy.html">deploy.pp</a>
16 <a class="source" href="extract.html">extract.pp</a>
17 <a class="source" href="file.html">file.pp</a>
18 <a class="source" href="init.html">init.pp</a>
19 </div>
20 </div>
21 </div>
22 <table cellspacing=0 cellpadding=0>
23 <thead>
24 <tr>
25 <th class=docs><h1>extract.pp</h1></th>
26 <th class=code></th>
27 </tr>
28 </thead>
29 <tbody>
30 <tr id='section-Define:_staging::extract'>
31 <td class=docs>
32 <div class="pilwrap">
33 <a class="pilcrow" href="#section-Define:_staging::extract">&#182;</a>
34 </div>
35 <h3>Define: staging::extract</h3>
36
37 <p>Define resource to extract files from staging directories to target directories.</p>
38
39 <h3>Parameters:</h3>
40
41 <ul>
42 <li>[<em>target</em>]: the target extraction directory (default: )</li>
43 <li>[<em>source</em>]: the source compression file, supports tar, tar.gz, zip, war (default: undef)</li>
44 <li>[<em>creates</em>]: the file created after extraction. if unspecified defaults ${staging::path}/${caller_module_name}/${name} ${target}/${name} (default: undef)</li>
45 <li>[<em>unless</em>]: alternative way to conditionally check whether to extract file. (default: undef)</li>
46 <li>[<em>onlyif</em>]: alternative way to conditionally check whether to extract file. (default: undef)</li>
47 <li>[<em>user</em>]: extract file as this user. (default: undef)</li>
48 <li>[<em>group</em>]: extract file as this group. (default: undef)</li>
49 <li>[<em>environment</em>]: environment variables. (default: undef)</li>
50 <li>[<em>subdir</em>]: subdir per module in staging directory. (default: $caller_module_name)</li>
51 </ul>
52
53
54 <h3>Usage:</h3>
55
56 <pre><code>$caller_module_name = 'demo'
57
58 class { 'staging':
59 path =&gt; '/tmp/staging',
60 }
61
62 staging::file { 'sample.tar.gz':
63 source =&gt; 'puppet:///modules/staging/sample.tar.gz'
64 }
65
66 staging::extract { 'sample.tar.gz':
67 target =&gt; '/tmp/staging',
68 creates =&gt; '/tmp/staging/sample',
69 require =&gt; Staging::File['sample.tar.gz'],
70 }
71 </code></pre>
72 </td>
73 <td class=code>
74 <div class='highlight'><pre><span class="n">define</span> <span class="n">staging</span><span class="o">::</span><span class="n">extract</span> <span class="p">(</span>
75 <span class="vg">$target</span><span class="p">,</span>
76 <span class="vg">$source</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
77 <span class="vg">$creates</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
78 <span class="vg">$unless</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
79 <span class="vg">$onlyif</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
80 <span class="vg">$user</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
81 <span class="vg">$group</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
82 <span class="vg">$environment</span> <span class="o">=</span> <span class="k">undef</span><span class="p">,</span>
83 <span class="vg">$subdir</span> <span class="o">=</span> <span class="vg">$caller_module_name</span>
84 <span class="p">)</span> <span class="p">{</span>
85
86 <span class="kp">include</span> <span class="n">staging</span>
87
88 <span class="k">if</span> <span class="vg">$source</span> <span class="p">{</span>
89 <span class="vg">$source_path</span> <span class="o">=</span> <span class="vg">$source</span>
90 <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
91 <span class="vg">$source_path</span> <span class="o">=</span> <span class="s2">&quot;${staging::path}/${subdir}/${name}&quot;</span>
92 <span class="p">}</span></pre></div>
93 </td>
94 </tr>
95 <tr id='section-2'>
96 <td class=docs>
97 <div class="pilwrap">
98 <a class="pilcrow" href="#section-2">&#182;</a>
99 </div>
100 <p>Use user supplied creates path, set default value if creates, unless or
101 onlyif is not supplied.</p>
102
103 </td>
104 <td class=code>
105 <div class='highlight'><pre> <span class="k">if</span> <span class="vg">$creates</span> <span class="p">{</span>
106 <span class="vg">$creates_path</span> <span class="o">=</span> <span class="vg">$creates</span>
107 <span class="p">}</span> <span class="k">elsif</span> <span class="o">!</span> <span class="p">(</span><span class="vg">$unless</span> <span class="ow">or</span> <span class="vg">$onlyif</span><span class="p">)</span> <span class="p">{</span>
108 <span class="k">if</span> <span class="vg">$name</span> <span class="o">=~</span> <span class="sr">/.tar.gz$/</span> <span class="p">{</span>
109 <span class="vg">$folder</span> <span class="o">=</span> <span class="n">staging_parse</span><span class="p">(</span><span class="vg">$name</span><span class="p">,</span> <span class="s1">&#39;basename&#39;</span><span class="p">,</span> <span class="s1">&#39;.tar.gz&#39;</span><span class="p">)</span>
110 <span class="vg">$creates_path</span> <span class="o">=</span> <span class="s2">&quot;${target}/${folder}&quot;</span>
111 <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
112 <span class="vg">$folder</span> <span class="o">=</span> <span class="n">staging_parse</span><span class="p">(</span><span class="vg">$name</span><span class="p">,</span> <span class="s1">&#39;basename&#39;</span><span class="p">)</span>
113 <span class="vg">$creates_path</span> <span class="o">=</span> <span class="s2">&quot;${target}/${folder}&quot;</span>
114 <span class="p">}</span>
115 <span class="p">}</span>
116
117 <span class="k">if</span> <span class="n">scope_defaults</span><span class="p">(</span><span class="s1">&#39;Exec&#39;</span><span class="p">,</span><span class="s1">&#39;path&#39;</span><span class="p">)</span> <span class="p">{</span>
118 <span class="no">Exec</span><span class="p">{</span>
119 <span class="n">cwd</span> <span class="o">=&gt;</span> <span class="vg">$target</span><span class="p">,</span>
120 <span class="n">user</span> <span class="o">=&gt;</span> <span class="vg">$user</span><span class="p">,</span>
121 <span class="n">group</span> <span class="o">=&gt;</span> <span class="vg">$group</span><span class="p">,</span>
122 <span class="n">environment</span> <span class="o">=&gt;</span> <span class="vg">$environment</span><span class="p">,</span>
123 <span class="n">creates</span> <span class="o">=&gt;</span> <span class="vg">$creates_path</span><span class="p">,</span>
124 <span class="k">unless</span> <span class="o">=&gt;</span> <span class="vg">$unless</span><span class="p">,</span>
125 <span class="n">onlyif</span> <span class="o">=&gt;</span> <span class="vg">$onlyif</span><span class="p">,</span>
126 <span class="n">logoutput</span> <span class="o">=&gt;</span> <span class="n">on_failure</span><span class="p">,</span>
127 <span class="p">}</span>
128 <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
129 <span class="no">Exec</span><span class="p">{</span>
130 <span class="n">path</span> <span class="o">=&gt;</span> <span class="vg">$:</span><span class="ss">:path</span><span class="p">,</span>
131 <span class="n">cwd</span> <span class="o">=&gt;</span> <span class="vg">$target</span><span class="p">,</span>
132 <span class="n">user</span> <span class="o">=&gt;</span> <span class="vg">$user</span><span class="p">,</span>
133 <span class="n">group</span> <span class="o">=&gt;</span> <span class="vg">$group</span><span class="p">,</span>
134 <span class="n">environment</span> <span class="o">=&gt;</span> <span class="vg">$environment</span><span class="p">,</span>
135 <span class="n">creates</span> <span class="o">=&gt;</span> <span class="vg">$creates_path</span><span class="p">,</span>
136 <span class="k">unless</span> <span class="o">=&gt;</span> <span class="vg">$unless</span><span class="p">,</span>
137 <span class="n">onlyif</span> <span class="o">=&gt;</span> <span class="vg">$onlyif</span><span class="p">,</span>
138 <span class="n">logoutput</span> <span class="o">=&gt;</span> <span class="n">on_failure</span><span class="p">,</span>
139 <span class="p">}</span>
140 <span class="p">}</span>
141
142 <span class="k">case</span> <span class="vg">$name</span> <span class="p">{</span>
143 <span class="sr">/.tar$/</span><span class="p">:</span> <span class="p">{</span>
144 <span class="vg">$command</span> <span class="o">=</span> <span class="s2">&quot;tar xf ${source_path}&quot;</span>
145 <span class="p">}</span>
146
147 <span class="sr">/(.tgz|.tar.gz)$/</span><span class="p">:</span> <span class="p">{</span>
148 <span class="k">if</span> <span class="vg">$:</span><span class="ss">:osfamily</span> <span class="o">==</span> <span class="s1">&#39;Solaris&#39;</span> <span class="p">{</span>
149 <span class="vg">$command</span> <span class="o">=</span> <span class="s2">&quot;gunzip -dc &lt; ${source_path} | tar xf - &quot;</span>
150 <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
151 <span class="vg">$command</span> <span class="o">=</span> <span class="s2">&quot;tar xzf ${source_path}&quot;</span>
152 <span class="p">}</span>
153 <span class="p">}</span>
154
155 <span class="sr">/.zip$/</span><span class="p">:</span> <span class="p">{</span>
156 <span class="vg">$command</span> <span class="o">=</span> <span class="s2">&quot;unzip ${source_path}&quot;</span>
157 <span class="p">}</span>
158
159 <span class="sr">/.war$/</span><span class="p">:</span> <span class="p">{</span>
160 <span class="vg">$command</span> <span class="o">=</span> <span class="s2">&quot;jar xf ${source_path}&quot;</span>
161 <span class="p">}</span>
162
163 <span class="n">default</span><span class="p">:</span> <span class="p">{</span>
164 <span class="nb">fail</span><span class="p">(</span><span class="s2">&quot;staging::extract: unsupported file format ${name}.&quot;</span><span class="p">)</span>
165 <span class="p">}</span>
166 <span class="p">}</span>
167
168 <span class="nb">exec</span> <span class="p">{</span> <span class="s2">&quot;extract ${name}&quot;</span><span class="p">:</span>
169 <span class="n">command</span> <span class="o">=&gt;</span> <span class="vg">$command</span><span class="p">,</span>
170 <span class="p">}</span>
171 <span class="p">}</span></pre></div>
172 </td>
173 </tr>
174 </table>
175 </div>
176 </body>