test utilities: easy way to simulate terminal context by cre4ture · Pull Request #5869 · uutils/coreutils

cre4ture · 2024-01-22T17:16:22Z

addresses #5785
and addresses #1857
replaces if accepted PR #5858

let me know what you think. It's very easy to use. Just do a .simulate_terminal(true) and thats it.
I implemented in such a way that also stdin piping still works and also the capturing of stdout and stderr works as usual.
EDIT: For cases where the terminal size matters, there is no an additional function available:

.terminal_size(libc::winsize {
                ws_col: 40,
                ws_row: 10,
                ws_xpixel: 40 * 8,
                ws_ypixel: 10 * 10,
            })

Example:

#[test]
fn test_simulation_of_terminal_true() {
    let scene = TestScenario::new(util_name!());

    let out = scene
        .ucmd()
        .arg("sh")
        .arg("is_atty.sh")
        .terminal_simulation(true)
        .succeeds();
    assert_eq!(
        String::from_utf8_lossy(out.stdout()),
        "stdin is atty\r\nstdout is atty\r\nstderr is atty\r\n"
    );
    assert_eq!(
        String::from_utf8_lossy(out.stderr()),
        "This is an error message.\r\n"
    );
}

where is_atty.sh looks like this:

#!/bin/bash

if [ -t 0 ] ; then
    echo "stdin is atty"
else
    echo "stdin is not atty"
fi

if [ -t 1 ] ; then
    echo "stdout is atty"
else
    echo "stdout is not atty"
fi

if [ -t 2 ] ; then
    echo "stderr is atty"
else
    echo "stderr is not atty"
fi

echo "This is an error message." > /dev/stderr

true

tests/common/util.rs

RenjiSann · 2024-02-05T21:29:53Z

Is it ready to merge already, or are we waiting for further improvements ?

cre4ture · 2024-02-07T21:25:58Z

What is missing is a review and approval from one of the maintainers.
@sylvestre - I also did the squash commit now. Let me know what you think.

tertsdiepraam

I like it a lot! Excellent work! I only have some small questions.

I also think that we might want to be able to configure the terminal with this interface, but for now, the API is flexible enough I think. It's also about time we extract the test framework to a crate, so we can generate documentation for it. It's getting quite complex. That's something for another PR though.

I would like to wait for approval of one of the other maintainers before merging though.

One final question: have you seen any intermittently failing tests with this? Can we assume that this implementation is robust enough not to make our test suite fail unexpectedly (even more so then it already does 😅)

.gitignore

tertsdiepraam · 2024-02-07T22:39:20Z

tests/by-util/test_env.rs

+fn test_simulation_of_terminal_false() {
+    let scene = TestScenario::new(util_name!());
+
+    let out = scene.ucmd().arg("sh").arg("is_atty.sh").succeeds();


Are these meaningful tests of env? If not, it could still be useful to have them (we're going very meta with tests for our test framework 😄), but maybe somewhere else?

ah, yes. This is a valid point. I used env here as a tool rather than to test itself. This is something I should cleanup. Do you have a proposal for a better location of these tests?

Maybe in the file where the test framework is defined? It's an interesting question, we don't really have tests for the tests yet 😄

cre4ture · 2024-02-08T21:18:16Z

One final question: have you seen any intermittently failing tests with this? Can we assume that this implementation is robust enough not to make our test suite fail unexpectedly (even more so then it already does 😅)

I think its stable.

github-actions · 2024-02-25T17:54:47Z

GNU testsuite comparison:

Skipping an intermittent issue tests/tail/inotify-dir-recreate (passes in this run but fails in the 'main' branch)

github-actions · 2024-02-25T18:25:16Z

GNU testsuite comparison:

Skipping an intermittent issue tests/tail/inotify-dir-recreate (passes in this run but fails in the 'main' branch)

github-actions · 2024-02-25T21:36:26Z

GNU testsuite comparison:

Skipping an intermittent issue tests/tail/inotify-dir-recreate (passes in this run but fails in the 'main' branch)

sylvestre · 2024-03-01T17:13:30Z

thanks

cre4ture mentioned this pull request Jan 22, 2024

tests: Provide a way to run tests with PTY stdout #5785

Closed

cre4ture force-pushed the feature/simulate_terminal_utility branch from 83412c4 to 379a38c Compare January 22, 2024 17:19

cre4ture mentioned this pull request Jan 22, 2024

nohup: improve test coverage #5858

Closed

RenjiSann reviewed Jan 23, 2024

View reviewed changes

tests/common/util.rs Outdated Show resolved Hide resolved

cre4ture force-pushed the feature/simulate_terminal_utility branch from 2ac77c5 to 7bfed9e Compare January 23, 2024 21:07

cre4ture force-pushed the feature/simulate_terminal_utility branch from 7bfed9e to 0e11cdc Compare February 4, 2024 22:32

cre4ture force-pushed the feature/simulate_terminal_utility branch from 0e11cdc to a803ce1 Compare February 7, 2024 21:02

tertsdiepraam approved these changes Feb 7, 2024

View reviewed changes

cre4ture force-pushed the feature/simulate_terminal_utility branch 3 times, most recently from 0d14526 to 66ded04 Compare February 8, 2024 20:47

cre4ture closed this Feb 8, 2024

cre4ture reopened this Feb 8, 2024

cre4ture force-pushed the feature/simulate_terminal_utility branch from 66ded04 to d21d2f1 Compare February 10, 2024 13:36

cre4ture force-pushed the feature/simulate_terminal_utility branch 2 times, most recently from 943c22b to b291cf3 Compare February 24, 2024 16:11

simulate terminal utility (squash)

a4d5def

cre4ture force-pushed the feature/simulate_terminal_utility branch from b291cf3 to a4d5def Compare February 25, 2024 17:15

cre4ture force-pushed the feature/simulate_terminal_utility branch 2 times, most recently from 5d57805 to ef02e43 Compare February 25, 2024 20:40

added configurable terminal size

d8b3b41

cre4ture force-pushed the feature/simulate_terminal_utility branch from ef02e43 to d8b3b41 Compare February 25, 2024 20:47

sylvestre merged commit 9003e3f into uutils:main Mar 1, 2024

cakebaker mentioned this pull request Mar 3, 2024

tests/common/util.rs: add cfg(feature = "env") #6044

Merged

chenrui333 mentioned this pull request Mar 24, 2024

uutils-coreutils 0.0.25 Homebrew/homebrew-core#167053

Merged

moonfruit mentioned this pull request Mar 28, 2024

uutils-selected 0.0.25 moonfruit/homebrew-tap#92

Merged

augustebaum mentioned this pull request May 28, 2025

nohup: write unit tests to improve coverage #1857

Open

Uh oh!

Conversation

cre4ture commented Jan 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

RenjiSann commented Feb 5, 2024

Uh oh!

cre4ture commented Feb 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tertsdiepraam left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tertsdiepraam Feb 7, 2024

Choose a reason for hiding this comment

Uh oh!

cre4ture Feb 8, 2024

Choose a reason for hiding this comment

Uh oh!

tertsdiepraam Feb 8, 2024

Choose a reason for hiding this comment

Uh oh!

cre4ture Feb 8, 2024

Choose a reason for hiding this comment

Uh oh!

cre4ture commented Feb 8, 2024

Uh oh!

github-actions bot commented Feb 25, 2024

Uh oh!

github-actions bot commented Feb 25, 2024

Uh oh!

github-actions bot commented Feb 25, 2024

Uh oh!

sylvestre commented Mar 1, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

cre4ture commented Jan 22, 2024 •

edited

Loading

cre4ture commented Feb 7, 2024 •

edited

Loading