onc_certification_g10_test_kit 2.0.0.rc3 → 2.1.0

data/lib/onc_certification_g10_test_kit/tasks/generate_matrix.rb

@@ -0,0 +1,247 @@
+require 'rubyXL'
+require 'rubyXL/convenience_methods'
+require 'inferno'
+require_relative '../../onc_certification_g10_test_kit'
+require_relative 'test_procedure'
+
+module ONCCertificationG10TestKit
+  module Tasks
+    class GenerateMatrix
+      include ONCCertificationG10TestKit
+
+      FILE_NAME = 'onc_certification_g10_matrix.xlsx'.freeze
+
+      def inferno_to_procedure_map
+        @inferno_to_procedure_map ||= Hash.new { |h, k| h[k] = [] }
+      end
+
+      def test_procedure
+        @test_procedure ||=
+          if File.file? File.join('lib', 'onc_certification_g10_test_kit', 'onc_program_procedure.yml')
+            TestProcedure.new(
+              YAML.load_file(File.join('lib', 'onc_certification_g10_test_kit',
+                                       'onc_program_procedure.yml')).deep_symbolize_keys
+            )
+          else
+            TestProcedure.new
+          end
+      end
+
+      def test_suite
+        ONCCertificationG10TestKit::G10CertificationSuite
+      end
+
+      def workbook
+        @workbook ||= RubyXL::Workbook.new
+      end
+
+      def run
+        generate_matrix_worksheet
+        generate_test_procedure_worksheet
+        generate_inferno_test_worksheet
+
+        Inferno.logger.info "Writing to #{FILE_NAME}"
+        workbook.write(FILE_NAME)
+      end
+
+      def generate_matrix_worksheet # rubocop:disable Metrics/CyclomaticComplexity
+        matrix_worksheet = workbook.worksheets[0]
+        matrix_worksheet.sheet_name = 'Matrix'
+
+        col = 2
+        matrix_worksheet.add_cell(0, 1, "ONC Certification (g)(10) Test Kit (v#{ONCCertificationG10TestKit::VERSION})")
+        matrix_worksheet.change_row_height(0, 20)
+        matrix_worksheet.change_row_vertical_alignment(0, 'distributed')
+        column_map = {}
+        matrix_worksheet.change_column_width(1, 25)
+        matrix_worksheet.change_row_height(1, 20)
+        matrix_worksheet.change_row_horizontal_alignment(1, 'center')
+        matrix_worksheet.change_row_vertical_alignment(1, 'distributed')
+        matrix_worksheet.change_row_height(2, 70)
+        column_borders = []
+
+        test_suite.groups.each do |group|
+          matrix_worksheet.add_cell(1, col, group.title).change_text_wrap(true)
+          matrix_worksheet.merge_cells(1, col, 1, col + group.groups.length - 1)
+          matrix_worksheet.change_column_border(col, :left, 'medium')
+          matrix_worksheet.change_column_border_color(col, :left, '000000')
+          column_borders << col
+
+          group.groups.each do |test_case|
+            matrix_worksheet.change_column_width(col, 4.2)
+
+            cell = matrix_worksheet.add_cell(2, col,
+                                             "#{test_case.short_id} #{test_case.short_title || test_case.title}")
+            cell.change_text_rotation(90)
+            cell.change_border_color(:bottom, '000000')
+            cell.change_border(:bottom, 'medium')
+            matrix_worksheet.change_column_border(col, :right, 'thin')
+            matrix_worksheet.change_column_border_color(col, :right, '666666')
+
+            test_case.tests.each do |test|
+              # tests << { test_case: test_case, test: test }
+              # full_test_id = "#{test_case.prefix}#{test.id}"
+              column_map[test.short_id] = col
+            end
+            col += 1
+          end
+        end
+
+        total_width = col - 1
+        matrix_worksheet.merge_cells(0, 1, 0, total_width)
+        matrix_worksheet.change_row_horizontal_alignment(0, 'center')
+
+        matrix_worksheet.add_cell(2, total_width + 2, 'Supported?')
+        row = 3
+
+        test_procedure.sections.each do |section|
+          section.steps.each do |step|
+            step_id = step.id.upcase
+            matrix_worksheet.add_cell(row, 1, "#{step_id} ")
+            matrix_worksheet.change_row_height(row, 13)
+            matrix_worksheet.change_row_vertical_alignment(row, 'distributed')
+
+            (2..total_width).each do |column|
+              matrix_worksheet.add_cell(row, column, '')
+            end
+
+            step.inferno_tests.each do |test_id|
+              column = column_map[test_id]
+              inferno_to_procedure_map[test_id].push(step_id)
+              if column.nil?
+                puts "No such test found: #{test_id}"
+                next
+              end
+
+              matrix_worksheet.add_cell(row, column, '').change_fill('3C63FF')
+            end
+
+            matrix_worksheet.add_cell(row, total_width + 2, step.inferno_supported.upcase)
+
+            row += 1
+          end
+        end
+        matrix_worksheet.change_column_horizontal_alignment(1, 'right')
+        matrix_worksheet.change_row_horizontal_alignment(0, 'center')
+
+        column_borders.each do |column|
+          matrix_worksheet.change_column_border(column, :left, 'medium')
+          matrix_worksheet.change_column_border_color(column, :left, '000000')
+        end
+        matrix_worksheet.change_column_border_color(total_width, :right, '000000')
+        matrix_worksheet.change_column_border(total_width, :right, 'medium')
+        matrix_worksheet.change_column_width(total_width + 1, 3)
+
+        matrix_worksheet.change_column_width(total_width + 3, 6)
+        matrix_worksheet.change_column_width(total_width + 4, 2)
+        matrix_worksheet.change_column_width(total_width + 5, 60)
+        matrix_worksheet.add_cell(1, total_width + 3, '').change_fill('3C63FF')
+        this_text = 'Blue boxes indicate that the Inferno test (top) covers this test procedure step (left).'
+        matrix_worksheet.add_cell(1, total_width + 5, this_text).change_text_wrap(true)
+        matrix_worksheet.change_column_horizontal_alignment(total_width + 5, :left)
+      end
+
+      def generate_test_procedure_worksheet # rubocop:disable Metrics/CyclomaticComplexity
+        workbook.add_worksheet('Test Procedure')
+        tp_worksheet = workbook.worksheets[1]
+
+        [3, 3, 22, 65, 65, 3, 15, 30, 65, 65].each_with_index do |width, index|
+          tp_worksheet.change_column_width(index, width)
+        end
+        ['',
+         '',
+         'ID',
+         'System Under Test',
+         'Test Lab Verifies',
+         '',
+         'Inferno Supports?',
+         'Inferno Tests',
+         'Inferno Notes',
+         'Alternate Test Methodology'].each_with_index { |text, index| tp_worksheet.add_cell(0, index, text) }
+
+        row = 2
+
+        test_procedure.sections.each do |section|
+          tp_worksheet.add_cell(row, 0, section.name)
+          row += 1
+          section.steps.group_by(&:group).each do |group_name, steps|
+            tp_worksheet.add_cell(row, 1, group_name)
+            row += 1
+            steps.each do |step|
+              longest_line = [step.s_u_t, step.t_l_v, step.inferno_notes, step.alternate_test].map do |text|
+                text&.lines&.count || 0
+              end.max
+              tp_worksheet.change_row_height(row, (longest_line * 10) + 10)
+              tp_worksheet.change_row_vertical_alignment(row, 'top')
+              tp_worksheet.add_cell(row, 2, "#{step.id.upcase} ")
+              tp_worksheet.add_cell(row, 3, step.s_u_t).change_text_wrap(true)
+              tp_worksheet.add_cell(row, 4, step.t_l_v).change_text_wrap(true)
+              tp_worksheet.add_cell(row, 5, '')
+              tp_worksheet.add_cell(row, 6, step.inferno_supported)
+              tp_worksheet.add_cell(row, 7, step.inferno_tests.join(', ')).change_text_wrap(true)
+              tp_worksheet.add_cell(row, 8, step.inferno_notes).change_text_wrap(true)
+              tp_worksheet.add_cell(row, 9, step.alternate_test).change_text_wrap(true)
+              row += 1
+            end
+          end
+          row += 1
+        end
+      end
+
+      def generate_inferno_test_worksheet # rubocop:disable Metrics/CyclomaticComplexity
+        workbook.add_worksheet('Inferno Tests')
+        inferno_worksheet = workbook.worksheets[2]
+
+        columns = [
+          ['', 3, ->(_test) { '' }],
+          ['', 3, ->(_test) { '' }],
+          ['Inferno Test ID', 22, ->(test) { test.short_id.to_s }],
+          ['Inferno Test Name', 65, ->(test) { test.title }],
+          ['Inferno Test Description', 65, lambda do |test|
+            description = test.description || ''
+            natural_indent =
+              description
+                .lines
+                .collect { |l| l.index(/[^ ]/) }
+                .select { |l| !l.nil? && l.positive? }
+                .min || 0
+            description.lines.map { |l| l[natural_indent..] || "\n" }.join.strip
+          end],
+          ['Test Procedure Steps', 30, ->(test) { inferno_to_procedure_map[test.short_id].join(', ') }]
+        ]
+
+        columns.each_with_index do |row_name, index|
+          inferno_worksheet.add_cell(0, index, row_name.first)
+        end
+
+        row = 1
+
+        test_suite.groups.each do |group|
+          row += 1
+          inferno_worksheet.add_cell(row, 0, group.title)
+          row += 1
+          group.groups.each do |test_case|
+            inferno_worksheet.add_cell(row, 1, "#{test_case.short_id}: #{test_case.title}")
+            row += 1
+            test_case.tests.each do |test|
+              this_row = columns.map do |column|
+                column[2].call(test)
+              end
+
+              this_row.each_with_index do |value, index|
+                inferno_worksheet.add_cell(row, index, value).change_text_wrap(true)
+              end
+              inferno_worksheet.change_row_height(row, [26, ((test.description || '').strip.lines.count * 10) + 10].max)
+              inferno_worksheet.change_row_vertical_alignment(row, 'top')
+              row += 1
+            end
+          end
+        end
+
+        columns.each_with_index do |column, index|
+          inferno_worksheet.change_column_width(index, column[1])
+        end
+      end
+    end
+  end
+end

