~ubuntu-branches/ubuntu/lucid/cedar-backup2/lucid

<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Revision : $Id: testutil.py 949 2009-08-16 20:04:58Z pronovic $</tt> </tt>

<a name="L210"></a><tt class="py-lineno">210</tt>  <tt class="py-line">   <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>

<a name="L211"></a><tt class="py-lineno">211</tt>  <tt class="py-line">      <tt class="py-name">tar</tt><tt class="py-op">.</tt><tt class="py-name">format</tt> <tt class="py-op">=</tt> <tt class="py-name">tarfile</tt><tt class="py-op">.</tt><tt class="py-name">GNU_FORMAT</tt> </tt>

<a name="L212"></a><tt class="py-lineno">212</tt>  <tt class="py-line">   <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>

<a name="L213"></a><tt class="py-lineno">213</tt>  <tt class="py-line">      <tt class="py-name">tar</tt><tt class="py-op">.</tt><tt class="py-name">posix</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>

<a name="L214"></a><tt class="py-lineno">214</tt>  <tt class="py-line">   <tt class="py-keyword">for</tt> <tt class="py-name">tarinfo</tt> <tt class="py-keyword">in</tt> <tt class="py-name">tar</tt><tt class="py-op">:</tt> </tt>

<a name="L215"></a><tt class="py-lineno">215</tt>  <tt class="py-line">      <tt class="py-name">tar</tt><tt class="py-op">.</tt><tt class="py-name">extract</tt><tt class="py-op">(</tt><tt class="py-name">tarinfo</tt><tt class="py-op">,</tt> <tt class="py-name">tmpdir</tt><tt class="py-op">)</tt> </tt>

</div><a name="L216"></a><tt class="py-lineno">216</tt>  <tt class="py-line"> </tt>

<a name="L217"></a><tt class="py-lineno">217</tt>  <tt class="py-line"> </tt>

<a name="L218"></a><tt class="py-lineno">218</tt>  <tt class="py-line"><tt class="py-comment">###########################</tt> </tt>

<a name="L219"></a><tt class="py-lineno">219</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># changeFileAge() function</tt> </tt>

<a name="L220"></a><tt class="py-lineno">220</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">###########################</tt> </tt>

