train 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '008089b91adad72506c6825bad3e8b4c6837af27'
-  data.tar.gz: 7d584e084f13afe3ef7a915cbc7a19ee20597be3
+  metadata.gz: f52a89e11554a1520fed7d09db564885c954e88d
+  data.tar.gz: ca15551ae18c8a60cdf9c4f246170ddb5f04b123
 SHA512:
-  metadata.gz: 67d87897890642480be62a48e8bc7571ebf0769f3561d85931bd524317c1503c0c4e4ff4e26b3a1d72e717a4f02c5f660956f741b0663046697d0549b3dd059d
-  data.tar.gz: 8c6f4246840527633d22c5aee4947cc17349cf77a8a2f742db541d11f9a371aee4f41825428ee2e163f277aabaae62ce75a5cef8abc406220da0f6b9d01934bf
+  metadata.gz: c723c108b4a86e02d646f7389c2ea075a6c86d83aaaf87c845da1356b84eeeaf9b209f3cebbf959655e812db0dbbcb08929170f9539576cd1326fae7adc4751c
+  data.tar.gz: 8596b9929258af323373aae7a6d34bb1f341d3ab9aa28d92bd7739b62e325a56832833ea063f81619fb6a2d752ba4736c42741547b0f51bd8f49f4a53ce98bea

data/.rubocop.yml

@@ -71,3 +71,5 @@ Style/IfUnlessModifier:
   Enabled: false
 Style/FrozenStringLiteralComment:
   Enabled: false
+SignalException:
+  Enabled: false

data/CHANGELOG.md

@@ -1,7 +1,20 @@
 # Change Log
 
