FI-3600: Requirements Support

dev_suites/dev_requirements/requirements/sample_requirements.csv

@@ -0,0 +1,8 @@
+Req Set,ID,URL,Requirement,Conformance,Actor,Sub-Requirement(s),Conditionality
+sample-criteria-proposal,1,,Feugiat in ante metus dictum. Dignissim cras tincidunt lobortis feugiat.,SHALL,Client,"sample-criteria-proposal@2-3,4,6",FALSE
+sample-criteria-proposal,2,,tempor incididunt ut labore et dolore magna aliqua,SHALL,Client,sample-criteria-proposal@3,FALSE
+sample-criteria-proposal,3,,"Lorem ipsum dolor sit amet, consectetur adipiscing elit",SHALL,Client,sample-criteria-proposal@5,FALSE
+sample-criteria-proposal,4,,Consequat mauris nunc congue nisi vitae suscipit tellus mauris.,SHALL,Client,sample-criteria-proposal@6,FALSE
+sample-criteria-proposal,5,,condimentum vitae sapien pellentesque habitant morbi tristique senectus,SHALL,Client,sample-criteria-proposal@6,TRUE
+sample-criteria-proposal,6,,Faucibus scelerisque eleifend donec pretium vulputate sapien nec sagittis,SHALL,Client,,TRUE
+sample-criteria-proposal,7,,Nulla facilisi nullam vehicula ipsum a,SHALL,Client,,FALSE

dev_suites/dev_requirements/requirements_suite.rb

@@ -0,0 +1,40 @@
+module RequirementsSuite
+  class Suite < Inferno::TestSuite
+    title 'Requirements Suite'
+    id :ig_requirements
+    description 'Suite Description'
+
+    verifies_requirements 'sample-criteria-proposal@1', 'sample-criteria-proposal@2',
+                          'sample-criteria-proposal@3', 'sample-criteria-proposal@4'
+
+    group do
+      title 'Test Requirements 1 and 2'
+      verifies_requirements 'sample-criteria-proposal@1', 'sample-criteria-proposal@2'
+
+      test do
+        title 'Requirement 1'
+        run { pass }
+      end
+
+      test do
+        title 'Requirement 2'
+        run { pass }
+      end
+    end
+
+    group do
+      title 'Test Requirements 3 and 4'
+      verifies_requirements 'sample-criteria-proposal@3', 'sample-criteria-proposal@4'
+
+      test do
+        title 'Requirement 3'
+        run { pass }
+      end
+
+      test do
+        title 'Requirement 4'
+        run { pass }
+      end
+    end
+  end
+end

docs/swagger.yml

@@ -341,6 +341,40 @@ paths:
             $ref: "#/definitions/Request"
         "404":
           description: "HTTP request not found"
+  /requirements:
+    get:
+      tags:
+      - "Requirements"
+      summary: "Get the set of requirements for the specification or guide being tested."
+      produces:
+      - "application/json"
+      responses:
+        "200":
+          description: "success"
+          schema:
+            type: "array"
+            items:
+              $ref: "#/definitions/Requirement"
+  /requirements/{requirement_id}:
+    get:
+      tags:
+      - "Requirement"
+      summary: "Get a single Requirement"
+      produces:
+      - "application/json"
+      parameters:
+      - in: "path"
+        type: "string"
+        name: "requirement_id"
+        description: "ID of the requirement"
+        required: true
+      responses:
+        "200":
+          description: "Success"
+          schema:
+            $ref: "#/definitions/Requirement"
+        "404":
+          description: "Requirement not found"
   /version:
     get:
       tags:
@@ -750,3 +784,28 @@ definitions:
     properties:
       version:
         type: "string"
+  Requirement:
+    type: "object"
+    required:
+    - "id"
+    - "requirement"
+    - "conformance"
+    - "actor"
+    properties:
+      id:
+        type: "string"
+      requirement:
+        type: "string"
+      conformance:
+        type: "string"
+      actor:
+        type: "string"
+      conditionality:
+        type: "string"
+      url:
+        type: "string"
+      sub_requirements:
+        type: "array"
+        items:
+          type: "string"
+

