Skip to content

chore(test): refactor build system test and adding interface for file struct output #88

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
merged 3 commits into from
Jan 8, 2025
Merged

chore(test): refactor build system test and adding interface for file struct output #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
757ab4f
feat(backend): update file structure handling and introduce Level2UXS…
Sma1lboy Jan 7, 2025
0fd11d6
Merge branch 'chore-optimization-handler-output-content' into chore-r…
ZHallen122 Jan 7, 2025
3eb7273
[autofix.ci] apply automated fixes
autofix-ci[bot] Jan 7, 2025
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
49 changes: 0 additions & 49 deletions backend/src/build-system/__tests__/test-database-schemas.spec.ts
View file
Open in desktop

This file was deleted.

80 changes: 18 additions & 62 deletions backend/src/build-system/__tests__/test-generate-doc.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,15 @@
/* eslint-disable no-console */
import { BuilderContext } from 'src/build-system/context';
import { BuildSequence } from '../types';
import * as fs from 'fs';
import * as path from 'path';
import { writeToFile } from './utils';
import { executeBuildSequence } from './utils';

// TODO: adding integration flag
describe('Sequence: PRD -> UXSD -> UXDD -> UXSS', () => {
// Generate a unique folder with a timestamp
const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
const logFolderPath = `./logs/generate-docs-${timestamp}`;
fs.mkdirSync(logFolderPath, { recursive: true });

it('should execute the full sequence and log results to individual files', async () => {
const sequence: BuildSequence = {
id: 'test-sequence',
id: 'test-backend-sequence',
version: '1.0.0',
name: 'Test PRD to UX Sequence',
description: 'Testing PRD to UX sequence execution',
name: 'Spotify-like Music Web',
description: 'Users can play music',
databaseType: 'SQLite',
steps: [
{
id: 'step-1',
Expand All @@ -35,7 +28,6 @@ describe('Sequence: PRD -> UXSD -> UXDD -> UXSS', () => {
{
id: 'op:UX:SMD',
name: 'UX Sitemap Document Node',
requires: ['op:PRD'],
},
],
},
Expand All @@ -46,7 +38,6 @@ describe('Sequence: PRD -> UXSD -> UXDD -> UXSS', () => {
{
id: 'op:UX:SMS',
name: 'UX Sitemap Structure Node',
requires: ['op:UX:SMD'],
},
],
},
Expand All @@ -57,73 +48,38 @@ describe('Sequence: PRD -> UXSD -> UXDD -> UXSS', () => {
{
id: 'op:UX:DATAMAP:DOC',
name: 'UX Data Map Document node',
requires: ['op:UX:SMD'],
},
],
},
{
id: 'step-5',
name: 'file structure generation',
nodes: [
{
id: 'op:FILE:STRUCT',
name: 'file structure generation',
requires: ['op:UX:SMD', 'op:UX:DATAMAP:DOC'],
options: {
projectPart: 'frontend',
},
},
],
},
{
id: 'step-6',
name: 'File_Arch Document',
name: 'UX SMD LEVEL 2 Page Details',
nodes: [
{
id: 'op:FILE:ARCH',
name: 'File_Arch',
requires: [
'op:FILE:STRUCT',
//TODO: here use datamap doc rather than datamap struct, we have to change this
'op:UX:DATAMAP:DOC',
],
id: 'op:UX:SMS:LEVEL2',
name: 'UX SMD LEVEL 2 Page Details Node',
},
],
},
],
};

const context = new BuilderContext(sequence, 'test');

// Set input data for context
context.setGlobalContext('projectName', 'spotify like music web');
context.setGlobalContext('description', 'user can play music');
context.setGlobalContext('platform', 'web');

try {
await context.execute();

for (const step of sequence.steps) {
for (const node of step.nodes) {
const resultData = await context.getNodeData(node.id);
console.log(resultData);
if (resultData) {
writeToFile(logFolderPath, node.id, resultData);
}
}
}
const result = await executeBuildSequence(
'test-generate-all-ux-part',
sequence,
);

console.log(
'Sequence completed successfully. Logs stored in:',
logFolderPath,
result.logFolderPath,
);

if (!result.success) {
throw result.error;
}
} catch (error) {
console.error('Error during sequence execution:', error);
fs.writeFileSync(
path.join(logFolderPath, 'error.txt'),
`Error: ${error.message}\n${error.stack}`,
'utf8',
);
throw error;
}
}, 600000);
Expand Down
136 changes: 13 additions & 123 deletions backend/src/build-system/__tests__/test.fullstack-gen.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,8 @@
/* eslint-disable no-console */
import { BuilderContext } from 'src/build-system/context';
import { BuildSequence } from '../types';
import * as fs from 'fs';
import * as path from 'path';
import { objectToMarkdown, writeToFile } from './utils';
import { BuildMonitor } from '../monitor';
import { executeBuildSequence, objectToMarkdown, writeToFile } from './utils';

describe('Sequence: PRD -> UXSD -> UXSS -> UXDD -> DATABASE_REQ -> DBSchemas -> Frontend_File_struct -> Frontend_File_arch -> BackendCodeGenerator', () => {
// Generate a unique folder with a timestamp
const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
const logFolderPath = `./logs/Fullstack_code_generator-${timestamp}`;
fs.mkdirSync(logFolderPath, { recursive: true });

it('should execute the frontend and backend code generation sequence and log results to individual files', async () => {
// Define the build sequence up to Backend Code Generator
describe('Build Sequence Test', () => {
it('should execute build sequence successfully', async () => {
const sequence: BuildSequence = {
id: 'test-backend-sequence',
version: '1.0.0',
Expand Down Expand Up @@ -90,6 +79,11 @@ describe('Sequence: PRD -> UXSD -> UXSS -> UXDD -> DATABASE_REQ -> DBSchemas ->
projectPart: 'frontend',
},
},
{
id: 'op:UX:SMS:LEVEL2',
name: 'Level 2 UX Sitemap Structure Node details',
requires: ['op:UX:SMS'],
},
],
},
{
Expand Down Expand Up @@ -145,114 +139,10 @@ describe('Sequence: PRD -> UXSD -> UXSS -> UXDD -> DATABASE_REQ -> DBSchemas ->
},
],
};
const context = new BuilderContext(sequence, 'test-env');
const monitor = BuildMonitor.getInstance();

try {
console.time('Total Execution Time');

await context.execute();

console.timeEnd('Total Execution Time');

const monitorReport = monitor.generateTextReport(sequence.id);
fs.writeFileSync(
path.join(logFolderPath, 'execution-metrics.txt'),
monitorReport,
'utf8',
);

const sequenceMetrics = monitor.getSequenceMetrics(sequence.id);
if (sequenceMetrics) {
const metricsJson = {
totalDuration: `${sequenceMetrics.duration}ms`,
successRate: `${sequenceMetrics.successRate.toFixed(2)}%`,
totalSteps: sequenceMetrics.totalSteps,
completedSteps: sequenceMetrics.completedSteps,
failedSteps: sequenceMetrics.failedSteps,
totalNodes: sequenceMetrics.totalNodes,
startTime: new Date(sequenceMetrics.startTime).toISOString(),
endTime: new Date(sequenceMetrics.endTime).toISOString(),
};

fs.writeFileSync(
path.join(logFolderPath, 'metrics.json'),
JSON.stringify(metricsJson, null, 2),
'utf8',
);

console.log('\nSequence Metrics:');
console.table(metricsJson);
}

for (const step of sequence.steps) {
const stepMetrics = sequenceMetrics?.stepMetrics.get(step.id);
for (const node of step.nodes) {
const resultData = await context.getNodeData(node.id);
const nodeMetrics = stepMetrics?.nodeMetrics.get(node.id);

if (resultData) {
const content =
typeof resultData === 'object'
? objectToMarkdown(resultData)
: resultData;

writeToFile(logFolderPath, `${node.name}`, content);
} else {
console.error(
` Error: Handler ${node.name} failed to produce result data`,
);
writeToFile(
logFolderPath,
`${node.name}-error`,
objectToMarkdown({
error: 'No result data',
metrics: nodeMetrics,
}),
);
}
}
}

const summary = {
timestamp: new Date().toISOString(),
sequenceId: sequence.id,
sequenceName: sequence.name,
totalExecutionTime: `${sequenceMetrics?.duration}ms`,
successRate: `${sequenceMetrics?.successRate.toFixed(2)}%`,
nodesExecuted: sequenceMetrics?.totalNodes,
completedNodes: sequenceMetrics?.stepMetrics.size,
logFolder: logFolderPath,
};

fs.writeFileSync(
path.join(logFolderPath, 'execution-summary.json'),
JSON.stringify(summary, null, 2),
'utf8',
);
} catch (error) {
const errorReport = {
error: {
message: error.message,
stack: error.stack,
},
metrics: monitor.getSequenceMetrics(sequence.id),
timestamp: new Date().toISOString(),
};

fs.writeFileSync(
path.join(logFolderPath, 'error-with-metrics.json'),
JSON.stringify(errorReport, null, 2),
'utf8',
);

console.error('\nError during sequence execution:');
console.error(error);
console.error(
'\nError report saved to:',
path.join(logFolderPath, 'error-with-metrics.json'),
);
throw new Error('Sequence execution failed.');
}
}, 300000); // Timeout set to 10 minutes
const result = await executeBuildSequence('fullstack-code-gen', sequence);
expect(result.success).toBe(true);
expect(result.metrics).toBeDefined();
console.log(`Logs saved to: ${result.logFolderPath}`);
}, 300000);
});
Loading
Loading