Merge pull request #9931 from gitbutlerapp/cli-add-project-command

feat(cli): add project command to but-testing

Author: estib-vega

Cargo.lock

@@ -29,6 +29,7 @@ but-hunk-assignment.workspace = true
 gitbutler-branch-actions.workspace = true
 gitbutler-branch.workspace = true
 gitbutler-operating-modes.workspace = true
+gitbutler-reference.workspace = true
 
 gitbutler-commit = { workspace = true, optional = true, features = ["testing"] }
 

crates/but-testing/Cargo.toml

@@ -1,3 +1,4 @@
+use gitbutler_reference::RemoteRefname;
 use gitbutler_stack::StackId;
 use std::path::PathBuf;
 
@@ -35,6 +36,16 @@ pub struct Args {
 
 #[derive(Debug, clap::Subcommand)]
 pub enum Subcommands {
+    /// Add the given Git repository as project for use with GitButler.
+    AddProject {
+        /// The long name of the remote reference to track, like `refs/remotes/origin/main`,
+        /// when switching to the workspace branch.
+        #[clap(short = 's', long)]
+        switch_to_workspace: Option<RemoteRefname>,
+        /// The path at which the repository worktree is located.
+        #[clap(default_value = ".", value_name = "REPOSITORY")]
+        path: PathBuf,
+    },
     /// Commit or amend all worktree changes to a new commit.
     Commit {
         /// The repo-relative path to the changed file to commit.

crates/but-testing/src/args.rs

@@ -111,6 +111,7 @@ pub use commit::commit;
 use gitbutler_command_context::CommandContext;
 
 pub mod diff;
+pub mod project;
 
 pub mod assignment {
     use crate::command::{debug_print, project_from_path};

crates/but-testing/src/command/mod.rs

@@ -0,0 +1,27 @@
+use std::path::PathBuf;
+
+use anyhow::{Context, Result};
+use but_settings::AppSettings;
+use gitbutler_command_context::CommandContext;
+use gitbutler_reference::RemoteRefname;
+
+use crate::command::debug_print;
+
+pub fn add(data_dir: PathBuf, path: PathBuf, refname: Option<RemoteRefname>) -> Result<()> {
+    let path = gix::discover(path)?
+        .workdir()
+        .context("Only non-bare repositories can be added")?
+        .to_owned()
+        .canonicalize()?;
+    let project = gitbutler_project::add_with_path(data_dir, path, None, None)?;
+    let ctx = CommandContext::open(&project, AppSettings::default())?;
+    if let Some(refname) = refname {
+        gitbutler_branch_actions::set_base_branch(
+            &ctx,
+            &refname,
+            false,
+            ctx.project().exclusive_worktree_access().write_permission(),
+        )?;
+    };
+    debug_print(project)
+}

crates/but-testing/src/command/project.rs

@@ -1,8 +1,8 @@
 //! A debug-CLI for making `but`-crates functionality available in real-world repositories.
 #![deny(rust_2018_idioms)]
-use std::str::FromStr;
+use std::{path::PathBuf, str::FromStr};
 
-use anyhow::{Result, bail};
+use anyhow::{Context, Result, bail};
 use but_workspace::HunkHeader;
 use command::parse_diff_spec;
 use gix::bstr::BString;
@@ -24,6 +24,15 @@ async fn main() -> Result<()> {
     let _op_span = tracing::info_span!("cli-op").entered();
 
     match &args.cmd {
+        args::Subcommands::AddProject {
+            switch_to_workspace,
+            path,
+        } => command::project::add(
+            data_dir(args.app_data_dir)?,
+            path.to_owned(),
+            switch_to_workspace.to_owned(),
+        ),
+
         args::Subcommands::RemoveReference {
             permit_empty_stacks,
             keep_metadata,
@@ -213,3 +222,18 @@ mod trace {
         Ok(())
     }
 }
+
+pub fn data_dir(app_data_dir: Option<PathBuf>) -> anyhow::Result<PathBuf> {
+    let path = if let Some(dir) = app_data_dir {
+        std::fs::create_dir_all(&dir).context("Failed to assure the designated data-dir exists")?;
+        dir
+    } else {
+        dirs_next::data_dir()
+            .map(|dir| dir.join("com.gitbutler.app"))
+            .context("no data-directory available on this platform")?
+    };
+    if !path.is_dir() {
+        bail!("Path '{}' must be a valid directory", path.display());
+    }
+    Ok(path)
+}