delete command #11

krauterbaquette · 2024-12-18T15:45:45Z

krauterbaquette commented

2024-12-18 15:45:45 +00:00

Added a command for branch deletion.

This command will default to delete local & remote branch at once.
The --local flag can be used to only delete the local branch
The --remote flag can be used to only delete the remote branch

Added a command for branch deletion. This command will default to delete local & remote branch at once. \ The `--local` flag can be used to only delete the **local** branch The `--remote` flag can be used to only delete the **remote** branch

krauterbaquette added 2 commits

2024-12-18 15:45:46 +00:00

added branch deletion command

Rust Checks / Run Rust Check (push) Failing after 3s

Details

d75b28c3fd

- deletes remote and local branch per default
- --local flag to only delete local branch
- --remote flag to only delete remote branch

added error message when branch is not found

Rust Checks / Run Rust Check (push) Failing after 3s

Details

0a4284c189

krauterbaquette commented

2024-12-18 15:46:39 +00:00

TODO / Checks

show error when trying to delete a remote branch that does not exist

### TODO / Checks - [x] show error when trying to delete a remote branch that does not exist

krauterbaquette added 1 commit

2024-12-18 15:51:09 +00:00

improved error message if the remote branch does not exist

Rust Checks / Run Rust Check (push) Failing after 3s

Details

c7535a0d1f

- show a warning, as the desired state was achieved, but not by the desired action

krauterbaquette commented

2024-12-18 16:06:10 +00:00

Testing

To test the branch deletion feature, a remote repository is needed (with a local clone). The demo project can be used.

All error messages should be user friendly

Basic deletion

Create a remote branch and a local branch with the same name.

$ git checkout -b test
$ git push origin test
$ git switch main

Afterwards delete the branch locally and remotely

$ sac delete test

Delete current branch

Create a test branch and switch to it.

$ git checkout -b test

In this case an error should be shown and no branch will be deleted.

$ sac delete test

Delete local branch only

Create a remote branch and a local branch

$ git checkout -b test
$ git push origin test
$ git switch main

Afterwards delete only the local branch

$ sac delete --local test

Check in the remote repository. The test branch should still be present.

Delete remote branch only

Create a remote branch and a local branch

$ git checkout -b test
$ git push origin test
$ git switch main

Afterwards delete only the remote branch

$ sac delete --remote test

Check the local repository for the branch.

git branch

Delete non existing branch

$ sac delete this-branch-does-not-exist

An error should be shown, suggesting to only delete the remote branch.

Delete a local branch with no remote

Create a local branch only

$ git branch local-only
``
Try to delete the branch:

$ sac delete local-only


The local branch should be deleted, while the remote deletion fails and prints an error.

## Delete non-existing remote branch

$ sac delete --remote non-existing

An error message should be shown. No local branch should be deleted.

# Testing To test the _branch deletion_ feature, a remote repository is needed (with a local clone). The [demo project](https://git.solarpunk.social/GTA-HEG/demo) can be used. > All error messages should be user friendly ## Basic deletion Create a remote branch and a local branch with the same name. ``` $ git checkout -b test $ git push origin test $ git switch main ``` Afterwards delete the branch locally and remotely ``` $ sac delete test ``` ## Delete current branch Create a test branch and switch to it. ``` $ git checkout -b test ``` In this case an error should be shown and no branch will be deleted. ``` $ sac delete test ``` ## Delete local branch only Create a remote branch and a local branch ``` $ git checkout -b test $ git push origin test $ git switch main ``` Afterwards delete only the local branch ``` $ sac delete --local test ``` Check in the remote repository. The `test` branch should still be present. ## Delete remote branch only Create a remote branch and a local branch ``` $ git checkout -b test $ git push origin test $ git switch main ``` Afterwards delete only the remote branch ``` $ sac delete --remote test ``` Check the local repository for the branch. ``` git branch ``` ## Delete non existing branch ``` $ sac delete this-branch-does-not-exist ``` An error should be shown, suggesting to only delete the remote branch. ## Delete a local branch with no remote Create a local branch only ``` $ git branch local-only `` Try to delete the branch: ``` $ sac delete local-only ``` The local branch should be deleted, while the remote deletion fails and prints an error. ## Delete non-existing remote branch ``` $ sac delete --remote non-existing ``` An error message should be shown. No local branch should be deleted.