data/lib/onc_certification_g10_test_kit/tasks/test_procedure.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module ONCCertificationG10TestKit
+  module Tasks
+    class TestProcedure
+      # procedure -> section -> steps
+      attr_accessor :sections
+
+      def initialize(data)
+        @sections = data[:procedure].map { |section| Section.new(section) }
+      end
+
+      class Section
+        attr_accessor :name, :steps
+
+        def initialize(data)
+          @name = data[:section]
+
+          group = nil
+          @steps = data[:steps].map do |step|
+            if step[:group].nil?
+              step[:group] = group
+            else
+              group = step[:group]
+            end
+
+            Step.new(step)
+          end
+        end
+      end
+
+      class Step
+        attr_accessor :group, :id, :s_u_t, :t_l_v, :inferno_supported, :inferno_notes, :inferno_tests, :alternate_test
+
+        def initialize(data)
+          @group = data[:group]
+          @id = data[:id]
+          @s_u_t = data[:SUT]
+          @t_l_v = data[:TLV]
+          @inferno_supported = data[:inferno_supported]
+          @inferno_notes = data[:inferno_notes]
+          @alternate_test = data[:alternate_test]
+          @inferno_tests = expand_tests(data[:inferno_tests]).flatten
+        end
+
+        def expand_tests(test_list)
+          return [] if test_list.nil?
+
+          test_list.map do |test|
+            if test.include?(' - ')
+              first, second = test.split(' - ')
+              prefix, _, beginning = first.rpartition('.')
+              second_prefix, _, ending = second.rpartition('.')
+              raise "'#{prefix}' != '#{second_prefix}' in #{@group} #{@id}" unless prefix == second_prefix
+
+              (beginning.to_i..ending.to_i).map { |index| "#{prefix}.#{format('%02<index>d', { index: index })}" }
+            else
+              [test]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onc_certification_g10_test_kit/token_revocation_group.rb

