vagrant-scp-sync 0.5.8 → 0.5.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65c818898c0656b74c7602b97bc8e9a65954254cd08a7d2dbdf740e177c86235
-  data.tar.gz: 62af0730c515cb15f50027d8fad094cf46ec973187749afb8c8d8f53edf439e5
+  metadata.gz: 48bd4bcdcb8103f2ca11386ff215a56fc98ef26d74b5d479736d0610480211a3
+  data.tar.gz: 1246659b2e00ada41282f939a5924038b3abe341452d09470d3a3dc3c2efb7e2
 SHA512:
-  metadata.gz: d1edeee758eacd0863690066cee48f67c7ad88d8f940c074c8f5b3e3ec87c19d3588b60d701ffdcc867f657c1e84414a49b56ecaa9a45df1879ea16afc5ee448
-  data.tar.gz: 667cb7d1e6abe906520039ebb4c9994a60ec9cfeffa76e60c335de4bad2aa0870e6f03ded3b535ccd4b001cee32868015b8ac5664ff8f7a6a83b57df2c6e9662
+  metadata.gz: e4fe45b3997bcbbe1138f0bb572dd6fe4dafa51adacfc78f62622229286f75e1af01a032ab7d981128e5539bcbcb46764c4d16332e313611d13cc237cd9440bd
+  data.tar.gz: ced2849fb7a6f595cac61fe13e88137b09a62ded22d7f252af1303ed71c51262600ba5d1f4e31538012f4049ec8733da8de4ae48428f295f7d2c7df38b304211

