utils.test.js

const { resolveFileAndLine, resolvePath, parseFile } = require('./utils');

describe('resolveFileAndLine', () => {
    it('should default to 1 if no line found', () => {
        const { filename, line } = resolveFileAndLine(null, 'someClassName', 'not a stacktrace');
        expect(filename).toBe('someClassName');
        expect(line).toBe(1);
    });

    it('should parse correctly filename and line for a Java file', () => {
        const { filename, line } = resolveFileAndLine(
            null,
            'action.surefire.report.email.EmailAddressTest',
            `
action.surefire.report.email.InvalidEmailAddressException: Invalid email address 'user@ñandú.com.ar'
    at action.surefire.report.email.EmailAddressTest.expectException(EmailAddressTest.java:74)
    at action.surefire.report.email.EmailAddressTest.shouldNotContainInternationalizedHostNames(EmailAddressTest.java:39)
        `,
            false,
        );
        expect(filename).toBe('EmailAddressTest');
        expect(line).toBe(39);
    });

    it('should parse correctly filename and line for a Kotlin file', () => {
        const { filename, line } = resolveFileAndLine(
            null,
            'action.surefire.report.calc.CalcUtilsTest',
            `
java.lang.AssertionError: unexpected exception type thrown; expected:<java.lang.IllegalStateException> but was:<java.lang.IllegalArgumentException>
    at action.surefire.report.calc.CalcUtilsTest.test error handling(CalcUtilsTest.kt:27)
Caused by: java.lang.IllegalArgumentException: Amount must have max 2 non-zero decimal places
    at action.surefire.report.calc.CalcUtilsTest.scale(CalcUtilsTest.kt:31)
    at action.surefire.report.calc.CalcUtilsTest.access$scale(CalcUtilsTest.kt:9)
    at action.surefire.report.calc.CalcUtilsTest.test error handling(CalcUtilsTest.kt:27)
        `,
            false,
        );
        expect(filename).toBe('CalcUtilsTest');
        expect(line).toBe(27);
    });

    it('should parse correctly filename and line for extended stacktrace', () => {
        const { filename, line } = resolveFileAndLine(
            null,
            'action.surefire.report.calc.StringUtilsTest',
            `
java.lang.AssertionError: 

Expected: (an instance of java.lang.IllegalArgumentException and exception with message a string containing "This is unexpected")
     but: exception with message a string containing "This is unexpected" message was "Input='' didn't match condition."
Stacktrace was: java.lang.IllegalArgumentException: Input='' didn't match condition.
	at action.surefire.report.calc.StringUtils.requireNotBlank(StringUtils.java:25)
	at action.surefire.report.calc.StringUtils.requireNotBlank(StringUtils.java:18)
	at action.surefire.report.calc.StringUtilsTest.require_fail(StringUtilsTest.java:26)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at org.junit.runners.ParentRunner.run(ParentRunner.java:413)
	at org.apache.maven.surefire.junit4.JUnit4Provider.invoke(JUnit4Provider.java:159)
	at org.apache.maven.surefire.booter.ForkedBooter.main(ForkedBooter.java:418)
`,
            false,
        );
        expect(filename).toBe('StringUtilsTest');
        expect(line).toBe(26);
    });

    it('should parse correctly filename and line for pytest', () => {
        const { filename, line } = resolveFileAndLine(
            'test.py',
            'anything',
            `
def
test_with_error():
event = { 'attr': 'test'}
&gt; assert event.attr == 'test'
E AttributeError: 'dict' object has no attribute 'attr'

test.py:14: AttributeError
`,
            false
        );
        expect(filename).toBe('test.py');
        expect(line).toBe(14);
    });

    it('should parse correctly filename and line for a Go file when filename is in stack trace', () => {
        const {filename, line} = resolveFileAndLine(
            null,
            'com/ScaCap/action-surefire-report',
            'main_test.go:8: failing test',
            true,
        );
        expect(filename).toBe('main_test.go');
        expect(line).toBe(8);
    });
});

