Merge pull request #478 from martinvanzijl/issue_460_team_description…

…_field

Added description field to GHTeam class.

src/main/java/org/kohsuke/github/GHTeam.java

@@ -12,7 +12,7 @@
  * @author Kohsuke Kawaguchi
  */
 public class GHTeam {
- private String name,permission,slug;
+ private String name,permission,slug,description;
  private int id;
  private GHOrganization organization; // populated by GET /user/teams where Teams+Orgs are returned together
 
@@ -59,6 +59,16 @@ public String getSlug() {
  return slug;
  }
 
+ public String getDescription() {
+ return description;
+ }
+
+ public void setDescription(String description) throws IOException {
+ org.root.retrieve().method("PATCH")
+ .with("description", description)
+ .to(api(""));
+ }
+
  public int getId() {
  return id;
  }

src/test/java/org/kohsuke/github/AbstractGitHubApiWireMockTest.java

@@ -107,6 +107,7 @@ protected GitHubBuilder getGitHubBuilder() {
  // This sets the user and password to a placeholder for wiremock testing
  // This makes the tests believe they are running with permissions
  // The recorded stubs will behave like they running with permissions
+ builder.oauthToken = null;
  builder.withPassword(STUBBED_USER_LOGIN, STUBBED_USER_PASSWORD);
  }
 

src/test/java/org/kohsuke/github/GHRepositoryTest.java

@@ -178,9 +178,9 @@ public void listLanguages() throws IOException {
 
  @Test // Issue #261
  public void listEmptyContributors() throws IOException {
- GitHub gh = GitHub.connect();
- for (GHRepository.Contributor c : gh.getRepository(GITHUB_API_TEST_ORG + "/empty").listContributors()) {
+ for (GHRepository.Contributor c : gitHub.getRepository(GITHUB_API_TEST_ORG + "/empty").listContributors()) {
  System.out.println(c);
+ fail("This list should be empty, but should return a valid empty iterable.");
  }
  }
 

src/test/java/org/kohsuke/github/GHTeamTest.java

@@ -0,0 +1,33 @@
+package org.kohsuke.github;
+
+import org.junit.Test;
+
+import java.io.IOException;
+import java.util.Random;
+
+public class GHTeamTest extends AbstractGitHubApiWireMockTest {
+
+ @Test
+ public void testSetDescription() throws IOException {
+
+ String description = "Updated by API Test";
+ String teamSlug = "dummy-team";
+
+ // Set the description.
+ GHTeam team = gitHub.getOrganization(GITHUB_API_TEST_ORG).getTeamBySlug(teamSlug);
+ team.setDescription(description);
+
+ // Check that it was set correctly.
+ team = gitHub.getOrganization(GITHUB_API_TEST_ORG).getTeamBySlug(teamSlug);
+ assertEquals(description, team.getDescription());
+
+ description += "Modified";
+
+ // Set the description.
+ team.setDescription(description);
+
+ // Check that it was set correctly.
+ team = gitHub.getOrganization(GITHUB_API_TEST_ORG).getTeamBySlug(teamSlug);
+ assertEquals(description, team.getDescription());
+ }
+}

src/test/java/org/kohsuke/github/junit/GitHubApiWireMockRule.java

@@ -1,23 +1,31 @@
 package org.kohsuke.github.junit;
 
 import com.github.tomakehurst.wiremock.common.FileSource;
+import com.github.tomakehurst.wiremock.common.InputStreamSource;
 import com.github.tomakehurst.wiremock.core.WireMockConfiguration;
 import com.github.tomakehurst.wiremock.extension.Parameters;
 import com.github.tomakehurst.wiremock.extension.ResponseTransformer;
+import com.github.tomakehurst.wiremock.http.HttpHeader;
+import com.github.tomakehurst.wiremock.http.HttpHeaders;
 import com.github.tomakehurst.wiremock.http.Request;
 import com.github.tomakehurst.wiremock.http.Response;
 import com.google.gson.*;
 import com.jcraft.jsch.IO;
 
+import java.io.ByteArrayInputStream;
 import java.io.File;
 import java.io.IOException;
+import java.io.InputStream;
 import java.lang.reflect.Type;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.Collection;
 import java.util.Map;
 
 import static com.github.tomakehurst.wiremock.client.WireMock.*;
 import static com.github.tomakehurst.wiremock.client.WireMock.status;
+import static com.github.tomakehurst.wiremock.common.Gzip.gzip;
+import static com.github.tomakehurst.wiremock.common.Gzip.unGzipToString;
 
 /**
  * @author Liam Newman
@@ -42,18 +50,35 @@ public GitHubApiWireMockRule(WireMockConfiguration options, boolean failOnUnmatc
  @Override
  public Response transform(Request request, Response response, FileSource files,
  Parameters parameters) {
+ Response.Builder builder = Response.Builder.like(response);
+ Collection<HttpHeader> headers = response.getHeaders().all();
+ HttpHeader linkHeader = response.getHeaders().getHeader("Link");
+ if (linkHeader.isPresent()) {
+ headers.removeIf(item -> item.keyEquals("Link"));
+ headers.add(HttpHeader.httpHeader("Link", linkHeader.firstValue()
+ .replace("https://api.github.com/",
+ "http://localhost:" + request.getPort() + "/")));
+ }
+
  if ("application/json"
- .equals(response.getHeaders().getContentTypeHeader().mimeTypePart())
- && !response.getHeaders().getHeader("Content-Encoding").containsValue("gzip")) {
- return Response.Builder.like(response)
- .but()
- .body(response.getBodyAsString()
- .replace("https://api.github.com/",
- "http://localhost:" + request.getPort() + "/")
- )
- .build();
+ .equals(response.getHeaders().getContentTypeHeader().mimeTypePart())) {
+
+ String body;
+ if (response.getHeaders().getHeader("Content-Encoding").containsValue("gzip")) {
+ headers.removeIf(item -> item.keyEquals("Content-Encoding"));
+ body = unGzipToString(response.getBody());
+ } else {
+ body = response.getBodyAsString();
+ }
+
+ builder.body(body
+ .replace("https://api.github.com/",
+ "http://localhost:" + request.getPort() + "/"));
+
  }
- return response;
+ builder.headers(new HttpHeaders(headers));
+
+ return builder.build();
  }
 
  @Override
@@ -126,6 +151,10 @@ public JsonElement serialize(Double src, Type typeOfSrc, JsonSerializationContex
  try {
  if (filePath.toString().endsWith(".json")) {
  String fileText = new String(Files.readAllBytes(filePath));
+ // while recording responses we replaced all github calls localhost
+ // now we reverse that for storage.
+ fileText = fileText.replace(this.baseUrl(),
+ "https://api.github.com");
  // Can be Array or Map
  Object parsedObject = g.fromJson(fileText, Object.class);
  if (parsedObject instanceof Map && filePath.toString().contains("mappings")) {

src/test/resources/org/kohsuke/github/AppTest/wiremock/testGetIssues/__files/orgs_github-api-f6cfd971-f411-41bf-ac1d-c6bfc7d0d3bf.json → src/test/resources/org/kohsuke/github/AppTest/wiremock/testGetIssues/__files/orgs_github-api-baecb5db-6e9c-441b-8414-c8070d9bc0c2.json

@@ -25,7 +25,7 @@
  "total_private_repos": 0,
  "owned_private_repos": 0,
  "private_gists": 0,
- "disk_usage": 11899,
+ "disk_usage": 12072,
  "collaborators": 0,
  "billing_email": "bitwiseman@gmail.com",
  "default_repository_permission": "read",

src/test/resources/org/kohsuke/github/AppTest/wiremock/testGetIssues/__files/repos_github-api_github-api-6d000b5b-5941-4a61-9352-b01e032a25d4.json → src/test/resources/org/kohsuke/github/AppTest/wiremock/testGetIssues/__files/repos_github-api_github-api-891820f6-7cd7-437a-8ec1-16c3e76c53ec.json

@@ -65,14 +65,14 @@
  "releases_url": "https://api.github.com/repos/github-api/github-api/releases{/id}",
  "deployments_url": "https://api.github.com/repos/github-api/github-api/deployments",
  "created_at": "2010-04-19T04:13:03Z",
- "updated_at": "2019-10-03T09:41:10Z",
- "pushed_at": "2019-10-02T22:27:45Z",
+ "updated_at": "2019-10-03T21:38:52Z",
+ "pushed_at": "2019-10-03T23:00:11Z",
  "git_url": "git://github.com/github-api/github-api.git",
  "ssh_url": "git@github.com:github-api/github-api.git",
  "clone_url": "https://github.com/github-api/github-api.git",
  "svn_url": "https://github.com/github-api/github-api",
  "homepage": "http://github-api.kohsuke.org/",
- "size": 11899,
+ "size": 12072,
  "stargazers_count": 557,
  "watchers_count": 557,
  "language": "Java",
@@ -85,7 +85,7 @@
  "mirror_url": null,
  "archived": false,
  "disabled": false,
- "open_issues_count": 90,
+ "open_issues_count": 89,
  "license": {
  "key": "mit",
  "name": "MIT License",
@@ -94,7 +94,7 @@
  "node_id": "MDc6TGljZW5zZTEz"
  },
  "forks": 428,
- "open_issues": 90,
+ "open_issues": 89,
  "watchers": 557,
  "default_branch": "master",
  "permissions": {