releasaurus-core 0.20.0

A comprehensive release automation tool that streamlines the software release process across multiple programming languages and forge platforms
Documentation
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
use semver::Version;
use tokio::time::{Duration, sleep};
use url::Url;

use crate::{
    config::Config,
    forge::{
        config::{LEGACY_PENDING_LABEL, PENDING_LABEL, RepoUrl, Scheme},
        manager::ForgeManager,
        request::{
            CreateCommitRequest, CreatePrRequest, CreateReleaseBranchRequest,
            FileChange, FileUpdateType, GetFileContentRequest, GetPrRequest,
            PrLabelsRequest,
        },
        tests::common::traits::ForgeTestHelper,
    },
    result::ReleasaurusError,
};

/// Parse a URL string into a [`RepoUrl`] for use in integration tests.
pub fn parse_repo_url(raw: &str) -> RepoUrl {
    let parsed = Url::parse(raw).expect("invalid test URL");
    let scheme = if parsed.scheme() == "http" {
        Scheme::Http
    } else {
        Scheme::Https
    };
    let host = parsed.host_str().unwrap_or("").to_string();
    let port = parsed.port();
    let segments: Vec<&str> = parsed
        .path_segments()
        .map(|s| s.collect())
        .unwrap_or_default();
    let owner = segments.first().copied().unwrap_or("").to_string();
    let name = segments.get(1).copied().unwrap_or("").to_string();
    let path = format!("/{}/{}", owner, name);
    RepoUrl {
        scheme,
        host,
        owner,
        name,
        path,
        port,
        token: None,
    }
}

const SHORT_WAIT: Duration = Duration::from_secs(2);
const LONG_WAIT: Duration = Duration::from_secs(20);

