+ + + Modules: Json, Xml + + + + Classes: Client, Model + + +
+ + + + + + + + + +Returns the value of attribute auth_info.
+Returns the value of attribute oauth_credentials.
+Returns the value of attribute auth_info.
+ + +
+ + + +3 +4 +5+ |
+
+ # File 'lib/inferno/ext/fhir_client.rb', line 3 + +def auth_info + @auth_info +end+ |
+
Returns the value of attribute oauth_credentials.
+ + +
+ + + +3 +4 +5+ |
+
+ # File 'lib/inferno/ext/fhir_client.rb', line 3 + +def oauth_credentials + @oauth_credentials +end+ |
+
+ + + +9 +10 +11+ |
+
+ # File 'lib/inferno/ext/fhir_client.rb', line 9 + +def able_to_refresh? + !!(auth_info&.able_to_refresh? || oauth_credentials&.able_to_refresh?) +end+ |
+
+ + + +5 +6 +7+ |
+
+ # File 'lib/inferno/ext/fhir_client.rb', line 5 + +def need_to_refresh? + !!(auth_info&.need_to_refresh? || oauth_credentials&.need_to_refresh?) +end+ |
+
+ + + Modules: Middleware + + + + +
+ + + + + + + + + ++ + + + + Classes: BodyParser + + +
+ + + + + + + + + ++ + + + + Classes: JsonParser + + +
+ + + + + + + + + +
+ + + +5 +6 +7+ |
+
+ # File 'lib/inferno/ext/json_parser.rb', line 5 + +def self.mime_types + ['application/json', 'application/vnd.api+json', 'application/fhir+json'] +end+ |
+
+ + + Modules: CLI, DSL, Entities, Exceptions, Jobs, Repositories, SpecSupport, Utils, Web + + + + Classes: Application + + +
+ + +Standard patterns for gem versions: https://guides.rubygems.org/patterns/
+ + +'0.5.4'.freeze
DSL::JWKS
Entities::Test
Entities::TestKit
injectorEntities::TestGroup
Entities::TestSuite
+ + + +2 +3 +4+ |
+
+ # File 'lib/inferno.rb', line 2 + +def self.routes + @routes ||= [] +end+ |
+
+ + + + + Classes: Console, Evaluate, Execute, Main, Migration, New, Services, Suite, SuiteInputTemplate, Suites + + +
+ + + + + + + + + +
+ + + +4 +5 +6 +7 +8 +9 +10 +11 +12+ |
+
+ # File 'lib/inferno/apps/cli/console.rb', line 4 + +def run + require_relative '../../../inferno' + + ENV['ASYNC_JOBS'] = 'false' + ENV['INITIALIZE_VALIDATOR_SESSIONS'] = 'false' + + Inferno::Application.finalize! + Pry.start +end+ |
+
Utils::IgDownloader::FHIR_PACKAGE_NAME_REG_EX, Utils::IgDownloader::FILE_URI_REG_EX, Utils::IgDownloader::HTTP_URI_END_REG_EX, Utils::IgDownloader::HTTP_URI_REG_EX
+ + + + + + +#ig_file, #ig_http_url, #ig_path, #ig_registry_url, #load_ig
+ + + + +
+ + + +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30+ |
+
+ # File 'lib/inferno/apps/cli/evaluate.rb', line 13 + +def evaluate(ig_path, data_path, _log_level) + validate_args(ig_path, data_path) + _ig = get_ig(ig_path) + + # Rule execution, and result output below will be integrated soon. + + # if data_path + # DatasetLoader.from_path(File.join(__dir__, data_path)) + # else + # ig.examples + # end + + # config = Config.new + # evaluator = Inferno::DSL::FHIREvaluation::Evaluator.new(data, config) + + # results = evaluate() + # output_results(results, options[:output]) +end+ |
+
+ + + +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56+ |
+
+ # File 'lib/inferno/apps/cli/evaluate.rb', line 40 + +def get_ig(ig_path) + if File.exist?(ig_path) + ig = Inferno::Entities::IG.from_file(ig_path) + elsif in_user_package_cache?(ig_path.sub('@', '#')) + # NPM syntax for a package identifier is id@version (eg, hl7.fhir.us.core@3.1.1) + # but in the cache the separator is # (hl7.fhir.us.core#3.1.1) + cache_directory = File.join(user_package_cache, ig_path.sub('@', '#')) + ig = Inferno::Entities::IG.from_file(cache_directory) + else + Tempfile.create('package.tgz') do |temp_file| + load_ig(ig_path, nil, { force: true }, temp_file.path) + ig = Inferno::Entities::IG.from_file(temp_file.path) + end + end + ig.add_self_to_repository + ig +end+ |
+
+ + + +62 +63 +64+ |
+
+ # File 'lib/inferno/apps/cli/evaluate.rb', line 62 + +def in_user_package_cache?(ig_identifier) + File.directory?(File.join(user_package_cache, ig_identifier)) +end+ |
+
+ + + +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77+ |
+
+ # File 'lib/inferno/apps/cli/evaluate.rb', line 66 + +def output_results(results, output) + if output&.end_with?('json') + oo = FhirEvaluator::EvaluationResult.to_operation_outcome(results) + File.write(output, oo.to_json) + puts "Results written to #{output}" + else + counts = results.group_by(&:severity).transform_values(&:count) + print(counts, 'Result Count') + puts "\n" + puts results + end +end+ |
+
+ + + +92 +93 +94+ |
+
+ # File 'lib/inferno/apps/cli/evaluate.rb', line 92 + +def pad(string, length) + format("%#{length}.#{length}s", string) +end+ |
+
+ + + +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90+ |
+
+ # File 'lib/inferno/apps/cli/evaluate.rb', line 79 + +def print(output_fields, title) + puts("╔══════════════ #{title} ═══════════════╗") + puts('║ ╭────────────────┬──────────────────────╮ ║') + output_fields.each_with_index do |(key, value), i| + field_name = pad(key, 14) + field_value = pad(value.to_s, 20) + puts("║ │ #{field_name} │ #{field_value} │ ║") + puts('║ ├────────────────┼──────────────────────┤ ║') unless i == output_fields.length - 1 + end + puts('║ ╰────────────────┴──────────────────────╯ ║') + puts('╚═══════════════════════════════════════════╝') +end+ |
+
+ + + +58 +59 +60+ |
+
+ # File 'lib/inferno/apps/cli/evaluate.rb', line 58 + +def user_package_cache + File.join(Dir.home, '.fhir', 'packages') +end+ |
+
+ + + +32 +33 +34 +35 +36 +37 +38+ |
+
+ # File 'lib/inferno/apps/cli/evaluate.rb', line 32 + +def validate_args(ig_path, data_path) + raise 'A path to an IG is required!' unless ig_path + + return unless data_path && (!File.directory? data_path) + + raise "Provided path '#{data_path}' is not a directory" +end+ |
+
{ + 'console' => Inferno::CLI::Execute::ConsoleOutputter, + 'plain' => Inferno::CLI::Execute::PlainOutputter, + 'json' => Inferno::CLI::Execute::JSONOutputter, + 'quiet' => Inferno::CLI::Execute::QuietOutputter +}.freeze
Returns the value of attribute options.
+Returns the value of attribute options.
+ + +
+ + + +20 +21 +22+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 20 + +def + @options +end+ |
+
+ + + +33 +34 +35 +36 +37 +38 +39 +40+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 33 + +def self.boot_full_inferno + ENV['NO_DB'] = 'false' + + # Inferno boot flow triggers migration and logger outputs it + Inferno::CLI::Execute.suppress_output { require_relative '../../../inferno' } + + Inferno::Application.start(:executor) +end+ |
+
+ + + +22 +23 +24 +25 +26 +27 +28 +29 +30 +31+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 22 + +def self.suppress_output + begin + original_stdout = $stdout.clone + $stdout.reopen(File.new(File::NULL, 'w+')) + retval = yield + ensure + $stdout.reopen(original_stdout) + end + retval +end+ |
+
+ + + +119 +120 +121+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 119 + +def all_selected_groups_and_tests + @all_selected_groups_and_tests ||= runnables_by_short_id + groups + tests +end+ |
+
+ + + +213 +214 +215 +216 +217 +218 +219+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 213 + +def create_params(test_session, runnable) + { + test_session_id: test_session.id, + runnable_id_key(runnable) => runnable.id, + inputs: thor_hash_to_inputs_array(inputs_and_preset) + } +end+ |
+
+ + + +174 +175 +176 +177 +178+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 174 + +def create_test_run(runnable) + test_runs_repo.create( + create_params(test_session, runnable).merge({ status: 'queued' }) + ) +end+ |
+
+ + + +221 +222 +223 +224 +225 +226 +227 +228 +229+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 221 + +def dispatch_job(test_run) + if [:verbose] + Jobs.perform(Jobs::ExecuteTestRun, test_run.id, force_synchronous: true) + else + Inferno::CLI::Execute.suppress_output do + Jobs.perform(Jobs::ExecuteTestRun, test_run.id, force_synchronous: true) + end + end +end+ |
+
+ + + +249 +250 +251 +252 +253 +254 +255 +256+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 249 + +def find_by_short_id(repo_symbol, short_id) + repo_symbol_to_array(repo_symbol).each do |repo| + repo.all.each do |entity| + return entity if short_id == entity.short_id && suite.id == entity.suite.id + end + end + raise StandardError, "#{repo_symbol.to_s.humanize} #{short_id} not found." +end+ |
+
+ + + +237 +238 +239 +240 +241+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 237 + +def groups + return [] if [:groups].blank? + + @groups ||= [:groups]&.map { |short_id| find_by_short_id(:group, short_id) } +end+ |
+
+ + + +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 135 + +def inputs_and_preset + if preset + preset_inputs = preset.inputs.to_h do |preset_input| + [preset_input[:name], preset_input[:value]] + end + + .fetch(:inputs, {}).reverse_merge(preset_inputs) + else + .fetch(:inputs, {}) + end +end+ |
+
+ + + +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 107 + +def load_preset_file_and_set_preset_id + return unless [:preset_file] + raise StandardError, 'Cannot use `--preset-id` and `--preset-file` options together' if [:preset_id] + + raise StandardError, "File #{[:preset_file]} not found" unless File.exist? [:preset_file] + + [:preset_id] = JSON.parse(File.read([:preset_file]))['id'] + raise StandardError, "Preset #{[:preset_file]} is missing id" if [:preset_id].nil? + + presets_repo.insert_from_file([:preset_file]) +end+ |
+
+ + + +98 +99 +100 +101 +102 +103 +104 +105+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 98 + +def outputter + unless OUTPUTTERS.key? [:outputter] + raise StandardError, + "Unrecognized outputter #{[:outputter]}" + end + + @outputter ||= OUTPUTTERS[[:outputter]].new +end+ |
+
+ + + +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 147 + +def preset + return unless [:preset_id] + + @preset ||= presets_repo.find([:preset_id]) + + raise StandardError, "Preset #{[:preset_id]} not found" if @preset.nil? + + unless presets_repo.presets_for_suite(suite.id).include?(@preset) + raise StandardError, + "Preset #{[:preset_id]} is incompatible with suite #{suite.id}" + end + + @preset +end+ |
+
+ + + +200 +201 +202+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 200 + +def presets_repo + @presets_repo ||= Inferno::Repositories::Presets.new +end+ |
+
+ + + +279 +280 +281 +282 +283 +284 +285+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 279 + +def print_error_and_exit(err, code) + outputter.print_error( || {}, err) +rescue StandardError => e + puts "Caught exception #{e} while printing exception #{err}. Exiting." +ensure + exit(code) +end+ |
+
+ + + +93 +94 +95 +96+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 93 + +def print_help_and_exit + puts `NO_DB=true bundle exec inferno help execute` + exit(0) +end+ |
+
+ + + +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 258 + +def repo_symbol_to_array(repo_symbol) + case repo_symbol + when :group + [test_groups_repo] + when :test + [tests_repo] + when :group_or_test + [test_groups_repo, tests_repo] + else + raise StandardError, "Unrecognized repo_symbol #{repo_symbol} for `find_by_short_id`" + end +end+ |
+
+ + + +180 +181 +182+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 180 + +def results_repo + @results_repo ||= Inferno::Repositories::Results.new +end+ |
+
+ + + +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 42 + +def run() + print_help_and_exit if [:help] + + self. = + + outputter.(self.) + + load_preset_file_and_set_preset_id + + results = [] + outputter.print_around_run(self.) do + if all_selected_groups_and_tests.empty? + test_run = create_test_run(suite) + run_one(suite, test_run) + + results = test_runs_repo.results_for_test_run(test_run.id) + results = sort_results(results) + else + all_selected_groups_and_tests.each do |runnable| + test_run = create_test_run(runnable) + run_one(runnable, test_run) + + results += sort_results(test_runs_repo.results_for_test_run(test_run.id)) + end + end + end + + # User may enter duplicate runnables, in which case this prevents a bug of extraneous results + results.uniq!(&:id) + + outputter.print_results(, results) + outputter.() + + # TODO: respect customized rollups + exit(0) if Inferno::ResultSummarizer.new(results).summarize == 'pass' + + # exit(1) is for Thor failures + # exit(2) is for shell builtin failures + exit(3) +rescue Sequel::ValidationFailed => e + print_error_and_exit(e, 4) +rescue Sequel::ForeignKeyConstraintViolation => e + print_error_and_exit(e, 5) +rescue Inferno::Exceptions::RequiredInputsNotFound => e + print_error_and_exit(e, 6) +rescue Inferno::Exceptions::NotUserRunnableException => e + print_error_and_exit(e, 7) +rescue StandardError => e + print_error_and_exit(e, 8) +end+ |
+
+ + + +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 123 + +def run_one(runnable, test_run) + verify_runnable( + runnable, + thor_hash_to_inputs_array(inputs_and_preset), + test_session. + ) + + persist_inputs(session_data_repo, create_params(test_session, suite), test_run) + + dispatch_job(test_run) +end+ |
+
+ + + +299 +300 +301 +302 +303 +304 +305 +306 +307 +308+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 299 + +def runnable_id_key(runnable) + case runnable_type(runnable) + when :suite + :test_suite_id + when :group + :test_group_id + else + :test_id + end +end+ |
+
+ + + +287 +288 +289 +290 +291 +292 +293 +294 +295 +296 +297+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 287 + +def runnable_type(runnable) + if runnable < Inferno::TestSuite + :suite + elsif runnable < Inferno::TestGroup + :group + elsif runnable < Inferno::Test + :test + else + raise StandardError, "Unidentified runnable #{runnable}" + end +end+ |
+
+ + + +231 +232 +233 +234 +235+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 231 + +def runnables_by_short_id + return [] if [:short_ids].blank? + + @runnables_by_short_id ||= [:short_ids]&.map { |short_id| find_by_short_id(:group_or_test, short_id) } +end+ |
+
+ + + +196 +197 +198+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 196 + +def session_data_repo + @session_data_repo ||= Inferno::Repositories::SessionData.new +end+ |
+
+ + + +310 +311 +312 +313 +314 +315 +316 +317 +318 +319 +320+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 310 + +def sort_results(results) + results.sort do |result, other| + if result.runnable < Inferno::TestSuite + -1 + elsif other.runnable < Inferno::TestSuite + 1 + else + result.runnable.short_id <=> other.runnable.short_id + end + end +end+ |
+
+ + + +162 +163 +164 +165 +166 +167 +168+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 162 + +def suite + @suite ||= Inferno::Repositories::TestSuites.new.find([:suite]) + + raise StandardError, "Test suite #{[:suite]} not found" if @suite.nil? + + @suite +end+ |
+
+ + + +184 +185 +186+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 184 + +def test_groups_repo + @test_groups_repo ||= Inferno::Repositories::TestGroups.new +end+ |
+
+ + + +170 +171 +172+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 170 + +def test_runs_repo + @test_runs_repo ||= Inferno::Repositories::TestRuns.new +end+ |
+
+ + + +204 +205 +206 +207 +208 +209 +210 +211+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 204 + +def test_session + @test_session ||= test_sessions_repo.create({ + test_suite_id: suite.id, + suite_options: ( + [:suite_options] + ) + }) +end+ |
+
+ + + +192 +193 +194+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 192 + +def test_sessions_repo + @test_sessions_repo ||= Inferno::Repositories::TestSessions.new +end+ |
+
+ + + +243 +244 +245 +246 +247+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 243 + +def tests + return [] if [:tests].blank? + + @tests ||= [:tests]&.map { |short_id| find_by_short_id(:test, short_id) } +end+ |
+
+ + + +188 +189 +190+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 188 + +def tests_repo + @tests_repo ||= Inferno::Repositories::Tests.new +end+ |
+
+ + + +275 +276 +277+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 275 + +def thor_hash_to_inputs_array(hash = {}) + hash.to_a.map { |pair| { name: pair[0], value: pair[1] } } +end+ |
+
+ + + +271 +272 +273+ |
+
+ # File 'lib/inferno/apps/cli/execute.rb', line 271 + +def (hash = {}) + hash.to_a.map { |pair| Inferno::DSL::SuiteOption.new({ id: pair[0], value: pair[1] }) } +end+ |
+
<<~END_OF_HELP.freeze + Run Inferno tests in the command line. Exits with 0 only if test entity passes. + Must be run with test kit as working directory. + + You must have background services running: `bundle exec inferno services start` + + You can view suite ids with: `bundle exec inferno suites` + + You can select an output format with the `--outputter` option. Current outputters + are console (default), plain, quiet, and json. JSON-formatted output will copy + Inferno's REST API: https://inferno-framework.github.io/inferno-core/api-docs/#/Result. + + Examples: + + (These examples only work from within the inferno_core directory). + + `bundle exec inferno execute --suite dev_validator \ + --inputs "url:https://hapi.fhir.org/baseR4" \ + patient_id:1234321` + => Outputs test results + + `bundle exec inferno execute --suite dev_validator \ + --inputs "url:https://hapi.fhir.org/baseR4" \ + patient_id:1234321 \ + --tests 1.01 1.02` + => Run specific tests from suite + + `bundle exec inferno execute --suite dev_validator \ + --inputs "url:https://hapi.fhir.org/baseR4" \ + patient_id:1234321 \ + --outputter json` + => Outputs test results in JSON +END_OF_HELP
https://github.com/rails/thor/issues/244 - Make Thor exit(1) on Errors/Exceptions.
+https://github.com/rails/thor/issues/244 - Make Thor exit(1) on Errors/Exceptions
+ + +
+ + + +195 +196 +197+ |
+
+ # File 'lib/inferno/apps/cli/main.rb', line 195 + +def self.exit_on_failure? + true +end+ |
+
+ + + +52 +53 +54 +55+ |
+
+ # File 'lib/inferno/apps/cli/main.rb', line 52 + +def console + Migration.new.run(Logger::INFO) + Console.new.run +end+ |
+
+ + + +47 +48 +49+ |
+
+ # File 'lib/inferno/apps/cli/main.rb', line 47 + +def evaluate(ig_path) + Evaluate.new.evaluate(ig_path, [:data_path], Logger::INFO) +end+ |
+
+ + + +189 +190 +191 +192+ |
+
+ # File 'lib/inferno/apps/cli/main.rb', line 189 + +def execute + Execute.boot_full_inferno + Execute.new.run(.dup) # dup to unfreeze Thor options +end+ |
+
+ + + +58 +59 +60+ |
+
+ # File 'lib/inferno/apps/cli/main.rb', line 58 + +def migrate + Migration.new.run +end+ |
+
+ + + +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87+ |
+
+ # File 'lib/inferno/apps/cli/main.rb', line 67 + +def start + Migration.new.run(Logger::INFO) + + without_bundler do + command = 'foreman start --env=/dev/null' + + if `gem list -i foreman`.chomp == 'false' + puts "You must install foreman with 'gem install foreman' prior to running Inferno." + end + + if [:watch] + if `gem list -i rerun`.chomp == 'false' + puts "You must install 'rerun' with 'gem install rerun' to restart on file changes." + end + + command = "rerun \"#{command}\" --background" + end + + exec command + end +end+ |
+
+ + + +6 +7 +8 +9 +10 +11+ |
+
+ # File 'lib/inferno/apps/cli/migration.rb', line 6 + +def run(log_level = Logger::DEBUG) + Inferno::Application.start(:logging) + Inferno::Application['logger'].level = log_level + + Utils::Migration.new.run +end+ |
+
Utils::IgDownloader::FHIR_PACKAGE_NAME_REG_EX, Utils::IgDownloader::FILE_URI_REG_EX, Utils::IgDownloader::HTTP_URI_END_REG_EX, Utils::IgDownloader::HTTP_URI_REG_EX
+ + + +Utils::NamedThorActions::INFLECTOR
+ + + + + + +#ig_file, #ig_http_url, #ig_path, #ig_registry_url, #load_ig
+ + + + + + + + + +#human_name, #library_name, #module_name, #root_name, #test_kit_id, #test_suite_id, #title_name
+ + + + +
+ + + +37 +38 +39+ |
+
+ # File 'lib/inferno/apps/cli/new.rb', line 37 + +def self. + 'inferno new TEST_KIT_NAME' +end+ |
+
+ + + +41 +42 +43+ |
+
+ # File 'lib/inferno/apps/cli/new.rb', line 41 + +def self.source_root + File.join(__dir__, 'templates') +end+ |
+
+ + + +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83+ |
+
+ # File 'lib/inferno/apps/cli/new.rb', line 68 + +def create_test_kit + directory('.', root_name, { mode: :preserve, recursive: true, verbose: !['quiet'] }) + + inside(root_name) do + bundle_install + inferno_migrate + load_igs + end + + say_unless_quiet "Created #{root_name} Inferno Test Kit!", :green + + return unless ['pretend'] + + say_unless_quiet 'This was a dry run; re-run without `--pretend` to actually create project', + :yellow +end+ |
+
+ + + +28 +29 +30+ |
+
+ # File 'lib/inferno/apps/cli/services.rb', line 28 + +def build + system "#{base_command} build" +end+ |
+
+ + + +47 +48 +49 +50 +51 +52 +53+ |
+
+ # File 'lib/inferno/apps/cli/services.rb', line 47 + +def logs + command = "#{base_command} logs" + command += ' -f' if [:follow] + command += " --tail #{[:tail]}" if [:tail] + + system command +end+ |
+
+ + + +33 +34 +35+ |
+
+ # File 'lib/inferno/apps/cli/services.rb', line 33 + +def pull + system "#{base_command} pull" +end+ |
+
+ + + +15 +16 +17 +18 +19 +20+ |
+
+ # File 'lib/inferno/apps/cli/services.rb', line 15 + +def start + command = "#{base_command} up" + command += ' -d' unless [:foreground] + + system command +end+ |
+
+ + + +23 +24 +25+ |
+
+ # File 'lib/inferno/apps/cli/services.rb', line 23 + +def stop + system "#{base_command} down" +end+ |
+
+ + + +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54+ |
+
+ # File 'lib/inferno/apps/cli/suite.rb', line 25 + +def describe(suite_id) + ENV['NO_DB'] = 'true' + Inferno::Application.start(:suites) + + suite = Inferno::Repositories::TestSuites.new.find(suite_id) + + if suite.blank? + = "No suite found with id `#{suite_id}`. Run `inferno suites` to see a list of available suites" + + puts TTY::Markdown.parse() + return + end + + description = '' + description += "# #{suite.title}\n" + description += "#{suite.description}\n" if suite.description + + if suite..present? + description += "***\n\n" + description += "# Suite Options\n\n" + suite..each do |option| + description += "* `#{option.id}`: #{option.title}\n" + option..each do |list_option| + description += " * `#{list_option[:value]}`: #{list_option[:label]}\n" + end + end + end + + puts TTY::Markdown.parse(description) +end+ |
+
+ + + +16 +17 +18 +19+ |
+
+ # File 'lib/inferno/apps/cli/suite.rb', line 16 + +def input_template(suite_id) + ENV['NO_DB'] = 'true' + SuiteInputTemplate.new.run(suite_id, ) +end+ |
+
+ + + +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27+ |
+
+ # File 'lib/inferno/apps/cli/suite_input_template.rb', line 6 + +def run(suite_id, ) + require_relative '../../../inferno' + + Inferno::Application.start(:suites) + + suite = Inferno::Repositories::TestSuites.new.find(suite_id) + if suite.nil? + puts "No Test Suite found with id: #{suite_id}" + return 1 + end + + output = JSON.pretty_generate(Inferno::Utils::PresetTemplateGenerator.new(suite).generate) + + if [:filename].present? + path = File.join(Dir.pwd, 'config', 'presets', [:filename]) + FileUtils.mkdir_p(File.dirname(path)) + + File.open(path, 'w') { |f| f.puts(output) } + else + puts output + end +end+ |
+
+ + + +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28+ |
+
+ # File 'lib/inferno/apps/cli/suites.rb', line 6 + +def run + ENV['NO_DB'] = 'true' + + require_relative '../../../inferno' + + Inferno::Application.start(:suites) + + suites = Inferno::Repositories::TestSuites.new.all + suite_hash = suites.each_with_object({}) { |suite, hash| hash[suite.id] = suite.title } + + id_column_length = suite_hash.keys.map(&:length).max + 2 + title_column_length = suite_hash.values.map(&:length).max + 1 + + output = '' + output += "| #{'Title'.ljust(title_column_length)}| #{'ID'.ljust(id_column_length)}|\n" + output += "|-#{'-' * title_column_length}|-#{'-' * id_column_length}|\n" + + suite_hash.each do |id, title| + output += "| #{title.ljust(title_column_length)}| #{id.ljust(id_column_length)}|\n" + end + + puts TTY::Markdown.parse(output) +end+ |
+
The DSL for writing tests.
+ + ++ + + Modules: Assertions, Configurable, FHIRClient, FHIREvaluation, FHIRResourceValidation, FHIRValidation, FhirpathEvaluation, HTTPClient, InputOutputHandling, Links, Messages, RequestStorage, Results, Runnable + + + + Classes: AuthInfo, FHIRClientBuilder, HTTPClientBuilder, JWKS, OAuthCredentials, SuiteEndpoint, SuiteOption + + +
+ + +[ + Assertions, + FHIRClient, + HTTPClient, + Results, + FHIRValidation, + FHIREvaluation, + FHIRResourceValidation, + FhirpathEvaluation, + Messages +].freeze
[ + Runnable +].freeze
This module contains the assertions used within tests to verify the
+behavior of the systems under test. Failing an assertion causes a test to
+immediately stop execution and receive a fail result. Additional
+assertions added to this module will be available in all tests.
Make an assertion.
+Check a FHIR resource’s type.
+Check the Content-Type header of a response.
+Check a response’s status.
+Validate each entry of a Bundle.
+Check for a valid http/https uri.
+Check for valid JSON.
+Validate a FHIR resource.
+This method returns an undefined value.
Make an assertion
+ + +
+ + + +16 +17 +18+ |
+
+ # File 'lib/inferno/dsl/assertions.rb', line 16 + +def assert(test, = '') + raise Exceptions::AssertionException, unless test +end+ |
+
This method returns an undefined value.
Check a FHIR resource’s type
+ + +
+ + + +52 +53 +54 +55 +56 +57+ |
+
+ # File 'lib/inferno/dsl/assertions.rb', line 52 + +def assert_resource_type(resource_type, resource: self.resource) + resource_type_name = normalize_resource_type(resource_type) + + assert resource&.resourceType == resource_type_name, + (resource_type_name, resource&.resourceType) +end+ |
+
This method returns an undefined value.
Check the Content-Type header of a response. This assertion will fail if +the response’s content type does not begin with the provided type.
+ + +
+ + + +184 +185 +186 +187 +188 +189+ |
+
+ # File 'lib/inferno/dsl/assertions.rb', line 184 + +def assert_response_content_type(type, request: self.request) + header = request.response_header('Content-Type') + assert header.present?, + + assert header.value.start_with?(type), (type, header.value) +end+ |
+
This method returns an undefined value.
Check a response’s status
+ + +
+ + + +32 +33 +34 +35+ |
+
+ # File 'lib/inferno/dsl/assertions.rb', line 32 + +def assert_response_status(status, request: self.request, response: nil) + response ||= request&.response + assert Array.wrap(status).include?(response[:status]), (status, response[:status]) +end+ |
+
This method returns an undefined value.
Validate each entry of a Bundle
+ +[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.
+ + +
+ + + +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125+ |
+
+ # File 'lib/inferno/dsl/assertions.rb', line 106 + +def assert_valid_bundle_entries(bundle: resource, resource_types: {}) + assert_resource_type('Bundle', resource: bundle) + + types_to_check = normalize_types_to_check(resource_types) + + invalid_resources = + bundle + .entry + .map(&:resource) + .select { |resource| types_to_check.empty? || types_to_check.include?(resource.resourceType) } + .reject do |resource| + validation_params = { resource: } + profile = types_to_check[resource.resourceType] + validation_params[:profile_url] = profile if profile + + resource_is_valid?(**validation_params) + end + + assert invalid_resources.empty?, (invalid_resources) +end+ |
+
This method returns an undefined value.
Check for a valid http/https uri
+ + +
+ + + +173 +174 +175 +176+ |
+
+ # File 'lib/inferno/dsl/assertions.rb', line 173 + +def assert_valid_http_uri(uri, = '') + = .presence || "\"#{uri}\" is not a valid URI" + assert uri =~ /\A#{URI::DEFAULT_PARSER.make_regexp(['http', 'https'])}\z/, +end+ |
+
This method returns an undefined value.
Check for valid JSON
+ + +
+ + + +162 +163 +164 +165 +166+ |
+
+ # File 'lib/inferno/dsl/assertions.rb', line 162 + +def assert_valid_json(maybe_json_string, = '') + assert JSON.parse(maybe_json_string) +rescue JSON::ParserError + assert false, "Invalid JSON. #{}" +end+ |
+
This method returns an undefined value.
Validate a FHIR resource
+ + +
+ + + +73 +74 +75 +76+ |
+
+ # File 'lib/inferno/dsl/assertions.rb', line 73 + +def assert_valid_resource(resource: self.resource, profile_url: nil, validator: :default) + assert resource_is_valid?(resource:, profile_url:, validator:), + (resource, profile_url) +end+ |
+
AuthInfo provides a user with a single input which contains the information +needed for a FHIR client to perform authorization and refresh an access +token when necessary.
+ +AuthInfo supports the following auth_type:
public - Client id onlysymmetric - Confidential symmetric (i.e., with a static client id and
+secret)asymmetric - Confidential asymmetric (i.e., a client id with a signed
+JWT rather than a client secret)backend_servicesWhen configuring an AuthInfo input, the invdidual fields are exposed as
+components in the input’s options, and can be configured there similar
+to normal inputs.
The AuthInfo input type supports two different modes in the UI. Different +fields will be presented to the user depending on which mode is selected:
+ +auth - This presents the inputs needed to perform authorization, and
+is appropriate to use as an input to test groups which perform
+authorization.access - This presents the inputs needed to access resources assuming
+that authorization has already happened, and is appropriate to use as an
+input to test groups which access resources using previously granted
+authorization.[ + :auth_type, + :use_discovery, + :token_url, + :auth_url, + :requested_scopes, + :client_id, + :client_secret, + :redirect_url, # TODO: does this belong here? + :pkce_support, + :pkce_code_challenge_method, + :auth_request_method, + :encryption_algorithm, + :kid, + :jwks, + :access_token, + :refresh_token, + :issue_time, + :expires_in, + :name +].freeze
The http method which will be used to perform the request to the authorization endpoint.
+The type of authorization to be performed.
+The url of the authorization endpoint.
+Returns the value of attribute client.
+The encryption algorithm which will be used to sign the JWT client credentials.
+The lifetime of the access token in seconds.
+An iso8601 formatted string representing the time the access token was issued.
+A JWKS (including private keys) which will be used instead of Inferno’s default JWKS if provided.
+The key id for the keys to be used to sign the JWT client credentials.
+Either S256 (default) or plain.
Whether PKCE will be used during authorization.
+The scopes which will be requested during authorization.
+The url of the auth server’s token endpoint.
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
The http method which will be used to perform the request to the authorization endpoint.
+Either get (default) or post
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
The type of authorization to be performed. One of public, symmetric, asymmetric, or backend_services
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
The url of the authorization endpoint
+ + +
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
Returns the value of attribute client.
+ + +
+ + + +98 +99 +100+ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 98 + +def client + @client +end+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
The encryption algorithm which will be used to sign the JWT client credentials.
+Either es384 (default) or rs384
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
The lifetime of the access token in seconds
+ + +
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
An iso8601 formatted string representing the time the access token was issued
+ + +
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
A JWKS (including private keys) which will be used instead of Inferno’s default JWKS if provided
+ + +
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
The key id for the keys to be used to sign the JWT client credentials. +When blank, the first key for the selected encryption algorithm will be used
+ + +
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
Either S256 (default) or plain
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
Whether PKCE will be used during authorization. Either enabled or disabled.
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
The scopes which will be requested during authorization
+ + +
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
The url of the auth server’s token endpoint
+ + +
+ + + ++ |
+
+ # File 'lib/inferno/dsl/auth_info.rb', line 100
+
+
+ |
+
This module contains the DSL for managing runnable configuration. Runnable +configuration provides a way to modify test behavior at boot time.
+ +The main features enabled by configuration are:
+ ++ + + + + Classes: Configuration + + +
+ + + + + + + + +Define/update/get the configuration for a runnable.
+Define/update/get the configuration for a runnable. This configuration +will be applied to the runnable and all of its children.
+ + +
+ + + +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96+ |
+
+ # File 'lib/inferno/dsl/configurable.rb', line 86 + +def config(new_configuration = {}) + @config ||= Configuration.new + + return @config if new_configuration.blank? + + @config.apply(new_configuration) + + all_children.each { |child| child.config(new_configuration) } + + @config +end+ |
+
This class stores a runnable’s configuration. It should never be
+directly instantiated within a test suite. Instead, a runnable’s
+configuration can be modified or retrieved using the config method.
Returns the value of attribute configuration.
+The input configuration for this runnable.
+The configuration options defined for this runnable.
+The output configuration for this runnable.
+The request configuration for this runnable.
+Returns the value of attribute configuration.
+ + +
+ + + +102 +103 +104+ |
+
+ # File 'lib/inferno/dsl/configurable.rb', line 102 + +def configuration + @configuration +end+ |
+
The input configuration for this runnable.
+ + +
+ + + +137 +138 +139+ |
+
+ # File 'lib/inferno/dsl/configurable.rb', line 137 + +def inputs + configuration[:inputs] ||= {} +end+ |
+
The configuration options defined for this runnable.
+ + +
+ + + +128 +129 +130+ |
+
+ # File 'lib/inferno/dsl/configurable.rb', line 128 + +def + configuration[:options] ||= {} +end+ |
+
The output configuration for this runnable.
+ + +
+ + + +190 +191 +192+ |
+
+ # File 'lib/inferno/dsl/configurable.rb', line 190 + +def outputs + configuration[:outputs] ||= {} +end+ |
+
The request configuration for this runnable.
+ + +
+ + + +230 +231 +232+ |
+
+ # File 'lib/inferno/dsl/configurable.rb', line 230 + +def requests + configuration[:requests] ||= {} +end+ |
+
This module contains the FHIR DSL available to test writers.
+ + ++ + + Modules: ClassMethods + + + + +
+ + + + + + + + +Return a previously defined FHIR client.
+Perform a FHIR create interaction.
+Perform a FHIR delete interaction.
+Fetch the capability statement.
+Perform a FHIR history interaction.
+Perform a FHIR operation.
+Perform a FHIR patch interaction.
+Perform a FHIR read interaction.
+Perform a FHIR search interaction.
+Perform a FHIR batch/transaction interaction.
+Perform a FHIR update interaction.
+Perform a FHIR vread interaction.
+Return a previously defined FHIR client
+ + +
+ + + +53 +54 +55 +56+ |
+
+ # File 'lib/inferno/dsl/fhir_client.rb', line 53 + +def fhir_client(client = :default) + fhir_clients[client] ||= + FHIRClientBuilder.new.build(self, self.class.fhir_client_definitions[client]) +end+ |
+
Perform a FHIR create interaction.
+ + +
+ + + +158 +159 +160 +161 +162 +163 +164+ |
+
+ # File 'lib/inferno/dsl/fhir_client.rb', line 158 + +def fhir_create(resource, client: :default, name: nil, tags: []) + store_request_and_refresh_token(fhir_client(client), name, ) do + tcp_exception_handler do + fhir_client(client).create(resource) + end + end +end+ |
+
Perform a FHIR delete interaction.
+ + +
+ + + +305 +306 +307 +308 +309 +310 +311+ |
+
+ # File 'lib/inferno/dsl/fhir_client.rb', line 305 + +def fhir_delete(resource_type, id, client: :default, name: nil, tags: []) + store_request('outgoing', name:, tags:) do + tcp_exception_handler do + fhir_client(client).destroy(fhir_class_from_resource_type(resource_type), id) + end + end +end+ |
+
Fetch the capability statement.
+ + +
+ + + +141 +142 +143 +144 +145 +146 +147 +148+ |
+
+ # File 'lib/inferno/dsl/fhir_client.rb', line 141 + +def fhir_get_capability_statement(client: :default, name: nil, tags: []) + store_request_and_refresh_token(fhir_client(client), name, ) do + tcp_exception_handler do + fhir_client(client).conformance_statement + fhir_client(client).reply + end + end +end+ |
+
Perform a FHIR history interaction.
+ + +
+ + + +245 +246 +247 +248 +249 +250 +251 +252 +253 +254 +255 +256 +257+ |
+
+ # File 'lib/inferno/dsl/fhir_client.rb', line 245 + +def fhir_history(resource_type = nil, id = nil, client: :default, name: nil, tags: []) + store_request_and_refresh_token(fhir_client(client), name, ) do + tcp_exception_handler do + if id + fhir_client(client).resource_instance_history(fhir_class_from_resource_type(resource_type), id) + elsif resource_type + fhir_client(client).resource_history(fhir_class_from_resource_type(resource_type)) + else + fhir_client(client).all_history + end + end + end +end+ |
+
This is a placeholder method until the FHIR::Client supports +general operations. Note that while both POST and GET methods are allowed, +GET is only allowed when the operation does not affect the server’s state. +See https://build.fhir.org/operationdefinition-definitions.html#OperationDefinition.affectsState
+Currently does not allow for repeated parameters if using GET
+Perform a FHIR operation
+ + +
+ + + +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132+ |
+
+ # File 'lib/inferno/dsl/fhir_client.rb', line 106 + +def fhir_operation( + path, + body: nil, + client: :default, + name: nil, + headers: {}, + operation_method: :post, + tags: [] +) + store_request_and_refresh_token(fhir_client(client), name, ) do + tcp_exception_handler do + operation_headers = fhir_client(client).fhir_headers + operation_headers.merge!('Content-Type' => 'application/fhir+json') if body.present? + operation_headers.merge!(headers) if headers.present? + case operation_method + when :post + fhir_client(client).send(:post, path, body, operation_headers) + when :get + path = "#{path}?#{body_to_path(body)}" if body.present? + fhir_client(client).send(:get, path, operation_headers) + else + Inferno::Application[:logger].error "Cannot perform #{operation_method} requests, use GET or POST" + raise ArgumentError, "Cannot perform #{operation_method} requests, use GET or POST" + end + end + end +end+ |
+
Perform a FHIR patch interaction.
+ + +
+ + + +228 +229 +230 +231 +232 +233 +234+ |
+
+ # File 'lib/inferno/dsl/fhir_client.rb', line 228 + +def fhir_patch(resource_type, id, patchset, client: :default, name: nil, tags: []) + store_request_and_refresh_token(fhir_client(client), name, ) do + tcp_exception_handler do + fhir_client(client).partial_update(fhir_class_from_resource_type(resource_type), id, patchset) + end + end +end+ |
+
Perform a FHIR read interaction.
+ + +
+ + + +175 +176 +177 +178 +179 +180 +181+ |
+
+ # File 'lib/inferno/dsl/fhir_client.rb', line 175 + +def fhir_read(resource_type, id, client: :default, name: nil, tags: []) + store_request_and_refresh_token(fhir_client(client), name, ) do + tcp_exception_handler do + fhir_client(client).read(fhir_class_from_resource_type(resource_type), id) + end + end +end+ |
+
Perform a FHIR search interaction.
+ + +
+ + + +269 +270 +271 +272 +273 +274 +275 +276 +277 +278 +279 +280 +281 +282 +283 +284 +285 +286 +287 +288 +289 +290 +291 +292 +293 +294+ |
+
+ # File 'lib/inferno/dsl/fhir_client.rb', line 269 + +def fhir_search( + resource_type = nil, + client: :default, + params: {}, + name: nil, + search_method: :get, + tags: [] +) + search = + if search_method == :post + { body: params } + else + { parameters: params } + end + + store_request_and_refresh_token(fhir_client(client), name, ) do + tcp_exception_handler do + if resource_type + fhir_client(client) + .search(fhir_class_from_resource_type(resource_type), { search: }) + else + fhir_client(client).search_all({ search: }) + end + end + end +end+ |
+
Perform a FHIR batch/transaction interaction.
+ + +
+ + + +321 +322 +323 +324 +325 +326 +327 +328+ |
+
+ # File 'lib/inferno/dsl/fhir_client.rb', line 321 + +def fhir_transaction(bundle = nil, client: :default, name: nil, tags: []) + store_request('outgoing', name:, tags:) do + tcp_exception_handler do + fhir_client(client).transaction_bundle = bundle if bundle.present? + fhir_client(client).end_transaction + end + end +end+ |
+
Perform a FHIR update interaction.
+ + +
+ + + +210 +211 +212 +213 +214 +215 +216+ |
+
+ # File 'lib/inferno/dsl/fhir_client.rb', line 210 + +def fhir_update(resource, id, client: :default, name: nil, tags: []) + store_request_and_refresh_token(fhir_client(client), name, ) do + tcp_exception_handler do + fhir_client(client).update(resource, id) + end + end +end+ |
+
Perform a FHIR vread interaction.
+ + +
+ + + +193 +194 +195 +196 +197 +198 +199+ |
+
+ # File 'lib/inferno/dsl/fhir_client.rb', line 193 + +def fhir_vread(resource_type, id, version_id, client: :default, name: nil, tags: []) + store_request_and_refresh_token(fhir_client(client), name, ) do + tcp_exception_handler do + fhir_client(client).vread(fhir_class_from_resource_type(resource_type), id, version_id) + end + end +end+ |
+
Define a FHIR client to be used by a Runnable.
+This method returns an undefined value.
Define a FHIR client to be used by a Runnable.
+ + +
+ + + +387 +388 +389+ |
+
+ # File 'lib/inferno/dsl/fhir_client.rb', line 387 + +def fhir_client(name = :default, &block) + fhir_client_definitions[name] = block +end+ |
+
DSL for configuring FHIR clients
+ + +Returns the value of attribute runnable.
+Define auth info for a client.
+Define the bearer token for a client.
+Define custom headers for a client.
+Define OAuth credentials for a client.
+Define the base FHIR url for a client.
++ This class handles dynamic methods through the method_missing method + +
+ +
+ + + +121 +122 +123 +124 +125+ |
+
+ # File 'lib/inferno/dsl/fhir_client_builder.rb', line 121 + +def method_missing(name, ...) + return runnable.send(name, ...) if runnable.respond_to? name + + super +end+ |
+
Returns the value of attribute runnable.
+ + +
+ + + +38 +39 +40+ |
+
+ # File 'lib/inferno/dsl/fhir_client_builder.rb', line 38 + +def runnable + @runnable +end+ |
+
This method returns an undefined value.
Define auth info for a client. Auth info contains info needed for client +to perform authorization and refresh access token when necessary
+ + +
+ + + +103 +104 +105 +106 +107 +108 +109 +110+ |
+
+ # File 'lib/inferno/dsl/fhir_client_builder.rb', line 103 + +def auth_info(auth_info = nil) + @auth_info ||= + if auth_info.is_a? Symbol + runnable.send(auth_info) + else + auth_info + end +end+ |
+
This method returns an undefined value.
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.
+ + +
+ + + +75 +76 +77 +78 +79 +80 +81 +82+ |
+
+ # File 'lib/inferno/dsl/fhir_client_builder.rb', line 75 + +def bearer_token(bearer_token = nil) + @bearer_token ||= + if bearer_token.is_a? Symbol + runnable.send(bearer_token) + else + bearer_token + end +end+ |
+
This method returns an undefined value.
Define custom headers for a client
+ + +
+ + + +116 +117 +118+ |
+
+ # File 'lib/inferno/dsl/fhir_client_builder.rb', line 116 + +def headers(headers = nil) + @headers ||= headers +end+ |
+
This method returns an undefined value.
Define OAuth credentials for a client. These can allow a client to +automatically refresh its access token when it expires.
+ + +
+ + + +89 +90 +91 +92 +93 +94 +95 +96+ |
+
+ # File 'lib/inferno/dsl/fhir_client_builder.rb', line 89 + +def oauth_credentials(oauth_credentials = nil) + @oauth_credentials ||= + if oauth_credentials.is_a? Symbol + runnable.send(oauth_credentials) + else + oauth_credentials + end +end+ |
+
This method returns an undefined value.
Define the base FHIR url for a client. A string or symbol can be provided. +A string is interpreted as a url. A symbol is interpreted as the name of +an input to the Runnable.
+ + +
+ + + +60 +61 +62 +63 +64 +65 +66 +67+ |
+
+ # File 'lib/inferno/dsl/fhir_client_builder.rb', line 60 + +def url(url = nil) + @url ||= + if url.is_a? Symbol + runnable.send(url) + else + url + end&.chomp('/') +end+ |
+
+ + + Modules: DatasetLoader + + + + Classes: Config, EvaluationContext, EvaluationResult, Evaluator, Rule + + +
+ + + + + + + + + +File.join(__dir__, 'default.yml')
Returns the value of attribute data.
+To-do: add config_file as arguments.
+To-do: add config_file as arguments
+ + +
+ + + +9 +10 +11 +12 +13 +14 +15 +16 +17+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/config.rb', line 9 + +def initialize(config_file = nil) + @data = if config_file.nil? + YAML.load_file(File.absolute_path(DEFAULT_FILE)) + else + YAML.load_file(File.absolute_path(config_file)) + end + + raise(TypeError, 'Malformed configuration') unless @data.is_a?(Hash) +end+ |
+
Returns the value of attribute data.
+ + +
+ + + +6 +7 +8+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/config.rb', line 6 + +def data + @data +end+ |
+
+ + + +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/dataset_loader.rb', line 5 + +def self.from_contents(source_array) + dataset = [] + + source_array.each do |json| + resource = FHIR::Json.from_json(json) + next if resource.nil? + + dataset.push resource + end + + dataset +end+ |
+
+ + + +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/dataset_loader.rb', line 18 + +def self.from_path(path) + dataset = [] + + Dir["#{path}/*.json"].each do |f| + resource = FHIR::Json.from_json(File.read(f)) + next if resource.nil? + + dataset.push resource + end + + dataset +end+ |
+
EvaluationContext is a wrapper class around the concepts needed to perform an evaluation: +- The IG used as the basis for evaluation +- The data being evaluated +- A summary/characterization of the data +- Evaluation results
+ + +Returns the value of attribute config.
+Returns the value of attribute data.
+Returns the value of attribute ig.
+Returns the value of attribute results.
+rubocop:disable Naming/MethodParameterName.
+rubocop:disable Naming/MethodParameterName
+ + +
+ + + +12 +13 +14 +15 +16 +17+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_context.rb', line 12 + +def initialize(ig, data, config) # rubocop:disable Naming/MethodParameterName + @ig = ig + @data = data + @results = [] + @config = config +end+ |
+
Returns the value of attribute config.
+ + +
+ + + +10 +11 +12+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_context.rb', line 10 + +def config + @config +end+ |
+
Returns the value of attribute data.
+ + +
+ + + +10 +11 +12+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_context.rb', line 10 + +def data + @data +end+ |
+
Returns the value of attribute ig.
+ + +
+ + + +10 +11 +12+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_context.rb', line 10 + +def ig + @ig +end+ |
+
Returns the value of attribute results.
+ + +
+ + + +10 +11 +12+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_context.rb', line 10 + +def results + @results +end+ |
+
+ + + +19 +20 +21+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_context.rb', line 19 + +def add_result(result) + results.push result +end+ |
+
The result of a Rule evaluating a data set.
+ + +Returns the value of attribute issue_type.
+Returns the value of attribute message.
+Returns the value of attribute rule.
+Returns the value of attribute severity.
+Returns the value of attribute threshold.
+Returns the value of attribute value.
+A new instance of EvaluationResult.
+Returns a new instance of EvaluationResult.
+ + +
+ + + +13 +14 +15 +16 +17 +18 +19 +20+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_result.rb', line 13 + +def initialize(, severity: 'warning', issue_type: 'business-rule', threshold: nil, value: nil, rule: nil) + @message = + @severity = severity + @issue_type = issue_type + @threshold = threshold + @value = value + @rule = rule +end+ |
+
Returns the value of attribute issue_type.
+ + +
+ + + +6 +7 +8+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_result.rb', line 6 + +def issue_type + @issue_type +end+ |
+
Returns the value of attribute message.
+ + +
+ + + +6 +7 +8+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_result.rb', line 6 + +def + @message +end+ |
+
Returns the value of attribute rule.
+ + +
+ + + +6 +7 +8+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_result.rb', line 6 + +def rule + @rule +end+ |
+
Returns the value of attribute severity.
+ + +
+ + + +6 +7 +8+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_result.rb', line 6 + +def severity + @severity +end+ |
+
Returns the value of attribute threshold.
+ + +
+ + + +6 +7 +8+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_result.rb', line 6 + +def threshold + @threshold +end+ |
+
Returns the value of attribute value.
+ + +
+ + + +6 +7 +8+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_result.rb', line 6 + +def value + @value +end+ |
+
+ + + +54 +55 +56 +57 +58+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_result.rb', line 54 + +def self.to_operation_outcome(results) + FHIR::OperationOutcome.new({ + issue: results.map(&:to_oo_issue) + }) +end+ |
+
+ + + +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_result.rb', line 26 + +def to_oo_issue + issue = { + severity:, + code: issue_type, + details: { text: } + } + + if threshold + issue[:extension] ||= [] + issue[:extension].push({ + # TODO: pick real extension for this + url: 'https://inferno-framework.github.io/fhir_evaluator/StructureDefinition/operationoutcome-issue-threshold', + valueDecimal: threshold + }) + end + + if value + issue[:extension] ||= [] + issue[:extension].push({ + # TODO: pick real extension for this + url: 'https://inferno-framework.github.io/fhir_evaluator/StructureDefinition/operationoutcome-issue-value', + valueDecimal: value + }) + end + + issue +end+ |
+
+ + + +22 +23 +24+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluation_result.rb', line 22 + +def to_s + "#{severity.upcase}: #{}" +end+ |
+
Returns the value of attribute ig.
+rubocop:disable Naming/MethodParameterName.
+rubocop:disable Naming/MethodParameterName
+ + +
+ + + +15 +16 +17+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluator.rb', line 15 + +def initialize(ig) # rubocop:disable Naming/MethodParameterName + @ig = ig +end+ |
+
Returns the value of attribute ig.
+ + +
+ + + +13 +14 +15+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluator.rb', line 13 + +def ig + @ig +end+ |
+
+ + + +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/evaluator.rb', line 19 + +def evaluate(data, config = Config.new) + context = EvaluationContext.new(@ig, data, config) + + active_rules = [] + config.data['Rule'].each do |rulename, rule_details| + active_rules << rulename if rule_details['Enabled'] + end + + Rule.descendants.each do |rule| + rule.new.check(context) if active_rules.include?(rule.name.demodulize) + end + + context.results +end+ |
+
+ + + +7 +8 +9+ |
+
+ # File 'lib/inferno/dsl/fhir_evaluation/rule.rb', line 7 + +def check(_context) + raise 'not implemented' +end+ |
+
This module contains the methods needed to configure a validator to
+perform validation of FHIR resources. The actual validation is performed
+by an external FHIR validation service. Tests will typically rely on
+assert_valid_resource for validation rather than directly calling
+methods on a validator.
+ + + Modules: ClassMethods + + + + Classes: Validator + + +
+ + + + + + + + + +Define a validator.
+Define a validator
+ + +
+ + + +383 +384 +385 +386 +387 +388 +389 +390 +391 +392+ |
+
+ # File 'lib/inferno/dsl/fhir_resource_validation.rb', line 383 + +def fhir_resource_validator(name = :default, required_suite_options: nil, &block) + current_validators = fhir_validators[name] || [] + + new_validator = Inferno::DSL::FHIRResourceValidation::Validator.new(name, id, , &block) + + current_validators.reject! { |validator| validator.requirements == } + current_validators << new_validator + + fhir_validators[name] = current_validators +end+ |
+
Returns the value of attribute name.
+Returns the value of attribute requirements.
+Returns the value of attribute session_id.
+Returns the value of attribute test_suite_id.
+Set the cliContext used as part of each validation request.
+Filter out unwanted validation messages.
+Set the IGs that the validator will need to load.
+Perform validation steps in addition to FHIR validation.
+Set the url of the validator service.
+Post a resource to the validation service for validating.
+Returns the value of attribute name.
+ + +
+ + + +30 +31 +32+ |
+
+ # File 'lib/inferno/dsl/fhir_resource_validation.rb', line 30 + +def name + @name +end+ |
+
Returns the value of attribute requirements.
+ + +
+ + + +29 +30 +31+ |
+
+ # File 'lib/inferno/dsl/fhir_resource_validation.rb', line 29 + +def requirements + @requirements +end+ |
+
Returns the value of attribute session_id.
+ + +
+ + + +30 +31 +32+ |
+
+ # File 'lib/inferno/dsl/fhir_resource_validation.rb', line 30 + +def session_id + @session_id +end+ |
+
Returns the value of attribute test_suite_id.
+ + +
+ + + +30 +31 +32+ |
+
+ # File 'lib/inferno/dsl/fhir_resource_validation.rb', line 30 + +def test_suite_id + @test_suite_id +end+ |
+
Set the cliContext used as part of each validation request. +Fields may be passed as either a Hash or block. +Note that all fields included here will be sent directly in requests, +there is no check that the fields are correct.
+ + +
+ + + +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109+ |
+
+ # File 'lib/inferno/dsl/fhir_resource_validation.rb', line 98 + +def cli_context(definition = nil, &) + if @cli_context + if definition + @cli_context.definition.merge!(definition.deep_symbolize_keys) + elsif block_given? + @cli_context.instance_eval(&) + end + else + @cli_context = CliContext.new(definition || {}, &) + end + @cli_context +end+ |
+
Filter out unwanted validation messages. Any messages for which the +block evalutates to a truthy value will be excluded.
+ + +
+ + + +154 +155 +156 +157+ |
+
+ # File 'lib/inferno/dsl/fhir_resource_validation.rb', line 154 + +def (&block) + @exclude_message = block if block_given? + @exclude_message +end+ |
+
Set the IGs that the validator will need to load
+ + +
+ + + +64 +65 +66 +67 +68+ |
+
+ # File 'lib/inferno/dsl/fhir_resource_validation.rb', line 64 + +def igs(*validator_igs) + cli_context(igs: validator_igs) if validator_igs + + cli_context.igs +end+ |
+
Perform validation steps in addition to FHIR validation.
+ + +
+ + + +135 +136 +137+ |
+
+ # File 'lib/inferno/dsl/fhir_resource_validation.rb', line 135 + +def perform_additional_validation(&block) + additional_validations << block +end+ |
+
+ + + +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192+ |
+
+ # File 'lib/inferno/dsl/fhir_resource_validation.rb', line 160 + +def resource_is_valid?(resource, profile_url, runnable) + profile_url ||= FHIR::Definitions.resource_definition(resource.resourceType).url + + begin + response = call_validator(resource, profile_url) + rescue StandardError => e + # This could be a complete failure to connect (validator isn't running) + # or a timeout (validator took too long to respond). + runnable.('error', e.) + raise Inferno::Exceptions::ErrorInValidatorException, "Unable to connect to validator at #{url}." + end + + outcome = operation_outcome_from_validator_response(response, runnable) + + = (outcome, resource, profile_url) + + + .each { || runnable.([:type], [:message]) } + + unless response.status == 200 + raise Inferno::Exceptions::ErrorInValidatorException, + 'Error occurred in the validator. Review Messages tab or validator service logs for more information.' + end + + + .none? { || [:type] == 'error' } +rescue Inferno::Exceptions::ErrorInValidatorException + raise +rescue StandardError => e + runnable.('error', e.) + raise Inferno::Exceptions::ErrorInValidatorException, + 'Error occurred in the validator. Review Messages tab or validator service logs for more information.' +end+ |
+
Set the url of the validator service
+ + +
+ + + +52 +53 +54 +55 +56+ |
+
+ # File 'lib/inferno/dsl/fhir_resource_validation.rb', line 52 + +def url(validator_url = nil) + @url = validator_url if validator_url + @url ||= default_validator_url + @url +end+ |
+
Post a resource to the validation service for validating.
+ + +
+ + + +273 +274 +275+ |
+
+ # File 'lib/inferno/dsl/fhir_resource_validation.rb', line 273 + +def validate(resource, profile_url) + call_validator(resource, profile_url).body +end+ |
+
+ + + +45 +46 +47+ |
+
+ # File 'lib/inferno/dsl/fhir_resource_validation.rb', line 45 + +def validator_session_repo + @validator_session_repo ||= Inferno::Repositories::ValidatorSessions.new +end+ |
+
This module contains the methods needed to configure a validator to
+perform validation of FHIR resources. The actual validation is performed
+by an external FHIR validation service. Tests will typically rely on
+assert_valid_resource for validation rather than directly calling
+methods on a validator.
+ + + Modules: ClassMethods + + + + Classes: Validator + + +
+ + + + + + + + +Find a particular validator.
+Perform validation, and add validation messages to the runnable.
+Find a particular validator. Looks through a runnable’s parents up to +the suite to find a validator with a particular name
+ + +
+ + + +40 +41 +42+ |
+
+ # File 'lib/inferno/dsl/fhir_validation.rb', line 40 + +def find_validator(validator_name) + self.class.find_validator(validator_name, ) +end+ |
+
Perform validation, and add validation messages to the runnable
+ + +
+ + + +34 +35 +36+ |
+
+ # File 'lib/inferno/dsl/fhir_validation.rb', line 34 + +def resource_is_valid?(resource: self.resource, profile_url: nil, validator: :default) + find_validator(validator).resource_is_valid?(resource, profile_url, self) +end+ |
+
Find a particular validator.
+Define a validator.
+Find a particular validator. Looks through a runnable’s parents up to +the suite to find a validator with a particular name
+ + +
+ + + +270 +271 +272 +273 +274 +275 +276 +277 +278 +279 +280 +281 +282 +283 +284 +285 +286+ |
+
+ # File 'lib/inferno/dsl/fhir_validation.rb', line 270 + +def find_validator(validator_name, = nil) + validators = fhir_validators[validator_name] || + Array.wrap(parent&.find_validator(validator_name, )) + + validator = + if .present? + validators.find do |possible_validator| + possible_validator.requirements.nil? || >= possible_validator.requirements + end + else + validators.first + end + + raise Exceptions::ValidatorNotFoundException, validator_name if validator.nil? + + validator +end+ |
+
Define a validator
+ + +
+ + + +257 +258 +259 +260 +261 +262 +263 +264 +265 +266+ |
+
+ # File 'lib/inferno/dsl/fhir_validation.rb', line 257 + +def validator(name = :default, required_suite_options: nil, &block) + current_validators = fhir_validators[name] || [] + + new_validator = Inferno::DSL::FHIRValidation::Validator.new(, &block) + + current_validators.reject! { |validator| validator.requirements == } + current_validators << new_validator + + fhir_validators[name] = current_validators +end+ |
+
Returns the value of attribute requirements.
+Filter out unwanted validation messages.
+Perform validation steps in addition to FHIR validation.
+Set the url of the validator service.
+Post a resource to the validation service for validating.
+Returns the value of attribute requirements.
+ + +
+ + + +45 +46 +47+ |
+
+ # File 'lib/inferno/dsl/fhir_validation.rb', line 45 + +def requirements + @requirements +end+ |
+
Filter out unwanted validation messages. Any messages for which the +block evalutates to a truthy value will be excluded.
+ + +
+ + + +110 +111 +112 +113+ |
+
+ # File 'lib/inferno/dsl/fhir_validation.rb', line 110 + +def (&block) + @exclude_message = block if block_given? + @exclude_message +end+ |
+
Perform validation steps in addition to FHIR validation.
+ + +
+ + + +91 +92 +93+ |
+
+ # File 'lib/inferno/dsl/fhir_validation.rb', line 91 + +def perform_additional_validation(&block) + additional_validations << block +end+ |
+
+ + + +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147+ |
+
+ # File 'lib/inferno/dsl/fhir_validation.rb', line 116 + +def resource_is_valid?(resource, profile_url, runnable) + profile_url ||= FHIR::Definitions.resource_definition(resource.resourceType).url + + begin + response = call_validator(resource, profile_url) + rescue StandardError => e + # This could be a complete failure to connect (validator isn't running) + # or a timeout (validator took too long to respond). + runnable.('error', e.) + raise Inferno::Exceptions::ErrorInValidatorException, "Unable to connect to validator at #{url}." + end + outcome = operation_outcome_from_validator_response(response, runnable) + + = (outcome, resource, profile_url) + + + .each { || runnable.([:type], [:message]) } + + unless response.status == 200 + raise Inferno::Exceptions::ErrorInValidatorException, + 'Error occurred in the validator. Review Messages tab or validator service logs for more information.' + end + + + .none? { || [:type] == 'error' } +rescue Inferno::Exceptions::ErrorInValidatorException + raise +rescue StandardError => e + runnable.('error', e.) + raise Inferno::Exceptions::ErrorInValidatorException, + 'Error occurred in the validator. Review Messages tab or validator service logs for more information.' +end+ |
+
Set the url of the validator service
+ + +
+ + + +61 +62 +63 +64 +65+ |
+
+ # File 'lib/inferno/dsl/fhir_validation.rb', line 61 + +def url(validator_url = nil) + @url = validator_url if validator_url + @url ||= default_validator_url + @url +end+ |
+
Post a resource to the validation service for validating.
+ + +
+ + + +203 +204 +205+ |
+
+ # File 'lib/inferno/dsl/fhir_validation.rb', line 203 + +def validate(resource, profile_url) + call_validator(resource, profile_url).body +end+ |
+
the element field can either be a primitive value (string, boolean, etc.) or a FHIR::Model.
This module contains the methods needed to perform FHIRPath evaluations +on FHIR resources/elements. The actual evaluation is typically performed by an external +FHIRPath evaluation service.
+ +Tests can leverage the evaluation functionality by calling evaluate_fhirpath to retrieve
+results of FHIRPath expressions.
results will be an array representing the result of evaluating the given
+expression against the given root element. Each “result” in the returned
+array will be in the form
+{ "type": "[FHIR datatype of the result]", "element": "[result value of the FHIRPath expression]" }.
+ + + Modules: ClassMethods + + + + Classes: Evaluator + + +
+ + + + + + + + +Evaluates a fhirpath expression for a given FHIR resource.
+Evaluates a fhirpath expression for a given FHIR resource
+ + +
+ + + +31 +32 +33+ |
+
+ # File 'lib/inferno/dsl/fhirpath_evaluation.rb', line 31 + +def evaluate_fhirpath(resource:, path:, url: nil) + self.class.evaluator(url).evaluate_fhirpath(resource, path, self) +end+ |
+
Evaluates a fhirpath expression for a given FHIR resource.
+Set/Get the url of the fhirpath service.
+
+ + + +96 +97 +98 +99 +100 +101 +102 +103 +104 +105+ |
+
+ # File 'lib/inferno/dsl/fhirpath_evaluation.rb', line 96 + +def call_fhirpath_service(fhir_resource, fhirpath_expression) + Faraday.new( + url, + request: { timeout: 600 } + ).post( + "evaluate?path=#{fhirpath_expression}", + fhir_resource.to_json, + content_type: 'application/json' + ) +end+ |
+
the element field can either be a primitive value (string, boolean, etc.) or a FHIR::Model.
Evaluates a fhirpath expression for a given FHIR resource
+ + +
+ + + +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83+ |
+
+ # File 'lib/inferno/dsl/fhirpath_evaluation.rb', line 63 + +def evaluate_fhirpath(fhir_resource, fhirpath_expression, runnable) + begin + response = call_fhirpath_service(fhir_resource, fhirpath_expression) + rescue StandardError => e + # This could be a complete failure to connect (fhirpath service isn't running) + # or a timeout (fhirpath service took too long to respond). + runnable.('error', e.) + raise Inferno::Exceptions::ErrorInFhirpathException, "Unable to connect to FHIRPath service at #{url}." + end + + sanitized_body = remove_invalid_characters(response.body) + return transform_fhirpath_results(JSON.parse(sanitized_body)) if response.status.to_s.start_with? '2' + + runnable.('error', "FHIRPath service Response: HTTP #{response.status}\n#{sanitized_body}") + raise Inferno::Exceptions::ErrorInFhirpathException, + 'FHIRPath service call failed. Review Messages tab for more information.' +rescue JSON::ParserError + runnable.('error', "Invalid FHIRPath service response format:\n#{sanitized_body}") + raise Inferno::Exceptions::ErrorInFhirpathException, + 'Error occurred in the FHIRPath service. Review Messages tab for more information.' +end+ |
+
Set/Get the url of the fhirpath service
+ + +
+ + + +50 +51 +52+ |
+
+ # File 'lib/inferno/dsl/fhirpath_evaluation.rb', line 50 + +def url(fhirpath_url = nil) + @url ||= fhirpath_url || default_fhirpath_url +end+ |
+
This module contains the HTTP DSL available to test writers.
+ + ++ + + Modules: ClassMethods + + + + +
+ + + + + + + + +Perform an HTTP DELETE request.
+Perform an HTTP GET request.
+Return a previously defined HTTP client.
+Perform an HTTP POST request.
+Perform an HTTP GET request and stream the response.
+Perform an HTTP DELETE request
+ + +
+ + + +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150+ |
+
+ # File 'lib/inferno/dsl/http_client.rb', line 136 + +def delete(url = '', client: :default, name: :nil, headers: nil, tags: []) + store_request('outgoing', name:, tags:) do + tcp_exception_handler do + client = http_client(client) + + if client + client.delete(url, nil, headers) + elsif url.match?(%r{\Ahttps?://}) + connection.delete(url, nil, headers) + else + raise StandardError, 'Must use an absolute url or define an HTTP client with a base url' + end + end + end +end+ |
+
Perform an HTTP GET request
+ + +
+ + + +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87+ |
+
+ # File 'lib/inferno/dsl/http_client.rb', line 73 + +def get(url = '', client: :default, name: nil, headers: nil, tags: []) + store_request('outgoing', name:, tags:) do + tcp_exception_handler do + client = http_client(client) + + if client + client.get(url, nil, headers) + elsif url.match?(%r{\Ahttps?://}) + connection.get(url, nil, headers) + else + raise StandardError, 'Must use an absolute url or define an HTTP client with a base url' + end + end + end +end+ |
+
Return a previously defined HTTP client
+ + +
+ + + +46 +47 +48 +49 +50 +51 +52 +53 +54 +55+ |
+
+ # File 'lib/inferno/dsl/http_client.rb', line 46 + +def http_client(client = :default) + return http_clients[client] if http_clients[client] + + definition = self.class.http_client_definitions[client] + return nil if definition.nil? + + tcp_exception_handler do + http_clients[client] = HTTPClientBuilder.new.build(self, definition) + end +end+ |
+
Perform an HTTP POST request
+ + +
+ + + +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123+ |
+
+ # File 'lib/inferno/dsl/http_client.rb', line 109 + +def post(url = '', body: nil, client: :default, name: nil, headers: nil, tags: []) + store_request('outgoing', name:, tags:) do + tcp_exception_handler do + client = http_client(client) + + if client + client.post(url, body, headers) + elsif url.match?(%r{\Ahttps?://}) + connection.post(url, body, headers) + else + raise StandardError, 'Must use an absolute url or define an HTTP client with a base url' + end + end + end +end+ |
+
Perform an HTTP GET request and stream the response
+ + +
+ + + +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191+ |
+
+ # File 'lib/inferno/dsl/http_client.rb', line 167 + +def stream(block, url = '', limit = 100, client: :default, name: nil, headers: nil, tags: []) + streamed = [] + + collector = proc do |chunk, bytes| + streamed << chunk if limit.positive? + limit -= 1 + block.call(chunk, bytes) + end + + store_request('outgoing', name:, tags:) do + tcp_exception_handler do + client = http_client(client) + + if client + response = client.get(url, nil, headers) { |req| req..on_data = collector } + elsif url.match?(%r{\Ahttps?://}) + response = connection.get(url, nil, headers) { |req| req..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 +end+ |
+
Define a HTTP client to be used by a Runnable.
+This method returns an undefined value.
Define a HTTP client to be used by a Runnable.
+ + +
+ + + +206 +207 +208+ |
+
+ # File 'lib/inferno/dsl/http_client.rb', line 206 + +def http_client(name = :default, &block) + http_client_definitions[name] = block +end+ |
+
This module contains the HTTP DSL available to test writers.
+ + +Returns the value of attribute runnable.
+Define custom headers for a client.
+Define the base url for an HTTP client.
++ This class handles dynamic methods through the method_missing method + +
+ +
+ + + +47 +48 +49 +50 +51+ |
+
+ # File 'lib/inferno/dsl/http_client_builder.rb', line 47 + +def method_missing(name, ...) + return runnable.send(name, ...) if runnable.respond_to? name + + super +end+ |
+
Returns the value of attribute runnable.
+ + +
+ + + +7 +8 +9+ |
+
+ # File 'lib/inferno/dsl/http_client_builder.rb', line 7 + +def runnable + @runnable +end+ |
+
This method returns an undefined value.
Define custom headers for a client
+ + +
+ + + +42 +43 +44+ |
+
+ # File 'lib/inferno/dsl/http_client_builder.rb', line 42 + +def headers(headers = nil) + @headers ||= headers +end+ |
+
This method returns an undefined value.
Define the base url for an HTTP client. A string or symbol can be +provided. A string is interpreted as a url. A symbol is interpreted as +the name of an input to the Runnable.
+ + +
+ + + +29 +30 +31 +32 +33 +34 +35 +36+ |
+
+ # File 'lib/inferno/dsl/http_client_builder.rb', line 29 + +def url(url = nil) + @url ||= + if url.is_a? Symbol + runnable.send(url) + else + url + end +end+ |
+
Define inputs.
+Define a particular order for inputs to be presented in the API/UI.
+Define outputs.
+This method returns an undefined value.
Define inputs
+ + +
+ + + +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44+ |
+
+ # File 'lib/inferno/dsl/input_output_handling.rb', line 24 + +def input(identifier, *other_identifiers, **input_params) + if other_identifiers.present? + [identifier, *other_identifiers].compact.each do |input_identifier| + inputs << input_identifier + config.add_input(input_identifier) + children + .reject { |child| child.inputs.include? input_identifier } + .each do |child| + child.input(input_identifier) + end + end + else + inputs << identifier + config.add_input(identifier, input_params) + children + .reject { |child| child.inputs.include? identifier } + .each do |child| + child.input(identifier, **input_params) + end + end +end+ |
+
Define a particular order for inputs to be presented in the API/UI
+ + +
+ + + +116 +117 +118 +119 +120+ |
+
+ # File 'lib/inferno/dsl/input_output_handling.rb', line 116 + +def input_order(*new_input_order) + return @input_order = new_input_order if new_input_order.present? + + @input_order ||= [] +end+ |
+
This method returns an undefined value.
Define outputs
+ + +
+ + + +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77+ |
+
+ # File 'lib/inferno/dsl/input_output_handling.rb', line 57 + +def output(identifier, *other_identifiers, **output_definition) + if other_identifiers.present? + [identifier, *other_identifiers].compact.each do |output_identifier| + outputs << output_identifier + config.add_output(output_identifier) + children + .reject { |child| child.outputs.include? output_identifier } + .each do |child| + child.output(output_identifier) + end + end + else + outputs << identifier + config.add_output(identifier, output_definition) + children + .reject { |child| child.outputs.include? identifier } + .each do |child| + child.output(identifier, **output_definition) + end + end +end+ |
+
The JWKS class provides methods to handle JSON Web Key Sets (JWKS) +within Inferno.
+ +This class allows users to fetch, parse, and manage JWKS, ensuring +that the necessary keys for verifying tokens are available.
+ + +Parses and returns a JWT::JWK::Set object from the provided JWKS string or from the file located at the JWKS path.
Returns a formatted JSON string of the JWKS public keys that are used for verification.
+Parses and returns a JWT::JWK::Set object from the provided JWKS string
+or from the file located at the JWKS path. If a user-provided JWKS string
+is not available, it reads the JWKS from the file.
+ + + +71 +72 +73+ |
+
+ # File 'lib/inferno/dsl/jwks.rb', line 71 + +def jwks(user_jwks: nil) + JWT::JWK::Set.new(JSON.parse(user_jwks.presence || default_jwks_json)) +end+ |
+
Returns a formatted JSON string of the JWKS public keys that are used for verification. +This method filters out keys that do not have the ‘verify’ operation.
+ + +
+ + + +18 +19 +20 +21 +22 +23+ |
+
+ # File 'lib/inferno/dsl/jwks.rb', line 18 + +def jwks_json + @jwks_json ||= + JSON.pretty_generate( + { keys: jwks.export[:keys].select { |key| key[:key_ops]&.include?('verify') } } + ) +end+ |
+
This module contains methods to add test suite links which are displayed in the footer of the UI
+ + +{ + 'report_issue' => 'Report Issue', + 'source_code' => 'Open Source', + 'download' => 'Download', + 'ig' => 'Implementation Guide' +}.freeze
Add a link to the test suit links list.
+Add a link to the latest release version of the test kit.
+Add a link to the implementation guide.
+Set/get a list of links which are displayed in the footer of the UI.
+Add a link to report an issue in the footer of the UI.
+Add a link to the source code repository.
+Add a link to the test suit links list.
+ + +
+ + + +51 +52 +53+ |
+
+ # File 'lib/inferno/dsl/links.rb', line 51 + +def add_link(type, label, url) + links << { type:, label:, url: } +end+ |
+
Add a link to the latest release version of the test kit.
+ + +
+ + + +78 +79 +80+ |
+
+ # File 'lib/inferno/dsl/links.rb', line 78 + +def download_url(url, label: nil) + add_predefined_link('download', url, label) +end+ |
+
Add a link to the implementation guide.
+ + +
+ + + +69 +70 +71+ |
+
+ # File 'lib/inferno/dsl/links.rb', line 69 + +def ig_url(url, label: nil) + add_predefined_link('ig', url, label) +end+ |
+
Set/get a list of links which are displayed in the footer of the UI.
+ + +
+ + + +33 +34 +35 +36 +37 +38+ |
+
+ # File 'lib/inferno/dsl/links.rb', line 33 + +def links(links = nil) + @links ||= [] + return @links if links.nil? + + @links.concat(links) +end+ |
+
Add a link to report an issue in the footer of the UI.
+ + +
+ + + +87 +88 +89+ |
+
+ # File 'lib/inferno/dsl/links.rb', line 87 + +def report_issue_url(url, label: nil) + add_predefined_link('report_issue', url, label) +end+ |
+
Add a link to the source code repository.
+ + +
+ + + +60 +61 +62+ |
+
+ # File 'lib/inferno/dsl/links.rb', line 60 + +def source_code_url(url, label: nil) + add_predefined_link('source_code', url, label) +end+ |
+
This module contains methods to add meessages to runnable results
+ + +Add a message to the result.
+Add an informational message to the results of a test.
+Add a warning message to the results of a test.
+This method returns an undefined value.
Add a message to the result.
+ + +
+ + + +18 +19 +20+ |
+
+ # File 'lib/inferno/dsl/messages.rb', line 18 + +def (type, ) + << { type: type.to_s, message: format_markdown() } +end+ |
+
This method returns an undefined value.
Add an informational message to the results of a test. If passed a +block, a failed assertion will become an info message and test execution +will continue.
+ + +
+ + + +35 +36 +37 +38 +39 +40 +41 +42 +43 +44+ |
+
+ # File 'lib/inferno/dsl/messages.rb', line 35 + +def info( = nil) + unless block_given? + ('info', ) unless .nil? + return + end + + yield +rescue Exceptions::AssertionException => e + ('info', e.) +end+ |
+
This method returns an undefined value.
Add a warning message to the results of a test. If passed a block, a +failed assertion will become a warning message and test execution will +continue.
+ + +
+ + + +59 +60 +61 +62 +63 +64 +65 +66 +67 +68+ |
+
+ # File 'lib/inferno/dsl/messages.rb', line 59 + +def warning( = nil) + unless block_given? + ('warning', ) unless .nil? + return + end + + yield +rescue Exceptions::AssertionException => e + ('warning', e.) +end+ |
+
OAuthCredentials provide a user with a single input which allows a fhir +client to use a bearer token and automatically refresh the token when it +expires.
+ + +[ + :access_token, + :refresh_token, + :token_url, + :client_id, + :client_secret, + :token_retrieval_time, + :expires_in, + :name +].freeze
Returns the value of attribute client.
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/oauth_credentials.rb', line 24
+
+
+ |
+
Returns the value of attribute client.
+ + +
+ + + +22 +23 +24+ |
+
+ # File 'lib/inferno/dsl/oauth_credentials.rb', line 22 + +def client + @client +end+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/oauth_credentials.rb', line 24
+
+
+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/oauth_credentials.rb', line 24
+
+
+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/oauth_credentials.rb', line 24
+
+
+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/oauth_credentials.rb', line 24
+
+
+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/oauth_credentials.rb', line 24
+
+
+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/oauth_credentials.rb', line 24
+
+
+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/oauth_credentials.rb', line 24
+
+
+ |
+
This module handles storing and retrieving requests/responses made by +FHIR/HTTP clients
+ + ++ + + Modules: ClassMethods + + + + +
+ + + + + + + + +Returns requests which match all of the given tags.
+Returns the most recent FHIR/HTTP request.
+Returns the FHIR/HTTP requests that have been made in this Test.
Returns the FHIR resource from the response to the most recent FHIR request.
+Returns the response from the most recent FHIR/HTTP request.
+Returns requests which match all of the given tags
+ + +
+ + + +43 +44 +45 +46 +47 +48 +49+ |
+
+ # File 'lib/inferno/dsl/request_storage.rb', line 43 + +def load_tagged_requests(*) + return [] if .blank? + + Repositories::Requests.new.tagged_requests(test_session_id, ).tap do |tagged_requests| + requests.concat(tagged_requests) + end +end+ |
+
Returns the most recent FHIR/HTTP request
+ + +
+ + + +20 +21 +22+ |
+
+ # File 'lib/inferno/dsl/request_storage.rb', line 20 + +def request + requests.last +end+ |
+
Returns the FHIR/HTTP requests that have been made in this Test
+ + + +13 +14 +15+ |
+
+ # File 'lib/inferno/dsl/request_storage.rb', line 13 + +def requests + @requests ||= [] +end+ |
+
Returns the FHIR resource from the response to the most recent FHIR +request
+ + +
+ + + +35 +36 +37+ |
+
+ # File 'lib/inferno/dsl/request_storage.rb', line 35 + +def resource + request&.resource +end+ |
+
Returns the response from the most recent FHIR/HTTP request
+ + +
+ + + +27 +28 +29+ |
+
+ # File 'lib/inferno/dsl/request_storage.rb', line 27 + +def response + request&.response +end+ |
+
Specify the named requests made by a test.
+Specify the name for a request received by a test.
+Specify the named requests used by a test.
+This method returns an undefined value.
Specify the named requests made by a test
+ + +
+ + + +105 +106 +107 +108 +109 +110+ |
+
+ # File 'lib/inferno/dsl/request_storage.rb', line 105 + +def makes_request(*identifiers) + named_requests_made.concat(identifiers).uniq! + identifiers.each do |identifier| + config.add_request(identifier) + end +end+ |
+
This method returns an undefined value.
Specify the name for a request received by a test
+ + +
+ + + +116 +117 +118 +119+ |
+
+ # File 'lib/inferno/dsl/request_storage.rb', line 116 + +def receives_request(identifier) + config.add_request(identifier) + @incoming_request_name = identifier +end+ |
+
This method returns an undefined value.
Specify the named requests used by a test
+ + +
+ + + +130 +131 +132 +133 +134 +135+ |
+
+ # File 'lib/inferno/dsl/request_storage.rb', line 130 + +def uses_request(*identifiers) + named_requests_used.concat(identifiers).uniq! + identifiers.each do |identifier| + config.add_request(identifier) + end +end+ |
+
This module contains methods to set test results.
+ + +Halt execution of the current test and mark it as omitted.
+Halt execution of the current test and mark it as omitted if a condition is true.
+Halt execution of the current test and mark it as passed.
+Halt execution of the current test and mark it as passed if a condition is true.
+Halt execution of the current test and mark it as skipped.
+Halt execution of the current test and mark it as skipped if a condition is true.
+Halt execution of the current test and wait for execution to resume.
+This method returns an undefined value.
Halt execution of the current test and mark it as omitted.
+ + +
+ + + +45 +46 +47+ |
+
+ # File 'lib/inferno/dsl/results.rb', line 45 + +def omit( = '') + raise Exceptions::OmitException, +end+ |
+
This method returns an undefined value.
Halt execution of the current test and mark it as omitted if a condition +is true.
+ + +
+ + + +55 +56 +57+ |
+
+ # File 'lib/inferno/dsl/results.rb', line 55 + +def omit_if(test, = '') + raise Exceptions::OmitException, if test +end+ |
+
This method returns an undefined value.
Halt execution of the current test and mark it as passed.
+ + +
+ + + +9 +10 +11+ |
+
+ # File 'lib/inferno/dsl/results.rb', line 9 + +def pass( = '') + raise Exceptions::PassException, +end+ |
+
This method returns an undefined value.
Halt execution of the current test and mark it as passed if a condition +is true.
+ + +
+ + + +19 +20 +21+ |
+
+ # File 'lib/inferno/dsl/results.rb', line 19 + +def pass_if(test, = '') + raise Exceptions::PassException, if test +end+ |
+
This method returns an undefined value.
Halt execution of the current test and mark it as skipped.
+ + +
+ + + +27 +28 +29+ |
+
+ # File 'lib/inferno/dsl/results.rb', line 27 + +def skip( = '') + raise Exceptions::SkipException, +end+ |
+
This method returns an undefined value.
Halt execution of the current test and mark it as skipped if a condition +is true.
+ + +
+ + + +37 +38 +39+ |
+
+ # File 'lib/inferno/dsl/results.rb', line 37 + +def skip_if(test, = '') + raise Exceptions::SkipException, if test +end+ |
+
This method returns an undefined value.
Halt execution of the current test and wait for execution to resume.
+ + +
+ + + +85 +86 +87 +88 +89 +90+ |
+
+ # File 'lib/inferno/dsl/results.rb', line 85 + +def wait(identifier:, message: '', timeout: 300) + identifier(identifier) + wait_timeout(timeout) + + raise Exceptions::WaitException, +end+ |
+
This module contains the DSL for defining child entities in the test +definition framework.
+ + +Returns the value of attribute parent.
+Returns the value of attribute suite_option_requirements.
+Set/Get the block that is executed when a runnable is run.
+Set/Get a runnable’s description.
+Set/Get a runnable’s id.
+Set/Get a runnable’s input instructions.
+Mark as optional.
+The test or group is optional if true.
+Mark as required.
+The test or group is required if true.
+Set/get suite options required for this runnable to be executed.
+Create a route which will resume a test run when a request is received.
+Create a route to handle a request.
+Set/Get a runnable’s short one-sentence description.
+Set/Get a runnable’s short title.
+Create an endpoint to receive incoming requests during a Test Run.
+Set/Get a runnable’s title.
+Returns the value of attribute parent.
+ + +
+ + + +12 +13 +14+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 12 + +def parent + @parent +end+ |
+
Returns the value of attribute suite_option_requirements.
+ + +
+ + + +13 +14 +15+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 13 + +def suite_option_requirements + @suite_option_requirements +end+ |
+
Set/Get the block that is executed when a runnable is run
+ + +
+ + + +303 +304 +305 +306 +307+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 303 + +def block(&block) + return @block unless block_given? + + @block = block +end+ |
+
Set/Get a runnable’s description
+ + +
+ + + +235 +236 +237 +238 +239+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 235 + +def description(new_description = nil) + return @description if new_description.nil? + + @description = format_markdown(new_description) +end+ |
+
Set/Get a runnable’s id
+ + +
+ + + +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 192 + +def id(new_id = nil) + return @id if new_id.nil? && @id.present? + + prefix = + if parent + "#{parent.id}-" + else + '' + end + + @base_id = new_id || @base_id || default_id + + final_id = "#{prefix}#{@base_id}" + + raise Exceptions::InvalidRunnableIdException, final_id if final_id.length > 255 + + @id = final_id +end+ |
+
Set/Get a runnable’s input instructions
+ + +
+ + + +255 +256 +257 +258 +259+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 255 + +def input_instructions(new_input_instructions = nil) + return @input_instructions if new_input_instructions.nil? + + @input_instructions = format_markdown(new_input_instructions) +end+ |
+
This method returns an undefined value.
Mark as optional. Tests are required by default.
+ + +
+ + + +265 +266 +267+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 265 + +def optional(optional = true) # rubocop:disable Style/OptionalBooleanParameter + @optional = optional +end+ |
+
The test or group is optional if true
+ + +
+ + + +283 +284 +285+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 283 + +def optional? + !!@optional +end+ |
+
This method returns an undefined value.
Mark as required
+ +Tests are required by default. This method is provided to make an +existing optional test required.
+ + +
+ + + +276 +277 +278+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 276 + +def required(required = true) # rubocop:disable Style/OptionalBooleanParameter + @optional = !required +end+ |
+
The test or group is required if true
+ + +
+ + + +290 +291 +292+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 290 + +def required? + !optional? +end+ |
+
This method returns an undefined value.
Set/get suite options required for this runnable to be executed.
+ + +
+ + + +448 +449 +450 +451 +452 +453+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 448 + +def (suite_option_requirements) + @suite_option_requirements = + suite_option_requirements.map do |key, value| + DSL::SuiteOption.new(id: key, value:) + end +end+ |
+
This method returns an undefined value.
Create a route which will resume a test run when a request is received
+ + +
+ + + +359 +360 +361 +362 +363 +364 +365 +366 +367+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 359 + +def resume_test_route(method, path, tags: [], result: 'pass', &block) + route_class = Class.new(ResumeTestRoute) do |klass| + klass.singleton_class.instance_variable_set(:@test_run_identifier_block, block) + klass.singleton_class.instance_variable_set(:@tags, ) + klass.singleton_class.instance_variable_set(:@result, result) + end + + route(method, path, route_class) +end+ |
+
This method returns an undefined value.
Create a route to handle a request
+ + +
+ + + +401 +402 +403+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 401 + +def route(method, path, handler) + Inferno.routes << { method:, path:, handler:, suite: } +end+ |
+
Set/Get a runnable’s short one-sentence description
+ + +
+ + + +245 +246 +247 +248 +249+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 245 + +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 short title
+ + +
+ + + +225 +226 +227 +228 +229+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 225 + +def short_title(new_short_title = nil) + return @short_title if new_short_title.nil? + + @short_title = new_short_title +end+ |
+
This method returns an undefined value.
Create an endpoint to receive incoming requests during a Test Run.
+ + +
+ + + +383 +384 +385+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 383 + +def suite_endpoint(method, path, endpoint_class) + route(method, path, endpoint_class) +end+ |
+
Set/Get a runnable’s title
+ + +
+ + + +215 +216 +217 +218 +219+ |
+
+ # File 'lib/inferno/dsl/runnable.rb', line 215 + +def title(new_title = nil) + return @title if new_title.nil? + + @title = new_title +end+ |
+
A base class for creating endpoints to test client requests. This class is +based on Hanami::Action, and may be used similarly to a normal Hanami +endpoint.
+ + +Returns the value of attribute req.
+Returns the value of attribute res.
+Override this method to build the response.
+Override this method to assign a name to the request.
+Override this method to specify whether this request should be persisted.
+Override this method to define the tags which will be applied to the request.
+Override this method to determine a test run’s identifier based on an incoming request.
+Override this method to update the current waiting result.
+Inferno’s logger.
+The incoming request as a Hanami::Action::Request.
The response as a Hanami::Action::Response.
The result which is waiting for incoming requests for the current test run.
+The test which is currently waiting for incoming requests.
+The test run which is waiting for incoming requests.
+Returns the value of attribute req.
+ + +
+ + + +61 +62 +63+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 61 + +def req + @req +end+ |
+
Returns the value of attribute res.
+ + +
+ + + +61 +62 +63+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 61 + +def res + @res +end+ |
+
Returns Inferno’s logger.
+ + +
+ + + +215 +216 +217+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 215 + +def logger + @logger ||= Application['logger'] +end+ |
+
Override this method to build the response.
+ + +
+ + + +91 +92 +93+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 91 + +def make_response + nil +end+ |
+
Override this method to assign a name to the request
+ + +
+ + + +106 +107 +108+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 106 + +def name + result&.runnable&.incoming_request_name +end+ |
+
Override this method to specify whether this request should be +persisted. Defaults to true.
+ + +
+ + + +127 +128 +129+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 127 + +def persist_request? + true +end+ |
+
The incoming request as a Hanami::Action::Request
+ + + +171 +172 +173+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 171 + +def request + req +end+ |
+
+ + + +139 +140 +141+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 139 + +def requests_repo + @requests_repo ||= Inferno::Repositories::Requests.new +end+ |
+
The response as a Hanami::Action::Response. Modify this to build the
+response to the incoming request.
+ + + +185 +186 +187+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 185 + +def response + res +end+ |
+
The result which is waiting for incoming requests for the current test +run
+ + +
+ + + +203 +204 +205+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 203 + +def result + @result ||= find_result +end+ |
+
+ + + +144 +145 +146+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 144 + +def results_repo + @results_repo ||= Inferno::Repositories::Results.new +end+ |
+
Override this method to define the tags which will be applied to the +request.
+ + +
+ + + +99 +100 +101+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 99 + +def + @tags ||= [] +end+ |
+
The test which is currently waiting for incoming requests
+ + +
+ + + +210 +211 +212+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 210 + +def test + @test ||= tests_repo.find(result.test_id) +end+ |
+
The test run which is waiting for incoming requests
+ + +
+ + + +192 +193 +194 +195 +196 +197+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 192 + +def test_run + @test_run ||= + test_runs_repo.find_latest_waiting_by_identifier(find_test_run_identifier).tap do |test_run| + halt 500, "Unable to find test run with identifier '#{test_run_identifier}'." if test_run.nil? + end +end+ |
+
Override this method to determine a test run’s identifier based on an +incoming request.
+ + +
+ + + +77 +78 +79+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 77 + +def test_run_identifier + nil +end+ |
+
+ + + +149 +150 +151+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 149 + +def test_runs_repo + @test_runs_repo ||= Inferno::Repositories::TestRuns.new +end+ |
+
+ + + +154 +155 +156+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 154 + +def tests_repo + @tests_repo ||= Inferno::Repositories::Tests.new +end+ |
+
Override this method to update the current waiting result. To resume the +test run, set the result to something other than ‘waiting’.
+ + +
+ + + +119 +120 +121+ |
+
+ # File 'lib/inferno/dsl/suite_endpoint.rb', line 119 + +def update_result + nil +end+ |
+
This class is used to represent TestSuite-level options which are selected +by the user, and can affect which tests/groups are displayed and run as +well as the behavior of those tests.
+ + +[ + :id, + :title, + :description, + :list_options, + :value +].freeze
+ + + ++ |
+
+ # File 'lib/inferno/dsl/suite_option.rb', line 21
+
+
+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/suite_option.rb', line 21
+
+
+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/suite_option.rb', line 21
+
+
+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/suite_option.rb', line 21
+
+
+ |
+
+ + + ++ |
+
+ # File 'lib/inferno/dsl/suite_option.rb', line 21
+
+
+ |
+
Entities are domain objects whose identity is based on an id. Entities
+don’t know anything about persistence, which is handled by Repositories.
+ + + Modules: HasRunnable + + + + Classes: Entity, Header, IG, Input, Message, Preset, Request, Result, SessionData, Test, TestGroup, TestKit, TestRun, TestSession, TestSuite, ValidatorSession + + +
+ + + + + + + + + +Header, IG, Message, Preset, Request, Result, SessionData, TestRun, TestSession, ValidatorSession
+A new instance of Entity.
+Returns a new instance of Entity.
+ + +
+ + + +4 +5 +6+ |
+
+ # File 'lib/inferno/entities/entity.rb', line 4 + +def initialize(params, attributes) + attributes.each { |name| instance_variable_set("@#{name}", params[name]) } +end+ |
+
+ + + +8 +9 +10 +11 +12+ |
+
+ # File 'lib/inferno/entities/entity.rb', line 8 + +def to_hash + self.class::ATTRIBUTES.each_with_object({}) do |attribute, hash| + hash[attribute] = send(attribute) + end.compact +end+ |
+
Returns the Test, TestGroup, or TestSuite associated with this entity.
+Returns the Test, TestGroup, or TestSuite associated with this entity
+ + +
+ + + +7 +8 +9 +10 +11+ |
+
+ # File 'lib/inferno/entities/has_runnable.rb', line 7 + +def runnable + return @runnable if @runnable + + @runnable = test || test_group || test_suite || load_runnable +end+ |
+
A Header represents an HTTP request/response header
[:id, :request_id, :name, :type, :value].freeze
Id of the header.
+Header name.
+Index of the HTTP request.
+Request/response.
+Header value.
+A new instance of Header.
+Returns a new instance of Header.
+ + +
+ + + +20 +21 +22+ |
+
+ # File 'lib/inferno/entities/header.rb', line 20 + +def initialize(params) + super(params, ATTRIBUTES) +end+ |
+
Returns id of the header.
+ + +
+ + + +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41+ |
+
+ # File 'lib/inferno/entities/header.rb', line 15 + +class Header < Entity + ATTRIBUTES = [:id, :request_id, :name, :type, :value].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end + + def request? + type == 'request' + end + + def response? + type == 'response' + end + + def to_hash + { + id:, + request_id:, + type:, + name:, + value: + }.compact + end +end+ |
+
Returns header name.
+ + +
+ + + +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41+ |
+
+ # File 'lib/inferno/entities/header.rb', line 15 + +class Header < Entity + ATTRIBUTES = [:id, :request_id, :name, :type, :value].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end + + def request? + type == 'request' + end + + def response? + type == 'response' + end + + def to_hash + { + id:, + request_id:, + type:, + name:, + value: + }.compact + end +end+ |
+
Returns index of the HTTP request.
+ + +
+ + + +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41+ |
+
+ # File 'lib/inferno/entities/header.rb', line 15 + +class Header < Entity + ATTRIBUTES = [:id, :request_id, :name, :type, :value].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end + + def request? + type == 'request' + end + + def response? + type == 'response' + end + + def to_hash + { + id:, + request_id:, + type:, + name:, + value: + }.compact + end +end+ |
+
Returns request/response.
+ + +
+ + + +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41+ |
+
+ # File 'lib/inferno/entities/header.rb', line 15 + +class Header < Entity + ATTRIBUTES = [:id, :request_id, :name, :type, :value].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end + + def request? + type == 'request' + end + + def response? + type == 'response' + end + + def to_hash + { + id:, + request_id:, + type:, + name:, + value: + }.compact + end +end+ |
+
Returns header value.
+ + +
+ + + +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41+ |
+
+ # File 'lib/inferno/entities/header.rb', line 15 + +class Header < Entity + ATTRIBUTES = [:id, :request_id, :name, :type, :value].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end + + def request? + type == 'request' + end + + def response? + type == 'response' + end + + def to_hash + { + id:, + request_id:, + type:, + name:, + value: + }.compact + end +end+ |
+
+ + + +24 +25 +26+ |
+
+ # File 'lib/inferno/entities/header.rb', line 24 + +def request? + type == 'request' +end+ |
+
+ + + +28 +29 +30+ |
+
+ # File 'lib/inferno/entities/header.rb', line 28 + +def response? + type == 'response' +end+ |
+
+ + + +32 +33 +34 +35 +36 +37 +38 +39 +40+ |
+
+ # File 'lib/inferno/entities/header.rb', line 32 + +def to_hash + { + id:, + request_id:, + type:, + name:, + value: + }.compact +end+ |
+
IG is a wrapper class around the relevant concepts inside an IG. +Not everything within an IG is currently used by Inferno.
+ + +[ + :id, + :profiles, + :extensions, + :value_sets, + :search_params, + :examples +].freeze
These files aren’t FHIR resources
+ + +['package.json', 'validation-summary.json'].freeze
A new instance of IG.
+Returns a new instance of IG.
+ + +
+ + + +26 +27 +28 +29 +30 +31 +32 +33 +34+ |
+
+ # File 'lib/inferno/entities/ig.rb', line 26 + +def initialize(**params) + super(params, ATTRIBUTES) + + @profiles = [] + @extensions = [] + @value_sets = [] + @examples = [] + @search_params = [] +end+ |
+
+ + + +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95+ |
+
+ # File 'lib/inferno/entities/ig.rb', line 77 + +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+ |
+
+ + + +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53+ |
+
+ # File 'lib/inferno/entities/ig.rb', line 36 + +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+ |
+
+ + + +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75+ |
+
+ # File 'lib/inferno/entities/ig.rb', line 55 + +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+ |
+
+ + + +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113+ |
+
+ # File 'lib/inferno/entities/ig.rb', line 100 + +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+ |
+
+ + + +134 +135 +136+ |
+
+ # File 'lib/inferno/entities/ig.rb', line 134 + +def extract_package_id(ig_resource) + "#{ig_resource.id}##{ig_resource.version || 'current'}" +end+ |
+
+ + + +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132+ |
+
+ # File 'lib/inferno/entities/ig.rb', line 115 + +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+ |
+
This class represents an Input for a runnable.
+ + +[ + :name, + :title, + :description, + :type, + :default, + :optional, + :options, + :locked, + :value +].freeze
These attributes require special handling when merging input +definitions.
+ + +[ + # Locking an input only has meaning at the level it is locked. + # Consider: + # - ParentGroup + # - Group 1, input :a + # - Group 2, input :a, locked: true + # The input 'a' should be only be locked when running Group 2 in + # isolation. It should not be locked when running Group 1 or the + # ParentGroup. + :locked, + # Input type is sometimes only a UI concern (e.g. text vs. textarea), so + # it is common to not redeclare the type everywhere it's used and needs + # special handling to avoid clobbering the type with the default (text) + # type. + :type +].freeze
These are the attributes that can be directly copied when merging a +runnable’s input with the input of one of its children.
+ + +(ATTRIBUTES - UNINHERITABLE_ATTRIBUTES).freeze
These are the attributes that can be directly copied when merging a +runnable’s input with an input configuration.
+ + +(ATTRIBUTES - [:type]).freeze
A new instance of Input.
+Returns a new instance of Input.
+ + +
+ + + +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58+ |
+
+ # File 'lib/inferno/entities/input.rb', line 48 + +def initialize(**params) + bad_params = params.keys - ATTRIBUTES + + raise Exceptions::UnknownAttributeException.new(bad_params, self.class) if bad_params.present? + + params + .compact + .each { |key, value| send("#{key}=", value) } + + self.name = name.to_s if params[:name].present? +end+ |
+
+ + + +115 +116 +117 +118 +119+ |
+
+ # File 'lib/inferno/entities/input.rb', line 115 + +def ==(other) + return false unless other.is_a? Input + + ATTRIBUTES.all? { |attribute| send(attribute) == other.send(attribute) } +end+ |
+
+ + + +106 +107 +108 +109 +110 +111 +112 +113+ |
+
+ # File 'lib/inferno/entities/input.rb', line 106 + +def to_hash + ATTRIBUTES.each_with_object({}) do |attribute, hash| + value = send(attribute) + next if value.nil? + + hash[attribute] = value + end +end+ |
+
A Message represents a message generated during a test.
[:id, :index, :message, :result_id, :result, :type].freeze
['error', 'warning', 'info'].freeze
Id of the message.
+Index of the message.
+A new instance of Message.
+Returns a new instance of Message.
+ + +
+ + + +23 +24 +25+ |
+
+ # File 'lib/inferno/entities/message.rb', line 23 + +def initialize(params) + super(params, ATTRIBUTES) +end+ |
+
Returns id of the message.
+ + +
+ + + +17 +18 +19 +20 +21 +22 +23 +24 +25 +26+ |
+
+ # File 'lib/inferno/entities/message.rb', line 17 + +class Message < Entity + ATTRIBUTES = [:id, :index, :message, :result_id, :result, :type].freeze + TYPES = ['error', 'warning', 'info'].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end +end+ |
+
Returns index of the message. Used for ordering.
+ + +
+ + + +17 +18 +19 +20 +21 +22 +23 +24 +25 +26+ |
+
+ # File 'lib/inferno/entities/message.rb', line 17 + +class Message < Entity + ATTRIBUTES = [:id, :index, :message, :result_id, :result, :type].freeze + TYPES = ['error', 'warning', 'info'].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end +end+ |
+
+ + + +17 +18 +19 +20 +21 +22 +23 +24 +25 +26+ |
+
+ # File 'lib/inferno/entities/message.rb', line 17 + +class Message < Entity + ATTRIBUTES = [:id, :index, :message, :result_id, :result, :type].freeze + TYPES = ['error', 'warning', 'info'].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end +end+ |
+
+ + + +17 +18 +19 +20 +21 +22 +23 +24 +25 +26+ |
+
+ # File 'lib/inferno/entities/message.rb', line 17 + +class Message < Entity + ATTRIBUTES = [:id, :index, :message, :result_id, :result, :type].freeze + TYPES = ['error', 'warning', 'info'].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end +end+ |
+
+ + + +17 +18 +19 +20 +21 +22 +23 +24 +25 +26+ |
+
+ # File 'lib/inferno/entities/message.rb', line 17 + +class Message < Entity + ATTRIBUTES = [:id, :index, :message, :result_id, :result, :type].freeze + TYPES = ['error', 'warning', 'info'].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end +end+ |
+
+ + + +17 +18 +19 +20 +21 +22 +23 +24 +25 +26+ |
+
+ # File 'lib/inferno/entities/message.rb', line 17 + +class Message < Entity + ATTRIBUTES = [:id, :index, :message, :result_id, :result, :type].freeze + TYPES = ['error', 'warning', 'info'].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end +end+ |
+
A Preset represents a set of input values for a runnable.
[ + :id, + :test_suite_id, + :inputs, + :title +].freeze
A new instance of Preset.
+Returns a new instance of Preset.
+ + +
+ + + +19 +20 +21+ |
+
+ # File 'lib/inferno/entities/preset.rb', line 19 + +def initialize(params) + super(params, ATTRIBUTES) +end+ |
+
A Request represents a request and response issued during a test.
[ + :id, :index, :verb, :url, :direction, :name, :status, + :request_body, :response_body, :result_id, :test_session_id, :created_at, + :updated_at, :headers, :tags +].freeze
[ + :id, :index, :url, :verb, :direction, :name, :status, :result_id, :created_at, :updated_at +].freeze
Creation timestamp.
+Incoming/outgoing.
+Http request/response headers.
+Id of the request.
+Index of the request.
+Name for the request.
+Body of the http request.
+Body of the http response.
+Id of the result for this request.
+Http response status code.
+Id of the test session for this request.
+Update timestamp.
+Request url.
+Http verb.
+Return a hash of the request parameters.
+Find a request header.
+All of the request headers.
+Return the FHIR resource from the response body.
+Return a hash of the response parameters.
+Find a response header.
+All of the response headers.
+Returns creation timestamp.
+ + +
+ + + +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226+ |
+
+ # File 'lib/inferno/entities/request.rb', line 33 + +class Request < Entity + ATTRIBUTES = [ + :id, :index, :verb, :url, :direction, :name, :status, + :request_body, :response_body, :result_id, :test_session_id, :created_at, + :updated_at, :headers, :tags + ].freeze + SUMMARY_FIELDS = [ + :id, :index, :url, :verb, :direction, :name, :status, :result_id, :created_at, :updated_at + ].freeze + + include Attributes + + # @private + def initialize(params) + super(params, ATTRIBUTES - [:headers, :name]) + + @name = params[:name]&.to_sym + @headers = params[:headers]&.map { |header| header.is_a?(Hash) ? Header.new(header) : header } || [] + (params[:tags] || []) + end + + def () + @tags = .map do |tag| + case tag + when Hash + tag[:name] + when String + tag + end + end + end + + # @return [Hash<String, String>] + def query_parameters + Addressable::URI.parse(url).query_values || {} + end + + # Find a response header + # + # @param name [String] the header name + # @return [Inferno::Entities::Header, nil] + def response_header(name) + response_headers.find { |header| header.name.casecmp(name).zero? } + end + + # Find a request header + # + # @param name [String] the header name. + # @return [Inferno::Entities::Header, nil] + def request_header(name) + request_headers.find { |header| header.name.casecmp(name).zero? } + end + + # All of the request headers + # + # @return [Array<Inferno::Entities::Header>] + def request_headers + headers.select(&:request?) + end + + # All of the response headers + # + # @return [Array<Inferno::Entities::Header>] + def response_headers + headers.select(&:response?) + end + + # Return a hash of the request parameters + # + # @return [Hash] A Hash with `:verb`, `:url`, `:headers`, and `:body` + # fields + def request + { + verb:, + url:, + headers: request_headers, + body: request_body + } + end + + # Return a hash of the response parameters + # + # @return [Hash] A Hash with `:status`, `:headers`, and `:body` fields + def response + { + status:, + headers: response_headers, + body: response_body + } + end + + # @private + def to_hash + { + id:, + verb:, + url:, + direction:, + status:, + name:, + request_body:, + response_body:, + result_id:, + test_session_id:, + request_headers: request_headers.map(&:to_hash), + response_headers: response_headers.map(&:to_hash), + tags:, + created_at:, + updated_at: + }.compact + end + + # Return the FHIR resource from the response body. + # + # @return [FHIR::Model, nil] + def resource + FHIR.from_contents(response_body) + end + + class << self + # @private + def from_hanami_request(request, name: nil, tags: []) + url = "#{request.base_url}#{request.path}" + url += "?#{request.query_string}" if request.query_string.present? + request_headers = + request.params.env + .select { |key, _| key.start_with? 'HTTP_' } + .transform_keys { |key| key.delete_prefix('HTTP_').tr('_', '-').downcase } + .map { |header_name, value| Header.new(name: header_name, value:, type: 'request') } + + new( + verb: request.request_method.downcase, + url:, + direction: 'incoming', + name:, + request_body: request.body.string, + headers: request_headers, + tags: + ) + end + + # @private + def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request_headers = + response.env.request_headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = + response.headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + + new( + verb: response.env.method.downcase, + url: response.env.url.to_s, + direction:, + name:, + status: response.status, + request_body: response.env.request_body, + response_body: response.body, + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + + # @private + def from_fhir_client_reply(reply, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request = reply.request + response = reply.response + request_headers = request[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = response[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + request_body = + if request.dig(:headers, 'Content-Type')&.include?('application/x-www-form-urlencoded') + URI.encode_www_form(request[:payload]) + else + request[:payload] + end + + new( + verb: request[:method].downcase, + url: request[:url], + direction:, + name:, + status: response[:code].to_i, + request_body:, + response_body: response[:body], + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + end +end+ |
+
Returns incoming/outgoing.
+ + +
+ + + +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226+ |
+
+ # File 'lib/inferno/entities/request.rb', line 33 + +class Request < Entity + ATTRIBUTES = [ + :id, :index, :verb, :url, :direction, :name, :status, + :request_body, :response_body, :result_id, :test_session_id, :created_at, + :updated_at, :headers, :tags + ].freeze + SUMMARY_FIELDS = [ + :id, :index, :url, :verb, :direction, :name, :status, :result_id, :created_at, :updated_at + ].freeze + + include Attributes + + # @private + def initialize(params) + super(params, ATTRIBUTES - [:headers, :name]) + + @name = params[:name]&.to_sym + @headers = params[:headers]&.map { |header| header.is_a?(Hash) ? Header.new(header) : header } || [] + (params[:tags] || []) + end + + def () + @tags = .map do |tag| + case tag + when Hash + tag[:name] + when String + tag + end + end + end + + # @return [Hash<String, String>] + def query_parameters + Addressable::URI.parse(url).query_values || {} + end + + # Find a response header + # + # @param name [String] the header name + # @return [Inferno::Entities::Header, nil] + def response_header(name) + response_headers.find { |header| header.name.casecmp(name).zero? } + end + + # Find a request header + # + # @param name [String] the header name. + # @return [Inferno::Entities::Header, nil] + def request_header(name) + request_headers.find { |header| header.name.casecmp(name).zero? } + end + + # All of the request headers + # + # @return [Array<Inferno::Entities::Header>] + def request_headers + headers.select(&:request?) + end + + # All of the response headers + # + # @return [Array<Inferno::Entities::Header>] + def response_headers + headers.select(&:response?) + end + + # Return a hash of the request parameters + # + # @return [Hash] A Hash with `:verb`, `:url`, `:headers`, and `:body` + # fields + def request + { + verb:, + url:, + headers: request_headers, + body: request_body + } + end + + # Return a hash of the response parameters + # + # @return [Hash] A Hash with `:status`, `:headers`, and `:body` fields + def response + { + status:, + headers: response_headers, + body: response_body + } + end + + # @private + def to_hash + { + id:, + verb:, + url:, + direction:, + status:, + name:, + request_body:, + response_body:, + result_id:, + test_session_id:, + request_headers: request_headers.map(&:to_hash), + response_headers: response_headers.map(&:to_hash), + tags:, + created_at:, + updated_at: + }.compact + end + + # Return the FHIR resource from the response body. + # + # @return [FHIR::Model, nil] + def resource + FHIR.from_contents(response_body) + end + + class << self + # @private + def from_hanami_request(request, name: nil, tags: []) + url = "#{request.base_url}#{request.path}" + url += "?#{request.query_string}" if request.query_string.present? + request_headers = + request.params.env + .select { |key, _| key.start_with? 'HTTP_' } + .transform_keys { |key| key.delete_prefix('HTTP_').tr('_', '-').downcase } + .map { |header_name, value| Header.new(name: header_name, value:, type: 'request') } + + new( + verb: request.request_method.downcase, + url:, + direction: 'incoming', + name:, + request_body: request.body.string, + headers: request_headers, + tags: + ) + end + + # @private + def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request_headers = + response.env.request_headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = + response.headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + + new( + verb: response.env.method.downcase, + url: response.env.url.to_s, + direction:, + name:, + status: response.status, + request_body: response.env.request_body, + response_body: response.body, + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + + # @private + def from_fhir_client_reply(reply, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request = reply.request + response = reply.response + request_headers = request[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = response[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + request_body = + if request.dig(:headers, 'Content-Type')&.include?('application/x-www-form-urlencoded') + URI.encode_www_form(request[:payload]) + else + request[:payload] + end + + new( + verb: request[:method].downcase, + url: request[:url], + direction:, + name:, + status: response[:code].to_i, + request_body:, + response_body: response[:body], + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + end +end+ |
+
Returns http request/response headers.
+ + +
+ + + +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226+ |
+
+ # File 'lib/inferno/entities/request.rb', line 33 + +class Request < Entity + ATTRIBUTES = [ + :id, :index, :verb, :url, :direction, :name, :status, + :request_body, :response_body, :result_id, :test_session_id, :created_at, + :updated_at, :headers, :tags + ].freeze + SUMMARY_FIELDS = [ + :id, :index, :url, :verb, :direction, :name, :status, :result_id, :created_at, :updated_at + ].freeze + + include Attributes + + # @private + def initialize(params) + super(params, ATTRIBUTES - [:headers, :name]) + + @name = params[:name]&.to_sym + @headers = params[:headers]&.map { |header| header.is_a?(Hash) ? Header.new(header) : header } || [] + (params[:tags] || []) + end + + def () + @tags = .map do |tag| + case tag + when Hash + tag[:name] + when String + tag + end + end + end + + # @return [Hash<String, String>] + def query_parameters + Addressable::URI.parse(url).query_values || {} + end + + # Find a response header + # + # @param name [String] the header name + # @return [Inferno::Entities::Header, nil] + def response_header(name) + response_headers.find { |header| header.name.casecmp(name).zero? } + end + + # Find a request header + # + # @param name [String] the header name. + # @return [Inferno::Entities::Header, nil] + def request_header(name) + request_headers.find { |header| header.name.casecmp(name).zero? } + end + + # All of the request headers + # + # @return [Array<Inferno::Entities::Header>] + def request_headers + headers.select(&:request?) + end + + # All of the response headers + # + # @return [Array<Inferno::Entities::Header>] + def response_headers + headers.select(&:response?) + end + + # Return a hash of the request parameters + # + # @return [Hash] A Hash with `:verb`, `:url`, `:headers`, and `:body` + # fields + def request + { + verb:, + url:, + headers: request_headers, + body: request_body + } + end + + # Return a hash of the response parameters + # + # @return [Hash] A Hash with `:status`, `:headers`, and `:body` fields + def response + { + status:, + headers: response_headers, + body: response_body + } + end + + # @private + def to_hash + { + id:, + verb:, + url:, + direction:, + status:, + name:, + request_body:, + response_body:, + result_id:, + test_session_id:, + request_headers: request_headers.map(&:to_hash), + response_headers: response_headers.map(&:to_hash), + tags:, + created_at:, + updated_at: + }.compact + end + + # Return the FHIR resource from the response body. + # + # @return [FHIR::Model, nil] + def resource + FHIR.from_contents(response_body) + end + + class << self + # @private + def from_hanami_request(request, name: nil, tags: []) + url = "#{request.base_url}#{request.path}" + url += "?#{request.query_string}" if request.query_string.present? + request_headers = + request.params.env + .select { |key, _| key.start_with? 'HTTP_' } + .transform_keys { |key| key.delete_prefix('HTTP_').tr('_', '-').downcase } + .map { |header_name, value| Header.new(name: header_name, value:, type: 'request') } + + new( + verb: request.request_method.downcase, + url:, + direction: 'incoming', + name:, + request_body: request.body.string, + headers: request_headers, + tags: + ) + end + + # @private + def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request_headers = + response.env.request_headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = + response.headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + + new( + verb: response.env.method.downcase, + url: response.env.url.to_s, + direction:, + name:, + status: response.status, + request_body: response.env.request_body, + response_body: response.body, + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + + # @private + def from_fhir_client_reply(reply, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request = reply.request + response = reply.response + request_headers = request[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = response[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + request_body = + if request.dig(:headers, 'Content-Type')&.include?('application/x-www-form-urlencoded') + URI.encode_www_form(request[:payload]) + else + request[:payload] + end + + new( + verb: request[:method].downcase, + url: request[:url], + direction:, + name:, + status: response[:code].to_i, + request_body:, + response_body: response[:body], + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + end +end+ |
+
Returns id of the request.
+ + +
+ + + +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226+ |
+
+ # File 'lib/inferno/entities/request.rb', line 33 + +class Request < Entity + ATTRIBUTES = [ + :id, :index, :verb, :url, :direction, :name, :status, + :request_body, :response_body, :result_id, :test_session_id, :created_at, + :updated_at, :headers, :tags + ].freeze + SUMMARY_FIELDS = [ + :id, :index, :url, :verb, :direction, :name, :status, :result_id, :created_at, :updated_at + ].freeze + + include Attributes + + # @private + def initialize(params) + super(params, ATTRIBUTES - [:headers, :name]) + + @name = params[:name]&.to_sym + @headers = params[:headers]&.map { |header| header.is_a?(Hash) ? Header.new(header) : header } || [] + (params[:tags] || []) + end + + def () + @tags = .map do |tag| + case tag + when Hash + tag[:name] + when String + tag + end + end + end + + # @return [Hash<String, String>] + def query_parameters + Addressable::URI.parse(url).query_values || {} + end + + # Find a response header + # + # @param name [String] the header name + # @return [Inferno::Entities::Header, nil] + def response_header(name) + response_headers.find { |header| header.name.casecmp(name).zero? } + end + + # Find a request header + # + # @param name [String] the header name. + # @return [Inferno::Entities::Header, nil] + def request_header(name) + request_headers.find { |header| header.name.casecmp(name).zero? } + end + + # All of the request headers + # + # @return [Array<Inferno::Entities::Header>] + def request_headers + headers.select(&:request?) + end + + # All of the response headers + # + # @return [Array<Inferno::Entities::Header>] + def response_headers + headers.select(&:response?) + end + + # Return a hash of the request parameters + # + # @return [Hash] A Hash with `:verb`, `:url`, `:headers`, and `:body` + # fields + def request + { + verb:, + url:, + headers: request_headers, + body: request_body + } + end + + # Return a hash of the response parameters + # + # @return [Hash] A Hash with `:status`, `:headers`, and `:body` fields + def response + { + status:, + headers: response_headers, + body: response_body + } + end + + # @private + def to_hash + { + id:, + verb:, + url:, + direction:, + status:, + name:, + request_body:, + response_body:, + result_id:, + test_session_id:, + request_headers: request_headers.map(&:to_hash), + response_headers: response_headers.map(&:to_hash), + tags:, + created_at:, + updated_at: + }.compact + end + + # Return the FHIR resource from the response body. + # + # @return [FHIR::Model, nil] + def resource + FHIR.from_contents(response_body) + end + + class << self + # @private + def from_hanami_request(request, name: nil, tags: []) + url = "#{request.base_url}#{request.path}" + url += "?#{request.query_string}" if request.query_string.present? + request_headers = + request.params.env + .select { |key, _| key.start_with? 'HTTP_' } + .transform_keys { |key| key.delete_prefix('HTTP_').tr('_', '-').downcase } + .map { |header_name, value| Header.new(name: header_name, value:, type: 'request') } + + new( + verb: request.request_method.downcase, + url:, + direction: 'incoming', + name:, + request_body: request.body.string, + headers: request_headers, + tags: + ) + end + + # @private + def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request_headers = + response.env.request_headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = + response.headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + + new( + verb: response.env.method.downcase, + url: response.env.url.to_s, + direction:, + name:, + status: response.status, + request_body: response.env.request_body, + response_body: response.body, + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + + # @private + def from_fhir_client_reply(reply, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request = reply.request + response = reply.response + request_headers = request[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = response[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + request_body = + if request.dig(:headers, 'Content-Type')&.include?('application/x-www-form-urlencoded') + URI.encode_www_form(request[:payload]) + else + request[:payload] + end + + new( + verb: request[:method].downcase, + url: request[:url], + direction:, + name:, + status: response[:code].to_i, + request_body:, + response_body: response[:body], + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + end +end+ |
+
Returns index of the request. Used for ordering.
+ + +
+ + + +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226+ |
+
+ # File 'lib/inferno/entities/request.rb', line 33 + +class Request < Entity + ATTRIBUTES = [ + :id, :index, :verb, :url, :direction, :name, :status, + :request_body, :response_body, :result_id, :test_session_id, :created_at, + :updated_at, :headers, :tags + ].freeze + SUMMARY_FIELDS = [ + :id, :index, :url, :verb, :direction, :name, :status, :result_id, :created_at, :updated_at + ].freeze + + include Attributes + + # @private + def initialize(params) + super(params, ATTRIBUTES - [:headers, :name]) + + @name = params[:name]&.to_sym + @headers = params[:headers]&.map { |header| header.is_a?(Hash) ? Header.new(header) : header } || [] + (params[:tags] || []) + end + + def () + @tags = .map do |tag| + case tag + when Hash + tag[:name] + when String + tag + end + end + end + + # @return [Hash<String, String>] + def query_parameters + Addressable::URI.parse(url).query_values || {} + end + + # Find a response header + # + # @param name [String] the header name + # @return [Inferno::Entities::Header, nil] + def response_header(name) + response_headers.find { |header| header.name.casecmp(name).zero? } + end + + # Find a request header + # + # @param name [String] the header name. + # @return [Inferno::Entities::Header, nil] + def request_header(name) + request_headers.find { |header| header.name.casecmp(name).zero? } + end + + # All of the request headers + # + # @return [Array<Inferno::Entities::Header>] + def request_headers + headers.select(&:request?) + end + + # All of the response headers + # + # @return [Array<Inferno::Entities::Header>] + def response_headers + headers.select(&:response?) + end + + # Return a hash of the request parameters + # + # @return [Hash] A Hash with `:verb`, `:url`, `:headers`, and `:body` + # fields + def request + { + verb:, + url:, + headers: request_headers, + body: request_body + } + end + + # Return a hash of the response parameters + # + # @return [Hash] A Hash with `:status`, `:headers`, and `:body` fields + def response + { + status:, + headers: response_headers, + body: response_body + } + end + + # @private + def to_hash + { + id:, + verb:, + url:, + direction:, + status:, + name:, + request_body:, + response_body:, + result_id:, + test_session_id:, + request_headers: request_headers.map(&:to_hash), + response_headers: response_headers.map(&:to_hash), + tags:, + created_at:, + updated_at: + }.compact + end + + # Return the FHIR resource from the response body. + # + # @return [FHIR::Model, nil] + def resource + FHIR.from_contents(response_body) + end + + class << self + # @private + def from_hanami_request(request, name: nil, tags: []) + url = "#{request.base_url}#{request.path}" + url += "?#{request.query_string}" if request.query_string.present? + request_headers = + request.params.env + .select { |key, _| key.start_with? 'HTTP_' } + .transform_keys { |key| key.delete_prefix('HTTP_').tr('_', '-').downcase } + .map { |header_name, value| Header.new(name: header_name, value:, type: 'request') } + + new( + verb: request.request_method.downcase, + url:, + direction: 'incoming', + name:, + request_body: request.body.string, + headers: request_headers, + tags: + ) + end + + # @private + def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request_headers = + response.env.request_headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = + response.headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + + new( + verb: response.env.method.downcase, + url: response.env.url.to_s, + direction:, + name:, + status: response.status, + request_body: response.env.request_body, + response_body: response.body, + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + + # @private + def from_fhir_client_reply(reply, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request = reply.request + response = reply.response + request_headers = request[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = response[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + request_body = + if request.dig(:headers, 'Content-Type')&.include?('application/x-www-form-urlencoded') + URI.encode_www_form(request[:payload]) + else + request[:payload] + end + + new( + verb: request[:method].downcase, + url: request[:url], + direction:, + name:, + status: response[:code].to_i, + request_body:, + response_body: response[:body], + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + end +end+ |
+
Returns name for the request.
+ + +
+ + + +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226+ |
+
+ # File 'lib/inferno/entities/request.rb', line 33 + +class Request < Entity + ATTRIBUTES = [ + :id, :index, :verb, :url, :direction, :name, :status, + :request_body, :response_body, :result_id, :test_session_id, :created_at, + :updated_at, :headers, :tags + ].freeze + SUMMARY_FIELDS = [ + :id, :index, :url, :verb, :direction, :name, :status, :result_id, :created_at, :updated_at + ].freeze + + include Attributes + + # @private + def initialize(params) + super(params, ATTRIBUTES - [:headers, :name]) + + @name = params[:name]&.to_sym + @headers = params[:headers]&.map { |header| header.is_a?(Hash) ? Header.new(header) : header } || [] + (params[:tags] || []) + end + + def () + @tags = .map do |tag| + case tag + when Hash + tag[:name] + when String + tag + end + end + end + + # @return [Hash<String, String>] + def query_parameters + Addressable::URI.parse(url).query_values || {} + end + + # Find a response header + # + # @param name [String] the header name + # @return [Inferno::Entities::Header, nil] + def response_header(name) + response_headers.find { |header| header.name.casecmp(name).zero? } + end + + # Find a request header + # + # @param name [String] the header name. + # @return [Inferno::Entities::Header, nil] + def request_header(name) + request_headers.find { |header| header.name.casecmp(name).zero? } + end + + # All of the request headers + # + # @return [Array<Inferno::Entities::Header>] + def request_headers + headers.select(&:request?) + end + + # All of the response headers + # + # @return [Array<Inferno::Entities::Header>] + def response_headers + headers.select(&:response?) + end + + # Return a hash of the request parameters + # + # @return [Hash] A Hash with `:verb`, `:url`, `:headers`, and `:body` + # fields + def request + { + verb:, + url:, + headers: request_headers, + body: request_body + } + end + + # Return a hash of the response parameters + # + # @return [Hash] A Hash with `:status`, `:headers`, and `:body` fields + def response + { + status:, + headers: response_headers, + body: response_body + } + end + + # @private + def to_hash + { + id:, + verb:, + url:, + direction:, + status:, + name:, + request_body:, + response_body:, + result_id:, + test_session_id:, + request_headers: request_headers.map(&:to_hash), + response_headers: response_headers.map(&:to_hash), + tags:, + created_at:, + updated_at: + }.compact + end + + # Return the FHIR resource from the response body. + # + # @return [FHIR::Model, nil] + def resource + FHIR.from_contents(response_body) + end + + class << self + # @private + def from_hanami_request(request, name: nil, tags: []) + url = "#{request.base_url}#{request.path}" + url += "?#{request.query_string}" if request.query_string.present? + request_headers = + request.params.env + .select { |key, _| key.start_with? 'HTTP_' } + .transform_keys { |key| key.delete_prefix('HTTP_').tr('_', '-').downcase } + .map { |header_name, value| Header.new(name: header_name, value:, type: 'request') } + + new( + verb: request.request_method.downcase, + url:, + direction: 'incoming', + name:, + request_body: request.body.string, + headers: request_headers, + tags: + ) + end + + # @private + def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request_headers = + response.env.request_headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = + response.headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + + new( + verb: response.env.method.downcase, + url: response.env.url.to_s, + direction:, + name:, + status: response.status, + request_body: response.env.request_body, + response_body: response.body, + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + + # @private + def from_fhir_client_reply(reply, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request = reply.request + response = reply.response + request_headers = request[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = response[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + request_body = + if request.dig(:headers, 'Content-Type')&.include?('application/x-www-form-urlencoded') + URI.encode_www_form(request[:payload]) + else + request[:payload] + end + + new( + verb: request[:method].downcase, + url: request[:url], + direction:, + name:, + status: response[:code].to_i, + request_body:, + response_body: response[:body], + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + end +end+ |
+
Returns body of the http request.
+ + +
+ + + +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226+ |
+
+ # File 'lib/inferno/entities/request.rb', line 33 + +class Request < Entity + ATTRIBUTES = [ + :id, :index, :verb, :url, :direction, :name, :status, + :request_body, :response_body, :result_id, :test_session_id, :created_at, + :updated_at, :headers, :tags + ].freeze + SUMMARY_FIELDS = [ + :id, :index, :url, :verb, :direction, :name, :status, :result_id, :created_at, :updated_at + ].freeze + + include Attributes + + # @private + def initialize(params) + super(params, ATTRIBUTES - [:headers, :name]) + + @name = params[:name]&.to_sym + @headers = params[:headers]&.map { |header| header.is_a?(Hash) ? Header.new(header) : header } || [] + (params[:tags] || []) + end + + def () + @tags = .map do |tag| + case tag + when Hash + tag[:name] + when String + tag + end + end + end + + # @return [Hash<String, String>] + def query_parameters + Addressable::URI.parse(url).query_values || {} + end + + # Find a response header + # + # @param name [String] the header name + # @return [Inferno::Entities::Header, nil] + def response_header(name) + response_headers.find { |header| header.name.casecmp(name).zero? } + end + + # Find a request header + # + # @param name [String] the header name. + # @return [Inferno::Entities::Header, nil] + def request_header(name) + request_headers.find { |header| header.name.casecmp(name).zero? } + end + + # All of the request headers + # + # @return [Array<Inferno::Entities::Header>] + def request_headers + headers.select(&:request?) + end + + # All of the response headers + # + # @return [Array<Inferno::Entities::Header>] + def response_headers + headers.select(&:response?) + end + + # Return a hash of the request parameters + # + # @return [Hash] A Hash with `:verb`, `:url`, `:headers`, and `:body` + # fields + def request + { + verb:, + url:, + headers: request_headers, + body: request_body + } + end + + # Return a hash of the response parameters + # + # @return [Hash] A Hash with `:status`, `:headers`, and `:body` fields + def response + { + status:, + headers: response_headers, + body: response_body + } + end + + # @private + def to_hash + { + id:, + verb:, + url:, + direction:, + status:, + name:, + request_body:, + response_body:, + result_id:, + test_session_id:, + request_headers: request_headers.map(&:to_hash), + response_headers: response_headers.map(&:to_hash), + tags:, + created_at:, + updated_at: + }.compact + end + + # Return the FHIR resource from the response body. + # + # @return [FHIR::Model, nil] + def resource + FHIR.from_contents(response_body) + end + + class << self + # @private + def from_hanami_request(request, name: nil, tags: []) + url = "#{request.base_url}#{request.path}" + url += "?#{request.query_string}" if request.query_string.present? + request_headers = + request.params.env + .select { |key, _| key.start_with? 'HTTP_' } + .transform_keys { |key| key.delete_prefix('HTTP_').tr('_', '-').downcase } + .map { |header_name, value| Header.new(name: header_name, value:, type: 'request') } + + new( + verb: request.request_method.downcase, + url:, + direction: 'incoming', + name:, + request_body: request.body.string, + headers: request_headers, + tags: + ) + end + + # @private + def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request_headers = + response.env.request_headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = + response.headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + + new( + verb: response.env.method.downcase, + url: response.env.url.to_s, + direction:, + name:, + status: response.status, + request_body: response.env.request_body, + response_body: response.body, + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + + # @private + def from_fhir_client_reply(reply, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request = reply.request + response = reply.response + request_headers = request[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = response[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + request_body = + if request.dig(:headers, 'Content-Type')&.include?('application/x-www-form-urlencoded') + URI.encode_www_form(request[:payload]) + else + request[:payload] + end + + new( + verb: request[:method].downcase, + url: request[:url], + direction:, + name:, + status: response[:code].to_i, + request_body:, + response_body: response[:body], + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + end +end+ |
+
Returns body of the http response.
+ + +
+ + + +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226+ |
+
+ # File 'lib/inferno/entities/request.rb', line 33 + +class Request < Entity + ATTRIBUTES = [ + :id, :index, :verb, :url, :direction, :name, :status, + :request_body, :response_body, :result_id, :test_session_id, :created_at, + :updated_at, :headers, :tags + ].freeze + SUMMARY_FIELDS = [ + :id, :index, :url, :verb, :direction, :name, :status, :result_id, :created_at, :updated_at + ].freeze + + include Attributes + + # @private + def initialize(params) + super(params, ATTRIBUTES - [:headers, :name]) + + @name = params[:name]&.to_sym + @headers = params[:headers]&.map { |header| header.is_a?(Hash) ? Header.new(header) : header } || [] + (params[:tags] || []) + end + + def () + @tags = .map do |tag| + case tag + when Hash + tag[:name] + when String + tag + end + end + end + + # @return [Hash<String, String>] + def query_parameters + Addressable::URI.parse(url).query_values || {} + end + + # Find a response header + # + # @param name [String] the header name + # @return [Inferno::Entities::Header, nil] + def response_header(name) + response_headers.find { |header| header.name.casecmp(name).zero? } + end + + # Find a request header + # + # @param name [String] the header name. + # @return [Inferno::Entities::Header, nil] + def request_header(name) + request_headers.find { |header| header.name.casecmp(name).zero? } + end + + # All of the request headers + # + # @return [Array<Inferno::Entities::Header>] + def request_headers + headers.select(&:request?) + end + + # All of the response headers + # + # @return [Array<Inferno::Entities::Header>] + def response_headers + headers.select(&:response?) + end + + # Return a hash of the request parameters + # + # @return [Hash] A Hash with `:verb`, `:url`, `:headers`, and `:body` + # fields + def request + { + verb:, + url:, + headers: request_headers, + body: request_body + } + end + + # Return a hash of the response parameters + # + # @return [Hash] A Hash with `:status`, `:headers`, and `:body` fields + def response + { + status:, + headers: response_headers, + body: response_body + } + end + + # @private + def to_hash + { + id:, + verb:, + url:, + direction:, + status:, + name:, + request_body:, + response_body:, + result_id:, + test_session_id:, + request_headers: request_headers.map(&:to_hash), + response_headers: response_headers.map(&:to_hash), + tags:, + created_at:, + updated_at: + }.compact + end + + # Return the FHIR resource from the response body. + # + # @return [FHIR::Model, nil] + def resource + FHIR.from_contents(response_body) + end + + class << self + # @private + def from_hanami_request(request, name: nil, tags: []) + url = "#{request.base_url}#{request.path}" + url += "?#{request.query_string}" if request.query_string.present? + request_headers = + request.params.env + .select { |key, _| key.start_with? 'HTTP_' } + .transform_keys { |key| key.delete_prefix('HTTP_').tr('_', '-').downcase } + .map { |header_name, value| Header.new(name: header_name, value:, type: 'request') } + + new( + verb: request.request_method.downcase, + url:, + direction: 'incoming', + name:, + request_body: request.body.string, + headers: request_headers, + tags: + ) + end + + # @private + def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request_headers = + response.env.request_headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = + response.headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + + new( + verb: response.env.method.downcase, + url: response.env.url.to_s, + direction:, + name:, + status: response.status, + request_body: response.env.request_body, + response_body: response.body, + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + + # @private + def from_fhir_client_reply(reply, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request = reply.request + response = reply.response + request_headers = request[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = response[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + request_body = + if request.dig(:headers, 'Content-Type')&.include?('application/x-www-form-urlencoded') + URI.encode_www_form(request[:payload]) + else + request[:payload] + end + + new( + verb: request[:method].downcase, + url: request[:url], + direction:, + name:, + status: response[:code].to_i, + request_body:, + response_body: response[:body], + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + end +end+ |
+
Returns id of the result for this request.
+ + +
+ + + +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226+ |
+
+ # File 'lib/inferno/entities/request.rb', line 33 + +class Request < Entity + ATTRIBUTES = [ + :id, :index, :verb, :url, :direction, :name, :status, + :request_body, :response_body, :result_id, :test_session_id, :created_at, + :updated_at, :headers, :tags + ].freeze + SUMMARY_FIELDS = [ + :id, :index, :url, :verb, :direction, :name, :status, :result_id, :created_at, :updated_at + ].freeze + + include Attributes + + # @private + def initialize(params) + super(params, ATTRIBUTES - [:headers, :name]) + + @name = params[:name]&.to_sym + @headers = params[:headers]&.map { |header| header.is_a?(Hash) ? Header.new(header) : header } || [] + (params[:tags] || []) + end + + def () + @tags = .map do |tag| + case tag + when Hash + tag[:name] + when String + tag + end + end + end + + # @return [Hash<String, String>] + def query_parameters + Addressable::URI.parse(url).query_values || {} + end + + # Find a response header + # + # @param name [String] the header name + # @return [Inferno::Entities::Header, nil] + def response_header(name) + response_headers.find { |header| header.name.casecmp(name).zero? } + end + + # Find a request header + # + # @param name [String] the header name. + # @return [Inferno::Entities::Header, nil] + def request_header(name) + request_headers.find { |header| header.name.casecmp(name).zero? } + end + + # All of the request headers + # + # @return [Array<Inferno::Entities::Header>] + def request_headers + headers.select(&:request?) + end + + # All of the response headers + # + # @return [Array<Inferno::Entities::Header>] + def response_headers + headers.select(&:response?) + end + + # Return a hash of the request parameters + # + # @return [Hash] A Hash with `:verb`, `:url`, `:headers`, and `:body` + # fields + def request + { + verb:, + url:, + headers: request_headers, + body: request_body + } + end + + # Return a hash of the response parameters + # + # @return [Hash] A Hash with `:status`, `:headers`, and `:body` fields + def response + { + status:, + headers: response_headers, + body: response_body + } + end + + # @private + def to_hash + { + id:, + verb:, + url:, + direction:, + status:, + name:, + request_body:, + response_body:, + result_id:, + test_session_id:, + request_headers: request_headers.map(&:to_hash), + response_headers: response_headers.map(&:to_hash), + tags:, + created_at:, + updated_at: + }.compact + end + + # Return the FHIR resource from the response body. + # + # @return [FHIR::Model, nil] + def resource + FHIR.from_contents(response_body) + end + + class << self + # @private + def from_hanami_request(request, name: nil, tags: []) + url = "#{request.base_url}#{request.path}" + url += "?#{request.query_string}" if request.query_string.present? + request_headers = + request.params.env + .select { |key, _| key.start_with? 'HTTP_' } + .transform_keys { |key| key.delete_prefix('HTTP_').tr('_', '-').downcase } + .map { |header_name, value| Header.new(name: header_name, value:, type: 'request') } + + new( + verb: request.request_method.downcase, + url:, + direction: 'incoming', + name:, + request_body: request.body.string, + headers: request_headers, + tags: + ) + end + + # @private + def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request_headers = + response.env.request_headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = + response.headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + + new( + verb: response.env.method.downcase, + url: response.env.url.to_s, + direction:, + name:, + status: response.status, + request_body: response.env.request_body, + response_body: response.body, + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + + # @private + def from_fhir_client_reply(reply, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request = reply.request + response = reply.response + request_headers = request[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = response[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + request_body = + if request.dig(:headers, 'Content-Type')&.include?('application/x-www-form-urlencoded') + URI.encode_www_form(request[:payload]) + else + request[:payload] + end + + new( + verb: request[:method].downcase, + url: request[:url], + direction:, + name:, + status: response[:code].to_i, + request_body:, + response_body: response[:body], + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + end +end+ |
+
Returns http response status code.
+ + +
+ + + +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226+ |
+
+ # File 'lib/inferno/entities/request.rb', line 33 + +class Request < Entity + ATTRIBUTES = [ + :id, :index, :verb, :url, :direction, :name, :status, + :request_body, :response_body, :result_id, :test_session_id, :created_at, + :updated_at, :headers, :tags + ].freeze + SUMMARY_FIELDS = [ + :id, :index, :url, :verb, :direction, :name, :status, :result_id, :created_at, :updated_at + ].freeze + + include Attributes + + # @private + def initialize(params) + super(params, ATTRIBUTES - [:headers, :name]) + + @name = params[:name]&.to_sym + @headers = params[:headers]&.map { |header| header.is_a?(Hash) ? Header.new(header) : header } || [] + (params[:tags] || []) + end + + def () + @tags = .map do |tag| + case tag + when Hash + tag[:name] + when String + tag + end + end + end + + # @return [Hash<String, String>] + def query_parameters + Addressable::URI.parse(url).query_values || {} + end + + # Find a response header + # + # @param name [String] the header name + # @return [Inferno::Entities::Header, nil] + def response_header(name) + response_headers.find { |header| header.name.casecmp(name).zero? } + end + + # Find a request header + # + # @param name [String] the header name. + # @return [Inferno::Entities::Header, nil] + def request_header(name) + request_headers.find { |header| header.name.casecmp(name).zero? } + end + + # All of the request headers + # + # @return [Array<Inferno::Entities::Header>] + def request_headers + headers.select(&:request?) + end + + # All of the response headers + # + # @return [Array<Inferno::Entities::Header>] + def response_headers + headers.select(&:response?) + end + + # Return a hash of the request parameters + # + # @return [Hash] A Hash with `:verb`, `:url`, `:headers`, and `:body` + # fields + def request + { + verb:, + url:, + headers: request_headers, + body: request_body + } + end + + # Return a hash of the response parameters + # + # @return [Hash] A Hash with `:status`, `:headers`, and `:body` fields + def response + { + status:, + headers: response_headers, + body: response_body + } + end + + # @private + def to_hash + { + id:, + verb:, + url:, + direction:, + status:, + name:, + request_body:, + response_body:, + result_id:, + test_session_id:, + request_headers: request_headers.map(&:to_hash), + response_headers: response_headers.map(&:to_hash), + tags:, + created_at:, + updated_at: + }.compact + end + + # Return the FHIR resource from the response body. + # + # @return [FHIR::Model, nil] + def resource + FHIR.from_contents(response_body) + end + + class << self + # @private + def from_hanami_request(request, name: nil, tags: []) + url = "#{request.base_url}#{request.path}" + url += "?#{request.query_string}" if request.query_string.present? + request_headers = + request.params.env + .select { |key, _| key.start_with? 'HTTP_' } + .transform_keys { |key| key.delete_prefix('HTTP_').tr('_', '-').downcase } + .map { |header_name, value| Header.new(name: header_name, value:, type: 'request') } + + new( + verb: request.request_method.downcase, + url:, + direction: 'incoming', + name:, + request_body: request.body.string, + headers: request_headers, + tags: + ) + end + + # @private + def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request_headers = + response.env.request_headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = + response.headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + + new( + verb: response.env.method.downcase, + url: response.env.url.to_s, + direction:, + name:, + status: response.status, + request_body: response.env.request_body, + response_body: response.body, + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + + # @private + def from_fhir_client_reply(reply, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request = reply.request + response = reply.response + request_headers = request[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = response[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + request_body = + if request.dig(:headers, 'Content-Type')&.include?('application/x-www-form-urlencoded') + URI.encode_www_form(request[:payload]) + else + request[:payload] + end + + new( + verb: request[:method].downcase, + url: request[:url], + direction:, + name:, + status: response[:code].to_i, + request_body:, + response_body: response[:body], + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + end +end+ |
+
Returns id of the test session for this request.
+ + +
+ + + +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226+ |
+
+ # File 'lib/inferno/entities/request.rb', line 33 + +class Request < Entity + ATTRIBUTES = [ + :id, :index, :verb, :url, :direction, :name, :status, + :request_body, :response_body, :result_id, :test_session_id, :created_at, + :updated_at, :headers, :tags + ].freeze + SUMMARY_FIELDS = [ + :id, :index, :url, :verb, :direction, :name, :status, :result_id, :created_at, :updated_at + ].freeze + + include Attributes + + # @private + def initialize(params) + super(params, ATTRIBUTES - [:headers, :name]) + + @name = params[:name]&.to_sym + @headers = params[:headers]&.map { |header| header.is_a?(Hash) ? Header.new(header) : header } || [] + (params[:tags] || []) + end + + def () + @tags = .map do |tag| + case tag + when Hash + tag[:name] + when String + tag + end + end + end + + # @return [Hash<String, String>] + def query_parameters + Addressable::URI.parse(url).query_values || {} + end + + # Find a response header + # + # @param name [String] the header name + # @return [Inferno::Entities::Header, nil] + def response_header(name) + response_headers.find { |header| header.name.casecmp(name).zero? } + end + + # Find a request header + # + # @param name [String] the header name. + # @return [Inferno::Entities::Header, nil] + def request_header(name) + request_headers.find { |header| header.name.casecmp(name).zero? } + end + + # All of the request headers + # + # @return [Array<Inferno::Entities::Header>] + def request_headers + headers.select(&:request?) + end + + # All of the response headers + # + # @return [Array<Inferno::Entities::Header>] + def response_headers + headers.select(&:response?) + end + + # Return a hash of the request parameters + # + # @return [Hash] A Hash with `:verb`, `:url`, `:headers`, and `:body` + # fields + def request + { + verb:, + url:, + headers: request_headers, + body: request_body + } + end + + # Return a hash of the response parameters + # + # @return [Hash] A Hash with `:status`, `:headers`, and `:body` fields + def response + { + status:, + headers: response_headers, + body: response_body + } + end + + # @private + def to_hash + { + id:, + verb:, + url:, + direction:, + status:, + name:, + request_body:, + response_body:, + result_id:, + test_session_id:, + request_headers: request_headers.map(&:to_hash), + response_headers: response_headers.map(&:to_hash), + tags:, + created_at:, + updated_at: + }.compact + end + + # Return the FHIR resource from the response body. + # + # @return [FHIR::Model, nil] + def resource + FHIR.from_contents(response_body) + end + + class << self + # @private + def from_hanami_request(request, name: nil, tags: []) + url = "#{request.base_url}#{request.path}" + url += "?#{request.query_string}" if request.query_string.present? + request_headers = + request.params.env + .select { |key, _| key.start_with? 'HTTP_' } + .transform_keys { |key| key.delete_prefix('HTTP_').tr('_', '-').downcase } + .map { |header_name, value| Header.new(name: header_name, value:, type: 'request') } + + new( + verb: request.request_method.downcase, + url:, + direction: 'incoming', + name:, + request_body: request.body.string, + headers: request_headers, + tags: + ) + end + + # @private + def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request_headers = + response.env.request_headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = + response.headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + + new( + verb: response.env.method.downcase, + url: response.env.url.to_s, + direction:, + name:, + status: response.status, + request_body: response.env.request_body, + response_body: response.body, + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + + # @private + def from_fhir_client_reply(reply, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request = reply.request + response = reply.response + request_headers = request[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = response[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + request_body = + if request.dig(:headers, 'Content-Type')&.include?('application/x-www-form-urlencoded') + URI.encode_www_form(request[:payload]) + else + request[:payload] + end + + new( + verb: request[:method].downcase, + url: request[:url], + direction:, + name:, + status: response[:code].to_i, + request_body:, + response_body: response[:body], + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + end +end+ |
+
Returns update timestamp.
+ + +
+ + + +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226+ |
+
+ # File 'lib/inferno/entities/request.rb', line 33 + +class Request < Entity + ATTRIBUTES = [ + :id, :index, :verb, :url, :direction, :name, :status, + :request_body, :response_body, :result_id, :test_session_id, :created_at, + :updated_at, :headers, :tags + ].freeze + SUMMARY_FIELDS = [ + :id, :index, :url, :verb, :direction, :name, :status, :result_id, :created_at, :updated_at + ].freeze + + include Attributes + + # @private + def initialize(params) + super(params, ATTRIBUTES - [:headers, :name]) + + @name = params[:name]&.to_sym + @headers = params[:headers]&.map { |header| header.is_a?(Hash) ? Header.new(header) : header } || [] + (params[:tags] || []) + end + + def () + @tags = .map do |tag| + case tag + when Hash + tag[:name] + when String + tag + end + end + end + + # @return [Hash<String, String>] + def query_parameters + Addressable::URI.parse(url).query_values || {} + end + + # Find a response header + # + # @param name [String] the header name + # @return [Inferno::Entities::Header, nil] + def response_header(name) + response_headers.find { |header| header.name.casecmp(name).zero? } + end + + # Find a request header + # + # @param name [String] the header name. + # @return [Inferno::Entities::Header, nil] + def request_header(name) + request_headers.find { |header| header.name.casecmp(name).zero? } + end + + # All of the request headers + # + # @return [Array<Inferno::Entities::Header>] + def request_headers + headers.select(&:request?) + end + + # All of the response headers + # + # @return [Array<Inferno::Entities::Header>] + def response_headers + headers.select(&:response?) + end + + # Return a hash of the request parameters + # + # @return [Hash] A Hash with `:verb`, `:url`, `:headers`, and `:body` + # fields + def request + { + verb:, + url:, + headers: request_headers, + body: request_body + } + end + + # Return a hash of the response parameters + # + # @return [Hash] A Hash with `:status`, `:headers`, and `:body` fields + def response + { + status:, + headers: response_headers, + body: response_body + } + end + + # @private + def to_hash + { + id:, + verb:, + url:, + direction:, + status:, + name:, + request_body:, + response_body:, + result_id:, + test_session_id:, + request_headers: request_headers.map(&:to_hash), + response_headers: response_headers.map(&:to_hash), + tags:, + created_at:, + updated_at: + }.compact + end + + # Return the FHIR resource from the response body. + # + # @return [FHIR::Model, nil] + def resource + FHIR.from_contents(response_body) + end + + class << self + # @private + def from_hanami_request(request, name: nil, tags: []) + url = "#{request.base_url}#{request.path}" + url += "?#{request.query_string}" if request.query_string.present? + request_headers = + request.params.env + .select { |key, _| key.start_with? 'HTTP_' } + .transform_keys { |key| key.delete_prefix('HTTP_').tr('_', '-').downcase } + .map { |header_name, value| Header.new(name: header_name, value:, type: 'request') } + + new( + verb: request.request_method.downcase, + url:, + direction: 'incoming', + name:, + request_body: request.body.string, + headers: request_headers, + tags: + ) + end + + # @private + def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request_headers = + response.env.request_headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = + response.headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + + new( + verb: response.env.method.downcase, + url: response.env.url.to_s, + direction:, + name:, + status: response.status, + request_body: response.env.request_body, + response_body: response.body, + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + + # @private + def from_fhir_client_reply(reply, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request = reply.request + response = reply.response + request_headers = request[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = response[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + request_body = + if request.dig(:headers, 'Content-Type')&.include?('application/x-www-form-urlencoded') + URI.encode_www_form(request[:payload]) + else + request[:payload] + end + + new( + verb: request[:method].downcase, + url: request[:url], + direction:, + name:, + status: response[:code].to_i, + request_body:, + response_body: response[:body], + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + end +end+ |
+
Returns request url.
+ + +
+ + + +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226+ |
+
+ # File 'lib/inferno/entities/request.rb', line 33 + +class Request < Entity + ATTRIBUTES = [ + :id, :index, :verb, :url, :direction, :name, :status, + :request_body, :response_body, :result_id, :test_session_id, :created_at, + :updated_at, :headers, :tags + ].freeze + SUMMARY_FIELDS = [ + :id, :index, :url, :verb, :direction, :name, :status, :result_id, :created_at, :updated_at + ].freeze + + include Attributes + + # @private + def initialize(params) + super(params, ATTRIBUTES - [:headers, :name]) + + @name = params[:name]&.to_sym + @headers = params[:headers]&.map { |header| header.is_a?(Hash) ? Header.new(header) : header } || [] + (params[:tags] || []) + end + + def () + @tags = .map do |tag| + case tag + when Hash + tag[:name] + when String + tag + end + end + end + + # @return [Hash<String, String>] + def query_parameters + Addressable::URI.parse(url).query_values || {} + end + + # Find a response header + # + # @param name [String] the header name + # @return [Inferno::Entities::Header, nil] + def response_header(name) + response_headers.find { |header| header.name.casecmp(name).zero? } + end + + # Find a request header + # + # @param name [String] the header name. + # @return [Inferno::Entities::Header, nil] + def request_header(name) + request_headers.find { |header| header.name.casecmp(name).zero? } + end + + # All of the request headers + # + # @return [Array<Inferno::Entities::Header>] + def request_headers + headers.select(&:request?) + end + + # All of the response headers + # + # @return [Array<Inferno::Entities::Header>] + def response_headers + headers.select(&:response?) + end + + # Return a hash of the request parameters + # + # @return [Hash] A Hash with `:verb`, `:url`, `:headers`, and `:body` + # fields + def request + { + verb:, + url:, + headers: request_headers, + body: request_body + } + end + + # Return a hash of the response parameters + # + # @return [Hash] A Hash with `:status`, `:headers`, and `:body` fields + def response + { + status:, + headers: response_headers, + body: response_body + } + end + + # @private + def to_hash + { + id:, + verb:, + url:, + direction:, + status:, + name:, + request_body:, + response_body:, + result_id:, + test_session_id:, + request_headers: request_headers.map(&:to_hash), + response_headers: response_headers.map(&:to_hash), + tags:, + created_at:, + updated_at: + }.compact + end + + # Return the FHIR resource from the response body. + # + # @return [FHIR::Model, nil] + def resource + FHIR.from_contents(response_body) + end + + class << self + # @private + def from_hanami_request(request, name: nil, tags: []) + url = "#{request.base_url}#{request.path}" + url += "?#{request.query_string}" if request.query_string.present? + request_headers = + request.params.env + .select { |key, _| key.start_with? 'HTTP_' } + .transform_keys { |key| key.delete_prefix('HTTP_').tr('_', '-').downcase } + .map { |header_name, value| Header.new(name: header_name, value:, type: 'request') } + + new( + verb: request.request_method.downcase, + url:, + direction: 'incoming', + name:, + request_body: request.body.string, + headers: request_headers, + tags: + ) + end + + # @private + def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request_headers = + response.env.request_headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = + response.headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + + new( + verb: response.env.method.downcase, + url: response.env.url.to_s, + direction:, + name:, + status: response.status, + request_body: response.env.request_body, + response_body: response.body, + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + + # @private + def from_fhir_client_reply(reply, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request = reply.request + response = reply.response + request_headers = request[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = response[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + request_body = + if request.dig(:headers, 'Content-Type')&.include?('application/x-www-form-urlencoded') + URI.encode_www_form(request[:payload]) + else + request[:payload] + end + + new( + verb: request[:method].downcase, + url: request[:url], + direction:, + name:, + status: response[:code].to_i, + request_body:, + response_body: response[:body], + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + end +end+ |
+
Returns http verb.
+ + +
+ + + +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226+ |
+
+ # File 'lib/inferno/entities/request.rb', line 33 + +class Request < Entity + ATTRIBUTES = [ + :id, :index, :verb, :url, :direction, :name, :status, + :request_body, :response_body, :result_id, :test_session_id, :created_at, + :updated_at, :headers, :tags + ].freeze + SUMMARY_FIELDS = [ + :id, :index, :url, :verb, :direction, :name, :status, :result_id, :created_at, :updated_at + ].freeze + + include Attributes + + # @private + def initialize(params) + super(params, ATTRIBUTES - [:headers, :name]) + + @name = params[:name]&.to_sym + @headers = params[:headers]&.map { |header| header.is_a?(Hash) ? Header.new(header) : header } || [] + (params[:tags] || []) + end + + def () + @tags = .map do |tag| + case tag + when Hash + tag[:name] + when String + tag + end + end + end + + # @return [Hash<String, String>] + def query_parameters + Addressable::URI.parse(url).query_values || {} + end + + # Find a response header + # + # @param name [String] the header name + # @return [Inferno::Entities::Header, nil] + def response_header(name) + response_headers.find { |header| header.name.casecmp(name).zero? } + end + + # Find a request header + # + # @param name [String] the header name. + # @return [Inferno::Entities::Header, nil] + def request_header(name) + request_headers.find { |header| header.name.casecmp(name).zero? } + end + + # All of the request headers + # + # @return [Array<Inferno::Entities::Header>] + def request_headers + headers.select(&:request?) + end + + # All of the response headers + # + # @return [Array<Inferno::Entities::Header>] + def response_headers + headers.select(&:response?) + end + + # Return a hash of the request parameters + # + # @return [Hash] A Hash with `:verb`, `:url`, `:headers`, and `:body` + # fields + def request + { + verb:, + url:, + headers: request_headers, + body: request_body + } + end + + # Return a hash of the response parameters + # + # @return [Hash] A Hash with `:status`, `:headers`, and `:body` fields + def response + { + status:, + headers: response_headers, + body: response_body + } + end + + # @private + def to_hash + { + id:, + verb:, + url:, + direction:, + status:, + name:, + request_body:, + response_body:, + result_id:, + test_session_id:, + request_headers: request_headers.map(&:to_hash), + response_headers: response_headers.map(&:to_hash), + tags:, + created_at:, + updated_at: + }.compact + end + + # Return the FHIR resource from the response body. + # + # @return [FHIR::Model, nil] + def resource + FHIR.from_contents(response_body) + end + + class << self + # @private + def from_hanami_request(request, name: nil, tags: []) + url = "#{request.base_url}#{request.path}" + url += "?#{request.query_string}" if request.query_string.present? + request_headers = + request.params.env + .select { |key, _| key.start_with? 'HTTP_' } + .transform_keys { |key| key.delete_prefix('HTTP_').tr('_', '-').downcase } + .map { |header_name, value| Header.new(name: header_name, value:, type: 'request') } + + new( + verb: request.request_method.downcase, + url:, + direction: 'incoming', + name:, + request_body: request.body.string, + headers: request_headers, + tags: + ) + end + + # @private + def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request_headers = + response.env.request_headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = + response.headers + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + + new( + verb: response.env.method.downcase, + url: response.env.url.to_s, + direction:, + name:, + status: response.status, + request_body: response.env.request_body, + response_body: response.body, + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + + # @private + def from_fhir_client_reply(reply, test_session_id:, direction: 'outgoing', name: nil, tags: []) + request = reply.request + response = reply.response + request_headers = request[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'request') } + response_headers = response[:headers] + .map { |header_name, value| Header.new(name: header_name.downcase, value:, type: 'response') } + request_body = + if request.dig(:headers, 'Content-Type')&.include?('application/x-www-form-urlencoded') + URI.encode_www_form(request[:payload]) + else + request[:payload] + end + + new( + verb: request[:method].downcase, + url: request[:url], + direction:, + name:, + status: response[:code].to_i, + request_body:, + response_body: response[:body], + test_session_id:, + headers: request_headers + response_headers, + tags: + ) + end + end +end+ |
+
+ + + +54 +55 +56 +57 +58 +59 +60 +61 +62 +63+ |
+
+ # File 'lib/inferno/entities/request.rb', line 54 + +def () + @tags = .map do |tag| + case tag + when Hash + tag[:name] + when String + tag + end + end +end+ |
+
+ + + +66 +67 +68+ |
+
+ # File 'lib/inferno/entities/request.rb', line 66 + +def query_parameters + Addressable::URI.parse(url).query_values || {} +end+ |
+
Return a hash of the request parameters
+ + +
+ + + +104 +105 +106 +107 +108 +109 +110 +111+ |
+
+ # File 'lib/inferno/entities/request.rb', line 104 + +def request + { + verb:, + url:, + headers: request_headers, + body: request_body + } +end+ |
+
Find a request header
+ + +
+ + + +82 +83 +84+ |
+
+ # File 'lib/inferno/entities/request.rb', line 82 + +def request_header(name) + request_headers.find { |header| header.name.casecmp(name).zero? } +end+ |
+
All of the request headers
+ + +
+ + + +89 +90 +91+ |
+
+ # File 'lib/inferno/entities/request.rb', line 89 + +def request_headers + headers.select(&:request?) +end+ |
+
Return the FHIR resource from the response body.
+ + +
+ + + +148 +149 +150+ |
+
+ # File 'lib/inferno/entities/request.rb', line 148 + +def resource + FHIR.from_contents(response_body) +end+ |
+
Return a hash of the response parameters
+ + +
+ + + +116 +117 +118 +119 +120 +121 +122+ |
+
+ # File 'lib/inferno/entities/request.rb', line 116 + +def response + { + status:, + headers: response_headers, + body: response_body + } +end+ |
+
Find a response header
+ + +
+ + + +74 +75 +76+ |
+
+ # File 'lib/inferno/entities/request.rb', line 74 + +def response_header(name) + response_headers.find { |header| header.name.casecmp(name).zero? } +end+ |
+
All of the response headers
+ + +
+ + + +96 +97 +98+ |
+
+ # File 'lib/inferno/entities/request.rb', line 96 + +def response_headers + headers.select(&:response?) +end+ |
+
A Result represents the result of running a Test, TestGroup,
+or TestSuite
[ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json +].freeze
['cancel', 'wait', 'running', 'error', 'fail', 'skip', 'pass', 'omit'].freeze
Creation timestamp.
+Id of the session.
+JSON string of the inputs used for this result.
+result.
+JSON string of the outputs created by this result.
+associated with this result.
+running, wait, cancel).
Summary message for this result.
+The Test this result belongs to.
The TestGroup this result belongs to.
Id of the TestGroup this result belongs to.
Id of the Test this result belongs to.
The TestRun this result belongs to.
The TestSession this result belongs to.
The TestSuite this result belongs to.
Id of the TestSuite this result belongs to.
Update timestamp.
+A new instance of Result.
+Returns a new instance of Result.
+ + +
+ + + +55 +56 +57 +58 +59 +60+ |
+
+ # File 'lib/inferno/entities/result.rb', line 55 + +def initialize(params) + super(params, ATTRIBUTES - [:messages, :requests]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } +end+ |
+
Returns creation timestamp.
+ + +
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
Returns id of the session.
+ + +
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
Returns JSON string of the inputs used for this result.
+ + +
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
result
+ + +
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
Returns JSON string of the outputs created by this result.
+ + +
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
associated with this result
+ + +
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
running, wait, cancel)
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
Returns summary message for this result.
+ + +
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
Returns the Test this result belongs to.
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
Returns the TestGroup this result belongs to.
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
Returns id of the TestGroup this result belongs to.
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
Returns id of the Test this result belongs to.
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
Returns the TestRun this result belongs to.
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
Returns the TestSession this result belongs to.
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
Returns the TestSuite this result belongs to.
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
Returns id of the TestSuite this result belongs to.
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
Returns update timestamp.
+ + +
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/result.rb', line 43 + +class Result < Entity + ATTRIBUTES = [ + :id, :created_at, :updated_at, :test_id, :test, :test_group_id, + :test_group, :test_suite_id, :test_suite, :test_run_id, + :test_session_id, :result, :result_message, :messages, :requests, + :input_json, :output_json + ].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]) + + @messages = (params[:messages] || []).map { || Message.new() } + @requests = (params[:requests] || []).map { |request| Request.new(request) } + end + + def optional? + runnable.nil? || runnable.optional? + end + + def required? + !optional? + end + + # @return [Boolean] + def waiting? + result == 'wait' + end +end+ |
+
+ + + +62 +63 +64+ |
+
+ # File 'lib/inferno/entities/result.rb', line 62 + +def optional? + runnable.nil? || runnable.optional? +end+ |
+
+ + + +66 +67 +68+ |
+
+ # File 'lib/inferno/entities/result.rb', line 66 + +def required? + !optional? +end+ |
+
+ + + +71 +72 +73+ |
+
+ # File 'lib/inferno/entities/result.rb', line 71 + +def waiting? + result == 'wait' +end+ |
+
SessionData represents a piece of saved state for a TestSession.
+These are used to store test inputs and outputs.
[:id, :name, :value, :test_session_id, :created_at, :updated_at].freeze
Id of the test input.
+A new instance of SessionData.
+Returns a new instance of SessionData.
+ + +
+ + + +23 +24 +25+ |
+
+ # File 'lib/inferno/entities/session_data.rb', line 23 + +def initialize(params) + super(params, ATTRIBUTES) +end+ |
+
+ + + +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37+ |
+
+ # File 'lib/inferno/entities/session_data.rb', line 18 + +class SessionData < Entity + ATTRIBUTES = [:id, :name, :value, :test_session_id, :created_at, :updated_at].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end + + def to_hash + { + id:, + name:, + value:, + test_session_id:, + created_at:, + updated_at: + } + end +end+ |
+
Returns id of the test input.
+ + +
+ + + +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37+ |
+
+ # File 'lib/inferno/entities/session_data.rb', line 18 + +class SessionData < Entity + ATTRIBUTES = [:id, :name, :value, :test_session_id, :created_at, :updated_at].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end + + def to_hash + { + id:, + name:, + value:, + test_session_id:, + created_at:, + updated_at: + } + end +end+ |
+
+ + + +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37+ |
+
+ # File 'lib/inferno/entities/session_data.rb', line 18 + +class SessionData < Entity + ATTRIBUTES = [:id, :name, :value, :test_session_id, :created_at, :updated_at].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end + + def to_hash + { + id:, + name:, + value:, + test_session_id:, + created_at:, + updated_at: + } + end +end+ |
+
+ + + +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37+ |
+
+ # File 'lib/inferno/entities/session_data.rb', line 18 + +class SessionData < Entity + ATTRIBUTES = [:id, :name, :value, :test_session_id, :created_at, :updated_at].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end + + def to_hash + { + id:, + name:, + value:, + test_session_id:, + created_at:, + updated_at: + } + end +end+ |
+
+ + + +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37+ |
+
+ # File 'lib/inferno/entities/session_data.rb', line 18 + +class SessionData < Entity + ATTRIBUTES = [:id, :name, :value, :test_session_id, :created_at, :updated_at].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end + + def to_hash + { + id:, + name:, + value:, + test_session_id:, + created_at:, + updated_at: + } + end +end+ |
+
+ + + +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37+ |
+
+ # File 'lib/inferno/entities/session_data.rb', line 18 + +class SessionData < Entity + ATTRIBUTES = [:id, :name, :value, :test_session_id, :created_at, :updated_at].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + end + + def to_hash + { + id:, + name:, + value:, + test_session_id:, + created_at:, + updated_at: + } + end +end+ |
+
+ + + +27 +28 +29 +30 +31 +32 +33 +34 +35 +36+ |
+
+ # File 'lib/inferno/entities/session_data.rb', line 27 + +def to_hash + { + id:, + name:, + value:, + test_session_id:, + created_at:, + updated_at: + } +end+ |
+
DSL::EXTENDABLE_DSL_MODULES, DSL::INCLUDABLE_DSL_MODULES
+ + +Returns the value of attribute result_message.
+Returns the value of attribute scratch.
+Returns the value of attribute suite_options.
+Returns the value of attribute test_session_id.
+Define inputs for this Test.
+Define outputs for this Test.
+Set output values.
++ This class handles dynamic methods through the method_missing method + +
+ +
+ + + +47 +48 +49 +50 +51 +52 +53 +54+ |
+
+ # File 'lib/inferno/entities/test.rb', line 47 + +def method_missing(name, ...) + parent_instance = self.class.parent&.new + if parent_instance.respond_to?(name) + parent_instance.send(name, ...) + else + super + end +end+ |
+
Returns the value of attribute result_message.
+ + +
+ + + +13 +14 +15+ |
+
+ # File 'lib/inferno/entities/test.rb', line 13 + +def + @result_message +end+ |
+
Returns the value of attribute scratch.
+ + +
+ + + +14 +15 +16+ |
+
+ # File 'lib/inferno/entities/test.rb', line 14 + +def scratch + @scratch +end+ |
+
Returns the value of attribute suite_options.
+ + +
+ + + +14 +15 +16+ |
+
+ # File 'lib/inferno/entities/test.rb', line 14 + +def + @suite_options +end+ |
+
Returns the value of attribute test_session_id.
+ + +
+ + + +14 +15 +16+ |
+
+ # File 'lib/inferno/entities/test.rb', line 14 + +def test_session_id + @test_session_id +end+ |
+
This method returns an undefined value.
Define inputs for this Test
+ + +
+ + + +75 +76 +77 +78 +79 +80 +81 +82 +83+ |
+
+ # File 'lib/inferno/entities/test.rb', line 75 + +def input(name, *other_names, **input_params) + super + + if other_names.present? + [name, *other_names].each { |input| attr_reader input } + else + attr_reader name + end +end+ |
+
This method returns an undefined value.
Define outputs for this Test
+ + +
+ + + +93 +94 +95 +96 +97 +98 +99+ |
+
+ # File 'lib/inferno/entities/test.rb', line 93 + +def output(*output_definitions, **_output_params) + super + + output_definitions.each do |output| + attr_accessor output + end +end+ |
+
+ + + +106 +107 +108 +109 +110 +111 +112+ |
+
+ # File 'lib/inferno/entities/test.rb', line 106 + +def short_id + @short_id ||= begin + prefix = parent.respond_to?(:short_id) ? "#{parent.short_id}." : '' + suffix = parent ? (parent.tests.find_index(self) + 1).to_s.rjust(2, '0') : 'x' + "#{prefix}#{suffix}" + end +end+ |
+
This method returns an undefined value.
Set output values. Once set, these values will be available to any +subsequent tests.
+ + +
+ + + +31 +32 +33 +34 +35 +36+ |
+
+ # File 'lib/inferno/entities/test.rb', line 31 + +def output(outputs) + outputs.each do |key, value| + send("#{key}=", value) + outputs_to_persist[key] = value + end +end+ |
+
Returns the value of attribute result_message.
+Returns the value of attribute results.
+#parent, #suite_option_requirements
+ + + +Add a child group.
+Get this group’s child groups, filtered by suite options, if provided.
+When true, this group’s children can not be run individually in the UI, and this group must be run as a group.
+A short numeric id which is displayed in the UI.
+Add a test.
+Get this group’s child tests, filtered by suite options, if provided.
+block, description, id, input_instructions, optional, optional?, required, required?, required_suite_options, resume_test_route, route, short_description, short_title, suite_endpoint, title
+ + + + + + + + + + + + + + + +#assert, #assert_resource_type, #assert_response_content_type, #assert_response_status, #assert_valid_bundle_entries, #assert_valid_http_uri, #assert_valid_json, #assert_valid_resource
+ + + + + + + + + +#omit, #omit_if, #pass, #pass_if, #skip, #skip_if, #wait
+ + + + + + + + + +#find_validator, #resource_is_valid?
++ This class handles dynamic methods through the method_missing method + +
+ +
+ + + +28 +29 +30 +31 +32 +33 +34 +35+ |
+
+ # File 'lib/inferno/entities/test_group.rb', line 28 + +def method_missing(name, ...) + parent_instance = self.class.parent&.new + if parent_instance.respond_to?(name) + parent_instance.send(name, ...) + else + super + end +end+ |
+
Returns the value of attribute result_message.
+ + +
+ + + +20 +21 +22+ |
+
+ # File 'lib/inferno/entities/test_group.rb', line 20 + +def + @result_message +end+ |
+
Returns the value of attribute results.
+ + +
+ + + +20 +21 +22+ |
+
+ # File 'lib/inferno/entities/test_group.rb', line 20 + +def results + @results +end+ |
+
This method returns an undefined value.
Add a child group
+ + +
+ + + +70 +71 +72 +73+ |
+
+ # File 'lib/inferno/entities/test_group.rb', line 70 + +def group(...) + () + define_child(...) +end+ |
+
Get this group’s child groups, filtered by suite options, if provided.
+ + +
+ + + +53 +54 +55+ |
+
+ # File 'lib/inferno/entities/test_group.rb', line 53 + +def groups( = nil) + children().select { |child| child < Inferno::Entities::TestGroup } +end+ |
+
This method returns an undefined value.
When true, this group’s children can not be run individually in the +UI, and this group must be run as a group.
+ + +
+ + + +127 +128 +129+ |
+
+ # File 'lib/inferno/entities/test_group.rb', line 127 + +def run_as_group(value = true) # rubocop:disable Style/OptionalBooleanParameter + @run_as_group = value +end+ |
+
+ + + +132 +133 +134+ |
+
+ # File 'lib/inferno/entities/test_group.rb', line 132 + +def run_as_group? + @run_as_group || false +end+ |
+
Returns A short numeric id which is displayed in the UI.
+ + +
+ + + +99 +100 +101 +102 +103 +104 +105+ |
+
+ # File 'lib/inferno/entities/test_group.rb', line 99 + +def short_id + @short_id ||= begin + prefix = parent.respond_to?(:short_id) ? "#{parent.short_id}." : '' + suffix = parent ? (parent.groups.find_index(self) + 1).to_s : 'X' + "#{prefix}#{suffix}" + end +end+ |
+
This method returns an undefined value.
Add a test
+ + +
+ + + +77 +78 +79 +80+ |
+
+ # File 'lib/inferno/entities/test_group.rb', line 77 + +def test(...) + () + define_child(...) +end+ |
+
Get this group’s child tests, filtered by suite options, if provided.
+ + +
+ + + +62 +63 +64+ |
+
+ # File 'lib/inferno/entities/test_group.rb', line 62 + +def tests( = nil) + children().select { |child| child < Inferno::Entities::Test } +end+ |
+
Set/get the list of authors for the test kit.
+Set/get the description for the test kit.
+Set/get the id for the test kit.
+Set/get the last updated date for the test kit.
+Set/get the maturity level for the test kit.
+Get the options for the suites in the test kit.
+Set/get the code repository url for the test kit.
+Set/get the suite ids for the test kit.
+Get the suites whose ids are defined in suite_ids.
Set/get the tags for the test kit.
+Set/get the title for the test kit.
+Set/get the version for the test kit.
+Set/get the list of authors for the test kit
+ + +
+ + + +127 +128 +129 +130 +131+ |
+
+ # File 'lib/inferno/entities/test_kit.rb', line 127 + +def ( = nil) + return @authors if .nil? + + @authors = +end+ |
+
Set/get the description for the test kit
+ + +
+ + + +57 +58 +59 +60 +61+ |
+
+ # File 'lib/inferno/entities/test_kit.rb', line 57 + +def description(new_description = nil) + return @description if new_description.nil? + + @description = new_description +end+ |
+
Set/get the id for the test kit
+ + +
+ + + +37 +38 +39 +40 +41+ |
+
+ # File 'lib/inferno/entities/test_kit.rb', line 37 + +def id(new_id = nil) + return @id if new_id.nil? + + @id = new_id +end+ |
+
Set/get the last updated date for the test kit
+ + +
+ + + +77 +78 +79 +80 +81+ |
+
+ # File 'lib/inferno/entities/test_kit.rb', line 77 + +def last_updated(new_last_updated = nil) + return @last_updated if new_last_updated.nil? + + @last_updated = new_last_updated +end+ |
+
Set/get the maturity level for the test kit
+ + +
+ + + +97 +98 +99 +100 +101+ |
+
+ # File 'lib/inferno/entities/test_kit.rb', line 97 + +def maturity(new_maturity = nil) + return @maturity if new_maturity.nil? + + @maturity = new_maturity +end+ |
+
Get the options for the suites in the test kit
+ + +
+ + + +146 +147 +148 +149 +150+ |
+
+ # File 'lib/inferno/entities/test_kit.rb', line 146 + +def + return @options if @options.present? + + @options = suites.each_with_object({}) { |suite, hash| hash[suite.id] = suite. } +end+ |
+
Set/get the code repository url for the test kit
+ + +
+ + + +117 +118 +119 +120 +121+ |
+
+ # File 'lib/inferno/entities/test_kit.rb', line 117 + +def repo(new_repo = nil) + return @repo if new_repo.nil? + + @repo = new_repo +end+ |
+
Set/get the suite ids for the test kit
+ + +
+ + + +107 +108 +109 +110 +111+ |
+
+ # File 'lib/inferno/entities/test_kit.rb', line 107 + +def suite_ids(new_ids = nil) + return @suite_ids || [] if new_ids.nil? + + @suite_ids = new_ids +end+ |
+
Get the suites whose ids are defined in suite_ids
+ + + +136 +137 +138 +139 +140 +141+ |
+
+ # File 'lib/inferno/entities/test_kit.rb', line 136 + +def suites + return @suites if @suites.present? + + repo = Inferno::Repositories::TestSuites.new + @suites = suite_ids.map { |id| repo.find(id) } +end+ |
+
Set/get the tags for the test kit
+ + +
+ + + +67 +68 +69 +70 +71+ |
+
+ # File 'lib/inferno/entities/test_kit.rb', line 67 + +def ( = nil) + return @tags if .nil? + + @tags = +end+ |
+
Set/get the title for the test kit
+ + +
+ + + +47 +48 +49 +50 +51+ |
+
+ # File 'lib/inferno/entities/test_kit.rb', line 47 + +def title(new_title = nil) + return @title if new_title.nil? + + @title = new_title +end+ |
+
Set/get the version for the test kit
+ + +
+ + + +87 +88 +89 +90 +91+ |
+
+ # File 'lib/inferno/entities/test_kit.rb', line 87 + +def version(new_version = nil) + return @version if new_version.nil? + + @version = new_version +end+ |
+
A TestRun represents a request to execute an executable set of tests.
['queued', 'running', 'waiting', 'cancelling', 'done'].freeze
[ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at +].freeze
Creation timestamp.
+Id of the test run.
+Identfier for a waiting TestRun.
The Test this result belongs to.
The TestGroup this result belongs to.
Id of the TestGroup this result belongs to.
Id of the Test this result belongs to.
Returns the value of attribute test_session.
+The TestSuite this result belongs to.
Id of the TestSuite this result belongs to.
Update timestamp.
+A TestRun represents a request to execute an executable set of tests.
How to define test run inputs? Class in this file? Separate Entity?.
+How to define test run inputs? Class in this file? Separate Entity?
+ + +
+ + + +61 +62 +63 +64 +65+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 61 + +def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] +end+ |
+
Returns creation timestamp.
+ + +
+ + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 34 + +class TestRun < Entity + STATUS_OPTIONS = ['queued', 'running', 'waiting', 'cancelling', 'done'].freeze + ATTRIBUTES = [ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at + ].freeze + + include Inferno::Entities::Attributes + include Inferno::Entities::HasRunnable + + attr_accessor :test_session + + # How to define test run inputs? Class in this file? Separate Entity? + + def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] + end + + def to_hash + super.merge(test_session:).compact + end + + def test_count( = []) + @test_count ||= runnable.test_count() + end +end+ |
+
Returns id of the test run.
+ + +
+ + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 34 + +class TestRun < Entity + STATUS_OPTIONS = ['queued', 'running', 'waiting', 'cancelling', 'done'].freeze + ATTRIBUTES = [ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at + ].freeze + + include Inferno::Entities::Attributes + include Inferno::Entities::HasRunnable + + attr_accessor :test_session + + # How to define test run inputs? Class in this file? Separate Entity? + + def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] + end + + def to_hash + super.merge(test_session:).compact + end + + def test_count( = []) + @test_count ||= runnable.test_count() + end +end+ |
+
Returns identfier for a waiting TestRun.
+ + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 34 + +class TestRun < Entity + STATUS_OPTIONS = ['queued', 'running', 'waiting', 'cancelling', 'done'].freeze + ATTRIBUTES = [ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at + ].freeze + + include Inferno::Entities::Attributes + include Inferno::Entities::HasRunnable + + attr_accessor :test_session + + # How to define test run inputs? Class in this file? Separate Entity? + + def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] + end + + def to_hash + super.merge(test_session:).compact + end + + def test_count( = []) + @test_count ||= runnable.test_count() + end +end+ |
+
+ + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 34 + +class TestRun < Entity + STATUS_OPTIONS = ['queued', 'running', 'waiting', 'cancelling', 'done'].freeze + ATTRIBUTES = [ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at + ].freeze + + include Inferno::Entities::Attributes + include Inferno::Entities::HasRunnable + + attr_accessor :test_session + + # How to define test run inputs? Class in this file? Separate Entity? + + def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] + end + + def to_hash + super.merge(test_session:).compact + end + + def test_count( = []) + @test_count ||= runnable.test_count() + end +end+ |
+
+ + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 34 + +class TestRun < Entity + STATUS_OPTIONS = ['queued', 'running', 'waiting', 'cancelling', 'done'].freeze + ATTRIBUTES = [ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at + ].freeze + + include Inferno::Entities::Attributes + include Inferno::Entities::HasRunnable + + attr_accessor :test_session + + # How to define test run inputs? Class in this file? Separate Entity? + + def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] + end + + def to_hash + super.merge(test_session:).compact + end + + def test_count( = []) + @test_count ||= runnable.test_count() + end +end+ |
+
+ + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 34 + +class TestRun < Entity + STATUS_OPTIONS = ['queued', 'running', 'waiting', 'cancelling', 'done'].freeze + ATTRIBUTES = [ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at + ].freeze + + include Inferno::Entities::Attributes + include Inferno::Entities::HasRunnable + + attr_accessor :test_session + + # How to define test run inputs? Class in this file? Separate Entity? + + def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] + end + + def to_hash + super.merge(test_session:).compact + end + + def test_count( = []) + @test_count ||= runnable.test_count() + end +end+ |
+
Returns the Test this result belongs to.
+ + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 34 + +class TestRun < Entity + STATUS_OPTIONS = ['queued', 'running', 'waiting', 'cancelling', 'done'].freeze + ATTRIBUTES = [ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at + ].freeze + + include Inferno::Entities::Attributes + include Inferno::Entities::HasRunnable + + attr_accessor :test_session + + # How to define test run inputs? Class in this file? Separate Entity? + + def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] + end + + def to_hash + super.merge(test_session:).compact + end + + def test_count( = []) + @test_count ||= runnable.test_count() + end +end+ |
+
Returns the TestGroup this result belongs to.
+ + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 34 + +class TestRun < Entity + STATUS_OPTIONS = ['queued', 'running', 'waiting', 'cancelling', 'done'].freeze + ATTRIBUTES = [ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at + ].freeze + + include Inferno::Entities::Attributes + include Inferno::Entities::HasRunnable + + attr_accessor :test_session + + # How to define test run inputs? Class in this file? Separate Entity? + + def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] + end + + def to_hash + super.merge(test_session:).compact + end + + def test_count( = []) + @test_count ||= runnable.test_count() + end +end+ |
+
Returns id of the TestGroup this result belongs to.
+ + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 34 + +class TestRun < Entity + STATUS_OPTIONS = ['queued', 'running', 'waiting', 'cancelling', 'done'].freeze + ATTRIBUTES = [ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at + ].freeze + + include Inferno::Entities::Attributes + include Inferno::Entities::HasRunnable + + attr_accessor :test_session + + # How to define test run inputs? Class in this file? Separate Entity? + + def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] + end + + def to_hash + super.merge(test_session:).compact + end + + def test_count( = []) + @test_count ||= runnable.test_count() + end +end+ |
+
Returns id of the Test this result belongs to.
+ + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 34 + +class TestRun < Entity + STATUS_OPTIONS = ['queued', 'running', 'waiting', 'cancelling', 'done'].freeze + ATTRIBUTES = [ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at + ].freeze + + include Inferno::Entities::Attributes + include Inferno::Entities::HasRunnable + + attr_accessor :test_session + + # How to define test run inputs? Class in this file? Separate Entity? + + def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] + end + + def to_hash + super.merge(test_session:).compact + end + + def test_count( = []) + @test_count ||= runnable.test_count() + end +end+ |
+
Returns the value of attribute test_session.
+ + +
+ + + +57 +58 +59+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 57 + +def test_session + @test_session +end+ |
+
+ + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 34 + +class TestRun < Entity + STATUS_OPTIONS = ['queued', 'running', 'waiting', 'cancelling', 'done'].freeze + ATTRIBUTES = [ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at + ].freeze + + include Inferno::Entities::Attributes + include Inferno::Entities::HasRunnable + + attr_accessor :test_session + + # How to define test run inputs? Class in this file? Separate Entity? + + def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] + end + + def to_hash + super.merge(test_session:).compact + end + + def test_count( = []) + @test_count ||= runnable.test_count() + end +end+ |
+
Returns the TestSuite this result belongs to.
+ + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 34 + +class TestRun < Entity + STATUS_OPTIONS = ['queued', 'running', 'waiting', 'cancelling', 'done'].freeze + ATTRIBUTES = [ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at + ].freeze + + include Inferno::Entities::Attributes + include Inferno::Entities::HasRunnable + + attr_accessor :test_session + + # How to define test run inputs? Class in this file? Separate Entity? + + def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] + end + + def to_hash + super.merge(test_session:).compact + end + + def test_count( = []) + @test_count ||= runnable.test_count() + end +end+ |
+
Returns id of the TestSuite this result belongs to.
+ + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 34 + +class TestRun < Entity + STATUS_OPTIONS = ['queued', 'running', 'waiting', 'cancelling', 'done'].freeze + ATTRIBUTES = [ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at + ].freeze + + include Inferno::Entities::Attributes + include Inferno::Entities::HasRunnable + + attr_accessor :test_session + + # How to define test run inputs? Class in this file? Separate Entity? + + def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] + end + + def to_hash + super.merge(test_session:).compact + end + + def test_count( = []) + @test_count ||= runnable.test_count() + end +end+ |
+
Returns update timestamp.
+ + +
+ + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 34 + +class TestRun < Entity + STATUS_OPTIONS = ['queued', 'running', 'waiting', 'cancelling', 'done'].freeze + ATTRIBUTES = [ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at + ].freeze + + include Inferno::Entities::Attributes + include Inferno::Entities::HasRunnable + + attr_accessor :test_session + + # How to define test run inputs? Class in this file? Separate Entity? + + def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] + end + + def to_hash + super.merge(test_session:).compact + end + + def test_count( = []) + @test_count ||= runnable.test_count() + end +end+ |
+
A TestRun represents a request to execute an executable set of tests.
+ + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 34 + +class TestRun < Entity + STATUS_OPTIONS = ['queued', 'running', 'waiting', 'cancelling', 'done'].freeze + ATTRIBUTES = [ + :id, + :test_session_id, + :status, + :test_suite_id, + :test_group_id, + :test_id, + :test, + :test_group, + :test_suite, + :inputs, + :results, + :identifier, + :wait_timeout, + :created_at, + :updated_at + ].freeze + + include Inferno::Entities::Attributes + include Inferno::Entities::HasRunnable + + attr_accessor :test_session + + # How to define test run inputs? Class in this file? Separate Entity? + + def initialize(params) + super(params, ATTRIBUTES) + + @test_session = params[:test_session] + end + + def to_hash + super.merge(test_session:).compact + end + + def test_count( = []) + @test_count ||= runnable.test_count() + end +end+ |
+
+ + + +71 +72 +73+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 71 + +def test_count( = []) + @test_count ||= runnable.test_count() +end+ |
+
+ + + +67 +68 +69+ |
+
+ # File 'lib/inferno/entities/test_run.rb', line 67 + +def to_hash + super.merge(test_session:).compact +end+ |
+
A TestSession represents an individual testing session.
[ + :id, + :created_at, + :updated_at, + :test_suite_id, + :test_suite, + :test_runs, + :results, + :suite_options +].freeze
Creation timestamp.
+Id of the session.
+The TestResults associated with this session.
The suite options associated with this session.
+The TestRuns associated with this session.
The TestSuite being run in this session.
Id of the TestSuite being run in this session.
Update timestamp.
+A new instance of TestSession.
+Returns a new instance of TestSession.
+ + +
+ + + +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48+ |
+
+ # File 'lib/inferno/entities/test_session.rb', line 38 + +def initialize(params) + super(params, ATTRIBUTES) + + self. ||= [] + + test_suite&.&.each do |option| + if .none? { |selected_option| selected_option.id == option.id } + << DSL::SuiteOption.new(id: option.id, value: option..first[:value]) + end + end +end+ |
+
Returns creation timestamp.
+ + +
+ + + +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69+ |
+
+ # File 'lib/inferno/entities/test_session.rb', line 24 + +class TestSession < Entity + ATTRIBUTES = [ + :id, + :created_at, + :updated_at, + :test_suite_id, + :test_suite, + :test_runs, + :results, + :suite_options + ].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + + self. ||= [] + + test_suite&.&.each do |option| + if .none? { |selected_option| selected_option.id == option.id } + << DSL::SuiteOption.new(id: option.id, value: option..first[:value]) + end + end + end + + def test_suite + @test_suite ||= Repositories::TestSuites.new.find(test_suite_id) + end + + def to_hash + session_hash = (self.class::ATTRIBUTES - [:suite_options]).each_with_object({}) do |attribute, hash| + hash[attribute] = send(attribute) + end + + session_hash[:suite_options] = &.map(&:to_hash) || [] + + session_hash.compact + end + + def + ( || []).each_with_object({}) do |option, hash| + hash[option.id] = option.value + end + end +end+ |
+
Returns id of the session.
+ + +
+ + + +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69+ |
+
+ # File 'lib/inferno/entities/test_session.rb', line 24 + +class TestSession < Entity + ATTRIBUTES = [ + :id, + :created_at, + :updated_at, + :test_suite_id, + :test_suite, + :test_runs, + :results, + :suite_options + ].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + + self. ||= [] + + test_suite&.&.each do |option| + if .none? { |selected_option| selected_option.id == option.id } + << DSL::SuiteOption.new(id: option.id, value: option..first[:value]) + end + end + end + + def test_suite + @test_suite ||= Repositories::TestSuites.new.find(test_suite_id) + end + + def to_hash + session_hash = (self.class::ATTRIBUTES - [:suite_options]).each_with_object({}) do |attribute, hash| + hash[attribute] = send(attribute) + end + + session_hash[:suite_options] = &.map(&:to_hash) || [] + + session_hash.compact + end + + def + ( || []).each_with_object({}) do |option, hash| + hash[option.id] = option.value + end + end +end+ |
+
Returns the TestResults
+associated with this session.
+ + + +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69+ |
+
+ # File 'lib/inferno/entities/test_session.rb', line 24 + +class TestSession < Entity + ATTRIBUTES = [ + :id, + :created_at, + :updated_at, + :test_suite_id, + :test_suite, + :test_runs, + :results, + :suite_options + ].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + + self. ||= [] + + test_suite&.&.each do |option| + if .none? { |selected_option| selected_option.id == option.id } + << DSL::SuiteOption.new(id: option.id, value: option..first[:value]) + end + end + end + + def test_suite + @test_suite ||= Repositories::TestSuites.new.find(test_suite_id) + end + + def to_hash + session_hash = (self.class::ATTRIBUTES - [:suite_options]).each_with_object({}) do |attribute, hash| + hash[attribute] = send(attribute) + end + + session_hash[:suite_options] = &.map(&:to_hash) || [] + + session_hash.compact + end + + def + ( || []).each_with_object({}) do |option, hash| + hash[option.id] = option.value + end + end +end+ |
+
Returns the suite options associated with this session.
+ + +
+ + + +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69+ |
+
+ # File 'lib/inferno/entities/test_session.rb', line 24 + +class TestSession < Entity + ATTRIBUTES = [ + :id, + :created_at, + :updated_at, + :test_suite_id, + :test_suite, + :test_runs, + :results, + :suite_options + ].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + + self. ||= [] + + test_suite&.&.each do |option| + if .none? { |selected_option| selected_option.id == option.id } + << DSL::SuiteOption.new(id: option.id, value: option..first[:value]) + end + end + end + + def test_suite + @test_suite ||= Repositories::TestSuites.new.find(test_suite_id) + end + + def to_hash + session_hash = (self.class::ATTRIBUTES - [:suite_options]).each_with_object({}) do |attribute, hash| + hash[attribute] = send(attribute) + end + + session_hash[:suite_options] = &.map(&:to_hash) || [] + + session_hash.compact + end + + def + ( || []).each_with_object({}) do |option, hash| + hash[option.id] = option.value + end + end +end+ |
+
Returns the TestRuns associated
+with this session.
+ + + +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69+ |
+
+ # File 'lib/inferno/entities/test_session.rb', line 24 + +class TestSession < Entity + ATTRIBUTES = [ + :id, + :created_at, + :updated_at, + :test_suite_id, + :test_suite, + :test_runs, + :results, + :suite_options + ].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + + self. ||= [] + + test_suite&.&.each do |option| + if .none? { |selected_option| selected_option.id == option.id } + << DSL::SuiteOption.new(id: option.id, value: option..first[:value]) + end + end + end + + def test_suite + @test_suite ||= Repositories::TestSuites.new.find(test_suite_id) + end + + def to_hash + session_hash = (self.class::ATTRIBUTES - [:suite_options]).each_with_object({}) do |attribute, hash| + hash[attribute] = send(attribute) + end + + session_hash[:suite_options] = &.map(&:to_hash) || [] + + session_hash.compact + end + + def + ( || []).each_with_object({}) do |option, hash| + hash[option.id] = option.value + end + end +end+ |
+
Returns the TestSuite being run in this
+session.
+ + + +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69+ |
+
+ # File 'lib/inferno/entities/test_session.rb', line 24 + +class TestSession < Entity + ATTRIBUTES = [ + :id, + :created_at, + :updated_at, + :test_suite_id, + :test_suite, + :test_runs, + :results, + :suite_options + ].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + + self. ||= [] + + test_suite&.&.each do |option| + if .none? { |selected_option| selected_option.id == option.id } + << DSL::SuiteOption.new(id: option.id, value: option..first[:value]) + end + end + end + + def test_suite + @test_suite ||= Repositories::TestSuites.new.find(test_suite_id) + end + + def to_hash + session_hash = (self.class::ATTRIBUTES - [:suite_options]).each_with_object({}) do |attribute, hash| + hash[attribute] = send(attribute) + end + + session_hash[:suite_options] = &.map(&:to_hash) || [] + + session_hash.compact + end + + def + ( || []).each_with_object({}) do |option, hash| + hash[option.id] = option.value + end + end +end+ |
+
Returns id of the TestSuite being run in this session.
+ + + +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69+ |
+
+ # File 'lib/inferno/entities/test_session.rb', line 24 + +class TestSession < Entity + ATTRIBUTES = [ + :id, + :created_at, + :updated_at, + :test_suite_id, + :test_suite, + :test_runs, + :results, + :suite_options + ].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + + self. ||= [] + + test_suite&.&.each do |option| + if .none? { |selected_option| selected_option.id == option.id } + << DSL::SuiteOption.new(id: option.id, value: option..first[:value]) + end + end + end + + def test_suite + @test_suite ||= Repositories::TestSuites.new.find(test_suite_id) + end + + def to_hash + session_hash = (self.class::ATTRIBUTES - [:suite_options]).each_with_object({}) do |attribute, hash| + hash[attribute] = send(attribute) + end + + session_hash[:suite_options] = &.map(&:to_hash) || [] + + session_hash.compact + end + + def + ( || []).each_with_object({}) do |option, hash| + hash[option.id] = option.value + end + end +end+ |
+
Returns update timestamp.
+ + +
+ + + +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69+ |
+
+ # File 'lib/inferno/entities/test_session.rb', line 24 + +class TestSession < Entity + ATTRIBUTES = [ + :id, + :created_at, + :updated_at, + :test_suite_id, + :test_suite, + :test_runs, + :results, + :suite_options + ].freeze + + include Inferno::Entities::Attributes + + def initialize(params) + super(params, ATTRIBUTES) + + self. ||= [] + + test_suite&.&.each do |option| + if .none? { |selected_option| selected_option.id == option.id } + << DSL::SuiteOption.new(id: option.id, value: option..first[:value]) + end + end + end + + def test_suite + @test_suite ||= Repositories::TestSuites.new.find(test_suite_id) + end + + def to_hash + session_hash = (self.class::ATTRIBUTES - [:suite_options]).each_with_object({}) do |attribute, hash| + hash[attribute] = send(attribute) + end + + session_hash[:suite_options] = &.map(&:to_hash) || [] + + session_hash.compact + end + + def + ( || []).each_with_object({}) do |option, hash| + hash[option.id] = option.value + end + end +end+ |
+
+ + + +64 +65 +66 +67 +68+ |
+
+ # File 'lib/inferno/entities/test_session.rb', line 64 + +def + ( || []).each_with_object({}) do |option, hash| + hash[option.id] = option.value + end +end+ |
+
+ + + +54 +55 +56 +57 +58 +59 +60 +61 +62+ |
+
+ # File 'lib/inferno/entities/test_session.rb', line 54 + +def to_hash + session_hash = (self.class::ATTRIBUTES - [:suite_options]).each_with_object({}) do |attribute, hash| + hash[attribute] = send(attribute) + end + + session_hash[:suite_options] = &.map(&:to_hash) || [] + + session_hash.compact +end+ |
+
A TestSuite represents a packaged group of tests, usually for a
+single Implementation Guide
Returns the value of attribute result_message.
+Returns the value of attribute results.
+#parent, #suite_option_requirements
+ + + +Provide a block which will verify any configuration needed for this test suite to operate properly.
+Add a child group.
+Get this suite’s child groups, filtered by suite options, if provided.
+Define an option for this suite.
+The options defined for this suite.
+Set/get a description which for this test suite which will be displayed in the UI.
+Get the TestKit this suite belongs to.
+Set/get the version of this test suite.
+block, description, id, input_instructions, optional, optional?, required, required?, required_suite_options, resume_test_route, route, short_description, short_title, suite_endpoint, title
+ + + + + + + + + + + + + + + +add_link, download_url, ig_url, links, report_issue_url, source_code_url
+ + + + + + + + + +#assert, #assert_resource_type, #assert_response_content_type, #assert_response_status, #assert_valid_bundle_entries, #assert_valid_http_uri, #assert_valid_json, #assert_valid_resource
+ + + + + + + + + +#omit, #omit_if, #pass, #pass_if, #skip, #skip_if, #wait
+ + + + + + + + + +#find_validator, #resource_is_valid?
+ +Returns the value of attribute result_message.
+ + +
+ + + +28 +29 +30+ |
+
+ # File 'lib/inferno/entities/test_suite.rb', line 28 + +def + @result_message +end+ |
+
Returns the value of attribute results.
+ + +
+ + + +28 +29 +30+ |
+
+ # File 'lib/inferno/entities/test_suite.rb', line 28 + +def results + @results +end+ |
+
This method returns an undefined value.
Provide a block which will verify any configuration needed for this +test suite to operate properly.
+ + +
+ + + +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129+ |
+
+ # File 'lib/inferno/entities/test_suite.rb', line 118 + +def check_configuration(&block) + @check_configuration_block = lambda do + block.call&.each do || + case [:type] + when 'warning' + Application[:logger].warn([:message]) + when 'error' + Application[:logger].error([:message]) + end + end + end +end+ |
+
This method returns an undefined value.
Add a child group
+ + +
+ + + +67 +68 +69 +70+ |
+
+ # File 'lib/inferno/entities/test_suite.rb', line 67 + +def group(...) + () + define_child(...) +end+ |
+
Get this suite’s child groups, filtered by suite options, if provided.
+ + +
+ + + +59 +60 +61+ |
+
+ # File 'lib/inferno/entities/test_suite.rb', line 59 + +def groups( = nil) + children().select { |child| child < Inferno::Entities::TestGroup } +end+ |
+
This method returns an undefined value.
Define an option for this suite. Options are used to define suite-wide +configuration which is selected by a user at the start of a test +session. These options can be used to change what tests/groups are run +or behavior within particular tests.
+ + +
+ + + +169 +170 +171+ |
+
+ # File 'lib/inferno/entities/test_suite.rb', line 169 + +def suite_option(identifier, **option_params) + << DSL::SuiteOption.new(option_params.merge(id: identifier)) +end+ |
+
Returns The options defined for +this suite.
+ + +
+ + + +175 +176 +177+ |
+
+ # File 'lib/inferno/entities/test_suite.rb', line 175 + +def + @suite_options ||= [] +end+ |
+
Set/get a description which for this test suite which will be +displayed in the UI.
+ + +
+ + + +185 +186 +187 +188 +189+ |
+
+ # File 'lib/inferno/entities/test_suite.rb', line 185 + +def suite_summary(suite_summary = nil) + return @suite_summary if suite_summary.nil? + + @suite_summary = format_markdown(suite_summary) +end+ |
+
Get the TestKit this suite belongs to
+ + +
+ + + +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208+ |
+
+ # File 'lib/inferno/entities/test_suite.rb', line 194 + +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+ |
+
Set/get the version of this test suite. Defaults to the TestKit +version.
+ + +
+ + + +93 +94 +95 +96 +97+ |
+
+ # File 'lib/inferno/entities/test_suite.rb', line 93 + +def version(version = nil) + @version = version if version.present? + + @version || test_kit&.version +end+ |
+
[ + :id, + :created_at, + :updated_at, + :validator_session_id, + :test_suite_id, + :validator_name, + :suite_options, + :validator_index +].freeze
A new instance of ValidatorSession.
+Returns a new instance of ValidatorSession.
+ + +
+ + + +17 +18 +19+ |
+
+ # File 'lib/inferno/entities/validator_session.rb', line 17 + +def initialize(params) + super(params, ATTRIBUTES) +end+ |
+
+ + + + + Classes: AssertionException, BadSessionDataType, CancelException, DuplicateEntityIdException, ErrorInFhirpathException, ErrorInValidatorException, FhirpathNotFoundException, InvalidRunnableIdException, NotUserRunnableException, OmitException, ParentNotLoadedException, PassException, RequiredInputsNotFound, SkipException, TestResultException, UnknownAttributeException, UnknownSessionDataType, ValidatorNotFoundException, WaitException + + +
+ + + + + + + + + +
+ + + +7 +8 +9+ |
+
+ # File 'lib/inferno/exceptions.rb', line 7 + +def result + 'fail' +end+ |
+
A new instance of BadSessionDataType.
+Returns a new instance of BadSessionDataType.
+ + +
+ + + +112 +113 +114+ |
+
+ # File 'lib/inferno/exceptions.rb', line 112 + +def initialize(name, expected_class_names, actual_class) + super("Expected '#{name}' to be a #{expected_class_names}, but found a #{actual_class.name}.") +end+ |
+
+ + + +37 +38 +39+ |
+
+ # File 'lib/inferno/exceptions.rb', line 37 + +def result + 'cancel' +end+ |
+
A new instance of DuplicateEntityIdException.
+Returns a new instance of DuplicateEntityIdException.
+ + +
+ + + +124 +125 +126+ |
+
+ # File 'lib/inferno/exceptions.rb', line 124 + +def initialize(id) + super("ID '#{id}' already exists. Ensure the uniqueness of the IDs.") +end+ |
+
ErrorInFhirpathException is used when an exception occurred in +calling the FHIRPath service, for example a connection timeout +or an unexpected response format. +Note: This class extends TestResultException instead of RuntimeError +to bypass printing the stack trace in the UI, since +the stack trace of this exception is not likely be useful. +Instead the message should point to where in the fhirpath evaluator an error occurred.
+ + +
+ + + +81 +82 +83+ |
+
+ # File 'lib/inferno/exceptions.rb', line 81 + +def result + 'error' +end+ |
+
ErrorInValidatorException is used when an exception occurred in +calling the validator service, for example a connection timeout +or an unexpected response format. +Note: This class extends TestResultException instead of RuntimeError +to bypass printing the stack trace in the UI, since +the stack trace of this exception is not likely be useful. +Instead the message should point to where in the validator an error occurred.
+ + +
+ + + +50 +51 +52+ |
+
+ # File 'lib/inferno/exceptions.rb', line 50 + +def result + 'error' +end+ |
+
A new instance of FhirpathNotFoundException.
+Returns a new instance of FhirpathNotFoundException.
+ + +
+ + + +68 +69 +70+ |
+
+ # File 'lib/inferno/exceptions.rb', line 68 + +def initialize(fhirpath_name) + super("No '#{fhirpath_name}' FHIRPath evaluator found") +end+ |
+
A new instance of InvalidRunnableIdException.
+Returns a new instance of InvalidRunnableIdException.
+ + +
+ + + +118 +119 +120+ |
+
+ # File 'lib/inferno/exceptions.rb', line 118 + +def initialize(id) + super("ID '#{id}' exceeds the maximum id length of 255 characters") +end+ |
+
A new instance of NotUserRunnableException.
+Returns a new instance of NotUserRunnableException.
+ + +
+ + + +93 +94 +95+ |
+
+ # File 'lib/inferno/exceptions.rb', line 93 + +def initialize + super('The chosen runnable must be run as part of a group') +end+ |
+
+ + + +19 +20 +21+ |
+
+ # File 'lib/inferno/exceptions.rb', line 19 + +def result + 'omit' +end+ |
+
A new instance of ParentNotLoadedException.
+Returns a new instance of ParentNotLoadedException.
+ + +
+ + + +56 +57 +58+ |
+
+ # File 'lib/inferno/exceptions.rb', line 56 + +def initialize(klass, id) + super("No #{klass.name.demodulize} found with id '#{id}'") +end+ |
+
+ + + +25 +26 +27+ |
+
+ # File 'lib/inferno/exceptions.rb', line 25 + +def result + 'pass' +end+ |
+
A new instance of RequiredInputsNotFound.
+Returns a new instance of RequiredInputsNotFound.
+ + +
+ + + +87 +88 +89+ |
+
+ # File 'lib/inferno/exceptions.rb', line 87 + +def initialize(missing_inputs) + super("Missing the following required inputs: #{missing_inputs.join(', ')}") +end+ |
+
+ + + +13 +14 +15+ |
+
+ # File 'lib/inferno/exceptions.rb', line 13 + +def result + 'skip' +end+ |
+
AssertionException, CancelException, ErrorInFhirpathException, ErrorInValidatorException, OmitException, PassException, SkipException, WaitException
+A new instance of UnknownAttributeException.
+Returns a new instance of UnknownAttributeException.
+ + +
+ + + +99 +100 +101 +102+ |
+
+ # File 'lib/inferno/exceptions.rb', line 99 + +def initialize(attributes, klass) + attributes_string = attributes.map { |attribute| "'#{attribute}'" }.join(', ') + super("Unknown attributes for #{klass.name}: #{attributes_string}") +end+ |
+
A new instance of UnknownSessionDataType.
+Returns a new instance of UnknownSessionDataType.
+ + +
+ + + +106 +107 +108+ |
+
+ # File 'lib/inferno/exceptions.rb', line 106 + +def initialize(output) + super("Unknown type '#{output[:type]}' for '#{output[:name]}'.") +end+ |
+
A new instance of ValidatorNotFoundException.
+Returns a new instance of ValidatorNotFoundException.
+ + +
+ + + +62 +63 +64+ |
+
+ # File 'lib/inferno/exceptions.rb', line 62 + +def initialize(validator_name) + super("No '#{validator_name}' validator found") +end+ |
+
+ + + +31 +32 +33+ |
+
+ # File 'lib/inferno/exceptions.rb', line 31 + +def result + 'wait' +end+ |
+
+ + + + + Classes: ExecuteTestRun, InvokeValidatorSession, ResumeTestRun + + +
+ + + + + + + + +
+ + + +9 +10 +11 +12 +13 +14 +15+ |
+
+ # File 'lib/inferno/jobs.rb', line 9 + +def self.perform(job_klass, *params, force_synchronous: false) + if force_synchronous || (Application['async_jobs'] == false) + job_klass.new.perform(*params) + else + job_klass.perform_async(*params) + end +end+ |
+
+ + + +6 +7 +8 +9 +10 +11+ |
+
+ # File 'lib/inferno/jobs/execute_test_run.rb', line 6 + +def perform(test_run_id) + test_run = Inferno::Repositories::TestRuns.new.find(test_run_id) + test_session = Inferno::Repositories::TestSessions.new.find(test_run.test_session_id) + + TestRunner.new(test_session:, test_run:).start +end+ |
+
+ + + +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20+ |
+
+ # File 'lib/inferno/jobs/invoke_validator_session.rb', line 7 + +def perform(suite_id, validator_name, validator_index) + suite = Inferno::Repositories::TestSuites.new.find suite_id + validator = suite.fhir_validators[validator_name.to_sym][validator_index] + response_body = validator.validate(FHIR::Patient.new, 'http://hl7.org/fhir/StructureDefinition/Patient') + res = JSON.parse(response_body) + session_id = res['sessionId'] + session_repo = Inferno::Repositories::ValidatorSessions.new + session_repo.save(test_suite_id: suite_id, validator_session_id: session_id, + validator_name:, suite_options: validator.requirements) + validator.session_id = session_id +rescue JSON::ParserError + Inferno::Application['logger'] + .error("InvokeValidatorSession - error unexpected response format from validator: #{response_body}") +end+ |
+
+ + + +6 +7 +8 +9 +10 +11+ |
+
+ # File 'lib/inferno/jobs/resume_test_run.rb', line 6 + +def perform(test_run_id) + test_run = Inferno::Repositories::TestRuns.new.find(test_run_id) + test_session = Inferno::Repositories::TestSessions.new.find(test_run.test_session_id) + + TestRunner.new(test_session:, test_run:, resume: true).start +end+ |
+
Repositories provide an abstraction layer for dealing with entity +persistence. All code for interacting with the database lives in +repositories. The rest of the codebase interacts with the database through a +public api provided by various repositories.
+ +Naming Convention: A repository should be named the plural version of +the entity name. For example:
+ +TestSessions is the repsitory for the TestSession entityTestGroups is the repository for the TestGroup entity+ + + Modules: ValidateRunnableReference + + + + Classes: Headers, IGs, InMemoryRepository, Messages, Presets, Repository, Requests, Results, SessionData, Tags, TestGroups, TestKits, TestRuns, TestSessions, TestSuites, Tests, ValidatorSessions + + +
+ + + + + + + + + ++ + + + + Classes: Model + + +
+ + + + + + + + + + + + + + +#add_non_db_entities, #build_entity, #create, db, #db_params, #entity_class, #entity_class_name, #find, #handle_non_db_params, #non_db_params, table_name, #update
+ + + +
+ + + +7 +8 +9 +10+ |
+
+ # File 'lib/inferno/repositories/headers.rb', line 7 + +def before_create + self.id = SecureRandom.uuid + super +end+ |
+
+ + + +12 +13 +14 +15+ |
+
+ # File 'lib/inferno/repositories/headers.rb', line 12 + +def validate + super + errors.add(:request_id, 'must be present') if request_id.blank? +end+ |
+
Repository that deals with persistence for the IG entity.
+ + + +28 +29 +30+ |
+
+ # File 'lib/inferno/repositories/in_memory_repository.rb', line 28 + +def all + @all ||= [] +end+ |
+
+ + + +23 +24 +25+ |
+
+ # File 'lib/inferno/repositories/in_memory_repository.rb', line 23 + +def exists?(id) + all_by_id.key?(id.to_s) +end+ |
+
+ + + +19 +20 +21+ |
+
+ # File 'lib/inferno/repositories/in_memory_repository.rb', line 19 + +def find(id) + all_by_id[id.to_s] +end+ |
+
+ + + +11 +12 +13 +14 +15 +16 +17+ |
+
+ # File 'lib/inferno/repositories/in_memory_repository.rb', line 11 + +def insert(entity) + raise Exceptions::DuplicateEntityIdException, entity.id if exists?(entity.id) + + all << entity + all_by_id[entity.id.to_s] = entity + entity +end+ |
+
+ + + + + Classes: Model + + +
+ + + + + + + + +#add_non_db_entities, #build_entity, #create, db, #db_params, #entity_class, #entity_class_name, #find, #handle_non_db_params, #non_db_params, table_name, #update
+ + + +
+ + + +4 +5 +6 +7 +8 +9 +10 +11 +12+ |
+
+ # File 'lib/inferno/repositories/messages.rb', line 4 + +def (result_id) + self.class::Model + .order(:index) + .where(result_id:) + .to_a + .map!(&:to_json_data) + .each(&:deep_symbolize_keys!) + .map! { |result| build_entity(result) } +end+ |
+
+ + + +17 +18 +19 +20+ |
+
+ # File 'lib/inferno/repositories/messages.rb', line 17 + +def before_create + self.id = SecureRandom.uuid + super +end+ |
+
+ + + +22 +23 +24 +25 +26 +27 +28+ |
+
+ # File 'lib/inferno/repositories/messages.rb', line 22 + +def validate + super + types = Entities::Message::TYPES + errors.add(:message, 'must be present') if .blank? + errors.add(:type, 'must be present') if type.blank? + errors.add(:type, "'#{type}' is invalid. Must be one of: #{types.join(', ')}") unless types.include?(type) +end+ |
+
Repository that deals with persistence for the Preset entity.
+ + + +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30+ |
+
+ # File 'lib/inferno/repositories/presets.rb', line 10 + +def insert_from_file(path) + raw_contents = + case path + when /\.json$/ + File.read(path) + when /\.erb$/ + ERB.new(File.read(path)).result + end + + if Application['base_url'].start_with? 'https://inferno-qa.healthit.gov' + raw_contents.gsub!('https://inferno.healthit.gov', 'https://inferno-qa.healthit.gov') + end + + preset_hash = JSON.parse(raw_contents) + + preset_hash.deep_symbolize_keys! + preset_hash[:id] ||= SecureRandom.uuid + preset = Entities::Preset.new(preset_hash) + + insert(preset) +end+ |
+
+ + + +32 +33 +34+ |
+
+ # File 'lib/inferno/repositories/presets.rb', line 32 + +def presets_for_suite(suite_id) + all.select { |preset| preset.test_suite_id.to_s == suite_id.to_s } +end+ |
+
Base class for repositories. Subclass and override methods as +needed.
+ + +Headers, Messages, Requests, Results, SessionData, Tags, TestRuns, TestSessions, ValidatorSessions
+Return the db connection for this repository.
+Return the name of the database table for this repository.
+Creates an instance of the entity associated with this repository.
+Create a new record in the database.
+Return the class of the entity which will be instantiated by a repository.
+Return the name of the entity class which will be instantiated by a repository.
+Find a database record by id, and instantiate an entity from that record.
+Update a record in the database.
+Return the db connection for this repository.
+ + +
+ + + +13 +14 +15+ |
+
+ # File 'lib/inferno/repositories/repository.rb', line 13 + +def self.db + Application['db.connection'][table_name] +end+ |
+
Return the name of the database table for this repository. Override if +the table name is not the snake case version of the name of the +repository class.
+ + +
+ + + +22 +23 +24+ |
+
+ # File 'lib/inferno/repositories/repository.rb', line 22 + +def self.table_name + name.demodulize.underscore.to_sym +end+ |
+
+ + + +57 +58 +59 +60 +61 +62 +63 +64 +65+ |
+
+ # File 'lib/inferno/repositories/repository.rb', line 57 + +def add_non_db_entities(hash) + if hash.include? :test_id + hash[:test] = Tests.new.find(hash[:test_id]) + elsif hash.include? :test_group_id + hash[:test_group] = TestGroups.new.find(hash[:test_group_id]) + elsif hash.include? :test_suite_id + hash[:test_suite] = TestSuites.new.find(hash[:test_suite_id]) + end +end+ |
+
Creates an instance of the entity associated with this repository. +Override if any special logic is required to create the entity.
+ + +
+ + + +101 +102 +103 +104+ |
+
+ # File 'lib/inferno/repositories/repository.rb', line 101 + +def build_entity(params) + add_non_db_entities(params) + entity_class.new(params) +end+ |
+
Create a new record in the database.
+ + +
+ + + +78 +79 +80 +81+ |
+
+ # File 'lib/inferno/repositories/repository.rb', line 78 + +def create(params) + result = self.class::Model.create(db_params(params)) + build_entity(result.to_hash.merge(handle_non_db_params(params))) +end+ |
+
+ + + +106 +107 +108+ |
+
+ # File 'lib/inferno/repositories/repository.rb', line 106 + +def db_params(params) + params.slice(*self.class::Model.columns) +end+ |
+
Return the class of the entity which will be instantiated by a
+repository. Override if the entity class is not in the
+Inferno::Entities namespace.
+ + + +40 +41 +42+ |
+
+ # File 'lib/inferno/repositories/repository.rb', line 40 + +def entity_class + Entities.const_get(entity_class_name) +end+ |
+
Return the name of the entity class which will be instantiated by a +repository. Override if the entity class name is not the singular +version of the repository name.
+ + +
+ + + +31 +32 +33+ |
+
+ # File 'lib/inferno/repositories/repository.rb', line 31 + +def entity_class_name + self.class.name.demodulize.singularize +end+ |
+
Find a database record by id, and instantiate an entity from that +record.
+ + +
+ + + +50 +51 +52 +53 +54 +55+ |
+
+ # File 'lib/inferno/repositories/repository.rb', line 50 + +def find(id) + result = self.class::Model.find(id:) + return result if result.nil? + + build_entity(result.to_hash) +end+ |
+
+ + + +114 +115 +116+ |
+
+ # File 'lib/inferno/repositories/repository.rb', line 114 + +def handle_non_db_params(params) + non_db_params(params) +end+ |
+
+ + + +110 +111 +112+ |
+
+ # File 'lib/inferno/repositories/repository.rb', line 110 + +def non_db_params(params) + params.except(*self.class::Model.columns) +end+ |
+
Update a record in the database.
+ + +
+ + + +90 +91 +92 +93 +94+ |
+
+ # File 'lib/inferno/repositories/repository.rb', line 90 + +def update(entity_id, params = {}) + self.class::Model + .find(id: entity_id) + .update(params.merge(updated_at: Time.now)) +end+ |
+
+ + + + + Classes: Model + + +
+ + + + + + + + +#add_non_db_entities, #build_entity, db, #db_params, #entity_class, #entity_class_name, #handle_non_db_params, #non_db_params, table_name, #update
+ + + +
+ + + +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23+ |
+
+ # File 'lib/inferno/repositories/requests.rb', line 9 + +def create(params) + request = self.class::Model.create(db_params(params)) + + headers = create_headers(request, params) + + params[:tags]&.each do |tag| + request.add_tag(tag) + end + + build_entity( + request.to_hash + .merge(headers:) + .merge(non_db_params(params)) + ) +end+ |
+
+ + + +25 +26 +27 +28 +29 +30 +31 +32 +33 +34+ |
+
+ # File 'lib/inferno/repositories/requests.rb', line 25 + +def create_headers(request, params) + request_headers = (params[:request_headers] || []).map do |header| + request.add_header(header.merge(request_id: request.index, type: 'request')) + end + response_headers = (params[:response_headers] || []).map do |header| + request.add_header(header.merge(request_id: request.index, type: 'response')) + end + + (request_headers + response_headers).map { |header| headers_repo.build_entity(header.to_hash) } +end+ |
+
+ + + +36 +37 +38 +39 +40 +41 +42 +43 +44 +45+ |
+
+ # File 'lib/inferno/repositories/requests.rb', line 36 + +def find(id) + result = + self.class::Model + .where(id:) + .select(*entity_class::SUMMARY_FIELDS) + .to_a + return nil if result.blank? + + build_entity(result.first.to_hash) +end+ |
+
+ + + +47 +48 +49 +50 +51 +52 +53 +54 +55+ |
+
+ # File 'lib/inferno/repositories/requests.rb', line 47 + +def find_full_request(id) + result = + self.class::Model + .find(id:) + .to_json_data() + .deep_symbolize_keys! + + build_entity(result) +end+ |
+
+ + + +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68+ |
+
+ # File 'lib/inferno/repositories/requests.rb', line 57 + +def find_named_request(test_session_id, name) + results = + self.class::Model + .where(test_session_id:, name: name.to_s) + .map { |model| model.to_json_data() } + return nil if results.blank? + + result = results.reduce { |max, current| current['index'] > max['index'] ? current : max } + result.deep_symbolize_keys! + + build_entity(result) +end+ |
+
+ + + +93 +94 +95 +96 +97+ |
+
+ # File 'lib/inferno/repositories/requests.rb', line 93 + +def + { + include: [:headers, :tags] + } +end+ |
+
+ + + +83 +84 +85 +86 +87 +88 +89 +90 +91+ |
+
+ # File 'lib/inferno/repositories/requests.rb', line 83 + +def requests_for_result(result_id) + self.class::Model + .order(:index) + .where(result_id:) + .select(*entity_class::SUMMARY_FIELDS) + .to_a + .map(&:to_hash) + .map! { |result| build_entity(result) } +end+ |
+
+ + + +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81+ |
+
+ # File 'lib/inferno/repositories/requests.rb', line 70 + +def tagged_requests(test_session_id, ) + self.class::Model + .tagged_requests(test_session_id, ) + .to_a + .map! do |request| + build_entity( + request + .to_json_data() + .deep_symbolize_keys! + ) + end +end+ |
+
+ + + +170 +171 +172+ |
+
+ # File 'lib/inferno/repositories/requests.rb', line 170 + +def self.tagged_requests(test_session_id, ) + fetch(tagged_requests_sql, test_session_id:, tags:, tag_count: .length) +end+ |
+
+ + + +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168+ |
+
+ # File 'lib/inferno/repositories/requests.rb', line 132 + +def self.tagged_requests_sql + # Find all the requests for the current session which: + # - match all supplied tags + # - are the from the most recent test run for each runnable + <<~SQL.gsub(/\s+/, ' ').freeze + select final_requests.* + from ( + select uncounted_requests.request_id request_id + from ( + select r.id request_id, t.id tag_id from requests r + inner join requests_tags rt on r."index" = rt.requests_id + inner join tags t on rt.tags_id = t.id + where r.test_session_id = :test_session_id + and r.result_id in ( + SELECT a.id FROM results a + WHERE a.test_session_id = r.test_session_id + AND a.id IN ( + SELECT id + FROM results b + WHERE (b.test_session_id = a.test_session_id AND b.test_id = a.test_id) OR + (b.test_session_id = a.test_session_id AND b.test_group_id = a.test_group_id) OR + (b.test_session_id = a.test_session_id AND b.test_suite_id = a.test_suite_id) + ORDER BY updated_at DESC + LIMIT 1 + ) + ) + and t.name in :tags + group by r.id, t.id + ) as uncounted_requests + group by uncounted_requests.request_id + having count(*) = :tag_count + ) as matched_requests + inner join requests final_requests on final_requests.id = matched_requests.request_id + where final_requests.test_session_id = :test_session_id + order by final_requests."index" + SQL +end+ |
+
+ + + +123 +124 +125 +126 +127 +128 +129 +130+ |
+
+ # File 'lib/inferno/repositories/requests.rb', line 123 + +def add_tag(tag_name) + tag = Tags::Model.find_or_create(name: tag_name) + + Inferno::Application['db.connection'][:requests_tags].insert( + tags_id: tag.id, + requests_id: index + ) +end+ |
+
+ + + +115 +116 +117 +118 +119 +120 +121+ |
+
+ # File 'lib/inferno/repositories/requests.rb', line 115 + +def before_create + self.id = SecureRandom.uuid + time = Time.now + self.created_at ||= time + self.updated_at ||= time + super +end+ |
+
+ + + + + Classes: Model + + +
+ + + + + + + + +Get all of the current results for a test session.
+Get the current results for a list of runnables.
+#add_non_db_entities, db, #db_params, #entity_class, #entity_class_name, #find, #handle_non_db_params, #non_db_params, table_name, #update
+ + + +
+ + + +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67+ |
+
+ # File 'lib/inferno/repositories/results.rb', line 55 + +def build_entity(params) + runnable = + if params[:test_id] + { test: tests_repo.find(params[:test_id]) } + elsif params[:test_group_id] + { test_group: groups_repo.find(params[:test_group_id]) } + elsif params[:test_suite_id] + { test_suite: suites_repo.find(params[:test_suite_id]) } + else + {} + end + entity_class.new(params.merge(runnable)) +end+ |
+
+ + + +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31+ |
+
+ # File 'lib/inferno/repositories/results.rb', line 14 + +def create(params) + = params.delete(:messages) || [] + requests = params.delete(:requests) || [] + super(params).tap do |result| + result_model = self.class::Model.find(id: result.id) + .each { || .create(.merge(result_id: result.id)) } + requests.each do |request| + request_id = + if request.id.present? + request.id + else + requests_repo.create(request.to_hash.merge(result_id: result.id)).id + end + request_model = requests_repo.class::Model.find(id: request_id) + result_model.add_request(request_model) + end + end +end+ |
+
Get all of the current results for a test session
+ + +
+ + + +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123+ |
+
+ # File 'lib/inferno/repositories/results.rb', line 110 + +def current_results_for_test_session(test_session_id) + self.class::Model + .current_results_for_test_session(test_session_id) + .eager(:messages) + .eager(requests: proc { |requests| requests.select(*Entities::Request::SUMMARY_FIELDS) }) + .all + .map! do |result_hash| + build_entity( + result_hash + .to_json_data() + .deep_symbolize_keys! + ) + end +end+ |
+
Get the current results for a list of runnables
+ + +
+ + + +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137+ |
+
+ # File 'lib/inferno/repositories/results.rb', line 126 + +def current_results_for_test_session_and_runnables(test_session_id, runnables) + self.class::Model + .current_results_for_test_session_and_runnables(test_session_id, runnables) + .all + .map! do |result_hash| + build_entity( + result_hash + .to_json_data() + .deep_symbolize_keys! + ) + end +end+ |
+
+ + + +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107+ |
+
+ # File 'lib/inferno/repositories/results.rb', line 94 + +def find_waiting_result(test_run_id:) + result_hash = + Model + .where(test_run_id:, result: 'wait') + .where { test_id !~ nil } + .limit(1) + .to_a + .first + &.to_hash + + return nil if result_hash.nil? + + build_entity(result_hash) +end+ |
+
+ + + +143 +144 +145 +146 +147 +148 +149 +150 +151 +152+ |
+
+ # File 'lib/inferno/repositories/results.rb', line 143 + +def + { + include: { + messages: {}, + requests: { + only: Entities::Request::SUMMARY_FIELDS + } + } + } +end+ |
+
+ + + +69 +70 +71 +72 +73 +74 +75 +76 +77 +78+ |
+
+ # File 'lib/inferno/repositories/results.rb', line 69 + +def result_for_test_run(params) + result_hash = + self.class::Model + .find(params) + &.to_hash + + return nil if result_hash.nil? + + build_entity(result_hash) +end+ |
+
+ + + +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91 +92+ |
+
+ # File 'lib/inferno/repositories/results.rb', line 80 + +def test_run_results_after(test_run_id:, after:) + Model + .where(test_run_id:) + .where { updated_at >= after } + .to_a + .map! do |result_hash| + build_entity( + result_hash + .to_json_data() + .deep_symbolize_keys! + ) + end +end+ |
+
+ + + +139 +140 +141+ |
+
+ # File 'lib/inferno/repositories/results.rb', line 139 + +def update_result(result_id, result, = nil) + update(result_id, result:, result_message:) +end+ |
+
ValidateRunnableReference::REFERENCE_KEYS
+ + + + + + +#check_runnable_reference, #runnable_reference_exists?
+ + +
+ + + +200 +201 +202+ |
+
+ # File 'lib/inferno/repositories/results.rb', line 200 + +def self.current_results_for_test_session(test_session_id) + fetch(current_results_sql, test_session_id:) +end+ |
+
+ + + +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216+ |
+
+ # File 'lib/inferno/repositories/results.rb', line 204 + +def self.current_results_for_test_session_and_runnables(test_session_id, runnables) + test_ids = runnables.select { |runnable| runnable < Entities::Test }.map!(&:id) + test_group_ids = runnables.select { |runnable| runnable < Entities::TestGroup }.map!(&:id) + test_suite_ids = runnables.select { |runnable| runnable < Entities::TestSuite }.map!(&:id) + + fetch( + current_results_sql(with_runnables_filter: true), + test_session_id:, + test_ids:, + test_group_ids:, + test_suite_ids: + ) +end+ |
+
+ + + +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179+ |
+
+ # File 'lib/inferno/repositories/results.rb', line 157 + +def self.current_results_sql(with_runnables_filter: false) + query = <<~SQL.gsub(/\s+/, ' ').freeze + SELECT * FROM results a + WHERE test_session_id = :test_session_id + SQL + runnables_filter = <<~SQL.gsub(/\s+/, ' ').freeze + AND (test_id IN :test_ids OR test_group_id IN :test_group_ids OR test_suite_id IN :test_suite_ids) + SQL + subquery = <<~SQL.gsub(/\s+/, ' ').freeze + AND a.id IN ( + SELECT id + FROM results b + WHERE (b.test_session_id = a.test_session_id AND b.test_id = a.test_id) OR + (b.test_session_id = a.test_session_id AND b.test_group_id = a.test_group_id) OR + (b.test_session_id = a.test_session_id AND b.test_suite_id = a.test_suite_id) + ORDER BY updated_at DESC + LIMIT 1 + ) + SQL + return "#{query} #{runnables_filter} #{subquery}" if with_runnables_filter + + "#{query} #{subquery}" +end+ |
+
+ + + +187 +188 +189 +190 +191 +192 +193+ |
+
+ # File 'lib/inferno/repositories/results.rb', line 187 + +def before_create + self.id = SecureRandom.uuid + time = Time.now + self.created_at ||= time + self.updated_at ||= time + super +end+ |
+
+ + + +195 +196 +197 +198+ |
+
+ # File 'lib/inferno/repositories/results.rb', line 195 + +def validate + super + errors.add(:result, "'#{result}' is not valid") unless Entities::Result::RESULT_OPTIONS.include?(result) +end+ |
+
+ + + + + Classes: Model + + +
+ + + + + + + + +rubocop:disable Metrics/CyclomaticComplexity.
+#add_non_db_entities, #build_entity, #create, db, #db_params, #entity_class, #find, #handle_non_db_params, #non_db_params, table_name, #update
+ + + +
+ + + +56 +57 +58+ |
+
+ # File 'lib/inferno/repositories/session_data.rb', line 56 + +def entity_class_name + 'SessionData' +end+ |
+
+ + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54+ |
+
+ # File 'lib/inferno/repositories/session_data.rb', line 43 + +def get_all_from_session(test_session_id) + self.class::Model + .where(test_session_id:) + .all + .map! do |session_data_hash| + build_entity( + session_data_hash + .to_json_data + .deep_symbolize_keys! + ) + end +end+ |
+
rubocop:disable Metrics/CyclomaticComplexity
+ + +
+ + + +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41+ |
+
+ # File 'lib/inferno/repositories/session_data.rb', line 25 + +def load(test_session_id:, name:, type: 'text') # rubocop:disable Metrics/CyclomaticComplexity + raw_value = + self.class::Model + .find(test_session_id:, name: name.to_s.downcase) + &.value + + case type.to_s + when 'oauth_credentials' + DSL::OAuthCredentials.new(JSON.parse(raw_value || '{}')) + when 'checkbox' + JSON.parse(raw_value || '[]') + when 'auth_info' + DSL::AuthInfo.new(JSON.parse(raw_value || '{}')) + else + raw_value + end +end+ |
+
+ + + +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23+ |
+
+ # File 'lib/inferno/repositories/session_data.rb', line 7 + +def save(params) + name = params[:name].to_s.downcase + test_session_id = params[:test_session_id] + + value = value_to_persist(params) + + db + .insert_conflict( + target: :id, + update: { value: } + ).insert( + id: "#{test_session_id}_#{name}", + name:, + value:, + test_session_id: + ) +end+ |
+
+ + + +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127+ |
+
+ # File 'lib/inferno/repositories/session_data.rb', line 111 + +def serialize_auth_info(params) + auth = + if params[:value].is_a? String + DSL::AuthInfo.new(JSON.parse(params[:value])) + elsif !params[:value].is_a? DSL::AuthInfo + raise Exceptions::BadSessionDataType.new( + params[:name], + DSL::AuthInfo.name, + params[:value].class + ) + else + params[:value] + end + + auth.name = params[:name] + auth.to_s +end+ |
+
+ + + +77 +78 +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89 +90 +91+ |
+
+ # File 'lib/inferno/repositories/session_data.rb', line 77 + +def serialize_checkbox_input(params) + if params[:value].is_a?(String) + params[:value] + elsif params[:value].nil? + '[]' + elsif params[:value].is_a?(Array) + params[:value].to_json + else + raise Exceptions::BadSessionDataType.new( + params[:name], + 'JSON String or Array', + params[:value].class + ) + end +end+ |
+
+ + + +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109+ |
+
+ # File 'lib/inferno/repositories/session_data.rb', line 93 + +def serialize_oauth_credentials_input(params) + credentials = + if params[:value].is_a? String + DSL::OAuthCredentials.new(JSON.parse(params[:value])) + elsif !params[:value].is_a? DSL::OAuthCredentials + raise Exceptions::BadSessionDataType.new( + params[:name], + DSL::OAuthCredentials.name, + params[:value].class + ) + else + params[:value] + end + + credentials.name = params[:name] + credentials.to_s +end+ |
+
+ + + +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75+ |
+
+ # File 'lib/inferno/repositories/session_data.rb', line 60 + +def value_to_persist(params) + return nil if params[:value].blank? + + case params[:type]&.to_s + when 'text', 'textarea', 'radio' + params[:value].to_s + when 'checkbox' + serialize_checkbox_input(params) + when 'oauth_credentials' + serialize_oauth_credentials_input(params) + when 'auth_info' + serialize_auth_info(params) + else + raise Exceptions::UnknownSessionDataType, params + end +end+ |
+
+ + + + + Classes: Model + + +
+ + + + + + + + + + + + + + +#add_non_db_entities, #build_entity, #create, db, #db_params, #entity_class, #entity_class_name, #find, #handle_non_db_params, #non_db_params, table_name, #update
+ + + +
+ + + +11 +12 +13 +14+ |
+
+ # File 'lib/inferno/repositories/tags.rb', line 11 + +def before_create + self.id = SecureRandom.uuid + super +end+ |
+
Repository that deals with persistence for the TestGroup entity.
Repository that deals with persistence for the TestKit entity.
+ + + + + Classes: Model + + +
+ + + + + + + + +#add_non_db_entities, #create, db, #db_params, #entity_class, #entity_class_name, #find, #handle_non_db_params, #non_db_params, table_name, #update
+ + + +
+ + + +127 +128 +129 +130 +131 +132+ |
+
+ # File 'lib/inferno/repositories/test_runs.rb', line 127 + +def active_test_run_for_session?(test_session_id) + self.class::Model + .where(test_session_id:) + .exclude(status: 'done') + .count.positive? +end+ |
+
+ + + +16 +17 +18 +19 +20 +21 +22+ |
+
+ # File 'lib/inferno/repositories/test_runs.rb', line 16 + +def build_entity(params) + super.tap do |test_run| + test_run&.results&.map! do |result| + result.is_a?(Entities::Result) ? result : Entities::Result.new(result) + end + end +end+ |
+
+ + + +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50+ |
+
+ # File 'lib/inferno/repositories/test_runs.rb', line 35 + +def find_latest_waiting_by_identifier(identifier) + test_run_hash = + self.class::Model + .where(status: 'waiting') + .where(identifier:) + .where { wait_timeout >= Time.now } + .order(Sequel.desc(:updated_at)) + .limit(1) + .to_a + &.first + &.to_hash + + return nil if test_run_hash.nil? + + build_entity(test_run_hash) +end+ |
+
+ + + +8 +9 +10 +11 +12 +13 +14+ |
+
+ # File 'lib/inferno/repositories/test_runs.rb', line 8 + +def + { + include: { + results: results_repo. + } + } +end+ |
+
+ + + +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66+ |
+
+ # File 'lib/inferno/repositories/test_runs.rb', line 52 + +def last_test_run(test_session_id) + test_run_hash = + self.class::Model + .where(test_session_id:) + .order(Sequel.desc(:updated_at)) + .limit(1) + .to_a + .map { |record| record.to_json_data.deep_symbolize_keys! } + &.first + &.to_hash + + return nil if test_run_hash.nil? + + build_entity(test_run_hash) +end+ |
+
+ + + +98 +99 +100+ |
+
+ # File 'lib/inferno/repositories/test_runs.rb', line 98 + +def mark_as_cancelling(test_run_id) + update(test_run_id, status: 'cancelling') +end+ |
+
+ + + +76 +77 +78+ |
+
+ # File 'lib/inferno/repositories/test_runs.rb', line 76 + +def mark_as_done(test_run_id) + update(test_run_id, status: 'done') +end+ |
+
+ + + +89 +90 +91 +92 +93 +94 +95 +96+ |
+
+ # File 'lib/inferno/repositories/test_runs.rb', line 89 + +def mark_as_no_longer_waiting(test_run_id) + update( + test_run_id, + status: 'queued', + identifier: nil, + wait_timeout: nil + ) +end+ |
+
+ + + +72 +73 +74+ |
+
+ # File 'lib/inferno/repositories/test_runs.rb', line 72 + +def mark_as_running(test_run_id) + update(test_run_id, status: 'running') +end+ |
+
+ + + +80 +81 +82 +83 +84 +85 +86 +87+ |
+
+ # File 'lib/inferno/repositories/test_runs.rb', line 80 + +def mark_as_waiting(test_run_id, identifier, timeout) + update( + test_run_id, + status: 'waiting', + identifier:, + wait_timeout: Time.now + timeout.seconds + ) +end+ |
+
+ + + +24 +25 +26 +27 +28 +29 +30 +31 +32 +33+ |
+
+ # File 'lib/inferno/repositories/test_runs.rb', line 24 + +def results_for_test_run(test_run_id) + test_run_hash = + self.class::Model + .find(id: test_run_id) + .to_json_data() + .deep_symbolize_keys! + + test_run_hash[:results] + .map! { |result| results_repo.build_entity(result) } +end+ |
+
+ + + +68 +69 +70+ |
+
+ # File 'lib/inferno/repositories/test_runs.rb', line 68 + +def status_for_test_run(id) + self.class::Model.where(id:).get(:status) +end+ |
+
ValidateRunnableReference::REFERENCE_KEYS
+ + + + + + +#check_runnable_reference, #runnable_reference_exists?
+ + +
+ + + +118 +119 +120 +121 +122 +123 +124+ |
+
+ # File 'lib/inferno/repositories/test_runs.rb', line 118 + +def before_create + self.id = SecureRandom.uuid + time = Time.now + self.created_at ||= time + self.updated_at ||= time + super +end+ |
+
+ + + +111 +112 +113 +114 +115 +116+ |
+
+ # File 'lib/inferno/repositories/test_runs.rb', line 111 + +def validate + super + if status.present? && !Entities::TestRun::STATUS_OPTIONS.include?(status) # rubocop:disable Style/GuardClause + errors.add(:status, "'#{status}' is not valid") + end +end+ |
+
Repository that deals with persistence for the TestSession entity.
+ + + + + Classes: Model + + +
+ + + + + + + + +#add_non_db_entities, db, #db_params, #entity_class, #entity_class_name, #find, #handle_non_db_params, #non_db_params, table_name, #update
+ + + +
+ + + +47 +48 +49 +50 +51 +52+ |
+
+ # File 'lib/inferno/repositories/test_sessions.rb', line 47 + +def apply_preset(test_session, preset_id) + preset = presets_repo.find(preset_id) + Utils::PresetProcessor.new(preset, test_session).processed_inputs.each do |input| + session_data_repo.save(input.merge(test_session_id: test_session.id)) + end +end+ |
+
+ + + +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64+ |
+
+ # File 'lib/inferno/repositories/test_sessions.rb', line 54 + +def build_entity(params) + = JSON.parse(params[:suite_options] || '[]').map do |suite_option_hash| + suite_option_hash.deep_symbolize_keys! + suite_option_hash[:id] = suite_option_hash[:id].to_sym + DSL::SuiteOption.new(suite_option_hash) + end + + final_params = params.merge(suite_options:) + add_non_db_entities(final_params) + entity_class.new(final_params) +end+ |
+
+ + + +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34+ |
+
+ # File 'lib/inferno/repositories/test_sessions.rb', line 24 + +def create(params) + = params[:suite_options] + = + if .blank? + '[]' + else + JSON.generate(.map(&:to_hash)) + end + + super(params.merge(suite_options:)) +end+ |
+
+ + + +15 +16 +17 +18 +19 +20 +21 +22+ |
+
+ # File 'lib/inferno/repositories/test_sessions.rb', line 15 + +def + { + include: { + results: results_repo., + test_runs: {} + } + } +end+ |
+
+ + + +36 +37 +38 +39 +40 +41 +42 +43 +44 +45+ |
+
+ # File 'lib/inferno/repositories/test_sessions.rb', line 36 + +def results_for_test_session(test_session_id) + test_session_hash = + self.class::Model + .find(id: test_session_id) + .to_json_data() + .deep_symbolize_keys! + + test_session_hash[:results] + .map! { |result| results_repo.build_entity(result) } +end+ |
+
+ + + +75 +76 +77 +78 +79 +80 +81+ |
+
+ # File 'lib/inferno/repositories/test_sessions.rb', line 75 + +def before_create + self.id = Base62.encode(SecureRandom.random_number(2**64)) + time = Time.now + self.created_at ||= time + self.updated_at ||= time + super +end+ |
+
+ + + +83 +84 +85 +86 +87 +88 +89+ |
+
+ # File 'lib/inferno/repositories/test_sessions.rb', line 83 + +def validate + super + errors.add(:test_suite_id, 'cannot be empty') if test_suite_id.blank? + unless test_suites_repo.exists? test_suite_id # rubocop:disable Style/GuardClause + errors.add(:test_suite_id, "'#{test_suite_id}' is not valid") + end +end+ |
+
Repository that deals with persistence for the TestSuite entity.
Repository that deals with persistence for the Test entity.
[:test_id, :test_group_id, :test_suite_id].freeze
+ + + +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25+ |
+
+ # File 'lib/inferno/repositories/validate_runnable_reference.rb', line 12 + +def check_runnable_reference + present_keys = REFERENCE_KEYS.select { |reference_key| send(reference_key) } + + if present_keys.length == 1 + runnable_type = present_keys.first + id = values[runnable_type] + reference_exists = runnable_reference_exists?(runnable_type, id) + return if reference_exists + + { key: runnable_type, message: "of #{id} does not exist" } + else + { key: :base, message: "must contain exactly one of 'test_id', 'test_group_id', or 'test_suite_id'" } + end +end+ |
+
+ + + +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39+ |
+
+ # File 'lib/inferno/repositories/validate_runnable_reference.rb', line 27 + +def runnable_reference_exists?(type, id) + repo = + case type + when :test_id + Inferno::Repositories::Tests.new + when :test_group_id + Inferno::Repositories::TestGroups.new + when :test_suite_id + Inferno::Repositories::TestSuites.new + end + + repo.exists? id +end+ |
+
+ + + +6 +7 +8 +9 +10+ |
+
+ # File 'lib/inferno/repositories/validate_runnable_reference.rb', line 6 + +def validate + super + = check_runnable_reference + errors.add([:key], [:message]) if +end+ |
+
+ + + + + Classes: Model + + +
+ + + + + + + + +#add_non_db_entities, #build_entity, #create, db, #db_params, #entity_class, #entity_class_name, #find, #handle_non_db_params, #non_db_params, table_name, #update
+ + + +
+ + + +39 +40 +41 +42 +43 +44 +45 +46 +47 +48+ |
+
+ # File 'lib/inferno/repositories/validator_sessions.rb', line 39 + +def find_validator_session_id(test_suite_id, validator_name, ) + = .nil? ? '[]' : .sort.to_s + session = self.class::Model + .find(test_suite_id:, validator_name:, suite_options:) + return nil if session.nil? + + time = Time.now + session.update(last_accessed: time) + session[:validator_session_id] +end+ |
+
+ + + +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37+ |
+
+ # File 'lib/inferno/repositories/validator_sessions.rb', line 7 + +def save(params) + validator_session_id = params[:validator_session_id] + validator_name = params[:validator_name] + test_suite_id = params[:test_suite_id] + = params[:suite_options] + time = Time.now + + = + if .blank? + '[]' + else + .sort.to_s + end + + db.insert_conflict( + target: [:test_suite_id, + :suite_options, + :validator_name], + update: { validator_session_id:, + test_suite_id:, + suite_options:, + validator_name: } + ).insert( + id: SecureRandom.uuid, + validator_session_id:, + test_suite_id:, + validator_name:, + suite_options:, + last_accessed: time + ) +end+ |
+
+ + + +51 +52 +53 +54+ |
+
+ # File 'lib/inferno/repositories/validator_sessions.rb', line 51 + +def before_save + time = Time.now + self.last_accessed ||= time +end+ |
+
+ This module is part of a private API. + You should avoid using this module if possible, as it may be removed or be changed in the future. +
+This module provides constants so that unit tests in suite repositories can +load the factories defined in inferno.
+ + ++ This constant is part of a private API. + You should avoid using this constant if possible, as it may be removed or be changed in the future. +
+ + + +File.('../../spec/support/factory_bot', __dir__).freeze
+ This constant is part of a private API. + You should avoid using this constant if possible, as it may be removed or be changed in the future. +
+ + + +File.('../../spec/factories', __dir__).freeze
+ This constant is part of a private API. + You should avoid using this constant if possible, as it may be removed or be changed in the future. +
+ + + +File.('../../spec/request_helper', __dir__).freeze
+ This constant is part of a private API. + You should avoid using this constant if possible, as it may be removed or be changed in the future. +
+ + + +File.('../../spec/runnable_helper', __dir__).freeze
+ This method is part of a private API. + You should avoid using this method if possible, as it may be removed or be changed in the future. +
+ + + +
+ + + +11 +12 +13 +14 +15+ |
+
+ # File 'lib/inferno/spec_support.rb', line 11 + +def self.require_helpers + require FACTORY_BOT_SUPPORT_PATH + require RUNNABLE_HELPER_PATH + require REQUEST_HELPER_PATH +end+ |
+
+ + + Modules: IgDownloader, NamedThorActions + + + + Classes: Migration, PresetProcessor, PresetTemplateGenerator + + +
+ + + + + + + + + +/^[a-z][a-zA-Z0-9-]*\.([a-z][a-zA-Z0-9-]*\.?)*/%r{^https?://[^/?#]+[^?#]*}%r{^file://(.+)}%r{[^/]*\.x?html?$}
+ + + +13 +14 +15+ |
+
+ # File 'lib/inferno/utils/ig_downloader.rb', line 13 + +def ig_file(suffix = nil) + File.join(ig_path, suffix ? "package_#{suffix}.tgz" : 'package.tgz') +end+ |
+
+ + + +48 +49 +50 +51 +52 +53 +54+ |
+
+ # File 'lib/inferno/utils/ig_downloader.rb', line 48 + +def ig_http_url(ig_page_url) + return ig_page_url if ig_page_url.end_with? 'package.tgz' + + return "#{ig_page_url}package.tgz" if ig_page_url.end_with? '/' + + ig_page_url.gsub(HTTP_URI_END_REG_EX, 'package.tgz') +end+ |
+
+ + + +9 +10 +11+ |
+
+ # File 'lib/inferno/utils/ig_downloader.rb', line 9 + +def ig_path + File.join('lib', library_name, 'igs') +end+ |
+
+ + + +37 +38 +39 +40 +41 +42 +43 +44 +45 +46+ |
+
+ # File 'lib/inferno/utils/ig_downloader.rb', line 37 + +def ig_registry_url(ig_npm_style) + unless ig_npm_style.include? '@' + raise StandardError, <<~NO_VERSION + No IG version specified for #{ig_npm_style}; you must specify one with '@'. I.e: hl7.fhir.us.core@6.1.0 + NO_VERSION + end + + package_name, version = ig_npm_style.split('@') + "https://packages.fhir.org/#{package_name}/-/#{package_name}-#{version}.tgz" +end+ |
+
+ + + +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35+ |
+
+ # File 'lib/inferno/utils/ig_downloader.rb', line 17 + +def load_ig(ig_input, idx = nil, thor_config = { verbose: true }, output_path = nil) + case ig_input + when FHIR_PACKAGE_NAME_REG_EX + uri = ig_registry_url(ig_input) + when HTTP_URI_REG_EX + uri = ig_http_url(ig_input) + when FILE_URI_REG_EX + uri = ig_input[7..] + else + raise StandardError, <<~FAILED_TO_LOAD + Could not find implementation guide: #{ig_input} + FAILED_TO_LOAD + end + + destination = output_path || ig_file(idx) + # use Thor's get to support CLI options config + get(uri, destination, thor_config) + uri +end+ |
+
+ + + +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14+ |
+
+ # File 'lib/inferno/utils/migration.rb', line 4 + +def run + db = Inferno::Application['db.connection'] + migration_path = File.join(Inferno::Application.root, 'lib', 'inferno', 'db', 'migrations') + Sequel::Migrator.run(db, migration_path) + + if ENV['APP_ENV'] == 'development' # rubocop:disable Style/GuardClause + schema_path = File.join(Inferno::Application.root, 'lib', 'inferno', 'db', 'schema.rb') + db.extension :schema_dumper + File.open(schema_path, 'w') { |f| f.print(db.dump_schema_migration) } + end +end+ |
+
Dry::Inflector.new
+ + + +20 +21 +22+ |
+
+ # File 'lib/inferno/utils/named_thor_actions.rb', line 20 + +def human_name + INFLECTOR.humanize(INFLECTOR.underscore(name)) +end+ |
+
+ + + +12 +13 +14+ |
+
+ # File 'lib/inferno/utils/named_thor_actions.rb', line 12 + +def library_name + INFLECTOR.underscore(name) +end+ |
+
+ + + +16 +17 +18+ |
+
+ # File 'lib/inferno/utils/named_thor_actions.rb', line 16 + +def module_name + INFLECTOR.camelize(name) +end+ |
+
+ + + +8 +9 +10+ |
+
+ # File 'lib/inferno/utils/named_thor_actions.rb', line 8 + +def root_name + INFLECTOR.dasherize(INFLECTOR.underscore(name)) +end+ |
+
+ + + +28 +29 +30+ |
+
+ # File 'lib/inferno/utils/named_thor_actions.rb', line 28 + +def test_kit_id + library_name.delete_suffix('_test_kit') +end+ |
+
+ + + +32 +33 +34+ |
+
+ # File 'lib/inferno/utils/named_thor_actions.rb', line 32 + +def test_suite_id + test_kit_id +end+ |
+
+ + + +24 +25 +26+ |
+
+ # File 'lib/inferno/utils/named_thor_actions.rb', line 24 + +def title_name + human_name.split.map(&:capitalize).join(' ') +end+ |
+
+ This class is part of a private API. + You should avoid using this class if possible, as it may be removed or be changed in the future. +
+This class determines which values to use in a preset based on the suite +options chosen in a session.
+ + +A new instance of PresetProcessor.
+Returns the list of inputs which need to be persisted, with options applied.
++ This method is part of a private API. + You should avoid using this method if possible, as it may be removed or be changed in the future. +
+Returns a new instance of PresetProcessor.
+ + +
+ + + +9 +10 +11 +12 +13 +14 +15+ |
+
+ # File 'lib/inferno/utils/preset_processor.rb', line 9 + +def initialize(preset, session) + self.preset = preset + self.session = session + self.suite = session.test_suite + self.suite_inputs = suite.available_inputs.transform_values(&:to_hash) + self. = session. +end+ |
+
+ This method is part of a private API. + You should avoid using this method if possible, as it may be removed or be changed in the future. +
+ + + +
+ + + +7 +8 +9+ |
+
+ # File 'lib/inferno/utils/preset_processor.rb', line 7 + +def preset + @preset +end+ |
+
+ This method is part of a private API. + You should avoid using this method if possible, as it may be removed or be changed in the future. +
+ + + +
+ + + +7 +8 +9+ |
+
+ # File 'lib/inferno/utils/preset_processor.rb', line 7 + +def session + @session +end+ |
+
+ This method is part of a private API. + You should avoid using this method if possible, as it may be removed or be changed in the future. +
+ + + +
+ + + +7 +8 +9+ |
+
+ # File 'lib/inferno/utils/preset_processor.rb', line 7 + +def suite + @suite +end+ |
+
+ This method is part of a private API. + You should avoid using this method if possible, as it may be removed or be changed in the future. +
+ + + +
+ + + +7 +8 +9+ |
+
+ # File 'lib/inferno/utils/preset_processor.rb', line 7 + +def suite_inputs + @suite_inputs +end+ |
+
+ This method is part of a private API. + You should avoid using this method if possible, as it may be removed or be changed in the future. +
+ + + +
+ + + +7 +8 +9+ |
+
+ # File 'lib/inferno/utils/preset_processor.rb', line 7 + +def + @suite_options +end+ |
+
+ This method is part of a private API. + You should avoid using this method if possible, as it may be removed or be changed in the future. +
+Returns the list of inputs which need to be persisted, with options +applied.
+ + +
+ + + +19 +20 +21 +22 +23+ |
+
+ # File 'lib/inferno/utils/preset_processor.rb', line 19 + +def processed_inputs + preset.inputs + .map { |input| (input) } + .compact +end+ |
+
Returns the value of attribute runnable.
+A new instance of PresetTemplateGenerator.
+Returns a new instance of PresetTemplateGenerator.
+ + +
+ + + +6 +7 +8+ |
+
+ # File 'lib/inferno/utils/preset_template_generator.rb', line 6 + +def initialize(runnable) + self.runnable = runnable +end+ |
+
Returns the value of attribute runnable.
+ + +
+ + + +4 +5 +6+ |
+
+ # File 'lib/inferno/utils/preset_template_generator.rb', line 4 + +def runnable + @runnable +end+ |
+
+ + + +10 +11 +12+ |
+
+ # File 'lib/inferno/utils/preset_template_generator.rb', line 10 + +def available_inputs + @available_inputs ||= runnable.available_inputs.transform_values(&:to_hash) +end+ |
+
+ + + +34 +35 +36 +37 +38+ |
+
+ # File 'lib/inferno/utils/preset_template_generator.rb', line 34 + +def generate + .merge( + inputs: + ) +end+ |
+
+ + + +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25+ |
+
+ # File 'lib/inferno/utils/preset_template_generator.rb', line 14 + +def inputs + # The rubocop rule is disabled because `each_value` returns the hash, + # while `values.each` will return the array of values. We want the array + # of values here. + available_inputs.values.map do |original_input| + {}.tap do |input| + input[:name] = original_input.delete(:name) + input[:value] = (original_input.delete(:default) if original_input.key? :default) + original_input.each { |key, value| input[:"_#{key}"] = value } + end + end +end+ |
+
+ + + +27 +28 +29 +30 +31 +32+ |
+
+ # File 'lib/inferno/utils/preset_template_generator.rb', line 27 + +def + { + title: "Preset for #{runnable.title}", + id: nil + }.merge(runnable.reference_hash) +end+ |
+
+ + + Modules: Controllers, Serializers + + + + +
+ + +rubocop:disable Naming/ConstantName
+ + +if base_path.present? + Hanami::Router.new do + scope("#{base_path}/") do + get '/', to: ->(_env) { [200, { 'Content-Type' => 'text/html' }, [client_page]] } + end + scope(base_path, &route_block) + end +else + Hanami::Router.new(&route_block) +end
+ + + +10 +11 +12 +13 +14 +15+ |
+
+ # File 'lib/inferno/apps/web/application.rb', line 10 + +def self.app + Rack::Builder.new do + use Hanami::Middleware::BodyParser, :json + run Inferno::Web::Router + end +end+ |
+
+ + + Modules: Requests, TestRuns, TestSessions, TestSuites + + + + Classes: Controller, TestSessionFormPostController + + +
+ + + + + + + + + +Requests::Show, TestRuns::Create, TestRuns::Destroy, TestRuns::Results::Index, TestRuns::Show, TestSessions::ClientShow, TestSessions::Create, TestSessions::LastTestRun, TestSessions::Results::Index, TestSessions::SessionData::ApplyPreset, TestSessions::SessionData::Index, TestSessions::Show, TestSuites::CheckConfiguration, TestSuites::Index, TestSuites::Show
+
+ + + +7 +8 +9+ |
+
+ # File 'lib/inferno/apps/web/controllers/controller.rb', line 7 + +def self.call(...) + new.call(...) +end+ |
+
+ + + +30 +31 +32+ |
+
+ # File 'lib/inferno/apps/web/controllers/controller.rb', line 30 + +def self.resource_class + name.split('::')[-2].singularize +end+ |
+
+ + + +26 +27 +28+ |
+
+ # File 'lib/inferno/apps/web/controllers/controller.rb', line 26 + +def self.resource_name + name.split('::')[-2].underscore +end+ |
+
+ + + + + Classes: Show + + +
+ + + + + + + + + +call, resource_class, resource_name
+ + + +
+ + + +6 +7 +8 +9 +10 +11+ |
+
+ # File 'lib/inferno/apps/web/controllers/requests/show.rb', line 6 + +def handle(req, res) + request = repo.find_full_request(req.params[:id]) + halt 404 if request.nil? + + res.body = serialize(request, view: :full) +end+ |
+
+ + + Modules: Results + + + + Classes: Create, Destroy, Show + + +
+ + + + + + + + + +[:test_session_id, :test_suite_id, :test_group_id, :test_id].freeze
call, resource_class, resource_name
+ + + +
+ + + +50 +51 +52+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_runs/create.rb', line 50 + +def create_params(params) + params.to_h.slice(*PARAMS) +end+ |
+
+ + + +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_runs/create.rb', line 20 + +def handle(req, res) + test_session = test_sessions_repo.find(req.params[:test_session_id]) + + # if testsession.nil? + if test_runs_repo.active_test_run_for_session?(test_session.id) + halt 409, { error: 'Cannot run new test while another test run is in progress' }.to_json + end + + verify_runnable( + repo.build_entity(create_params(req.params)).runnable, + req.params[:inputs], + test_session. + ) + + test_run = repo.create(create_params(req.params).merge(status: 'queued')) + + res.body = serialize(test_run, suite_options: test_session.) + + persist_inputs(session_data_repo, req.params, test_run) + + Jobs.perform(Jobs::ExecuteTestRun, test_run.id) +rescue Sequel::ValidationFailed, Sequel::ForeignKeyConstraintViolation, + Inferno::Exceptions::RequiredInputsNotFound, + Inferno::Exceptions::NotUserRunnableException => e + halt 422, { errors: e. }.to_json +rescue StandardError => e + Application['logger'].error(e.) + halt 500, { errors: e. }.to_json +end+ |
+
call, resource_class, resource_name
+ + + +
+ + + +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_runs/destroy.rb', line 11 + +def handle(req, res) + test_run = test_runs_repo.find(req.params[:id]) + + if test_run.nil? || ['done', 'cancelling'].include?(test_run.status) + # If it doesn't exist, already finished, or currently being cancelled + halt 204 + end + + test_run_is_waiting = (test_run.status == 'waiting') + test_runs_repo.mark_as_cancelling(req.params[:id]) + + if test_run_is_waiting + waiting_result = results_repo.find_waiting_result(test_run_id: test_run.id) + results_repo.update_result(waiting_result.id, 'cancel', 'Test cancelled by user') + Jobs.perform(Jobs::ResumeTestRun, test_run.id) + end + + res.status = 204 +rescue StandardError => e + Application['logger'].error(e.) + halt 500, { errors: e. }.to_json +end+ |
+
+ + + + + Classes: Index + + +
+ + + + + + + + + +call, resource_class, resource_name
+ + + +
+ + + +9 +10 +11 +12+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_runs/results/index.rb', line 9 + +def handle(req, res) + results = test_runs_repo.results_for_test_run(req.params[:id]) + res.body = serialize(results) +end+ |
+
call, resource_class, resource_name
+ + + +
+ + + +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_runs/show.rb', line 10 + +def handle(req, res) + test_run = repo.find(req.params[:id]) + halt 404 if test_run.nil? + + if req.params[:include_results] == 'true' + results_repo = Inferno::Repositories::Results.new + test_run.results = + if req.params[:after].present? + results_repo.test_run_results_after(test_run_id: test_run.id, after: Time.parse(req.params[:after])) + else + repo.results_for_test_run(test_run.id) + end + end + + test_session = test_sessions_repo.find(test_run.test_session_id) + res.body = serialize(test_run, suite_options: test_session.) +end+ |
+
+ + + +5 +6 +7+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_session_form_post_controller.rb', line 5 + +def self.call(...) + new.call(...) +end+ |
+
+ + + +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_session_form_post_controller.rb', line 9 + +def handle(req, res) + test_suite_id = req.params[:test_suite_id] + + test_suite = Inferno::Repositories::TestSuites.new.find(test_suite_id) + halt 404, "Unable to find test suite with id #{test_suite_id}" if test_suite.nil? + + params = { test_suite_id: } + suite_option_keys = test_suite..map(&:id) + = req.params.to_h.slice(*suite_option_keys) + + params[:suite_options] = .map { |key, value| { id: key, value: } } if .present? + + repo = Inferno::Repositories::TestSessions.new + session = repo.create(params) + + preset_id = req.params[:preset_id] + + if preset_id.present? + preset = Inferno::Repositories::Presets.new.find(preset_id) + + halt 422, "Unable to find preset with id #{preset_id} for test suite #{test_suite_id}" if preset.nil? + + repo.apply_preset(session, preset_id) + end + + res.redirect_to "#{Inferno::Application['base_url']}/#{test_suite_id}/#{session.id}" +end+ |
+
+ + + Modules: Results, SessionData + + + + Classes: ClientShow, Create, LastTestRun, Show + + +
+ + + + + + + + + +ERB.new( + File.read( + File.join( + Inferno::Application.root, 'lib', 'inferno', 'apps', 'web', 'index.html.erb' + ) + ) +).result.freeze
call, resource_class, resource_name
+ + + +
+ + + +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_sessions/client_show.rb', line 15 + +def handle(req, res) + test_session_id = req.params[:id] + test_suite_id = req.params[:test_suite_id] + + test_session = repo.find(test_session_id) + halt 404 if test_session.nil? + + if test_suite_id.blank? || test_suite_id != test_session.test_suite_id + test_suite_id = test_session.test_suite_id + + res.redirect_to "#{Inferno::Application['base_url']}/#{test_suite_id}/#{test_session_id}" + end + + test_suite = Inferno::Repositories::TestSuites.new.find(test_suite_id) + + halt 404 if test_suite.nil? + + res.format = :html + res.body = CLIENT_PAGE +end+ |
+
[:test_suite_id, :suite_options].freeze
call, resource_class, resource_name
+ + + +
+ + + +27 +28 +29+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_sessions/create.rb', line 27 + +def create_params(params) + params.slice(*PARAMS) +end+ |
+
+ + + +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_sessions/create.rb', line 11 + +def handle(req, res) + params = req.params.to_h + params.merge!(JSON.parse(req.body.string).symbolize_keys) unless req.body.string.blank? + + session = repo.create(create_params(params)) + + repo.apply_preset(session, params[:preset_id]) if params[:preset_id].present? + + res.body = serialize(session) +rescue Sequel::ValidationFailed, Sequel::ForeignKeyConstraintViolation => e + halt 422, { errors: e. }.to_json +rescue StandardError => e + Application['logger'].error(e.) + halt 500, { errors: e. }.to_json +end+ |
+
call, resource_class, resource_name
+ + + +
+ + + +8 +9 +10 +11 +12 +13 +14 +15 +16 +17+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_sessions/last_test_run.rb', line 8 + +def handle(req, res) + test_run = test_runs_repo.last_test_run(req.params[:id]) + + res.body = + if test_run.nil? + nil + else + Inferno::Web::Serializers::TestRun.render(test_run) + end +end+ |
+
+ + + + + Classes: Index + + +
+ + + + + + + + + +call, resource_class, resource_name
+ + + +
+ + + +9 +10 +11 +12 +13 +14 +15 +16+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_sessions/results/index.rb', line 9 + +def handle(req, res) + res.body = + if req.params[:all] == 'true' + serialize(test_sessions_repo.results_for_test_session(req.params[:id])) + else + serialize(repo.current_results_for_test_session(req.params[:id])) + end +end+ |
+
+ + + + + Classes: ApplyPreset, Index + + +
+ + + + + + + + + +
+ + + +14 +15 +16+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_sessions/session_data/apply_preset.rb', line 14 + +def self.resource_class + 'SessionData' +end+ |
+
+ + + +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_sessions/session_data/apply_preset.rb', line 18 + +def handle(req, res) + test_session_id = req.params[:id] + test_session = test_sessions_repo.find(test_session_id) + + if test_session.nil? + Application[:logger].error("Unknown test session #{test_session_id}") + halt 404 + end + + preset_id = req.params[:preset_id] + preset = presets_repo.find(preset_id) + + if preset.nil? + Application[:logger].error("Unknown preset #{preset_id}") + halt 404 + end + + test_sessions_repo.apply_preset(test_session, preset_id) + res.status = 200 +end+ |
+
+ + + +11 +12 +13+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_sessions/session_data/index.rb', line 11 + +def self.resource_class + 'SessionData' +end+ |
+
+ + + +15 +16 +17+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_sessions/session_data/index.rb', line 15 + +def handle(req, res) + res.body = serialize(session_data_repo.get_all_from_session(req.params[:id])) +end+ |
+
call, resource_class, resource_name
+ + + +
+ + + +6 +7 +8 +9 +10 +11+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_sessions/show.rb', line 6 + +def handle(req, res) + test_session = repo.find(req.params[:id]) + halt 404 if test_session.nil? + + res.body = serialize(test_session) +end+ |
+
+ + + + + Classes: CheckConfiguration, Index, Show + + +
+ + + + + + + + + +call, resource_class, resource_name
+ + + +
+ + + +6 +7 +8 +9 +10 +11 +12+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_suites/check_configuration.rb', line 6 + +def handle(req, res) + test_suite = repo.find(req.params[:id]) + halt 404 if test_suite.nil? + + res.body = + Inferno::Web::Serializers::Message.render(test_suite.(force_recheck: true)) +end+ |
+
call, resource_class, resource_name
+ + + +
+ + + +6 +7 +8+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_suites/index.rb', line 6 + +def handle(_req, res) + res.body = serialize(repo.all, view: :summary) +end+ |
+
call, resource_class, resource_name
+ + + +
+ + + +6 +7 +8 +9 +10 +11+ |
+
+ # File 'lib/inferno/apps/web/controllers/test_suites/show.rb', line 6 + +def handle(req, res) + test_suite = repo.find(req.params[:id]) + halt 404 if test_suite.nil? + + res.body = serialize(test_suite, view: :full) +end+ |
+
+ + + + + Classes: HashValueExtractor, Header, Input, MarkdownExtractor, Message, Preset, Request, Result, Serializer, SessionData, SuiteOption, Test, TestGroup, TestRun, TestSession, TestSuite + + +
+ + + + + + + + + +
+ + + +5 +6 +7+ |
+
+ # File 'lib/inferno/apps/web/serializers/hash_value_extractor.rb', line 5 + +def extract(field_name, object, , ) + object.send(field_name).values +end+ |
+
+ + + +10 +11 +12+ |
+
+ # File 'lib/inferno/apps/web/serializers/markdown_extractor.rb', line 10 + +def extract(field_name, object, , = {}) + format_markdown(object.send(field_name)) +end+ |
+
Header, Input, Message, Preset, Request, Result, SessionData, SuiteOption, Test, TestGroup, TestRun, TestSession, TestSuite
+
+ + + +8 +9 +10 +11 +12 +13 +14 +15+ |
+
+ # File 'lib/inferno/apps/web/serializers/serializer.rb', line 8 + +def self.field_present?(field_name, result, ) + name = [:name] || field_name + if result.respond_to?(:[]) + result[name].present? + else + result.send(name).present? + end +end+ |
+
Extension to FHIR::Model. Prepending this into FHIR::Model (done below) +allows us to call super() on initialize when we overriding it, +while also defining new methods and attributes
+ + +Returns the value of attribute source_hash.
+Returns the value of attribute source_text.
+Returns the value of attribute source_hash.
+ + +
+ + + +7 +8 +9+ |
+
+ # File 'lib/inferno/ext/fhir_models.rb', line 7 + +def source_hash + @source_hash +end+ |
+
Returns the value of attribute source_text.
+ + +
+ + + +7 +8 +9+ |
+
+ # File 'lib/inferno/ext/fhir_models.rb', line 7 + +def source_text + @source_text +end+ |
+
+ + + +9 +10 +11 +12+ |
+
+ # File 'lib/inferno/ext/fhir_models.rb', line 9 + +def initialize(hash = {}) + super + @source_hash = hash +end+ |
+
+ + + +14 +15 +16+ |
+
+ # File 'lib/inferno/ext/fhir_models.rb', line 14 + +def source_contents + @source_text || JSON.generate(@source_hash) +end+ |
+
Extension to FHIR::Json. Prepending this into FHIR::Json (done below) +allows us to call super() on from_json
+ + +
+ + + +28 +29 +30 +31 +32+ |
+
+ # File 'lib/inferno/ext/fhir_models.rb', line 28 + +def from_json(json) + resource = super + resource&.source_text = json + resource +end+ |
+
Extension to FHIR::Xml. Prepending this into FHIR::Xml (done below) +allows us to call super() on from_xml
+ + +
+ + + +38 +39 +40 +41 +42+ |
+
+ # File 'lib/inferno/ext/fhir_models.rb', line 38 + +def from_xml(xml) + resource = super + resource&.source_text = xml + resource +end+ |
+
Patch based on https://github.com/rack/rack/pull/1881 +This should be removed when/if this functionality makes its way into a rack +release (possible rack 3.1.0)
+ + ++ + + + + Classes: Request + + +
+ + + + + + + + + ++ + + + + Classes: Headers + + +
+ + + + + + + + +A new instance of Headers.
+Returns a new instance of Headers.
+ + +
+ + + +11 +12 +13+ |
+
+ # File 'lib/inferno/ext/rack.rb', line 11 + +def initialize(env) + @env = env +end+ |
+
+ + + +15 +16 +17+ |
+
+ # File 'lib/inferno/ext/rack.rb', line 15 + +def [](k) + @env[header_to_env_key(k)] +end+ |
+
+ + + +19 +20 +21+ |
+
+ # File 'lib/inferno/ext/rack.rb', line 19 + +def []=(k, v) + @env[header_to_env_key(k)] = v +end+ |
+
+ + + +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33+ |
+
+ # File 'lib/inferno/ext/rack.rb', line 23 + +def add(k, v) + k = header_to_env_key(k) + case existing = @env[k] + when nil + @env[k] = v + when String + @env[k] = [existing, v] + when Array + existing << v + end +end+ |
+
+ + + +35 +36 +37+ |
+
+ # File 'lib/inferno/ext/rack.rb', line 35 + +def delete(k) + @env.delete(header_to_env_key(k)) +end+ |
+
+ + + +39 +40 +41 +42 +43 +44 +45 +46+ |
+
+ # File 'lib/inferno/ext/rack.rb', line 39 + +def each + return to_enum(:each) unless block_given? + + @env.each do |k, v| + next unless k = env_to_header_key(k) + yield k, v + end +end+ |
+
+ + + +48 +49 +50+ |
+
+ # File 'lib/inferno/ext/rack.rb', line 48 + +def fetch(k, &block) + @env.fetch(header_to_env_key(k), &block) +end+ |
+
+ + + +52 +53 +54+ |
+
+ # File 'lib/inferno/ext/rack.rb', line 52 + +def has_key?(k) + @env.has_key?(header_to_env_key(k)) +end+ |
+
+ + + +56 +57 +58 +59 +60+ |
+
+ # File 'lib/inferno/ext/rack.rb', line 56 + +def to_h + h = {} + each{|k, v| h[k] = v} + h +end+ |
+
+
+
+
|
+
+
+
|
+
+
+
|
+
| t |
