ok/jj
1
0
Fork 0
forked from mirrors/jj
Code Pull requests Activity

cli: require revision arguments to be non-empty strings

Browse source 
I can't see any reason the user would want to specify revisions
matching the empty string, so let's disallow it. I created a custom
type for revision arguments instead of repeating `value_parser =
NonEmptyStringValueParser::new()`.
This commit is contained in:
Martin von Zweigbergk 2022-11-28 06:32:44 -08:00 committed by Martin von Zweigbergk
parent fd02dc2dc2
commit b32598e989
3 changed files with 95 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
src/cli_util.rs
View file

@ -14,15 +14,17 @@
use std::collections::{HashSet, VecDeque};
use std::env::ArgsOs;
use std::ffi::OsString;
use std::ffi::{OsStr, OsString};
use std::fmt::Debug;
use std::iter;
use std::ops::Deref;
use std::path::PathBuf;
use std::rc::Rc;
use std::sync::Arc;
use clap;
use clap::{ArgMatches, FromArgMatches};
use clap::builder::{NonEmptyStringValueParser, TypedValueParser, ValueParserFactory};
use clap::{Arg, ArgMatches, Command, Error, FromArgMatches};
use git2::{Oid, Repository};
use itertools::Itertools;
use jujutsu_lib::backend::{BackendError, CommitId, TreeId};
@ -1048,7 +1050,7 @@ fn load_revset_aliases(ui: &mut Ui) -> Result<RevsetAliasesMap, CommandError> {
pub fn resolve_base_revs(
workspace_command: &WorkspaceCommandHelper,
revisions: &[String],
revisions: &[RevisionArg],
) -> Result<Vec<Commit>, CommandError> {
let mut commits = vec![];
for revision_str in revisions {
@ -1056,8 +1058,8 @@ pub fn resolve_base_revs(
if let Some(i) = commits.iter().position(|c| c == &commit) {
return Err(user_error(format!(
r#"Revset "{}" and "{}" resolved to the same revision {}"#,
revisions[i],
revision_str,
&revisions[i].0,
&revision_str.0,
short_commit_hash(commit.id()),
)));
}
@ -1243,6 +1245,42 @@ pub struct GlobalArgs {
pub verbose: bool,
}
#[derive(Clone, Debug)]
pub struct RevisionArg(String);
impl Deref for RevisionArg {
type Target = str;
fn deref(&self) -> &Self::Target {
self.0.as_str()
}
}
#[derive(Clone)]
pub struct RevisionArgValueParser;
impl TypedValueParser for RevisionArgValueParser {
type Value = RevisionArg;
fn parse_ref(
&self,
cmd: &Command,
arg: Option<&Arg>,
value: &OsStr,
) -> Result<Self::Value, Error> {
let string = NonEmptyStringValueParser::new().parse(cmd, arg, value.to_os_string())?;
Ok(RevisionArg(string))
}
}
impl ValueParserFactory for RevisionArg {
type Parser = RevisionArgValueParser;
fn value_parser() -> RevisionArgValueParser {
RevisionArgValueParser
}
}
pub fn create_ui() -> (Ui, Result<(), CommandError>) {
// TODO: We need to do some argument parsing here, at least for things like
// --config, and for reading user configs from the repo pointed to by -R.

75
src/commands.rs
View file

@ -16,7 +16,7 @@ use std::collections::{HashSet, VecDeque};
use std::fmt::Debug;
use std::fs::OpenOptions;
use std::io::{Read, Seek, SeekFrom, Write};
use std::ops::Range;
use std::ops::{Deref, Range};
use std::path::{Path, PathBuf};
use std::process::{Command, Stdio};
use std::sync::{Arc, Mutex};
@ -56,7 +56,7 @@ use pest::Parser;
use crate::cli_util::{
print_checkout_stats, print_failed_git_export, resolve_base_revs, short_commit_description,
short_commit_hash, user_error, user_error_with_hint, write_commit_summary, Args, CommandError,
CommandHelper, WorkspaceCommandHelper,
CommandHelper, RevisionArg, WorkspaceCommandHelper,
};
use crate::formatter::{Formatter, PlainTextFormatter};
use crate::graphlog::{AsciiGraphDrawer, Edge};
@ -149,7 +149,7 @@ struct InitArgs {
#[command(visible_aliases = &["co", "update", "up"])]
struct CheckoutArgs {
/// The revision to update to
revision: String,
revision: RevisionArg,
/// Ignored (but lets you pass `-r` for consistency with other commands)
#[arg(short = 'r', hide = true)]
unused_revision: bool,
@ -171,7 +171,7 @@ struct UntrackArgs {
struct FilesArgs {
/// The revision to list files in
#[arg(long, short, default_value = "@")]
revision: String,
revision: RevisionArg,
/// Only list files matching these prefixes (instead of all files)
#[arg(value_hint = clap::ValueHint::AnyPath)]
paths: Vec<String>,
@ -182,7 +182,7 @@ struct FilesArgs {
struct PrintArgs {
/// The revision to get the file contents from
#[arg(long, short, default_value = "@")]
revision: String,
revision: RevisionArg,
/// The file to print
#[arg(value_hint = clap::ValueHint::FilePath)]
path: String,
@ -217,13 +217,13 @@ struct DiffFormatArgs {
struct DiffArgs {
/// Show changes in this revision, compared to its parent(s)
#[arg(long, short)]
revision: Option<String>,
revision: Option<RevisionArg>,
/// Show changes from this revision
#[arg(long, conflicts_with = "revision")]
from: Option<String>,
from: Option<RevisionArg>,
/// Show changes to this revision
#[arg(long, conflicts_with = "revision")]
to: Option<String>,
to: Option<RevisionArg>,
/// Restrict the diff to these paths
#[arg(value_hint = clap::ValueHint::AnyPath)]
paths: Vec<String>,
@ -236,7 +236,7 @@ struct DiffArgs {
struct ShowArgs {
/// Show changes in this revision, compared to its parent(s)
#[arg(default_value = "@")]
revision: String,
revision: RevisionArg,
/// Ignored (but lets you pass `-r` for consistency with other commands)
#[arg(short = 'r', hide = true)]
unused_revision: bool,
@ -263,7 +263,7 @@ struct LogArgs {
/// or `@ | (remote_branches() | tags()).. | ((remote_branches() |
/// tags())..)-` if it is not set.
#[arg(long, short)]
revisions: Option<String>,
revisions: Option<RevisionArg>,
/// Show commits modifying the given paths
#[arg(value_hint = clap::ValueHint::AnyPath)]
paths: Vec<String>,
@ -290,7 +290,7 @@ struct LogArgs {
#[derive(clap::Args, Clone, Debug)]
struct ObslogArgs {
#[arg(long, short, default_value = "@")]
revision: String,
revision: RevisionArg,
/// Don't show the graph, show a flat list of revisions
#[arg(long)]
no_graph: bool,
@ -319,10 +319,10 @@ struct ObslogArgs {
struct InterdiffArgs {
/// Show changes from this revision
#[arg(long)]
from: Option<String>,
from: Option<RevisionArg>,
/// Show changes to this revision
#[arg(long)]
to: Option<String>,
to: Option<RevisionArg>,
/// Restrict the diff to these paths
#[arg(value_hint = clap::ValueHint::AnyPath)]
paths: Vec<String>,
@ -338,7 +338,7 @@ struct InterdiffArgs {
struct DescribeArgs {
/// The revision whose description to edit
#[arg(default_value = "@")]
revision: String,
revision: RevisionArg,
/// Ignored (but lets you pass `-r` for consistency with other commands)
#[arg(short = 'r', hide = true)]
unused_revision: bool,
@ -364,7 +364,7 @@ struct CommitArgs {
struct DuplicateArgs {
/// The revision to duplicate
#[arg(default_value = "@")]
revision: String,
revision: RevisionArg,
/// Ignored (but lets you pass `-r` for consistency with other commands)
#[arg(short = 'r', hide = true)]
unused_revision: bool,
@ -380,7 +380,7 @@ struct DuplicateArgs {
struct AbandonArgs {
/// The revision(s) to abandon
#[arg(default_value = "@")]
revisions: Vec<String>,
revisions: Vec<RevisionArg>,
/// Ignored (but lets you pass `-r` for consistency with other commands)
#[arg(short = 'r', hide = true)]
unused_revision: bool,
@ -393,7 +393,7 @@ struct AbandonArgs {
#[derive(clap::Args, Clone, Debug)]
struct EditArgs {
/// The commit to edit
revision: String,
revision: RevisionArg,
/// Ignored (but lets you pass `-r` for consistency with other commands)
#[arg(short = 'r', hide = true)]
unused_revision: bool,
@ -411,7 +411,7 @@ struct EditArgs {
struct NewArgs {
/// Parent(s) of the new change
#[arg(default_value = "@")]
revisions: Vec<String>,
revisions: Vec<RevisionArg>,
/// Ignored (but lets you pass `-r` for consistency with other commands)
#[arg(short = 'r', hide = true)]
unused_revision: bool,
@ -437,10 +437,10 @@ struct NewArgs {
struct MoveArgs {
/// Move part of this change into the destination
#[arg(long)]
from: Option<String>,
from: Option<RevisionArg>,
/// Move part of the source into this change
#[arg(long)]
to: Option<String>,
to: Option<RevisionArg>,
/// Interactively choose which parts to move
#[arg(long, short)]
interactive: bool,
@ -463,7 +463,7 @@ struct MoveArgs {
#[command(visible_alias = "amend")]
struct SquashArgs {
#[arg(long, short, default_value = "@")]
revision: String,
revision: RevisionArg,
/// Interactively choose which parts to squash
#[arg(long, short)]
interactive: bool,
@ -486,7 +486,7 @@ struct SquashArgs {
#[command(visible_alias = "unamend")]
struct UnsquashArgs {
#[arg(long, short, default_value = "@")]
revision: String,
revision: RevisionArg,
/// Interactively choose which parts to unsquash
// TODO: It doesn't make much sense to run this without -i. We should make that
// the default.
@ -507,10 +507,10 @@ struct UnsquashArgs {
struct RestoreArgs {
/// Revision to restore from (source)
#[arg(long)]
from: Option<String>,
from: Option<RevisionArg>,
/// Revision to restore into (destination)
#[arg(long)]
to: Option<String>,
to: Option<RevisionArg>,
/// Interactively choose which parts to restore
#[arg(long, short)]
interactive: bool,
@ -531,7 +531,7 @@ struct RestoreArgs {
struct TouchupArgs {
/// The revision to touch up
#[arg(long, short, default_value = "@")]
revision: String,
revision: RevisionArg,
}
/// Split a revision in two
@ -545,7 +545,7 @@ struct TouchupArgs {
struct SplitArgs {
/// The revision to split
#[arg(long, short, default_value = "@")]
revision: String,
revision: RevisionArg,
/// Put these paths in the first commit and don't run the diff editor
#[arg(value_hint = clap::ValueHint::AnyPath)]
paths: Vec<String>,
@ -617,17 +617,17 @@ struct SplitArgs {
struct RebaseArgs {
/// Rebase the whole branch (relative to destination's ancestors)
#[arg(long, short)]
branch: Option<String>,
branch: Option<RevisionArg>,
/// Rebase this revision and its descendants
#[arg(long, short)]
source: Option<String>,
source: Option<RevisionArg>,
/// Rebase only this revision, rebasing descendants onto this revision's
/// parent(s)
#[arg(long, short)]
revision: Option<String>,
revision: Option<RevisionArg>,
/// The revision(s) to rebase onto
#[arg(long, short, required = true)]
destination: Vec<String>,
destination: Vec<RevisionArg>,
}
/// Apply the reverse of a revision on top of another revision
@ -635,12 +635,12 @@ struct RebaseArgs {
struct BackoutArgs {
/// The revision to apply the reverse of
#[arg(long, short, default_value = "@")]
revision: String,
revision: RevisionArg,
/// The revision to apply the reverse changes on top of
// TODO: It seems better to default this to `@-`. Maybe the working
// copy should be rebased on top?
#[arg(long, short, default_value = "@")]
destination: Vec<String>,
destination: Vec<RevisionArg>,
}
/// Manage branches.
@ -654,7 +654,7 @@ enum BranchSubcommand {
Create {
/// The branch's target revision.
#[arg(long, short)]
revision: Option<String>,
revision: Option<RevisionArg>,
/// The branches to create.
#[arg(required = true, value_parser=NonEmptyStringValueParser::new())]
@ -697,7 +697,7 @@ enum BranchSubcommand {
Set {
/// The branch's target revision.
#[arg(long, short)]
revision: Option<String>,
revision: Option<RevisionArg>,
/// Allow moving the branch backwards or sideways.
#[arg(long, short = 'B')]
@ -891,7 +891,7 @@ struct GitPushArgs {
all: bool,
/// Push this commit by creating a branch based on its change ID
#[arg(long)]
change: Option<String>,
change: Option<RevisionArg>,
/// Only display what will change on the remote
#[arg(long)]
dry_run: bool,
@ -2035,7 +2035,7 @@ fn cmd_log(ui: &mut Ui, command: &CommandHelper, args: &LogArgs) -> Result<(), C
let default_revset = ui.settings().default_revset();
let revset_expression =
workspace_command.parse_revset(args.revisions.as_ref().unwrap_or(&default_revset))?;
workspace_command.parse_revset(args.revisions.as_deref().unwrap_or(&default_revset))?;
let repo = workspace_command.repo();
let workspace_id = workspace_command.workspace_id();
let checkout_id = repo.view().get_wc_commit_id(&workspace_id);
@ -4294,7 +4294,8 @@ fn cmd_git_push(
writeln!(
ui,
"Creating branch {} for revision {}",
branch_name, change_str
branch_name,
change_str.deref()
)?;
}
tx = workspace_command.start_transaction(&format!(

14
tests/test_log_command.rs
View file

@ -17,6 +17,20 @@ use regex::Regex;
pub mod common;
#[test]
fn test_log_with_empty_revision() {
let test_env = TestEnvironment::default();
test_env.jj_cmd_success(test_env.env_root(), &["init", "repo", "--git"]);
let repo_path = test_env.env_root().join("repo");
let stderr = test_env.jj_cmd_cli_error(&repo_path, &["log", "-r="]);
insta::assert_snapshot!(stderr, @r###"
error: The argument '--revisions <REVISIONS>' requires a value but none was supplied
For more information try '--help'
"###);
}
#[test]
fn test_log_with_or_without_diff() {
let test_env = TestEnvironment::default();