From 62d7f2fb26f2843fa8f7ff8b988bac14e5f756e2 Mon Sep 17 00:00:00 2001 From: DanConwayDev Date: Wed, 14 Feb 2024 08:54:27 +0000 Subject: feat!: move `claim` > `init` this aligns with gitstr and is more intuative the idea behind using claim to indicate that it is only for maintainersto do is valid but its too confusing --- src/main.rs | 4 +- src/sub_commands/claim.rs | 152 ----------- src/sub_commands/init.rs | 152 +++++++++++ src/sub_commands/mod.rs | 2 +- tests/claim.rs | 655 ---------------------------------------------- tests/init.rs | 655 ++++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 810 insertions(+), 810 deletions(-) delete mode 100644 src/sub_commands/claim.rs create mode 100644 src/sub_commands/init.rs delete mode 100644 tests/claim.rs create mode 100644 tests/init.rs diff --git a/src/main.rs b/src/main.rs index 539d9ff..0e8e847 100644 --- a/src/main.rs +++ b/src/main.rs @@ -35,7 +35,7 @@ enum Commands { /// save encrypted nsec for future use Login(sub_commands::login::SubCommandArgs), /// issue repository reference event as a maintainers - Claim(sub_commands::claim::SubCommandArgs), + Init(sub_commands::init::SubCommandArgs), /// send a PR / patch / patch set via nostr events Send(sub_commands::send::SubCommandArgs), /// list open PRs / patches / patch sets and pull / apply them a branch @@ -51,7 +51,7 @@ async fn main() -> Result<()> { let cli = Cli::parse(); match &cli.command { Commands::Login(args) => sub_commands::login::launch(&cli, args).await, - Commands::Claim(args) => sub_commands::claim::launch(&cli, args).await, + Commands::Init(args) => sub_commands::init::launch(&cli, args).await, Commands::Send(args) => sub_commands::send::launch(&cli, args).await, Commands::List(args) => sub_commands::list::launch(&cli, args).await, Commands::Pull => sub_commands::pull::launch().await, diff --git a/src/sub_commands/claim.rs b/src/sub_commands/claim.rs deleted file mode 100644 index a95021d..0000000 --- a/src/sub_commands/claim.rs +++ /dev/null @@ -1,152 +0,0 @@ -use anyhow::{Context, Result}; - -use super::send::send_events; -#[cfg(not(test))] -use crate::client::Client; -#[cfg(test)] -use crate::client::MockConnect; -use crate::{ - cli_interactor::{Interactor, InteractorPrompt, PromptInputParms}, - client::Connect, - git::{Repo, RepoActions}, - login, - repo_ref::{extract_pks, get_repo_config_from_yaml, save_repo_config_to_yaml, RepoRef}, - Cli, -}; - -#[derive(Debug, clap::Args)] -pub struct SubCommandArgs { - #[clap(short, long)] - /// name of repository - title: Option, - #[clap(short, long)] - /// optional description - description: Option, - #[clap(short, long, value_parser, num_args = 1..)] - /// homepage - web: Vec, - #[clap(short, long, value_parser, num_args = 1..)] - /// relays contributors push patches and comments to - relays: Vec, -} - -pub async fn launch(cli_args: &Cli, args: &SubCommandArgs) -> Result<()> { - let git_repo = Repo::discover().context("cannot find a git repository")?; - - let root_commit = git_repo - .get_root_commit() - .context("failed to get root commit of the repository")?; - - // TODO: check for empty repo - // TODO: check for existing maintaiers file - - let repo_config_result = get_repo_config_from_yaml(&git_repo); - // TODO: check for other claims - - let name = match &args.title { - Some(t) => t.clone(), - None => Interactor::default().input(PromptInputParms::default().with_prompt("name"))?, - }; - - let description = match &args.description { - Some(t) => t.clone(), - None => Interactor::default() - .input(PromptInputParms::default().with_prompt("description (Optional)"))?, - }; - - let git_server = git_repo - .get_origin_url() - .context( - "to claim the repository it must be available on a publically accessable git server", - ) - .context("no git remote origin configured")?; - - let web: Vec = if args.web.is_empty() { - Interactor::default() - .input(PromptInputParms::default().with_prompt("description (Optional)"))? - .split(' ') - .map(std::string::ToString::to_string) - .collect() - } else { - args.web.clone() - }; - #[cfg(not(test))] - let mut client = Client::default(); - #[cfg(test)] - let mut client = ::default(); - - let (keys, user_ref) = login::launch(&cli_args.nsec, &cli_args.password, Some(&client)).await?; - - client.set_keys(&keys).await; - - let mut maintainers = vec![keys.public_key()]; - - let mut repo_relays: Vec = if !args.relays.is_empty() { - args.relays.clone() - } else if let Ok(config) = &repo_config_result { - config.relays.clone() - } else { - // TODO: choice input defaulting to user relay list filtered by non paid relays - // TODO: allow manual input for more relays - // TODO: reccommend some free relays - user_ref.relays.write() - }; - - // TODO: add blaster for just repo event and don't add it to repo relays - // TODO: fix the tests to support blaster - if std::env::var("NGITTEST").is_err() - && !repo_relays - .iter() - .any(|s| s.contains("nostr.mutinywallet.com")) - { - repo_relays.push("wss://nostr.mutinywallet.com".to_string()); - } - - if let Ok(config) = &repo_config_result { - maintainers = extract_pks(config.maintainers.clone())?; - } - - // if yaml file doesnt exist or needs updating - if match &repo_config_result { - Ok(config) => { - !(extract_pks(config.maintainers.clone())?.eq(&maintainers) - && config.relays.eq(&repo_relays)) - } - Err(_) => true, - } { - save_repo_config_to_yaml(&git_repo, maintainers.clone(), repo_relays.clone())?; - println!( - "maintainers.yaml {}. commit and push.", - if repo_config_result.is_err() { - "created" - } else { - "updated" - } - ); - } - - println!("publishing repostory reference..."); - - let repo_event = RepoRef { - identifier: root_commit.to_string()[..7].to_string(), - name, - description, - root_commit: root_commit.to_string(), - git_server, - web, - relays: repo_relays.clone(), - maintainers, - } - .to_event(&keys)?; - - send_events( - &client, - vec![repo_event], - user_ref.relays.write(), - repo_relays, - !cli_args.disable_cli_spinners, - ) - .await?; - - Ok(()) -} diff --git a/src/sub_commands/init.rs b/src/sub_commands/init.rs new file mode 100644 index 0000000..a95021d --- /dev/null +++ b/src/sub_commands/init.rs @@ -0,0 +1,152 @@ +use anyhow::{Context, Result}; + +use super::send::send_events; +#[cfg(not(test))] +use crate::client::Client; +#[cfg(test)] +use crate::client::MockConnect; +use crate::{ + cli_interactor::{Interactor, InteractorPrompt, PromptInputParms}, + client::Connect, + git::{Repo, RepoActions}, + login, + repo_ref::{extract_pks, get_repo_config_from_yaml, save_repo_config_to_yaml, RepoRef}, + Cli, +}; + +#[derive(Debug, clap::Args)] +pub struct SubCommandArgs { + #[clap(short, long)] + /// name of repository + title: Option, + #[clap(short, long)] + /// optional description + description: Option, + #[clap(short, long, value_parser, num_args = 1..)] + /// homepage + web: Vec, + #[clap(short, long, value_parser, num_args = 1..)] + /// relays contributors push patches and comments to + relays: Vec, +} + +pub async fn launch(cli_args: &Cli, args: &SubCommandArgs) -> Result<()> { + let git_repo = Repo::discover().context("cannot find a git repository")?; + + let root_commit = git_repo + .get_root_commit() + .context("failed to get root commit of the repository")?; + + // TODO: check for empty repo + // TODO: check for existing maintaiers file + + let repo_config_result = get_repo_config_from_yaml(&git_repo); + // TODO: check for other claims + + let name = match &args.title { + Some(t) => t.clone(), + None => Interactor::default().input(PromptInputParms::default().with_prompt("name"))?, + }; + + let description = match &args.description { + Some(t) => t.clone(), + None => Interactor::default() + .input(PromptInputParms::default().with_prompt("description (Optional)"))?, + }; + + let git_server = git_repo + .get_origin_url() + .context( + "to claim the repository it must be available on a publically accessable git server", + ) + .context("no git remote origin configured")?; + + let web: Vec = if args.web.is_empty() { + Interactor::default() + .input(PromptInputParms::default().with_prompt("description (Optional)"))? + .split(' ') + .map(std::string::ToString::to_string) + .collect() + } else { + args.web.clone() + }; + #[cfg(not(test))] + let mut client = Client::default(); + #[cfg(test)] + let mut client = ::default(); + + let (keys, user_ref) = login::launch(&cli_args.nsec, &cli_args.password, Some(&client)).await?; + + client.set_keys(&keys).await; + + let mut maintainers = vec![keys.public_key()]; + + let mut repo_relays: Vec = if !args.relays.is_empty() { + args.relays.clone() + } else if let Ok(config) = &repo_config_result { + config.relays.clone() + } else { + // TODO: choice input defaulting to user relay list filtered by non paid relays + // TODO: allow manual input for more relays + // TODO: reccommend some free relays + user_ref.relays.write() + }; + + // TODO: add blaster for just repo event and don't add it to repo relays + // TODO: fix the tests to support blaster + if std::env::var("NGITTEST").is_err() + && !repo_relays + .iter() + .any(|s| s.contains("nostr.mutinywallet.com")) + { + repo_relays.push("wss://nostr.mutinywallet.com".to_string()); + } + + if let Ok(config) = &repo_config_result { + maintainers = extract_pks(config.maintainers.clone())?; + } + + // if yaml file doesnt exist or needs updating + if match &repo_config_result { + Ok(config) => { + !(extract_pks(config.maintainers.clone())?.eq(&maintainers) + && config.relays.eq(&repo_relays)) + } + Err(_) => true, + } { + save_repo_config_to_yaml(&git_repo, maintainers.clone(), repo_relays.clone())?; + println!( + "maintainers.yaml {}. commit and push.", + if repo_config_result.is_err() { + "created" + } else { + "updated" + } + ); + } + + println!("publishing repostory reference..."); + + let repo_event = RepoRef { + identifier: root_commit.to_string()[..7].to_string(), + name, + description, + root_commit: root_commit.to_string(), + git_server, + web, + relays: repo_relays.clone(), + maintainers, + } + .to_event(&keys)?; + + send_events( + &client, + vec![repo_event], + user_ref.relays.write(), + repo_relays, + !cli_args.disable_cli_spinners, + ) + .await?; + + Ok(()) +} diff --git a/src/sub_commands/mod.rs b/src/sub_commands/mod.rs index b16d50f..9f97b7e 100644 --- a/src/sub_commands/mod.rs +++ b/src/sub_commands/mod.rs @@ -1,4 +1,4 @@ -pub mod claim; +pub mod init; pub mod list; pub mod login; pub mod pull; diff --git a/tests/claim.rs b/tests/claim.rs deleted file mode 100644 index fa7adcc..0000000 --- a/tests/claim.rs +++ /dev/null @@ -1,655 +0,0 @@ -use anyhow::Result; -use serial_test::serial; -use test_utils::{git::GitTestRepo, *}; - -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::*; - - mod when_repo_relays_specified_as_arguments { - use futures::join; - use test_utils::relay::Relay; - - use super::*; - - 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", - "--web", - "https://exampleproject.xyz", - "https://gitworkshop.dev/123", - "--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::*; - - #[tokio::test] - #[serial] - async fn only_1_repository_kind_event_sent_to_user_relays() -> Result<()> { - let (_, _, r53, r55, _) = prep_run_claim().await?; - for relay in [&r53, &r55] { - assert_eq!( - relay - .events - .iter() - .filter(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) - .count(), - 1, - ); - } - Ok(()) - } - - #[tokio::test] - #[serial] - async fn only_1_repository_kind_event_sent_to_specified_repo_relays() -> Result<()> { - let (_, _, _, r55, r56) = prep_run_claim().await?; - for relay in [&r55, &r56] { - assert_eq!( - relay - .events - .iter() - .filter(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) - .count(), - 1, - ); - } - Ok(()) - } - - #[tokio::test] - #[serial] - async fn event_not_sent_to_fallback_relay() -> Result<()> { - let (r51, r52, _, _, _) = prep_run_claim().await?; - 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(()) - }); - - // 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(()) - } - - #[tokio::test] - #[serial] - async fn contains_maintainers_and_relays() -> Result<()> { - async_run_test().await?; - Ok(()) - } - } - - mod tags { - use super::*; - - #[tokio::test] - #[serial] - async fn d_replaceable_event_identifier_defaults_to_root_commit_id_shorthand() - -> 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("9ee507f")) - ); - } - Ok(()) - } - - #[tokio::test] - #[serial] - async fn root_commit_as_reference() -> Result<()> { - let (_, _, r53, r55, r56) = prep_run_claim().await?; - 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("9ee507fc4357d7ee16a5d8901bedcd103f23c17d"))); - } - Ok(()) - } - - #[tokio::test] - #[serial] - async fn name() -> Result<()> { - let (_, _, r53, r55, r56) = prep_run_claim().await?; - 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("name") && t.as_vec()[1].eq("example-name")) - ); - } - Ok(()) - } - - #[tokio::test] - #[serial] - async fn description() -> Result<()> { - let (_, _, r53, r55, r56) = prep_run_claim().await?; - 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"))); - } - Ok(()) - } - - #[tokio::test] - #[serial] - async fn git_server() -> Result<()> { - let (_, _, r53, r55, r56) = prep_run_claim().await?; - 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("clone") - && t.as_vec()[1].eq("https://localhost:1000")) - ); - } - Ok(()) - } - - #[tokio::test] - #[serial] - async fn relays() -> Result<()> { - let (_, _, r53, r55, r56) = prep_run_claim().await?; - for relay in [&r53, &r55, &r56] { - let event: &nostr::Event = relay - .events - .iter() - .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) - .unwrap(); - let relays_tag = event - .tags - .iter() - .find(|t| t.as_vec()[0].eq("relays")) - .unwrap() - .as_vec(); - assert_eq!(relays_tag[1], "ws://localhost:8055",); - assert_eq!(relays_tag[2], "ws://localhost:8056",); - } - Ok(()) - } - - #[tokio::test] - #[serial] - async fn web() -> 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 web_tag = event - .tags - .iter() - .find(|t| t.as_vec()[0].eq("web")) - .unwrap() - .as_vec(); - assert_eq!(web_tag[1], "https://exampleproject.xyz",); - assert_eq!(web_tag[2], "https://gitworkshop.dev/123",); - } - Ok(()) - } - - #[test] - #[serial] - fn current_user_in_maintainers() -> 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 maintainers_tag = event - .tags - .iter() - .find(|t| t.as_vec()[0].eq("maintainers")) - .unwrap() - .as_vec(); - assert_eq!(maintainers_tag[1], TEST_KEY_1_KEYS.public_key().to_string()); - } - 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: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(()) - } - - #[tokio::test] - #[serial] - async fn check_cli_output() -> Result<()> { - run_test_async().await?; - Ok(()) - } - } - } - - mod when_repo_relays_not_specified { - use futures::join; - use test_utils::relay::Relay; - - use super::*; - - 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", - "--web", - "https://exampleproject.xyz", - "https://gitworkshop.dev/123", - ], - ) - } - - 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 tags { - use super::*; - - #[tokio::test] - #[serial] - async fn relays_match_user_write_relays() -> Result<()> { - let (_, _, r53, r55, _) = prep_run_claim().await?; - for relay in [&r53, &r55] { - 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("relays") - && t.as_vec()[1].eq("ws://localhost:8053") - && t.as_vec()[2].eq("ws://localhost:8055"))); - } - 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(()) - } - - #[tokio::test] - #[serial] - async fn check_cli_output() -> Result<()> { - run_test_async().await?; - Ok(()) - } - } - } -} - -// TODO: when_updating_existing_repoistory diff --git a/tests/init.rs b/tests/init.rs new file mode 100644 index 0000000..56ce332 --- /dev/null +++ b/tests/init.rs @@ -0,0 +1,655 @@ +use anyhow::Result; +use serial_test::serial; +use test_utils::{git::GitTestRepo, *}; + +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::*; + + mod when_repo_relays_specified_as_arguments { + use futures::join; + use test_utils::relay::Relay; + + use super::*; + + 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_init(git_repo: &GitTestRepo) -> CliTester { + CliTester::new_from_dir( + &git_repo.dir, + [ + "--nsec", + TEST_KEY_1_NSEC, + "--password", + TEST_PASSWORD, + "--disable-cli-spinners", + "init", + "--title", + "example-name", + "--description", + "example-description", + "--web", + "https://exampleproject.xyz", + "https://gitworkshop.dev/123", + "--relays", + "ws://localhost:8055", + "ws://localhost:8056", + ], + ) + } + + async fn prep_run_init() -> 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_init(&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::*; + + #[tokio::test] + #[serial] + async fn only_1_repository_kind_event_sent_to_user_relays() -> Result<()> { + let (_, _, r53, r55, _) = prep_run_init().await?; + for relay in [&r53, &r55] { + assert_eq!( + relay + .events + .iter() + .filter(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .count(), + 1, + ); + } + Ok(()) + } + + #[tokio::test] + #[serial] + async fn only_1_repository_kind_event_sent_to_specified_repo_relays() -> Result<()> { + let (_, _, _, r55, r56) = prep_run_init().await?; + for relay in [&r55, &r56] { + assert_eq!( + relay + .events + .iter() + .filter(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .count(), + 1, + ); + } + Ok(()) + } + + #[tokio::test] + #[serial] + async fn event_not_sent_to_fallback_relay() -> Result<()> { + let (r51, r52, _, _, _) = prep_run_init().await?; + 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_init(&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(()) + }); + + // 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(()) + } + + #[tokio::test] + #[serial] + async fn contains_maintainers_and_relays() -> Result<()> { + async_run_test().await?; + Ok(()) + } + } + + mod tags { + use super::*; + + #[tokio::test] + #[serial] + async fn d_replaceable_event_identifier_defaults_to_root_commit_id_shorthand() + -> Result<()> { + let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_init())?; + 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("9ee507f")) + ); + } + Ok(()) + } + + #[tokio::test] + #[serial] + async fn root_commit_as_reference() -> Result<()> { + let (_, _, r53, r55, r56) = prep_run_init().await?; + 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("9ee507fc4357d7ee16a5d8901bedcd103f23c17d"))); + } + Ok(()) + } + + #[tokio::test] + #[serial] + async fn name() -> Result<()> { + let (_, _, r53, r55, r56) = prep_run_init().await?; + 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("name") && t.as_vec()[1].eq("example-name")) + ); + } + Ok(()) + } + + #[tokio::test] + #[serial] + async fn description() -> Result<()> { + let (_, _, r53, r55, r56) = prep_run_init().await?; + 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"))); + } + Ok(()) + } + + #[tokio::test] + #[serial] + async fn git_server() -> Result<()> { + let (_, _, r53, r55, r56) = prep_run_init().await?; + 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("clone") + && t.as_vec()[1].eq("https://localhost:1000")) + ); + } + Ok(()) + } + + #[tokio::test] + #[serial] + async fn relays() -> Result<()> { + let (_, _, r53, r55, r56) = prep_run_init().await?; + for relay in [&r53, &r55, &r56] { + let event: &nostr::Event = relay + .events + .iter() + .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .unwrap(); + let relays_tag = event + .tags + .iter() + .find(|t| t.as_vec()[0].eq("relays")) + .unwrap() + .as_vec(); + assert_eq!(relays_tag[1], "ws://localhost:8055",); + assert_eq!(relays_tag[2], "ws://localhost:8056",); + } + Ok(()) + } + + #[tokio::test] + #[serial] + async fn web() -> Result<()> { + let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_init())?; + for relay in [&r53, &r55, &r56] { + let event: &nostr::Event = relay + .events + .iter() + .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .unwrap(); + let web_tag = event + .tags + .iter() + .find(|t| t.as_vec()[0].eq("web")) + .unwrap() + .as_vec(); + assert_eq!(web_tag[1], "https://exampleproject.xyz",); + assert_eq!(web_tag[2], "https://gitworkshop.dev/123",); + } + Ok(()) + } + + #[test] + #[serial] + fn current_user_in_maintainers() -> Result<()> { + let (_, _, r53, r55, r56) = futures::executor::block_on(prep_run_init())?; + for relay in [&r53, &r55, &r56] { + let event: &nostr::Event = relay + .events + .iter() + .find(|e| e.kind.as_u64().eq(&REPOSITORY_KIND)) + .unwrap(); + let maintainers_tag = event + .tags + .iter() + .find(|t| t.as_vec()[0].eq("maintainers")) + .unwrap() + .as_vec(); + assert_eq!(maintainers_tag[1], TEST_KEY_1_KEYS.public_key().to_string()); + } + 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_init(&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(()) + } + + #[tokio::test] + #[serial] + async fn check_cli_output() -> Result<()> { + run_test_async().await?; + Ok(()) + } + } + } + + mod when_repo_relays_not_specified { + use futures::join; + use test_utils::relay::Relay; + + use super::*; + + 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_init(git_repo: &GitTestRepo) -> CliTester { + CliTester::new_from_dir( + &git_repo.dir, + [ + "--nsec", + TEST_KEY_1_NSEC, + "--password", + TEST_PASSWORD, + "--disable-cli-spinners", + "init", + "--title", + "example-name", + "--description", + "example-description", + "--web", + "https://exampleproject.xyz", + "https://gitworkshop.dev/123", + ], + ) + } + + async fn prep_run_init() -> 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_init(&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 tags { + use super::*; + + #[tokio::test] + #[serial] + async fn relays_match_user_write_relays() -> Result<()> { + let (_, _, r53, r55, _) = prep_run_init().await?; + for relay in [&r53, &r55] { + 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("relays") + && t.as_vec()[1].eq("ws://localhost:8053") + && t.as_vec()[2].eq("ws://localhost:8055"))); + } + 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_init(&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(()) + } + + #[tokio::test] + #[serial] + async fn check_cli_output() -> Result<()> { + run_test_async().await?; + Ok(()) + } + } + } +} + +// TODO: when_updating_existing_repoistory -- cgit v1.2.3