smart_app_launch_test_kit 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21424366eca8716c4cc57feb07c162f7165c8075d4b086e9df170612d877822a
-  data.tar.gz: d2f9cdf39968fe9fc9ef55e4dd22ea149efd49d2037ef3287b71a62ed280cebc
+  metadata.gz: d447427f008c3e0b93992b96bd18039b5c8819c1ac017820c33c6e755ce9b2e8
+  data.tar.gz: de45b6b42de7a104fd051fa80a91ecfd580650643ba4179ecd7655e81c6b3d34
 SHA512:
-  metadata.gz: 549de4e5b1ba8ffb722bea7c836a4cb2b76448468c6a23aacce51f6308ba79a4ca0376337d28d5a9c291bab8b6a5cb3161500fcce6cde726564ee2ba91d6219f
-  data.tar.gz: feb62ad828bed3008a14dcb731a93dec19720aba821eda08ebda4777813bb197282c3c9a9fe50d9981a392381ea0e9114da1c6dcf0cfe7abb7cb29c8ab34d802
+  metadata.gz: 1718dffebfcb4d79b3967a137781a8f9e85c60e55a9f2921faf1c5b3d3bb81c5887d778ade46d3492a121b039748e8317af102a0612bec080a82145f061efac6
+  data.tar.gz: 5bd03aa14bb3912820a1ca7d25c944644d4995e250f7b6c74aed826effa6236827ce326d121652d73816a48f70c48dea65b03fa18d889eb2712f5049b7bc2c7a

data/execution_scripts/README.md

