FI-2701: Migrate to HL7 validator wrapper (#4)

* FI-2701: migrate to HL7 validator wrapper

* missed a couple things

* Update profile/version logic

* rubocop fixes

* Update resources to remove relative links

* update lockfile and dockerfile fix

* update lockfile again after rebase

.env.development

@@ -1,2 +1,3 @@
-VALIDATOR_URL=http://localhost/validatorapi
-REDIS_URL=redis://localhost:6379/0
+FHIR_RESOURCE_VALIDATOR_URL=http://localhost/hl7validatorapi
+REDIS_URL=redis://localhost:6379/0
+FHIRPATH_URL=http://localhost/fhirpath

.env.production

@@ -1,3 +1,4 @@
 REDIS_URL=redis://redis:6379/0
-VALIDATOR_URL=http://validator_service:4567
-INFERNO_HOST=http://localhost
+FHIR_RESOURCE_VALIDATOR_URL=http://hl7_validator_service:3500
+INFERNO_HOST=http://localhost
+FHIRPATH_URL=http://fhirpath:6789

.env.test

@@ -1,2 +1,3 @@
-VALIDATOR_URL=https://example.com/validatorapi
+FHIR_RESOURCE_VALIDATOR_URL=https://example.com/validatorapi
+FHIRPATH_URL=https://example.com/fhirpath
 ASYNC_JOBS=false

Dockerfile

@@ -9,6 +9,7 @@ WORKDIR $INSTALL_PATH
 ADD *.gemspec $INSTALL_PATH
 ADD Gemfile* $INSTALL_PATH
 ADD lib/davinci_pas_test_kit/version.rb $INSTALL_PATH/lib/davinci_pas_test_kit/version.rb
+RUN gem update --system
 RUN gem install bundler
 # The below RUN line is commented out for development purposes, because any change to the 
 # required gems will break the dockerfile build process.

Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     davinci_pas_test_kit (0.9.3)
-      inferno_core (~> 0.4.34)
+      inferno_core (~> 0.4.37)
 
 GEM
   remote: https://rubygems.org/
@@ -134,7 +134,7 @@ GEM
       domain_name (~> 0.5)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    inferno_core (0.4.38)
+    inferno_core (0.4.39)
       activesupport (~> 6.1.7.5)
       base62-rb (= 0.3.1)
       blueprinter (= 0.25.2)
@@ -165,7 +165,7 @@ GEM
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     json (2.7.2)
-    jwt (2.8.1)
+    jwt (2.8.2)
       base64
     kramdown (2.4.0)
       rexml
@@ -187,14 +187,14 @@ GEM
       mustermann (= 1.1.2)
     netrc (0.11.0)
     nio4r (2.7.3)
-    nokogiri (1.16.5)
+    nokogiri (1.16.6)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.16.5-arm64-darwin)
+    nokogiri (1.16.6-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.5-x86_64-darwin)
+    nokogiri (1.16.6-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.5-x86_64-linux)
+    nokogiri (1.16.6-x86_64-linux)
       racc (~> 1.4)
     oauth2 (1.4.11)
       faraday (>= 0.17.3, < 3.0)
@@ -238,7 +238,7 @@ GEM
       netrc (~> 0.8)
     rexml (3.2.8)
       strscan (>= 3.0.9)
-    rouge (4.2.1)
+    rouge (4.3.0)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)

config/nginx.background.conf

