Class: Train::Transports::Azure::Connection

Inherits:
BaseConnection
  • Object
show all
Defined in:
lib/train/transports/azure.rb

Overview

rubocop:disable Metrics/ClassLength

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Connection

Returns a new instance of Connection.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/train/transports/azure.rb', line 29

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

  @options[:msi_port] = @options[:msi_port].to_i unless @options[:msi_port].nil?

  # additional platform details
  release = Gem.loaded_specs['azure_mgmt_resources'].version
  @platform_details = { release: "azure_mgmt_resources-v#{release}" }

  connect
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



27
28
29
 
# File 'lib/train/transports/azure.rb', line 27

def options
  @options
end

Instance Method Details

#azure_client(klass = ::Azure::Resources::Profiles::Latest::Mgmt::Client) ⇒ Object 



57
58
59
60
61
 
# File 'lib/train/transports/azure.rb', line 57

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

#connect ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/train/transports/azure.rb', line 63

def connect
  if @options[:client_id].nil? && @options[:client_secret].nil? && port_open?(@options[:msi_port])
    # this needs set for azure cloud to authenticate
    ENV['MSI_VM'] = 'true'
    provider = ::MsRestAzure::MSITokenProvider.new(@options[:msi_port])
  else
    provider = ::MsRestAzure::ApplicationTokenProvider.new(
      @options[:tenant_id],
      @options[:client_id],
      @options[:client_secret],
    )
  end

  @credentials = {
    credentials: ::MsRest::TokenCredentials.new(provider),
    subscription_id: @options[:subscription_id],
    tenant_id: @options[:tenant_id],
  }
  @credentials[:client_id] = @options[:client_id] unless @options[:client_id].nil?
  @credentials[:client_secret] = @options[:client_secret] unless @options[:client_secret].nil?
end

#get_api_version(resource_type, options) ⇒ Object

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.

Parameters:

  • string —

    resource_type The resource type for which the API is required

  • hash —

    options Options have that have been passed to the resource during the test.

  • opts (Hash) —

    a customizable set of options

Returns:

  • string API Version of the specified resource type



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/train/transports/azure.rb', line 107

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

#platform ⇒ Object 



53
54
55
 
# File 'lib/train/transports/azure.rb', line 53

def platform
  direct_platform('azure', @platform_details)
end

#unique_identifier ⇒ Object 



134
135
136
 
# File 'lib/train/transports/azure.rb', line 134

def unique_identifier
  options[:subscription_id] || options[:tenant_id]
end

#uri ⇒ Object 



85
86
87
 
# File 'lib/train/transports/azure.rb', line 85

def uri
  "azure://#{@options[:subscription_id]}"
end