redfish_tools 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d591794d6dd81a861a334116e4ddc69d0e583f5f
-  data.tar.gz: b801a69d947f93e521bc9f910727ad03485e5e07
+  metadata.gz: 62d5e62a684fe41e5f66474396da984161869dc0
+  data.tar.gz: 401e723d7f305dd2576e45352e19fe9b5da901e7
 SHA512:
-  metadata.gz: 4c862e78f28fe165dda817dd3ce34a9501ec4ffd0cd511821f8a63dab0658e0e34b60b6cfd69b1367ccf10e7a28a68ea2dbd63147a52bb26105fe8376bc047fd
-  data.tar.gz: 8beb0d8f83e83dbf03f00dade9c78a16d778efd94415f1cafef8cf3dd71405c98ad558c9d93944b9eb7a89db76008c16d8ba568c0238547165c7a44552617d79
+  metadata.gz: 26f1eb827d58a02555259bb9b618ac0444c5483599ffd5b2477e57fe15f4e10559431b3d041a21b2f1684370df60daf0fd73e50135f5f8136528165079fa9663
+  data.tar.gz: 7ec1d90be137f6006b9cf18dd75e622e03d5efccda563ef682200d3954a5a60f43acb8a1ef70f5b65e508e2cd6015d9079d1e18a1aedd988d91e9dc1ee603994

data/.travis.yml

@@ -1,5 +1,14 @@
 sudo: false
 language: ruby
+cache: bundler
 rvm:
-  - 2.4.3
-before_install: gem install bundler -v 1.16.1
+- 2.4.3
+script: true
+deploy:
+  provider: rubygems
+  api_key:
+    secure: r3WiTmAZTHbqi30saYw0Iv2YEUZNAv4dp2RPzDoc7K9l1yV+Pt+fol/NCOg8gVBXPn5WHHrXUpw4jz158CneOPlmp7opdzW8SZymUlphXBl7kcI9qEsDJnqZOAJkj1YVwMvjMwRqE1UjWs43Ok93wVQlt2M9FIztLBXHhKtm+M0T6GpeFisAntgeIYiRl0/XTYr36SG23dTcWogkKEHahX24/W1ap5Z2O+p0wZNyRbhFXMMkvMVqwS6EFn9CR1GuJ2f93WYzsIZWm4LhjDZisAxh4oHtcGfXyOSHTU4d4fOnoBd0H7Ejyf/4mr407gnfSqpuXJUIiTsNPDrlMTGT0l/sSJYPWY6P1nygOTlCd7oLG+E3nOUKD5L0KPdzLkAxqylrNbCFx9dPMfyuT6wUin4XW/NulwCAy7qLrMFn0MuugxZINMJE09dWCMd5B+guMPtmpj7eVerrDi26H7hEO7Mdvg1rmhEfUVLFbiiAOzi3SvHhFYZC7Rr1WFt+8zUxgAUxwuAfAyJX4Zolkj1xcQF1Qssj4g8wAtaQ1ZWhdWWoJjEziJcqZPOIckeB+uuvauXVSd1a8ASsHLBCrnZUYKp6ZOn7a3t5zaoUjUTl4BuPZFfZ0gAqP3YMEmGboeDPFRM4uNk7l5eA5qc0s0HT2wgjYXeL+M2ZmHk5ACInWAw=
+  gem: redfish_tools
+  on:
+    tags: true
+    repo: xlab-si/redfish_tools

data/README.md

@@ -1,16 +1,21 @@
-# RedfishTools
+# Redfish tools
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/redfish_tools`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.com/xlab-si/redfish_tools.svg?branch=master)](https://travis-ci.com/xlab-si/redfish_tools)
+
+
+This repository contains source code for redfish_tools gem that contains tools
+for testing application that know how to work with Redfish API.
+
+The only tool that is currently available is mock server, but in the near
+future, we will also add a mock creator tool and interactive inspector for
+Redfish services.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'redfish_tools'
-```
+    gem "redfish_tools"
 
 And then execute:
 
@@ -20,16 +25,38 @@ Or install it yourself as:
 
     $ gem install redfish_tools
 
+
 ## Usage
 
-TODO: Write usage instructions here
+The simplest way to start using Redfish tools is to simply run the `redfish`
+command and read the provided help. At the moment, the output should look like
+this:
+
+    $ redfish
+    Commands:
+      redfish help [COMMAND]        # Describe available commands
+      redfish serve [OPTIONS] PATH  # serve mock from PATH
+
+To start serving existing Redfish recording, we run the `serve` command:
+
+    $ redfish serve --ssl --user test --pass demo path/to/recording
+
+To get the description of all available options, use `help` command or add
+`-h` flag anywhere in the command.
+
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Unfortunately, this gem contains no tests at the moment, so if you feel like
+contributing, this would be a great place to start.
+
+To create new release, increment the version number, commit the change, tag
+the commit and push tag to the GitHub. Travis CI will pick from there on and
+create new release, publishing it on https://rubygems.org.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/redfish_tools.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/xlab-si/redfish_tools.

