Merge pull request #33 from code-check/30-UserEnv

30 user env

Author: sukeshni

src/main/scala/codecheck/github/api/GitHubAPI.scala

@@ -53,6 +53,10 @@ class GitHubAPI(token: String, client: AsyncHttpClient, tokenType: String = "tok
     request
       .setHeader("Authorization", s"$tokenType $token")
       .setHeader("Content-Type", "application/json")
+    if (method == "PUT" && body == JNothing){
+      request
+        .setHeader("Content-Length", "0")
+    }
     request.execute(new AsyncCompletionHandler[Response]() {
       def onCompleted(res: Response) = {
         val json = Option(res.getResponseBody).filter(_.length > 0).map(parseJson(_)).getOrElse(JNothing)

src/main/scala/codecheck/github/models/Collaborator.scala

@@ -8,4 +8,4 @@ case class Collaborator(value: JValue) extends AbstractJson(value) {
   def url = get("url")
   def site_admin: Boolean = boolean("site_admin")
 }
-//case class CollaboratorInput extends AbstractInput
+//case class CollaboratorInput extends AbstractInput

src/main/scala/codecheck/github/operations/CollaboratorOp.scala

@@ -20,4 +20,28 @@ trait CollaboratorOp {
       }
     )
   }
+
+  def isCollaborator(owner: String, repo: String, name: String): Future[Boolean] = {
+    val path = s"/repos/${owner}/${repo}/collaborators/" + encode(name)
+    exec("GET", path, fail404 = false).map { res =>
+      res.statusCode match {
+        case 404 => false
+        case 204 => true
+      }
+    }
+  }
+
+  def addCollaborator(owner: String, repo: String, name: String): Future[Boolean] = {
+    val path = s"/repos/${owner}/${repo}/collaborators/" + encode(name)
+    exec("PUT", path).map {
+      _.statusCode == 204
+    }
+  }
+
+  def removeCollaborator(owner: String, repo: String, name: String): Future[Boolean] = {
+    val path = s"/repos/${owner}/${repo}/collaborators/" + encode(name)
+    exec("DELETE", path).map {
+      _.statusCode == 204
+    }
+  }
 }

src/test/scala/CollaboratorOpSpec.scala

@@ -1,6 +1,8 @@
 import org.scalatest.path.FunSpec
-import codecheck.github.models.Collaborator
 import scala.concurrent.Await
+import codecheck.github.models.Collaborator
+import codecheck.github.exceptions.GitHubAPIException
+import codecheck.github.exceptions.NotFoundException
 
 class CollaboratorOpSpec extends FunSpec with Constants {
 
@@ -16,4 +18,44 @@ class CollaboratorOpSpec extends FunSpec with Constants {
       assert(c.site_admin == false)
     }
   }
+  describe("isCollaborator"){
+    it("if it is Collaborator"){
+      val res = Await.result(api.addCollaborator(user, userRepo, collaboratorUser),TIMEOUT)
+      assert(res)
+      val res1 = Await.result(api.isCollaborator(user, userRepo, collaboratorUser),TIMEOUT)
+      assert(res1 == true)
+      var res2 = Await.result(api.removeCollaborator(user, userRepo, collaboratorUser),TIMEOUT)
+      assert(res2)
+    }
+    it("if it is not a valid Collaborator"){
+      val res1 = Await.result(api.isCollaborator(organization, repo, otherUserInvalid),TIMEOUT)
+      assert(res1 == false)
+    }
+  }
+  describe("addCollaborator"){
+    it("should add Collaborator User to user Repo"){
+      val res = Await.result(api.addCollaborator(user, userRepo, collaboratorUser),TIMEOUT)
+      assert(res)
+    }
+    it("should fail for non existent User Repo"){
+      val res = Await.result(api.addCollaborator(user, repoInvalid, collaboratorUser).failed,TIMEOUT)
+      res match {
+        case e: NotFoundException  =>
+        case _ => fail
+      }
+    }
+  }
+ describe("removeCollaborator"){
+    it("should remove the Collaborator"){
+      var res = Await.result(api.removeCollaborator(user, userRepo, collaboratorUser),TIMEOUT)
+      assert(res)
+    }
+  }
+  it("should fail for non existent User Repo"){
+    var res = Await.result(api.removeCollaborator(user, repoInvalid, collaboratorUser).failed,TIMEOUT)
+    res match {
+      case e: NotFoundException  =>
+      case _ => fail
+    }
+  }
 }

