This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9397

rhg: add a `debugrequirements` subcommand
ClosedPublic

Authored by SimonSapin on Nov 25 2020, 7:41 AM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHGead435aa5294: rhg: add a `debugrequirements` subcommand
Summary

For now it only prints the contents of .hg/requires as-is, without parsing.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

SimonSapin created this revision.Nov 25 2020, 7:41 AM
pulkit added a subscriber: pulkit.Nov 26 2020, 4:55 AM

For now it only prints the contents of .hg/requires as-is, without parsing.

It will be wrong when share-safe functionality is in play. It's an experimental feature and hence that should not block this series. However, one nice thing will be to add a TODO about it.

SimonSapin added a comment.Nov 26 2020, 5:01 AM

“For now” was intended as: until the next commit in the series which parses into a list of feature names. But with share-safe, did you mean that .hg/store/requires should also be read? Indeed that is not part of this series.

pulkit added a comment.Nov 26 2020, 7:26 AM
In D9397#141367, @SimonSapin wrote:

“For now” was intended as: until the next commit in the series which parses into a list of feature names. But with share-safe, did you mean that .hg/store/requires should also be read?

Not always, but yes. Seems like we lack documentation on the related behavior, I will do that and share with you.

pulkit accepted this revision.Nov 26 2020, 7:26 AM
This revision is now accepted and ready to land.Nov 26 2020, 7:26 AM
SimonSapin added a commit: rHGead435aa5294: rhg: add a `debugrequirements` subcommand.Nov 26 2020, 8:14 AM
Closed by commit rHGead435aa5294: rhg: add a `debugrequirements` subcommand (authored by SimonSapin). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 23691

rust/rhg/src/commands.rs

pub mod cat; pub mod cat;
pub mod debugdata; pub mod debugdata;
pub mod debugrequirements;
pub mod files; pub mod files;
pub mod root; pub mod root;
use crate::error::CommandError; use crate::error::CommandError;
use crate::ui::Ui; use crate::ui::Ui;
/// The common trait for rhg commands /// The common trait for rhg commands
/// ///
/// Normalize the interface of the commands provided by rhg /// Normalize the interface of the commands provided by rhg
pub trait Command { pub trait Command {
fn run(&self, ui: &Ui) -> Result<(), CommandError>; fn run(&self, ui: &Ui) -> Result<(), CommandError>;
} }

rust/rhg/src/commands/debugrequirements.rs

  • This file was added.
use crate::commands::Command;
use crate::error::{CommandError, CommandErrorKind};
use crate::ui::Ui;
use hg::operations::FindRoot;
pub const HELP_TEXT: &str = "
Print the current repo requirements.
";
pub struct DebugRequirementsCommand {}
impl DebugRequirementsCommand {
pub fn new() -> Self {
DebugRequirementsCommand {}
}
}
impl Command for DebugRequirementsCommand {
fn run(&self, ui: &Ui) -> Result<(), CommandError> {
let root = FindRoot::new().run()?;
let requires = root.join(".hg").join("requires");
let requirements = match std::fs::read(requires) {
Ok(bytes) => bytes,
// Treat a missing file the same as an empty file.
// From `mercurial/localrepo.py`:
// > requires file contains a newline-delimited list of
// > features/capabilities the opener (us) must have in order to use
// > the repository. This file was introduced in Mercurial 0.9.2,
// > which means very old repositories may not have one. We assume
// > a missing file translates to no requirements.
Err(error) if error.kind() == std::io::ErrorKind::NotFound => Vec::new(),
Err(error) => Err(CommandErrorKind::FileError(error))?,
};
ui.write_stdout(&requirements)?;
Ok(())
}
}

rust/rhg/src/error.rs

