mongo/buildscripts/resmokelib/testing/testcases/jstest.py

"""The unittest.TestCase for JavaScript tests."""

import copy
import os
import os.path
import random
import shutil
import string
import sys
import threading
import uuid
from typing import Optional

from bson.objectid import ObjectId

from buildscripts.resmokelib import config, core, errors, logging, utils
from buildscripts.resmokelib.testing.testcases import interface
from buildscripts.resmokelib.utils import registry


class _SingleJSTestCase(interface.ProcessTestCase):
    """A jstest to execute."""

    REGISTERED_NAME = registry.LEAVE_UNREGISTERED

    def __init__(
        self,
        logger: logging.Logger,
        js_filenames: list[str],
        test_name: str,
        _id: uuid.UUID,
        shell_executable: Optional[str] = None,
        shell_options: Optional[dict] = None,
    ):
        """Initialize the _SingleJSTestCase with the JS file to run."""
        interface.ProcessTestCase.__init__(self, logger, "JSTest", test_name)

        # Command line options override the YAML configuration.
        self.shell_executable: Optional[str] = utils.default_if_none(
            config.MONGO_EXECUTABLE, shell_executable
        )

        self.js_filenames = js_filenames
        self._id = _id
        self.shell_options: dict = utils.default_if_none(shell_options, {}).copy()

    def configure(self, fixture: "interface.Fixture", *args, **kwargs):
        """Configure the jstest."""
        interface.ProcessTestCase.configure(self, fixture, *args, **kwargs)

    def configure_shell(self):
        """Set up the global variables for the shell, and data/ directory for the mongod.

        configure_shell() only needs to be called once per test. Therefore if creating multiple
        _SingleJSTestCase instances to be run in parallel, only call configure_shell() on one of
        them.
        """
        global_vars = self.shell_options.get("global_vars", {}).copy()
        data_dir = self._get_data_dir(global_vars)

        # Set MongoRunner.dataPath if overridden at command line or not specified in YAML.
        if config.DBPATH_PREFIX is not None or "MongoRunner.dataPath" not in global_vars:
            # dataPath property is the dataDir property with a trailing slash.
            data_path = os.path.join(data_dir, "")
        else:
            data_path = os.path.join(os.path.abspath(global_vars["MongoRunner.dataPath"]), "")

        global_vars["MongoRunner.dataDir"] = data_dir
        global_vars["MongoRunner.dataPath"] = data_path

        test_data = global_vars.get("TestData", {}).copy()
        test_run_id = "".join(random.choices(string.ascii_letters + string.digits, k=10))
        self.fixture.test_run_id = test_run_id
        test_data["test_run_id"] = test_run_id
        test_data["minPort"] = core.network.PortAllocator.min_test_port(self.fixture.job_num)
        test_data["maxPort"] = core.network.PortAllocator.max_test_port(self.fixture.job_num)
        test_data["peerPids"] = self.fixture.pids()
        test_data["alwaysUseLogFiles"] = config.ALWAYS_USE_LOG_FILES
        test_data["ignoreUnterminatedProcesses"] = False
        test_data["ignoreChildProcessErrorCode"] = False

        if config.MOZJS_JS_GC_ZEAL:
            test_data["mozJSGCZeal"] = config.MOZJS_JS_GC_ZEAL

        # The tests in 'timeseries' directory need to use a different logic for implicity sharding
        # the collection. Make sure that we consider both unix and windows directory structures.
        # Check if any test being run is a timeseries test
        for js_filename in self.js_filenames:
            is_timeseries_file = "/timeseries/" in js_filename or "\\timeseries\\" in js_filename
            test_data["implicitlyShardOnCreateCollectionOnly"] = is_timeseries_file
            if is_timeseries_file:
                break

        global_vars["TestData"] = test_data
        self.shell_options["global_vars"] = global_vars

        shutil.rmtree(data_dir, ignore_errors=True)

        try:
            os.makedirs(data_dir)
        except os.error:
            # Directory already exists.
            pass

        process_kwargs = copy.deepcopy(self.shell_options.get("process_kwargs", {}))

        if (
            process_kwargs
            and "env_vars" in process_kwargs
            and "KRB5_CONFIG" in process_kwargs["env_vars"]
            and "KRB5CCNAME" not in process_kwargs["env_vars"]
        ):
            # Use a job-specific credential cache for JavaScript tests involving Kerberos.
            krb5_dir = os.path.join(data_dir, "krb5")

            try:
                os.makedirs(krb5_dir)
            except os.error:
                pass

            process_kwargs["env_vars"]["KRB5CCNAME"] = "DIR:" + krb5_dir

        interface.append_process_tracking_options(process_kwargs, self._id)

        self.shell_options["process_kwargs"] = process_kwargs

    def _get_data_dir(self, global_vars: dict) -> str:
        """Return the value that mongo shell should set for the MongoRunner.dataDir property."""
        # Command line options override the YAML configuration.
        data_dir_prefix = utils.default_if_none(
            config.DBPATH_PREFIX, global_vars.get("MongoRunner.dataDir")
        )
        data_dir_prefix = utils.default_if_none(data_dir_prefix, config.DEFAULT_DBPATH_PREFIX)
        return os.path.abspath(
            os.path.join(
                data_dir_prefix, "job%d" % self.fixture.job_num, config.MONGO_RUNNER_SUBDIR
            )
        )

    def _make_process(self) -> "process.Process":
        return core.programs.mongo_shell_program(
            self.logger,
            executable=self.shell_executable,
            filenames=self.js_filenames,
            test_name=os.path.splitext(os.path.basename(self.test_name))[0],
            connection_string=self.fixture.get_shell_connection_url(),
            **self.shell_options,
        )


