Skip to content

Commit

Permalink
Fix the OutputEngineTest::TestEscapePath unit test.
Browse files Browse the repository at this point in the history
  • Loading branch information
@j4james
j4james committed Mar 2, 2024
1 parent 8fe43a7 commit b5390c1
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions src/terminal/parser/ut_parser/OutputEngineTest.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,7 @@ class Microsoft::Console::VirtualTerminal::OutputEngineTest final
auto engine = std::make_unique<OutputStateMachineEngine>(std::move(dispatch));
StateMachine mach(std::move(engine));

// The OscString state shouldn't escape out after an ESC.
// Same for DcsPassThrough and SosPmApcString state.
auto shouldEscapeOut = true;
auto expectedEscapeState = StateMachine::VTStates::Escape;

switch (uiTest)
{
Expand Down Expand Up @@ -109,17 +107,21 @@ class Microsoft::Console::VirtualTerminal::OutputEngineTest final
mach._state = StateMachine::VTStates::CsiIntermediate;
break;
}
// The OscParam and OscString states shouldn't escape out after an ESC.
// They enter the OscTermination state to wait for the `\` char of the
// string terminator, without which the OSC operation won't be executed.
case 7:
{
Log::Comment(L"Escape from OscParam");
mach._state = StateMachine::VTStates::OscParam;
expectedEscapeState = StateMachine::VTStates::OscTermination;
break;
}
case 8:
{
Log::Comment(L"Escape from OscString");
shouldEscapeOut = false;
mach._state = StateMachine::VTStates::OscString;
expectedEscapeState = StateMachine::VTStates::OscTermination;
break;
}
case 9:
Expand Down Expand Up @@ -167,25 +169,20 @@ class Microsoft::Console::VirtualTerminal::OutputEngineTest final
case 16:
{
Log::Comment(L"Escape from DcsPassThrough");
shouldEscapeOut = false;
mach._state = StateMachine::VTStates::DcsPassThrough;
mach._dcsStringHandler = [](const auto) { return true; };
break;
}
case 17:
{
Log::Comment(L"Escape from SosPmApcString");
shouldEscapeOut = false;
mach._state = StateMachine::VTStates::SosPmApcString;
break;
}
}

mach.ProcessCharacter(AsciiChars::ESC);
if (shouldEscapeOut)
{
VERIFY_ARE_EQUAL(mach._state, StateMachine::VTStates::Escape);
}
VERIFY_ARE_EQUAL(expectedEscapeState, mach._state);
}

TEST_METHOD(TestEscapeImmediatePath)
Expand Down

1 comment on commit b5390c1

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

🔴 Please review

See the 📜action log or 📝 job summary for details.

Unrecognized words (1)

DECSWT

Previously acknowledged words that are now absent AAAa Batang chcbpat CLUSTERMAP COLORMATRIX COLR DBlob dcompile DESTINATIONNAME dxguid FFrom GFEh inputrc kcub kcud kcuf kcuu khome Mbxy Mip QUESTIONMARK reallocs reamapping Resequence RTFTo srv subresource tracelog TRIANGLESTRIP Uniscribe waitable WScript XColors xff XMFLOAT 🫥
To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the [email protected]:j4james/terminal.git repository
on the feature-decswt branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.22/apply.pl' |
perl - 'https://github.com/j4james/terminal/actions/runs/8126151975/attempts/1'
Available 📚 dictionaries could cover words (expected and unrecognized) not in the 📘 dictionary

This includes both expected items (2255) from .github/actions/spelling/expect/04cdb9b77d6827c0202f51acd4205b017015bfff.txt
.github/actions/spelling/expect/alphabet.txt
.github/actions/spelling/expect/expect.txt
.github/actions/spelling/expect/web.txt and unrecognized words (1)

Dictionary Entries Covers Uniquely
cspell:swift/src/swift.txt 53 1 1
cspell:gaming-terms/dict/gaming-terms.txt 59 1 1
cspell:monkeyc/src/monkeyc_keywords.txt 123 1 1
cspell:cryptocurrencies/cryptocurrencies.txt 125 1 1
cspell:scala/dict/scala.txt 153 1 1

Consider adding them (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

      with:
        extra_dictionaries:
          cspell:swift/src/swift.txt
          cspell:gaming-terms/dict/gaming-terms.txt
          cspell:monkeyc/src/monkeyc_keywords.txt
          cspell:cryptocurrencies/cryptocurrencies.txt
          cspell:scala/dict/scala.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

check_extra_dictionaries: ''
Errors (1)

See the 📜action log or 📝 job summary for details.

❌ Errors Count
❌ ignored-expect-variant 4

See ❌ Event descriptions for more information.

✏️ Contributor please read this

By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

If the listed items are:

  • ... misspelled, then please correct them instead of using the command.
  • ... names, please add them to .github/actions/spelling/allow/names.txt.
  • ... APIs, you can add them to a file in .github/actions/spelling/allow/.
  • ... just things you're using, please add them to an appropriate file in .github/actions/spelling/expect/.
  • ... tokens you only need in one place and shouldn't generally be used, you can add an item in an appropriate file in .github/actions/spelling/patterns/.

See the README.md in each directory for more information.

🔬 You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The check-spelling action will run in response to your push -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. 😉

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Please sign in to comment.