train 0.29.2 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91f83eccb563ed719ca19fd8be06d9616afc4eae
-  data.tar.gz: 740ba4a80a9b4690b36dec69dd2e752659032033
+  metadata.gz: 0e4971c8f699dbb772e9eb5532fa2de1771de4a5
+  data.tar.gz: 40bf72dd2c53b33379c256b4a4f4acc42dc46efd
 SHA512:
-  metadata.gz: 96eda4528ad55102f10ff705b13a639dec7405f693f67f72d6d8d1b11c35439210ca92ee172d3f18ae564097271de3aa88671f2c8528a8a5b84604dd1ec0344d
-  data.tar.gz: b4260ea407f3cf12614d222d5304a85091830972aade03e10491f1b897f5e01c99e3dc7ff45a7314cdd30e7224d46cd0b460538d34a0454f0601136ff8343db8
+  metadata.gz: 3c5fdd0a5d53e68d3eb928d5e9ddcbcaea5a8c3fa39b57d7aa3a20f7135f4436d78e334e4d93b3ce1e8f2fd2a3310462d10ae4099899372bd4f4fbd6309af4e4
+  data.tar.gz: db6f8f5c82f459a9f78c60cf758aaad8c4877e5adee714add3e060e5328c85a4275ef3502aae0525d80a49b0100b92fea2345f5f493fddf2ecc766954dae9c44

data/CHANGELOG.md

@@ -1,10 +1,34 @@
 # Change Log
 
