inferno_core 0.5.2 → 0.5.4

data/lib/inferno/dsl/suite_endpoint.rb

@@ -9,54 +9,54 @@ module Inferno
     # endpoint](https://github.com/hanami/controller/tree/v2.0.0).
     #
     # @example
-    # class AuthorizedEndpoint < Inferno::DSL::SuiteEndpoint
-    #   # Identify the incoming request based on a bearer token
-    #   def test_run_identifier
-    #     request.header['authorization']&.delete_prefix('Bearer ')
-    #   end
+    #     class AuthorizedEndpoint < Inferno::DSL::SuiteEndpoint
+    #       # Identify the incoming request based on a bearer token
+    #       def test_run_identifier
+    #         request.header['authorization']&.delete_prefix('Bearer ')
+    #       end
     #
-    #   # Return a json FHIR Patient resource
-    #   def make_response
-    #     response.status = 200
-    #     response.body = FHIR::Patient.new(id: 'abcdef').to_json
-    #     response.format = :json
-    #   end
+    #       # Return a json FHIR Patient resource
+    #       def make_response
+    #         response.status = 200
+    #         response.body = FHIR::Patient.new(id: 'abcdef').to_json
+    #         response.format = :json
+    #       end
     #
-    #   # Update the waiting test to pass when the incoming request is received.
-    #   # This will resume the test run.
-    #   def update_result
-    #     results_repo.update(result.id, result: 'pass')
-    #   end
+    #       # Update the waiting test to pass when the incoming request is received.
+    #       # This will resume the test run.
+    #       def update_result
+    #         results_repo.update(result.id, result: 'pass')
+    #       end
     #
-    #   # Apply the 'authorized' tag to the incoming request so that it may be
-    #   # used by later tests.
-    #   def tags
-    #     ['authorized']
-    #   end
-    # end
+    #       # Apply the 'authorized' tag to the incoming request so that it may be
+    #       # used by later tests.
+    #       def tags
+    #         ['authorized']
+    #       end
+    #     end
     #
-    # class AuthorizedRequestSuite < Inferno::TestSuite
-    #   id :authorized_suite
-    #   suite_endpoint :get, '/authorized_endpoint', AuthorizedEndpoint
+    #     class AuthorizedRequestSuite < Inferno::TestSuite
+    #       id :authorized_suite
+    #       suite_endpoint :get, '/authorized_endpoint', AuthorizedEndpoint
     #
-    #   group do
-    #     title 'Authorized Request Group'
+    #       group do
+    #         title 'Authorized Request Group'
     #
-    #     test do
-    #       title 'Wait for authorized request'
+    #         test do
+    #           title 'Wait for authorized request'
     #
-    #       input :bearer_token
+    #           input :bearer_token
     #
-    #       run do
-    #         wait(
-    #           identifier: bearer_token,
-    #           message: "Waiting to receive a request with bearer_token: #{bearer_token}" \
-    #                    "at `#{Inferno::Application['base_url']}/custom/authorized_suite/authorized_endpoint`"
-    #         )
+    #           run do
+    #             wait(
+    #               identifier: bearer_token,
+    #               message: "Waiting to receive a request with bearer_token: #{bearer_token}" \
+    #                        "at `#{Inferno::Application['base_url']}/custom/authorized_suite/authorized_endpoint`"
+    #             )
+    #           end
+    #         end
     #       end
     #     end
-    #   end
-    # end
     class SuiteEndpoint < Hanami::Action
       attr_reader :req, :res
 
@@ -69,11 +69,11 @@ module Inferno
       # @return [String]
       #
       # @example
-      # def test_run_identifier
-      #   # Identify the test session of an incoming request based on the bearer
-      #   # token
-      #   request.headers['authorization']&.delete_prefix('Bearer ')
-      # end
+      #   def test_run_identifier
+      #     # Identify the test session of an incoming request based on the bearer
+      #     # token
+      #     request.headers['authorization']&.delete_prefix('Bearer ')
+      #   end
       def test_run_identifier
         nil
       end
@@ -83,11 +83,11 @@ module Inferno
       # @return [Void]
       #
       # @example
-      # def make_response
-      #   response.status = 200
-      #   response.body = { abc: 123 }.to_json
-      #   response.format = :json
-      # end
+      #   def make_response
+      #     response.status = 200
+      #     response.body = { abc: 123 }.to_json
+      #     response.format = :json
+      #   end
       def make_response
         nil
       end
