lxd-common 0.9.8 → 0.9.9

data/lib/nexussw/lxd/driver/mixins/helpers/wait.rb

@@ -8,9 +8,9 @@ module NexusSW
               cc = driver.container(container_name)
               state = driver.container_state(container_name)
               cc[:expanded_devices].each do |nic, data|
-                next unless data[:type] == 'nic'
+                next unless data[:type] == "nic"
                 state[:network][nic][:addresses].each do |address|
-                  return address[:address] if address[:family] == 'inet' && address[:address] && !address[:address].empty?
+                  return address[:address] if address[:family] == "inet" && address[:address] && !address[:address].empty?
                 end
               end
               nil
@@ -22,11 +22,11 @@ module NexusSW
                   retval = nil
                   case what
                   when :cloud_init
-                    retval = !transport_for(container_name).execute('test -f /run/cloud-init/result.json').error?
+                    retval = !transport_for(container_name).execute("test -f /run/cloud-init/result.json").error?
                   when :ip
                     retval = check_for_ip(self, container_name)
                   else
-                    raise 'unrecognized option'
+                    raise "unrecognized option"
                   end
                   return retval if retval
                   sleep 0.5

data/lib/nexussw/lxd/driver/mixins/rest.rb

@@ -1,6 +1,6 @@
-require 'nexussw/lxd/rest_api'
-require 'nexussw/lxd/driver/mixins/helpers/wait'
-require 'nexussw/lxd/transport/rest'
+require "nexussw/lxd/rest_api"
+require "nexussw/lxd/driver/mixins/helpers/wait"
+require "nexussw/lxd/transport/rest"
 
 module NexusSW
   module LXD
@@ -25,7 +25,7 @@ module NexusSW
           include Helpers::WaitMixin
 
           def server_info
-            @server_info ||= api.get('/1.0')[:metadata]
+            api.server_info
           end
 
           def transport_for(container_name)
@@ -33,35 +33,41 @@ module NexusSW
           end
 
           def create_container(container_name, container_options = {})
+            autostart = (container_options.delete(:autostart) != false)
             if container_exists?(container_name)
-              start_container container_name # Start the container for Parity with the CLI
+              start_container(container_name) if autostart
               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
+            start_container(container_name) if autostart
             container_name
           end
 
+          def update_container(container_name, container_options)
+            api.update_container(container_name, container_options)
+            container(container_name)
+          end
+
           def start_container(container_id)
-            return if container_status(container_id) == 'running'
+            return if container_status(container_id) == "running"
             retry_forever do
               api.start_container(container_id, sync: false)
             end
-            wait_for_status container_id, 'running'
+            wait_for_status container_id, "running"
           end
 
           def stop_container(container_id, options = {})
-            return if container_status(container_id) == 'stopped'
+            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'
+                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)
@@ -75,31 +81,19 @@ module NexusSW
                   end
                   api.wait_for_operation last_id # , options[:retry_interval]
                 rescue Faraday::TimeoutError => e
-                  return if container_status(container_id) == 'stopped'
+                  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'
+            wait_for_status container_id, "stopped"
           end
 
           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
 
           def container_status(container_id)
@@ -107,16 +101,16 @@ module NexusSW
           end
 
           def container_state(container_id)
-            return nil unless container_status(container_id) == 'running' # Parity with CLI
+            return nil unless container_status(container_id) == "running" # Parity with CLI
             api.container_state(container_id)[:metadata]
           end
 
           def container(container_id)
-            api.container(container_id)[:metadata]
+            Driver.convert_bools api.container(container_id)[:metadata]
           end
 
           def container_exists?(container_id)
-            api.containers[:metadata].map { |url| url.split('/').last }.include? container_id
+            api.containers[:metadata].map { |url| url.split("/").last }.include? container_id
           end
 
           protected

data/lib/nexussw/lxd/driver/rest.rb

@@ -1,5 +1,5 @@
-require 'nexussw/lxd/driver'
-require 'nexussw/lxd/driver/mixins/rest'
+require "nexussw/lxd/driver"
+require "nexussw/lxd/driver/mixins/rest"
 
 module NexusSW
   module LXD

data/lib/nexussw/lxd/rest_api.rb

@@ -1,6 +1,6 @@
-require 'nexussw/lxd/rest_api/connection'
-require 'nexussw/lxd/rest_api/errors'
-require 'shellwords'
+require "nexussw/lxd/rest_api/connection"
+require "nexussw/lxd/rest_api/errors"
+require "shellwords"
 
 module NexusSW
   module LXD
