Skip to content

Port findutils to use uutests #537

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
Open
sylvestre opened this issue Apr 14, 2025 · 1 comment · May be fixed by #541
Open

Port findutils to use uutests #537

sylvestre opened this issue Apr 14, 2025 · 1 comment · May be fixed by #541
Labels
good first issue

Comments

@sylvestre
Copy link
Contributor

Currently, the tests are custom. we should move to our framework for consistency.

The doc is here:
https://docs.rs/uutests/0.0.30/uutests/

Some examples of usage:
https://github.com/uutils/coreutils/blob/main/tests/by-util/test_ls.rs
https://github.com/uutils/coreutils/blob/main/tests/by-util/test_cp.rs

To do it:
tests/common/mod.rs

diff --git a/tests/common/mod.rs b/tests/common/mod.rs
index aa8de37..d69371b 100644
--- a/tests/common/mod.rs
+++ b/tests/common/mod.rs
@@ -8,3 +8,13 @@
 // in one test but not another can cause a dead code warning.
 #[allow(dead_code)]
 pub mod test_helpers;
+pub const TESTS_BINARY: &str = env!("CARGO_BIN_EXE_find");
+
+// Use the ctor attribute to run this function before any tests
+#[ctor::ctor]
+fn init() {
+    unsafe {
+        // Necessary for uutests to be able to find the binary
+        std::env::set_var("UUTESTS_BINARY_PATH", TESTS_BINARY);
+    }
+}

Cargo.toml:

diff --git a/Cargo.toml b/Cargo.toml
index 6ed7124..43b09d0 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -19,6 +19,9 @@ onig = { version = "6.4", default-features = false }
 uucore = { version = "0.0.30", features = ["entries", "fs", "fsext", "mode"] }
 nix = { version = "0.29", features = ["fs", "user"] }
 argmax = "0.3.1"
+uutests = { version = "0.0.30" }
+ctor = "0.4.1"
+
 
 [dev-dependencies]
 assert_cmd = "2"

And update:

  • tests/exec_unit_tests.rs
  • tests/find_cmd_tests.rs
  • tests/find_exec_tests.rs
  • tests/xargs_tests.rs
@hz2
Copy link

hz2 commented Apr 15, 2025

I can try taking this!

Though I may be misunderstanding the updates to be made to exec_unit_tests.rs. From this comment that states:

/// ! This file contains what would be normally be unit tests for `find::matchers::exec`.
/// ! But as the tests require running an external executable, they need to be run
/// ! as integration tests so we can ensure that our testing-commandline binary
/// ! has been built.

My understanding is that these tests are not targeting the find CLI binary itself, but instead validate internal matcher logic (SingleExecMatcher, MultiExecMatcher) which invoke external executables as part of the test setup.

In that case, would converting exec_unit_tests.rs to uutests still be appropriate? Since uutests is geared toward CLI-level testing of the find binary?

This may be a misunderstanding on my part, feedback is much appreciated!

Cheers!

hz2 added a commit to hz2/findutils that referenced this issue Apr 26, 2025
@hz2
porting findutils testing to use uutests
aeb2429 
closes uutils#537
@hz2 hz2 linked a pull request Apr 26, 2025 that will close this issue
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

porting findutils testing to use uutests hz2/findutils
2 participants
@sylvestre @hz2