<a name="L221"></a><tt class="py-lineno">221</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="changeFileAge"></a><div id="changeFileAge-def"><a name="L222"></a><tt class="py-lineno">222</tt> <a class="py-toggle" href="#" id="changeFileAge-toggle" onclick="return toggle('changeFileAge');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#changeFileAge">changeFileAge</a><tt class="py-op">(</tt><tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">subtract</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="changeFileAge-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="changeFileAge-expanded"><a name="L223"></a><tt class="py-lineno">223</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L224"></a><tt class="py-lineno">224</tt>  <tt class="py-line"><tt class="py-docstring">   Changes a file age using the C{os.utime} function.</tt> </tt>

<a name="L225"></a><tt class="py-lineno">225</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L226"></a><tt class="py-lineno">226</tt>  <tt class="py-line"><tt class="py-docstring">   @note: Some platforms don't seem to be able to set an age precisely.  As a</tt> </tt>

<a name="L227"></a><tt class="py-lineno">227</tt>  <tt class="py-line"><tt class="py-docstring">   result, whereas we might have intended to set an age of 86400 seconds, we</tt> </tt>

<a name="L228"></a><tt class="py-lineno">228</tt>  <tt class="py-line"><tt class="py-docstring">   actually get an age of 86399.375 seconds.  When util.calculateFileAge()</tt> </tt>

<a name="L229"></a><tt class="py-lineno">229</tt>  <tt class="py-line"><tt class="py-docstring">   looks at that the file, it calculates an age of 0.999992766204 days, which</tt> </tt>

<a name="L230"></a><tt class="py-lineno">230</tt>  <tt class="py-line"><tt class="py-docstring">   then gets truncated down to zero whole days.  The tests get very confused.</tt> </tt>

<a name="L231"></a><tt class="py-lineno">231</tt>  <tt class="py-line"><tt class="py-docstring">   To work around this, I always subtract off one additional second as a fudge</tt> </tt>

<a name="L232"></a><tt class="py-lineno">232</tt>  <tt class="py-line"><tt class="py-docstring">   factor.  That way, the file age will be I{at least} as old as requested</tt> </tt>

<a name="L233"></a><tt class="py-lineno">233</tt>  <tt class="py-line"><tt class="py-docstring">   later on.</tt> </tt>

<a name="L234"></a><tt class="py-lineno">234</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L235"></a><tt class="py-lineno">235</tt>  <tt class="py-line"><tt class="py-docstring">   @param filename: File to operate on.</tt> </tt>

<a name="L236"></a><tt class="py-lineno">236</tt>  <tt class="py-line"><tt class="py-docstring">   @param subtract: Number of seconds to subtract from the current time.</tt> </tt>

<a name="L237"></a><tt class="py-lineno">237</tt>  <tt class="py-line"><tt class="py-docstring">   @raise ValueError: If a path cannot be encoded properly.</tt> </tt>

<a name="L238"></a><tt class="py-lineno">238</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L239"></a><tt class="py-lineno">239</tt>  <tt class="py-line">   <tt class="py-name">filename</tt> <tt class="py-op">=</tt> <tt id="link-18" class="py-name"><a title="CedarBackup2.util.encodePath" class="py-name" href="#" onclick="return doclink('link-18', 'encodePath', 'link-3');">encodePath</a></tt><tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">)</tt> </tt>

<a name="L240"></a><tt class="py-lineno">240</tt>  <tt class="py-line">   <tt class="py-name">newTime</tt> <tt class="py-op">=</tt> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">time</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">-</tt> <tt class="py-number">1</tt><tt class="py-op">;</tt> </tt>

<a name="L241"></a><tt class="py-lineno">241</tt>  <tt class="py-line">   <tt class="py-keyword">if</tt> <tt class="py-name">subtract</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>

<a name="L242"></a><tt class="py-lineno">242</tt>  <tt class="py-line">      <tt class="py-name">newTime</tt> <tt class="py-op">-=</tt> <tt class="py-name">subtract</tt> </tt>

<a name="L243"></a><tt class="py-lineno">243</tt>  <tt class="py-line">   <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">utime</tt><tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">newTime</tt><tt class="py-op">,</tt> <tt class="py-name">newTime</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>

</div><a name="L244"></a><tt class="py-lineno">244</tt>  <tt class="py-line"> </tt>

<a name="L245"></a><tt class="py-lineno">245</tt>  <tt class="py-line"> </tt>

<a name="L246"></a><tt class="py-lineno">246</tt>  <tt class="py-line"><tt class="py-comment">###########################</tt> </tt>

<a name="L247"></a><tt class="py-lineno">247</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># getMaskAsMode() function</tt> </tt>

<a name="L248"></a><tt class="py-lineno">248</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">###########################</tt> </tt>

<a name="L249"></a><tt class="py-lineno">249</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="getMaskAsMode"></a><div id="getMaskAsMode-def"><a name="L250"></a><tt class="py-lineno">250</tt> <a class="py-toggle" href="#" id="getMaskAsMode-toggle" onclick="return toggle('getMaskAsMode');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#getMaskAsMode">getMaskAsMode</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="getMaskAsMode-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="getMaskAsMode-expanded"><a name="L251"></a><tt class="py-lineno">251</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L252"></a><tt class="py-lineno">252</tt>  <tt class="py-line"><tt class="py-docstring">   Returns the user's current umask inverted to a mode.</tt> </tt>

<a name="L253"></a><tt class="py-lineno">253</tt>  <tt class="py-line"><tt class="py-docstring">   A mode is mostly a bitwise inversion of a mask, i.e. mask 002 is mode 775.</tt> </tt>

<a name="L254"></a><tt class="py-lineno">254</tt>  <tt class="py-line"><tt class="py-docstring">   @return: Umask converted to a mode, as an integer.</tt> </tt>

<a name="L255"></a><tt class="py-lineno">255</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L256"></a><tt class="py-lineno">256</tt>  <tt class="py-line">   <tt class="py-name">umask</tt> <tt class="py-op">=</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">umask</tt><tt class="py-op">(</tt><tt class="py-number">0777</tt><tt class="py-op">)</tt> </tt>

<a name="L257"></a><tt class="py-lineno">257</tt>  <tt class="py-line">   <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">umask</tt><tt class="py-op">(</tt><tt class="py-name">umask</tt><tt class="py-op">)</tt> </tt>

<a name="L258"></a><tt class="py-lineno">258</tt>  <tt class="py-line">   <tt class="py-keyword">return</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-op">~</tt><tt class="py-name">umask</tt> <tt class="py-op">&amp;</tt> <tt class="py-number">0777</tt><tt class="py-op">)</tt>  <tt class="py-comment"># invert, then use only lower bytes</tt> </tt>

</div><a name="L259"></a><tt class="py-lineno">259</tt>  <tt class="py-line"> </tt>

<a name="L260"></a><tt class="py-lineno">260</tt>  <tt class="py-line"> </tt>

<a name="L261"></a><tt class="py-lineno">261</tt>  <tt class="py-line"><tt class="py-comment">######################</tt> </tt>

<a name="L262"></a><tt class="py-lineno">262</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># getLogin() function</tt> </tt>

<a name="L263"></a><tt class="py-lineno">263</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">######################</tt> </tt>

<a name="L264"></a><tt class="py-lineno">264</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="getLogin"></a><div id="getLogin-def"><a name="L265"></a><tt class="py-lineno">265</tt> <a class="py-toggle" href="#" id="getLogin-toggle" onclick="return toggle('getLogin');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#getLogin">getLogin</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="getLogin-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="getLogin-expanded"><a name="L266"></a><tt class="py-lineno">266</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L267"></a><tt class="py-lineno">267</tt>  <tt class="py-line"><tt class="py-docstring">   Returns the name of the currently-logged in user.  This might fail under</tt> </tt>

<a name="L268"></a><tt class="py-lineno">268</tt>  <tt class="py-line"><tt class="py-docstring">   some circumstances - but if it does, our tests would fail anyway.</tt> </tt>

<a name="L269"></a><tt class="py-lineno">269</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L270"></a><tt class="py-lineno">270</tt>  <tt class="py-line">   <tt class="py-keyword">return</tt> <tt class="py-name">getpass</tt><tt class="py-op">.</tt><tt class="py-name">getuser</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>

</div><a name="L271"></a><tt class="py-lineno">271</tt>  <tt class="py-line"> </tt>

<a name="L272"></a><tt class="py-lineno">272</tt>  <tt class="py-line"> </tt>

<a name="L273"></a><tt class="py-lineno">273</tt>  <tt class="py-line"><tt class="py-comment">############################</tt> </tt>

<a name="L274"></a><tt class="py-lineno">274</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># randomFilename() function</tt> </tt>

<a name="L275"></a><tt class="py-lineno">275</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">############################</tt> </tt>

<a name="L276"></a><tt class="py-lineno">276</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="randomFilename"></a><div id="randomFilename-def"><a name="L277"></a><tt class="py-lineno">277</tt> <a class="py-toggle" href="#" id="randomFilename-toggle" onclick="return toggle('randomFilename');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#randomFilename">randomFilename</a><tt class="py-op">(</tt><tt class="py-param">length</tt><tt class="py-op">,</tt> <tt class="py-param">prefix</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">suffix</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="randomFilename-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="randomFilename-expanded"><a name="L278"></a><tt class="py-lineno">278</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L279"></a><tt class="py-lineno">279</tt>  <tt class="py-line"><tt class="py-docstring">   Generates a random filename with the given length.</tt> </tt>

<a name="L280"></a><tt class="py-lineno">280</tt>  <tt class="py-line"><tt class="py-docstring">   @param length: Length of filename.</tt> </tt>

<a name="L281"></a><tt class="py-lineno">281</tt>  <tt class="py-line"><tt class="py-docstring">   @return Random filename.</tt> </tt>

<a name="L282"></a><tt class="py-lineno">282</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L283"></a><tt class="py-lineno">283</tt>  <tt class="py-line">   <tt class="py-name">characters</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">None</tt><tt class="py-op">]</tt> <tt class="py-op">*</tt> <tt class="py-name">length</tt> </tt>

<a name="L284"></a><tt class="py-lineno">284</tt>  <tt class="py-line">   <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">xrange</tt><tt class="py-op">(</tt><tt class="py-name">length</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

<a name="L285"></a><tt class="py-lineno">285</tt>  <tt class="py-line">      <tt class="py-name">characters</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">random</tt><tt class="py-op">.</tt><tt class="py-name">choice</tt><tt class="py-op">(</tt><tt class="py-name">string</tt><tt class="py-op">.</tt><tt class="py-name">uppercase</tt><tt class="py-op">)</tt> </tt>

<a name="L286"></a><tt class="py-lineno">286</tt>  <tt class="py-line">   <tt class="py-keyword">if</tt> <tt class="py-name">prefix</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>

<a name="L287"></a><tt class="py-lineno">287</tt>  <tt class="py-line">      <tt class="py-name">prefix</tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt> </tt>

<a name="L288"></a><tt class="py-lineno">288</tt>  <tt class="py-line">   <tt class="py-keyword">if</tt> <tt class="py-name">suffix</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>

<a name="L289"></a><tt class="py-lineno">289</tt>  <tt class="py-line">      <tt class="py-name">suffix</tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt> </tt>

<a name="L290"></a><tt class="py-lineno">290</tt>  <tt class="py-line">   <tt class="py-keyword">return</tt> <tt class="py-string">"%s%s%s"</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">prefix</tt><tt class="py-op">,</tt> <tt class="py-string">""</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-name">characters</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">suffix</tt><tt class="py-op">)</tt> </tt>

</div><a name="L291"></a><tt class="py-lineno">291</tt>  <tt class="py-line"> </tt>

<a name="L292"></a><tt class="py-lineno">292</tt>  <tt class="py-line"> </tt>

<a name="L293"></a><tt class="py-lineno">293</tt>  <tt class="py-line"><tt class="py-comment">####################################</tt> </tt>

<a name="L294"></a><tt class="py-lineno">294</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># failUnlessAssignRaises() function</tt> </tt>

<a name="L295"></a><tt class="py-lineno">295</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">####################################</tt> </tt>

<a name="L296"></a><tt class="py-lineno">296</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="failUnlessAssignRaises"></a><div id="failUnlessAssignRaises-def"><a name="L297"></a><tt class="py-lineno">297</tt> <a class="py-toggle" href="#" id="failUnlessAssignRaises-toggle" onclick="return toggle('failUnlessAssignRaises');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#failUnlessAssignRaises">failUnlessAssignRaises</a><tt class="py-op">(</tt><tt class="py-param">testCase</tt><tt class="py-op">,</tt> <tt class="py-param">exception</tt><tt class="py-op">,</tt> <tt class="py-param">object</tt><tt class="py-op">,</tt> <tt class="py-param">property</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="failUnlessAssignRaises-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="failUnlessAssignRaises-expanded"><a name="L298"></a><tt class="py-lineno">298</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L299"></a><tt class="py-lineno">299</tt>  <tt class="py-line"><tt class="py-docstring">   Equivalent of C{failUnlessRaises}, but used for property assignments instead.</tt> </tt>

<a name="L300"></a><tt class="py-lineno">300</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L301"></a><tt class="py-lineno">301</tt>  <tt class="py-line"><tt class="py-docstring">   It's nice to be able to use C{failUnlessRaises} to check that a method call</tt> </tt>

<a name="L302"></a><tt class="py-lineno">302</tt>  <tt class="py-line"><tt class="py-docstring">   raises the exception that you expect.  Unfortunately, this method can't be</tt> </tt>

<a name="L303"></a><tt class="py-lineno">303</tt>  <tt class="py-line"><tt class="py-docstring">   used to check Python propery assignments, even though these property</tt> </tt>

<a name="L304"></a><tt class="py-lineno">304</tt>  <tt class="py-line"><tt class="py-docstring">   assignments are actually implemented underneath as methods.</tt> </tt>

<a name="L305"></a><tt class="py-lineno">305</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L306"></a><tt class="py-lineno">306</tt>  <tt class="py-line"><tt class="py-docstring">   This function (which can be easily called by unit test classes) provides an</tt> </tt>

<a name="L307"></a><tt class="py-lineno">307</tt>  <tt class="py-line"><tt class="py-docstring">   easy way to wrap the assignment checks.  It's not pretty, or as intuitive as</tt> </tt>

<a name="L308"></a><tt class="py-lineno">308</tt>  <tt class="py-line"><tt class="py-docstring">   the original check it's modeled on, but it does work.</tt> </tt>

<a name="L309"></a><tt class="py-lineno">309</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L310"></a><tt class="py-lineno">310</tt>  <tt class="py-line"><tt class="py-docstring">   Let's assume you make this method call::</tt> </tt>

<a name="L311"></a><tt class="py-lineno">311</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L312"></a><tt class="py-lineno">312</tt>  <tt class="py-line"><tt class="py-docstring">      testCase.failUnlessAssignRaises(ValueError, collectDir, "absolutePath", absolutePath)</tt> </tt>

<a name="L313"></a><tt class="py-lineno">313</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L314"></a><tt class="py-lineno">314</tt>  <tt class="py-line"><tt class="py-docstring">   If you do this, a test case failure will be raised unless the assignment::</tt> </tt>

<a name="L315"></a><tt class="py-lineno">315</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L316"></a><tt class="py-lineno">316</tt>  <tt class="py-line"><tt class="py-docstring">      collectDir.absolutePath = absolutePath</tt> </tt>

<a name="L317"></a><tt class="py-lineno">317</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L318"></a><tt class="py-lineno">318</tt>  <tt class="py-line"><tt class="py-docstring">   fails with a C{ValueError} exception.  The failure message differentiates</tt> </tt>

<a name="L319"></a><tt class="py-lineno">319</tt>  <tt class="py-line"><tt class="py-docstring">   between the case where no exception was raised and the case where the wrong</tt> </tt>

<a name="L320"></a><tt class="py-lineno">320</tt>  <tt class="py-line"><tt class="py-docstring">   exception was raised.</tt> </tt>

<a name="L321"></a><tt class="py-lineno">321</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L322"></a><tt class="py-lineno">322</tt>  <tt class="py-line"><tt class="py-docstring">   @note: Internally, the C{missed} and C{instead} variables are used rather</tt> </tt>

<a name="L323"></a><tt class="py-lineno">323</tt>  <tt class="py-line"><tt class="py-docstring">   than directly calling C{testCase.fail} upon noticing a problem because the</tt> </tt>

<a name="L324"></a><tt class="py-lineno">324</tt>  <tt class="py-line"><tt class="py-docstring">   act of "failure" itself generates an exception that would be caught by the</tt> </tt>

<a name="L325"></a><tt class="py-lineno">325</tt>  <tt class="py-line"><tt class="py-docstring">   general C{except} clause.</tt> </tt>

<a name="L326"></a><tt class="py-lineno">326</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L327"></a><tt class="py-lineno">327</tt>  <tt class="py-line"><tt class="py-docstring">   @param testCase: PyUnit test case object (i.e. self).</tt> </tt>

<a name="L328"></a><tt class="py-lineno">328</tt>  <tt class="py-line"><tt class="py-docstring">   @param exception: Exception that is expected to be raised.</tt> </tt>

<a name="L329"></a><tt class="py-lineno">329</tt>  <tt class="py-line"><tt class="py-docstring">   @param object: Object whose property is to be assigned to.</tt> </tt>

<a name="L330"></a><tt class="py-lineno">330</tt>  <tt class="py-line"><tt class="py-docstring">   @param property: Name of the property, as a string.</tt> </tt>

<a name="L331"></a><tt class="py-lineno">331</tt>  <tt class="py-line"><tt class="py-docstring">   @param value: Value that is to be assigned to the property.</tt> </tt>

<a name="L332"></a><tt class="py-lineno">332</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L333"></a><tt class="py-lineno">333</tt>  <tt class="py-line"><tt class="py-docstring">   @see: C{unittest.TestCase.failUnlessRaises}</tt> </tt>

<a name="L334"></a><tt class="py-lineno">334</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L335"></a><tt class="py-lineno">335</tt>  <tt class="py-line">   <tt class="py-name">missed</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>

<a name="L336"></a><tt class="py-lineno">336</tt>  <tt class="py-line">   <tt class="py-name">instead</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>

<a name="L337"></a><tt class="py-lineno">337</tt>  <tt class="py-line">   <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>

<a name="L338"></a><tt class="py-lineno">338</tt>  <tt class="py-line">      <tt class="py-keyword">exec</tt> <tt class="py-string">"object.%s = value"</tt> <tt class="py-op">%</tt> <tt class="py-name">property</tt> </tt>

<a name="L339"></a><tt class="py-lineno">339</tt>  <tt class="py-line">      <tt class="py-name">missed</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>

<a name="L340"></a><tt class="py-lineno">340</tt>  <tt class="py-line">   <tt class="py-keyword">except</tt> <tt class="py-name">exception</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>

<a name="L341"></a><tt class="py-lineno">341</tt>  <tt class="py-line">   <tt class="py-keyword">except</tt> <tt class="py-name">Exception</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt><tt class="py-op">:</tt> <tt class="py-name">instead</tt> <tt class="py-op">=</tt> <tt class="py-name">e</tt> </tt>

<a name="L342"></a><tt class="py-lineno">342</tt>  <tt class="py-line">   <tt class="py-keyword">if</tt> <tt class="py-name">missed</tt><tt class="py-op">:</tt> </tt>

<a name="L343"></a><tt class="py-lineno">343</tt>  <tt class="py-line">      <tt class="py-name">testCase</tt><tt class="py-op">.</tt><tt class="py-name">fail</tt><tt class="py-op">(</tt><tt class="py-string">"Expected assignment to raise %s, but got no exception."</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">exception</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>

<a name="L344"></a><tt class="py-lineno">344</tt>  <tt class="py-line">   <tt class="py-keyword">if</tt> <tt class="py-name">instead</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>

<a name="L345"></a><tt class="py-lineno">345</tt>  <tt class="py-line">      <tt class="py-name">testCase</tt><tt class="py-op">.</tt><tt class="py-name">fail</tt><tt class="py-op">(</tt><tt class="py-string">"Expected assignment to raise %s, but got %s instead."</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">ValueError</tt><tt class="py-op">,</tt> <tt class="py-name">instead</tt><tt class="py-op">.</tt><tt class="py-name">__class__</tt><tt class="py-op">.</tt><tt class="py-name">__name__</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>

</div><a name="L346"></a><tt class="py-lineno">346</tt>  <tt class="py-line"> </tt>

<a name="L347"></a><tt class="py-lineno">347</tt>  <tt class="py-line"> </tt>

<a name="L348"></a><tt class="py-lineno">348</tt>  <tt class="py-line"><tt class="py-comment">###########################</tt> </tt>

<a name="L349"></a><tt class="py-lineno">349</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># captureOutput() function</tt> </tt>

<a name="L350"></a><tt class="py-lineno">350</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">###########################</tt> </tt>

<a name="L351"></a><tt class="py-lineno">351</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="captureOutput"></a><div id="captureOutput-def"><a name="L352"></a><tt class="py-lineno">352</tt> <a class="py-toggle" href="#" id="captureOutput-toggle" onclick="return toggle('captureOutput');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#captureOutput">captureOutput</a><tt class="py-op">(</tt><tt class="py-param">callable</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="captureOutput-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="captureOutput-expanded"><a name="L353"></a><tt class="py-lineno">353</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L354"></a><tt class="py-lineno">354</tt>  <tt class="py-line"><tt class="py-docstring">   Captures the output (stdout, stderr) of a function or a method.</tt> </tt>

<a name="L355"></a><tt class="py-lineno">355</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L356"></a><tt class="py-lineno">356</tt>  <tt class="py-line"><tt class="py-docstring">   Some of our functions don't do anything other than just print output.  We</tt> </tt>

<a name="L357"></a><tt class="py-lineno">357</tt>  <tt class="py-line"><tt class="py-docstring">   need a way to test these functions (at least nominally) but we don't want</tt> </tt>

<a name="L358"></a><tt class="py-lineno">358</tt>  <tt class="py-line"><tt class="py-docstring">   any of the output spoiling the test suite output.</tt> </tt>

<a name="L360"></a><tt class="py-lineno">360</tt>  <tt class="py-line"><tt class="py-docstring">   This function just creates a dummy file descriptor that can be used as a</tt> </tt>

<a name="L361"></a><tt class="py-lineno">361</tt>  <tt class="py-line"><tt class="py-docstring">   target by the callable function, rather than C{stdout} or C{stderr}.</tt> </tt>

<a name="L363"></a><tt class="py-lineno">363</tt>  <tt class="py-line"><tt class="py-docstring">   @note: This method assumes that C{callable} doesn't take any arguments</tt> </tt>

<a name="L364"></a><tt class="py-lineno">364</tt>  <tt class="py-line"><tt class="py-docstring">   besides keyword argument C{fd} to specify the file descriptor.</tt> </tt>

<a name="L365"></a><tt class="py-lineno">365</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L366"></a><tt class="py-lineno">366</tt>  <tt class="py-line"><tt class="py-docstring">   @param callable: Callable function or method.</tt> </tt>

<a name="L367"></a><tt class="py-lineno">367</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L368"></a><tt class="py-lineno">368</tt>  <tt class="py-line"><tt class="py-docstring">   @return: Output of function, as one big string.</tt> </tt>

<a name="L369"></a><tt class="py-lineno">369</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L370"></a><tt class="py-lineno">370</tt>  <tt class="py-line">   <tt class="py-name">fd</tt> <tt class="py-op">=</tt> <tt class="py-name">StringIO</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>

<a name="L371"></a><tt class="py-lineno">371</tt>  <tt class="py-line">   <tt class="py-name">callable</tt><tt class="py-op">(</tt><tt class="py-name">fd</tt><tt class="py-op">=</tt><tt class="py-name">fd</tt><tt class="py-op">)</tt> </tt>

<a name="L372"></a><tt class="py-lineno">372</tt>  <tt class="py-line">   <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">fd</tt><tt class="py-op">.</tt><tt class="py-name">getvalue</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>

<a name="L373"></a><tt class="py-lineno">373</tt>  <tt class="py-line">   <tt class="py-name">fd</tt><tt class="py-op">.</tt><tt class="py-name">close</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>

<a name="L374"></a><tt class="py-lineno">374</tt>  <tt class="py-line">   <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>

</div><a name="L375"></a><tt class="py-lineno">375</tt>  <tt class="py-line"> </tt>

<a name="L376"></a><tt class="py-lineno">376</tt>  <tt class="py-line"> </tt>

<a name="L377"></a><tt class="py-lineno">377</tt>  <tt class="py-line"><tt class="py-comment">#########################</tt> </tt>

<a name="L378"></a><tt class="py-lineno">378</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># _isPlatform() function</tt> </tt>

<a name="L379"></a><tt class="py-lineno">379</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#########################</tt> </tt>

<a name="L380"></a><tt class="py-lineno">380</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="_isPlatform"></a><div id="_isPlatform-def"><a name="L381"></a><tt class="py-lineno">381</tt> <a class="py-toggle" href="#" id="_isPlatform-toggle" onclick="return toggle('_isPlatform');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#_isPlatform">_isPlatform</a><tt class="py-op">(</tt><tt class="py-param">name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="_isPlatform-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_isPlatform-expanded"><a name="L382"></a><tt class="py-lineno">382</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L383"></a><tt class="py-lineno">383</tt>  <tt class="py-line"><tt class="py-docstring">   Returns boolean indicating whether we're running on the indicated platform.</tt> </tt>

<a name="L384"></a><tt class="py-lineno">384</tt>  <tt class="py-line"><tt class="py-docstring">   @param name: Platform name to check, currently one of "windows" or "macosx"</tt> </tt>

<a name="L385"></a><tt class="py-lineno">385</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L386"></a><tt class="py-lineno">386</tt>  <tt class="py-line">   <tt class="py-keyword">if</tt> <tt id="link-19" class="py-name"><a title="CedarBackup2.config.ExtendedAction.name

<a name="L387"></a><tt class="py-lineno">387</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt id="link-20" class="py-name"><a title="CedarBackup2.util.Diagnostics.platform" class="py-name" href="#" onclick="return doclink('link-20', 'platform', 'link-0');">platform</a></tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="CedarBackup2.util.Diagnostics.platform" class="py-name" href="#" onclick="return doclink('link-21', 'platform', 'link-0');">platform</a></tt><tt class="py-op">(</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">startswith</tt><tt class="py-op">(</tt><tt class="py-string">"Windows"</tt><tt class="py-op">)</tt> </tt>

<a name="L388"></a><tt class="py-lineno">388</tt>  <tt class="py-line">   <tt class="py-keyword">elif</tt> <tt id="link-22" class="py-name"><a title="CedarBackup2.config.ExtendedAction.name

<a name="L389"></a><tt class="py-lineno">389</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="CedarBackup2.util.Diagnostics.platform" class="py-name" href="#" onclick="return doclink('link-23', 'platform', 'link-0');">platform</a></tt> <tt class="py-op">==</tt> <tt class="py-string">"darwin"</tt> </tt>

<a name="L390"></a><tt class="py-lineno">390</tt>  <tt class="py-line">   <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>

<a name="L391"></a><tt class="py-lineno">391</tt>  <tt class="py-line">      <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">"Unknown platform [%s]."</tt> <tt class="py-op">%</tt> <tt id="link-24" class="py-name"><a title="CedarBackup2.config.ExtendedAction.name

</div><a name="L392"></a><tt class="py-lineno">392</tt>  <tt class="py-line"> </tt>

<a name="L393"></a><tt class="py-lineno">393</tt>  <tt class="py-line"> </tt>

<a name="L394"></a><tt class="py-lineno">394</tt>  <tt class="py-line"><tt class="py-comment">############################</tt> </tt>

<a name="L395"></a><tt class="py-lineno">395</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># platformMacOsX() function</tt> </tt>

<a name="L396"></a><tt class="py-lineno">396</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">############################</tt> </tt>

<a name="L397"></a><tt class="py-lineno">397</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="platformMacOsX"></a><div id="platformMacOsX-def"><a name="L398"></a><tt class="py-lineno">398</tt> <a class="py-toggle" href="#" id="platformMacOsX-toggle" onclick="return toggle('platformMacOsX');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#platformMacOsX">platformMacOsX</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="platformMacOsX-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="platformMacOsX-expanded"><a name="L399"></a><tt class="py-lineno">399</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L400"></a><tt class="py-lineno">400</tt>  <tt class="py-line"><tt class="py-docstring">   Returns boolean indicating whether this is the Mac OS X platform.</tt> </tt>

<a name="L401"></a><tt class="py-lineno">401</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L402"></a><tt class="py-lineno">402</tt>  <tt class="py-line">   <tt class="py-keyword">return</tt> <tt id="link-25" class="py-name" targets="Function CedarBackup2.testutil._isPlatform()=CedarBackup2.testutil-module.html#_isPlatform"><a title="CedarBackup2.testutil._isPlatform" class="py-name" href="#" onclick="return doclink('link-25', '_isPlatform', 'link-25');">_isPlatform</a></tt><tt class="py-op">(</tt><tt class="py-string">"macosx"</tt><tt class="py-op">)</tt> </tt>

</div><a name="L403"></a><tt class="py-lineno">403</tt>  <tt class="py-line"> </tt>

<a name="L404"></a><tt class="py-lineno">404</tt>  <tt class="py-line"> </tt>

<a name="L405"></a><tt class="py-lineno">405</tt>  <tt class="py-line"><tt class="py-comment">#############################</tt> </tt>

<a name="L406"></a><tt class="py-lineno">406</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># platformWindows() function</tt> </tt>

<a name="L407"></a><tt class="py-lineno">407</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#############################</tt> </tt>

<a name="L408"></a><tt class="py-lineno">408</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="platformWindows"></a><div id="platformWindows-def"><a name="L409"></a><tt class="py-lineno">409</tt> <a class="py-toggle" href="#" id="platformWindows-toggle" onclick="return toggle('platformWindows');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#platformWindows">platformWindows</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="platformWindows-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="platformWindows-expanded"><a name="L410"></a><tt class="py-lineno">410</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L411"></a><tt class="py-lineno">411</tt>  <tt class="py-line"><tt class="py-docstring">   Returns boolean indicating whether this is the Windows platform.</tt> </tt>

<a name="L412"></a><tt class="py-lineno">412</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L413"></a><tt class="py-lineno">413</tt>  <tt class="py-line">   <tt class="py-keyword">return</tt> <tt id="link-26" class="py-name"><a title="CedarBackup2.testutil._isPlatform" class="py-name" href="#" onclick="return doclink('link-26', '_isPlatform', 'link-25');">_isPlatform</a></tt><tt class="py-op">(</tt><tt class="py-string">"windows"</tt><tt class="py-op">)</tt> </tt>

</div><a name="L414"></a><tt class="py-lineno">414</tt>  <tt class="py-line"> </tt>

<a name="L415"></a><tt class="py-lineno">415</tt>  <tt class="py-line"> </tt>

<a name="L416"></a><tt class="py-lineno">416</tt>  <tt class="py-line"><tt class="py-comment">###################################</tt> </tt>

<a name="L417"></a><tt class="py-lineno">417</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># platformSupportsLinks() function</tt> </tt>

<a name="L418"></a><tt class="py-lineno">418</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">###################################</tt> </tt>

<a name="L419"></a><tt class="py-lineno">419</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="platformSupportsLinks"></a><div id="platformSupportsLinks-def"><a name="L420"></a><tt class="py-lineno">420</tt> <a class="py-toggle" href="#" id="platformSupportsLinks-toggle" onclick="return toggle('platformSupportsLinks');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#platformSupportsLinks">platformSupportsLinks</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="platformSupportsLinks-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="platformSupportsLinks-expanded"><a name="L421"></a><tt class="py-lineno">421</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L422"></a><tt class="py-lineno">422</tt>  <tt class="py-line"><tt class="py-docstring">   Returns boolean indicating whether the platform supports soft-links.</tt> </tt>

<a name="L423"></a><tt class="py-lineno">423</tt>  <tt class="py-line"><tt class="py-docstring">   Some platforms, like Windows, do not support links, and tests need to take</tt> </tt>

<a name="L424"></a><tt class="py-lineno">424</tt>  <tt class="py-line"><tt class="py-docstring">   this into account.</tt> </tt>

<a name="L425"></a><tt class="py-lineno">425</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L426"></a><tt class="py-lineno">426</tt>  <tt class="py-line">   <tt class="py-keyword">return</tt> <tt class="py-keyword">not</tt> <tt id="link-27" class="py-name" targets="Function CedarBackup2.testutil.platformWindows()=CedarBackup2.testutil-module.html#platformWindows"><a title="CedarBackup2.testutil.platformWindows" class="py-name" href="#" onclick="return doclink('link-27', 'platformWindows', 'link-27');">platformWindows</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>

</div><a name="L427"></a><tt class="py-lineno">427</tt>  <tt class="py-line"> </tt>

<a name="L428"></a><tt class="py-lineno">428</tt>  <tt class="py-line"> </tt>

<a name="L429"></a><tt class="py-lineno">429</tt>  <tt class="py-line"><tt class="py-comment">#########################################</tt> </tt>

<a name="L430"></a><tt class="py-lineno">430</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># platformSupportsPermissions() function</tt> </tt>

<a name="L431"></a><tt class="py-lineno">431</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#########################################</tt> </tt>

<a name="L432"></a><tt class="py-lineno">432</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="platformSupportsPermissions"></a><div id="platformSupportsPermissions-def"><a name="L433"></a><tt class="py-lineno">433</tt> <a class="py-toggle" href="#" id="platformSupportsPermissions-toggle" onclick="return toggle('platformSupportsPermissions');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#platformSupportsPermissions">platformSupportsPermissions</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="platformSupportsPermissions-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="platformSupportsPermissions-expanded"><a name="L434"></a><tt class="py-lineno">434</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L435"></a><tt class="py-lineno">435</tt>  <tt class="py-line"><tt class="py-docstring">   Returns boolean indicating whether the platform supports UNIX-style file permissions.</tt> </tt>

<a name="L436"></a><tt class="py-lineno">436</tt>  <tt class="py-line"><tt class="py-docstring">   Some platforms, like Windows, do not support permissions, and tests need to take</tt> </tt>

<a name="L437"></a><tt class="py-lineno">437</tt>  <tt class="py-line"><tt class="py-docstring">   this into account.</tt> </tt>

<a name="L438"></a><tt class="py-lineno">438</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L439"></a><tt class="py-lineno">439</tt>  <tt class="py-line">   <tt class="py-keyword">return</tt> <tt class="py-keyword">not</tt> <tt id="link-28" class="py-name"><a title="CedarBackup2.testutil.platformWindows" class="py-name" href="#" onclick="return doclink('link-28', 'platformWindows', 'link-27');">platformWindows</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>

</div><a name="L440"></a><tt class="py-lineno">440</tt>  <tt class="py-line"> </tt>

<a name="L441"></a><tt class="py-lineno">441</tt>  <tt class="py-line"> </tt>

<a name="L442"></a><tt class="py-lineno">442</tt>  <tt class="py-line"><tt class="py-comment">########################################</tt> </tt>

<a name="L443"></a><tt class="py-lineno">443</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># platformRequiresBinaryRead() function</tt> </tt>

<a name="L444"></a><tt class="py-lineno">444</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">########################################</tt> </tt>

<a name="L445"></a><tt class="py-lineno">445</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="platformRequiresBinaryRead"></a><div id="platformRequiresBinaryRead-def"><a name="L446"></a><tt class="py-lineno">446</tt> <a class="py-toggle" href="#" id="platformRequiresBinaryRead-toggle" onclick="return toggle('platformRequiresBinaryRead');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#platformRequiresBinaryRead">platformRequiresBinaryRead</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="platformRequiresBinaryRead-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="platformRequiresBinaryRead-expanded"><a name="L447"></a><tt class="py-lineno">447</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L448"></a><tt class="py-lineno">448</tt>  <tt class="py-line"><tt class="py-docstring">   Returns boolean indicating whether the platform requires binary reads.</tt> </tt>

<a name="L449"></a><tt class="py-lineno">449</tt>  <tt class="py-line"><tt class="py-docstring">   Some platforms, like Windows, require a special flag to read binary data</tt> </tt>

<a name="L450"></a><tt class="py-lineno">450</tt>  <tt class="py-line"><tt class="py-docstring">   from files.</tt> </tt>

<a name="L451"></a><tt class="py-lineno">451</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L452"></a><tt class="py-lineno">452</tt>  <tt class="py-line">   <tt class="py-keyword">return</tt> <tt id="link-29" class="py-name"><a title="CedarBackup2.testutil.platformWindows" class="py-name" href="#" onclick="return doclink('link-29', 'platformWindows', 'link-27');">platformWindows</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>

</div><a name="L453"></a><tt class="py-lineno">453</tt>  <tt class="py-line"> </tt>

<a name="L454"></a><tt class="py-lineno">454</tt>  <tt class="py-line"> </tt>

<a name="L455"></a><tt class="py-lineno">455</tt>  <tt class="py-line"><tt class="py-comment">#############################</tt> </tt>

<a name="L456"></a><tt class="py-lineno">456</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># platformHasEcho() function</tt> </tt>

<a name="L457"></a><tt class="py-lineno">457</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#############################</tt> </tt>

<a name="L458"></a><tt class="py-lineno">458</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="platformHasEcho"></a><div id="platformHasEcho-def"><a name="L459"></a><tt class="py-lineno">459</tt> <a class="py-toggle" href="#" id="platformHasEcho-toggle" onclick="return toggle('platformHasEcho');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#platformHasEcho">platformHasEcho</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="platformHasEcho-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="platformHasEcho-expanded"><a name="L460"></a><tt class="py-lineno">460</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L461"></a><tt class="py-lineno">461</tt>  <tt class="py-line"><tt class="py-docstring">   Returns boolean indicating whether the platform has a sensible echo command.</tt> </tt>

<a name="L462"></a><tt class="py-lineno">462</tt>  <tt class="py-line"><tt class="py-docstring">   On some platforms, like Windows, echo doesn't really work for tests.</tt> </tt>

<a name="L463"></a><tt class="py-lineno">463</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L464"></a><tt class="py-lineno">464</tt>  <tt class="py-line">   <tt class="py-keyword">return</tt> <tt class="py-keyword">not</tt> <tt id="link-30" class="py-name"><a title="CedarBackup2.testutil.platformWindows" class="py-name" href="#" onclick="return doclink('link-30', 'platformWindows', 'link-27');">platformWindows</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>

</div><a name="L465"></a><tt class="py-lineno">465</tt>  <tt class="py-line">    </tt>

<a name="L466"></a><tt class="py-lineno">466</tt>  <tt class="py-line"> </tt>

<a name="L467"></a><tt class="py-lineno">467</tt>  <tt class="py-line"><tt class="py-comment">###########################</tt> </tt>

<a name="L468"></a><tt class="py-lineno">468</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># runningAsRoot() function</tt> </tt>

<a name="L469"></a><tt class="py-lineno">469</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">###########################</tt> </tt>

<a name="L470"></a><tt class="py-lineno">470</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="runningAsRoot"></a><div id="runningAsRoot-def"><a name="L471"></a><tt class="py-lineno">471</tt> <a class="py-toggle" href="#" id="runningAsRoot-toggle" onclick="return toggle('runningAsRoot');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#runningAsRoot">runningAsRoot</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="runningAsRoot-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="runningAsRoot-expanded"><a name="L472"></a><tt class="py-lineno">472</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L473"></a><tt class="py-lineno">473</tt>  <tt class="py-line"><tt class="py-docstring">   Returns boolean indicating whether the effective user id is root.</tt> </tt>

<a name="L474"></a><tt class="py-lineno">474</tt>  <tt class="py-line"><tt class="py-docstring">   This is always true on platforms that have no concept of root, like Windows.</tt> </tt>

<a name="L475"></a><tt class="py-lineno">475</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L476"></a><tt class="py-lineno">476</tt>  <tt class="py-line">   <tt class="py-keyword">if</tt> <tt id="link-31" class="py-name"><a title="CedarBackup2.testutil.platformWindows" class="py-name" href="#" onclick="return doclink('link-31', 'platformWindows', 'link-27');">platformWindows</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

<a name="L477"></a><tt class="py-lineno">477</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>

<a name="L478"></a><tt class="py-lineno">478</tt>  <tt class="py-line">   <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>

<a name="L479"></a><tt class="py-lineno">479</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">geteuid</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">0</tt> </tt>

</div><a name="L480"></a><tt class="py-lineno">480</tt>  <tt class="py-line"> </tt>

<a name="L481"></a><tt class="py-lineno">481</tt>  <tt class="py-line"> </tt>

<a name="L482"></a><tt class="py-lineno">482</tt>  <tt class="py-line"><tt class="py-comment">##############################</tt> </tt>

<a name="L483"></a><tt class="py-lineno">483</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># availableLocales() function</tt> </tt>

<a name="L484"></a><tt class="py-lineno">484</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##############################</tt> </tt>

<a name="L485"></a><tt class="py-lineno">485</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="availableLocales"></a><div id="availableLocales-def"><a name="L486"></a><tt class="py-lineno">486</tt> <a class="py-toggle" href="#" id="availableLocales-toggle" onclick="return toggle('availableLocales');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#availableLocales">availableLocales</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="availableLocales-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="availableLocales-expanded"><a name="L487"></a><tt class="py-lineno">487</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L488"></a><tt class="py-lineno">488</tt>  <tt class="py-line"><tt class="py-docstring">   Returns a list of available locales on the system</tt> </tt>

<a name="L489"></a><tt class="py-lineno">489</tt>  <tt class="py-line"><tt class="py-docstring">   @return: List of string locale names</tt> </tt>

<a name="L490"></a><tt class="py-lineno">490</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L491"></a><tt class="py-lineno">491</tt>  <tt class="py-line">   <tt class="py-name">locales</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>

<a name="L492"></a><tt class="py-lineno">492</tt>  <tt class="py-line">   <tt id="link-32" class="py-name" targets="Variable CedarBackup2.cli.Options.output=CedarBackup2.cli.Options-class.html#output"><a title="CedarBackup2.cli.Options.output" class="py-name" href="#" onclick="return doclink('link-32', 'output', 'link-32');">output</a></tt> <tt class="py-op">=</tt> <tt id="link-33" class="py-name"><a title="CedarBackup2.util.executeCommand" class="py-name" href="#" onclick="return doclink('link-33', 'executeCommand', 'link-4');">executeCommand</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">"locale"</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt> <tt class="py-string">"-a"</tt><tt class="py-op">,</tt> <tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">returnOutput</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">ignoreStderr</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> </tt>

<a name="L493"></a><tt class="py-lineno">493</tt>  <tt class="py-line">   <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt id="link-34" class="py-name"><a title="CedarBackup2.cli.Options.output" class="py-name" href="#" onclick="return doclink('link-34', 'output', 'link-32');">output</a></tt><tt class="py-op">:</tt> </tt>

<a name="L494"></a><tt class="py-lineno">494</tt>  <tt class="py-line">      <tt class="py-name">locales</tt><tt class="py-op">.</tt><tt id="link-35" class="py-name" targets="Method CedarBackup2.util.AbsolutePathList.append()=CedarBackup2.util.AbsolutePathList-class.html#append,Method CedarBackup2.util.ObjectTypeList.append()=CedarBackup2.util.ObjectTypeList-class.html#append,Method CedarBackup2.util.RegexList.append()=CedarBackup2.util.RegexList-class.html#append,Method CedarBackup2.util.RegexMatchList.append()=CedarBackup2.util.RegexMatchList-class.html#append,Method CedarBackup2.util.RestrictedContentList.append()=CedarBackup2.util.RestrictedContentList-class.html#append"><a title="CedarBackup2.util.AbsolutePathList.append

<a name="L495"></a><tt class="py-lineno">495</tt>  <tt class="py-line">   <tt class="py-keyword">return</tt> <tt class="py-name">locales</tt> </tt>

</div><a name="L496"></a><tt class="py-lineno">496</tt>  <tt class="py-line"> </tt>

<a name="L497"></a><tt class="py-lineno">497</tt>  <tt class="py-line"> </tt>

<a name="L498"></a><tt class="py-lineno">498</tt>  <tt class="py-line"><tt class="py-comment">####################################</tt> </tt>

<a name="L499"></a><tt class="py-lineno">499</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># hexFloatLiteralAllowed() function</tt> </tt>

<a name="L500"></a><tt class="py-lineno">500</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">####################################</tt> </tt>

<a name="L501"></a><tt class="py-lineno">501</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt>

<a name="hexFloatLiteralAllowed"></a><div id="hexFloatLiteralAllowed-def"><a name="L502"></a><tt class="py-lineno">502</tt> <a class="py-toggle" href="#" id="hexFloatLiteralAllowed-toggle" onclick="return toggle('hexFloatLiteralAllowed');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="CedarBackup2.testutil-module.html#hexFloatLiteralAllowed">hexFloatLiteralAllowed</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

</div><div id="hexFloatLiteralAllowed-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="hexFloatLiteralAllowed-expanded"><a name="L503"></a><tt class="py-lineno">503</tt>  <tt class="py-line">   <tt class="py-docstring">"""</tt> </tt>

<a name="L504"></a><tt class="py-lineno">504</tt>  <tt class="py-line"><tt class="py-docstring">   Indicates whether hex float literals are allowed by the interpreter.</tt> </tt>

<a name="L505"></a><tt class="py-lineno">505</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L506"></a><tt class="py-lineno">506</tt>  <tt class="py-line"><tt class="py-docstring">   As far back as 2004, some Python documentation indicated that octal and hex</tt> </tt>

<a name="L507"></a><tt class="py-lineno">507</tt>  <tt class="py-line"><tt class="py-docstring">   notation applied only to integer literals.  However, prior to Python 2.5, it</tt> </tt>

<a name="L508"></a><tt class="py-lineno">508</tt>  <tt class="py-line"><tt class="py-docstring">   was legal to construct a float with an argument like 0xAC on some platforms.</tt> </tt>

<a name="L509"></a><tt class="py-lineno">509</tt>  <tt class="py-line"><tt class="py-docstring">   This check provides a an indication of whether the current interpreter</tt> </tt>

<a name="L510"></a><tt class="py-lineno">510</tt>  <tt class="py-line"><tt class="py-docstring">   supports that behavior.</tt> </tt>

<a name="L511"></a><tt class="py-lineno">511</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L512"></a><tt class="py-lineno">512</tt>  <tt class="py-line"><tt class="py-docstring">   This check exists so that unit tests can continue to test the same thing as</tt> </tt>

<a name="L513"></a><tt class="py-lineno">513</tt>  <tt class="py-line"><tt class="py-docstring">   always for pre-2.5 interpreters (i.e. making sure backwards compatibility</tt> </tt>

<a name="L514"></a><tt class="py-lineno">514</tt>  <tt class="py-line"><tt class="py-docstring">   doesn't break) while still continuing to work for later interpreters.</tt> </tt>

<a name="L515"></a><tt class="py-lineno">515</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>

<a name="L516"></a><tt class="py-lineno">516</tt>  <tt class="py-line"><tt class="py-docstring">   The returned value is True if hex float literals are allowed, False otherwise.</tt> </tt>

<a name="L517"></a><tt class="py-lineno">517</tt>  <tt class="py-line"><tt class="py-docstring">   """</tt> </tt>

<a name="L518"></a><tt class="py-lineno">518</tt>  <tt class="py-line">   <tt class="py-keyword">if</tt> <tt class="py-name">map</tt><tt class="py-op">(</tt><tt class="py-name">int</tt><tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">version_info</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">version_info</tt><tt class="py-op">[</tt><tt class="py-number">1</tt><tt class="py-op">]</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> <tt class="py-op">&lt;</tt> <tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">,</tt> <tt class="py-number">5</tt><tt class="py-op">]</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt id="link-36" class="py-name"><a title="CedarBackup2.testutil.platformWindows" class="py-name" href="#" onclick="return doclink('link-36', 'platformWindows', 'link-27');">platformWindows</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>

<a name="L519"></a><tt class="py-lineno">519</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>

<a name="L520"></a><tt class="py-lineno">520</tt>  <tt class="py-line">   <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>

</div><a name="L521"></a><tt class="py-lineno">521</tt>  <tt class="py-line"> </tt><script type="text/javascript">

    Generated by Epydoc 3.0.1 on Sun Aug 16 15:13:25 2009