Ignore github example integration tests when building PR (OpenFeign#1094)

velo · web-flow · commit 770b579fd66a · 2019-10-12T16:05:51.000+13:00
diff --git a/example-github/pom.xml b/example-github/pom.xml
@@ -92,6 +92,15 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-failsafe-plugin</artifactId>
         <version>${maven-surefire-plugin.version}</version>
+        <configuration>
+          <!--
+              Travis does not inject GITHUB_TOKEN when building PRs, which will make module fail
+              https://docs.travis-ci.com/user/environment-variables/#defining-encrypted-variables-in-travisyml
+
+              ignoring test errors for any build that is not master
+          -->
+          <testFailureIgnore>true</testFailureIgnore>
+        </configuration>
         <executions>
           <execution>
             <goals>
@@ -103,4 +112,26 @@
       </plugin>
     </plugins>
   </build>
+
+  <profiles>
+    <profile>
+      <activation>
+        <property>
+          <name>env.TRAVIS_PULL_REQUEST</name>
+          <value>false</value>
+        </property>
+      </activation>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-failsafe-plugin</artifactId>
+            <configuration>
+              <testFailureIgnore>false</testFailureIgnore>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
 </project>
diff --git a/example-github/src/main/java/example/github/GitHubExample.java b/example-github/src/main/java/example/github/GitHubExample.java
@@ -13,15 +13,15 @@
  */
 package example.github;
 
+import java.io.IOException;
+import java.util.List;
+import java.util.stream.Collectors;
 import feign.*;
 import feign.codec.Decoder;
 import feign.codec.Encoder;
 import feign.codec.ErrorDecoder;
 import feign.gson.GsonDecoder;
 import feign.gson.GsonEncoder;
-import java.io.IOException;
-import java.util.List;
-import java.util.stream.Collectors;
 
 /**
  * Inspired by {@code com.example.retrofit.GitHubClient}
@@ -72,8 +72,8 @@ default List<String> contributors(String owner) {
     }
 
     static GitHub connect() {
-      Decoder decoder = new GsonDecoder();
-      Encoder encoder = new GsonEncoder();
+      final Decoder decoder = new GsonDecoder();
+      final Encoder encoder = new GsonEncoder();
       return Feign.builder()
           .encoder(encoder)
           .decoder(decoder)
@@ -84,6 +84,8 @@ static GitHub connect() {
             if (System.getenv().containsKey(GITHUB_TOKEN)) {
               System.out.println("Detected Authorization token from environment variable");
               template.header(
+                  // not available when building PRs...
+                  // https://docs.travis-ci.com/user/environment-variables/#defining-encrypted-variables-in-travisyml
                   "Authorization",
                   "token " + System.getenv(GITHUB_TOKEN));
             }
@@ -103,28 +105,28 @@ public String getMessage() {
   }
 
   public static void main(String... args) {
-    GitHub github = GitHub.connect();
+    final GitHub github = GitHub.connect();
 
     System.out.println("Let's fetch and print a list of the contributors to this org.");
-    List<String> contributors = github.contributors("openfeign");
-    for (String contributor : contributors) {
+    final List<String> contributors = github.contributors("openfeign");
+    for (final String contributor : contributors) {
       System.out.println(contributor);
     }
 
     System.out.println("Now, let's cause an error.");
     try {
       github.contributors("openfeign", "some-unknown-project");
-    } catch (GitHubClientError e) {
+    } catch (final GitHubClientError e) {
       System.out.println(e.getMessage());
     }
 
     System.out.println("Now, try to create an issue - which will also cause an error.");
     try {
-      GitHub.Issue issue = new GitHub.Issue();
+      final GitHub.Issue issue = new GitHub.Issue();
       issue.title = "The title";
       issue.body = "Some Text";
       github.createIssue(issue, "OpenFeign", "SomeRepo");
-    } catch (GitHubClientError e) {
+    } catch (final GitHubClientError e) {
       System.out.println(e.getMessage());
     }
   }
@@ -144,7 +146,7 @@ public Exception decode(String methodKey, Response response) {
         // must replace status by 200 other GSONDecoder returns null
         response = response.toBuilder().status(200).build();
         return (Exception) decoder.decode(response, GitHubClientError.class);
-      } catch (IOException fallbackToDefault) {
+      } catch (final IOException fallbackToDefault) {
         return defaultDecoder.decode(methodKey, response);
       }
     }