src/test/scala/Constants.scala

@@ -12,8 +12,6 @@ trait Constants {
   protected val TIMEOUT = 5 seconds
   protected val api = Constants.API
 
-  protected val user = "fanwashere" //REQUIRED: Edit this to your own username.
-
   //Request membership of dummy organization "celestialbeing" if you are not member. Do not edit.
   protected val organization = "celestialbeings"
   protected val repo = "test-repo"
@@ -27,13 +25,18 @@ trait Constants {
       println(v)
     }
   }
-  protected val otherUser = "shunjikonishi" 
+
+  protected val user = sys.env("GITHUB_USER")
+  protected val userRepo = sys.env("GITHUB_REPO")
+
+  protected val otherUser = "shunjikonishi"
+  protected val collaboratorUser = "givery-dev"
   protected val otherUserInvalid = "loremipsom123"
   protected val organizationInvalid = "loremipsom123"
   protected val repoInvalid = "loremipsom123"
 
   val wordBank = Array("Alpha", "Beta", "Gamma", "Delta", "Epsilon", "Zeta", "Theta", "Lambda", "Pi", "Sigma")
-  def generateRandomString: String = 
+  def generateRandomString: String =
   wordBank(nextInt(10)) + " " + wordBank(nextInt(10)) + " " + wordBank(nextInt(10))
   def generateRandomWord: String = wordBank(nextInt(10))
   def generateRandomInt: Int = nextInt(1000)
@@ -44,4 +47,4 @@ object Constants {
   implicit val client = new AsyncHttpClient()
 
   val API = GitHubAPI(token)
-}
+}

src/test/scala/README.md

@@ -2,15 +2,17 @@
 This readme documents the changes to the tests.
 
 ## Initial Setup
-1. Change variable user in Constants.scala to your own Github username.
+1. Please export username and repository that exists under your name.
 2. If you have no yet exported your Github token, create one [here](https://github.com/settings/tokens) and export it.
 
 ``` bash
-export GITHUB_TOKEN=[Your GitHub Token] 
+export GITHUB_TOKEN=[Your GitHub Token]
+export GITHUB_USER=[Your User Name]
+export GITHUB_REPO=[Your Repo name that exists]
 ```
 
 ## Optional settings
-- showResponse 
+- showResponse
 -- Set this to true if you would like to see the response JSON data. Otherwise it is omitted when running tests.
 
 The following variables are for futureproofing. Generally won't need to be modified.
@@ -37,4 +39,4 @@ The random string generator is located in Constants.scala and uses words from th
 -- Returns a String with a single random word.
 - generatedRandomInt()
 -- Returns a random Int from 0 to 999. This was added to avoid having to import the Random class in every file (so it is bundled with Constants)
-Use these to generate random field values to test create and update functions.
+Use these to generate random field values to test create and update functions.

test.md

@@ -0,0 +1,42 @@
+# Tests
+This readme documents the changes to the tests.
+
+## Initial Setup
+1. Please export username and repository that exists under your name.
+2. If you have no yet exported your Github token, create one [here](https://github.com/settings/tokens) and export it.
+
+``` bash
+export GITHUB_TOKEN=[Your GitHub Token]
+export GITHUB_USER=[Your User Name]
+export GITHUB_REPO=[Your Repo name that exists]
+```
+
+## Optional settings
+- showResponse
+-- Set this to true if you would like to see the response JSON data. Otherwise it is omitted when running tests.
+
+The following variables are for futureproofing. Generally won't need to be modified.
+- otherUser
+-- Another user's (not yourself) username.
+- otherUserInvalid
+-- An invalid username.
+- organizationInvalid
+-- An invalid organization.
+- repoInvalid
+-- An invalid repo.
+
+The following variables should not be changed.
+- organization
+-- This is by default set to our dummy test organization "celestialbeings".
+- repo
+-- This is by default set to the dummy est repo "test-repo".
+
+## Random Generator
+The random string generator is located in Constants.scala and uses words from the wordBank array. It has three methods.
+- generateRandomString()
+-- Returns a String with three random words seperated by spaces.
+- generateRandomWord()
+-- Returns a String with a single random word.
+- generatedRandomInt()
+-- Returns a random Int from 0 to 999. This was added to avoid having to import the Random class in every file (so it is bundled with Constants)
+Use these to generate random field values to test create and update functions.