8ba8f35dc5
This PR represents the start of the work on Cascading User + default settings, #754. Cascading settings will be done in two parts: * [ ] Layered Default+User settings (this PR) * [ ] Dynamic Profile Generation (#2603). Until _both_ are done, _neither are going in. The dynamic profiles PR will target this PR when it's ready, but will go in as a separate commit into master. This PR covers adding one primary feature: the settings are now in two separate files: * a static `defaults.json` that ships with the package (the "default settings") * a `profiles.json` with the user's customizations (the "user settings) User settings are _layered_ upon the settings in the defaults settings. ## References Other things that might be related here: * #1378 - This seems like it's definitely fixed. The default keybindings are _much_ cleaner, and without the save-on-load behavior, the user's keybindings will be left in a good state * #1398 - This might have honestly been solved by #2475 ## PR Checklist * [x] Closes #754 * [x] Closes #1378 * [x] Closes #2566 * [x] I work here * [x] Tests added/passed * [x] Requires documentation to be updated - it **ABSOLUTELY DOES** ## Detailed Description of the Pull Request / Additional comments 1. We start by taking all of the `FromJson` functions in Profile, ColorScheme, Globals, etc, and converting them to `LayerJson` methods. These are effectively the same, with the change that instead of building a new object, they are simply layering the values on top of `this` object. 2. Next, we add tests for layering properties like that. 3. Now, we add a `defaults.json` to the package. This is the file the users can refer to as our default settings. 4. We then take that `defaults.json` and stamp it into an auto generated `.h` file, so we can use it's data without having to worry about reading it from disk. 5. We then change the `LoadAll` function in `CascadiaSettings`. Now, the function does two loads - one from the defaults, and then a second load from the `profiles.json` file, layering the settings from each source upon the previous values. 6. If the `profiles.json` file doesn't exist, we'll create it from a hardcoded `userDefaults.json`, which is stamped in similar to how `defaults.json` is. 7. We also add support for _unbinding_ keybindings that might exist in the `defaults.json`, but the user doesn't want to be bound to anything. 8. We add support for _hiding_ a profile, which is useful if a user doesn't want one of the default profiles to appear in the list of profiles. ## TODO: * [x] Still need to make Alt+Click work on the settings button * [x] Need to write some user documentation on how the new settings model works * [x] Fix the pair of tests I broke (re: Duplicate profiles) <hr> * Create profiles by layering them * Update test to layer multiple times on the same profile * Add support for layering an array of profiles, but break a couple tests * Add a defaults.json to the package * Layer colorschemes * Moves tests into individual classes * adds support for layering a colorscheme on top of another * Layer an array of color schemes * oh no, this was missed with #2481 must have committed without staging this change, uh oh. Not like those tests actually work so nbd * Layer keybindings * Read settings from defaults.json + profiles.json, layer appropriately This is like 80% of #754. Needs tests. * Add tests for keybindings * add support to unbind a key with `null` or `"unbound"` or `"garbage"` * Layer or clear optional properties * Add a helper to get an optional variable for a bunch of different types In the end, I think we need to ask _was this worth it_ * Do this with the stretch mode too * Add back in the GUID check for profiles * Add some tests for global settings layering * M A D W I T H P O W E R Add a MsBuild target to auto-generate a header with the defaults.json as a string in the file. That way, we can _always_ load the defaults. Literally impossible to not. * When the user's profile.json doesn't exist, create it from a template * Re-order profiles to match the order set in the user's profiles.json * Add tests for re-ordering profiles to match user ordering * Add support for hiding profiles using `"hidden": true` * Use the hardcoded defaults.json for the exception->"use defaults" case * Somehow I messed up the git submodules? * woo documentation * Fix a Terminal.App.Unit.Tests failure * signed/unsigned is hard * Use Alt+Settings button to open the default settings * Missed a signed/unsigned * Some very preliminary PR feedback * More PR feedback Use the wil helper for the exe path Move jsonutils into their own file kill some dead code * Add templates to these bois * remove some code for generating defaults, reorder defaults.json a tad * Make guid a std::optional * Large block of PR feedback * Remove some dead code * add some comments * tag some todos * stl is love, stl is life * add `-noprofile` * Fix the crash that dustin found * -Encoding ASCII * Set a profile's default scheme to Campbell * Fix the tests I regressed * Update UsingJsonSetting.md to reflect that changes from these PRs * Change how GenerateGuidForProfile works * Make AppKeyBindings do its own serialization * Remove leftover dead code from the previous commit * Fix up an enormous number of PR nits * Fix a typo; Update the defaults to match #2378 * Tiny nits * Some typos, PR nits * Fix this broken defaults case
297 lines
13 KiB
C++
297 lines
13 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#include "precomp.h"
|
|
|
|
#include "../TerminalApp/ColorScheme.h"
|
|
#include "../TerminalApp/CascadiaSettings.h"
|
|
#include "JsonTestClass.h"
|
|
|
|
using namespace Microsoft::Console;
|
|
using namespace TerminalApp;
|
|
using namespace WEX::Logging;
|
|
using namespace WEX::TestExecution;
|
|
using namespace WEX::Common;
|
|
|
|
namespace TerminalAppLocalTests
|
|
{
|
|
// Unfortunately, these tests _WILL NOT_ work in our CI, until we have a lab
|
|
// machine available that can run Windows version 18362.
|
|
|
|
class ProfileTests : public JsonTestClass
|
|
{
|
|
// Use a custom manifest to ensure that we can activate winrt types from
|
|
// our test. This property will tell taef to manually use this as the
|
|
// sxs manifest during this test class. It includes all the cppwinrt
|
|
// types we've defined, so if your test is crashing for an unknown
|
|
// reason, make sure it's included in that file.
|
|
// If you want to do anything XAML-y, you'll need to run your test in a
|
|
// packaged context. See TabTests.cpp for more details on that.
|
|
BEGIN_TEST_CLASS(ProfileTests)
|
|
TEST_CLASS_PROPERTY(L"ActivationContext", L"TerminalApp.LocalTests.manifest")
|
|
END_TEST_CLASS()
|
|
|
|
TEST_METHOD(CanLayerProfile);
|
|
TEST_METHOD(LayerProfileProperties);
|
|
TEST_METHOD(LayerProfileIcon);
|
|
TEST_METHOD(LayerProfilesOnArray);
|
|
|
|
TEST_CLASS_SETUP(ClassSetup)
|
|
{
|
|
InitializeJsonReader();
|
|
return true;
|
|
}
|
|
};
|
|
|
|
void ProfileTests::CanLayerProfile()
|
|
{
|
|
const std::string profile0String{ R"({
|
|
"name" : "profile0",
|
|
"guid" : "{6239a42c-1111-49a3-80bd-e8fdd045185c}"
|
|
})" };
|
|
const std::string profile1String{ R"({
|
|
"name" : "profile1",
|
|
"guid" : "{6239a42c-2222-49a3-80bd-e8fdd045185c}"
|
|
})" };
|
|
const std::string profile2String{ R"({
|
|
"name" : "profile2",
|
|
"guid" : "{6239a42c-1111-49a3-80bd-e8fdd045185c}"
|
|
})" };
|
|
const std::string profile3String{ R"({
|
|
"name" : "profile3"
|
|
})" };
|
|
|
|
const auto profile0Json = VerifyParseSucceeded(profile0String);
|
|
const auto profile1Json = VerifyParseSucceeded(profile1String);
|
|
const auto profile2Json = VerifyParseSucceeded(profile2String);
|
|
const auto profile3Json = VerifyParseSucceeded(profile3String);
|
|
|
|
const auto profile0 = Profile::FromJson(profile0Json);
|
|
|
|
VERIFY_IS_FALSE(profile0.ShouldBeLayered(profile1Json));
|
|
VERIFY_IS_TRUE(profile0.ShouldBeLayered(profile2Json));
|
|
VERIFY_IS_FALSE(profile0.ShouldBeLayered(profile3Json));
|
|
|
|
const auto profile1 = Profile::FromJson(profile1Json);
|
|
|
|
VERIFY_IS_FALSE(profile1.ShouldBeLayered(profile0Json));
|
|
// A profile _can_ be layered with itself, though what's the point?
|
|
VERIFY_IS_TRUE(profile1.ShouldBeLayered(profile1Json));
|
|
VERIFY_IS_FALSE(profile1.ShouldBeLayered(profile2Json));
|
|
VERIFY_IS_FALSE(profile1.ShouldBeLayered(profile3Json));
|
|
|
|
const auto profile3 = Profile::FromJson(profile3Json);
|
|
|
|
VERIFY_IS_FALSE(profile3.ShouldBeLayered(profile0Json));
|
|
// A profile _can_ be layered with itself, though what's the point?
|
|
VERIFY_IS_FALSE(profile3.ShouldBeLayered(profile1Json));
|
|
VERIFY_IS_FALSE(profile3.ShouldBeLayered(profile2Json));
|
|
VERIFY_IS_FALSE(profile3.ShouldBeLayered(profile3Json));
|
|
}
|
|
|
|
void ProfileTests::LayerProfileProperties()
|
|
{
|
|
const std::string profile0String{ R"({
|
|
"name": "profile0",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}",
|
|
"foreground": "#000000",
|
|
"background": "#010101"
|
|
})" };
|
|
const std::string profile1String{ R"({
|
|
"name": "profile1",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}",
|
|
"foreground": "#020202",
|
|
"startingDirectory": "C:/"
|
|
})" };
|
|
const std::string profile2String{ R"({
|
|
"name": "profile2",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}",
|
|
"foreground": "#030303"
|
|
})" };
|
|
|
|
const auto profile0Json = VerifyParseSucceeded(profile0String);
|
|
const auto profile1Json = VerifyParseSucceeded(profile1String);
|
|
const auto profile2Json = VerifyParseSucceeded(profile2String);
|
|
|
|
auto profile0 = Profile::FromJson(profile0Json);
|
|
VERIFY_IS_TRUE(profile0._defaultForeground.has_value());
|
|
VERIFY_ARE_EQUAL(ARGB(0, 0, 0, 0), profile0._defaultForeground.value());
|
|
|
|
VERIFY_IS_TRUE(profile0._defaultBackground.has_value());
|
|
VERIFY_ARE_EQUAL(ARGB(0, 1, 1, 1), profile0._defaultBackground.value());
|
|
|
|
VERIFY_ARE_EQUAL(L"profile0", profile0._name);
|
|
|
|
VERIFY_IS_FALSE(profile0._startingDirectory.has_value());
|
|
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Layering profile1 on top of profile0"));
|
|
profile0.LayerJson(profile1Json);
|
|
|
|
VERIFY_IS_TRUE(profile0._defaultForeground.has_value());
|
|
VERIFY_ARE_EQUAL(ARGB(0, 2, 2, 2), profile0._defaultForeground.value());
|
|
|
|
VERIFY_IS_TRUE(profile0._defaultBackground.has_value());
|
|
VERIFY_ARE_EQUAL(ARGB(0, 1, 1, 1), profile0._defaultBackground.value());
|
|
|
|
VERIFY_ARE_EQUAL(L"profile1", profile0._name);
|
|
|
|
VERIFY_IS_TRUE(profile0._startingDirectory.has_value());
|
|
VERIFY_ARE_EQUAL(L"C:/", profile0._startingDirectory.value());
|
|
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Layering profile2 on top of (profile0+profile1)"));
|
|
profile0.LayerJson(profile2Json);
|
|
|
|
VERIFY_IS_TRUE(profile0._defaultForeground.has_value());
|
|
VERIFY_ARE_EQUAL(ARGB(0, 3, 3, 3), profile0._defaultForeground.value());
|
|
|
|
VERIFY_IS_TRUE(profile0._defaultBackground.has_value());
|
|
VERIFY_ARE_EQUAL(ARGB(0, 1, 1, 1), profile0._defaultBackground.value());
|
|
|
|
VERIFY_ARE_EQUAL(L"profile2", profile0._name);
|
|
|
|
VERIFY_IS_TRUE(profile0._startingDirectory.has_value());
|
|
VERIFY_ARE_EQUAL(L"C:/", profile0._startingDirectory.value());
|
|
}
|
|
|
|
void ProfileTests::LayerProfileIcon()
|
|
{
|
|
const std::string profile0String{ R"({
|
|
"name": "profile0",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}",
|
|
"icon": "not-null.png"
|
|
})" };
|
|
const std::string profile1String{ R"({
|
|
"name": "profile1",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}",
|
|
"icon": null
|
|
})" };
|
|
const std::string profile2String{ R"({
|
|
"name": "profile2",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}"
|
|
})" };
|
|
const std::string profile3String{ R"({
|
|
"name": "profile3",
|
|
"guid": "{6239a42c-1111-49a3-80bd-e8fdd045185c}",
|
|
"icon": "another-real.png"
|
|
})" };
|
|
|
|
const auto profile0Json = VerifyParseSucceeded(profile0String);
|
|
const auto profile1Json = VerifyParseSucceeded(profile1String);
|
|
const auto profile2Json = VerifyParseSucceeded(profile2String);
|
|
const auto profile3Json = VerifyParseSucceeded(profile3String);
|
|
|
|
auto profile0 = Profile::FromJson(profile0Json);
|
|
VERIFY_IS_TRUE(profile0._icon.has_value());
|
|
VERIFY_ARE_EQUAL(L"not-null.png", profile0._icon.value());
|
|
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Verify that layering an object the key set to null will clear the key"));
|
|
profile0.LayerJson(profile1Json);
|
|
VERIFY_IS_FALSE(profile0._icon.has_value());
|
|
|
|
profile0.LayerJson(profile2Json);
|
|
VERIFY_IS_FALSE(profile0._icon.has_value());
|
|
|
|
profile0.LayerJson(profile3Json);
|
|
VERIFY_IS_TRUE(profile0._icon.has_value());
|
|
VERIFY_ARE_EQUAL(L"another-real.png", profile0._icon.value());
|
|
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Verify that layering an object _without_ the key will not clear the key"));
|
|
profile0.LayerJson(profile2Json);
|
|
VERIFY_IS_TRUE(profile0._icon.has_value());
|
|
VERIFY_ARE_EQUAL(L"another-real.png", profile0._icon.value());
|
|
|
|
auto profile1 = Profile::FromJson(profile1Json);
|
|
VERIFY_IS_FALSE(profile1._icon.has_value());
|
|
profile1.LayerJson(profile3Json);
|
|
VERIFY_IS_TRUE(profile1._icon.has_value());
|
|
VERIFY_ARE_EQUAL(L"another-real.png", profile1._icon.value());
|
|
}
|
|
|
|
void ProfileTests::LayerProfilesOnArray()
|
|
{
|
|
const std::string profile0String{ R"({
|
|
"name" : "profile0",
|
|
"guid" : "{6239a42c-0000-49a3-80bd-e8fdd045185c}"
|
|
})" };
|
|
const std::string profile1String{ R"({
|
|
"name" : "profile1",
|
|
"guid" : "{6239a42c-1111-49a3-80bd-e8fdd045185c}"
|
|
})" };
|
|
const std::string profile2String{ R"({
|
|
"name" : "profile2",
|
|
"guid" : "{6239a42c-2222-49a3-80bd-e8fdd045185c}"
|
|
})" };
|
|
const std::string profile3String{ R"({
|
|
"name" : "profile3",
|
|
"guid" : "{6239a42c-0000-49a3-80bd-e8fdd045185c}"
|
|
})" };
|
|
const std::string profile4String{ R"({
|
|
"name" : "profile4",
|
|
"guid" : "{6239a42c-0000-49a3-80bd-e8fdd045185c}"
|
|
})" };
|
|
|
|
const auto profile0Json = VerifyParseSucceeded(profile0String);
|
|
const auto profile1Json = VerifyParseSucceeded(profile1String);
|
|
const auto profile2Json = VerifyParseSucceeded(profile2String);
|
|
const auto profile3Json = VerifyParseSucceeded(profile3String);
|
|
const auto profile4Json = VerifyParseSucceeded(profile4String);
|
|
|
|
CascadiaSettings settings;
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings._profiles.size());
|
|
VERIFY_IS_NULL(settings._FindMatchingProfile(profile0Json));
|
|
VERIFY_IS_NULL(settings._FindMatchingProfile(profile1Json));
|
|
VERIFY_IS_NULL(settings._FindMatchingProfile(profile2Json));
|
|
VERIFY_IS_NULL(settings._FindMatchingProfile(profile3Json));
|
|
VERIFY_IS_NULL(settings._FindMatchingProfile(profile4Json));
|
|
|
|
settings._LayerOrCreateProfile(profile0Json);
|
|
VERIFY_ARE_EQUAL(1u, settings._profiles.size());
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile0Json));
|
|
VERIFY_IS_NULL(settings._FindMatchingProfile(profile1Json));
|
|
VERIFY_IS_NULL(settings._FindMatchingProfile(profile2Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile3Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile4Json));
|
|
|
|
settings._LayerOrCreateProfile(profile1Json);
|
|
VERIFY_ARE_EQUAL(2u, settings._profiles.size());
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile0Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile1Json));
|
|
VERIFY_IS_NULL(settings._FindMatchingProfile(profile2Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile3Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile4Json));
|
|
|
|
settings._LayerOrCreateProfile(profile2Json);
|
|
VERIFY_ARE_EQUAL(3u, settings._profiles.size());
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile0Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile1Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile2Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile3Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile4Json));
|
|
VERIFY_ARE_EQUAL(L"profile0", settings._profiles.at(0)._name);
|
|
|
|
settings._LayerOrCreateProfile(profile3Json);
|
|
VERIFY_ARE_EQUAL(3u, settings._profiles.size());
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile0Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile1Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile2Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile3Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile4Json));
|
|
VERIFY_ARE_EQUAL(L"profile3", settings._profiles.at(0)._name);
|
|
|
|
settings._LayerOrCreateProfile(profile4Json);
|
|
VERIFY_ARE_EQUAL(3u, settings._profiles.size());
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile0Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile1Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile2Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile3Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingProfile(profile4Json));
|
|
VERIFY_ARE_EQUAL(L"profile4", settings._profiles.at(0)._name);
|
|
}
|
|
|
|
}
|