projvar 0.20.0

A tiny CLI tool that tries to gather project specific meta-data in different ways, to store them into key=value pairs in a file for later use by other tools. See --list for the keys set by this tool.
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

// SPDX-FileCopyrightText: 2021 - 2026 Robin Vobruba <hoijui.quaero@gmail.com>
//
// SPDX-License-Identifier: AGPL-3.0-or-later

mod common;

use cli_utils::BoxResult;
use common::StrMatcher;
use std::collections::HashMap;

const CI: &str = "true";
const GITHUB_ACTOR: &str = "octocat";
const GITHUB_REPOSITORY: &str = "octocat/Hello-World";
const GITHUB_SHA: &str = "ffac537e6cbbf934b08745a378932722df287a53";
const GITHUB_SERVER_URL: &str = "https://github.com";
const GITHUB_API_URL: &str = "https://api.github.com";
const GITHUB_REF: [Option<&str>; 6] = [
    Some("refs/heads/feature-branch-1"),
    Some("refs/tags/0.1.0"),
    Some("refs/tags/hello-world-0.1.0"),
    Some("refs/tags/hello-world-v0.1.0"),
    Some("refs/tags/some-tag"),
    None,
];
const GITHUB_REF_NAME: [Option<&str>; 4] = [
    Some("feature-branch-1"),
    Some("v0.1.0"),
    Some("0.1.0"),
    None,
];
const GITHUB_REF_TYPE: [Option<&str>; 3] = [Some("branch"), Some("tag"), None];
const GITHUB_HEAD_REF: [Option<&str>; 2] = [Some("head-branch"), None];
const GITHUB_BASE_REF: [Option<&str>; 2] = [Some("base-branch"), None];

fn setup() -> HashMap<&'static str, &'static str> {
    HashMap::from([
        ("CI", CI),
        ("GITHUB_ACTOR", GITHUB_ACTOR),
        ("GITHUB_REPOSITORY", GITHUB_REPOSITORY),
        ("GITHUB_SHA", GITHUB_SHA),
        ("GITHUB_SERVER_URL", GITHUB_SERVER_URL),
        ("GITHUB_API_URL", GITHUB_API_URL),
        ("GITHUB_REF", GITHUB_REF[0].unwrap()),
        ("GITHUB_REF_NAME", GITHUB_REF_NAME[0].unwrap()),
        ("GITHUB_REF_TYPE", GITHUB_REF_TYPE[0].unwrap()),
        ("GITHUB_HEAD_REF", GITHUB_HEAD_REF[0].unwrap()),
        ("GITHUB_BASE_REF", GITHUB_BASE_REF[0].unwrap()),
    ])
}

fn expected_pats() -> HashMap<&'static str, (&'static dyn StrMatcher, bool)> {
    let vars = vec![
        (
            "PROJECT_BUILD_BRANCH",
            (
                &"feature-branch-1" as &'static dyn StrMatcher as &'static dyn StrMatcher,
                true,
            ),
        ),
        (
            "PROJECT_BUILD_HOSTING_URL",
            (&"https://octocat.github.io/Hello-World", true),
        ),
        ("PROJECT_CI", (&"true", true)),
        ("PROJECT_NAME", (&"Hello-World", true)),
        ("PROJECT_NAME_MACHINE_READABLE", (&"Hello-World", true)),
        (
            "PROJECT_REPO_CLONE_URL",
            (&"https://github.com/octocat/Hello-World.git", true),
        ),
        (
            "PROJECT_REPO_CLONE_URL_HTTP",
            (&"https://github.com/octocat/Hello-World.git", true),
        ),
        (
            "PROJECT_REPO_CLONE_URL_SSH",
            (&"ssh://git@github.com/octocat/Hello-World.git", true),
        ),
        (
            "PROJECT_REPO_COMMIT_PREFIX_URL",
            (&"https://github.com/octocat/Hello-World/commit", true),
        ),
        (
            "PROJECT_REPO_ISSUES_URL",
            (&"https://github.com/octocat/Hello-World/issues", true),
        ),
        (
            "PROJECT_REPO_RAW_VERSIONED_PREFIX_URL",
            (
                &"https://raw.githubusercontent.com/octocat/Hello-World",
                true,
            ),
        ),
        (
            "PROJECT_REPO_VERSIONED_DIR_PREFIX_URL",
            (&"https://github.com/octocat/Hello-World/tree", true),
        ),
        (
            "PROJECT_REPO_VERSIONED_FILE_PREFIX_URL",
            (&"https://github.com/octocat/Hello-World/blob", true),
        ),
        (
            "PROJECT_REPO_WEB_URL",
            (&"https://github.com/octocat/Hello-World", true),
        ),
        (
            "PROJECT_VERSION",
            (&"ffac537e6cbbf934b08745a378932722df287a53", true),
        ),
    ];
    vars.into_iter().collect()
}

#[test]
fn github_ci() -> BoxResult<()> {
    let tmp_proj_dir_empty = assert_fs::TempDir::new()?;
    let envs = setup();
    common::projvar_test(
        &expected_pats(),
        &["--all"],
        tmp_proj_dir_empty.path(),
        envs,
    )
}