-## [0.29.1](https://github.com/chef/train/tree/0.29.1) (2017-11-13)
-[Full Changelog](https://github.com/chef/train/compare/v0.29.0...0.29.1)
+## [0.30.0](https://github.com/chef/train/tree/0.30.0) (2017-12-04)
+[Full Changelog](https://github.com/chef/train/compare/v0.29.2...0.30.0)
 
 **Merged pull requests:**
 
+- Change the mock transport name to be 'mock' [\#221](https://github.com/chef/train/pull/221) ([jquick](https://github.com/jquick))
+- Enable caching on connections [\#214](https://github.com/chef/train/pull/214) ([jquick](https://github.com/jquick))
+
+## [v0.29.2](https://github.com/chef/train/tree/v0.29.2) (2017-11-21)
+[Full Changelog](https://github.com/chef/train/compare/v0.29.1...v0.29.2)
+
+**Fixed bugs:**
+
+- Add unix\_mode\_mask method to Train::File::Local::Unix [\#215](https://github.com/chef/train/pull/215) ([adamleff](https://github.com/adamleff))
+
+**Merged pull requests:**
+
+- Fix regressions in 0.29.1 [\#219](https://github.com/chef/train/pull/219) ([adamleff](https://github.com/adamleff))
+- Use the sanitized file path for remote linux files [\#218](https://github.com/chef/train/pull/218) ([RoboticCheese](https://github.com/RoboticCheese))
+- Remove bundler install during Appveyor tests [\#217](https://github.com/chef/train/pull/217) ([adamleff](https://github.com/adamleff))
+- Fix inspec mock tests [\#216](https://github.com/chef/train/pull/216) ([jquick](https://github.com/jquick))
+- Platform framework and detect DSL [\#209](https://github.com/chef/train/pull/209) ([jquick](https://github.com/jquick))
+
+## [v0.29.1](https://github.com/chef/train/tree/v0.29.1) (2017-11-13)
+[Full Changelog](https://github.com/chef/train/compare/v0.29.0...v0.29.1)
+
+**Merged pull requests:**
+
+- Release 0.29.1 [\#213](https://github.com/chef/train/pull/213) ([adamleff](https://github.com/adamleff))
 - Allow for a nil value when mocking OS [\#212](https://github.com/chef/train/pull/212) ([adamleff](https://github.com/adamleff))
 - Ensure a `mounted?` method exists for all File classes, including Mock [\#211](https://github.com/chef/train/pull/211) ([adamleff](https://github.com/adamleff))
 

data/lib/train.rb

@@ -6,6 +6,7 @@ require 'train/version'
 require 'train/options'
 require 'train/plugins'
 require 'train/errors'
+require 'train/platforms'
 require 'uri'
 
 module Train

data/lib/train/errors.rb

@@ -20,4 +20,10 @@ module Train
   # Base exception class for all exceptions that are caused by other failures
   # in the transport layer.
   class TransportError < ::StandardError; end
+
+  # Exception for when no platform can be detected.
+  class PlatformDetectionFailed < ::StandardError; end
+
+  # Exception for when a invalid cache type is passed.
+  class UnknownCacheType < ::StandardError; end
 end

data/lib/train/extras.rb

@@ -4,7 +4,6 @@
 
 module Train::Extras
   require 'train/extras/command_wrapper'
-  require 'train/extras/os_common'
   require 'train/extras/stat'
 
   CommandResult = Struct.new(:stdout, :stderr, :exit_status)

data/lib/train/platforms.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+
+require 'train/platforms/common'
+require 'train/platforms/family'
+require 'train/platforms/platform'
+require 'train/platforms/detect'
+require 'train/platforms/detect/scanner'
+require 'train/platforms/detect/specifications/os'
+
+module Train::Platforms
+  class << self
+    # Retrieve the current platform list
+    #
+    # @return [Hash] map with platform names and their objects
+    def list
+      @list ||= {}
+    end
+
+    # Retrieve the current family list
+    #
+    # @return [Hash] map with family names and their objects
+    def families
+      @families ||= {}
+    end
+  end
+
+  # Create or update a platform
+  #
+  # @return Train::Platform
+  def self.name(name, condition = {})
+    # Check the list to see if one is already created
+    plat = list[name]
+    unless plat.nil?
+      # Pass the condition incase we are adding a family relationship
+      plat.condition = condition unless condition.nil?
+      return plat
+    end
+
+    Train::Platforms::Platform.new(name, condition)
+  end
+
+  # Create or update a family
+  #
+  # @return Train::Platforms::Family
+  def self.family(name, condition = {})
+    # Check the families to see if one is already created
+    family = families[name]
+    unless family.nil?
+      # Pass the condition incase we are adding a family relationship
+      family.condition = condition unless condition.nil?
+      return family
+    end
+
+    Train::Platforms::Family.new(name, condition)
+  end
+
+  # Find the families or top level platforms
+  #
+  # @return [Hash] with top level family and platforms
+  def self.top_platforms
+    top_platforms = list.select { |_key, value| value.families.empty? }
+    top_platforms.merge!(families.select { |_key, value| value.families.empty? })
+    top_platforms
+  end
+
+  # List all platforms and families in a readable output
+  def self.list_all
+    top_platforms = self.top_platforms
+    top_platforms.each_value do |platform|
+      puts platform.title
+      print_children(platform) if defined?(platform.children)
+    end
+  end
+
+  def self.print_children(parent, pad = 2)
+    parent.children.each do |key, value|
+      obj = key
+      puts "#{' ' * pad}-> #{obj.title}#{value unless value.empty?}"
+      print_children(obj, pad + 2) if defined?(obj.children) && !obj.children.nil?
+    end
+  end
+end

data/lib/train/platforms/common.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+module Train::Platforms
+  module Common
+    # Add a family connection. This will create a family
+    # if it does not exist and add a child relationship.
+    def in_family(family)
+      if self.class == Train::Platforms::Family && @name == family
+        fail "Unable to add family #{@name} to itself: '#{@name}.in_family(#{family})'"
+      end
+
+      # add family to the family list
+      family = Train::Platforms.family(family)
+      family.children[self] = @condition
+
+      @families[family] = @condition
+      @condition = nil
+      self
+    end
+
+    def detect(&block)
+      if block_given?
+        @detect = block
+        self
+      elsif @detect.nil?
+        # we are returning a block that just returns false here
+        # to skip the family/platform evaluation if detect is not set
+        ->(_) { false }
+      else
+        @detect
+      end
+    end
+  end
+end

data/lib/train/platforms/detect.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Train::Platforms
+  module Detect
+    # Main detect method to scan all platforms for a match
+    #
+    # @return Train::Platform instance or error if none found
+    def self.scan(backend)
+      Scanner.new(backend).scan
+    end
+  end
+end

data/lib/train/platforms/detect/helpers/os_common.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require 'train/platforms/detect/helpers/os_linux'
+require 'train/platforms/detect/helpers/os_windows'
+require 'rbconfig'
+
+module Train::Platforms::Detect::Helpers
+  module OSCommon
+    include Train::Platforms::Detect::Helpers::Linux
+    include Train::Platforms::Detect::Helpers::Windows
+
+    def ruby_host_os(regex)
+      ::RbConfig::CONFIG['host_os'] =~ regex
+    end
+
+    def winrm?
+      Object.const_defined?('Train::Transports::WinRM::Connection') &&
+        @backend.class == Train::Transports::WinRM::Connection
+    end
+
+    def unix_file_contents(path)
+      # keep a log of files incase multiple checks call the same one
+      return @files[path] if @files.key?(path)
+
+      res = @backend.run_command("test -f #{path} && cat #{path}")
+      # ignore files that can't be read
+      @files[path] = res.exit_status.zero? ? res.stdout : nil
+      @files[path]
+    end
+
+    def unix_file_exist?(path)
+      @backend.run_command("test -f #{path}").exit_status.zero?
+    end
+
+    def command_output(cmd)
+      res = @backend.run_command(cmd).stdout
+      res.strip! unless res.nil?
+      res
+    end
+
+    def unix_uname_s
+      return @uname[:s] if @uname.key?(:s)
+      @uname[:s] = command_output('uname -s')
+    end
+
+    def unix_uname_r
+      return @uname[:r] if @uname.key?(:r)
+      @uname[:r] = command_output('uname -r')
+    end
+
+    def unix_uname_m
+      return @uname[:m] if @uname.key?(:m)
+      @uname[:m] = command_output('uname -m')
+    end
+  end
+end

data/lib/train/platforms/detect/helpers/os_linux.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+module Train::Platforms::Detect::Helpers
+  module Linux
+    def redhatish_platform(conf)
+      conf =~ /^red hat/i ? 'redhat' : /(\w+)/i.match(conf)[1].downcase
+    end
+
+    def redhatish_version(conf)
+      case conf
+      when /rawhide/i
+        /((\d+) \(Rawhide\))/i.match(conf)[1].downcase
+      when /derived from .*linux/i
+        /Linux ((\d+|\.)+)/i.match(conf)[1]
+      else
+        /release ([\d\.]+)/.match(conf)[1]
+      end
+    end
+
+    def linux_os_release
+      data = unix_file_contents('/etc/os-release')
+      return if data.nil?
+
+      os_info = parse_os_release_info(data)
+      cisco_info_file = os_info['CISCO_RELEASE_INFO']
+      if cisco_info_file
+        os_info.merge!(parse_os_release_info(unix_file_contents(cisco_info_file)))
+      end
+
+      os_info
+    end
+
+    def parse_os_release_info(raw)
+      return {} if raw.nil?
+
+      raw.lines.each_with_object({}) do |line, memo|
+        line.strip!
+        next if line.empty?
+        key, value = line.split('=', 2)
+        memo[key] = value.gsub(/\A"|"\Z/, '') unless value.empty?
+      end
+    end
+
+    def lsb_config(content)
+      id = /^DISTRIB_ID=["']?(.+?)["']?$/.match(content)
+      release = /^DISTRIB_RELEASE=["']?(.+?)["']?$/.match(content)
+      codename = /^DISTRIB_CODENAME=["']?(.+?)["']?$/.match(content)
+      {
+        id:       id.nil? ? nil : id[1],
+        release:  release.nil? ? nil : release[1],
+        codename: codename.nil? ? nil : codename[1],
+      }
+    end
+
+    def lsb_release(content)
+      id = /^Distributor ID:\s+(.+)$/.match(content)
+      release = /^Release:\s+(.+)$/.match(content)
+      codename = /^Codename:\s+(.+)$/.match(content)
+      {
+        id:       id.nil? ? nil : id[1],
+        release:  release.nil? ? nil : release[1],
+        codename: codename.nil? ? nil : codename[1],
+      }
+    end
+
+    def read_linux_lsb
+      return @lsb unless @lsb.empty?
+      if !(raw = unix_file_contents('/etc/lsb-release')).nil?
+        @lsb = lsb_config(raw)
+      elsif !(raw = unix_file_contents('/usr/bin/lsb-release')).nil?
+        @lsb = lsb_release(raw)
+      end
+    end
+  end
+end

data/lib/train/{extras/os_detect_windows.rb → platforms/detect/helpers/os_windows.rb}

@@ -1,14 +1,7 @@
 # encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
-#
-# This is heavily based on:
-#
-#   OHAI https://github.com/chef/ohai
-#   by Adam Jacob, Chef Software Inc
-#
-module Train::Extras
-  module DetectWindows
+
+module Train::Platforms::Detect::Helpers
+  module Windows
     def detect_windows
       res = @backend.run_command('cmd /c ver')
       return false if res.exit_status != 0 or res.stdout.empty?

data/lib/train/platforms/detect/scanner.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+
+require 'train/platforms/detect/helpers/os_common'
+
+module Train::Platforms::Detect
+  class Scanner
+    include Train::Platforms::Detect::Helpers::OSCommon
+
+    def initialize(backend)
+      @backend = backend
+      @platform = {}
+      @family_hierarchy = []
+
+      # detect cache variables
+      @files = {}
+      @uname = {}
+      @lsb = {}
+    end
+
+    # Main detect method to scan all platforms for a match
+    #
+    # @return Train::Platform instance or error if none found
+    def scan
+      # start with the platform/families who have no families (the top levels)
+      top = Train::Platforms.top_platforms
+      top.each do |_name, plat|
+        # we are doing a instance_eval here to make sure we have the proper
+        # context with all the detect helper methods
+        next unless instance_eval(&plat.detect) == true
+
+        # if we have a match start looking at the children
+        plat_result = scan_children(plat)
+        next if plat_result.nil?
+
+        # return platform to backend
+        @family_hierarchy << plat.name
+        return get_platform(plat_result)
+      end
+
+      fail Train::PlatformDetectionFailed, 'Sorry, we are unable to detect your platform'
+    end
+
+    def scan_children(parent)
+      parent.children.each do |plat, condition|
+        next unless instance_eval(&plat.detect) == true
+
+        if plat.class == Train::Platforms::Platform
+          @platform[:family] = parent.name
+          return plat if condition.empty? || check_condition(condition)
+        elsif plat.class == Train::Platforms::Family
+          plat = scan_family_children(plat)
+          return plat unless plat.nil?
+        end
+      end
+
+      nil
+    end
+
+    def scan_family_children(plat)
+      child_result = scan_children(plat) unless plat.children.nil?
+      return if child_result.nil?
+      @family_hierarchy << plat.name
+      child_result
+    end
+
+    def check_condition(condition)
+      condition.each do |k, v|
+        op, expected = v.strip.split(' ')
+        op = '==' if op == '='
+        return false if @platform[k].nil? || !instance_eval("'#{@platform[k]}' #{op} '#{expected}'")
+      end
+
+      true
+    end
+
+    def get_platform(plat)
+      plat.backend = @backend
+      plat.platform = @platform
+      plat.add_platform_methods
+      plat.family_hierarchy = @family_hierarchy
+      plat
+    end
+  end
+end