@@ -4,67 +4,16 @@ module ONCCertificationG10TestKit
     description 'Demonstrate the Health IT module is capable of revoking access granted to an application.'
     id :g10_token_revocation
     run_as_group
-    input :token_revocation_attestation,
-          title: 'Prior to executing test, Health IT developer demonstrated revoking tokens provided during patient standalone launch.', # rubocop:disable Layout/LineLength
-          type: 'radio',
-          default: 'false',
-          options: {
-            list_options: [
-              {
-                label: 'Yes',
-                value: 'true'
-              },
-              {
-                label: 'No',
-                value: 'false'
-              }
-            ]
-          }
-    input :token_revocation_notes,
-          title: 'Notes, if applicable:',
-          type: 'textarea',
-          optional: true
-    input :url, :access_token, :refresh_token, :smart_token_url, :patient_id, :client_id, :client_secret
 
-    config(
-      inputs: {
-        url: {
-          title: 'FHIR Endpoint',
-          description: 'URL of the FHIR endpoint used by standalone applications'
-        },
-        smart_token_url: {
-          title: 'OAuth 2.0 Token Endpoint',
-          description: 'OAuth token endpoint provided during the patient standalone launch'
-        },
-        access_token: {
-          name: :standalone_access_token,
-          title: 'Revoked Bearer Token',
-          description: 'Prior to the test, please revoke this bearer token from patient standalone launch.'
-        },
-        refresh_token: {
-          name: :standalone_refresh_token,
-          title: 'Revoked Refresh Token',
-          description: 'Prior to the test, please revoke this refresh token from patient standalone launch.'
-        },
-        patient_id: {
-          name: :standalone_patient_id,
-          title: 'Patient ID',
-          description: 'Patient ID associated with revoked tokens provided as context in the patient standalone launch. This will be used to verify access is no longer granted using the revoked token.' # rubocop:disable Layout/LineLength
-        },
-        client_id: {
-          name: :standalone_client_id,
-          title: 'Standalone Client ID',
-          description: 'Client ID provided during registration of Inferno as a standalone application',
-          locked: true
-        },
-        client_secret: {
-          name: :standalone_client_secret,
-          title: 'Standalone Client Secret',
-          description: 'Client Secret provided during registration of Inferno as a standalone application',
-          locked: true
-        }
-      }
-    )
+    input_order :token_revocation_attestation,
+                :token_revocation_notes,
+                :standalone_access_token,
+                :standalone_refresh_token,
+                :standalone_patient_id,
+                :url,
+                :smart_token_url,
+                :standalone_client_id,
+                :standalone_client_secret
 
     test do
       title 'Health IT developer demonstrated the ability of the Health IT Module to revoke tokens.'