use crate::exitcode; use crate::exitcode;
use crate::ui::UiError; use crate::ui::UiError;
use hg::operations::{FindRootError, FindRootErrorKind}; use hg::operations::{FindRootError, FindRootErrorKind};
use hg::utils::files::get_bytes_from_path; use hg::utils::files::get_bytes_from_path;
use std::convert::From; use std::convert::From;
use std::path::PathBuf; use std::path::PathBuf;
/// The kind of command error /// The kind of command error
#[derive(Debug)] #[derive(Debug)]
pub enum CommandErrorKind { pub enum CommandErrorKind {
/// The root of the repository cannot be found /// The root of the repository cannot be found
RootNotFound(PathBuf), RootNotFound(PathBuf),
/// The current directory cannot be found /// The current directory cannot be found
CurrentDirNotFound(std::io::Error), CurrentDirNotFound(std::io::Error),
/// Error while reading or writing a file
// TODO: add the file name/path?
FileError(std::io::Error),
/// The standard output stream cannot be written to /// The standard output stream cannot be written to
StdoutError, StdoutError,
/// The standard error stream cannot be written to /// The standard error stream cannot be written to
StderrError, StderrError,
/// The command aborted /// The command aborted
Abort(Option<Vec<u8>>), Abort(Option<Vec<u8>>),
/// A mercurial capability as not been implemented. /// A mercurial capability as not been implemented.
Unimplemented, Unimplemented,
} }
impl CommandErrorKind { impl CommandErrorKind {
pub fn get_exit_code(&self) -> exitcode::ExitCode { pub fn get_exit_code(&self) -> exitcode::ExitCode {
match self { match self {
CommandErrorKind::RootNotFound(_) => exitcode::ABORT, CommandErrorKind::RootNotFound(_) => exitcode::ABORT,
CommandErrorKind::CurrentDirNotFound(_) => exitcode::ABORT, CommandErrorKind::CurrentDirNotFound(_) => exitcode::ABORT,
CommandErrorKind::FileError(_) => exitcode::ABORT,
CommandErrorKind::StdoutError => exitcode::ABORT, CommandErrorKind::StdoutError => exitcode::ABORT,
CommandErrorKind::StderrError => exitcode::ABORT, CommandErrorKind::StderrError => exitcode::ABORT,
CommandErrorKind::Abort(_) => exitcode::ABORT, CommandErrorKind::Abort(_) => exitcode::ABORT,
CommandErrorKind::Unimplemented => exitcode::UNIMPLEMENTED_COMMAND, CommandErrorKind::Unimplemented => exitcode::UNIMPLEMENTED_COMMAND,
} }
} }
/// Return the message corresponding to the error kind if any /// Return the message corresponding to the error kind if any

rust/rhg/src/main.rs

.required(true), .required(true),
) )
.arg( .arg(
Arg::with_name("rev") Arg::with_name("rev")
.help("revision") .help("revision")
.required(true) .required(true)
.value_name("REV"), .value_name("REV"),
), ),
)
.subcommand(
SubCommand::with_name("debugrequirements")
.about(commands::debugrequirements::HELP_TEXT),
); );
let matches = app.clone().get_matches_safe().unwrap_or_else(|err| { let matches = app.clone().get_matches_safe().unwrap_or_else(|err| {
let _ = ui::Ui::new().writeln_stderr_str(&err.message); let _ = ui::Ui::new().writeln_stderr_str(&err.message);
std::process::exit(exitcode::UNIMPLEMENTED_COMMAND) std::process::exit(exitcode::UNIMPLEMENTED_COMMAND)
}); });
let ui = ui::Ui::new(); let ui = ui::Ui::new();
commands::files::FilesCommand::try_from(matches)?.run(&ui) commands::files::FilesCommand::try_from(matches)?.run(&ui)
} }
("cat", Some(matches)) => { ("cat", Some(matches)) => {
commands::cat::CatCommand::try_from(matches)?.run(&ui) commands::cat::CatCommand::try_from(matches)?.run(&ui)
} }
("debugdata", Some(matches)) => { ("debugdata", Some(matches)) => {
commands::debugdata::DebugDataCommand::try_from(matches)?.run(&ui) commands::debugdata::DebugDataCommand::try_from(matches)?.run(&ui)
} }
("debugrequirements", _) => {
commands::debugrequirements::DebugRequirementsCommand::new()
.run(&ui)
}
_ => unreachable!(), // Because of AppSettings::SubcommandRequired, _ => unreachable!(), // Because of AppSettings::SubcommandRequired,
} }
} }
impl<'a> TryFrom<&'a ArgMatches<'_>> for commands::files::FilesCommand<'a> { impl<'a> TryFrom<&'a ArgMatches<'_>> for commands::files::FilesCommand<'a> {
type Error = CommandError; type Error = CommandError;
fn try_from(args: &'a ArgMatches) -> Result<Self, Self::Error> { fn try_from(args: &'a ArgMatches) -> Result<Self, Self::Error> {

tests/test-rhg.t

$ hg commit -m "add original" original $ hg commit -m "add original" original
$ rhg cat -r 0 original $ rhg cat -r 0 original
original content original content
Cat copied file should not display copy metadata Cat copied file should not display copy metadata
$ hg copy original copy_of_original $ hg copy original copy_of_original
$ hg commit -m "add copy of original" $ hg commit -m "add copy of original"
$ rhg cat -r 1 copy_of_original $ rhg cat -r 1 copy_of_original
original content original content
Requirements
$ rhg debugrequirements
dotencode
fncache
generaldelta
revlogv1
sparserevlog
store