From e3d301220fa0730c7023aa82fdb9067b17ad613f Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru Date: Fri, 3 Feb 2023 23:09:24 +0100 Subject: [PATCH 01/39] mv: Update of fs_extra - address the new warnings --- Cargo.lock | 4 ++-- src/uu/mv/Cargo.toml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 1dd53c9bb..6b838a518 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -862,9 +862,9 @@ checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1" [[package]] name = "fs_extra" -version = "1.2.0" +version = "1.3.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2022715d62ab30faffd124d40b76f4134a550a87792276512b18d63272333394" +checksum = "42703706b716c37f96a77aea830392ad231f44c9e9a67872fa5548707e11b11c" [[package]] name = "fsevent-sys" diff --git a/src/uu/mv/Cargo.toml b/src/uu/mv/Cargo.toml index 7ef274153..2b4272fea 100644 --- a/src/uu/mv/Cargo.toml +++ b/src/uu/mv/Cargo.toml @@ -16,7 +16,7 @@ path = "src/mv.rs" [dependencies] clap = { version = "4.0", features = ["wrap_help", "cargo"] } -fs_extra = "1.1.0" +fs_extra = "1.3.0" indicatif = "0.17" uucore = { version=">=0.0.17", package="uucore", path="../../uucore" } From 5e98227714559ebaca4c7ae23f682716646dcbc4 Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru Date: Wed, 15 Feb 2023 08:35:19 +0100 Subject: [PATCH 02/39] refresh the installation doc with new distros --- docs/src/installation.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/src/installation.md b/docs/src/installation.md index cb5c89163..e2e72699b 100644 --- a/docs/src/installation.md +++ b/docs/src/installation.md @@ -43,13 +43,23 @@ pacman -S uutils-coreutils ### Debian -[![Debian Unstable package](https://repology.org/badge/version-for-repo/debian_unstable/uutils-coreutils.svg)](https://packages.debian.org/sid/source/rust-coreutils) +[![Debian package](https://repology.org/badge/version-for-repo/debian_unstable/uutils-coreutils.svg)](https://packages.debian.org/sid/source/rust-coreutils) ```bash apt install rust-coreutils +# To use it: +export PATH=/usr/lib/cargo/bin/coreutils:$PATH ``` -> **Note**: Requires the `unstable` repository. +> **Note**: Only available from Bookworm (Debian 12) + +### Gentoo + +[![Gentoo package](https://repology.org/badge/version-for-repo/gentoo/uutils-coreutils.svg)](https://packages.gentoo.org/packages/sys-apps/uutils) + +```bash +emerge -pv sys-apps/uutils +``` ### Manjaro ![Manjaro Stable package](https://repology.org/badge/version-for-repo/manjaro_stable/uutils-coreutils.svg) @@ -69,6 +79,18 @@ pamac install uutils-coreutils nix-env -iA nixos.uutils-coreutils ``` +### Ubuntu + +[![Ubuntu package](https://repology.org/badge/version-for-repo/ubuntu_23_04/uutils-coreutils.svg)](https://packages.ubuntu.com/source/lunar/rust-coreutils) + +```bash +apt install rust-coreutils +# To use it: +export PATH=/usr/lib/cargo/bin/coreutils:$PATH +``` + +> **Note**: Only available from Kinetic (Ubuntu 22.10) + ## MacOS ### Homebrew From cca54089fbc8c3629025d7841d789bd38f55c079 Mon Sep 17 00:00:00 2001 From: Joining7943 <111500881+Joining7943@users.noreply.github.com> Date: Thu, 16 Feb 2023 19:43:00 +0100 Subject: [PATCH 03/39] tail: Cargo.toml: Remove unneeded features of uucore and the nix dependency --- Cargo.lock | 1 - src/uu/tail/Cargo.toml | 5 +---- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index f01c623f9..6d210d303 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -3102,7 +3102,6 @@ dependencies = [ "fundu", "libc", "memchr", - "nix", "notify", "same-file", "uucore", diff --git a/src/uu/tail/Cargo.toml b/src/uu/tail/Cargo.toml index 12736f36a..bd16132ea 100644 --- a/src/uu/tail/Cargo.toml +++ b/src/uu/tail/Cargo.toml @@ -20,7 +20,7 @@ clap = { workspace=true } libc = { workspace=true } memchr = { workspace=true } notify = { workspace=true } -uucore = { workspace=true, features=["ringbuffer", "lines"] } +uucore = { workspace=true } same-file = { workspace=true } atty = { workspace=true } fundu = { workspace=true } @@ -29,9 +29,6 @@ fundu = { workspace=true } windows-sys = { workspace=true, features = ["Win32_System_Threading", "Win32_Foundation"] } winapi-util = { workspace=true } -[target.'cfg(unix)'.dependencies] -nix = { workspace=true, features = ["fs"] } - [[bin]] name = "tail" path = "src/main.rs" From 946c8d2d4a57d0d825a1e7bbee0f9139ff7d5707 Mon Sep 17 00:00:00 2001 From: David Matos Date: Tue, 14 Feb 2023 00:18:17 +0100 Subject: [PATCH 04/39] chmod: change permissions for files present even when there is a missing file --- src/uu/chmod/src/chmod.rs | 15 ++++---- tests/by-util/test_chmod.rs | 68 +++++++++++++++++++++++++++++++++++++ 2 files changed, 77 insertions(+), 6 deletions(-) diff --git a/src/uu/chmod/src/chmod.rs b/src/uu/chmod/src/chmod.rs index a2dc8e06b..374f22874 100644 --- a/src/uu/chmod/src/chmod.rs +++ b/src/uu/chmod/src/chmod.rs @@ -12,12 +12,12 @@ use std::fs; use std::os::unix::fs::{MetadataExt, PermissionsExt}; use std::path::Path; use uucore::display::Quotable; -use uucore::error::{ExitCode, UResult, USimpleError, UUsageError}; +use uucore::error::{set_exit_code, ExitCode, UResult, USimpleError, UUsageError}; use uucore::fs::display_permissions_unix; use uucore::libc::mode_t; #[cfg(not(windows))] use uucore::mode; -use uucore::{format_usage, show_error}; +use uucore::{format_usage, show, show_error}; const ABOUT: &str = "Change the mode of each FILE to MODE.\n\ With --reference, change the mode of each FILE to that of RFILE."; @@ -195,21 +195,24 @@ impl Chmoder { filename.quote() ); if !self.quiet { - return Err(USimpleError::new( + show!(USimpleError::new( 1, format!("cannot operate on dangling symlink {}", filename.quote()), )); } } else if !self.quiet { - return Err(USimpleError::new( + show!(USimpleError::new( 1, format!( "cannot access {}: No such file or directory", filename.quote() - ), + ) )); } - return Err(ExitCode::new(1)); + // GNU exits with exit code 1 even if -q or --quiet are passed + // So we set the exit code, because it hasn't been set yet if `self.quiet` is true. + set_exit_code(1); + continue; } if self.recursive && self.preserve_root && filename == "/" { return Err(USimpleError::new( diff --git a/tests/by-util/test_chmod.rs b/tests/by-util/test_chmod.rs index 5dfd1a714..feb756632 100644 --- a/tests/by-util/test_chmod.rs +++ b/tests/by-util/test_chmod.rs @@ -574,3 +574,71 @@ fn test_mode_after_dash_dash() { ucmd, ); } + +#[test] +fn test_chmod_file_after_non_existing_file() { + let scene = TestScenario::new(util_name!()); + let at = &scene.fixtures; + at.touch(TEST_FILE); + at.touch("file2"); + set_permissions(at.plus(TEST_FILE), Permissions::from_mode(0o664)).unwrap(); + set_permissions(at.plus("file2"), Permissions::from_mode(0o664)).unwrap(); + scene + .ucmd() + .arg("u+x") + .arg("does-not-exist") + .arg(TEST_FILE) + .fails() + .stderr_contains("chmod: cannot access 'does-not-exist': No such file or directory") + .code_is(1); + + assert_eq!(at.metadata(TEST_FILE).permissions().mode(), 0o100764); + + scene + .ucmd() + .arg("u+x") + .arg("--q") + .arg("does-not-exist") + .arg("file2") + .fails() + .no_stderr() + .code_is(1); + assert_eq!(at.metadata("file2").permissions().mode(), 0o100764); +} + +#[test] +fn test_chmod_file_symlink_after_non_existing_file() { + let scene = TestScenario::new(util_name!()); + let at = &scene.fixtures; + let existing = "file"; + let test_existing_symlink = "file_symlink"; + + let non_existing = "test_chmod_symlink_non_existing_file"; + let test_dangling_symlink = "test_chmod_symlink_non_existing_file_symlink"; + let expected_stdout = &format!( + "failed to change mode of '{test_dangling_symlink}' from 0000 (---------) to 0000 (---------)" + ); + let expected_stderr = &format!("cannot operate on dangling symlink '{test_dangling_symlink}'"); + + at.touch(existing); + set_permissions(at.plus(existing), Permissions::from_mode(0o664)).unwrap(); + at.symlink_file(non_existing, test_dangling_symlink); + at.symlink_file(existing, test_existing_symlink); + + // this cannot succeed since the symbolic link dangles + // but the metadata for the existing target should change + scene + .ucmd() + .arg("u+x") + .arg("-v") + .arg(test_dangling_symlink) + .arg(test_existing_symlink) + .fails() + .code_is(1) + .stdout_contains(expected_stdout) + .stderr_contains(expected_stderr); + assert_eq!( + at.metadata(test_existing_symlink).permissions().mode(), + 0o100764 + ); +} From 94eddc470152e8f957322d1a1f70c55f83639ace Mon Sep 17 00:00:00 2001 From: Daniel Hofstetter Date: Fri, 17 Feb 2023 09:25:32 +0100 Subject: [PATCH 05/39] uucore_procs: separate file opening & parsing --- src/uucore_procs/src/lib.rs | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/src/uucore_procs/src/lib.rs b/src/uucore_procs/src/lib.rs index 1a452254a..dc3d0fbc0 100644 --- a/src/uucore_procs/src/lib.rs +++ b/src/uucore_procs/src/lib.rs @@ -61,7 +61,7 @@ fn render_markdown(s: &str) -> String { pub fn help_usage(input: TokenStream) -> TokenStream { let input: Vec = input.into_iter().collect(); let filename = get_argument(&input, 0, "filename"); - let text: String = parse_usage(&parse_help("usage", &filename)); + let text: String = parse_usage(&parse_help_section("usage", &read_help(&filename))); TokenTree::Literal(Literal::string(&text)).into() } @@ -94,7 +94,7 @@ pub fn help_section(input: TokenStream) -> TokenStream { let input: Vec = input.into_iter().collect(); let section = get_argument(&input, 0, "section"); let filename = get_argument(&input, 1, "filename"); - let text = parse_help(§ion, &filename); + let text = parse_help_section(§ion, &read_help(&filename)); let rendered = render_markdown(&text); TokenTree::Literal(Literal::string(&rendered)).into() } @@ -121,13 +121,11 @@ fn get_argument(input: &[TokenTree], index: usize, name: &str) -> String { .to_string() } -/// Read the help file and extract a section -fn parse_help(section: &str, filename: &str) -> String { - let section = section.to_lowercase(); - let section = section.trim_matches('"'); +/// Read the help file +fn read_help(filename: &str) -> String { let mut content = String::new(); - let mut path = PathBuf::from(std::env::var("CARGO_MANIFEST_DIR").unwrap()); + let mut path = PathBuf::from(std::env::var("CARGO_MANIFEST_DIR").unwrap()); path.push(filename); File::open(path) @@ -135,7 +133,7 @@ fn parse_help(section: &str, filename: &str) -> String { .read_to_string(&mut content) .unwrap(); - parse_help_section(section, &content) + content } /// Get a single section from content @@ -147,6 +145,8 @@ fn parse_help_section(section: &str, content: &str) -> String { .map_or(false, |l| l.trim().to_lowercase() == section) } + let section = §ion.to_lowercase(); + // We cannot distinguish between an empty or non-existing section below, // so we do a quick test to check whether the section exists to provide // a nice error message. @@ -209,6 +209,10 @@ mod tests { parse_help_section("some section", input), "This is some section" ); + assert_eq!( + parse_help_section("SOME SECTION", input), + "This is some section" + ); assert_eq!( parse_help_section("another section", input), "This is the other section\nwith multiple lines" From 1ba0c6853c854fbd5765fd86e2df02ef7d42ead1 Mon Sep 17 00:00:00 2001 From: Daniel Hofstetter Date: Fri, 17 Feb 2023 14:51:40 +0100 Subject: [PATCH 06/39] uucore_procs: drop need for "Usage" header in help --- src/uucore_procs/src/lib.rs | 46 ++++++++++++++++++++++--------------- 1 file changed, 27 insertions(+), 19 deletions(-) diff --git a/src/uucore_procs/src/lib.rs b/src/uucore_procs/src/lib.rs index dc3d0fbc0..cb7e4c355 100644 --- a/src/uucore_procs/src/lib.rs +++ b/src/uucore_procs/src/lib.rs @@ -7,6 +7,8 @@ use std::{fs::File, io::Read, path::PathBuf}; use proc_macro::{Literal, TokenStream, TokenTree}; use quote::quote; +const MARKDOWN_CODE_FENCES: &str = "```"; + //## rust proc-macro background info //* ref: @@ //* ref: [path construction from LitStr](https://oschwald.github.io/maxminddb-rust/syn/struct.LitStr.html) @@ @@ -51,7 +53,7 @@ fn render_markdown(s: &str) -> String { s.replace('`', "") } -/// Get the usage from the "Usage" section in the help file. +/// Get the usage from the help file. /// /// The usage is assumed to be surrounded by markdown code fences. It may span /// multiple lines. The first word of each line is assumed to be the name of @@ -61,7 +63,7 @@ fn render_markdown(s: &str) -> String { pub fn help_usage(input: TokenStream) -> TokenStream { let input: Vec = input.into_iter().collect(); let filename = get_argument(&input, 0, "filename"); - let text: String = parse_usage(&parse_help_section("usage", &read_help(&filename))); + let text: String = parse_usage(&read_help(&filename)); TokenTree::Literal(Literal::string(&text)).into() } @@ -167,17 +169,17 @@ fn parse_help_section(section: &str, content: &str) -> String { .to_string() } -/// Parses a markdown code block into a usage string +/// Parses the first markdown code block into a usage string /// /// The code fences are removed and the name of the util is replaced /// with `{}` so that it can be replaced with the appropriate name /// at runtime. fn parse_usage(content: &str) -> String { content - .strip_suffix("```") - .unwrap() .lines() - .skip(1) // Skip the "```" of markdown syntax + .skip_while(|l| !l.starts_with(MARKDOWN_CODE_FENCES)) + .skip(1) + .take_while(|l| !l.starts_with(MARKDOWN_CODE_FENCES)) .map(|l| { // Replace the util name (assumed to be the first word) with "{}" // to be replaced with the runtime value later. @@ -187,7 +189,10 @@ fn parse_usage(content: &str) -> String { "{}\n".to_string() } }) - .collect() + .collect::>() + .join("") + .trim() + .to_string() } #[cfg(test)] @@ -237,7 +242,6 @@ mod tests { fn usage_parsing() { let input = "\ # ls\n\ - ## Usage\n\ ```\n\ ls -l\n\ ```\n\ @@ -248,17 +252,21 @@ mod tests { This is the other section\n\ with multiple lines\n"; - assert_eq!(parse_usage(&parse_help_section("usage", input)), "{} -l",); + assert_eq!(parse_usage(input), "{} -l"); + } - assert_eq!( - parse_usage( - "\ - ```\n\ - util [some] [options]\n\ - ```\ - " - ), - "{} [some] [options]" - ); + #[test] + fn multi_line_usage_parsing() { + let input = "\ + # ls\n\ + ```\n\ + ls -a\n\ + ls -b\n\ + ls -c\n\ + ```\n\ + ## some section\n\ + This is some section\n"; + + assert_eq!(parse_usage(input), "{} -a\n{} -b\n{} -c"); } } From 2c027a9312ab1063311294b9894cc54c9f4afd18 Mon Sep 17 00:00:00 2001 From: Daniel Hofstetter Date: Fri, 17 Feb 2023 15:39:26 +0100 Subject: [PATCH 07/39] uucore_procs: add help_about macro --- src/uucore_procs/src/lib.rs | 64 ++++++++++++++++++++++++++++++++++++- 1 file changed, 63 insertions(+), 1 deletion(-) diff --git a/src/uucore_procs/src/lib.rs b/src/uucore_procs/src/lib.rs index cb7e4c355..c1ef8bc75 100644 --- a/src/uucore_procs/src/lib.rs +++ b/src/uucore_procs/src/lib.rs @@ -53,6 +53,18 @@ fn render_markdown(s: &str) -> String { s.replace('`', "") } +/// Get the about text from the help file. +/// +/// The about text is assumed to be the text between the first markdown +/// code block and the next header, if any. It may span multiple lines. +#[proc_macro] +pub fn help_about(input: TokenStream) -> TokenStream { + let input: Vec = input.into_iter().collect(); + let filename = get_argument(&input, 0, "filename"); + let text: String = parse_about(&read_help(&filename)); + TokenTree::Literal(Literal::string(&text)).into() +} + /// Get the usage from the help file. /// /// The usage is assumed to be surrounded by markdown code fences. It may span @@ -195,9 +207,25 @@ fn parse_usage(content: &str) -> String { .to_string() } +/// Parses the text between the first markdown code block and the next header, if any, +/// into an about string. +fn parse_about(content: &str) -> String { + content + .lines() + .skip_while(|l| !l.starts_with(MARKDOWN_CODE_FENCES)) + .skip(1) + .skip_while(|l| !l.starts_with(MARKDOWN_CODE_FENCES)) + .skip(1) + .take_while(|l| !l.starts_with('#')) + .collect::>() + .join("\n") + .trim() + .to_string() +} + #[cfg(test)] mod tests { - use super::{parse_help_section, parse_usage}; + use super::{parse_about, parse_help_section, parse_usage}; #[test] fn section_parsing() { @@ -269,4 +297,38 @@ mod tests { assert_eq!(parse_usage(input), "{} -a\n{} -b\n{} -c"); } + + #[test] + fn about_parsing() { + let input = "\ + # ls\n\ + ```\n\ + ls -l\n\ + ```\n\ + \n\ + This is the about section\n\ + \n\ + ## some section\n\ + This is some section\n"; + + assert_eq!(parse_about(input), "This is the about section"); + } + + #[test] + fn multi_line_about_parsing() { + let input = "\ + # ls\n\ + ```\n\ + ls -l\n\ + ```\n\ + \n\ + about a\n\ + \n\ + about b\n\ + \n\ + ## some section\n\ + This is some section\n"; + + assert_eq!(parse_about(input), "about a\n\nabout b"); + } } From dcc7c4ed7b120a95acc4a28c6db08c2fb4ffcd93 Mon Sep 17 00:00:00 2001 From: Daniel Hofstetter Date: Fri, 17 Feb 2023 16:40:22 +0100 Subject: [PATCH 08/39] Use help_about! & adapt help files for its usage --- src/uu/base32/base32.md | 3 --- src/uu/base32/src/base32.rs | 4 ++-- src/uu/base64/base64.md | 3 --- src/uu/base64/src/base64.rs | 4 ++-- src/uu/cat/cat.md | 3 --- src/uu/cat/src/cat.rs | 4 ++-- src/uu/cp/cp.md | 3 --- src/uu/cp/src/cp.rs | 8 ++++---- src/uu/dd/dd.md | 6 +++++- src/uu/dd/src/dd.rs | 7 ++++--- src/uu/expr/expr.md | 9 +++------ src/uu/expr/src/expr.rs | 4 ++-- src/uu/numfmt/numfmt.md | 3 --- src/uu/numfmt/src/numfmt.rs | 5 ++--- src/uu/stat/src/stat.rs | 6 ++++-- src/uu/stat/stat.md | 7 ++----- 16 files changed, 32 insertions(+), 47 deletions(-) diff --git a/src/uu/base32/base32.md b/src/uu/base32/base32.md index 0889292ce..e55fb25f6 100644 --- a/src/uu/base32/base32.md +++ b/src/uu/base32/base32.md @@ -1,12 +1,9 @@ # base32 -## Usage ``` base32 [OPTION]... [FILE] ``` -## About - encode/decode data and print to standard output With no FILE, or when FILE is -, read standard input. diff --git a/src/uu/base32/src/base32.rs b/src/uu/base32/src/base32.rs index 01932e675..740e2d70b 100644 --- a/src/uu/base32/src/base32.rs +++ b/src/uu/base32/src/base32.rs @@ -8,11 +8,11 @@ use std::io::{stdin, Read}; use clap::Command; -use uucore::{encoding::Format, error::UResult, help_section, help_usage}; +use uucore::{encoding::Format, error::UResult, help_about, help_usage}; pub mod base_common; -const ABOUT: &str = help_section!("about", "base32.md"); +const ABOUT: &str = help_about!("base32.md"); const USAGE: &str = help_usage!("base32.md"); #[uucore::main] diff --git a/src/uu/base64/base64.md b/src/uu/base64/base64.md index 89b9cb618..6ff657457 100644 --- a/src/uu/base64/base64.md +++ b/src/uu/base64/base64.md @@ -1,12 +1,9 @@ # base64 -## Usage ``` base64 [OPTION]... [FILE] ``` -## About - encode/decode data and print to standard output With no FILE, or when FILE is -, read standard input. diff --git a/src/uu/base64/src/base64.rs b/src/uu/base64/src/base64.rs index 932a1f0c7..e502482e3 100644 --- a/src/uu/base64/src/base64.rs +++ b/src/uu/base64/src/base64.rs @@ -9,11 +9,11 @@ use uu_base32::base_common; pub use uu_base32::uu_app; -use uucore::{encoding::Format, error::UResult, help_section, help_usage}; +use uucore::{encoding::Format, error::UResult, help_about, help_usage}; use std::io::{stdin, Read}; -const ABOUT: &str = help_section!("about", "base64.md"); +const ABOUT: &str = help_about!("base64.md"); const USAGE: &str = help_usage!("base64.md"); #[uucore::main] diff --git a/src/uu/cat/cat.md b/src/uu/cat/cat.md index 0188be123..efcd317eb 100644 --- a/src/uu/cat/cat.md +++ b/src/uu/cat/cat.md @@ -1,11 +1,8 @@ # cat -## Usage ``` cat [OPTION]... [FILE]... ``` -## About - Concatenate FILE(s), or standard input, to standard output With no FILE, or when FILE is -, read standard input. diff --git a/src/uu/cat/src/cat.rs b/src/uu/cat/src/cat.rs index d8cc46035..85a626d5b 100644 --- a/src/uu/cat/src/cat.rs +++ b/src/uu/cat/src/cat.rs @@ -33,10 +33,10 @@ use std::net::Shutdown; use std::os::unix::fs::FileTypeExt; #[cfg(unix)] use std::os::unix::net::UnixStream; -use uucore::{format_usage, help_section, help_usage}; +use uucore::{format_usage, help_about, help_usage}; const USAGE: &str = help_usage!("cat.md"); -const ABOUT: &str = help_section!("about", "cat.md"); +const ABOUT: &str = help_about!("cat.md"); #[derive(Error, Debug)] enum CatError { diff --git a/src/uu/cp/cp.md b/src/uu/cp/cp.md index 3659423ff..5f3cabc18 100644 --- a/src/uu/cp/cp.md +++ b/src/uu/cp/cp.md @@ -1,12 +1,9 @@ # cp -## Usage ``` cp [OPTION]... [-T] SOURCE DEST cp [OPTION]... SOURCE... DIRECTORY cp [OPTION]... -t DIRECTORY SOURCE... ``` -## About - Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY. diff --git a/src/uu/cp/src/cp.rs b/src/uu/cp/src/cp.rs index a41ef836b..f0dc762be 100644 --- a/src/uu/cp/src/cp.rs +++ b/src/uu/cp/src/cp.rs @@ -40,7 +40,7 @@ use uucore::error::{set_exit_code, UClapError, UError, UResult, UUsageError}; use uucore::fs::{ canonicalize, paths_refer_to_same_file, FileInformation, MissingHandling, ResolveMode, }; -use uucore::{crash, format_usage, help_section, help_usage, prompt_yes, show_error, show_warning}; +use uucore::{crash, format_usage, help_about, help_usage, prompt_yes, show_error, show_warning}; use crate::copydir::copy_directory; @@ -228,11 +228,11 @@ pub struct Options { progress_bar: bool, } -const ABOUT: &str = help_section!("about", "cp.md"); -static EXIT_ERR: i32 = 1; - +const ABOUT: &str = help_about!("cp.md"); const USAGE: &str = help_usage!("cp.md"); +static EXIT_ERR: i32 = 1; + // Argument constants mod options { pub const ARCHIVE: &str = "archive"; diff --git a/src/uu/dd/dd.md b/src/uu/dd/dd.md index b5e16a1bc..7f0acd718 100644 --- a/src/uu/dd/dd.md +++ b/src/uu/dd/dd.md @@ -1,7 +1,11 @@ # dd -## About +``` +dd [OPERAND]... +dd OPTION +``` + Copy, and optionally convert, a file system resource ## After Help diff --git a/src/uu/dd/src/dd.rs b/src/uu/dd/src/dd.rs index 813d60ceb..51b656582 100644 --- a/src/uu/dd/src/dd.rs +++ b/src/uu/dd/src/dd.rs @@ -39,11 +39,11 @@ use clap::{crate_version, Arg, Command}; use gcd::Gcd; use uucore::display::Quotable; use uucore::error::{FromIo, UResult}; -use uucore::help_section; -use uucore::show_error; +use uucore::{format_usage, help_about, help_section, help_usage, show_error}; -const ABOUT: &str = help_section!("about", "dd.md"); +const ABOUT: &str = help_about!("dd.md"); const AFTER_HELP: &str = help_section!("after help", "dd.md"); +const USAGE: &str = help_usage!("dd.md"); const BUF_INIT_BYTE: u8 = 0xDD; /// Final settings after parsing @@ -832,6 +832,7 @@ pub fn uu_app() -> Command { Command::new(uucore::util_name()) .version(crate_version!()) .about(ABOUT) + .override_usage(format_usage(USAGE)) .after_help(AFTER_HELP) .infer_long_args(true) .arg(Arg::new(options::OPERANDS).num_args(1..)) diff --git a/src/uu/expr/expr.md b/src/uu/expr/expr.md index 6c881eb35..eaa748076 100644 --- a/src/uu/expr/expr.md +++ b/src/uu/expr/expr.md @@ -1,15 +1,12 @@ # expr -## About - -Print the value of `EXPRESSION` to standard output - -## Usage ``` expr [EXPRESSION] expr [OPTIONS] ``` +Print the value of `EXPRESSION` to standard output + ## After help Print the value of `EXPRESSION` to standard output. A blank line below @@ -58,4 +55,4 @@ Environment variables: - `EXPR_DEBUG_TOKENS=1`: dump expression's tokens - `EXPR_DEBUG_RPN=1`: dump expression represented in reverse polish notation - `EXPR_DEBUG_SYA_STEP=1`: dump each parser step - - `EXPR_DEBUG_AST=1`: dump expression represented abstract syntax tree \ No newline at end of file + - `EXPR_DEBUG_AST=1`: dump expression represented abstract syntax tree diff --git a/src/uu/expr/src/expr.rs b/src/uu/expr/src/expr.rs index a5fab19f2..97cfa32f3 100644 --- a/src/uu/expr/src/expr.rs +++ b/src/uu/expr/src/expr.rs @@ -8,7 +8,7 @@ use clap::{crate_version, Arg, ArgAction, Command}; use uucore::{ error::{UResult, USimpleError}, - format_usage, help_section, help_usage, + format_usage, help_about, help_section, help_usage, }; mod syntax_tree; @@ -23,7 +23,7 @@ mod options { pub fn uu_app() -> Command { Command::new(uucore::util_name()) .version(crate_version!()) - .about(help_section!("about", "expr.md")) + .about(help_about!("expr.md")) .override_usage(format_usage(help_usage!("expr.md"))) .after_help(help_section!("after help", "expr.md")) .infer_long_args(true) diff --git a/src/uu/numfmt/numfmt.md b/src/uu/numfmt/numfmt.md index 3216d6eb7..74af2b016 100644 --- a/src/uu/numfmt/numfmt.md +++ b/src/uu/numfmt/numfmt.md @@ -1,13 +1,10 @@ # numfmt -## Usage ``` numfmt [OPTION]... [NUMBER]... ``` -## About - Convert numbers from/to human-readable strings ## After Help diff --git a/src/uu/numfmt/src/numfmt.rs b/src/uu/numfmt/src/numfmt.rs index 8730c9f8d..f1fd4b115 100644 --- a/src/uu/numfmt/src/numfmt.rs +++ b/src/uu/numfmt/src/numfmt.rs @@ -14,16 +14,15 @@ use std::io::{BufRead, Write}; use units::{IEC_BASES, SI_BASES}; use uucore::display::Quotable; use uucore::error::UResult; -use uucore::format_usage; use uucore::ranges::Range; -use uucore::{help_section, help_usage}; +use uucore::{format_usage, help_about, help_section, help_usage}; pub mod errors; pub mod format; pub mod options; mod units; -const ABOUT: &str = help_section!("about", "numfmt.md"); +const ABOUT: &str = help_about!("numfmt.md"); const AFTER_HELP: &str = help_section!("after help", "numfmt.md"); const USAGE: &str = help_usage!("numfmt.md"); diff --git a/src/uu/stat/src/stat.rs b/src/uu/stat/src/stat.rs index 2d0949223..fbbed8c21 100644 --- a/src/uu/stat/src/stat.rs +++ b/src/uu/stat/src/stat.rs @@ -13,7 +13,9 @@ use uucore::fsext::{ pretty_filetype, pretty_fstype, pretty_time, read_fs_list, statfs, BirthTime, FsMeta, }; use uucore::libc::mode_t; -use uucore::{entries, format_usage, help_section, help_usage, show_error, show_warning}; +use uucore::{ + entries, format_usage, help_about, help_section, help_usage, show_error, show_warning, +}; use clap::{crate_version, Arg, ArgAction, ArgMatches, Command}; use std::borrow::Cow; @@ -24,7 +26,7 @@ use std::os::unix::fs::{FileTypeExt, MetadataExt}; use std::os::unix::prelude::OsStrExt; use std::path::Path; -const ABOUT: &str = help_section!("about", "stat.md"); +const ABOUT: &str = help_about!("stat.md"); const USAGE: &str = help_usage!("stat.md"); const LONG_USAGE: &str = help_section!("long usage", "stat.md"); diff --git a/src/uu/stat/stat.md b/src/uu/stat/stat.md index 4304e4b0c..9228ba9dc 100644 --- a/src/uu/stat/stat.md +++ b/src/uu/stat/stat.md @@ -1,14 +1,11 @@ # stat -## About - -Display file or file system status. - -## Usage ``` stat [OPTION]... FILE... ``` +Display file or file system status. + ## Long Usage The valid format sequences for files (without `--file-system`): From 2b5b0c82c162a19da7b0ba587d2cde8d87dd4823 Mon Sep 17 00:00:00 2001 From: Joining7943 <111500881+Joining7943@users.noreply.github.com> Date: Mon, 30 Jan 2023 08:53:28 +0100 Subject: [PATCH 09/39] tests/util: Bump rlimit version to 0.9.1 to be able to use `prlimit` on android --- Cargo.lock | 4 ++-- Cargo.toml | 2 +- tests/common/util.rs | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 6d210d303..05b2a1e1e 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1833,9 +1833,9 @@ dependencies = [ [[package]] name = "rlimit" -version = "0.8.3" +version = "0.9.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f7278a1ec8bfd4a4e07515c589f5ff7b309a373f987393aef44813d9dcf87aa3" +checksum = "f8a29d87a652dc4d43c586328706bb5cdff211f3f39a530f240b53f7221dab8e" dependencies = [ "libc", ] diff --git a/Cargo.toml b/Cargo.toml index ebd8685ca..9e5e0570a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -482,7 +482,7 @@ rstest = "0.16.0" [target.'cfg(any(target_os = "linux", target_os = "android"))'.dev-dependencies] procfs = { version = "0.14", default-features = false } -rlimit = "0.8.3" +rlimit = "0.9.1" [target.'cfg(unix)'.dev-dependencies] nix = { workspace=true, features=["process", "signal", "user"] } diff --git a/tests/common/util.rs b/tests/common/util.rs index ed4ecf8e9..eee47eca9 100644 --- a/tests/common/util.rs +++ b/tests/common/util.rs @@ -8,7 +8,7 @@ #![allow(dead_code)] use pretty_assertions::assert_eq; -#[cfg(target_os = "linux")] +#[cfg(any(target_os = "linux", target_os = "android"))] use rlimit::prlimit; use rstest::rstest; #[cfg(unix)] @@ -1406,7 +1406,7 @@ impl UCommand { let child = command.spawn().unwrap(); - #[cfg(target_os = "linux")] + #[cfg(any(target_os = "linux", target_os = "android"))] for &(resource, soft_limit, hard_limit) in &self.limits { prlimit( child.id() as i32, From fdf0f96a0195126ea1593414c3918d3ab3db1e95 Mon Sep 17 00:00:00 2001 From: Joining7943 <111500881+Joining7943@users.noreply.github.com> Date: Sun, 22 Jan 2023 17:46:25 +0100 Subject: [PATCH 10/39] tests/util: Restructure UCommand to run in shell per default. Introduce constant TESTS_BINARY. Summary of changes in tests/util: * Introduce global constant TESTS_BINARY holding the path to `coreutils` * Implement running an arbitrary command in a sh or cmd shell per default. * Implement std::fmt::Display for UCommand. * Change usages of UCommand::util_name from &Option to Option * `UCommand::new_from_tmp`: Use OsStr directly instead of TempDir -> String -> OsStr * Collect arguments in `UCommand::args` field * Build environment variables in `UCommand` itself instead of `std::process::Command` * Move building of std::process:Command from fields in UCommand to own method `build` * Remove assertions of UCommand::has_run in arg, args and env. Summary of changes in tests/by-util: * Remove usages of UCommand::raw. Fix tests to use UCommand::to_string. * test_test: Adjust test_invalid_utf8_integer_compare to use `UCommand::args` * test_chmod: run_single_test * test_pwd: symlinked_env * test_cp: Fix the usage of &Option in `test_src_base_dot` Refactor test_src_base_dot to not use UCommand::new but ts.ucmd() instead --- tests/by-util/test_chmod.rs | 7 +- tests/by-util/test_cp.rs | 6 +- tests/by-util/test_pwd.rs | 2 +- tests/by-util/test_test.rs | 16 +-- tests/common/util.rs | 258 +++++++++++++++++++++++------------- 5 files changed, 178 insertions(+), 111 deletions(-) diff --git a/tests/by-util/test_chmod.rs b/tests/by-util/test_chmod.rs index feb756632..072756604 100644 --- a/tests/by-util/test_chmod.rs +++ b/tests/by-util/test_chmod.rs @@ -48,15 +48,12 @@ fn run_single_test(test: &TestCase, at: &AtPath, mut ucmd: UCommand) { let r = ucmd.run(); if !r.succeeded() { println!("{}", r.stderr_str()); - panic!("{:?}: failed", ucmd.raw); + panic!("{}: failed", ucmd); } let perms = at.metadata(TEST_FILE).permissions().mode(); if perms != test.after { - panic!( - "{:?}: expected: {:o} got: {:o}", - ucmd.raw, test.after, perms - ); + panic!("{}: expected: {:o} got: {:o}", ucmd, test.after, perms); } } diff --git a/tests/by-util/test_cp.rs b/tests/by-util/test_cp.rs index e6e8a6ba2..790383ded 100644 --- a/tests/by-util/test_cp.rs +++ b/tests/by-util/test_cp.rs @@ -2524,9 +2524,9 @@ fn test_src_base_dot() { let at = ts.fixtures.clone(); at.mkdir("x"); at.mkdir("y"); - let mut ucmd = UCommand::new(ts.bin_path, &Some(ts.util_name), at.plus("y"), true); - - ucmd.args(&["--verbose", "-r", "../x/.", "."]) + ts.ucmd() + .current_dir(at.plus("y")) + .args(&["--verbose", "-r", "../x/.", "."]) .succeeds() .no_stderr() .no_stdout(); diff --git a/tests/by-util/test_pwd.rs b/tests/by-util/test_pwd.rs index 0ae0cc909..461c597bd 100644 --- a/tests/by-util/test_pwd.rs +++ b/tests/by-util/test_pwd.rs @@ -60,7 +60,7 @@ fn symlinked_env() -> Env { // Note: on Windows this requires admin permissions at.symlink_dir("subdir", "symdir"); let root = PathBuf::from(at.root_dir_resolved()); - ucmd.raw.current_dir(root.join("symdir")); + ucmd.current_dir(root.join("symdir")); #[cfg(not(windows))] ucmd.env("PWD", root.join("symdir")); Env { diff --git a/tests/by-util/test_test.rs b/tests/by-util/test_test.rs index 146809f48..b4fb1b0ce 100644 --- a/tests/by-util/test_test.rs +++ b/tests/by-util/test_test.rs @@ -300,19 +300,15 @@ fn test_invalid_utf8_integer_compare() { let source = [0x66, 0x6f, 0x80, 0x6f]; let arg = OsStr::from_bytes(&source[..]); - let mut cmd = new_ucmd!(); - cmd.arg("123").arg("-ne"); - cmd.raw.arg(arg); - - cmd.run() + new_ucmd!() + .args(&[OsStr::new("123"), OsStr::new("-ne"), arg]) + .run() .code_is(2) .stderr_is("test: invalid integer $'fo\\x80o'\n"); - let mut cmd = new_ucmd!(); - cmd.raw.arg(arg); - cmd.arg("-eq").arg("456"); - - cmd.run() + new_ucmd!() + .args(&[arg, OsStr::new("-eq"), OsStr::new("456")]) + .run() .code_is(2) .stderr_is("test: invalid integer $'fo\\x80o'\n"); } diff --git a/tests/common/util.rs b/tests/common/util.rs index eee47eca9..0f3f0d7d8 100644 --- a/tests/common/util.rs +++ b/tests/common/util.rs @@ -3,7 +3,7 @@ // * For the full copyright and license information, please view the LICENSE // * file that was distributed with this source code. -//spell-checker: ignore (linux) rlimit prlimit coreutil ggroups uchild uncaptured scmd +//spell-checker: ignore (linux) rlimit prlimit coreutil ggroups uchild uncaptured scmd SHLVL #![allow(dead_code)] @@ -15,7 +15,7 @@ use rstest::rstest; use std::borrow::Cow; #[cfg(not(windows))] use std::ffi::CString; -use std::ffi::OsStr; +use std::ffi::{OsStr, OsString}; use std::fs::{self, hard_link, remove_file, File, OpenOptions}; use std::io::{self, BufWriter, Read, Result, Write}; #[cfg(unix)] @@ -34,7 +34,6 @@ use std::thread::{sleep, JoinHandle}; use std::time::{Duration, Instant}; use std::{env, hint, thread}; use tempfile::{Builder, TempDir}; -use uucore::Args; static TESTS_DIR: &str = "tests"; static FIXTURES_DIR: &str = "fixtures"; @@ -46,6 +45,8 @@ static MULTIPLE_STDIN_MEANINGLESS: &str = "Ucommand is designed around a typical static NO_STDIN_MEANINGLESS: &str = "Setting this flag has no effect if there is no stdin"; +pub const TESTS_BINARY: &str = env!("CARGO_BIN_EXE_coreutils"); + /// Test if the program is running under CI pub fn is_ci() -> bool { std::env::var("CI") @@ -1096,7 +1097,7 @@ impl TestScenario { pub fn new(util_name: &str) -> Self { let tmpd = Rc::new(TempDir::new().unwrap()); let ts = Self { - bin_path: PathBuf::from(env!("CARGO_BIN_EXE_coreutils")), + bin_path: PathBuf::from(TESTS_BINARY), util_name: String::from(util_name), fixtures: AtPath::new(tmpd.as_ref().path()), tmpd, @@ -1127,13 +1128,13 @@ impl TestScenario { util_name: T, env_clear: bool, ) -> UCommand { - UCommand::new_from_tmp(bin, &Some(util_name), self.tmpd.clone(), env_clear) + UCommand::new_from_tmp(bin, Some(util_name), self.tmpd.clone(), env_clear) } /// Returns builder for invoking any system command. Paths given are treated /// relative to the environment's unique temporary test directory. pub fn cmd>(&self, bin: S) -> UCommand { - UCommand::new_from_tmp::(bin, &None, self.tmpd.clone(), true) + UCommand::new_from_tmp::(bin, None, self.tmpd.clone(), true) } /// Returns builder for invoking any uutils command. Paths given are treated @@ -1153,7 +1154,7 @@ impl TestScenario { /// Differs from the builder returned by `cmd` in that `cmd_keepenv` does not call /// `Command::env_clear` (Clears the entire environment map for the child process.) pub fn cmd_keepenv>(&self, bin: S) -> UCommand { - UCommand::new_from_tmp::(bin, &None, self.tmpd.clone(), false) + UCommand::new_from_tmp::(bin, None, self.tmpd.clone(), false) } } @@ -1165,16 +1166,19 @@ impl TestScenario { /// 3. it provides convenience construction arguments to set the Command working directory and/or clear its environment. #[derive(Debug)] pub struct UCommand { - pub raw: Command, - comm_string: String, - bin_path: String, - util_name: Option, + args: Vec, + env_vars: Vec<(OsString, OsString)>, + current_dir: Option, + env_clear: bool, + bin_path: Option, + util_name: Option, has_run: bool, ignore_stdin_write_error: bool, stdin: Option, stdout: Option, stderr: Option, bytes_into_stdin: Option>, + // TODO: Why android? #[cfg(any(target_os = "linux", target_os = "android"))] limits: Vec<(rlimit::Resource, u64, u64)>, stderr_to_stdout: bool, @@ -1183,74 +1187,51 @@ pub struct UCommand { } impl UCommand { - pub fn new, S: AsRef, U: AsRef>( - bin_path: T, - util_name: &Option, - curdir: U, - env_clear: bool, - ) -> Self { - let bin_path = bin_path.as_ref(); - let util_name = util_name.as_ref().map(std::convert::AsRef::as_ref); - - let mut ucmd = Self { + pub fn new() -> Self { + Self { tmpd: None, has_run: false, - raw: { - let mut cmd = Command::new(bin_path); - cmd.current_dir(curdir.as_ref()); - if env_clear { - cmd.env_clear(); - if cfg!(windows) { - // spell-checker:ignore (dll) rsaenh - // %SYSTEMROOT% is required on Windows to initialize crypto provider - // ... and crypto provider is required for std::rand - // From `procmon`: RegQueryValue HKLM\SOFTWARE\Microsoft\Cryptography\Defaults\Provider\Microsoft Strong Cryptographic Provider\Image Path - // SUCCESS Type: REG_SZ, Length: 66, Data: %SystemRoot%\system32\rsaenh.dll" - if let Some(systemroot) = env::var_os("SYSTEMROOT") { - cmd.env("SYSTEMROOT", systemroot); - } - } else { - // if someone is setting LD_PRELOAD, there's probably a good reason for it - if let Some(ld_preload) = env::var_os("LD_PRELOAD") { - cmd.env("LD_PRELOAD", ld_preload); - } - } - } - cmd - }, - comm_string: String::from(bin_path.to_str().unwrap()), - bin_path: bin_path.to_str().unwrap().to_string(), - util_name: util_name.map(|un| un.to_str().unwrap().to_string()), + bin_path: None, + current_dir: None, + args: vec![], + env_clear: true, + env_vars: vec![], + util_name: None, ignore_stdin_write_error: false, bytes_into_stdin: None, stdin: None, stdout: None, stderr: None, + // TODO: Why android? #[cfg(any(target_os = "linux", target_os = "android"))] limits: vec![], stderr_to_stdout: false, timeout: Some(Duration::from_secs(30)), - }; - - if let Some(un) = util_name { - ucmd.arg(un); } - - ucmd } pub fn new_from_tmp, S: AsRef>( bin_path: T, - util_name: &Option, + util_name: Option, tmpd: Rc, env_clear: bool, ) -> Self { - let tmpd_path_buf = String::from(tmpd.as_ref().path().to_str().unwrap()); - let mut ucmd: Self = Self::new(bin_path, util_name, tmpd_path_buf, env_clear); + let mut ucmd: Self = Self::new(); + ucmd.bin_path = Some(PathBuf::from(bin_path.as_ref())); + ucmd.util_name = util_name.map(|s| s.as_ref().to_os_string()); ucmd.tmpd = Some(tmpd); + ucmd.env_clear = env_clear; ucmd } + pub fn current_dir(&mut self, current_dir: T) -> &mut Self + where + T: AsRef, + { + self.current_dir = Some(current_dir.as_ref().into()); + self + } + pub fn set_stdin>(&mut self, stdin: T) -> &mut Self { self.stdin = Some(stdin.into()); self @@ -1274,29 +1255,14 @@ impl UCommand { /// Add a parameter to the invocation. Path arguments are treated relative /// to the test environment directory. pub fn arg>(&mut self, arg: S) -> &mut Self { - assert!(!self.has_run, "{}", ALREADY_RUN); - self.comm_string.push(' '); - self.comm_string - .push_str(arg.as_ref().to_str().unwrap_or_default()); - self.raw.arg(arg.as_ref()); + self.args.push(arg.as_ref().into()); self } /// Add multiple parameters to the invocation. Path arguments are treated relative /// to the test environment directory. pub fn args>(&mut self, args: &[S]) -> &mut Self { - assert!(!self.has_run, "{}", MULTIPLE_STDIN_MEANINGLESS); - let strings = args - .iter() - .map(|s| s.as_ref().to_os_string()) - .collect_ignore(); - - for s in strings { - self.comm_string.push(' '); - self.comm_string.push_str(&s); - } - - self.raw.args(args.as_ref()); + self.args.extend(args.iter().map(|s| s.as_ref().into())); self } @@ -1331,11 +1297,12 @@ impl UCommand { K: AsRef, V: AsRef, { - assert!(!self.has_run, "{}", ALREADY_RUN); - self.raw.env(key, val); + self.env_vars + .push((key.as_ref().into(), val.as_ref().into())); self } + // TODO: Why android? #[cfg(any(target_os = "linux", target_os = "android"))] pub fn with_limit( &mut self, @@ -1359,26 +1326,85 @@ impl UCommand { self } - /// Spawns the command, feeds the stdin if any, and returns the - /// child process immediately. - pub fn run_no_wait(&mut self) -> UChild { - assert!(!self.has_run, "{}", ALREADY_RUN); - self.has_run = true; - log_info("run", &self.comm_string); + // TODO: make public? + fn build(&mut self) -> (Command, Option, Option) { + if self.bin_path.is_some() { + if let Some(util_name) = &self.util_name { + self.args.insert(0, OsString::from(util_name)); + } + } else if let Some(util_name) = &self.util_name { + self.bin_path = Some(PathBuf::from(TESTS_BINARY)); + self.args.insert(0, OsString::from(util_name)); + } else if cfg!(unix) { + let bin_path = if cfg!(target_os = "android") { + PathBuf::from("/system/bin/sh") + } else { + PathBuf::from("/bin/sh") + }; + self.bin_path = Some(bin_path); + let c_arg = OsString::from("-c"); + if !self.args.contains(&c_arg) { + self.args.insert(0, c_arg); + } + } else { + self.bin_path = Some(PathBuf::from("cmd")); + let c_arg = OsString::from("/C"); + let k_arg = OsString::from("/K"); + if !self + .args + .iter() + .any(|s| s.eq_ignore_ascii_case(&c_arg) || s.eq_ignore_ascii_case(&k_arg)) + { + self.args.insert(0, c_arg); + } + }; + + let mut command = Command::new(self.bin_path.as_ref().unwrap()); + command.args(&self.args); + + if self.tmpd.is_none() { + self.tmpd = Some(Rc::new(tempfile::tempdir().unwrap())); + } + + if let Some(current_dir) = &self.current_dir { + command.current_dir(current_dir); + } else { + command.current_dir(self.tmpd.as_ref().unwrap().path()); + } + + if self.env_clear { + command.env_clear(); + if cfg!(windows) { + // spell-checker:ignore (dll) rsaenh + // %SYSTEMROOT% is required on Windows to initialize crypto provider + // ... and crypto provider is required for std::rand + // From `procmon`: RegQueryValue HKLM\SOFTWARE\Microsoft\Cryptography\Defaults\Provider\Microsoft Strong Cryptographic Provider\Image Path + // SUCCESS Type: REG_SZ, Length: 66, Data: %SystemRoot%\system32\rsaenh.dll" + if let Some(systemroot) = env::var_os("SYSTEMROOT") { + command.env("SYSTEMROOT", systemroot); + } + } else { + // if someone is setting LD_PRELOAD, there's probably a good reason for it + if let Some(ld_preload) = env::var_os("LD_PRELOAD") { + command.env("LD_PRELOAD", ld_preload); + } + } + } + + for (key, value) in &self.env_vars { + command.env(key, value); + } let mut captured_stdout = None; let mut captured_stderr = None; - let command = if self.stderr_to_stdout { + if self.stderr_to_stdout { let mut output = CapturedOutput::default(); - let command = self - .raw + command .stdin(self.stdin.take().unwrap_or_else(Stdio::null)) .stdout(Stdio::from(output.try_clone().unwrap())) .stderr(Stdio::from(output.try_clone().unwrap())); captured_stdout = Some(output); - - command } else { let stdout = if self.stdout.is_some() { self.stdout.take().unwrap() @@ -1398,12 +1424,25 @@ impl UCommand { stdio }; - self.raw + command .stdin(self.stdin.take().unwrap_or_else(Stdio::null)) .stdout(stdout) - .stderr(stderr) + .stderr(stderr); }; + (command, captured_stdout, captured_stderr) + } + + /// Spawns the command, feeds the stdin if any, and returns the + /// child process immediately. + pub fn run_no_wait(&mut self) -> UChild { + // TODO: remove? + assert!(!self.has_run, "{}", ALREADY_RUN); + self.has_run = true; + + let (mut command, captured_stdout, captured_stderr) = self.build(); + log_info("run", self.to_string()); + let child = command.spawn().unwrap(); #[cfg(any(target_os = "linux", target_os = "android"))] @@ -1465,6 +1504,17 @@ impl UCommand { } } +impl std::fmt::Display for UCommand { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let mut comm_string: Vec = vec![self + .bin_path + .as_ref() + .map_or("".to_string(), |p| p.display().to_string())]; + comm_string.extend(self.args.iter().map(|s| s.to_string_lossy().to_string())); + f.write_str(&comm_string.join(" ")) + } +} + /// Stored the captured output in a temporary file. The file is deleted as soon as /// [`CapturedOutput`] is dropped. #[derive(Debug)] @@ -1704,8 +1754,11 @@ impl UChild { ) -> Self { Self { raw: child, - bin_path: ucommand.bin_path.clone(), - util_name: ucommand.util_name.clone(), + bin_path: ucommand.bin_path.as_ref().unwrap().display().to_string(), + util_name: ucommand + .util_name + .clone() + .map(|s| s.to_string_lossy().to_string()), captured_stdout, captured_stderr, ignore_stdin_write_error: ucommand.ignore_stdin_write_error, @@ -2443,7 +2496,7 @@ mod tests { pub fn run_cmd>(cmd: T) -> CmdResult { let mut ucmd = UCommand::new_from_tmp::<&str, String>( "sh", - &None, + None, Rc::new(tempfile::tempdir().unwrap()), true, ); @@ -2456,7 +2509,7 @@ mod tests { pub fn run_cmd>(cmd: T) -> CmdResult { let mut ucmd = UCommand::new_from_tmp::<&str, String>( "cmd", - &None, + None, Rc::new(tempfile::tempdir().unwrap()), true, ); @@ -3200,4 +3253,25 @@ mod tests { let ts = TestScenario::new("sleep"); ts.ucmd().timeout(Duration::from_secs(60)).arg("1.0").run(); } + + #[cfg(feature = "echo")] + #[test] + fn test_ucommand_when_default() { + let shell_cmd = format!("{} echo -n hello", TESTS_BINARY); + + let mut command = UCommand::new(); + command.arg(&shell_cmd).succeeds().stdout_is("hello"); + + #[cfg(target_os = "android")] + let (expected_bin, expected_arg) = (PathBuf::from("/system/bin/sh"), OsString::from("-c")); + #[cfg(all(unix, not(target_os = "android")))] + let (expected_bin, expected_arg) = (PathBuf::from("/bin/sh"), OsString::from("-c")); + #[cfg(windows)] + let (expected_bin, expected_arg) = (PathBuf::from("cmd"), OsString::from("/C")); + + std::assert_eq!(&expected_bin, command.bin_path.as_ref().unwrap()); + assert!(command.util_name.is_none()); + std::assert_eq!(command.args, &[expected_arg, OsString::from(&shell_cmd)]); + assert!(command.tmpd.is_some()); + } } From b763143db0d5ff2741ed41710d4dad0859267309 Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru Date: Fri, 17 Feb 2023 17:55:33 +0100 Subject: [PATCH 11/39] End the current execution if there is a new changeset in the PR --- .github/workflows/CICD.yml | 5 +++++ .github/workflows/GnuTests.yml | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/.github/workflows/CICD.yml b/.github/workflows/CICD.yml index b1b8dca54..cf12ee2d7 100644 --- a/.github/workflows/CICD.yml +++ b/.github/workflows/CICD.yml @@ -20,6 +20,11 @@ on: [push, pull_request] permissions: contents: read # to fetch code (actions/checkout) +# End the current execution if there is a new changeset in the PR. +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} + jobs: cargo-deny: name: Style/cargo-deny diff --git a/.github/workflows/GnuTests.yml b/.github/workflows/GnuTests.yml index a462b946a..61da457ed 100644 --- a/.github/workflows/GnuTests.yml +++ b/.github/workflows/GnuTests.yml @@ -14,6 +14,11 @@ on: [push, pull_request] permissions: contents: read +# End the current execution if there is a new changeset in the PR. +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} + jobs: gnu: permissions: From 2f64dc9d0353b4899e73cb0ad76f76167d5612b3 Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru Date: Sun, 22 Jan 2023 22:05:53 +0100 Subject: [PATCH 12/39] GNU: Ignore some intermittent We have a list, no need to show them over and over. They are adding noise: https://github.com/orgs/uutils/projects/2 --- .github/workflows/GnuTests.yml | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/.github/workflows/GnuTests.yml b/.github/workflows/GnuTests.yml index a462b946a..342c24af6 100644 --- a/.github/workflows/GnuTests.yml +++ b/.github/workflows/GnuTests.yml @@ -196,6 +196,9 @@ jobs: REF_LOG_FILE='${{ steps.vars.outputs.path_reference }}/test-logs/test-suite.log' REF_SUMMARY_FILE='${{ steps.vars.outputs.path_reference }}/test-summary/gnu-result.json' REPO_DEFAULT_BRANCH='${{ steps.vars.outputs.repo_default_branch }}' + # https://github.com/uutils/coreutils/issues/4294 + # https://github.com/uutils/coreutils/issues/4295 + IGNORE_INTERMITTENT='tests/tail-2/inotify-dir-recreate tests/misc/timeout tests/rm/rm1' mkdir -p ${{ steps.vars.outputs.path_reference }} @@ -227,10 +230,18 @@ jobs: do if ! grep -Fxq ${LINE}<<<"${REF_FAILING}" then - MSG="GNU test failed: ${LINE}. ${LINE} is passing on '${{ steps.vars.outputs.repo_default_branch }}'. Maybe you have to rebase?" - echo "::error ::$MSG" - echo $MSG >> ${COMMENT_LOG} - have_new_failures="true" + if ! grep ${LINE} ${IGNORE_INTERMITTENT} + then + MSG="GNU test failed: ${LINE}. ${LINE} is passing on '${{ steps.vars.outputs.repo_default_branch }}'. Maybe you have to rebase?" + echo "::error ::$MSG" + echo $MSG >> ${COMMENT_LOG} + have_new_failures="true" + else + MSG="Skip an intermittent issue ${LINE}" + echo "::warning ::$MSG" + echo $MSG >> ${COMMENT_LOG} + echo "" + fi fi done for LINE in ${REF_ERROR} From cf72c990f25c63ccf5525aeb0a39e88d63ebcc35 Mon Sep 17 00:00:00 2001 From: Jeffrey Finkelstein Date: Sat, 12 Nov 2022 15:44:32 -0500 Subject: [PATCH 13/39] dd: create Source enum and simpler Input struct This mirrors a recent commit that introduced the `Dest` enum and a simplified `Output` struct. These changes allow us to add new types of inputs and output more easily. --- src/uu/dd/src/dd.rs | 155 ++++++++++++++++++++++++-------------------- 1 file changed, 86 insertions(+), 69 deletions(-) diff --git a/src/uu/dd/src/dd.rs b/src/uu/dd/src/dd.rs index 813d60ceb..cd6e59157 100644 --- a/src/uu/dd/src/dd.rs +++ b/src/uu/dd/src/dd.rs @@ -27,7 +27,7 @@ use std::cmp; use std::env; use std::ffi::OsString; use std::fs::{File, OpenOptions}; -use std::io::{self, Read, Seek, SeekFrom, Stdout, Write}; +use std::io::{self, Read, Seek, SeekFrom, Stdin, Stdout, Write}; #[cfg(any(target_os = "linux", target_os = "android"))] use std::os::unix::fs::OpenOptionsExt; use std::path::Path; @@ -90,30 +90,84 @@ impl Num { } } -struct Input<'a, R: Read> { - src: R, +/// Data sources. +enum Source { + /// Input from stdin. + Stdin(Stdin), + + /// Input from a file. + File(File), +} + +impl Source { + fn skip(&mut self, n: u64) -> io::Result { + match self { + Self::Stdin(stdin) => match io::copy(&mut stdin.take(n), &mut io::sink()) { + Ok(m) if m < n => { + show_error!("'standard input': cannot skip to specified offset"); + Ok(m) + } + Ok(m) => Ok(m), + Err(e) => Err(e), + }, + Self::File(f) => f.seek(io::SeekFrom::Start(n)), + } + } +} + +impl Read for Source { + fn read(&mut self, buf: &mut [u8]) -> io::Result { + match self { + Self::Stdin(stdin) => stdin.read(buf), + Self::File(f) => f.read(buf), + } + } +} + +/// The source of the data, configured with the given settings. +/// +/// Use the [`Input::new_stdin`] or [`Input::new_file`] functions to +/// construct a new instance of this struct. Then pass the instance to +/// the [`Output::dd_out`] function to execute the main copy operation +/// for `dd`. +struct Input<'a> { + /// The source from which bytes will be read. + src: Source, + + /// Configuration settings for how to read the data. settings: &'a Settings, } -impl<'a> Input<'a, io::Stdin> { - fn new(settings: &'a Settings) -> UResult { - let mut input = Self { - src: io::stdin(), - settings, +impl<'a> Input<'a> { + /// Instantiate this struct with stdin as a source. + fn new_stdin(settings: &'a Settings) -> UResult { + let mut src = Source::Stdin(io::stdin()); + if settings.skip > 0 { + src.skip(settings.skip)?; + } + Ok(Self { src, settings }) + } + + /// Instantiate this struct with the named file as a source. + fn new_file(filename: &Path, settings: &'a Settings) -> UResult { + let src = { + let mut opts = OpenOptions::new(); + opts.read(true); + + #[cfg(any(target_os = "linux", target_os = "android"))] + if let Some(libc_flags) = make_linux_iflags(&settings.iflags) { + opts.custom_flags(libc_flags); + } + + opts.open(filename) + .map_err_context(|| format!("failed to open {}", filename.quote()))? }; + let mut src = Source::File(src); if settings.skip > 0 { - if let Err(e) = input.read_skip(settings.skip) { - if let io::ErrorKind::UnexpectedEof = e.kind() { - show_error!("'standard input': cannot skip to specified offset"); - } else { - return io::Result::Err(e) - .map_err_context(|| "I/O error while skipping".to_string()); - } - } + src.skip(settings.skip)?; } - - Ok(input) + Ok(Self { src, settings }) } } @@ -153,31 +207,7 @@ fn make_linux_iflags(iflags: &IFlags) -> Option { } } -impl<'a> Input<'a, File> { - fn new(filename: &Path, settings: &'a Settings) -> UResult { - let mut src = { - let mut opts = OpenOptions::new(); - opts.read(true); - - #[cfg(any(target_os = "linux", target_os = "android"))] - if let Some(libc_flags) = make_linux_iflags(&settings.iflags) { - opts.custom_flags(libc_flags); - } - - opts.open(filename) - .map_err_context(|| format!("failed to open {}", filename.quote()))? - }; - - if settings.skip > 0 { - src.seek(io::SeekFrom::Start(settings.skip)) - .map_err_context(|| "failed to seek in input file".to_string())?; - } - - Ok(Self { src, settings }) - } -} - -impl<'a, R: Read> Read for Input<'a, R> { +impl<'a> Read for Input<'a> { fn read(&mut self, buf: &mut [u8]) -> io::Result { let mut base_idx = 0; let target_len = buf.len(); @@ -200,7 +230,7 @@ impl<'a, R: Read> Read for Input<'a, R> { } } -impl<'a, R: Read> Input<'a, R> { +impl<'a> Input<'a> { /// Fills a given buffer. /// Reads in increments of 'self.ibs'. /// The start of each ibs-sized read follows the previous one. @@ -266,20 +296,6 @@ impl<'a, R: Read> Input<'a, R> { records_truncated: 0, }) } - - /// Skips amount_to_read bytes from the Input by copying into a sink - fn read_skip(&mut self, amount_to_read: u64) -> std::io::Result<()> { - let copy_result = io::copy(&mut self.src.by_ref().take(amount_to_read), &mut io::sink()); - if let Ok(n) = copy_result { - if n != amount_to_read { - io::Result::Err(io::Error::new(io::ErrorKind::UnexpectedEof, "")) - } else { - Ok(()) - } - } else { - io::Result::Err(copy_result.unwrap_err()) - } - } } enum Density { @@ -485,7 +501,7 @@ impl<'a> Output<'a> { /// /// If there is a problem reading from the input or writing to /// this output. - fn dd_out(mut self, mut i: Input) -> std::io::Result<()> { + fn dd_out(mut self, mut i: Input) -> std::io::Result<()> { // The read and write statistics. // // These objects are counters, initialized to zero. After each @@ -645,12 +661,13 @@ fn make_linux_oflags(oflags: &OFlags) -> Option { } } -/// Read helper performs read operations common to all dd reads, and dispatches the buffer to relevant helper functions as dictated by the operations requested by the user. -fn read_helper( - i: &mut Input, - buf: &mut Vec, - bsize: usize, -) -> std::io::Result { +/// Read from an input (that is, a source of bytes) into the given buffer. +/// +/// This function also performs any conversions as specified by +/// `conv=swab` or `conv=block` command-line arguments. This function +/// mutates the `buf` argument in-place. The returned [`ReadStat`] +/// indicates how many blocks were read. +fn read_helper(i: &mut Input, buf: &mut Vec, bsize: usize) -> std::io::Result { // Local Helper Fns ------------------------------------------------- fn perform_swab(buf: &mut [u8]) { for base in (1..buf.len()).step_by(2) { @@ -794,17 +811,17 @@ pub fn uumain(args: impl uucore::Args) -> UResult<()> { match (&settings.infile, &settings.outfile) { (Some(infile), Some(outfile)) => { - let i = Input::::new(Path::new(&infile), &settings)?; + let i = Input::new_file(Path::new(&infile), &settings)?; let o = Output::new_file(Path::new(&outfile), &settings)?; o.dd_out(i).map_err_context(|| "IO error".to_string()) } (None, Some(outfile)) => { - let i = Input::::new(&settings)?; + let i = Input::new_stdin(&settings)?; let o = Output::new_file(Path::new(&outfile), &settings)?; o.dd_out(i).map_err_context(|| "IO error".to_string()) } (Some(infile), None) => { - let i = Input::::new(Path::new(&infile), &settings)?; + let i = Input::new_file(Path::new(&infile), &settings)?; if is_stdout_redirected_to_seekable_file() { let filename = stdout_canonicalized(); let o = Output::new_file(Path::new(&filename), &settings)?; @@ -815,7 +832,7 @@ pub fn uumain(args: impl uucore::Args) -> UResult<()> { } } (None, None) => { - let i = Input::::new(&settings)?; + let i = Input::new_stdin(&settings)?; if is_stdout_redirected_to_seekable_file() { let filename = stdout_canonicalized(); let o = Output::new_file(Path::new(&filename), &settings)?; From 9c3f810f973a1840fbf1ed4d1856a423b52fb166 Mon Sep 17 00:00:00 2001 From: Jeffrey Finkelstein Date: Sun, 13 Nov 2022 08:46:01 -0500 Subject: [PATCH 14/39] dd: add support for seeking in output FIFOs For example, `dd seek=1 of=fifo` will now work. --- src/uu/dd/src/dd.rs | 127 ++++++++++++++++++++++++++++----------- tests/by-util/test_dd.rs | 39 ++++++++++++ 2 files changed, 132 insertions(+), 34 deletions(-) diff --git a/src/uu/dd/src/dd.rs b/src/uu/dd/src/dd.rs index cd6e59157..1a00af8b5 100644 --- a/src/uu/dd/src/dd.rs +++ b/src/uu/dd/src/dd.rs @@ -28,6 +28,8 @@ use std::env; use std::ffi::OsString; use std::fs::{File, OpenOptions}; use std::io::{self, Read, Seek, SeekFrom, Stdin, Stdout, Write}; +#[cfg(unix)] +use std::os::unix::fs::FileTypeExt; #[cfg(any(target_os = "linux", target_os = "android"))] use std::os::unix::fs::OpenOptionsExt; use std::path::Path; @@ -313,6 +315,14 @@ enum Dest { /// The [`Density`] component indicates whether to attempt to /// write a sparse file when all-zero blocks are encountered. File(File, Density), + + /// Output to a named pipe, also known as a FIFO. + #[cfg(unix)] + Fifo(File), + + /// Output to nothing, dropping each byte written to the output. + #[cfg(unix)] + Sink, } impl Dest { @@ -323,6 +333,13 @@ impl Dest { f.flush()?; f.sync_all() } + #[cfg(unix)] + Self::Fifo(f) => { + f.flush()?; + f.sync_all() + } + #[cfg(unix)] + Self::Sink => Ok(()), } } @@ -333,6 +350,13 @@ impl Dest { f.flush()?; f.sync_data() } + #[cfg(unix)] + Self::Fifo(f) => { + f.flush()?; + f.sync_data() + } + #[cfg(unix)] + Self::Sink => Ok(()), } } @@ -340,17 +364,24 @@ impl Dest { match self { Self::Stdout(stdout) => io::copy(&mut io::repeat(0).take(n), stdout), Self::File(f, _) => f.seek(io::SeekFrom::Start(n)), + #[cfg(unix)] + Self::Fifo(f) => { + // Seeking in a named pipe means *reading* from the pipe. + io::copy(&mut f.take(n), &mut io::sink()) + } + #[cfg(unix)] + Self::Sink => Ok(0), } } /// Truncate the underlying file to the current stream position, if possible. fn truncate(&mut self) -> io::Result<()> { match self { - Self::Stdout(_) => Ok(()), Self::File(f, _) => { let pos = f.stream_position()?; f.set_len(pos) } + _ => Ok(()), } } } @@ -373,6 +404,10 @@ impl Write for Dest { } Self::File(f, _) => f.write(buf), Self::Stdout(stdout) => stdout.write(buf), + #[cfg(unix)] + Self::Fifo(f) => f.write(buf), + #[cfg(unix)] + Self::Sink => Ok(buf.len()), } } @@ -380,6 +415,10 @@ impl Write for Dest { match self { Self::Stdout(stdout) => stdout.flush(), Self::File(f, _) => f.flush(), + #[cfg(unix)] + Self::Fifo(f) => f.flush(), + #[cfg(unix)] + Self::Sink => Ok(()), } } } @@ -449,6 +488,35 @@ impl<'a> Output<'a> { Ok(Self { dst, settings }) } + /// Instantiate this struct with the given named pipe as a destination. + #[cfg(unix)] + fn new_fifo(filename: &Path, settings: &'a Settings) -> UResult { + // We simulate seeking in a FIFO by *reading*, so we open the + // file for reading. But then we need to close the file and + // re-open it for writing. + if settings.seek > 0 { + Dest::Fifo(File::open(filename)?).seek(settings.seek)?; + } + // If `count=0`, then we don't bother opening the file for + // writing because that would cause this process to block + // indefinitely. + if let Some(Num::Blocks(0) | Num::Bytes(0)) = settings.count { + let dst = Dest::Sink; + return Ok(Self { dst, settings }); + } + // At this point, we know there is at least one block to write + // to the output, so we open the file for writing. + let mut opts = OpenOptions::new(); + opts.write(true) + .create(!settings.oconv.nocreat) + .create_new(settings.oconv.excl) + .append(settings.oflags.append); + #[cfg(any(target_os = "linux", target_os = "android"))] + opts.custom_flags(make_linux_oflags(&settings.oflags).unwrap_or(0)); + let dst = Dest::Fifo(opts.open(filename)?); + Ok(Self { dst, settings }) + } + /// Write the given bytes one block at a time. /// /// This may write partial blocks (for example, if the underlying @@ -795,6 +863,17 @@ fn is_stdout_redirected_to_seekable_file() -> bool { } } +/// Decide whether the named file is a named pipe, also known as a FIFO. +#[cfg(unix)] +fn is_fifo(filename: &str) -> bool { + if let Ok(metadata) = std::fs::metadata(filename) { + if metadata.file_type().is_fifo() { + return true; + } + } + false +} + #[uucore::main] pub fn uumain(args: impl uucore::Args) -> UResult<()> { let args = args.collect_ignore(); @@ -809,40 +888,20 @@ pub fn uumain(args: impl uucore::Args) -> UResult<()> { .collect::>()[..], )?; - match (&settings.infile, &settings.outfile) { - (Some(infile), Some(outfile)) => { - let i = Input::new_file(Path::new(&infile), &settings)?; - let o = Output::new_file(Path::new(&outfile), &settings)?; - o.dd_out(i).map_err_context(|| "IO error".to_string()) + let i = match settings.infile { + Some(ref infile) => Input::new_file(Path::new(&infile), &settings)?, + None => Input::new_stdin(&settings)?, + }; + let o = match settings.outfile { + #[cfg(unix)] + Some(ref outfile) if is_fifo(outfile) => Output::new_fifo(Path::new(&outfile), &settings)?, + Some(ref outfile) => Output::new_file(Path::new(&outfile), &settings)?, + None if is_stdout_redirected_to_seekable_file() => { + Output::new_file(Path::new(&stdout_canonicalized()), &settings)? } - (None, Some(outfile)) => { - let i = Input::new_stdin(&settings)?; - let o = Output::new_file(Path::new(&outfile), &settings)?; - o.dd_out(i).map_err_context(|| "IO error".to_string()) - } - (Some(infile), None) => { - let i = Input::new_file(Path::new(&infile), &settings)?; - if is_stdout_redirected_to_seekable_file() { - let filename = stdout_canonicalized(); - let o = Output::new_file(Path::new(&filename), &settings)?; - o.dd_out(i).map_err_context(|| "IO error".to_string()) - } else { - let o = Output::new_stdout(&settings)?; - o.dd_out(i).map_err_context(|| "IO error".to_string()) - } - } - (None, None) => { - let i = Input::new_stdin(&settings)?; - if is_stdout_redirected_to_seekable_file() { - let filename = stdout_canonicalized(); - let o = Output::new_file(Path::new(&filename), &settings)?; - o.dd_out(i).map_err_context(|| "IO error".to_string()) - } else { - let o = Output::new_stdout(&settings)?; - o.dd_out(i).map_err_context(|| "IO error".to_string()) - } - } - } + None => Output::new_stdout(&settings)?, + }; + o.dd_out(i).map_err_context(|| "IO error".to_string()) } pub fn uu_app() -> Command { diff --git a/tests/by-util/test_dd.rs b/tests/by-util/test_dd.rs index 19050965c..554ce785d 100644 --- a/tests/by-util/test_dd.rs +++ b/tests/by-util/test_dd.rs @@ -5,6 +5,8 @@ use crate::common::util::*; use std::fs::{File, OpenOptions}; use std::io::{BufReader, Read, Write}; use std::path::PathBuf; +#[cfg(all(not(windows), not(target_os = "macos")))] +use std::process::{Command, Stdio}; #[cfg(not(windows))] use std::thread::sleep; #[cfg(not(windows))] @@ -1442,3 +1444,40 @@ fn test_sparse() { // number of blocks stored on disk may be zero. assert_eq!(at.metadata("infile").len(), at.metadata("outfile").len()); } + +// TODO These FIFO tests should work on macos, but some issue is +// causing our implementation of dd to wait indefinitely when it +// shouldn't. + +/// Test that a seek on an output FIFO results in a read. +#[test] +#[cfg(all(unix, not(target_os = "macos"), not(target_os = "freebsd")))] +fn test_seek_output_fifo() { + let ts = TestScenario::new(util_name!()); + let at = &ts.fixtures; + at.mkfifo("fifo"); + + // TODO When `dd` is a bit more advanced, we could use the uutils + // version of dd here as well. + let child = Command::new("dd") + .current_dir(&at.subdir) + .args([ + "count=1", + "if=/dev/zero", + &format!("of={}", at.plus_as_string("fifo")), + "status=noxfer", + ]) + .stderr(Stdio::piped()) + .spawn() + .expect("failed to execute child process"); + + ts.ucmd() + .args(&["count=0", "seek=1", "of=fifo", "status=noxfer"]) + .succeeds() + .stderr_only("0+0 records in\n0+0 records out\n"); + + let output = child.wait_with_output().unwrap(); + assert!(output.status.success()); + assert!(output.stdout.is_empty()); + assert_eq!(&output.stderr, b"1+0 records in\n1+0 records out\n"); +} From c52647a6324fd7b73fa42b62672838c1db32bf6b Mon Sep 17 00:00:00 2001 From: Jeffrey Finkelstein Date: Sat, 19 Nov 2022 11:36:08 -0500 Subject: [PATCH 15/39] dd: add support for skipping in input FIFO For example, `dd skip=1 if=fifo` will now work. --- src/uu/dd/src/dd.rs | 24 ++++++++++++++++++++++++ tests/by-util/test_dd.rs | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+) diff --git a/src/uu/dd/src/dd.rs b/src/uu/dd/src/dd.rs index 1a00af8b5..fdd7947cf 100644 --- a/src/uu/dd/src/dd.rs +++ b/src/uu/dd/src/dd.rs @@ -99,6 +99,10 @@ enum Source { /// Input from a file. File(File), + + /// Input from a named pipe, also known as a FIFO. + #[cfg(unix)] + Fifo(File), } impl Source { @@ -113,6 +117,8 @@ impl Source { Err(e) => Err(e), }, Self::File(f) => f.seek(io::SeekFrom::Start(n)), + #[cfg(unix)] + Self::Fifo(f) => io::copy(&mut f.take(n), &mut io::sink()), } } } @@ -122,6 +128,8 @@ impl Read for Source { match self { Self::Stdin(stdin) => stdin.read(buf), Self::File(f) => f.read(buf), + #[cfg(unix)] + Self::Fifo(f) => f.read(buf), } } } @@ -171,6 +179,20 @@ impl<'a> Input<'a> { } Ok(Self { src, settings }) } + + /// Instantiate this struct with the named pipe as a source. + #[cfg(unix)] + fn new_fifo(filename: &Path, settings: &'a Settings) -> UResult { + let mut opts = OpenOptions::new(); + opts.read(true); + #[cfg(any(target_os = "linux", target_os = "android"))] + opts.custom_flags(make_linux_iflags(&settings.iflags).unwrap_or(0)); + let mut src = Source::Fifo(opts.open(filename)?); + if settings.skip > 0 { + src.skip(settings.skip)?; + } + Ok(Self { src, settings }) + } } #[cfg(any(target_os = "linux", target_os = "android"))] @@ -889,6 +911,8 @@ pub fn uumain(args: impl uucore::Args) -> UResult<()> { )?; let i = match settings.infile { + #[cfg(unix)] + Some(ref infile) if is_fifo(infile) => Input::new_fifo(Path::new(&infile), &settings)?, Some(ref infile) => Input::new_file(Path::new(&infile), &settings)?, None => Input::new_stdin(&settings)?, }; diff --git a/tests/by-util/test_dd.rs b/tests/by-util/test_dd.rs index 554ce785d..5deeb12f0 100644 --- a/tests/by-util/test_dd.rs +++ b/tests/by-util/test_dd.rs @@ -1481,3 +1481,36 @@ fn test_seek_output_fifo() { assert!(output.stdout.is_empty()); assert_eq!(&output.stderr, b"1+0 records in\n1+0 records out\n"); } + +/// Test that a skip on an input FIFO results in a read. +#[test] +#[cfg(all(unix, not(target_os = "macos"), not(target_os = "freebsd")))] +fn test_skip_input_fifo() { + let ts = TestScenario::new(util_name!()); + let at = &ts.fixtures; + at.mkfifo("fifo"); + + // TODO When `dd` is a bit more advanced, we could use the uutils + // version of dd here as well. + let child = Command::new("dd") + .current_dir(&at.subdir) + .args([ + "count=1", + "if=/dev/zero", + &format!("of={}", at.plus_as_string("fifo")), + "status=noxfer", + ]) + .stderr(Stdio::piped()) + .spawn() + .expect("failed to execute child process"); + + ts.ucmd() + .args(&["count=0", "skip=1", "if=fifo", "status=noxfer"]) + .succeeds() + .stderr_only("0+0 records in\n0+0 records out\n"); + + let output = child.wait_with_output().unwrap(); + assert!(output.status.success()); + assert!(output.stdout.is_empty()); + assert_eq!(&output.stderr, b"1+0 records in\n1+0 records out\n"); +} From 1c230fd7795932dadd89f5cc29bedfda7b157bb8 Mon Sep 17 00:00:00 2001 From: Joining7943 <111500881+Joining7943@users.noreply.github.com> Date: Wed, 25 Jan 2023 03:40:39 +0100 Subject: [PATCH 16/39] tests/util: Refactor UCommand and TestScenario. Summary of changes in UCommand: * Extend UCommand by builder methods and simplify methods in TestScenario * Simplify code structures where possible. Add documentation. * Store bin_path as PathBuf and util_name as String in all structs * Remove UCommand::util and make bin_path, temp_dir private * Rename UCommand::with_limit -> UCommand::limit Summary of changes in TestScenario: * Rename some parameters in TestScenario methods to be more descriptive * Remove ucmd_keepenv, cmd_keepenv from TestScenario. Use UCommand::keep_env instead. --- tests/by-util/test_cat.rs | 2 +- tests/by-util/test_chmod.rs | 2 +- tests/by-util/test_chown.rs | 14 +- tests/by-util/test_cp.rs | 11 +- tests/by-util/test_env.rs | 3 +- tests/by-util/test_mktemp.rs | 6 +- tests/by-util/test_nproc.rs | 51 +++-- tests/by-util/test_printenv.rs | 6 +- tests/by-util/test_sort.rs | 21 +- tests/by-util/test_uptime.rs | 3 +- tests/by-util/test_users.rs | 3 +- tests/common/util.rs | 339 +++++++++++++++++++-------------- 12 files changed, 276 insertions(+), 185 deletions(-) diff --git a/tests/by-util/test_cat.rs b/tests/by-util/test_cat.rs index bef9e76e4..8b6022c93 100644 --- a/tests/by-util/test_cat.rs +++ b/tests/by-util/test_cat.rs @@ -103,7 +103,7 @@ fn test_closes_file_descriptors() { "alpha.txt", "alpha.txt", ]) - .with_limit(Resource::NOFILE, 9, 9) + .limit(Resource::NOFILE, 9, 9) .succeeds(); } diff --git a/tests/by-util/test_chmod.rs b/tests/by-util/test_chmod.rs index 072756604..52b43d32e 100644 --- a/tests/by-util/test_chmod.rs +++ b/tests/by-util/test_chmod.rs @@ -48,7 +48,7 @@ fn run_single_test(test: &TestCase, at: &AtPath, mut ucmd: UCommand) { let r = ucmd.run(); if !r.succeeded() { println!("{}", r.stderr_str()); - panic!("{}: failed", ucmd); + panic!("{ucmd}: failed"); } let perms = at.metadata(TEST_FILE).permissions().mode(); diff --git a/tests/by-util/test_chown.rs b/tests/by-util/test_chown.rs index 5237a7cf7..c0e210435 100644 --- a/tests/by-util/test_chown.rs +++ b/tests/by-util/test_chown.rs @@ -396,7 +396,7 @@ fn test_chown_only_user_id() { let scene = TestScenario::new(util_name!()); let at = &scene.fixtures; - let result = scene.cmd_keepenv("id").arg("-u").run(); + let result = scene.cmd("id").keep_env().arg("-u").run(); if skipping_test_is_okay(&result, "id: cannot find name for group ID") { return; } @@ -430,7 +430,7 @@ fn test_chown_fail_id() { let scene = TestScenario::new(util_name!()); let at = &scene.fixtures; - let result = scene.cmd_keepenv("id").arg("-u").run(); + let result = scene.cmd("id").keep_env().arg("-u").run(); if skipping_test_is_okay(&result, "id: cannot find name for group ID") { return; } @@ -487,7 +487,7 @@ fn test_chown_only_group_id() { let scene = TestScenario::new(util_name!()); let at = &scene.fixtures; - let result = scene.cmd_keepenv("id").arg("-g").run(); + let result = scene.cmd("id").keep_env().arg("-g").run(); if skipping_test_is_okay(&result, "id: cannot find name for group ID") { return; } @@ -551,14 +551,14 @@ fn test_chown_owner_group_id() { let scene = TestScenario::new(util_name!()); let at = &scene.fixtures; - let result = scene.cmd_keepenv("id").arg("-u").run(); + let result = scene.cmd("id").keep_env().arg("-u").run(); if skipping_test_is_okay(&result, "id: cannot find name for group ID") { return; } let user_id = String::from(result.stdout_str().trim()); assert!(!user_id.is_empty()); - let result = scene.cmd_keepenv("id").arg("-g").run(); + let result = scene.cmd("id").keep_env().arg("-g").run(); if skipping_test_is_okay(&result, "id: cannot find name for group ID") { return; } @@ -612,14 +612,14 @@ fn test_chown_owner_group_mix() { let scene = TestScenario::new(util_name!()); let at = &scene.fixtures; - let result = scene.cmd_keepenv("id").arg("-u").run(); + let result = scene.cmd("id").keep_env().arg("-u").run(); if skipping_test_is_okay(&result, "id: cannot find name for group ID") { return; } let user_id = String::from(result.stdout_str().trim()); assert!(!user_id.is_empty()); - let result = scene.cmd_keepenv("id").arg("-gn").run(); + let result = scene.cmd("id").keep_env().arg("-gn").run(); if skipping_test_is_okay(&result, "id: cannot find name for group ID") { return; } diff --git a/tests/by-util/test_cp.rs b/tests/by-util/test_cp.rs index 790383ded..01eb9bd00 100644 --- a/tests/by-util/test_cp.rs +++ b/tests/by-util/test_cp.rs @@ -1545,7 +1545,7 @@ fn test_closes_file_descriptors() { .arg("--reflink=auto") .arg("dir_with_10_files/") .arg("dir_with_10_files_new/") - .with_limit(Resource::NOFILE, limit_fd, limit_fd) + .limit(Resource::NOFILE, limit_fd, limit_fd) .succeeds(); } @@ -1692,7 +1692,8 @@ fn test_cp_reflink_always_override() { .succeeds(); if !scene - .cmd_keepenv("env") + .cmd("env") + .keep_env() .args(&["mkfs.btrfs", "--rootdir", ROOTDIR, DISK]) .run() .succeeded() @@ -1704,7 +1705,8 @@ fn test_cp_reflink_always_override() { scene.fixtures.mkdir(MOUNTPOINT); let mount = scene - .cmd_keepenv("sudo") + .cmd("sudo") + .keep_env() .args(&["-E", "--non-interactive", "mount", DISK, MOUNTPOINT]) .run(); @@ -1730,7 +1732,8 @@ fn test_cp_reflink_always_override() { .succeeds(); scene - .cmd_keepenv("sudo") + .cmd("sudo") + .keep_env() .args(&["-E", "--non-interactive", "umount", MOUNTPOINT]) .succeeds(); } diff --git a/tests/by-util/test_env.rs b/tests/by-util/test_env.rs index ef10512ab..9b386541c 100644 --- a/tests/by-util/test_env.rs +++ b/tests/by-util/test_env.rs @@ -156,7 +156,8 @@ fn test_unset_variable() { // This test depends on the HOME variable being pre-defined by the // default shell let out = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .arg("-u") .arg("HOME") .succeeds() diff --git a/tests/by-util/test_mktemp.rs b/tests/by-util/test_mktemp.rs index d6926c41b..109963edf 100644 --- a/tests/by-util/test_mktemp.rs +++ b/tests/by-util/test_mktemp.rs @@ -425,7 +425,8 @@ fn test_mktemp_tmpdir_one_arg() { let scene = TestScenario::new(util_name!()); let result = scene - .ucmd_keepenv() + .ucmd() + .keep_env() .arg("--tmpdir") .arg("apt-key-gpghome.XXXXXXXXXX") .succeeds(); @@ -438,7 +439,8 @@ fn test_mktemp_directory_tmpdir() { let scene = TestScenario::new(util_name!()); let result = scene - .ucmd_keepenv() + .ucmd() + .keep_env() .arg("--directory") .arg("--tmpdir") .arg("apt-key-gpghome.XXXXXXXXXX") diff --git a/tests/by-util/test_nproc.rs b/tests/by-util/test_nproc.rs index 3260e46e7..abae40697 100644 --- a/tests/by-util/test_nproc.rs +++ b/tests/by-util/test_nproc.rs @@ -20,7 +20,8 @@ fn test_nproc_all_omp() { assert!(nproc > 0); let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .env("OMP_NUM_THREADS", "60") .succeeds(); @@ -28,7 +29,8 @@ fn test_nproc_all_omp() { assert_eq!(nproc_omp, 60); let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .env("OMP_NUM_THREADS", "1") // Has no effect .arg("--all") .succeeds(); @@ -37,7 +39,8 @@ fn test_nproc_all_omp() { // If the parsing fails, returns the number of CPU let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .env("OMP_NUM_THREADS", "incorrectnumber") // returns the number CPU .succeeds(); let nproc_omp: u8 = result.stdout_str().trim().parse().unwrap(); @@ -51,7 +54,8 @@ fn test_nproc_ignore() { if nproc_total > 1 { // Ignore all CPU but one let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .arg("--ignore") .arg((nproc_total - 1).to_string()) .succeeds(); @@ -59,7 +63,8 @@ fn test_nproc_ignore() { assert_eq!(nproc, 1); // Ignore all CPU but one with a string let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .arg("--ignore= 1") .succeeds(); let nproc: u8 = result.stdout_str().trim().parse().unwrap(); @@ -70,7 +75,8 @@ fn test_nproc_ignore() { #[test] fn test_nproc_ignore_all_omp() { let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .env("OMP_NUM_THREADS", "42") .arg("--ignore=40") .succeeds(); @@ -81,7 +87,8 @@ fn test_nproc_ignore_all_omp() { #[test] fn test_nproc_omp_limit() { let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .env("OMP_NUM_THREADS", "42") .env("OMP_THREAD_LIMIT", "0") .succeeds(); @@ -89,7 +96,8 @@ fn test_nproc_omp_limit() { assert_eq!(nproc, 42); let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .env("OMP_NUM_THREADS", "42") .env("OMP_THREAD_LIMIT", "2") .succeeds(); @@ -97,7 +105,8 @@ fn test_nproc_omp_limit() { assert_eq!(nproc, 2); let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .env("OMP_NUM_THREADS", "42") .env("OMP_THREAD_LIMIT", "2bad") .succeeds(); @@ -109,14 +118,16 @@ fn test_nproc_omp_limit() { assert!(nproc_system > 0); let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .env("OMP_THREAD_LIMIT", "1") .succeeds(); let nproc: u8 = result.stdout_str().trim().parse().unwrap(); assert_eq!(nproc, 1); let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .env("OMP_NUM_THREADS", "0") .env("OMP_THREAD_LIMIT", "") .succeeds(); @@ -124,7 +135,8 @@ fn test_nproc_omp_limit() { assert_eq!(nproc, nproc_system); let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .env("OMP_NUM_THREADS", "") .env("OMP_THREAD_LIMIT", "") .succeeds(); @@ -132,7 +144,8 @@ fn test_nproc_omp_limit() { assert_eq!(nproc, nproc_system); let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .env("OMP_NUM_THREADS", "2,2,1") .env("OMP_THREAD_LIMIT", "") .succeeds(); @@ -140,7 +153,8 @@ fn test_nproc_omp_limit() { assert_eq!(2, nproc); let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .env("OMP_NUM_THREADS", "2,ignored") .env("OMP_THREAD_LIMIT", "") .succeeds(); @@ -148,7 +162,8 @@ fn test_nproc_omp_limit() { assert_eq!(2, nproc); let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .env("OMP_NUM_THREADS", "2,2,1") .env("OMP_THREAD_LIMIT", "0") .succeeds(); @@ -156,7 +171,8 @@ fn test_nproc_omp_limit() { assert_eq!(2, nproc); let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .env("OMP_NUM_THREADS", "2,2,1") .env("OMP_THREAD_LIMIT", "1bad") .succeeds(); @@ -164,7 +180,8 @@ fn test_nproc_omp_limit() { assert_eq!(2, nproc); let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .env("OMP_NUM_THREADS", "29,2,1") .env("OMP_THREAD_LIMIT", "1bad") .succeeds(); diff --git a/tests/by-util/test_printenv.rs b/tests/by-util/test_printenv.rs index 29ca24857..c4f32705f 100644 --- a/tests/by-util/test_printenv.rs +++ b/tests/by-util/test_printenv.rs @@ -8,7 +8,8 @@ fn test_get_all() { assert_eq!(env::var(key), Ok("VALUE".to_string())); TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .succeeds() .stdout_contains("HOME=") .stdout_contains("KEY=VALUE"); @@ -21,7 +22,8 @@ fn test_get_var() { assert_eq!(env::var(key), Ok("VALUE".to_string())); let result = TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .arg("KEY") .succeeds(); diff --git a/tests/by-util/test_sort.rs b/tests/by-util/test_sort.rs index 8a03432af..174ac255c 100644 --- a/tests/by-util/test_sort.rs +++ b/tests/by-util/test_sort.rs @@ -31,7 +31,8 @@ fn test_buffer_sizes() { let buffer_sizes = ["0", "50K", "50k", "1M", "100M"]; for buffer_size in &buffer_sizes { TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .arg("-n") .arg("-S") .arg(buffer_size) @@ -44,7 +45,8 @@ fn test_buffer_sizes() { let buffer_sizes = ["1000G", "10T"]; for buffer_size in &buffer_sizes { TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .arg("-n") .arg("-S") .arg(buffer_size) @@ -918,7 +920,8 @@ fn test_compress_merge() { fn test_compress_fail() { #[cfg(not(windows))] TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .args(&[ "ext_sort.txt", "-n", @@ -934,7 +937,8 @@ fn test_compress_fail() { // So, don't check the output #[cfg(windows)] TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .args(&[ "ext_sort.txt", "-n", @@ -949,7 +953,8 @@ fn test_compress_fail() { #[test] fn test_merge_batches() { TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .timeout(Duration::from_secs(120)) .args(&["ext_sort.txt", "-n", "-S", "150b"]) .succeeds() @@ -959,7 +964,8 @@ fn test_merge_batches() { #[test] fn test_merge_batch_size() { TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .arg("--batch-size=2") .arg("-m") .arg("--unique") @@ -1067,7 +1073,8 @@ fn test_output_is_input() { at.touch("file"); at.append("file", input); scene - .ucmd_keepenv() + .ucmd() + .keep_env() .args(&["-m", "-u", "-o", "file", "file", "file", "file"]) .succeeds(); assert_eq!(at.read("file"), input); diff --git a/tests/by-util/test_uptime.rs b/tests/by-util/test_uptime.rs index 946bb30fa..02cba9e8f 100644 --- a/tests/by-util/test_uptime.rs +++ b/tests/by-util/test_uptime.rs @@ -10,7 +10,8 @@ fn test_invalid_arg() { #[test] fn test_uptime() { TestScenario::new(util_name!()) - .ucmd_keepenv() + .ucmd() + .keep_env() .succeeds() .stdout_contains("load average:") .stdout_contains(" up "); diff --git a/tests/by-util/test_users.rs b/tests/by-util/test_users.rs index 747995d99..7fadb2bb2 100644 --- a/tests/by-util/test_users.rs +++ b/tests/by-util/test_users.rs @@ -22,7 +22,8 @@ fn test_users_check_name() { // note: clippy::needless_borrow *false positive* #[allow(clippy::needless_borrow)] let expected = TestScenario::new(&util_name) - .cmd_keepenv(util_name) + .cmd(util_name) + .keep_env() .env("LC_ALL", "C") .succeeds() .stdout_move_str(); diff --git a/tests/common/util.rs b/tests/common/util.rs index 0f3f0d7d8..3097a762f 100644 --- a/tests/common/util.rs +++ b/tests/common/util.rs @@ -3,7 +3,7 @@ // * For the full copyright and license information, please view the LICENSE // * file that was distributed with this source code. -//spell-checker: ignore (linux) rlimit prlimit coreutil ggroups uchild uncaptured scmd SHLVL +//spell-checker: ignore (linux) rlimit prlimit coreutil ggroups uchild uncaptured scmd SHLVL canonicalized #![allow(dead_code)] @@ -13,6 +13,7 @@ use rlimit::prlimit; use rstest::rstest; #[cfg(unix)] use std::borrow::Cow; +use std::collections::VecDeque; #[cfg(not(windows))] use std::ffi::CString; use std::ffi::{OsStr, OsString}; @@ -65,7 +66,7 @@ fn read_scenario_fixture>(tmpd: &Option>, file_rel_p #[derive(Debug, Clone)] pub struct CmdResult { /// bin_path provided by `TestScenario` or `UCommand` - bin_path: String, + bin_path: PathBuf, /// util_name provided by `TestScenario` or `UCommand` util_name: Option, //tmpd is used for convenience functions for asserts against fixtures @@ -79,21 +80,23 @@ pub struct CmdResult { } impl CmdResult { - pub fn new( - bin_path: String, - util_name: Option, + pub fn new( + bin_path: S, + util_name: Option, tmpd: Option>, exit_status: Option, - stdout: T, - stderr: U, + stdout: U, + stderr: V, ) -> Self where - T: Into>, + S: Into, + T: AsRef, U: Into>, + V: Into>, { Self { - bin_path, - util_name, + bin_path: bin_path.into(), + util_name: util_name.map(|s| s.as_ref().into()), tmpd, exit_status, stdout: stdout.into(), @@ -635,7 +638,7 @@ impl CmdResult { self.stderr_only(format!( "{0}: {2}\nTry '{1} {0} --help' for more information.\n", self.util_name.as_ref().unwrap(), // This shouldn't be called using a normal command - self.bin_path, + self.bin_path.display(), msg.as_ref() )) } @@ -1094,18 +1097,21 @@ pub struct TestScenario { } impl TestScenario { - pub fn new(util_name: &str) -> Self { + pub fn new(util_name: T) -> Self + where + T: AsRef, + { let tmpd = Rc::new(TempDir::new().unwrap()); let ts = Self { bin_path: PathBuf::from(TESTS_BINARY), - util_name: String::from(util_name), + util_name: util_name.as_ref().into(), fixtures: AtPath::new(tmpd.as_ref().path()), tmpd, }; let mut fixture_path_builder = env::current_dir().unwrap(); fixture_path_builder.push(TESTS_DIR); fixture_path_builder.push(FIXTURES_DIR); - fixture_path_builder.push(util_name); + fixture_path_builder.push(util_name.as_ref()); if let Ok(m) = fs::metadata(&fixture_path_builder) { if m.is_dir() { recursive_copy(&fixture_path_builder, &ts.fixtures.subdir).unwrap(); @@ -1117,68 +1123,57 @@ impl TestScenario { /// Returns builder for invoking the target uutils binary. Paths given are /// treated relative to the environment's unique temporary test directory. pub fn ucmd(&self) -> UCommand { - self.composite_cmd(&self.bin_path, &self.util_name, true) - } - - /// Returns builder for invoking the target uutils binary. Paths given are - /// treated relative to the environment's unique temporary test directory. - pub fn composite_cmd, T: AsRef>( - &self, - bin: S, - util_name: T, - env_clear: bool, - ) -> UCommand { - UCommand::new_from_tmp(bin, Some(util_name), self.tmpd.clone(), env_clear) + UCommand::from_test_scenario(self) } /// Returns builder for invoking any system command. Paths given are treated /// relative to the environment's unique temporary test directory. - pub fn cmd>(&self, bin: S) -> UCommand { - UCommand::new_from_tmp::(bin, None, self.tmpd.clone(), true) + pub fn cmd>(&self, bin_path: S) -> UCommand { + let mut command = UCommand::new(); + command.bin_path(bin_path); + command.temp_dir(self.tmpd.clone()); + command } /// Returns builder for invoking any uutils command. Paths given are treated /// relative to the environment's unique temporary test directory. - pub fn ccmd>(&self, bin: S) -> UCommand { - self.composite_cmd(&self.bin_path, bin, true) - } - - // different names are used rather than an argument - // because the need to keep the environment is exceedingly rare. - pub fn ucmd_keepenv(&self) -> UCommand { - self.composite_cmd(&self.bin_path, &self.util_name, false) - } - - /// Returns builder for invoking any system command. Paths given are treated - /// relative to the environment's unique temporary test directory. - /// Differs from the builder returned by `cmd` in that `cmd_keepenv` does not call - /// `Command::env_clear` (Clears the entire environment map for the child process.) - pub fn cmd_keepenv>(&self, bin: S) -> UCommand { - UCommand::new_from_tmp::(bin, None, self.tmpd.clone(), false) + pub fn ccmd>(&self, util_name: S) -> UCommand { + UCommand::with_util(util_name, self.tmpd.clone()) } } -/// A `UCommand` is a wrapper around an individual Command that provides several additional features +/// A `UCommand` is a builder wrapping an individual Command that provides several additional features: /// 1. it has convenience functions that are more ergonomic to use for piping in stdin, spawning the command /// and asserting on the results. /// 2. it tracks arguments provided so that in test cases which may provide variations of an arg in loops /// the test failure can display the exact call which preceded an assertion failure. -/// 3. it provides convenience construction arguments to set the Command working directory and/or clear its environment. -#[derive(Debug)] +/// 3. it provides convenience construction methods to set the Command uutils utility and temporary directory. +/// +/// Per default `UCommand` runs a command given as an argument in a shell, platform independently. +/// It does so with safety in mind, so the working directory is set to an individual temporary +/// directory and the environment variables are cleared per default. +/// +/// The default behavior can be changed with builder methods: +/// * [`UCommand::with_util`]: Run `coreutils UTIL_NAME` instead of the shell +/// * [`UCommand::from_test_scenario`]: Run `coreutils UTIL_NAME` instead of the shell in the +/// temporary directory of the [`TestScenario`] +/// * [`UCommand::current_dir`]: Sets the working directory +/// * [`UCommand::keep_env`]: Keep environment variables instead of clearing them +/// * ... +#[derive(Debug, Default)] pub struct UCommand { - args: Vec, + args: VecDeque, env_vars: Vec<(OsString, OsString)>, current_dir: Option, env_clear: bool, bin_path: Option, - util_name: Option, + util_name: Option, has_run: bool, ignore_stdin_write_error: bool, stdin: Option, stdout: Option, stderr: Option, bytes_into_stdin: Option>, - // TODO: Why android? #[cfg(any(target_os = "linux", target_os = "android"))] limits: Vec<(rlimit::Resource, u64, u64)>, stderr_to_stdout: bool, @@ -1187,48 +1182,79 @@ pub struct UCommand { } impl UCommand { + /// Create a new plain [`UCommand`]. + /// + /// Executes a command that must be given as argument (for example with [`UCommand::arg`] in a + /// shell (`sh -c` on unix platforms or `cmd /C` on windows). + /// + /// Per default the environment is cleared and the working directory is set to an individual + /// temporary directory for safety purposes. pub fn new() -> Self { Self { - tmpd: None, - has_run: false, - bin_path: None, - current_dir: None, - args: vec![], env_clear: true, - env_vars: vec![], - util_name: None, - ignore_stdin_write_error: false, - bytes_into_stdin: None, - stdin: None, - stdout: None, - stderr: None, - // TODO: Why android? - #[cfg(any(target_os = "linux", target_os = "android"))] - limits: vec![], - stderr_to_stdout: false, - timeout: Some(Duration::from_secs(30)), + ..Default::default() } } - pub fn new_from_tmp, S: AsRef>( - bin_path: T, - util_name: Option, - tmpd: Rc, - env_clear: bool, - ) -> Self { - let mut ucmd: Self = Self::new(); - ucmd.bin_path = Some(PathBuf::from(bin_path.as_ref())); - ucmd.util_name = util_name.map(|s| s.as_ref().to_os_string()); - ucmd.tmpd = Some(tmpd); - ucmd.env_clear = env_clear; + /// Create a [`UCommand`] for a specific uutils utility. + /// + /// Sets the temporary directory to `tmpd` and the execution binary to the path where + /// `coreutils` is found. + pub fn with_util(util_name: T, tmpd: Rc) -> Self + where + T: AsRef, + { + let mut ucmd = Self::new(); + ucmd.util_name = Some(util_name.as_ref().into()); + ucmd.bin_path(TESTS_BINARY).temp_dir(tmpd); ucmd } + /// Create a [`UCommand`] from a [`TestScenario`]. + /// + /// The temporary directory and uutils utility are inherited from the [`TestScenario`] and the + /// execution binary is set to `coreutils`. + pub fn from_test_scenario(scene: &TestScenario) -> Self { + Self::with_util(&scene.util_name, scene.tmpd.clone()) + } + + /// Set the execution binary. + /// + /// Make sure the binary found at this path is executable. It's safest to provide the + /// canonicalized path instead of just the name of the executable, since path resolution is not + /// guaranteed to work on all platforms. + fn bin_path(&mut self, bin_path: T) -> &mut Self + where + T: Into, + { + self.bin_path = Some(bin_path.into()); + self + } + + /// Set the temporary directory. + /// + /// Per default an individual temporary directory is created for every [`UCommand`]. If not + /// specified otherwise with [`UCommand::current_dir`] the working directory is set to this + /// temporary directory. + fn temp_dir(&mut self, temp_dir: Rc) -> &mut Self { + self.tmpd = Some(temp_dir); + self + } + + /// Keep the environment variables instead of clearing them before running the command. + pub fn keep_env(&mut self) -> &mut Self { + self.env_clear = false; + self + } + + /// Set the working directory for this [`UCommand`] + /// + /// Per default the working directory is set to the [`UCommands`] temporary directory. pub fn current_dir(&mut self, current_dir: T) -> &mut Self where - T: AsRef, + T: Into, { - self.current_dir = Some(current_dir.as_ref().into()); + self.current_dir = Some(current_dir.into()); self } @@ -1255,7 +1281,7 @@ impl UCommand { /// Add a parameter to the invocation. Path arguments are treated relative /// to the test environment directory. pub fn arg>(&mut self, arg: S) -> &mut Self { - self.args.push(arg.as_ref().into()); + self.args.push_back(arg.as_ref().into()); self } @@ -1302,9 +1328,8 @@ impl UCommand { self } - // TODO: Why android? #[cfg(any(target_os = "linux", target_os = "android"))] - pub fn with_limit( + pub fn limit( &mut self, resource: rlimit::Resource, soft_limit: u64, @@ -1326,25 +1351,46 @@ impl UCommand { self } - // TODO: make public? + /// Build the `std::process::Command` and apply the defaults on fields which were not specified + /// by the user. + /// + /// These __defaults__ are: + /// * `bin_path`: Depending on the platform and os, the native shell (unix -> `/bin/sh` etc.). + /// This default also requires to set the first argument to `-c` on unix (`/C` on windows) if + /// this argument wasn't specified explicitly by the user. + /// * `util_name`: `None`. If neither `bin_path` nor `util_name` were given the arguments are + /// run in a shell (See `bin_path` above). + /// * `temp_dir`: If `current_dir` was not set, a new temporary directory will be created in + /// which this command will be run and `current_dir` will be set to this `temp_dir`. + /// * `current_dir`: The temporary directory given by `temp_dir`. + /// * `timeout`: `30 seconds` + /// * `env_clear`: `true`. (Almost) all environment variables will be cleared. + /// * `stdin`: `Stdio::null()` + /// * `ignore_stdin_write_error`: `false` + /// * `stdout`, `stderr`: If not specified the output will be captured with [`CapturedOutput`] + /// * `stderr_to_stdout`: `false` + /// * `bytes_into_stdin`: `None` + /// * `limits`: `None`. fn build(&mut self) -> (Command, Option, Option) { if self.bin_path.is_some() { if let Some(util_name) = &self.util_name { - self.args.insert(0, OsString::from(util_name)); + self.args.push_front(util_name.into()); } } else if let Some(util_name) = &self.util_name { self.bin_path = Some(PathBuf::from(TESTS_BINARY)); - self.args.insert(0, OsString::from(util_name)); + self.args.push_front(util_name.into()); + // neither `bin_path` nor `util_name` was set so we apply the default to run the arguments + // in a platform specific shell } else if cfg!(unix) { - let bin_path = if cfg!(target_os = "android") { - PathBuf::from("/system/bin/sh") - } else { - PathBuf::from("/bin/sh") - }; + #[cfg(target_os = "android")] + let bin_path = PathBuf::from("/system/bin/sh"); + #[cfg(not(target_os = "android"))] + let bin_path = PathBuf::from("/bin/sh"); + self.bin_path = Some(bin_path); let c_arg = OsString::from("-c"); if !self.args.contains(&c_arg) { - self.args.insert(0, c_arg); + self.args.push_front(c_arg); } } else { self.bin_path = Some(PathBuf::from("cmd")); @@ -1355,21 +1401,26 @@ impl UCommand { .iter() .any(|s| s.eq_ignore_ascii_case(&c_arg) || s.eq_ignore_ascii_case(&k_arg)) { - self.args.insert(0, c_arg); + self.args.push_front(c_arg); } }; + // unwrap is safe here because we have set `self.bin_path` before let mut command = Command::new(self.bin_path.as_ref().unwrap()); command.args(&self.args); - if self.tmpd.is_none() { - self.tmpd = Some(Rc::new(tempfile::tempdir().unwrap())); - } - + // We use a temporary directory as working directory if not specified otherwise with + // `current_dir()`. If neither `current_dir` nor a temporary directory is available, then we + // create our own. if let Some(current_dir) = &self.current_dir { command.current_dir(current_dir); + } else if let Some(temp_dir) = &self.tmpd { + command.current_dir(temp_dir.path()); } else { - command.current_dir(self.tmpd.as_ref().unwrap().path()); + let temp_dir = tempfile::tempdir().unwrap(); + self.current_dir = Some(temp_dir.path().into()); + command.current_dir(temp_dir.path()); + self.tmpd = Some(Rc::new(temp_dir)); } if self.env_clear { @@ -1391,8 +1442,10 @@ impl UCommand { } } - for (key, value) in &self.env_vars { - command.env(key, value); + command.envs(self.env_vars.iter().cloned()); + + if self.timeout.is_none() { + self.timeout = Some(Duration::from_secs(30)); } let mut captured_stdout = None; @@ -1436,7 +1489,6 @@ impl UCommand { /// Spawns the command, feeds the stdin if any, and returns the /// child process immediately. pub fn run_no_wait(&mut self) -> UChild { - // TODO: remove? assert!(!self.has_run, "{}", ALREADY_RUN); self.has_run = true; @@ -1509,7 +1561,7 @@ impl std::fmt::Display for UCommand { let mut comm_string: Vec = vec![self .bin_path .as_ref() - .map_or("".to_string(), |p| p.display().to_string())]; + .map_or(String::new(), |p| p.display().to_string())]; comm_string.extend(self.args.iter().map(|s| s.to_string_lossy().to_string())); f.write_str(&comm_string.join(" ")) } @@ -1647,14 +1699,14 @@ impl<'a> UChildAssertion<'a> { self.uchild.stderr_exact_bytes(expected_stderr_size), ), }; - CmdResult { - bin_path: self.uchild.bin_path.clone(), - util_name: self.uchild.util_name.clone(), - tmpd: self.uchild.tmpd.clone(), + CmdResult::new( + self.uchild.bin_path.clone(), + self.uchild.util_name.clone(), + self.uchild.tmpd.clone(), exit_status, stdout, stderr, - } + ) } // Make assertions of [`CmdResult`] with all output from start of the process until now. @@ -1734,7 +1786,7 @@ impl<'a> UChildAssertion<'a> { /// Abstraction for a [`std::process::Child`] to handle the child process. pub struct UChild { raw: Child, - bin_path: String, + bin_path: PathBuf, util_name: Option, captured_stdout: Option, captured_stderr: Option, @@ -1754,11 +1806,8 @@ impl UChild { ) -> Self { Self { raw: child, - bin_path: ucommand.bin_path.as_ref().unwrap().display().to_string(), - util_name: ucommand - .util_name - .clone() - .map(|s| s.to_string_lossy().to_string()), + bin_path: ucommand.bin_path.clone().unwrap(), + util_name: ucommand.util_name.clone(), captured_stdout, captured_stderr, ignore_stdin_write_error: ucommand.ignore_stdin_write_error, @@ -2388,11 +2437,13 @@ fn parse_coreutil_version(version_string: &str) -> f32 { ///``` #[cfg(unix)] pub fn expected_result(ts: &TestScenario, args: &[&str]) -> std::result::Result { - println!("{}", check_coreutil_version(&ts.util_name, VERSION_MIN)?); - let util_name = &host_name_for(&ts.util_name); + let util_name = ts.util_name.as_str(); + println!("{}", check_coreutil_version(util_name, VERSION_MIN)?); + let util_name = host_name_for(util_name); let result = ts - .cmd_keepenv(util_name.as_ref()) + .cmd(util_name.as_ref()) + .keep_env() .env("LC_ALL", "C") .args(args) .run(); @@ -2464,7 +2515,8 @@ pub fn run_ucmd_as_root( // we can run sudo and we're root // run ucmd as root: Ok(ts - .cmd_keepenv("sudo") + .cmd("sudo") + .keep_env() .env("LC_ALL", "C") .arg("-E") .arg("--non-interactive") @@ -2492,30 +2544,8 @@ mod tests { // spell-checker:ignore (tests) asdfsadfa use super::*; - #[cfg(unix)] pub fn run_cmd>(cmd: T) -> CmdResult { - let mut ucmd = UCommand::new_from_tmp::<&str, String>( - "sh", - None, - Rc::new(tempfile::tempdir().unwrap()), - true, - ); - ucmd.arg("-c"); - ucmd.arg(cmd); - ucmd.run() - } - - #[cfg(windows)] - pub fn run_cmd>(cmd: T) -> CmdResult { - let mut ucmd = UCommand::new_from_tmp::<&str, String>( - "cmd", - None, - Rc::new(tempfile::tempdir().unwrap()), - true, - ); - ucmd.arg("/C"); - ucmd.arg(cmd); - ucmd.run() + UCommand::new().arg(cmd).run() } #[test] @@ -3257,7 +3287,7 @@ mod tests { #[cfg(feature = "echo")] #[test] fn test_ucommand_when_default() { - let shell_cmd = format!("{} echo -n hello", TESTS_BINARY); + let shell_cmd = format!("{TESTS_BINARY} echo -n hello"); let mut command = UCommand::new(); command.arg(&shell_cmd).succeeds().stdout_is("hello"); @@ -3274,4 +3304,31 @@ mod tests { std::assert_eq!(command.args, &[expected_arg, OsString::from(&shell_cmd)]); assert!(command.tmpd.is_some()); } + + #[cfg(feature = "echo")] + #[test] + fn test_ucommand_with_util() { + let tmpd = tempfile::tempdir().unwrap(); + let mut command = UCommand::with_util("echo", Rc::new(tmpd)); + + command + .args(&["-n", "hello"]) + .succeeds() + .stdout_only("hello"); + + std::assert_eq!( + &PathBuf::from(TESTS_BINARY), + command.bin_path.as_ref().unwrap() + ); + std::assert_eq!("echo", &command.util_name.unwrap()); + std::assert_eq!( + &[ + OsString::from("echo"), + OsString::from("-n"), + OsString::from("hello") + ], + command.args.make_contiguous() + ); + assert!(command.tmpd.is_some()); + } } From 2cd19522e40ab2c869268348efb0792e7023fc85 Mon Sep 17 00:00:00 2001 From: Yang Hau Date: Sun, 19 Feb 2023 03:22:54 +0800 Subject: [PATCH 17/39] fix: Fix panic in multi-byte characters Closes #4353 --- src/uucore/src/lib/parser/parse_time.rs | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/uucore/src/lib/parser/parse_time.rs b/src/uucore/src/lib/parser/parse_time.rs index e440a3c91..1a7b66e90 100644 --- a/src/uucore/src/lib/parser/parse_time.rs +++ b/src/uucore/src/lib/parser/parse_time.rs @@ -51,7 +51,10 @@ pub fn from_str(string: &str) -> Result { if len == 0 { return Err("empty string".to_owned()); } - let slice = &string[..len - 1]; + let slice = match string.get(..len - 1) { + Some(s) => s, + None => return Err(format!("invalid time interval {}", string.quote())), + }; let (numstr, times) = match string.chars().next_back().unwrap() { 's' => (slice, 1), 'm' => (slice, 60), @@ -112,6 +115,11 @@ mod tests { assert!(from_str("123X").is_err()); } + #[test] + fn test_error_multi_bytes_characters() { + assert!(from_str("10€").is_err()); + } + #[test] fn test_error_invalid_magnitude() { assert!(from_str("12abc3s").is_err()); From 7aa7f219a09a5c9fbf71bca2c8fc1d64a33c898d Mon Sep 17 00:00:00 2001 From: Kyle Manna Date: Mon, 13 Feb 2023 23:58:06 -0600 Subject: [PATCH 18/39] install: fix issue #4360 with bad target directory permissions * Correct bug that set the last directory to the mode the file should have been set to. * Add unit test to verify correct functionality. --- src/uu/install/src/install.rs | 6 ------ tests/by-util/test_install.rs | 31 +++++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+), 6 deletions(-) diff --git a/src/uu/install/src/install.rs b/src/uu/install/src/install.rs index 597eacc67..3178df8e1 100644 --- a/src/uu/install/src/install.rs +++ b/src/uu/install/src/install.rs @@ -558,12 +558,6 @@ fn standard(mut paths: Vec, b: &Behavior) -> UResult<()> { if let Err(e) = fs::create_dir_all(to_create) { return Err(InstallError::CreateDirFailed(to_create.to_path_buf(), e).into()); } - - // Silent the warning as we want to the error message - #[allow(clippy::question_mark)] - if mode::chmod(to_create, b.mode()).is_err() { - return Err(InstallError::ChmodFailed(to_create.to_path_buf()).into()); - } } } } diff --git a/tests/by-util/test_install.rs b/tests/by-util/test_install.rs index 1e6cd7606..e041fb081 100644 --- a/tests/by-util/test_install.rs +++ b/tests/by-util/test_install.rs @@ -124,6 +124,37 @@ fn test_install_ancestors_mode_directories() { assert_eq!(0o40_200_u32, at.metadata(target_dir).permissions().mode()); } +#[test] +fn test_install_ancestors_mode_directories_with_file() { + let (at, mut ucmd) = at_and_ucmd!(); + let ancestor1 = "ancestor1"; + let ancestor2 = "ancestor1/ancestor2"; + let target_file = "ancestor1/ancestor2/target_file"; + let directories_arg = "-D"; + let mode_arg = "--mode=200"; + let file = "file"; + let probe = "probe"; + + at.mkdir(probe); + let default_perms = at.metadata(probe).permissions().mode(); + + at.touch(file); + + ucmd.args(&[mode_arg, directories_arg, file, target_file]) + .succeeds() + .no_stderr(); + + assert!(at.dir_exists(ancestor1)); + assert!(at.dir_exists(ancestor2)); + assert!(at.file_exists(target_file)); + + assert_eq!(default_perms, at.metadata(ancestor1).permissions().mode()); + assert_eq!(default_perms, at.metadata(ancestor2).permissions().mode()); + + // Expected mode only on the target_file. + assert_eq!(0o100_200_u32, at.metadata(target_file).permissions().mode()); +} + #[test] fn test_install_parent_directories() { let (at, mut ucmd) = at_and_ucmd!(); From 5876cd25814ed0a3d7f034854eeafdff50ad390b Mon Sep 17 00:00:00 2001 From: Kyle Manna Date: Tue, 14 Feb 2023 01:02:31 -0600 Subject: [PATCH 19/39] install: add missing directory chown * Re-factor the copy function chown into a function that can be re-used. * Fix bug where the group overwrote the user. * Add chown compatibility to follow GNU coreutils. * Reduce two chown calls to a single syscall only when needed. * Fixes #4361 --- src/uu/install/src/install.rs | 119 +++++++++++++++++----------------- 1 file changed, 59 insertions(+), 60 deletions(-) diff --git a/src/uu/install/src/install.rs b/src/uu/install/src/install.rs index 597eacc67..c3b64cdd8 100644 --- a/src/uu/install/src/install.rs +++ b/src/uu/install/src/install.rs @@ -466,6 +466,8 @@ fn directory(paths: &[String], b: &Behavior) -> UResult<()> { uucore::error::set_exit_code(1); continue; } + + chown_optional_user_group(path, b)?; } // If the exit code was set, or show! has been called at least once // (which sets the exit code as well), function execution will end after @@ -626,6 +628,62 @@ fn copy_files_into_dir(files: &[PathBuf], target_dir: &Path, b: &Behavior) -> UR Ok(()) } +/// Handle incomplete user/group parings for chown. +/// +/// Returns a Result type with the Err variant containing the error message. +/// +/// # Parameters +/// +/// _path_ must exist. +/// +/// # Errors +/// +/// If the owner or group are invalid or copy system call fails, we print a verbose error and +/// return an empty error value. +/// +fn chown_optional_user_group(path: &Path, b: &Behavior) -> UResult<()> { + let owner = if !b.owner.is_empty() { + match usr2uid(&b.owner) { + Ok(u) => Some(u), + _ => return Err(InstallError::NoSuchUser(b.owner.clone()).into()), + } + } else { + None + }; + + let group = if !b.group.is_empty() { + match grp2gid(&b.group) { + Ok(g) => Some(g), + _ => return Err(InstallError::NoSuchGroup(b.group.clone()).into()), + } + } else { + None + }; + + let meta = match fs::metadata(path) { + Ok(meta) => meta, + Err(e) => return Err(InstallError::MetadataFailed(e).into()), + }; + + let verbosity = Verbosity { + groups_only: owner.is_none(), + level: VerbosityLevel::Normal, + }; + + if owner.is_some() || group.is_some() { + match wrap_chown(path, &meta, owner, group, false, verbosity) { + Ok(n) => { + if !n.is_empty() { + show_error!("{}", n); + } + } + Err(e) => show_error!("{}", e), + } + } + + Ok(()) +} + /// Copy one file to a new location, changing metadata. /// /// Returns a Result type with the Err variant containing the error message. @@ -708,66 +766,7 @@ fn copy(from: &Path, to: &Path, b: &Behavior) -> UResult<()> { return Err(InstallError::ChmodFailed(to.to_path_buf()).into()); } - if !b.owner.is_empty() { - let meta = match fs::metadata(to) { - Ok(meta) => meta, - Err(e) => return Err(InstallError::MetadataFailed(e).into()), - }; - - let owner_id = match usr2uid(&b.owner) { - Ok(g) => g, - _ => return Err(InstallError::NoSuchUser(b.owner.clone()).into()), - }; - let gid = meta.gid(); - match wrap_chown( - to, - &meta, - Some(owner_id), - Some(gid), - false, - Verbosity { - groups_only: false, - level: VerbosityLevel::Normal, - }, - ) { - Ok(n) => { - if !n.is_empty() { - show_error!("{}", n); - } - } - Err(e) => show_error!("{}", e), - } - } - - if !b.group.is_empty() { - let meta = match fs::metadata(to) { - Ok(meta) => meta, - Err(e) => return Err(InstallError::MetadataFailed(e).into()), - }; - - let group_id = match grp2gid(&b.group) { - Ok(g) => g, - _ => return Err(InstallError::NoSuchGroup(b.group.clone()).into()), - }; - match wrap_chown( - to, - &meta, - Some(group_id), - None, - false, - Verbosity { - groups_only: true, - level: VerbosityLevel::Normal, - }, - ) { - Ok(n) => { - if !n.is_empty() { - show_error!("{}", n); - } - } - Err(e) => show_error!("{}", e), - } - } + chown_optional_user_group(to, b)?; if b.preserve_timestamps { let meta = match fs::metadata(from) { From 376f4d90ef7d8ee8b5d0283b6997796e10052719 Mon Sep 17 00:00:00 2001 From: Kyle Manna Date: Wed, 15 Feb 2023 21:28:40 -0600 Subject: [PATCH 20/39] install: add tests for invalid owner and group * Move the user and group resolution to the behavior decoding instead of re-running on every file/directory creation. Simplifies code. * Update error output to match GNU coreutils. * Add tests to verify invalid owner and group. --- src/uu/install/src/install.rs | 97 ++++++++++++++++++----------------- tests/by-util/test_install.rs | 94 +++++++++++++++++++++++++++++++++ 2 files changed, 143 insertions(+), 48 deletions(-) diff --git a/src/uu/install/src/install.rs b/src/uu/install/src/install.rs index c3b64cdd8..ec80709a9 100644 --- a/src/uu/install/src/install.rs +++ b/src/uu/install/src/install.rs @@ -41,8 +41,8 @@ pub struct Behavior { specified_mode: Option, backup_mode: BackupMode, suffix: String, - owner: String, - group: String, + owner_id: Option, + group_id: Option, verbose: bool, preserve_timestamps: bool, compare: bool, @@ -64,8 +64,8 @@ enum InstallError { InstallFailed(PathBuf, PathBuf, std::io::Error), StripProgramFailed(String), MetadataFailed(std::io::Error), - NoSuchUser(String), - NoSuchGroup(String), + InvalidUser(String), + InvalidGroup(String), OmittingDirectory(PathBuf), } @@ -117,8 +117,8 @@ impl Display for InstallError { ), Self::StripProgramFailed(msg) => write!(f, "strip program failed: {msg}"), Self::MetadataFailed(e) => Display::fmt(&uio_error!(e, ""), f), - Self::NoSuchUser(user) => write!(f, "no such user: {}", user.maybe_quote()), - Self::NoSuchGroup(group) => write!(f, "no such group: {}", group.maybe_quote()), + Self::InvalidUser(user) => write!(f, "invalid user: {}", user.quote()), + Self::InvalidGroup(group) => write!(f, "invalid group: {}", group.quote()), Self::OmittingDirectory(dir) => write!(f, "omitting directory {}", dir.quote()), } } @@ -391,21 +391,44 @@ fn behavior(matches: &ArgMatches) -> UResult { show_error!("Options --compare and --strip are mutually exclusive"); return Err(1.into()); } + + let owner = matches + .get_one::(OPT_OWNER) + .map(|s| s.as_str()) + .unwrap_or("") + .to_string(); + + let owner_id = if !owner.is_empty() { + match usr2uid(&owner) { + Ok(u) => Some(u), + _ => return Err(InstallError::InvalidUser(owner.clone()).into()), + } + } else { + None + }; + + let group = matches + .get_one::(OPT_GROUP) + .map(|s| s.as_str()) + .unwrap_or("") + .to_string(); + + let group_id = if !group.is_empty() { + match grp2gid(&group) { + Ok(g) => Some(g), + _ => return Err(InstallError::InvalidGroup(group.clone()).into()), + } + } else { + None + }; + Ok(Behavior { main_function, specified_mode, backup_mode, suffix: backup_control::determine_backup_suffix(matches), - owner: matches - .get_one::(OPT_OWNER) - .map(|s| s.as_str()) - .unwrap_or("") - .to_string(), - group: matches - .get_one::(OPT_GROUP) - .map(|s| s.as_str()) - .unwrap_or("") - .to_string(), + owner_id, + group_id, verbose: matches.get_flag(OPT_VERBOSE), preserve_timestamps, compare, @@ -467,7 +490,11 @@ fn directory(paths: &[String], b: &Behavior) -> UResult<()> { continue; } - chown_optional_user_group(path, b)?; + if chown_optional_user_group(path, b).is_err() { + // Error messages are printed by the chown_optional_user_group function! + uucore::error::set_exit_code(1); + continue; + } } // If the exit code was set, or show! has been called at least once // (which sets the exit code as well), function execution will end after @@ -642,36 +669,18 @@ fn copy_files_into_dir(files: &[PathBuf], target_dir: &Path, b: &Behavior) -> UR /// return an empty error value. /// fn chown_optional_user_group(path: &Path, b: &Behavior) -> UResult<()> { - let owner = if !b.owner.is_empty() { - match usr2uid(&b.owner) { - Ok(u) => Some(u), - _ => return Err(InstallError::NoSuchUser(b.owner.clone()).into()), - } - } else { - None - }; - - let group = if !b.group.is_empty() { - match grp2gid(&b.group) { - Ok(g) => Some(g), - _ => return Err(InstallError::NoSuchGroup(b.group.clone()).into()), - } - } else { - None - }; - let meta = match fs::metadata(path) { Ok(meta) => meta, Err(e) => return Err(InstallError::MetadataFailed(e).into()), }; let verbosity = Verbosity { - groups_only: owner.is_none(), + groups_only: b.owner_id.is_none(), level: VerbosityLevel::Normal, }; - if owner.is_some() || group.is_some() { - match wrap_chown(path, &meta, owner, group, false, verbosity) { + if b.owner_id.is_some() || b.group_id.is_some() { + match wrap_chown(path, &meta, b.owner_id, b.group_id, false, verbosity) { Ok(n) => { if !n.is_empty() { show_error!("{}", n); @@ -846,19 +855,11 @@ fn need_copy(from: &Path, to: &Path, b: &Behavior) -> UResult { // TODO: if -P (#1809) and from/to contexts mismatch, return true. - if !b.owner.is_empty() { - let owner_id = match usr2uid(&b.owner) { - Ok(id) => id, - _ => return Err(InstallError::NoSuchUser(b.owner.clone()).into()), - }; + if let Some(owner_id) = b.owner_id { if owner_id != to_meta.uid() { return Ok(true); } - } else if !b.group.is_empty() { - let group_id = match grp2gid(&b.group) { - Ok(id) => id, - _ => return Err(InstallError::NoSuchGroup(b.group.clone()).into()), - }; + } else if let Some(group_id) = b.group_id { if group_id != to_meta.gid() { return Ok(true); } diff --git a/tests/by-util/test_install.rs b/tests/by-util/test_install.rs index 1e6cd7606..342824fdb 100644 --- a/tests/by-util/test_install.rs +++ b/tests/by-util/test_install.rs @@ -1369,6 +1369,100 @@ fn test_install_dir_req_verbose() { .stdout_contains("install: creating directory 'sub5/a'\ninstall: creating directory 'sub5/a/b'\ninstall: creating directory 'sub5/a/b/c'\n'source_file1' -> 'sub5/a/b/c/file'"); } +#[test] +fn test_install_chown_file_invalid() { + let scene = TestScenario::new(util_name!()); + let at = &scene.fixtures; + + let file_1 = "source_file1"; + at.touch(file_1); + + scene + .ucmd() + .arg("-o") + .arg("test_invalid_user") + .arg(file_1) + .arg("target_file1") + .fails() + .stderr_contains("install: invalid user: 'test_invalid_user'"); + + scene + .ucmd() + .arg("-g") + .arg("test_invalid_group") + .arg(file_1) + .arg("target_file1") + .fails() + .stderr_contains("install: invalid group: 'test_invalid_group'"); + + scene + .ucmd() + .arg("-o") + .arg("test_invalid_user") + .arg("-g") + .arg("test_invalid_group") + .arg(file_1) + .arg("target_file1") + .fails() + .stderr_contains("install: invalid user: 'test_invalid_user'"); + + scene + .ucmd() + .arg("-g") + .arg("test_invalid_group") + .arg("-o") + .arg("test_invalid_user") + .arg(file_1) + .arg("target_file1") + .fails() + .stderr_contains("install: invalid user: 'test_invalid_user'"); +} + +#[test] +fn test_install_chown_directory_invalid() { + let scene = TestScenario::new(util_name!()); + + scene + .ucmd() + .arg("-o") + .arg("test_invalid_user") + .arg("-d") + .arg("dir1/dir2") + .fails() + .stderr_contains("install: invalid user: 'test_invalid_user'"); + + scene + .ucmd() + .arg("-g") + .arg("test_invalid_group") + .arg("-d") + .arg("dir1/dir2") + .fails() + .stderr_contains("install: invalid group: 'test_invalid_group'"); + + scene + .ucmd() + .arg("-o") + .arg("test_invalid_user") + .arg("-g") + .arg("test_invalid_group") + .arg("-d") + .arg("dir1/dir2") + .fails() + .stderr_contains("install: invalid user: 'test_invalid_user'"); + + scene + .ucmd() + .arg("-g") + .arg("test_invalid_group") + .arg("-o") + .arg("test_invalid_user") + .arg("-d") + .arg("dir1/dir2") + .fails() + .stderr_contains("install: invalid user: 'test_invalid_user'"); +} + #[test] fn test_install_compare_option() { let scene = TestScenario::new(util_name!()); From 044f3d3a434f03848f044690ea4df0d17d51b32b Mon Sep 17 00:00:00 2001 From: Koki Ueha Date: Sun, 19 Feb 2023 14:54:33 +0000 Subject: [PATCH 21/39] yes: move help strings to markdown file --- src/uu/yes/src/yes.rs | 6 +++--- src/uu/yes/yes.md | 7 +++++++ 2 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 src/uu/yes/yes.md diff --git a/src/uu/yes/src/yes.rs b/src/uu/yes/src/yes.rs index 22ccebab2..714bdcac5 100644 --- a/src/uu/yes/src/yes.rs +++ b/src/uu/yes/src/yes.rs @@ -12,13 +12,13 @@ use std::io::{self, Result, Write}; use clap::{Arg, ArgAction, Command}; use uucore::error::{UResult, USimpleError}; -use uucore::format_usage; +use uucore::{format_usage, help_about, help_usage}; #[cfg(any(target_os = "linux", target_os = "android"))] mod splice; -const ABOUT: &str = "Repeatedly display a line with STRING (or 'y')"; -const USAGE: &str = "{} [STRING]..."; +const ABOUT: &str = help_about!("yes.md"); +const USAGE: &str = help_usage!("yes.md"); // it's possible that using a smaller or larger buffer might provide better performance on some // systems, but honestly this is good enough diff --git a/src/uu/yes/yes.md b/src/uu/yes/yes.md new file mode 100644 index 000000000..ad2da7dc9 --- /dev/null +++ b/src/uu/yes/yes.md @@ -0,0 +1,7 @@ +# yes + +``` +yes [STRING]... +``` + +Repeatedly display a line with STRING (or 'y') From 05db5f744239d81bdfff00ef8f7c81981dc92a7f Mon Sep 17 00:00:00 2001 From: Kyle Manna Date: Sat, 18 Feb 2023 23:45:39 -0600 Subject: [PATCH 22/39] install: address merge request feedback * Explicitly handle Err() in match. * Move metdata functions deeper into `chown_optional_user_group()`. * Add `ChownFailed` to propagate errors. * Use `show_if_err!()` to wrap `chown_optional_user_group`. * Simplify chown verbose message handling. --- src/uu/install/src/install.rs | 58 ++++++++++++++++------------------- 1 file changed, 27 insertions(+), 31 deletions(-) diff --git a/src/uu/install/src/install.rs b/src/uu/install/src/install.rs index ec80709a9..5e6efd150 100644 --- a/src/uu/install/src/install.rs +++ b/src/uu/install/src/install.rs @@ -58,6 +58,7 @@ enum InstallError { DirNeedsArg(), CreateDirFailed(PathBuf, std::io::Error), ChmodFailed(PathBuf), + ChownFailed(PathBuf, String), InvalidTarget(PathBuf), TargetDirIsntDir(PathBuf), BackupFailed(PathBuf, PathBuf, std::io::Error), @@ -99,6 +100,7 @@ impl Display for InstallError { Display::fmt(&uio_error!(e, "failed to create {}", dir.quote()), f) } Self::ChmodFailed(file) => write!(f, "failed to chmod {}", file.quote()), + Self::ChownFailed(file, msg) => write!(f, "failed to chown {}: {}", file.quote(), msg), Self::InvalidTarget(target) => write!( f, "invalid target {}: No such file or directory", @@ -393,30 +395,30 @@ fn behavior(matches: &ArgMatches) -> UResult { } let owner = matches - .get_one::(OPT_OWNER) - .map(|s| s.as_str()) - .unwrap_or("") - .to_string(); + .get_one::(OPT_OWNER) + .map(|s| s.as_str()) + .unwrap_or("") + .to_string(); let owner_id = if !owner.is_empty() { match usr2uid(&owner) { Ok(u) => Some(u), - _ => return Err(InstallError::InvalidUser(owner.clone()).into()), + Err(_) => return Err(InstallError::InvalidUser(owner.clone()).into()), } } else { None }; let group = matches - .get_one::(OPT_GROUP) - .map(|s| s.as_str()) - .unwrap_or("") - .to_string(); + .get_one::(OPT_GROUP) + .map(|s| s.as_str()) + .unwrap_or("") + .to_string(); let group_id = if !group.is_empty() { match grp2gid(&group) { Ok(g) => Some(g), - _ => return Err(InstallError::InvalidGroup(group.clone()).into()), + Err(_) => return Err(InstallError::InvalidGroup(group.clone()).into()), } } else { None @@ -490,11 +492,7 @@ fn directory(paths: &[String], b: &Behavior) -> UResult<()> { continue; } - if chown_optional_user_group(path, b).is_err() { - // Error messages are printed by the chown_optional_user_group function! - uucore::error::set_exit_code(1); - continue; - } + show_if_err!(chown_optional_user_group(path, b)); } // If the exit code was set, or show! has been called at least once // (which sets the exit code as well), function execution will end after @@ -669,24 +667,22 @@ fn copy_files_into_dir(files: &[PathBuf], target_dir: &Path, b: &Behavior) -> UR /// return an empty error value. /// fn chown_optional_user_group(path: &Path, b: &Behavior) -> UResult<()> { - let meta = match fs::metadata(path) { - Ok(meta) => meta, - Err(e) => return Err(InstallError::MetadataFailed(e).into()), - }; - - let verbosity = Verbosity { - groups_only: b.owner_id.is_none(), - level: VerbosityLevel::Normal, - }; - if b.owner_id.is_some() || b.group_id.is_some() { + let meta = match fs::metadata(path) { + Ok(meta) => meta, + Err(e) => return Err(InstallError::MetadataFailed(e).into()), + }; + + // GNU coreutils doesn't print chown operations during install with verbose flag. + let verbosity = Verbosity { + groups_only: b.owner_id.is_none(), + level: VerbosityLevel::Normal, + }; + match wrap_chown(path, &meta, b.owner_id, b.group_id, false, verbosity) { - Ok(n) => { - if !n.is_empty() { - show_error!("{}", n); - } - } - Err(e) => show_error!("{}", e), + Ok(msg) if b.verbose && !msg.is_empty() => println!("chown: {msg}"), + Ok(_) => {} + Err(e) => return Err(InstallError::ChownFailed(path.to_path_buf(), e).into()), } } From e0470c02940ea93e8980aae225bbed52766e2bd1 Mon Sep 17 00:00:00 2001 From: Koki Ueha Date: Mon, 20 Feb 2023 11:30:33 +0000 Subject: [PATCH 23/39] tac: move help strings to markdown file --- src/uu/tac/src/tac.rs | 6 +++--- src/uu/tac/tac.md | 7 +++++++ 2 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 src/uu/tac/tac.md diff --git a/src/uu/tac/src/tac.rs b/src/uu/tac/src/tac.rs index b0d79e6da..aef9932a2 100644 --- a/src/uu/tac/src/tac.rs +++ b/src/uu/tac/src/tac.rs @@ -19,12 +19,12 @@ use std::{ use uucore::display::Quotable; use uucore::error::UError; use uucore::error::UResult; -use uucore::{format_usage, show}; +use uucore::{format_usage, help_about, help_usage, show}; use crate::error::TacError; -static USAGE: &str = "{} [OPTION]... [FILE]..."; -static ABOUT: &str = "Write each file to standard output, last line first."; +static USAGE: &str = help_usage!("tac.md"); +static ABOUT: &str = help_about!("tac.md"); mod options { pub static BEFORE: &str = "before"; diff --git a/src/uu/tac/tac.md b/src/uu/tac/tac.md new file mode 100644 index 000000000..6787b3f49 --- /dev/null +++ b/src/uu/tac/tac.md @@ -0,0 +1,7 @@ +# tac + +``` +tac [OPTION]... [FILE]... +``` + +Write each file to standard output, last line first. From 9bf9bba7c319ee79f5fd5e5c8c2ec343488e1a20 Mon Sep 17 00:00:00 2001 From: Koki Ueha Date: Mon, 20 Feb 2023 11:56:39 +0000 Subject: [PATCH 24/39] kill: move help strings to markdown file --- src/uu/kill/kill.md | 7 +++++++ src/uu/kill/src/kill.rs | 6 +++--- 2 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 src/uu/kill/kill.md diff --git a/src/uu/kill/kill.md b/src/uu/kill/kill.md new file mode 100644 index 000000000..1e3e2b3d0 --- /dev/null +++ b/src/uu/kill/kill.md @@ -0,0 +1,7 @@ +# kill + +``` +kill [OPTIONS]... PID... +``` + +Send signal to processes or list information about signals. diff --git a/src/uu/kill/src/kill.rs b/src/uu/kill/src/kill.rs index c14023e82..d18a483fd 100644 --- a/src/uu/kill/src/kill.rs +++ b/src/uu/kill/src/kill.rs @@ -14,10 +14,10 @@ use std::io::Error; use uucore::display::Quotable; use uucore::error::{FromIo, UError, UResult, USimpleError}; use uucore::signals::{signal_by_name_or_value, ALL_SIGNALS}; -use uucore::{format_usage, show}; +use uucore::{format_usage, help_about, help_usage, show}; -static ABOUT: &str = "Send signal to processes or list information about signals."; -const USAGE: &str = "{} [OPTIONS]... PID..."; +static ABOUT: &str = help_about!("kill.md"); +const USAGE: &str = help_usage!("kill.md"); pub mod options { pub static PIDS_OR_SIGNALS: &str = "pids_or_signals"; From 72f13369aa5f8483160bec439ae280539c13cb54 Mon Sep 17 00:00:00 2001 From: pkubaj Date: Mon, 20 Feb 2023 15:20:31 +0000 Subject: [PATCH 25/39] Add FreeBSD to documentation --- docs/src/installation.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/src/installation.md b/docs/src/installation.md index e2e72699b..063935ed6 100644 --- a/docs/src/installation.md +++ b/docs/src/installation.md @@ -107,6 +107,13 @@ brew install uutils-coreutils port install coreutils-uutils ``` +## FreeBSD +[![FreeBSD port](https://repology.org/badge/version-for-repo/freebsd/uutils-coreutils.svg)](https://repology.org/project/uutils-coreutils/versions) + +```sh +pkg install uutils +``` + ## Windows ### Scoop From dd4299c32ebef81a450f3434fe186b8faeb18171 Mon Sep 17 00:00:00 2001 From: David Matos Date: Mon, 20 Feb 2023 22:18:07 +0100 Subject: [PATCH 26/39] chmod: supress verbose output when not verbose --- src/uu/chmod/src/chmod.rs | 10 ++++++---- tests/by-util/test_chmod.rs | 15 +++++++++++++-- 2 files changed, 19 insertions(+), 6 deletions(-) diff --git a/src/uu/chmod/src/chmod.rs b/src/uu/chmod/src/chmod.rs index 374f22874..eb8db104f 100644 --- a/src/uu/chmod/src/chmod.rs +++ b/src/uu/chmod/src/chmod.rs @@ -190,16 +190,18 @@ impl Chmoder { let file = Path::new(filename); if !file.exists() { if file.is_symlink() { - println!( - "failed to change mode of {} from 0000 (---------) to 0000 (---------)", - filename.quote() - ); if !self.quiet { show!(USimpleError::new( 1, format!("cannot operate on dangling symlink {}", filename.quote()), )); } + if self.verbose { + println!( + "failed to change mode of {} from 0000 (---------) to 1500 (r-x-----T)", + filename.quote() + ); + } } else if !self.quiet { show!(USimpleError::new( 1, diff --git a/tests/by-util/test_chmod.rs b/tests/by-util/test_chmod.rs index feb756632..c5f731d7d 100644 --- a/tests/by-util/test_chmod.rs +++ b/tests/by-util/test_chmod.rs @@ -414,7 +414,7 @@ fn test_chmod_symlink_non_existing_file() { let non_existing = "test_chmod_symlink_non_existing_file"; let test_symlink = "test_chmod_symlink_non_existing_file_symlink"; let expected_stdout = &format!( - "failed to change mode of '{test_symlink}' from 0000 (---------) to 0000 (---------)" + "failed to change mode of '{test_symlink}' from 0000 (---------) to 1500 (r-x-----T)" ); let expected_stderr = &format!("cannot operate on dangling symlink '{test_symlink}'"); @@ -442,6 +442,17 @@ fn test_chmod_symlink_non_existing_file() { .code_is(1) .no_stderr() .stdout_contains(expected_stdout); + + // this should only include the dangling symlink message + // NOT the failure to change mode + scene + .ucmd() + .arg("755") + .arg(test_symlink) + .run() + .code_is(1) + .no_stdout() + .stderr_contains(expected_stderr); } #[test] @@ -616,7 +627,7 @@ fn test_chmod_file_symlink_after_non_existing_file() { let non_existing = "test_chmod_symlink_non_existing_file"; let test_dangling_symlink = "test_chmod_symlink_non_existing_file_symlink"; let expected_stdout = &format!( - "failed to change mode of '{test_dangling_symlink}' from 0000 (---------) to 0000 (---------)" + "failed to change mode of '{test_dangling_symlink}' from 0000 (---------) to 1500 (r-x-----T)" ); let expected_stderr = &format!("cannot operate on dangling symlink '{test_dangling_symlink}'"); From 7cfeba0d22e60a8b69ad690635cef02fcdd8f6d2 Mon Sep 17 00:00:00 2001 From: Cheng-Hao Date: Mon, 20 Feb 2023 16:29:20 -0800 Subject: [PATCH 27/39] mkdir: move help strings to markdown file --- src/uu/mkdir/mkdir.md | 11 +++++++++++ src/uu/mkdir/src/mkdir.rs | 9 ++++----- 2 files changed, 15 insertions(+), 5 deletions(-) create mode 100644 src/uu/mkdir/mkdir.md diff --git a/src/uu/mkdir/mkdir.md b/src/uu/mkdir/mkdir.md new file mode 100644 index 000000000..79deafc46 --- /dev/null +++ b/src/uu/mkdir/mkdir.md @@ -0,0 +1,11 @@ +# mkdir + +``` +mkdir [OPTION]... [USER] +``` + +Create the given DIRECTORY(ies) if they do not exist + +## Long Usage + +Each MODE is of the form '[ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=]?[0-7]+'. diff --git a/src/uu/mkdir/src/mkdir.rs b/src/uu/mkdir/src/mkdir.rs index 9aced8ba5..ab92e7e74 100644 --- a/src/uu/mkdir/src/mkdir.rs +++ b/src/uu/mkdir/src/mkdir.rs @@ -18,14 +18,13 @@ use uucore::error::{UResult, USimpleError}; #[cfg(not(windows))] use uucore::mode; use uucore::{display::Quotable, fs::dir_strip_dot_for_creation}; -use uucore::{format_usage, show, show_if_err}; +use uucore::{format_usage, help_about, help_section, help_usage, show, show_if_err}; static DEFAULT_PERM: u32 = 0o755; -const ABOUT: &str = "Create the given DIRECTORY(ies) if they do not exist"; -const USAGE: &str = "{} [OPTION]... [USER]"; -const LONG_USAGE: &str = - "Each MODE is of the form '[ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=]?[0-7]+'."; +const ABOUT: &str = help_about!("mkdir.md"); +const USAGE: &str = help_usage!("mkdir.md"); +const LONG_USAGE: &str = help_section!("long usage", "mkdir.md"); mod options { pub const MODE: &str = "mode"; From 4e7ae2d46a8550e7bd372a80449662fd646e895e Mon Sep 17 00:00:00 2001 From: papparapa <37232476+papparapa@users.noreply.github.com> Date: Wed, 22 Feb 2023 00:51:59 +0900 Subject: [PATCH 28/39] du: move help strings to markdown file (#4384) --- src/uu/du/du.md | 24 ++++++++++++++++++++++++ src/uu/du/src/du.rs | 28 +++++++--------------------- 2 files changed, 31 insertions(+), 21 deletions(-) create mode 100644 src/uu/du/du.md diff --git a/src/uu/du/du.md b/src/uu/du/du.md new file mode 100644 index 000000000..6f154d047 --- /dev/null +++ b/src/uu/du/du.md @@ -0,0 +1,24 @@ +# du + +``` +du [OPTION]... [FILE]... +du [OPTION]... --files0-from=F +``` + +Estimate file space usage + +## After Help + +Display values are in units of the first available SIZE from --block-size, +and the DU_BLOCK_SIZE, BLOCK_SIZE and BLOCKSIZE environment variables. +Otherwise, units default to 1024 bytes (or 512 if POSIXLY_CORRECT is set). + +SIZE is an integer and optional unit (example: 10M is 10*1024*1024). +Units are K, M, G, T, P, E, Z, Y (powers of 1024) or KB, MB,... (powers +of 1000). + +PATTERN allows some advanced exclusions. For example, the following syntaxes +are supported: +? will match only one character +* will match zero or more characters +{a,b} will match a or b diff --git a/src/uu/du/src/du.rs b/src/uu/du/src/du.rs index a204adf4d..c35bbf119 100644 --- a/src/uu/du/src/du.rs +++ b/src/uu/du/src/du.rs @@ -36,7 +36,9 @@ use uucore::error::FromIo; use uucore::error::{UError, UResult}; use uucore::parse_glob; use uucore::parse_size::{parse_size, ParseSizeError}; -use uucore::{crash, format_usage, show, show_error, show_warning}; +use uucore::{ + crash, format_usage, help_about, help_section, help_usage, show, show_error, show_warning, +}; #[cfg(windows)] use windows_sys::Win32::Foundation::HANDLE; #[cfg(windows)] @@ -73,25 +75,9 @@ mod options { pub const FILE: &str = "FILE"; } -const ABOUT: &str = "Estimate file space usage"; -const LONG_HELP: &str = " -Display values are in units of the first available SIZE from --block-size, -and the DU_BLOCK_SIZE, BLOCK_SIZE and BLOCKSIZE environment variables. -Otherwise, units default to 1024 bytes (or 512 if POSIXLY_CORRECT is set). - -SIZE is an integer and optional unit (example: 10M is 10*1024*1024). -Units are K, M, G, T, P, E, Z, Y (powers of 1024) or KB, MB,... (powers -of 1000). - -PATTERN allows some advanced exclusions. For example, the following syntaxes -are supported: -? will match only one character -* will match zero or more characters -{a,b} will match a or b -"; -const USAGE: &str = "\ - {} [OPTION]... [FILE]... - {} [OPTION]... --files0-from=F"; +const ABOUT: &str = help_about!("du.md"); +const AFTER_HELP: &str = help_section!("after help", "du.md"); +const USAGE: &str = help_usage!("du.md"); // TODO: Support Z & Y (currently limited by size of u64) const UNITS: [(char, u32); 6] = [('E', 6), ('P', 5), ('T', 4), ('G', 3), ('M', 2), ('K', 1)]; @@ -705,7 +691,7 @@ pub fn uu_app() -> Command { Command::new(uucore::util_name()) .version(crate_version!()) .about(ABOUT) - .after_help(LONG_HELP) + .after_help(AFTER_HELP) .override_usage(format_usage(USAGE)) .infer_long_args(true) .disable_help_flag(true) From e6fec39db136014d64bc0ddecf464424ecb764a8 Mon Sep 17 00:00:00 2001 From: Cheng-Hao Date: Tue, 21 Feb 2023 11:05:35 -0800 Subject: [PATCH 29/39] mkdir: update markdown naming for consistency --- src/uu/mkdir/mkdir.md | 2 +- src/uu/mkdir/src/mkdir.rs | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/uu/mkdir/mkdir.md b/src/uu/mkdir/mkdir.md index 79deafc46..1a6041a7e 100644 --- a/src/uu/mkdir/mkdir.md +++ b/src/uu/mkdir/mkdir.md @@ -6,6 +6,6 @@ mkdir [OPTION]... [USER] Create the given DIRECTORY(ies) if they do not exist -## Long Usage +## After Help Each MODE is of the form '[ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=]?[0-7]+'. diff --git a/src/uu/mkdir/src/mkdir.rs b/src/uu/mkdir/src/mkdir.rs index ab92e7e74..9f490ecf9 100644 --- a/src/uu/mkdir/src/mkdir.rs +++ b/src/uu/mkdir/src/mkdir.rs @@ -24,7 +24,7 @@ static DEFAULT_PERM: u32 = 0o755; const ABOUT: &str = help_about!("mkdir.md"); const USAGE: &str = help_usage!("mkdir.md"); -const LONG_USAGE: &str = help_section!("long usage", "mkdir.md"); +const AFTER_HELP: &str = help_section!("after help", "mkdir.md"); mod options { pub const MODE: &str = "mode"; @@ -89,7 +89,7 @@ pub fn uumain(args: impl uucore::Args) -> UResult<()> { // Linux-specific options, not implemented // opts.optflag("Z", "context", "set SELinux security context" + // " of each created directory to CTX"), - let matches = uu_app().after_help(LONG_USAGE).try_get_matches_from(args)?; + let matches = uu_app().after_help(AFTER_HELP).try_get_matches_from(args)?; let dirs = matches .get_many::(options::DIRS) From 7d7b9eb49ac634c9758b1143d64643fc463c96bd Mon Sep 17 00:00:00 2001 From: "Guilherme A. de Souza" <125218612+rgasnix@users.noreply.github.com> Date: Tue, 21 Feb 2023 17:52:18 -0300 Subject: [PATCH 30/39] Migrate from `atty` to `is-terminal` (#4382) --- Cargo.lock | 162 ++++++++++++++++++++++++++----------- Cargo.toml | 4 +- deny.toml | 14 +++- src/uu/cat/Cargo.toml | 2 +- src/uu/cat/src/cat.rs | 3 +- src/uu/cut/Cargo.toml | 2 +- src/uu/cut/src/cut.rs | 3 +- src/uu/ls/Cargo.toml | 2 +- src/uu/ls/src/ls.rs | 9 ++- src/uu/more/Cargo.toml | 2 +- src/uu/more/src/more.rs | 3 +- src/uu/nohup/Cargo.toml | 2 +- src/uu/nohup/src/nohup.rs | 7 +- src/uu/tail/Cargo.toml | 2 +- src/uu/tail/src/args.rs | 4 +- src/uu/tty/Cargo.toml | 2 +- src/uu/tty/src/tty.rs | 3 +- tests/by-util/test_more.rs | 5 +- 18 files changed, 161 insertions(+), 70 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index fd2385a64..8742a8092 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -67,7 +67,7 @@ version = "0.2.14" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d9b39be18770d11421cdb1b9947a45dd3f37e93092cbf377614828a319d5fee8" dependencies = [ - "hermit-abi", + "hermit-abi 0.1.19", "libc", "winapi", ] @@ -293,7 +293,7 @@ dependencies = [ "lazy_static", "libc", "unicode-width", - "windows-sys", + "windows-sys 0.42.0", ] [[package]] @@ -321,7 +321,6 @@ checksum = "5827cebf4670468b8772dd191856768aedcb1b0278a04f989f7766351917b9dc" name = "coreutils" version = "0.0.17" dependencies = [ - "atty", "chrono", "clap", "clap_complete", @@ -329,6 +328,7 @@ dependencies = [ "filetime", "glob", "hex-literal", + "is-terminal", "libc", "nix", "once_cell", @@ -635,7 +635,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "1631ca6e3c59112501a9d87fd86f21591ff77acd31331e8a73f8d80a65bbdd71" dependencies = [ "nix", - "windows-sys", + "windows-sys 0.42.0", ] [[package]] @@ -834,7 +834,7 @@ dependencies = [ "cfg-if", "libc", "redox_syscall", - "windows-sys", + "windows-sys 0.42.0", ] [[package]] @@ -1045,6 +1045,12 @@ dependencies = [ "libc", ] +[[package]] +name = "hermit-abi" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fed44880c466736ef9a5c5b5facefb5ed0785676d0c02d612db14e54f0d84286" + [[package]] name = "hex" version = "0.4.3" @@ -1139,6 +1145,28 @@ version = "0.7.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "59ce5ef949d49ee85593fc4d3f3f95ad61657076395cbbce23e2121fc5542074" +[[package]] +name = "io-lifetimes" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1abeb7a0dd0f8181267ff8adc397075586500b81b28a73e8a0208b00fc170fb3" +dependencies = [ + "libc", + "windows-sys 0.45.0", +] + +[[package]] +name = "is-terminal" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "22e18b0a45d56fe973d6db23972bf5bc46f988a4a2385deac9cc29572f09daef" +dependencies = [ + "hermit-abi 0.3.1", + "io-lifetimes 1.0.5", + "rustix 0.36.8", + "windows-sys 0.45.0", +] + [[package]] name = "itertools" version = "0.10.5" @@ -1235,6 +1263,12 @@ version = "0.0.46" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d4d2456c373231a208ad294c33dc5bff30051eafd954cd4caae83a712b12854d" +[[package]] +name = "linux-raw-sys" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f051f77a7c8e6957c0696eac88f26b0117e54f52d3fc682ab19397a8812846a4" + [[package]] name = "lock_api" version = "0.4.9" @@ -1326,7 +1360,7 @@ dependencies = [ "libc", "log", "wasi", - "windows-sys", + "windows-sys 0.42.0", ] [[package]] @@ -1415,7 +1449,7 @@ version = "1.14.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "f6058e64324c71e02bc2b150e4f3bc8286db6c83092132ffa3f6b1eab0f9def5" dependencies = [ - "hermit-abi", + "hermit-abi 0.1.19", "libc", ] @@ -1545,7 +1579,7 @@ dependencies = [ "libc", "redox_syscall", "smallvec", - "windows-sys", + "windows-sys 0.42.0", ] [[package]] @@ -1693,7 +1727,7 @@ dependencies = [ "byteorder", "hex", "lazy_static", - "rustix", + "rustix 0.35.13", ] [[package]] @@ -1899,10 +1933,24 @@ checksum = "727a1a6d65f786ec22df8a81ca3121107f235970dc1705ed681d3e6e8b9cd5f9" dependencies = [ "bitflags", "errno", - "io-lifetimes", + "io-lifetimes 0.7.5", "libc", - "linux-raw-sys", - "windows-sys", + "linux-raw-sys 0.0.46", + "windows-sys 0.42.0", +] + +[[package]] +name = "rustix" +version = "0.36.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f43abb88211988493c1abb44a70efa56ff0ce98f233b7b276146f1f3f7ba9644" +dependencies = [ + "bitflags", + "errno", + "io-lifetimes 1.0.5", + "libc", + "linux-raw-sys 0.1.4", + "windows-sys 0.45.0", ] [[package]] @@ -2161,8 +2209,8 @@ version = "0.2.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "40ca90c434fd12083d1a6bdcbe9f92a14f96c8a1ba600ba451734ac334521f7a" dependencies = [ - "rustix", - "windows-sys", + "rustix 0.35.13", + "windows-sys 0.42.0", ] [[package]] @@ -2334,8 +2382,8 @@ dependencies = [ name = "uu_cat" version = "0.0.17" dependencies = [ - "atty", "clap", + "is-terminal", "nix", "thiserror", "uucore", @@ -2432,9 +2480,9 @@ dependencies = [ name = "uu_cut" version = "0.0.17" dependencies = [ - "atty", "bstr", "clap", + "is-terminal", "memchr", "uucore", ] @@ -2447,7 +2495,7 @@ dependencies = [ "clap", "libc", "uucore", - "windows-sys", + "windows-sys 0.42.0", ] [[package]] @@ -2503,7 +2551,7 @@ dependencies = [ "clap", "glob", "uucore", - "windows-sys", + "windows-sys 0.42.0", ] [[package]] @@ -2634,7 +2682,7 @@ dependencies = [ "clap", "hostname", "uucore", - "windows-sys", + "windows-sys 0.42.0", ] [[package]] @@ -2705,10 +2753,10 @@ dependencies = [ name = "uu_ls" version = "0.0.17" dependencies = [ - "atty", "chrono", "clap", "glob", + "is-terminal", "lscolors", "number_prefix", "once_cell", @@ -2759,9 +2807,9 @@ dependencies = [ name = "uu_more" version = "0.0.17" dependencies = [ - "atty", "clap", "crossterm", + "is-terminal", "nix", "unicode-segmentation", "unicode-width", @@ -2801,8 +2849,8 @@ dependencies = [ name = "uu_nohup" version = "0.0.17" dependencies = [ - "atty", "clap", + "is-terminal", "libc", "uucore", ] @@ -2936,7 +2984,7 @@ dependencies = [ "libc", "uucore", "walkdir", - "windows-sys", + "windows-sys 0.42.0", ] [[package]] @@ -3079,7 +3127,7 @@ dependencies = [ "libc", "nix", "uucore", - "windows-sys", + "windows-sys 0.42.0", ] [[package]] @@ -3097,16 +3145,16 @@ dependencies = [ name = "uu_tail" version = "0.0.17" dependencies = [ - "atty", "clap", "fundu", + "is-terminal", "libc", "memchr", "notify", "same-file", "uucore", "winapi-util", - "windows-sys", + "windows-sys 0.42.0", ] [[package]] @@ -3146,7 +3194,7 @@ dependencies = [ "filetime", "time", "uucore", - "windows-sys", + "windows-sys 0.42.0", ] [[package]] @@ -3186,8 +3234,8 @@ dependencies = [ name = "uu_tty" version = "0.0.17" dependencies = [ - "atty", "clap", + "is-terminal", "nix", "uucore", ] @@ -3282,7 +3330,7 @@ dependencies = [ "clap", "libc", "uucore", - "windows-sys", + "windows-sys 0.42.0", ] [[package]] @@ -3316,7 +3364,7 @@ dependencies = [ "walkdir", "wild", "winapi-util", - "windows-sys", + "windows-sys 0.42.0", "z85", ] @@ -3478,46 +3526,70 @@ dependencies = [ ] [[package]] -name = "windows_aarch64_gnullvm" -version = "0.42.0" +name = "windows-sys" +version = "0.45.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "41d2aa71f6f0cbe00ae5167d90ef3cfe66527d6f613ca78ac8024c3ccab9a19e" +checksum = "75283be5efb2831d37ea142365f009c02ec203cd29a3ebecbc093d52315b66d0" +dependencies = [ + "windows-targets", +] + +[[package]] +name = "windows-targets" +version = "0.42.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e2522491fbfcd58cc84d47aeb2958948c4b8982e9a2d8a2a35bbaed431390e7" +dependencies = [ + "windows_aarch64_gnullvm", + "windows_aarch64_msvc", + "windows_i686_gnu", + "windows_i686_msvc", + "windows_x86_64_gnu", + "windows_x86_64_gnullvm", + "windows_x86_64_msvc", +] + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.42.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8c9864e83243fdec7fc9c5444389dcbbfd258f745e7853198f365e3c4968a608" [[package]] name = "windows_aarch64_msvc" -version = "0.42.0" +version = "0.42.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dd0f252f5a35cac83d6311b2e795981f5ee6e67eb1f9a7f64eb4500fbc4dcdb4" +checksum = "4c8b1b673ffc16c47a9ff48570a9d85e25d265735c503681332589af6253c6c7" [[package]] name = "windows_i686_gnu" -version = "0.42.0" +version = "0.42.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fbeae19f6716841636c28d695375df17562ca208b2b7d0dc47635a50ae6c5de7" +checksum = "de3887528ad530ba7bdbb1faa8275ec7a1155a45ffa57c37993960277145d640" [[package]] name = "windows_i686_msvc" -version = "0.42.0" +version = "0.42.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "84c12f65daa39dd2babe6e442988fc329d6243fdce47d7d2d155b8d874862246" +checksum = "bf4d1122317eddd6ff351aa852118a2418ad4214e6613a50e0191f7004372605" [[package]] name = "windows_x86_64_gnu" -version = "0.42.0" +version = "0.42.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bf7b1b21b5362cbc318f686150e5bcea75ecedc74dd157d874d754a2ca44b0ed" +checksum = "c1040f221285e17ebccbc2591ffdc2d44ee1f9186324dd3e84e99ac68d699c45" [[package]] name = "windows_x86_64_gnullvm" -version = "0.42.0" +version = "0.42.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "09d525d2ba30eeb3297665bd434a54297e4170c7f1a44cad4ef58095b4cd2028" +checksum = "628bfdf232daa22b0d64fdb62b09fcc36bb01f05a3939e20ab73aaf9470d0463" [[package]] name = "windows_x86_64_msvc" -version = "0.42.0" +version = "0.42.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f40009d85759725a34da6d89a94e63d7bdc50a862acf0dbc7c8e488f1edcb6f5" +checksum = "447660ad36a13288b1db4d4248e857b510e8c3a225c822ba4fb748c0aafecffd" [[package]] name = "xattr" diff --git a/Cargo.toml b/Cargo.toml index ebd8685ca..61d6db205 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -263,7 +263,6 @@ feat_os_windows_legacy = [ test = [ "uu_test" ] [workspace.dependencies] -atty = "0.2" bigdecimal = "0.3" binary-heap-plus = "0.5.0" bstr = "1.0" @@ -287,6 +286,7 @@ gcd = "2.2" glob = "0.3.0" half = "2.1" indicatif = "0.17" +is-terminal = "0.4.3" itertools = "0.10.0" libc = "0.2.139" lscolors = { version = "0.13.0", default-features=false, features = ["nu-ansi-term"] } @@ -476,7 +476,7 @@ time = { workspace=true, features=["local-offset"] } unindent = "0.1" uucore = { workspace=true, features=["entries", "process", "signals"] } walkdir = { workspace=true } -atty = { workspace=true } +is-terminal = { workspace=true } hex-literal = "0.3.1" rstest = "0.16.0" diff --git a/deny.toml b/deny.toml index 20995c936..aa05cdf3e 100644 --- a/deny.toml +++ b/deny.toml @@ -58,12 +58,24 @@ highlight = "all" # For each duplicate dependency, indicate the name of the dependency which # introduces it. # spell-checker: disable -skip = [] +skip = [ + # is-terminal + { name = "hermit-abi", version = "0.3.1" }, + # is-terminal + { name = "rustix", version = "0.36.8" }, + # is-terminal (via rustix) + { name = "io-lifetimes", version = "1.0.5" }, + # is-terminal + { name = "linux-raw-sys", version = "0.1.4" }, + # is-terminal + { name = "windows-sys", version = "0.45.0" }, +] # spell-checker: enable # This section is considered when running `cargo deny check sources`. # More documentation about the 'sources' section can be found here: # https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html + [sources] unknown-registry = "warn" unknown-git = "warn" diff --git a/src/uu/cat/Cargo.toml b/src/uu/cat/Cargo.toml index e707c6db0..fbf91c249 100644 --- a/src/uu/cat/Cargo.toml +++ b/src/uu/cat/Cargo.toml @@ -17,7 +17,7 @@ path = "src/cat.rs" [dependencies] clap = { workspace=true } thiserror = { workspace = true } -atty = { workspace=true } +is-terminal = { workspace = true } uucore = { workspace=true, features=["fs", "pipes"] } [target.'cfg(unix)'.dependencies] diff --git a/src/uu/cat/src/cat.rs b/src/uu/cat/src/cat.rs index 85a626d5b..e90bdd116 100644 --- a/src/uu/cat/src/cat.rs +++ b/src/uu/cat/src/cat.rs @@ -12,6 +12,7 @@ // last synced with: cat (GNU coreutils) 8.13 use clap::{crate_version, Arg, ArgAction, Command}; +use is_terminal::IsTerminal; use std::fs::{metadata, File}; use std::io::{self, Read, Write}; use thiserror::Error; @@ -332,7 +333,7 @@ fn cat_path( let stdin = io::stdin(); let mut handle = InputHandle { reader: stdin, - is_interactive: atty::is(atty::Stream::Stdin), + is_interactive: std::io::stdin().is_terminal(), }; cat_handle(&mut handle, options, state) } diff --git a/src/uu/cut/Cargo.toml b/src/uu/cut/Cargo.toml index f680b67e5..8a5e8f1d2 100644 --- a/src/uu/cut/Cargo.toml +++ b/src/uu/cut/Cargo.toml @@ -19,7 +19,7 @@ clap = { workspace=true } uucore = { workspace=true } memchr = { workspace=true } bstr = { workspace=true } -atty = { workspace=true } +is-terminal = { workspace=true } [[bin]] name = "cut" diff --git a/src/uu/cut/src/cut.rs b/src/uu/cut/src/cut.rs index 9db114fb2..105449cbc 100644 --- a/src/uu/cut/src/cut.rs +++ b/src/uu/cut/src/cut.rs @@ -9,6 +9,7 @@ use bstr::io::BufReadExt; use clap::{crate_version, Arg, ArgAction, Command}; +use is_terminal::IsTerminal; use std::fs::File; use std::io::{stdin, stdout, BufReader, BufWriter, Read, Write}; use std::path::Path; @@ -136,7 +137,7 @@ enum Mode { } fn stdout_writer() -> Box { - if atty::is(atty::Stream::Stdout) { + if std::io::stdout().is_terminal() { Box::new(stdout()) } else { Box::new(BufWriter::new(stdout())) as Box diff --git a/src/uu/ls/Cargo.toml b/src/uu/ls/Cargo.toml index ade9c5e29..7c7add294 100644 --- a/src/uu/ls/Cargo.toml +++ b/src/uu/ls/Cargo.toml @@ -25,7 +25,7 @@ glob = { workspace=true } lscolors = { workspace=true } uucore = { workspace=true, features = ["entries", "fs"] } once_cell = { workspace=true } -atty = { workspace=true } +is-terminal = { workspace=true } selinux = { workspace=true, optional = true } [[bin]] diff --git a/src/uu/ls/src/ls.rs b/src/uu/ls/src/ls.rs index 965248495..abf05676f 100644 --- a/src/uu/ls/src/ls.rs +++ b/src/uu/ls/src/ls.rs @@ -12,6 +12,7 @@ use clap::{ crate_version, Arg, ArgAction, Command, }; use glob::{MatchOptions, Pattern}; +use is_terminal::IsTerminal; use lscolors::LsColors; use number_prefix::NumberPrefix; use once_cell::unsync::OnceCell; @@ -451,7 +452,7 @@ impl Config { (Format::Commas, Some(options::format::COMMAS)) } else if options.get_flag(options::format::COLUMNS) { (Format::Columns, Some(options::format::COLUMNS)) - } else if atty::is(atty::Stream::Stdout) { + } else if std::io::stdout().is_terminal() { (Format::Columns, None) } else { (Format::OneLine, None) @@ -557,7 +558,7 @@ impl Config { None => options.contains_id(options::COLOR), Some(val) => match val.as_str() { "" | "always" | "yes" | "force" => true, - "auto" | "tty" | "if-tty" => atty::is(atty::Stream::Stdout), + "auto" | "tty" | "if-tty" => std::io::stdout().is_terminal(), /* "never" | "no" | "none" | */ _ => false, }, }; @@ -678,7 +679,7 @@ impl Config { } else if options.get_flag(options::SHOW_CONTROL_CHARS) { true } else { - !atty::is(atty::Stream::Stdout) + !std::io::stdout().is_terminal() }; let opt_quoting_style = options @@ -750,7 +751,7 @@ impl Config { "never" | "no" | "none" => IndicatorStyle::None, "always" | "yes" | "force" => IndicatorStyle::Classify, "auto" | "tty" | "if-tty" => { - if atty::is(atty::Stream::Stdout) { + if std::io::stdout().is_terminal() { IndicatorStyle::Classify } else { IndicatorStyle::None diff --git a/src/uu/more/Cargo.toml b/src/uu/more/Cargo.toml index 416a2359b..01bb96183 100644 --- a/src/uu/more/Cargo.toml +++ b/src/uu/more/Cargo.toml @@ -18,7 +18,7 @@ path = "src/more.rs" clap = { workspace=true } uucore = { workspace=true } crossterm = { workspace=true } -atty = { workspace=true } +is-terminal = { workspace=true } unicode-width = { workspace=true } unicode-segmentation = { workspace=true } diff --git a/src/uu/more/src/more.rs b/src/uu/more/src/more.rs index 0309ad33e..31b1640a2 100644 --- a/src/uu/more/src/more.rs +++ b/src/uu/more/src/more.rs @@ -23,6 +23,7 @@ use crossterm::{ terminal, }; +use is_terminal::IsTerminal; use unicode_segmentation::UnicodeSegmentation; use unicode_width::UnicodeWidthStr; use uucore::display::Quotable; @@ -83,7 +84,7 @@ pub fn uumain(args: impl uucore::Args) -> UResult<()> { buff.clear(); } reset_term(&mut stdout); - } else if atty::isnt(atty::Stream::Stdin) { + } else if !std::io::stdin().is_terminal() { stdin().read_to_string(&mut buff).unwrap(); let mut stdout = setup_term(); more(&buff, &mut stdout, None, silent)?; diff --git a/src/uu/nohup/Cargo.toml b/src/uu/nohup/Cargo.toml index 9a6b4af43..f35869506 100644 --- a/src/uu/nohup/Cargo.toml +++ b/src/uu/nohup/Cargo.toml @@ -17,7 +17,7 @@ path = "src/nohup.rs" [dependencies] clap = { workspace=true } libc = { workspace=true } -atty = { workspace=true } +is-terminal = { workspace=true } uucore = { workspace=true, features=["fs"] } [[bin]] diff --git a/src/uu/nohup/src/nohup.rs b/src/uu/nohup/src/nohup.rs index 789888ea4..d00ef4931 100644 --- a/src/uu/nohup/src/nohup.rs +++ b/src/uu/nohup/src/nohup.rs @@ -8,6 +8,7 @@ // spell-checker:ignore (ToDO) execvp SIGHUP cproc vprocmgr cstrs homeout use clap::{crate_version, Arg, ArgAction, Command}; +use is_terminal::IsTerminal; use libc::{c_char, dup2, execvp, signal}; use libc::{SIGHUP, SIG_IGN}; use std::env; @@ -129,7 +130,7 @@ pub fn uu_app() -> Command { } fn replace_fds() -> UResult<()> { - if atty::is(atty::Stream::Stdin) { + if std::io::stdin().is_terminal() { let new_stdin = File::open(Path::new("/dev/null")) .map_err(|e| NohupError::CannotReplace("STDIN", e))?; if unsafe { dup2(new_stdin.as_raw_fd(), 0) } != 0 { @@ -137,7 +138,7 @@ fn replace_fds() -> UResult<()> { } } - if atty::is(atty::Stream::Stdout) { + if std::io::stdout().is_terminal() { let new_stdout = find_stdout()?; let fd = new_stdout.as_raw_fd(); @@ -146,7 +147,7 @@ fn replace_fds() -> UResult<()> { } } - if atty::is(atty::Stream::Stderr) && unsafe { dup2(1, 2) } != 2 { + if std::io::stderr().is_terminal() && unsafe { dup2(1, 2) } != 2 { return Err(NohupError::CannotReplace("STDERR", Error::last_os_error()).into()); } Ok(()) diff --git a/src/uu/tail/Cargo.toml b/src/uu/tail/Cargo.toml index bd16132ea..88b82a8e6 100644 --- a/src/uu/tail/Cargo.toml +++ b/src/uu/tail/Cargo.toml @@ -22,7 +22,7 @@ memchr = { workspace=true } notify = { workspace=true } uucore = { workspace=true } same-file = { workspace=true } -atty = { workspace=true } +is-terminal = { workspace=true } fundu = { workspace=true } [target.'cfg(windows)'.dependencies] diff --git a/src/uu/tail/src/args.rs b/src/uu/tail/src/args.rs index bfc314185..0807aa912 100644 --- a/src/uu/tail/src/args.rs +++ b/src/uu/tail/src/args.rs @@ -7,10 +7,10 @@ use crate::paths::Input; use crate::{parse, platform, Quotable}; -use atty::Stream; use clap::crate_version; use clap::{parser::ValueSource, Arg, ArgAction, ArgMatches, Command}; use fundu::DurationParser; +use is_terminal::IsTerminal; use same_file::Handle; use std::collections::VecDeque; use std::ffi::OsString; @@ -274,7 +274,7 @@ impl Settings { .map_or(false, |meta| !meta.is_file()) }); - if !blocking_stdin && atty::is(Stream::Stdin) { + if !blocking_stdin && std::io::stdin().is_terminal() { show_warning!("following standard input indefinitely is ineffective"); } } diff --git a/src/uu/tty/Cargo.toml b/src/uu/tty/Cargo.toml index 34eb84570..ee7fe559b 100644 --- a/src/uu/tty/Cargo.toml +++ b/src/uu/tty/Cargo.toml @@ -17,7 +17,7 @@ path = "src/tty.rs" [dependencies] clap = { workspace=true } nix = { workspace=true, features=["term"] } -atty = { workspace=true } +is-terminal = { workspace=true } uucore = { workspace=true, features=["fs"] } [[bin]] diff --git a/src/uu/tty/src/tty.rs b/src/uu/tty/src/tty.rs index ad41c323c..e3fc0451e 100644 --- a/src/uu/tty/src/tty.rs +++ b/src/uu/tty/src/tty.rs @@ -10,6 +10,7 @@ // spell-checker:ignore (ToDO) ttyname filedesc use clap::{crate_version, Arg, ArgAction, Command}; +use is_terminal::IsTerminal; use std::io::Write; use std::os::unix::io::AsRawFd; use uucore::error::{set_exit_code, UResult}; @@ -30,7 +31,7 @@ pub fn uumain(args: impl uucore::Args) -> UResult<()> { // If silent, we don't need the name, only whether or not stdin is a tty. if silent { - return if atty::is(atty::Stream::Stdin) { + return if std::io::stdin().is_terminal() { Ok(()) } else { Err(1.into()) diff --git a/tests/by-util/test_more.rs b/tests/by-util/test_more.rs index 5c2b3c0f6..b3a1522f6 100644 --- a/tests/by-util/test_more.rs +++ b/tests/by-util/test_more.rs @@ -1,9 +1,10 @@ use crate::common::util::*; +use is_terminal::IsTerminal; #[test] fn test_more_no_arg() { // Reading from stdin is now supported, so this must succeed - if atty::is(atty::Stream::Stdout) { + if std::io::stdout().is_terminal() { new_ucmd!().succeeds(); } else { } @@ -14,7 +15,7 @@ fn test_more_dir_arg() { // Run the test only if there's a valid terminal, else do nothing // Maybe we could capture the error, i.e. "Device not found" in that case // but I am leaving this for later - if atty::is(atty::Stream::Stdout) { + if std::io::stdout().is_terminal() { new_ucmd!() .arg(".") .fails() From ddd40fda6b89f4bb20e7bfdaf607e7d4356aeb22 Mon Sep 17 00:00:00 2001 From: Chen Chi <114895836+ChenChiii@users.noreply.github.com> Date: Tue, 21 Feb 2023 15:56:52 -0800 Subject: [PATCH 31/39] sleep: move help strings to markdown file --- src/uu/sleep/sleep.md | 16 ++++++++++++++++ src/uu/sleep/src/sleep.rs | 16 +++++----------- 2 files changed, 21 insertions(+), 11 deletions(-) create mode 100644 src/uu/sleep/sleep.md diff --git a/src/uu/sleep/sleep.md b/src/uu/sleep/sleep.md new file mode 100644 index 000000000..0a9a39a19 --- /dev/null +++ b/src/uu/sleep/sleep.md @@ -0,0 +1,16 @@ +# sleep + +``` +sleep NUMBER[SUFFIX]... +sleep OPTION +``` + +Pause for NUMBER seconds. + +## After Help + +Pause for NUMBER seconds. SUFFIX may be 's' for seconds (the default), +'m' for minutes, 'h' for hours or 'd' for days. Unlike most implementations +that require NUMBER be an integer, here NUMBER may be an arbitrary floating +point number. Given two or more arguments, pause for the amount of time +specified by the sum of their values. \ No newline at end of file diff --git a/src/uu/sleep/src/sleep.rs b/src/uu/sleep/src/sleep.rs index eecdc0512..517fda098 100644 --- a/src/uu/sleep/src/sleep.rs +++ b/src/uu/sleep/src/sleep.rs @@ -10,20 +10,14 @@ use std::time::Duration; use uucore::{ error::{UResult, USimpleError, UUsageError}, - format_usage, show, + format_usage, help_about, help_section, help_usage, show, }; use clap::{crate_version, Arg, ArgAction, Command}; -static ABOUT: &str = "Pause for NUMBER seconds."; -const USAGE: &str = "\ - {} NUMBER[SUFFIX]... - {} OPTION"; -static LONG_HELP: &str = "Pause for NUMBER seconds. SUFFIX may be 's' for seconds (the default), -'m' for minutes, 'h' for hours or 'd' for days. Unlike most implementations -that require NUMBER be an integer, here NUMBER may be an arbitrary floating -point number. Given two or more arguments, pause for the amount of time -specified by the sum of their values."; +static ABOUT: &str = help_about!("sleep.md"); +const USAGE: &str = help_usage!("sleep.md"); +static AFTER_HELP: &str = help_section!("after help", "sleep.md"); mod options { pub const NUMBER: &str = "NUMBER"; @@ -54,7 +48,7 @@ pub fn uu_app() -> Command { Command::new(uucore::util_name()) .version(crate_version!()) .about(ABOUT) - .after_help(LONG_HELP) + .after_help(AFTER_HELP) .override_usage(format_usage(USAGE)) .infer_long_args(true) .arg( From ab5d0b6b9defe2160f5d4cdfd115fb3334c162f4 Mon Sep 17 00:00:00 2001 From: Cheng-Hao Date: Tue, 21 Feb 2023 18:28:35 -0800 Subject: [PATCH 32/39] rmdir: move help strings to markdown file --- src/uu/rmdir/rmdir.md | 7 +++++++ src/uu/rmdir/src/rmdir.rs | 6 +++--- 2 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 src/uu/rmdir/rmdir.md diff --git a/src/uu/rmdir/rmdir.md b/src/uu/rmdir/rmdir.md new file mode 100644 index 000000000..16f7bf82b --- /dev/null +++ b/src/uu/rmdir/rmdir.md @@ -0,0 +1,7 @@ +# rmdir + +``` +rmdir [OPTION]... DIRECTORY... +``` + +Remove the DIRECTORY(ies), if they are empty. diff --git a/src/uu/rmdir/src/rmdir.rs b/src/uu/rmdir/src/rmdir.rs index 51240b5ad..9a864266a 100644 --- a/src/uu/rmdir/src/rmdir.rs +++ b/src/uu/rmdir/src/rmdir.rs @@ -16,10 +16,10 @@ use std::path::Path; use uucore::display::Quotable; use uucore::error::{set_exit_code, strip_errno, UResult}; -use uucore::{format_usage, show_error, util_name}; +use uucore::{format_usage, help_about, help_usage, show_error, util_name}; -static ABOUT: &str = "Remove the DIRECTORY(ies), if they are empty."; -const USAGE: &str = "{} [OPTION]... DIRECTORY..."; +static ABOUT: &str = help_about!("rmdir.md"); +const USAGE: &str = help_usage!("rmdir.md"); static OPT_IGNORE_FAIL_NON_EMPTY: &str = "ignore-fail-on-non-empty"; static OPT_PARENTS: &str = "parents"; static OPT_VERBOSE: &str = "verbose"; From 4cbf9a63987f84aeb7759016b4c36592d6e9a4b4 Mon Sep 17 00:00:00 2001 From: Cheng-Hao Date: Tue, 21 Feb 2023 18:50:47 -0800 Subject: [PATCH 33/39] rm: move help strings to markdown file --- src/uu/rm/rm.md | 22 ++++++++++++++++++++++ src/uu/rm/src/rm.rs | 22 +++++----------------- 2 files changed, 27 insertions(+), 17 deletions(-) create mode 100644 src/uu/rm/rm.md diff --git a/src/uu/rm/rm.md b/src/uu/rm/rm.md new file mode 100644 index 000000000..7acc46363 --- /dev/null +++ b/src/uu/rm/rm.md @@ -0,0 +1,22 @@ +# rm + +``` +rm [OPTION]... FILE... +``` + +Remove (unlink) the FILE(s) + +## After Help + +By default, rm does not remove directories. Use the --recursive (-r or -R) +option to remove each listed directory, too, along with all of its contents + +To remove a file whose name starts with a '-', for example '-foo', +use one of these commands: +rm -- -foo + +rm ./-foo + +Note that if you use rm to remove a file, it might be possible to recover +some of its contents, given sufficient expertise and/or time. For greater +assurance that the contents are truly unrecoverable, consider using shred. diff --git a/src/uu/rm/src/rm.rs b/src/uu/rm/src/rm.rs index 0d621355d..05d03cee2 100644 --- a/src/uu/rm/src/rm.rs +++ b/src/uu/rm/src/rm.rs @@ -15,7 +15,7 @@ use std::ops::BitOr; use std::path::{Path, PathBuf}; use uucore::display::Quotable; use uucore::error::{UResult, USimpleError, UUsageError}; -use uucore::{format_usage, prompt_yes, show_error}; +use uucore::{format_usage, help_about, help_section, help_usage, prompt_yes, show_error}; use walkdir::{DirEntry, WalkDir}; #[derive(Eq, PartialEq, Clone, Copy)] @@ -37,21 +37,9 @@ struct Options { verbose: bool, } -const ABOUT: &str = "Remove (unlink) the FILE(s)"; -const USAGE: &str = "{} [OPTION]... FILE..."; -const LONG_USAGE: &str = "\ -By default, rm does not remove directories. Use the --recursive (-r or -R) -option to remove each listed directory, too, along with all of its contents - -To remove a file whose name starts with a '-', for example '-foo', -use one of these commands: -rm -- -foo - -rm ./-foo - -Note that if you use rm to remove a file, it might be possible to recover -some of its contents, given sufficient expertise and/or time. For greater -assurance that the contents are truly unrecoverable, consider using shred."; +const ABOUT: &str = help_about!("rm.md"); +const USAGE: &str = help_usage!("rm.md"); +const AFTER_HELP: &str = help_section!("after help", "rm.md"); static OPT_DIR: &str = "dir"; static OPT_INTERACTIVE: &str = "interactive"; @@ -69,7 +57,7 @@ static ARG_FILES: &str = "files"; #[uucore::main] pub fn uumain(args: impl uucore::Args) -> UResult<()> { - let matches = uu_app().after_help(LONG_USAGE).try_get_matches_from(args)?; + let matches = uu_app().after_help(AFTER_HELP).try_get_matches_from(args)?; let files: Vec = matches .get_many::(ARG_FILES) From 52902f6e99b978468fca7dcc9aff2414ca2f8d1f Mon Sep 17 00:00:00 2001 From: Koki Ueha Date: Wed, 22 Feb 2023 10:41:49 +0000 Subject: [PATCH 34/39] nohup: move help strings to markdown file --- src/uu/nohup/nohup.md | 15 +++++++++++++++ src/uu/nohup/src/nohup.rs | 17 +++++------------ 2 files changed, 20 insertions(+), 12 deletions(-) create mode 100644 src/uu/nohup/nohup.md diff --git a/src/uu/nohup/nohup.md b/src/uu/nohup/nohup.md new file mode 100644 index 000000000..cc35ef9f4 --- /dev/null +++ b/src/uu/nohup/nohup.md @@ -0,0 +1,15 @@ +# nohup + +``` +nohup COMMAND [ARG]... +nohup FLAG +``` + +Run COMMAND ignoring hangup signals. + +## After Help + +If standard input is terminal, it'll be replaced with /dev/null. +If standard output is terminal, it'll be appended to nohup.out instead, +or $HOME/nohup.out, if nohup.out open failed. +If standard error is terminal, it'll be redirected to stdout. diff --git a/src/uu/nohup/src/nohup.rs b/src/uu/nohup/src/nohup.rs index d00ef4931..8247cdb3e 100644 --- a/src/uu/nohup/src/nohup.rs +++ b/src/uu/nohup/src/nohup.rs @@ -20,18 +20,11 @@ use std::os::unix::prelude::*; use std::path::{Path, PathBuf}; use uucore::display::Quotable; use uucore::error::{set_exit_code, UClapError, UError, UResult}; -use uucore::{format_usage, show_error}; +use uucore::{format_usage, help_about, help_section, help_usage, show_error}; -static ABOUT: &str = "Run COMMAND ignoring hangup signals."; -static LONG_HELP: &str = " -If standard input is terminal, it'll be replaced with /dev/null. -If standard output is terminal, it'll be appended to nohup.out instead, -or $HOME/nohup.out, if nohup.out open failed. -If standard error is terminal, it'll be redirected to stdout. -"; -const USAGE: &str = "\ - {} COMMAND [ARG]... - {} FLAG"; +const ABOUT: &str = help_about!("nohup.md"); +const AFTER_HELP: &str = help_section!("after help", "nohup.md"); +const USAGE: &str = help_usage!("nohup.md"); static NOHUP_OUT: &str = "nohup.out"; // exit codes that match the GNU implementation static EXIT_CANCELED: i32 = 125; @@ -116,7 +109,7 @@ pub fn uu_app() -> Command { Command::new(uucore::util_name()) .version(crate_version!()) .about(ABOUT) - .after_help(LONG_HELP) + .after_help(AFTER_HELP) .override_usage(format_usage(USAGE)) .arg( Arg::new(options::CMD) From ed30869b45d8f7a9149a8ec85c8d78f50f619701 Mon Sep 17 00:00:00 2001 From: Terts Diepraam Date: Wed, 22 Feb 2023 16:23:27 +0100 Subject: [PATCH 35/39] fix spell checker error in mkdir.md --- src/uu/mkdir/mkdir.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/uu/mkdir/mkdir.md b/src/uu/mkdir/mkdir.md index 1a6041a7e..8773d15f4 100644 --- a/src/uu/mkdir/mkdir.md +++ b/src/uu/mkdir/mkdir.md @@ -1,3 +1,4 @@ + # mkdir ``` From 29a25a6c8527ac5861a29504702228bb8eef32b8 Mon Sep 17 00:00:00 2001 From: papparapa <37232476+papparapa@users.noreply.github.com> Date: Thu, 23 Feb 2023 00:44:55 +0900 Subject: [PATCH 36/39] od: move help strings to markdown file (#4406) * od: move help strings to markdown file * od: fix the commented points --- src/uu/od/od.md | 49 ++++++++++++++++++++++++++++++++++++++++++ src/uu/od/src/od.rs | 52 +++++---------------------------------------- 2 files changed, 54 insertions(+), 47 deletions(-) create mode 100644 src/uu/od/od.md diff --git a/src/uu/od/od.md b/src/uu/od/od.md new file mode 100644 index 000000000..5cd9ac3b5 --- /dev/null +++ b/src/uu/od/od.md @@ -0,0 +1,49 @@ +# od + +``` +od [OPTION]... [--] [FILENAME]... +od [-abcdDefFhHiIlLoOsxX] [FILENAME] [[+][0x]OFFSET[.][b]] +od --traditional [OPTION]... [FILENAME] [[+][0x]OFFSET[.][b] [[+][0x]LABEL[.][b]]] +``` + +Dump files in octal and other formats + +## After Help + +Displays data in various human-readable formats. If multiple formats are +specified, the output will contain all formats in the order they appear on the +command line. Each format will be printed on a new line. Only the line +containing the first format will be prefixed with the offset. + +If no filename is specified, or it is "-", stdin will be used. After a "--", no +more options will be recognized. This allows for filenames starting with a "-". + +If a filename is a valid number which can be used as an offset in the second +form, you can force it to be recognized as a filename if you include an option +like "-j0", which is only valid in the first form. + +RADIX is one of o,d,x,n for octal, decimal, hexadecimal or none. + +BYTES is decimal by default, octal if prefixed with a "0", or hexadecimal if +prefixed with "0x". The suffixes b, KB, K, MB, M, GB, G, will multiply the +number with 512, 1000, 1024, 1000^2, 1024^2, 1000^3, 1024^3, 1000^2, 1024^2. + +OFFSET and LABEL are octal by default, hexadecimal if prefixed with "0x" or +decimal if a "." suffix is added. The "b" suffix will multiply with 512. + +TYPE contains one or more format specifications consisting of: + a for printable 7-bits ASCII + c for utf-8 characters or octal for undefined characters + d[SIZE] for signed decimal + f[SIZE] for floating point + o[SIZE] for octal + u[SIZE] for unsigned decimal + x[SIZE] for hexadecimal +SIZE is the number of bytes which can be the number 1, 2, 4, 8 or 16, + or C, I, S, L for 1, 2, 4, 8 bytes for integer types, + or F, D, L for 4, 8, 16 bytes for floating point. +Any type specification can have a "z" suffix, which will add a ASCII dump at + the end of the line. + +If an error occurred, a diagnostic message will be printed to stderr, and the +exit code will be non-zero. diff --git a/src/uu/od/src/od.rs b/src/uu/od/src/od.rs index ebcaa50ba..e41776ac4 100644 --- a/src/uu/od/src/od.rs +++ b/src/uu/od/src/od.rs @@ -44,57 +44,15 @@ use clap::ArgAction; use clap::{crate_version, parser::ValueSource, Arg, ArgMatches, Command}; use uucore::display::Quotable; use uucore::error::{UResult, USimpleError}; -use uucore::format_usage; use uucore::parse_size::ParseSizeError; -use uucore::show_error; -use uucore::show_warning; +use uucore::{format_usage, help_about, help_section, help_usage, show_error, show_warning}; const PEEK_BUFFER_SIZE: usize = 4; // utf-8 can be 4 bytes -static ABOUT: &str = "Dump files in octal and other formats"; +const ABOUT: &str = help_about!("od.md"); -static USAGE: &str = "\ - {} [OPTION]... [--] [FILENAME]... - {} [-abcdDefFhHiIlLoOsxX] [FILENAME] [[+][0x]OFFSET[.][b]] - {} --traditional [OPTION]... [FILENAME] [[+][0x]OFFSET[.][b] [[+][0x]LABEL[.][b]]]"; +const USAGE: &str = help_usage!("od.md"); -static LONG_HELP: &str = r#" -Displays data in various human-readable formats. If multiple formats are -specified, the output will contain all formats in the order they appear on the -command line. Each format will be printed on a new line. Only the line -containing the first format will be prefixed with the offset. - -If no filename is specified, or it is "-", stdin will be used. After a "--", no -more options will be recognized. This allows for filenames starting with a "-". - -If a filename is a valid number which can be used as an offset in the second -form, you can force it to be recognized as a filename if you include an option -like "-j0", which is only valid in the first form. - -RADIX is one of o,d,x,n for octal, decimal, hexadecimal or none. - -BYTES is decimal by default, octal if prefixed with a "0", or hexadecimal if -prefixed with "0x". The suffixes b, KB, K, MB, M, GB, G, will multiply the -number with 512, 1000, 1024, 1000^2, 1024^2, 1000^3, 1024^3, 1000^2, 1024^2. - -OFFSET and LABEL are octal by default, hexadecimal if prefixed with "0x" or -decimal if a "." suffix is added. The "b" suffix will multiply with 512. - -TYPE contains one or more format specifications consisting of: - a for printable 7-bits ASCII - c for utf-8 characters or octal for undefined characters - d[SIZE] for signed decimal - f[SIZE] for floating point - o[SIZE] for octal - u[SIZE] for unsigned decimal - x[SIZE] for hexadecimal -SIZE is the number of bytes which can be the number 1, 2, 4, 8 or 16, - or C, I, S, L for 1, 2, 4, 8 bytes for integer types, - or F, D, L for 4, 8, 16 bytes for floating point. -Any type specification can have a "z" suffix, which will add a ASCII dump at - the end of the line. - -If an error occurred, a diagnostic message will be printed to stderr, and the -exitcode will be non-zero."#; +const AFTER_HELP: &str = help_section!("after help", "od.md"); pub(crate) mod options { pub const HELP: &str = "help"; @@ -295,7 +253,7 @@ pub fn uu_app() -> Command { .version(crate_version!()) .about(ABOUT) .override_usage(format_usage(USAGE)) - .after_help(LONG_HELP) + .after_help(AFTER_HELP) .trailing_var_arg(true) .dont_delimit_trailing_values(true) .infer_long_args(true) From b70131f14891137d82dde824cf2832db189679ea Mon Sep 17 00:00:00 2001 From: zleyyij <75810274+zleyyij@users.noreply.github.com> Date: Wed, 22 Feb 2023 08:50:27 -0700 Subject: [PATCH 37/39] arch: move help strings to a markdown file (#4373) Co-authored-by: zleyyij --- src/uu/arch/arch.md | 14 ++++++++++++++ src/uu/arch/src/arch.rs | 5 +++-- 2 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 src/uu/arch/arch.md diff --git a/src/uu/arch/arch.md b/src/uu/arch/arch.md new file mode 100644 index 000000000..7225ede2d --- /dev/null +++ b/src/uu/arch/arch.md @@ -0,0 +1,14 @@ +# arch + +``` +arch +``` + + +Display machine architecture + + +## After Help + +Determine architecture name for current machine. + diff --git a/src/uu/arch/src/arch.rs b/src/uu/arch/src/arch.rs index 62a07159e..a2208d8b0 100644 --- a/src/uu/arch/src/arch.rs +++ b/src/uu/arch/src/arch.rs @@ -10,9 +10,10 @@ use platform_info::*; use clap::{crate_version, Command}; use uucore::error::{FromIo, UResult}; +use uucore::{help_about, help_section}; -static ABOUT: &str = "Display machine architecture"; -static SUMMARY: &str = "Determine architecture name for current machine."; +static ABOUT: &str = help_about!("arch.md"); +static SUMMARY: &str = help_section!("after help", "arch.md"); #[uucore::main] pub fn uumain(args: impl uucore::Args) -> UResult<()> { From dd216ee23eaee199165aac62902280d60265614c Mon Sep 17 00:00:00 2001 From: Benjamin Bara Date: Tue, 21 Feb 2023 07:05:44 +0100 Subject: [PATCH 38/39] utmpx: cast timeval fields to i64 --- src/uucore/src/lib/features/utmpx.rs | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/src/uucore/src/lib/features/utmpx.rs b/src/uucore/src/lib/features/utmpx.rs index ee8744721..599a02778 100644 --- a/src/uucore/src/lib/features/utmpx.rs +++ b/src/uucore/src/lib/features/utmpx.rs @@ -192,13 +192,9 @@ impl Utmpx { } /// A.K.A. ut.ut_tv pub fn login_time(&self) -> time::OffsetDateTime { - #[cfg(all(not(target_os = "freebsd"), not(target_vendor = "apple")))] - let ts_nanos: i128 = (self.inner.ut_tv.tv_sec as i64 * 1_000_000_000_i64 - + self.inner.ut_tv.tv_usec as i64 * 1_000_i64) - .into(); - #[cfg(any(target_os = "freebsd", target_vendor = "apple"))] - let ts_nanos: i128 = (self.inner.ut_tv.tv_sec * 1_000_000_000_i64 - + self.inner.ut_tv.tv_usec as i64 * 1_000_i64) + #[allow(clippy::unnecessary_cast)] + let ts_nanos: i128 = (1_000_000_000_i64 * self.inner.ut_tv.tv_sec as i64 + + 1_000_i64 * self.inner.ut_tv.tv_usec as i64) .into(); let local_offset = time::OffsetDateTime::now_local().unwrap().offset(); time::OffsetDateTime::from_unix_timestamp_nanos(ts_nanos) From a24da1d57539e68998d62c475f9c9a1119b28523 Mon Sep 17 00:00:00 2001 From: zleyyij <75810274+zleyyij@users.noreply.github.com> Date: Wed, 22 Feb 2023 13:02:39 -0700 Subject: [PATCH 39/39] basenc: Move strings to markdown file (#4417) basenc: moved help strings to markdown file --- src/uu/basenc/basenc.md | 12 ++++++++++++ src/uu/basenc/src/basenc.rs | 12 +++--------- 2 files changed, 15 insertions(+), 9 deletions(-) create mode 100644 src/uu/basenc/basenc.md diff --git a/src/uu/basenc/basenc.md b/src/uu/basenc/basenc.md new file mode 100644 index 000000000..17916bd4a --- /dev/null +++ b/src/uu/basenc/basenc.md @@ -0,0 +1,12 @@ +# basenc + +``` +basenc [OPTION]... [FILE]" +``` + +Encode/decode data and print to standard output +With no FILE, or when FILE is -, read standard input. + +When decoding, the input may contain newlines in addition to the bytes of +the formal alphabet. Use --ignore-garbage to attempt to recover +from any other non-alphabet bytes in the encoded stream. diff --git a/src/uu/basenc/src/basenc.rs b/src/uu/basenc/src/basenc.rs index 1bc2aae44..afc25c736 100644 --- a/src/uu/basenc/src/basenc.rs +++ b/src/uu/basenc/src/basenc.rs @@ -19,14 +19,10 @@ use uucore::{ use std::io::{stdin, Read}; use uucore::error::UClapError; -static ABOUT: &str = "\ -Encode/decode data and print to standard output -With no FILE, or when FILE is -, read standard input. +use uucore::{help_about, help_usage}; -When decoding, the input may contain newlines in addition to the bytes of -the formal alphabet. Use --ignore-garbage to attempt to recover -from any other non-alphabet bytes in the encoded stream. -"; +const ABOUT: &str = help_about!("basenc.md"); +const USAGE: &str = help_usage!("basenc.md"); const ENCODINGS: &[(&str, Format)] = &[ ("base64", Format::Base64), @@ -39,8 +35,6 @@ const ENCODINGS: &[(&str, Format)] = &[ ("z85", Format::Z85), ]; -const USAGE: &str = "{} [OPTION]... [FILE]"; - pub fn uu_app() -> Command { let mut command = base_common::base_app(ABOUT, USAGE); for encoding in ENCODINGS {