subscriptions_test_kit 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33ac6bc935b44cb7bc9e03e4d8d5c3fecb0626f72afe303a2fbda58c59c89bf9
-  data.tar.gz: 99a87dfe4745fdb7f658ed01e133f63b392d2341db636c1f65a1289c1e9fa2f6
+  metadata.gz: 9b0d106312b06065683c721f242cdf245652dd5b14278a933c68ebbd85d10cca
+  data.tar.gz: 20d796f12f6c84e6f332a0b9bc990d8674077a17b927cab550d4913d1e79963d
 SHA512:
-  metadata.gz: 6d38fca0fc6b0714be01b3f33273dbd6df9dd5001dc294d0a602bd93ebafd02fa3dd0166f1e7f35e624f3f3627e7a720f00eb33bc84631b0115eb1bfde89b120
-  data.tar.gz: 58a359a599bb089ce6bdae13f6a343d489138f482b65f0348fcb5bbdb71be7eba5ec1d913914351a979bbfd001c9d20dca86ddfd2dfbb16f2a59c6c27501ea4b
+  metadata.gz: 29543919ba760e5227ac5a72b27467e9b3d3f23b475d39d7c99d4e96a13467edbacefa1f5f1754f12251c25758e4109996e3cca4d703f921d7f0aed36537abc2
+  data.tar.gz: 9b2dbbb0563af958aca05c08c3e1894c61343b3ed9a5b0dd6f86cf087f36a44a4bc3385f75d41a8577acaf0ba59db377f09ab5cdffd70d1d5775bb36132e3c95

data/lib/subscriptions_test_kit/common/notification_conformance_verification.rb

@@ -305,5 +305,41 @@ module SubscriptionsTestKit
 
       verify_id_only_notification_bundle_entries(bundle_entries)
     end
+
+    def notification_header_verification(request_headers, subscription)
+      mime_type = subscription&.dig('channel', 'payload')
+      # Verification for hl7.fhir.uv.subscriptions_1.1.0@26
+      if mime_type.present?
+        content_type_header = request_headers.find { |header| header.name.downcase == 'content-type' }
+        handle_content_type_header_errors(mime_type, content_type_header)
+      end
+      # Verification for hl7.fhir.uv.subscriptions_1.1.0@27
+      subscription.dig('channel', 'header').each do |requested_header|
+        handle_sent_header_errors(request_headers, requested_header)
+      end
+    end
+
+    def handle_content_type_header_errors(mime_type, content_type_header)
+      if content_type_header.blank?
+        add_message('error', "Content type header not sent, subscription requested #{mime_type}\n")
+      elsif !content_type_header.value.start_with?(mime_type)
+        add_message('error',
+                    'Content type of request does not match the Subscription MIME type. ' \
+                    "Expected #{mime_type}, received #{content_type_header.value}")
+      end
+    end
+
+    def handle_sent_header_errors(request_headers, requested_header)
+      requested_name = requested_header.partition(': ').first.downcase
+      requested_value = requested_header.partition(': ').last
+      sent_header = request_headers.find { |header| header.name.downcase == requested_name }
+      if sent_header.blank?
+        add_message('error', "Requested header not sent: #{requested_header}\n")
+      elsif sent_header.value != requested_value
+        add_message('error',
+                    "Requested value for header #{requested_name} does not match the request sent. " \
+                    "Expected #{requested_value}, received #{sent_header.value}")
+      end
+    end
   end
 end

data/lib/subscriptions_test_kit/metadata.rb

@@ -3,9 +3,9 @@ require_relative 'version'
 module SubscriptionsTestKit
   class Metadata < Inferno::TestKit
     id :subscriptions_test_kit
-    title 'Subscription Test Kit'
+    title 'Subscriptions Test Kit'
     description <<~DESCRIPTION