-## [1.0.0](https://github.com/chef/train/tree/1.0.0) (2018-02-01)
-[Full Changelog](https://github.com/chef/train/compare/v0.32.0...1.0.0)
+## [1.1.0](https://github.com/chef/train/tree/1.1.0) (2018-02-08)
+[Full Changelog](https://github.com/chef/train/compare/v1.0.0...1.1.0)
+
+**Closed issues:**
+
+- Add azure:// target [\#233](https://github.com/chef/train/issues/233)
+
+**Merged pull requests:**
+
+- Add qnx platform support [\#253](https://github.com/chef/train/pull/253) ([jquick](https://github.com/jquick))
+- Add azure transport [\#250](https://github.com/chef/train/pull/250) ([jquick](https://github.com/jquick))
+- Fix AIX and QNX file support [\#249](https://github.com/chef/train/pull/249) ([adamleff](https://github.com/adamleff))
+
+## [v1.0.0](https://github.com/chef/train/tree/v1.0.0) (2018-02-01)
+[Full Changelog](https://github.com/chef/train/compare/v0.32.0...v1.0.0)
 
 **Closed issues:**
 
@@ -9,6 +22,7 @@
 
 **Merged pull requests:**
 
+- Update version to 1.0.0 [\#248](https://github.com/chef/train/pull/248) ([jquick](https://github.com/jquick))
 - cisco nexus + ios12 [\#247](https://github.com/chef/train/pull/247) ([arlimus](https://github.com/arlimus))
 - Add a CONTRIBUTING.md to Train [\#245](https://github.com/chef/train/pull/245) ([miah](https://github.com/miah))
 - catch detect failing to parse json [\#243](https://github.com/chef/train/pull/243) ([arlimus](https://github.com/arlimus))

data/Gemfile

@@ -19,7 +19,7 @@ group :test do
   gem 'rake', '~> 10'
   gem 'rubocop', '~> 0.36.0'
   gem 'simplecov', '~> 0.10'
-  gem 'concurrent-ruby', '~> 0.9'
+  gem 'concurrent-ruby', '~> 1.0'
 end
 
 group :integration do

data/README.md

@@ -21,6 +21,7 @@ Train supports:
 * Docker
 * Mock (for testing and debugging)
 * AWS as an API
+* Azure as an API
 
 # Examples
 

data/lib/train/file.rb

@@ -4,13 +4,7 @@
 # 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'

data/lib/train/file/local.rb

@@ -68,3 +68,8 @@ module Train
     end
   end
 end
+
+# subclass requires are loaded after Train::File::Local is defined
+# to avoid superclass mismatch errors
+require 'train/file/local/unix'
+require 'train/file/local/windows'

data/lib/train/file/remote.rb

@@ -26,3 +26,11 @@ module Train
     end
   end
 end
+
+# subclass requires are loaded after Train::File::Remote is defined
+# to avoid superclass mismatch errors
+require 'train/file/remote/aix'
+require 'train/file/remote/linux'
+require 'train/file/remote/qnx'
+require 'train/file/remote/unix'
+require 'train/file/remote/windows'

data/lib/train/file/remote/qnx.rb

@@ -8,7 +8,7 @@ require 'train/file/remote/unix'
 module Train
   class File
     class Remote
-      class Aix < Train::File::Remote::Unix
+      class Qnx < Train::File::Remote::Unix
         def content
           cat = 'cat'
           cat = '/proc/boot/cat' if @backend.os[:release].to_i >= 7
@@ -32,7 +32,7 @@ module Train
           mode owner group uid gid mtime size selinux_label link_path mounted stat
         }.each do |field|
           define_method field.to_sym do
-            fail NotImplementedError, "QNX does not implement the #{m}() method yet."
+            fail NotImplementedError, "QNX does not implement the #{field}() method yet."
           end
         end
       end

data/lib/train/platforms/detect/specifications/api.rb

@@ -6,8 +6,10 @@ module Train::Platforms::Detect::Specifications
       plat = Train::Platforms
 
       plat.family('api')
+
       plat.family('cloud').in_family('api')
       plat.name('aws').in_family('cloud')
+      plat.name('azure').in_family('cloud')
     end
   end
 end

data/lib/train/platforms/detect/specifications/os.rb

@@ -453,6 +453,19 @@ module Train::Platforms::Detect::Specifications
             true
           }
 
+      # qnx
+      plat.family('qnx').in_family('unix')
+          .detect {
+            true if unix_uname_s =~ /qnx/i
+          }
+      plat.name('qnx').title('QNX').in_family('qnx')
+          .detect {
+            @platform[:name] = unix_uname_s.lines[0].chomp.downcase
+            @platform[:release] = unix_uname_r.lines[0].chomp
+            @platform[:arch] = unix_uname_m
+            true
+          }
+
       # bsd family
       plat.family('bsd').in_family('unix')
           .detect {

data/lib/train/transports/azure.rb

@@ -0,0 +1,153 @@
+# encoding: utf-8
+
+require 'train/plugins'
+require 'ms_rest_azure'
+require 'azure_mgmt_resources'
+require 'inifile'
+
+module Train::Transports
+  class Azure < Train.plugin(1)
+    name 'azure'
+    option :tenant_id, default: ENV['AZURE_TENANT_ID']
+    option :client_id, default: ENV['AZURE_CLIENT_ID']
+    option :client_secret, default: ENV['AZURE_CLIENT_SECRET']
+    option :subscription_id, default: ENV['AZURE_SUBSCRIPTION_ID']
+
+    # This can provide the client id and secret
+    option :credentials_file, default: ENV['AZURE_CRED_FILE']
+
+    def connection(_ = nil)
+      @connection ||= Connection.new(@options)
+    end
+
+    class Connection < BaseConnection
+      def initialize(options)
+        @apis = {}
+
+        # Override for any cli options
+        # azure://subscription_id
+        options[:subscription_id] = options[:host] || options[:subscription_id]
+        super(options)
+
+        @cache_enabled[:api_call] = true
+        @cache[:api_call] = {}
+
+        if @options[:client_secret].nil? && @options[:client_id].nil?
+          parse_credentials_file
+        end
+        connect
+      end
+
+      def platform
+        direct_platform('azure')
+      end
+
+      def azure_client(klass = ::Azure::Resources::Profiles::Latest::Mgmt::Client)
+        return klass.new(@credentials) unless cache_enabled?(:api_call)
+
+        @cache[:api_call][klass.to_s.to_sym] ||= klass.new(@credentials)
+      end
+
+      def connect
+        provider = ::MsRestAzure::ApplicationTokenProvider.new(
+          @options[:tenant_id],
+          @options[:client_id],
+          @options[:client_secret],
+        )
+
+        @credentials = {
+          credentials: ::MsRest::TokenCredentials.new(provider),
+          subscription_id: @options[:subscription_id],
+          tenant_id: @options[:tenant_id],
+          client_id: @options[:client_id],
+          client_secret: @options[:client_secret],
+        }
+      end
+
+      def uri
+        "azure://#{@options[:subscription_id]}"
+      end
+
+      # Returns the api version for the specified resource type
+      #
+      # If an api version has been specified in the options then the apis version table is updated
+      # with that value and it is returned
+      #
+      # However if it is not specified, or multiple types are being interrogated then this method
+      # will interrogate Azure for each of the types versions and pick the latest one. This is added
+      # to the apis table so that it can be retrieved quickly again of another one of those resources
+      # is encountered again in the resource collection.
+      #
+      # @param string resource_type The resource type for which the API is required
+      # @param hash options Options have that have been passed to the resource during the test.
+      # @option opts [String] :group_name Resource group name
+      # @option opts [String] :type Azure resource type
+      # @option opts [String] :name Name of specific resource to look for
+      # @option opts [String] :apiversion If looking for a specific item or type specify the api version to use
+      #
+      # @return string API Version of the specified resource type
+      def get_api_version(resource_type, options)
+        # if an api version has been set in the options, add to the apis hashtable with
+        # the resource type
+        if options[:apiversion]
+          @apis[resource_type] = options[:apiversion]
+        else
+          # only attempt to get the api version from Azure if the resource type
+          # is not present in the apis hashtable
+          unless @apis.key?(resource_type)
+
+            # determine the namespace for the resource type
+            namespace, type = resource_type.split(%r{/})
+
+            client = azure_client(::Azure::Resources::Profiles::Latest::Mgmt::Client)
+            provider = client.providers.get(namespace)
+
+            # get the latest API version for the type
+            # assuming that this is the first one in the list
+            api_versions = (provider.resource_types.find { |v| v.resource_type == type }).api_versions
+            @apis[resource_type] = api_versions[0]
+          end
+        end
+
+        # return the api version for the type
+        @apis[resource_type]
+      end
+
+      private
+
+      def parse_credentials_file # rubocop:disable Metrics/AbcSize
+        # If an AZURE_CRED_FILE environment variable has been specified set the
+        # the credentials file to that, otherwise set the one in home
+        azure_creds_file = @options[:credentials_file]
+        azure_creds_file = File.join(Dir.home, '.azure', 'credentials') if azure_creds_file.nil?
+        return unless File.readable?(azure_creds_file)
+
+        credentials = IniFile.load(File.expand_path(azure_creds_file))
+        if @options[:subscription_id]
+          id = @options[:subscription_id]
+        elsif !ENV['AZURE_SUBSCRIPTION_NUMBER'].nil?
+          subscription_number = ENV['AZURE_SUBSCRIPTION_NUMBER'].to_i
+
+          # Check that the specified index is not greater than the number of subscriptions
+          if subscription_number > credentials.sections.length
+            raise format(
+              'Your credentials file only contains %s subscriptions.  You specified number %s.',
+              @credentials.sections.length,
+              subscription_number,
+            )
+          end
+          id = credentials.sections[subscription_number - 1]
+        else
+          raise 'Multiple credentials detected, please set the AZURE_SUBSCRIPTION_ID environment variable.' if credentials.sections.count > 1
+          id = credentials.sections[0]
+        end
+
+        raise "No credentials found for subscription number #{id}" if credentials.sections.empty? || credentials[id].empty?
+        @options[:subscription_id] = id
+        @options[:tenant_id] = credentials[id]['tenant_id']
+        @options[:client_id] = credentials[id]['client_id']
+        @options[:client_secret] = credentials[id]['client_secret']
+      end
+    end
+  end
+end

data/lib/train/version.rb

@@ -3,5 +3,5 @@
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 
 module Train
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/test/unit/file/remote/aix_test.rb

@@ -0,0 +1,26 @@
+require 'helper'
+require 'train/transports/local'
+require 'train/file/remote/aix'
+require 'train/transports/mock'
+
+describe Train::File::Remote::Aix do
+  let(:cls) { Train::File::Remote::Aix }
+  let(:backend) {
+    backend = Train::Transports::Mock.new.connection
+    backend.mock_os({ name: 'aix', family: 'unix' })
+    backend
+  }
+
+  it 'returns a nil link_path if the object is not a symlink' do
+    file = cls.new(backend, 'path')
+    file.stubs(:symlink?).returns(false)
+    file.link_path.must_be_nil
+  end
+
+  it 'returns a correct link_path' do
+    file = cls.new(backend, 'path')
+    file.stubs(:symlink?).returns(true)
+    backend.mock_command("perl -e 'print readlink shift' path", 'our_link_path')
+    file.link_path.must_equal 'our_link_path'
+  end
+end

data/test/unit/file/remote/qnx_test.rb

@@ -0,0 +1,44 @@
+require 'helper'
+require 'train/transports/local'
+require 'train/file/remote/qnx'
+require 'train/transports/mock'
+
+describe Train::File::Remote::Qnx do
+  let(:cls) { Train::File::Remote::Qnx }
+  let(:backend) {
+    backend = Train::Transports::Mock.new.connection
+    backend.mock_os({ name: 'qnx', family: 'unix' })
+    backend
+  }
+
+  it 'returns file contents when the file exists' do
+    out = rand.to_s
+    backend.mock_command('cat path', out)
+    file = cls.new(backend, 'path')
+    file.stubs(:exist?).returns(true)
+    file.content.must_equal out
+  end
+
+  it 'returns nil contents when the file does not exist' do
+    file = cls.new(backend, 'path')
+    file.stubs(:exist?).returns(false)
+    file.content.must_be_nil
+  end
+
+  it 'returns a file type' do
+    backend.mock_command('file path', 'blah directory blah')
+    cls.new(backend, 'path').type.must_equal :directory
+  end
+
+  it 'returns a directory type' do
+    backend.mock_command('file path', 'blah regular file blah')
+    cls.new(backend, 'path').type.must_equal :file
+  end
+
+  it 'raises exception for unimplemented methods' do
+    file = cls.new(backend, 'path')
+    %w{mode owner group uid gid mtime size selinux_label link_path mounted stat}.each do |m|
+      proc { file.send(m) }.must_raise NotImplementedError
+    end
+  end
+end

data/test/unit/platforms/os_detect_test.rb

@@ -183,6 +183,16 @@ describe 'os_detect' do
     end
   end
 
+  describe 'qnx' do
+    it 'sets the correct info for qnx platform' do
+      platform = scan_with_files('qnx', {})
+
+      platform[:name].must_equal('qnx')
+      platform[:family].must_equal('qnx')
+      platform[:release].must_equal('test-release')
+    end
+  end
+
   describe 'cisco' do
     it 'recognizes Cisco IOS12' do
       mock = Train::Transports::Mock::Connection.new

data/test/unit/transports/azure_test.rb

@@ -0,0 +1,148 @@
+# encoding: utf-8
+
+require 'helper'
+
+describe 'azure transport' do
+  def transport(options = nil)
+    ENV['AZURE_TENANT_ID'] = 'test_tenant_id'
+    ENV['AZURE_CLIENT_ID'] = 'test_client_id'
+    ENV['AZURE_CLIENT_SECRET'] = 'test_client_secret'
+    ENV['AZURE_SUBSCRIPTION_ID'] = 'test_subscription_id'
+
+    # need to require this at here as it captures the envs on load
+    require 'train/transports/azure'
+    Train::Transports::Azure.new(options)
+  end
+  let(:connection) { transport.connection }
+  let(:options) { connection.instance_variable_get(:@options) }
+  let(:cache) { connection.instance_variable_get(:@cache) }
+  let(:credentials) { connection.instance_variable_get(:@credentials) }
+
+  describe 'options' do
+    it 'defaults to env options' do
+      options[:tenant_id].must_equal 'test_tenant_id'
+      options[:client_id].must_equal 'test_client_id'
+      options[:client_secret].must_equal 'test_client_secret'
+      options[:subscription_id].must_equal 'test_subscription_id'
+    end
+
+    it 'allows for options override' do
+      transport = transport(subscription_id: '102', client_id: '717')
+      options = transport.connection.instance_variable_get(:@options)
+      options[:tenant_id].must_equal 'test_tenant_id'
+      options[:client_id].must_equal '717'
+      options[:client_secret].must_equal 'test_client_secret'
+      options[:subscription_id].must_equal '102'
+    end
+
+    it 'allows uri parse override' do
+      transport = transport(host: '999')
+      options = transport.connection.instance_variable_get(:@options)
+      options[:tenant_id].must_equal 'test_tenant_id'
+      options[:subscription_id].must_equal '999'
+    end
+  end
+
+  describe 'platform' do
+    it 'returns platform' do
+      plat = connection.platform
+      plat.name.must_equal 'azure'
+      plat.family_hierarchy.must_equal ['cloud', 'api']
+    end
+  end
+
+  describe 'azure_client' do
+    class AzureResource
+      attr_reader :hash
+      def initialize(hash)
+        @hash = hash
+      end
+    end
+
+    it 'can use azure_client with caching' do
+      connection.instance_variable_set(:@credentials, {})
+      client = connection.azure_client(AzureResource)
+      client.is_a?(AzureResource).must_equal true
+      cache[:api_call].count.must_equal 1
+    end
+
+    it 'can use azure_client without caching' do
+      connection.instance_variable_set(:@credentials, {})
+      connection.disable_cache(:api_call)
+      client = connection.azure_client(AzureResource)
+      client.is_a?(AzureResource).must_equal true
+      cache[:api_call].count.must_equal 0
+    end
+
+    it 'can use azure_client default client' do
+      client = connection.azure_client
+      client.class.must_equal Azure::Resources::Profiles::Latest::Mgmt::Client
+    end
+  end
+
+  describe 'connect' do
+    it 'validate credentials' do
+      connection.connect
+      credentials[:credentials].class.must_equal MsRest::TokenCredentials
+      credentials[:tenant_id].must_equal 'test_tenant_id'
+      credentials[:client_id].must_equal 'test_client_id'
+      credentials[:client_secret].must_equal 'test_client_secret'
+      credentials[:subscription_id].must_equal 'test_subscription_id'
+    end
+  end
+
+  describe 'parse_credentials_file' do
+    let(:cred_file) do
+      require 'tempfile'
+      file = Tempfile.new('cred_file')
+      info = <<-INFO
+        [my_subscription_id]
+        client_id = "my_client_id"
+        client_secret = "my_client_secret"
+        tenant_id = "my_tenant_id"
+
+        [my_subscription_id2]
+        client_id = "my_client_id2"
+        client_secret = "my_client_secret2"
+        tenant_id = "my_tenant_id2"
+      INFO
+      file.write(info)
+      file.close
+      file
+    end
+
+    it 'validate credentials from file' do
+      options[:credentials_file] = cred_file.path
+      options[:subscription_id] = 'my_subscription_id'
+      connection.send(:parse_credentials_file)
+
+      options[:tenant_id].must_equal 'my_tenant_id'
+      options[:client_id].must_equal 'my_client_id'
+      options[:client_secret].must_equal 'my_client_secret'
+      options[:subscription_id].must_equal 'my_subscription_id'
+    end
+
+    it 'validate credentials from file subscription override' do
+      options[:credentials_file] = cred_file.path
+      options[:subscription_id] = 'my_subscription_id2'
+      connection.send(:parse_credentials_file)
+
+      options[:tenant_id].must_equal 'my_tenant_id2'
+      options[:client_id].must_equal 'my_client_id2'
+      options[:client_secret].must_equal 'my_client_secret2'
+      options[:subscription_id].must_equal 'my_subscription_id2'
+    end
+
+    it 'validate credentials from file subscription index' do
+      options[:credentials_file] = cred_file.path
+      options[:subscription_id] = nil
+      ENV['AZURE_SUBSCRIPTION_NUMBER'] = '2'
+      connection.send(:parse_credentials_file)
+
+      options[:tenant_id].must_equal 'my_tenant_id2'
+      options[:client_id].must_equal 'my_client_id2'
+      options[:client_secret].must_equal 'my_client_secret2'
+      options[:subscription_id].must_equal 'my_subscription_id2'
+    end
+  end
+end

data/train.gemspec

@@ -34,6 +34,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'winrm-fs', '~> 1.0'
   spec.add_dependency 'docker-api', '~> 1.26'
   spec.add_dependency 'aws-sdk', '~> 2'
+  spec.add_dependency 'azure_mgmt_resources', '~> 0.15'
+  spec.add_dependency 'inifile'
 
   spec.add_development_dependency 'mocha', '~> 1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-01 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -134,6 +134,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: azure_mgmt_resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +220,7 @@ files:
 - lib/train/plugins/base_connection.rb
 - lib/train/plugins/transport.rb
 - lib/train/transports/aws.rb
+- lib/train/transports/azure.rb
 - lib/train/transports/docker.rb
 - lib/train/transports/local.rb
 - lib/train/transports/mock.rb
@@ -236,7 +265,9 @@ files:
 - test/unit/file/local/unix_test.rb
 - test/unit/file/local/windows_test.rb
 - test/unit/file/local_test.rb
+- test/unit/file/remote/aix_test.rb
 - test/unit/file/remote/linux_test.rb
+- test/unit/file/remote/qnx_test.rb
 - test/unit/file/remote/unix_test.rb
 - test/unit/file/remote_test.rb
 - test/unit/file_test.rb
@@ -254,6 +285,7 @@ files:
 - test/unit/plugins_test.rb
 - test/unit/train_test.rb
 - test/unit/transports/aws_test.rb
+- test/unit/transports/azure_test.rb
 - test/unit/transports/local_test.rb
 - test/unit/transports/mock_test.rb
 - test/unit/transports/ssh_test.rb
@@ -322,7 +354,9 @@ test_files:
 - test/unit/file/local/unix_test.rb
 - test/unit/file/local/windows_test.rb
 - test/unit/file/local_test.rb
+- test/unit/file/remote/aix_test.rb
 - test/unit/file/remote/linux_test.rb
+- test/unit/file/remote/qnx_test.rb
 - test/unit/file/remote/unix_test.rb
 - test/unit/file/remote_test.rb
 - test/unit/file_test.rb
@@ -340,6 +374,7 @@ test_files:
 - test/unit/plugins_test.rb
 - test/unit/train_test.rb
 - test/unit/transports/aws_test.rb
+- test/unit/transports/azure_test.rb
 - test/unit/transports/local_test.rb
 - test/unit/transports/mock_test.rb
 - test/unit/transports/ssh_test.rb