inferno_core 0.5.4 → 0.6.0

data/lib/inferno/route_storage.rb

@@ -0,0 +1,10 @@
+module Inferno
+  # @private
+  module RouteStorage
+    def routes
+      @routes ||= []
+    end
+  end
+
+  extend RouteStorage
+end

data/lib/inferno/spec_support.rb

@@ -7,11 +7,13 @@ module Inferno
     FACTORY_PATH = File.expand_path('../../spec/factories', __dir__).freeze
     REQUEST_HELPER_PATH = File.expand_path('../../spec/request_helper', __dir__).freeze
     RUNNABLE_HELPER_PATH = File.expand_path('../../spec/runnable_helper', __dir__).freeze
+    TEST_KIT_SPEC = File.expand_path('../../spec/shared/test_kit_examples', __dir__).freeze
 
     def self.require_helpers
       require FACTORY_BOT_SUPPORT_PATH
       require RUNNABLE_HELPER_PATH
       require REQUEST_HELPER_PATH
+      require TEST_KIT_SPEC
     end
   end
 end

data/lib/inferno/version.rb

@@ -1,4 +1,4 @@
 module Inferno
   # Standard patterns for gem versions: https://guides.rubygems.org/patterns/
-  VERSION = '0.5.4'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/lib/inferno.rb

@@ -1,7 +1,4 @@
 module Inferno
-  def self.routes
-    @routes ||= []
-  end
 end
 
 require_relative 'inferno/config/application'
@@ -14,3 +11,4 @@ require_relative 'inferno/spec_support'
 require_relative 'inferno/test_runner'
 require_relative 'inferno/version'
 require_relative 'inferno/utils/static_assets'
+require_relative 'inferno/route_storage'

data/spec/shared/test_kit_examples.rb

