Skip to content

feat: Use GNU/POSIX-style argument syntax conventions for CLI flags #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 14, 2022
Merged

feat: Use GNU/POSIX-style argument syntax conventions for CLI flags #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,34 +39,34 @@ pub fn get_args() -> DCPResult<Config> {
.required(true)
)
.arg(
Arg::with_name("download_path")
.value_name("DOWNLOAD_PATH")
Arg::with_name("download-path")
.value_name("DOWNLOAD-PATH")
.help("Where the image contents should be saved on the filesystem")
.default_value(".")
.short("d")
.long("download_path")
.long("download-path")
)
.arg(
Arg::with_name("content_path")
.value_name("CONTENT_PATH")
Arg::with_name("content-path")
.value_name("CONTENT-PATH")
.help("Where in the container filesystem the content to extract is")
.short("p")
.default_value("/")
.long("content_path")
.long("content-path")
)
.arg(
Arg::with_name("write_to_stdout")
.value_name("WRITE_TO_STDOUT")
Arg::with_name("write-to-stdout")
.value_name("WRITE-TO-STDOUT")
.help("Whether to write to stdout instead of the filesystem")
.takes_value(false)
.short("w")
.long("write_to_stdout")
.long("write-to-stdout")
).get_matches();

let image = matches.value_of("image").unwrap().to_string();
let download_path = matches.value_of("download_path").unwrap().to_string();
let content_path = matches.value_of("content_path").unwrap().to_string();
let write_to_stdout = matches.is_present("write_to_stdout");
let download_path = matches.value_of("download-path").unwrap().to_string();
let content_path = matches.value_of("content-path").unwrap().to_string();
let write_to_stdout = matches.is_present("write-to-stdout");

if write_to_stdout {
return Err(Box::new(DCPError::new("error: writing to stdout is not currently implemented")));
Expand Down
16 changes: 8 additions & 8 deletions tests/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const TEST_CONTENT_DIR: &str = "/tmp/dcp_test_run";
const DEFAULT_IMAGE: &str = "quay.io/tyslaton/sample-catalog:v0.0.4";
const IMAGE_NO_TAG: &str = "quay.io/tyslaton/sample-catalog";

// generate_temp_path takes the constant TEST_CONTENT_DIR and
// generate_temp_path takes the constant TEST_CONTENT_DIR and
// returns a new string with an appended 5 digit string
fn generate_temp_path() -> String {
let random_string = thread_rng().gen_range(10000..99999);
Expand Down Expand Up @@ -40,7 +40,7 @@ fn accepts_download_path() -> TestResult {

// content_path is defined and succeeds
Command::cargo_bin(PRG)?
.args(&["--download_path", path])
.args(&["--download-path", path])
.args(&[DEFAULT_IMAGE])
.assert()
.success();
Expand All @@ -59,8 +59,8 @@ fn accepts_content_path() -> TestResult {

// content_path is defined and succeeds
Command::cargo_bin(PRG)?
.args(&["--download_path", path])
.args(&["--content_path", content_path, DEFAULT_IMAGE])
.args(&["--download-path", path])
.args(&["--content-path", content_path, DEFAULT_IMAGE])
.assert()
.success();

Expand All @@ -78,14 +78,14 @@ fn accepts_image() -> TestResult {

// image is defined and succeeds
Command::cargo_bin(PRG)?
.args(&["--download_path", path])
.args(&["--download-path", path])
.args(&[DEFAULT_IMAGE])
.assert()
.success();

// image is not defined and fails
Command::cargo_bin(PRG)?
.args(&["--download_path", path])
.args(&["--download-path", path])
.assert()
.failure();

Expand All @@ -99,7 +99,7 @@ fn defaults_tag_to_latest() -> TestResult {

// image is defined and succeeds
Command::cargo_bin(PRG)?
.args(&["--download_path", path])
.args(&["--download-path", path])
.args(&[IMAGE_NO_TAG])
.assert()
.success();
Expand All @@ -114,7 +114,7 @@ fn fails_on_just_tag() -> TestResult {

// image is defined and succeeds
Command::cargo_bin(PRG)?
.args(&["--download_path", path])
.args(&["--download-path", path])
.args(&[":v0.0.4"])
.assert()
.failure();
Expand Down