train 0.28.0 → 0.29.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2017-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -151,11 +151,6 @@ files:
 - lib/train/errors.rb
 - lib/train/extras.rb
 - lib/train/extras/command_wrapper.rb
-- lib/train/extras/file_aix.rb
-- lib/train/extras/file_common.rb
-- lib/train/extras/file_linux.rb
-- lib/train/extras/file_unix.rb
-- lib/train/extras/file_windows.rb
 - lib/train/extras/linux_lsb.rb
 - lib/train/extras/os_common.rb
 - lib/train/extras/os_detect_arista_eos.rb
@@ -167,13 +162,22 @@ files:
 - lib/train/extras/os_detect_windows.rb
 - lib/train/extras/stat.rb
 - lib/train/extras/uname.rb
+- lib/train/file.rb
+- lib/train/file/local.rb
+- lib/train/file/local/unix.rb
+- lib/train/file/local/windows.rb
+- lib/train/file/remote.rb
+- lib/train/file/remote/aix.rb
+- lib/train/file/remote/linux.rb
+- lib/train/file/remote/qnx.rb
+- lib/train/file/remote/unix.rb
+- lib/train/file/remote/windows.rb
 - lib/train/options.rb
 - lib/train/plugins.rb
 - lib/train/plugins/base_connection.rb
 - lib/train/plugins/transport.rb
 - lib/train/transports/docker.rb
 - lib/train/transports/local.rb
-- lib/train/transports/local_file.rb
 - lib/train/transports/local_os.rb
 - lib/train/transports/mock.rb
 - lib/train/transports/ssh.rb
@@ -213,19 +217,22 @@ files:
 - test/integration/tests/path_symlink_test.rb
 - test/integration/tests/run_command_test.rb
 - test/unit/extras/command_wrapper_test.rb
-- test/unit/extras/file_common_test.rb
-- test/unit/extras/linux_file_test.rb
 - test/unit/extras/os_common_test.rb
 - test/unit/extras/os_detect_linux_test.rb
 - test/unit/extras/os_detect_windows_test.rb
 - test/unit/extras/stat_test.rb
-- test/unit/extras/windows_file_test.rb
+- test/unit/file/local/unix_test.rb
+- test/unit/file/local/windows_test.rb
+- test/unit/file/local_test.rb
+- test/unit/file/remote/linux_test.rb
+- test/unit/file/remote/unix_test.rb
+- test/unit/file/remote_test.rb
+- test/unit/file_test.rb
 - test/unit/helper.rb
 - test/unit/plugins/connection_test.rb
 - test/unit/plugins/transport_test.rb
 - test/unit/plugins_test.rb
 - test/unit/train_test.rb
-- test/unit/transports/local_file_test.rb
 - test/unit/transports/local_test.rb
 - test/unit/transports/mock_test.rb
 - test/unit/transports/ssh_test.rb
@@ -290,19 +297,22 @@ test_files:
 - test/integration/tests/path_symlink_test.rb
 - test/integration/tests/run_command_test.rb
 - test/unit/extras/command_wrapper_test.rb
-- test/unit/extras/file_common_test.rb
-- test/unit/extras/linux_file_test.rb
 - test/unit/extras/os_common_test.rb
 - test/unit/extras/os_detect_linux_test.rb
 - test/unit/extras/os_detect_windows_test.rb
 - test/unit/extras/stat_test.rb
-- test/unit/extras/windows_file_test.rb
+- test/unit/file/local/unix_test.rb
+- test/unit/file/local/windows_test.rb
+- test/unit/file/local_test.rb
+- test/unit/file/remote/linux_test.rb
+- test/unit/file/remote/unix_test.rb
+- test/unit/file/remote_test.rb
+- test/unit/file_test.rb
 - test/unit/helper.rb
 - test/unit/plugins/connection_test.rb
 - test/unit/plugins/transport_test.rb
 - test/unit/plugins_test.rb
 - test/unit/train_test.rb
-- test/unit/transports/local_file_test.rb
 - test/unit/transports/local_test.rb
 - test/unit/transports/mock_test.rb
 - test/unit/transports/ssh_test.rb

data/lib/train/extras/file_aix.rb

@@ -1,20 +0,0 @@
-# encoding: utf-8
-
-require 'shellwords'
-require 'train/extras/stat'
-
-module Train::Extras
-  class AixFile < UnixFile
-    def link_path
-      return nil unless symlink?
-      @link_path ||=
-        @backend.run_command("perl -e 'print readlink shift' #{@spath}")
-                .stdout.chomp
-    end
-
-    def mounted
-      @mounted ||=
-        @backend.run_command("lsfs -c #{@spath}")
-    end
-  end
-end

