bulk_data_test_kit 0.10.0 → 0.11.0

data/lib/bulk_data_test_kit/v2.0.0_client/endpoints/status.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV200Client
+    module Endpoints
+      # Status Endpoint
+      class Status < Inferno::DSL::SuiteEndpoint
+        include URLs
+
+        def test_run_identifier
+          request.get_header('HTTP_AUTHORIZATION')&.split&.last
+        end
+
+        def make_response
+          response.status = 200
+          response.body = response_body.to_json
+          response.format = :json
+        end
+
+        def tags
+          [STATUS_TAG]
+        end
+
+        def response_body
+          {
+            transactionTime: DateTime.now.iso8601,
+            request: kickoff_url,
+            requiresAccessToken: true,
+            output: [{
+              type: 'Patient',
+              url: output_url
+            }],
+            error: []
+          }
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/v2.0.0_client/export_types.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV200Client
+    PATIENT_EXPORT_TYPE = 'Patient'
+    GROUP_EXPORT_TYPE = 'Group'
+    SYSTEM_EXPORT_TYPE = 'System'
+  end
+end

data/lib/bulk_data_test_kit/v2.0.0_client/postman/delete.postman_collection.json

@@ -0,0 +1,133 @@
+{
+	"info": {
+		"name": "Bulk Data Client - Delete",
+		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+	},
+	"item": [
+		{
+			"name": "Kickoff",
+			"event": [
+				{
+					"listen": "test",
+					"script": {
+						"exec": [
+							"pm.test(\"kick-off was accepted\", function () {",
+							"  pm.response.to.have.status(202);",
+							"});",
+							"",
+							"pm.collectionVariables.set(\"status_url\", pm.response.headers.get('Content-Location'));",
+							""
+						],
+						"type": "text/javascript",
+						"packages": {}
+					}
+				}
+			],
+			"request": {
+				"method": "GET",
+				"header": [],
+				"url": {
+					"raw": "{{base_url}}/custom/bulk_data_v200_client/fhir/$export",
+					"host": [
+						"{{base_url}}"
+					],
+					"path": [
+						"custom",
+						"bulk_data_v200_client",
+						"fhir",
+						"$export"
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "Delete",
+			"event": [
+				{
+					"listen": "test",
+					"script": {
+						"exec": [
+							"pm.test(\"export was deleted\", function () {",
+							"  pm.response.to.have.status(202);",
+							"});",
+							""
+						],
+						"type": "text/javascript",
+						"packages": {}
+					}
+				},
+				{
+					"listen": "prerequest",
+					"script": {
+						"exec": [
+							""
+						],
+						"type": "text/javascript",
+						"packages": {}
+					}
+				}
+			],
+			"request": {
+				"method": "DELETE",
+				"header": [],
+				"url": {
+					"raw": "{{status_url}}",
+					"host": [
+						"{{status_url}}"
+					]
+				}
+			},
+			"response": []
+		}
+	],
+	"auth": {
+		"type": "bearer",
+		"bearer": [
+			{
+				"key": "token",
+				"value": "{{access_token}}",
+				"type": "string"
+			}
+		]
+	},
+	"event": [
+		{
+			"listen": "prerequest",
+			"script": {
+				"type": "text/javascript",
+				"packages": {},
+				"exec": [
+					""
+				]
+			}
+		},
+		{
+			"listen": "test",
+			"script": {
+				"type": "text/javascript",
+				"packages": {},
+				"exec": [
+					""
+				]
+			}
+		}
+	],
+	"variable": [
+		{
+			"key": "access_token",
+			"value": "SAMPLE_TOKEN",
+			"type": "string"
+		},
+		{
+			"key": "base_url",
+			"value": "http://localhost:4567",
+			"type": "string"
+		},
+		{
+			"key": "status_url",
+			"value": "",
+			"type": "string"
+		}
+	]
+}

data/lib/bulk_data_test_kit/v2.0.0_client/postman/system_export.postman_collection.json

@@ -0,0 +1,181 @@
+{
+	"info": {
+		"name": "Bulk Data Client - System Export",
+		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+	},
+	"item": [
+		{
+			"name": "Kickoff",
+			"event": [
+				{
+					"listen": "test",
+					"script": {
+						"exec": [
+							"pm.test(\"kick-off was accepted\", function () {",
+							"  pm.response.to.have.status(202);",
+							"});",
+							"",
+							"pm.collectionVariables.set(\"status_url\", pm.response.headers.get('Content-Location'));",
+							""
+						],
+						"type": "text/javascript",
+						"packages": {}
+					}
+				}
+			],
+			"request": {
+				"method": "GET",
+				"header": [],
+				"url": {
+					"raw": "{{base_url}}/custom/bulk_data_v200_client/fhir/$export",
+					"host": [
+						"{{base_url}}"
+					],
+					"path": [
+						"custom",
+						"bulk_data_v200_client",
+						"fhir",
+						"$export"
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "Status",
+			"event": [
+				{
+					"listen": "test",
+					"script": {
+						"exec": [
+							"let responseData = pm.response.json();",
+							"",
+							"pm.test(\"export is complete\", function () {",
+							"  pm.response.to.have.status(200);",
+							"});",
+							"",
+							"pm.collectionVariables.set(\"download_url\", responseData.output[0].url);",
+							""
+						],
+						"type": "text/javascript",
+						"packages": {}
+					}
+				},
+				{
+					"listen": "prerequest",
+					"script": {
+						"exec": [
+							""
+						],
+						"type": "text/javascript",
+						"packages": {}
+					}
+				}
+			],
+			"request": {
+				"method": "GET",
+				"header": [],
+				"url": {
+					"raw": "{{status_url}}",
+					"host": [
+						"{{status_url}}"
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "Download",
+			"event": [
+				{
+					"listen": "test",
+					"script": {
+						"exec": [
+							"pm.test(\"downlaod is successful\", function () {",
+							"  pm.response.to.have.status(200);",
+							"});",
+							""
+						],
+						"type": "text/javascript",
+						"packages": {}
+					}
+				},
+				{
+					"listen": "prerequest",
+					"script": {
+						"exec": [
+							""
+						],
+						"type": "text/javascript",
+						"packages": {}
+					}
+				}
+			],
+			"request": {
+				"method": "GET",
+				"header": [],
+				"url": {
+					"raw": "{{download_url}}",
+					"host": [
+						"{{download_url}}"
+					]
+				}
+			},
+			"response": []
+		}
+	],
+	"auth": {
+		"type": "bearer",
+		"bearer": [
+			{
+				"key": "token",
+				"value": "{{access_token}}",
+				"type": "string"
+			}
+		]
+	},
+	"event": [
+		{
+			"listen": "prerequest",
+			"script": {
+				"type": "text/javascript",
+				"packages": {},
+				"exec": [
+					""
+				]
+			}
+		},
+		{
+			"listen": "test",
+			"script": {
+				"type": "text/javascript",
+				"packages": {},
+				"exec": [
+					""
+				]
+			}
+		}
+	],
+	"variable": [
+		{
+			"key": "access_token",
+			"value": "SAMPLE_TOKEN",
+			"type": "string"
+		},
+		{
+			"key": "base_url",
+			"value": "http://localhost:4567",
+			"type": "string"
+		},
+		{
+			"key": "status_url",
+			"value": "",
+			"type": "string"
+		},
+		{
+			"key": "download_url",
+			"value": "",
+			"type": "string"
+		}
+	]
+}

data/lib/bulk_data_test_kit/v2.0.0_client/tags.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV200Client
+    METADATA_TAG = 'bulk_data_metadata'
+    PATIENT_KICKOFF_TAG = 'bulk_data_kickoff_patient'
+    GROUP_KICKOFF_TAG = 'bulk_data_kickoff_group'
+    SYSTEM_KICKOFF_TAG = 'bulk_data_kickoff_system'
+    STATUS_TAG = 'bulk_data_status'
+    OUTPUT_TAG = 'bulk_data_output'
+    DELETE_TAG = 'bulk_data_delete'
+  end
+end

data/lib/bulk_data_test_kit/v2.0.0_client/urls.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module BulkDataTestKit
+  module BulkDataV200Client
+    RESUME_PASS_PATH = '/resume_pass'
+    BASE_ROUTE = '/fhir'
+    METADATA_ROUTE = "#{BASE_ROUTE}/metadata".freeze
+    PATIENT_KICKOFF_ROUTE = "#{BASE_ROUTE}/:type/$export".freeze
+    GROUP_KICKOFF_ROUTE = "#{BASE_ROUTE}/:type/:group_id/$export".freeze
+    SYSTEM_KICKOFF_ROUTE = "#{BASE_ROUTE}/$export".freeze
+    STATUS_ROUTE = '/status'
+    OUTPUT_ROUTE = '/output/example.ndjson'
+
+    # URLs for use in Bulk Data Client tests and endpoints
+    module URLs
+      def base_url
+        "#{Inferno::Application['base_url']}/custom/#{suite_id}"
+      end
+
+      def resume_pass_url
+        base_url + RESUME_PASS_PATH
+      end
+
+      def kickoff_url
+        base_url + BASE_ROUTE
+      end
+
+      def status_url
+        base_url + STATUS_ROUTE
+      end
+
+      def output_url
+        base_url + OUTPUT_ROUTE
+      end
+
+      def suite_id
+        if respond_to?('result') # If being used with a suite endpoint
+          result.test_id.split('-').first
+        elsif self.class.respond_to?('suite') # If being used with a test/group/suite
+          self.class.suite.id
+        end
+      end
+    end
+  end
+end

data/lib/bulk_data_test_kit/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module BulkDataTestKit
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'        
+  LAST_UPDATED = '2025-02-24'
 end

data/lib/bulk_data_test_kit.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
-
+require_relative 'bulk_data_test_kit/metadata.rb'
+require_relative 'inferno_requirements_tools/ext/inferno_core/runnable'
 require_relative 'bulk_data_test_kit/v1.0.1/bulk_data_test_suite'
 require_relative 'bulk_data_test_kit/v2.0.0/bulk_data_test_suite'
+require_relative 'bulk_data_test_kit/v2.0.0_client/bulk_data_client_test_suite'

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/rake/rakefile_template

@@ -0,0 +1,37 @@
+namespace :requirements do
+  desc 'Generate requirements coverage CSV'
+  task :generate_coverage do
+    require 'inferno'
+    Inferno::Application.start(:suites)
+
+    require_relative 'lib/inferno_requirements_tools/tasks/requirements_coverage'
+    InfernoRequirementsTools::Tasks::RequirementsCoverage.new.run
+  end
+end
+
+namespace :requirements do
+  desc 'Check if requirements coverage CSV is up-to-date'
+  task :check_coverage do
+    require 'inferno'
+    Inferno::Application.start(:suites)
+
+    require_relative 'lib/inferno_requirements_tools/tasks/requirements_coverage'
+    InfernoRequirementsTools::Tasks::RequirementsCoverage.new.run_check
+  end
+end
+
+namespace :requirements do
+  desc 'Collect requirements and planned not tested requirements into CSVs'
+  task :collect, [:input_directory] => [] do |_t, args|
+    require_relative 'lib/inferno_requirements_tools/tasks/collect_requirements'
+    InfernoRequirementsTools::Tasks::CollectRequirements.new.run(args.input_directory)
+  end
+end
+
+namespace :requirements do
+  desc 'Check if requirements and planned not tested CSVs are up-to-date'
+  task :check_collection, [:input_directory] => [] do |_t, args|
+    require_relative 'lib/inferno_requirements_tools/tasks/collect_requirements'
+    InfernoRequirementsTools::Tasks::CollectRequirements.new.run_check(args.input_directory)
+  end
+end