winrm-fs 0.2.3 → 0.3.0

data/spec/unit/tmp_zip_spec.rb

@@ -0,0 +1,79 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2015, Fletcher Nichol
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'winrm-fs/core/tmp_zip'
+
+describe WinRM::FS::Core::TmpZip do
+  let(:src_dir) do
+    tmpdir = Pathname.new(Dir.mktmpdir)
+    @tmpdirs << tmpdir
+    src_dir = tmpdir.join('src')
+    sub_dir = src_dir.join('veggies')
+
+    src_dir.mkpath
+    create_local_file(src_dir.join('apple.txt'), 'appleapple')
+    create_local_file(src_dir.join('banana.txt'), 'bananabanana')
+    create_local_file(src_dir.join('cherry.txt'), 'cherrycherry')
+    sub_dir.mkpath
+    create_local_file(sub_dir.join('carrot.txt'), 'carrotcarrot')
+    src_dir
+  end
+
+  let(:tmp_zip) { WinRM::FS::Core::TmpZip.new(src_dir) }
+
+  before  { @tmpdirs = [] }
+
+  after do
+    @tmpdirs.each(&:rmtree)
+    tmp_zip.unlink if tmp_zip.path
+  end
+
+  it '#path returns path to created zip file' do
+    expect(tmp_zip.path.file?).to eq true
+  end
+
+  it '#unlink removes the file' do
+    path = tmp_zip.path
+    expect(path.file?).to eq true
+
+    tmp_zip.unlink
+
+    expect(path.file?).to eq false
+    expect(tmp_zip.path).to eq nil
+  end
+
+  describe 'for a zip file containing the base directory' do
+    let(:tmp_zip) { WinRM::FS::Core::TmpZip.new(src_dir) }
+
+    it 'contains the input entries' do
+      zip = Zip::File.new(tmp_zip.path)
+
+      expect(zip.map(&:name).sort).to eq(
+        ['apple.txt', 'banana.txt', 'cherry.txt', 'veggies/carrot.txt']
+      )
+      expect(zip.read('apple.txt')).to eq 'appleapple'
+      expect(zip.read('banana.txt')).to eq 'bananabanana'
+      expect(zip.read('cherry.txt')).to eq 'cherrycherry'
+      expect(zip.read('veggies/carrot.txt')).to eq 'carrotcarrot'
+    end
+  end
+
+  def create_local_file(path, content)
+    path.open('wb') { |file| file.write(content) }
+  end
+end

data/winrm-fs.gemspec

@@ -29,7 +29,8 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'erubis', '~> 2.7'
   s.add_runtime_dependency 'logging', '~> 1.6', '>= 1.6.1'
   s.add_runtime_dependency 'rubyzip', '~> 1.1'
-  s.add_runtime_dependency 'winrm', '~> 1.3.0'
+  s.add_runtime_dependency 'winrm', '~> 1.5'
+  s.add_development_dependency 'pry'
   s.add_development_dependency 'rspec', '~> 3.0.0'
   s.add_development_dependency 'rake', '~> 10.3.2'
   s.add_development_dependency 'rubocop', '~> 0.28.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: winrm-fs
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Shawn Neal
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-11 00:00:00.000000000 Z
+date: 2016-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -65,14 +65,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -137,28 +151,29 @@ files:
 - Rakefile
 - VERSION
 - Vagrantfile
-- benchmark.rb
+- appveyor.yml
 - bin/rwinrmcp
 - changelog.md
 - lib/winrm-fs.rb
-- lib/winrm-fs/core/command_executor.rb
-- lib/winrm-fs/core/file_uploader.rb
-- lib/winrm-fs/core/temp_zip_file.rb
-- lib/winrm-fs/core/upload_orchestrator.rb
+- lib/winrm-fs/core/file_transporter.rb
+- lib/winrm-fs/core/tmp_zip.rb
 - lib/winrm-fs/exceptions.rb
 - lib/winrm-fs/file_manager.rb
+- lib/winrm-fs/scripts/check_files.ps1.erb
 - lib/winrm-fs/scripts/checksum.ps1.erb
 - lib/winrm-fs/scripts/create_dir.ps1.erb
-- lib/winrm-fs/scripts/decode_file.ps1.erb
+- lib/winrm-fs/scripts/decode_files.ps1.erb
 - lib/winrm-fs/scripts/delete.ps1.erb
 - lib/winrm-fs/scripts/download.ps1.erb
 - lib/winrm-fs/scripts/exists.ps1.erb
 - lib/winrm-fs/scripts/scripts.rb
 - spec/config-example.yml
-- spec/file_manager_spec.rb
+- spec/integration/file_manager_spec.rb
+- spec/integration/tmp_zip_spec.rb
 - spec/matchers.rb
 - spec/spec_helper.rb
-- spec/temp_zip_file_spec.rb
+- spec/unit/file_transporter_spec.rb
+- spec/unit/tmp_zip_spec.rb
 - winrm-fs.gemspec
 homepage: http://github.com/WinRb/winrm-fs
 licenses: []

data/benchmark.rb