@@ -11,10 +11,25 @@ module NexusSW
 
       include RestAPI::Connection
 
+      def server_info
+        @server_info ||= LXD.symbolize_keys(get("/1.0"))[:metadata]
+      end
+
       def create_container(container_name, options)
         options, sync = parse_options options
-        options[:config] = convert_bools(options[:config]) if options.key? :config
-        handle_async post('/1.0/containers', create_source(options).merge(name: container_name)), sync
+        handle_async post("/1.0/containers", RestAPI.convert_bools(create_source(options).merge(name: container_name))), sync
+      end
+
+      def update_container(container_name, container_options)
+        if can_patch?
+          patch "/1.0/containers/#{container_name}", RestAPI.convert_bools(container_options)
+        else
+          data = container(container_name)[:metadata].select { |k, _| [:config, :devices, :profiles].include? k }
+          data[:config].merge! container_options[:config] if container_options.key? :config
+          data[:devices].merge! container_options[:devices] if container_options.key? :devices
+          data[:profiles] = container_options[:profiles] if container_options.key? :profiles
+          handle_async put("/1.0/containers/#{container_name}", RestAPI.convert_bools(data)), true
+        end
       end
 
       def execute_command(container_name, command, options)
@@ -35,12 +50,12 @@ module NexusSW
 
       def start_container(container_name, options)
         options, sync = parse_options options
-        handle_async put("/1.0/containers/#{container_name}/state", options.merge(action: 'start')), sync
+        handle_async put("/1.0/containers/#{container_name}/state", options.merge(action: "start")), sync
       end
 
       def stop_container(container_name, options)
         options, sync = parse_options options
-        handle_async put("/1.0/containers/#{container_name}/state", options.merge(action: 'stop')), sync
+        handle_async put("/1.0/containers/#{container_name}/state", options.merge(action: "stop")), sync
       end
 
       def delete_container(container_name, options = {})
@@ -55,10 +70,10 @@ module NexusSW
 
       def write_file(container_name, path, options)
         post "/1.0/containers/#{container_name}/files?path=#{path}", options[:content] do |req|
-          req.headers['Content-Type'] = 'application/octet-stream'
-          req.headers['X-LXD-uid'] = options[:uid] if options[:uid]
-          req.headers['X-LXD-gid'] = options[:gid] if options[:gid]
-          req.headers['X-LXD-mode'] = options[:file_mode] if options[:file_mode]
+          req.headers["Content-Type"] = "application/octet-stream"
+          req.headers["X-LXD-uid"] = options[:uid] if options[:uid]
+          req.headers["X-LXD-gid"] = options[:gid] if options[:gid]
+          req.headers["X-LXD-mode"] = options[:file_mode] if options[:file_mode]
         end
       end
 
@@ -75,30 +90,41 @@ module NexusSW
       end
 
       def container(container_name)
-        exceptkeys = %w(config expanded_config)
-        get "/1.0/containers/#{container_name}" do |response|
-          retval = JSON.parse(response.body)
-          lift = retval['metadata'].select { |k, _| exceptkeys.include? k }
-          retval['metadata'].delete_if { |k, _| exceptkeys.include? k }
-          retval = LXD.symbolize_keys(retval)
-          retval[:metadata][:config] = lift['config'] if lift.key? 'config'
-          retval[:metadata][:expanded_config] = lift['expanded_config'] if lift.key? 'expanded_config'
-          return retval
-        end
+        get "/1.0/containers/#{container_name}"
       end
 
       def containers
-        get('/1.0/containers')
+        get("/1.0/containers")
       end
 
       def wait_for_operation(operation_id)
         get "/1.0/operations/#{operation_id}/wait"
       end
 
+      def self.convert_bools(hash)
+        {}.tap do |retval|
+          hash.each do |k, v|
+            if [:ephemeral, :stateful].include? k
+              retval[k] = v
+            else
+              retval[k] = case v
+                          when true then "true"
+                          when false then "false"
+                          else v.is_a?(Hash) && ([:config, :devices].include?(k)) ? convert_bools(v) : v
+                          end
+            end
+          end
+        end
+      end
+
       private
 
       attr_reader :api_options
 
+      def can_patch?
+        server_info[:api_extensions].include? "patch"
+      end
+
       def handle_async(data, sync)
         return data if sync == false
         wait_for_operation data[:metadata][:id]
@@ -112,22 +138,10 @@ module NexusSW
       def create_source(options)
         moveprops = [:type, :alias, :fingerprint, :properties, :protocol, :server]
         options.dup.tap do |retval|