lib/inferno/apps/web/controllers/requirements/index.rb

@@ -0,0 +1,15 @@
+require_relative '../../serializers/requirement'
+
+module Inferno
+  module Web
+    module Controllers
+      module Requirements
+        class Index < Controller
+          def handle(_req, res)
+            res.body = serialize(repo.all)
+          end
+        end
+      end
+    end
+  end
+end

lib/inferno/apps/web/controllers/requirements/show.rb

@@ -0,0 +1,18 @@
+require_relative '../../serializers/requirement'
+
+module Inferno
+  module Web
+    module Controllers
+      module Requirements
+        class Show < Controller
+          def handle(req, res)
+            requirement = repo.find(req.params[:id])
+            halt 404 if requirement.nil?
+
+            res.body = serialize(requirement)
+          end
+        end
+      end
+    end
+  end
+end

lib/inferno/apps/web/router.rb

@@ -45,6 +45,11 @@ module Web
               as: :check_configuration
         end
 
+        scope 'requirements' do
+          get '/', to: Inferno::Web::Controllers::Requirements::Index, as: :index
+          get '/:id', to: Inferno::Web::Controllers::Requirements::Show, as: :show
+        end
+
         get '/requests/:id', to: Inferno::Web::Controllers::Requests::Show, as: :requests_show
 
         get '/version', to: ->(_env) { [200, {}, [{ 'version' => Inferno::VERSION.to_s }.to_json]] }, as: :version

lib/inferno/apps/web/serializers/requirement.rb

@@ -0,0 +1,18 @@
+require_relative 'serializer'
+
+module Inferno
+  module Web
+    module Serializers
+      class Requirement < Serializer
+        identifier :id
+
+        field :requirement
+        field :conformance
+        field :actor
+        field :sub_requirements
+        field :conditionality
+        field :url, if: :field_present?
+      end
+    end
+  end
+end

lib/inferno/config/boot/requirements.rb

@@ -0,0 +1,39 @@
+require_relative '../../repositories/requirements'
+
+Inferno::Application.register_provider(:requirements) do
+  prepare do
+    target_container.start :suites
+
+    requirements_repo = Inferno::Repositories::Requirements.new
+
+    test_kit_gems =
+      Bundler
+        .definition
+        .specs
+        .select { |spec| spec.metadata.fetch('inferno_test_kit', 'false').casecmp? 'true' }
+
+    files_to_load = Dir.glob(['lib/*test_kit/requirements/*.csv'])
+
+    if ENV['LOAD_DEV_SUITES'].present?
+      ENV['LOAD_DEV_SUITES'].split(',').map(&:strip).reject(&:empty?).each do |suite|
+        files_to_load.concat Dir.glob(File.join(Inferno::Application.root, 'dev_suites', suite, 'requirements',
+                                                '*.csv'))
+      end
+    end
+
+    files_to_load +=
+      test_kit_gems.flat_map do |gem|
+        [
+          Dir.glob([File.join(gem.full_gem_path, 'lib', '*test_kit', 'requirements', '*.csv')])
+        ].flatten
+      end
+
+    files_to_load.compact!
+    files_to_load.uniq!
+    files_to_load.map! { |path| File.realpath(path) }
+
+    files_to_load.each do |path|
+      requirements_repo.insert_from_file(path)
+    end
+  end
+end

lib/inferno/dsl/runnable.rb

@@ -258,6 +258,21 @@ def input_instructions(new_input_instructions = nil)
         @input_instructions = format_markdown(new_input_instructions)
       end
 
+      # 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
+
       # Mark as optional. Tests are required by default.
       #
       # @param optional [Boolean]

lib/inferno/entities/requirement.rb

