Test permission of OAuth token to post comments to GH

Author: noahd1

lib/cc/services/github_pull_requests.rb

@@ -24,7 +24,11 @@ class Config < CC::Service::Config
   # additional information (github-slug, PR number, etc) we can't test much
   # else.
   def receive_test
-    receive_test_status if config.update_status
+    if config.update_status
+      receive_test_status
+    elsif config.add_comment
+      receive_test_comment
+    end
   end
 
   def receive_test_status
@@ -42,6 +46,20 @@ def receive_test_status
     { ok: false, message: ex.message }
   end
 
+  def receive_test_comment
+    setup_http
+
+    response = http_get(user_url)
+    if response_includes_repo_scope?(response)
+      { ok: true, message: "OAuth token is valid" }
+    else
+      { ok: false, message: "OAuth token requires 'repo' scope to post comments." }
+    end
+
+  rescue => ex
+    { ok: false, message: ex.message }
+  end
+
   def receive_pull_request
     setup_http
 
@@ -104,6 +122,10 @@ def comments_url
     "#{BASE_URL}/repos/#{github_slug}/issues/#{number}/comments"
   end
 
+  def user_url
+    "#{BASE_URL}/user"
+  end
+
   def github_slug
     @payload.fetch("github_slug")
   end
@@ -116,4 +138,8 @@ def number
     @payload.fetch("number")
   end
 
+  def response_includes_repo_scope?(response)
+    response.headers['x-oauth-scopes'] && response.headers['x-oauth-scopes'].split(/\s*,\s*/).include?("repo")
+  end
+
 end

service_test.rb

@@ -11,7 +11,7 @@
 # Example:
 #
 #   $ SLACK_WEBHOOK_URL="http://..." bundle exec ruby service_test.rb
-#   $ GITHUBPULLREQUESTS_OAUTH_TOKEN=06083a4a060d358ca709939b1f00645777661c44 bundle exec ruby service_test.rb
+#   $ GITHUBPULLREQUESTS_UPDATE_STATUS=false GITHUBPULLREQUESTS_ADD_COMMENT=true GITHUBPULLREQUESTS_OAUTH_TOKEN=06083a4a060d358ca709939b1f00645777661c44 bundle exec ruby service_test.rb
 #
 # Other Environment variables used:
 #
@@ -80,4 +80,4 @@ def test_service(klass, config, payload)
 ServiceTest.new(CC::Service::Flowdock, :api_token).test
 ServiceTest.new(CC::Service::Jira, :username, :password, :domain, :project_id).test
 ServiceTest.new(CC::Service::Asana, :api_key, :workspace_id, :project_id).test
-ServiceTest.new(CC::Service::GitHubPullRequests, :oauth_token).test({ github_slug: "codeclimate/codeclimate" })
+ServiceTest.new(CC::Service::GitHubPullRequests, :oauth_token, :update_status, :add_comment).test({ github_slug: "codeclimate/codeclimate" })

test/github_pull_requests_test.rb

@@ -39,6 +39,24 @@ def test_pull_request_status_test_failure
     assert !receive_test({ update_status: true }, { github_slug: "pbrisbin/foo" })[:ok], "Expected failed test of pull request"
   end
 
+  def test_pull_request_comment_test_success
+    @stubs.get("/user") { |env| [200, { "x-oauth-scopes" => "gist, user, repo" }, ""] }
+
+    assert receive_test({ add_comment: true })[:ok], "Expected test of pull request to be true"
+  end
+
+  def test_pull_request_comment_test_failure_insufficient_permissions
+    @stubs.get("/user") { |env| [200, { "x-oauth-scopes" => "gist, user" }, ""] }
+
+    assert !receive_test({ add_comment: true })[:ok], "Expected failed test of pull request"
+  end
+
+  def test_pull_request_comment_test_failure_bad_token
+    @stubs.get("/user") { |env| [401, {}, ""] }
+
+    assert !receive_test({ add_comment: true })[:ok], "Expected failed test of pull request"
+  end
+
   def test_pull_request_comment
     stub_existing_comments("pbrisbin/foo", 1, %w[Hey Yo])
 
@@ -104,7 +122,7 @@ def receive_pull_request(config, event_data)
     )
   end
 
-  def receive_test(config, event_data)
+  def receive_test(config, event_data = {})
     receive(
       CC::Service::GitHubPullRequests,
       { oauth_token: "123" }.merge(config),