@@ -0,0 +1,133 @@
+RSpec.shared_examples 'platform_deployable_test_kit' do
+  let(:test_kit_location) do
+    Object.const_source_location(described_class.name).first
+  end
+  let(:test_kit_gem) do
+    Bundler.definition.specs.find { |gem| test_kit_location.start_with? gem.full_gem_path }
+  end
+  let(:base_path) do
+    test_kit_gem.full_gem_path
+  end
+  let(:test_kit) do
+    described_class.const_get('Metadata')
+  rescue NameError
+    skip 'TestKit must be defined first'
+  end
+  let(:suites) do
+    test_kit.suite_ids.map { |id| Inferno::Repositories::TestSuites.new.find(id) }
+  end
+
+  describe 'TestKit' do
+    it 'defines test kit in the Metadata class' do
+      error_message =
+        "Define #{described_class.name}::Metadata at " \
+        "lib/#{described_class.name.underscore}/metadata.rb and require it in " \
+        "lib/#{described_class.name.underscore}.rb\n"
+
+      expect { described_class.const_get('Metadata') }.to_not raise_error(NameError), error_message
+
+      expect(described_class.const_get('Metadata') < Inferno::Entities::TestKit).to be(true)
+    end
+
+    it 'defines all required fields' do
+      required_fields = [
+        :id,
+        :title,
+        :description,
+        :suite_ids,
+        :version,
+        :maturity
+      ]
+
+      required_fields.each do |field_name|
+        expect(test_kit.send(field_name)).to be_present
+      end
+    end
+
+    it 'has a description with a <!-- break -->' do
+      error_message =
+        'The test kit description must begin with one paragraph followed by "<!-- ' \
+        'break -->". The portion of the description above the break is displayed ' \
+        "on the test kit listing page.\n"
+
+      expect(test_kit.description).to include('<!-- break -->'), error_message
+    end
+
+    it 'has a maturity of "Low", "Medium", or "High"' do
+      expect(['Low', 'Medium', 'High']).to include(test_kit.maturity) # rubocop:disable RSpec/ExpectActual
+    end
+
+    it 'uses the correct ruby version in its Dockerfile' do
+      dockerfile_path = File.join(base_path, 'Dockerfile')
+      dockerfile_contents = File.read(dockerfile_path)
+
+      expect(dockerfile_contents.lines.first.chomp).to eq('FROM ruby:3.3.6')
+    end
+  end
+
+  describe 'suites' do
+    it 'relies on the test kit version rather than defining the version in the suites' do
+      suite_paths = suites.map { |suite| Object.const_source_location(suite.name).first }
+      suite_contents = suite_paths.map { |path| File.read(path) }
+
+      suite_contents.each_with_index do |suite, i|
+        error_message =
+          "Suite at #{suite_paths[i]} should not explicitly declare a version, as " \
+          'its version can now be determined by the version of its Test Kit.' \
+          "Remove the `version` method call in the suite definition.\n"
+
+        expect(suite).to_not match(/^\s+version(\s|\()\S+\)?/), error_message
+      end
+    end
+
+    it 'contains standard links' do
+      suites.each do |suite|
+        link_labels = suite.links.map { |link| link[:label] }
+
+        expected_labels = ['Report Issue', 'Open Source', 'Download']
+
+        error_message =
+          "Include the standard 'Report Issue', 'Open Source', and 'Download links in " \
+          'each suite.\n'
+        expect(link_labels).to match_array(expected_labels), error_message
+      end
+    end
+  end
+
+  describe 'presets' do
+    it 'includes presets in the gem' do
+      presets = Dir[
+        File.join(base_path, 'config', 'presets', '*.json'),
+        File.join(base_path, 'config', 'presets', '*.json.erb')
+      ].map { |file_path| file_path.delete_prefix "#{Dir.pwd}/" }
+
+      missing_presets = presets - test_kit_gem.files
+
+      error_message =
+        "The following presets are not included in the gem: #{missing_presets.join(', ')}\n" \
+        "Ensure that config/presets is included in spec.files in #{test_kit_gem.name}.gemspec"
+
+      expect(missing_presets).to be_empty, error_message
+    end
+  end
+
+  describe 'gemspec' do
+    it 'uses git to determine files to include in the gem' do
+      gemspec_contents = File.read(File.join(base_path, "#{test_kit_gem.name}.gemspec"))
+
+      error_message =
+        'Use git to determine which files to include in the gem. In ' \
+        "#{test_kit_gem.name}.gemspec, use: " \
+        "spec.files = `[ -d .git ] && git ls-files -z lib config/presets LICENSE`.split(\"\\x0\")\n"
+
+      expect(gemspec_contents).to include('[ -d .git ] && git ls-files'), error_message
+    end
+
+    it 'includes the inferno test kit metadata tag' do
+      error_message =
+        %(Add "spec.metadata['inferno_test_kit'] = 'true'" to #{test_kit_gem.name}.gemspec)
+
+      expect(test_kit_gem.metadata['inferno_test_kit']).to eq('true'), error_message
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inferno_core
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Stephen MacVicar
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-19 00:00:00.000000000 Z
+date: 2025-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -412,6 +412,7 @@ files:
 - lib/inferno/apps/cli/templates/.env.test
 - lib/inferno/apps/cli/templates/.gitignore
 - lib/inferno/apps/cli/templates/.rspec
+- lib/inferno/apps/cli/templates/.rubocop.yml
 - lib/inferno/apps/cli/templates/.ruby-version
 - lib/inferno/apps/cli/templates/.tool-versions
 - lib/inferno/apps/cli/templates/Dockerfile.tt
@@ -586,6 +587,7 @@ files:
 - lib/inferno/repositories/validator_sessions.rb
 - lib/inferno/result_collection.rb
 - lib/inferno/result_summarizer.rb
+- lib/inferno/route_storage.rb
 - lib/inferno/spec_support.rb
 - lib/inferno/test_runner.rb
 - lib/inferno/utils/ig_downloader.rb
@@ -614,6 +616,7 @@ files:
 - spec/request_helper.rb
 - spec/runnable_context.rb
 - spec/runnable_helper.rb
+- spec/shared/test_kit_examples.rb
 - spec/spec_helper.rb
 - spec/support/factory_bot.rb
 homepage: https://github.com/inferno-framework/inferno-core
@@ -632,14 +635,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: 3.1.2
+      version: 3.3.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Inferno Core is an open source tool for testing data exchanges enabled by