vagrant-winrm-file-download 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 533c81cb90827c3e2c7e88b5923cbfb4ea306d96b93722cebb12fc3616c8f8ef
+  data.tar.gz: 899ba3dd911a750f5e92509f0faa4dcd5173e343cc31ffd3d5fadd546afd5abe
+SHA512:
+  metadata.gz: 1e58b2c50ba7e44965a0a820a0ecd3fca50915c4cc63f6ba7ce76fb350b84efc4f13984fb1030b00ff2a629d52d776e6704863e961484e5eabc710afdcac1fd3
+  data.tar.gz: 66a386946c3f66ff8ddfc7403517ba5b1b566ef1a1ce3b7608fd34efdea43f0d311c5e4dfd3e11b3febaa50b0bde1ac89b2e60c9611d4c28364deb1a8b90f58c

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.vagrant
+.idea
+bin/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem "vagrant", git: "https://github.com/mitchellh/vagrant.git"
+end

data/LICENSE.txt

@@ -0,0 +1,12 @@
+Copyright (c) Octopus Deploy and contributors. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+these files 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.

data/README.md

@@ -0,0 +1,62 @@
+# Vagrant WinRM File Downloader Plugin
+
+This is a super simple vagrant provisioner plugin that allows you to download files from the guest to the host.
+
+## Installation
+
+```vagrant plugin install vagrant-winrm-file-download```
+
+## Usage
+
+In your Vagrantfile, add the following plugin and configure to your needs:
+
+```ruby
+  config.vm.provision "winrm-file-download" do |file|
+    file.source = 'c:\temp\foo.txt'
+    file.destination = 'c:\temp\foo-downloaded.txt'
+  end
+```
+
+## Uninstallation
+
+```vagrant plugin uninstall vagrant-dsc```
+
+## Development
+
+Before getting started, read the Vagrant plugin [development basics](https://docs.vagrantup.com/v2/plugins/development-basics.html) and [packaging](https://docs.vagrantup.com/v2/plugins/packaging.html) documentation.
+
+Development was done against:
+* Ruby 2.6.4
+* Bundler 1.17.2, and 
+* vagrant [master@9eac6ae62d6a](https://github.com/hashicorp/vagrant/commit/9eac6ae62d6ad7acdd173fabe558ba75156245b6), which is likely to be 2.2.6
+
+```
+git clone git@github.com:OcotpusDeploy/vagrant-winrm-file-download.git
+cd vagrant-winrm-file-download
+bundle install
+```
+
+Run tests:
+```
+# tests are... not yet there
+bundle exec rake spec
+```
+
+Run Vagrant in context of current vagrant-dsc plugin:
+```
+cd <directory>
+bundle exec vagrant up
+```
+
+### Building a new version
+1. update the version number in the `lib/vagrant-winrm-file-download.rb`
+1. run `gem build .\vagrant-winrm-file-download.gemspec`
+
+## Contributing
+
+1. Create a github issue to discuss your idea
+1. Fork it ( https://github.com/[your-github-username]/vagrant-winrm-file-download/fork )
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes, including relevant tests (`git commit -am 'Add some feature'`)
+1. Squash commits & push to the branch (`git push origin my-new-feature`)
+1. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+task :default => [:test]
+# Remove 'install' task as the gem is installed to Vagrant, not to system
+Rake::Task[:install].clear
+namespace :test do
+  RSpec::Core::RakeTask.new('unit') do |task|
+    task.pattern = 'spec/**/*_spec.rb'
+  end
+end
+desc "Run all tests"
+task :test => ['test:unit']
+task :spec => :test

data/lib/vagrant-winrm-file-download/config.rb

@@ -0,0 +1,22 @@
+require "vagrant"
+
+module VagrantPlugins
+  module WinRmFileDownload
+    class Config < Vagrant.plugin("2", :config)
+      attr_accessor :source
+      attr_accessor :destination
+
+      def validate(machine)
+        errors = _detected_errors
+
+        if !source
+          errors << "No source file specified"
+        end
+        if !destination
+          errors << "No destination path specified"
+        end
+        { "WinRm file download provisioner" => errors }
+      end
+    end
+  end
+end

data/lib/vagrant-winrm-file-download/plugin.rb

@@ -0,0 +1,23 @@
+require "vagrant"
+
+module VagrantPlugins
+  module WinRmFileDownload
+    class Plugin < Vagrant.plugin("2")
+      name "winrm-file-download"
+      description <<-DESC
+        Provides support for downloading a file from the guest
+        to the host via WinRM.
+      DESC
+
+      config("winrm-file-download", :provisioner) do
+        require File.expand_path("../config", __FILE__)
+        Config
+      end
+
+      provisioner("winrm-file-download") do
+        require File.expand_path("../provisioner", __FILE__)
+        Provisioner
+      end
+    end
+  end
+end

data/lib/vagrant-winrm-file-download/provisioner.rb

@@ -0,0 +1,43 @@
+module VagrantPlugins
+  module WinRmFileDownload
+    class Provisioner < Vagrant.plugin("2", :provisioner)
+      def provision
+        # this is pratically identical to https://github.com/hashicorp/vagrant/blob/9eac6ae62d6ad7acdd173fabe558ba75156245b6/plugins/provisioners/file/provisioner.rb
+        @machine.communicate.tap do |comm|
+          source = expand_guest_path(config.source)
+          destination = File.expand_path(config.destination)
+
+          # If the source is a directory determine if any path modifications
+          # need to be applied to the source for upload behavior. If the original
+          # source value ends with a "." or if the original source does not end
+          # with a "." but the original destination ends with a file separator
+          # then append a "." character to the new source. This ensures that
+          # the contents of the directory are uploaded to the destination and
+          # not folder itself.
+          if File.directory?(source)
+            if config.source.end_with?(".") ||
+                (!config.destination.end_with?(File::SEPARATOR) &&
+                !config.source.end_with?("#{File::SEPARATOR}."))
+              source = File.join(source, ".")
+            end
+          end
+
+          @machine.ui.detail("Downloading from #{source} on guest to #{destination} on host.")
+          # now download the file
+          comm.download(source, destination)
+        end
+      end
+
+      private
+
+      # Expand the guest path if the guest has the capability
+      def expand_guest_path(destination)
+        if machine.guest.capability?(:shell_expand_guest_path)
+          machine.guest.capability(:shell_expand_guest_path, destination)
+        else
+          destination
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-winrm-file-download/version.rb

@@ -0,0 +1,5 @@
+module Vagrant
+  module WinRmFileDownload
+   VERSION = "0.0.1"
+  end
+end

data/lib/vagrant-winrm-file-download.rb

@@ -0,0 +1,11 @@
+require "pathname"
+
+require "vagrant-winrm-file-download/plugin"
+
+module VagrantPlugins
+  module WinRmFileDownload
+    lib_path = Pathname.new(File.expand_path("../vagrant-winrm-file-download", __FILE__))
+    autoload :Action, lib_path.join("action")
+    autoload :Errors, lib_path.join("errors")
+  end
+end

data/vagrant-winrm-file-download.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-winrm-file-download/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-winrm-file-download"
+  spec.version       = Vagrant::WinRmFileDownload::VERSION
+  spec.authors       = ["Matt Richardson"]
+  spec.email         = ["matt.richardson@octopus.com"]
+  spec.summary       = "WinRM file download Provisioner for Vagrant"
+  spec.description   = "Provisioner plugin that downloads files from guest to host with Vagrant."
+  spec.homepage      = "https://github.com/OctopusDeploy/vagrant-winrm-file-download"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+end

data/vagrantfile

@@ -0,0 +1,48 @@
+# -*- mode: ruby -*-
+
+# this is a sample file for using & testing the plugin
+
+VAGRANT_FILE_API_VERSION = "2"
+
+Vagrant.configure(VAGRANT_FILE_API_VERSION) do |config|
+
+  hostname = "vagrantdsc.local"
+  config.vm.guest = :windows
+  config.vm.communicator = :winrm
+
+  config.vm.allowed_synced_folder_types = [:winrm]
+  config.vm.synced_folder ".", "/vagrant", disabled: true
+
+  config.vm.provider "virtualbox" do |v, override|
+    v.gui = true
+    v.linked_clone = true
+    v.customize ["modifyvm", :id, "--natdnshostresolver1", "on"]
+    v.customize ["modifyvm", :id, "--audio", "none"]
+    v.customize ["modifyvm", :id, "--vram", "32"]
+    override.vm.box = "OctopusDeploy/dsc-test-server-windows-server-1803"
+    override.vm.box_url = "https://s3-ap-southeast-2.amazonaws.com/octopus-vagrant-boxes/vagrant/json/OctopusDeploy/virtualbox/dsc-test-server-windows-server-1803.json"
+    override.vm.network :forwarded_port, guest: 5985, host: 5985, id: "winrm", auto_correct: true
+  end
+
+  if Vagrant::Util::Platform.windows? then
+    config.vm.provider "hyperv" do |v, override|
+      override.vm.box = "OctopusDeploy/dsc-test-server-windows-server-1803"
+      override.vm.box_url = "https://s3-ap-southeast-2.amazonaws.com/octopus-vagrant-boxes/vagrant/json/OctopusDeploy/hyperv/dsc-test-server-windows-server-1803.json"
+      config.vm.network "public_network", bridge: "Default Switch"
+      v.memory = 2048
+      v.maxmemory = 2048
+      v.cpus = 2
+      override.vm.network :forwarded_port, guest: 5985, host: 5985, id: "winrm", auto_correct: true
+    end
+  end
+
+  # create a temp file
+  config.vm.provision "shell", inline: "get-date | set-content -path 'c:\\temp\\foo.txt'" 
+  
+  # download it
+  config.vm.provision "winrm-file-download" do |winrm|
+    winrm.source = 'c:\temp\foo.txt'
+    winrm.destination = 'c:\temp\foo-downloaded.txt'
+  end
+
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-winrm-file-download
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Richardson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-07-26 00:00:00.000000000 Z
+dependencies: []
+description: Provisioner plugin that downloads files from guest to host with Vagrant.
+email:
+- matt.richardson@octopus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-winrm-file-download.rb
+- lib/vagrant-winrm-file-download/config.rb
+- lib/vagrant-winrm-file-download/plugin.rb
+- lib/vagrant-winrm-file-download/provisioner.rb
+- lib/vagrant-winrm-file-download/version.rb
+- vagrant-winrm-file-download.gemspec
+- vagrantfile
+homepage: https://github.com/OctopusDeploy/vagrant-winrm-file-download
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: WinRM file download Provisioner for Vagrant
+test_files: []