[Feature]: Support "real" TCR that also reverts tests

[philou]

Contact Details

[email protected]

Feature Request

The TCR tool only reverts the code files, and keeps the failing test. The original TCR was also reverting the tests. These 2 behaviors lead to quite different workflow. The original TCR encourages:

• to add "disabled" tests that get "re-disabled" when they fail
• to take even smaller steps, and to use the tidy-first workflow: "Make the change easy, then make the easy change"

Feature Description

This could be an option to TCR (ex: --also-revert-tests). It could also become the default behavior, and make the current behavior available with an option (ex: --nice)

Alternatives

An alternative is to completely drop the current behavior, and stick only to the Real TCR.

Additional Context

I needed this feature on the Baby Steps Golf Kata (https://github.com/philou/kata-babystepsgolf). I ended up reverting to straightforward TCR scripts. I also needed to run the TCR manually (and not systematically on save, as I wanted participants to give a special commit message).

Code of Conduct

• I agree to follow this project's Code of Conduct

TODO

• Add a parameter "flavor": taking 2 values: "nice" (current, and default) and "original" (which reverts tests)
  • find a shortcut letter for the command line -> 'f'
  • make commit failures shortcut upper 'F'
  • define the flavor parameter
  • Call the AddFlavorParam
• add and pass down the flavor attribute to the TCR struct
  • add flavor to TCREngine
  • pass the flavor from UI to TCREngine
• Display the flavor in the UI
  • Terminal
  • Angular
    • Transfer Flavor through HTTP
    • Display in in the web frontend
    • Improve wording on web frontend
• Transform flavor from string to enum:
  • flavor -> Variant
  • nice -> relaxed
  • original -> btcr (build && (test && commit || revert)
  • Create an enum
  • propagate the types from the params
  • add a Name() function to variant type
• in tcr.revert, branch on the 2 variants
  • Add a test around the current source revert, asserting reverted files with VCS fake
    • test that revert was called
    • add both tests and source files
    • make it possible to capture src from test files in the languages
    • assert that only source files are reverted
    • override and add a parameter to initTCREngineWithFakes to pass in an array of file diffs
    • assert that many sources files can be reverted
    • Transform the tests to parametrized tests
  • Rename tcr.srcRevert to tcr.revertSrcOnly
  • implement the btcr variant
    • add tests around btcr
    • implement
• add a 3rd variant: "introspective", which is based on btcr but also commits failures and reverts
  • draw a mermaid diagram to visualize what it will look like
  • add description for introspector variant in variants markdown description file
  • check that it works in the UI and Command Line
  • Add tests for the introspective variant
    • Add a list of received commands in VCS fake so that we can test that we got "commit && revert"
    • Should we update the LastCommand to get the tail of the list instead of keeping it?
    • Unskip the test with "add, commit, rollback, and commit"
  • in tcr.revert, implement the introspective variant
    • implement introspectiveRevert (copied from git commitFailures)
    • make sure we have tests for the commit messages
    • clean up the revert function (currently spanning different levels of abstraction)
  • And what about the error we are ignoring out of introspectiveRevert?
  • Add introspective to the list of variants in the short description for variant parameter
• Reinforce command line argument "-r" so that in only accepts recognized variant names
• remove the "commit failure" option and code
  • remove config/cparam_commit_failure()
  • remove CommitFailures flag from params and related test data builder
  • remove parts that leverage on CommitFailures flag in engine.tcr
  • remove SetCommitOnFail()
    • in trc class
    • in tcr interface
  • remove from checker.check_workflow
• clean up vcs interface and related git/p4 implementations
• add a link to the workflow picture from the web app session info
• Rename in VCS to map to TCR domain, not that of git:
  • rename Revert into RollbackCommit
  • rename Restore into Revert

Variants	TCR	VCS (current)	VCS (updated)	git	p4
original, BTCR, relaxed	revert(file)	Restore(file)	RevertLocal(file)	git checkout HEAD file	p4 reconcile file
introspective	rollbackLastCommit()?	Revert()	RollbackLastCommit()	git revert HEAD	TODO: p4 undo + p4 submit

• Test the introspective revert in practice.
  • Should we add some warning or info traces in introspective mode? No, confirmed that this cannot happen when using introspective variant
  • Tune git revert command call so that it does not auto-commits
• rework checker for TCR workflow configuration
  • rename chech_workflow group to check_variant
  • add checking of variant value
    • variants btcr, relaxed and introspective should be supported (lowercase or uppercase)
    • variant original should return a "not yet supported" error message
    • all other cases should return an error
  • remove "commit failure" related stuff from checker
• document in readme each of the available variants and what they imply in terms of workflow (explain ref to https://medium.com/@tdeniffel/tcr-variants-test-commit-revert-bf6bd84b17d3)
  • Create visual workflows for each variant
• Remove the "amend" parameter in the VCS.Commit function

Parking

• Add feature tests (end to end and/or scoped) use more dependency injection and try "Testing without mocks" (cf. [Experiment]: Behaviour Driven Developement and Living Documentation #810 & [Experiment]: Testing without mocks #811)
• Create a Builder for the TCREngine(Fake) because the test factory method is getting complicated (we had to add an extra parameter for the FileDiffs (cf. [Experiment]: A Wall of Technical Debt #809)
• improve the VCS fake? (real mock with check method and better error reporting, ex: fakeVCS.assertFilesWereReverted(count: 2...), currently, we are using the reporter warning to check how many files were reverted
• improve the reporter fake? (real mock with check method and better error reporting, ex: report.assertWarning... instead of setting up the sniffer then asserting count matches) (cf. [Experiment]: A Wall of Technical Debt #809)
• implement the orginal variant (cf. [Feature]: Add Original TCR Variant #807 )
• experiment using strong-type variant in the Params (cf. [Experiment]: Strong Typed Variant in the Params #812)

[mengdaming]

A note about running TCR manually (and not systematically on save): this part is already available through running tcr one-shot subcommand