zixcel-github 0.1.1

Policy-neutral GitHub API wrapper boundary for Zixcel
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

mod support;

use support::{RecordingBackend, request};
use zixcel_github::{
    GitHubAction, GitHubRemoteExpectation, PermissionRequirement, execute_api_request,
};

#[test]
fn every_action_has_one_exact_permission_pair() {
    for (action, expected) in cases() {
        assert_eq!(action.required_permission(), expected);
        let request = request(action);
        let mut backend = RecordingBackend::default();
        execute_api_request(&request, &mut backend).expect("valid API request");
        assert_eq!(backend.calls(), 1, "{}", expected.resource);
    }
}

fn cases() -> Vec<(GitHubAction, PermissionRequirement)> {
    vec![
        case(
            GitHubAction::ObserveRepositoryMetadata,
            "github-repository-metadata",
            "inspect-metadata",
        ),
        case(
            GitHubAction::ListIssues { maximum_items: 10 },
            "github-issue-observation",
            "list-records",
        ),
        case(
            GitHubAction::ListPullRequests { maximum_items: 10 },
            "github-pull-request-observation",
            "list-records",
        ),
        case(
            GitHubAction::ListReleases { maximum_items: 10 },
            "github-release-observation",
            "list-records",
        ),
        case(
            GitHubAction::ListWorkflowRuns { maximum_items: 10 },
            "github-workflow-run-observation",
            "list-records",
        ),
        case(
            GitHubAction::ListWorkflowArtifacts {
                workflow_run_id: "123".into(),
                maximum_items: 10,
            },
            "github-actions-artifact-observation",
            "list-records",
        ),
        case(
            GitHubAction::DownloadWorkflowArtifact {
                workflow_run_id: "123".into(),
                artifact_id: "456".into(),
                expected_digest_sha256: None,
            },
            "github-actions-artifact",
            "download-artifact",
        ),
        case(
            GitHubAction::CreatePrivateRepository {
                default_branch: "main".into(),
            },
            "github-private-repository",
            "create-private-resource",
        ),
        case(
            GitHubAction::PushRepositorySnapshot {
                snapshot_ref: "artifact/source-snapshot-1".into(),
                snapshot_digest_sha256: "a".repeat(64),
                expected_remote: GitHubRemoteExpectation::Absent,
            },
            "github-repository-content",
            "publish-artifact",
        ),
        case(
            GitHubAction::DeleteRepository {
                expected_repository_id: "12345".into(),
                backup_digest_sha256: "a".repeat(64),
            },
            "github-repository-administration",
            "delete-resource",
        ),
        case(
            GitHubAction::CreateIssue {
                title: "Issue title".into(),
                body_artifact_ref: "artifact/issue-body-1".into(),
            },
            "github-issue-creation",
            "create-work-item",
        ),
        case(
            GitHubAction::CreatePullRequest {
                base: "main".into(),
                head: "feature".into(),
                title: "Pull request title".into(),
                body_artifact_ref: "artifact/pull-request-body-1".into(),
            },
            "github-pull-request-creation",
            "create-review-request",
        ),
        case(
            GitHubAction::DispatchWorkflow {
                workflow_ref: "ci.yml".into(),
                git_ref: "main".into(),
                inputs_artifact_ref: None,
            },
            "github-workflow",
            "dispatch-operation",
        ),
    ]
}

const fn case(
    action: GitHubAction,
    resource: &'static str,
    operation: &'static str,
) -> (GitHubAction, PermissionRequirement) {
    (
        action,
        PermissionRequirement {
            resource,
            operation,
        },
    )
}