settings.test.ts

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

import * as assert from "assert";
import * as vscode from "vscode";
import Settings = require("../../src/settings");

describe("Settings module", function() {
    it("Settings load without error", function() {
        assert.doesNotThrow(Settings.load);
    });

    it("Settings update correctly", async function() {
        // then syntax
        Settings.change("helpCompletion", "BlockComment", false).then(() =>
            assert.strictEqual(Settings.load().helpCompletion, "BlockComment"));

        // async/await syntax
        await Settings.change("helpCompletion", "LineComment", false);
        assert.strictEqual(Settings.load().helpCompletion, "LineComment");
    });

    it("Settings that can only be user settings update correctly", async function() {
        // set to false means it's set as a workspace-level setting so this should throw.
        const psExeDetails = [{
            versionName: "My PowerShell",
            exePath: "dummyPath",
        }];

        assert.rejects(async () => await Settings.change("powerShellAdditionalExePaths", psExeDetails, false));

        // set to true means it's a user-level setting so this should not throw.
        await Settings.change("powerShellAdditionalExePaths", psExeDetails, true);
        assert.strictEqual(Settings.load().powerShellAdditionalExePaths[0].versionName, psExeDetails[0].versionName);
    });

    it("Can get effective configuration target", async function() {
        await Settings.change("helpCompletion", "LineComment", false);
        let target = await Settings.getEffectiveConfigurationTarget("helpCompletion");
        assert.strictEqual(target, vscode.ConfigurationTarget.Workspace);

        await Settings.change("helpCompletion", undefined, false);
        target = await Settings.getEffectiveConfigurationTarget("helpCompletion");
        assert.strictEqual(target, null);
    });
});