inferno_core 0.1.0 → 0.1.1.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b9bcb584c21004b00bc1ebb9fa2cce3b89f55bd7cb8f1565a9a29242e293e2b
-  data.tar.gz: b8a2e7ad09a42bb802289859ca6d48ba1c5473cd0553230a53563063b44c2194
+  metadata.gz: 70e3295132f61902fb03d7dcfc6fd3f8593b9cdfb5dd5079a1ae7fe92d6c165c
+  data.tar.gz: a3d26fbdbb272907f5f244d90971a5496466419d4204201cc21762bf6939f7ff
 SHA512:
-  metadata.gz: 51d1cfeeed361f0b1647568ed179b9f45eeadb26b635d21fbd59a8d314f9a85141fd8e64d4dce5453fde0d61866b0c55fb6dcac9529caf379af507f7cefaa20c
-  data.tar.gz: a9479200fa536bf1031d03f47dfda90885caa4135a5aa195de74d9302b2dd8a3ebfefa3ad6b0a265fa24d29bc3ac40fde3ec0e32089cd085a8648dc6ce73274c
+  metadata.gz: 01cd288246ed891b29f77fd9cfeb57acd35e41fc894c164dba372e1317e3a2d3e8c0a59f3d1f5f62b528c457de0cde9aeb60b6c620387b42889121026570c803
+  data.tar.gz: dd3664cc7873ffc8a998a04409632a3a53424b964e189bd5b0918cc8d372a76cdc161e1b0515a54012b43b6f787b79f60b1d1d2b1511ee97187a28c66efcbd6f

data/lib/inferno/apps/web/serializers/result.rb

@@ -16,6 +16,7 @@ module Inferno
         field :result_message, if: :field_present?
         field :created_at
         field :updated_at
+        field :optional?, name: :optional
 
         field :outputs do |result, _options|
           result.output_json.present? ? JSON.parse(result.output_json) : []

data/lib/inferno/apps/web/serializers/test.rb

@@ -4,10 +4,14 @@ module Inferno
       class Test < Serializer
         identifier :id
         field :title
+        field :short_title
         field :input_definitions, name: :inputs, extractor: HashValueExtractor, blueprint: Input
         field :output_definitions, name: :outputs, extractor: HashValueExtractor
         field :description
+        field :short_description
+        field :input_instructions
         field :user_runnable?, name: :user_runnable
+        field :optional?, name: :optional
       end
     end
   end

data/lib/inferno/apps/web/serializers/test_group.rb

@@ -5,10 +5,14 @@ module Inferno
         identifier :id
 
         field :title
+        field :short_title
         field :description
+        field :short_description
+        field :input_instructions
         field :test_count
         field :run_as_group?, name: :run_as_group
         field :user_runnable?, name: :user_runnable
+        field :optional?, name: :optional
 
         association :groups, name: :test_groups, blueprint: TestGroup
         association :tests, blueprint: Test

data/lib/inferno/apps/web/serializers/test_suite.rb

@@ -5,7 +5,10 @@ module Inferno
         view :summary do
           identifier :id
           field :title
+          field :short_title
           field :description
+          field :short_description
+          field :input_instructions
           field :test_count
         end
 

data/lib/inferno/dsl/fhir_client.rb

@@ -131,6 +131,20 @@ module Inferno
         end
       end
 
+      # Perform a FHIR delete interaction.
+      #
+      # @param resource_type [String, Symbol, Class]
+      # @param id [String]
+      # @param client [Symbol]
+      # @param name [Symbol] Name for this request to allow it to be used by
+      #   other tests
+      # @return [Inferno::Entities::Request]
+      def fhir_delete(resource_type, id, client: :default, name: nil)
+        store_request('outgoing', name) do
+          fhir_client(client).destroy(fhir_class_from_resource_type(resource_type), id)
+        end
+      end
+
       # @todo Make this a FHIR class method? Something like
       #   FHIR.class_for(resource_type)
       # @api private

data/lib/inferno/dsl/http_client.rb

@@ -103,6 +103,68 @@ module Inferno
         end
       end
 