@@ -73,6 +22,27 @@ module ONCCertificationG10TestKit
         authorization server to revoke tokens.
       )
 
+      input :token_revocation_attestation,
+            title: 'Prior to executing test, Health IT developer demonstrated revoking tokens provided during patient standalone launch.', # rubocop:disable Layout/LineLength
+            type: 'radio',
+            default: 'false',
+            options: {
+              list_options: [
+                {
+                  label: 'Yes',
+                  value: 'true'
+                },
+                {
+                  label: 'No',
+                  value: 'false'
+                }
+              ]
+            }
+      input :token_revocation_notes,
+            title: 'Notes, if applicable:',
+            type: 'textarea',
+            optional: true
+
       run do
         assert token_revocation_attestation == 'true',
                'Health IT Module did not demonstrate support for application registration for single patients.'
@@ -86,6 +56,18 @@ module ONCCertificationG10TestKit
         This test checks that the Patient resource returns unuathorized after token revocation.
       )
 
+      input :url,
+            title: 'FHIR Endpoint',
+            description: 'URL of the FHIR endpoint used by standalone applications'
+      input :patient_id,
+            name: :standalone_patient_id,
+            title: 'Patient ID',
+            description: 'Patient ID associated with revoked tokens provided as context in the patient standalone launch. This will be used to verify access is no longer granted using the revoked token.' # rubocop:disable Layout/LineLength
+      input :access_token,
+            name: :standalone_access_token,
+            title: 'Revoked Bearer Token',
+            description: 'Prior to the test, please revoke this bearer token from patient standalone launch.'
+
       fhir_client :revoked_token do
         url :url
         bearer_token :access_token
