inferno_core 0.0.3 → 0.0.7

data/lib/inferno/db/schema.rb

@@ -0,0 +1,154 @@
+Sequel.migration do
+  change do
+    create_table(:schema_info) do
+      Integer :version, :default=>0, :null=>false
+    end
+    
+    create_table(:test_sessions) do
+      String :id, :size=>255, :null=>false
+      String :test_suite_id, :size=>255
+      DateTime :created_at, :null=>false
+      DateTime :updated_at, :null=>false
+      
+      primary_key [:id]
+    end
+    
+    create_table(:session_data, :ignore_index_errors=>true) do
+      String :id, :size=>255, :null=>false
+      foreign_key :test_session_id, :test_sessions, :type=>String, :size=>255
+      String :name, :size=>255
+      String :value, :text=>true
+      
+      index [:id], :unique=>true
+      index [:test_session_id]
+      index [:test_session_id, :name], :unique=>true
+    end
+    
+    create_table(:test_runs, :ignore_index_errors=>true) do
+      String :id, :size=>255, :null=>false
+      String :status, :size=>255
+      foreign_key :test_session_id, :test_sessions, :type=>String, :size=>255
+      String :test_suite_id, :size=>255
+      String :test_group_id, :size=>255
+      String :test_id, :size=>255
+      DateTime :created_at, :null=>false
+      DateTime :updated_at, :null=>false
+      String :identifier, :text=>true
+      DateTime :wait_timeout
+      
+      primary_key [:id]
+      
+      index [:status, :identifier, :wait_timeout, :updated_at]
+      index [:test_group_id]
+      index [:test_id]
+      index [:test_session_id]
+      index [:test_session_id, :status]
+      index [:test_suite_id]
+    end
+    
+    create_table(:results, :ignore_index_errors=>true) do
+      String :id, :size=>255, :null=>false
+      foreign_key :test_run_id, :test_runs, :type=>String, :size=>255
+      foreign_key :test_session_id, :test_sessions, :type=>String, :size=>255
+      String :result, :size=>255
+      String :result_message, :size=>255
+      String :test_suite_id, :size=>255
+      String :test_group_id, :size=>255
+      String :test_id, :size=>255
+      DateTime :created_at, :null=>false
+      DateTime :updated_at, :null=>false
+      String :input_json, :text=>true
+      String :output_json, :text=>true
+      
+      primary_key [:id]
+      
+      index [:test_run_id]
+      index [:test_run_id, :updated_at]
+      index [:test_session_id]
+      index [:test_session_id, :test_group_id]
+      index [:test_session_id, :test_id]
+      index [:test_session_id, :test_suite_id]
+    end
+    
+    create_table(:messages, :ignore_index_errors=>true) do
+      primary_key :index
+      String :id, :size=>255, :null=>false
+      foreign_key :result_id, :results, :type=>String, :size=>255
+      String :type, :size=>255
+      String :message, :size=>255
+      DateTime :created_at, :null=>false
+      DateTime :updated_at, :null=>false
+      
+      index [:id]
+      index [:result_id]
+    end
+    
+    create_table(:requests, :ignore_index_errors=>true) do
+      primary_key :index
+      String :id, :size=>255, :null=>false
+      String :verb, :size=>255
+      String :url, :size=>255
+      String :direction, :size=>255
+      Integer :status
+      String :name, :size=>255
+      String :request_body, :text=>true
+      String :response_body, :text=>true
+      foreign_key :result_id, :results, :type=>String, :size=>255
+      foreign_key :test_session_id, :test_sessions, :type=>String, :size=>255
+      String :"[:test_session_id, :name]"
+      DateTime :created_at, :null=>false
+      DateTime :updated_at, :null=>false
+      
+      index [:id]
+      index [:result_id]
+      index [:test_session_id]
+    end
+    
+    create_table(:result_outputs, :ignore_index_errors=>true) do
+      String :id, :size=>255, :null=>false
+      foreign_key :result_id, :results, :type=>String, :size=>255
+      String :test_output_id, :size=>255
+      String :value, :size=>255
+      DateTime :created_at, :null=>false
+      DateTime :updated_at, :null=>false
+      
+      primary_key [:id]
+      
+      index [:result_id]
+    end
+    
+    create_table(:result_prompt_values, :ignore_index_errors=>true) do
+      String :id, :size=>255, :null=>false
+      foreign_key :result_id, :results, :type=>String, :size=>255
+      String :test_prompt_id, :size=>255, :null=>false
+      String :value, :size=>255, :null=>false
+      DateTime :created_at, :null=>false
+      DateTime :updated_at, :null=>false
+      
+      primary_key [:id]
+      
+      index [:result_id]
+    end
+    
+    create_table(:headers, :ignore_index_errors=>true) do
+      String :id, :size=>255, :null=>false
+      foreign_key :request_id, :requests, :type=>String, :size=>255
+      String :type, :size=>255
+      String :name, :size=>255
+      String :value, :size=>255
+      DateTime :created_at, :null=>false
+      DateTime :updated_at, :null=>false
+      
+      index [:id]
+      index [:request_id]
+    end
+    
+    create_table(:requests_results, :ignore_index_errors=>true) do
+      foreign_key :results_id, :results, :type=>String, :size=>255, :null=>false
+      foreign_key :requests_id, :requests, :type=>String, :size=>255, :null=>false
+      
+      index [:requests_id]
+      index [:results_id]
+    end
+  end
+end