@@ -1,20 +0,0 @@
-# encoding: UTF-8
-require 'winrm-fs'
-require 'benchmark'
-
-def files
-  # This is a fairly short list of small files, may also want a benchmark with larger files
-  `git ls-files`.lines.map(&:strip)
-end
-
-def create_zip(factory, file)
-  WinRM::FS::Core::TempZipFile.new(Dir.pwd, zip_file: file, via: factory, X: true) do | temp_zip |
-    temp_zip.add(*files)
-  end
-end
-
-Benchmark.bm do | benchmark |
-  benchmark.report('zip cmd') { `git ls-files | zip zip_command.zip -X --names-stdin` }
-  benchmark.report('shell') { create_zip(:shell, 'shell.zip') }
-  benchmark.report('ruby') { create_zip(:rubyzip, 'ruby.zip') }
-end

data/lib/winrm-fs/core/command_executor.rb

@@ -1,74 +0,0 @@
-# encoding: UTF-8
-#
-# Copyright 2015 Shawn Neal <sneal@sneal.net>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-module WinRM
-  module FS
-    module Core
-      # Executes commands used by the WinRM file management module
-      class CommandExecutor
-        def initialize(service)
-          @service = service
-        end
-
-        def open
-          @shell = @service.open_shell
-          @shell_open = true
-        end
-
-        def close
-          @service.close_shell(@shell) if @shell
-          @shell_open = false
-        end
-
-        def run_powershell(script)
-          assert_shell_is_open
-          run_cmd('powershell', ['-encodedCommand', encode_script(safe_script(script))])
-        end
-
-        def run_cmd(command, arguments = [])
-          assert_shell_is_open
-          result = nil
-          @service.run_command(@shell, command, arguments) do |command_id|
-            result = @service.get_command_output(@shell, command_id)
-          end
-          assert_command_success(command, result)
-          result.stdout
-        end
-
-        private
-
-        def assert_shell_is_open
-          fail 'You must call open before calling any run methods' unless @shell_open
-        end
-
-        def assert_command_success(command, result)
-          return if result[:exitcode] == 0 && result.stderr.length == 0
-          fail WinRMUploadError, command + '\n' + result.output
-        end
-
-        def encode_script(script)
-          encoded_script = script.encode('UTF-16LE', 'UTF-8')
-          Base64.strict_encode64(encoded_script)
-        end
-
-        # suppress the progress stream from leaking to stderr
-        def safe_script(script)
-          "$ProgressPreference='SilentlyContinue';" + script
-        end
-      end
-    end
-  end
-end

data/lib/winrm-fs/core/file_uploader.rb

@@ -1,84 +0,0 @@
-# encoding: UTF-8
-#
-# Copyright 2015 Shawn Neal <sneal@sneal.net>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-require_relative 'command_executor'
-
-module WinRM
-  module FS
-    module Core
-      # Uploads the given source file to a temp file in 8k chunks
-      class FileUploader
-        def initialize(command_executor)
-          @command_executor = command_executor
-        end
-
-        # Uploads the given file to the specified temp file as base64 encoded.
-        #
-        # @param [String] Path to the local source file on this machine
-        # @param [String] Path to the file on the target machine
-        # @return [Integer] Count of bytes uploaded
-        def upload(local_file, remote_file, &block)
-          @command_executor.run_powershell(prepare_script(remote_file))
-          do_upload(local_file, dos_path(remote_file), &block)
-        end
-
-        private
-
-        def do_upload(local_file, remote_file)
-          bytes_copied = 0
-          base64_array = base64_content(local_file)
-          base64_array.each_slice(8000 - remote_file.size) do |chunk|
-            @command_executor.run_cmd("echo #{chunk.join} >> \"#{remote_file}\"")
-            bytes_copied += chunk.count
-            yield bytes_copied, base64_array.count if block_given?
-          end
-          base64_array.length
-        end
-
-        def base64_content(local_file)
-          base64_host_file = Base64.encode64(IO.binread(local_file)).gsub("\n", '')
-          base64_host_file.chars.to_a
-        end
-
-        def dos_path(path)
-          # TODO: convert all env vars
-          path = path.gsub(/\$env:TEMP/, '%TEMP%')
-          path.gsub(/\\/, '/')
-        end
-
-        # rubocop:disable Metrics/MethodLength
-        def prepare_script(remote_file)
-          <<-EOH
-            $p = $ExecutionContext.SessionState.Path
-            $path = $p.GetUnresolvedProviderPathFromPSPath("#{remote_file}")
-
-            # if the file exists, truncate it
-            if (Test-Path $path -PathType Leaf) {
-              '' | Set-Content $path
-            }
-
-            # ensure the target directory exists
-            $dir = [System.IO.Path]::GetDirectoryName($path)
-            if (!(Test-Path $dir -PathType Container)) {
-              mkdir $dir -ErrorAction SilentlyContinue | Out-Null
-            }
-          EOH
-        end
-        # rubocop:enable Metrics/MethodLength
-      end
-    end
-  end
-end

