Modified IT for branch filter

sanderv32 · sanderv32 · commit d61317718ff8 · 2019-07-19T00:41:37.000+02:00
diff --git a/src/test/java/org/jenkinsci/plugins/gogs/GogsConfigHandler.java b/src/test/java/org/jenkinsci/plugins/gogs/GogsConfigHandler.java
@@ -193,6 +193,20 @@ void createEmptyRepo(String projectName) throws IOException {
         }
     }
 
+    void removeRepo(String projectName) throws IOException {
+        Executor executor = getExecutor();
+        String gogsHookConfigUrl = getGogsServer_apiUrl() + "repos/" + this.gogsServer_user + "/" + projectName;
+        Request request = Request.Delete(gogsHookConfigUrl);
+
+        if (this.gogsAccessToken != null) {
+            request.addHeader("Authorization", "token " + this.gogsAccessToken);
+        }
+
+        int result = executor.execute(request).returnResponse().getStatusLine().getStatusCode();
+        if (result != 204) {
+            throw new IOException("Repository deletion call did not return the expected value (returned " +  result + ")");
+        }
+    }
 
     /**
      * Gets a Executor object. The Executor object allows to cache the authentication data.
diff --git a/src/test/java/org/jenkinsci/plugins/gogs/GogsWebHook_IT.java b/src/test/java/org/jenkinsci/plugins/gogs/GogsWebHook_IT.java
@@ -1,5 +1,29 @@
 package org.jenkinsci.plugins.gogs;
 
+import static org.eclipse.jgit.lib.ConfigConstants.CONFIG_BRANCH_SECTION;
+import static org.eclipse.jgit.lib.ConfigConstants.CONFIG_REMOTE_SECTION;
+import static org.eclipse.jgit.lib.ConfigConstants.CONFIG_USER_SECTION;
+import static org.jenkinsci.plugins.gogs.JenkinsHandler.waitUntilJenkinsHasBeenStartedUp;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.fail;
+
+import java.io.BufferedWriter;
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.StringReader;
+import java.io.Writer;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.nio.charset.Charset;
+import java.nio.file.Files;
+import java.text.SimpleDateFormat;
+import java.util.Date;
+import java.util.List;
+import java.util.Properties;
+import java.util.concurrent.TimeoutException;
+
 import com.offbytwo.jenkins.JenkinsServer;
 import com.offbytwo.jenkins.model.Artifact;
 import com.offbytwo.jenkins.model.BuildWithDetails;
@@ -11,7 +35,6 @@
 import org.eclipse.jgit.dircache.DirCache;
 import org.eclipse.jgit.lib.StoredConfig;
 import org.eclipse.jgit.revwalk.RevCommit;
-import org.eclipse.jgit.transport.PushResult;
 import org.eclipse.jgit.transport.RefSpec;
 import org.eclipse.jgit.transport.UsernamePasswordCredentialsProvider;
 import org.junit.Rule;
@@ -22,35 +45,18 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.io.*;
-import java.net.URI;
-import java.net.URISyntaxException;
-import java.nio.charset.Charset;
-import java.nio.file.Files;
-import java.text.SimpleDateFormat;
-import java.util.Date;
-import java.util.List;
-import java.util.Properties;
-import java.util.concurrent.TimeoutException;
-
-import static org.eclipse.jgit.lib.ConfigConstants.*;
-import static org.jenkinsci.plugins.gogs.JenkinsHandler.waitUntilJenkinsHasBeenStartedUp;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.fail;
-
 //FIXME: the test should run in sequence
 
 public class GogsWebHook_IT {
-    public static final String JENKINS_URL = "http://localhost:8080/";
-    public static final String JENKINS_USER = "butler";
-    public static final String JENKINS_PASSWORD = "butler";
-    public static final String GOGS_URL = "http://localhost:3000";
-    public static final String GOGS_USER = "butler";
-    public static final String GOGS_PASSWORD = "butler";
-    public static final String WEBHOOK_URL = "http://localhost:8080/job/testRep1/build?delay=0";
-    public static final String JSON_COMMANDFILE_PATH = "target/test-classes/Gogs-config-json/";
-    public static final String JENKINS_CONFIGS_PATH = "target/test-classes/Jenkins-config/";
-    public static final String JENKINS_JOB_NAME = "test project";
+    private static final String JENKINS_URL = "http://localhost:8080/";
+    private static final String JENKINS_USER = "butler";
+    private static final String JENKINS_PASSWORD = "butler";
+    private static final String GOGS_URL = "http://localhost:3000";
+    private static final String GOGS_USER = "butler";
+    private static final String GOGS_PASSWORD = "butler";
+    private static final String JSON_COMMANDFILE_PATH = "target/test-classes/Gogs-config-json/";
+    private static final String JENKINS_CONFIGS_PATH = "target/test-classes/Jenkins-config/";
+    private static final String JENKINS_JOB_NAME = "test project";
     final Logger log = LoggerFactory.getLogger(GogsWebHook_IT.class);
 
     @Rule
@@ -63,13 +69,50 @@ protected void starting(Description description) {
 
     @Test
     public void smokeTest_build_masterBranch() throws Exception {
+        final String projectName = "testRep1";
+
+        doItTest(JENKINS_JOB_NAME,
+                 projectName,
+                "test-project.xml",
+                "webHookDefinition.json",
+                null);
+    }
+
+    @Test
+    public void smokeTest_build_testBranch() throws Exception {
+        final String projectName = "testRep2";
+        doItTest(JENKINS_JOB_NAME + "2",
+                 projectName,
+                "test-project-branch.xml",
+                "webHookDefinition_branch.json",
+                "test");
+    }
+
+    /**
+     * Do integration tests
+     *
+     * @param jenkinsJobName Jenkins jobname
+     * @param projectName Gogs project name
+     * @param jenkinsXML XML file name with Jenkins job definition
+     * @param webhookDefinition JSON file with webhook definition
+     * @param branch Branch name to do test on (null means master)
+     * @throws Exception Something unexpected went wrong
+     */
+    private void doItTest(final String jenkinsJobName,
+                          final String projectName,
+                          final String jenkinsXML,
+                          final String webhookDefinition,
+                          final String branch) throws Exception {
+        // Default refspec is master
+        StringBuilder refSpec = new StringBuilder("refs/heads/master:refs/heads/");
+
         //Instantiate the Gogs Handler object and wait for the server to be available
         GogsConfigHandler gogsServer = new GogsConfigHandler(GOGS_URL, GOGS_USER, GOGS_PASSWORD);
         gogsServer.waitForServer(12, 5);
 
         //Create the test repository on the server
         try {
-            gogsServer.createEmptyRepo("testRep1");
+            gogsServer.createEmptyRepo(projectName);
         } catch (IOException e) {
             //check for the exist message;
             if (e.getMessage().contains("422")) {
@@ -87,50 +130,52 @@ public void smokeTest_build_masterBranch() throws Exception {
         StoredConfig config = git.getRepository().getConfig();
         config.setString(CONFIG_USER_SECTION, null, "name", "Automated Test");
         config.setString(CONFIG_USER_SECTION, null, "email", "test@test.org");
-        config.setString(CONFIG_REMOTE_SECTION, "origin", "url", "http://localhost:3000/butler/testRep1.git");
+        config.setString(CONFIG_REMOTE_SECTION, "origin", "url", "http://localhost:3000/butler/"+projectName+".git");
         config.setString(CONFIG_REMOTE_SECTION, "origin", "fetch", "+refs/heads/*:refs/remotes/origin/*");
         config.setString(CONFIG_BRANCH_SECTION, "master", "remote", "origin");
         config.setString(CONFIG_BRANCH_SECTION, "master", "merge", "refs/heads/master");
         config.save();
 
-
         //add the files located there and commit them
         Status status = git.status().call();
         DirCache index = git.add().addFilepattern(".").call();
         RevCommit commit = git.commit().setMessage("Repos initialization").call();
         log.info("Commit" + commit.getName());
 
-
         //push
         UsernamePasswordCredentialsProvider user2 = new UsernamePasswordCredentialsProvider("butler", "butler");
 
-        RefSpec spec = new RefSpec("refs/heads/master:refs/heads/master");
-        Iterable<PushResult> resultIterable = git.push()
-                .setRemote("origin")
-                .setCredentialsProvider(user2)
-                .setRefSpecs(spec)
-                .call();
+        if (branch == null) {
+            refSpec.append("master");
+        } else {
+            refSpec.append(branch);
+        }
 
-        //Setup the Jenkins job
+        RefSpec spec = new RefSpec(refSpec.toString());
+        git.push()
+           .setRemote("origin")
+           .setCredentialsProvider(user2)
+           .setRefSpecs(spec)
+           .setPushAll()
+           .call();
 
+        //Setup the Jenkins job
         JenkinsServer jenkins = new JenkinsServer(new URI(JENKINS_URL), JENKINS_USER, JENKINS_PASSWORD);
-
         waitUntilJenkinsHasBeenStartedUp(jenkins);
 
-
         //Check if the job exist. If not create it.
-        Job job = jenkins.getJob(JENKINS_JOB_NAME);
+        Job job = jenkins.getJob(jenkinsJobName);
         if (job == null) {
             //Read the job configuration into a string
-            File jenkinsConfigFile = new File(JENKINS_CONFIGS_PATH + "test-project.xml");
+            File jenkinsConfigFile = new File(JENKINS_CONFIGS_PATH + jenkinsXML);
             byte[] encoded = Files.readAllBytes(jenkinsConfigFile.toPath());
             String configXml = new String(encoded, Charset.defaultCharset());
 
-            jenkins.createJob(JENKINS_JOB_NAME, configXml);
+            jenkins.createJob(jenkinsJobName, configXml);
         }
 
         //Get the expected build number
-        JobWithDetails jobAtIntitalState = jenkins.getJob(JENKINS_JOB_NAME);
+        JobWithDetails jobAtIntitalState = jenkins.getJob(jenkinsJobName);
         int expectedBuildNbr = jobAtIntitalState.getNextBuildNumber();
         log.info("Next build number: " + expectedBuildNbr);
 
@@ -139,21 +184,21 @@ public void smokeTest_build_masterBranch() throws Exception {
 
         //Wait for the job to complete
         long timeOut = 60000L;
-        waitForBuildToComplete(jenkins, expectedBuildNbr, timeOut);
+        waitForBuildToComplete(jenkins, expectedBuildNbr, timeOut, jenkinsJobName);
 
         //Get the data we stored in the marker file and check it
-        Properties markerAsProperty = loadMarkerArtifactAsProperty(jenkins);
+        Properties markerAsProperty = loadMarkerArtifactAsProperty(jenkins, jenkinsJobName);
         String buildedCommit = markerAsProperty.getProperty("GIT_COMMIT");
-        assertEquals("Not the expected GIT commit", commit.getName(), buildedCommit);
 
+        assertEquals("Not the expected GIT commit", commit.getName(), buildedCommit);
 
         //add the trigger to Gogs
-        File jsonCommandFile = new File(JSON_COMMANDFILE_PATH + "webHookDefinition.json");
-        int hookId = gogsServer.createWebHook(jsonCommandFile, "testRep1");
+        File jsonCommandFile = new File(JSON_COMMANDFILE_PATH + webhookDefinition);
+        int hookId = gogsServer.createWebHook(jsonCommandFile, projectName);
         log.info("Created hook with ID " + hookId);
 
         //Get what is the next build number of the test jenkins job
-        jobAtIntitalState = jenkins.getJob(JENKINS_JOB_NAME);
+        jobAtIntitalState = jenkins.getJob(jenkinsJobName);
         expectedBuildNbr = jobAtIntitalState.getNextBuildNumber();
 
         //change the source file
@@ -164,34 +209,37 @@ public void smokeTest_build_masterBranch() throws Exception {
         RevCommit commitForHook = git.commit().setMessage("Small test modification").call();
         log.info("Commit" + commitForHook.getName());
         git.push()
-                .setRemote("origin")
-                .setCredentialsProvider(user2)
-                .setRefSpecs(spec)
-                .call();
+           .setRemote("origin")
+           .setCredentialsProvider(user2)
+           .setRefSpecs(spec)
+           .setPushAll()
+           .call();
 
-        //wait for the build
-        waitForBuildToComplete(jenkins, expectedBuildNbr, timeOut);
-
-        //Get the data we stored in the marker file and check it
-        Properties hookMarkerAsProperty = loadMarkerArtifactAsProperty(jenkins);
-        String hookBuildedCommit = hookMarkerAsProperty.getProperty("GIT_COMMIT");
-        assertEquals("Not the expected GIT commit", commitForHook.getName(), hookBuildedCommit);
-
-        //Cleanup - remove the hook we created
-        gogsServer.removeHook("demoApp", hookId);
+        try {
+            //wait for the build
+            waitForBuildToComplete(jenkins, expectedBuildNbr, timeOut, jenkinsJobName);
+
+            //Get the data we stored in the marker file and check it
+            Properties hookMarkerAsProperty = loadMarkerArtifactAsProperty(jenkins, jenkinsJobName);
+            String hookBuildedCommit = hookMarkerAsProperty.getProperty("GIT_COMMIT");
+            assertEquals("Not the expected GIT commit", commitForHook.getName(), hookBuildedCommit);
+        } finally {
+            // Cleanup the mess we made
+            gogsServer.removeHook(projectName, hookId);
+            gogsServer.removeRepo(projectName);
+        }
     }
 
-
     /**
      * Loads the marker file of the last build (archived during the build)
      *
      * @param jenkins the jenkins instance we want to load from
      * @return the marker file loaded as a property file (so that it can be easily queried)
      * @throws IOException        Something unexpected went wrong when querying the Jenkins server
-     * @throws URISyntaxException Something uunexpected went wrong loading the marker as a property
+     * @throws URISyntaxException Something unexpected went wrong loading the marker as a property
      */
-    private Properties loadMarkerArtifactAsProperty(JenkinsServer jenkins) throws IOException, URISyntaxException {
-        JobWithDetails detailedJob = jenkins.getJob(JENKINS_JOB_NAME);
+    private Properties loadMarkerArtifactAsProperty(JenkinsServer jenkins, String jobName) throws IOException, URISyntaxException {
+        JobWithDetails detailedJob = jenkins.getJob(jobName);
         BuildWithDetails lastBuild = detailedJob.getLastBuild().details();
         int buildNbr = lastBuild.getNumber();
         boolean isBuilding = lastBuild.isBuilding();
@@ -223,13 +271,13 @@ private Properties loadMarkerArtifactAsProperty(JenkinsServer jenkins) throws IO
      * @param fileName the source file to modify
      * @throws IOException something went wrong when updating the file
      */
-    private void changeTheSourceFile(String fileName) throws IOException {
+    private void changeTheSourceFile(@SuppressWarnings("SameParameterValue") String fileName) throws IOException {
         Writer output;
-        boolean openInAppendMode = true;
-        output = new BufferedWriter(new FileWriter(fileName, openInAppendMode));
+        output = new BufferedWriter(new FileWriter(fileName, true));
         Date dNow = new Date();
         SimpleDateFormat ft = new SimpleDateFormat("E yyyy.MM.dd 'at' hh:mm:ss a zzz");
-        output.append("\nThe file was modified by the test application : " + ft.format(dNow) + " \n");
+        String outString = "\nThe file was modified by the test application : " + ft.format(dNow) + " \n";
+        output.append(outString);
         output.close();
     }
 
@@ -243,9 +291,9 @@ private void changeTheSourceFile(String fileName) throws IOException {
      * @throws TimeoutException     we exeeded the timeout period.
      * @throws IOException          an unexpected error occurred while communicating with Jenkins
      */
-    private void waitForBuildToComplete(JenkinsServer jenkins, int expectedBuildNbr, long timeOut) throws InterruptedException, TimeoutException, IOException {
+    private void waitForBuildToComplete(JenkinsServer jenkins, int expectedBuildNbr, long timeOut, String jobname) throws InterruptedException, TimeoutException, IOException {
         boolean buildCompleted = false;
-        Long timeoutCounter = 0L;
+        long timeoutCounter = 0L;
         while (!buildCompleted) {
             Thread.sleep(2000);
             timeoutCounter = timeoutCounter + 2000L;
@@ -254,7 +302,7 @@ private void waitForBuildToComplete(JenkinsServer jenkins, int expectedBuildNbr,
             }
             //When the build is in the queue, the nextbuild number didn't change.
             //When it changed, It might still be running.
-            JobWithDetails wrkJobData = jenkins.getJob(JENKINS_JOB_NAME);
+            JobWithDetails wrkJobData = jenkins.getJob(jobname);
             int newNextNbr = wrkJobData.getNextBuildNumber();
             log.info("New Next Nbr:" + newNextNbr);
             if (expectedBuildNbr != newNextNbr) {
diff --git a/src/test/resources/Gogs-config-json/webHookDefinition.json b/src/test/resources/Gogs-config-json/webHookDefinition.json
@@ -2,7 +2,7 @@
   "type":"gogs",
   "config":
     {
-      "url":"http://jenkins:8080/job/test%20project/build?delay=0",
+      "url":"http://jenkins:8080/gogs-webhook/?job=test%20project",
       "content_type":"json"
     },
   "events":["create","push","pull_request"],
diff --git a/src/test/resources/Gogs-config-json/webHookDefinition_branch.json b/src/test/resources/Gogs-config-json/webHookDefinition_branch.json
@@ -2,7 +2,7 @@
   "type":"gogs",
   "config":
     {
-      "url":"http://localhost:8080/job/demoapp/build?delay=0",
+      "url":"http://jenkins:8080/gogs-webhook/?job=test%20project2&branch=test",
       "content_type":"json"
     },
   "events":["create","push","pull_request"],
diff --git a/src/test/resources/Jenkins-config/test-project-branch.xml b/src/test/resources/Jenkins-config/test-project-branch.xml

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`"type":"gogs",`
`3`	`3`	`"config":`
`4`	`4`	`{`
`5`		`- "url":"http://jenkins:8080/job/test%20project/build?delay=0",`
	`5`	`+ "url":"http://jenkins:8080/gogs-webhook/?job=test%20project",`
`6`	`6`	`"content_type":"json"`
`7`	`7`	`},`
`8`	`8`	`"events":["create","push","pull_request"],`