bfs-scp 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29d510784470981aeebbf54fdde1c56cafbe6e7a53bb3aa7cc1ac6f043315c3f
-  data.tar.gz: d80b9721dbb7934abddbb5ea09adf1fb0de83421cf9deeb298d0bf0ae450a50e
+  metadata.gz: 878d1632ac424efe2225eb33581d0725c07c6a90151b3cca5e5cd72ca2efe4f5
+  data.tar.gz: a86995b8873ddb45841358a0b6675b4a2987314812ca3fdca4ff46b04a08cc8d
 SHA512:
-  metadata.gz: 1d9bf7a73342ae2090dbbb487d87fc28aefd8680b6f6145c82f790905467e2e662152e7c5710f73147a163f4adc43687dbb63afece37b8867e20c437169b9af6
-  data.tar.gz: e0458841db2fa130caa4a64d4b954f4ef3fda113a905ce9ae3b9e556d3a468f3747cfdb83d9f5f629dda505a27ed35b60b445a10f35fdc7aeec1db70462f5495
+  metadata.gz: 461dc093c7849db7ac94c71596d9fda2ff55bcba1d5bd47002e35ceed2b81a9333221f1a741a0e8a6e04e5d0b81ed4edfd0cce1c471965014e632cfe07cbcded
+  data.tar.gz: 868529f0d5e1a9d0d21a7fa37ec6a04ace9b62bad34f92f7004374207a8970209bbe755671eea334af29a3b5e1a54a9931f9196f3db8b481be84d9c9f3f0c46e

data/lib/bfs/bucket/scp.rb

@@ -1,6 +1,5 @@
 require 'bfs'
 require 'net/scp'
-require 'net/ssh'
 require 'shellwords'
 
 module BFS
@@ -32,7 +31,7 @@ module BFS
         super(**opts)
 
         @prefix = prefix
-        @client = Net::SCP.start(host, nil, **opts.slice(*Net::SSH::VALID_OPTIONS))
+        @client = Net::SCP.start(host, nil, **opts.slice(*Net::SSH::VALID_OPTIONS), non_interactive: true)
 
         if @prefix # rubocop:disable Style/GuardClause
           @prefix = "#{norm_path(@prefix)}/"
@@ -42,14 +41,15 @@ module BFS
 
       # Lists the contents of a bucket using a glob pattern
       def ls(pattern = '**/*', **_opts)
-        prefix = @prefix ? abs_path(@prefix) : '/'
-        Enumerator.new do |y|
-          sh! 'find', prefix, '-type', 'f' do |out|
-            out.each_line do |line|
-              path = trim_prefix(norm_path(line.strip))
-              y << path if File.fnmatch?(pattern, path, File::FNM_PATHNAME)
-            end
-          end
+        Enumerator.new do |acc|
+          walk(pattern) {|path| acc << path }
+        end
+      end
+
+      # Iterates over the contents of a bucket using a glob pattern
+      def glob(pattern = '**/*', **_opts)
+        Enumerator.new do |acc|
+          walk(pattern, with_stat: true) {|info| acc << info }
         end
       end
 
@@ -57,9 +57,11 @@ module BFS
       def info(path, **_opts)
         full = full_path(path)
         path = norm_path(path)
