Proposal for unit & integration testing

.github/workflows/rust.yml

@@ -15,8 +15,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - name: CheckoutRepo
+      uses: actions/checkout@v2
     - name: Build
-      run: cargo build --release --verbose
-    - name: Run tests
-      run: cargo test --release --verbose
+      run: cargo build --release
+    - name: Test
+      run: RUST_BACKTRACE=1 cargo test --release

.gitignore

@@ -4,7 +4,7 @@
 
 # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
 # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-Cargo.lock
+#Cargo.lock
 
 # These are backup files generated by rustfmt
 **/*.rs.bk

Cargo.toml

@@ -7,31 +7,12 @@ edition = "2018"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+regex = "1"
+lazy_static = "1.4.0"
+
+[dev-dependencies]
+tempdir = "0.3.7"
 
 [lib]
 name = "libgitpr"
 path = "src/lib.rs"
-
-[[bin]]
-name = "git-pr-list"
-path = "src/list.rs"
-
-[[bin]]
-name = "git-pr-clean"
-path = "src/clean.rs"
-
-[[bin]]
-name = "git-pr-accept"
-path = "src/accept.rs"
-
-[[bin]]
-name = "git-pr-create"
-path = "src/create.rs"
-
-[[bin]]
-name = "git-pr-rebase"
-path = "src/rebase.rs"
-
-[[bin]]
-name = "git-pr-abandon"
-path = "src/abandon.rs"

README.md

@@ -1,3 +1,43 @@
 ![build status](https://github.com/robertdfrench/git-pr/actions/workflows/rust.yml/badge.svg)
-# git-pr
-Pull requests without Git(Hub|Lab)
+# `git-pr`
+*Pull requests without Git{Hub,Lab,Whatever}*
+
+[License](https://github.com/robertdfrench/portunusd/blob/trunk/LICENSE)
+❘
+[Roadmap](https://github.com/robertdfrench/git-pr/milestones)
+❘
+[Download](https://github.com/robertdfrench/git-pr/releases)
+
+Git does not support pull requests by default, but it could! By following a few
+simple conventions, any shared repository can support pull requests without
+additional tooling required from the host. `git-pr` is tooling to implement
+those conventions, making it easy to create, approve, or destroy pull requests
+-- all from the command line:
+
+```console
+$ git pr-create hotfix # Create a new branch for an emergency hotfix
+Switched to a new branch 'hotfix/0'
+...
+ * [new branch]      hotfix/0 -> hotfix/0
+Branch 'hotfix/0' set up to track remote branch 'hotfix/0' from 'origin'.
+$ # (code code code...)
+$ git push # Submit for review... it's just a branch!
+```
+
+Meanwhile, your collaborators can check for the latest updates, review your
+changes, and even merge them:
+
+```console
+$ git pr-list # Check the server for new PRs
+...
+ * [new branch]      hotfix/0 -> hotfix/0
+hotfix
+remove-hardcoded-passwords
+use-git-pr-tool
+$ # (review review review...)
+$ git pr-accept hotfix # LGTM!
+```
+
+Given this minimalist approach, the means of communication is up to you. We
+don't try to force you into some mechanism that just ends up emailing you
+anyway. :smirk:

src/bin/failing_git.rs

@@ -0,0 +1,8 @@
+//! A program that always returns an error.
+//!
+//! Used to facilitate testing scenarios where git should immediately fail.
+use std::process::exit;
+
+fn main() {
+    exit(1)
+}

src/bin/fake_git.rs

@@ -0,0 +1,18 @@
+//! A mock implementation of git.
+//!
+//! Used to facilitate testing scenarios where prescribed behavior is required, and would be too
+//! cumbersome to obtain from "real git". Should only be used in unit testing; integration tests
+//! should still run against an actual git binary.
+use std::env;
+use std::process::exit;
+
+fn main() {
+    let first_arg = env::args().nth(1);
+    match first_arg.as_deref() {
+        None => exit(1),
+        Some("--version") => println!("fake_git version 1"),
+        Some(_) => exit(1)
+    };
+
+    exit(0);
+}

src/bin/git-pr-list.rs

@@ -0,0 +1,15 @@
+//! Display a list of currently active Pull Requests
+//!
+//! By "currently active", we mean "not yet deleted from the remote".
+use libgitpr;
+
+fn main() -> Result<(),libgitpr::GitError> {
+    let git = libgitpr::Git::new();
+    git.fetch_prune()?;
+    let branches = git.all_branches()?;
+
+    for pr_name in libgitpr::extract_pr_names(&branches) {
+        println!("{}", pr_name);
+    }
+    Ok(())
+}