train 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eca87a39cc3d6258174e753e4533c05f9508ac24
-  data.tar.gz: 82689ec956034e7e19b96d0f749bced3964c7fa7
+  metadata.gz: b82f61f801217ce81fc40bb5ad6a6e73a19da3de
+  data.tar.gz: 25fb11d1d6930ecda79bb5d2e70030ddddcf976b
 SHA512:
-  metadata.gz: e984b1624f89dee67e5dbf0014db3b3d7f40b3a24a7a68bc1e5bfdb212c080940427ca167df8799f3fa1b54ae7c801791661e8d000e497de853703e5fcb4b01d
-  data.tar.gz: 67639d931b4d15c01ef5feafdc80c2bba5b02b3f78d6ec90d04124cb7e2d195475c17d14d52e3070bf07720b8a3d433b25effa88a3dba03ec5ef901952696301
+  metadata.gz: 1c752a556c55eadeaec19702a6db9ba3110b17b55418f3301a04d919ae899a3e806ed716ce5239515f33efb203e98d6678a8d0bed0f515a8cf0e4cbf22e1dc9f
+  data.tar.gz: 51098591df48b28d34798dbf729c701f903889e55d63f48a38115aeea0a94d2eca48bcc32bba33b398700574f66db6d7f980aa2e50b1b9fda528edba9b96cba6

data/CHANGELOG.md

@@ -1,10 +1,25 @@
 # Change Log
 
