22fd06e19b
This entirely removes `KeyMapping` from the settings model, and builds on the work done in #9543 to consolidate all actions (key bindings and commands) into a unified data structure (`ActionMap`). ## References #9428 - Spec #6900 - Actions page Closes #7441 ## Detailed Description of the Pull Request / Additional comments The important thing here is to remember that we're shifting our philosophy of how to interact/represent actions. Prior to this, the actions arrays in the JSON would be deserialized twice: once for key bindings, and again for commands. By thinking of every entry in the relevant JSON as a `Command`, we can remove a lot of the context switching between working with a key binding vs a command palette item. #9543 allows us to make that shift. Given the work in that PR, we can now deserialize all of the relevant information from each JSON action item. This allows us to simplify `ActionMap::FromJson` to simply iterate over each JSON action item, deserialize it, and add it to our `ActionMap`. Internally, our `ActionMap` operates as discussed in #9428 by maintaining a `_KeyMap` that points to an action ID, and using that action ID to retrieve the `Command` from the `_ActionMap`. Adding actions to the `ActionMap` automatically accounts for name/key-chord collisions. A `NameMap` can be constructed when requested; this is for the Command Palette. Querying the `ActionMap` is fairly straightforward. Helper functions were needed to be able to distinguish an explicit unbinding vs the command not being found in the current layer. Internally, we store explicitly unbound names/key-chords as `ShortcutAction::Invalid` commands. However, we return `nullptr` when a query points to an unbound command. This is done to hide this complexity away from any caller. The command palette still needs special handling for nested and iterable commands. Thankfully, the expansion of iterable commands is performed on an `IMapView`, so we can just expose `NameMap` as a consolidation of `ActionMap`'s `NameMap` with its parents. The same can be said for exposing key chords in nested commands. ## Validation Steps Performed All local tests pass.
1206 lines
57 KiB
C++
1206 lines
57 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#include "pch.h"
|
|
|
|
#include "../TerminalApp/TerminalPage.h"
|
|
#include "../LocalTests_SettingsModel/TestUtils.h"
|
|
|
|
using namespace Microsoft::Console;
|
|
using namespace WEX::Logging;
|
|
using namespace WEX::TestExecution;
|
|
using namespace WEX::Common;
|
|
using namespace winrt::TerminalApp;
|
|
using namespace winrt::Microsoft::Terminal::Settings::Model;
|
|
using namespace winrt::Microsoft::Terminal::Control;
|
|
|
|
namespace TerminalAppLocalTests
|
|
{
|
|
// TODO:microsoft/terminal#3838:
|
|
// Unfortunately, these tests _WILL NOT_ work in our CI. We're waiting for
|
|
// an updated TAEF that will let us install framework packages when the test
|
|
// package is deployed. Until then, these tests won't deploy in CI.
|
|
|
|
class SettingsTests
|
|
{
|
|
// Use a custom AppxManifest to ensure that we can activate winrt types
|
|
// from our test. This property will tell taef to manually use this as
|
|
// the AppxManifest for this test class.
|
|
// This does not yet work for anything XAML-y. See TabTests.cpp for more
|
|
// details on that.
|
|
BEGIN_TEST_CLASS(SettingsTests)
|
|
TEST_CLASS_PROPERTY(L"RunAs", L"UAP")
|
|
TEST_CLASS_PROPERTY(L"UAP:AppXManifest", L"TestHostAppXManifest.xml")
|
|
END_TEST_CLASS()
|
|
|
|
TEST_METHOD(TestIterateCommands);
|
|
TEST_METHOD(TestIterateOnGeneratedNamedCommands);
|
|
TEST_METHOD(TestIterateOnBadJson);
|
|
TEST_METHOD(TestNestedCommands);
|
|
TEST_METHOD(TestNestedInNestedCommand);
|
|
TEST_METHOD(TestNestedInIterableCommand);
|
|
TEST_METHOD(TestIterableInNestedCommand);
|
|
TEST_METHOD(TestMixedNestedAndIterableCommand);
|
|
|
|
TEST_METHOD(TestIterableColorSchemeCommands);
|
|
|
|
TEST_CLASS_SETUP(ClassSetup)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
private:
|
|
void _logCommandNames(winrt::Windows::Foundation::Collections::IMapView<winrt::hstring, Command> commands, const int indentation = 1)
|
|
{
|
|
if (indentation == 1)
|
|
{
|
|
Log::Comment((commands.Size() == 0) ? L"Commands:\n <none>" : L"Commands:");
|
|
}
|
|
for (const auto& nameAndCommand : commands)
|
|
{
|
|
Log::Comment(fmt::format(L"{0:>{1}}* {2}->{3}",
|
|
L"",
|
|
indentation,
|
|
nameAndCommand.Key(),
|
|
nameAndCommand.Value().Name())
|
|
.c_str());
|
|
|
|
if (nameAndCommand.Value().HasNestedCommands())
|
|
{
|
|
_logCommandNames(nameAndCommand.Value().NestedCommands(), indentation + 2);
|
|
}
|
|
}
|
|
}
|
|
};
|
|
|
|
void SettingsTests::TestIterateCommands()
|
|
{
|
|
// For this test, put an iterable command with a given `name`,
|
|
// containing a ${profile.name} to replace. When we expand it, it should
|
|
// have created one command for each profile.
|
|
|
|
const std::string settingsJson{ R"(
|
|
{
|
|
"defaultProfile": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"profiles": [
|
|
{
|
|
"name": "profile0",
|
|
"guid": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 1,
|
|
"commandline": "cmd.exe"
|
|
},
|
|
{
|
|
"name": "profile1",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 2,
|
|
"commandline": "pwsh.exe"
|
|
},
|
|
{
|
|
"name": "profile2",
|
|
"historySize": 3,
|
|
"commandline": "wsl.exe"
|
|
}
|
|
],
|
|
"actions": [
|
|
{
|
|
"name": "iterable command ${profile.name}",
|
|
"iterateOn": "profiles",
|
|
"command": { "action": "splitPane", "profile": "${profile.name}" }
|
|
},
|
|
],
|
|
"schemes": [ { "name": "Campbell" } ] // This is included here to prevent settings validation errors.
|
|
})" };
|
|
|
|
const auto guid0 = ::Microsoft::Console::Utils::GuidFromString(L"{6239a42c-0000-49a3-80bd-e8fdd045185c}");
|
|
const auto guid1 = ::Microsoft::Console::Utils::GuidFromString(L"{6239a42c-1111-49a3-80bd-e8fdd045185c}");
|
|
|
|
CascadiaSettings settings{ til::u8u16(settingsJson) };
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
|
|
VERIFY_ARE_EQUAL(3u, settings.ActiveProfiles().Size());
|
|
|
|
auto nameMap{ settings.ActionMap().NameMap() };
|
|
VERIFY_ARE_EQUAL(1u, nameMap.Size());
|
|
|
|
{
|
|
auto command = nameMap.TryLookup(L"iterable command ${profile.name}");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"${profile.name}", realArgs.TerminalArgs().Profile());
|
|
}
|
|
|
|
auto expandedCommands = winrt::TerminalApp::implementation::TerminalPage::_ExpandCommands(nameMap, settings.ActiveProfiles().GetView(), settings.GlobalSettings().ColorSchemes());
|
|
_logCommandNames(expandedCommands.GetView());
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
VERIFY_ARE_EQUAL(3u, expandedCommands.Size());
|
|
|
|
{
|
|
auto command = expandedCommands.Lookup(L"iterable command profile0");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"profile0", realArgs.TerminalArgs().Profile());
|
|
}
|
|
|
|
{
|
|
auto command = expandedCommands.Lookup(L"iterable command profile1");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"profile1", realArgs.TerminalArgs().Profile());
|
|
}
|
|
|
|
{
|
|
auto command = expandedCommands.Lookup(L"iterable command profile2");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"profile2", realArgs.TerminalArgs().Profile());
|
|
}
|
|
}
|
|
|
|
void SettingsTests::TestIterateOnGeneratedNamedCommands()
|
|
{
|
|
// For this test, put an iterable command without a given `name` to
|
|
// replace. When we expand it, it should still work.
|
|
|
|
const std::string settingsJson{ R"(
|
|
{
|
|
"defaultProfile": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"profiles": [
|
|
{
|
|
"name": "profile0",
|
|
"guid": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 1,
|
|
"commandline": "cmd.exe"
|
|
},
|
|
{
|
|
"name": "profile1",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 2,
|
|
"commandline": "pwsh.exe"
|
|
},
|
|
{
|
|
"name": "profile2",
|
|
"historySize": 3,
|
|
"commandline": "wsl.exe"
|
|
}
|
|
],
|
|
"actions": [
|
|
{
|
|
"iterateOn": "profiles",
|
|
"command": { "action": "splitPane", "profile": "${profile.name}" }
|
|
},
|
|
],
|
|
"schemes": [ { "name": "Campbell" } ] // This is included here to prevent settings validation errors.
|
|
})" };
|
|
|
|
const auto guid0 = ::Microsoft::Console::Utils::GuidFromString(L"{6239a42c-0000-49a3-80bd-e8fdd045185c}");
|
|
const auto guid1 = ::Microsoft::Console::Utils::GuidFromString(L"{6239a42c-1111-49a3-80bd-e8fdd045185c}");
|
|
|
|
CascadiaSettings settings{ til::u8u16(settingsJson) };
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
|
|
VERIFY_ARE_EQUAL(3u, settings.ActiveProfiles().Size());
|
|
|
|
auto nameMap{ settings.ActionMap().NameMap() };
|
|
VERIFY_ARE_EQUAL(1u, nameMap.Size());
|
|
|
|
{
|
|
auto command = nameMap.TryLookup(L"Split pane, profile: ${profile.name}");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"${profile.name}", realArgs.TerminalArgs().Profile());
|
|
}
|
|
|
|
auto expandedCommands = winrt::TerminalApp::implementation::TerminalPage::_ExpandCommands(nameMap, settings.ActiveProfiles().GetView(), settings.GlobalSettings().ColorSchemes());
|
|
_logCommandNames(expandedCommands.GetView());
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
VERIFY_ARE_EQUAL(3u, expandedCommands.Size());
|
|
|
|
{
|
|
auto command = expandedCommands.Lookup(L"Split pane, profile: profile0");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"profile0", realArgs.TerminalArgs().Profile());
|
|
}
|
|
|
|
{
|
|
auto command = expandedCommands.Lookup(L"Split pane, profile: profile1");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"profile1", realArgs.TerminalArgs().Profile());
|
|
}
|
|
|
|
{
|
|
auto command = expandedCommands.Lookup(L"Split pane, profile: profile2");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"profile2", realArgs.TerminalArgs().Profile());
|
|
}
|
|
}
|
|
|
|
void SettingsTests::TestIterateOnBadJson()
|
|
{
|
|
// For this test, put an iterable command with a profile name that would
|
|
// cause bad json to be filled in. Something like a profile with a name
|
|
// of "Foo\"", so the trailing '"' might break the json parsing.
|
|
|
|
const std::string settingsJson{ R"(
|
|
{
|
|
"defaultProfile": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"profiles": [
|
|
{
|
|
"name": "profile0",
|
|
"guid": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 1,
|
|
"commandline": "cmd.exe"
|
|
},
|
|
{
|
|
"name": "profile1\"",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 2,
|
|
"commandline": "pwsh.exe"
|
|
},
|
|
{
|
|
"name": "profile2",
|
|
"historySize": 3,
|
|
"commandline": "wsl.exe"
|
|
}
|
|
],
|
|
"actions": [
|
|
{
|
|
"name": "iterable command ${profile.name}",
|
|
"iterateOn": "profiles",
|
|
"command": { "action": "splitPane", "profile": "${profile.name}" }
|
|
},
|
|
],
|
|
"schemes": [ { "name": "Campbell" } ] // This is included here to prevent settings validation errors.
|
|
})" };
|
|
|
|
const auto guid0 = ::Microsoft::Console::Utils::GuidFromString(L"{6239a42c-0000-49a3-80bd-e8fdd045185c}");
|
|
const auto guid1 = ::Microsoft::Console::Utils::GuidFromString(L"{6239a42c-1111-49a3-80bd-e8fdd045185c}");
|
|
|
|
CascadiaSettings settings{ til::u8u16(settingsJson) };
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
|
|
VERIFY_ARE_EQUAL(3u, settings.ActiveProfiles().Size());
|
|
|
|
auto nameMap{ settings.ActionMap().NameMap() };
|
|
VERIFY_ARE_EQUAL(1u, nameMap.Size());
|
|
|
|
{
|
|
auto command = nameMap.TryLookup(L"iterable command ${profile.name}");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"${profile.name}", realArgs.TerminalArgs().Profile());
|
|
}
|
|
|
|
auto expandedCommands = winrt::TerminalApp::implementation::TerminalPage::_ExpandCommands(nameMap, settings.ActiveProfiles().GetView(), settings.GlobalSettings().ColorSchemes());
|
|
_logCommandNames(expandedCommands.GetView());
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
VERIFY_ARE_EQUAL(3u, expandedCommands.Size());
|
|
|
|
{
|
|
auto command = expandedCommands.Lookup(L"iterable command profile0");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"profile0", realArgs.TerminalArgs().Profile());
|
|
}
|
|
|
|
{
|
|
auto command = expandedCommands.Lookup(L"iterable command profile1\"");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"profile1\"", realArgs.TerminalArgs().Profile());
|
|
}
|
|
|
|
{
|
|
auto command = expandedCommands.Lookup(L"iterable command profile2");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"profile2", realArgs.TerminalArgs().Profile());
|
|
}
|
|
}
|
|
|
|
void SettingsTests::TestNestedCommands()
|
|
{
|
|
// This test checks a nested command.
|
|
// The commands should look like:
|
|
//
|
|
// <Command Palette>
|
|
// └─ Connect to ssh...
|
|
// ├─ first.com
|
|
// └─ second.com
|
|
|
|
const std::string settingsJson{ R"(
|
|
{
|
|
"defaultProfile": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"profiles": [
|
|
{
|
|
"name": "profile0",
|
|
"guid": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 1,
|
|
"commandline": "cmd.exe"
|
|
},
|
|
{
|
|
"name": "profile1",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 2,
|
|
"commandline": "pwsh.exe"
|
|
},
|
|
{
|
|
"name": "profile2",
|
|
"historySize": 3,
|
|
"commandline": "wsl.exe"
|
|
}
|
|
],
|
|
"actions": [
|
|
{
|
|
"name": "Connect to ssh...",
|
|
"commands": [
|
|
{
|
|
"name": "first.com",
|
|
"command": { "action": "newTab", "commandline": "ssh me@first.com" }
|
|
},
|
|
{
|
|
"name": "second.com",
|
|
"command": { "action": "newTab", "commandline": "ssh me@second.com" }
|
|
}
|
|
]
|
|
},
|
|
],
|
|
"schemes": [ { "name": "Campbell" } ] // This is included here to prevent settings validation errors.
|
|
})" };
|
|
|
|
CascadiaSettings settings{ til::u8u16(settingsJson) };
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
VERIFY_ARE_EQUAL(3u, settings.ActiveProfiles().Size());
|
|
|
|
auto expandedCommands = winrt::TerminalApp::implementation::TerminalPage::_ExpandCommands(settings.ActionMap().NameMap(), settings.ActiveProfiles().GetView(), settings.GlobalSettings().ColorSchemes());
|
|
_logCommandNames(expandedCommands.GetView());
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
VERIFY_ARE_EQUAL(1u, expandedCommands.Size());
|
|
|
|
auto rootCommand = expandedCommands.Lookup(L"Connect to ssh...");
|
|
VERIFY_IS_NOT_NULL(rootCommand);
|
|
auto rootActionAndArgs = rootCommand.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(rootActionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::Invalid, rootActionAndArgs.Action());
|
|
|
|
VERIFY_ARE_EQUAL(2u, rootCommand.NestedCommands().Size());
|
|
|
|
{
|
|
winrt::hstring commandName{ L"first.com" };
|
|
auto command = rootCommand.NestedCommands().Lookup(commandName);
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
|
|
VERIFY_IS_FALSE(command.HasNestedCommands());
|
|
}
|
|
{
|
|
winrt::hstring commandName{ L"second.com" };
|
|
auto command = rootCommand.NestedCommands().Lookup(commandName);
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
|
|
VERIFY_IS_FALSE(command.HasNestedCommands());
|
|
}
|
|
}
|
|
|
|
void SettingsTests::TestNestedInNestedCommand()
|
|
{
|
|
// This test checks a nested command that includes nested commands.
|
|
// The commands should look like:
|
|
//
|
|
// <Command Palette>
|
|
// └─ grandparent
|
|
// └─ parent
|
|
// ├─ child1
|
|
// └─ child2
|
|
|
|
const std::string settingsJson{ R"(
|
|
{
|
|
"defaultProfile": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"profiles": [
|
|
{
|
|
"name": "profile0",
|
|
"guid": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 1,
|
|
"commandline": "cmd.exe"
|
|
},
|
|
{
|
|
"name": "profile1",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 2,
|
|
"commandline": "pwsh.exe"
|
|
},
|
|
{
|
|
"name": "profile2",
|
|
"historySize": 3,
|
|
"commandline": "wsl.exe"
|
|
}
|
|
],
|
|
"actions": [
|
|
{
|
|
"name": "grandparent",
|
|
"commands": [
|
|
{
|
|
"name": "parent",
|
|
"commands": [
|
|
{
|
|
"name": "child1",
|
|
"command": { "action": "newTab", "commandline": "ssh me@first.com" }
|
|
},
|
|
{
|
|
"name": "child2",
|
|
"command": { "action": "newTab", "commandline": "ssh me@second.com" }
|
|
}
|
|
]
|
|
},
|
|
]
|
|
},
|
|
],
|
|
"schemes": [ { "name": "Campbell" } ] // This is included here to prevent settings validation errors.
|
|
})" };
|
|
|
|
CascadiaSettings settings{ til::u8u16(settingsJson) };
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
VERIFY_ARE_EQUAL(3u, settings.ActiveProfiles().Size());
|
|
|
|
auto expandedCommands = winrt::TerminalApp::implementation::TerminalPage::_ExpandCommands(settings.ActionMap().NameMap(), settings.ActiveProfiles().GetView(), settings.GlobalSettings().ColorSchemes());
|
|
_logCommandNames(expandedCommands.GetView());
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
VERIFY_ARE_EQUAL(1u, expandedCommands.Size());
|
|
|
|
auto grandparentCommand = expandedCommands.Lookup(L"grandparent");
|
|
VERIFY_IS_NOT_NULL(grandparentCommand);
|
|
auto grandparentActionAndArgs = grandparentCommand.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(grandparentActionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::Invalid, grandparentActionAndArgs.Action());
|
|
|
|
VERIFY_ARE_EQUAL(1u, grandparentCommand.NestedCommands().Size());
|
|
|
|
winrt::hstring parentName{ L"parent" };
|
|
auto parent = grandparentCommand.NestedCommands().Lookup(parentName);
|
|
VERIFY_IS_NOT_NULL(parent);
|
|
auto parentActionAndArgs = parent.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(parentActionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::Invalid, parentActionAndArgs.Action());
|
|
|
|
VERIFY_ARE_EQUAL(2u, parent.NestedCommands().Size());
|
|
{
|
|
winrt::hstring childName{ L"child1" };
|
|
auto child = parent.NestedCommands().Lookup(childName);
|
|
VERIFY_IS_NOT_NULL(child);
|
|
auto childActionAndArgs = child.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(childActionAndArgs);
|
|
|
|
VERIFY_ARE_EQUAL(ShortcutAction::NewTab, childActionAndArgs.Action());
|
|
const auto& realArgs = childActionAndArgs.Args().try_as<NewTabArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"ssh me@first.com", realArgs.TerminalArgs().Commandline());
|
|
|
|
VERIFY_IS_FALSE(child.HasNestedCommands());
|
|
}
|
|
{
|
|
winrt::hstring childName{ L"child2" };
|
|
auto child = parent.NestedCommands().Lookup(childName);
|
|
VERIFY_IS_NOT_NULL(child);
|
|
auto childActionAndArgs = child.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(childActionAndArgs);
|
|
|
|
VERIFY_ARE_EQUAL(ShortcutAction::NewTab, childActionAndArgs.Action());
|
|
const auto& realArgs = childActionAndArgs.Args().try_as<NewTabArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"ssh me@second.com", realArgs.TerminalArgs().Commandline());
|
|
|
|
VERIFY_IS_FALSE(child.HasNestedCommands());
|
|
}
|
|
}
|
|
|
|
void SettingsTests::TestNestedInIterableCommand()
|
|
{
|
|
// This test checks a iterable command that includes a nested command.
|
|
// The commands should look like:
|
|
//
|
|
// <Command Palette>
|
|
// ├─ profile0...
|
|
// | ├─ Split pane, profile: profile0
|
|
// | ├─ Split pane, direction: vertical, profile: profile0
|
|
// | └─ Split pane, direction: horizontal, profile: profile0
|
|
// ├─ profile1...
|
|
// | ├─Split pane, profile: profile1
|
|
// | ├─Split pane, direction: vertical, profile: profile1
|
|
// | └─Split pane, direction: horizontal, profile: profile1
|
|
// └─ profile2...
|
|
// ├─ Split pane, profile: profile2
|
|
// ├─ Split pane, direction: vertical, profile: profile2
|
|
// └─ Split pane, direction: horizontal, profile: profile2
|
|
|
|
const std::string settingsJson{ R"(
|
|
{
|
|
"defaultProfile": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"profiles": [
|
|
{
|
|
"name": "profile0",
|
|
"guid": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 1,
|
|
"commandline": "cmd.exe"
|
|
},
|
|
{
|
|
"name": "profile1",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 2,
|
|
"commandline": "pwsh.exe"
|
|
},
|
|
{
|
|
"name": "profile2",
|
|
"historySize": 3,
|
|
"commandline": "wsl.exe"
|
|
}
|
|
],
|
|
"actions": [
|
|
{
|
|
"iterateOn": "profiles",
|
|
"name": "${profile.name}...",
|
|
"commands": [
|
|
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "auto" } },
|
|
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "vertical" } },
|
|
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "horizontal" } }
|
|
]
|
|
}
|
|
],
|
|
"schemes": [ { "name": "Campbell" } ] // This is included here to prevent settings validation errors.
|
|
})" };
|
|
|
|
CascadiaSettings settings{ til::u8u16(settingsJson) };
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
VERIFY_ARE_EQUAL(3u, settings.ActiveProfiles().Size());
|
|
|
|
auto expandedCommands = winrt::TerminalApp::implementation::TerminalPage::_ExpandCommands(settings.ActionMap().NameMap(), settings.ActiveProfiles().GetView(), settings.GlobalSettings().ColorSchemes());
|
|
_logCommandNames(expandedCommands.GetView());
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
|
|
VERIFY_ARE_EQUAL(3u, expandedCommands.Size());
|
|
|
|
for (auto name : std::vector<std::wstring>({ L"profile0", L"profile1", L"profile2" }))
|
|
{
|
|
winrt::hstring commandName{ name + L"..." };
|
|
auto command = expandedCommands.Lookup(commandName);
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::Invalid, actionAndArgs.Action());
|
|
|
|
VERIFY_IS_TRUE(command.HasNestedCommands());
|
|
VERIFY_ARE_EQUAL(3u, command.NestedCommands().Size());
|
|
_logCommandNames(command.NestedCommands());
|
|
{
|
|
winrt::hstring childCommandName{ fmt::format(L"Split pane, profile: {}", name) };
|
|
auto childCommand = command.NestedCommands().Lookup(childCommandName);
|
|
VERIFY_IS_NOT_NULL(childCommand);
|
|
auto childActionAndArgs = childCommand.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(childActionAndArgs);
|
|
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, childActionAndArgs.Action());
|
|
const auto& realArgs = childActionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(name, realArgs.TerminalArgs().Profile());
|
|
|
|
VERIFY_IS_FALSE(childCommand.HasNestedCommands());
|
|
}
|
|
{
|
|
winrt::hstring childCommandName{ fmt::format(L"Split pane, split: horizontal, profile: {}", name) };
|
|
auto childCommand = command.NestedCommands().Lookup(childCommandName);
|
|
VERIFY_IS_NOT_NULL(childCommand);
|
|
auto childActionAndArgs = childCommand.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(childActionAndArgs);
|
|
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, childActionAndArgs.Action());
|
|
const auto& realArgs = childActionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Horizontal, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(name, realArgs.TerminalArgs().Profile());
|
|
|
|
VERIFY_IS_FALSE(childCommand.HasNestedCommands());
|
|
}
|
|
{
|
|
winrt::hstring childCommandName{ fmt::format(L"Split pane, split: vertical, profile: {}", name) };
|
|
auto childCommand = command.NestedCommands().Lookup(childCommandName);
|
|
VERIFY_IS_NOT_NULL(childCommand);
|
|
auto childActionAndArgs = childCommand.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(childActionAndArgs);
|
|
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, childActionAndArgs.Action());
|
|
const auto& realArgs = childActionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Vertical, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(name, realArgs.TerminalArgs().Profile());
|
|
|
|
VERIFY_IS_FALSE(childCommand.HasNestedCommands());
|
|
}
|
|
}
|
|
}
|
|
|
|
void SettingsTests::TestIterableInNestedCommand()
|
|
{
|
|
// This test checks a nested command that includes an iterable command.
|
|
// The commands should look like:
|
|
//
|
|
// <Command Palette>
|
|
// └─ New Tab With Profile...
|
|
// ├─ Profile 1
|
|
// ├─ Profile 2
|
|
// └─ Profile 3
|
|
|
|
const std::string settingsJson{ R"(
|
|
{
|
|
"defaultProfile": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"profiles": [
|
|
{
|
|
"name": "profile0",
|
|
"guid": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 1,
|
|
"commandline": "cmd.exe"
|
|
},
|
|
{
|
|
"name": "profile1",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 2,
|
|
"commandline": "pwsh.exe"
|
|
},
|
|
{
|
|
"name": "profile2",
|
|
"historySize": 3,
|
|
"commandline": "wsl.exe"
|
|
}
|
|
],
|
|
"actions": [
|
|
{
|
|
"name": "New Tab With Profile...",
|
|
"commands": [
|
|
{
|
|
"iterateOn": "profiles",
|
|
"command": { "action": "newTab", "profile": "${profile.name}" }
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"schemes": [ { "name": "Campbell" } ] // This is included here to prevent settings validation errors.
|
|
})" };
|
|
|
|
CascadiaSettings settings{ til::u8u16(settingsJson) };
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
VERIFY_ARE_EQUAL(3u, settings.ActiveProfiles().Size());
|
|
|
|
auto expandedCommands = winrt::TerminalApp::implementation::TerminalPage::_ExpandCommands(settings.ActionMap().NameMap(), settings.ActiveProfiles().GetView(), settings.GlobalSettings().ColorSchemes());
|
|
_logCommandNames(expandedCommands.GetView());
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
VERIFY_ARE_EQUAL(1u, expandedCommands.Size());
|
|
|
|
auto rootCommand = expandedCommands.Lookup(L"New Tab With Profile...");
|
|
VERIFY_IS_NOT_NULL(rootCommand);
|
|
auto rootActionAndArgs = rootCommand.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(rootActionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::Invalid, rootActionAndArgs.Action());
|
|
|
|
VERIFY_ARE_EQUAL(3u, rootCommand.NestedCommands().Size());
|
|
|
|
for (auto name : std::vector<std::wstring>({ L"profile0", L"profile1", L"profile2" }))
|
|
{
|
|
winrt::hstring commandName{ fmt::format(L"New tab, profile: {}", name) };
|
|
auto command = rootCommand.NestedCommands().Lookup(commandName);
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
|
|
VERIFY_ARE_EQUAL(ShortcutAction::NewTab, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<NewTabArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(name, realArgs.TerminalArgs().Profile());
|
|
|
|
VERIFY_IS_FALSE(command.HasNestedCommands());
|
|
}
|
|
}
|
|
void SettingsTests::TestMixedNestedAndIterableCommand()
|
|
{
|
|
// This test checks a nested commands that includes an iterable command
|
|
// that includes a nested command.
|
|
// The commands should look like:
|
|
//
|
|
// <Command Palette>
|
|
// └─ New Pane...
|
|
// ├─ profile0...
|
|
// | ├─ Split automatically
|
|
// | ├─ Split vertically
|
|
// | └─ Split horizontally
|
|
// ├─ profile1...
|
|
// | ├─ Split automatically
|
|
// | ├─ Split vertically
|
|
// | └─ Split horizontally
|
|
// └─ profile2...
|
|
// ├─ Split automatically
|
|
// ├─ Split vertically
|
|
// └─ Split horizontally
|
|
|
|
const std::string settingsJson{ R"(
|
|
{
|
|
"defaultProfile": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"profiles": [
|
|
{
|
|
"name": "profile0",
|
|
"guid": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 1,
|
|
"commandline": "cmd.exe"
|
|
},
|
|
{
|
|
"name": "profile1",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 2,
|
|
"commandline": "pwsh.exe"
|
|
},
|
|
{
|
|
"name": "profile2",
|
|
"historySize": 3,
|
|
"commandline": "wsl.exe"
|
|
}
|
|
],
|
|
"actions": [
|
|
{
|
|
"name": "New Pane...",
|
|
"commands": [
|
|
{
|
|
"iterateOn": "profiles",
|
|
"name": "${profile.name}...",
|
|
"commands": [
|
|
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "auto" } },
|
|
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "vertical" } },
|
|
{ "command": { "action": "splitPane", "profile": "${profile.name}", "split": "horizontal" } }
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"schemes": [ { "name": "Campbell" } ] // This is included here to prevent settings validation errors.
|
|
})" };
|
|
|
|
CascadiaSettings settings{ til::u8u16(settingsJson) };
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
VERIFY_ARE_EQUAL(3u, settings.ActiveProfiles().Size());
|
|
|
|
auto expandedCommands = winrt::TerminalApp::implementation::TerminalPage::_ExpandCommands(settings.ActionMap().NameMap(), settings.ActiveProfiles().GetView(), settings.GlobalSettings().ColorSchemes());
|
|
_logCommandNames(expandedCommands.GetView());
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings.Warnings().Size());
|
|
VERIFY_ARE_EQUAL(1u, expandedCommands.Size());
|
|
|
|
auto rootCommand = expandedCommands.Lookup(L"New Pane...");
|
|
VERIFY_IS_NOT_NULL(rootCommand);
|
|
auto rootActionAndArgs = rootCommand.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(rootActionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::Invalid, rootActionAndArgs.Action());
|
|
|
|
VERIFY_ARE_EQUAL(3u, rootCommand.NestedCommands().Size());
|
|
|
|
for (auto name : std::vector<std::wstring>({ L"profile0", L"profile1", L"profile2" }))
|
|
{
|
|
winrt::hstring commandName{ name + L"..." };
|
|
auto command = rootCommand.NestedCommands().Lookup(commandName);
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::Invalid, actionAndArgs.Action());
|
|
|
|
VERIFY_IS_TRUE(command.HasNestedCommands());
|
|
VERIFY_ARE_EQUAL(3u, command.NestedCommands().Size());
|
|
|
|
_logCommandNames(command.NestedCommands());
|
|
{
|
|
winrt::hstring childCommandName{ fmt::format(L"Split pane, profile: {}", name) };
|
|
auto childCommand = command.NestedCommands().Lookup(childCommandName);
|
|
VERIFY_IS_NOT_NULL(childCommand);
|
|
auto childActionAndArgs = childCommand.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(childActionAndArgs);
|
|
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, childActionAndArgs.Action());
|
|
const auto& realArgs = childActionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(name, realArgs.TerminalArgs().Profile());
|
|
|
|
VERIFY_IS_FALSE(childCommand.HasNestedCommands());
|
|
}
|
|
{
|
|
winrt::hstring childCommandName{ fmt::format(L"Split pane, split: horizontal, profile: {}", name) };
|
|
auto childCommand = command.NestedCommands().Lookup(childCommandName);
|
|
VERIFY_IS_NOT_NULL(childCommand);
|
|
auto childActionAndArgs = childCommand.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(childActionAndArgs);
|
|
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, childActionAndArgs.Action());
|
|
const auto& realArgs = childActionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Horizontal, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(name, realArgs.TerminalArgs().Profile());
|
|
|
|
VERIFY_IS_FALSE(childCommand.HasNestedCommands());
|
|
}
|
|
{
|
|
winrt::hstring childCommandName{ fmt::format(L"Split pane, split: vertical, profile: {}", name) };
|
|
auto childCommand = command.NestedCommands().Lookup(childCommandName);
|
|
VERIFY_IS_NOT_NULL(childCommand);
|
|
auto childActionAndArgs = childCommand.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(childActionAndArgs);
|
|
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, childActionAndArgs.Action());
|
|
const auto& realArgs = childActionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Vertical, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(name, realArgs.TerminalArgs().Profile());
|
|
|
|
VERIFY_IS_FALSE(childCommand.HasNestedCommands());
|
|
}
|
|
}
|
|
}
|
|
|
|
void SettingsTests::TestIterableColorSchemeCommands()
|
|
{
|
|
// For this test, put an iterable command with a given `name`,
|
|
// containing a ${profile.name} to replace. When we expand it, it should
|
|
// have created one command for each profile.
|
|
|
|
const std::string settingsJson{ R"(
|
|
{
|
|
"defaultProfile": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"profiles": [
|
|
{
|
|
"name": "profile0",
|
|
"guid": "{6239a42c-0000-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 1,
|
|
"commandline": "cmd.exe"
|
|
},
|
|
{
|
|
"name": "profile1",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}",
|
|
"historySize": 2,
|
|
"commandline": "pwsh.exe"
|
|
},
|
|
{
|
|
"name": "profile2",
|
|
"historySize": 3,
|
|
"commandline": "wsl.exe"
|
|
}
|
|
],
|
|
"schemes": [
|
|
{ "name": "scheme_0" },
|
|
{ "name": "scheme_1" },
|
|
{ "name": "scheme_2" },
|
|
],
|
|
"actions": [
|
|
{
|
|
"name": "iterable command ${scheme.name}",
|
|
"iterateOn": "schemes",
|
|
"command": { "action": "splitPane", "profile": "${scheme.name}" }
|
|
},
|
|
]
|
|
})" };
|
|
|
|
CascadiaSettings settings{ til::u8u16(settingsJson) };
|
|
|
|
// Since at least one profile does not reference a color scheme,
|
|
// we add a warning saying "the color scheme is unknown"
|
|
VERIFY_ARE_EQUAL(1u, settings.Warnings().Size());
|
|
|
|
VERIFY_ARE_EQUAL(3u, settings.ActiveProfiles().Size());
|
|
|
|
auto nameMap{ settings.ActionMap().NameMap() };
|
|
VERIFY_ARE_EQUAL(1u, nameMap.Size());
|
|
|
|
{
|
|
auto command = nameMap.TryLookup(L"iterable command ${scheme.name}");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"${scheme.name}", realArgs.TerminalArgs().Profile());
|
|
}
|
|
|
|
auto expandedCommands = winrt::TerminalApp::implementation::TerminalPage::_ExpandCommands(nameMap, settings.ActiveProfiles().GetView(), settings.GlobalSettings().ColorSchemes());
|
|
_logCommandNames(expandedCommands.GetView());
|
|
|
|
// This is the same warning as above
|
|
VERIFY_ARE_EQUAL(1u, settings.Warnings().Size());
|
|
VERIFY_ARE_EQUAL(3u, expandedCommands.Size());
|
|
|
|
// Yes, this test is testing splitPane with profiles named after each
|
|
// color scheme. These would obviously not work in real life, they're
|
|
// just easy tests to write.
|
|
|
|
{
|
|
auto command = expandedCommands.Lookup(L"iterable command scheme_0");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"scheme_0", realArgs.TerminalArgs().Profile());
|
|
}
|
|
|
|
{
|
|
auto command = expandedCommands.Lookup(L"iterable command scheme_1");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"scheme_1", realArgs.TerminalArgs().Profile());
|
|
}
|
|
|
|
{
|
|
auto command = expandedCommands.Lookup(L"iterable command scheme_2");
|
|
VERIFY_IS_NOT_NULL(command);
|
|
auto actionAndArgs = command.ActionAndArgs();
|
|
VERIFY_IS_NOT_NULL(actionAndArgs);
|
|
VERIFY_ARE_EQUAL(ShortcutAction::SplitPane, actionAndArgs.Action());
|
|
const auto& realArgs = actionAndArgs.Args().try_as<SplitPaneArgs>();
|
|
VERIFY_IS_NOT_NULL(realArgs);
|
|
// Verify the args have the expected value
|
|
VERIFY_ARE_EQUAL(SplitState::Automatic, realArgs.SplitStyle());
|
|
VERIFY_IS_NOT_NULL(realArgs.TerminalArgs());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().Commandline().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().StartingDirectory().empty());
|
|
VERIFY_IS_TRUE(realArgs.TerminalArgs().TabTitle().empty());
|
|
VERIFY_IS_FALSE(realArgs.TerminalArgs().Profile().empty());
|
|
VERIFY_ARE_EQUAL(L"scheme_2", realArgs.TerminalArgs().Profile());
|
|
}
|
|
}
|
|
|
|
}
|