data/lib/train/extras/file_linux.rb

@@ -1,16 +0,0 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-module Train::Extras
-  class LinuxFile < UnixFile
-    def content
-      return @content if defined?(@content)
-      @content = @backend.run_command(
-        "cat #{@spath} || echo -n").stdout
-      return @content unless @content.empty?
-      @content = nil if directory? or size.nil? or size > 0
-      @content
-    end
-  end
-end

data/lib/train/extras/file_unix.rb

@@ -1,79 +0,0 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'shellwords'
-require 'train/extras/stat'
-
-module Train::Extras
-  class UnixFile < FileCommon
-    attr_reader :path
-    def initialize(backend, path, follow_symlink = true)
-      super(backend, path, follow_symlink)
-      @spath = Shellwords.escape(@path)
-    end
-
-    def content
-      @content ||= case
-                   when !exist?, directory?
-                     nil
-                   when size.nil?, size == 0
-                     ''
-                   else
-                     @backend.run_command("cat #{@spath}").stdout || ''
-                   end
-    end
-
-    def exist?
-      @exist ||= (
-        f = @follow_symlink ? '' : " || test -L #{@spath}"
-        @backend.run_command("test -e #{@spath}"+f)
-                .exit_status == 0
-      )
-    end
-
-    def path
-      return @path unless @follow_symlink && symlink?
-      @link_path ||= read_target_path
-    end
-
-    def mounted
-      @mounted ||=
-        @backend.run_command("mount | grep -- ' on #{@spath} '")
-    end
-
-    %w{
-      type mode owner group uid gid mtime size selinux_label
-    }.each do |field|
-      define_method field.to_sym do
-        stat[field.to_sym]
-      end
-    end
-
-    def product_version
-      nil
-    end
-
-    def file_version
-      nil
-    end
-
-    def stat
-      return @stat if defined?(@stat)
-      @stat = Train::Extras::Stat.stat(@spath, @backend, @follow_symlink)
-    end
-
-    private
-
-    # Returns full path of a symlink target(real dest) or '' on symlink loop
-    def read_target_path
-      full_path = @backend.run_command("readlink -n #{@spath} -f").stdout
-      # Needed for some OSes like OSX that returns relative path
-      # when the link and target are in the same directory
-      if !full_path.start_with?('/') && full_path != ''
-        full_path = File.expand_path("../#{full_path}", @spath)
-      end
-      full_path
-    end
-  end
-end

data/lib/train/extras/file_windows.rb

