FI-2748: Add TestKit to template

lib/inferno/apps/cli/templates/%library_name%.gemspec.tt

@@ -1,11 +1,15 @@
+require_relative 'lib/<%= library_name %>/version'
+
 Gem::Specification.new do |spec|
   spec.name          = '<%= library_name %>'
-  spec.version       = '0.0.1'
+  spec.version       = <%= module_name %>::VERSION
   spec.authors       = <%= authors %>
   # spec.email         = ['TODO']
   spec.date          = Time.now.utc.strftime('%Y-%m-%d')
-  spec.summary       = '<%= title_name %> Test Kit'
-  spec.description   = '<%= human_name %> Inferno test kit for FHIR'
+  spec.summary       = '<%= title_name %>'
+  # spec.description   = <<~DESCRIPTION
+  #   This is a big markdown description of the test kit.
+  # DESCRIPTION
   # spec.homepage      = 'TODO'
   spec.license       = 'Apache-2.0'
   spec.add_runtime_dependency 'inferno_core', '~> <%= Inferno::VERSION %>'

lib/inferno/apps/cli/templates/Dockerfile.tt

@@ -6,12 +6,13 @@ RUN mkdir -p $INSTALL_PATH
 
 WORKDIR $INSTALL_PATH
 
+ADD lib/<%= library_name %>/metadata.rb $INSTALL_PATH/lib/<%= library_name %>/metadata.rb
 ADD *.gemspec $INSTALL_PATH
 ADD Gemfile* $INSTALL_PATH
 RUN gem install bundler
-# The below RUN line is commented out for development purposes, because any change to the 
+# The below RUN line is commented out for development purposes, because any change to the
 # required gems will break the dockerfile build process.
-# If you want to run in Deploy mode, just run `bundle install` locally to update 
+# If you want to run in Deploy mode, just run `bundle install` locally to update
 # Gemfile.lock, and uncomment the following line.
 # RUN bundle config set --local deployment 'true'
 RUN bundle install

lib/inferno/apps/cli/templates/lib/%library_name%.rb.tt

@@ -1,58 +1 @@
-require_relative '<%= library_name %>/patient_group'
-
-module <%= module_name %>
-  class Suite < Inferno::TestSuite
-    id :<%= test_suite_id %>
-    title '<%= title_name %> Test Suite'
-    description '<%= human_name %> test suite.'
-
-    # These inputs will be available to all tests in this suite
-    input :url,
-          title: 'FHIR Server Base Url'
-
-    input :credentials,
-          title: 'OAuth Credentials',
-          type: :oauth_credentials,
-          optional: true
-
-    # All FHIR requests in this suite will use this FHIR client
-    fhir_client do
-      url :url
-      oauth_credentials :credentials
-    end
-
-    # All FHIR validation requests will use this FHIR validator
-    fhir_resource_validator do
-      # igs 'identifier#version' # Use this method for published IGs/versions
-      # igs 'igs/filename.tgz'   # Use this otherwise
-
-      exclude_message do |message|
-        message.message.match?(/\A\S+: \S+: URL value '.*' does not resolve/)
-      end
-    end
-
-    # Tests and TestGroups can be defined inline
-    group do
-      id :capability_statement
-      title 'Capability Statement'
-      description 'Verify that the server has a CapabilityStatement'
-
-      test do
-        id :capability_statement_read
-        title 'Read CapabilityStatement'
-        description 'Read CapabilityStatement from /metadata endpoint'
-
-        run do
-          fhir_get_capability_statement
-
-          assert_response_status(200)
-          assert_resource_type(:capability_statement)
-        end
-      end
-    end
-
-    # Tests and TestGroups can be written in separate files and then included
-    # using their id
-    group from: :patient_group
-  end
-end
+require_relative '<%= library_name %>/suite'

lib/inferno/apps/cli/templates/lib/%library_name%/metadata.rb.tt

@@ -0,0 +1,18 @@
+require_relative 'version'
+
+module <%= module_name %>
+  class Metadata < Inferno::TestKit
+    id :<%= test_kit_id %>
+    title '<%= title_name %>'
+    description <<~DESCRIPTION
+      This is a big markdown description of the test kit.
+    DESCRIPTION
+    suite_ids [:<%= test_suite_id %>]
+    # tags ['SMART App Launch', 'US Core']
+    # last_updated '2024-03-07'
+    version VERSION
+    maturity 'Low'
+    authors <%= authors %>
+    # repo 'TODO'
+  end
+end

lib/inferno/apps/cli/templates/lib/%library_name%/suite.rb.tt

