Merge pull request #7 from ctrf-io/feat/include-suite

fixes #5

Author: Ma11hewThomas

README.md

@@ -22,8 +22,11 @@ npx junit-to-ctrf path/to/junit.xml
 
 `-t`, `--tool` <toolName>: Tool name to include in the CTRF report.
 
+`-u`, `--use-suite-name` <useSuiteName>: Use suite name in the test name, defaults to true.
+
 `-e`, `--env` <envProperties>: Environment properties to include in the CTRF report. Accepts multiple properties in the format KEY=value.
 
+
 ## Examples
 
 Convert a JUnit XML report to the default CTRF report location (ctrf/ctrf-report.json):
@@ -58,6 +61,12 @@ npx junit-to-ctrf path/to/junit.xml -e appName=MyApp buildName=MyBuild
 
 See [CTRF schema](https://www.ctrf.io/docs/schema/environment) for possible environment properties
 
+### Exclude Suite Name
+
+```sh
+npx junit-to-ctrf path/to/junit.xml -u false
+```
+
 ### Full Command
 
 Combine all options in a single command:

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "junit-to-ctrf",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "",
   "main": "index.js",
   "scripts": {

package.json

@@ -30,12 +30,18 @@ yargs(hideBin(process.argv))
           alias: 'e',
           type: 'array',
           description: 'Environment properties',
+        })
+        .option('use-suite-name', {
+          alias: 'u',
+          type: 'boolean',
+          default: true,
+          description: 'Use suite name in the test name',
         });
     },
     async (argv) => {
       try {
-        const { path, output, tool, env } = argv;
-        await convertJUnitToCTRF(path as string, output as string, tool as string, env as string[]);
+        const { path, output, tool, env, useSuiteName  } = argv;
+        await convertJUnitToCTRF(path as string, output as string, tool as string, env as string[], useSuiteName);
         console.log('Conversion completed successfully.');
       } catch (error: any) {
         console.error('Error:', error.message);

src/cli.ts

@@ -61,7 +61,7 @@ async function parseJUnitReport(filePath: string): Promise<JUnitTestCase[]> {
   return testCases;
 }
 
-function convertToCTRFTest(testCase: JUnitTestCase): CtrfTest {
+function convertToCTRFTest(testCase: JUnitTestCase, useSuiteName: boolean): CtrfTest {
   let status: CtrfTest['status'] = 'other';
 
   if (testCase.failure) {
@@ -76,21 +76,27 @@ function convertToCTRFTest(testCase: JUnitTestCase): CtrfTest {
 
   const durationMs = Math.round(parseFloat(testCase.time) * 1000);
 
+  const testName = useSuiteName
+    ? `${testCase.suite}: ${testCase.name}`
+    : testCase.name;
+
   return {
-    name: `${testCase.suite}: ${testCase.name}`,
+    name: testName,
     status,
     duration: durationMs,
     message: testCase.failure || testCase.error ? (testCase.failure || testCase.error) : undefined,
     trace: testCase.failure || testCase.error ? (testCase.failure || testCase.error) : undefined,
+    suite: testCase.suite || ''
   };
 }
 
 function createCTRFReport(
   testCases: JUnitTestCase[],
   toolName?: string,
-  envProps?: Record<string, any>
+  envProps?: Record<string, any>,
+  useSuiteName?: boolean
 ): CtrfReport {
-  const ctrfTests = testCases.map(convertToCTRFTest);
+  const ctrfTests = testCases.map(testCase => convertToCTRFTest(testCase, !!useSuiteName));
   const passed = ctrfTests.filter(test => test.status === 'passed').length;
   const failed = ctrfTests.filter(test => test.status === 'failed').length;
   const skipped = ctrfTests.filter(test => test.status === 'skipped').length;
@@ -131,11 +137,12 @@ export async function convertJUnitToCTRF(
   junitPath: string,
   outputPath?: string,
   toolName?: string,
-  envProps?: string[]
+  envProps?: string[],
+  useSuiteName?: boolean
 ): Promise<void> {
   const testCases = await parseJUnitReport(junitPath);
   const envPropsObj = envProps ? Object.fromEntries(envProps.map(prop => prop.split('='))) : {};
-  const ctrfReport = createCTRFReport(testCases, toolName, envPropsObj);
+  const ctrfReport = createCTRFReport(testCases, toolName, envPropsObj, useSuiteName);
 
   const defaultOutputPath = path.join('ctrf', 'ctrf-report.json');
   const finalOutputPath = path.resolve(outputPath || defaultOutputPath);