ISECompatibility.test.ts

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

import * as assert from "assert";
import * as vscode from "vscode";
import { ISECompatibilityFeature } from "../../src/features/ISECompatibility";
import utils = require("../utils");

describe("ISE compatibility feature", function () {
    let currentTheme: string | undefined;

    async function enableISEMode(): Promise<void> { await vscode.commands.executeCommand("PowerShell.EnableISEMode"); }
    async function disableISEMode(): Promise<void> { await vscode.commands.executeCommand("PowerShell.DisableISEMode"); }
    async function toggleISEMode(): Promise<void> { await vscode.commands.executeCommand("PowerShell.ToggleISEMode"); }

    before(async function () {
        // Save user's current theme.
        currentTheme = await vscode.workspace.getConfiguration("workbench").get("colorTheme");
        await utils.ensureEditorServicesIsConnected();
    });

    after(async function () {
        // Reset user's current theme.
        await vscode.workspace.getConfiguration("workbench").update("colorTheme", currentTheme, true);
        assert.strictEqual(vscode.workspace.getConfiguration("workbench").get("colorTheme"), currentTheme);
    });

    describe("Enable ISE Mode updates expected settings", function () {
        before(enableISEMode);
        after(disableISEMode);
        for (const iseSetting of ISECompatibilityFeature.settings) {
            it(`Sets ${iseSetting.name} correctly`, function () {
                const currently = vscode.workspace.getConfiguration(iseSetting.path).get(iseSetting.name);
                assert.strictEqual(currently, iseSetting.value);
            });
        }
    });

    describe("Disable ISE Mode reverts expected settings", function () {
        before(enableISEMode);
        before(disableISEMode);
        after(disableISEMode);
        for (const iseSetting of ISECompatibilityFeature.settings) {
            it(`Reverts ${iseSetting.name} correctly`, function () {
                const currently = vscode.workspace.getConfiguration(iseSetting.path).get(iseSetting.name);
                assert.notStrictEqual(currently, iseSetting.value);
            });
        }
    });

    describe("Toggle switches from enabled to disabled", function () {
        before(enableISEMode);
        before(toggleISEMode);
        after(disableISEMode);
        for (const iseSetting of ISECompatibilityFeature.settings) {
            it(`Reverts ${iseSetting.name} correctly`, function () {
                const currently = vscode.workspace.getConfiguration(iseSetting.path).get(iseSetting.name);
                assert.notStrictEqual(currently, iseSetting.value);
            });
        }
    });

    describe("Toggle switches from disabled to enabled", function () {
        before(disableISEMode);
        before(toggleISEMode);
        after(disableISEMode);
        for (const iseSetting of ISECompatibilityFeature.settings) {
            it(`Sets ${iseSetting.name} correctly`, function () {
                const currently = vscode.workspace.getConfiguration(iseSetting.path).get(iseSetting.name);
                assert.strictEqual(currently, iseSetting.value);
            });
        }
    });

    describe("Color theme interactions", function () {
        beforeEach(enableISEMode);

        function assertISESettings(): void {
            for (const iseSetting of ISECompatibilityFeature.settings) {
                const currently = vscode.workspace.getConfiguration(iseSetting.path).get(iseSetting.name);
                assert.notStrictEqual(currently, iseSetting.value);
            }
        }

        it("Changes the theme back from PowerShell ISE", async function () {
            // Change state to something that DisableISEMode will change
            await vscode.workspace.getConfiguration("workbench").update("colorTheme", "PowerShell ISE", true);
            assert.strictEqual(vscode.workspace.getConfiguration("workbench").get("colorTheme"), "PowerShell ISE");
            await disableISEMode();
            assertISESettings();
        });

        it("Doesn't change theme if it was manually changed", async function () {
            assert.strictEqual(vscode.workspace.getConfiguration("workbench").get("colorTheme"), "PowerShell ISE");
            // "Manually" change theme after enabling ISE mode. Use a built-in theme but not the default.
            await vscode.workspace.getConfiguration("workbench").update("colorTheme", "Monokai", true);
            assert.strictEqual(vscode.workspace.getConfiguration("workbench").get("colorTheme"), "Monokai");
            await disableISEMode();
            assertISESettings();
            assert.strictEqual(vscode.workspace.getConfiguration("workbench").get("colorTheme"), "Monokai");
        });
    });
});