subscriptions_test_kit 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3010c0e41d18422300572d2bdd268ba8f979ae507b7b0e409d7f10522a73fd6
+  data.tar.gz: 6ca1f0f14fc953337763a5cf849210f0bf2ac10d4474dbe32625a8743d67c349
+SHA512:
+  metadata.gz: 654ce8de2da7ea3311efd3abaed8119bfd9e1bca5ebd7b5f272ca860f93d8057d822f90ed93846aa726a6cfce801491104a132b2debf748fb27507ec3c6a4c13
+  data.tar.gz: fab4227a438ee3299ec345d88ee02dd4b7c9b851a71cdd9b0e22952be0cbfb9d83779bc3d971439a384a71020b65e61b27866aad1ce6fd7b70cf71858bd28d48

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/lib/inferno_requirements_tools/ext/inferno_core/runnable.rb

@@ -0,0 +1,22 @@
+module Inferno
+  module DSL
+    # This module contains the DSL for defining child entities in the test
+    # definition framework.
+    module Runnable
+      # Set/Get the IDs of requirements verifed by this runnable
+      # Set with [] to clear the list
+      #
+      # @param requirements [Array<String>]
+      # @return [Array<String>] the requirement IDs
+      def verifies_requirements(*requirement_ids)
+        if requirement_ids.empty?
+          @requirement_ids || []
+        elsif requirement_ids == [[]]
+          @requirement_ids = []
+        else
+          @requirement_ids = requirement_ids
+        end
+      end
+    end
+  end
+end

