Function configure

src/test/index.node.ts:81–135

* Configure the test environment and return the options required to run mocha tests.

()

 * Configure the test environment and return the options required to run mocha tests.
 */
async function configure(): Promise<SetupOptions> {
    process.env.VSC_JUPYTER_CI_TEST = '1';
    process.env.IS_MULTI_ROOT_TEST = IS_MULTI_ROOT_TEST().toString();

    // Check for a grep setting. Might be running a subset of the tests
    const defaultGrep = process.env.VSC_JUPYTER_CI_TEST_GREP;
    // Check whether to invert the grep (i.e. test everything that doesn't include the grep).
    const invert = (process.env.VSC_JUPYTER_CI_TEST_INVERT_GREP || '').length > 0;

    // If running on CI server and we're running the debugger tests, then ensure we only run debug tests.
    // We do this to ensure we only run debugger test, as debugger tests are very flaky on CI.
    // So the solution is to run them separately and first on CI.
    const grep = IS_CI_SERVER_TEST_DEBUGGER ? 'Debug' : defaultGrep;
    const testFilesSuffix = process.env.TEST_FILES_SUFFIX || '.test*';
    const testTimeout = process.env.VSC_JUPYTER_TEST_TIMEOUT || TEST_TIMEOUT;

    const options: SetupOptions & { retries: number; invert: boolean } = {
        ui: 'tdd',
        color: true,
        rootHooks: rootHooks,
        invert,
        timeout: testTimeout,
        retries: IS_CI_SERVER ? TEST_RETRYCOUNT : 0,
        grep,
        testFilesSuffix,
        // Force Mocha to exit after tests.
        exit: true
    };

    // Set up the CI reporter for
    // reporting to both the console (spec) and to a JUnit XML file. The xml file
    // written to is `test-report.xml` in the root folder by default, but can be
    // changed by setting env var `MOCHA_FILE` (we do this in our CI).
    options.reporter = 'mocha-multi-reporters';
    const customReporterPath = path.join(__dirname, 'web', 'customReporter.js');
    const reporterEnabled = ['spec', 'mocha-junit-reporter'];
    if (process.env.VSC_JUPYTER_FORCE_LOGGING) {
        // If verbose logging is enabled, then the output would contain verbose logs as well as test results
        // Hence enable a separate reporter. Else if we have this custom reporter too, we end up with duplicate messages in the terminal output.
        reporterEnabled.push(customReporterPath);
    }
    options.reporterOptions = {
        reporterEnabled: reporterEnabled.join(',')
    };

    // Linux: prevent a weird NPE when mocha on Linux requires the window size from the TTY.
    // Since we are not running in a tty environment, we just implement the method statically.
    // Use dynamic import for tty to avoid TypeScript type issues
    const tty = await import('tty');
    if (!(tty as any).getWindowSize) {
        (tty as any).getWindowSize = () => [80, 75];
    }

    return options;
}

/**
 * Waits until the Python Extension completes loading or a timeout.