redfish_tools 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d8e4fd83aeaa6c8af2e97fce4d2e92802cc97281
-  data.tar.gz: d2e92b0b838758132ba345a45ab6d8c4b423dcf3
+SHA256:
+  metadata.gz: d6eb47b4ce78b595e4465c9efcda2ca2a8700b22257bd039cd4651411b0b5e9d
+  data.tar.gz: d6fb33b3c654c4edd44279bfb107ecbc941d0d456bac7c0652062a88449d9fcd
 SHA512:
-  metadata.gz: f8c3805f96c543a24c787edb52ec70a60ccf097b547e9a6ca87909219f810f091852479ba4237439c2ae146222536f9a30fdc2f814fd3b4491c1d9296ebbf184
-  data.tar.gz: f02fc22a3b4600a5b41621026bf26c98160f6c72665d23290b6df19dd538f209a267fca3ebfd2ece864e76e7840d16dc08f3a9013b5418631726a1bbfd678aa4
+  metadata.gz: b6a62c917f853e1812c9ce2a2266aeebfdcff73d313a92a7b5d1434e596084d8d50eea6a0acf4c05d8935c44326aac2dd75705ff7f05a5fd62ceb2c9cd43d234
+  data.tar.gz: c88535b973f5010dcdd50b9b218882fc45240b63b2a22fb93cffe868bf4e6c9fc3b6601668680cf9c4407ccdb662ab1bff474813e7674319b86746440aaa857e

data/lib/redfish_tools/exceptions.rb

@@ -0,0 +1,7 @@
+module RedfishTools
+  module Exceptions
+    class RedfishServerError < StandardError; end
+
+    class MergeConflict < RedfishServerError; end
+  end
+end

data/lib/redfish_tools/recorder.rb

@@ -36,13 +36,30 @@ module RedfishTools
     end
 
     def process_oid(oid)
-      start = Time.now
-      resource = @client.find(oid)
-      duration = Time.now - start
-      return Set.new unless resource
+      resource, duration = fetch_resource(oid)
+      if resource
+        persist_to_disk(oid, resource.raw, resource.headers, duration)
+        extract_oids(resource.raw)
+      else
+        puts("!!!! FAILED TO FETCH #{oid} !!!!")
+        Set.new
+      end
+    end
 
-      persist_to_disk(oid, resource.raw, resource.headers, duration)
-      extract_oids(resource.raw)
+    def fetch_resource(oid)
+      3.times do
+        begin
+          start = Time.now
+          resource = @client.find(oid)
+          duration = Time.now - start
+          return [resource, duration] if resource
+        rescue JSON::ParserError => e
+          return [nil, nil]
+        end
+
+        sleep(2)
+      end
+      [nil, nil]
     end
 
     def persist_to_disk(oid, body, headers, duration)
@@ -81,18 +98,20 @@ module RedfishTools
       File.open(path, "w") { |f| f.write(data) }
     end
 
-    def extract_oids_from_hash(data)
-      ids = Set.new
-      ids.add(data["@odata.id"]) if data["@odata.id"]
-      data.values.reduce(ids) { |a, v| a.merge(extract_oids(v)) }
-    end
-
     def extract_oids(data)
+      result = Set.new
+
       case data
-      when Hash then extract_oids_from_hash(data)
-      when Array then data.reduce(Set.new) { |a, v| a.merge(extract_oids(v)) }
-      else Set.new
+      when Hash then data.values.each { |v| result.merge(extract_oids(v)) }
+      when Array then data.each { |v| result.merge(extract_oids(v)) }
+      when String then result.add(data) if path?(data)
       end
