Add Config File Provider support (#45)

* Add Config File Provider support

Author: seanly

.github/workflows/codeql-analysis.yml

@@ -30,11 +30,11 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v3
 
-      - name: Set up JDK 8
+      - name: Set up JDK 11
         uses: actions/setup-java@v2
         with:
           distribution: 'adopt'
-          java-version: 8
+          java-version: 11
           cache: 'maven'
 
       # Initializes the CodeQL tools for scanning.

.github/workflows/jenkins-security-scan.yml

@@ -22,4 +22,4 @@ jobs:
     uses: jenkins-infra/jenkins-security-scan/.github/workflows/jenkins-security-scan.yaml@v2
     with:
       java-cache: maven
-      java-version: 8
+      java-version: 11

Jenkinsfile

@@ -1,5 +1,4 @@
 buildPlugin(timeout: 120, useContainerAgent: true, configurations: [
-  [ platform: 'linux', jdk: '8'],
-  [ platform: 'windows', jdk: '8'],
+  [ platform: 'windows', jdk: '11'],
   [ platform: 'linux', jdk: '11']
 ])

pom.xml

@@ -4,18 +4,17 @@
     <parent>
         <groupId>org.jenkins-ci.plugins</groupId>
         <artifactId>plugin</artifactId>
-        <version>4.40</version>
+        <version>4.75</version>
         <relativePath />
     </parent>
 
     <properties>
         <changelist>999999-SNAPSHOT</changelist>
 
-        <jenkins.version>2.303.3</jenkins.version>
-        <jenkins-tools-bom.artifactId>bom-2.303.x</jenkins-tools-bom.artifactId>
-        <jenkins-tools-bom.version>987.v4ade2e49fe70</jenkins-tools-bom.version>
+        <jenkins.version>2.414.3</jenkins.version>
+        <jenkins-tools-bom.artifactId>bom-2.414.x</jenkins-tools-bom.artifactId>
+        <jenkins-tools-bom.version>2571.vede9dc5a_2e23</jenkins-tools-bom.version>
 
-        <java.level>8</java.level>
         <gitHubRepo>jenkinsci/${project.artifactId}-plugin</gitHubRepo>
 
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -102,6 +101,10 @@
             <artifactId>workflow-job</artifactId>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>org.jenkins-ci.plugins</groupId>
+            <artifactId>config-file-provider</artifactId>
+        </dependency>
     </dependencies>
 
     <repositories>

src/main/java/cn/opsbox/jenkinsci/plugins/cps/ConfigFileProviderOesTemplateFlowDefinitionConfiguration.java

@@ -0,0 +1,23 @@
+package cn.opsbox.jenkinsci.plugins.cps;
+
+import hudson.Extension;
+import lombok.Getter;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+public class ConfigFileProviderOesTemplateFlowDefinitionConfiguration extends OesTemplateFlowDefinitionConfiguration {
+ 
+    @Getter
+    private final String scriptId;
+
+    @DataBoundConstructor
+    public ConfigFileProviderOesTemplateFlowDefinitionConfiguration(String scriptId) {
+        this.scriptId = scriptId;
+    }
+
+    @Extension
+    public static class DescriptorImpl extends OesTemplateFlowDefinitionConfiguration.DescriptorImpl {
+        public String getDisplayName() {
+            return "From Config File Provider";
+        }
+    }
+}

src/main/java/cn/opsbox/jenkinsci/plugins/cps/CpsTemplateFlowDefinition.java

@@ -12,6 +12,10 @@
 import org.jenkinsci.plugins.workflow.flow.*;
 import org.jenkinsci.plugins.workflow.job.WorkflowRun;
 
+import org.jenkinsci.lib.configprovider.model.Config;
+import org.jenkinsci.plugins.configfiles.ConfigFileStore;
+import org.jenkinsci.plugins.configfiles.GlobalConfigFiles;
+
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.util.List;
@@ -53,10 +57,28 @@ public CpsFlowExecution create(
     String initializePipeline(FlowExecutionOwner owner) {
 
         String script = "";
+        TaskListener listener = owner.getListener();
 
         if (configProvider instanceof ConsoleOesTemplateFlowDefinitionConfiguration) {
             ConsoleOesTemplateFlowDefinitionConfiguration console = (ConsoleOesTemplateFlowDefinitionConfiguration) configProvider;
             script = console.getScript();
+        } else if (configProvider instanceof ConfigFileProviderOesTemplateFlowDefinitionConfiguration) {
+            ConfigFileProviderOesTemplateFlowDefinitionConfiguration configFile = (ConfigFileProviderOesTemplateFlowDefinitionConfiguration) configProvider;
+            String scriptId = configFile.getScriptId();
+            ConfigFileStore store = GlobalConfigFiles.get();
+            if (store != null) {
+                Config config = store.getById(scriptId);
+                if (config != null) {
+                    script = config.content;
+                    listener.getLogger().println("Obtained " + scriptId + " from Config File Provider");
+                    return script;
+                } else {
+                    throw new AbortException("Config File not found. Check configuration.");
+                }
+            } else {
+                throw new AbortException("Get ConfigFileStore Error. Check configuration.");
+            }
+
         } else {
             ScmOesTemplateFlowDefinitionConfiguration scm = (ScmOesTemplateFlowDefinitionConfiguration) configProvider;
 
@@ -68,14 +90,13 @@ String initializePipeline(FlowExecutionOwner owner) {
 
             SCM scm1 = scm.getScm();
             String scriptPath = scm.getScriptPath();
-            TaskListener listener = owner.getListener();
 
             try(SCMFileSystem fs = SCMFileSystem.of(build.getParent(), scm1)) {
                 if (fs != null) {
                     try {
                         script = fs.child(scriptPath).contentAsString();
                         listener.getLogger().println("Obtained " + scriptPath + " from " + scm1.getKey());
-
+                        return script;
                     } catch (FileNotFoundException e) {
                         throw new AbortException("Unable to find " + scriptPath + " from " + scm1.getKey());
                     }
@@ -87,5 +108,4 @@ String initializePipeline(FlowExecutionOwner owner) {
 
         return script;
     }
-
 }

src/main/resources/cn/opsbox/jenkinsci/plugins/cps/ConfigFileProviderOesTemplateFlowDefinitionConfiguration/config.jelly

@@ -0,0 +1,9 @@
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form" xmlns:st="jelly:stapler" xmlns:wfe="/org/jenkinsci/plugins/workflow/editor">
+    <f:entry title="${%Script ID}" field="scriptId">
+        <f:textbox value="${instance.scriptId}" default="Jenkinsfile" />
+    </f:entry>
+    <f:block>
+        <a href="pipeline-syntax" target="_blank">${%Pipeline Syntax}</a>
+    </f:block>
+</j:jelly>