train 1.4.4 → 1.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bd7445d39832ea8fdd1ccba4a089153a6352229246b6c7ed8251eb44afd099f
-  data.tar.gz: e813525dbb9a25e7cf7138d30c704503acd06d96e895c238b0d4453b6fc6323f
+  metadata.gz: cecb9bec9682f0acc90154bcdc16a17fbe7c146b30b3be37bbadd774176d7065
+  data.tar.gz: fa01c4fde81ed2a58584576a07cb68ad52b3e73926521e6329486352c4dfa14c
 SHA512:
-  metadata.gz: d38b05424dbd5431aa31f5a921d724f1e07247d5601a85a61b503a0c73a2194f3694aaddffe39fac89e375825a8f44ed839bd76c0a3e7353f90a593026c97398
-  data.tar.gz: 814a6345a5f4d3eecc7e9d26d4050831598be0205f2c1a82dbec11678f9776a517bbf7657b3e1182cd72c4bf0192661390afaec1a356831edb1287a256f86f50
+  metadata.gz: 49af5ddd1e984052b4b4e3ba9d1f121ece725a29ecbcd672589a21187c19fb5f3d51859806560cfe2835f4f6499574fc5ed21fb5ae4356131297c05663bf0c63
+  data.tar.gz: f8e5cf2d0459c8e1b75ee95d91cba4084313f556a8900a0c7b6dbd9536f9602c0fb613f591787cdf02a63a8b8187cf4d8953cbc735a6defde018a01eb8d79e92

data/CHANGELOG.md

@@ -1,22 +1,33 @@
-<!-- latest_release 1.4.4 -->
-## [v1.4.4](https://github.com/chef/train/tree/v1.4.4) (2018-05-02)
+<!-- latest_release 1.4.9 -->
+## [v1.4.9](https://github.com/chef/train/tree/v1.4.9) (2018-05-16)
 
 #### Merged Pull Requests