-        out  = sh! 'stat', '-c', '%s;%Z;%a', full
+        out  = sh! %(stat -c '%F;%s;%Z;%a' #{Shellwords.escape full})
+
+        type, size, epoch, mode = out.strip.split(';', 4)
+        raise BFS::FileNotFound, path unless type.include?('file')
 
-        size, epoch, mode = out.strip.split(';', 3)
         BFS::FileInfo.new(path: path, size: size.to_i, mtime: Time.at(epoch.to_i), mode: BFS.norm_mode(mode))
       rescue CommandError => e
         e.status == 1 ? raise(BFS::FileNotFound, path) : raise
@@ -93,7 +95,7 @@ module BFS
       # Deletes a file.
       def rm(path, **_opts)
         path = full_path(path)
-        sh! 'rm', '-f', path
+        sh! %(rm -f #{Shellwords.escape(path)})
       end
 
       # Copies src to dst
@@ -105,7 +107,7 @@ module BFS
         full_dst = full_path(dst)
 
         mkdir_p File.dirname(full_dst)
-        sh! 'cp', '-a', '-f', full_src, full_dst
+        sh! %(cp -a -f #{Shellwords.escape(full_src)} #{Shellwords.escape(full_dst)})
       rescue CommandError => e
         e.status == 1 ? raise(BFS::FileNotFound, src) : raise
       end
@@ -119,7 +121,7 @@ module BFS
         full_dst = full_path(dst)
 
         mkdir_p File.dirname(full_dst)
-        sh! 'mv', '-f', full_src, full_dst
+        sh! %(mv -f #{Shellwords.escape(full_src)} #{Shellwords.escape(full_dst)})
       rescue CommandError => e
         e.status == 1 ? raise(BFS::FileNotFound, src) : raise
       end
@@ -140,23 +142,47 @@ module BFS
         abs_path(super)
       end
 
+      def walk(pattern, with_stat: false)
+        prefix  = @prefix ? abs_path(@prefix) : '/'
+        command = %(find #{Shellwords.escape(prefix)} -type f)
+        command << %( -exec stat -c '%s;%Z;%a;%n' {} \\;) if with_stat
+
+        sh!(command) do |out|
+          out.each_line do |line|
+            line.strip!
+
+            if with_stat
+              size, epoch, mode, path = out.strip.split(';', 4)
+              path = trim_prefix(norm_path(path))
+              next unless File.fnmatch?(pattern, path, File::FNM_PATHNAME)
+
+              info = BFS::FileInfo.new(path: path, size: size.to_i, mtime: Time.at(epoch.to_i), mode: BFS.norm_mode(mode))
+              yield info
+            else
+              path = trim_prefix(norm_path(line))
+              yield path if File.fnmatch?(pattern, path, File::FNM_PATHNAME)
+            end
+          end
+        end
+      end
+
       def mkdir_p(path)
-        sh! 'mkdir', '-p', path
+        sh! %(mkdir -p #{Shellwords.escape(path)})
       end
 
-      def sh!(*cmd) # rubocop:disable Metrics/MethodLength
+      def sh!(command) # rubocop:disable Metrics/MethodLength
         stdout = ''
         stderr = nil
         status = 0
-        cmdstr = cmd.map {|x| Shellwords.escape(x) }.join(' ')
 
         @client.session.open_channel do |ch|
-          ch.exec(cmdstr) do |_, _success|
+          ch.exec(command) do |_, _success|
             ch.on_data do |_, data|
+              stdout << data
+
               if block_given?
-                yield data
-              else
-                stdout += data
+                pos = stdout.rindex("\n")
+                yield stdout.slice!(0..pos) if pos
               end
             end
             ch.on_extended_data do |_, _, data|
@@ -167,8 +193,14 @@ module BFS
             end
           end
         end
+
+        if block_given? && stdout.length.positive?
+          yield stdout
+          stdout.clear
+        end
+
         @client.session.loop
-        raise CommandError.new(cmdstr, status, stderr) unless status.zero?
+        raise CommandError.new(command, status, stderr) unless status.zero?
 
         stdout
       end

data/spec/bfs/bucket/scp_spec.rb

@@ -1,24 +1,25 @@
 require 'spec_helper'
 
 RSpec.describe BFS::Bucket::SCP, scp: true do
+  subject { described_class.new hostname, **conn_opts }
+
   let(:hostname) { '127.0.0.1' }
   let(:conn_opts) { { port: 7022, user: 'root', password: 'root', prefix: prefix } }
   let(:prefix) { SecureRandom.uuid }
 
-  subject { described_class.new hostname, **conn_opts }
   after { subject.close }
 
-  context 'absolute' do
+  context 'with absolute path' do
     it_behaves_like 'a bucket', content_type: false, metadata: false
   end
 
-  context 'relative' do
+  context 'with relative path' do
     let(:prefix) { "~/#{SecureRandom.uuid}" }
 
     it_behaves_like 'a bucket', content_type: false, metadata: false
   end
 
-  it 'should resolve from URL' do
+  it 'resolves from URL' do
     bucket = BFS.resolve('scp://root:root@127.0.0.1:7022')
     expect(bucket).to be_instance_of(described_class)
     expect(bucket.instance_variable_get(:@prefix)).to be_nil
@@ -30,7 +31,7 @@ RSpec.describe BFS::Bucket::SCP, scp: true do
     bucket.close
   end
 
-  it 'should handle absolute and relative paths' do
+  it 'handles absolute and relative paths' do
     abs = BFS::Blob.new("scp://root:root@127.0.0.1:7022/#{SecureRandom.uuid}/file.txt")
     abs.create {|w| w.write 'absolute' }
 
@@ -44,7 +45,7 @@ RSpec.describe BFS::Bucket::SCP, scp: true do
     rel.close
   end
 
-  it 'should support custom perms' do
+  it 'supports custom perms' do
     blob = BFS::Blob.new("scp://root:root@127.0.0.1:7022/#{SecureRandom.uuid}/file.txt")
     blob.create(perm: 0o666) {|w| w.write 'foo' }
     expect(blob.info.mode).to eq(0o666)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bfs-scp
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bfs
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: net-scp
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: SCP/SSH adapter for bfs