test: use snapshot and split into multiple files #143

marcalexiei · 2024-07-03T11:51:47Z

Part of #141

Unit tests updates

Split tests between files

Unit tests have been divided into multiple files and now use snapshots.
This should improve readability and, hopefully, maintenance efforts.
All common utilities and variables are now exported by test/utils/index file

`insertStyle.test.ts` – replace `jsdom` with `happy-dom`

Since the test are quite simple I opted out to switch jsdom to happy-dom (less dependencies and faster)

Additional changes

All unit test dependencies have been updated:
- ava
- @ava/typescript
- nyc
- sinon
Added missing @types for
- sinon
- icss-utils

elycruz · 2024-07-06T00:10:32Z

Started looking over the changes - Will review them fully over the weekend.

- Added 'husky', and 'commitlint' dev-deps. - Ran 'npx husky init' (which in-turn, creates initial 'pre-commit' hook).

- Added 'commit-msg' hook, and (package) script.

- Removed un-required changes.

elycruz · 2024-07-13T19:59:37Z

@marcalexiei Hey, the changes are pretty lenghty to go through - Could you summarize which tests have been updated to use snapshots, and which tests actually changed (I see a couple are using snapshots, but not all of them)?

marcalexiei

The majority of test has been converted to snapshot, the change is basically replace one or more assertions with t.snapshot

Here is the list of list which are not using snapshot and why:

