upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/tests/prs_create.rs
blob: 0863496f4a7a12106560c5951bce60040158d156 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
use anyhow::Result;
use serial_test::serial;
use test_utils::{git::GitTestRepo, *};

#[test]
fn when_to_branch_doesnt_exist_return_error() -> Result<()> {
    let test_repo = GitTestRepo::default();
    test_repo.populate()?;
    let mut p = CliTester::new_from_dir(
        &test_repo.dir,
        ["prs", "create", "--to-branch", "nonexistant"],
    );
    p.expect("Error: cannot find to_branch 'nonexistant'")?;
    Ok(())
}

#[test]
fn when_no_to_branch_specified_and_no_main_or_master_branch_return_error() -> Result<()> {
    let test_repo = GitTestRepo::new("notmain")?;
    test_repo.populate()?;
    let mut p = CliTester::new_from_dir(&test_repo.dir, ["prs", "create"]);
    p.expect("Error: a destination branch (to_branch) is not specified and the defaults (main or master) do not exist")?;
    Ok(())
}

#[test]
fn when_from_branch_doesnt_exist_return_error() -> Result<()> {
    let test_repo = GitTestRepo::default();
    test_repo.populate()?;
    let mut p = CliTester::new_from_dir(
        &test_repo.dir,
        ["prs", "create", "--from-branch", "nonexistant"],
    );
    p.expect("Error: cannot find from_branch 'nonexistant'")?;
    Ok(())
}

#[test]
fn when_no_commits_ahead_of_main_return_error() -> Result<()> {
    let test_repo = GitTestRepo::default();
    test_repo.populate()?;
    // create feature branch with 1 commit ahead
    test_repo.create_branch("feature")?;
    test_repo.checkout("feature")?;

    let mut p = CliTester::new_from_dir(&test_repo.dir, ["prs", "create"]);
    p.expect("Error: 'head' is 0 commits ahead of 'main' so no patches were created")?;
    Ok(())
}

mod when_commits_behind_ask_to_proceed {
    use super::*;

    fn prep_test_repo() -> Result<GitTestRepo> {
        let test_repo = GitTestRepo::default();
        test_repo.populate()?;
        // create feature branch with 2 commit ahead
        test_repo.create_branch("feature")?;
        test_repo.checkout("feature")?;
        std::fs::write(test_repo.dir.join("t3.md"), "some content")?;
        test_repo.stage_and_commit("add t3.md")?;
        std::fs::write(test_repo.dir.join("t4.md"), "some content")?;
        test_repo.stage_and_commit("add t4.md")?;
        // checkout main and add 1 commit
        test_repo.checkout("main")?;
        std::fs::write(test_repo.dir.join("t5.md"), "some content")?;
        test_repo.stage_and_commit("add t5.md")?;
        // checkout feature branch
        test_repo.checkout("feature")?;
        Ok(test_repo)
    }
    static BEHIND_LEN: u8 = 1;
    static AHEAD_LEN: u8 = 2;

    fn expect_confirm_prompt(
        p: &mut CliTester,
        behind: u8,
        ahead: u8,
    ) -> Result<CliTesterConfirmPrompt> {
        p.expect_confirm(
            format!("'head' is {behind} commits behind 'main' and {ahead} ahead. Consider rebasing before sending patches. Proceed anyway?").as_str(),
            Some(false),
        )
    }

    #[test]
    fn asked_with_default_no() -> Result<()> {
        let test_repo = prep_test_repo()?;

        let mut p = CliTester::new_from_dir(&test_repo.dir, ["prs", "create"]);
        expect_confirm_prompt(&mut p, BEHIND_LEN, AHEAD_LEN)?;
        p.exit()?;
        Ok(())
    }

    #[test]
    fn when_response_is_false_aborts() -> Result<()> {
        let test_repo = prep_test_repo()?;

        let mut p = CliTester::new_from_dir(&test_repo.dir, ["prs", "create"]);

        expect_confirm_prompt(&mut p, BEHIND_LEN, AHEAD_LEN)?.succeeds_with(Some(false))?;

        p.expect_end_with("Error: aborting so branch can be rebased\r\n")?;

        Ok(())
    }
    #[test]
    #[serial]
    fn when_response_is_true_proceeds() -> Result<()> {
        let test_repo = prep_test_repo()?;

        let mut p = CliTester::new_from_dir(&test_repo.dir, ["prs", "create"]);
        expect_confirm_prompt(&mut p, BEHIND_LEN, AHEAD_LEN)?.succeeds_with(Some(true))?;
        p.expect(
            format!("creating patch for {AHEAD_LEN} commits from 'head' that are {BEHIND_LEN} behind 'main'",)
                .as_str(),
        )?;
        p.exit()?;
        Ok(())
    }
}

