Merge pull request #89 from bryantaustin13/AddSkipMessage

Add skip message to results output file and console

Author: brynrhodes

package.json

@@ -13,6 +13,8 @@
         "dev": "tsc --watch",
         "test": "vitest run test/",
         "test:cql": "node --import tsx src/bin/cql-tests.ts run-tests conf/localhost.json ./results",
+        "cql-run-tests:dev": "tsx src/bin/cql-tests.ts run-tests conf/development.json ./results",
+	    "cql-run-tests:local": "tsx src/bin/cql-tests.ts run-tests conf/localhost.json ./local_results",
         "build-libs": "npm run build && node dist/bin/cql-tests.js build-cql conf/localhost.json ./cql",
         "unit-tests": "vitest run test/",
         "clean": "rm -rf dist",
@@ -50,4 +52,4 @@
         "typescript": "^6.0.2",
         "vitest": "^4.1.2"
     }
-}
+}

src/models/test-types.ts

@@ -63,6 +63,7 @@ export interface CapabilityKV {
 // Internal Result type used during test execution (allows 'undefined' for invalid)
 export interface InternalTestResult {
 	testStatus?: 'pass' | 'fail' | 'skip' | 'error';
+	skipMessage?: string;
 	responseStatus?: number;
 	actual?: any;
 	expected?: string;
@@ -85,6 +86,7 @@ export interface InternalTestResult {
 // Schema-compliant TestResult type (strictly matches cql-test-results.schema.json)
 export interface TestResult {
 	testStatus?: 'pass' | 'fail' | 'skip' | 'error';
+	skipMessage?: string;
 	responseStatus?: number;
 	actual?: string;
 	expected?: string;

src/services/test-runner.ts

@@ -64,12 +64,12 @@ export class TestRunner {
 		for (const testFile of emptyResults) {
 			for (const result of testFile) {
 				if (this.shouldSkipVersionTest(cqlEngine, result)) {
-					//add to skipMap
 					const skipReason =
-						'test version ' +
-						result.testVersion +
-						' not applicable to engine version ' +
-						cqlEngine.cqlVersion;
+						result.testVersionTo &&
+						this.compareVersions(cqlEngine.cqlVersion, result.testVersionTo) > 0
+							? `test versionTo ${result.testVersionTo} not applicable to engine version ${cqlEngine.cqlVersion}`
+							: `test version ${result.testVersion} not applicable to engine version ${cqlEngine.cqlVersion}`;
+
 					this.addToSkipList(
 						skipMap,
 						result.testsName,
@@ -117,19 +117,36 @@ export class TestRunner {
 		const key = `${result.testsName}-${result.groupName}-${result.testName}`;
 
 		if (result.testStatus === 'skip') {
-			result.SkipMessage = 'Skipped by cql-tests-runner';
+			if (!result.skipMessage?.trim()) {
+				result.skipMessage = 'Skipped by cql-tests-runner';
+			}
+			console.log(
+				'Test %s:%s:%s status: %s skipMessage: %s',
+				result.testsName,
+				result.groupName,
+				result.testName,
+				result.testStatus,
+				result.skipMessage
+			);
 			return result;
 		} else if (onlySet.size > 0 && !onlySet.has(key)) {
 			result.SkipMessage = 'Skipped by OnlyList filter';
 			result.testStatus = 'skip';
 			return result;
 		} else if (skipMap.has(key)) {
 			const reason = skipMap.get(key) || '';
-			result.SkipMessage = `Skipped by config: ${reason}`;
+			result.skipMessage = `Skipped by config: ${reason}`;
 			result.testStatus = 'skip';
+			console.log(
+				'Test %s:%s:%s status: %s skipMessage: %s',
+				result.testsName,
+				result.groupName,
+				result.testName,
+				result.testStatus,
+				result.skipMessage
+			);
 			return result;
 		}
-
 		const data = generateParametersResource(result, config.FhirServer.CqlOperation);
 
 		try {

src/shared/results-shared.ts

@@ -3,6 +3,7 @@ import { Parameters } from 'fhir/r4';
 
 export class Result implements InternalTestResult {
 	testStatus!: 'pass' | 'fail' | 'skip' | 'error';
+	skipMessage?: string;
 	responseStatus?: number;
 	actual?: any;
 	expected?: string;
@@ -49,6 +50,7 @@ export class Result implements InternalTestResult {
 			}
 		} else {
 			this.testStatus = 'skip';
+			this.skipMessage = 'No output specified';
 		}
 
 		this.capability = Array.isArray(test.capability)

src/test-results/cql-test-results.ts

@@ -102,6 +102,7 @@ export class CQLTestResults {
 				expression: result.expression,
 				// Optional fields (only include if present)
 				...(result.testStatus && { testStatus: result.testStatus }),
+				...(result.skipMessage?.trim() && { skipMessage: result.skipMessage.trim() }),
 				...(result.responseStatus !== undefined && {
 					responseStatus: result.responseStatus,
 				}),