@@ -0,0 +1,16 @@
+# Using Core Execution Scripts
+
+This directory contains [execution scripts](https://inferno-framework.github.io/docs/advanced-test-features/scripting-execution.html)
+that demonstrate and validate the behavior of suites defined
+by this test kit in the context of running Inferno services
+allowing for end-to-end executions that check for expected suite execution
+results when using Inferno services like the FHIR Validator and FHIR Path
+Service as well as dependency services that Inferno does not control such
+as `tx.fhir.org`.
+
+Execution scripts defined here will
+be [executed](https://inferno-framework.github.io/docs/advanced-test-features/scripting-execution.html#execution)
+automatically on pull requests as a part of the github
+workflows and can also be executed locally using the
+[`execute_script` CLI](https://inferno-framework.github.io/docs/getting-started/inferno-cli.html#complex-scripted-execution)
+on individual scripts or the `execute_scripts:run_all` rake task.

data/execution_scripts/client_vs_server/access_data_and_continue_client.rb

@@ -0,0 +1,37 @@
+begin
+  require 'selenium-webdriver'
+rescue LoadError
+  warn 'selenium-webdriver is required to run this command script.'
+  warn "Add it to your Gemfile: gem 'selenium-webdriver'"
+  exit(1)
+end
+require 'faraday'
+require 'json'
+
+session_id = ARGV[0]
+target_suite = ARGV[1]
+continuation_url = ARGV[2]
+patient_id = ARGV[3]
+inferno_host = ARGV[4]
+
+inputs_cli_command = "bundle exec inferno session data #{session_id}#{" -I #{inferno_host}" unless inferno_host.nil?}"
+inputs = JSON.parse(`#{inputs_cli_command}`)
+token = inputs.find { |input| input['name'] == 'bearer_token' }&.dig('value')
+raise StandardError, 'could not find access token to revoke' if token.nil? || token == ''
+
+suite_base_url = continuation_url.split(target_suite).first
+read_url = "#{suite_base_url}#{target_suite}/fhir/Patient/#{patient_id}"
+
+Faraday.get(read_url, nil, :Authorization => "Bearer #{token}")
+options = Selenium::WebDriver::Options.chrome(args: ['--headless=new'])
+driver = Selenium::WebDriver.for(:chrome, options: options)
+wait = Selenium::WebDriver::Wait.new(timeout: 10)
+driver.get continuation_url
+wait.until { driver.find_element(:xpath, '//title') }
+driver.quit
+exit(0)
+
+
+
+
+

data/execution_scripts/client_vs_server/smart_v22_backend_services_with_commands.yaml

@@ -0,0 +1,69 @@
+sessions:
+  - suite: smart_client_stu2_2
+    name: client
+    preset: smart_run_client_against_server_v2_2
+    suite_options:
+      SMART Client Type: SMART Backend Services Confidential Asymmetric Client
+  - suite: smart_stu2_2
+    name: server
+    preset: smart_run_server_against_ca_client_v2_2
+
+comparison_config:
+  normalized_strings:
+    - replacement: <INFERNO_HOST>
+      patterns:
+        - http://localhost:4567/inferno # local inferno core ruby
+        - http://localhost:4567 # local ruby
+        - http://localhost # local docker
+        - https://inferno.healthit.gov/suites # prod
+        - https://inferno-qa.healthit.gov/suites # qa
+    - replacement: <REFERENCE_SERVER_URL>
+      patterns:
+        - https://inferno.healthit.gov/reference-server # prod reference server
+        - https://inferno-qa.healthit.gov/reference-server # qa reference server
+    - replacement: code_challenge=<CODE_CHALLENGE>
+      pattern: /code_challenge=[A-Za-z0-9+\/=_-]{43}/
+    - replacement: <UUID>
+      pattern: /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/i
+  sessions:
+    server:
+      alternate_expected_files:           
+        - file: smart_v22_backend_services_with_commands_server_no_tls_expected.json
+          when:
+            - field: inputs.url
+              matches: ^http://
+
+steps:
+  - state_description: Session Created
+    session: client
+    status: created
+    start_run:
+      session: client
+      runnable: suite
+    action_description: Run the client suite
+
+  - state_description: Wait at Client test 5.04 Access a secured FHIR endpoint using SMART Backend Services
+    session: client
+    status: waiting
+    last_completed: 5.04
+    start_run:
+      session: server
+      runnable: 3
+    next_poll_session: server
+    action_description: Run server group 3 Backend Services
+    
+  - state_description: Finished server group 3 Backend Services
+    session: server
+    status: done
+    last_completed: 3
+    command: bundle exec ruby execution_scripts/client_vs_server/access_data_and_continue_client.rb {session_id} smart_client_stu2_2 '{client.wait_outputs.continuation_url}' example {inferno_base_url}
+    next_poll_session: client
+    action_description: Perform access and tell the client tests the access was performed
+
+  - state_description: Finished Client Suite
+    session: client
+    status: done
+    last_completed: suite
+    action: END_SCRIPT
+    action_description: Finished Script
+    

data/execution_scripts/client_vs_server/smart_v22_backend_services_with_commands_client_expected.json

@@ -0,0 +1 @@
+[{"id":"0b88aedc-40d9-430a-b0e0-d2fe1873cc03","created_at":"2026-04-03T12:23:06.734-04:00","inputs":[{"name":"client_id","value":"smart_client_test_demo","type":"text"},{"name":"smart_jwk_set","value":"http://localhost:4567/custom/smart_stu2_2/.well-known/jwks.json","type":"textarea"}],"optional":false,"outputs":[],"requests":[],"result":"pass","test_id":"smart_client_stu2_2-smart_client_registration_bsca-smart_client_registration_bsca_verification","test_run_id":"b0c3b58f-115c-4dc1-a526-0f94bcfd5575","test_session_id":"4UK5MliAu7N","updated_at":"2026-04-03T12:23:06.734-04:00"},{"id":"1507b727-47a8-4109-b172-864c8586f4f4","created_at":"2026-04-03T12:23:06.740-04:00","inputs":[{"name":"client_id","value":"smart_client_test_demo","type":"text"},{"name":"fhir_read_resources_bundle","value":"{\n  \"resourceType\": \"Bundle\",\n  \"entry\": [\n    {\n      \"resource\": {\n        \"resourceType\": \"Patient\",\n        \"id\": \"example\",\n        \"name\": [\n          {\n            \"family\": \"Chalmers\",\n            \"given\": [\n              \"Peter\",\n              \"James\"\n            ]\n          }\n        ],\n        \"gender\": \"male\",\n        \"birthDate\": \"1974-12-25\",\n        \"address\": [\n          {\n            \"line\": [\n              \"534 Erewhon St\"\n            ],\n            \"city\": \"Ann Arbor\",\n            \"state\": \"MI\",\n            \"postalCode\": \"48108\"\n          }\n        ]\n      }\n    }\n  ]\n}","type":"textarea"},{"name":"echoed_fhir_response","value":null,"type":"textarea"}],"optional":false,"outputs":[{"name":"continuation_url","type":"text","value":"http://localhost:4567/custom/smart_client_stu2_2/resume_pass?token=smart_client_test_demo"}],"requests":[],"result":"pass","test_id":"smart_client_stu2_2-smart_client_access-smart_client_access_bsca_interaction","test_run_id":"b0c3b58f-115c-4dc1-a526-0f94bcfd5575","test_session_id":"4UK5MliAu7N","updated_at":"2026-04-03T12:23:16.988-04:00"},{"id":"59f85e35-b76e-42e0-9c2d-80146a3224cb","created_at":"2026-04-03T12:23:17.008-04:00","inputs":[{"name":"client_id","label":"Client Id","description":"Testers may provide a specific value for Inferno to assign as the client id. If no value is provided, the Inferno session id will be used.","value":"smart_client_test_demo","type":"text"},{"name":"smart_jwk_set","label":"SMART Confidential Asymmetric JSON Web Key Set (JWKS)","description":"The SMART client's JSON Web Key Set including the key(s) Inferno will need to verify signatures on token requests made by the client. May be provided as either a publicly accessible url containing the JWKS, or the raw JWKS JSON.","value":"http://localhost:4567/custom/smart_stu2_2/.well-known/jwks.json","type":"textarea"}],"optional":false,"outputs":[],"requests":[],"result":"pass","test_group_id":"smart_client_stu2_2-smart_client_registration_bsca","test_run_id":"b0c3b58f-115c-4dc1-a526-0f94bcfd5575","test_session_id":"4UK5MliAu7N","updated_at":"2026-04-03T12:23:17.008-04:00"},{"id":"bc761706-8711-4d95-b9b3-bd87db5ad58f","created_at":"2026-04-03T12:23:17.031-04:00","inputs":[{"name":"client_id","value":"smart_client_test_demo","type":"text"},{"name":"smart_jwk_set","value":"http://localhost:4567/custom/smart_stu2_2/.well-known/jwks.json","type":"textarea"}],"messages":[{"message":"Confidential asymmetric token request 1 had an incorrect `client_assertion_type`: expected 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer', but got 'not_an_assertion_type'","type":"error"},{"message":"Confidential asymmetric token request 2 had an incorrect `client_assertion_type`: expected 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer', but got 'not_an_assertion_type'","type":"error"}],"optional":false,"outputs":[{"name":"smart_tokens","type":"text","value":"eyJjbGllbnRfaWQiOiJzbWFydF9jbGllbnRfdGVzdF9kZW1vIiwiZXhwaXJhdGlvbiI6MTc3NTIzNjk4OSwibm9uY2UiOiJkMjc3MjIzMjE5M2ZhNmVhIn0\neyJjbGllbnRfaWQiOiJzbWFydF9jbGllbnRfdGVzdF9kZW1vIiwiZXhwaXJhdGlvbiI6MTc3NTIzNjk4OSwibm9uY2UiOiJjZWQ0NDI5OWU1OWMxMjExIn0\neyJjbGllbnRfaWQiOiJzbWFydF9jbGllbnRfdGVzdF9kZW1vIiwiZXhwaXJhdGlvbiI6MTc3NTIzNjk4OSwibm9uY2UiOiI4ZmZiYzc4OGRjODZkMjAxIn0"}],"requests":[{"id":"12bd00ab-6bfc-46f2-a83e-93d1c308d672","direction":"incoming","index":839,"result_id":"1507b727-47a8-4109-b172-864c8586f4f4","status":200,"timestamp":"2026-04-03T12:23:09.885-04:00","url":"http://localhost:4567/custom/smart_client_stu2_2/auth/token","verb":"POST"},{"id":"926ba6ac-3a3a-4080-bdfa-24b4346332c0","direction":"incoming","index":840,"result_id":"1507b727-47a8-4109-b172-864c8586f4f4","status":200,"timestamp":"2026-04-03T12:23:09.920-04:00","url":"http://localhost:4567/custom/smart_client_stu2_2/auth/token","verb":"POST"},{"id":"cd358d10-549f-4c0e-a6f5-9a565b8267d2","direction":"incoming","index":842,"result_id":"1507b727-47a8-4109-b172-864c8586f4f4","status":200,"timestamp":"2026-04-03T12:23:09.944-04:00","url":"http://localhost:4567/custom/smart_client_stu2_2/auth/token","verb":"POST"}],"result":"fail","result_message":"Invalid token requests received. See messages for details.","test_id":"smart_client_stu2_2-smart_client_access-smart_client_token_request_bsca_verification","test_run_id":"b0c3b58f-115c-4dc1-a526-0f94bcfd5575","test_session_id":"4UK5MliAu7N","updated_at":"2026-04-03T12:23:17.031-04:00"},{"id":"0460df72-7dcf-4d89-8147-b8006ea8d466","created_at":"2026-04-03T12:23:17.037-04:00","inputs":[{"name":"smart_tokens","value":"eyJjbGllbnRfaWQiOiJzbWFydF9jbGllbnRfdGVzdF9kZW1vIiwiZXhwaXJhdGlvbiI6MTc3NTIzNjk4OSwibm9uY2UiOiJkMjc3MjIzMjE5M2ZhNmVhIn0\neyJjbGllbnRfaWQiOiJzbWFydF9jbGllbnRfdGVzdF9kZW1vIiwiZXhwaXJhdGlvbiI6MTc3NTIzNjk4OSwibm9uY2UiOiJjZWQ0NDI5OWU1OWMxMjExIn0\neyJjbGllbnRfaWQiOiJzbWFydF9jbGllbnRfdGVzdF9kZW1vIiwiZXhwaXJhdGlvbiI6MTc3NTIzNjk4OSwibm9uY2UiOiI4ZmZiYzc4OGRjODZkMjAxIn0","type":"text"}],"optional":false,"outputs":[],"requests":[{"id":"ad7961cc-bba0-462c-abc6-229fb5e845e4","direction":"incoming","index":844,"result_id":"1507b727-47a8-4109-b172-864c8586f4f4","status":200,"timestamp":"2026-04-03T12:23:15.531-04:00","url":"http://localhost:4567/custom/smart_client_stu2_2/fhir/Patient/example","verb":"GET"}],"result":"pass","test_id":"smart_client_stu2_2-smart_client_access-smart_client_token_use_verification","test_run_id":"b0c3b58f-115c-4dc1-a526-0f94bcfd5575","test_session_id":"4UK5MliAu7N","updated_at":"2026-04-03T12:23:17.037-04:00"},{"id":"8be4315c-8415-4797-9f31-76f19192f369","created_at":"2026-04-03T12:23:17.038-04:00","inputs":[{"name":"client_id","label":"Client Id","description":"The registered Client Id for use in obtaining access tokens. Create a new session and re-run the Client Registration group if you need to change this value.","value":"smart_client_test_demo","type":"text"},{"name":"smart_launch_urls","label":"SMART App Launch URL(s)","description":"Registered Launch URLs in the form of a comma-separated list of zero or more URLs. If present, Inferno will provide an option to use each to launch the app. Create a new session and re-run the Client Registration group if you need to change this value.","value":"http://localhost:4567/custom/smart_stu2_2/launch","type":"textarea"},{"name":"launch_context","label":"Launch Context","description":"Launch context details to be included in access token responses, specified as a JSON array. If provided, the contents will be merged into Inferno's token responses.","value":"{ \"patient\": \"example\" }","type":"textarea"},{"name":"fhir_user_relative_reference","label":"FHIR User Relative Reference","description":"A FHIR relative reference (\u003cresource type\u003e/\u003cid\u003e) for the FHIR user record to return when the openid and fhirUser scopes are requested. Include this resource in the **Available Resources** input so that it can be accessed via FHIR read.","value":"Patient/example","type":"text"},{"name":"fhir_read_resources_bundle","label":"Available Resources","description":"Resources to make available in Inferno's simulated FHIR server provided as a FHIR bundle. Each entry must contain a resource with the id element populated. Each instance present will be available for retrieval from Inferno at the endpoint: \u003cfhir-base\u003e/\u003cresource type\u003e/\u003cinstance id\u003e. These will only be available through the read interaction.","value":"{\n  \"resourceType\": \"Bundle\",\n  \"entry\": [\n    {\n      \"resource\": {\n        \"resourceType\": \"Patient\",\n        \"id\": \"example\",\n        \"name\": [\n          {\n            \"family\": \"Chalmers\",\n            \"given\": [\n              \"Peter\",\n              \"James\"\n            ]\n          }\n        ],\n        \"gender\": \"male\",\n        \"birthDate\": \"1974-12-25\",\n        \"address\": [\n          {\n            \"line\": [\n              \"534 Erewhon St\"\n            ],\n            \"city\": \"Ann Arbor\",\n            \"state\": \"MI\",\n            \"postalCode\": \"48108\"\n          }\n        ]\n      }\n    }\n  ]\n}","type":"textarea"},{"name":"echoed_fhir_response","label":"Default FHIR Response","description":"JSON representation of a default FHIR resource for Inferno to echo when a request is made to the simulated FHIR server. Reads targetting resources in the **Available Resources** input will return that resource instead of this. Otherwise, the content here will be echoed back exactly and no check will be made that it is appropriate for the request made. If nothing is provided, an OperationOutcome indicating nothing to echo will be returned.","value":null,"type":"textarea"},{"name":"smart_redirect_uris","label":"SMART App Launch Redirect URI(s)","description":"Registered Redirect URIs in the form of a comma-separated list of one or more URIs. Redirect URIs specified in authorization requests must come from this list. Create a new session and re-run the Client Registration group if you need to change this value.","value":"http://localhost:4567/custom/smart_stu2_2/redirect","type":"textarea"},{"name":"smart_jwk_set","label":"JSON Web Key Set (JWKS)","description":"The SMART client's JSON Web Key Set in the form of either a publicly accessible url containing the JWKS, or the raw JWKS JSON. Must include the key(s) Inferno will need to verify signatures on token requests made by the client. Create a new session and re-run the Client Registration group if you need to change this value.","value":"http://localhost:4567/custom/smart_stu2_2/.well-known/jwks.json","type":"textarea"},{"name":"smart_client_secret","label":"SMART Confidential Symmetric Client Secret","description":"The registered client secret that will be provided during token requests to authenticate the client to Inferno. Create a new session and re-run the Client Registration group if you need to change this value.","value":"SAMPLE_SECRET","type":"text"}],"optional":false,"outputs":[],"requests":[],"result":"fail","test_group_id":"smart_client_stu2_2-smart_client_access","test_run_id":"b0c3b58f-115c-4dc1-a526-0f94bcfd5575","test_session_id":"4UK5MliAu7N","updated_at":"2026-04-03T12:23:17.038-04:00"},{"id":"14527436-499a-4383-b37e-a49c39ae6b42","created_at":"2026-04-03T12:23:17.041-04:00","inputs":[{"name":"client_id","label":"Client Id","description":"Testers may provide a specific value for Inferno to assign as the client id. If no value is provided, the Inferno session id will be used.","value":"smart_client_test_demo","type":"text"},{"name":"smart_launch_urls","label":"SMART App Launch URL(s)","description":"If the client app supports EHR launch, a comma-delimited list of one or more URLs that Inferno can use to launch the app.","value":"http://localhost:4567/custom/smart_stu2_2/launch","type":"textarea"},{"name":"smart_redirect_uris","label":"SMART App Launch Redirect URI(s)","description":"A comma-separated list of one or more URIs that the app will sepcify as the target of the redirect for Inferno to use when providing the authorization code.","value":"http://localhost:4567/custom/smart_stu2_2/redirect","type":"textarea"},{"name":"smart_jwk_set","label":"SMART Confidential Asymmetric JSON Web Key Set (JWKS)","description":"The SMART client's JSON Web Key Set including the key(s) Inferno will need to verify signatures on token requests made by the client. May be provided as either a publicly accessible url containing the JWKS, or the raw JWKS JSON.","value":"http://localhost:4567/custom/smart_stu2_2/.well-known/jwks.json","type":"textarea"},{"name":"smart_client_secret","label":"SMART Confidential Symmetric Client Secret","description":"Provide the client secret that the confidential symmetric client will send with token requests to authenticate the client to Inferno.","value":"SAMPLE_SECRET","type":"text"},{"name":"launch_context","label":"Launch Context","description":"Launch context details to be included in access token responses, specified as a JSON array. If provided, the contents will be merged into Inferno's token responses.","value":"{ \"patient\": \"example\" }","type":"textarea"},{"name":"fhir_user_relative_reference","label":"FHIR User Relative Reference","description":"A FHIR relative reference (\u003cresource type\u003e/\u003cid\u003e) for the FHIR user record to return when the openid and fhirUser scopes are requested. Include this resource in the **Available Resources** input so that it can be accessed via FHIR read.","value":"Patient/example","type":"text"},{"name":"fhir_read_resources_bundle","label":"Available Resources","description":"Resources to make available in Inferno's simulated FHIR server provided as a FHIR bundle. Each entry must contain a resource with the id element populated. Each instance present will be available for retrieval from Inferno at the endpoint: \u003cfhir-base\u003e/\u003cresource type\u003e/\u003cinstance id\u003e. These will only be available through the read interaction.","value":"{\n  \"resourceType\": \"Bundle\",\n  \"entry\": [\n    {\n      \"resource\": {\n        \"resourceType\": \"Patient\",\n        \"id\": \"example\",\n        \"name\": [\n          {\n            \"family\": \"Chalmers\",\n            \"given\": [\n              \"Peter\",\n              \"James\"\n            ]\n          }\n        ],\n        \"gender\": \"male\",\n        \"birthDate\": \"1974-12-25\",\n        \"address\": [\n          {\n            \"line\": [\n              \"534 Erewhon St\"\n            ],\n            \"city\": \"Ann Arbor\",\n            \"state\": \"MI\",\n            \"postalCode\": \"48108\"\n          }\n        ]\n      }\n    }\n  ]\n}","type":"textarea"},{"name":"echoed_fhir_response","label":"Default FHIR Response","description":"JSON representation of a default FHIR resource for Inferno to echo when a request is made to the simulated FHIR server. Reads targetting resources in the **Available Resources** input will return that resource instead of this. Otherwise, the content here will be echoed back exactly and no check will be made that it is appropriate for the request made. If nothing is provided, an OperationOutcome indicating nothing to echo will be returned.","value":null,"type":"textarea"}],"optional":false,"outputs":[],"requests":[],"result":"fail","test_run_id":"b0c3b58f-115c-4dc1-a526-0f94bcfd5575","test_session_id":"4UK5MliAu7N","test_suite_id":"smart_client_stu2_2","updated_at":"2026-04-03T12:23:17.041-04:00"}]