Class: Bolt::Target

Inherits:
Object
  • Object
show all
Defined in:
lib/bolt/target.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(uri, options = nil) ⇒ Target

URI can be passes as nil



20
21
22
23
24
25
26
27
28
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/bolt/target.rb', line 20

def initialize(uri, options = nil)
  # lazy-load expensive gem code
  require 'addressable/uri'

  @uri = uri
  @uri_obj = parse(uri)
  @options = options || {}
  @options.freeze

  if @options['user']
    @user = @options['user']
  end

  if @options['password']
    @password = @options['password']
  end

  if @options['port']
    @port = @options['port']
  end

  if @options['protocol']
    @protocol = @options['protocol']
  end

  if @options['host']
    @host = @options['host']
  end

  # WARNING: name should never be updated
  @name = @options['name'] || @uri
end

Instance Attribute Details

#inventory ⇒ Object

CODEREVIEW: this feels wrong. The altertative is threading inventory through the executor to the RemoteTransport



10
11
12
 
# File 'lib/bolt/target.rb', line 10

def inventory
  @inventory
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



7
8
9
 
# File 'lib/bolt/target.rb', line 7

def options
  @options
end

#uri ⇒ Object

CODEREVIEW: this feels wrong. The altertative is threading inventory through the executor to the RemoteTransport



10
11
12
 
# File 'lib/bolt/target.rb', line 10

def uri
  @uri
end

Class Method Details

.from_asserted_hash(hash) ⇒ Object

Satisfies the Puppet datatypes API



15
16
17
 
# File 'lib/bolt/target.rb', line 15

def self.from_asserted_hash(hash)
  new(hash['uri'], hash['options'])
end

Instance Method Details

#eql?(other) ⇒ Boolean Also known as: ==

TODO: WHAT does equality mean here? should we just compare names? is there something else that is meaninful?

Returns:

  • (Boolean) 


93
94
95
96
97
98
99
100
101
102
 
# File 'lib/bolt/target.rb', line 93

def eql?(other)
  if self.class.equal?(other.class)
    if @uri
      return @uri == other.uri
    else
      @name = other.name
    end
  end
  false
end

#features ⇒ Object 



83
84
85
86
87
88
89
 
# File 'lib/bolt/target.rb', line 83

def features
  if @inventory
    @inventory.features(self)
  else
    Set.new
  end
end

#hash ⇒ Object 



105
106
107
 
# File 'lib/bolt/target.rb', line 105

def hash
  @uri.hash ^ @options.hash
end

#host ⇒ Object 



126
127
128
 
# File 'lib/bolt/target.rb', line 126

def host
  @uri_obj&.hostname || @host
end

#name ⇒ Object 



130
131
132
 
# File 'lib/bolt/target.rb', line 130

def name
  @name || @uri
end

#password ⇒ Object 



155
156
157
 
# File 'lib/bolt/target.rb', line 155

def password
  Addressable::URI.unencode_component(@uri_obj&.password) || @password
end

#port ⇒ Object 



138
139
140
 
# File 'lib/bolt/target.rb', line 138

def port
  @uri_obj&.port || @port
end

#protocol ⇒ Object 



147
148
149
 
# File 'lib/bolt/target.rb', line 147

def protocol
  @uri_obj&.scheme || @protocol
end

#remote? ⇒ Boolean

Returns:

  • (Boolean) 


134
135
136
 
# File 'lib/bolt/target.rb', line 134

def remote?
  @uri_obj&.scheme == 'remote' || @protocol == 'remote'
end

#to_h ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/bolt/target.rb', line 114

def to_h
  options.merge(
    'name' => name,
    'uri' => uri,
    'protocol' => protocol,
    'user' => user,
    'password' => password,
    'host' => host,
    'port' => port
  )
end

#to_s ⇒ Object 



109
110
111
112
 
# File 'lib/bolt/target.rb', line 109

def to_s
  opts = @options.select { |k, _| PRINT_OPTS.include? k }
  "Target('#{@uri}', #{opts})"
end

#transport ⇒ Object

transport is separate from protocol for remote targets.



143
144
145
 
# File 'lib/bolt/target.rb', line 143

def transport
  remote? ? 'remote' : protocol
end

#update_conf(conf) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/bolt/target.rb', line 53

def update_conf(conf)
  @protocol = conf[:transport]

  t_conf = conf[:transports][transport.to_sym] || {}
  # Override url methods
  @user = t_conf['user']
  @password = t_conf['password']
  @port = t_conf['port']
  @host = t_conf['host']

  # Preserve everything in options so we can easily create copies of a Target.
  @options = t_conf.merge(@options)

  self
end

#user ⇒ Object 



151
152
153
 
# File 'lib/bolt/target.rb', line 151

def user
  Addressable::URI.unencode_component(@uri_obj&.user) || @user
end