mongo/buildscripts/tests/resmokelib/test_parser.py

"""Unit tests for buildscripts/resmokelib/parser.py."""

import unittest
from unittest.mock import patch

from buildscripts.resmokelib.parser import parse, parse_command_line
from buildscripts.resmokelib.run import to_local_args


class TestLocalCommandLine(unittest.TestCase):
    """Unit tests for the to_local_args() function."""

    def test_keeps_any_positional_arguments(self):
        cmdline = to_local_args(
            [
                "run",
                "test_file1.js",
                "test_file2.js",
                "test_file3.js",
                "test_file4.js",
                "--suites=my_suite",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(
            cmdline,
            [
                "run",
                "--suites=my_suite",
                "--storageEngine=my_storage_engine",
                "test_file1.js",
                "test_file2.js",
                "test_file3.js",
                "test_file4.js",
            ],
        )

    def test_keeps_continue_on_failure_option(self):
        cmdline = to_local_args(
            [
                "run",
                "--suites=my_suite",
                "--continueOnFailure",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(
            cmdline,
            [
                "run",
                "--suites=my_suite",
                "--storageEngine=my_storage_engine",
                "--continueOnFailure",
            ],
        )

    def test_keeps_exclude_with_any_tags_option(self):
        cmdline = to_local_args(
            [
                "run",
                "--suites=my_suite",
                "--excludeWithAnyTags=tag1,tag2,tag4",
                "--excludeWithAnyTags=tag3,tag5",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(
            cmdline,
            [
                "run",
                "--suites=my_suite",
                "--storageEngine=my_storage_engine",
                "--excludeWithAnyTags=tag1,tag2,tag4",
                "--excludeWithAnyTags=tag3,tag5",
            ],
        )

    def test_keeps_include_with_any_tags_option(self):
        cmdline = to_local_args(
            [
                "run",
                "--suites=my_suite",
                "--includeWithAnyTags=tag1,tag2,tag4",
                "--includeWithAnyTags=tag3,tag5",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(
            cmdline,
            [
                "run",
                "--suites=my_suite",
                "--storageEngine=my_storage_engine",
                "--includeWithAnyTags=tag1,tag2,tag4",
                "--includeWithAnyTags=tag3,tag5",
            ],
        )

    def test_keeps_num_clients_per_fixture_option(self):
        cmdline = to_local_args(
            [
                "run",
                "--suites=my_suite",
                "--numClientsPerFixture=10",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(
            cmdline,
            [
                "run",
                "--suites=my_suite",
                "--storageEngine=my_storage_engine",
                "--numClientsPerFixture=10",
            ],
        )

    def test_keeps_repeat_options(self):
        cmdline = to_local_args(
            [
                "run",
                "--suites=my_suite",
                "--repeatSuites=1000",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(
            cmdline,
            [
                "run",
                "--suites=my_suite",
                "--storageEngine=my_storage_engine",
                "--repeatSuites=1000",
            ],
        )

        cmdline = to_local_args(
            [
                "run",
                "--suites=my_suite",
                "--repeatTests=1000",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(
            cmdline,
            [
                "run",
                "--suites=my_suite",
                "--storageEngine=my_storage_engine",
                "--repeatTests=1000",
            ],
        )

        cmdline = to_local_args(
            [
                "run",
                "--suites=my_suite",
                "--repeatTestsMax=1000",
                "--repeatTestsMin=20",
                "--repeatTestsSecs=300",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(
            cmdline,
            [
                "run",
                "--suites=my_suite",
                "--storageEngine=my_storage_engine",
                "--repeatTestsMax=1000",
                "--repeatTestsMin=20",
                "--repeatTestsSecs=300.0",
            ],
        )

    def test_keeps_shuffle_option(self):
        cmdline = to_local_args(
            [
                "run",
                "--suites=my_suite",
                "--shuffle",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(
            cmdline,
            [
                "run",
                "--suites=my_suite",
                "--storageEngine=my_storage_engine",
                "--shuffle",
            ],
        )

    def test_keeps_storage_engine_cache_size_option(self):
        cmdline = to_local_args(
            [
                "run",
                "--suites=my_suite",
                "--storageEngineCacheSizeGB=1",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(
            cmdline,
            [
                "run",
                "--suites=my_suite",
                "--storageEngine=my_storage_engine",
                "--storageEngineCacheSizeGB=1",
            ],
        )

    def test_origin_suite_option_replaces_suite_option(self):
        cmdline = to_local_args(
            [
                # We intentionally say --suite rather than --suites here to protect against this command
                # line option from becoming ambiguous if more similarly named command line options are
                # added in the future.
                "run",
                "--suite=part_of_my_suite",
                "--originSuite=my_entire_suite",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(
            cmdline, ["run", "--suites=my_entire_suite", "--storageEngine=my_storage_engine"]
        )

    def test_removes_archival_options(self):
        cmdline = to_local_args(
            [
                "run",
                "--suites=my_suite",
                "--archiveLimitMb=100",
                "--archiveLimitTests=10",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(cmdline, ["run", "--suites=my_suite", "--storageEngine=my_storage_engine"])

    def test_removes_evergreen_options(self):
        cmdline = to_local_args(
            [
                "run",
                "--suites=my_suite",
                "--buildId=some_build_id",
                "--distroId=some_distro_id",
                "--executionNumber=1",
                "--gitRevision=c0de",
                "--patchBuild",
                "--projectName=some_project",
                "--revisionOrderId=20",
                "--taskName=some_task",
                "--taskId=some_task_id",
                "--variantName=some_variant",
                "--versionId=some_version_id",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(cmdline, ["run", "--suites=my_suite", "--storageEngine=my_storage_engine"])


def test_removes_log_option(self):
    cmdline = to_local_args(
        [
            "run",
            "--suites=my_suite",
            "--log=evg",
            "--storageEngine=my_storage_engine",
        ]
    )

    self.assertEqual(cmdline, ["run", "--suites=my_suite", "--storageEngine=my_storage_engine"])

    def test_removes_report_file_options(self):
        cmdline = to_local_args(
            [
                "run",
                "--suites=my_suite",
                "--reportFile=report.json",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(cmdline, ["run", "--suites=my_suite", "--storageEngine=my_storage_engine"])

    def test_removes_stagger_jobs_option(self):
        cmdline = to_local_args(
            [
                "run",
                "--suites=my_suite",
                "--staggerJobs=on",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(cmdline, ["run", "--suites=my_suite", "--storageEngine=my_storage_engine"])

    def test_removes_tag_file_option(self):
        cmdline = to_local_args(
            [
                "run",
                "--suites=my_suite",
                "--tagFile=etc/test_retrial.yml",
                "--storageEngine=my_storage_engine",
            ]
        )

        self.assertEqual(cmdline, ["run", "--suites=my_suite", "--storageEngine=my_storage_engine"])

    def test_accepts_space_delimited_args(self):
        cmdline = to_local_args(
            [
                "run",
                "--suites",
                "my_suite",
                "--tagFile=etc/test_retrial.yml",
                "--storageEngine",
                "my_storage_engine",
                "--includeWithAnyTags",
                "tag1,tag2,tag4",
                "--includeWithAnyTags",
                "tag3,tag5",
            ]
        )

        self.assertEqual(
            cmdline,
            [
                "run",
                "--suites=my_suite",
                "--storageEngine=my_storage_engine",
                "--includeWithAnyTags=tag1,tag2,tag4",
                "--includeWithAnyTags=tag3,tag5",
            ],
        )


class TestParseArgs(unittest.TestCase):
    """Unit tests for the parse() function."""

    def test_files_at_end(self):
        _, args = parse(
            [
                "run",
                "--suites=my_suite1,my_suite2",
                "test_file1.js",
                "test_file2.js",
                "test_file3.js",
            ]
        )

        self.assertEqual(
            args["test_files"],
            [
                "test_file1.js",
                "test_file2.js",
                "test_file3.js",
            ],
        )
        # suites get split up when config.py gets populated
        self.assertEqual(args["suite_files"], "my_suite1,my_suite2")

    def test_files_in_the_middle(self):
        _, args = parse(
            [
                "run",
                "--storageEngine=my_storage_engine",
                "test_file1.js",
                "test_file2.js",
                "test_file3.js",
                "--suites=my_suite1",
            ]
        )

        self.assertEqual(
            args["test_files"],
            [
                "test_file1.js",
                "test_file2.js",
                "test_file3.js",
            ],
        )
        self.assertEqual(args["suite_files"], "my_suite1")


class TestParseCommandLine(unittest.TestCase):
    """Unit tests for the parse_command_line() function."""

    def test_find_suites(self):
        subcommand_obj = parse_command_line(["find-suites"], should_configure_otel=False)
        self.assertTrue(hasattr(subcommand_obj, "execute"))

    def test_list_suites(self):
        subcommand_obj = parse_command_line(["list-suites"], should_configure_otel=False)
        self.assertTrue(hasattr(subcommand_obj, "execute"))

    @patch("pathlib.Path.exists", return_value=True)
    def test_run(self, mock_exists):
        subcommand_obj = parse_command_line(
            ["run", "--suite=my_suite", "my_test.js"], should_configure_otel=False
        )

        self.assertTrue(hasattr(subcommand_obj, "execute"))

        mock_exists.assert_called_once()

    def test_run_fails_with_nonexistent_file(self):
        with self.assertRaises(SystemExit) as cm:
            parse_command_line(["run", "nonexistent_file.js"], should_configure_otel=False)
        self.assertEqual(cm.exception.code, 2)