@@ -1,100 +0,0 @@
-# encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'shellwords'
-require 'train/extras/stat'
-
-# PS C:\Users\Administrator> Get-Item -Path C:\test.txt | Select-Object -Property BaseName, FullName, IsReadOnly, Exists,
-# LinkType, Mode, VersionInfo, Owner, Archive, Hidden, ReadOnly, System |  ConvertTo-Json
-
-module Train::Extras
-  class WindowsFile < FileCommon
-    attr_reader :path
-    def initialize(backend, path, follow_symlink = false)
-      super(backend, path, follow_symlink)
-      @spath = sanitize_filename(@path)
-    end
-
-    def basename(suffix = nil, sep = '\\')
-      super(suffix, sep)
-    end
-
-    # Ensures we do not use invalid characters for file names
-    # @see https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx#naming_conventions
-    def sanitize_filename(filename)
-      return if filename.nil?
-      # we do not filter :, backslash and forward slash, since they are part of the path
-      filename.gsub(/[<>"|?*]/, '')
-    end
-
-    def content
-      return @content if defined?(@content)
-      @content = @backend.run_command(
-        "Get-Content(\"#{@spath}\") | Out-String").stdout
-      return @content unless @content.empty?
-      @content = nil if directory? # or size.nil? or size > 0
-      @content
-    end
-
-    def exist?
-      return @exist if defined?(@exist)
-      @exist = @backend.run_command(
-        "(Test-Path -Path \"#{@spath}\").ToString()").stdout.chomp == 'True'
-    end
-
-    def link_path
-      nil
-    end
-
-    def mounted
-      nil
-    end
-
-    def owner
-      owner = @backend.run_command(
-        "Get-Acl '#{@spath}' | select -expand Owner").stdout.strip
-      return if owner.empty?
-      owner
-    end
-
-    def type
-      if attributes.include?('Archive')
-        return :file
-      elsif attributes.include?('Directory')
-        return :directory
-      end
-      :unknown
-    end
-
-    %w{
-      mode group uid gid mtime size selinux_label
-    }.each do |field|
-      define_method field.to_sym do
-        nil
-      end
-    end
-
-    def product_version
-      @product_version ||= @backend.run_command(
-        "[System.Diagnostics.FileVersionInfo]::GetVersionInfo(\"#{@spath}\").ProductVersion").stdout.chomp
-    end
-
-    def file_version
-      @file_version ||= @backend.run_command(
-        "[System.Diagnostics.FileVersionInfo]::GetVersionInfo(\"#{@spath}\").FileVersion").stdout.chomp
-    end
-
-    def stat
-      nil
-    end
-
-    private
-
-    def attributes
-      return @attributes if defined?(@attributes)
-      @attributes = @backend.run_command(
-        "(Get-ItemProperty -Path \"#{@spath}\").attributes.ToString()").stdout.chomp.split(/\s*,\s*/)
-    end
-  end
-end

data/lib/train/transports/local_file.rb

@@ -1,98 +0,0 @@
-# encoding: utf-8
-#
-# author: Dominik Richter
-# author: Christoph Hartmann
-
-require 'train/extras'
-
-class Train::Transports::Local::Connection
-  class File < Train::Extras::LinuxFile
-    def content
-      @content ||= ::File.read(@path, encoding: 'UTF-8')
-    rescue StandardError => _
-      nil
-    end
-
-    %w{
-      exist? file? socket? directory? symlink? pipe?
-    }.each do |m|
-      define_method m.to_sym do
-        ::File.method(m.to_sym).call(@path)
-      end
-    end
-
-    def path
-      if symlink? && @follow_symlink
-        link_path
-      else
-        @path
-      end
-    end
-
-    def link_path
-      return nil unless symlink?
-      begin
-        @link_path ||= ::File.realpath(@path)
-      rescue Errno::ELOOP => _
-        # Leave it blank on symbolic loop, same as readlink
-        @link_path = ''
-      end
-    end
-
-    def block_device?
-      ::File.blockdev?(@path)
-    end
-
-    def character_device?
-      ::File.chardev?(@path)
-    end
-
-    private
-
-    def pw_username(uid)
-      Etc.getpwuid(uid).name
-    rescue ArgumentError => _
-      nil
-    end
-
-    def pw_groupname(gid)
-      Etc.getgrgid(gid).name
-    rescue ArgumentError => _
-      nil
-    end
-
-    def stat
-      return @stat if defined? @stat
-
-      begin
-        file_stat =
-          if @follow_symlink
-            ::File.stat(@path)
-          else
-            ::File.lstat(@path)
-          end
-      rescue StandardError => _err
-        return @stat = {}
-      end
-
-      @stat = {
-        type: Train::Extras::Stat.find_type(file_stat.mode),
-        mode: file_stat.mode & 07777,
-        mtime: file_stat.mtime.to_i,
-        size: file_stat.size,
-        owner: pw_username(file_stat.uid),
-        uid: file_stat.uid,
-        group: pw_groupname(file_stat.gid),
-        gid: file_stat.gid,
-      }
-
-      lstat = @follow_symlink ? ' -L' : ''
-      res = @backend.run_command("stat#{lstat} #{@spath} 2>/dev/null --printf '%C'")
-      if res.exit_status == 0 && !res.stdout.empty? && res.stdout != '?'
-        @stat[:selinux_label] = res.stdout.strip
-      end
-
-      @stat
-    end
-  end
-end

data/test/unit/extras/file_common_test.rb

@@ -1,180 +0,0 @@
-# encoding: utf-8
-require 'helper'
-require 'securerandom'
-require 'train/extras/file_common'
-
-describe 'file common' do
-  let(:cls) { Train::Extras::FileCommon }
-  let(:new_cls) { cls.new(nil, nil, false) }
-
-  def mockup(stubs)
-    Class.new(cls) do
-      stubs.each do |k,v|
-        define_method k.to_sym do
-          v
-        end
-      end
-    end.new(nil, nil, false)
-  end
-
-  it 'has the default type of unknown' do
-    new_cls.type.must_equal :unknown
-  end
-
-  it 'calculates md5sum from content' do
-    content = 'hello world'
-    new_cls.stub :content, content do |i|
-      i.md5sum.must_equal '5eb63bbbe01eeed093cb22bb8f5acdc3'
-    end
-  end
-
-  it 'sets md5sum of nil content to nil' do
-    new_cls.stub :content, nil do |i|
-      i.md5sum.must_be_nil
-    end
-  end
-
-  it 'calculates md5sum from content' do
-    content = 'hello world'
-    new_cls.stub :content, content do |i|
-      i.sha256sum.must_equal 'b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9'
-    end
-  end
-
-  it 'sets sha256sum of nil content to nil' do
-    new_cls.stub :content, nil do |i|
-      i.sha256sum.must_be_nil
-    end
-  end
-
-  describe 'type' do
-    it 'recognized type == file' do
-      fc = mockup(type: :file)
-      fc.file?.must_equal true
-    end
-
-    it 'recognized type == block_device' do
-      fc = mockup(type: :block_device)
-      fc.block_device?.must_equal true
-    end
-
-    it 'recognized type == character_device' do
-      fc = mockup(type: :character_device)
-      fc.character_device?.must_equal true
-    end
-
-    it 'recognized type == socket' do
-      fc = mockup(type: :socket)
-      fc.socket?.must_equal true
-    end
-
-    it 'recognized type == directory' do
-      fc = mockup(type: :directory)
-      fc.directory?.must_equal true
-    end
-
-    it 'recognized type == pipe' do
-      fc = mockup(type: :pipe)
-      fc.pipe?.must_equal true
-    end
-
-    it 'recognized type == symlink' do
-      fc = mockup(type: :symlink)
-      fc.symlink?.must_equal true
-    end
-  end
-
-  describe 'version' do
-    it 'recognized wrong version' do
-      fc = mockup(product_version: rand, file_version: rand)
-      fc.version?(rand).must_equal false
-    end
-
-    it 'recognized product_version' do
-      x = rand
-      fc = mockup(product_version: x, file_version: rand)
-      fc.version?(x).must_equal true
-    end
-
-    it 'recognized file_version' do
-      x = rand
-      fc = mockup(product_version: rand, file_version: x)
-      fc.version?(x).must_equal true
-    end
-  end
-
-  describe 'unix_mode_mask' do
-
-    let(:fc) { mockup(type: :file) }
-
-    it 'check owner mode calculation' do
-      fc.unix_mode_mask('owner', 'x').must_equal 0100
-      fc.unix_mode_mask('owner', 'w').must_equal 0200
-      fc.unix_mode_mask('owner', 'r').must_equal 0400
-    end
-
-    it 'check group mode calculation' do
-      fc.unix_mode_mask('group', 'x').must_equal 0010
-      fc.unix_mode_mask('group', 'w').must_equal 0020
-      fc.unix_mode_mask('group', 'r').must_equal 0040
-    end
-
-    it 'check other mode calculation' do
-      fc.unix_mode_mask('other', 'x').must_equal 0001
-      fc.unix_mode_mask('other', 'w').must_equal 0002
-      fc.unix_mode_mask('other', 'r').must_equal 0004
-    end
-
-    it 'check all mode calculation' do
-      fc.unix_mode_mask('all', 'x').must_equal 0111
-      fc.unix_mode_mask('all', 'w').must_equal 0222
-      fc.unix_mode_mask('all', 'r').must_equal 0444
-    end
-  end
-
-  describe 'basename helper' do
-    def fc(path)
-      mockup(type: :file, path: path)
-    end
-
-    it 'works with an empty path' do
-      fc('').basename.must_equal ''
-    end
-
-    it 'separates a simple path (defaults to unix mode)' do
-      fc('/dir/file').basename.must_equal 'file'
-    end
-
-    it 'separates a simple path (Unix mode)' do
-      fc('/dir/file').basename(nil, '/').must_equal 'file'
-    end
-
-    it 'separates a simple path (Windows mode)' do
-      fc('C:\dir\file').basename(nil, '\\').must_equal 'file'
-    end
-
-    it 'identifies a folder name (Unix mode)' do
-      fc('/dir/file/').basename(nil, '/').must_equal 'file'
-    end
-
-    it 'identifies a folder name (Windows mode)' do
-      fc('C:\dir\file\\').basename(nil, '\\').must_equal 'file'
-    end
-
-    it 'ignores tailing separators (Unix mode)' do
-      fc('/dir/file///').basename(nil, '/').must_equal 'file'
-    end
-
-    it 'ignores tailing separators (Windows mode)' do
-      fc('C:\dir\file\\\\\\').basename(nil, '\\').must_equal 'file'
-    end
-
-    it 'doesnt work with backward slashes (Unix mode)' do
-      fc('C:\dir\file').basename(nil, '/').must_equal 'C:\\dir\file'
-    end
-
-    it 'doesnt work with forward slashes (Windows mode)' do
-      fc('/dir/file').basename(nil, '\\').must_equal '/dir/file'
-    end
-  end
-end