data/lib/inferno/dsl/assertions.rb

@@ -3,22 +3,43 @@ require_relative '../exceptions'
 module Inferno
   module DSL
     module Assertions
+      # Make an assertion
+      #
+      # @param test a value whose truthiness will determine whether the
+      #   assertion passes or fails
+      # @param message [String] failure message
       def assert(test, message = '')
         raise Exceptions::AssertionException, message unless test
       end
 
+      # @private
       def bad_response_status_message(expected, received)
         "Bad response status: expected #{Array.wrap(expected).join(', ')}, but received #{received}"
       end
 
+      # Check an response's status
+      #
+      # @param status [Integer, Array<Integer>] a single integer or an array of
+      #   integer status codes
+      # @param response [Hash]
       def assert_response_status(status, response: self.response)
         assert Array.wrap(status).include?(response[:status]), bad_response_status_message(status, response[:status])
       end
 
+      # @private
       def bad_resource_type_message(expected, received)
         "Bad resource type received: expected #{expected}, but received #{received}"
       end
 
+      # Check a FHIR resource's type
+      #
+      # @param resource_type [String, Symbol, Class]
+      # @param resource [FHIR::Model]
+      # @example
+      #   # The resource type can be a symbol, String, or FHIR::Model class
+      #   assert_resource_type(:capability_statement)
+      #   assert_resource_type('CapabilityStatement')
+      #   assert_resource_type(FHIR::CapabilityStatement)
       def assert_resource_type(resource_type, resource: self.resource)
         resource_type_name = normalize_resource_type(resource_type)
 
@@ -26,15 +47,48 @@ module Inferno
                bad_resource_type_message(resource_type_name, resource&.resourceType)
       end
 
+      # @private
       def invalid_resource_message(profile_url)
         "Resource does not conform to the profile: #{profile_url}"
       end
 
+      # Validate a FHIR resource
+      #
+      # @param resource [FHIR::Model]
+      # @param profile_url [String] url of the profile to validate against,
+      #   defaults to validating against the base FHIR resource
       def assert_valid_resource(resource: self.resource, profile_url: nil)
         assert resource_is_valid?(resource: resource, profile_url: profile_url),
                invalid_resource_message(profile_url)
       end
 
