vagrant-scp-sync 0.5.10 → 0.5.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b37865ce15d9a043ad16012e533166f7fd9a0b3706aead065563929008fb924
-  data.tar.gz: ecd9d22f28a254d2c711a7975c873fe55abf861acd49b0eea40af85128718501
+  metadata.gz: a6dab1627126fa4175b128368987b80ba059ada1226d05346325bac4c124fe4c
+  data.tar.gz: ecf339d488869952c926f2226bdc0e584c6c4c9139455497a89a65441d544868
 SHA512:
-  metadata.gz: a3513b9189a63c1161f191ed70c7dadbdbfbd4aba0d2fa01ed5916526f019c342cd698c22b48c1458275c78087f1a6e6c639b6bbaa1ec3d5618002d1ddf098e8
-  data.tar.gz: 8f804f9f6c82ba3929ac3a79d4f3984baed01f42b52591b7c9319b1f21ec189afe6b01fb2dde85e4bbe6a1d89c7f80ad559a17aba629ceb7c119a7852181cd85
+  metadata.gz: ca832eaa5a34e0f0535ec8ff2e7806cf0ba2f472e5df84e8c6f1973af1f1cbf0a2148e240b516c4f20246e077b670d0bee449c5c5a35d760d9eef83262603cee
+  data.tar.gz: 45ba7fa7c86c90836a8c1b78427e0e1a250ce348c8e1b34a7effcc7d1b0612c69d3a7a140ea0659e0bcd640a8b559672041caa31dd0d496af1faebce190f50e0

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [0.5.11](https://github.com/STARTcloud/vagrant-scp-sync/compare/v0.5.10...v0.5.11) (2024-11-20)
+
+
+### Bug Fixes
+
+* implentation complete ([987197d](https://github.com/STARTcloud/vagrant-scp-sync/commit/987197d15506d7c11b08af2e279efeb178037b71))
+* linting ([c531e5b](https://github.com/STARTcloud/vagrant-scp-sync/commit/c531e5b2137781d6c670dc1cc0053d79a63637b6))
+* linting ([9720ea7](https://github.com/STARTcloud/vagrant-scp-sync/commit/9720ea74d683180f213b62dc45c821b3b3e9c615))
+* linting ([dbc75c3](https://github.com/STARTcloud/vagrant-scp-sync/commit/dbc75c328c7e5e042d02e8c7472a83e3898b274b))
+* linting ([fbb7533](https://github.com/STARTcloud/vagrant-scp-sync/commit/fbb7533ee869bd1d761fd33b365b26bcca9557c7))
+* linting ([70266d1](https://github.com/STARTcloud/vagrant-scp-sync/commit/70266d1a4aafe9e68ed9e1f5f0242268f1f3e5cc))
+* linting ([3e7facd](https://github.com/STARTcloud/vagrant-scp-sync/commit/3e7facd04a4af7060773e96b6e298a2c0ae0f953))
+* linting ([da0ef5d](https://github.com/STARTcloud/vagrant-scp-sync/commit/da0ef5d2435ca6cef31fc626891d1144677a34bb))
+* synced folders reference ([2b8ade9](https://github.com/STARTcloud/vagrant-scp-sync/commit/2b8ade9ef7d896e11851eb004ac687031f8dd1a0))
+* synced folders refernce ([3efe97c](https://github.com/STARTcloud/vagrant-scp-sync/commit/3efe97c50ea6e18e5aca4876c2fd05003401ddb0))
+* synced folders refernce ([fa1dfc5](https://github.com/STARTcloud/vagrant-scp-sync/commit/fa1dfc5a04611ac623b84cd02c7c513fb390936e))
+
 ## [0.5.10](https://github.com/STARTcloud/vagrant-scp-sync/compare/v0.5.9...v0.5.10) (2024-11-19)
 
 

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

@@ -7,65 +7,104 @@ module VagrantPlugins
   module ScpSync
     # This will SCP the files
     class ScpSyncHelper
-      def self.scp_single(machine, opts)
+      def self.scp_single(machine, opts, scp_path)
         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?('/')
+        source_files = expand_path(opts[:map], machine)
+        has_trailing_slash_source = opts[:map].end_with?('/')
+        sync_source_files = append_wildcard(source_files, has_trailing_slash_source)
+
+        target_files = expand_path(opts[:to], machine)
+
         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
+
+        ssh_opts = build_ssh_options(ssh_info)
+        scp_opts = build_scp_options(opts)
+
+        delete = scp_opts.include?('--delete')
 
         if opts[:direction] == :upload || opts[:direction].nil?
-          source = "'#{source_files}'"
-          target = "#{username}@#{host}:'#{target_files}'"
+          source = sync_source_files
+          target = "#{ssh_info[:username]}@#{ssh_info[:host]}:#{target_files}"
+          make_dir = build_ssh_command(ssh_opts, "sudo mkdir -p #{target_files}", ssh_info)
+          change_ownership = build_ssh_command(ssh_opts, "sudo chown -R #{opts[:owner]}:#{opts[:group]} #{target_files}", ssh_info)
+          change_permissions = build_ssh_command(ssh_opts, "sudo chmod 777 #{target_files}", ssh_info)
+          remove_dir = build_ssh_command(ssh_opts, "sudo rm -rf #{target_files}", ssh_info)
         elsif opts[:direction] == :download
-          source = "#{username}@#{host}:'#{source_files}'"
-          target = "'#{target_files}'"
+          source = "#{ssh_info[:username]}@#{ssh_info[:host]}:#{sync_source_files}"
+          target = target_files
+          make_dir = "mkdir -p #{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(' ')
+        synchronize = build_scp_command(scp_path, ssh_opts, source, target)
+        execute_command(machine, remove_dir, delete, nil, opts)
+        execute_command(machine, make_dir, false, nil, opts)
+        execute_command(machine, change_ownership, false, nil, opts)
+        execute_command(machine, change_permissions, false, nil, opts)
+        execute_command(machine, synchronize, true, 'scp_sync_folder', opts)
+      end
 
-        command_opts = {}
-        command_opts[:workdir] = machine.env.root_path.to_s
+      def self.expand_path(path, machine)
+        expanded_path = File.expand_path(path, machine.env.root_path)
+        Vagrant::Util::Platform.fs_real_path(expanded_path).to_s
+      end
 
-        machine.ui.info(I18n.t('vagrant.scp_folder', source_files: source_files, target_files: target_files))
+      def self.append_wildcard(path, has_trailing_slash)
+        has_trailing_slash ? "#{path}/*" : path
+      end
 
-        command += [command_opts]
+      def self.build_ssh_options(ssh_info)
+        opts = %w[
+          -o StrictHostKeyChecking=no
+          -o UserKnownHostsFile=/dev/null
+          -o LogLevel=ERROR
+        ]
+        opts << "-o port=#{ssh_info[:port]}"
+        opts << ssh_info[:private_key_path].map { |k| "-i #{k}" }.join(' ')
+        opts
+      end
 
-        r = Vagrant::Util::Subprocess.execute(*command)
+      def self.build_scp_options(opts)
+        opts[:scp__args] ? Array(opts[:scp__args]).dup : ['--verbose']
+      end
 
-        return if r.exit_code.zero?
+      def self.build_ssh_command(ssh_opts, command, ssh_info)
+        ['ssh', *ssh_opts, "#{ssh_info[:username]}@#{ssh_info[:host]}", command].join(' ')
+      end
 
-        raise Vagrant::Errors::SyncedFolderScpSyncError,
-              command: command.inspect,
-              source_files: source_files,
-              target_files: target_files,
-              stderr: r.stderr
+      def self.build_scp_command(scp_path, ssh_opts, source, target)
+        [scp_path, '-r', *ssh_opts, source, target].join(' ')
       end
+
+      def self.execute_command(machine, command, raise_error, message_key, opts)
+        return if command.nil?
+
+        if message_key
+          machine.ui.info(
+            I18n.t(
+              "vagrant_scp_sync.action.#{message_key}",
+              command: command,
+              target_files: opts[:to],
+              source_files: opts[:map]
+            )
+          )
+        end
+
+        result = Vagrant::Util::Subprocess.execute('sh', '-c', command)
+
+        raise_scp_error(message_key, command, result.stderr) if raise_error && !result.exit_code.zero?
+      end
+
+      def self.raise_scp_error(message_key, command, stderr)
+        raise Errors.const_get("SyncedFolderScpSync#{message_key.split('_').map(&:capitalize).join}Error"),
+              command: command,
+              stderr: stderr
+      end
+
+      private_class_method :expand_path, :append_wildcard, :build_ssh_options, :build_scp_options,
+                           :build_ssh_command, :build_scp_command, :execute_command, :raise_scp_error
     end
   end
 end

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

@@ -6,7 +6,7 @@ module VagrantPlugins
   module ScpSync
     module Command
       # This class defines SCPSync
-      class ScpSync < Vagrant.plugin(2, :command)
+      class ScpSync < Vagrant.plugin('2', :command)
         def self.synopsis
           'Copies data into a box via SCP'
         end

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

@@ -2,16 +2,43 @@
 
 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
+module VagrantPlugins
+  module ScpSync
+    module Errors
+      # Namespace for Vagrant SCP Sync Errors
+      class VagrantScpSyncError < Vagrant::Errors::VagrantError
+        error_namespace('vagrant_scp_sync.errors')
+      end
+
+      # This Class denotes Errors for SCP Sync
+      class SyncedFolderScpSyncError < VagrantScpSyncError
+        error_key(:scp_sync_error, 'vagrant_scp_sync.errors')
+      end
+
+      # This Class denotes Delete Dir Errors for SCP Sync
+      class SyncedFolderScpSyncDeleteDirError < VagrantScpSyncError
+        error_key(:scp_sync_error_delete_directory, 'vagrant_scp_sync.errors')
+      end
+
+      # This Class denotes Make Dir Errors for SCP Sync
+      class SyncedFolderScpSyncMakeDirError < VagrantScpSyncError
+        error_key(:scp_sync_error_make_directory, 'vagrant_scp_sync.errors')
+      end
+
+      # This Class denotes Make Dir Errors for SCP Sync
+      class SyncedFolderScpSyncChangePermissionsDirError < VagrantScpSyncError
+        error_key(:scp_sync_error_change_permissions_directory, 'vagrant_scp_sync.errors')
+      end
+
+      # This Class denotes Make Dir Errors for SCP Sync
+      class SyncedFolderScpSyncChangeOwnershipDirError < VagrantScpSyncError
+        error_key(:scp_sync_error_change_ownership_directory, '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')
+      # This Class denotes that SCP Sync is not found
+      class SCPNotFound < VagrantScpSyncError
+        error_key(:scp_installed_error, 'vagrant_scp_sync.errors')
+      end
     end
   end
 end

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

@@ -19,7 +19,7 @@ module VagrantPlugins
 
       command 'scp' do
         setup_i18n
-        require_relative 'command'
+        require_relative 'command/scp'
         Command
       end
 
@@ -28,10 +28,47 @@ module VagrantPlugins
         SyncedFolder
       end
 
+      # This initializes the internationalization strings.
       def self.setup_i18n
         I18n.load_path << File.expand_path('locales/en.yml', ScpSync.source_root)
         I18n.reload!
       end
+
+      # This sets up our log level to be whatever VAGRANT_LOG is.
+      def self.setup_logging
+        require 'log4r'
+
+        level = nil
+        begin
+          level = Log4r.const_get(ENV['VAGRANT_LOG'].upcase)
+        rescue NameError
+          # This means that the logging constant wasn't found,
+          # which is fine. We just keep `level` as `nil`. But
+          # we tell the user.
+          level = nil
+        end
+
+        # Some constants, such as "true" resolve to booleans, so the
+        # above error checking doesn't catch it. This will check to make
+        # sure that the log level is an integer, as Log4r requires.
+        level = nil unless level.is_a?(Integer)
+
+        # Set the logging level on all "vagrant" namespaced
+        # logs as long as we have a valid level.
+
+        return unless level
+
+        logger = Log4r::Logger.new('vagrant_scp_sync')
+        logger.outputters = Log4r::Outputter.stderr
+        logger.level = level
+        logger
+      end
+
+      # Setup logging and i18n before any autoloading loads other classes
+      # with logging configured as this prevents inheritance of the log level
+      # from the parent logger.
+      setup_logging
+      setup_i18n
     end
   end
 end

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

@@ -18,11 +18,11 @@ module VagrantPlugins
         @logger = Log4r::Logger.new('vagrant_scp_sync')
       end
 
-      def usable?(_machine, raise_error: false)
+      def usable?(_machine, *args)
         scp_path = Which.which('scp')
         return true if scp_path
 
-        return false unless raise_error
+        return false unless args.include?(:raise_error) && args[:raise_error]
 
         raise Vagrant::Errors::SCPNotFound
       end
@@ -31,11 +31,12 @@ module VagrantPlugins
 
       def enable(machine, folders, _opts)
         ssh_info = machine.ssh_info
+        scp_path = Which.which('scp')
 
         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)
+          ScpSyncHelper.scp_single(machine, folder_opts, scp_path)
         end
       end
     end

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

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

data/lib/vagrant-scp-sync.rb

@@ -1,14 +1,25 @@
 # frozen_string_literal: true
 
-require 'vagrant-scp-sync/version'
-require 'vagrant-scp-sync/plugin'
-require 'vagrant-scp-sync/errors'
+require 'pathname'
 
 module VagrantPlugins
   # This is used to SCP files to/from Guests and Hosts
   module ScpSync
+    lib_path = Pathname.new(File.expand_path('vagrant-scp-sync', __dir__))
+    autoload :Errors, lib_path.join('errors')
     def self.source_root
       @source_root ||= Pathname.new(File.expand_path('..', __dir__))
     end
   end
 end
+
+begin
+  require 'vagrant'
+rescue LoadError
+  raise 'The Vagrant vagrant-zones plugin must be run within Vagrant.'
+end
+
+raise 'The Vagrant vagrant-zones plugin is only compatible with Vagrant 2+.' if Vagrant::VERSION < '2'
+
+require 'vagrant-scp-sync/version'
+require 'vagrant-scp-sync/plugin'

data/locales/en.yml

@@ -1,18 +1,53 @@
 en:
   vagrant_scp_sync:
+    action:
+      scp_sync_folder: |-
+        Syncing Folder: %{source_files} ==> %{target_files}
+
     errors:
       not_yet_implemented: |-
         Configuration is not yet implemented
+      scp_sync_error_delete_directory: |-
+        There was an error when attemping to delete the directory for SCP Sync.
+        Target Files: %{target_files}
+
+        Error: %{stderr}
+        Full command causing error:
+        %{command}
+
+      scp_sync_error_change_ownership_directory: |-
+        There was an error when attemping to change the ownership of the directory for SCP Sync.
+        Target Files: %{target_files}
+
+        Error: %{stderr}
+        Full command causing error:
+        %{command}
+
+      scp_sync_error_change_permissions_directory: |-
+        There was an error when attemping to change the permissions of the directory for SCP Sync.
+        Target Files: %{target_files}
+
+        Error: %{stderr}
+        Full command causing error:
+        %{command}
+
+      scp_sync_error_make_directory: |-
+        There was an error when attemping to create the directory for SCP Sync.
+        Target Files: %{target_files}
+
+        Error: %{stderr}
+        Full command causing error:
+        %{command}
 
       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}
+        Source Files: %{source_files}
+        Target Files: %{target_files}
         Error: %{stderr}
-        Full command causing error: 
+        Full command causing error:
         %{command}
 
       scp_installed_error: |-
-        SCP was not detected as installed
+        SCP was not detected as installed

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-scp-sync
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.5.11
 platform: ruby
 authors:
 - Mark Gilbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-19 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n