Function test_skipped_tests_comment

tests/python/ci/test_ci.py:253–321

Test that a comment with a link to the docs is successfully left on PRs

(
    caplog,
    tmpdir_factory,
    main_xml_file,
    main_xml_content,
    pr_xml_file,
    pr_xml_content,
    additional_tests_to_check,
    target_url,
    s3_prefix,
    jenkins_prefix,
    common_main_build,
    commit_sha,
    expected_body,
)

@parameterize_named(**TEST_DATA_SKIPPED_BOT)
# pylint: enable=line-too-long
def test_skipped_tests_comment(
    caplog,
    tmpdir_factory,
    main_xml_file,
    main_xml_content,
    pr_xml_file,
    pr_xml_content,
    additional_tests_to_check,
    target_url,
    s3_prefix,
    jenkins_prefix,
    common_main_build,
    commit_sha,
    expected_body,
):
    """
    Test that a comment with a link to the docs is successfully left on PRs
    """

    def write_xml_file(root_dir, xml_file, xml_content):
        shutil.rmtree(root_dir, ignore_errors=True)
        file = root_dir / xml_file
        file.parent.mkdir(parents=True)
        with open(file, "w") as f:
            f.write(textwrap.dedent(xml_content))

    git = TempGit(tmpdir_factory.mktemp("tmp_git_dir"))
    pr_test_report_dir = Path(git.cwd) / "pr-reports"
    write_xml_file(pr_test_report_dir, pr_xml_file, pr_xml_content)
    main_test_report_dir = Path(git.cwd) / "main-reports"
    write_xml_file(main_test_report_dir, main_xml_file, main_xml_content)
    with open(Path(git.cwd) / "required_tests_to_run.json", "w") as f:
        f.write(additional_tests_to_check)

    pr_data = {
        "commits": {
            "nodes": [
                {
                    "commit": {
                        "oid": commit_sha,
                        "statusCheckRollup": {
                            "contexts": {
                                "nodes": [
                                    {
                                        "context": "tvm-ci/pr-head",
                                        "targetUrl": target_url,
                                    }
                                ]
                            }
                        },
                    }
                }
            ]
        }
    }
    with caplog.at_level(logging.INFO):
        comment = scripts.github.github_skipped_tests_comment.get_skipped_tests_comment(
            pr=pr_data,