class JSTestCaseBuilder(interface.TestCaseFactory):
    """Build the real TestCase in the JSTestCase wrapper."""

    def __init__(
        self,
        logger: logging.Logger,
        js_filenames: list[str],
        test_name: str,
        test_id: uuid.UUID,
        shell_executable: Optional[str] = None,
        shell_options: Optional[dict] = None,
    ):
        """Initialize the JSTestCase with the JS file to run."""
        self.test_case_template = _SingleJSTestCase(
            logger, js_filenames, test_name, test_id, shell_executable, shell_options
        )
        interface.TestCaseFactory.__init__(self, _SingleJSTestCase, shell_options)

    def configure(self, fixture: "interface.Fixture", *args, **kwargs):
        """Configure the jstest."""
        self.test_case_template.configure(fixture, *args, **kwargs)
        self.test_case_template.configure_shell()
        self.shell_options = self.test_case_template.shell_options

    def make_process(self) -> "process.Process":
        # This function should only be called by MultiClientsTestCase's _make_process().
        return self.test_case_template._make_process()

    def create_test_case(self, logger: logging.Logger, shell_options: dict) -> _SingleJSTestCase:
        test_case = _SingleJSTestCase(
            logger,
            self.test_case_template.js_filenames,
            self.test_case_template.test_name,
            self.test_case_template._id,
            self.test_case_template.shell_executable,
            shell_options,
        )
        test_case.configure(self.test_case_template.fixture)
        return test_case


