Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor(test): heavily simplify the context helper #404

Merged
merged 2 commits into from
Aug 25, 2022
Merged

refactor(test): heavily simplify the context helper #404

merged 2 commits into from
Aug 25, 2022

Commits on Aug 24, 2022

  1. refactor(test): heavily simplify the context helper 

    - since we're type-casting it anyway, we can heavily simplify this and remove the stubs entirely
  - they're actually unused in the unit tests, so we don't need them at all
    - besides the type-checking, which we force with a cast anyway
    - the `as unknown as` is bad practice, and probably why I didn't use it initially (plus other typing issues), but it's much simpler this way and reflects the intent better -- just making it type-check with the few properties we use

- we can also use Jest mocks directly instead of the hacky `contextualLogger` and passing `data` in
  - `makeContext` now creates the mocks, so we just need to check against `context.error` etc
    - this is _much_ more familiar as it's what we use in the source and follows idiomatic Jest
    - rewrite all the checks to test against the mocks instead
  - I thought this felt too complicated / verbose before, but I had left this as is from brekk's initial test structure
    - now that I understand all the tests and test intent much better, I could rewrite this to be a good bit simpler

- make the `toBeFalsy()` checks more precise by checking that the mock _wasn't_ called
  - it returns `void` anyway, so `toBeFalsy()` _always_ returns true; it's not much of a test
  - checking that the low verbosity level didn't trigger the mock to be called actually checks the test's intent
    @agilgur5
    agilgur5 committed Aug 24, 2022
    Configuration menu
    Copy the full SHA
    75e04a6 View commit details
    Browse the repository at this point in the history

  2. make sure to check funcs in context calls too 

    - `get-options-overrides`'s coverage func % decreased bc funcs passed to `context.debug` weren't being called
  - took me a bit to notice too since we have no coverage checks
    - and then another bit to realize _why_ it decreased
    @agilgur5
    agilgur5 committed Aug 24, 2022
    Configuration menu
    Copy the full SHA
    7e316b8 View commit details
    Browse the repository at this point in the history