-          retval[:source] = { type: 'image', mode: 'pull' }.merge(retval.select { |k, _| moveprops.include? k }) unless retval.key? :source
+          retval[:source] = { type: "image", mode: "pull" }.merge(retval.select { |k, _| moveprops.include? k }) unless retval.key? :source
           retval.delete_if { |k, _| moveprops.include? k }
         end
       end
-
-      def convert_bools(hash)
-        {}.tap do |retval|
-          hash.each do |k, v|
-            retval[k] = case v
-                        when true then 'true'
-                        when false then 'false'
-                        else v.is_a?(Hash) ? convert_bools(v) : v
-                        end
-          end
-        end
-      end
     end
   end
 end

data/lib/nexussw/lxd/rest_api/connection.rb

@@ -1,6 +1,6 @@
-require 'faraday'
-require 'json'
-require 'openssl'
+require "faraday"
+require "json"
+require "openssl"
 
 module NexusSW
   module LXD
@@ -64,8 +64,12 @@ module NexusSW
           api_options[:verify_ssl].nil? ? true : api_options[:verify_ssl]
         end
 
-        def parse_response(response)
-          LXD.symbolize_keys(JSON.parse(response.body))
+        def do_error(code, message)
+          case code
+          when 404 then raise RestAPI::Error::NotFound, message
+          when 400 then raise RestAPI::Error::BadRequest, message
+          else raise RestAPI::Error, "Error #{code}: #{message}"
+          end
         end
 
         def send_request(verb, relative_url, content = nil)
@@ -73,7 +77,7 @@ module NexusSW
           response = connection.send(verb) do |req|
             req.url relative_url
             if content.is_a? Hash
-              req.headers['Content-Type'] = 'application/json'
+              req.headers["Content-Type"] = "application/json"
               req.body = content.to_json
             elsif content # Only upon file upload at this time
               yield req if block_given?
@@ -81,15 +85,15 @@ module NexusSW
               fileop = true
             end
           end
-          if response.status >= 400
-            err = JSON.parse(response.body)
-            case err['error_code']
-            when 404 then raise RestAPI::Error::NotFound, err['error']
-            when 400 then raise RestAPI::Error::BadRequest, err['error']
-            else raise RestAPI::Error, "Error #{err['error_code']}: #{err['error']}"
-            end
+          begin
+            raw = JSON.parse(response.body)
+            raw = raw[0] if raw.is_a? Array
+            do_error(raw["error_code"].to_i, raw["error"]) if response.status >= 400
+            do_error(raw["metadata"]["status_code"].to_i, raw["metadata"]["err"]) if raw["metadata"].is_a?(Hash) && (raw["metadata"]["class"] == "task") && (raw["metadata"]["status_code"] && raw["metadata"]["status_code"].to_i >= 400)
+          rescue JSON::ParserError
+            do_error response.status, "Malformed JSON Response" if response.status >= 400
           end
-          block_given? && !fileop ? yield(response) : parse_response(response)
+          block_given? && !fileop ? yield(response) : LXD.symbolize_keys(raw)
         end
       end
     end

data/lib/nexussw/lxd/transport.rb

@@ -1,5 +1,5 @@
-require 'nexussw/lxd'
-require 'tempfile'
+require "nexussw/lxd"
+require "tempfile"
 
 module NexusSW
   module LXD
@@ -45,10 +45,10 @@ module NexusSW
       end
 
       def self.local_tempdir
-        return ENV['TEMP'] unless !ENV['TEMP'] || ENV['TEMP'].empty?
-        return ENV['TMP'] unless !ENV['TMP'] || ENV['TMP'].empty?
-        return ENV['TMPDIR'] unless !ENV['TMPDIR'] || ENV['TMPDIR'].empty?
-        '/tmp'
+        return ENV["TEMP"] unless !ENV["TEMP"] || ENV["TEMP"].empty?
+        return ENV["TMP"] unless !ENV["TMP"] || ENV["TMP"].empty?
+        return ENV["TMPDIR"] unless !ENV["TMPDIR"] || ENV["TMPDIR"].empty?
+        "/tmp"
       end
 
       def self.chdir_mutex

data/lib/nexussw/lxd/transport/cli.rb

@@ -1,5 +1,5 @@
-require 'nexussw/lxd/transport'
-require 'nexussw/lxd/transport/mixins/cli'
+require "nexussw/lxd/transport"
+require "nexussw/lxd/transport/mixins/cli"
 
 module NexusSW
   module LXD

data/lib/nexussw/lxd/transport/local.rb