@@ -111,6 +93,24 @@ module ONCCertificationG10TestKit
         This test checks that refreshing token fails after token revokation.
       )
 
+      input :smart_token_url,
+            title: 'OAuth 2.0 Token Endpoint',
+            description: 'OAuth token endpoint provided during the patient standalone launch'
+      input :refresh_token,
+            name: :standalone_refresh_token,
+            title: 'Revoked Refresh Token',
+            description: 'Prior to the test, please revoke this refresh token from patient standalone launch.'
+      input :client_id,
+            name: :standalone_client_id,
+            title: 'Standalone Client ID',
+            description: 'Client ID provided during registration of Inferno as a standalone application',
+            locked: true
+      input :client_secret,
+            name: :standalone_client_secret,
+            title: 'Standalone Client Secret',
+            description: 'Client Secret provided during registration of Inferno as a standalone application',
+            locked: true
+
       run do
         skip_if refresh_token.blank?,
                 'Refresh token not provided to test.'

data/lib/onc_certification_g10_test_kit/unrestricted_resource_type_access_group.rb

@@ -152,7 +152,7 @@ module ONCCertificationG10TestKit
       id :g10_patient_unrestricted_access
 
       def resource_group
-        USCoreTestKit::PatientGroup
+        USCoreTestKit::USCoreV311::PatientGroup
       end
     end
 
@@ -170,7 +170,7 @@ module ONCCertificationG10TestKit
       id :g10_allergy_intolerance_unrestricted_access
 
       def resource_group
-        USCoreTestKit::AllergyIntoleranceGroup
+        USCoreTestKit::USCoreV311::AllergyIntoleranceGroup
       end
     end
 
@@ -188,7 +188,7 @@ module ONCCertificationG10TestKit
       id :g10_care_plan_unrestricted_access
 
       def resource_group
-        USCoreTestKit::CarePlanGroup
+        USCoreTestKit::USCoreV311::CarePlanGroup
       end
     end
 
@@ -206,7 +206,7 @@ module ONCCertificationG10TestKit
       id :g10_care_team_unrestricted_access
 
       def resource_group
-        USCoreTestKit::CareTeamGroup
+        USCoreTestKit::USCoreV311::CareTeamGroup
       end
     end
 
@@ -224,7 +224,7 @@ module ONCCertificationG10TestKit
       id :g10_condition_unrestricted_access
 
       def resource_group
-        USCoreTestKit::ConditionGroup
+        USCoreTestKit::USCoreV311::ConditionGroup
       end
     end
 
@@ -242,7 +242,7 @@ module ONCCertificationG10TestKit
       id :g10_device_unrestricted_access
 
       def resource_group