krauterbaquette changed title from ~~WIP: Delete command~~ to WIP: delete command

2024-12-18 20:54:23 +00:00

aviac approved these changes

2024-12-19 11:42:08 +00:00

Dismissed

aviac left a comment

Das sieht auch clean aus ✨

src/command/delete.rs Outdated

					
				@ -0,0 +17,20 @@

				    /// Name of the branch to delete

				    name: String,

				    #[arg(long, short, default_value = "false")]

				    /// delete the branch only localy

				    local: bool,

				    #[arg(long, short, default_value = "false")]

				    /// delete only the remote branch

				    /// this will try to delete the remote branch even if no local branch is found

				    remote: bool,

				}

				impl Cmd {

				    pub fn execute(&self) -> anyhow::Result<()> {

				        if self.remote {

				            remove_remote(&self.name);

				            return Ok(());

				        }

				        let repo = Repository::discover(".").context("failed to open repository")?;

				        for branch in repo.branches(Some(BranchType::Local)).unwrap() {

Achtung hier sind noch ein paar unwrap()s. Weiss nicht ob das so von dir gewollt ist. Wenn ja, am besten anstelle davon immer expect("eine gute Begruendung") fuer sowas nutzen, damit man selbst spaeter noch unterscheiden kann ob das nur zum schnellen testen war oder gewollt ist

Achtung hier sind noch ein paar `unwrap()`s. Weiss nicht ob das so von dir gewollt ist. Wenn ja, am besten anstelle davon immer `expect("eine gute Begruendung")` fuer sowas nutzen, damit man selbst spaeter noch unterscheiden kann ob das nur zum schnellen testen war oder gewollt ist

Das problem ist so ein wenig, dass die git2.rs documentation keinen wirklichen hinweis darauf gibt, was genau schief laufen kann.

Ich habe jetzt einfach das ganze mit .context as Undocumented error markiert.
Man kann dan in der Zukunft (sollte jemals ein fehler auftreten), das ganze besser analysieren und eine sinnvollere Fehlermeldung schreiben. Ich glaube aktuell liegt das aber etwas außerhalb des scopes.

Das problem ist so ein wenig, dass die [git2.rs documentation]() keinen wirklichen hinweis darauf gibt, was genau schief laufen kann. Ich habe jetzt einfach das ganze mit `.context` as `Undocumented error` markiert. Man kann dan in der Zukunft (sollte jemals ein fehler auftreten), das ganze besser analysieren und eine sinnvollere Fehlermeldung schreiben. Ich glaube aktuell liegt das aber etwas außerhalb des scopes.

krauterbaquette marked this conversation as resolved

krauterbaquette added 1 commit

2024-12-19 17:05:12 +00:00

switched unwraps to thrown errors

Rust Checks / Run Rust Check (push) Failing after 2s

Details

af333e5974

Adressing comment: GTA-HEG/SAC#11 (comment)

Sadly, [git2.rs](https://docs.rs/git2/latest/git2/) has no documentation on the errors
that can happen inside the libgit2-C libary,
so we don't know what could lead to an error

krauterbaquette requested review from aviac

2024-12-19 17:07:54 +00:00

krauterbaquette changed title from ~~WIP: delete command~~ to delete command

2024-12-19 17:08:18 +00:00

krauterbaquette force-pushed cmd-delete from af333e5974

Rust Checks / Run Rust Check (push) Failing after 2s

Details

to a4035aae7a

2024-12-21 17:37:10 +00:00

Compare

aviac approved these changes

2024-12-22 05:50:17 +00:00