3fcc935782
## Summary of the Pull Request New year, new unittests. This PR introduces a new project, `TestHostApp`. This project is largely taken from the TAEF samples, and allows us to easily construct a helper executable and `resources.pri` for running TerminalApp unittests. ## References ## PR Checklist * [x] Closes #3986 * [x] I work here * [x] is Tests * [n/a] Requires documentation to be updated * [x] **Waiting for an updated version of TAEF to be available** ## Detailed Description of the Pull Request / Additional comments Unittesting for the TerminalApp project has been a horrifying process to try getting everything pieced together just right. Dependencies need to get added to manifests, binplaced correctly, and XAML resources need to get compiled together as well. In addition, using a MUX `Application` (as opposed to the Windows.UI.Xaml `Application`) has led to additional problems. This was always a horrifying house of cards for us. Turns out, the reason this was so horrible is that the test infrastructure for doing what we're doing _literally didn't exist_ when I started doing all that work last year. So, with help from the TAEF team, I was able to get rid of our entire house of cards, and use a much simpler project to build and run the tests. Unfortunately, the latest TAEF release has a minor bug in it's build rules, and only publishes the x86 version of a dll we need from them. But, the rest of this PR works for x86, and I'll bump this when that updated version is available. We should be able to review this even in the state it's in. ## Validation Steps Performed ran the tests yo
281 lines
13 KiB
C++
281 lines
13 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#include "pch.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
|
|
{
|
|
// 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 ColorSchemeTests : public JsonTestClass
|
|
{
|
|
// 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(ColorSchemeTests)
|
|
TEST_CLASS_PROPERTY(L"RunAs", L"UAP")
|
|
TEST_CLASS_PROPERTY(L"UAP:AppXManifest", L"TestHostAppXManifest.xml")
|
|
END_TEST_CLASS()
|
|
|
|
TEST_METHOD(CanLayerColorScheme);
|
|
TEST_METHOD(LayerColorSchemeProperties);
|
|
TEST_METHOD(LayerColorSchemesOnArray);
|
|
|
|
TEST_CLASS_SETUP(ClassSetup)
|
|
{
|
|
InitializeJsonReader();
|
|
return true;
|
|
}
|
|
};
|
|
|
|
void ColorSchemeTests::CanLayerColorScheme()
|
|
{
|
|
const std::string scheme0String{ R"({
|
|
"name": "scheme0",
|
|
"foreground": "#000000",
|
|
"background": "#010101"
|
|
})" };
|
|
const std::string scheme1String{ R"({
|
|
"name": "scheme1",
|
|
"foreground": "#020202",
|
|
"background": "#030303"
|
|
})" };
|
|
const std::string scheme2String{ R"({
|
|
"name": "scheme0",
|
|
"foreground": "#040404",
|
|
"background": "#050505"
|
|
})" };
|
|
const std::string scheme3String{ R"({
|
|
// "name": "scheme3",
|
|
"foreground": "#060606",
|
|
"background": "#070707"
|
|
})" };
|
|
|
|
const auto scheme0Json = VerifyParseSucceeded(scheme0String);
|
|
const auto scheme1Json = VerifyParseSucceeded(scheme1String);
|
|
const auto scheme2Json = VerifyParseSucceeded(scheme2String);
|
|
const auto scheme3Json = VerifyParseSucceeded(scheme3String);
|
|
|
|
const auto scheme0 = ColorScheme::FromJson(scheme0Json);
|
|
|
|
VERIFY_IS_TRUE(scheme0.ShouldBeLayered(scheme0Json));
|
|
VERIFY_IS_FALSE(scheme0.ShouldBeLayered(scheme1Json));
|
|
VERIFY_IS_TRUE(scheme0.ShouldBeLayered(scheme2Json));
|
|
VERIFY_IS_FALSE(scheme0.ShouldBeLayered(scheme3Json));
|
|
|
|
const auto scheme1 = ColorScheme::FromJson(scheme1Json);
|
|
|
|
VERIFY_IS_FALSE(scheme1.ShouldBeLayered(scheme0Json));
|
|
VERIFY_IS_TRUE(scheme1.ShouldBeLayered(scheme1Json));
|
|
VERIFY_IS_FALSE(scheme1.ShouldBeLayered(scheme2Json));
|
|
VERIFY_IS_FALSE(scheme1.ShouldBeLayered(scheme3Json));
|
|
|
|
const auto scheme3 = ColorScheme::FromJson(scheme3Json);
|
|
|
|
VERIFY_IS_FALSE(scheme3.ShouldBeLayered(scheme0Json));
|
|
VERIFY_IS_FALSE(scheme3.ShouldBeLayered(scheme1Json));
|
|
VERIFY_IS_FALSE(scheme3.ShouldBeLayered(scheme2Json));
|
|
VERIFY_IS_FALSE(scheme3.ShouldBeLayered(scheme3Json));
|
|
}
|
|
|
|
void ColorSchemeTests::LayerColorSchemeProperties()
|
|
{
|
|
const std::string scheme0String{ R"({
|
|
"name": "scheme0",
|
|
"foreground": "#000000",
|
|
"background": "#010101",
|
|
"selectionBackground": "#010100",
|
|
"red": "#010000",
|
|
"green": "#000100",
|
|
"blue": "#000001"
|
|
})" };
|
|
const std::string scheme1String{ R"({
|
|
"name": "scheme1",
|
|
"foreground": "#020202",
|
|
"background": "#030303",
|
|
"selectionBackground": "#020200",
|
|
"red": "#020000",
|
|
|
|
"blue": "#000002"
|
|
})" };
|
|
const std::string scheme2String{ R"({
|
|
"name": "scheme0",
|
|
"foreground": "#040404",
|
|
"background": "#050505",
|
|
"selectionBackground": "#030300",
|
|
"red": "#030000",
|
|
"green": "#000300"
|
|
})" };
|
|
|
|
const auto scheme0Json = VerifyParseSucceeded(scheme0String);
|
|
const auto scheme1Json = VerifyParseSucceeded(scheme1String);
|
|
const auto scheme2Json = VerifyParseSucceeded(scheme2String);
|
|
|
|
auto scheme0 = ColorScheme::FromJson(scheme0Json);
|
|
VERIFY_ARE_EQUAL(L"scheme0", scheme0._schemeName);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 0, 0, 0), scheme0._defaultForeground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 1, 1, 1), scheme0._defaultBackground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 1, 1, 1), scheme0._defaultBackground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 1, 1, 0), scheme0._selectionBackground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 1, 0, 0), scheme0._table[XTERM_RED_ATTR]);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 0, 1, 0), scheme0._table[XTERM_GREEN_ATTR]);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 0, 0, 1), scheme0._table[XTERM_BLUE_ATTR]);
|
|
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Layering scheme1 on top of scheme0"));
|
|
scheme0.LayerJson(scheme1Json);
|
|
|
|
VERIFY_ARE_EQUAL(ARGB(0, 2, 2, 2), scheme0._defaultForeground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 3, 3, 3), scheme0._defaultBackground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 2, 2, 0), scheme0._selectionBackground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 2, 0, 0), scheme0._table[XTERM_RED_ATTR]);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 0, 1, 0), scheme0._table[XTERM_GREEN_ATTR]);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 0, 0, 2), scheme0._table[XTERM_BLUE_ATTR]);
|
|
|
|
Log::Comment(NoThrowString().Format(
|
|
L"Layering scheme2Json on top of (scheme0+scheme1)"));
|
|
scheme0.LayerJson(scheme2Json);
|
|
|
|
VERIFY_ARE_EQUAL(ARGB(0, 4, 4, 4), scheme0._defaultForeground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 5, 5, 5), scheme0._defaultBackground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 3, 3, 0), scheme0._selectionBackground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 3, 0, 0), scheme0._table[XTERM_RED_ATTR]);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 0, 3, 0), scheme0._table[XTERM_GREEN_ATTR]);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 0, 0, 2), scheme0._table[XTERM_BLUE_ATTR]);
|
|
}
|
|
|
|
void ColorSchemeTests::LayerColorSchemesOnArray()
|
|
{
|
|
const std::string scheme0String{ R"({
|
|
"name": "scheme0",
|
|
"foreground": "#000000",
|
|
"background": "#010101"
|
|
})" };
|
|
const std::string scheme1String{ R"({
|
|
"name": "scheme1",
|
|
"foreground": "#020202",
|
|
"background": "#030303"
|
|
})" };
|
|
const std::string scheme2String{ R"({
|
|
"name": "scheme0",
|
|
"foreground": "#040404",
|
|
"background": "#050505"
|
|
})" };
|
|
const std::string scheme3String{ R"({
|
|
// by not providing a name, the scheme will have the name ""
|
|
"foreground": "#060606",
|
|
"background": "#070707"
|
|
})" };
|
|
|
|
const auto scheme0Json = VerifyParseSucceeded(scheme0String);
|
|
const auto scheme1Json = VerifyParseSucceeded(scheme1String);
|
|
const auto scheme2Json = VerifyParseSucceeded(scheme2String);
|
|
const auto scheme3Json = VerifyParseSucceeded(scheme3String);
|
|
|
|
CascadiaSettings settings;
|
|
|
|
VERIFY_ARE_EQUAL(0u, settings._globals.GetColorSchemes().size());
|
|
VERIFY_IS_NULL(settings._FindMatchingColorScheme(scheme0Json));
|
|
VERIFY_IS_NULL(settings._FindMatchingColorScheme(scheme1Json));
|
|
VERIFY_IS_NULL(settings._FindMatchingColorScheme(scheme2Json));
|
|
VERIFY_IS_NULL(settings._FindMatchingColorScheme(scheme3Json));
|
|
|
|
settings._LayerOrCreateColorScheme(scheme0Json);
|
|
{
|
|
for (auto& kv : settings._globals._colorSchemes)
|
|
{
|
|
Log::Comment(NoThrowString().Format(
|
|
L"kv:%s->%s", kv.first.data(), kv.second.GetName().data()));
|
|
}
|
|
VERIFY_ARE_EQUAL(1u, settings._globals.GetColorSchemes().size());
|
|
|
|
VERIFY_IS_TRUE(settings._globals._colorSchemes.find(L"scheme0") != settings._globals._colorSchemes.end());
|
|
auto scheme0 = settings._globals._colorSchemes.find(L"scheme0")->second;
|
|
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingColorScheme(scheme0Json));
|
|
VERIFY_IS_NULL(settings._FindMatchingColorScheme(scheme1Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingColorScheme(scheme2Json));
|
|
VERIFY_IS_NULL(settings._FindMatchingColorScheme(scheme3Json));
|
|
VERIFY_ARE_EQUAL(ARGB(0, 0, 0, 0), scheme0._defaultForeground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 1, 1, 1), scheme0._defaultBackground);
|
|
}
|
|
|
|
settings._LayerOrCreateColorScheme(scheme1Json);
|
|
|
|
{
|
|
VERIFY_ARE_EQUAL(2u, settings._globals.GetColorSchemes().size());
|
|
|
|
VERIFY_IS_TRUE(settings._globals._colorSchemes.find(L"scheme0") != settings._globals._colorSchemes.end());
|
|
auto scheme0 = settings._globals._colorSchemes.find(L"scheme0")->second;
|
|
VERIFY_IS_TRUE(settings._globals._colorSchemes.find(L"scheme1") != settings._globals._colorSchemes.end());
|
|
auto scheme1 = settings._globals._colorSchemes.find(L"scheme1")->second;
|
|
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingColorScheme(scheme0Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingColorScheme(scheme1Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingColorScheme(scheme2Json));
|
|
VERIFY_IS_NULL(settings._FindMatchingColorScheme(scheme3Json));
|
|
VERIFY_ARE_EQUAL(ARGB(0, 0, 0, 0), scheme0._defaultForeground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 1, 1, 1), scheme0._defaultBackground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 2, 2, 2), scheme1._defaultForeground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 3, 3, 3), scheme1._defaultBackground);
|
|
}
|
|
settings._LayerOrCreateColorScheme(scheme2Json);
|
|
|
|
{
|
|
VERIFY_ARE_EQUAL(2u, settings._globals.GetColorSchemes().size());
|
|
|
|
VERIFY_IS_TRUE(settings._globals._colorSchemes.find(L"scheme0") != settings._globals._colorSchemes.end());
|
|
auto scheme0 = settings._globals._colorSchemes.find(L"scheme0")->second;
|
|
VERIFY_IS_TRUE(settings._globals._colorSchemes.find(L"scheme1") != settings._globals._colorSchemes.end());
|
|
auto scheme1 = settings._globals._colorSchemes.find(L"scheme1")->second;
|
|
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingColorScheme(scheme0Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingColorScheme(scheme1Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingColorScheme(scheme2Json));
|
|
VERIFY_IS_NULL(settings._FindMatchingColorScheme(scheme3Json));
|
|
VERIFY_ARE_EQUAL(ARGB(0, 4, 4, 4), scheme0._defaultForeground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 5, 5, 5), scheme0._defaultBackground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 2, 2, 2), scheme1._defaultForeground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 3, 3, 3), scheme1._defaultBackground);
|
|
}
|
|
settings._LayerOrCreateColorScheme(scheme3Json);
|
|
|
|
{
|
|
VERIFY_ARE_EQUAL(3u, settings._globals.GetColorSchemes().size());
|
|
|
|
VERIFY_IS_TRUE(settings._globals._colorSchemes.find(L"scheme0") != settings._globals._colorSchemes.end());
|
|
auto scheme0 = settings._globals._colorSchemes.find(L"scheme0")->second;
|
|
VERIFY_IS_TRUE(settings._globals._colorSchemes.find(L"scheme1") != settings._globals._colorSchemes.end());
|
|
auto scheme1 = settings._globals._colorSchemes.find(L"scheme1")->second;
|
|
VERIFY_IS_TRUE(settings._globals._colorSchemes.find(L"") != settings._globals._colorSchemes.end());
|
|
auto scheme2 = settings._globals._colorSchemes.find(L"")->second;
|
|
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingColorScheme(scheme0Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingColorScheme(scheme1Json));
|
|
VERIFY_IS_NOT_NULL(settings._FindMatchingColorScheme(scheme2Json));
|
|
VERIFY_IS_NULL(settings._FindMatchingColorScheme(scheme3Json));
|
|
VERIFY_ARE_EQUAL(ARGB(0, 4, 4, 4), scheme0._defaultForeground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 5, 5, 5), scheme0._defaultBackground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 2, 2, 2), scheme1._defaultForeground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 3, 3, 3), scheme1._defaultBackground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 6, 6, 6), scheme2._defaultForeground);
|
|
VERIFY_ARE_EQUAL(ARGB(0, 7, 7, 7), scheme2._defaultBackground);
|
|
}
|
|
}
|
|
}
|