mirror of https://git.meli.delivery/meli/meli
melib/utils: fix issues with ShellExpandTrait
ShellExpandTrait was not expanding paths properly: tilde was expanded
even if it wasn't the first byte in the sequence. Since $HOME tends to
be an absolute path, the entire value of the path accumulator up till
that point was overwritten, meaning a /path/to/~/some/file would get
expanded to ${HOME}/some/file.
ShellExpandTrait was also not completing paths properly, especially
between the generic impl and the linux specialized one. This commit adds
test to make sure their behavior is synced and changes the result type
to an enum to make the result more descriptive.
Concerns #431.
Signed-off-by: Manos Pitsidianakis <manos@pitsidianak.is>
pull/432/head
Manos Pitsidianakis
2 months ago
parent
9daf943758
commit
39e903b1d3
@ -0,0 +1,254 @@
|
||||
//
|
||||
// meli
|
||||
//
|
||||
// Copyright 2024 Emmanouil Pitsidianakis <manos@pitsidianak.is>
|
||||
//
|
||||
// This file is part of meli.
|
||||
//
|
||||
// meli is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// meli is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with meli. If not, see <http://www.gnu.org/licenses/>.
|
||||
//
|
||||
// SPDX-License-Identifier: EUPL-1.2 OR GPL-3.0-or-later
|
||||
|
||||
#[test]
|
||||
fn test_shellexpandtrait() {
|
||||
use std::{fs::File, io::Write, os::unix::fs::PermissionsExt, path::Path};
|
||||
|
||||
use tempfile::TempDir;
|
||||
|
||||
use super::shellexpand::*;
|
||||
|
||||
fn create_file_util(path: &str) {
|
||||
let path = Path::new(path).expand();
|
||||
let mut f = File::create(&path).unwrap();
|
||||
let mut permissions = f.metadata().unwrap().permissions();
|
||||
permissions.set_mode(0o600); // Read/write for owner only.
|
||||
f.set_permissions(permissions).unwrap();
|
||||
f.write_all(b"\n").unwrap();
|
||||
f.flush().unwrap();
|
||||
assert!(path.exists());
|
||||
}
|
||||
|
||||
fn create_dir_util(path: &str) {
|
||||
let path = Path::new(path).expand();
|
||||
std::fs::create_dir(&path).unwrap();
|
||||
assert!(path.exists());
|
||||
assert!(path.is_dir());
|
||||
}
|
||||
|
||||
std::env::remove_var("HOME");
|
||||
|
||||
let tmp_dir = TempDir::new().unwrap();
|
||||
|
||||
std::env::set_var("HOME", tmp_dir.path());
|
||||
|
||||
assert_eq!(&Path::new("~").expand(), tmp_dir.path());
|
||||
|
||||
assert_eq!(
|
||||
&tmp_dir.path().join("~/doc.pdf").expand(),
|
||||
&tmp_dir.path().join("~/doc.pdf")
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
Path::new("~").expand().complete(false, false),
|
||||
Completions::IsDirectory
|
||||
);
|
||||
assert_eq!(
|
||||
Path::new("~").expand().complete(true, false),
|
||||
Completions::Entries(vec!["/".to_string()]),
|
||||
r#" ~<TAB> should append a "/": "~/""#,
|
||||
);
|
||||
assert_eq!(
|
||||
Path::new("~").expand().complete(true, true),
|
||||
Completions::Entries(vec![]),
|
||||
r#"~/<TAB> should return directory entries."#
|
||||
);
|
||||
|
||||
create_file_util("~/doc.pdf");
|
||||
|
||||
assert_eq!(
|
||||
Path::new("~").expand().complete(false, false),
|
||||
Completions::IsDirectory
|
||||
);
|
||||
assert_eq!(
|
||||
Path::new("~").expand().complete(true, false),
|
||||
Completions::Entries(vec!["/".to_string()]),
|
||||
r#"~<TAB> should again append a "/": "~/""#
|
||||
);
|
||||
assert_eq!(
|
||||
Path::new("~").expand().complete(true, true),
|
||||
Completions::Entries(vec!["doc.pdf".to_string()]),
|
||||
r#"~/<TAB> should return directory entries."#
|
||||
);
|
||||
assert_eq!(
|
||||
Path::new("~/doc").expand().complete(true, false),
|
||||
Completions::Entries(vec![".pdf".to_string()]),
|
||||
r#"~/pattern<TAB> should return directory entries matching ~/pattern* glob."#
|
||||
);
|
||||
create_file_util("~/doc2.pdf");
|
||||
assert_eq!(
|
||||
Path::new("~/doc").expand().complete(true, false),
|
||||
Completions::Entries(vec![".pdf".to_string(), "2.pdf".to_string()]),
|
||||
r#"~/pattern<TAB> should again return directory entries matching ~/pattern* glob."#
|
||||
);
|
||||
create_dir_util("~/doc");
|
||||
create_file_util("~/doc/2.pdf");
|
||||
assert_eq!(
|
||||
Path::new("~/doc").expand().complete(true, false),
|
||||
Completions::Entries(vec![
|
||||
".pdf".to_string(),
|
||||
"/".to_string(),
|
||||
"2.pdf".to_string(),
|
||||
]),
|
||||
r#"~/pattern<TAB> should again return directory entries matching ~/pattern* glob."#
|
||||
);
|
||||
assert_eq!(
|
||||
Path::new("~/doc").expand().complete(true, false),
|
||||
Completions::Entries(vec![
|
||||
".pdf".to_string(),
|
||||
"/".to_string(),
|
||||
"2.pdf".to_string(),
|
||||
]),
|
||||
r#"~/pattern<TAB> should again return directory entries matching ~/pattern* glob."#
|
||||
);
|
||||
assert_eq!(
|
||||
Path::new("~/doc").expand().complete(false, false),
|
||||
Completions::IsDirectory,
|
||||
r#"~/doc/<TAB> should not return ~/ entries matching ~/doc* glob."#
|
||||
);
|
||||
assert_eq!(
|
||||
Path::new("~/doc").expand().complete(true, true),
|
||||
Completions::Entries(vec!["2.pdf".to_string()])
|
||||
);
|
||||
assert_eq!(
|
||||
Path::new("/").expand().complete(false, false),
|
||||
Completions::IsDirectory
|
||||
);
|
||||
assert_eq!(
|
||||
Path::new("/").expand().complete(true, false),
|
||||
Completions::IsDirectory
|
||||
);
|
||||
assert!(matches!(Path::new("/").expand().complete(true, true),
|
||||
Completions::Entries(entries) if !entries.is_empty()));
|
||||
}
|
||||
|
||||
#[cfg(target_os = "linux")]
|
||||
#[test]
|
||||
fn test_shellexpandtrait_impls() {
|
||||
use std::{fs::File, io::Write, os::unix::fs::PermissionsExt, path::Path};
|
||||
|
||||
use tempfile::TempDir;
|
||||
|
||||
use super::shellexpand::*;
|
||||
|
||||
fn create_file_util(path: &str) {
|
||||
let path = Path::new(path).expand();
|
||||
let mut f = File::create(&path).unwrap();
|
||||
let mut permissions = f.metadata().unwrap().permissions();
|
||||
permissions.set_mode(0o600); // Read/write for owner only.
|
||||
f.set_permissions(permissions).unwrap();
|
||||
f.write_all(b"\n").unwrap();
|
||||
f.flush().unwrap();
|
||||
assert!(path.exists());
|
||||
}
|
||||
|
||||
fn create_dir_util(path: &str) {
|
||||
let path = Path::new(path).expand();
|
||||
std::fs::create_dir(&path).unwrap();
|
||||
assert!(path.exists());
|
||||
assert!(path.is_dir());
|
||||
}
|
||||
|
||||
std::env::remove_var("HOME");
|
||||
|
||||
let tmp_dir = TempDir::new().unwrap();
|
||||
|
||||
std::env::set_var("HOME", tmp_dir.path());
|
||||
|
||||
macro_rules! assert_complete {
|
||||
(($path:expr, $force:literal, $treat_as_dir:literal), $($expected:tt)*) => {{
|
||||
assert_eq!(
|
||||
impls::inner_complete_linux($path, $force, $treat_as_dir),
|
||||
impls::inner_complete_generic($path, $force, $treat_as_dir),
|
||||
concat!("Expected ", stringify!($($expected)*)),
|
||||
);
|
||||
assert_eq!(
|
||||
impls::inner_complete_generic($path, $force, $treat_as_dir),
|
||||
$($expected)*,
|
||||
);
|
||||
}};
|
||||
}
|
||||
|
||||
assert_complete!(
|
||||
(&Path::new("~").expand(), false, false),
|
||||
Completions::IsDirectory
|
||||
);
|
||||
assert_complete!(
|
||||
(&Path::new("~").expand(), true, false),
|
||||
Completions::Entries(vec!["/".to_string()])
|
||||
);
|
||||
assert_complete!(
|
||||
(&Path::new("~").expand(), true, true),
|
||||
Completions::Entries(vec![])
|
||||
);
|
||||
|
||||
create_file_util("~/doc.pdf");
|
||||
|
||||
assert_complete!(
|
||||
(&Path::new("~").expand(), false, false),
|
||||
Completions::IsDirectory
|
||||
);
|
||||
assert_complete!(
|
||||
(&Path::new("~").expand(), true, false),
|
||||
Completions::Entries(vec!["/".to_string()])
|
||||
);
|
||||
assert_complete!(
|
||||
(&Path::new("~").expand(), true, true),
|
||||
Completions::Entries(vec!["doc.pdf".to_string()])
|
||||
);
|
||||
assert_complete!(
|
||||
(&Path::new("~/doc").expand(), true, false),
|
||||
Completions::Entries(vec![".pdf".to_string()])
|
||||
);
|
||||
create_file_util("~/doc2.pdf");
|
||||
assert_complete!(
|
||||
(&Path::new("~/doc").expand(), true, false),
|
||||
Completions::Entries(vec![".pdf".to_string(), "2.pdf".to_string()])
|
||||
);
|
||||
create_dir_util("~/doc");
|
||||
create_file_util("~/doc/2.pdf");
|
||||
assert_complete!(
|
||||
(&Path::new("~/doc").expand(), true, false),
|
||||
Completions::Entries(vec![
|
||||
".pdf".to_string(),
|
||||
"/".to_string(),
|
||||
"2.pdf".to_string(),
|
||||
])
|
||||
);
|
||||
assert_complete!(
|
||||
(&Path::new("~/doc").expand(), false, false),
|
||||
Completions::IsDirectory
|
||||
);
|
||||
assert_complete!(
|
||||
(&Path::new("~/doc").expand(), true, true),
|
||||
Completions::Entries(vec!["2.pdf".to_string()])
|
||||
);
|
||||
assert_complete!(
|
||||
(&Path::new("/").expand(), false, false),
|
||||
Completions::IsDirectory
|
||||
);
|
||||
assert_complete!(
|
||||
(&Path::new("/").expand(), true, false),
|
||||
Completions::IsDirectory
|
||||
);
|
||||
}
|
||||
Loading…
Reference in New Issue