Warn when rcode CRC does not match profiler CRC (#272)

Author: kenherring

CHANGELOG.md

@@ -1,20 +1,14 @@
 # [1.2.7](https://github.com/kenherring/ablunit-test-runner/releases/tag/1.2.7) - 2025-05-11 (pre-release)
 
-
- * 
+ * Warn when rcode CRC does not match profiler CRC (#272)
  * Create codeql.yml (#278)
-
-**Full Changelog**: [1.2.5...1.2.7](https://github.com/kenherring/ablunit-test-runner/compare/1.2.5...1.2.7)
-
-# [1.2.5](https://github.com/kenherring/ablunit-test-runner/releases/tag/1.2.5) - 2025-05-11 (pre-release)
-
  * Create dependabot.yml (#275)
  * Bump the npm_and_yarn group across 1 directory with 2 updates (#277)
  * Update eslint configuration (#279)
  * Unit test cleanup and performance (#274)
  * Increase debug profile wait time to 30s (part 2) (#273)
 
-**Full Changelog**: [1.2.0...1.2.5](https://github.com/kenherring/ablunit-test-runner/compare/1.2.0...1.2.5)
+**Full Changelog**: [1.2.0...1.2.7](https://github.com/kenherring/ablunit-test-runner/compare/1.2.0...1.2.7)
 
 # [1.2.0](https://github.com/kenherring/ablunit-test-runner/releases/tag/1.2.0) - 2025-04-26
 

src/ABLResults.ts

@@ -568,7 +568,7 @@ export class ABLResults implements Disposable {
 			const uri = Uri.joinPath(Uri.file(profDir), dataFiles[i])
 			log.debug('parsing profiler data ' + (i+1) + '/' + dataFiles.length + ' from ' + uri.fsPath)
 
-			proms.push(new ABLProfile().parseData(uri, this.cfg.ablunitConfig.profiler.writeJson, this.debugLines, this.cfg.ablunitConfig.profiler.ignoreExternalCoverage).then((profJson) => {
+			proms.push(new ABLProfile().parseData(uri, options, this.cfg.ablunitConfig.profiler.writeJson, this.debugLines, this.cfg.ablunitConfig.profiler.ignoreExternalCoverage).then((profJson) => {
 				log.debug('parsed profiler data ' + (i+1) + '/' + dataFiles.length + ' ' + profJson.parseDuration)
 				const item = this.findTest(profJson.description)
 				if (item) {

src/parse/ProfileParser.ts

@@ -1,4 +1,4 @@
-import { DeclarationCoverage, Position, Range, StatementCoverage, TextDocument, Uri, workspace } from 'vscode'
+import { DeclarationCoverage, Position, Range, StatementCoverage, TestRun, TextDocument, Uri, workspace } from 'vscode'
 import { PropathParser } from 'ABLPropath'
 import { ABLDebugLines } from 'ABLDebugLines'
 import { log } from 'ChannelLogger'
@@ -18,7 +18,7 @@ export class ABLProfile {
 	profJSON?: ABLProfileJson
 	parseAll = false
 
-	async parseData (uri: Uri, writeJson: boolean, debugLines?: ABLDebugLines, ignoreExternalCoverage = true, propath?: PropathParser) {
+	async parseData (uri: Uri, options: TestRun, writeJson: boolean, debugLines?: ABLDebugLines, ignoreExternalCoverage = true, propath?: PropathParser) {
 		if (!debugLines) {
 			// unit testing setup
 			debugLines = new ABLDebugLines()
@@ -46,7 +46,7 @@ export class ABLProfile {
 		}
 
 		log.debug('section1 ' + sectionLines[1].length)
-		this.profJSON = new ABLProfileJson(uri, sectionLines[1], debugLines, ignoreExternalCoverage)
+		this.profJSON = new ABLProfileJson(options, uri, sectionLines[1], debugLines, ignoreExternalCoverage)
 		log.debug('section2 ' + sectionLines[2].length)
 		this.profJSON.addModules(sectionLines[2])
 		if (this.profJSON.modules.length > 0) { // all modules excluded
@@ -308,7 +308,11 @@ export class ABLProfileJson {
 	ignoredModules: number[] = [0]
 	private hasSourceMap = false
 
-	constructor (public readonly profileUri: Uri, lines: string[], public debugLines: ABLDebugLines, private readonly ignoreExternalCoverage: boolean) {
+	constructor (private readonly options: TestRun,
+				public readonly profileUri: Uri,
+				lines: string[],
+				public debugLines: ABLDebugLines,
+				private readonly ignoreExternalCoverage: boolean) {
 		this.parseDuration = new Duration('parse profile data: ' + profileUri)
 		this.debugLines = debugLines
 		if (lines.length > 1) {
@@ -467,6 +471,13 @@ export class ABLProfileJson {
 	async addSourceMap () {
 		for (const mod of this.modules) {
 			const map = await this.debugLines.getSourceMap(mod.SourceUri).then((sourceMap) => {
+
+				if (sourceMap?.crc && sourceMap.crc != mod.CrcValue) {
+					log.warn('crc mismatch for module ' + mod.ModuleName + ' in uri=' + this.profileUri.fsPath + ' (ModuleID=' + mod.ModuleID + ')' +
+						'\n\t- expected: ' + mod.CrcValue +
+						'\n\t-      got: ' + sourceMap.crc, { testRun: this.options })
+				}
+
 				return sourceMap
 			}, (e: unknown) => {
 				log.error('could not get source map for module ' + mod.ModuleName + ' in uri=' + this.profileUri.fsPath + ' (ModuleID=' + mod.ModuleID + ') - ' + e)

src/parse/SourceMapRCodeParser.ts

@@ -74,12 +74,24 @@ export const getSourceMapFromRCode = (propath: PropathParser, uri: Uri) => {
 		//  * Frame (1 per frame)
 		//  * Debugger (1)
 
-		const debug = segmentTable.subarray(12, 16)
+		const size1 = segmentTable.subarray(16, 20)
+		const size2 = segmentTable.subarray(20, 24)
+		const size3 = segmentTable.subarray(24, 28)
 		const debugsize = segmentTable.subarray(28, 32)
-		const debugLoc = toBase10(debug) + segmentTable.byteOffset + segmentTable.length
+		const loc1 = toBase10(segmentTable.subarray(0, 4)) + segmentTable.byteOffset + segmentTable.length
+		const loc2 = toBase10(segmentTable.subarray(4, 8)) + segmentTable.byteOffset + segmentTable.length
+		const loc3 = toBase10(segmentTable.subarray(8, 12)) + segmentTable.byteOffset + segmentTable.length
+		const debugLoc = toBase10(segmentTable.subarray(12, 16)) + segmentTable.byteOffset + segmentTable.length
+
 		return {
+			segmentLoc1: loc1,
+			segmentSize1: toBase10(size1),
+			segmentLoc2: loc2,
+			segmentSize2: toBase10(size2),
+			segmentLoc3: loc3,
+			segmentSize3: toBase10(size3),
 			debugLoc: debugLoc,
-			debugSize: toBase10(debugsize)
+			debugSize: toBase10(debugsize),
 		}
 	}
 
@@ -412,6 +424,15 @@ export const getSourceMapFromRCode = (propath: PropathParser, uri: Uri) => {
 		return debugLines
 	}
 
+	const parseSegment1 = (segment1Bytes: Uint8Array) => {
+		log.debug('parseSegment1 segment1Bytes.length=' + segment1Bytes.length)
+		const crcLocation = 174
+		const crc = toBase10(segment1Bytes.subarray(crcLocation, crcLocation + 2))
+		return {
+			crc: crc,
+		}
+	}
+
 	const parseDebugSegment = async (debugBytes: Uint8Array) => {
 		const debugBytes32 = new Uint32Array(debugBytes.length / 4)
 		for (let i=0; i < debugBytes.length; i=i+4) {
@@ -453,6 +474,9 @@ export const getSourceMapFromRCode = (propath: PropathParser, uri: Uri) => {
 		const rawSignatureTable = raw.subarray(headerInfo.signatureTableLoc, headerInfo.signatureTableLoc + headerInfo.signatureTableSize)
 		const signatures = parseSignatureTable(rawSignatureTable)
 
+		const segment1Bytes = raw.subarray(segmentInfo.segmentLoc1, segmentInfo.segmentLoc1 + segmentInfo.segmentSize1)
+		const segment1Info = parseSegment1(segment1Bytes)
+
 		let debugInfo: SourceMapItem[] = []
 		if (segmentInfo.debugSize > 0) {
 			const debugBytes = raw.slice(segmentInfo.debugLoc, segmentInfo.debugLoc + segmentInfo.debugSize)
@@ -467,6 +491,7 @@ export const getSourceMapFromRCode = (propath: PropathParser, uri: Uri) => {
 			includes: includes,
 			declarations: declarations,
 			signatures: signatures,
+			crc: segment1Info.crc,
 		}
 
 		return sourceMap

test/parse/SourceMapRCodeParser.test.ts

@@ -91,6 +91,18 @@ test('SourceMapRCodeParser.test_4', async () => {
 	return
 })
 
+test('SourceMapRCodeParser.test_5', async () => {
+	const propath = new PropathParser()
+	const testuri = toUri('test_4/destructorSimple.cls')
+	await getSourceMap(propath, testuri).then((sourceMap) => {
+		log.info('sourceMap.crc=' + sourceMap.crc)
+		assert.equal(sourceMap.crc, 8413)
+		return true
+	}, (e: unknown) => {
+		assert.fail('Error in test_5: e=' + (e instanceof Error ? e.message : String(e)))
+	})
+})
+
 async function getSourceMap (propath: PropathParser, uri: Uri) {
 	const sourceMap = await getSourceMapFromRCode(propath, uri)
 	if (!sourceMap) {