pub async fn run_forge_test(
    forge: &ForgeManager,
    helper: &dyn ForgeTestHelper,
) {
    log::info!("resetting repository");
    helper.reset().await.unwrap();

    let default_branch = forge.default_branch();
    let release_branch = "release-branch";
    let test_file_path = "test.txt";
    let test_file_content = "test content";

    ////////////////////////////////////////////////////////////////////////////
    // get_file_content: expect -> None
    ////////////////////////////////////////////////////////////////////////////
    log::info!("looking for non-existent file content");
    let get_file_req = GetFileContentRequest {
        branch: Some(default_branch.to_string()),
        path: test_file_path.to_string(),
    };
    let file_content = forge.get_file_content(get_file_req).await.unwrap();
    assert!(file_content.is_none());

    ////////////////////////////////////////////////////////////////////////////
    // create_commit -> succeeds
    ////////////////////////////////////////////////////////////////////////////
    log::info!("creating commit with new file content");
    let create_commit_req = CreateCommitRequest {
        target_branch: default_branch.to_string(),
        message: "fix: test fix commit".into(),
        file_changes: vec![FileChange {
            content: test_file_content.to_string(),
            path: test_file_path.to_string(),
            update_type: FileUpdateType::Replace,
        }],
    };

    let created_commit = forge.create_commit(create_commit_req).await.unwrap();
    assert!(!created_commit.sha.is_empty());
    sleep(SHORT_WAIT).await;

    ////////////////////////////////////////////////////////////////////////////
    // create_release_branch forked here (before the release tag) so
    // we can later assert the tag is invisible on this branch
    ////////////////////////////////////////////////////////////////////////////
    let pre_tag_branch = "pre-tag-branch";
    log::info!("creating pre-tag-branch before release merge");
    let pre_tag_branch_req = CreateReleaseBranchRequest {
        base_branch: default_branch.to_string(),
        message: "chore: pre-tag branch".into(),
        release_branch: pre_tag_branch.to_string(),
        file_changes: vec![FileChange {
            content: "pre-tag".to_string(),
            path: "pre-tag.txt".into(),
            update_type: FileUpdateType::Replace,
        }],
    };
    forge
        .create_release_branch(pre_tag_branch_req)
        .await
        .unwrap();
    sleep(SHORT_WAIT).await;

    ////////////////////////////////////////////////////////////////////////////
    // get_commits -> succeeds
    ////////////////////////////////////////////////////////////////////////////

    let commits = forge.get_commits(None, None).await.unwrap();
    assert_eq!(commits.len(), 2);

    ////////////////////////////////////////////////////////////////////////////
    // re-get file content: expect -> content
    ////////////////////////////////////////////////////////////////////////////
    log::info!("looking for existing file content");
    let get_file_req = GetFileContentRequest {
        branch: Some(default_branch.to_string()),
        path: test_file_path.to_string(),
    };
    let file_content = forge.get_file_content(get_file_req).await.unwrap();
    assert!(file_content.is_some());
    let file_content = file_content.unwrap();
    assert_eq!(file_content, test_file_content);

    ////////////////////////////////////////////////////////////////////////////
    // create_release_branch with changelog file change -> succeeds
    ////////////////////////////////////////////////////////////////////////////
    log::info!("creating release-branch");
    let create_release_branch_req = CreateReleaseBranchRequest {
        base_branch: default_branch.to_string(),
        message: "chore(main): release".into(),
        release_branch: release_branch.to_string(),
        file_changes: vec![FileChange {
            content: format!("# Changelog - {}", created_commit.sha),
            path: "CHANGELOG.md".into(),
            update_type: FileUpdateType::Prepend,
        }],
    };

    let release_commit = forge
        .create_release_branch(create_release_branch_req)
        .await
        .unwrap();
    assert!(!release_commit.sha.is_empty());
    sleep(SHORT_WAIT).await;

    ////////////////////////////////////////////////////////////////////////////
    // create_release_branch on existing branch -> force-resets, succeeds
    ////////////////////////////////////////////////////////////////////////////
    log::info!("re-creating release-branch (force-reset scenario)");
    let re_create_req = CreateReleaseBranchRequest {
        base_branch: default_branch.to_string(),
        message: "chore(main): release (re-run)".into(),
        release_branch: release_branch.to_string(),
        file_changes: vec![FileChange {
            content: format!("# Changelog - {} (updated)", created_commit.sha),
            path: "CHANGELOG.md".into(),
            update_type: FileUpdateType::Prepend,
        }],
    };
    let re_create_commit =
        forge.create_release_branch(re_create_req).await.unwrap();
    assert!(!re_create_commit.sha.is_empty());
    sleep(SHORT_WAIT).await;

    ////////////////////////////////////////////////////////////////////////////
    // get_open_release_pr: expect -> None
    ////////////////////////////////////////////////////////////////////////////
    log::info!("getting non-existent open PR");
    let get_pr_req = GetPrRequest {
        base_branch: default_branch.to_string(),
        head_branch: release_branch.to_string(),
    };

    let open_pr = forge.get_open_release_pr(get_pr_req).await.unwrap();
    assert!(open_pr.is_none());

    ////////////////////////////////////////////////////////////////////////////
    // create_pr from release_branch -> succeeds
    ////////////////////////////////////////////////////////////////////////////
    log::info!("creating PR");
    let create_pr_req = CreatePrRequest {
        base_branch: default_branch.to_string(),
        body: "Test PR".into(),
        head_branch: release_branch.to_string(),
        title: "Test PR".into(),
    };

    let release_pr = forge.create_pr(create_pr_req).await.unwrap();
    assert_ne!(release_pr.number, 0);
    assert!(!release_pr.body.is_empty());
    assert!(!release_pr.sha.is_empty());
    sleep(SHORT_WAIT).await;

    ////////////////////////////////////////////////////////////////////////////
    // replace_pr_labels(legacy) -> succeeds
    ////////////////////////////////////////////////////////////////////////////
    log::info!(
        "replacing PR labels with legacy pending label: {}",
        LEGACY_PENDING_LABEL
    );
    let replace_labels_req = PrLabelsRequest {
        labels: vec![LEGACY_PENDING_LABEL.into()],
        pr_number: release_pr.number,
    };
    forge.replace_pr_labels(replace_labels_req).await.unwrap();
    // extra padding here
    sleep(LONG_WAIT).await;

    ////////////////////////////////////////////////////////////////////////////
    // get_open_release_pr(legacy label) -> Found
    ////////////////////////////////////////////////////////////////////////////
    log::info!("looking for newly created open PR with legacy label");
    let get_pr_req = GetPrRequest {
        base_branch: default_branch.to_string(),
        head_branch: release_branch.to_string(),
    };
    let open_pr = forge.get_open_release_pr(get_pr_req).await.unwrap();
    assert!(open_pr.is_some());
    let open_pr = open_pr.unwrap();
    assert_ne!(open_pr.number, 0);
    assert!(!open_pr.body.is_empty());
    assert!(!open_pr.sha.is_empty());

    ////////////////////////////////////////////////////////////////////////////
    // replace_pr_labels(new-scoped) -> succeeds
    ////////////////////////////////////////////////////////////////////////////
    log::info!(
        "replacing PR labels with new scoped pending label: {}",
        PENDING_LABEL
    );
    let replace_labels_req = PrLabelsRequest {
        labels: vec![PENDING_LABEL.into()],
        pr_number: release_pr.number,
    };
    forge.replace_pr_labels(replace_labels_req).await.unwrap();
    // extra padding here
    sleep(LONG_WAIT).await;

    ////////////////////////////////////////////////////////////////////////////
    // get_open_release_pr(new scoped label) -> Found
    ////////////////////////////////////////////////////////////////////////////
    log::info!("looking for newly created open PR with new scoped label");
    let get_pr_req = GetPrRequest {
        base_branch: default_branch.to_string(),
        head_branch: release_branch.to_string(),
    };
    let open_pr = forge.get_open_release_pr(get_pr_req).await.unwrap();
    assert!(open_pr.is_some());
    let open_pr = open_pr.unwrap();
    assert_ne!(open_pr.number, 0);
    assert!(!open_pr.body.is_empty());
    assert!(!open_pr.sha.is_empty());

    ////////////////////////////////////////////////////////////////////////////
    // get_merged_release_pr -> None
    ////////////////////////////////////////////////////////////////////////////
    log::info!("looking for non-existent merged PR");
    let get_pr_req = GetPrRequest {
        base_branch: default_branch.to_string(),
        head_branch: release_branch.to_string(),
    };
    let merged_pr = forge.get_merged_release_pr(get_pr_req).await.unwrap();
    assert!(merged_pr.is_none());

    ////////////////////////////////////////////////////////////////////////////
    // merge release PR -> helper succeeds
    ////////////////////////////////////////////////////////////////////////////
    log::info!("merging release PR via helper");
    helper.merge_pr(release_pr.number).await.unwrap();
    // extra padding here
    sleep(LONG_WAIT).await;

    ////////////////////////////////////////////////////////////////////////////
    // get_merged_release_pr -> Found
    ////////////////////////////////////////////////////////////////////////////
    log::info!("looking for newly merged release PR");
    let get_pr_req = GetPrRequest {
        base_branch: default_branch.to_string(),
        head_branch: release_branch.to_string(),
    };
    let merged_pr = forge.get_merged_release_pr(get_pr_req).await.unwrap();
    assert!(merged_pr.is_some());
    let merged_pr = merged_pr.unwrap();
    assert_ne!(merged_pr.number, 0);
    assert!(!merged_pr.sha.is_empty());
    assert!(!merged_pr.body.is_empty());

    ////////////////////////////////////////////////////////////////////////////
    // get_latest_tag_for_prefix -> None
    ////////////////////////////////////////////////////////////////////////////
    log::info!("looking for non-existent tag by prefix");
    let semver = "1.1.0";
    let tag = format!("v{}", semver);
    let current_tag = forge
        .get_latest_tag_for_prefix("v", default_branch)
        .await
        .unwrap();
    assert!(current_tag.is_none());

    ////////////////////////////////////////////////////////////////////////////
    // tag_commit -> succeeds
    ////////////////////////////////////////////////////////////////////////////
    log::info!("tagging commit");
    forge.tag_commit(&tag, &merged_pr.sha).await.unwrap();
    sleep(SHORT_WAIT).await;

    ////////////////////////////////////////////////////////////////////////////
    // get_latest_tag_for_prefix -> Found
    ////////////////////////////////////////////////////////////////////////////
    log::info!("looking for newly tagged commit by prefix");
    let current_tag = forge
        .get_latest_tag_for_prefix("v", default_branch)
        .await
        .unwrap();
    assert!(current_tag.is_some());
    let current_tag = current_tag.unwrap();
    assert_eq!(current_tag.name, tag);
    assert_eq!(current_tag.semver, Version::parse(semver).unwrap());
    assert_eq!(current_tag.sha, merged_pr.sha);
    assert!(
        current_tag.timestamp.is_some(),
        "tag must carry a timestamp so multi-package repos filter commits correctly"
    );

    ////////////////////////////////////////////////////////////////////////////
    // get_latest_tag_for_prefix on pre-tag-branch -> None
    //
    // pre-tag-branch was forked before the release merge, so the tag
    // commit is not in its ancestry and must not be returned.
    ////////////////////////////////////////////////////////////////////////////
    log::info!("verifying tag is not visible on branch forked before release");
    let pre_tag_result = forge
        .get_latest_tag_for_prefix("v", pre_tag_branch)
        .await
        .unwrap();
    assert!(
        pre_tag_result.is_none(),
        "tag must not appear on a branch that diverged before it \
         was created"
    );

    if helper.supports_native_releases() {
        ////////////////////////////////////////////////////////////////////////////
        // get_release_by_tag -> Err Not Found
        ////////////////////////////////////////////////////////////////////////////
        log::info!("getting non-existent release by tag name");
        let err = forge
            .get_release_by_tag(&current_tag.name)
            .await
            .unwrap_err();
        assert!(matches!(err, ReleasaurusError::ForgeError(_)));
    }

    ////////////////////////////////////////////////////////////////////////////
    // create_release -> succeeds
    ////////////////////////////////////////////////////////////////////////////
    log::info!("creating release for tag");
    forge
        .create_release(&current_tag.name, &current_tag.sha, "release notes")
        .await
        .unwrap();
    sleep(SHORT_WAIT).await;

    if helper.supports_native_releases() {
        ////////////////////////////////////////////////////////////////////////////
        // get_release_by_tag -> Found
        ////////////////////////////////////////////////////////////////////////////
        log::info!("getting newly created release by tag name");
        let release =
            forge.get_release_by_tag(&current_tag.name).await.unwrap();
        assert_eq!(release.tag, current_tag.name);
    }

    ////////////////////////////////////////////////////////////////////////////
    // load_config -> Default::default()
    ////////////////////////////////////////////////////////////////////////////
    log::info!("loading non-existent config file");
    let config = forge.load_config(None).await.unwrap();
    assert_eq!(
        config.packages[0].workspace_root,
        Config::default().packages[0].workspace_root
    );
    assert_eq!(config.packages[0].path, Config::default().packages[0].path);

    ////////////////////////////////////////////////////////////////////////////
    // load_config -> Found config
    ////////////////////////////////////////////////////////////////////////////
    log::info!("creating commit to add releasaurus config file");
    let releasaurus_toml_content = r#"
    [[package]]
    name = "test-package"
    workspace_root = "packages"
    path = "test-package"
    "#;

    let create_commit_req = CreateCommitRequest {
        target_branch: default_branch.to_string(),
        message: "chore: adds releasaurus.toml".into(),
        file_changes: vec![FileChange {
            content: releasaurus_toml_content.to_string(),
            path: "releasaurus.toml".to_string(),
            update_type: FileUpdateType::Replace,
        }],
    };

    log::info!("loading newly created releasaurus config file");
    let created_commit = forge.create_commit(create_commit_req).await.unwrap();
    assert!(!created_commit.sha.is_empty());
    sleep(SHORT_WAIT).await;

    let config = forge
        .load_config(Some(default_branch.to_string()))
        .await
        .unwrap();

    assert_eq!(config.packages[0].name, "test-package");
    assert_eq!(config.packages[0].workspace_root, "packages");
    assert_eq!(config.packages[0].path, "test-package");

    ////////////////////////////////////////////////////////////////////////////
    // get_commits(sha) -> exactly the one commit made after the tag
    //
    // This exercises the SHA-based history walk used by the orchestrator.
    // The releasaurus.toml commit above is the only commit on the default
    // branch that post-dates the release tag.
    ////////////////////////////////////////////////////////////////////////////
    log::info!("getting commits since release tag");
    let commits_since_tag = forge
        .get_commits(
            Some(default_branch.to_string()),
            Some(current_tag.sha.clone()),
        )
        .await
        .unwrap();
    assert_eq!(
        commits_since_tag.len(),
        1,
        "expected exactly one commit after the release tag"
    );
}