Fix snapshots within a nested crate #531

max-sixty · 2024-07-21T20:30:08Z

Fixes #396

max-sixty · 2024-07-21T22:50:19Z

I've now pushed a slightly broader change, because I was concerned that not passing any packages would fail to include interior packages.

In the existing code, we placed all packages in LocationInfo, and then sometimes passed selected packages to functions when required.
In the initial commit of the PR, we no longer necessarily pick up all code by running the root package (because we want to skip interior packages). Without better test coverage I'm not sure whether that can miss parts of the repo in some conditions.
With the subsequent commits, we now place all packages we want to run over in LocationInfo. Making this explicit in a single place means we're less likely to make a mistake. There's a bit more cloning, but of tiny objects outside any hot loops, and I think worth waiting for Upgrade structopt to clap #518 etc before optimizing those.

On top of mitsuhiko#531; that needs to merge first. This simplifies that code

regexident · 2024-07-24T09:14:46Z

@max-sixty It looks like this introduces a regression, which I unfortunately haven't yet been able to reproduce with the MCVE:

The regression is that while running insta test with --accept --workspace now works as expected it fails to accept the snapshots when running with a specific package via --accept --package "package-name".

This is the console output when running with --accept --workspace:

cargo insta test --release --accept --workspace

...

running 3 tests
stored new snapshot <SNIP>/crates/<SNIP>/tests/snapshots/<SNIP>.snap.new
stored new snapshot <SNIP>/crates/<SNIP>/tests/snapshots/<SNIP>.snap.new
...
test snapshots ... ok

...

insta review finished
accepted:
  crates/<SNIP>/tests/snapshots.rs (<SNIP>.snap)
  crates/<SNIP>/tests/snapshots.rs (<SNIP>.snap)
  ...

And this is with --accept --package "<SNIP>":

cargo insta test --release --accept --package "<SNIP>"

...

running 3 tests
stored new snapshot <SNIP>/crates/<SNIP>/tests/snapshots/<SNIP>.snap.new
stored new snapshot <SNIP>/crates/<SNIP>/tests/snapshots/<SNIP>.snap.new
...
test snapshots ... ok

...

Running the latter command (i.e. --accept --package) with the currently released version of cargo-insta I get the correct behavior.

Looks like it now under-counts in certain circumstances, instead of double-counting. 😅

max-sixty · 2024-07-24T17:15:25Z

Thanks! If there's any way of getting a repo that would be really helpful. I'll try to have a think about what might be going on but I suspect it'll be difficult to manage without a repro.

Do you know whether the failure happens when the selected package is the root vs the interior package?

~~One other oddity I noticed using this branch on my work is that snapshots are getting saved with empty headers. I'll try and make a repro myself (it doesn't seem to be all snapshots...)~~ edit: unrelated & fixed!

regexident · 2024-07-28T10:38:47Z

@max-sixty It looks like this introduces a regression, which I unfortunately haven't yet been able to reproduce with the MCVE:

I was wrong, it can be reproduced with the MCVE!

I had commented out the root package. Once I reset the shared repo to commit b8a2892 (7fd61fb would work, too), installed cargo-insta from branch 396 and ran cargo insta test --accept --package "member-crate" I got this:

cargo insta test --accept --package "member-crate"

    Finished `test` profile [unoptimized + debuginfo] target(s) in 0.03s
     Running unittests src/lib.rs (target/debug/deps/member_crate-7d5d5f9bfb1209aa)

running 1 test
stored new snapshot <SNIP>/insta-bug-repro/crates/member-crate/src/snapshots/member_crate__tests__member.snap.new
test tests::test_member ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.14s

   Doc-tests member_crate

running 0 tests

test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

done: no snapshots to review

max-sixty · 2024-07-28T17:52:23Z

Great! Can repro, looking now...

max-sixty · 2024-07-28T18:21:01Z

Fixed! Let me know if that works for you.

(separately I'm thinking about how we can have reasonable integration tests — atm I don't think we're compounding that well, given someone could break this and we wouldn't immediately find out, which then makes changes more difficult. I very much appreciate your patience and help fixing this one...)

max-sixty · 2024-07-28T20:14:52Z

cargo-insta/src/cargo.rs

    if let Some(manifest_path) = manifest_path {
        cmd.manifest_path(manifest_path);
    }
+
+    // TODO: why do we have this? When do we ever want dependencies here?


For anyone reviewing — all this code is replaced in #536

Very draft — but shows a reasonably scalable way to add integration tests. There are some TODOs at the top. This would help with issues such as mitsuhiko#531

