mirror of
https://github.com/block/buzz.git
synced 2026-11-14 13:21:02 +00:00
## Summary This PR is stacked on #9064. It does two things to the Git-on-object-storage code in `buzz-relay`. It replaces the TLA+ model of the push protocol with one that states what the protocol is supposed to implement and checks that it does. It also changes the rule by which the relay decides whether to publish a push, because the new model shows that the rule #9064 introduces still publishes requests in which git accepted nothing. ### Relationship to #9064 The branch is `main`, then the two commits of #9064, then four commits of this PR: the specification work, the publish-rule change, a review fix merged from #9429, and a fix to `check.sh`. A merge of `main` follows them; it was needed because `main` changed `Justfile`, which #9429 also edits, after the branch point. The first two commits are #9064's, replayed onto current `main` without conflicts and otherwise unchanged. The base of this PR stays `main` because #9064's branch is about 200 commits behind it. Once #9064 merges, this branch can be rebased and the diff shrinks to the last four commits. Until then, review the commits after the first two. This PR keeps two of #9064's three changes as they are: the `published_at` stamp that orders kind:30618 events by the manifest chain, and `protect_landed`, which lets a landed conditional write stand when the serving lease lapses after it. It replaces the third, the publish rule. ### The publish rule #9064 publishes when git exits 0 and the status report has an `ok` line or no `ng` line. That handles a push in which one ref is updated and another refused. The report, however, is not evidence of what git did. - git exits 0 for a request that carries no commands, and for a push the pre-receive hook declined. A decline is reported only to a client that negotiated `report-status`. For a request with no commands, and for a decline when the client did not negotiate a report, there is no `ng` line. The relay then writes the pointer and emits a relay-signed kind:30618 event that names the caller as pusher, although the push policy approved nothing. - The report is read from a stream whose framing the client's capabilities determine, so the decision depends on parsing a client-shaped stream. The decision is now taken from the workspace. `push_disposition` compares the refs after receive-pack with the refs the workspace was hydrated from. Unchanged refs are answered with git's own output and nothing is published. Changed refs are published if git exited normally. Changed refs after an abnormal exit fail the request. The snapshot that is compared is the one `cas_publish` publishes, so git's per-ref report is true of the published state. The status-report scanner and its tests are removed, and the ref-name conflict case they covered moves into the table-driven test described below. Three smaller changes follow. The ref-snapshot parser now fails closed: output that was not UTF-8 used to read as an empty ref set and a malformed line was skipped, and either would publish a manifest that lacks refs. `manifest_changed` in `finalize_push` could not be false and is removed. Taking the snapshot before the publish decision moved its resource-limit error (snapshot larger than 4 MiB, or more refs than a manifest may hold) onto a path that answered 500; #9429 restores the 413 the publish path gave before and adds `snapshot_resource_limit_answers_413`. ### What the specification work adds - `docs/spec/GitRefDB.tla` is the specification: a ref database in which a push takes effect in one step, is applied only if authorized and only against the old values it names, and is reported truthfully. - `docs/spec/GitOnObjectStore.tla` is the protocol: several refs, an object graph with reachability, packs, compaction, the pre-receive hook, the publish decision, the default-branch setter, repository creation, and a reader. `git receive-pack` is represented by a stated contract rather than modeled internally. - The correctness statement is `Refines`: every behavior of the protocol is a behavior of the specification. TLC checks it together with the store invariants (fence, reader completeness, closure of published manifests). - `docs/spec/check.sh` pins TLC 1.7.4 by SHA-256 and runs 28 checks. Eight instances must pass. Nineteen seeded design errors must each be detected with the violation named for them. One coverage check confirms that a behavior the properties depend on (git reporting `ok` for a command that changes nothing) is reachable. A name passed to `check.sh` that is not a check is an error, so a misspelled selection cannot report success. - Both earlier publish rules are among the seeded errors: the original rule (exit 0 and no `ng`) and #9064's status-report rule. For each, TLC reports a publication the policy did not approve (`PublishIsAuthorizedChange`) and a violation of `Refines`. - `docs/spec/GitPushPath.qnt`, the Quint model from #9064 that covers the serving lease and the event timestamps, is extended. The publish rule becomes a parameter with three values, a request may carry no commands or come from a client without a status report, and a new invariant, `publicationChangesRefs`, states that a published manifest differs in its refs from the one it replaces. The implemented rule satisfies all four invariants; the status-report rule violates the new one with a zero-command request. - `docs/spec/lean/GitPointer.lean` is a Lean 4 proof, with no dependencies, of the pointer discipline for any number of clients, refs and objects: the fence, closure, that every pointer change is a legal step from the value it replaces, that the length of the pointer's predecessor chain equals the number of pointer writes, and that a successful conditional write implies no intervening write. - `.github/workflows/spec.yml` runs TLC and Lean when a file under `docs/spec/` changes. On this PR's first run the TLC job took 10 minutes 19 seconds and the Lean job 22 seconds. Quint is not run in CI. - `docs/git-on-object-storage.md` is revised to match. The push listing follows the implemented order. The verification section separates definitions, assumptions, results checked by TLC, results proved in Lean, results checked with Quint, evidence about the implementation, and limitations. The invariant names cited by code comments and by migration 0002 are kept as aliases in the TLA+ module. ### Assumptions and limitations The TLC results hold for the bounded instances in `check.sh`, not for arbitrary sizes. The Lean proof is unbounded but covers the pointer discipline only, not the refinement. The Quint results are from random simulation (2,000,000 runs of at most 14 steps) and a bounded symbolic check (8 steps, Apalache); neither is a proof for unbounded runs. All of them rest on the assumptions named in the document: the object store's conditional-write semantics, ETag equality implying body equality, no SHA-256 collision among the values that occur, the stated contract for `git receive-pack`, and the policy endpoint deciding authorization. The correspondence between the models and the Rust code is established by reading the code and by the tests below; it is not mechanized. The document states one assumption that #9064's ordering fix depends on and that no model covers (Assumption C1). A manifest whose parent carries no `published_at` (the empty manifest written when a repository is announced, or a manifest written before the field existed) is stamped with the writing instance's current time plus one second. Its event is selected over the parent's only if that value exceeds the parent event's `created_at`, which was taken from the clock of the instance that emitted it. This holds when one instance handles both, and otherwise when the writing instance's clock is not behind the other's by more than the time elapsed between the two events. The assumption concerns one write per repository. The document lists its removal as a proposed extension, for example by having the first push after an unstamped manifest read the stored event's `created_at` and exceed it. ### Related issue Related to #2621 (CI for the formal models). This adds the TLC job for the git model and a Lean job; it does not cover the Tamarin models or the NIP-PL scripts, so it should not close that issue. ### Testing Run locally on the restacked branch: - `docs/spec/check.sh`: 28 checks, each with the expected result (8 pass, 19 seeded errors violate the named property, 1 coverage witness reached). About three minutes on 16 cores; the largest instance has 6,773,286 distinct states. - `lake build` in `docs/spec/lean` (Lean 4.33.1): succeeds. The safety theorems depend only on `propext`, `Classical.choice` and `Quot.sound`. - Quint 0.33.0, `GitPushPath.qnt`: `quint run --main fixed --invariant safety --max-steps 14 --max-samples 2000000 --seed 0x1` reports no violation; `quint verify --main fixed --invariant safety --max-steps 8` (Apalache 0.62.1) reports no violation; each single-defect module produces the counterexample the document lists. - `cargo fmt --all -- --check` and `cargo clippy -p buzz-relay --all-targets -- -D warnings`: clean. - `cargo nextest run -p buzz-relay --lib -E 'test(/^api::/) + test(/side_effects/)'`: 158 passed. - The storage-backed `finalize_push` tests (`api:
:transport::track_c_tests::external_infra_minio_tests`, with `--run-ignored ignored-only`) against local Postgres and MinIO: 5 passed. - `e2e_git` against a local relay built from this branch, with Postgres, Redis and MinIO: 3 passed (clone/push/fetch/force-push round trip, concurrent push, partially refused push). The storage probe in that test needs `BUZZ_E2E_GIT_COMMUNITY_ID` set to the local community's id. - `just file-size-check` and `just security-review-check`: pass. Two regression tests bind the changed decision to production code, and both were confirmed to fail when the decision is forced back to the exit status: - `push_is_published_exactly_when_receive_pack_changed_refs` runs real git through the production `run_git_at` and `observe_push` for seven ways a push can end: a request with no commands, a push the hook declines with and without a status report, an accepted push, an accepted command that asks for the value the ref already has, a push in which one ref is updated and another refused for its old value, and a push that creates two refs whose names conflict, of which git creates one and refuses the other. It needs no services. Which of the two conflicting refs git creates depends on the git version (2.50 creates the first command's ref, 2.56 on the flake-check runner creates the other), so the test accepts either outcome and requires that each ref is in the published snapshot exactly when git reported `ok` for it. The first version of this case assumed one outcome and failed the Rust flake check for that reason. Before #9429, `just test-unit` selected neither `api:
:cas_publish::tests` nor `api:
:transport::track_c_tests`, so this test ran only in the flake check; both modules are now in the unit-test lane (45 tests, none needing services). It is Unix-only because its hook fixture sets file modes; the first push of this PR failed Windows clippy for that reason, and the test and its fixture are now gated with `#[cfg(unix)]`. That gating has not been compiled for Windows locally, so the Windows CI job is the check. - `finalize_push_publishes_nothing_when_receive_pack_changed_no_ref` calls `finalize_push` with an unchanged workspace and checks that the pointer is not written and no kind:30618 event is stored. It needs Postgres and an object store. Not done, or not covered: - No CI job selects the storage-backed `finalize_push` tests or `e2e_git`, so the second regression test and the end-to-end tests are evidence only when someone runs them. Adding them to CI needs a change to the test fixture, which applies migrations itself, and is left as a follow-up. - `just ci` was not run in full. - No human has tested the change. The human-testing step of the readiness checklist in `AGENTS.md` is not met, and `buzz-review-completed` is not claimed. The local secret-scanning hook (`sadscan`) was skipped for the commits and pushes that touch `crates/buzz-relay/src/api/git/settings_tests.rs`. It scans whole files and flags the P-256 test key fixtures that file already contains on `main`; this branch adds no key material. --------- Signed-off-by: Jordan Mecom <jm@squareup.com> Signed-off-by: Tom Brow <tomb@squareup.com> Co-authored-by: Tom Brow <tomb@squareup.com> Co-authored-by: studio <dc2fc481343672df31a689840c09299972e704dac592e0da6f18486646a7ee3e@localhost>
649 lines
22 KiB
Rust
649 lines
22 KiB
Rust
//! End-to-end git-over-object-storage tests.
|
|
//!
|
|
//! Drives the real `git` binary (clone / push / fetch / force-push / tag,
|
|
//! plus a best-effort concurrent push race) against a running relay backed by
|
|
//! S3/MinIO, exercising the full manifest-pointer CAS commit path described in
|
|
//! `docs/git-on-object-storage.md`.
|
|
//!
|
|
//! Requires: relay at localhost:3000 with git + S3/MinIO configured, `git` on
|
|
//! PATH, and the `git-credential-nostr` helper built. All tests are `#[ignore]`
|
|
//! so they don't run in CI by default.
|
|
//!
|
|
//! # Running
|
|
//!
|
|
//! ```text
|
|
//! cargo build --release -p git-credential-nostr
|
|
//! GIT_CREDENTIAL_NOSTR_BIN=$PWD/target/release/git-credential-nostr \
|
|
//! cargo test -p buzz-test-client --test e2e_git -- --ignored --nocapture
|
|
//! ```
|
|
|
|
use std::path::{Path, PathBuf};
|
|
use std::process::Command;
|
|
use std::time::Duration;
|
|
|
|
use buzz_media::S3AddressingStyle;
|
|
use nostr::{EventBuilder, Keys, Kind, Tag};
|
|
use s3::creds::Credentials;
|
|
use s3::{Bucket, Region};
|
|
|
|
fn relay_http_url() -> String {
|
|
std::env::var("RELAY_HTTP_URL").unwrap_or_else(|_| "http://localhost:3000".to_string())
|
|
}
|
|
|
|
/// Path to the compiled credential helper. Defaults to the workspace release
|
|
/// build; override with `GIT_CREDENTIAL_NOSTR_BIN`.
|
|
fn credential_helper() -> PathBuf {
|
|
if let Ok(p) = std::env::var("GIT_CREDENTIAL_NOSTR_BIN") {
|
|
return PathBuf::from(p);
|
|
}
|
|
// tests run from the crate dir; the workspace target is two levels up.
|
|
let mut p = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
|
|
p.pop();
|
|
p.pop();
|
|
p.push("target/release/git-credential-nostr");
|
|
p
|
|
}
|
|
|
|
/// Submit a signed event to the relay's HTTP bridge (`POST /events`).
|
|
async fn post_event(event: &nostr::Event) {
|
|
let client = reqwest::Client::new();
|
|
let resp = client
|
|
.post(format!("{}/events", relay_http_url()))
|
|
.header("X-Pubkey", event.pubkey.to_hex())
|
|
.header("Content-Type", "application/json")
|
|
.body(serde_json::to_string(event).unwrap())
|
|
.send()
|
|
.await
|
|
.expect("post event");
|
|
assert!(
|
|
resp.status().is_success(),
|
|
"event rejected: {}",
|
|
resp.text().await.unwrap_or_default()
|
|
);
|
|
}
|
|
|
|
/// Create a channel (kind:9007) owned by `keys` and return its UUID.
|
|
///
|
|
/// The git read gate (SEC-005) authorizes against membership in the channel
|
|
/// named by the announcement's `buzz-channel` tag, so every repo these tests
|
|
/// announce must be bound to a channel its owner belongs to — creating the
|
|
/// channel makes the creator its owner-member.
|
|
async fn create_test_channel(keys: &Keys) -> String {
|
|
let channel_uuid = uuid::Uuid::new_v4().to_string();
|
|
let event = EventBuilder::new(Kind::Custom(9007), "")
|
|
.tags(vec![
|
|
Tag::parse(["h", &channel_uuid]).unwrap(),
|
|
Tag::parse(["name", &format!("git-e2e-{channel_uuid}")]).unwrap(),
|
|
Tag::parse(["channel_type", "stream"]).unwrap(),
|
|
Tag::parse(["visibility", "open"]).unwrap(),
|
|
])
|
|
.sign_with_keys(keys)
|
|
.unwrap();
|
|
post_event(&event).await;
|
|
channel_uuid
|
|
}
|
|
|
|
/// Run `git` with the Buzz credential helper and isolated config.
|
|
fn git_status(args: &[&str], cwd: &Path, owner_nsec: &str) -> std::process::Output {
|
|
let helper = credential_helper();
|
|
Command::new("git")
|
|
.args([
|
|
"-c",
|
|
"credential.useHttpPath=true",
|
|
"-c",
|
|
&format!("credential.helper={}", helper.display()),
|
|
"-c",
|
|
"commit.gpgsign=false",
|
|
"-c",
|
|
"tag.gpgsign=false",
|
|
"-c",
|
|
"user.name=E2E",
|
|
"-c",
|
|
"user.email=e2e@example.com",
|
|
])
|
|
.args(args)
|
|
.current_dir(cwd)
|
|
// Isolate from any machine/agent git config (signing, etc.).
|
|
.env("GIT_CONFIG_GLOBAL", "/dev/null")
|
|
.env("GIT_CONFIG_NOSYSTEM", "1")
|
|
.env_remove("GIT_CONFIG_COUNT")
|
|
.env("NOSTR_PRIVATE_KEY", owner_nsec)
|
|
.output()
|
|
.expect("spawn git")
|
|
}
|
|
|
|
/// Run `git` with the Buzz credential helper and isolated config. Asserts the
|
|
/// command succeeds; returns stdout.
|
|
fn git(args: &[&str], cwd: &Path, owner_nsec: &str) -> String {
|
|
let out = git_status(args, cwd, owner_nsec);
|
|
assert!(
|
|
out.status.success(),
|
|
"git {:?} failed:\nstdout: {}\nstderr: {}",
|
|
args,
|
|
String::from_utf8_lossy(&out.stdout),
|
|
String::from_utf8_lossy(&out.stderr)
|
|
);
|
|
String::from_utf8_lossy(&out.stdout).into_owned()
|
|
}
|
|
|
|
struct GitS3Probe {
|
|
bucket: Box<Bucket>,
|
|
}
|
|
|
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
|
struct PointerSnapshot {
|
|
etag: String,
|
|
digest: String,
|
|
}
|
|
|
|
impl GitS3Probe {
|
|
fn bucket(
|
|
endpoint: String,
|
|
access_key: &str,
|
|
secret_key: &str,
|
|
bucket_name: &str,
|
|
region_name: String,
|
|
addressing_style: S3AddressingStyle,
|
|
) -> Box<Bucket> {
|
|
let region = Region::Custom {
|
|
region: region_name,
|
|
endpoint,
|
|
};
|
|
let creds = Credentials::new(Some(access_key), Some(secret_key), None, None, None)
|
|
.expect("S3 credentials");
|
|
let bucket = Bucket::new(bucket_name, region, creds).expect("S3 bucket");
|
|
match addressing_style {
|
|
S3AddressingStyle::Path => bucket.with_path_style(),
|
|
S3AddressingStyle::Virtual => bucket,
|
|
}
|
|
}
|
|
|
|
fn from_env() -> Self {
|
|
// These E2E assertions inspect the relay's backing bucket directly, so
|
|
// they must receive the same provider connection and URL style as the
|
|
// relay. Unit/live MinIO probes in buzz-relay keep explicit local
|
|
// fixtures and do not need provider overrides.
|
|
let endpoint = std::env::var("BUZZ_S3_ENDPOINT")
|
|
.unwrap_or_else(|_| "http://localhost:9000".to_string());
|
|
let access_key =
|
|
std::env::var("BUZZ_S3_ACCESS_KEY").unwrap_or_else(|_| "buzz_dev".to_string());
|
|
let secret_key =
|
|
std::env::var("BUZZ_S3_SECRET_KEY").unwrap_or_else(|_| "buzz_dev_secret".to_string());
|
|
let bucket_name =
|
|
std::env::var("BUZZ_S3_BUCKET").unwrap_or_else(|_| "buzz-media".to_string());
|
|
let region_name =
|
|
std::env::var("BUZZ_S3_REGION").unwrap_or_else(|_| "us-east-1".to_string());
|
|
let addressing_style = std::env::var("BUZZ_S3_ADDRESSING_STYLE")
|
|
.unwrap_or_else(|_| "path".to_string())
|
|
.parse::<S3AddressingStyle>()
|
|
.expect("BUZZ_S3_ADDRESSING_STYLE must be 'path' or 'virtual'");
|
|
|
|
let bucket = Self::bucket(
|
|
endpoint,
|
|
&access_key,
|
|
&secret_key,
|
|
&bucket_name,
|
|
region_name,
|
|
addressing_style,
|
|
);
|
|
Self { bucket }
|
|
}
|
|
|
|
fn pointer_key(owner: &str, repo: &str) -> String {
|
|
let repo = repo.strip_suffix(".git").unwrap_or(repo);
|
|
if let Ok(community) = std::env::var("BUZZ_E2E_GIT_COMMUNITY_ID") {
|
|
return format!("repos/{community}/{owner}/{repo}/pointer");
|
|
}
|
|
format!("repos/{owner}/{repo}/pointer")
|
|
}
|
|
|
|
async fn pointer(&self, owner: &str, repo: &str) -> Option<PointerSnapshot> {
|
|
let key = Self::pointer_key(owner, repo);
|
|
match self.bucket.get_object(&key).await {
|
|
Ok(resp) => {
|
|
let etag = resp
|
|
.headers()
|
|
.iter()
|
|
.find(|(k, _)| k.eq_ignore_ascii_case("etag"))
|
|
.map(|(_, v)| v.to_string())
|
|
.expect("pointer GET must include ETag");
|
|
let digest = String::from_utf8(resp.to_vec()).expect("pointer body utf-8");
|
|
assert_eq!(digest.len(), 64, "pointer body is manifest digest");
|
|
assert!(digest.chars().all(|c| c.is_ascii_hexdigit()));
|
|
Some(PointerSnapshot { etag, digest })
|
|
}
|
|
Err(s3::error::S3Error::HttpFailWithBody(404, _)) => None,
|
|
Err(e) => panic!("GET S3 pointer {key} failed: {e}"),
|
|
}
|
|
}
|
|
|
|
async fn require_pointer(&self, owner: &str, repo: &str) -> PointerSnapshot {
|
|
for _ in 0..40 {
|
|
if let Some(p) = self.pointer(owner, repo).await {
|
|
self.assert_manifest_exists(&p.digest).await;
|
|
return p;
|
|
}
|
|
tokio::time::sleep(Duration::from_millis(250)).await;
|
|
}
|
|
panic!(
|
|
"S3 manifest pointer {} never appeared; git may have fallen back to disk",
|
|
Self::pointer_key(owner, repo)
|
|
);
|
|
}
|
|
|
|
async fn assert_manifest_exists(&self, digest: &str) {
|
|
let key = format!("manifests/{digest}");
|
|
match self.bucket.get_object(&key).await {
|
|
Ok(_) => {}
|
|
Err(e) => panic!("pointer named manifest {key}, but GET failed: {e}"),
|
|
}
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn git_s3_probe_builds_both_addressing_styles() {
|
|
let path = GitS3Probe::bucket(
|
|
"https://storage.example".to_string(),
|
|
"access",
|
|
"secret",
|
|
"buzz-media",
|
|
"us-east-1".to_string(),
|
|
S3AddressingStyle::Path,
|
|
);
|
|
assert!(path.is_path_style());
|
|
assert_eq!(path.url(), "https://storage.example/buzz-media");
|
|
|
|
let virtual_hosted = GitS3Probe::bucket(
|
|
"https://storage.example".to_string(),
|
|
"access",
|
|
"secret",
|
|
"buzz-media",
|
|
"auto".to_string(),
|
|
S3AddressingStyle::Virtual,
|
|
);
|
|
assert!(virtual_hosted.is_subdomain_style());
|
|
assert_eq!(virtual_hosted.url(), "https://buzz-media.storage.example");
|
|
}
|
|
|
|
#[tokio::test]
|
|
#[ignore = "requires live relay + MinIO + git"]
|
|
async fn git_clone_push_fetch_force_roundtrip() {
|
|
use nostr::ToBech32;
|
|
|
|
let owner = Keys::generate();
|
|
let owner_hex = owner.public_key().to_hex();
|
|
let owner_nsec = owner.secret_key().to_bech32().unwrap();
|
|
let repo = format!("e2e-git-{}", std::process::id());
|
|
let s3 = GitS3Probe::from_env();
|
|
|
|
// Announce the repo (kind:30617) so the relay creates the bare repo + hook.
|
|
// The `buzz-channel` binding is the repo's ACL: without it the read gate
|
|
// 404s even for the owner (issue #3527), so bind to a channel the owner
|
|
// just created (and therefore belongs to).
|
|
let channel = create_test_channel(&owner).await;
|
|
let announce = EventBuilder::new(Kind::from(30617), "")
|
|
.tags(vec![
|
|
Tag::parse(["d", &repo]).unwrap(),
|
|
Tag::parse(["name", "e2e git repo"]).unwrap(),
|
|
Tag::parse(["buzz-channel", &channel]).unwrap(),
|
|
])
|
|
.sign_with_keys(&owner)
|
|
.unwrap();
|
|
post_event(&announce).await;
|
|
tokio::time::sleep(std::time::Duration::from_secs(2)).await;
|
|
|
|
let tmp = tempdir();
|
|
let url = format!("{}/git/{}/{}", relay_http_url(), owner_hex, repo);
|
|
|
|
// 1. Clone the empty repo.
|
|
git(
|
|
&["clone", "--quiet", &url, "clone1"],
|
|
tmp.path(),
|
|
&owner_nsec,
|
|
);
|
|
let clone1 = tmp.path().join("clone1");
|
|
assert!(clone1.exists(), "clone1 created");
|
|
let empty_pointer = s3.require_pointer(&owner_hex, &repo).await;
|
|
|
|
// 2. Push an initial commit.
|
|
std::fs::write(clone1.join("README.md"), "hello\n").unwrap();
|
|
git(&["add", "."], &clone1, &owner_nsec);
|
|
git(
|
|
&["commit", "--quiet", "-m", "initial"],
|
|
&clone1,
|
|
&owner_nsec,
|
|
);
|
|
git(&["branch", "-M", "main"], &clone1, &owner_nsec);
|
|
git(&["push", "--quiet", "origin", "main"], &clone1, &owner_nsec);
|
|
let p1 = s3.require_pointer(&owner_hex, &repo).await;
|
|
assert_ne!(
|
|
p1, empty_pointer,
|
|
"initial push must advance S3 manifest pointer"
|
|
);
|
|
let sha1 = git(&["rev-parse", "main"], &clone1, &owner_nsec)
|
|
.trim()
|
|
.to_string();
|
|
|
|
// 3. A fresh clone observes the pushed content and exact SHA.
|
|
git(
|
|
&["clone", "--quiet", &url, "clone2"],
|
|
tmp.path(),
|
|
&owner_nsec,
|
|
);
|
|
let clone2 = tmp.path().join("clone2");
|
|
assert_eq!(
|
|
std::fs::read_to_string(clone2.join("README.md")).unwrap(),
|
|
"hello\n",
|
|
"fresh clone sees pushed content"
|
|
);
|
|
assert_eq!(
|
|
git(&["rev-parse", "main"], &clone2, &owner_nsec).trim(),
|
|
sha1,
|
|
"fresh clone main == pushed SHA"
|
|
);
|
|
|
|
// 4. Second commit, push, pull into the other clone.
|
|
std::fs::write(clone1.join("README.md"), "hello\nmore\n").unwrap();
|
|
git(
|
|
&["commit", "--quiet", "-am", "second"],
|
|
&clone1,
|
|
&owner_nsec,
|
|
);
|
|
git(&["push", "--quiet", "origin", "main"], &clone1, &owner_nsec);
|
|
let p2 = s3.require_pointer(&owner_hex, &repo).await;
|
|
assert_ne!(p2, p1, "second push must advance S3 manifest pointer");
|
|
let sha2 = git(&["rev-parse", "main"], &clone1, &owner_nsec)
|
|
.trim()
|
|
.to_string();
|
|
git(&["pull", "--quiet", "origin", "main"], &clone2, &owner_nsec);
|
|
assert_eq!(
|
|
git(&["rev-parse", "main"], &clone2, &owner_nsec).trim(),
|
|
sha2,
|
|
"clone2 fetched second commit"
|
|
);
|
|
|
|
// 5. Force-push a rewritten history.
|
|
git(&["reset", "--quiet", "--hard", &sha1], &clone1, &owner_nsec);
|
|
std::fs::write(clone1.join("README.md"), "forced\n").unwrap();
|
|
git(
|
|
&["commit", "--quiet", "-am", "forced"],
|
|
&clone1,
|
|
&owner_nsec,
|
|
);
|
|
let sha_f = git(&["rev-parse", "main"], &clone1, &owner_nsec)
|
|
.trim()
|
|
.to_string();
|
|
git(
|
|
&["push", "--quiet", "--force", "origin", "main"],
|
|
&clone1,
|
|
&owner_nsec,
|
|
);
|
|
let p3 = s3.require_pointer(&owner_hex, &repo).await;
|
|
assert_ne!(p3, p2, "force push must advance S3 manifest pointer");
|
|
assert_ne!(sha_f, sha2);
|
|
|
|
// 6. A new clone after the force-push gets the rewritten history.
|
|
git(
|
|
&["clone", "--quiet", &url, "clone3"],
|
|
tmp.path(),
|
|
&owner_nsec,
|
|
);
|
|
assert_eq!(
|
|
std::fs::read_to_string(tmp.path().join("clone3/README.md")).unwrap(),
|
|
"forced\n",
|
|
"clone3 has force-pushed content"
|
|
);
|
|
|
|
// 7. Tag push survives the round-trip.
|
|
git(&["tag", "v1.0"], &clone1, &owner_nsec);
|
|
git(&["push", "--quiet", "origin", "v1.0"], &clone1, &owner_nsec);
|
|
let p4 = s3.require_pointer(&owner_hex, &repo).await;
|
|
assert_ne!(p4, p3, "tag push must advance S3 manifest pointer");
|
|
git(
|
|
&["clone", "--quiet", &url, "clone4"],
|
|
tmp.path(),
|
|
&owner_nsec,
|
|
);
|
|
let tags = git(&["tag"], &tmp.path().join("clone4"), &owner_nsec);
|
|
assert!(tags.contains("v1.0"), "tag v1.0 cloned back: {tags}");
|
|
}
|
|
|
|
#[tokio::test]
|
|
#[ignore = "requires live relay + MinIO + git"]
|
|
async fn git_concurrent_push_one_wins_and_repo_recovers() {
|
|
use nostr::ToBech32;
|
|
|
|
let owner = Keys::generate();
|
|
let owner_hex = owner.public_key().to_hex();
|
|
let owner_nsec = owner.secret_key().to_bech32().unwrap();
|
|
let repo = format!("e2e-git-concurrent-{}", std::process::id());
|
|
let s3 = GitS3Probe::from_env();
|
|
|
|
let channel = create_test_channel(&owner).await;
|
|
let announce = EventBuilder::new(Kind::from(30617), "")
|
|
.tags(vec![
|
|
Tag::parse(["d", &repo]).unwrap(),
|
|
Tag::parse(["name", "e2e concurrent git repo"]).unwrap(),
|
|
Tag::parse(["buzz-channel", &channel]).unwrap(),
|
|
])
|
|
.sign_with_keys(&owner)
|
|
.unwrap();
|
|
post_event(&announce).await;
|
|
tokio::time::sleep(std::time::Duration::from_secs(2)).await;
|
|
|
|
let tmp = tempdir_named("buzz-e2e-git-concurrent");
|
|
let url = format!("{}/git/{}/{}", relay_http_url(), owner_hex, repo);
|
|
|
|
git(&["clone", "--quiet", &url, "seed"], tmp.path(), &owner_nsec);
|
|
let seed = tmp.path().join("seed");
|
|
std::fs::write(seed.join("README.md"), "base\n").unwrap();
|
|
git(&["add", "."], &seed, &owner_nsec);
|
|
git(&["commit", "--quiet", "-m", "base"], &seed, &owner_nsec);
|
|
git(&["branch", "-M", "main"], &seed, &owner_nsec);
|
|
git(&["push", "--quiet", "origin", "main"], &seed, &owner_nsec);
|
|
let base_pointer = s3.require_pointer(&owner_hex, &repo).await;
|
|
let base_sha = git(&["rev-parse", "main"], &seed, &owner_nsec)
|
|
.trim()
|
|
.to_string();
|
|
|
|
let contenders = 8usize;
|
|
let mut contenders_info = Vec::new();
|
|
for i in 0..contenders {
|
|
let dir = format!("c{i}");
|
|
git(&["clone", "--quiet", &url, &dir], tmp.path(), &owner_nsec);
|
|
let worktree = tmp.path().join(&dir);
|
|
std::fs::write(
|
|
worktree.join(format!("file-{i}.txt")),
|
|
format!("winner? {i}\n"),
|
|
)
|
|
.unwrap();
|
|
git(&["add", "."], &worktree, &owner_nsec);
|
|
git(
|
|
&["commit", "--quiet", "-m", &format!("contender {i}")],
|
|
&worktree,
|
|
&owner_nsec,
|
|
);
|
|
let sha = git(&["rev-parse", "main"], &worktree, &owner_nsec)
|
|
.trim()
|
|
.to_string();
|
|
contenders_info.push((i, sha));
|
|
}
|
|
|
|
let mut children = Vec::new();
|
|
for i in 0..contenders {
|
|
let worktree = tmp.path().join(format!("c{i}"));
|
|
let owner_nsec = owner_nsec.clone();
|
|
children.push(std::thread::spawn(move || {
|
|
git_status(
|
|
&["push", "--quiet", "origin", "main"],
|
|
&worktree,
|
|
&owner_nsec,
|
|
)
|
|
}));
|
|
}
|
|
|
|
let mut successes = Vec::new();
|
|
let mut failures = 0usize;
|
|
for (i, child) in children.into_iter().enumerate() {
|
|
let out = child.join().expect("push thread panicked");
|
|
if out.status.success() {
|
|
successes.push(i);
|
|
} else {
|
|
failures += 1;
|
|
}
|
|
}
|
|
assert_eq!(successes.len(), 1, "exactly one concurrent push should win");
|
|
assert_eq!(failures, contenders - 1, "the rest should lose cleanly");
|
|
let winner_index = successes[0];
|
|
let winner_sha = contenders_info
|
|
.iter()
|
|
.find_map(|(i, sha)| (*i == winner_index).then_some(sha.clone()))
|
|
.expect("winner sha recorded");
|
|
|
|
let after_pointer = s3.require_pointer(&owner_hex, &repo).await;
|
|
assert_ne!(
|
|
after_pointer, base_pointer,
|
|
"winning push must advance S3 manifest pointer"
|
|
);
|
|
|
|
git(
|
|
&["clone", "--quiet", &url, "after"],
|
|
tmp.path(),
|
|
&owner_nsec,
|
|
);
|
|
let after = tmp.path().join("after");
|
|
let after_sha = git(&["rev-parse", "main"], &after, &owner_nsec)
|
|
.trim()
|
|
.to_string();
|
|
assert_ne!(after_sha, base_sha, "winner advanced main");
|
|
assert_eq!(
|
|
after_sha, winner_sha,
|
|
"published head must equal the successful contender's tip"
|
|
);
|
|
let log = git(
|
|
&["log", "--oneline", "--decorate", "-1"],
|
|
&after,
|
|
&owner_nsec,
|
|
);
|
|
assert!(
|
|
log.contains("contender"),
|
|
"published head is one contender: {log}"
|
|
);
|
|
}
|
|
|
|
/// A non-atomic multi-ref push can be partially accepted: git applies each ref
|
|
/// update independently and reports `ok` for the refs it applied. The relay
|
|
/// must publish those refs, or the client records an update that never landed.
|
|
#[tokio::test]
|
|
#[ignore = "requires live relay + MinIO + git"]
|
|
async fn git_partial_push_publishes_accepted_refs() {
|
|
use nostr::ToBech32;
|
|
|
|
let owner = Keys::generate();
|
|
let owner_hex = owner.public_key().to_hex();
|
|
let owner_nsec = owner.secret_key().to_bech32().unwrap();
|
|
let repo = format!("e2e-git-partial-{}", std::process::id());
|
|
let s3 = GitS3Probe::from_env();
|
|
|
|
let channel = create_test_channel(&owner).await;
|
|
let announce = EventBuilder::new(Kind::from(30617), "")
|
|
.tags(vec![
|
|
Tag::parse(["d", &repo]).unwrap(),
|
|
Tag::parse(["name", "e2e partial push repo"]).unwrap(),
|
|
Tag::parse(["buzz-channel", &channel]).unwrap(),
|
|
])
|
|
.sign_with_keys(&owner)
|
|
.unwrap();
|
|
post_event(&announce).await;
|
|
tokio::time::sleep(std::time::Duration::from_secs(2)).await;
|
|
|
|
let tmp = tempdir_named("buzz-e2e-git-partial");
|
|
let url = format!("{}/git/{}/{}", relay_http_url(), owner_hex, repo);
|
|
|
|
git(&["clone", "--quiet", &url, "work"], tmp.path(), &owner_nsec);
|
|
let work = tmp.path().join("work");
|
|
std::fs::write(work.join("README.md"), "base\n").unwrap();
|
|
git(&["add", "."], &work, &owner_nsec);
|
|
git(&["commit", "--quiet", "-m", "base"], &work, &owner_nsec);
|
|
git(&["branch", "-M", "main"], &work, &owner_nsec);
|
|
git(
|
|
&["push", "--quiet", "origin", "main", "main:feature"],
|
|
&work,
|
|
&owner_nsec,
|
|
);
|
|
let base_pointer = s3.require_pointer(&owner_hex, &repo).await;
|
|
|
|
// `feature/x` conflicts with the existing `feature` branch, so git rejects
|
|
// it while applying the fast-forward of `main`.
|
|
std::fs::write(work.join("README.md"), "base\nnext\n").unwrap();
|
|
git(&["commit", "--quiet", "-am", "next"], &work, &owner_nsec);
|
|
let next_sha = git(&["rev-parse", "main"], &work, &owner_nsec)
|
|
.trim()
|
|
.to_string();
|
|
let out = git_status(
|
|
&["push", "origin", "main", "main:refs/heads/feature/x"],
|
|
&work,
|
|
&owner_nsec,
|
|
);
|
|
let stderr = String::from_utf8_lossy(&out.stderr);
|
|
assert!(
|
|
!out.status.success(),
|
|
"feature/x must be rejected: {stderr}"
|
|
);
|
|
assert!(
|
|
stderr.contains("main -> main"),
|
|
"client reports main as pushed: {stderr}"
|
|
);
|
|
|
|
let after_pointer = s3.require_pointer(&owner_hex, &repo).await;
|
|
assert_ne!(
|
|
after_pointer, base_pointer,
|
|
"the accepted main update must advance the S3 manifest pointer"
|
|
);
|
|
git(
|
|
&["clone", "--quiet", &url, "after"],
|
|
tmp.path(),
|
|
&owner_nsec,
|
|
);
|
|
let after = tmp.path().join("after");
|
|
assert_eq!(
|
|
git(&["rev-parse", "main"], &after, &owner_nsec).trim(),
|
|
next_sha,
|
|
"a fresh clone sees the main update the client was told landed"
|
|
);
|
|
let feature_x = git_status(
|
|
&[
|
|
"rev-parse",
|
|
"--verify",
|
|
"--quiet",
|
|
"refs/remotes/origin/feature/x",
|
|
],
|
|
&after,
|
|
&owner_nsec,
|
|
);
|
|
assert!(!feature_x.status.success(), "rejected feature/x is absent");
|
|
}
|
|
|
|
struct TempDir(PathBuf);
|
|
impl TempDir {
|
|
fn path(&self) -> &Path {
|
|
&self.0
|
|
}
|
|
}
|
|
impl Drop for TempDir {
|
|
fn drop(&mut self) {
|
|
let _ = std::fs::remove_dir_all(&self.0);
|
|
}
|
|
}
|
|
fn tempdir() -> TempDir {
|
|
tempdir_named("buzz-e2e-git")
|
|
}
|
|
|
|
fn tempdir_named(prefix: &str) -> TempDir {
|
|
let mut p = std::env::temp_dir();
|
|
p.push(format!("{prefix}-{}", std::process::id()));
|
|
let _ = std::fs::remove_dir_all(&p);
|
|
std::fs::create_dir_all(&p).unwrap();
|
|
TempDir(p)
|
|
}
|
