[STACKED] [Tigron]: mocks + debugging output enhancements #4076
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: apostasie <[email protected]>
Signed-off-by: apostasie <[email protected]>
Signed-off-by: apostasie <[email protected]>
- use internal/com instead of icmd - move pty from test/internal to internal - update go mod, sum, and depguard Signed-off-by: apostasie <[email protected]>
Signed-off-by: apostasie <[email protected]>
- Background() signature change - command creation change Signed-off-by: apostasie <[email protected]>
- Background - Feed, WithFeeder, WithPseudoTTY - use exit code consts where appropriate - some --quiet Signed-off-by: apostasie <[email protected]>
This commit relaxes line length from 100 to 120, and disables a bunch of linters we do not want. Signed-off-by: apostasie <[email protected]>
Mimicry is a lightweight, zero dependency mock mechanism created to ease testing of Tigron. Since Tigron heavily relies on *testing.T, it is currently hard to test. Moving away to a tig.T interface instead of *testing.T will unlock the ability to mock. Mimicry does provide: - recording of all function calls, with arguments and complete stack trace (see Report()) - optional custom handling of function calls (see Register()) - QOL: fancyfied OCS8 links allow opening files from traces in terminal UX is largely in flux right now and experimental, but the objective is to: - do not require code generation - do not abuse reflection - keep the amount of boilerplate to the absolute minimum for the mock consumer - ... and as small as possible for the mock creator - keep zero dependencies This commit also introduce the tig.T interface to be used everywhere inside Tigron in the future, along with a complete mock for it. Mimicry is not meant to be used directly for now, though, if there is interest, a future version might graduate out of `internal`. Signed-off-by: apostasie <[email protected]>
apostasie
force-pushed
the
tigron-1-mock
branch
2 times, most recently
from
f5cf369 to
88b9c53
Compare
This brings a set of enhancements to assertive: - function name simplifications - generics-ifying of some functions that can be used on comparables - additional methods (Match, DoesNotMatch) - debugging output is made clear, along with OCS8 link and excerpt of the test file - all methods can now elect to Fail later instead of FailNow - Check method is removed (^ because of above) - all methods can now elect to silence output on success Other Tigron files are updated to adopt these changes: - method names update - comparators move away from Check and now fully leverages assertive This also adds a large number of tests for assertive, leveraging mimicry. Signed-off-by: apostasie <[email protected]>
|
Here is how the new assertive debug will be presented. The first line is enriched with the exact content from the source test file that triggered the failure (to facilitate copy paste search), as a clickable OCS8 link so that the (local) developer can directly click and open the offending file. The following lines present clearly what was expected, what was the actual value, with some high-contrast emojis to facilitate reading (for old people like me). 
This is to be compared with the normal "assert.Assert" information: 
|
|
Here is how the captured call traces will show when using mocks: In that specific case, the test wants to make sure that the mocked method Source links are clickable as well. 
This of course is not replay-debugging - just a frame capture done with |
apostasie
changed the title
1 task
apostasie
changed the title
apostasie
changed the title
27 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
<!> Blocked by <!>:
Should preferably be merged after:
[MAJOR] content digest not found) #4062 (purely for QOL reasons)This is a new series of Tigron PRs (FIXME: currently on top of #4056).
Now that the big change with the new command implementation is in, upcoming work on Tigron will focus on:
Ideally, none of these PRs will require ANY change in nerdctl, and are either changes to the way we test Tigron itself, or refactoring that does not change signatures and API.
Efforts are being made to break these PRs down into small, digestible changes to ease and fasten review, which explains the chain of PRs.
LMK at any point if a given PR needs to be further broken down.
This first PR is focused on making Tigron more testable, starting with
assertive.Commit 1 is mundane and just disables golangci linters that we do not want.
Second commit does introduce
internal/mimicry, a mock mechanism that will allow mocking*testing.Tand other conendrums. See commit message for details.Third commit is work on
internal/assertive(code cleanup, methods generalization), and a raft of new tests (leveragingmimicry). See commit message for detailsSee following comments for preview of how failures will now be presented.
Note that more work on debugging output quality will very soon come in an upcoming PR (this time focused on general output, which is currently crowded, noisy and really hard to read) - I would prefer to keep that separate to keep PRs small, though meanwhile the display will be a bit loosy goosy because of that.