data/lib/redfish_tools/cli/serve.rb

@@ -14,8 +14,12 @@ module RedfishTools
       def run
         datastore = RedfishTools::DataStore.new(@path)
         server = RedfishTools::Server.new(datastore,
+                                          @options[:user],
+                                          @options[:pass],
                                           Port: @options[:port],
-                                          BindAddress: @options[:bind])
+                                          BindAddress: @options[:bind],
+                                          SSLEnable: @options[:ssl],
+                                          SSLCertName: [%w[CN localhost]])
         trap("INT") { server.shutdown }
         server.start
       end

data/lib/redfish_tools/cli.rb

@@ -11,6 +11,10 @@ module RedfishTools
       super(args)
     end
 
+    def self.exit_on_failure?
+      true
+    end
+
     desc "serve [OPTIONS] PATH", "serve mock from PATH"
     option :port,
            desc: "port that should be used to serve the mock",
@@ -19,18 +23,24 @@ module RedfishTools
     option :bind,
            desc: "address that server should bind to",
            default: "127.0.0.1"
+    option :ssl,
+           desc: "use SSL",
+           default: false,
+           type: :boolean
+    option :user,
+           desc: "username to use"
+    option :pass,
+           desc: "password to use"
     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
+
       require "redfish_tools/cli/serve"
       Serve.new(path, options).run