max-sixty · 2024-07-29T05:40:21Z

This now has a nice integration test with a new integration test approach, in #537

regexident · 2024-07-29T07:13:41Z

Fixed! Let me know if that works for you.

It does! 🥳

max-sixty · 2024-08-02T06:52:08Z

I would like to merge #537 first and add a test, as I'm not sure I've got the logic right here (even though it seems to pass our hand-tests).

So removing the review request for the moment

mitsuhiko · 2024-08-02T09:22:07Z

I merged #537.

mitsuhiko · 2024-08-02T21:26:37Z

So looking through this I think we need real integration tests here. I find it hard to follow both existing code and the changes here with confidence that nothing regressed.

max-sixty · 2024-08-02T21:43:54Z

So looking through this I think we need real integration tests here. I find it hard to follow both existing code and the changes here with confidence that nothing regressed.

Yes agree (re my request to merge #537 first!)

I ended up just integrating everything into #532, because it made the code simpler and easier to debug. So going to close this in favor of that.

Fix snapshots within a nested crate

2986754

Fixes mitsuhiko#396

max-sixty mentioned this pull request Jul 21, 2024

Duplicated snapshots and os error 2 when running a workspace + root crate #396

Closed

max-sixty added 4 commits July 21, 2024 15:04

add comment

c3dbf6a

Always pass packages along

4e83ac4

Change LocationInfo::packages to have the selected packages

8451e13

09c7522

max-sixty requested a review from mitsuhiko July 21, 2024 22:50

max-sixty added a commit to max-sixty/insta that referenced this pull request Jul 22, 2024

Unify snapshot walkers

59c7101

On top of mitsuhiko#531; that needs to merge first. This simplifies that code

max-sixty mentioned this pull request Jul 22, 2024

Fix workspace with default root, simplify lots walkers & metadata #532

Merged

Merge branch 'master' into 396

fa34135

Include all packages when --workspace is passed

5b54841

max-sixty added 2 commits July 28, 2024 12:09

Merge branch 'master' into 396

4ac2dc4

remove unneeded code now that we always have packages

4d45bea

max-sixty commented Jul 28, 2024

View reviewed changes

max-sixty mentioned this pull request Jul 28, 2024

New integration test approach #537

Merged

max-sixty added 4 commits August 1, 2024 12:37

Merge branch 'master' into 396

1e93eb3

Merge branch 'master' into 396

de18c75

8ee8592

7dc7d6a

max-sixty removed the request for review from mitsuhiko August 2, 2024 06:52

0a31d12

Merge branch 'master' into 396

e78415d

max-sixty closed this Aug 2, 2024

max-sixty deleted the 396 branch August 2, 2024 21:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix snapshots within a nested crate #531

Fix snapshots within a nested crate #531

max-sixty commented Jul 21, 2024

max-sixty commented Jul 21, 2024 •

edited

Loading

regexident commented Jul 24, 2024

max-sixty commented Jul 24, 2024 •

edited

Loading

regexident commented Jul 28, 2024 •

edited

Loading

max-sixty commented Jul 28, 2024

max-sixty commented Jul 28, 2024

max-sixty Jul 28, 2024 •

edited

Loading

max-sixty commented Jul 29, 2024

regexident commented Jul 29, 2024

max-sixty commented Aug 2, 2024

mitsuhiko commented Aug 2, 2024

mitsuhiko commented Aug 2, 2024

max-sixty commented Aug 2, 2024

Fix snapshots within a nested crate #531

Fix snapshots within a nested crate #531

Conversation

max-sixty commented Jul 21, 2024

max-sixty commented Jul 21, 2024 • edited Loading

regexident commented Jul 24, 2024

max-sixty commented Jul 24, 2024 • edited Loading

regexident commented Jul 28, 2024 • edited Loading

max-sixty commented Jul 28, 2024

max-sixty commented Jul 28, 2024

max-sixty Jul 28, 2024 • edited Loading

Choose a reason for hiding this comment

max-sixty commented Jul 29, 2024

regexident commented Jul 29, 2024

max-sixty commented Aug 2, 2024

mitsuhiko commented Aug 2, 2024

mitsuhiko commented Aug 2, 2024

max-sixty commented Aug 2, 2024

max-sixty commented Jul 21, 2024 •

edited

Loading

max-sixty commented Jul 24, 2024 •

edited

Loading

regexident commented Jul 28, 2024 •

edited

Loading

max-sixty Jul 28, 2024 •

edited

Loading