@@ -53,7 +53,38 @@ http {
     # the server will close connections after this time
     keepalive_timeout 600;
 
-    location /validator {
+#    location /validator {
+#      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+#      proxy_set_header Host $http_host;
+#      proxy_set_header X-Forwarded-Proto $scheme;
+#      proxy_set_header X-Forwarded-Port $server_port;
+#      proxy_redirect off;
+#      proxy_set_header Connection '';
+#      proxy_http_version 1.1;
+#      chunked_transfer_encoding off;
+#      proxy_buffering off;
+#      proxy_cache off;
+#
+#      proxy_pass http://fhir_validator_app;
+#    }
+
+#    location /validatorapi/ {
+#      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+#      proxy_set_header Host $http_host;
+#      proxy_set_header X-Forwarded-Proto $scheme;
+#      proxy_set_header X-Forwarded-Port $server_port;
+#      proxy_redirect off;
+#      proxy_set_header Connection '';
+#      proxy_http_version 1.1;
+#      chunked_transfer_encoding off;
+#      proxy_buffering off;
+#      proxy_cache off;
+#
+#      proxy_pass http://validator_service:4567/;
+#    }
+#  }
+
+    location /hl7validatorapi/ {
       proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
       proxy_set_header Host $http_host;
       proxy_set_header X-Forwarded-Proto $scheme;
@@ -64,11 +95,12 @@ http {
       chunked_transfer_encoding off;
       proxy_buffering off;
       proxy_cache off;
+      proxy_read_timeout 600s;
 
-      proxy_pass http://fhir_validator_app;
+      proxy_pass http://hl7_validator_service:3500/;
     }
 
-    location /validatorapi/ {
+    location /fhirpath/ {
       proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
       proxy_set_header Host $http_host;
       proxy_set_header X-Forwarded-Proto $scheme;
@@ -80,7 +112,7 @@ http {
       proxy_buffering off;
       proxy_cache off;
 
-      proxy_pass http://validator_service:4567/;
+      proxy_pass http://fhirpath:6789/;
     }
   }
 }

config/nginx.conf

@@ -68,7 +68,37 @@ http {
       proxy_pass http://inferno:4567;
     }
 
-    location /validator {
+#    location /validator {
+#      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+#      proxy_set_header Host $http_host;
+#      proxy_set_header X-Forwarded-Proto $scheme;
+#      proxy_set_header X-Forwarded-Port $server_port;
+#      proxy_redirect off;
+#      proxy_set_header Connection '';
+#      proxy_http_version 1.1;
+#      chunked_transfer_encoding off;
+#      proxy_buffering off;
+#      proxy_cache off;
+#
+#      proxy_pass http://fhir_validator_app;
+#    }
+
+#    location /validatorapi/ {
+#      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+#      proxy_set_header Host $http_host;
+#      proxy_set_header X-Forwarded-Proto $scheme;
+#      proxy_set_header X-Forwarded-Port $server_port;
+#      proxy_redirect off;
+#      proxy_set_header Connection '';
+#      proxy_http_version 1.1;
+#      chunked_transfer_encoding off;
+#      proxy_buffering off;
+#      proxy_cache off;
+#
+#      proxy_pass http://validator_service:4567/;
+#    }
+
+    location /hl7validatorapi/ {
       proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
       proxy_set_header Host $http_host;
       proxy_set_header X-Forwarded-Proto $scheme;
@@ -79,23 +109,9 @@ http {
       chunked_transfer_encoding off;
       proxy_buffering off;
       proxy_cache off;
+      proxy_read_timeout 600s;
 
-      proxy_pass http://fhir_validator_app;
-    }
-
-    location /validatorapi/ {
-      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-      proxy_set_header Host $http_host;
-      proxy_set_header X-Forwarded-Proto $scheme;
-      proxy_set_header X-Forwarded-Port $server_port;
-      proxy_redirect off;
-      proxy_set_header Connection '';
-      proxy_http_version 1.1;
-      chunked_transfer_encoding off;
-      proxy_buffering off;
-      proxy_cache off;
-
-      proxy_pass http://validator_service:4567/;
+      proxy_pass http://hl7_validator_service:3500/;
     }
   }
 }

davinci_pas_test_kit.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Inferno Test Kit for the Da Vinci Prior Authorization Support IG'
   spec.homepage      = 'https://github.com/inferno-framework/davinci-pas-test-kit'
   spec.license       = 'Apache-2.0'
-  spec.add_runtime_dependency 'inferno_core', '~> 0.4.34'
+  spec.add_runtime_dependency 'inferno_core', '~> 0.4.37'
   spec.add_development_dependency 'database_cleaner-sequel', '~> 1.8'
   spec.add_development_dependency 'factory_bot', '~> 6.1'
   spec.add_development_dependency 'rspec', '~> 3.10'

docker-compose.background.yml

@@ -1,17 +1,32 @@
 version: '3'
 services:
-  validator_service:
-    image: infernocommunity/fhir-validator-service
-    # Update this path to match your directory structure
-    volumes:
-      - ./lib/davinci_pas_test_kit/igs:/home/igs
-  fhir_validator_app:
-    image: infernocommunity/fhir-validator-app
-    depends_on:
-      - validator_service
+  hl7_validator_service:
+    image: infernocommunity/inferno-resource-validator
     environment:
-      EXTERNAL_VALIDATOR_URL: http://localhost/validatorapi
-      VALIDATOR_BASE_PATH: /validator
+      # Defines how long validator sessions last if unused, in minutes:
+      # Negative values mean sessions never expire, 0 means sessions immediately expire
+      SESSION_CACHE_DURATION: -1
+    volumes:
+      - ./lib/davinci_pas_test_kit/igs:/app/igs
+      # To let the service share your local FHIR package cache,
+      # uncomment the below line
+      # - ~/.fhir:/home/ktor/.fhir
+  # validator_service:
+  #   image: infernocommunity/fhir-validator-service
+  #   # Update this path to match your directory structure
+  #   volumes:
+  #     - ./lib/davinci_pas_test_kit/igs:/home/igs
+  # fhir_validator_app:
+  #   image: infernocommunity/fhir-validator-app
+  #   depends_on:
+  #     - validator_service
+  #   environment:
+  #     EXTERNAL_VALIDATOR_URL: http://localhost/validatorapi
+  #     VALIDATOR_BASE_PATH: /validator
+  fhirpath:
+    image: infernocommunity/fhirpath-service
+    ports:
+      - "6789:6789"
   nginx:
     image: nginx
     volumes:
@@ -20,7 +35,8 @@ services:
       - "80:80"
     command: [nginx, '-g', 'daemon off;']
     depends_on:
-      - fhir_validator_app
+      - hl7_validator_service
+      - fhirpath
   redis:
     image: redis
     ports:

docker-compose.yml

@@ -6,7 +6,7 @@ services:
     volumes:
       - ./data:/opt/inferno/data
     depends_on:
-      - validator_service
+      - hl7_validator_service
   worker:
     build:
       context: ./
@@ -15,14 +15,22 @@ services:
     command: bundle exec sidekiq -r ./worker.rb
     depends_on:
       - redis
-  validator_service:
+  hl7_validator_service:
     extends:
       file: docker-compose.background.yml
-      service: validator_service
-  fhir_validator_app:
+      service: hl7_validator_service
+  # validator_service:
+  #   extends:
+  #     file: docker-compose.background.yml
+  #     service: validator_service
+  # fhir_validator_app:
+  #   extends:
+  #     file: docker-compose.background.yml
+  #     service: fhir_validator_app
+  fhirpath:
     extends:
       file: docker-compose.background.yml
-      service: fhir_validator_app
+      service: fhirpath
   nginx:
     extends:
       file: docker-compose.background.yml

lib/davinci_pas_test_kit/client_suite.rb

@@ -41,8 +41,8 @@ def self.test_resumes?(test)
       !test.config.options[:accepts_multiple_requests]
     end
 
-    validator do
-      url ENV.fetch('VALIDATOR_URL')
+    fhir_resource_validator do
+      igs 'hl7.fhir.us.davinci-pas#2.0.1'
 
       exclude_message do |message|
         # Messages expected of the form `<ResourceType>: <FHIRPath>: <message>`

lib/davinci_pas_test_kit/generated/v2.0.1/server_suite.rb

@@ -33,8 +33,8 @@ class ServerSuite < Inferno::TestSuite
         request.query_parameters['use_case']
       end
 
-      validator do
-        url ENV.fetch('VALIDATOR_URL')
+      fhir_resource_validator do
+        igs 'hl7.fhir.us.davinci-pas#2.0.1'
 
         exclude_message do |message|
           # Messages expected of the form `<ResourceType>: <FHIRPath>: <message>`

lib/davinci_pas_test_kit/generator/suite_generator.rb

@@ -48,6 +48,11 @@ def title
         "Da Vinci PAS Server Suite #{ig_metadata.ig_version}"
       end
 
+      def ig_identifier
+        version = ig_metadata.ig_version[1..] # Remove leading 'v'
+        "hl7.fhir.us.davinci-pas##{version}"
+      end
+
       def ig_link
         case ig_metadata.ig_version
         when 'v2.0.1'

lib/davinci_pas_test_kit/generator/templates/suite.rb.erb

@@ -30,8 +30,8 @@ module DaVinciPASTestKit
         request.query_parameters['use_case']
       end
 
-      validator do
-        url ENV.fetch('VALIDATOR_URL')
+      fhir_resource_validator do
+        igs '<%= ig_identifier %>'
 
         exclude_message do |message|
           # Messages expected of the form `<ResourceType>: <FHIRPath>: <message>`

lib/davinci_pas_test_kit/igs/README.md

@@ -0,0 +1,21 @@
+# Note on this IGs folder
+
+There are three reasons why it would be necessary to put an IG package.tgz in this folder. If none of these apply, you do not need to put any files here, or can consider removing any existing files to make it clear they are unused.
+
+## 1. Generated Test Suites
+Some test kits use a "generator" to automatically generate the contents of a test suite for an IG. The IG files are required every time the test suites need to be regenerated. Examples of test kits that use this approach are the US Core Test Kit and CARIN IG for Blue Button® Test Kit.
+
+
+## 2. Non-published IG
+If your IG, or the specific version of the IG you want to test against, is not published, then the validator service needs to load the IG from file in order to be able to validate resources with it. The IG must be referenced in the `fhir_resource_validator` block in the test suite definition by filename, ie:
+
+```ruby
+      fhir_resource_validator do
+        igs 'igs/filename.tgz'
+
+        ...
+      end
+```
+
+## 3. Inferno Validator UI
+The Inferno Validator UI is configured to auto-load any IGs present in the igs folder and include them in all validations. The Inferno Validator UI is currently disabled by default, so this is only relevant if you choose to re-enable it. In general, the Inferno team is currently leaving IGs in this folder even if not otherwise necessary to make it easy to re-enable the validator UI.