-- Split train into a core gem. [#293](https://github.com/chef/train/pull/293) ([miah](https://github.com/miah))
-- Enable expeditor release tasks [#294](https://github.com/chef/train/pull/294) ([jquick](https://github.com/jquick))
+- Unpin google-protobuf now that we are building it as a gem [#300](https://github.com/chef/train/pull/300) ([scotthain](https://github.com/scotthain))
 <!-- latest_release -->
 
-<!-- release_rollup since=1.4.2 -->
-### Changes since 1.4.2 release
+<!-- release_rollup since=1.4.4 -->
+### Changes since 1.4.4 release
+
+#### Bug Fixes
+- Allow nil password and www_form_encoded_password to work together. [#297](https://github.com/chef/train/pull/297) ([marcparadise](https://github.com/marcparadise)) <!-- 1.4.6 -->
 
 #### Merged Pull Requests
-- Split train into a core gem. [#293](https://github.com/chef/train/pull/293) ([miah](https://github.com/miah)) <!-- 1.4.4 -->
-- Enable expeditor release tasks [#294](https://github.com/chef/train/pull/294) ([jquick](https://github.com/jquick)) <!-- 1.4.3 -->
+- Unpin google-protobuf now that we are building it as a gem [#300](https://github.com/chef/train/pull/300) ([scotthain](https://github.com/scotthain)) <!-- 1.4.9 -->
+- Change Cisco IOS transport log level to INFO [#298](https://github.com/chef/train/pull/298) ([jerryaldrichiii](https://github.com/jerryaldrichiii)) <!-- 1.4.8 -->
+- Initial import of transport for GCP. [#283](https://github.com/chef/train/pull/283) ([skpaterson](https://github.com/skpaterson)) <!-- 1.4.7 -->
+- Support encoded passwords in target url [#296](https://github.com/chef/train/pull/296) ([marcparadise](https://github.com/marcparadise)) <!-- 1.4.5 -->
 <!-- release_rollup -->
 
 <!-- latest_stable_release -->
+## [v1.4.4](https://github.com/chef/train/tree/v1.4.4) (2018-05-02)
+
+#### Merged Pull Requests
+- Enable expeditor release tasks [#294](https://github.com/chef/train/pull/294) ([jquick](https://github.com/jquick))
+- Split train into a core gem. [#293](https://github.com/chef/train/pull/293) ([miah](https://github.com/miah))
 <!-- latest_stable_release -->
 
+
+
 # Change Log
 
 ## [1.4.2](https://github.com/chef/train/tree/1.4.2) (2018-04-26)

data/Gemfile

@@ -23,7 +23,7 @@ group :test do
 end
 
 group :integration do
-  gem 'berkshelf', '~> 4.3'
+  gem 'berkshelf', '~> 5.2'
   gem 'test-kitchen', '~> 1.11'
   gem 'kitchen-vagrant'
 end

data/lib/train.rb

@@ -66,8 +66,13 @@ module Train
       conf[:host]     ||= uri.hostname
       conf[:port]     ||= uri.port
       conf[:user]     ||= uri.user
-      conf[:password] ||= uri.password
       conf[:path]     ||= uri.path
+      conf[:password] ||=
+        if conf[:www_form_encoded_password] && !uri.password.nil?
+          URI.decode_www_form_component(uri.password)
+        else
+          uri.password
+        end
     end
 
     # ensure path is nil, if its empty; e.g. required to reset defaults for winrm

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

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

data/lib/train/transports/cisco_ios_connection.rb

@@ -7,6 +7,8 @@ class Train::Transports::SSH
     def initialize(options)
       super(options)
 
+      logger.level = Logger::INFO
+
       # Extract options to avoid passing them in to `Net::SSH.start` later
       @host = options.delete(:host)
       @user = options.delete(:user)

data/lib/train/transports/gcp.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+
+require 'train/plugins'
+require 'google/apis'
+require 'google/apis/cloudresourcemanager_v1'
+require 'google/apis/compute_v1'
+require 'google/apis/storage_v1'
+require 'google/apis/iam_v1'
+require 'googleauth'
+
+module Train::Transports
+  class Gcp < Train.plugin(1)
+    name 'gcp'
+
+    # GCP will look automatically for the below env var for service accounts etc. :
+    option :google_application_credentials, required: false, default: ENV['GOOGLE_APPLICATION_CREDENTIALS']
+    # see https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application
+    # In the absence of this, the client is expected to have already set up local credentials via:
+    #   $ gcloud auth application-default login
+    #   $ gcloud config set project <project-name>
+    # GCP projects can have default regions / zones set, see:
+    # https://cloud.google.com/compute/docs/regions-zones/changing-default-zone-region
+    # can also specify project via env var:
+    option :google_cloud_project, required: false, default: ENV['GOOGLE_CLOUD_PROJECT']
+
+    def connection(_ = nil)
+      @connection ||= Connection.new(@options)
+    end
+
+    class Connection < BaseConnection
+      def initialize(options)
+        super(options)
+
+        # additional GCP platform metadata
+        release = Gem.loaded_specs['google_cloud']
+        @platform_details = { release: "google-cloud-v#{release}" }
+
+        # Initialize the client object cache
+        @cache_enabled[:api_call] = true
+        @cache[:api_call] = {}
+
+        connect
+      end
+
+      def platform
+        direct_platform('gcp', @platform_details)
+      end
+
+      # Instantiate some named classes for ease of use
+      def gcp_compute_client
+        gcp_client(Google::Apis::ComputeV1::ComputeService)
+      end
+
+      def gcp_iam_client
+        gcp_client(Google::Apis::IamV1::IamService)
+      end
+
+      def gcp_project_client
+        gcp_client(Google::Apis::CloudresourcemanagerV1::CloudResourceManagerService)
+      end
+
+      def gcp_storage_client
+        gcp_client(Google::Apis::StorageV1::StorageService)
+      end
+
+      # Let's allow for other clients too
+      def gcp_client(klass)
+        return klass.new unless cache_enabled?(:api_call)
+        @cache[:api_call][klass.to_s.to_sym] ||= klass.new
+      end
+
+      def connect
+        ENV['GOOGLE_APPLICATION_CREDENTIALS'] = @options[:google_application_credentials] if @options[:google_application_credentials]
+        ENV['GOOGLE_CLOUD_PROJECT'] = @options[:google_cloud_project] if @options[:google_cloud_project]
+        # GCP initialization
+        scopes = ['https://www.googleapis.com/auth/cloud-platform',
+                  'https://www.googleapis.com/auth/compute']
+        authorization = Google::Auth.get_application_default(scopes)
+        Google::Apis::RequestOptions.default.authorization = authorization
+      end
+
+      def uri
+        "gcp://#{unique_identifier}"
+      end
+
+      def unique_identifier
+        # use auth client_id - same to retrieve for any of the clients but use IAM
+        gcp_iam_client.request_options.authorization.client_id
+      end
+    end
+  end
+end

data/lib/train/version.rb

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

data/test/unit/train_test.rb

@@ -177,6 +177,32 @@ describe Train do
       res[:target].must_equal org[:target]
     end
 
+    it 'supports www-form encoded passwords when the option is set' do
+      raw_password = '+!@#$%^&*()_-\';:"\\|/?.>,<][}{=`~'
+      encoded_password = URI.encode_www_form_component(raw_password)
+      org = { target: "mock://username:#{encoded_password}@1.2.3.4:100",
+              www_form_encoded_password: true}
+      res = Train.target_config(org)
+      res[:backend].must_equal 'mock'
+      res[:host].must_equal '1.2.3.4'
+      res[:user].must_equal 'username'
+      res[:password].must_equal raw_password
+      res[:port].must_equal 100
+      res[:target].must_equal org[:target]
+    end
+
+    it 'ignores www-form-encoded password value when there is no password' do
+      org = { target: "mock://username@1.2.3.4:100",
+              www_form_encoded_password: true}
+      res = Train.target_config(org)
+      res[:backend].must_equal 'mock'
+      res[:host].must_equal '1.2.3.4'
+      res[:user].must_equal 'username'
+      res[:password].must_be_nil
+      res[:port].must_equal 100
+      res[:target].must_equal org[:target]
+    end
+
     it 'it raises UserError on invalid URIs' do
       org = { target: 'mock world' }
       proc { Train.target_config(org) }.must_raise Train::UserError

data/test/unit/transports/gcp_test.rb

@@ -0,0 +1,191 @@
+# encoding: utf-8
+
+require 'helper'
+
+describe 'gcp transport' do
+
+  let(:credentials_file) do
+    require 'tempfile'
+    file = Tempfile.new('application_default_credentials.json')
+    info = <<-INFO
+{
+  "client_id": "asdfasf-asdfasdf.apps.googleusercontent.com",
+  "client_secret": "d-asdfasdf",
+  "refresh_token": "1/adsfasdf-lCkju3-yQmjr20xVZonrfkE48L",
+  "type": "authorized_user"
+}
+    INFO
+    file.write(info)
+    file.close
+    file
+  end
+
+  let(:credentials_file_override) do
+    require 'tempfile'
+    file = Tempfile.new('application_default_credentials.json')
+    info = <<-INFO
+{
+  "client_id": "asdfasf-asdfasdf.apps.googleusercontent.com",
+  "client_secret": "d-asdfasdf",
+  "refresh_token": "1/adsfasdf-lCkju3-yQmjr20xVZonrfkE48L",
+  "type": "authorized_user"
+}
+    INFO
+    file.write(info)
+    file.close
+    file
+  end
+
+  def transport(options = nil)
+    ENV['GOOGLE_APPLICATION_CREDENTIALS'] = credentials_file.path
+    ENV['GOOGLE_CLOUD_PROJECT'] = 'test_project'
+    # need to require this at here as it captures the envs on load
+    require 'train/transports/gcp'
+    Train::Transports::Gcp.new(options)
+  end
+
+  let(:connection) { transport.connection }
+  let(:options) { connection.instance_variable_get(:@options) }
+  let(:cache) { connection.instance_variable_get(:@cache) }
+
+  describe 'options' do
+    it 'defaults to env options' do
+      options[:google_application_credentials] = credentials_file.path
+      options[:google_cloud_project].must_equal 'test_project'
+    end
+  end
+
+  it 'allows for options override' do
+    transport = transport(google_application_credentials: credentials_file_override.path, google_cloud_project: "override_project")
+    options = transport.connection.instance_variable_get(:@options)
+    options[:google_application_credentials].must_equal credentials_file_override.path
+    options[:google_cloud_project].must_equal "override_project"
+  end
+
+  describe 'platform' do
+    it 'returns platform' do
+      platform = connection.platform
+      platform.name.must_equal 'gcp'
+      platform.family_hierarchy.must_equal ['cloud', 'api']
+    end
+  end
+
+  describe 'gcp_client' do
+    it 'test gcp_client with caching' do
+      client = connection.gcp_client(Object)
+      client.is_a?(Object).must_equal true
+      cache[:api_call].count.must_equal 1
+    end
+
+    it 'test gcp_client without caching' do
+      connection.disable_cache(:api_call)
+      client = connection.gcp_client(Object)
+      client.is_a?(Object).must_equal true
+      cache[:api_call].count.must_equal 0
+    end
+  end
+
+
+  describe 'gcp_compute_client' do
+    it 'test gcp_compute_client with caching' do
+      client = connection.gcp_compute_client
+      client.is_a?(Google::Apis::ComputeV1::ComputeService).must_equal true
+      cache[:api_call].count.must_equal 1
+    end
+
+    it 'test gcp_client without caching' do
+      connection.disable_cache(:api_call)
+      client = connection.gcp_compute_client
+      client.is_a?(Google::Apis::ComputeV1::ComputeService).must_equal true
+      cache[:api_call].count.must_equal 0
+    end
+  end
+
+  describe 'gcp_iam_client' do
+    it 'test gcp_iam_client with caching' do
+      client = connection.gcp_iam_client
+      client.is_a?(Google::Apis::IamV1::IamService).must_equal true
+      cache[:api_call].count.must_equal 1
+    end
+
+    it 'test gcp_iam_client without caching' do
+      connection.disable_cache(:api_call)
+      client = connection.gcp_iam_client
+      client.is_a?(Google::Apis::IamV1::IamService).must_equal true
+      cache[:api_call].count.must_equal 0
+    end
+  end
+
+  describe 'gcp_project_client' do
+    it 'test gcp_project_client with caching' do
+      client = connection.gcp_project_client
+      client.is_a?(Google::Apis::CloudresourcemanagerV1::CloudResourceManagerService).must_equal true
+      cache[:api_call].count.must_equal 1
+    end
+
+    it 'test gcp_project_client without caching' do
+      connection.disable_cache(:api_call)
+      client = connection.gcp_project_client
+      client.is_a?(Google::Apis::CloudresourcemanagerV1::CloudResourceManagerService).must_equal true
+      cache[:api_call].count.must_equal 0
+    end
+  end
+
+  describe 'gcp_storage_client' do
+    it 'test gcp_storage_client with caching' do
+      client = connection.gcp_storage_client
+      client.is_a?(Google::Apis::StorageV1::StorageService).must_equal true
+      cache[:api_call].count.must_equal 1
+    end
+
+    it 'test gcp_storage_client without caching' do
+      connection.disable_cache(:api_call)
+      client = connection.gcp_storage_client
+      client.is_a?(Google::Apis::StorageV1::StorageService).must_equal true
+      cache[:api_call].count.must_equal 0
+    end
+  end
+
+  # test options override of env vars in connect
+  describe 'connect' do
+    let(:creds) do
+      require 'tempfile'
+      file = Tempfile.new('creds')
+      info = <<-INFO
+{
+  "client_id": "asdfasf-asdfasdf.apps.googleusercontent.com",
+  "client_secret": "d-asdfasdf",
+  "refresh_token": "1/adsfasdf-lCkju3-yQmjr20xVZonrfkE48L",
+  "type": "authorized_user"
+}
+      INFO
+      file.write(info)
+      file.close
+      file
+    end
+    it 'validate gcp connection with credentials' do
+      options[:google_application_credentials] = creds.path
+      connection.connect
+      ENV['GOOGLE_APPLICATION_CREDENTIALS'].must_equal creds.path
+    end
+    it 'validate gcp connection with project' do
+      options[:google_cloud_project] = 'project'
+      connection.connect
+      ENV['GOOGLE_CLOUD_PROJECT'].must_equal 'project'
+    end
+  end
+
+  describe 'unique_identifier' do
+    it 'test connection unique identifier' do
+      client = connection
+      client.unique_identifier.must_equal 'asdfasf-asdfasdf.apps.googleusercontent.com'
+    end
+  end
+
+  describe 'uri' do
+    it 'test uri' do
+      client = connection
+      client.uri.must_equal 'gcp://asdfasf-asdfasdf.apps.googleusercontent.com'
+    end
+  end
+end

data/train.gemspec

@@ -35,6 +35,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'docker-api', '~> 1.26'
   spec.add_dependency 'aws-sdk', '~> 2'
   spec.add_dependency 'azure_mgmt_resources', '~> 0.15'
+  spec.add_dependency 'google-api-client', '~> 0.19.8'
+  spec.add_dependency 'googleauth', '~> 0.6.2'
+  spec.add_dependency 'google-cloud', '~> 0.51.1'
   spec.add_dependency 'inifile'
 
   spec.add_development_dependency 'mocha', '~> 1.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.4.9
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
+date: 2018-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -148,6 +148,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.8
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: google-cloud
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.1
 - !ruby/object:Gem::Dependency
   name: inifile
   requirement: !ruby/object:Gem::Requirement
@@ -224,6 +266,7 @@ files:
 - lib/train/transports/azure.rb
 - lib/train/transports/cisco_ios_connection.rb
 - lib/train/transports/docker.rb
+- lib/train/transports/gcp.rb
 - lib/train/transports/local.rb
 - lib/train/transports/mock.rb
 - lib/train/transports/ssh.rb
@@ -290,6 +333,7 @@ files:
 - test/unit/transports/aws_test.rb
 - test/unit/transports/azure_test.rb
 - test/unit/transports/cisco_ios_connection.rb
+- test/unit/transports/gcp_test.rb
 - test/unit/transports/local_test.rb
 - test/unit/transports/mock_test.rb
 - test/unit/transports/ssh_test.rb
@@ -381,6 +425,7 @@ test_files:
 - test/unit/transports/aws_test.rb
 - test/unit/transports/azure_test.rb
 - test/unit/transports/cisco_ios_connection.rb
+- test/unit/transports/gcp_test.rb
 - test/unit/transports/local_test.rb
 - test/unit/transports/mock_test.rb
 - test/unit/transports/ssh_test.rb