-        USCoreTestKit::DeviceGroup
+        USCoreTestKit::USCoreV311::DeviceGroup
       end
     end
 
@@ -260,7 +260,7 @@ module ONCCertificationG10TestKit
       id :g10_diagnostic_report_unrestricted_access
 
       def resource_group
-        USCoreTestKit::DiagnosticReportLabGroup
+        USCoreTestKit::USCoreV311::DiagnosticReportLabGroup
       end
     end
 
@@ -278,7 +278,7 @@ module ONCCertificationG10TestKit
       id :g10_document_reference_unrestricted_access
 
       def resource_group
-        USCoreTestKit::DocumentReferenceGroup
+        USCoreTestKit::USCoreV311::DocumentReferenceGroup
       end
     end
 
@@ -296,7 +296,7 @@ module ONCCertificationG10TestKit
       id :g10_goal_unrestricted_access
 
       def resource_group
-        USCoreTestKit::GoalGroup
+        USCoreTestKit::USCoreV311::GoalGroup
       end
     end
 
@@ -314,7 +314,7 @@ module ONCCertificationG10TestKit
       id :g10_immunization_unrestricted_access
 
       def resource_group
-        USCoreTestKit::ImmunizationGroup
+        USCoreTestKit::USCoreV311::ImmunizationGroup
       end
     end
 
@@ -332,7 +332,7 @@ module ONCCertificationG10TestKit
       id :g10_medication_request_access
 
       def resource_group
-        USCoreTestKit::MedicationRequestGroup
+        USCoreTestKit::USCoreV311::MedicationRequestGroup
       end
     end
 
@@ -350,7 +350,7 @@ module ONCCertificationG10TestKit
       id :g10_observation_unrestricted_access
 
       def resource_group
-        USCoreTestKit::PulseOximetryGroup
+        USCoreTestKit::USCoreV311::PulseOximetryGroup
       end
     end
 
@@ -368,7 +368,7 @@ module ONCCertificationG10TestKit
       id :g10_procedure_unrestricted_access
 
       def resource_group
-        USCoreTestKit::ProcedureGroup
+        USCoreTestKit::USCoreV311::ProcedureGroup
       end
     end
   end

data/lib/onc_certification_g10_test_kit/version.rb

@@ -1,3 +1,3 @@
 module ONCCertificationG10TestKit
-  VERSION = '2.0.0.rc3'.freeze
+  VERSION = '2.1.0'.freeze
 end

data/lib/onc_certification_g10_test_kit/visual_inspection_and_attestations_group.rb

@@ -144,13 +144,14 @@ module ONCCertificationG10TestKit
     end
 
     test do
-      title 'Health IT Module attested that refresh tokens are valid for a period of no shorter than three months.'
+      title 'Health IT Module attested that it is capable of issuing refresh tokens ' \
+            'that are valid for a period of no shorter than three months.'
       description %(
-        Health IT Module attested that refresh tokens are valid for a period of
-        no shorter than three months.
+        Health IT Module attested that it is capable of issuing refresh tokens
+        that are valid for a period of no shorter than three months.
       )
       input :refresh_token_period_attestation,
-            title: 'Health IT Module attested that refresh tokens are valid for a period of no shorter than three months.', # rubocop:disable Layout/LineLength
+            title: 'Health IT Module attested that it is capable of issuing refresh tokens that are valid for a period of no shorter than three months.', # rubocop:disable Layout/LineLength
             type: 'radio',
             default: 'false',
             options: {
@@ -172,8 +173,8 @@ module ONCCertificationG10TestKit
 
       run do
         assert refresh_token_period_attestation == 'true',
-               'Health IT Module did not attest that refresh tokens are valid ' \
-               'for a period of no shorter than three months.'
+               'Health IT Module did not attest that it is capable of issuing refresh tokens ' \
+               'that are valid for a period of no shorter than three months.'
         pass refresh_token_period_notes if refresh_token_period_notes.present?
       end
     end