+
+      result
+    end
+
+    def path?(data)
+      /^\/redfish\/v1\/[^# ]*$/.match(data)
     end
   end
 end

data/lib/redfish_tools/server.rb

@@ -28,13 +28,26 @@ module RedfishTools
         Base64.strict_encode64("#{username}:#{password}")
     end
 
-    def system_actions
+    def actions
       # Hash of action_id => system_id
-      @system_actions ||= load_all_system_actions
+      @actions ||= load_all_actions
+    end
+
+    def systems
+      @systems ||= load_all_system_ids
     end
 
     private
 
+    def load_all_system_ids
+      systems_id = datastore.get("/redfish/v1").body["Systems"]["@odata.id"]
+      datastore.get(systems_id).body["Members"].map { |l| l["@odata.id"] }
+    end
+
+    def load_all_actions
+      load_all_system_actions.merge(load_update_actions)
+    end
+
     def load_all_system_actions
       systems_id = datastore.get("/redfish/v1").body["Systems"]["@odata.id"]
       datastore.get(systems_id).body["Members"].reduce({}) do |acc, link|
@@ -45,7 +58,19 @@ module RedfishTools
     def load_system_actions(id)
       actions = datastore.get(id).body.dig("Actions") || {}
       actions.each_with_object({}) do |(name, data), acc|
-        acc[data["target"]] = { name: name, system_id: id }
+        acc[data["target"]] = { name: name, id: id }
+      end
+    end
+
+    def load_update_actions
+      update_service_id = datastore.get("/redfish/v1").body.dig(
+        "UpdateService", "@odata.id",
+      )
+      return {} if update_service_id.nil?
+
+      actions = datastore.get(update_service_id).body["Actions"] || {}
+      actions.each_with_object({}) do |(name, data), acc|
+        acc[data["target"]] = { name: name, id: update_service_id }
       end
     end
   end

data/lib/redfish_tools/servlet.rb

@@ -5,6 +5,8 @@ require "json"
 require "securerandom"
 require "set"
 require "webrick"
+require "redfish_tools/utils"
+require "redfish_tools/exceptions"
 
 module RedfishTools
   class Servlet < WEBrick::HTTPServlet::AbstractServlet
@@ -12,28 +14,36 @@ module RedfishTools
 
     def_delegators :@server,
                    :datastore, :login_path, :username, :password,
-                   :basic_auth_header, :system_actions
+                   :basic_auth_header, :actions, :systems
 
     BAD_HEADERS = Set.new(["connection", "content-length", "keep-alive"])
     DEFAULT_HEADERS = {
       "content-type" => "application/json"
     }.freeze
     TRANSITIONS = {
-      "On"  => {
-        "GracefullShutdown" => "Off",
-        "ForceOff"          => "Off",
-        "PushPowerButton"   => "Off",
-        "Nmi"               => "Off",
-        "GracefullRestart"  => "On",
-        "ForceRestart"      => "On",
-        "PowerCycle"        => "On",
+      "PoweringOn"  => {}.freeze,
+      "On"          => {
+        "GracefulShutdown" => "Off",
+        "ForceOff"         => "Off",
+        "PushPowerButton"  => "Off",
+        "Nmi"              => "Off",
+        "GracefulRestart"  => "On",
+        "ForceRestart"     => "On",
+        "PowerCycle"       => "On",
       }.freeze,
-      "Off" => {
+      "PoweringOff" => {}.freeze,
+      "Off"         => {
         "On"              => "On",
         "ForceOn"         => "On",
         "PushPowerButton" => "On",
       }.freeze,
     }.freeze
+    TASK_TRANSITIONS = {
+      "New"       => "Starting",
+      "Starting"  => "Running",
+      "Running"   => "Completed",
+      "Completed" => "Completed",
+    }
 
     def service(request, response)
       return response.status = 401 unless authorized?(request)
@@ -46,12 +56,22 @@ module RedfishTools
 
       item = datastore.get(request.path)
       response.status = 200
+
+      if request.path.chomp("/").end_with?("monitor") && item.body["TaskState"]
+        item.body["TaskState"] = TASK_TRANSITIONS[item.body["TaskState"]]
+        response.status = 202
+        if item.body["TaskState"] == "Completed"
+          response.status = 200
+          item.body["EndTime"] = Time.now.utc.iso8601
+        end
+      end
+
       set_headers(response, item.headers)
       response.body = item.body.to_json
     end
 
     def do_POST(request, response)
-      action = system_actions[request.path]
+      action = actions[request.path]
       item = datastore.get(request.path)
       return response.status = 404 unless action || item.body
       return response.status = 405 if action.nil? && item.body["Members"].nil?
@@ -78,8 +98,15 @@ module RedfishTools
       response.status = 501
     end
 
-    def do_PATCH(_request, response)
-      response.status = 501
+    def do_PATCH(request, response)
+      system = datastore.get(request.path)
+      return response.status = 404 unless system.body
+      system.body = Utils.combine_hashes(system.body, JSON.parse(request.body))
+      response.status = 200
+    rescue Exceptions::MergeConflict => error
+      response.status = 405
+      set_headers(response)
+      response.body = error_body(error).to_json
     end
 
     def do_DELETE(request, response)
@@ -97,13 +124,22 @@ module RedfishTools
     end
 
     def execute_action(action, data)
-      # TODO(@tadeboro): This method currently only handles reset action.
-      system = datastore.get(action[:system_id]).body
-      action = system["Actions"][action[:name]]
+      resource = datastore.get(action[:id]).body
+      case action[:name]
+      when "#ComputerSystem.Reset"
+        execute_computer_system_reset(resource, data)
+      when "#UpdateService.SimpleUpdate"
+        execute_update_service_simple_update(resource, data)
+      end
+    end
+
+    def execute_computer_system_reset(system, data)
+      action = system["Actions"]["#ComputerSystem.Reset"]
       reset = data["ResetType"]
 
+      # TODO(@tadeboro): Handle ActionInfo case also.
       unless action["ResetType@Redfish.AllowableValues"].include?(reset)
-        return error_body("Invalid reset type"), nill, 400
+        return error_body("Invalid reset type"), nil, 400
       end
 
       unless TRANSITIONS[system["PowerState"]].key?(reset)
@@ -116,6 +152,37 @@ module RedfishTools
       [error_body("Success"), nil, 200]
     end
 
+    def execute_update_service_simple_update(service, data)
+      action = service["Actions"]["#UpdateService.SimpleUpdate"]
+      proto = data["TransferProtocol"]
+      targets = data["Targets"] || []
+
+      # TODO(@tadeboro): Handle ActionInfo case also.
+      unless action["TransferProtocol@Redfish.AllowableValues"].include?(proto)
+        return error_body("Invalid transfer protocol value"), nil, 400
+      end
+
+      unless (targets - systems).empty?
+        return error_body("Invalid targets: #{targets - systems}"), nil, 400
+      end
+
+      task_service_id = datastore.get("/redfish/v1").body["Tasks"]["@odata.id"]
+      task_col_id = datastore.get(task_service_id).body["Tasks"]["@odata.id"]
+
+      body, _, _ = new_item(datastore.get(task_col_id), {
+        "TaskState" => "New",
+        "StartTime" => Time.new.utc.iso8601,
+      })
+
+      task_monitor_path = body["@odata.id"] + "/monitor"
+      headers = DEFAULT_HEADERS.merge("location" => task_monitor_path)
+
+      body["TaskMonitor"] = task_monitor_path
+      datastore.set(task_monitor_path, body, headers: headers)
+
+      [body, headers, 202]
+    end
+
     def login_path?(path)
       login_path == path.chomp("/")
     end

data/lib/redfish_tools/sse_server.rb

@@ -2,6 +2,7 @@
 
 require "date"
 require "json"
+require "securerandom"
 require "socket"
 
 module RedfishTools
@@ -30,13 +31,20 @@ module RedfishTools
       id = 0
       loop do
         event = @events.sample
-        event["Events"][0]["EventTimestamp"] = DateTime.now.to_s
+        make_events_unique(event["Events"])
         socket.print("id: #{id}\ndata: #{event.to_json}\n\n")
-        sleep(rand(1..10))
+        sleep(rand(1..60))
         id += 1
       end
     ensure
       socket.close
     end
+
+    def make_events_unique(events)
+      events.each do |event|
+        event["EventTimestamp"] = Time.now.utc.to_s
+        event["EventId"] = SecureRandom.uuid
+      end
+    end
   end
 end

data/lib/redfish_tools/utils.rb

@@ -0,0 +1,24 @@
+require "redfish_tools/exceptions"
+
+module RedfishTools
+  module Utils
+    def self.combine_hashes(original, b, path: nil)
+      path ||= []
+      a = original.clone
+      b.each {|key, value|
+        if a.include?(key)
+          if (a[key].is_a? Hash) && (b[key].is_a? Hash)
+            a[key] = combine_hashes(a[key], b[key], path: path + [key.to_s])
+          elsif a[key].is_a? b[key].class
+            a[key] = b[key]
+          else
+            raise Exceptions::MergeConflict, "Conflict at '%s'" % (path + [key.to_s]).join(".")
+          end
+        else
+          raise Exceptions::MergeConflict, "Key '%s' does not exists in source hash" % (path + [key.to_s]).join(".")
+        end
+      }
+      a
+    end
+  end
+end

data/lib/redfish_tools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RedfishTools
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redfish_tools
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Tadej Borovšak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2019-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redfish_client
@@ -148,11 +148,13 @@ files:
 - lib/redfish_tools/cli/serve.rb
 - lib/redfish_tools/cli/serve_sse.rb
 - lib/redfish_tools/datastore.rb
+- lib/redfish_tools/exceptions.rb
 - lib/redfish_tools/recorder.rb
 - lib/redfish_tools/server.rb
 - lib/redfish_tools/servlet.rb
 - lib/redfish_tools/sse_client.rb
 - lib/redfish_tools/sse_server.rb
+- lib/redfish_tools/utils.rb
 - lib/redfish_tools/version.rb
 - redfish_tools.gemspec
 homepage: https://github.com/xlab-si/redfish-tools-ruby
@@ -176,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Collection of tools for working with Redfish services.