From 3e52ecb609f8424cffb2e6398c599aa78224825a Mon Sep 17 00:00:00 2001 From: DanConwayDev Date: Tue, 12 Dec 2023 00:00:00 +0000 Subject: feat(claim) create yaml add maintainers and relays - create yaml file with maintainers and relays - add maintainers to repo event - add current user as maintainer - custom repo relays from cli argument - save git-server in repo event --- tests/claim.rs | 785 ++++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 556 insertions(+), 229 deletions(-) (limited to 'tests') diff --git a/tests/claim.rs b/tests/claim.rs index 61be68b..cd845f7 100644 --- a/tests/claim.rs +++ b/tests/claim.rs @@ -11,260 +11,509 @@ fn when_no_main_or_master_branch_return_error() -> Result<()> { Ok(()) } -mod sends_repoistory_to_relays { - use futures::join; - use test_utils::relay::Relay; +fn expect_msgs_first(p: &mut CliTester) -> Result<()> { + p.expect("searching for your details...\r\n")?; + p.expect("\r")?; + p.expect("logged in as fred\r\n")?; + // // p.expect("searching for existing claims on repository...\r\n")?; + p.expect("maintainers.yaml created. commit and push.\r\n")?; + p.expect("publishing repostory reference...\r\n")?; + Ok(()) +} +mod when_repo_not_previously_claimed { use super::*; - fn prep_git_repo() -> Result { - let test_repo = GitTestRepo::default(); - test_repo.populate()?; - Ok(test_repo) - } + mod when_repo_relays_specified_as_arguments { + use futures::join; + use test_utils::relay::Relay; - fn cli_tester_claim(git_repo: &GitTestRepo) -> CliTester { - CliTester::new_from_dir( - &git_repo.dir, - [ - "--nsec", - TEST_KEY_1_NSEC, - "--password", - TEST_PASSWORD, - "--disable-cli-spinners", - "claim", - "--title", - "example-name", - "--description", - "example-description", - ], - ) - } + use super::*; - fn expect_msgs_first(p: &mut CliTester) -> Result<()> { - p.expect("searching for your details...\r\n")?; - p.expect("\r")?; - p.expect("logged in as fred\r\n")?; - // // p.expect("searching for existing claims on repository...\r\n")?; - p.expect("publishing repostory reference...\r\n")?; - Ok(()) - } + fn prep_git_repo() -> Result { + let test_repo = GitTestRepo::default(); + test_repo.populate()?; + test_repo.add_remote("origin", "https://localhost:1000")?; + Ok(test_repo) + } - async fn prep_run_claim() -> Result<( - Relay<'static>, - Relay<'static>, - Relay<'static>, - Relay<'static>, - Relay<'static>, - )> { - let git_repo = prep_git_repo()?; - // fallback (51,52) user write (53, 55) repo (55, 56) - let (mut r51, mut r52, mut r53, mut r55, mut r56) = ( - Relay::new( - 8051, - None, - Some(&|relay, client_id, subscription_id, _| -> Result<()> { - relay.respond_events( - client_id, - &subscription_id, - &vec![ - generate_test_key_1_metadata_event("fred"), - generate_test_key_1_relay_list_event(), - ], - )?; + fn cli_tester_claim(git_repo: &GitTestRepo) -> CliTester { + CliTester::new_from_dir( + &git_repo.dir, + [ + "--nsec", + TEST_KEY_1_NSEC, + "--password", + TEST_PASSWORD, + "--disable-cli-spinners", + "claim", + "--title", + "example-name", + "--description", + "example-description", + "--relays", + "ws://localhost:8055", + "ws://localhost:8056", + ], + ) + } + + async fn prep_run_claim() -> Result<( + Relay<'static>, + Relay<'static>, + Relay<'static>, + Relay<'static>, + Relay<'static>, + )> { + let git_repo = prep_git_repo()?; + // fallback (51,52) user write (53, 55) repo (55, 56) + let (mut r51, mut r52, mut r53, mut r55, mut r56) = ( + Relay::new( + 8051, + None, + Some(&|relay, client_id, subscription_id, _| -> Result<()> { + relay.respond_events( + client_id, + &subscription_id, + &vec![ + generate_test_key_1_metadata_event("fred"), + generate_test_key_1_relay_list_event(), + ], + )?; + Ok(()) + }), + ), + Relay::new(8052, None, None), + Relay::new(8053, None, None), + Relay::new(8055, None, None), + Relay::new(8056, None, None), + ); + + // // check relay had the right number of events + let cli_tester_handle = std::thread::spawn(move || -> Result<()> { + let mut p = cli_tester_claim(&git_repo); + p.expect_end_eventually()?; + for p in [51, 52, 53, 55, 56] { + relay::shutdown_relay(8000 + p)?; + } + Ok(()) + }); + + // launch relay + let _ = join!( + r51.listen_until_close(), + r52.listen_until_close(), + r53.listen_until_close(), + r55.listen_until_close(), + r56.listen_until_close(), + ); + cli_tester_handle.join().unwrap()?; + Ok((r51, r52, r53, r55, r56)) + } + + mod sent_to_correct_relays { + use super::*; + + #[test] + #[serial] + fn only_1_repository_kind_event_sent_to_user_relays() -> Result<()> { + let (_, _, r53, r55, _) = futures::executor::block_on(prep_run_claim())?; + for relay in [&r53, &r55] { + assert_eq!( + relay + .events + .iter() + .filter(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .count(), + 1, + ); + } + Ok(()) + } + + #[test] + #[serial] + fn only_1_repository_kind_event_sent_to_specified_repo_relays() -> Result<()> { + let (_, _, _, r55, r56) = futures::executor::block_on(prep_run_claim())?; + for relay in [&r55, &r56] { + assert_eq!( + relay + .events + .iter() + .filter(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .count(), + 1, + ); + } + Ok(()) + } + + #[test] + #[serial] + fn event_not_sent_to_fallback_relay() -> Result<()> { + let (r51, r52, _, _, _) = futures::executor::block_on(prep_run_claim())?; + for relay in [&r51, &r52] { + assert_eq!( + relay + .events + .iter() + .filter(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .count(), + 0, + ); + } + Ok(()) + } + } + + mod yaml_file { + use std::{fs, io::Read}; + + use super::*; + + async fn async_run_test() -> Result<()> { + let git_repo = prep_git_repo()?; + // fallback (51,52) user write (53, 55) repo (55, 56) + let (mut r51, mut r52, mut r53, mut r55, mut r56) = ( + Relay::new( + 8051, + None, + Some(&|relay, client_id, subscription_id, _| -> Result<()> { + relay.respond_events( + client_id, + &subscription_id, + &vec![ + generate_test_key_1_metadata_event("fred"), + generate_test_key_1_relay_list_event(), + ], + )?; + Ok(()) + }), + ), + Relay::new(8052, None, None), + Relay::new(8053, None, None), + Relay::new(8055, None, None), + Relay::new(8056, None, None), + ); + + // // check relay had the right number of events + let cli_tester_handle = std::thread::spawn(move || -> Result<()> { + let mut p = cli_tester_claim(&git_repo); + p.expect_end_eventually()?; + + let yaml_path = git_repo.dir.join("maintainers.yaml"); + + assert!(yaml_path.exists()); + + let mut file = fs::File::open(yaml_path).expect("no such file"); + let mut file_contents = "".to_string(); + let _ = file.read_to_string(&mut file_contents); + assert_eq!( + file_contents, + format!( + "\ + maintainers:\n\ + - {TEST_KEY_1_NPUB}\n\ + relays:\n\ + - ws://localhost:8055\n\ + - ws://localhost:8056\n\ + " + ), + ); + for p in [51, 52, 53, 55, 56] { + relay::shutdown_relay(8000 + p)?; + } Ok(()) - }), - ), - Relay::new(8052, None, None), - Relay::new(8053, None, None), - Relay::new(8055, None, None), - Relay::new(8056, None, None), - ); - - // // check relay had the right number of events - let cli_tester_handle = std::thread::spawn(move || -> Result<()> { - let mut p = cli_tester_claim(&git_repo); - p.expect_end_eventually()?; - for p in [51, 52, 53, 55, 56] { - relay::shutdown_relay(8000 + p)?; + }); + + // launch relay + let _ = join!( + r51.listen_until_close(), + r52.listen_until_close(), + r53.listen_until_close(), + r55.listen_until_close(), + r56.listen_until_close(), + ); + cli_tester_handle.join().unwrap()?; + Ok(()) } - Ok(()) - }); - - // launch relay - let _ = join!( - r51.listen_until_close(), - r52.listen_until_close(), - r53.listen_until_close(), - r55.listen_until_close(), - r56.listen_until_close(), - ); - cli_tester_handle.join().unwrap()?; - Ok((r51, r52, r53, r55, r56)) - } - mod sent_to_correct_relays { - use super::*; + #[test] + #[serial] + fn contains_maintainers_and_relays() -> Result<()> { + futures::executor::block_on(async_run_test())?; + Ok(()) + } + } + + mod tags { + use super::*; - #[test] - #[serial] - fn only_1_repository_kind_event_sent_to_user_relays() -> Result<()> { - let (_, _, r53, r55, _) = futures::executor::block_on(prep_run_claim())?; - for relay in [&r53, &r55] { - assert_eq!( - relay + #[test] + #[serial] + fn root_commit_as_d_replaceable_event_identifier() -> Result<()> { + let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_claim())?; + for relay in [&r53, &r55, &r56] { + let event: &nostr::Event = relay .events .iter() - .filter(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) - .count(), - 1, - ); + .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .unwrap(); + + assert!(event.tags.iter().any(|t| t.as_vec()[0].eq("d") + && t.as_vec()[1].eq("9ee507fc4357d7ee16a5d8901bedcd103f23c17d"))); + } + Ok(()) } - Ok(()) - } - #[test] - #[serial] - fn only_1_repository_kind_event_sent_to_repo_relays() -> Result<()> { - let (_, _, _, r55, r56) = futures::executor::block_on(prep_run_claim())?; - for relay in [&r55, &r56] { - assert_eq!( - relay + #[test] + #[serial] + fn root_commit_as_reference() -> Result<()> { + let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_claim())?; + for relay in [&r53, &r55, &r56] { + let event: &nostr::Event = relay .events .iter() - .filter(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) - .count(), - 1, - ); + .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .unwrap(); + + // root commit 'r' tag with 'r-' prefix + assert!(event.tags.iter().any(|t| t.as_vec()[0].eq("r") + && t.as_vec()[1].eq("r-9ee507fc4357d7ee16a5d8901bedcd103f23c17d"))); + } + Ok(()) } - Ok(()) - } - #[test] - #[serial] - fn event_not_sent_to_fallback_relay() -> Result<()> { - let (r51, r52, _, _, _) = futures::executor::block_on(prep_run_claim())?; - for relay in [&r51, &r52] { - assert_eq!( - relay + #[test] + #[serial] + fn name() -> Result<()> { + let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_claim())?; + for relay in [&r53, &r55, &r56] { + let event: &nostr::Event = relay .events .iter() - .filter(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) - .count(), - 0, - ); + .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .unwrap(); + + assert!( + event + .tags + .iter() + .any(|t| t.as_vec()[0].eq("name") && t.as_vec()[1].eq("example-name")) + ); + } + Ok(()) } - Ok(()) - } - } - mod tags { - use super::*; + #[test] + #[serial] + fn description() -> Result<()> { + let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_claim())?; + for relay in [&r53, &r55, &r56] { + let event: &nostr::Event = relay + .events + .iter() + .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .unwrap(); - #[test] - #[serial] - fn root_commit_as_d_replaceable_event_identifier() -> Result<()> { - let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_claim())?; - for relay in [&r53, &r55, &r56] { - let event: &nostr::Event = relay - .events - .iter() - .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) - .unwrap(); - - assert!(event.tags.iter().any(|t| t.as_vec()[0].eq("d") - && t.as_vec()[1].eq("9ee507fc4357d7ee16a5d8901bedcd103f23c17d"))); + assert!(event.tags.iter().any(|t| t.as_vec()[0].eq("description") + && t.as_vec()[1].eq("example-description"))); + } + Ok(()) } - Ok(()) - } - #[test] - #[serial] - fn root_commit_as_reference() -> Result<()> { - let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_claim())?; - for relay in [&r53, &r55, &r56] { - let event: &nostr::Event = relay - .events - .iter() - .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) - .unwrap(); - - // root commit 'r' tag with 'r-' prefix - assert!(event.tags.iter().any(|t| t.as_vec()[0].eq("r") - && t.as_vec()[1].eq("r-9ee507fc4357d7ee16a5d8901bedcd103f23c17d"))); + #[test] + #[serial] + fn git_server() -> Result<()> { + let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_claim())?; + for relay in [&r53, &r55, &r56] { + let event: &nostr::Event = relay + .events + .iter() + .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .unwrap(); + + assert!(event.tags.iter().any(|t| t.as_vec()[0].eq("git-server") + && t.as_vec()[1].eq("https://localhost:1000"))); + } + Ok(()) + } + + #[test] + #[serial] + fn git_server_as_reference() -> Result<()> { + let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_claim())?; + for relay in [&r53, &r55, &r56] { + let event: &nostr::Event = relay + .events + .iter() + .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .unwrap(); + + assert!(event.tags.iter().any( + |t| t.as_vec()[0].eq("r") && t.as_vec()[1].eq("https://localhost:1000") + )); + } + Ok(()) } - Ok(()) - } - #[test] - #[serial] - fn name() -> Result<()> { - let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_claim())?; - for relay in [&r53, &r55, &r56] { - let event: &nostr::Event = relay - .events - .iter() - .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) - .unwrap(); - - assert!( - event + #[test] + #[serial] + fn relays() -> Result<()> { + let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_claim())?; + for relay in [&r53, &r55, &r56] { + let event: &nostr::Event = relay + .events + .iter() + .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .unwrap(); + + let relay_tags = event .tags .iter() - .any(|t| t.as_vec()[0].eq("name") && t.as_vec()[1].eq("example-name")) - ); + .filter(|t| t.as_vec()[0].eq("relay")) + .collect::>(); + assert_eq!(relay_tags[0].as_vec()[1], "ws://localhost:8055"); + assert_eq!(relay_tags[1].as_vec()[1], "ws://localhost:8056"); + } + Ok(()) + } + + #[test] + #[serial] + fn current_user_tagged_indicating_maintainer() -> Result<()> { + let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_claim())?; + for relay in [&r53, &r55, &r56] { + let event: &nostr::Event = relay + .events + .iter() + .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .unwrap(); + + let relay_tags = event + .tags + .iter() + .filter(|t| t.as_vec()[0].eq("p")) + .collect::>(); + assert_eq!(relay_tags.len(), 1); + assert_eq!( + relay_tags[0].as_vec()[1], + TEST_KEY_1_KEYS.public_key().to_string() + ); + } + Ok(()) } - Ok(()) } - #[test] - #[serial] - fn description() -> Result<()> { - let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_claim())?; - for relay in [&r53, &r55, &r56] { - let event: &nostr::Event = relay - .events - .iter() - .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) - .unwrap(); - - assert!( - event.tags.iter().any(|t| t.as_vec()[0].eq("description") - && t.as_vec()[1].eq("example-description")) + mod cli_ouput { + use super::*; + + async fn run_test_async() -> Result<()> { + let git_repo = prep_git_repo()?; + + let (mut r51, mut r52, mut r53, mut r55, mut r56) = ( + Relay::new( + 8051, + None, + Some(&|relay, client_id, subscription_id, _| -> Result<()> { + relay.respond_events( + client_id, + &subscription_id, + &vec![ + generate_test_key_1_metadata_event("fred"), + generate_test_key_1_relay_list_event(), + ], + )?; + Ok(()) + }), + ), + Relay::new(8052, None, None), + Relay::new(8053, None, None), + Relay::new(8055, None, None), + Relay::new(8056, None, None), ); + + // // check relay had the right number of events + let cli_tester_handle = std::thread::spawn(move || -> Result<()> { + let mut p = cli_tester_claim(&git_repo); + expect_msgs_first(&mut p)?; + relay::expect_send_with_progress( + &mut p, + vec![ + (" [my-relay] [repo-relay] ws://localhost:8055", true, ""), + (" [my-relay] ws://localhost:8053", true, ""), + (" [repo-relay] ws://localhost:8056", true, ""), + ], + 1, + )?; + p.expect_end_with_whitespace()?; + for p in [51, 52, 53, 55, 56] { + relay::shutdown_relay(8000 + p)?; + } + Ok(()) + }); + + // launch relay + let _ = join!( + r51.listen_until_close(), + r52.listen_until_close(), + r53.listen_until_close(), + r55.listen_until_close(), + r56.listen_until_close(), + ); + cli_tester_handle.join().unwrap()?; + Ok(()) } - Ok(()) - } - #[test] - #[serial] - fn relays() -> Result<()> { - let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_claim())?; - for relay in [&r53, &r55, &r56] { - let event: &nostr::Event = relay - .events - .iter() - .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) - .unwrap(); - - let relay_tags = event - .tags - .iter() - .filter(|t| t.as_vec()[0].eq("relay")) - .collect::>(); - assert_eq!(relay_tags[0].as_vec()[1], "ws://localhost:8055"); - assert_eq!(relay_tags[1].as_vec()[1], "ws://localhost:8056"); + #[test] + #[serial] + fn check_cli_output() -> Result<()> { + futures::executor::block_on(run_test_async())?; + Ok(()) } - Ok(()) } } - mod cli_ouput { + mod when_repo_relays_not_specified { + use futures::join; + use test_utils::relay::Relay; + use super::*; - async fn run_test_async() -> Result<()> { - let git_repo = prep_git_repo()?; + fn prep_git_repo() -> Result { + let test_repo = GitTestRepo::default(); + test_repo.populate()?; + test_repo.add_remote("origin", "https://localhost:1000")?; + Ok(test_repo) + } + + fn cli_tester_claim(git_repo: &GitTestRepo) -> CliTester { + CliTester::new_from_dir( + &git_repo.dir, + [ + "--nsec", + TEST_KEY_1_NSEC, + "--password", + TEST_PASSWORD, + "--disable-cli-spinners", + "claim", + "--title", + "example-name", + "--description", + "example-description", + ], + ) + } + async fn prep_run_claim() -> Result<( + Relay<'static>, + Relay<'static>, + Relay<'static>, + Relay<'static>, + Relay<'static>, + )> { + let git_repo = prep_git_repo()?; + // fallback (51,52) user write (53, 55) repo (55, 56) let (mut r51, mut r52, mut r53, mut r55, mut r56) = ( Relay::new( 8051, @@ -290,17 +539,7 @@ mod sends_repoistory_to_relays { // // check relay had the right number of events let cli_tester_handle = std::thread::spawn(move || -> Result<()> { let mut p = cli_tester_claim(&git_repo); - expect_msgs_first(&mut p)?; - relay::expect_send_with_progress( - &mut p, - vec![ - (" [my-relay] [repo-relay] ws://localhost:8055", true, ""), - (" [my-relay] ws://localhost:8053", true, ""), - (" [repo-relay] ws://localhost:8056", true, ""), - ], - 1, - )?; - p.expect_end_with_whitespace()?; + p.expect_end_eventually()?; for p in [51, 52, 53, 55, 56] { relay::shutdown_relay(8000 + p)?; } @@ -316,14 +555,102 @@ mod sends_repoistory_to_relays { r56.listen_until_close(), ); cli_tester_handle.join().unwrap()?; - Ok(()) + Ok((r51, r52, r53, r55, r56)) + } + + mod tags { + use super::*; + + #[test] + #[serial] + fn relays_match_user_write_relays() -> Result<()> { + let (_, _, r53, r55, _) = futures::executor::block_on(prep_run_claim())?; + for relay in [&r53, &r55] { + let event: &nostr::Event = relay + .events + .iter() + .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .unwrap(); + + let relay_tags = event + .tags + .iter() + .filter(|t| t.as_vec()[0].eq("relay")) + .collect::>(); + assert_eq!(relay_tags[0].as_vec()[1], "ws://localhost:8053"); + assert_eq!(relay_tags[1].as_vec()[1], "ws://localhost:8055"); + } + Ok(()) + } } - #[test] - #[serial] - fn check_cli_output() -> Result<()> { - futures::executor::block_on(run_test_async())?; - Ok(()) + mod cli_ouput { + use super::*; + + async fn run_test_async() -> Result<()> { + let git_repo = prep_git_repo()?; + + let (mut r51, mut r52, mut r53, mut r55, mut r56) = ( + Relay::new( + 8051, + None, + Some(&|relay, client_id, subscription_id, _| -> Result<()> { + relay.respond_events( + client_id, + &subscription_id, + &vec![ + generate_test_key_1_metadata_event("fred"), + generate_test_key_1_relay_list_event(), + ], + )?; + Ok(()) + }), + ), + Relay::new(8052, None, None), + Relay::new(8053, None, None), + Relay::new(8055, None, None), + Relay::new(8056, None, None), + ); + + // // check relay had the right number of events + let cli_tester_handle = std::thread::spawn(move || -> Result<()> { + let mut p = cli_tester_claim(&git_repo); + expect_msgs_first(&mut p)?; + relay::expect_send_with_progress( + &mut p, + vec![ + (" [my-relay] [repo-relay] ws://localhost:8053", true, ""), + (" [my-relay] [repo-relay] ws://localhost:8055", true, ""), + ], + 1, + )?; + p.expect_end_with_whitespace()?; + for p in [51, 52, 53, 55, 56] { + relay::shutdown_relay(8000 + p)?; + } + Ok(()) + }); + + // launch relay + let _ = join!( + r51.listen_until_close(), + r52.listen_until_close(), + r53.listen_until_close(), + r55.listen_until_close(), + r56.listen_until_close(), + ); + cli_tester_handle.join().unwrap()?; + Ok(()) + } + + #[test] + #[serial] + fn check_cli_output() -> Result<()> { + futures::executor::block_on(run_test_async())?; + Ok(()) + } } } } + +// TODO: when_updating_existing_repoistory -- cgit v1.2.3