+      # Validate each entry of a Bundle
+      #
+      # @param bundle [FHIR::Bundle]
+      # @param resource_types
+      # [String,Symbol,FHIR::Model,Array<String,Symbol,FHIR::Model>,Hash] If a
+      #   string, symbol, or FHIR::Model is provided, only that resource type
+      #   will be validated. If an array of strings is provided, only those
+      #   resource types will be validated. If a hash is provided with resource
+      #   types as keys and profile urls (or nil) as values, only those resource
+      #   types will be validated against the provided profile url or the base
+      #   resource if nil.
+      # @example
+      #   # Only validate Patient bundle entries
+      #   assert_valid_bundle_entries(resource_types: 'Patient')
+      #
+      #   # Only valiadte Patient and Condition bundle entries
+      #   assert_valid_bundle_entries(resource_types: ['Patient', 'Condition'])
+      #
+      #   # Only validate Patient and Condition bundle entries. Validate Patient
+      #   # resources against the given profile, and Codition resources against the
+      #   # base FHIR Condition resource.
+      #   assert_valid_bundle_entries(
+      #     resource_types: {
+      #       'Patient': 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient',
+      #       'Condition': nil
+      #     }
+      #   )
       def assert_valid_bundle_entries(bundle: resource, resource_types: {})
         assert_resource_type('Bundle', resource: bundle)
 
@@ -56,6 +110,7 @@ module Inferno
         assert invalid_resources.empty?, invalid_bundle_entries_message(invalid_resources)
       end
 
+      # @private
       def invalid_bundle_entries_message(invalid_resources)
         identifier_strings =
           invalid_resources
@@ -64,6 +119,7 @@ module Inferno
         "The following bundle entries are invalid: #{identifier_strings}"
       end
 
+      # @private
       def normalize_resource_type(resource_type)
         if resource_type.is_a? Class
           resource_type.name.demodulize
@@ -72,6 +128,7 @@ module Inferno
         end
       end
 
+      # @private
       def normalize_types_to_check(resource_types)
         case resource_types
         when Hash
@@ -83,11 +140,39 @@ module Inferno
         end
       end
 
+      # Check for valid JSON
+      #
+      # @param maybe_json_string [String]
+      # @param message [String] extra failure message
       def assert_valid_json(maybe_json_string, message = '')
         assert JSON.parse(maybe_json_string)
       rescue JSON::ParserError
         assert false, "Invalid JSON. #{message}"
       end
+
+      # Check for a valid http/https uri
+      #
+      # @param uri [String]
+      # @param message [String] custom failure message
+      def assert_valid_http_uri(uri, message = '')
+        error_message = message.presence || "\"#{uri}\" is not a valid URI"
+        assert uri =~ /\A#{URI::DEFAULT_PARSER.make_regexp(['http', 'https'])}\z/, error_message
+      end
+
+      def assert_response_content_type(type, request: self.request)
+        header = request.response_header('Content-Type')
+        assert header.present?, no_content_type_message
+
+        assert header.value.start_with?(type), bad_content_type_message(type, header.value)
+      end
+
+      def no_content_type_message
+        'Response did not contain a `Content-Type` header.'
+      end
+
+      def bad_content_type_message(expected, received)
+        "Expected `Content-Type` to be `#{expected}`, but found `#{received}`"
+      end
     end
   end
 end

data/lib/inferno/dsl/configurable.rb

@@ -0,0 +1,126 @@
+module Inferno
+  module DSL
+    # This module contains the DSL for managing runnable configuration.
+    module Configurable
+      def self.extended(klass)
+        klass.extend Forwardable
+        klass.def_delegator 'self.class', :config
+      end
+
+      def config(new_configuration = {})
+        @config ||= Configuration.new
+
+        return @config if new_configuration.blank?
+
+        @config.apply(new_configuration)
+      end
+
+      # @private
+      class Configuration
+        attr_accessor :configuration
+
+        def initialize(configuration = {})
+          self.configuration = configuration
+        end
+
+        def apply(new_configuration)
+          config_to_apply =
+            if new_configuration.is_a? Configuration
+              new_configuration.configuration
+            else
+              new_configuration
+            end
+
+          self.configuration = configuration.deep_merge(config_to_apply)
+        end
+
+        def options
+          configuration[:options] ||= {}
+        end
+
+        ### Input Configuration ###
+
+        def inputs
+          configuration[:inputs] ||= {}
+        end
+
+        def add_input(identifier, new_config = {})
+          existing_config = input_config(identifier) || {}
+          inputs[identifier] = default_input_config(identifier).merge(existing_config, new_config)
+        end
+
+        def default_input_config(identifier)
+          { name: identifier, type: 'text' }
+        end
+
+        def input_config_exists?(identifier)
+          inputs.key? identifier
+        end
+
+        def input_config(identifier)
+          inputs[identifier]
+        end
+
+        def input_name(identifier)
+          inputs.dig(identifier, :name) || identifier
+        end
+
+        ### Output Configuration ###
+
+        def outputs
+          configuration[:outputs] ||= {}
+        end
+
+        def add_output(identifier)
+          return if output_config_exists?(identifier)
+
+          outputs[identifier] = default_output_config(identifier)
+        end
+
+        def default_output_config(identifier)
+          { name: identifier }
+        end
+
+        def output_config_exists?(identifier)
+          outputs.key? identifier
+        end
+
+        def output_config(identifier)
+          outputs[identifier]
+        end
+
+        def output_name(identifier)
+          outputs.dig(identifier, :name) || identifier
+        end
+
+        ### Request Configuration ###
+
+        def requests
+          configuration[:requests] ||= {}
+        end
+
+        def add_request(identifier)
+          return if request_config_exists?(identifier)
+
+          requests[identifier] = default_request_config(identifier)
+        end
+
+        def default_request_config(identifier)
+          { name: identifier }
+        end
+
+        def request_config_exists?(identifier)
+          requests.key? identifier
+        end
+
+        def request_config(identifier)
+          requests[identifier]
+        end
+
+        def request_name(identifier)
+          requests.dig(identifier, :name) || identifier
+        end
+      end
+    end
+  end
+end