#[test]
#[serial]
fn cli_message_creating_patches() -> Result<()> {
    let test_repo = GitTestRepo::default();
    test_repo.populate()?;
    // create feature branch with 2 commit ahead
    test_repo.create_branch("feature")?;
    test_repo.checkout("feature")?;
    std::fs::write(test_repo.dir.join("t3.md"), "some content")?;
    test_repo.stage_and_commit("add t3.md")?;
    std::fs::write(test_repo.dir.join("t4.md"), "some content")?;
    test_repo.stage_and_commit("add t4.md")?;

    let mut p = CliTester::new_from_dir(&test_repo.dir, ["prs", "create"]);

    p.expect("creating patch for 2 commits from 'head' that can be merged into 'main'")?;
    p.exit()?;
    Ok(())
}

mod sends_pr_and_2_patches_to_3_relays {
    use futures::join;
    use test_utils::relay::Relay;

    use super::*;

    static PR_KIND: u64 = 318;
    static PATCH_KIND: u64 = 317;

    fn prep_git_repo() -> Result<GitTestRepo> {
        let test_repo = GitTestRepo::default();
        test_repo.populate()?;
        // create feature branch with 2 commit ahead
        test_repo.create_branch("feature")?;
        test_repo.checkout("feature")?;
        std::fs::write(test_repo.dir.join("t3.md"), "some content")?;
        test_repo.stage_and_commit("add t3.md")?;
        std::fs::write(test_repo.dir.join("t4.md"), "some content")?;
        test_repo.stage_and_commit("add t4.md")?;
        Ok(test_repo)
    }

    fn cli_tester_create_pr(git_repo: &GitTestRepo) -> CliTester {
        CliTester::new_from_dir(
            &git_repo.dir,
            [
                "--nsec",
                TEST_KEY_1_NSEC,
                "--disable-cli-spinners",
                "prs",
                "create",
                "--title",
                "example",
                "--description",
                "example",
            ],
        )
    }

    fn expect_msgs_first(p: &mut CliTester) -> Result<()> {
        p.expect("creating patch for 2 commits from 'head' that can be merged into 'main'\r\n")?;
        p.expect(
            "logged in as npub175lyhnt6nn00qjw0v3navw9pxgv43txnku0tpxprl4h6mvpr6a5qlphudg\r\n",
        )?;
        p.expect("connecting to relays...\r\n")?;
        p.expect("\r")?;
        p.expect("posting 1 pull request with 2 commits...\r\n")?;
        Ok(())
    }

    async fn prep_run_create_pr() -> Result<(Relay<'static>, Relay<'static>, Relay<'static>)> {
        let git_repo = prep_git_repo()?;

        let (mut r51, mut r52, mut r53) = (
            Relay::new(8051, None),
            Relay::new(8052, None),
            Relay::new(8053, None),
        );

        // // check relay had the right number of events
        let cli_tester_handle = std::thread::spawn(move || -> Result<()> {
            let mut p = cli_tester_create_pr(&git_repo);
            p.expect_end_eventually()?;
            Ok(())
        });

        // launch relay
        let _ = join!(
            r51.listen_until_close(),
            r52.listen_until_close(),
            r53.listen_until_close(),
        );
        cli_tester_handle.join().unwrap()?;
        Ok((r51, r52, r53))
    }

    #[test]
    #[serial]
    fn only_1_pr_kind_event_sent_to_each_relay() -> Result<()> {
        let (r51, r52, r53) = futures::executor::block_on(prep_run_create_pr())?;
        for relay in [&r51, &r52, &r53] {
            assert_eq!(
                relay
                    .events
                    .iter()
                    .filter(|e| e.kind.as_u64().eq(&PR_KIND))
                    .count(),
                1,
            );
        }
        Ok(())
    }

    #[test]
    #[serial]
    fn only_2_patch_kind_events_sent_to_each_relay() -> Result<()> {
        let (r51, r52, r53) = futures::executor::block_on(prep_run_create_pr())?;
        for relay in [&r51, &r52, &r53] {
            assert_eq!(
                relay
                    .events
                    .iter()
                    .filter(|e| e.kind.as_u64().eq(&PATCH_KIND))
                    .count(),
                2,
            );
        }
        Ok(())
    }