data/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "ansible.python.interpreterPath": "/bin/python3"
+}

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.5.9](https://github.com/STARTcloud/vagrant-scp-sync/compare/v0.5.8...v0.5.9) (2024-11-19)
+
+
+### Bug Fixes
+
+* add synced folders ([69bc1c6](https://github.com/STARTcloud/vagrant-scp-sync/commit/69bc1c683eddc802746f9e308cc951ad4baaee01))
+* linting ([e8739c4](https://github.com/STARTcloud/vagrant-scp-sync/commit/e8739c453433e682d8cefe86b3031a9754f3dec8))
+* linting ([2c92774](https://github.com/STARTcloud/vagrant-scp-sync/commit/2c92774f575ad1279a46cc3926c9b5bbf839410a))
+* linting ([87edab0](https://github.com/STARTcloud/vagrant-scp-sync/commit/87edab01efdfde25f05d35945bcd5e22c67dad0b))
+* linting ([98380fc](https://github.com/STARTcloud/vagrant-scp-sync/commit/98380fcf1b8c234ef5a7e42ced475f3416905681))
+* linting ([bc1c3d8](https://github.com/STARTcloud/vagrant-scp-sync/commit/bc1c3d87432320d77c7e47a023f99f63d98e63fa))
+* linting ([4b62732](https://github.com/STARTcloud/vagrant-scp-sync/commit/4b62732083b4a7fe516a0c77dec6618bdadd2fa1))
+* linting ([41bf13b](https://github.com/STARTcloud/vagrant-scp-sync/commit/41bf13b94d233997755bcf48e60e2e26ac8b9f37))
+* linting ([dd1b58f](https://github.com/STARTcloud/vagrant-scp-sync/commit/dd1b58fd7bad93afa9164dcf46e6f3668ee546be))
+
 ## [0.5.8](https://github.com/STARTcloud/vagrant-scp-sync/compare/v0.5.7...v0.5.8) (2024-06-25)
 
 

data/lib/vagrant-scp-sync/action/scp_sync.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'vagrant/util/platform'
+require 'vagrant/util/subprocess'
+
+module VagrantPlugins
+  module ScpSync
+    # This will SCP the files
+    class ScpSyncHelper
+      def self.scp_single(machine, opts)
+        ssh_info = machine.ssh_info
+        raise Vagrant::Errors::SSHNotReady if ssh_info.nil?
+
+        source_files = opts[:guestpath]
+        target_files = opts[:hostpath]
+        target_files = File.expand_path(target_files, machine.env.root_path)
+        target_files = Vagrant::Util::Platform.fs_real_path(target_files).to_s
+        target_files = Vagrant::Util::Platform.cygwin_path(target_files) if Vagrant::Util::Platform.windows?
+        source_files += '/' unless source_files.end_with?('/')
+        target_files += '/' unless target_files.end_with?('/')
+        opts[:owner] ||= ssh_info[:username]
+        opts[:group] ||= ssh_info[:username]
+        username = ssh_info[:username]
+        host = ssh_info[:host]
+        proxy_command = if @ssh_info[:proxy_command]
+                          "-o ProxyCommand='#{@ssh_info[:proxy_command]}' "
+                        else
+                          ''
+                        end
+
+        if opts[:direction] == :upload || opts[:direction].nil?
+          source = "'#{source_files}'"
+          target = "#{username}@#{host}:'#{target_files}'"
+        elsif opts[:direction] == :download
+          source = "#{username}@#{host}:'#{source_files}'"
+          target = "'#{target_files}'"
+        end
+
+        command = [
+          'scp',
+          '-r',
+          '-o StrictHostKeyChecking=no',
+          '-o UserKnownHostsFile=/dev/null',
+          "-o port=#{@ssh_info[:port]}",
+          '-o LogLevel=ERROR',
+          proxy_command,
+          @ssh_info[:private_key_path].map { |k| "-i '#{k}'" }.join(' '),
+          source,
+          target
+        ].join(' ')
+
+        command_opts = {}
+        command_opts[:workdir] = machine.env.root_path.to_s
+
+        machine.ui.info(I18n.t('vagrant.scp_folder', source_files: source_files, target_files: target_files))
+
+        command += [command_opts]
+
+        r = Vagrant::Util::Subprocess.execute(*command)
+
+        return if r.exit_code.zero?
+
+        raise Vagrant::Errors::SyncedFolderScpSyncError,
+              command: command.inspect,
+              source_files: source_files,
+              target_files: target_files,
+              stderr: r.stderr
+      end
+    end
+  end
+end

data/lib/vagrant-scp-sync/errors.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'vagrant'
+
+module Vagrant
+  module Errors
+    # This Class denotes Errors for SCP Sync
+    class SyncedFolderScpSyncError < VagrantError
+      error_key(:scp_sync_error, 'vagrant_scp_sync.errors')
+    end
+
+    # This Class denotes that SCP Sync is not found
+    class SCPNotFound < VagrantError
+      error_key(:scp_installed_error, 'vagrant_scp_sync.errors')
+    end
+  end
+end

data/lib/vagrant-scp-sync/plugin.rb

@@ -1,5 +1,13 @@
 # frozen_string_literal: true
 
+begin
+  require 'vagrant'
+rescue LoadError
+  raise 'The vagrant-scp-sync plugin must be run within Vagrant.'
+end
+
+raise 'The vagrant-scp-sync plugin is only compatible with Vagrant 2+' if Vagrant::VERSION < '2'
+
 module VagrantPlugins
   module ScpSync
     # This defines the class for the plugin vagrant-scp-sync
@@ -10,8 +18,19 @@ module VagrantPlugins
       DESC
 
       command 'scp' do
-        require_relative 'commands/scp'
-        Command::ScpSync
+        setup_i18n
+        require_relative 'command'
+        Command
+      end
+
+      synced_folder('scp', 5) do
+        require_relative 'synced_folder'
+        SyncedFolder
+      end
+
+      def self.setup_i18n
+        I18n.load_path << File.expand_path('locales/en.yml', ScpSync.source_root)
+        I18n.reload!
       end
     end
   end

data/lib/vagrant-scp-sync/synced_folders.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'log4r'
+require 'vagrant/util/subprocess'
+require 'vagrant/util/which'
+
+require_relative 'action/scp_sync'
+
+module VagrantPlugins
+  module ScpSync
+    # This Class prepares the environment for SCP Sync
+    class SyncedFolder < Vagrant.plugin('2', :synced_folder)
+      include Vagrant::Util
+
+      def initialize(*args)
+        super
+
+        @logger = Log4r::Logger.new('vagrant_scp_sync')
+      end
+
+      def usable?(_machine, raise_error: false)
+        scp_path = Which.which('scp')
+        return true if scp_path
+
+        return false unless raise_error
+
+        raise Vagrant::Errors::SCPNotFound
+      end
+
+      def prepare(machine, folders, opts); end
+
+      def enable(machine, folders, _opts)
+        ssh_info = machine.ssh_info
+
+        machine.ui.warn(I18n.t('vagrant.scp_ssh_password')) if ssh_info[:private_key_path].empty? && ssh_info[:password]
+
+        folders.each_value do |folder_opts|
+          ScpSyncHelper.scp_single(machine, folder_opts)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-scp-sync/version.rb

@@ -2,7 +2,7 @@
 
 module Vagrant
   module ScpSync
-    VERSION = '0.5.8'
+    VERSION = '0.5.9'
     NAME = 'vagrant-scp-sync'
   end
 end

data/lib/vagrant-scp-sync.rb

@@ -2,3 +2,13 @@
 
 require 'vagrant-scp-sync/version'
 require 'vagrant-scp-sync/plugin'
+require 'vagrant-scp-sync/errors'
+
+module VagrantPlugins
+  # This is used to SCP files to/from Guests and Hosts
+  module ScpSync
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('..', __dir__))
+    end
+  end
+end

data/locales/en.yml

@@ -1,5 +1,18 @@
-en:
-  vagrant_scp_sync:
-    errors:
-      not_yet_implemented: |-
-        Configuration is not yet implemented
+en:
+  vagrant_scp_sync:
+    errors:
+      not_yet_implemented: |-
+        Configuration is not yet implemented
+
+      scp_sync_error: |-
+        There was an error when attemping to sync folders using scp.
+        Please inspect the error message below for more info.
+
+        Host path: %{hostpath}
+        Guest path: %{guestpath}
+        Error: %{stderr}
+        Full command causing error: 
+        %{command}
+
+      scp_installed_error: |-
+        SCP was not detected as installed

data/vagrant-scp.gemspec

@@ -29,10 +29,10 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.7.0'
   spec.required_rubygems_version = '>= 1.3.6'
-  spec.add_runtime_dependency 'i18n', '~> 1.0'
-  spec.add_runtime_dependency 'iniparse', '~> 1.0'
-  spec.add_runtime_dependency 'log4r', '~> 1.1'
-  spec.add_runtime_dependency 'netaddr', '~> 2.0', '>= 2.0.4'
-  spec.add_runtime_dependency 'net-scp', '>= 1.1'
-  spec.add_runtime_dependency 'ruby_expect', '~> 1.7', '>= 1.7.5'
+  spec.add_dependency  'i18n', '~> 1.0'
+  spec.add_dependency  'iniparse', '~> 1.0'
+  spec.add_dependency  'log4r', '~> 1.1'
+  spec.add_dependency  'netaddr', '~> 2.0', '>= 2.0.4'
+  spec.add_dependency  'net-scp', '>= 1.1'
+  spec.add_dependency  'ruby_expect', '~> 1.7', '>= 1.7.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-scp-sync
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 0.5.9
 platform: ruby
 authors:
 - Mark Gilbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-25 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -122,6 +122,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".vscode/settings.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -138,8 +139,11 @@ files:
 - docs/css/styles.css
 - docs/index.html
 - lib/vagrant-scp-sync.rb
-- lib/vagrant-scp-sync/commands/scp.rb
+- lib/vagrant-scp-sync/action/scp_sync.rb
+- lib/vagrant-scp-sync/command/scp.rb
+- lib/vagrant-scp-sync/errors.rb
 - lib/vagrant-scp-sync/plugin.rb
+- lib/vagrant-scp-sync/synced_folders.rb
 - lib/vagrant-scp-sync/version.rb
 - locales/en.yml
 - vagrant-scp.gemspec