data/lib/inferno/dsl/fhir_client.rb

@@ -35,7 +35,7 @@ module Inferno
     # @see Inferno::FHIRClientBuilder Documentation for the client
     #   configuration DSL
     module FHIRClient
-      # @api private
+      # @private
       def self.included(klass)
         klass.extend ClassMethods
         klass.extend Forwardable
@@ -54,7 +54,7 @@ module Inferno
           FHIRClientBuilder.new.build(self, self.class.fhir_client_definitions[client])
       end
 
-      # @api private
+      # @private
       def fhir_clients
         @fhir_clients ||= {}
       end
@@ -69,12 +69,14 @@ module Inferno
       # @param client [Symbol]
       # @param name [Symbol] Name for this request to allow it to be used by
       #   other tests
-      # @param _options [Hash] TODO
+      # @option options [Hash]  Input headers here - headers are optional and
+      #   must be entered as the last piece of input to this method
       # @return [Inferno::Entities::Request]
-      def fhir_operation(path, body: nil, client: :default, name: nil, **_options)
+      def fhir_operation(path, body: nil, client: :default, name: nil, **options)
         store_request('outgoing', name) do
           headers = fhir_client(client).fhir_headers
           headers.merge!('Content-Type' => 'application/fhir+json') if body.present?
+          headers.merge!(options[:headers]) if options[:headers].present?
           fhir_client(client).send(:post, path, body, headers)
         end
       end
@@ -126,13 +128,13 @@ module Inferno
 
       # @todo Make this a FHIR class method? Something like
       #   FHIR.class_for(resource_type)
-      # @api private
+      # @private
       def fhir_class_from_resource_type(resource_type)
         FHIR.const_get(resource_type.to_s.camelize)
       end
 
       module ClassMethods
-        # @api private
+        # @private
         def fhir_client_definitions
           @fhir_client_definitions ||= {}
         end

data/lib/inferno/dsl/fhir_client_builder.rb

@@ -6,7 +6,7 @@ module Inferno
     class FHIRClientBuilder
       attr_accessor :runnable
 
-      # @api private
+      # @private
       def build(runnable, block)
         self.runnable = runnable
         instance_exec(self, &block)
@@ -14,6 +14,7 @@ module Inferno
         FHIR::Client.new(url).tap do |client|
           client.additional_headers = headers if headers
           client.default_json
+          client.set_bearer_token bearer_token if bearer_token
         end
       end
 
@@ -32,6 +33,21 @@ module Inferno
           end
       end
 
+      # Define the bearer token for a client. A string or symbol can be provided.
+      # A string is interpreted as a token. A symbol is interpreted as the name of
+      # an input to the Runnable.
+      #
+      # @param bearer_token [String, Symbol]
+      # @return [void]
+      def bearer_token(bearer_token = nil)
+        @bearer_token ||=
+          if bearer_token.is_a? Symbol
+            runnable.send(bearer_token)
+          else
+            bearer_token
+          end
+      end
+
       # Define custom headers for a client
       #
       # @param headers [Hash]