@@ -113,9 +113,9 @@ module Inferno
       # @return [Void]
       #
       # @example
-      # def update_result
-      #   results_repo.update(result.id, result: 'pass')
-      # end
+      #   def update_result
+      #     results_repo.update(result.id, result: 'pass')
+      #   end
       def update_result
         nil
       end
@@ -165,9 +165,9 @@ module Inferno
       # @return [Hanami::Action::Request]
       #
       # @example
-      # request.params               # Get url/query params
-      # request.body.read            # Get body
-      # request.headers['accept']    # Get Accept header
+      #   request.params               # Get url/query params
+      #   request.body.read            # Get body
+      #   request.headers['accept']    # Get Accept header
       def request
         req
       end
@@ -178,10 +178,10 @@ module Inferno
       # @return [Hanami::Action::Response]
       #
       # @example
-      # response.status = 200        # Set the status
-      # response.body = 'Ok'         # Set the body
-      # # Set headers
-      # response.headers.merge!('X-Custom-Header' => 'CUSTOM_HEADER_VALUE')
+      #   response.status = 200        # Set the status
+      #   response.body = 'Ok'         # Set the body
+      #   # Set headers
+      #   response.headers.merge!('X-Custom-Header' => 'CUSTOM_HEADER_VALUE')
       def response
         res
       end

data/lib/inferno/dsl.rb

@@ -1,6 +1,7 @@
 require_relative 'dsl/assertions'
 require_relative 'dsl/fhir_client'
 require_relative 'dsl/fhir_validation'
+require_relative 'dsl/fhir_evaluation/evaluator'
 require_relative 'dsl/fhir_resource_validation'
 require_relative 'dsl/fhirpath_evaluation'
 require_relative 'dsl/http_client'
@@ -18,6 +19,7 @@ module Inferno
       HTTPClient,
       Results,
       FHIRValidation,
+      FHIREvaluation,
       FHIRResourceValidation,
       FhirpathEvaluation,
       Messages

data/lib/inferno/entities/ig.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require 'fhir_models'
+require 'pathname'
+require 'rubygems/package'
+require 'zlib'
+
+require_relative '../repositories/igs'
+
+module Inferno
+  module Entities
+    # IG is a wrapper class around the relevant concepts inside an IG.
+    # Not everything within an IG is currently used by Inferno.
+    class IG < Entity
+      ATTRIBUTES = [
+        :id,
+        :profiles,
+        :extensions,
+        :value_sets,
+        :search_params,
+        :examples
+      ].freeze
+
+      include Inferno::Entities::Attributes
+
+      def initialize(**params)
+        super(params, ATTRIBUTES)
+
+        @profiles = []
+        @extensions = []
+        @value_sets = []
+        @examples = []
+        @search_params = []
+      end
+
+      def self.from_file(ig_path)
+        raise "#{ig_path} does not exist" unless File.exist?(ig_path)
+
+        # fhir_models by default logs the entire content of non-FHIR files
+        # which could be things like a package.json
+        original_logger = FHIR.logger
+        FHIR.logger = Logger.new('/dev/null')
+
+        if File.directory?(ig_path)
+          from_directory(ig_path)
+        elsif ig_path.end_with? '.tgz'
+          from_tgz(ig_path)
+        else
+          raise "Unable to load #{ig_path} as it does not appear to be a directory or a .tgz file"
+        end
+      ensure
+        FHIR.logger = original_logger if defined? original_logger
+      end
+
+      def self.from_tgz(ig_path)
+        tar = Gem::Package::TarReader.new(
+          Zlib::GzipReader.open(ig_path)
+        )
+
+        ig = IG.new
+
+        tar.each do |entry|
+          next if skip_item?(entry.full_name, entry.directory?)
+
+          begin
+            resource = FHIR::Json.from_json(entry.read)
+            next if resource.nil?
+
+            ig.handle_resource(resource, entry.full_name)
+          rescue StandardError
+            next
+          end
+        end
+        ig
+      end
+
+      def self.from_directory(ig_directory)
+        ig = IG.new
+
+        ig_path = Pathname.new(ig_directory)
+        Dir.glob("#{ig_path}/**/*") do |f|
+          relative_path = Pathname.new(f).relative_path_from(ig_path).to_s
+          next if skip_item?(relative_path, File.directory?(f))
+
+          begin
+            resource = FHIR::Json.from_json(File.read(f))
+            next if resource.nil?
+
+            ig.handle_resource(resource, relative_path)
+          rescue StandardError
+            next
+          end
+        end
+        ig
+      end
+
+      # These files aren't FHIR resources
+      FILES_TO_SKIP = ['package.json', 'validation-summary.json'].freeze
+
+      def self.skip_item?(relative_path, is_directory)
+        return true if is_directory
+
+        file_name = relative_path.split('/').last
+
+        return true unless file_name.end_with? '.json'
+        return true unless relative_path.start_with? 'package/'
+
+        return true if file_name.start_with? '.' # ignore hidden files
+        return true if file_name.end_with? '.openapi.json'
+        return true if FILES_TO_SKIP.include? file_name
+
+        false
+      end
+
+      def handle_resource(resource, relative_path)
+        case resource.resourceType
+        when 'StructureDefinition'
+          if resource.type == 'Extension'
+            extensions.push resource
+          else
+            profiles.push resource
+          end
+        when 'ValueSet'
+          value_sets.push resource
+        when 'SearchParameter'
+          search_params.push resource
+        when 'ImplementationGuide'
+          @id = extract_package_id(resource)
+        else
+          examples.push(resource) if relative_path.start_with? 'package/example'
+        end
+      end
+
+      def extract_package_id(ig_resource)
+        "#{ig_resource.id}##{ig_resource.version || 'current'}"
+      end
+
+      # @private
+      def add_self_to_repository
+        repository.insert(self)
+      end
+
+      # @private
+      def repository
+        Inferno::Repositories::IGs.new
+      end
+    end
+  end
+end