+      # Perform an HTTP DELETE request
+      #
+      # @param url [String] if this request is using a defined client, this will
+      #   be appended to the client's url. Must be an absolute url for requests
+      #   made without a defined client
+      # @param client [Symbol]
+      # @param name [Symbol] Name for this request to allow it to be used by
+      #   other tests
+      # @return [Inferno::Entities::Request]
+      def delete(url = '', client: :default, name: :nil, **options)
+        store_request('outgoing', name) do
+          client = http_client(client)
+
+          if client
+            client.delete(url, nil, options[:headers])
+          elsif url.match?(%r{\Ahttps?://})
+            Faraday.delete(url, nil, options[:headers])
+          else
+            raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
+          end
+        end
+      end
+
+      # Perform an HTTP GET request and stream the response
+      #
+      # @param block [Proc] A Proc object whose input will be the string chunks
+      #   received while streaming response to the get request.
+      # @param url [String] If this request is using a defined client, this will
+      #   be appended to the client's url. Must be an absolute url for requests
+      #   made without a defined client
+      # @param limit [Integer] The number of streamed-in chunks to be stored in
+      #   the response body. This optional input defaults to 100.
+      # @param client [Symbol]
+      # @param name [Symbol] Name for this request to allow it to be used by
+      #   other tests
+      # @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 stream(block, url = '', limit = 100, client: :default, name: nil, **options)
+        streamed = []
+
+        collector = proc do |chunk, bytes|
+          streamed << chunk if limit.positive?
+          limit -= 1
+          block.call(chunk, bytes)
+        end
+
+        store_request('outgoing', name) do
+          client = http_client(client)
+
+          if client
+            response = client.get(url, nil, options[:headers]) { |req| req.options.on_data = collector }
+          elsif url.match?(%r{\Ahttps?://})
+            response = Faraday.get(url, nil, options[:headers]) { |req| req.options.on_data = collector }
+          else
+            raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
+          end
+          response.env.body = streamed.join
+          response
+        end
+      end
+
       module ClassMethods
         # @private
         def http_client_definitions

data/lib/inferno/dsl/runnable.rb

@@ -85,7 +85,6 @@ module Inferno
 
         klass.parent = self
 
-        child_metadata[:collection] << klass
         children << klass
 
         configure_child_class(klass, hash_args)
@@ -164,6 +163,8 @@ module Inferno
 
         klass.config(config)
 
+        klass.children.select!(&:required?) if hash_args.delete(:exclude_optional)
+
         hash_args.each do |key, value|
           if value.is_a? Array
             klass.send(key, *value)
@@ -212,6 +213,16 @@ module Inferno
         @title = new_title
       end
 
+      # Set/Get a runnable's short title
+      #
+      # @param new_short_title [String]
+      # @return [String] the short title
+      def short_title(new_short_title = nil)
+        return @short_title if new_short_title.nil?
+
+        @short_title = new_short_title
+      end
+
       # Set/Get a runnable's description
       #
       # @param new_description [String]
@@ -222,6 +233,26 @@ module Inferno
         @description = format_markdown(new_description)
       end
 
+      # Set/Get a runnable's short one-sentence description
+      #
+      # @param new_short_description [String]
+      # @return [String] the one-sentence description
+      def short_description(new_short_description = nil)
+        return @short_description if new_short_description.nil?
+
+        @short_description = format_markdown(new_short_description)
+      end
+
+      # Set/Get a runnable's input instructions
+      #
+      # @param new_input_instructions [String]
+      # @return [String] the input instructions
+      def input_instructions(new_input_instructions = nil)
+        return @input_instructions if new_input_instructions.nil?
+
+        @input_instructions = format_markdown(new_input_instructions)
+      end
+
       # Define inputs
       #
       # @param identifier [Symbol] identifier for the input
@@ -252,6 +283,40 @@ module Inferno
         end
       end
 
+      # Mark as optional. Tests are required by default.
+      #
+      # @param optional [Boolean]
+      # @return [void]
+      #
+      def optional(optional = true) # rubocop:disable Style/OptionalBooleanParameter
+        @optional = optional
+      end
+
+      # Mark as required
+      #
+      # Tests are required by default. This method is provided to make an
+      # existing optional test required.
+      #
+      # @param required[Boolean]
+      # @return [void]
+      def required(required = true) # rubocop:disable Style/OptionalBooleanParameter
+        @optional = !required
+      end
+
+      # The test or group is optional if true
+      #
+      # @return [Boolean]
+      def optional?
+        !!@optional
+      end
+
+      # The test or group is required if true
+      #
+      # @return [Boolean]
+      def required?
+        !optional?
+      end
+
       # Define outputs
       #
       # @param identifier [Symbol] identifier for the output
@@ -407,6 +472,7 @@ module Inferno
         required_inputs.map(&:to_s) - submitted_inputs.map { |input| input[:name] }
       end
 
+      # @private
       def user_runnable?
         @user_runnable ||= parent.nil? ||
                            !parent.respond_to?(:run_as_group?) ||

data/lib/inferno/entities/has_runnable.rb

@@ -0,0 +1,26 @@
+module Inferno
+  module Entities
+    module HasRunnable
+      # Returns the Test, TestGroup, or TestSuite associated with this entity
+      #
+      # @return [Inferno::Entities::Test, Inferno::Entities::TestGroup, Inferno::Entities::TestSuite]
+      def runnable
+        return @runnable if @runnable
+
+        @runnable = (test || test_group || test_suite || load_runnable)
+      end
+
+      private
+
+      def load_runnable
+        if test_id.present?
+          @test = Inferno::Repositories::Tests.new.find(test_id)
+        elsif test_group_id.present?
+          @test_group = Inferno::Repositories::TestGroups.new.find(test_group_id)
+        elsif test_suite_id.present?
+          @test_suite = Inferno::Repositories::TestSuites.new.find(test_suite_id)
+        end
+      end
+    end
+  end
+end

data/lib/inferno/entities/result.rb

@@ -47,9 +47,10 @@ module Inferno
         :test_session_id, :result, :result_message, :messages, :requests,
         :input_json, :output_json
       ].freeze
-      RESULT_OPTIONS = ['cancel', 'wait', 'running', 'error', 'fail', 'skip', 'omit', 'pass'].freeze
+      RESULT_OPTIONS = ['cancel', 'wait', 'running', 'error', 'fail', 'skip', 'pass', 'omit'].freeze
 
       include Inferno::Entities::Attributes
+      include Inferno::Entities::HasRunnable
 
       def initialize(params)
         super(params, ATTRIBUTES - [:messages, :requests])
@@ -58,9 +59,12 @@ module Inferno
         @requests = (params[:requests] || []).map { |request| Request.new(request) }
       end
 
-      # @return [Inferno::Entities::Test, Inferno::Entities::TestGroup, Inferno::Entities::TestSuite]
-      def runnable
-        test || test_group || test_suite
+      def optional?
+        runnable.optional?
+      end
+
+      def required?
+        !optional?
       end
 
       # @return [Boolean]

data/lib/inferno/entities/test_group.rb

@@ -32,11 +32,11 @@ module Inferno
         end
 
         def groups
-          @groups ||= []
+          children.select { |child| child < Inferno::Entities::TestGroup }
         end
 
         def tests
-          @tests ||= []
+          children.select { |child| child < Inferno::Entities::Test }
         end
 
         # Methods to configure Inferno::DSL::Runnable
@@ -54,16 +54,14 @@ module Inferno
         def group_metadata
           {
             class: TestGroup,
-            repo: repository,
-            collection: groups
+            repo: repository
           }
         end
 
         def test_metadata
           {
             class: Test,
-            repo: Inferno::Repositories::Tests.new,
-            collection: tests
+            repo: Inferno::Repositories::Tests.new
           }
         end
 

data/lib/inferno/entities/test_run.rb

@@ -52,6 +52,7 @@ module Inferno
       ].freeze
 
       include Inferno::Entities::Attributes
+      include Inferno::Entities::HasRunnable
 
       attr_accessor :test_session
 
@@ -63,12 +64,6 @@ module Inferno
         @test_session = params[:test_session]
       end
 
-      def runnable
-        return @runnable if @runnable
-
-        @runnable = (test || test_group || test_suite || load_runnable)
-      end
-
       def to_hash
         super.merge(test_session: test_session).compact
       end
@@ -76,18 +71,6 @@ module Inferno
       def test_count
         @test_count ||= runnable.test_count
       end
-
-      private
-
-      def load_runnable
-        if test_id.present?
-          @test = Inferno::Repositories::Tests.new.find(test_id)
-        elsif test_group_id.present?
-          @test_group = Inferno::Repositories::TestGroups.new.find(test_group_id)
-        elsif test_suite_id.present?
-          @test_suite = Inferno::Repositories::TestSuites.new.find(test_suite_id)
-        end
-      end
     end
   end
 end

data/lib/inferno/entities/test_suite.rb

@@ -22,7 +22,7 @@ module Inferno
           return @default_group if @default_group
 
           @default_group = Class.new(TestGroup)
-          groups << @default_group
+          children << @default_group
           @default_group
         end
 
@@ -31,7 +31,7 @@ module Inferno
         end
 
         def groups
-          @groups ||= []
+          children.select { |child| child < Inferno::Entities::TestGroup }
         end
 
         # Methods to configure Inferno::DSL::Runnable
@@ -44,8 +44,7 @@ module Inferno
         def group_metadata
           {
             class: TestGroup,
-            repo: Inferno::Repositories::TestGroups.new,
-            collection: groups
+            repo: Inferno::Repositories::TestGroups.new
           }
         end
 

data/lib/inferno/entities.rb

@@ -1,4 +1,5 @@
 require_relative 'entities/attributes'
+require_relative 'entities/has_runnable'
 require_relative 'entities/entity'
 require_relative 'entities/header'
 require_relative 'entities/message'