Update to file-leak-detector:1.11 to detect pipe and selector leaks

.gitignore

@@ -1,2 +1,4 @@
 target
 work
+.idea
+file-leak-detector.iml

Jenkinsfile

@@ -0,0 +1,2 @@
+// Build the plugin using https://github.com/jenkins-infra/pipeline-library
+buildPlugin()

pom.xml

@@ -3,22 +3,27 @@
   <parent>
     <groupId>org.jenkins-ci.plugins</groupId>
     <artifactId>plugin</artifactId>
-    <version>1.466</version><!-- which version of Jenkins is this plugin built against? -->
+    <version>3.7</version>
   </parent>
 
   <groupId>com.cloudbees.jenkins.plugins</groupId>
   <artifactId>file-leak-detector</artifactId>
   <name>CloudBees File Leak Detector Plugin</name>
   <description>Monitors and detects file handle leaks in Jenkins</description>
-  <version>1.5-SNAPSHOT</version>
+  <version>1.6-SNAPSHOT</version>
   <packaging>hpi</packaging>
-  <url>https://wiki.jenkins-ci.org/display/JENKINS/File+Leak+Detector+Plugin</url>
+  <url>https://wiki.jenkins.io/display/JENKINS/File+Leak+Detector+Plugin</url>
+
+  <properties>
+        <jenkins.version>2.7.3</jenkins.version>
+        <java.level>8</java.level>
+  </properties>
 
   <dependencies>
     <dependency>
       <groupId>org.kohsuke</groupId>
       <artifactId>file-leak-detector</artifactId>
-      <version>1.6</version>
+      <version>1.11</version>
       <classifier>jar-with-dependencies</classifier>
       <exclusions>
         <exclusion>
@@ -27,7 +32,7 @@
         </exclusion>
         <exclusion>
           <groupId>org.kohsuke</groupId>
-          <artifactId>asm3</artifactId>
+          <artifactId>asm6</artifactId>
         </exclusion>
       </exclusions>
     </dependency>

src/main/resources/com/cloudbees/jenkins/plugins/file_leak_detector/FileHandleDump/_notRunning.jelly

@@ -1,3 +1,4 @@
+<?jelly escape-by-default='true'?>
 <j:jelly xmlns:j="jelly:core" xmlns:l="/lib/layout">
   <l:layout title="${%File handle dump}">
     <l:main-panel>
@@ -64,4 +65,4 @@
       </form>
     </l:main-panel>
   </l:layout>
-</j:jelly>
+</j:jelly>

src/main/resources/index.jelly

@@ -1,3 +1,4 @@
+<?jelly escape-by-default='true'?>
 <!--
   This view is used to render the installed plugins page.
 -->

src/test/java/com/cloudbees/jenkins/plugins/file_leak_detector/FileHandleDumpTest.java

@@ -0,0 +1,146 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2018 CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package com.cloudbees.jenkins.plugins.file_leak_detector;
+
+import com.gargoylesoftware.htmlunit.Page;
+import hudson.model.ManagementLink;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.InputStream;
+import java.nio.channels.Pipe;
+import java.nio.channels.Selector;
+import java.util.Arrays;
+import java.util.List;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.TemporaryFolder;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.JenkinsRule.WebClient;
+
+import static org.hamcrest.CoreMatchers.allOf;
+import static org.hamcrest.CoreMatchers.anyOf;
+import static org.hamcrest.CoreMatchers.containsString;
+import static org.hamcrest.CoreMatchers.hasItem;
+import static org.hamcrest.CoreMatchers.not;
+import static org.junit.Assert.assertThat;
+
+public class FileHandleDumpTest {
+
+    @Rule
+    public JenkinsRule r = new JenkinsRule();
+
+    @Rule
+    public TemporaryFolder f = new TemporaryFolder();
+
+    @Test
+    public void detectFileLeak() throws Exception {
+        activateFileLeakDetector();
+        File leakyFile = f.newFile("leaky-file");
+        try (InputStream unused = new FileInputStream(leakyFile)) {
+            assertThat("There should be a file opened by this method", getOpenDescriptors(), hasItem(allOf(
+                    containsString(leakyFile.getPath() + " by thread:"),
+                    containsString("FileHandleDumpTest.detectFileLeak(")
+            )));
+        }
+        assertThat("There should not be a file opened by this method", getOpenDescriptors(), not(hasItem(allOf(
+                containsString(leakyFile.getPath() + " by thread:"),
+                containsString("FileHandleDumpTest.detectFileLeak(")
+        ))));
+    }
+
+    @Test
+    public void detectPipeLeak() throws Exception {
+        activateFileLeakDetector();
+        Pipe p = null;
+        try {
+            p = Pipe.open();
+            assertThat("There should be a pipe sink and source channel opened by this method", getOpenDescriptors(), allOf(
+                hasItem(allOf(
+                        containsString("Pipe Sink Channel by thread:"),
+                        containsString("FileHandleDumpTest.detectPipeLeak(")
+                )), hasItem(allOf(
+                        containsString("Pipe Source Channel by thread:"),
+                        containsString("FileHandleDumpTest.detectPipeLeak(")
+                ))));
+        } finally {
+            if (p != null) {
+                p.sink().close();
+                p.source().close();
+            }
+        }
+        assertThat("There should not be a pipe sink or source channel opened by this method", getOpenDescriptors(), not(anyOf(
+                hasItem(allOf(
+                        containsString("Pipe Sink Channel by thread:"),
+                        containsString("FileHandleDumpTest.detectPipeLeak(")
+                )), hasItem(allOf(
+                        containsString("Pipe Source Channel by thread:"),
+                        containsString("FileHandleDumpTest.detectPipeLeak(")
+                )))));
+    }
+
+    @Test
+    public void detectSelectorLeak() throws Exception {
+        activateFileLeakDetector();
+        try (Selector unused = Selector.open()) {
+            assertThat("There should be a selector opened by this method", getOpenDescriptors(), hasItem(allOf(
+                    containsString("selector by thread:"),
+                    containsString("FileHandleDumpTest.detectSelectorLeak(")
+            )));
+        }
+        assertThat("There should not be a selector opened by this method", getOpenDescriptors(), not(hasItem(allOf(
+                containsString("selector by thread:"),
+                containsString("FileHandleDumpTest.detectSelectorLeak(")
+        ))));
+    }
+
+    /**
+     * Activates the file-leak-detector library. Only activates once for the
+     * whole test suite, but is called in every test so they can run in any
+     * order, and cannot not be called until Jenkins starts.
+     */
+    private void activateFileLeakDetector() throws Exception {
+        FileHandleDump fileHandleDump = ManagementLink.all().get(FileHandleDump.class);
+        fileHandleDump.doActivate("");
+    }
+
+    /**
+     * @return a list of open file detectors as detected by the file-leak-detector
+     * library. Items in the list have the following format:
+     * <pre>{@code
+     * <descriptor type> by thread:<thread name> on <date descriptor was opened>
+     *     <stack trace of call that opened the descriptor>
+     * }</pre>
+     */
+    private List<String> getOpenDescriptors() throws Exception {
+        FileHandleDump fileHandleDump = ManagementLink.all().get(FileHandleDump.class);
+        WebClient wc = r.createWebClient();
+        Page p = wc.goTo(fileHandleDump.getUrlName(), "text/plain");
+        String descriptorDump = p.getWebResponse().getContentAsString();
+        String[] descriptors = descriptorDump.split("#\\d+ ");
+         // First element is similar to "6 descriptors are open", so we exclude it.
+        return Arrays.asList(descriptors).subList(1, descriptors.length);
+    }
+
+}