data/lib/inferno/entities/test_kit.rb

@@ -6,7 +6,7 @@ module Inferno
     # @example
     #
     #   module USCoreTestKit
-    #     class TestKit < Inferno::Entities::TestKit
+    #     class Metadata < Inferno::Entities::TestKit
     #       id :us_core
     #       title 'US Core Test Kit'
     #       description <<~DESCRIPTION
@@ -156,7 +156,7 @@ module Inferno
 
         # @private
         def repository
-          @repository ||= Inferno::Repositories::TestKits
+          @repository ||= Inferno::Repositories::TestKits.new
         end
 
         # @private
@@ -168,4 +168,6 @@ module Inferno
       end
     end
   end
+
+  TestKit = Entities::TestKit
 end

data/lib/inferno/entities/test_suite.rb

@@ -84,15 +84,16 @@ module Inferno
           }
         end
 
-        # Set/get the version of this test suite.
+        # Set/get the version of this test suite. Defaults to the TestKit
+        # version.
         #
         # @param version [String]
         #
         # @return [String, nil]
         def version(version = nil)
-          return @version if version.nil?
+          @version = version if version.present?
 
-          @version = version
+          @version || test_kit&.version
         end
 
         # @private
@@ -186,6 +187,25 @@ module Inferno
 
           @suite_summary = format_markdown(suite_summary)
         end
+
+        # Get the TestKit this suite belongs to
+        #
+        # @return [Inferno::Entities::TestKit]
+        def test_kit
+          return @test_kit if @test_kit
+
+          module_name = name
+
+          while module_name.present? && @test_kit.nil?
+            module_name = module_name.deconstantize
+
+            next unless const_defined?("#{module_name}::Metadata")
+
+            @test_kit = const_get("#{module_name}::Metadata")
+          end
+
+          @test_kit
+        end
       end
     end
   end

data/lib/inferno/entities.rb

@@ -2,12 +2,14 @@ require_relative 'entities/attributes'
 require_relative 'entities/has_runnable'
 require_relative 'entities/entity'
 require_relative 'entities/header'
+require_relative 'entities/ig'
 require_relative 'entities/message'
 require_relative 'entities/request'
 require_relative 'entities/result'
 require_relative 'entities/session_data'
 require_relative 'entities/test'
 require_relative 'entities/test_group'
+require_relative 'entities/test_kit'
 require_relative 'entities/test_run'
 require_relative 'entities/test_session'
 require_relative 'entities/test_suite'