    #[test]
    #[serial]
    fn patch_content_contains_patch_in_email_format() -> Result<()> {
        let (r51, r52, r53) = futures::executor::block_on(prep_run_create_pr())?;
        for relay in [&r51, &r52, &r53] {
            let patch_events: Vec<&nostr::Event> = relay
                .events
                .iter()
                .filter(|e| e.kind.as_u64().eq(&PATCH_KIND))
                .collect();

            assert_eq!(
                patch_events[0].content,
                "\
                    From fe973a840fba2a8ab37dd505c154854a69a6505c Mon Sep 17 00:00:00 2001\n\
                    From: Joe Bloggs <joe.bloggs@pm.me>\n\
                    Date: Thu, 1 Jan 1970 00:00:00 +0000\n\
                    Subject: [PATCH] add t4.md\n\
                    \n\
                    ---\n \
                    t4.md | 1 +\n \
                    1 file changed, 1 insertion(+)\n \
                    create mode 100644 t4.md\n\
                    \n\
                    diff --git a/t4.md b/t4.md\n\
                    new file mode 100644\n\
                    index 0000000..f0eec86\n\
                    --- /dev/null\n\
                    +++ b/t4.md\n\
                    @@ -0,0 +1 @@\n\
                    +some content\n\\ \
                    No newline at end of file\n\
                    --\n\
                    libgit2 1.7.1\n\
                    \n\
                    ",
            );
            assert_eq!(
                patch_events[1].content,
                "\
                    From 232efb37ebc67692c9e9ff58b83c0d3d63971a0a Mon Sep 17 00:00:00 2001\n\
                    From: Joe Bloggs <joe.bloggs@pm.me>\n\
                    Date: Thu, 1 Jan 1970 00:00:00 +0000\n\
                    Subject: [PATCH] add t3.md\n\
                    \n\
                    ---\n \
                    t3.md | 1 +\n \
                    1 file changed, 1 insertion(+)\n \
                    create mode 100644 t3.md\n\
                    \n\
                    diff --git a/t3.md b/t3.md\n\
                    new file mode 100644\n\
                    index 0000000..f0eec86\n\
                    --- /dev/null\n\
                    +++ b/t3.md\n\
                    @@ -0,0 +1 @@\n\
                    +some content\n\\ \
                    No newline at end of file\n\
                    --\n\
                    libgit2 1.7.1\n\
                    \n\
                    ",
            );
        }
        Ok(())
    }

    mod pr_tags {
        use super::*;
        #[test]
        #[serial]
        fn pr_tags_repo_commit() -> Result<()> {
            let (r51, r52, r53) = futures::executor::block_on(prep_run_create_pr())?;
            for relay in [&r51, &r52, &r53] {
                let pr_event: &nostr::Event = relay
                    .events
                    .iter()
                    .find(|e| e.kind.as_u64().eq(&PR_KIND))
                    .unwrap();

                // root commit 't' tag
                assert!(pr_event.tags.iter().any(|t| t.as_vec()[0].eq("t")
                    && t.as_vec()[1].eq("r-9ee507fc4357d7ee16a5d8901bedcd103f23c17d")));
            }
            Ok(())
        }
    }

    mod patch_tags {
        use super::*;
        #[test]
        #[serial]
        fn patch_tags_correctly_formatted() -> Result<()> {
            let (r51, r52, r53) = futures::executor::block_on(prep_run_create_pr())?;
            for relay in [&r51, &r52, &r53] {
                let patch_events: Vec<&nostr::Event> = relay
                    .events
                    .iter()
                    .filter(|e| e.kind.as_u64().eq(&PATCH_KIND))
                    .collect();

                static COMMIT_ID: &str = "fe973a840fba2a8ab37dd505c154854a69a6505c";
                let most_recent_patch = patch_events[0];

                // commit 't' and 'commit' tag
                assert!(
                    most_recent_patch
                        .tags
                        .iter()
                        .any(|t| t.as_vec()[0].eq("t") && t.as_vec()[1].eq(COMMIT_ID))
                );
                assert!(
                    most_recent_patch
                        .tags
                        .iter()
                        .any(|t| t.as_vec()[0].eq("commit") && t.as_vec()[1].eq(COMMIT_ID))
                );

                // commit parent 't' and 'parent-commit' tag
                static COMMIT_PARENT_ID: &str = "232efb37ebc67692c9e9ff58b83c0d3d63971a0a";
                assert!(
                    most_recent_patch
                        .tags
                        .iter()
                        .any(|t| t.as_vec()[0].eq("t") && t.as_vec()[1].eq(COMMIT_PARENT_ID))
                );
                assert!(most_recent_patch.tags.iter().any(
                    |t| t.as_vec()[0].eq("parent-commit") && t.as_vec()[1].eq(COMMIT_PARENT_ID)
                ));

                // root commit 't' tag
                assert!(most_recent_patch.tags.iter().any(|t| t.as_vec()[0].eq("t")
                    && t.as_vec()[1].eq("r-9ee507fc4357d7ee16a5d8901bedcd103f23c17d")));
            }
            Ok(())
        }

