Skip to content
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

A new yaml 'task' to create files #16

Merged
merged 2 commits into from
Sep 30, 2024
Merged

A new yaml 'task' to create files #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2bad476
Added a new 'createFile' task that can write files to the FS
alanboy Sep 30, 2024
d37b595
undo the actions yaml
alanboy Sep 30, 2024
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
15 changes: 7 additions & 8 deletions challenge.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,23 +47,22 @@ configuration:
#
validate:
# Here is a task that compiles the code
- name: "Compile the code"
cmd: echo Compiling...
- name: "Compiling code"
cmd: echo Compiling code...

# The command to run the verification, this can be running tests
# And it needs to produce a file called with a junit test format
- name: "Run the tests"
cmd: |
echo Running some testing command...
echo '<?xml version="1.0" encoding="UTF-8"?>
<!-- This is a basic JUnit-style XML example to highlight the basis structure. -->
- task: createFile
file: output.xml
contents: |
<?xml version="1.0" encoding="UTF-8" ?>
<testsuites time="15.682687">
<testsuite name="Tests.DevMatchTestCases" time="6.605871">
<testcase name="TEST_1" classname="Tests.simpleSum" time="2.111" />
<testcase name="TEST_2" classname="Tests.simpleSum" time="1.051" />
<testcase name="TEST_3" classname="Tests.simpleSum" time="3.441" />
</testsuite>
</testsuites>' > output.xml
</testsuites>
# The location and filename of the results
results: output.xml

Expand Down
5 changes: 4 additions & 1 deletion validator/src/execute.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ export function execute(command, printOutput = false, cwd = "") {
}

const [cmd, ...args] = command.split(" ");
const child = spawn(cmd, args, { cwd: cwd });
const child = spawn(cmd, args, {
cwd: cwd,
shell: true,
});

let stdout = "";
let stderr = "";
Expand Down
207 changes: 112 additions & 95 deletions validator/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,19 +56,19 @@ program
);
let problemConfiguration = await problemCode.getProblemConfiguration();
console.table([
[ "inputType", problemConfiguration.inputType ],
[ "desktopEnabled", problemConfiguration.desktopEnabled ],
[ "ideEnabled", problemConfiguration.ideEnabled ],
[ "vsliteEnabled", problemConfiguration.vsliteEnabled ],
[ "agentPool", problemConfiguration.agentPool ],
[ "agentImage", problemConfiguration.agentImage ]
["inputType", problemConfiguration.inputType],
["desktopEnabled", problemConfiguration.desktopEnabled],
["ideEnabled", problemConfiguration.ideEnabled],
["vsliteEnabled", problemConfiguration.vsliteEnabled],
["agentPool", problemConfiguration.agentPool],
["agentImage", problemConfiguration.agentImage]
])

const worskpaceFolder = path.join(process.cwd(), "..", "workspace");
console.log("Current working directory", worskpaceFolder)

const validationSteps = parsedYaml.validate;
let buildTestResultFileNames : string[] = [];
let buildTestResultFileNames: string[] = [];

console.log(` `)
console.log(` _____ _______ _____ _______ `)
Expand All @@ -83,44 +83,61 @@ program
process.env.WAIT_ON_TIMEOUT = '60000';