describe('resolvePath', () => {
    it('should find correct file for Java filename', async () => {
        const path = await resolvePath('EmailAddressTest');
        expect(path).toBe(
            'tests/email/src/test/java/action/surefire/report/email/EmailAddressTest.java'
        );
    });

    it('should find correct file for Kotlin filename', async () => {
        const path = await resolvePath('CalcUtilsTest');
        expect(path).toBe('tests/utils/src/test/java/action/surefire/report/calc/CalcUtilsTest.kt');
    });

    it('should find correct file when extension is included', async () => {
        const path = await resolvePath('CalcUtilsTest.kt');
        expect(path).toBe('tests/utils/src/test/java/action/surefire/report/calc/CalcUtilsTest.kt');
    });
});

describe('parseFile', () => {
    it('should parse CalcUtils results', async () => {
        const { count, skipped, annotations } = await parseFile(
            'tests/utils/target/surefire-reports/TEST-action.surefire.report.calc.CalcUtilsTest.xml'
        );

        expect(count).toBe(2);
        expect(skipped).toBe(0);
        expect(annotations).toStrictEqual([
            {
                path: 'tests/utils/src/test/java/action/surefire/report/calc/CalcUtilsTest.kt',
                start_line: 27,
                end_line: 27,
                start_column: 0,
                end_column: 0,
                annotation_level: 'failure',
                title: 'CalcUtilsTest.test error handling',
                message:
                    'unexpected exception type thrown; expected:<java.lang.IllegalStateException> but was:<java.lang.IllegalArgumentException>',
                raw_details:
                    'java.lang.AssertionError: unexpected exception type thrown; expected:<java.lang.IllegalStateException> but was:<java.lang.IllegalArgumentException>\n\tat action.surefire.report.calc.CalcUtilsTest.test error handling(CalcUtilsTest.kt:27)\nCaused by: java.lang.IllegalArgumentException: Amount must have max 2 non-zero decimal places\n\tat action.surefire.report.calc.CalcUtilsTest.scale(CalcUtilsTest.kt:31)\n\tat action.surefire.report.calc.CalcUtilsTest.access$scale(CalcUtilsTest.kt:9)\n\tat action.surefire.report.calc.CalcUtilsTest.test error handling(CalcUtilsTest.kt:27)'
            },
            {
                path: 'tests/utils/src/test/java/action/surefire/report/calc/CalcUtilsTest.kt',
                start_line: 15,
                end_line: 15,
                start_column: 0,
                end_column: 0,
                annotation_level: 'failure',
                title: 'CalcUtilsTest.test scale',
                message: 'Expected: <100.10>\n     but: was <100.11>',
                raw_details:
                    'java.lang.AssertionError: \n\nExpected: <100.10>\n     but: was <100.11>\n\tat action.surefire.report.calc.CalcUtilsTest.test scale(CalcUtilsTest.kt:15)'
            }
        ]);
    });
    it('should parse pytest results', async () => {
        const { count, skipped, annotations } = await parseFile('python/report.xml');

        expect(count).toBe(3);
        expect(skipped).toBe(0);
        expect(annotations).toStrictEqual([
            {
                path: 'python/test_sample.py',
                start_line: 10,
                end_line: 10,
                start_column: 0,
                end_column: 0,
                annotation_level: 'failure',
                title: 'test_sample.test_which_fails',
                message: "AssertionError: assert 'test' == 'xyz'\n  \n  - xyz\n  + test",
                raw_details:
                    "def test_which_fails():\n        event = { 'attr': 'test'}\n>       assert event['attr'] == 'xyz'\nE       AssertionError: assert 'test' == 'xyz'\nE         \nE         - xyz\nE         + test\n\npython/test_sample.py:10: AssertionError"
            },
            {
                path: 'python/test_sample.py',
                start_line: 14,
                end_line: 14,
                start_column: 0,
                end_column: 0,
                annotation_level: 'failure',
                title: 'test_sample.test_with_error',
                message: "AttributeError: 'dict' object has no attribute 'attr'",
                raw_details:
                    "def test_with_error():\n        event = { 'attr': 'test'}\n>       assert event.attr == 'test'\nE       AttributeError: 'dict' object has no attribute 'attr'\n\npython/test_sample.py:14: AttributeError"
            }
        ]);
    });
    it('should parse go results', async () => {
        const {count, skipped, annotations} = await parseFile('go/report.xml', true);

        expect(count).toBe(3);
        expect(skipped).toBe(0);
        // noinspection RegExpRepeatedSpace
        expect(annotations).toStrictEqual([
            {
                path: 'go/main_test.go',
                start_line: 12,
                end_line: 12,
                start_column: 0,
                end_column: 0,
                annotation_level: 'failure',
                title: 'main_test.go.TestFailing',
                message: 'Failed',
                raw_details: 'main_test.go:12: failing test'
            },
            {
                path: 'go/utils/string_test.go',
                start_line: 7,
                end_line: 7,
                start_column: 0,
                end_column: 0,
                annotation_level: 'failure',
                title: 'string_test.go.TestFailing',
                message: 'Failed',
                raw_details: expect.stringMatching(new RegExp(`string_test.go:7: 
\\s*Error Trace:.*action-surefire-report/go/utils/string_test.go:7
\\s*Error:     \\s*Not equal: 
\\s*expected: "1"
\\s*actual  : "2"
\\s*
\\s*Diff:
\\s*--- Expected
\\s*\\+\\+\\+ Actual
\\s*@@ -1 \\+1 @@
\\s*-1
\\s*\\+2
\\s*Test:\\s*TestFailing`))
            },
        ]);
    });
    it('should parse custom report with details as an array', async () => {
        const { count, skipped, annotations } = await parseFile(
            'custom_reports/TEST-pro.taskana.common.api.ListUtilTest-H2.xml'
        );

        expect(count).toBe(1);
        expect(skipped).toBe(0);
        expect(annotations).toStrictEqual([
            {
                path: 'pro/taskana/common/api/ListUtilTest(H2)',
                start_line: 22,
                end_line: 22,
                start_column: 0,
                end_column: 0,
                annotation_level: 'failure',
                title: 'ListUtilTest.should_SplitListIntoChunks_When_CallingPartitionBasedOnSize',
                message: 'java.lang.AssertionError:',
                raw_details:
                    'java.lang.AssertionError: \n' +
                    '\n' +
                    'Expected size:<11> but was:<10> in:\n' +
                    '<[[1,\n' +
                    '    2,\n' +
                    '    3,\n' +
                    '    4,\n' +
                    '    5,\n' +
                    '    6,\n' +
                    '    7,\n' +
                    '    96,\n' +
                    '    97,\n' +
                    '    98,\n' +
                    '    99,\n' +
                    '    100],\n' +
                    '    [101,\n' +
                    '    102,\n' +
                    '    103,\n' +
                    '    104,\n' +
                    '    194,\n' +
                    '    195,\n' +
                    '    196,\n' +
                    '    197,\n' +
                    '    198,\n' +
                    '    199,\n' +
                    '    200],\n' +
                    '    [201,\n' +
                    '    202,\n' +
                    '    997,\n' +
                    '    998,\n' +
                    '    999,\n' +
                    '    1000]]>\n' +
                    '\tat pro.taskana.common.api.ListUtilTest.should_SplitListIntoChunks_When_CallingPartitionBasedOnSize(ListUtilTest.java:22)'
            }
        ]);
    });

    it('should parse custom report with flaky failures', async () => {
        const { count, skipped, annotations } = await parseFile(
            'custom_reports/TEST-test.MyIntegrationTestSuite.xml'
        );

        expect(count).toBe(5);
        expect(skipped).toBe(0);
        expect(annotations).toStrictEqual([
            {
                path: 'test/MyIntegrationTest',
                start_line: 43,
                end_line: 43,
                start_column: 0,
                end_column: 0,
                annotation_level: 'failure',
                title: 'MyIntegrationTest.testGetMails',
                message:
                    'JSON path "$.mails[0].subject"\n' +
                    'Expected: "MySubject"\n' +
                    '     but: was "YourSubject"',
                raw_details:
                    'java.lang.AssertionError: \n' +
                    'JSON path "$.mails[0].subject"\n' +
                    'Expected: "MySubject"\n' +
                    '     but: was "YourSubject"\n' +
                    '	at test.MyIntegrationTest.testGetMails(MyIntegrationTest.java:43)\n' +
                    '\n' +
                    '      2021-02-05 09:11:05.249  INFO [,,,] 2909 --- [           main] o.s.b.t.m.w.SpringBootMockServletContext : Initializing Spring TestDispatcherServlet \'\'\n' +
                    '2021-02-05 09:11:05.249  INFO [,,,] 2909 --- [           main] o.s.t.web.servlet.TestDispatcherServlet  : Initializing Servlet \'\'\n' +
                    '2021-02-05 09:11:05.255  INFO [,,,] 2909 --- [           main] o.s.t.web.servlet.TestDispatcherServlet  : Completed initialization in 6 ms',
            },
            {
                path: 'test/DocumentUploadIntegrationTest',
                start_line: 33,
                end_line: 33,
                start_column: 0,
                end_column: 0,
                annotation_level: 'failure',
                title:
                    'DocumentUploadIntegrationTest.shouldReturnBadRequestIfDocumentTypeIsInvalid',
                message: 'Status expected:<400> but was:<403>',
                raw_details:
                    'java.lang.AssertionError: Status expected:<400> but was:<403>\n' +
                    '\tat test.DocumentUploadIntegrationTest.shouldReturnBadRequestIfDocumentTypeIsInvalid(DocumentUploadIntegrationTest.java:33)'
            },
            {
                path: 'test/DocumentUploadIntegrationTest',
                start_line: 23,
                end_line: 23,
                start_column: 0,
                end_column: 0,
                annotation_level: 'failure',
                title: 'DocumentUploadIntegrationTest.shouldReturnSuccessResponse',
                message: 'Status expected:<200> but was:<403>',
                raw_details:
                    'java.lang.AssertionError: Status expected:<200> but was:<403>\n' +
                    '	at test.DocumentUploadIntegrationTest.shouldReturnSuccessResponse(DocumentUploadIntegrationTest.java:23)\n' +
                    '\n' +
                    '      2021-02-05 09:11:11.668  INFO [,,,] 2909 --- [           main] o.s.b.t.m.w.SpringBootMockServletContext : Initializing Spring TestDispatcherServlet \'\'\n' +
                    '2021-02-05 09:11:11.668  INFO [,,,] 2909 --- [           main] o.s.t.web.servlet.TestDispatcherServlet  : Initializing Servlet \'\'\n' +
                    '2021-02-05 09:11:11.673  INFO [,,,] 2909 --- [           main] o.s.t.web.servlet.TestDispatcherServlet  : Completed initialization in 5 ms',
            },
            {
                path: 'test/DocumentUploadIntegrationTest',
                start_line: 47,
                end_line: 47,
                start_column: 0,
                end_column: 0,
                annotation_level: 'failure',
                title: 'DocumentUploadIntegrationTest.shouldReturnBadRequestIfDocumentSizeIsZero',
                message: 'Status expected:<400> but was:<403>',
                raw_details:
                    'java.lang.AssertionError: Status expected:<400> but was:<403>\n' +
                    '\tat test.DocumentUploadIntegrationTest.shouldReturnBadRequestIfDocumentSizeIsZero(DocumentUploadIntegrationTest.java:47)'
            }
        ]);
    });
});