microsoft/Terminal

A few StateMachine unit tests don't fully test what they purport to

开放

#1,372 创建于 2019年6月21日

 (1 条评论) (0 个反应) (0 位负责人)C++ (9,275 个派生)batch import
Area-CodeHealthHelp WantedIssue-TaskProduct-Conhost

仓库指标

星标
 (103,173 个星标)
PR 合并指标
 (平均合并 27天 19小时) (30 天内合并 24 个 PR)

描述

I'm not sure if this is right place to report this, because it's not a bug in the app itself, but it's an issue I noticed in the unit tests, which I think may be considered a bug.

As a specific example, consider the TestCursorKeysMode test in OutputEngineTest.cpp:

TEST_METHOD(TestCursorKeysMode)
{
    StatefulDispatch* pDispatch = new StatefulDispatch;
    VERIFY_IS_NOT_NULL(pDispatch);
    StateMachine mach(new OutputStateMachineEngine(pDispatch));

    mach.ProcessString(L"\x1b[?1h", 5);
    VERIFY_IS_TRUE(pDispatch->_fCursorKeysMode);

    pDispatch->ClearState();

    mach.ProcessString(L"\x1b[?1l", 5);
    VERIFY_IS_FALSE(pDispatch->_fCursorKeysMode);

    pDispatch->ClearState();
}

The second half of this test is assumedly meant to prove that the given escape sequence will reset the cursor keys mode. However, the _fCursorKeysMode flag is false by default, so you could replace that escape sequence with almost anything, including removing it altogether, and the test would still pass.

There are similar problems with TestCursorBlinking, TestCursorVisibility, and possibly also TestAltBufferSwapping.

When I added a similar test, I got around the problem by explicitly setting the flag I was testing to the opposite of what was expected, but I'm not sure if that is the best approach. Another possibility might be using std::optional<bool> instead of just a bool, so the default value could then be a nullopt, and it wouldn't be possible to pass the test based on the default value alone. The downside of that approach is the VERIFY steps become a little more complicated.

贡献者指南