test/insertStyle.test.ts do not use snapshot because is testing just the function itself
test/options.insert.test.ts
- should generate chunks with import insertStyle when insert is true checks output. of bundle to ensure that insertStyle is used once (issue-132 - dedupe insertStyle in output files #139)
test/sourcemap.test.ts doesn't use snapshots because are testing sourcemaps

After reviewing the changes I noticed tests in these files probably can use snapshots

test/options.output.test.ts
test/watchList.test.ts

I'll update them now.

marcalexiei · 2024-07-14T09:06:37Z

`test/watchList.test.ts`

Can't use snapshot since is comparing rollup properties with file system files.
However I was able to simplify the logic (I created a separate commit).

`test/options.output.test.ts`

Using snapshot here is not feasible due to rollup:
It looks like that, randomly, plugin transform is called first on actual_b and then on actual_a instead of calling transform on actual_a and then on actual_b.

So instead of having:

body{color:red}body{color:green}

you end up having

body{color:green}body{color:red}

But only some times.

This looks like a rollup bug:

Module execution order can be incorrect rollup/rollup#3888

Right now on main branch should support output as function sometimes fails for the exact same reason.
Also on other tests involving output, assertions are written using indexOf !== -1 logic.
I assume it's because of this bug.

E.g.:

rollup-plugin-sass/test/index.test.ts

Lines 265 to 268 in 0425739

    
           .then((rslt) => { 
        
             t.not(squash(rslt.toString()).indexOf(expectA), -1); 
        
             t.not(squash(rslt.toString()).indexOf(expectB), -1); 
        
           });

Right now there isn't much we can do.
I'm going to add a code comment on options.output.test.ts referencing this PR

# Conflicts: # package-lock.json # package.json

elycruz · 2024-07-18T23:32:27Z

I'm glad you noticed that bug (I had noticed it too) - Lets connect on the interwebs to discuss this PR - I'm on discord (as edlcmoose) - Note: I'm only asking because this is a large change that we should probably do in smaller pull requests also the value of changing all tests to use snapshots isn't very clear to me so was hoping you could shed light on what the pros/cons are about adapting this approach, and/or if there are any analysis that you have performed on the approach.

marcalexiei · 2024-07-19T16:00:26Z

For transparency and because I do not have a Discord account 😅 I will reply here:

I'm only asking because this is a large change that we should probably do in smaller pull requests

I divided the monolithic file into different files but the tests are the same.
I haven't changed test description, so it can be compared with the previous implementation.
I had to move the variables that were on the top of index.test.ts inside a separate file (test/utils/index.ts) to avoid duplication between the new test files.
The variables have been renamed with a TEST_ prefix to avoid clash with src folder export.

I do not have any rush to get this merged so feel free to review when you have time 😀.

Note

If you stil find hard to review the changes I can close this PR and re-create smaller ones.

the value of changing all tests to use snapshots isn't very clear

IMHO The main benefit is that though the snapshots you have a quick and fast way to compare the string output instead of having to search around for "expect" files that are read through node:fs and compared to plugin output after various trim / clean operations.

if there are any analysis that you have performed on the approach

I used snapshot approach for the first time when implementing a custom webpack loader tests.
I find it more quick and easy than manipulating the strings directly via JS (which I was doing previously).

An additional benefit is that they can easily updated via cli command instead of performing the operation manually.

You can find the code here: https://github.com/marcalexiei/ractive-html-loader
The snapshot are used in this file: test/loader.test.js

elycruz · 2024-07-19T21:58:22Z

Ok, thank you for indulging me - I understand the changes better now -
will set time to review and validate them over the next couple of days.

marcalexiei · 2024-07-20T06:24:26Z

thank you for indulging me

No problem 😉

will set time to review and validate them over the next couple of days.

Thank you! As I said there is no rush 😃.

Have a good weekend!

elycruz

Ok, so generally your changes look good, however they are to many to consume in one PR - You will need to separate it as follow, as well as make the review updates mentioned in the other review comments:

One PR for dependency updates.
One for changing all tests to use snapshots, and/or just contain updates, and,
One for breaking the tests out into their own files.

Like this we would be able to consume the changes without requiring high cognitive load (too many things changing requires more things to keep in mind).

elycruz · 2024-07-24T22:31:29Z

test/basic.test.ts

+
+import sass from "../src/index";
+import {
+  TEST_UTILS,


So for TEST_UTILS, could you change the exports to just the methods themselves - Since they already live at 'test/utils' it becomes redundant to export the object TEST_UTILS - What would be good here would be to rename squash to stripNewLines, or something similar!

Also, getOutputFirstChunkCode could just be getFirstChunkCode - since the declaration would read getFirstChunkCode(output: ...) ... - Would also change output to chunks, and/or, outputChunks for more correlation between what output constants actually represent.

elycruz · 2024-07-24T22:55:35Z

@marcalexiei Also, the dependency updates can go together with the changing the tests PR.

marcalexiei · 2024-07-25T03:33:56Z

Ok...

marcalexiei requested a review from elycruz as a code owner July 3, 2024 11:51

marcalexiei mentioned this pull request Jul 3, 2024

Suggestions: package maintenance improvements #141

Open

7 tasks

elycruz added a commit that referenced this pull request Jul 6, 2024

feat: issue-#143 - add commitlint

0450a95

- Added 'husky', and 'commitlint' dev-deps. - Ran 'npx husky init' (which in-turn, creates initial 'pre-commit' hook).

elycruz added a commit that referenced this pull request Jul 6, 2024

feat: issue-#143 - add commitlint

4043aef

- Added 'commit-msg' hook, and (package) script.

elycruz added a commit that referenced this pull request Jul 6, 2024

feat: issue-#143 - add commitlint

2dcec5e

- Removed un-required changes.

elycruz added enhancement CI/CD Issues related to running, and/or, updating ci/cd processes. and removed CI/CD Issues related to running, and/or, updating ci/cd processes. labels Jul 6, 2024

marcalexiei force-pushed the feature/test-snapshot branch from 8f661c1 to cec0454 Compare July 6, 2024 05:37

marcalexiei mentioned this pull request Jul 6, 2024

chore: move npm test to pre-push hook #148

Merged

marcalexiei commented Jul 14, 2024

View reviewed changes

marcalexiei added 5 commits July 14, 2024 11:08

test: use snapshot and split into multiple files

0c7643b

# Conflicts: # package-lock.json # package.json

chore(deps-dev): update ava, @ava/typescript and nyc

7980308

# Conflicts: # package-lock.json # package.json

test(insertStyle): replace jsdom with happy-dom

f74a07f

# Conflicts: # package-lock.json # package.json

test(watchList): simplify logic

8a43815

test(options.output): add information about why we can’t use snapshot

36c02c2

marcalexiei force-pushed the feature/test-snapshot branch from cec0454 to 36c02c2 Compare July 14, 2024 09:09

elycruz requested changes Jul 24, 2024

View reviewed changes

marcalexiei closed this Jul 25, 2024

marcalexiei deleted the feature/test-snapshot branch July 25, 2024 05:01

marcalexiei mentioned this pull request Jul 25, 2024

test: use snapshot #151

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: use snapshot and split into multiple files #143

test: use snapshot and split into multiple files #143

marcalexiei commented Jul 3, 2024 •

edited

Loading

elycruz commented Jul 6, 2024

elycruz commented Jul 13, 2024

marcalexiei left a comment

marcalexiei commented Jul 14, 2024

elycruz commented Jul 18, 2024 •

edited

Loading

marcalexiei commented Jul 19, 2024

elycruz commented Jul 19, 2024

marcalexiei commented Jul 20, 2024

elycruz left a comment

elycruz Jul 24, 2024

elycruz Jul 24, 2024

elycruz commented Jul 24, 2024

marcalexiei commented Jul 25, 2024

test: use snapshot and split into multiple files #143

test: use snapshot and split into multiple files #143

Conversation

marcalexiei commented Jul 3, 2024 • edited Loading

Unit tests updates

Split tests between files

insertStyle.test.ts – replace jsdom with happy-dom

Additional changes

elycruz commented Jul 6, 2024

elycruz commented Jul 13, 2024

marcalexiei left a comment

Choose a reason for hiding this comment

marcalexiei commented Jul 14, 2024

test/watchList.test.ts

test/options.output.test.ts

elycruz commented Jul 18, 2024 • edited Loading

marcalexiei commented Jul 19, 2024

elycruz commented Jul 19, 2024

marcalexiei commented Jul 20, 2024

elycruz left a comment

Choose a reason for hiding this comment

elycruz Jul 24, 2024

Choose a reason for hiding this comment

elycruz Jul 24, 2024

Choose a reason for hiding this comment

elycruz commented Jul 24, 2024

marcalexiei commented Jul 25, 2024

marcalexiei commented Jul 3, 2024 •

edited

Loading

`insertStyle.test.ts` – replace `jsdom` with `happy-dom`

`test/watchList.test.ts`

`test/options.output.test.ts`

elycruz commented Jul 18, 2024 •

edited

Loading