data/lib/winrm-fs/core/temp_zip_file.rb

@@ -1,187 +0,0 @@
-# encoding: UTF-8
-#
-# Copyright 2015 Shawn Neal <sneal@sneal.net>
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-require 'English'
-require 'zip'
-require 'fileutils'
-require 'pathname'
-
-module WinRM
-  module FS
-    module Core
-      # Temporary zip file on the local system
-      class TempZipFile
-        attr_reader :zip_file, :path, :paths, :basedir, :options
-
-        # Creates a new local temporary zip file
-        # @param [String] Base directory to use when expanding out files passed to add
-        # @param [Hash] Options: zip_file, via, recurse_paths
-        def initialize(basedir = Dir.pwd, options = {})
-          @basedir = Pathname.new(basedir)
-          @options = options
-          @zip_file = options[:zip_file] || Tempfile.new(['winrm_upload', '.zip'])
-          @zip_file.close unless @zip_file.respond_to?('closed?') && @zip_file.closed?
-          @path = Pathname.new(@zip_file)
-        end
-
-        # Adds a file or directory to the temporary zip file
-        # @param [String] Directory or file path relative to basedir to add into zip
-        def add(*new_paths)
-          new_paths.each do | path |
-            absolute_path = File.expand_path(path, basedir)
-            fail "#{path} must exist relative to #{basedir}" unless File.exist? absolute_path
-            paths << Pathname.new(absolute_path).relative_path_from(basedir)
-          end
-        end
-
-        def paths
-          @paths ||= []
-        end
-
-        def delete
-          @zip_file.delete
-        end
-
-        def build
-          factory.new(self).build
-        end
-
-        private
-
-        def factory
-          @factory ||= case options[:via]
-                       when nil, :rubyzip
-                         RubyZipFactory
-                       when :shell
-                         ShellZipFactory
-                       else
-                         fail "Unknown zip factory: #{factory}"
-                       end
-        end
-      end
-
-      # Creates a zip file by shelling out to the zip command
-      class ShellZipFactory
-        attr_reader :zip_definition, :basedir, :zip_file, :paths, :options
-
-        def initialize(zip_definition)
-          @zip_definition = zip_definition
-          @zip_file = zip_definition.zip_file
-          @basedir = zip_definition.basedir
-          @paths = zip_definition.paths
-          @options = build_options.push('--names-stdin').join(' ')
-        end
-
-        def build
-          Dir.chdir(basedir) do
-            # zip doesn't like the file that already exists
-            output = `zip #{zip_definition.path}.tmp #{options} < #{write_file_list.path}`
-            fail "zip command failed: #{output}" unless $CHILD_STATUS.success?
-
-            FileUtils.mv("#{zip_definition.path}.tmp", "#{zip_definition.path}")
-          end
-        end
-
-        private
-
-        def write_file_list
-          file_list = Tempfile.new('file_list')
-          file_list.puts paths.join("\n")
-          file_list.close
-          file_list
-        end
-
-        def build_options
-          zip_definition.options.map do | key, value |
-            prefix = key.length > 1 ? '--' : '-'
-            if value == true
-              "#{prefix}#{key}"
-            else
-              "#{prefix}#{key} #{value}"
-            end
-          end
-        end
-      end
-
-      # Creates a zip file using RubyZip
-      class RubyZipFactory
-        attr_reader :zip_definition, :basedir
-
-        def initialize(zip_definition)
-          @zip_definition = zip_definition
-          @basedir = zip_definition.basedir
-          @zip = Zip::File.open(zip_definition.path, Zip::File::CREATE)
-        end
-
-        def build
-          @zip_definition.paths.each do | path |
-            absolute_path = File.expand_path(path, basedir)
-            fail "#{path} doesn't exist" unless File.exist? absolute_path
-
-            if File.directory?(absolute_path)
-              add_directory(path)
-            else
-              add_file(path)
-            end
-          end
-          close
-        end
-
-        def close
-          @zip.close if @zip
-        end
-
-        private
-
-        # Adds all files in the specified directory recursively into the zip file
-        # @param [String] Directory to add into zip
-        def add_directory(dir)
-          glob_pattern = '*'
-          glob_pattern = '**/*' if zip_definition.options[:recurse_paths]
-
-          glob = File.join(basedir, dir, glob_pattern)
-          Dir.glob(glob).each do |file|
-            add_file(file)
-          end
-        end
-
-        def add_file(file)
-          write_zip_entry(file, basedir)
-        end
-
-        def write_zip_entry(file, _file_entry_path)
-          absolute_file = File.expand_path(file, basedir)
-          relative_file = Pathname.new(absolute_file).relative_path_from(basedir).to_s
-          entry = new_zip_entry(relative_file)
-          @zip.add(entry, absolute_file)
-        end
-
-        def new_zip_entry(file_entry_path)
-          Zip::Entry.new(
-            @zip,
-            file_entry_path,
-            nil,
-            nil,
-            nil,
-            nil,
-            nil,
-            nil,
-            ::Zip::DOSTime.new(2000))
-        end
-      end
-    end
-  end
-end