Skip to content

Commit

Permalink
[#809] Add "//FIXME SMELL" comments in the code
Browse files Browse the repository at this point in the history
To experiment tracking technical debt in the code.
- add FIXME comments for 2 smells we stumbled on when coding #674
  • Loading branch information
philou authored and mengdaming committed Oct 11, 2024
1 parent fd6f417 commit dfb91b3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/engine/tcr_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,7 @@ func Test_tcr_cycle_end_state(t *testing.T) {
}
}

// FIXME SMELL: This test factory method is getting complicated with too many parameters. Consider refactoring to Builders.
func initTCREngineWithFakesWithFileDiffs(
p *params.Params,
toolchainFailures toolchain.Operations,
Expand Down
4 changes: 4 additions & 0 deletions src/report/reporter_test_util.go
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,10 @@ func (sniffer *Sniffer) Stop() {
}
}

// FIXME SMELL: Duplicated assertion code in tests. Consider improving the reporter fake as a real mock with
// check method and better error reporting, ex: report.assertWarning... instead of setting up the sniffer
// then asserting count matches

// GetAllMatches returns a slice containing all matching messages captured by the sniffer
func (sniffer *Sniffer) GetAllMatches() []Message {
return sniffer.captured
Expand Down

0 comments on commit dfb91b3

Please sign in to comment.