Merge lp:~gz/juju-ci-tools/copy_ps_polish into lp:juju-ci-tools

[Martin Packman]

Improves powershell for gathering artifacts from windows machines

Mostly adding robustness:

* Always returns a non-zero exit code if something goes seriously wrong.
* If a particular file couldn't be opened generates a file containing the error.
* A glob that expands to no files will no longer try to open the empty string.

Would be possible instead to just output single file errors to stderr, but would mean continuing to log it all the time and it contains xml junk.

[Curtis Hovey (sinzui)]

Thank you

review: Approve (code)

[lp:~gz/juju-ci-tools/copy_ps_polish]

1015. By Martin Packman on 2015-07-07

Wrap interpolated powershell argument in array

=== modified file 'remote.py'
--- remote.py	2015-07-02 00:59:47 +0000
+++ remote.py	2015-07-07 18:04:46 +0000
@@ -162,42 +162,51 @@
 
 
 _ps_copy_script = """\
-function CopyText {
-    param([String]$file, [IO.Stream]$outstream)
-    $enc = New-Object Text.UTF8Encoding($False)
-    $us = New-Object IO.StreamWriter($outstream, $enc)
-    $us.NewLine = "\n"
-    $uin = New-Object IO.StreamReader($file)
-    while (($line = $uin.ReadLine()) -ne $Null) {
-        $us.WriteLine($line)
-    }
-    $uin.Close()
-    $us.Close()
-}
-
-function CopyBinary {
-    param([String]$file, [IO.Stream]$outstream)
-    $in = New-Object IO.FileStream($file, [IO.FileMode]::Open,
-        [IO.FileAccess]::Read, [IO.FileShare]"ReadWrite,Delete")
-    $in.CopyTo($outstream)
-    $in.Close()
-}
-
-ForEach ($pattern in %s) {
-    $path = [Environment]::ExpandEnvironmentVariables($pattern)
-    $files = Get-Item -path $path
-    ForEach ($file in $files) {
-        [Console]::Out.Write($file.name + "|")
-        $trans = New-Object Security.Cryptography.ToBase64Transform
-        $out = [Console]::OpenStandardOutput()
-        $bs = New-Object Security.Cryptography.CryptoStream($out, $trans,
-            [Security.Cryptography.CryptoStreamMode]::Write)
-        $zs = New-Object IO.Compression.DeflateStream($bs,
-            [IO.Compression.CompressionMode]::Compress)
-        CopyBinary -file $file -outstream $zs
-        $zs.Close()
-        [Console]::Out.Write("\n")
-    }
+$ErrorActionPreference = "Stop"
+
+function OutputEncodedFile {
+    param([String]$filename, [IO.Stream]$instream)
+    $trans = New-Object Security.Cryptography.ToBase64Transform
+    $out = [Console]::OpenStandardOutput()
+    $bs = New-Object Security.Cryptography.CryptoStream($out, $trans,
+        [Security.Cryptography.CryptoStreamMode]::Write)
+    $zs = New-Object IO.Compression.DeflateStream($bs,
+        [IO.Compression.CompressionMode]::Compress)
+    [Console]::Out.Write($filename + "|")
+    try {
+        $instream.CopyTo($zs)
+    } finally {
+        $zs.close()
+        $bs.close()
+        [Console]::Out.Write("`n")
+    }
+}
+
+function GatherFiles {
+    param([String[]]$patterns)
+    ForEach ($pattern in $patterns) {
+        $path = [Environment]::ExpandEnvironmentVariables($pattern)
+        ForEach ($file in Get-Item -path $path) {
+            try {
+                $in = New-Object IO.FileStream($file, [IO.FileMode]::Open,
+                    [IO.FileAccess]::Read, [IO.FileShare]"ReadWrite,Delete")
+                OutputEncodedFile -filename $file.name -instream $in
+            } catch {
+                $utf8 = New-Object Text.UTF8Encoding($False)
+                $errstream = New-Object IO.MemoryStream(
+                    $utf8.GetBytes($_.Exception), $False)
+                $errfilename = $file.name + ".copyerror"
+                OutputEncodedFile -filename $errfilename -instream $errstream
+            }
+        }
+    }
+}
+
+try {
+    GatherFiles -patterns @(%s)
+} catch {
+    Write-Error $_.Exception
+    exit 1
 }
 """
 
@@ -249,9 +258,8 @@
         # Encode globs into script to run on remote machine and return result.
         script = _ps_copy_script % ",".join(s.join('""') for s in source_globs)
         result = self.run_ps(script)
-        if result.std_err:
+        if result.status_code:
             logging.warning("winrm copy stderr:\n%s", result.std_err)
-        if result.status_code:
             raise subprocess.CalledProcessError(result.status_code,
                                                 "powershell", result)
         self._encoded_copy_to_dir(destination_dir, result.std_out)