-## [0.28.0](https://github.com/chef/train/tree/0.28.0) (2017-09-25)
-[Full Changelog](https://github.com/chef/train/compare/v0.27.0...0.28.0)
+## [0.29.0](https://github.com/chef/train/tree/0.29.0) (2017-11-13)
+[Full Changelog](https://github.com/chef/train/compare/v0.28.0...0.29.0)
 
 **Merged pull requests:**
 
+- Reverting accidental push to master re: \#204 [\#208](https://github.com/chef/train/pull/208) ([adamleff](https://github.com/adamleff))
+- clearer error if no auth methods are available [\#207](https://github.com/chef/train/pull/207) ([thommay](https://github.com/thommay))
+- Build a complete mock OS object [\#206](https://github.com/chef/train/pull/206) ([adamleff](https://github.com/adamleff))
+- Platform framework and detect DSL [\#204](https://github.com/chef/train/pull/204) ([jquick](https://github.com/jquick))
+- add basic qnx support for train [\#203](https://github.com/chef/train/pull/203) ([chris-rock](https://github.com/chris-rock))
+- Add CODEOWNERS for train [\#202](https://github.com/chef/train/pull/202) ([adamleff](https://github.com/adamleff))
+- implement uploads and downloads for ssh and winrm [\#201](https://github.com/chef/train/pull/201) ([thommay](https://github.com/thommay))
+- \[MSYS-649\] Fix InSpec file size in Windows, refactor File classes [\#193](https://github.com/chef/train/pull/193) ([Vasu1105](https://github.com/Vasu1105))
+
+## [v0.28.0](https://github.com/chef/train/tree/v0.28.0) (2017-09-25)
+[Full Changelog](https://github.com/chef/train/compare/v0.27.0...v0.28.0)
+
+**Merged pull requests:**
+
+- Release 0.28.0 [\#200](https://github.com/chef/train/pull/200) ([adamleff](https://github.com/adamleff))
 - Continue to support older net-ssh while fixing 4.2 deprecation [\#199](https://github.com/chef/train/pull/199) ([adamleff](https://github.com/adamleff))
 
 ## [v0.27.0](https://github.com/chef/train/tree/v0.27.0) (2017-09-25)

data/lib/train/extras.rb

@@ -4,11 +4,6 @@
 
 module Train::Extras
   require 'train/extras/command_wrapper'
-  require 'train/extras/file_common'
-  require 'train/extras/file_unix'
-  require 'train/extras/file_aix'
-  require 'train/extras/file_linux'
-  require 'train/extras/file_windows'
   require 'train/extras/os_common'
   require 'train/extras/stat'
 

data/lib/train/extras/os_common.rb

@@ -71,7 +71,7 @@ module Train::Extras
 
     OS['linux'] = %w{linux alpine arch coreos exherbo gentoo slackware fedora amazon} + OS['redhat'] + OS['debian'] + OS['suse']
 
-    OS['unix'] = %w{unix aix hpux} + OS['linux'] + OS['solaris'] + OS['bsd']
+    OS['unix'] = %w{unix aix hpux qnx} + OS['linux'] + OS['solaris'] + OS['bsd']
 
     # Helper methods to check the OS type
     # Provides methods in the form of: linux?, unix?, solaris? ...

data/lib/train/extras/os_detect_unix.rb

@@ -41,6 +41,12 @@ module Train::Extras
         @platform[:name] = uname_s.lines[0].chomp
         @platform[:release] = uname_r.lines[0].chomp
 
+      when /qnx/
+        @platform[:family] = 'qnx'
+        @platform[:name] = uname_s.lines[0].chomp.downcase
+        @platform[:release] = uname_r.lines[0].chomp
+        @platform[:arch] = uname_m
+
       when /sunos/
         detect_solaris
       else

data/lib/train/{extras/file_common.rb → file.rb}

@@ -1,17 +1,39 @@
 # encoding: utf-8
-# author: Dominik Richter
+#
 # author: Christoph Hartmann
+# author: Dominik Richter
 
+require 'train/file/local'
+require 'train/file/local/unix'
+require 'train/file/local/windows'
+require 'train/file/remote'
+require 'train/file/remote/unix'
+require 'train/file/remote/linux'
+require 'train/file/remote/windows'
+require 'train/file/remote/qnx'
 require 'digest/sha2'
 require 'digest/md5'
+require 'train/extras/stat'
+
+module Train
+  class File
+    def initialize(backend, path, follow_symlink = true)
+      @backend = backend
+      @path = path || ''
+      @follow_symlink = follow_symlink
+
+      sanitize_filename(path)
+    end
+
+    # This method gets override by particular os class.
+    def sanitize_filename(_path)
+      nil
+    end
 
-module Train::Extras
-  class FileCommon # rubocop:disable Metrics/ClassLength
     # interface methods: these fields should be implemented by every
     # backend File
     DATA_FIELDS = %w{
       exist? mode owner group uid gid content mtime size selinux_label path
-      product_version file_version
     }.freeze
 
     DATA_FIELDS.each do |m|
@@ -20,12 +42,6 @@ module Train::Extras
       end
     end
 
-    def initialize(backend, path, follow_symlink = true)
-      @backend = backend
-      @path = path || ''
-      @follow_symlink = follow_symlink
-    end
-
     def to_json
       res = Hash[DATA_FIELDS.map { |x| [x, method(x).call] }]
       # additional fields provided as input
@@ -38,9 +54,6 @@ module Train::Extras
       :unknown
     end
 
-    # The following methods can be overwritten by a derived class
-    # if desired, to e.g. achieve optimizations.
-
     def md5sum
       res = Digest::MD5.new
       res.update(content)
@@ -57,36 +70,6 @@ module Train::Extras
       nil
     end
 
-    # Additional methods for convenience
-
-    def file?
-      type.to_s == 'file'
-    end
-
-    def block_device?
-      type.to_s == 'block_device'
-    end
-
-    def character_device?
-      type.to_s == 'character_device'
-    end
-
-    def socket?
-      type.to_s == 'socket'
-    end
-
-    def directory?
-      type.to_s == 'directory'
-    end
-
-    def symlink?
-      source.type.to_s == 'symlink'
-    end
-
-    def source_path
-      @path
-    end
-
     def source
       if @follow_symlink
         self.class.new(@backend, @path, false)
@@ -95,28 +78,22 @@ module Train::Extras
       end
     end
 
-    def pipe?
-      type == :pipe
-    end
-
-    def mode?(sth)
-      mode == sth
-    end
-
-    def owned_by?(sth)
-      owner == sth
-    end
-
-    def grouped_into?(sth)
-      group == sth
+    def source_path
+      @path
     end
 
-    def linked_to?(dst)
-      link_path == dst
+    # product_version is primarily used by Windows operating systems only and will be overwritten
+    # in Windows-related classes. Since this field is returned for all file objects, the acceptable
+    # default value is nil
+    def product_version
+      nil
     end
 
-    def link_path
-      symlink? ? path : nil
+    # file_version is primarily used by Windows operating systems only and will be overwritten
+    # in Windows-related classes. Since this field is returned for all file objects, the acceptable
+    # default value is nil
+    def file_version
+      nil
     end
 
     def version?(version)
@@ -124,48 +101,44 @@ module Train::Extras
         file_version == version
     end
 
-    def unix_mode_mask(owner, type)
-      o = UNIX_MODE_OWNERS[owner.to_sym]
-      return nil if o.nil?
-
-      t = UNIX_MODE_TYPES[type.to_sym]
-      return nil if t.nil?
+    def block_device?
+      type.to_s == 'block_device'
+    end
 
-      t & o
+    def character_device?
+      type.to_s == 'character_device'
     end
 
-    def mounted?
-      !mounted.nil? && !mounted.stdout.nil? && !mounted.stdout.empty?
+    def pipe?
+      type.to_s == 'pipe'
     end
 
-    def basename(suffix = nil, sep = '/')
-      fail 'Not yet supported: Suffix in file.basename' unless suffix.nil?
-      @basename ||= detect_filename(path, sep || '/')
+    def file?
+      type.to_s == 'file'
     end
 
-    # helper methods provided to any implementing class
+    def socket?
+      type.to_s == 'socket'
+    end
 
-    private
+    def directory?
+      type.to_s == 'directory'
+    end
 
-    def detect_filename(path, sep)
-      idx = path.rindex(sep)
-      return path if idx.nil?
-      idx += 1
-      return detect_filename(path[0..-2], sep) if idx == path.length
-      path[idx..-1]
+    def symlink?
+      source.type.to_s == 'symlink'
     end
 
-    UNIX_MODE_OWNERS = {
-      all:   00777,
-      owner: 00700,
-      group: 00070,
-      other: 00007,
-    }.freeze
+    def owned_by?(sth)
+      owner == sth
+    end
 
-    UNIX_MODE_TYPES = {
-      r: 00444,
-      w: 00222,
-      x: 00111,
-    }.freeze
+    def path
+      if symlink? && @follow_symlink
+        link_path
+      else
+        @path
+      end
+    end
   end
 end

data/lib/train/file/local.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+module Train
+  class File
+    class Local < Train::File
+      %w{
+        exist? file? socket? directory? symlink? pipe? size basename
+      }.each do |m|
+        define_method m.to_sym do
+          ::File.method(m.to_sym).call(@path)
+        end
+      end
+
+      def content
+        @content ||= ::File.read(@path, encoding: 'UTF-8')
+      rescue StandardError => _
+        nil
+      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
+
+      def type
+        case ::File.ftype(@path)
+        when 'blockSpecial'
+          :block_device
+        when 'characterSpecial'
+          :character_device
+        when 'link'
+          :symlink
+        when 'fifo'
+          :pipe
+        else
+          ::File.ftype(@path).to_sym
+        end
+      end
+
+      %w{
+        mode owner group uid gid mtime selinux_label
+      }.each do |field|
+        define_method field.to_sym do
+          stat[field.to_sym]
+        end
+      end
+
+      def mode?(sth)
+        mode == sth
+      end
+
+      def linked_to?(dst)
+        link_path == dst
+      end
+    end
+  end
+end

data/lib/train/file/local/unix.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+require 'shellwords'
+require 'train/extras/stat'
+
+module Train
+  class File
+    class Local
+      class Unix < Train::File::Local
+        def sanitize_filename(path)
+          @spath = Shellwords.escape(path) || @path
+        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
+
+        def mounted
+          @mounted ||=
+            @backend.run_command("mount | grep -- ' on #{@spath} '")
+        end
+
+        def mounted?
+          !mounted.nil? && !mounted.stdout.nil? && !mounted.stdout.empty?
+        end
+
+        def grouped_into?(sth)
+          group == sth
+        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
+      end
+    end
+  end
+end

data/lib/train/file/local/windows.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+module Train
+  class File
+    class Local
+      class Windows < Train::File::Local
+        # 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(path)
+          return if path.nil?
+          # we do not filter :, backslash and forward slash, since they are part of the path
+          @spath = path.gsub(/[<>"|?*]/, '')
+        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 owner
+          owner = @backend.run_command(
+            "Get-Acl \"#{@spath}\" | select -expand Owner").stdout.strip
+          return if owner.empty?
+          owner
+        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: type,
+            mode: file_stat.mode,
+            mtime: file_stat.mtime.to_i,
+            size: file_stat.size,
+            owner: owner,
+            uid: file_stat.uid,
+            group: nil,
+            gid: file_stat.gid,
+            selinux_label: nil,
+          }
+
+          @stat
+        end
+      end
+    end
+  end
+end