try {
for (const validationStep of validationSteps)
{
// Start from the path to the workspace or if the Yaml specificies a working directory, then use that
// Whatever is specified, will be after the parent of the workspace directory.
const workingDirectory = validationStep.workingDirectory ?
path.normalize(path.join(process.cwd(), "..", validationStep.workingDirectory)) : worskpaceFolder;

console.log(`/=======================================================`);
console.log(`| name : ${validationStep.name}`);
console.log(`| workingDirectory: ${workingDirectory}`);
console.log(`| cmd : ${validationStep.cmd}`);
console.log(`\\=======================================================`);

//
// Run the command
//
try {

await execute(validationStep.cmd, true, workingDirectory);
} catch (innerError) {
console.error("Command failed. But continuing still...");
}

//
// Collect the result if instructed
//
if (validationStep.results !== undefined)
{
const resultPath = path.join(workingDirectory, validationStep.results);
buildTestResultFileNames.push(resultPath)
}

console.log(``);
for (const validationStep of validationSteps) {
// Start from the path to the workspace or if the Yaml specificies a working directory, then use that
// Whatever is specified, will be after the parent of the workspace directory.
const workingDirectory = validationStep.workingDirectory ?
path.normalize(path.join(process.cwd(), "..", validationStep.workingDirectory)) : worskpaceFolder;

if (validationStep?.task === "createFile") {
const fileFullName = path.join(workingDirectory, validationStep.file);

console.log(`/=======================================================`);
console.log(`| task : ${validationStep.task}`);
console.log(`| workingDirectory: ${workingDirectory}`);
console.log(`| file name : ${fileFullName}`);
console.log(`\\=======================================================`);

// create a file to disk
fs.writeFileSync(fileFullName, validationStep.contents);
console.log(`Created file: ${fileFullName}`);

} else {
console.log(`/=======================================================`);
console.log(`| name : ${validationStep.name}`);
console.log(`| workingDirectory: ${workingDirectory}`);
console.log(`| cmd : ${validationStep.cmd}`);
console.log(`\\=======================================================`);

//
// Run the command
//
try {
//await execute(validationStep.cmd, true, workingDirectory);
await execute(validationStep.cmd, true);

} catch (innerError) {
console.error("Command failed. But continuing still...");

}

}


//
// Collect the result if instructed
//
if (validationStep.results !== undefined) {
const resultPath = path.join(workingDirectory, validationStep.results);
buildTestResultFileNames.push(resultPath)
}

console.log(``);

}
} catch (e) {
console.error("Caught exception while executing.");
console.error(e)
console.error("Caught exception while executing.");
console.error(e)
}

console.log(` ______ _ _ _____ `)
Expand All @@ -144,61 +161,61 @@ program
//

const extractTestCasesFromJunit = async (fileName) => {
const resultsContents = await getFileContents(fileName);
if (resultsContents === false) {
console.log(
`The test run did not produce an output at: ${fileName}`
);
return [];
}
const resultsContents = await getFileContents(fileName);
if (resultsContents === false) {
console.log(
`The test run did not produce an output at: ${fileName}`
);
return [];
}

//
// Read build test cases: Parse the JUnit test result file
//
console.log(`Found the output file: ${fileName}`);
let buildParsedJunitContents : any = null;
try {
buildParsedJunitContents = await parseJunitXml(resultsContents);
} catch (e) {
console.log(`Unable to parse output: ${fileName}`);
throw e;
return;
}
if (!buildParsedJunitContents) {
console.log(`Unable to parse output: ${fileName}`);
throw Error();
}
//
// Read build test cases: Parse the JUnit test result file
//
console.log(`Found the output file: ${fileName}`);
let buildParsedJunitContents: any = null;
try {
buildParsedJunitContents = await parseJunitXml(resultsContents);
} catch (e) {
console.log(`Unable to parse output: ${fileName}`);
throw e;
return;
}
if (!buildParsedJunitContents) {
console.log(`Unable to parse output: ${fileName}`);
throw Error();
}

const buildTestSuites = (buildParsedJunitContents as TestSuites).testsuite || [];

// Flatten the tree and just extract all the test cases from the build
let buildTestCases : any [] = [];
for (const suites of buildTestSuites) {
if (suites?.testcase === undefined) {
continue;
}
for (const testCase of suites?.testcase) {
buildTestCases.push(testCase);
console.log(`Found test case from the build : '${testCase.name}'`)
}
const buildTestSuites = (buildParsedJunitContents as TestSuites).testsuite || [];

// Flatten the tree and just extract all the test cases from the build
let buildTestCases: any[] = [];
for (const suites of buildTestSuites) {
if (suites?.testcase === undefined) {
continue;
}
for (const testCase of suites?.testcase) {
buildTestCases.push(testCase);
console.log(`Found test case from the build : '${testCase.name}'`)
}
}

return buildTestCases;
return buildTestCases;
}

console.log(``);

// NOW we need to merge the result files... and
// just get the various test cases from as many
// test files we have in buildTestResultFileNames
let buildTestCases : any [] = [];
let buildTestCases: any[] = [];
for (const resultFile of buildTestResultFileNames) {
console.log(`Result file : ${resultFile}`);
try {
buildTestCases = buildTestCases.concat(await extractTestCasesFromJunit(resultFile));
} catch (e) {
console.log(`Unable to parse test case from ${resultFile}: ${e}.`);
}
console.log(`Result file : ${resultFile}`);
try {
buildTestCases = buildTestCases.concat(await extractTestCasesFromJunit(resultFile));
} catch (e) {
console.log(`Unable to parse test case from ${resultFile}: ${e}.`);
}
}

// Read the test cases from the YAML file, and start the comparison with the
Expand Down Expand Up @@ -233,18 +250,18 @@ program
// Find this result on build test cases

const foundBuildTestCase = buildTestCases?.find((c) => c?.name?.trim() === yamlTestCase.id);
if (foundBuildTestCase) {
const failure = foundBuildTestCase.failure !== undefined;
console.log(`Found mapping ${yamlTestCase.id}. Failure = ${failure}`);

if (!failure) {
yamlTestCase.actualPoints = yamlTestCase.maxPoints;
yamlTestCase.solved = true;
}
if (foundBuildTestCase) {
const failure = foundBuildTestCase.failure !== undefined;
console.log(`Found mapping ${yamlTestCase.id}. Failure = ${failure}`);

} else {
console.log(`Test case mapping ${yamlTestCase.id} *NOT* found. Build did not produce this test case.`);
if (!failure) {
yamlTestCase.actualPoints = yamlTestCase.maxPoints;
yamlTestCase.solved = true;
}

} else {
console.log(`Test case mapping ${yamlTestCase.id} *NOT* found. Build did not produce this test case.`);
}
}

//
Expand Down
Loading