Use insta for the integration tests (#967)

* Make sure the submodules are populated before running cargo test

* Remove rust std from the tests

* Use insta

* Add a rust integration test using serde sources

* Change the snapshots layout

And omit the FuncSpace::name

* Remove excess whitespace from the names

Author: lu-zero

.gitmodules

@@ -4,9 +4,9 @@
 [submodule "tests/repositories/DeepSpeech"]
 	path = tests/repositories/DeepSpeech
 	url = https://github.com/mozilla/DeepSpeech
-[submodule "tests/repositories/rust"]
-	path = tests/repositories/rust
-	url = https://github.com/rust-lang/rust.git
 [submodule "tests/repositories/pdf.js"]
 	path = tests/repositories/pdf.js
 	url = https://github.com/mozilla/pdf.js
+[submodule "tests/repositories/serde"]
+	path = tests/repositories/serde
+	url = https://github.com/serde-rs/serde

.taskcluster.yml

@@ -47,6 +47,7 @@ tasks:
                git clone --quiet ${repository} &&
                cd rust-code-analysis &&
                git -c advice.detachedHead=false checkout ${head_rev} &&
+               git submodule update --init &&
                pip3 install --quiet pre-commit &&
                pre-commit run -a --show-diff-on-failure &&
                pre-commit run --show-diff-on-failure -c .pre-commit-audit-config.yaml &&
@@ -113,6 +114,7 @@ tasks:
                git clone --quiet ${repository} &&
                cd rust-code-analysis &&
                git -c advice.detachedHead=false checkout ${head_rev} &&
+               git submodule update --init &&
                cargo test --workspace --verbose --all-features --target x86_64-unknown-linux-gnu &&
                ../grcov . --binary-path ./target/ -s . -t lcov --llvm --branch --ignore-not-existing --ignore '/*' -o lcov.info &&
                bash <(curl -s https://codecov.io/bash) -f lcov.info"
@@ -143,6 +145,7 @@ tasks:
             - git clone --quiet ${repository}
             - cd rust-code-analysis
             - git -c advice.detachedHead=false checkout ${head_rev}
+            - git submodule update --init
             - cargo test --workspace --verbose --all-features
           mounts:
             - content:

Cargo.lock

@@ -39,8 +39,14 @@ tree-sitter-mozcpp = { path = "./tree-sitter-mozcpp", version = "=0.20.1" }
 tree-sitter-mozjs = { path = "./tree-sitter-mozjs", version = "=0.19.0" }
 
 [dev-dependencies]
+insta = { version = "1.22.0", features = ["yaml"] }
 pretty_assertions = "^1.0"
-serde_json = { version = "^1.0", features = ["arbitrary_precision"] }
+
+[profile.dev.package.insta]
+opt-level = 3
+
+[profile.dev.package.similar]
+opt-level = 3
 
 [workspace]
 members = ["rust-code-analysis-cli", "rust-code-analysis-web"]

Cargo.toml

@@ -71,6 +71,15 @@ To verify whether all tests pass, run the `cargo test` command.
 cargo test --workspace --all-features --verbose
 ```
 
+### Updating insta tests
+We use [insta](https://insta.rs), to update the snapshot tests you should install [cargo insta](https://crates.io/crates/cargo-insta)
+
+``` console
+cargo insta test --review
+```
+
+Will run the tests, generate the new snapshot references and let you review them.
+
 # Contributing
 
 If you want to contribute to the development of this software, have a look at the

README.md

@@ -164,8 +164,10 @@ impl FuncSpace {
                 node.object().end_position().row + 1,
             ),
         };
+
         Self {
-            name: T::get_func_space_name(node, code).map(|name| name.to_string()),
+            name: T::get_func_space_name(node, code)
+                .map(|name| name.split_whitespace().collect::<Vec<_>>().join(" ")),
             spaces: Vec::new(),
             metrics: CodeMetrics::default(),
             kind,