-      The Subscriptions Test Suite verifies the conformance of systems to the FHIR Subscriptions
+      The Subscriptions Test Kit verifies the conformance of systems to the FHIR Subscriptions
       framework as specified in the [HL7® FHIR® R5 version](https://www.hl7.org/fhir/R5/subscriptions.html)
       and above. For systems using the R4 and R4B releases of FHIR, it verifies Subscription
       functionality against the [Subscriptions R5 Backport

data/lib/subscriptions_test_kit/requirements/generated/subscriptions-test-kit_requirements_coverage.csv

@@ -25,8 +25,8 @@ hl7.fhir.uv.subscriptions_1.1.0,22,https://hl7.org/fhir/uv/subscriptions-backpor
 hl7.fhir.uv.subscriptions_1.1.0,23,https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/channels.html#rest-hook-1,"To receive notifications via HTTP/S POST, a client should request a subscription with the channel type of rest-hook and set the endpoint to the appropriate client URL.",SHALL,Client,,,1.1.01,subscriptions_r5_backport_r4_client-subscriptions_r4_client_workflow-Group01-subscriptions_r4_client_interaction,NA,NA
 hl7.fhir.uv.subscriptions_1.1.0,24,https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/channels.html#rest-hook-1,This URL [for the subscription notification endpoint] must be accessible by the hosting server.,SHALL,Client,,,1.2.02,subscriptions_r5_backport_r4_client-subscriptions_r4_client_workflow-subscriptions_r4_client_interaction_verification-subscriptions_r4_client_event_notification_verification,NA,NA
 hl7.fhir.uv.subscriptions_1.1.0,25,https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/channels.html#rest-hook-1,"To convey an event notification, the server POSTs a Bundle to the client’s nominated endpoint URL",SHALL,Server,,,NA,NA,"1.1.03, 3.1.1.03, 3.2.1.03, 3.3.1.03, 4.01","subscriptions_r5_backport_r4_server-subscriptions_r4_server_workflow-subscriptions_r4_server_interaction-subscriptions_r4_server_creation_response_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_empty_content-subscriptions_r4_server_empty_content_interaction-subscriptions_r4_server_creation_response_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_id_only_content-subscriptions_r4_server_id_only_content_interaction-subscriptions_r4_server_creation_response_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_full_resource_content-subscriptions_r4_server_full_resource_content_interaction-subscriptions_r4_server_creation_response_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_handshake_heartbeat-subscriptions_r4_server_handshake_conformance"
-hl7.fhir.uv.subscriptions_1.1.0,26,https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/channels.html#rest-hook-1,The content-type of the POST SHALL match the MIME type on the Subscription (Subscription.channel.payload).,SHALL,Server,,,NA,NA,,
-hl7.fhir.uv.subscriptions_1.1.0,27,https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/channels.html#rest-hook-1,Each Subscription.channel.header value SHALL be conveyed as an HTTP request header.,SHALL,Server,,,NA,NA,,
+hl7.fhir.uv.subscriptions_1.1.0,26,https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/channels.html#rest-hook-1,The content-type of the POST SHALL match the MIME type on the Subscription (Subscription.channel.payload).,SHALL,Server,,,NA,NA,"1.2.02, 3.1.2.02, 3.2.2.02, 3.3.2.02","subscriptions_r5_backport_r4_server-subscriptions_r4_server_workflow-subscriptions_r4_server_interaction_verification-subscriptions_r4_server_notification_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_empty_content-subscriptions_r4_server_empty_content_interaction_verification-subscriptions_r4_server_notification_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_id_only_content-subscriptions_r4_server_id_only_content_interaction_verification-subscriptions_r4_server_notification_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_full_resource_content-subscriptions_r4_server_full_resource_content_interaction_verification-subscriptions_r4_server_notification_conformance"
+hl7.fhir.uv.subscriptions_1.1.0,27,https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/channels.html#rest-hook-1,Each Subscription.channel.header value SHALL be conveyed as an HTTP request header.,SHALL,Server,,,NA,NA,"1.2.02, 3.1.2.02, 3.2.2.02, 3.3.2.02","subscriptions_r5_backport_r4_server-subscriptions_r4_server_workflow-subscriptions_r4_server_interaction_verification-subscriptions_r4_server_notification_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_empty_content-subscriptions_r4_server_empty_content_interaction_verification-subscriptions_r4_server_notification_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_id_only_content-subscriptions_r4_server_id_only_content_interaction_verification-subscriptions_r4_server_notification_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_full_resource_content-subscriptions_r4_server_full_resource_content_interaction_verification-subscriptions_r4_server_notification_conformance"
 hl7.fhir.uv.subscriptions_1.1.0,28,https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/channels.html#rest-hook-1,The bundle SHALL comply with the Backported R5 Notification Bundle Profile.,SHALL,Server,,,NA,NA,"1.2.02, 3.1.2.02, 3.1.2.03, 3.2.2.02, 3.2.2.03, 3.3.2.02, 3.3.2.03, 4.01, 4.02","subscriptions_r5_backport_r4_server-subscriptions_r4_server_workflow-subscriptions_r4_server_interaction_verification-subscriptions_r4_server_notification_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_empty_content-subscriptions_r4_server_empty_content_interaction_verification-subscriptions_r4_server_notification_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_empty_content-subscriptions_r4_server_empty_content_interaction_verification-subscriptions_r4_server_empty_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_id_only_content-subscriptions_r4_server_id_only_content_interaction_verification-subscriptions_r4_server_notification_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_id_only_content-subscriptions_r4_server_id_only_content_interaction_verification-subscriptions_r4_server_id_only_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_full_resource_content-subscriptions_r4_server_full_resource_content_interaction_verification-subscriptions_r4_server_notification_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_full_resource_content-subscriptions_r4_server_full_resource_content_interaction_verification-subscriptions_r4_server_full_resource_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_handshake_heartbeat-subscriptions_r4_server_handshake_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_handshake_heartbeat-subscriptions_r4_server_heartbeat_conformance"
 hl7.fhir.uv.subscriptions_1.1.0,29,https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/channels.html#rest-hook-1,"When a Subscription is created for a REST Hook channel type, the server SHALL set initial status to requested, pending verification of the nominated endpoint URL.",SHALL,Server,,,NA,NA,"1.1.03, 3.1.1.03, 3.2.1.03, 3.3.1.03","subscriptions_r5_backport_r4_server-subscriptions_r4_server_workflow-subscriptions_r4_server_interaction-subscriptions_r4_server_creation_response_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_empty_content-subscriptions_r4_server_empty_content_interaction-subscriptions_r4_server_creation_response_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_id_only_content-subscriptions_r4_server_id_only_content_interaction-subscriptions_r4_server_creation_response_conformance, subscriptions_r5_backport_r4_server-subscriptions_r4_server_event_notification-subscriptions_r4_server_full_resource_content-subscriptions_r4_server_full_resource_content_interaction-subscriptions_r4_server_creation_response_conformance"
 hl7.fhir.uv.subscriptions_1.1.0,30,https://hl7.org/fhir/uv/subscriptions-backport/STU1.1/channels.html#rest-hook-1,"After a successful handshake notification has been sent and accepted [for a REST Hook channel type], the server SHALL update the status to active.",SHALL,Server,,,NA,NA,5.01,subscriptions_r5_backport_r4_server-subscriptions_r4_server_status_operation-subscriptions_r4_server_status_invocation

data/lib/subscriptions_test_kit/suites/subscriptions_r5_backport_r4_client/workflow/conformance_verification/processing_attestation_test.rb

@@ -27,9 +27,9 @@ module SubscriptionsTestKit
           message: %(
             I attest that the client application successfully processed the event notification sent by Inferno.
 
-            [Click here](#{resume_pass_url}?test_run_identifier=#{token}) if the above statement is **true**.
+            [Click here](#{resume_pass_url_client}?test_run_identifier=#{token}) if the above statement is **true**.
 
-            [Click here](#{resume_fail_url}?test_run_identifier=#{token}) if the above statement is **false**.
+            [Click here](#{resume_fail_url_client}?test_run_identifier=#{token}) if the above statement is **false**.
           )
         )
       end

data/lib/subscriptions_test_kit/suites/subscriptions_r5_backport_r4_client/workflow/interaction_test.rb

@@ -101,10 +101,10 @@ module SubscriptionsTestKit
             At any point while this test is waiting, Inferno will respond to Subscription GET and $status requests.
 
             Once the client has received an event notification and has made any additional requests,
-            [click here to complete the test](#{resume_pass_url}?test_run_identifier=#{access_token})
+            [click here to complete the test](#{resume_pass_url_client}?test_run_identifier=#{access_token})
 
             If at any point something has gone wrong and the client is unable to continue,
-            [click here to fail the test](#{resume_fail_url}?test_run_identifier=#{access_token})
+            [click here to fail the test](#{resume_fail_url_client}?test_run_identifier=#{access_token})
 
             NOTE: The test must be completed or failed using the links above within 10 minutes. After that,
             attempts to send requests or to complete or fail the tests using the links above

data/lib/subscriptions_test_kit/suites/subscriptions_r5_backport_r4_server/common/interaction/notification_delivery_test.rb

@@ -45,8 +45,8 @@ module SubscriptionsTestKit
 
             `#{subscription_channel_url}`
 
-            [Click here](#{resume_pass_url}?token=notification%20#{access_token}) when you have finished submitting
-            requests.
+            [Click here](#{resume_pass_url_server}?token=notification%20#{access_token}) when you have finished
+            submitting requests.
 
           )
         )

data/lib/subscriptions_test_kit/suites/subscriptions_r5_backport_r4_server/common/interaction_verification/notification_conformance_test.rb

@@ -23,6 +23,8 @@ module SubscriptionsTestKit
 
       verifies_requirements 'hl7.fhir.uv.subscriptions_1.1.0@14',
                             'hl7.fhir.uv.subscriptions_1.1.0@15',
+                            'hl7.fhir.uv.subscriptions_1.1.0@26',
+                            'hl7.fhir.uv.subscriptions_1.1.0@27',
                             'hl7.fhir.uv.subscriptions_1.1.0@28',
                             'hl7.fhir.uv.subscriptions_1.1.0@69',
                             'hl7.fhir.uv.subscriptions_1.1.0@70',
@@ -80,6 +82,10 @@ module SubscriptionsTestKit
             subscription_id: subscription['id'],
             status: 'active'
           )
+          notification_header_verification(
+            request.request_headers,
+            subscription
+          )
         end
 
         no_error_verification("Received event-notifications for Subscription #{subscription['id']} are not conformant.")

data/lib/subscriptions_test_kit/urls.rb

@@ -10,28 +10,44 @@ module SubscriptionsTestKit
   RESUME_FAIL_PATH = '/resume_fail'
 
   module URLs
-    def base_url
-      @base_url ||= "#{Inferno::Application['base_url']}/custom/#{suite_id}"
+    def server_suite_base_url
+      @server_suite_base_url ||= "#{Inferno::Application['base_url']}/custom/#{server_suite_id}"
+    end
+
+    def client_suite_base_url
+      @client_suite_base_url ||= "#{Inferno::Application['base_url']}/custom/#{client_suite_id}"
     end
 
     def subscription_channel_url
-      @subscription_channel_url ||= base_url + SUBSCRIPTION_CHANNEL_PATH
+      @subscription_channel_url ||= server_suite_base_url + SUBSCRIPTION_CHANNEL_PATH
+    end
+
+    def resume_pass_url_server
+      @resume_pass_url_server ||= server_suite_base_url + RESUME_PASS_PATH
+    end
+
+    def resume_fail_url_server
+      @resume_fail_url_server ||= server_suite_base_url + RESUME_FAIL_PATH
     end
 
     def fhir_subscription_url
-      @fhir_subscription_url ||= base_url + FHIR_SUBSCRIPTION_PATH
+      @fhir_subscription_url ||= client_suite_base_url + FHIR_SUBSCRIPTION_PATH
+    end
+
+    def resume_pass_url_client
+      @resume_pass_url_client ||= client_suite_base_url + RESUME_PASS_PATH
     end
 
-    def resume_pass_url
-      @resume_pass_url ||= base_url + RESUME_PASS_PATH
+    def resume_fail_url_client
+      @resume_fail_url_client ||= client_suite_base_url + RESUME_FAIL_PATH
     end
 
-    def resume_fail_url
-      @resume_fail_url ||= base_url + RESUME_FAIL_PATH
+    def server_suite_id
+      SubscriptionsR5BackportR4Server::SubscriptionsR5BackportR4ServerSuite.id
     end
 
-    def suite_id
-      self.class.suite.id
+    def client_suite_id
+      SubscriptionsR5BackportR4Client::SubscriptionsR5BackportR4ClientSuite.id
     end
   end
 end

data/lib/subscriptions_test_kit/version.rb

@@ -1,4 +1,4 @@
 module SubscriptionsTestKit
-  VERSION = '0.10.0'.freeze
+  VERSION = '0.10.1'.freeze
   LAST_UPDATED = '2025-02-25'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: subscriptions_test_kit
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Karl Naden, Emily Semple, Tom Strassner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-26 00:00:00.000000000 Z
+date: 2025-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inferno_core