@@ -0,0 +1,25 @@
+require_relative 'attributes'
+require_relative 'entity'
+
+module Inferno
+  module Entities
+    # A `Requirement` represents the specific rule or behavior a runnable is testing.
+    class Requirement < Entity
+      ATTRIBUTES = [
+        :id,
+        :url,
+        :requirement,
+        :conformance,
+        :actor,
+        :sub_requirements,
+        :conditionality
+      ].freeze
+
+      include Inferno::Entities::Attributes
+
+      def initialize(params)
+        super(params, ATTRIBUTES)
+      end
+    end
+  end
+end

lib/inferno/repositories/requirements.rb

@@ -0,0 +1,53 @@
+require 'csv'
+require_relative 'in_memory_repository'
+require_relative '../entities/requirement'
+
+module Inferno
+  module Repositories
+    # Repository that deals with persistence for the `Requirement` entity.
+    class Requirements < InMemoryRepository
+      def insert_from_file(path) # rubocop:disable Metrics/CyclomaticComplexity
+        result = []
+
+        CSV.foreach(path, headers: true, header_converters: :symbol) do |row|
+          req_set = row[:req_set]
+          id = row[:id]
+          sub_requirements_field = row[:subrequirements]
+
+          combined_id = "#{req_set}@#{id}"
+
+          # Processing sub requirements: e.g. "170.315(g)(31)_hti-2-proposal@5,17,23,26,27,32,35,38-41"
+          sub_requirements = if sub_requirements_field.nil? || sub_requirements_field.strip.blank?
+                               []
+                             else
+                               base, ids = sub_requirements_field.split('@')
+                               ids.split(',').flat_map do |item|
+                                 if item.include?('-')
+                                   start_range, end_range = item.split('-').map(&:to_i)
+                                   (start_range..end_range).map { |num| "#{base}@#{num}" }
+                                 else
+                                   "#{base}@#{item}"
+                                 end
+                               end
+                             end
+
+          result << {
+            id: combined_id,
+            url: row[:url],
+            requirement: row[:requirement],
+            conformance: row[:conformance],
+            actor: row[:actor],
+            sub_requirements: sub_requirements,
+            conditionality: row[:conditionality]&.downcase
+          }
+        end
+
+        result.each do |raw_req|
+          requirement = Entities::Requirement.new(raw_req)
+
+          insert(requirement)
+        end
+      end
+    end
+  end
+end

spec/fixtures/simple_requirements.csv

@@ -0,0 +1,3 @@
+Req Set,ID,URL,Requirement,Conformance,Actor,Sub-Requirement(s),Conditionality
+sample-criteria,1,,requirement,SHALL,Client,sample-criteria@2,FALSE
+sample-criteria,2,,requirement,SHALL,Client,,FALSE

spec/inferno/repositories/requirements_spec.rb

@@ -0,0 +1,39 @@
+RSpec.describe Inferno::Repositories::Requirements do
+  subject(:requirements) { described_class.new }
+
+  describe '#insert_from_file' do
+    let(:csv) do
+      File.realpath(File.join(Dir.pwd, 'spec/fixtures/simple_requirements.csv'))
+    end
+    let(:req_one) do
+      Inferno::Entities::Requirement.new(
+        {
+          id: 'sample-criteria@1',
+          requirement: 'requirement',
+          conformance: 'SHALL',
+          actor: 'Client',
+          sub_requirements: ['sample-criteria@2'],
+          conditionality: 'false'
+        }
+      )
+    end
+    let(:req2) do
+      Inferno::Entities::Requirement.new(
+        {
+          id: 'sample-criteria@2',
+          requirement: 'requirement',
+          conformance: 'SHALL',
+          actor: 'Client',
+          sub_requirements: [],
+          conditionality: 'false'
+        }
+      )
+    end
+
+    it 'creates and inserts all requirements from the csv file' do
+      expect { requirements.insert_from_file(csv) }.to change { requirements.all.size }.by(2)
+      expect(requirements.find(req_one.id).to_hash).to eq(req_one.to_hash)
+      expect(requirements.find(req2.id).to_hash).to eq(req2.to_hash)
+    end
+  end
+end