-    end
-
-    desc "query [OPTIONS] URL QUERY", "query service at URL using QUERY"
-    def query(url, *query
-
-    desc "record [OPTIONS] URL PATH", "record service at URL"
-    def record(url, path)
-      require "redfish_tools/cli/record"
-      Record.new(url, path, options).run
+    rescue StandardError => e
+      raise Thor::Error, e.to_s
     end
   end
 end

data/lib/redfish_tools/datastore.rb

@@ -7,14 +7,16 @@ module RedfishTools
     Resource = Struct.new(:id, :body, :headers, :time)
 
     def initialize(base_path)
-      # TODO(tadeboro): check for folder and determine mode of operation
       @base_path = File.expand_path(base_path)
       @overlay = {}
+
+      root_file = File.join(@base_path, "redfish", "v1", "index.json")
+      raise "Invalid recording folder" unless File.file?(root_file)
     end
 
     def get(id)
       id = id.chomp("/")
-      @overlay[id] || load_resource(id)
+      @overlay[id] ||= load_resource(id)
     end
 
     def set(id, body, headers: nil, time: nil)
@@ -28,24 +30,21 @@ module RedfishTools
     end
 
     def load_body(id)
-      load(File.join(@base_path, id, "index.json"))
+      load_json(File.join(@base_path, id, "index.json"))
     end
 
     def load_headers(id)
-      load_json(File.join(@base_path, id, "headers.json"))["GET"]
+      headers = load_json(File.join(@base_path, id, "headers.json"))
+      headers && headers["GET"]
     end
 
     def load_time(id)
-      load_json(File.join(@base_path, id, "time.json"))["GET_Time"].to_f
-    end
-
-    def load(path)
-      File.readable?(path) ? File.read(path) : nil
+      times = load_json(File.join(@base_path, id, "time.json"))
+      times && times["GET_Time"]&.to_f
     end
 
     def load_json(path)
-      content = load(path)
-      content ? JSON.parse(content) : {}
+      File.readable?(path) ? JSON.parse(File.read(path)) : nil
     end
   end
 end

data/lib/redfish_tools/server.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "base64"
 require "openssl"
 require "webrick"
 require "webrick/https"
@@ -8,12 +9,23 @@ require "redfish_tools/servlet"
 
 module RedfishTools
   class Server < WEBrick::HTTPServer
-    def initialize(datastore, config = {})
+    def initialize(datastore, username, password, config = {})
       super(config)
 
-      root = JSON.parse(datastore.get("/redfish/v1").body)
-      login_path = root.dig("Links", "Sessions", "@odata.id")
-      mount("/", Servlet, datastore, login_path)
+      @datastore = datastore
+      root = datastore.get("/redfish/v1").body
+      @login_path = root.dig("Links", "Sessions", "@odata.id")&.chomp("/")
+      @username = username
+      @password = password
+
+      mount("/", Servlet)
+    end
+
+    attr_reader :datastore, :login_path, :username, :password
+
+    def basic_auth_header
+      @basic_auth_header ||= "Basic " +
+        Base64.strict_encode64("#{username}:#{password}")
     end
   end
 end

data/lib/redfish_tools/servlet.rb

@@ -1,38 +1,51 @@
 # frozen_string_literal: true
 
+require "forwardable"
+require "json"
+require "securerandom"
 require "set"
 require "webrick"
 
 module RedfishTools
   class Servlet < WEBrick::HTTPServlet::AbstractServlet
+    extend Forwardable
+
+    def_delegators :@server,
+                   :datastore, :login_path, :username, :password,
+                   :basic_auth_header
+
     BAD_HEADERS = Set.new(["connection", "content-length", "keep-alive"])
     DEFAULT_HEADERS = {
       "content-type" => "application/json"
     }.freeze
 
-    def initialize(server, datastore, login_path)
-      super(server)
-      @datastore = datastore
-      @login_path = login_path.chomp("/")
+    def service(request, response)
+      return response.status = 401 unless authorized?(request)
+      return response.status = 404 unless datastore.get(request.path).body
+
+      super
     end
 
     def do_GET(request, response)
-      return response.status = 401 unless authorized?(request)
-
-      resource = @datastore.get(request.path)
-      response.body = resource.body
-      set_headers(response, resource.headers)
-      response.status = response.body ? 200 : 404
+      item = datastore.get(request.path)
+      response.status = 200
+      set_headers(response, item.headers)
+      response.body = item.body.to_json
     end
 
     def do_POST(request, response)
-      return response.status = 401 unless authorized?(request)
+      item = datastore.get(request.path)
+      return response.status = 405 unless item.body["Members"]
 
-      if login_path?(request.path)
-        login(request, response)
-      else
-        response.status = 501
-      end
+      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
+
+      response.status = 201
+      set_headers(response, item_n.headers)
+      response.body = item_n.body.to_json
+    rescue JSON::ParserError
+      response.status = 400
     end
 
     def do_PUT(_request, response)
@@ -49,24 +62,65 @@ module RedfishTools
 
     private
 
-    def login_path?(path)
-      @login_path == path.chomp("/")
+    def login_path?(request)
+      login_path == request.path.chomp("/")
     end
 
-    def login(request, response)
-      credentials = JSON.parse(request.body)
-      response.body = {
-        "Name"        => "User Session",
-        "Description" => "User Session",
-        "UserName"    => credentials["UserName"]
-      }.to_json
-      set_headers(response, DEFAULT_HEADERS.merge("X-Auth-Token" => "dummy"))
-      response.status = 201
+    def login(item, data)
+      user = data["UserName"]
+      pass = data["Password"]
+      return nil unless username == user && password == pass
+
+      res = new_item(item,
+                     "@odata.type" => "#Session.v1_1_0.Session",
+                     "UserName"    => user,
+                     "Password"    => nil)
+      res.headers = DEFAULT_HEADERS.merge("X-Auth-Token" => res.body["Id"])
+      res
+    end
+
+    def new_item(item, data)
+      id = SecureRandom.uuid
+      oid = item.id.chomp("/") + "/" + id
+      item.body["Members@odata.count"] += 1
+      item.body["Members"].push("@odata.id" => oid)
+
+      base = { "@odata.id" => oid, "Id" => id, "Name" => id }
+      datastore.set(id, base.merge(data))
+    end
+
+    def authorized?(request)
+      username.nil? || # Server has no credentials set
+        always_allow?(request.path) || # Non-protected endpoints
+        authorized_basic?(request) ||
+        authorized_session?(request) ||
+        (request.request_method == "POST" && login_path?(request))
+    end
+
+    def always_allow?(path)
+      [
+        "/redfish",
+        "/redfish/v1",
+        "/redfish/v1/$metadata",
+        "/redfish/v1/odata"
+      ].include?(path.chomp("/"))
+    end
+
+    def authorized_basic?(request)
+      request["authorization"] == basic_auth_header
+    end
+
+    def authorized_session?(request)
+      return false if login_path.nil? || request["X-Auth-Token"].nil?
+      remove_stale_sessions
+      datastore.get(login_path).body["Members"].any? do |session|
+        session["@odata.id"].index(request["X-Auth-Token"])
+      end
     end
 
-    def authorized?(_request)
-      # TODO(tadeboro): Add checks as per Redfish standard
-      true
+    def remove_stale_sessions
+      # TODO(tadeboro): implement session expiration
+      nil
     end
 
     def set_headers(response, headers)

data/lib/redfish_tools/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redfish_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Tadej Borovšak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-12 00:00:00.000000000 Z
+date: 2018-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redfish_client