File: codespaces_secrets_spec.rb

package info (click to toggle)
ruby-octokit 10.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 24,092 kB
  • sloc: ruby: 13,339; sh: 99; makefile: 7; javascript: 3
file content (248 lines) | stat: -rw-r--r-- 8,881 bytes parent folder | download | duplicates (2)
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
# frozen_string_literal: true

require 'rbnacl'
require 'base64'

def create_box(public_key)
  b64_key = RbNaCl::PublicKey.new(Base64.decode64(public_key[:key]))
  {
    key_id: public_key[:key_id],
    box: RbNaCl::Boxes::Sealed.from_public_key(b64_key)
  }
end

describe Octokit::Client::CodespacesSecrets do
  before do
    Octokit.reset!
    @client = oauth_client
    @secrets = [{ name: 'secret_name', value: 'secret_value' }, { name: 'secret_name2', value: 'secret_value2' }]
  end

  context 'with a repo' do
    before(:each) do
      @repo = @client.create_repository('secret-repo')
    end

    after(:each) do
      @client.delete_repository(@repo.full_name) unless @repo.nil?
    rescue Octokit::NotFound
    end

    describe '.get_codespaces_public_key', :vcr do
      it 'get repo specific public key for secrets encryption' do
        box = create_box(@client.get_codespaces_public_key(@repo.id))
        expect(box[:key_id]).not_to be_empty
      end
    end # .get_public_key
  end

  context 'with a repo without secrets' do
    before(:each) do
      @repo = @client.create_repository('secret-repo')
    end

    after(:each) do
      @client.delete_repository(@repo.full_name) unless @repo.nil?
    rescue Octokit::NotFound
    end

    describe '.list_codespaces_secrets', :vcr do
      it 'returns empty list of secrets' do
        secrets = @client.list_codespaces_secrets(@repo.id)
        expect(secrets.total_count).to eq(0)
        expect(secrets.secrets).to be_empty
      end
    end # .list_codespaces_secrets

    describe '.create_or_update_codespaces_secret', :vcr do
      it 'creating secret returns 201' do
        box = create_box(@client.get_codespaces_public_key(@repo.id))
        encrypted = box[:box].encrypt(@secrets.first[:value])
        @client.create_or_update_codespaces_secret(
          @repo.id, @secrets.first[:name],
          key_id: box[:key_id], encrypted_value: Base64.strict_encode64(encrypted)
        )
        expect(@client.last_response.status).to eq(201)
      end
    end # .create_or_update_codespaces_secret
  end

  context 'with a repository with a secret' do
    before(:each) do
      @repo = @client.create_repository('secret-repo')
      @box = create_box(@client.get_codespaces_public_key(@repo.id))
      @secrets.each do |secret|
        encrypted = @box[:box].encrypt(secret[:value])
        @client.create_or_update_codespaces_secret(
          @repo.id, secret[:name],
          key_id: @box[:key_id], encrypted_value: Base64.strict_encode64(encrypted)
        )
      end
    end

    after(:each) do
      @client.delete_repository(@repo.full_name) unless @repo.nil?
    rescue Octokit::NotFound
    end

    describe '.list_codespaces_secrets', :vcr do
      it 'returns list of two secrets' do
        secrets = @client.list_codespaces_secrets(@repo.id)
        expect(secrets.total_count).to eq(2)
        expect(secrets.secrets[0].name).to eq(@secrets.first[:name].upcase)
      end

      it 'paginates the results' do
        @client.per_page = 1
        allow(@client).to receive(:paginate).and_call_original
        secrets = @client.list_codespaces_secrets(@repo.id)

        expect(@client).to have_received(:paginate)
        expect(secrets.total_count).to eq(2)
        expect(secrets.secrets.count).to eq(1)
      end

      it 'auto-paginates the results' do
        @client.auto_paginate = true
        @client.per_page = 1
        allow(@client).to receive(:paginate).and_call_original
        secrets = @client.list_codespaces_secrets(@repo.id)

        expect(@client).to have_received(:paginate)
        expect(secrets.total_count).to eq(2)
        expect(secrets.secrets.count).to eq(2)
      end
    end # .list_codespaces_secrets

    describe '.get_codespaces_secret', :vcr do
      it 'return timestamps related to one secret' do
        received = @client.get_codespaces_secret(@repo.id, @secrets.first[:name])
        expect(received.name).to eq(@secrets.first[:name].upcase)
      end
    end # .get_codespaces_secret

    describe '.create_or_update_codespaces_secret', :vcr do
      it 'updating existing secret returns 204' do
        box = create_box(@client.get_codespaces_public_key(@repo.id))
        encrypted = box[:box].encrypt('new value')
        @client.create_or_update_codespaces_secret(
          @repo.id, @secrets.first[:name],
          key_id: box[:key_id], encrypted_value: Base64.strict_encode64(encrypted)
        )
        expect(@client.last_response.status).to eq(204)
      end
    end # .create_or_update_codespaces_secret

    describe '.delete_codespaces_secret', :vcr do
      it 'delete existing secret' do
        @client.delete_codespaces_secret(@repo.id, @secrets.first[:name])
        expect(@client.last_response.status).to eq(204)
      end
    end # .delete_codespaces_secret
  end

  context 'with an org' do
    describe '.get_org_codespaces_public_key', :vcr do
      it 'get org specific public key for secrets encryption' do
        box = create_box(@client.get_org_codespaces_public_key(test_github_org))
        expect(box[:key_id]).not_to be_empty
      end
    end # .get_org_codespaces_public_key
  end

  context 'with an org without secrets' do
    describe '.list_org_codespaces_secrets', :vcr do
      it 'returns empty list of secrets' do
        secrets = @client.list_org_codespaces_secrets(test_github_org)
        expect(secrets.total_count).to eq(0)
        expect(secrets.secrets).to be_empty
      end
    end # .list_org_codespaces_secrets

    describe '.create_or_update_org_codespaces_secret', :vcr do
      it 'creating secret returns 201' do
        @box = create_box(@client.get_org_codespaces_public_key(test_github_org))
        encrypted = @box[:box].encrypt(@secrets.first[:value])
        @client.create_or_update_org_codespaces_secret(
          test_github_org, @secrets.first[:name],
          key_id: @box[:key_id],
          encrypted_value: Base64.strict_encode64(encrypted),
          visibility: 'private'
        )
        expect(@client.last_response.status).to eq(201)
      end
    end # .create_or_update_org_codespaces_secret
  end

  context 'with an org with a secret' do
    before(:each) do
      @box = create_box(@client.get_org_codespaces_public_key(test_github_org))
      @secrets.each do |secret|
        encrypted = @box[:box].encrypt(secret[:value])
        @client.create_or_update_org_codespaces_secret(
          test_github_org, secret[:name],
          key_id: @box[:key_id],
          encrypted_value: Base64.strict_encode64(encrypted),
          visibility: 'private'
        )
      end
    end

    describe '.list_org_codespaces_secrets', :vcr do
      it 'returns list of two secrets' do
        secrets = @client.list_org_codespaces_secrets(test_github_org)
        expect(secrets.total_count).to eq(2)
        expect(secrets.secrets[0].name).to eq(@secrets.first[:name].upcase)
      end

      it 'paginates the results' do
        @client.per_page = 1
        allow(@client).to receive(:paginate).and_call_original
        secrets = @client.list_org_codespaces_secrets(test_github_org)

        expect(@client).to have_received(:paginate)
        expect(secrets.total_count).to eq(2)
        expect(secrets.secrets.count).to eq(1)
      end

      it 'auto-paginates the results' do
        @client.auto_paginate = true
        @client.per_page = 1
        allow(@client).to receive(:paginate).and_call_original
        secrets = @client.list_org_codespaces_secrets(test_github_org)

        expect(@client).to have_received(:paginate)
        expect(secrets.total_count).to eq(2)
        expect(secrets.secrets.count).to eq(2)
      end
    end # .list_org_codespaces_secrets

    describe '.get_org_codespaces_secret', :vcr do
      it 'return timestamps related to one secret' do
        received = @client.get_org_codespaces_secret(test_github_org, @secrets.first[:name])
        expect(received.name).to eq(@secrets.first[:name].upcase)
      end
    end # .get_org_codespaces_secret

    describe '.create_or_update_org_codespaces_secret', :vcr do
      it 'updating existing secret returns 204' do
        box = create_box(@client.get_org_codespaces_public_key(test_github_org))
        encrypted = box[:box].encrypt('new value')
        @client.create_or_update_org_codespaces_secret(
          test_github_org, @secrets.first[:name],
          key_id: @box[:key_id],
          encrypted_value: Base64.strict_encode64(encrypted),
          visibility: 'private'
        )
        expect(@client.last_response.status).to eq(204)
      end
    end # .create_or_update_org_codespaces_secret

    describe '.delete_org_codespaces_secret', :vcr do
      it 'delete existing secret' do
        @client.delete_org_codespaces_secret(test_github_org, @secrets.first[:name])
        expect(@client.last_response.status).to eq(204)
      end
    end
  end
end