data/lib/inferno_requirements_tools/tasks/collect_requirements.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+require 'CSV'
+require 'roo'
+
+module InfernoRequirementsTools
+  module Tasks
+    # This class manages the collection of requirements details from
+    # requirements planning excel workbooks into a CSV representation.
+    # Currently splits out Requirements and Planned Not Tested Requirements
+    # into two separate files.
+    #
+    # The `run` method will generate the files
+    # The `run_check` method will check whether the previously generated files are up-to-date.
+    class CollectRequirements
+      # Update these constants based on the test kit.
+      TEST_KIT_ID = 'subscriptions-test-kit'
+      INPUT_SETS = ['hl7.fhir.uv.subscriptions_1.1.0'].freeze
+
+      # Derivative constants
+      TEST_KIT_CODE_FOLDER = TEST_KIT_ID.gsub('-', '_')
+      INPUT_HEADERS =
+        [
+          'ID*',
+          'URL*',
+          'Requirement*',
+          'Conformance*',
+          'Actor*',
+          'Sub-Requirement(s)',
+          'Conditionality',
+          'Verifiable?',
+          'Verifiability Details',
+          'Planning To Test?',
+          'Planning To Test Details'
+        ].freeze
+      REQUIREMENTS_OUTPUT_HEADERS =
+        [
+          'Req Set',
+          'ID',
+          'URL',
+          'Requirement',
+          'Conformance',
+          'Actor',
+          'Sub-Requirement(s)',
+          'Conditionality'
+        ].freeze
+      REQUIREMENTS_OUTPUT_FILE_NAME = "#{TEST_KIT_ID}_requirements.csv".freeze
+      REQUIREMENTS_OUTPUT_FILE =
+        File.join('lib', TEST_KIT_CODE_FOLDER, 'requirements', REQUIREMENTS_OUTPUT_FILE_NAME).freeze
+      PLANNED_NOT_TESTED_OUTPUT_HEADERS = ['Req Set', 'ID', 'Reason', 'Details'].freeze
+      PLANNED_NOT_TESTED_OUTPUT_FILE_NAME = "#{TEST_KIT_ID}_out_of_scope_requirements.csv".freeze
+      PLANNED_NOT_TESTED_OUTPUT_FILE =
+        File.join('lib', TEST_KIT_CODE_FOLDER, 'requirements', PLANNED_NOT_TESTED_OUTPUT_FILE_NAME).freeze
+
+      def input_file_map
+        @input_file_map ||= {}
+      end
+
+      def input_rows
+        @input_rows ||= {}
+      end
+
+      def input_rows_for_set(req_set_id)
+        input_rows[req_set_id] = extract_input_rows_for_set(req_set_id) unless input_rows.has_key?(req_set_id)
+        input_rows[req_set_id]
+      end
+
+      def extract_input_rows_for_set(req_set_id)
+        CSV.parse(Roo::Spreadsheet.open(input_file_map[req_set_id]).sheet('Requirements').to_csv, headers: true).map do |row|
+          row.to_h.slice(*INPUT_HEADERS)
+        end
+      end
+
+      def new_requirements_csv
+        @new_requirements_csv ||=
+          CSV.generate(+"\xEF\xBB\xBF") do |csv| # start with an unnecessary BOM to make viewing in excel easier
+            csv << REQUIREMENTS_OUTPUT_HEADERS
+
+            INPUT_SETS.each do |req_set_id|
+              input_rows = input_rows_for_set(req_set_id)
+              input_rows.each do |row| # NOTE: use row order from source file
+                row['Req Set'] = req_set_id
+
+                csv << REQUIREMENTS_OUTPUT_HEADERS.map { |header| row.key?(header) ? row[header] : row["#{header}*"]}
+              end
+            end
+          end
+      end
+
+      def old_requirements_csv
+        @old_requirements_csv ||= File.read(REQUIREMENTS_OUTPUT_FILE)
+      end
+
+      def new_planned_not_tested_csv
+        @new_planned_not_tested_csv ||=
+          CSV.generate(+"\xEF\xBB\xBF") do |csv| # start with an unnecessary BOM to make viewing in excel easier
+            csv << PLANNED_NOT_TESTED_OUTPUT_HEADERS
+
+            INPUT_SETS.each do |req_set_id|
+              input_rows = input_rows_for_set(req_set_id)
+              input_rows.each do |row| # note: use row order from source file
+                not_verifiable = row['Verifiable?']&.downcase == 'no' || row['Verifiable?']&.downcase == 'false'
+                not_tested = row['Planning To Test?']&.downcase == 'no' || row['Planning To Test?']&.downcase == 'false'
+                next unless not_verifiable || not_tested
+
+                csv << [
+                  req_set_id,
+                  row['ID*'],
+                  not_verifiable ? 'Not Verifiable' : 'Not Tested',
+                  not_verifiable ? row['Verifiability Details'] : row['Planning To Test Details']
+                ]
+              end
+            end
+          end
+      end
+
+      def old_planned_not_tested_csv
+        @old_planned_not_tested_csv ||= File.read(PLANNED_NOT_TESTED_OUTPUT_FILE)
+      end
+
+      def check_for_req_set_files(input_directory)
+        available_worksheets = Dir.glob(File.join(input_directory, '*.xlsx')).reject { |f| f.include?('~$') }
+
+        INPUT_SETS.each do |req_set_id|
+          req_set_file = available_worksheets&.find { |worksheet_file| worksheet_file.include?(req_set_id) }
+
+          if req_set_file&.empty?
+            puts "Could not find input file for set #{req_set_id} in directory #{input_directory}. Aborting requirements collection..."
+            exit(1)
+          end
+          input_file_map[req_set_id] = req_set_file
+        end
+      end
+
+      def run(input_directory)
+        check_for_req_set_files(input_directory)
+
+        update_requirements =
+          if File.exist?(REQUIREMENTS_OUTPUT_FILE)
+            if old_requirements_csv == new_requirements_csv
+              puts "'#{REQUIREMENTS_OUTPUT_FILE_NAME}' file is up to date."
+              false
+            else
+              puts 'Requirements set has changed.'
+              true
+            end
+          else
+            puts "No existing #{REQUIREMENTS_OUTPUT_FILE_NAME}."
+            true
+          end
+
+        if update_requirements
+          puts "Writing to file #{REQUIREMENTS_OUTPUT_FILE}..."
+          File.write(REQUIREMENTS_OUTPUT_FILE, new_requirements_csv, encoding: Encoding::UTF_8)
+        end
+
+        udpate_planned_not_tested =
+          if File.exist?(PLANNED_NOT_TESTED_OUTPUT_FILE)
+            if old_planned_not_tested_csv == new_planned_not_tested_csv
+              puts "'#{PLANNED_NOT_TESTED_OUTPUT_FILE_NAME}' file is up to date."
+              false
+            else
+              puts 'Planned Not Tested Requirements set has changed.'
+              true
+            end
+          else
+            puts "No existing #{PLANNED_NOT_TESTED_OUTPUT_FILE_NAME}."
+            true
+          end
+
+        if udpate_planned_not_tested
+          puts "Writing to file #{PLANNED_NOT_TESTED_OUTPUT_FILE}..."
+          File.write(PLANNED_NOT_TESTED_OUTPUT_FILE, new_planned_not_tested_csv, encoding: Encoding::UTF_8)
+        end
+
+        puts 'Done.'
+      end
+
+      def run_check(input_directory)
+        check_for_req_set_files(input_directory)
+
+        requirements_ok =
+          if File.exist?(REQUIREMENTS_OUTPUT_FILE)
+            if old_requirements_csv == new_requirements_csv
+              puts "'#{REQUIREMENTS_OUTPUT_FILE_NAME}' file is up to date."
+              true
+            else
+              puts "#{REQUIREMENTS_OUTPUT_FILE_NAME} file is out of date."
+              false
+            end
+          else
+            puts "No existing #{REQUIREMENTS_OUTPUT_FILE_NAME} file."
+            false
+          end
+
+        planned_not_tested_requirements_ok =
+          if File.exist?(PLANNED_NOT_TESTED_OUTPUT_FILE)
+            if old_planned_not_tested_csv == new_planned_not_tested_csv
+              puts "'#{PLANNED_NOT_TESTED_OUTPUT_FILE_NAME}' file is up to date."
+              true
+            else
+              puts "#{PLANNED_NOT_TESTED_OUTPUT_FILE_NAME} file is out of date."
+              false
+            end
+          else
+            puts "No existing #{PLANNED_NOT_TESTED_OUTPUT_FILE_NAME} file."
+            false
+          end
+
+        return if planned_not_tested_requirements_ok && requirements_ok
+
+        puts <<~MESSAGE
+          Check Failed. To resolve, run:
+
+                bundle exec rake "requirements:collect[<input_directory>]"
+
+        MESSAGE
+        exit(1)
+      end
+    end
+  end
+end