File: issues_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 (262 lines) | stat: -rw-r--r-- 10,142 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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# frozen_string_literal: true

describe Octokit::Client::Issues do
  before do
    Octokit.reset!
    @client = oauth_client
  end

  after do
    Octokit.reset!
  end

  describe '.list_issues', :vcr do
    it 'returns issues for a repository' do
      issues = @client.issues('sferik/rails_admin')
      expect(issues).to be_kind_of Array
      assert_requested :get, github_url('/repos/sferik/rails_admin/issues')
    end
    it 'returns dashboard issues for the authenticated user' do
      issues = @client.issues
      expect(issues).to be_kind_of Array
      assert_requested :get, github_url('/issues')
    end
  end # .list_issues

  describe '.user_issues', :vcr do
    it 'returns issues for the authenticated user for owned and member repos' do
      issues = @client.user_issues
      expect(issues).to be_kind_of Array
      assert_requested :get, github_url('/user/issues')
    end
  end # .user_issues

  describe '.org_issues', :vcr do
    it 'returns issues for the organization for the authenticated user' do
      issues = @client.org_issues(test_github_org)
      expect(issues).to be_kind_of Array
      assert_requested :get, github_url("/orgs/#{test_github_org}/issues")
    end
  end # .org_issues

  describe '.list_assignees', :vcr do
    it 'returns available assignees for a repository' do
      users = @client.list_assignees('octokit/octokit.rb')
      expect(users).to be_kind_of Array
      assert_requested :get, github_url('/repos/octokit/octokit.rb/assignees')
    end
  end

  context 'with repository' do
    before(:each) do
      @repo = @client.create_repository("#{test_github_repository}_#{Time.now.to_f}")
    end

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

    describe '.create_issue', :vcr do
      it 'creates an issue' do
        issue = @client.create_issue \
          @repo.full_name,
          'Migrate issues to v3',
          'Move all Issues calls to v3 of the API'
        expect(issue.title).to match(/Migrate/)
        assert_requested :post, github_url("/repos/#{@repo.full_name}/issues")
      end

      it 'creates an issue with delimited labels' do
        issue = @client.create_issue \
          @repo.full_name,
          'New issue with delimited labels',
          'Testing',
          labels: 'bug, feature'
        expect(issue.title).to match(/delimited/)
        expect(issue.labels.map(&:name)).to include('feature')
        assert_requested :post, github_url("/repos/#{@repo.full_name}/issues")
      end

      it 'creates an issue with labels array' do
        issue = @client.create_issue \
          @repo.full_name,
          'New issue with labels array',
          'Testing',
          labels: %w[bug feature]
        expect(issue.title).to match(/array/)
        expect(issue.labels.map(&:name)).to include('feature')
        assert_requested :post, github_url("/repos/#{@repo.full_name}/issues")
      end

      it 'creates an issue without body argument' do
        issue = @client.create_issue(@repo.full_name, 'New issue without body argument')
        expect(issue.body).to be_nil
        assert_requested :post, github_url("/repos/#{@repo.full_name}/issues")
      end
    end # .create_issue

    context 'with issue' do
      before(:each) do
        @issue = @client.create_issue(@repo.full_name, 'Migrate issues to v3', 'Move all Issues calls to v3 of the API')
      end

      describe '.issue', :vcr do
        it 'returns an issue' do
          issue = @client.issue(@repo.full_name, @issue.number)
          assert_requested :get, github_url("/repos/#{@repo.full_name}/issues/#{@issue.number}")
          expect(issue.number).to eq(@issue.number)
        end
        it 'returns a full issue' do
          issue = @client.issue(@repo.full_name, @issue.number, accept: 'application/vnd.github.full+json')
          assert_requested :get, github_url("/repos/#{@repo.full_name}/issues/#{@issue.number}")
          expect(issue.body_html).to include('<p>Move all')
          expect(issue.body_text).to include('Move all')
        end
      end # .issue

      describe '.close_issue', :vcr do
        it 'closes an issue' do
          issue = @client.close_issue(@repo.full_name, @issue.number)
          expect(issue.state).to eq 'closed'
          expect(issue.number).to eq(@issue.number)
          assert_requested :patch, github_url("/repos/#{@repo.full_name}/issues/#{@issue.number}")
        end
      end # .close_issue

      context 'with closed issue' do
        before(:each) do
          @client.close_issue(@repo.full_name, @issue.number)
        end

        describe '.reopen_issue', :vcr do
          it 'reopens an issue' do
            issue = @client.reopen_issue(@repo.full_name, @issue.number)
            expect(issue.state).to eq 'open'
            expect(issue.number).to eq(@issue.number)
            assert_requested :patch, github_url("/repos/#{@repo.full_name}/issues/#{@issue.number}"), times: 2
          end
        end # .reopen_issue
      end # with closed issue

      describe '.lock_issue', :vcr do
        it 'locks an issue' do
          @client.lock_issue(@repo.full_name, @issue.number)
          assert_requested :put, github_url("/repos/#{@repo.full_name}/issues/#{@issue.number}/lock")
        end
      end # .lock_issue

      context 'with locked issue' do
        before(:each) do
          @client.lock_issue(@repo.full_name, @issue.number)
        end

        describe '.unlock_issue', :vcr do
          it 'unlocks an issue' do
            @client.unlock_issue(@repo.full_name, @issue.number)
            assert_requested :delete, github_url("/repos/#{@repo.full_name}/issues/#{@issue.number}/lock")
          end
        end # .unlock_issue
      end # with locked issue

      describe '.update_issue', :vcr do
        it 'updates an issue' do
          issue = @client.update_issue(@repo.full_name, @issue.number, 'Use all the v3 api!', '')
          expect(issue.number).to eq(@issue.number)
          assert_requested :patch, github_url("/repos/#{@repo.full_name}/issues/#{@issue.number}")
        end

        it 'updates an issue without positional args' do
          issue = @client.update_issue(@repo.full_name, @issue.number, title: 'Use all the v3 api!', body: '')
          expect(issue.number).to eq(@issue.number)
          assert_requested :patch, github_url("/repos/#{@repo.full_name}/issues/#{@issue.number}")
        end
      end # .update_issue

      describe '.add_comment', :vcr do
        it 'adds a comment' do
          comment = @client.add_comment(@repo.full_name, @issue.number, 'A test comment')
          expect(comment.user.login).to eq(test_github_login)
          assert_requested :post, github_url("/repos/#{@repo.full_name}/issues/#{@issue.number}/comments")
        end
      end # .add_comment

      context 'with issue comment' do
        before(:each) do
          @issue_comment = @client.add_comment(@repo.full_name, @issue.number, 'Another test comment')
        end

        describe '.update_comment', :vcr do
          it 'updates an existing comment' do
            @client.update_comment(@repo.full_name, @issue_comment.id, 'A test comment update')
            assert_requested :patch, github_url("/repos/#{@repo.full_name}/issues/comments/#{@issue_comment.id}")
          end
        end # .update_comment

        describe '.delete_comment', :vcr do
          it 'deletes an existing comment' do
            @client.delete_comment(@repo.full_name, @issue_comment.id)
            assert_requested :delete, github_url("/repos/#{@repo.full_name}/issues/comments/#{@issue_comment.id}")
          end
        end # .delete_comment
      end # with issue comment

      describe '.issue_timeline', :vcr do
        it 'returns an issue timeline' do
          timeline = @client.issue_timeline(@repo.full_name, @issue.number)
          expect(timeline).to be_kind_of Array
          assert_requested :get, github_url("/repos/#{@repo.full_name}/issues/#{@issue.number}/timeline")
        end
      end # .issue_timeline

      context 'with assignees' do
        before(:each) do
          issue = @client.add_assignees(@repo.full_name, @issue.number, ['api-padawan'])
          expect(issue.assignees.count).not_to be_zero
        end

        describe '.remove_assignees', :vcr do
          it 'removes assignees' do
            issue = @client.remove_assignees(
              @repo.full_name, @issue.number, ['api-padawan']
            )
            expect(issue.assignees.count).to be_zero
            assert_requested :post, github_url("repos/#{@repo.full_name}/issues/#{@issue.number}/assignees")
          end
        end # .remove_assignees
      end # with assignees
    end # with issue
  end # with repo

  describe '.repository_issues_comments', :vcr do
    it 'returns comments for all issues in a repository' do
      comments = @client.issues_comments('octokit/octokit.rb')
      expect(comments).to be_kind_of Array
      assert_requested :get, github_url('/repos/octokit/octokit.rb/issues/comments')
    end
  end # .repository_issues_comments

  describe '.issue_comments', :vcr do
    it 'returns comments for an issue' do
      comments = @client.issue_comments('octokit/octokit.rb', 25)
      expect(comments).to be_kind_of Array
      assert_requested :get, github_url('/repos/octokit/octokit.rb/issues/25/comments')
    end
  end # .issue_comments

  describe '.issue_comment', :vcr do
    it 'returns a single comment for an issue' do
      comment = @client.issue_comment('octokit/octokit.rb', 1_194_690)
      expect(comment.rels[:self].href).to eq('https://api.github.com/repos/octokit/octokit.rb/issues/comments/1194690')
      assert_requested :get, github_url('/repos/octokit/octokit.rb/issues/comments/1194690')
    end
  end # .issue_comment

  describe '.add_assignees', :vcr do
    it 'adds assignees' do
      issue = @client.add_assignees('tomb0y/wheelbarrow', 10, ['tomb0y'])
      expect(issue.assignees.count).not_to be_zero
      assert_requested :post, github_url('repos/tomb0y/wheelbarrow/issues/10/assignees')
    end
  end # .add_assignees
end