        #[test]
        #[serial]
        fn patch_tags_pr_event_as_root() -> Result<()> {
            let (r51, r52, r53) = futures::executor::block_on(prep_run_create_pr())?;
            for relay in [&r51, &r52, &r53] {
                let patch_events: Vec<&nostr::Event> = relay
                    .events
                    .iter()
                    .filter(|e| e.kind.as_u64().eq(&PATCH_KIND))
                    .collect();

                let most_recent_patch = patch_events[0];
                let pr_event = relay
                    .events
                    .iter()
                    .find(|e| e.kind.as_u64().eq(&PR_KIND))
                    .unwrap();

                let root_event_tag = most_recent_patch
                    .tags
                    .iter()
                    .find(|t| {
                        t.as_vec()[0].eq("e") && t.as_vec().len().eq(&4) && t.as_vec()[3].eq("root")
                    })
                    .unwrap();

                assert_eq!(root_event_tag.as_vec()[1], pr_event.id.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) = (
                Relay::new(8051, None),
                Relay::new(8052, None),
                Relay::new(8053, None),
            );

            // // check relay had the right number of events
            let cli_tester_handle = std::thread::spawn(move || -> Result<()> {
                let mut p = cli_tester_create_pr(&git_repo);
                expect_msgs_first(&mut p)?;
                relay::expect_send_with_progress(
                    &mut p,
                    vec![
                        (" [my-relay] [repo-relay] ws://localhost:8051", true, ""),
                        (" [my-relay] ws://localhost:8052", true, ""),
                        (" [repo-relay] ws://localhost:8053", true, ""),
                    ],
                    3,
                )?;
                p.expect_end_with_whitespace()?;
                Ok(())
            });

            // launch relay
            let _ = join!(
                r51.listen_until_close(),
                r52.listen_until_close(),
                r53.listen_until_close(),
            );
            cli_tester_handle.join().unwrap()?;
            Ok(())
        }

        #[test]
        #[serial]
        fn check_cli_output() -> Result<()> {
            futures::executor::block_on(run_test_async())?;
            Ok(())
        }
    }

    mod first_event_rejected_by_1_relay {
        use super::*;

        mod only_first_rejected_event_sent_to_relay {
            use super::*;

            async fn run_test_async() -> Result<()> {
                let git_repo = prep_git_repo()?;

                let (mut r51, mut r52, mut r53) = (
                    Relay::new(8051, None),
                    Relay::new(
                        8052,
                        Some(&|relay, client_id, event| -> Result<()> {
                            relay.respond_ok(client_id, event, Some("Payment Required"))?;
                            Ok(())
                        }),
                    ),
                    Relay::new(8053, None),
                );

                // // check relay had the right number of events
                let cli_tester_handle = std::thread::spawn(move || -> Result<()> {
                    let mut p = cli_tester_create_pr(&git_repo);
                    p.expect_end_eventually()?;
                    Ok(())
                });

                // launch relay
                let _ = join!(
                    r51.listen_until_close(),
                    r52.listen_until_close(),
                    r53.listen_until_close(),
                );
                cli_tester_handle.join().unwrap()?;

                assert_eq!(r52.events.len(), 1);

                Ok(())
            }

            #[test]
            #[serial]
            fn only_first_rejected_event_sent_to_relay() -> Result<()> {
                futures::executor::block_on(run_test_async())?;
                Ok(())
            }
        }

        mod cli_show_rejection_with_comment {
            use super::*;

            async fn run_test_async() -> Result<(Relay<'static>, Relay<'static>, Relay<'static>)> {
                let git_repo = prep_git_repo()?;

                let (mut r51, mut r52, mut r53) = (
                    Relay::new(8051, None),
                    Relay::new(
                        8052,
                        Some(&|relay, client_id, event| -> Result<()> {
                            relay.respond_ok(client_id, event, Some("Payment Required"))?;
                            Ok(())
                        }),
                    ),
                    Relay::new(8053, None),
                );

                // // check relay had the right number of events
                let cli_tester_handle = std::thread::spawn(move || -> Result<()> {
                    let mut p = cli_tester_create_pr(&git_repo);
                    expect_msgs_first(&mut p)?;
                    relay::expect_send_with_progress(
                        &mut p,
                        vec![
                            (" [my-relay] [repo-relay] ws://localhost:8051", true, ""),
                            (
                                " [my-relay] ws://localhost:8052",
                                false,
                                "error: Payment Required",
                            ),
                            (" [repo-relay] ws://localhost:8053", true, ""),
                        ],
                        3,
                    )?;
                    p.expect_end_with_whitespace()?;
                    Ok(())
                });

                // launch relay
                let _ = join!(
                    r51.listen_until_close(),
                    r52.listen_until_close(),
                    r53.listen_until_close(),
                );
                cli_tester_handle.join().unwrap()?;
                Ok((r51, r52, r53))
            }

            #[test]
            #[serial]
            fn cli_show_rejection_with_comment() -> Result<()> {
                futures::executor::block_on(run_test_async())?;
                Ok(())
            }
        }
    }
}