@@ -0,0 +1,59 @@
+require_relative 'metadata'
+require_relative 'patient_group'
+
+module <%= module_name %>
+  class Suite < Inferno::TestSuite
+    id :<%= test_suite_id %>
+    title '<%= title_name %> Test Suite'
+    description '<%= human_name %> test suite.'
+
+    # These inputs will be available to all tests in this suite
+    input :url,
+          title: 'FHIR Server Base Url'
+
+    input :credentials,
+          title: 'OAuth Credentials',
+          type: :oauth_credentials,
+          optional: true
+
+    # All FHIR requests in this suite will use this FHIR client
+    fhir_client do
+      url :url
+      oauth_credentials :credentials
+    end
+
+    # All FHIR validation requests will use this FHIR validator
+    fhir_resource_validator do
+      # igs 'identifier#version' # Use this method for published IGs/versions
+      # igs 'igs/filename.tgz'   # Use this otherwise
+
+      exclude_message do |message|
+        message.message.match?(/\A\S+: \S+: URL value '.*' does not resolve/)
+      end
+    end
+
+    # Tests and TestGroups can be defined inline
+    group do
+      id :capability_statement
+      title 'Capability Statement'
+      description 'Verify that the server has a CapabilityStatement'
+
+      test do
+        id :capability_statement_read
+        title 'Read CapabilityStatement'
+        description 'Read CapabilityStatement from /metadata endpoint'
+
+        run do
+          fhir_get_capability_statement
+
+          assert_response_status(200)
+          assert_resource_type(:capability_statement)
+        end
+      end
+    end
+
+    # Tests and TestGroups can be written in separate files and then included
+    # using their id
+    group from: :patient_group
+  end
+end

lib/inferno/apps/cli/templates/lib/%library_name%/version.rb.tt

@@ -0,0 +1,3 @@
+module <%= module_name %>
+  VERSION = '0.0.0'.freeze
+end

lib/inferno/entities.rb

@@ -8,6 +8,7 @@
 require_relative 'entities/session_data'
 require_relative 'entities/test'
 require_relative 'entities/test_group'
+require_relative 'entities/test_kit'
 require_relative 'entities/test_run'
 require_relative 'entities/test_session'
 require_relative 'entities/test_suite'

lib/inferno/entities/test_kit.rb

@@ -6,7 +6,7 @@ module Entities
     # @example
     #
     #   module USCoreTestKit
-    #     class TestKit < Inferno::Entities::TestKit
+    #     class Metadata < Inferno::Entities::TestKit
     #       id :us_core
     #       title 'US Core Test Kit'
     #       description <<~DESCRIPTION
@@ -156,7 +156,7 @@ def add_self_to_repository
 
         # @private
         def repository
-          @repository ||= Inferno::Repositories::TestKits
+          @repository ||= Inferno::Repositories::TestKits.new
         end
 
         # @private
@@ -168,4 +168,6 @@ def copy_instance_variables
       end
     end
   end
+
+  TestKit = Entities::TestKit
 end

lib/inferno/entities/test_suite.rb

@@ -84,15 +84,16 @@ def reference_hash
           }
         end
 
-        # Set/get the version of this test suite.
+        # Set/get the version of this test suite. Defaults to the TestKit
+        # version.
         #
         # @param version [String]
         #
         # @return [String, nil]
         def version(version = nil)
-          return @version if version.nil?
+          @version = version if version.present?
 
-          @version = version
+          @version || test_kit&.version
         end
 
         # @private
@@ -186,6 +187,25 @@ def suite_summary(suite_summary = nil)
 
           @suite_summary = format_markdown(suite_summary)
         end
+
+        # Get the TestKit this suite belongs to
+        #
+        # @return [Inferno::Entities::TestKit]
+        def test_kit
+          return @test_kit if @test_kit
+
+          module_name = name
+
+          while module_name.present? && @test_kit.nil?
+            module_name = module_name.deconstantize
+
+            next unless const_defined?("#{module_name}::Metadata")
+
+            @test_kit = const_get("#{module_name}::Metadata")
+          end
+
+          @test_kit
+        end
       end
     end
   end

lib/inferno/utils/named_thor_actions.rb

@@ -25,8 +25,12 @@ def title_name
         human_name.split.map(&:capitalize).join(' ')
       end
 
+      def test_kit_id
+        library_name.delete_suffix('_test_kit')
+      end
+
       def test_suite_id
-        "#{library_name}_test_suite"
+        test_kit_id
       end
     end
   end

spec/inferno/cli/new_spec.rb

@@ -31,12 +31,10 @@
       expect(File).to exist('test-fhir-app/test_fhir_app.gemspec')
       expect(File).to exist('test-fhir-app/lib/test_fhir_app.rb')
 
-      if cli_args.include? '--author'
-        expect(File.read('test-fhir-app/test_fhir_app.gemspec')).to match(/authors\s*=.*ABC/)
-      end
-
-      if cli_args.count('--author') == 2
-        expect(File.read('test-fhir-app/test_fhir_app.gemspec')).to match(/authors\s*=.*ABC.*DEF/)
+      if cli_args.count('--author') == 1
+        expect(File.read('test-fhir-app/lib/test_fhir_app/metadata.rb')).to include('authors ["ABC"]')
+      elsif cli_args.count('--author') == 2
+        expect(File.read('test-fhir-app/lib/test_fhir_app/metadata.rb')).to include('authors ["ABC", "DEF"]')
       end
 
       if cli_args.count('--implementation-guide') == 1