Module: NexusSW::LXD::Driver::Mixins::Rest

Includes:
Helpers::WaitMixin
Included in:
Rest
Defined in:
lib/nexussw/lxd/driver/mixins/rest.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Helpers::WaitMixin

#check_for_ip, #wait_for

Instance Attribute Details

#api ⇒ Object (readonly)

Returns the value of attribute api.



23
24
25
 
# File 'lib/nexussw/lxd/driver/mixins/rest.rb', line 23

def api
  @api
end

#driver_options ⇒ Object (readonly)

Returns the value of attribute driver_options.



23
24
25
 
# File 'lib/nexussw/lxd/driver/mixins/rest.rb', line 23

def driver_options
  @driver_options
end

#rest_endpoint ⇒ Object (readonly)

Returns the value of attribute rest_endpoint.



23
24
25
 
# File 'lib/nexussw/lxd/driver/mixins/rest.rb', line 23

def rest_endpoint
  @rest_endpoint
end

Instance Method Details

#container(container_id) ⇒ Object 



114
115
116
 
# File 'lib/nexussw/lxd/driver/mixins/rest.rb', line 114

def container(container_id)
  api.container(container_id)[:metadata]
end

#container_exists?(container_id) ⇒ Boolean

Returns:

  • (Boolean) 


118
119
120
 
# File 'lib/nexussw/lxd/driver/mixins/rest.rb', line 118

def container_exists?(container_id)
  api.containers[:metadata].map { |url| url.split('/').last }.include? container_id
end

#container_state(container_id) ⇒ Object 



109
110
111
112
 
# File 'lib/nexussw/lxd/driver/mixins/rest.rb', line 109

def container_state(container_id)
  return nil unless container_status(container_id) == 'running' # Parity with CLI
  api.container_state(container_id)[:metadata]
end

#container_status(container_id) ⇒ Object 



105
106
107
 
# File 'lib/nexussw/lxd/driver/mixins/rest.rb', line 105

def container_status(container_id)
  STATUS_CODES[api.container(container_id)[:metadata][:status_code].to_i]
end

#create_container(container_name, container_options = {}) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/nexussw/lxd/driver/mixins/rest.rb', line 35

def create_container(container_name, container_options = {})
  if container_exists?(container_name)
    start_container container_name # Start the container for Parity with the CLI
    return container_name
  end
  # parity note: CLI will run indefinitely rather than timeout hence the 0 timeout
  retry_forever do
    api.create_container(container_name, container_options.merge(sync: false))
  end
  start_container container_name
  container_name
end

#delete_container(container_id) ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/nexussw/lxd/driver/mixins/rest.rb', line 86

def delete_container(container_id)
  return unless container_exists? container_id
  stop_container container_id, force: true

  # ISSUE 17: something upstream is causing a double-tap on the REST endpoint

  # trial return to normal
  # begin
  api.delete_container container_id
  # rescue ::Faraday::ConnectionFailed, ::NexusSW::LXD::RestAPI::Error::BadRequest
  #   LXD.with_timeout_and_retries timeout: 120 do
  #     loop do
  #       return unless container_exists? container_id
  #       sleep 0.3
  #     end
  #   end
  # end
end

#initialize(rest_endpoint, driver_options = {}, inner_driver = nil) ⇒ Object

PARITY note: CLI functions are on an indefinite timeout by default, yet we have a 2 minute socket read timeout Leaving it alone, for now, on calls that are quick in nature Adapting on known long running calls such as create, stop, execute



13
14
15
16
17
18
19
20
21
 
# File 'lib/nexussw/lxd/driver/mixins/rest.rb', line 13

def initialize(rest_endpoint, driver_options = {}, inner_driver = nil)
  @rest_endpoint = rest_endpoint
  @driver_options = driver_options
  apioptions = (driver_options || {}).merge(
    api_endpoint: rest_endpoint,
    auto_sync: true
  )
  @api = inner_driver || RestAPI.new(apioptions)
end

#server_info ⇒ Object 



27
28
29
 
# File 'lib/nexussw/lxd/driver/mixins/rest.rb', line 27

def server_info
  @server_info ||= api.get('/1.0')[:metadata]
end

#start_container(container_id) ⇒ Object 



48
49
50
51
52
53
54
 
# File 'lib/nexussw/lxd/driver/mixins/rest.rb', line 48

def start_container(container_id)
  return if container_status(container_id) == 'running'
  retry_forever do
    api.start_container(container_id, sync: false)
  end
  wait_for_status container_id, 'running'
end

#stop_container(container_id, options = {}) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/nexussw/lxd/driver/mixins/rest.rb', line 56

def stop_container(container_id, options = {})
  return if container_status(container_id) == 'stopped'
  if options[:force]
    api.stop_container(container_id, force: true)
  else
    last_id = nil
    use_last = false
    LXD.with_timeout_and_retries({ timeout: 0 }.merge(options)) do # timeout: 0 to enable retry functionality
      return if container_status(container_id) == 'stopped'
      begin
        unless use_last
          # Keep resubmitting until the server complains (Stops will be ignored/hang if init is not yet listening for SIGPWR i.e. recently started)
          begin
            last_id = api.stop_container(container_id, sync: false)[:metadata][:id]
          rescue NexusSW::LXD::RestAPI::Error::BadRequest # Happens if a stop command has previously been accepted as well as other reasons.  handle that on next line
            # if we have a last_id then a prior stop command has successfully initiated so we'll just wait on that one
            raise unless last_id # rubocop:disable Metrics/BlockNesting
            use_last = true
          end
        end
        api.wait_for_operation last_id # , options[:retry_interval]
      rescue Faraday::TimeoutError => e
        return if container_status(container_id) == 'stopped'
        raise Timeout::Retry.new e # if options[:retry_interval] # rubocop:disable Style/RaiseArgs
      end
    end
  end
  wait_for_status container_id, 'stopped'
end

#transport_for(container_name) ⇒ Object 



31
32
33
 
# File 'lib/nexussw/lxd/driver/mixins/rest.rb', line 31

def transport_for(container_name)
  Transport::Rest.new container_name, info: server_info, connection: api, driver_options: driver_options, rest_endpoint: rest_endpoint
end