Skip to content

Improves assertion errors #535

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aaronzi merged 5 commits into from
May 5, 2026
Merged

Improves assertion errors #535

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3b9b449
Improves assertion errors
aaronzi May 5, 2026
b183d8d
Fixes formatting issues
aaronzi May 5, 2026
394eed1
fixes TS errors
aaronzi May 5, 2026
3226f40
Adds missing status assertions
aaronzi May 5, 2026
722bcf0
Adds further status code assertions
aaronzi May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 58 additions & 5 deletions scripts/test-engine.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,40 @@ function escapeXml(value) {
.replaceAll("'", ''');
}

function normalizeFailureMessage(message) {
if (!message) {
return '';
}

return String(message).trim();
}

function sanitizeFailureMessages(messages) {
if (!Array.isArray(messages)) {
return [];
}

return messages.map((message) => normalizeFailureMessage(message)).filter(Boolean);
}

function compactFailureReason(message) {
const normalized = normalizeFailureMessage(message);
if (!normalized) {
return '';
}

const firstLine = normalized
.split('\n')
.map((line) => line.trim())
.find(Boolean);

return firstLine || normalized;
}

function formatFailureDetailLine(message) {
return normalizeFailureMessage(message).replace(/\s+/g, ' ').trim();
}

function parseVitestResults(vitestReport) {
const passedChecks = [];
const failedChecks = [];
Expand All @@ -260,12 +294,14 @@ function parseVitestResults(vitestReport) {
let suiteHasFailedAssertion = false;

for (const assertion of suite.assertionResults ?? []) {
const failureMessages = sanitizeFailureMessages(assertion.failureMessages);
const check = {
checkType: 'integration-test',
suite: suite.name,
name: assertion.fullName || assertion.title,
durationMs: assertion.duration,
reason: assertion.failureMessages?.[0] || '',
reason: failureMessages[0] || '',
failureMessages,
status: assertion.status,
};

Expand All @@ -284,12 +320,14 @@ function parseVitestResults(vitestReport) {
}

if (suite.status === 'failed' && !suiteHasFailedAssertion) {
const suiteMessage = normalizeFailureMessage(suite.message);
failedChecks.push({
checkType: 'integration-suite',
suite: suite.name,
name: `Suite failure: ${suite.name}`,
durationMs: 0,
reason: suite.message || 'Suite failed before assertions (setup hook or runtime error).',
reason: suiteMessage || 'Suite failed before assertions (setup hook or runtime error).',
failureMessages: suiteMessage ? [suiteMessage] : [],
status: 'failed',
});
}
Expand Down Expand Up @@ -449,7 +487,15 @@ function writeMarkdownReport(report, outputPath) {
if (failure.suite) {
lines.push(` - suite: ${failure.suite}`);
}
lines.push(` - reason: ${failure.reason || 'No failure reason provided'}`);

const primaryReason = failure.reason || failure.failureMessages?.[0] || 'No failure reason provided';
lines.push(` - reason: ${primaryReason}`);

if (Array.isArray(failure.failureMessages) && failure.failureMessages.length > 1) {
for (const extraMessage of failure.failureMessages.slice(1, 5)) {
lines.push(` - detail: ${formatFailureDetailLine(extraMessage)}`);
}
}
}
}
lines.push('');
Expand Down Expand Up @@ -498,7 +544,7 @@ function writeJunitReport(report, outputPath) {
name: check.name,
status: 'failed',
durationMs: check.durationMs ?? 0,
message: check.reason || 'No failure message',
message: compactFailureReason(check.reason || check.failureMessages?.[0] || 'No failure message'),
});
}

Expand Down Expand Up @@ -550,7 +596,14 @@ function printConsoleSummary(report, artifactPaths) {
console.log('Failed checks:');
for (const failure of report.failedChecks) {
console.log(`- [${failure.checkType}] ${failure.name}`);
console.log(` reason: ${failure.reason || 'No failure reason provided'}`);
const primaryReason = failure.reason || failure.failureMessages?.[0] || 'No failure reason provided';
console.log(` reason: ${primaryReason}`);

if (Array.isArray(failure.failureMessages) && failure.failureMessages.length > 1) {
for (const extraMessage of failure.failureMessages.slice(1, 3)) {
console.log(` detail: ${formatFailureDetailLine(extraMessage)}`);
}
}
}
}

Expand Down
38 changes: 18 additions & 20 deletions src/integration-tests/aasDiscovery.integration.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { AasDiscoveryClient } from '../clients/AasDiscoveryClient';
import { Configuration } from '../generated';
import { base64Encode } from '../lib/base64Url';
import { createTestSpecificAssetId1, createTestSpecificAssetId2 } from './fixtures/aasDiscoveryFixtures';
import { assertApiFailure, assertApiResult } from './fixtures/assertionHelpers';
import { createPerTestCleanupRunner } from './fixtures/testCleanup';
import { getIntegrationBasePath } from './testEngineConfig';

Expand Down Expand Up @@ -55,10 +56,7 @@ describe('AAS Discovery Integration Tests', () => {
specificAssetId: [specificAssetId1, specificAssetId2],
});

expect(createResponse.success).toBe(true);
if (!createResponse.success) {
throw new Error('Failed to seed AAS discovery asset links fixture');
}
assertApiResult(createResponse, 'Seed AAS discovery asset links fixture');

registerAssetLinkCleanup(aasIdentifier);
return { aasIdentifier, specificAssetId1, specificAssetId2 };
Expand All @@ -79,7 +77,7 @@ describe('AAS Discovery Integration Tests', () => {
specificAssetId: [specificAssetId1, specificAssetId2],
});

expect(response.success).toBe(true);
assertApiResult(response);
if (response.success) {
registerAssetLinkCleanup(aasIdentifier);
expect(response.statusCode).toBe(201);
Expand All @@ -100,7 +98,7 @@ describe('AAS Discovery Integration Tests', () => {
aasIdentifier,
});

expect(response.success).toBe(true);
assertApiResult(response);
if (response.success) {
expect(response.statusCode).toBe(200);
expect(response.data).toBeDefined();
Expand All @@ -118,7 +116,7 @@ describe('AAS Discovery Integration Tests', () => {
configuration,
aasIdentifier: nonExistingId,
});
expect(response.success).toBe(false);
assertApiFailure(response);
if (!response.success) {
expect(response.statusCode).toBe(404);
expect(response.error).toBeDefined();
Expand Down Expand Up @@ -153,7 +151,7 @@ describe('AAS Discovery Integration Tests', () => {
assetIds: [specificAssetId1, specificAssetId2],
});

expect(response.success).toBe(true);
assertApiResult(response);
if (response.success) {
expect(response.statusCode).toBe(200);
expect(response.data).toBeDefined();
Expand All @@ -176,7 +174,7 @@ describe('AAS Discovery Integration Tests', () => {
limit: -1,
});

expect(response.success).toBe(false);
assertApiFailure(response);
if (!response.success) {
expect(response.statusCode).toBe(400);
expect(response.error.messages?.[0]?.code).toBe('400');
Expand All @@ -197,7 +195,7 @@ describe('AAS Discovery Integration Tests', () => {
cursor: unavailableCursor(),
});

expect(response.success).toBe(true);
assertApiResult(response);
if (response.success) {
expect(response.statusCode).toBe(200);
expect(response.data.pagedResult).toEqual({});
Expand All @@ -217,7 +215,7 @@ describe('AAS Discovery Integration Tests', () => {
assetLink: [specificAssetId1, specificAssetId2],
});

expect(response.success).toBe(true);
assertApiResult(response);
if (response.success) {
expect(response.statusCode).toBe(200);
expect(response.data.result).toContainEqual(aasIdentifier);
Expand All @@ -234,7 +232,7 @@ describe('AAS Discovery Integration Tests', () => {
assetLink: [{ name: 'globalAssetId' } as unknown as CoreSpecificAssetId],
});

expect(response.success).toBe(false);
assertApiFailure(response);
if (!response.success) {
expect(response.statusCode).toBe(400);
expect(response.error.messages?.[0]?.code).toBe('400');
Expand All @@ -255,7 +253,7 @@ describe('AAS Discovery Integration Tests', () => {
cursor: unavailableCursor(),
});

expect(response.success).toBe(true);
assertApiResult(response);
if (response.success) {
expect(response.statusCode).toBe(200);
expect(response.data.pagedResult).toEqual({});
Expand All @@ -277,7 +275,7 @@ describe('AAS Discovery Integration Tests', () => {
specificAssetId: [invalidSpecificAssetId],
});

expect(response.success).toBe(false);
assertApiFailure(response);
if (!response.success) {
expect(response.statusCode).toBe(400);
expect(response.error.messages?.[0]?.code).toBe('400');
Expand All @@ -297,7 +295,7 @@ describe('AAS Discovery Integration Tests', () => {
specificAssetId: [specificAssetId1],
});

expect(response.success).toBe(false);
assertApiFailure(response);
if (!response.success) {
expect(response.statusCode).toBe(405);
expect(response.error.messages?.[0]?.code).toBe('405');
Expand All @@ -317,7 +315,7 @@ describe('AAS Discovery Integration Tests', () => {
specificAssetId: [specificAssetId1],
});

expect(response.success).toBe(false);
assertApiFailure(response);
if (!response.success) {
expect(response.statusCode).toBe(404);
expect(response.error.messages?.[0]?.code).toBe('404');
Expand Down Expand Up @@ -358,7 +356,7 @@ describe('AAS Discovery Integration Tests', () => {
aasIdentifier,
});

expect(response.success).toBe(true);
assertApiResult(response);
if (response.success) {
expect(response.statusCode).toBe(204);
expect(response.data).toBeUndefined();
Expand All @@ -377,7 +375,7 @@ describe('AAS Discovery Integration Tests', () => {
aasIdentifier: nonExistingAasIdentifier,
});

expect(response.success).toBe(false);
assertApiFailure(response);
if (!response.success) {
expect(response.statusCode).toBe(404);
expect(response.error.messages?.[0]?.code).toBe('404');
Expand All @@ -394,7 +392,7 @@ describe('AAS Discovery Integration Tests', () => {
aasIdentifier: '',
});

expect(response.success).toBe(false);
assertApiFailure(response);
if (!response.success) {
expect(response.statusCode).toBe(405);
expect(response.error.messages?.[0]?.code).toBe('405');
Expand All @@ -410,7 +408,7 @@ describe('AAS Discovery Integration Tests', () => {
configuration,
});

expect(response.success).toBe(true);
assertApiResult(response);
if (response.success) {
expect(response.statusCode).toBe(200);
expect(response.data).toBeDefined();
Expand Down
Loading
Loading