vscode-extension-tester/out/util/codeUtil.d.ts

ExTester is a package that is designed to help you run UI tests for your Visual Studio Code extensions using selenium-webdriver.

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License", destination); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { logging } from 'selenium-webdriver';
export declare enum ReleaseQuality {
    Stable = "stable",
    Insider = "insider"
}
export interface RunOptions {
    /** version of VS Code to test against, defaults to latest */
    vscodeVersion?: string;
    /** path to custom settings json file */
    settings?: string;
    /** remove the extension's directory as well (if present) */
    cleanup?: boolean;
    /** path to a custom mocha configuration file */
    config?: string;
    /** logging level of the Webdriver */
    logLevel?: logging.Level;
    /** try to perform all setup without internet connection, needs all requirements pre-downloaded manually */
    offline?: boolean;
    /** list of resources to be opened by VS Code */
    resources: string[];
}
/** defaults for the [[RunOptions]] */
export declare const DEFAULT_RUN_OPTIONS: {
    vscodeVersion: string;
    settings: string;
    logLevel: logging.Level;
    offline: boolean;
    resources: never[];
    noCache: boolean;
};
/**
 * Handles the VS Code instance used for testing.
 * Includes downloading, unpacking, launching, and version checks.
 */
export declare class CodeUtil {
    private codeFolder;
    private downloadPlatform;
    private downloadFolder;
    private releaseType;
    private executablePath;
    private cliPath;
    private cliEnv;
    private availableVersions;
    private extensionsFolder;
    private coverage;
    private readonly env;
    /**
     * Create an instance of code handler
     * @param folder Path to folder where all the artifacts will be stored.
     * @param extensionsFolder Path to use as extensions directory by VS Code
     */
    constructor(folder?: string, type?: ReleaseQuality, extensionsFolder?: string, coverage?: boolean);
    /**
     * Get all versions for the given release stream
     */
    getVSCodeVersions(): Promise<string[]>;
    /**
     * Download and unpack VS Code for testing purposes
     *
     * @param version VS Code version to get, default latest
     * @param noCache whether to skip using cached version
     */
    downloadVSCode(version?: string, noCache?: boolean): Promise<void>;
    /**
     * Install your extension into the test instance of VS Code
     */
    installExtension(vsix?: string, id?: string, preRelease?: boolean): void;
    /**
     * Install extension dependencies from marketplace
     */
    installDependencies(): void;
    private getCliInitCommand;
    private installExt;
    /**
     * Open files/folders in running vscode
     * @param paths vararg paths to files or folders to open
     */
    open(...paths: string[]): void;
    /**
     * Download a vsix file
     * @param vsixURL URL of the vsix file
     */
    downloadExtension(vsixURL: string): Promise<string>;
    /**
     * Package extension into a vsix file
     * @param useYarn false to use npm as packaging system, true to use yarn instead
     */
    packageExtension(useYarn?: boolean): Promise<void>;
    /**
     * Uninstall the tested extension from the test instance of VS Code
     *
     * @param cleanup remove the extension's directory as well.
     */
    uninstallExtension(cleanup?: boolean): void;
    /**
     * Run tests in your test environment using mocha
     *
     * @param testFilesPattern glob pattern of test files to run
     * @param runOptions additional options for customizing the test run
     *
     * @return The exit code of the mocha process
     */
    runTests(testFilesPattern: string[], runOptions?: RunOptions): Promise<number>;
    /**
     * Finds the version of chromium used for given VS Code version.
     * Works only for versions 1.30+, older versions need to be checked manually
     *
     * @param codeVersion version of VS Code, default latest
     * @param quality release stream, default stable
     */
    getChromiumVersion(codeVersion?: string): Promise<string>;
    /**
     * Check if VS Code exists in local cache along with an appropriate version of chromedriver
     * without internet connection
     */
    checkOfflineRequirements(): string;
    /**
     * Attempt to get chromium version from a downloaded copy of vs code
     */
    getChromiumVersionOffline(): string;
    /**
     * Get the root folder of VS Code instance
     */
    getCodeFolder(): string;
    /**
     * Getter for coverage enablement option
     */
    get coverageEnabled(): boolean | undefined;
    /**
     * Check if given version is available in the given stream
     */
    private checkCodeVersion;
    /**
     * Check what VS Code version is present in the testing folder
     */
    private getExistingCodeVersion;
    /**
     * Construct the platform string based on OS
     */
    private getPlatform;
    /**
     * Setup paths specific to used OS
     */
    private findExecutables;
    /**
     * Parse JSON from a file
     * @param path path to json file
     */
    private parseSettings;
}