Help wanted to reach ~100% code coverage

[paulmelnikow]

As discussed in #1374 and elsewhere, our current milestone is to reach close to 100% coverage on the beta branch. With 100% test coverage, the tests take on a life of their own in maintaining the project, and will allow us to refactor – and add functionality – with confidence.

@jlilja, @gr2m and I conducted a line-by-line triage and added 46 comments marked TODO-coverage in #1375 and #1380. These are all the spots in the code where work on this milestone is needed.

As of right now we're down to 40, so we're 13% of the way there!

You can help!

1. Look in the beta branch for TODO-coverage.
2. Pick a todo or a file to start working on.
3. Post here, so we don't duplicate any work.
4. When you're ready, open your pull request on the beta branch.

One bit of guidance: our test strategy is to avoid narrow-bracket tests, and instead aim to keep writing high-level functional tests (i.e. via calls to nock()). If there is not a way to exercise the code through the public nock API, it may be dead code. In the case of dead code, it's better to remove it than to add tests.

[paulmelnikow]

I'm going to work on the coverage TODOs in request_overrider.js.

I am no longer working in this file. I got through a lot of the header code, which is what prompted the umbrella TODO-coverage comment we wrote at the top of the file. The file is less of a mystery now. Though there are a smattering of uncovered lines for various edge cases. It may need another round of triage.

[paulmelnikow]

I just tackled the last one in lib/common.js. I'll open another PR in a moment for the truthiness checks on http.ClientMessage and http.OutgoingMessage in lib/intercept.js.

[paulmelnikow]

@gr2m Do you want to finish the one in socket.js?

#1374 (comment)

[gr2m]

Please take it if you can, I won’t get to it before our vacation next week

[paulmelnikow]

After the open PRs are merged, these are the coverage TODOs that are left:

lib/common.js:      // TODO-coverage: `override` is always truthy. Refactor to eliminate the
lib/common.js:  // TODO-coverage: Add a test to cover the missing condition, or remove if
lib/common.js:  // TODO-coverage: Add a test to cover the missing condition, or remove if
lib/common.js:    // TODO-coverage: Add a test to cover the missing condition, or remove if
lib/common.js:    // TODO-coverage: For `_.isObject(headers)`, add a test to cover the
lib/common.js:  // TODO-coverage: either replace this with a library function or add a
lib/common.js:  // TODO-coverage: Find out what's not covered. Probably refactor code to
lib/interceptor.js:  // TODO-coverage: This looks very special. Worth an investigation.
lib/recorder.js:      // TODO-coverage: Try to add a test for this case. If we can't figure
lib/recorder.js:  // TODO-coverage: Try to add coverage of this case.
lib/recorder.js:    // TODO-coverage: Try to add coverage of this case.
lib/recorder.js:      // TODO-coverage: Investigate why this was added. Add a test if
lib/recorder.js:      // TODO-coverage: Investigate why this was added. Add a test if
lib/recorder.js:          // TODO-coverage: The `else` case is missing coverage. Maybe look
lib/recorder.js:              // TODO-coverage: This is missing coverage. Could this be
lib/recorder.js:      // TODO-coverage: Is this for parity with native node `req.write()`? If
lib/recorder.js:          // TODO-coverage: Add a test.
lib/request_overrider.js:// TODO-coverage: This file is puzzling. It would be good to investigate why
lib/scope.js:      // TODO-coverage: Try to find an actual use case where a non-string
lib/scope.js:    // TODO-coverage: `else` throw with an error.
lib/scope.js:    // TODO-coverage: Find out what `body === '*'` means. Add a comment here

That's 54% of the way done! I may pick up one or two of these, though TBH I've gone about as far as I want to with this. If anyone else is interested in working on these, help would be really appreciated! They tend to be good puzzles!

[RichardLitt]

Thank you so much, @paulmelnikow! I'll grab a couple. Perhaps we should schedule another open source friday hackathon, too?

[paulmelnikow]

That sounds good!