class MultiClientsTestCase(interface.TestCase):
    """A wrapper for several copies of a SingleTestCase to execute."""

    REGISTERED_NAME = registry.LEAVE_UNREGISTERED
    DEFAULT_CLIENT_NUM = 1

    class ThreadWithException(threading.Thread):
        """A wrapper for the thread class that lets us propagate exceptions."""

        def __init__(self, *args, **kwargs):
            """Initialize JSTestCase."""
            threading.Thread.__init__(self, *args, **kwargs)
            self.exc_info = None

        def run(self):
            """Run the jstest."""
            try:
                threading.Thread.run(self)
            except:
                self.exc_info = sys.exc_info()

    def __init__(
        self,
        logger: logging.Logger,
        test_kind: str,
        test_name: str,
        test_id: uuid.UUID,
        factory: interface.TestCaseFactory,
    ):
        """Initialize the TestCase for running test."""
        super().__init__(logger, test_kind, test_name)
        self._id = test_id
        self.num_clients = MultiClientsTestCase.DEFAULT_CLIENT_NUM
        self.use_tenant_client = False
        self._factory = factory
        self._child_test_cases = []

    def configure(
        self,
        fixture: "interface.Fixture",
        num_clients: int = DEFAULT_CLIENT_NUM,
        use_tenant_client: bool = False,
        *args,
        **kwargs,
    ):
        """Configure the test case and its factory."""
        super().configure(fixture, *args, **kwargs)
        self.num_clients = num_clients
        self.use_tenant_client = use_tenant_client
        self._factory.configure(fixture, *args, **kwargs)

    def _make_process(self):
        # This function should only be called by interface.py's as_command().
        return self._factory.make_process()

    def _run_single_copy(self):
        tenant_id = str(ObjectId()) if self.use_tenant_client else None
        test_case = self._factory.create_test_case_for_thread(
            self.logger, num_clients=1, thread_id=0, tenant_id=tenant_id
        )
        self._child_test_cases = [test_case]

        try:
            test_case.run_test()
            # If there was an exception, it will be logged in test_case's run_test function.
        finally:
            self.return_code = test_case.return_code
            self._raise_if_unsafe_exit(self.return_code)

    def _run_multiple_copies(self):
        threads = []
        try:
            # If there are multiple clients, make a new thread for each client.
            for thread_id in range(self.num_clients):
                tenant_id = str(ObjectId()) if self.use_tenant_client else None
                logger = logging.loggers.new_test_thread_logger(
                    self.logger, self.test_kind, str(thread_id), tenant_id
                )
                test_case = self._factory.create_test_case_for_thread(
                    logger, num_clients=self.num_clients, thread_id=thread_id, tenant_id=tenant_id
                )
                self._child_test_cases.append(test_case)

                thread = self.ThreadWithException(target=test_case.run_test)
                threads.append(thread)
                thread.start()
        except:
            self.logger.exception(
                "Encountered an error starting threads for jstest %s.", self.basename()
            )
            raise
        finally:
            for thread in threads:
                thread.join()

            # Go through each test's return codes, asserting safe exits and storing the last nonzero code.
            return_code = 0
            for test_case in self._child_test_cases:
                if test_case.return_code != 0:
                    self._raise_if_unsafe_exit(return_code)
                    return_code = test_case.return_code
            self.return_code = return_code

            for thread_id, thread in enumerate(threads):
                if thread.exc_info is not None:
                    if not isinstance(thread.exc_info[1], self.failureException):
                        self.logger.error(
                            "Encountered an error inside thread %d running jstest %s.",
                            thread_id,
                            self.basename(),
                            exc_info=thread.exc_info,
                        )
                    raise thread.exc_info[1]

    def run_test(self):
        """Execute the test."""
        if self.num_clients == 1:
            self._run_single_copy()
        else:
            self._run_multiple_copies()

    def on_timeout(self):
        self.timed_out.set()
        for testcase in self._child_test_cases:
            testcase.on_timeout()

    def _raise_if_unsafe_exit(self, return_code: int):
        """Determine if a return code represents and unsafe exit."""
        if self.timed_out.is_set():
            # If the test timed out, it is assumed a non-zero exit code is
            # from the hang-analyzer intentionally killing the process.
            return
        # 252 and 253 may be returned in failed test executions.
        # (i.e. -4 and -3 in mongo_main.cpp)
        if return_code not in (252, 253, 0):
            self.propagate_error = errors.UnsafeExitError(
                f"Mongo shell exited with code {return_code} while running jstest {self.basename()}."
                " Further test execution may be unsafe."
            )
            raise self.propagate_error


class JSTestCase(MultiClientsTestCase):
    """A wrapper for several copies of a _SingleJSTestCase to execute."""

    REGISTERED_NAME = "js_test"
    TEST_KIND = "JSTest"

    def __init__(
        self,
        logger: logging.Logger,
        js_filenames: list[str],
        shell_executable: Optional[str] = None,
        shell_options: Optional[dict] = None,
    ):
        """Initialize the TestCase for running JS files."""
        assert len(js_filenames) >= 1
        test_id = uuid.uuid4()
        if len(js_filenames) > 1:
            test_name = "combination_test"
        else:
            test_name = js_filenames[0]
        factory = JSTestCaseBuilder(
            logger,
            js_filenames,
            test_name,
            test_id,
            shell_executable,
            shell_options,
        )
        MultiClientsTestCase.__init__(self, logger, self.TEST_KIND, test_name, test_id, factory)


class AllVersionsJSTestCase(JSTestCase):
    """
    Alias for JSTestCase for multiversion passthrough suites.

    It runs with all combinations of versions of replica sets and sharded clusters.
    The distinct name is picked up by task generation.
    """

    REGISTERED_NAME = "all_versions_js_test"