@@ -1,5 +1,5 @@
-require 'nexussw/lxd/transport'
-require 'nexussw/lxd/transport/mixins/local'
+require "nexussw/lxd/transport"
+require "nexussw/lxd/transport/mixins/local"
 
 module NexusSW
   module LXD

data/lib/nexussw/lxd/transport/mixins/cli.rb

@@ -1,8 +1,8 @@
-require 'nexussw/lxd/transport/mixins/local'
-require 'nexussw/lxd/transport/mixins/helpers/users'
-require 'nexussw/lxd/transport/mixins/helpers/folder_txfr'
-require 'tempfile'
-require 'shellwords'
+require "nexussw/lxd/transport/mixins/local"
+require "nexussw/lxd/transport/mixins/helpers/users"
+require "nexussw/lxd/transport/mixins/helpers/folder_txfr"
+require "tempfile"
+require "shellwords"
 
 module NexusSW
   module LXD
@@ -38,10 +38,10 @@ module NexusSW
 
           def read_file(path)
             tfile = Transport.remote_tempname(container_name)
-            retval = execute("#{@container_name}#{path} #{tfile}", subcommand: 'file pull', capture: false)
+            retval = execute("#{@container_name}#{path} #{tfile}", subcommand: "file pull", capture: false)
             # return '' if retval.exitstatus == 1
             retval.error!
-            return inner_transport.read_file tfile
+            inner_transport.read_file tfile
           ensure
             inner_transport.execute("rm -rf #{tfile}", capture: false) if tfile
           end
@@ -59,7 +59,7 @@ module NexusSW
           def download_file(path, local_path)
             tfile = Transport.remote_tempname(container_name) if punt
             localname = tfile || local_path
-            execute("#{container_name}#{path} #{localname}", subcommand: 'file pull').error!
+            execute("#{container_name}#{path} #{localname}", subcommand: "file pull").error!
             inner_transport.download_file tfile, local_path if tfile
           ensure
             inner_transport.execute("rm -rf #{tfile}", capture: false) if tfile
@@ -77,19 +77,35 @@ module NexusSW
           end
 
           def upload_folder(local_path, path)
-            return super unless config[:info] && config[:info]['api_extensions'] && config[:info]['api_extensions'].include?('directory_manipulation')
+            return super unless config[:info] && config[:info]["api_extensions"] && config[:info]["api_extensions"].include?("directory_manipulation")
 
-            execute("-r #{local_path} #{container_name}#{path}", subcommand: 'file push', capture: false).error!
+            puntname = local_path
+            if punt
+              tfile = Transport.remote_tempname(container_name)
+              puntname = File.join(tfile, File.basename(local_path))
+              inner_transport.upload_folder(local_path, tfile)
+            end
+            execute("#{puntname} #{container_name}#{path}", subcommand: "file push -r", capture: false).error!
+          ensure
+            inner_transport.execute("rm -rf #{tfile}", capture: false) if tfile
           end
 
           def download_folder(path, local_path, options = {})
-            return super unless config[:info] && config[:info]['api_extensions'] && config[:info]['api_extensions'].include?('directory_manipulation')
+            return super unless config[:info] && config[:info]["api_extensions"] && config[:info]["api_extensions"].include?("directory_manipulation")
 
-            execute("-r #{container_name}#{path} #{local_path}", subcommand: 'file pull', capture: false).error!
+            puntname = local_path
+            if punt
+              tfile = Transport.remote_tempname(container_name)
+              puntname = File.join(tfile, File.basename(path))
+            end
+            execute("#{container_name}#{path} #{tfile || local_path}", subcommand: "file pull -r", capture: false).error!
+            inner_transport.download_folder(puntname, local_path) if punt
+          ensure
+            inner_transport.execute("rm -rf #{tfile}", capture: false) if tfile
           end
 
           def add_remote(host_name)
-            execute("add #{host_name} --accept-certificate", subcommand: 'remote').error! unless remote? host_name
+            execute("add #{host_name} --accept-certificate", subcommand: "remote").error! unless remote? host_name
           end
 
           def linked_transport(host_name)
@@ -100,7 +116,7 @@ module NexusSW
           end
 
           def remote?(host_name)
-            result = execute 'list', subcommand: 'remote'
+            result = execute "list", subcommand: "remote"
             result.error!
             result.stdout.each_line do |line|
               return true if line.start_with? "| #{host_name} "
@@ -111,7 +127,7 @@ module NexusSW
           private
 
           def file_perms(options = {})
-            perms = ''
+            perms = ""
             perms += " --uid=#{options[:uid] || uid || 0}"
             perms += " --gid=#{options[:gid] || gid || 0}"
             fmode = options[:file_mode] || file_mode