Skip to content
This repository has been archived by the owner on Feb 1, 2021. It is now read-only.

[RFC]: Replace the snapshot tests with more meaningful code #480

Open
2 tasks
KnisterPeter opened this issue Nov 7, 2019 · 2 comments
Open
2 tasks

[RFC]: Replace the snapshot tests with more meaningful code #480

KnisterPeter opened this issue Nov 7, 2019 · 2 comments

Comments

@KnisterPeter
Copy link
Contributor

Reason

Right now the snapshot test does not run on windows, because the path matching in the normalize helper fails to match for windows paths.

The details in the normalizer work on all strings matching a base path. This needs to convert backslashes as well and not only remove the common base path.

Problem

I think a few things about this are awkward:

  1. Replacing strings by regexp in a serialized json object could match other things and not only paths.
  2. Converting all backslashes for 'kind-of'-paths is not that easy and would increase complexity a lot
  3. This is 'patching' the test results before snapshoting them. This means to create code for just the tests to have them more stable which is contraproductive and could lead to fixing the testcode instead of bugs.
  4. Snapshots per se are more useful to detect if something has changed, but unit tests should be there do define whats expected. Right now the expectation in the untool tests with snapshots is not clear.

Solution

  • Rewrite the tests using snapshots into more explicit tests.
  • Maybe convert the tests to jest instead of use ava since the expect output is somewhat better
@KnisterPeter
Copy link
Contributor Author

Already started to adding test #484, #485, #486 and #487
No test where removed so far.

@dmbch
Copy link
Member

dmbch commented Nov 16, 2019

I love (most of) this. Having better tests is something we were keen on for a very long time. It will be quite a bit of work to render the snapshots obsolete, but it will certainly be worthwhile.

We decided not to focus on Windows support for developing untool because at XING, that is not an officially supported development environment, but sure, why not.

As to switching to Jest, the reasoning appears to be a bit weak, and also, I am personally partial to Ava...

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

No branches or pull requests

2 participants