@@ -40,14 +56,14 @@ module Inferno
         @headers ||= headers
       end
 
-      # @api private
+      # @private
       def method_missing(name, *args, &block)
         return runnable.call(name, *args, &block) if runnable.respond_to? name
 
         super
       end
 
-      # @api private
+      # @private
       def respond_to_missing?(name)
         runnable.respond_to?(name) || super
       end

data/lib/inferno/dsl/fhir_validation.rb

@@ -89,7 +89,7 @@ module Inferno
       end
 
       module ClassMethods
-        # @api private
+        # @private
         def fhir_validators
           @fhir_validators ||= {}
         end

data/lib/inferno/dsl/http_client.rb

@@ -16,7 +16,7 @@ module Inferno
     #         # performs a GET to https://example.com
     #         get
     #         # performs a GET to https://example.com/abc
-    #          get('abc')
+    #         get('abc')
     #
     #         request  # the most recent request
     #         response # the most recent response
@@ -27,7 +27,7 @@ module Inferno
     # @see Inferno::FHIRClientBuilder Documentation for the client
     #   configuration DSL
     module HTTPClient
-      # @api private
+      # @private
       def self.included(klass)
         klass.extend ClassMethods
         klass.include RequestStorage
@@ -47,7 +47,7 @@ module Inferno
         http_clients[client] = HTTPClientBuilder.new.build(self, definition)
       end
 
-      # @api private
+      # @private
       def http_clients
         @http_clients ||= {}
       end
@@ -60,16 +60,17 @@ module Inferno
       # @param client [Symbol]
       # @param name [Symbol] Name for this request to allow it to be used by
       #   other tests
-      # @param _options [Hash] TODO
+      # @option options [Hash] Input headers here - headers are optional and
+      #   must be entered as the last piece of input to this method
       # @return [Inferno::Entities::Request]
-      def get(url = '', client: :default, name: nil, **_options)
+      def get(url = '', client: :default, name: nil, **options)
         store_request('outgoing', name) do
           client = http_client(client)
 
           if client
-            client.get(url)
+            client.get(url, nil, options[:headers])
           elsif url.match?(%r{\Ahttps?://})
-            Faraday.get(url)
+            Faraday.get(url, nil, options[:headers])
           else
             raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
           end
@@ -85,16 +86,17 @@ module Inferno
       # @param client [Symbol]
       # @param name [Symbol] Name for this request to allow it to be used by
       #   other tests
-      # @param _options [Hash] TODO
+      # @option options [Hash] Input headers here - headers are optional and
+      #   must be entered as the last piece of input to this method
       # @return [Inferno::Entities::Request]
-      def post(url = '', body: nil, client: :default, name: nil, **_options)
+      def post(url = '', body: nil, client: :default, name: nil, **options)
         store_request('outgoing', name) do
           client = http_client(client)
 
           if client
-            client.post(url, body)
+            client.post(url, body, options[:headers])
           elsif url.match?(%r{\Ahttps?://})
-            Faraday.post(url, body)
+            Faraday.post(url, body, options[:headers])
           else
             raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
           end
@@ -102,7 +104,7 @@ module Inferno
       end
 
       module ClassMethods
-        # @api private
+        # @private
         def http_client_definitions
           @http_client_definitions ||= {}
         end

data/lib/inferno/dsl/http_client_builder.rb

@@ -4,7 +4,7 @@ module Inferno
     class HTTPClientBuilder
       attr_accessor :runnable
 
-      # @api private
+      # @private
       def build(runnable, block)
         self.runnable = runnable
         instance_exec(self, &block)
@@ -38,14 +38,14 @@ module Inferno
         @headers ||= headers
       end
 
-      # @api private
+      # @private
       def method_missing(name, *args, &block)
         return runnable.call(name, *args, &block) if runnable.respond_to? name
 
         super
       end
 
-      # @api private
+      # @private
       def respond_to_missing?(name)
         runnable.respond_to?(name) || super
       end