github-as-code/scripts/__tests__/actions/access-summary.test.ts at 34f200fbea77d191b001d5911949a9455f64e539 · ipdxco/github-as-code · GitHub

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
import 'reflect-metadata'

import assert from 'node:assert'
import {describe, it} from 'node:test'
import {Config} from '../../src/yaml/config.js'
import {State} from '../../src/terraform/state.js'
import {
  categorizeAccessSummary,
  getAccessSummaryFrom
} from '../../src/actions/shared/access-summary.js'
import {
  describeAccessChanges,
  describeAccessReport
} from '../../src/actions/shared/describe-access-changes.js'
import {StateSchema} from '../../src/terraform/schema.js'

describe('access summaries', () => {
  it('categorizes post-change users', () => {
    const config = new Config(`
members:
  member:
    - alice
    - carol
    - dave
    - kept # KEEP: manual exception
repositories:
  private-repo:
    collaborators:
      pull:
        - outside
    visibility: private
  public-repo:
    collaborators:
      pull:
        - alice
    visibility: public
  team-only-repo:
    teams:
      push:
        - guests
    visibility: public
  team-repo:
    teams:
      push:
        - maintainers
    visibility: public
teams:
  guests:
    members:
      member:
        - team-only-non-member
  maintainers:
    members:
      member:
        - dave
`)

    const summary = getAccessSummaryFrom(config)
    const categories = categorizeAccessSummary(summary)

    assert.equal(summary.outside.isMember, false)
    assert.equal(summary.outside.isOutsideCollaborator, true)
    assert.equal(summary['team-only-non-member'].isMember, false)
    assert.equal(summary['team-only-non-member'].isOutsideCollaborator, false)
    assert.deepEqual(categories.outsideCollaborators, ['outside'])
    assert.deepEqual(categories.potentialOutsideCollaborators, ['alice'])
    assert.deepEqual(categories.potentialNoMembers, ['carol'])
    assert.deepEqual(categories.anyOtherMembers, ['dave', 'kept'])
  })

  it('annotates repository visibility in access changes and summaries', () => {
    const state = new State(
      JSON.stringify({
        values: {
          root_module: {
            resources: [
              {
                mode: 'managed',
                index: 'alice',
                address: 'github_membership.this["alice"]',
                type: 'github_membership',
                values: {
                  username: 'alice',
                  role: 'member'
                }
              },
              {
                mode: 'managed',
                index: 'public-repo',
                address: 'github_repository.this["public-repo"]',
                type: 'github_repository',
                values: {
                  name: 'public-repo',
                  visibility: 'public'
                }
              },
              {
                mode: 'managed',
                index: 'public-repo:alice',
                address:
                  'github_repository_collaborator.this["public-repo:alice"]',
                type: 'github_repository_collaborator',
                values: {
                  repository: 'public-repo',
                  username: 'alice',
                  permission: 'pull'
                }
              }
            ]
          }
        }
      } satisfies StateSchema)
    )
    const config = new Config(`
members:
  member:
    - alice
repositories:
  public-repo:
    collaborators:
      push:
        - alice
    visibility: public
`)

    const changes = describeAccessChanges(state, config)
    const report = describeAccessReport(state, config)

    assert.match(
      changes,
      /will have the permission to public-repo \(public\) change from pull to push/
    )
    assert.match(report, /<summary>Potential outside collaborators<\/summary>/)
    assert.match(report, /Affected users: alice/)
    assert.match(report, /User alice \(member\):/)
    assert.match(report, /has push permission to public-repo \(public\)/)
  })
})