Add test for AppInstallationToken

Author: bitwiseman

src/main/java/org/jenkinsci/plugins/github_branch_source/GitHubAppCredentials.java

@@ -210,15 +210,15 @@ static class AppInstallationToken implements Serializable {
          * The time-to-live for the token may be less than this if the initial expiration for the token when
          * it is returned from GitHub is less than this.
          */
-        private final static long MINIMUM_SECONDS_UNTIL_EXPIRATION = Duration.ofMinutes(45).getSeconds();
+        static final long MINIMUM_SECONDS_UNTIL_EXPIRATION = Duration.ofMinutes(45).getSeconds();
 
         /**
          * Any token older than this is considered stale.
          *
          * This is a back stop to ensure that, in case of unforeseen error,
          * expired tokens are not accidentally retained past their expiration.
          */
-        private static final long MAXIMUM_AGE_SECONDS = Duration.ofMinutes(30).getSeconds();
+        static final long MAXIMUM_AGE_SECONDS = Duration.ofMinutes(30).getSeconds();
 
         private final String token;
         private final long tokenStaleEpochSeconds;
@@ -227,25 +227,25 @@ static class AppInstallationToken implements Serializable {
          * Create a AppInstallationToken instance.
          *
          * @param token the token string
-         * @param tokenExpirationEpochSeconds the time in epoch seconds that this token will expire
+         * @param expirationEpochSeconds the time in epoch seconds that this token will expire
          */
-        public AppInstallationToken(String token, long tokenExpirationEpochSeconds) {
+        public AppInstallationToken(String token, long expirationEpochSeconds) {
             long nextSecond = Instant.now().getEpochSecond() + 1;
 
             // Tokens go stale a while before they will expire
-            long tokenStaleEpochSeconds = tokenExpirationEpochSeconds - MINIMUM_SECONDS_UNTIL_EXPIRATION;
+            long staleEpochSeconds = expirationEpochSeconds - MINIMUM_SECONDS_UNTIL_EXPIRATION;
 
             // Tokens are not stale as soon as they are made
-            if (tokenStaleEpochSeconds < nextSecond) {
-                tokenStaleEpochSeconds = nextSecond;
+            if (staleEpochSeconds < nextSecond) {
+                staleEpochSeconds = nextSecond;
             } else {
                 // Tokens have a maximum age at which they go stale
-                tokenStaleEpochSeconds = Math.min(tokenExpirationEpochSeconds, nextSecond + MAXIMUM_AGE_SECONDS);
+                staleEpochSeconds = Math.min(staleEpochSeconds, nextSecond + MAXIMUM_AGE_SECONDS);
             }
-            LOGGER.log(Level.FINER, "Token stale time epoch seconds: {0}", tokenStaleEpochSeconds);
+            LOGGER.log(Level.FINER, "Token stale time epoch seconds: {0}", staleEpochSeconds);
 
             this.token = token;
-            this.tokenStaleEpochSeconds = tokenStaleEpochSeconds;
+            this.tokenStaleEpochSeconds = staleEpochSeconds;
         }
 
         public String getToken() {
@@ -265,6 +265,10 @@ public boolean isStale() {
             return Instant.now().getEpochSecond() >= tokenStaleEpochSeconds;
         }
 
+        long getTokenStaleEpochSeconds() {
+            return tokenStaleEpochSeconds;
+        }
+
     }
 
     /**

src/test/java/org/jenkinsci/plugins/github_branch_source/GitHubAppCredentialsTest.java

@@ -0,0 +1,73 @@
+package org.jenkinsci.plugins.github_branch_source;
+
+import com.cloudbees.plugins.credentials.Credentials;
+import com.cloudbees.plugins.credentials.SystemCredentialsProvider;
+import com.cloudbees.plugins.credentials.casc.CredentialsRootConfigurator;
+import com.cloudbees.plugins.credentials.domains.DomainCredentials;
+import com.vladsch.flexmark.ext.ins.Ins;
+import io.jenkins.plugins.casc.ConfigurationContext;
+import io.jenkins.plugins.casc.ConfiguratorRegistry;
+import io.jenkins.plugins.casc.misc.ConfiguredWithCode;
+import io.jenkins.plugins.casc.misc.EnvVarsRule;
+import io.jenkins.plugins.casc.misc.JenkinsConfiguredWithCodeRule;
+import io.jenkins.plugins.casc.model.CNode;
+import io.jenkins.plugins.casc.model.Mapping;
+import io.jenkins.plugins.casc.model.Sequence;
+import jenkins.model.Jenkins;
+import org.junit.ClassRule;
+import org.junit.Test;
+import org.junit.rules.RuleChain;
+import org.jvnet.hudson.test.JenkinsRule;
+
+import java.time.Duration;
+import java.time.Instant;
+import java.util.List;
+import java.util.Objects;
+
+import static io.jenkins.plugins.casc.misc.Util.toStringFromYamlFile;
+import static io.jenkins.plugins.casc.misc.Util.toYamlString;
+import static org.hamcrest.Matchers.*;
+import static org.junit.Assert.assertThat;
+import static org.jvnet.hudson.test.JenkinsMatchers.hasPlainText;
+
+public class GitHubAppCredentialsTest {
+
+    @Test
+    public void testAppInstallationTokenStale() throws Exception {
+
+        GitHubAppCredentials.AppInstallationToken token;
+        long now;
+
+        now = Instant.now().getEpochSecond();
+        token = new GitHubAppCredentials.AppInstallationToken("", now);
+        assertThat(token.isStale(), is(false));
+        assertThat(token.getTokenStaleEpochSeconds(), equalTo(now + 1));
+
+        Thread.sleep(1000);
+        assertThat(token.isStale(), is(true));
+
+        now = Instant.now().getEpochSecond();
+        token = new GitHubAppCredentials.AppInstallationToken("",
+            now + Duration.ofMinutes(15).getSeconds());
+        assertThat(token.isStale(), is(false));
+        assertThat(token.getTokenStaleEpochSeconds(), equalTo(now + 1));
+
+        now = Instant.now().getEpochSecond();
+        token = new GitHubAppCredentials.AppInstallationToken("",
+            now + GitHubAppCredentials.AppInstallationToken.MINIMUM_SECONDS_UNTIL_EXPIRATION + 2);
+        assertThat(token.isStale(), is(false));
+        assertThat(token.getTokenStaleEpochSeconds(), equalTo(now + 2));
+
+        now = Instant.now().getEpochSecond();
+        token = new GitHubAppCredentials.AppInstallationToken("",
+            now + GitHubAppCredentials.AppInstallationToken.MINIMUM_SECONDS_UNTIL_EXPIRATION + Duration.ofMinutes(7).getSeconds());
+        assertThat(token.isStale(), is(false));
+        assertThat(token.getTokenStaleEpochSeconds(), equalTo(now + Duration.ofMinutes(7).getSeconds()));
+
+        now = Instant.now().getEpochSecond();
+        token = new GitHubAppCredentials.AppInstallationToken("",
+            now + Duration.ofMinutes(90).getSeconds());
+        assertThat(token.isStale(), is(false));
+        assertThat(token.getTokenStaleEpochSeconds(), equalTo(now + GitHubAppCredentials.AppInstallationToken.MAXIMUM_AGE_SECONDS + 1));
+    }
+}