redfish_tools 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7feb2c802d0f87e0234e667245ab79eb8fb370583dc7b1203b212facdd02cfbf
-  data.tar.gz: 76c79888c493711b4689c3aaf8dd208542da7df126a57cd5f9ef5e47e38606a5
+  metadata.gz: a4f91c3c5220c2e6d5dcc1629bd45530ab56bbcab6b82dec3434c29392c195dd
+  data.tar.gz: 7a2dc097bb6e566ea3b3a26926dc1a3bb12ab1ffade24013d5bc5b4a08970198
 SHA512:
-  metadata.gz: 88e19d49c2f3e783c4dae7694d2b451e8dc93e1e59e805185eccfa63dbb81c470dc27d8f0fc6900f58c976900645f141f9a5bd79ffd4b29f675026123b8e4239
-  data.tar.gz: 047689712f71f7cde617939e9b64a53331ac767d812df6c933600597b1b0d74989a61396083493a5f6ce34f7b76e6218c8f6c1a28d4de5058ce16a4e085eeeca
+  metadata.gz: ee117d00c3b943b3acfc777563e16651af4e8e03d55fb4e2e647a9e3c22e4d0e254961943dbf9050ac70bf32de7410dce6dc6d0ec837c3159d0560ffcaca2dab
+  data.tar.gz: ab953ed1e9cf94325daeeabeacf4efdbae40992d4b42b7fa1e4ba1515dbe0fd5051e76733a3db1aed95726c476b3dc2c24d1c11d81dafd651fd3629b0b9f3961

data/lib/redfish_tools/cli.rb

@@ -34,13 +34,38 @@ module RedfishTools
     def serve(path)
       user = options[:user]
       pass = options[:pass]
-      raise Thor::Error, "Missing password" if user && pass.nil?
-      raise Thor::Error, "Missing username" if user.nil? && pass
+      raise "Missing password" if user && pass.nil?
+      raise "Missing username" if user.nil? && pass
 
       require "redfish_tools/cli/serve"
       Serve.new(path, options).run
     rescue StandardError => e
       raise Thor::Error, e.to_s
     end
+
+    desc "record SERVICE PATH", "create recording of SERVICE in PATH"
+    long_desc <<-LONGDESC
+      Record a Redfish service content into set of static files and store them
+      on disk. Sample record call:
+
+        $ . password_file
+        $ redfish record https://my.redfish.api:8443 output folder
+
+      Before running this command, make sure REDFISH_USERNAME and
+      REDFISH_PASSWORD environment variables are set. The recommended way of
+      setting them is by writing the assignments down into shell script that
+      can be then sourced as shown in example.
+    LONGDESC
+    def record(service, path)
+      username = ENV["REDFISH_USERNAME"]
+      password = ENV["REDFISH_PASSWORD"]
+      raise "Missing username" if username.nil?
+      raise "Missing password" if password.nil?
+
+      require "redfish_tools/cli/record"
+      Record.new(service, path, username, password).run
+    rescue StandardError => e
+      raise Thor::Error, e.to_s
+    end
   end
 end

data/lib/redfish_tools/cli/record.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "redfish_client"
+require "redfish_tools/recorder"
+
+module RedfishTools
+  class Cli
+    class Record
+      def initialize(service, path, username, password)
+        @service = service
+        @path = path
+        @username = username
+        @password = password
+      end
+
+      def run
+        client = RedfishClient.new(@service, verify: false)
+        client.login(@username, @password)
+        Recorder.new(client, @path).record
+      end
+    end
+  end
+end

data/lib/redfish_tools/recorder.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "json"
+require "set"
+
+module RedfishTools
+  # Recorder represents entry point into mock creation process.
+  class Recorder
+    def initialize(client, disk_path)
+      raise "Directory '#{disk_path}' exists" if File.directory?(disk_path)
+
+      @path = disk_path
+      @client = client
+    end
+
+    def record
+      visited = Set.new
+      batch = Set.new([@client["@odata.id"]])
+
+      until batch.empty?
+        visited.merge(batch)
+        batch = process_oid_batch(batch, visited)
+      end
+    end
+
+    private
+
+    def process_oid_batch(batch, visited)
+      next_batch = Set.new
+      batch.each do |oid|
+        puts("  Recording #{oid}")
+        next_batch.merge(process_oid(oid).subtract(visited))
+      end
+      next_batch
+    end
+
+    def process_oid(oid)
+      start = Time.now
+      resource = @client.find(oid)
+      duration = Time.now - start
+      return Set.new unless resource
+
+      persist_to_disk(oid, resource.raw, resource.headers, duration)
+      extract_oids(resource.raw)
+    end
+
+    def persist_to_disk(oid, body, headers, duration)
+      resource_path = File.join(@path, oid)
+      index_path = File.join(resource_path, "index.json")
+      headers_path = File.join(resource_path, "headers.json")
+      time_path = File.join(resource_path, "time.json")
+
+      FileUtils.mkdir_p(resource_path)
+      write_json(index_path, sanitize(body))
+      write_json(headers_path, "GET" => headers)
+      write_json(time_path, "GET_Time" => duration.to_s)
+    end
+
+    def sanitize(data)
+      case data
+      when Hash then sanitize_hash(data)
+      when Array then data.map { |v| sanitize(v) }
+      else data
+      end
+    end
+
+    def sanitize_hash(data)
+      keys = %w[serialnumber uuid durablename]
+      data.reduce({}) do |acc, (k, v)|
+        v = keys.include?(k.downcase) ? "REMOVED_FROM_MOCK" : sanitize(v)
+        acc.merge!(k => v)
+      end
+    end
+
+    def write_json(path, data)
+      write(path, data.to_json)
+    end
+
+    def write(path, data)
+      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)
+      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
+      end
+    end
+  end
+end

data/lib/redfish_tools/servlet.rb

@@ -39,7 +39,7 @@ module RedfishTools
 
       data = JSON.parse(request.body)
       item_n = login_path?(request) ? login(item, data) : new_item(item, data)
-      return response.status = 400 unless item_n.body
+      return response.status = 400 unless item_n&.body
 
       response.status = 201
       set_headers(response, item_n.headers)

data/lib/redfish_tools/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redfish_tools
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Tadej Borovšak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-20 00:00:00.000000000 Z
+date: 2018-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redfish_client
@@ -129,8 +129,10 @@ files:
 - exe/redfish
 - lib/redfish_tools.rb
 - lib/redfish_tools/cli.rb
+- lib/redfish_tools/cli/record.rb
 - lib/redfish_tools/cli/serve.rb
 - lib/redfish_tools/datastore.rb
+- lib/redfish_tools/recorder.rb
 - lib/redfish_tools/server.rb
 - lib/redfish_tools/servlet.rb
 - lib/redfish_tools/version.rb