[JENKINS-38865] First work on separating ModelAST.

jenkinsci · Oct 12, 2016 · 1fd77c6 · 1fd77c6
1 parent f4fffa2
commit 1fd77c6
Show file tree

Hide file tree

Showing 249 changed files with 563 additions and 232 deletions.
diff --git a/pipeline-model-api/pom.xml b/pipeline-model-api/pom.xml
@@ -0,0 +1,251 @@
+<!--
+  ~ The MIT License
+  ~
+  ~ Copyright (c) 2016, 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.
+  -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>org.jenkins-ci.plugins</groupId>
+    <artifactId>plugin</artifactId>
+    <version>2.13</version>
+  </parent>
+
+  <groupId>org.jenkinsci.plugins</groupId>
+  <artifactId>pipeline-model-api</artifactId>
+  <version>0.5-SNAPSHOT</version>
+  <packaging>hpi</packaging>
+  <name>Pipeline: Model API</name>
+  <description>An opinionated, declarative Pipeline</description>
+  <url>https://wiki.jenkins-ci.org/display/JENKINS/Pipeline+Model+Definition+Plugin</url>
+
+  <licenses>
+    <license>
+        <name>MIT</name>
+        <url>http://opensource.org/licenses/MIT</url>
+        <distribution>repo</distribution>
+    </license>
+  </licenses>
+
+  <developers>
+    <developer>
+      <id>abayer</id>
+      <name>Andrew Bayer</name>
+    </developer>
+  </developers>
+
+  <scm>
+    <connection>scm:git:git://git@github.com/jenkinsci/pipeline-config-plugin.git</connection>
+    <developerConnection>scm:git:git@github.com:jenkinsci/pipeline-config-plugin.git</developerConnection>
+    <url>https://github.com/jenkinsci/pipeline-config-plugin</url>
+    <tag>HEAD</tag>
+  </scm>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.codehaus.gmaven</groupId>
+        <artifactId>gmaven-plugin</artifactId>
+        <version>1.4</version>
+        <configuration>
+          <providerSelection>1.8</providerSelection>
+        </configuration>
+        <executions>
+          <execution>
+            <goals>
+              <goal>generateStubs</goal>
+              <goal>compile</goal>
+              <goal>generateTestStubs</goal>
+              <goal>testCompile</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <configuration>
+          <systemProperties>
+            <property>
+              <name>hudson.udp</name>
+              <value>33849</value>
+            </property>
+          </systemProperties>
+          <argLine>-Xmx4g -XX:MaxPermSize=256m</argLine>
+          <reuseForks>true</reuseForks>
+          <forkCount>0.5C</forkCount>
+          <!-- TODO: I hate the retrying tests but given the nondeterministic whackiness of JENKINS-37101... -->
+          <rerunFailingTestsCount>3</rerunFailingTestsCount>
+        </configuration>
+      </plugin>
+
+    </plugins>
+  </build>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-cps</artifactId>
+      <version>2.18</version>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-job</artifactId>
+      <version>2.6</version>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-multibranch</artifactId>
+      <version>2.8</version>
+    </dependency>
+    <dependency>
+        <groupId>org.jenkins-ci.plugins</groupId>
+        <artifactId>script-security</artifactId>
+        <version>1.22</version>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-scm-step</artifactId>
+      <version>2.2</version>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-basic-steps</artifactId>
+      <version>2.1</version>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-durable-task-step</artifactId>
+      <version>2.4</version>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins</groupId>
+      <artifactId>pipeline-stage-step</artifactId>
+      <version>2.2</version>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins</groupId>
+      <artifactId>docker-workflow</artifactId>
+      <version>1.8</version>
+    </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins</groupId>
+      <artifactId>structs</artifactId>
+      <version>1.5</version>
+    </dependency>
+
+    <!-- JSON schema stuff -->
+    <dependency>
+      <groupId>com.github.fge</groupId>
+      <artifactId>json-schema-validator</artifactId>
+      <version>2.0.4</version>
+    </dependency>
+    <dependency>
+      <groupId>com.fasterxml.jackson.datatype</groupId>
+      <artifactId>jackson-datatype-json-org</artifactId>
+      <version>2.2.3</version>
+    </dependency>
+
+    <!-- TEST deps --> 
+    <dependency>
+      <groupId>org.jenkins-ci.plugins</groupId>
+      <artifactId>git</artifactId>
+      <version>2.6.0</version>
+      <scope>test</scope>
+      <exclusions>
+        <exclusion>
+          <groupId>org.apache.httpcomponents</groupId>
+          <artifactId>httpclient</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>
+
+    <dependency>
+      <groupId>org.jenkins-ci.main</groupId>
+      <artifactId>jenkins-test-harness-tools</artifactId>
+      <version>2.0</version>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-cps-global-lib</artifactId>
+      <version>2.3</version>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.jenkins-ci.plugins</groupId>
+      <artifactId>git</artifactId>
+      <version>2.6.0</version>
+      <classifier>tests</classifier>
+      <scope>test</scope>
+      <exclusions>
+        <exclusion>
+          <groupId>org.apache.httpcomponents</groupId>
+          <artifactId>httpclient</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>
+
+    <dependency>
+      <groupId>org.jenkins-ci.plugins.workflow</groupId>
+      <artifactId>workflow-scm-step</artifactId>
+      <version>2.2</version>
+      <classifier>tests</classifier>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+        <groupId>org.jenkins-ci.plugins.workflow</groupId>
+        <artifactId>workflow-support</artifactId>
+        <version>2.2</version>
+        <classifier>tests</classifier>
+        <scope>test</scope>
+    </dependency>
+
+  </dependencies>
+
+  <properties>
+    <jenkins.version>2.7.1</jenkins.version>
+    <java.level>7</java.level>
+    <groovy.version>2.4.7</groovy.version>
+  </properties>
+
+  <repositories>
+    <repository>
+      <id>repo.jenkins-ci.org</id>
+      <url>http://repo.jenkins-ci.org/public/</url>
+      <releases>
+        <enabled>true</enabled>
+      </releases>
+      <snapshots>
+        <enabled>true</enabled>
+      </snapshots>
+    </repository>
+  </repositories>
+  <pluginRepositories>
+    <pluginRepository>
+      <id>repo.jenkins-ci.org</id>
+      <url>http://repo.jenkins-ci.org/public/</url>
+    </pluginRepository>
+  </pluginRepositories>
+
+</project>
diff --git a/.../modeldefinition/ast/ModelASTAgent.groovy → .../modeldefinition/ast/ModelASTAgent.groovy b/.../modeldefinition/ast/ModelASTAgent.groovy → .../modeldefinition/ast/ModelASTAgent.groovy
@@ -25,12 +25,11 @@ package org.jenkinsci.plugins.pipeline.modeldefinition.ast
 
 import groovy.transform.EqualsAndHashCode
 import groovy.transform.ToString
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.Agent
 import org.jenkinsci.plugins.pipeline.modeldefinition.validator.ModelValidator
 
 /**
  * Represents what context in which to run the build - i.e., which label to run on, what Docker agent to run in, etc.
- * Corresponds to {@link Agent}.
+ * Corresponds to Agent.
  *
  * @author Andrew Bayer
  */

diff --git a/...efinition/ast/ModelASTArgumentList.groovy → ...efinition/ast/ModelASTArgumentList.groovy b/...efinition/ast/ModelASTArgumentList.groovy → ...efinition/ast/ModelASTArgumentList.groovy
diff --git a/...modeldefinition/ast/ModelASTBranch.groovy → ...modeldefinition/ast/ModelASTBranch.groovy b/...modeldefinition/ast/ModelASTBranch.groovy → ...modeldefinition/ast/ModelASTBranch.groovy
diff --git a/...inition/ast/ModelASTBuildCondition.groovy → ...inition/ast/ModelASTBuildCondition.groovy b/...inition/ast/ModelASTBuildCondition.groovy → ...inition/ast/ModelASTBuildCondition.groovy
@@ -27,14 +27,11 @@ import edu.umd.cs.findbugs.annotations.SuppressFBWarnings
 import groovy.transform.EqualsAndHashCode
 import groovy.transform.ToString
 import net.sf.json.JSONObject
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.BuildCondition
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.Notifications
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.PostBuild
 import org.jenkinsci.plugins.pipeline.modeldefinition.validator.ModelValidator
 
 /**
- * Represents a single {@link BuildCondition} to be checked and possibly executed in either the {@link PostBuild} or
- * {@link Notifications} sections.
+ * Represents a single BuildCondition to be checked and possibly executed in either the PostBuild or
+ * Notifications sections.
  *
  * @author Andrew Bayer
  */

diff --git a/...inition/ast/ModelASTBuildParameter.groovy → ...inition/ast/ModelASTBuildParameter.groovy b/...inition/ast/ModelASTBuildParameter.groovy → ...inition/ast/ModelASTBuildParameter.groovy
diff --git a/...nition/ast/ModelASTBuildParameters.groovy → ...nition/ast/ModelASTBuildParameters.groovy b/...nition/ast/ModelASTBuildParameters.groovy → ...nition/ast/ModelASTBuildParameters.groovy
diff --git a/...odeldefinition/ast/ModelASTElement.groovy → ...odeldefinition/ast/ModelASTElement.groovy b/...odeldefinition/ast/ModelASTElement.groovy → ...odeldefinition/ast/ModelASTElement.groovy
diff --git a/...definition/ast/ModelASTEnvironment.groovy → ...definition/ast/ModelASTEnvironment.groovy b/...definition/ast/ModelASTEnvironment.groovy → ...definition/ast/ModelASTEnvironment.groovy
@@ -28,7 +28,6 @@ import groovy.transform.EqualsAndHashCode
 import groovy.transform.ToString
 import net.sf.json.JSONArray
 import net.sf.json.JSONObject
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.Environment
 import org.jenkinsci.plugins.pipeline.modeldefinition.validator.ModelValidator
 
 /**

diff --git a/...finition/ast/ModelASTJobProperties.groovy → ...finition/ast/ModelASTJobProperties.groovy b/...finition/ast/ModelASTJobProperties.groovy → ...finition/ast/ModelASTJobProperties.groovy
diff --git a/...definition/ast/ModelASTJobProperty.groovy → ...definition/ast/ModelASTJobProperty.groovy b/...definition/ast/ModelASTJobProperty.groovy → ...definition/ast/ModelASTJobProperty.groovy
diff --git a/...ne/modeldefinition/ast/ModelASTKey.groovy → ...ne/modeldefinition/ast/ModelASTKey.groovy b/...ne/modeldefinition/ast/ModelASTKey.groovy → ...ne/modeldefinition/ast/ModelASTKey.groovy
diff --git a/...t/ModelASTKeyValueOrMethodCallPair.groovy → ...t/ModelASTKeyValueOrMethodCallPair.groovy b/...t/ModelASTKeyValueOrMethodCallPair.groovy → ...t/ModelASTKeyValueOrMethodCallPair.groovy
diff --git a/...eldefinition/ast/ModelASTMethodArg.groovy → ...eldefinition/ast/ModelASTMethodArg.groovy b/...eldefinition/ast/ModelASTMethodArg.groovy → ...eldefinition/ast/ModelASTMethodArg.groovy
diff --git a/...ldefinition/ast/ModelASTMethodCall.groovy → ...ldefinition/ast/ModelASTMethodCall.groovy b/...ldefinition/ast/ModelASTMethodCall.groovy → ...ldefinition/ast/ModelASTMethodCall.groovy
diff --git a/...tion/ast/ModelASTNamedArgumentList.groovy → ...tion/ast/ModelASTNamedArgumentList.groovy b/...tion/ast/ModelASTNamedArgumentList.groovy → ...tion/ast/ModelASTNamedArgumentList.groovy
diff --git a/...finition/ast/ModelASTNotifications.groovy → ...finition/ast/ModelASTNotifications.groovy b/...finition/ast/ModelASTNotifications.groovy → ...finition/ast/ModelASTNotifications.groovy
@@ -28,9 +28,6 @@ import groovy.transform.EqualsAndHashCode
 import groovy.transform.ToString
 import net.sf.json.JSONArray
 import net.sf.json.JSONObject
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.BuildCondition
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.Notifications
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.StepsBlock
 import org.jenkinsci.plugins.pipeline.modeldefinition.validator.ModelValidator
 
 /**

diff --git a/...definition/ast/ModelASTPipelineDef.groovy → ...definition/ast/ModelASTPipelineDef.groovy b/...definition/ast/ModelASTPipelineDef.groovy → ...definition/ast/ModelASTPipelineDef.groovy
@@ -4,7 +4,6 @@ import edu.umd.cs.findbugs.annotations.SuppressFBWarnings
 import groovy.transform.EqualsAndHashCode
 import groovy.transform.ToString
 import net.sf.json.JSONObject
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.Root
 import org.jenkinsci.plugins.pipeline.modeldefinition.validator.ModelValidator
 
 /**

diff --git a/...ast/ModelASTPositionalArgumentList.groovy → ...ast/ModelASTPositionalArgumentList.groovy b/...ast/ModelASTPositionalArgumentList.groovy → ...ast/ModelASTPositionalArgumentList.groovy
diff --git a/...eldefinition/ast/ModelASTPostBuild.groovy → ...eldefinition/ast/ModelASTPostBuild.groovy b/...eldefinition/ast/ModelASTPostBuild.groovy → ...eldefinition/ast/ModelASTPostBuild.groovy
@@ -28,10 +28,6 @@ import groovy.transform.EqualsAndHashCode
 import groovy.transform.ToString
 import net.sf.json.JSONArray
 import net.sf.json.JSONObject
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.BuildCondition
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.Notifications
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.PostBuild
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.StepsBlock
 import org.jenkinsci.plugins.pipeline.modeldefinition.validator.ModelValidator
 
 /**

diff --git a/...definition/ast/ModelASTScriptBlock.groovy → ...definition/ast/ModelASTScriptBlock.groovy b/...definition/ast/ModelASTScriptBlock.groovy → ...definition/ast/ModelASTScriptBlock.groovy
@@ -24,7 +24,6 @@
 package org.jenkinsci.plugins.pipeline.modeldefinition.ast
 
 import groovy.transform.ToString
-import org.jenkinsci.plugins.pipeline.modeldefinition.steps.ScriptStep
 
 /**
  * Represents the special step for {@link ScriptStep}, which are executed without validation against the declarative subset.

diff --git a/...inition/ast/ModelASTSingleArgument.groovy → ...inition/ast/ModelASTSingleArgument.groovy b/...inition/ast/ModelASTSingleArgument.groovy → ...inition/ast/ModelASTSingleArgument.groovy
diff --git a/.../modeldefinition/ast/ModelASTStage.groovy → .../modeldefinition/ast/ModelASTStage.groovy b/.../modeldefinition/ast/ModelASTStage.groovy → .../modeldefinition/ast/ModelASTStage.groovy
@@ -5,11 +5,10 @@ import groovy.transform.EqualsAndHashCode
 import groovy.transform.ToString
 import net.sf.json.JSONArray
 import net.sf.json.JSONObject
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.Stage
 import org.jenkinsci.plugins.pipeline.modeldefinition.validator.ModelValidator
 
 /**
- * Represents an individual {@link Stage} and the {@link ModelASTBranch}s it may contain.
+ * Represents an individual Stage and the {@link ModelASTBranch}s it may contain.
  *
  * @author Kohsuke Kawaguchi
  * @author Andrew Bayer

diff --git a/...modeldefinition/ast/ModelASTStages.groovy → ...modeldefinition/ast/ModelASTStages.groovy b/...modeldefinition/ast/ModelASTStages.groovy → ...modeldefinition/ast/ModelASTStages.groovy
@@ -27,8 +27,6 @@ import edu.umd.cs.findbugs.annotations.SuppressFBWarnings
 import groovy.transform.EqualsAndHashCode
 import groovy.transform.ToString
 import net.sf.json.JSONArray
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.Stage
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.Stages
 import org.jenkinsci.plugins.pipeline.modeldefinition.validator.ModelValidator
 
 

diff --git a/...e/modeldefinition/ast/ModelASTStep.groovy → ...e/modeldefinition/ast/ModelASTStep.groovy b/...e/modeldefinition/ast/ModelASTStep.groovy → ...e/modeldefinition/ast/ModelASTStep.groovy
@@ -3,7 +3,6 @@ package org.jenkinsci.plugins.pipeline.modeldefinition.ast
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings
 import groovy.transform.ToString
 import net.sf.json.JSONObject
-import org.jenkinsci.plugins.pipeline.modeldefinition.Utils
 import org.jenkinsci.plugins.pipeline.modeldefinition.validator.ModelValidator
 
 /**
@@ -15,11 +14,19 @@ import org.jenkinsci.plugins.pipeline.modeldefinition.validator.ModelValidator
 @ToString(includeSuper = true, includeSuperProperties = true)
 @SuppressFBWarnings(value="SE_NO_SERIALVERSIONID")
 public class ModelASTStep extends ModelASTElement {
+    public static Map<String,String> blockedStepsBase() {
+        return [
+            "stage":      'The stage step cannot be used in Declarative Pipelines',
+            "properties": 'The properties step cannot be used in Declarative Pipelines',
+            "parallel":   "The parallel step can only be used as the only top-level step in a stage's step block"
+        ]
+    }
+
     /**
      * A list of step names which are banned from being executed within a step block.
      */
     public static Map<String, String> getBlockedSteps() {
-        return Utils.blockedStepsBase()
+        return blockedStepsBase()
     }
 
     String name;

diff --git a/.../modeldefinition/ast/ModelASTTools.groovy → .../modeldefinition/ast/ModelASTTools.groovy b/.../modeldefinition/ast/ModelASTTools.groovy → .../modeldefinition/ast/ModelASTTools.groovy
@@ -28,7 +28,6 @@ import groovy.transform.EqualsAndHashCode
 import groovy.transform.ToString
 import net.sf.json.JSONArray
 import net.sf.json.JSONObject
-import org.jenkinsci.plugins.pipeline.modeldefinition.model.Tools
 import org.jenkinsci.plugins.pipeline.modeldefinition.validator.ModelValidator
 
 /**

diff --git a/...deldefinition/ast/ModelASTTreeStep.groovy → ...deldefinition/ast/ModelASTTreeStep.groovy b/...deldefinition/ast/ModelASTTreeStep.groovy → ...deldefinition/ast/ModelASTTreeStep.groovy
diff --git a/...odeldefinition/ast/ModelASTTrigger.groovy → ...odeldefinition/ast/ModelASTTrigger.groovy b/...odeldefinition/ast/ModelASTTrigger.groovy → ...odeldefinition/ast/ModelASTTrigger.groovy
diff --git a/...deldefinition/ast/ModelASTTriggers.groovy → ...deldefinition/ast/ModelASTTriggers.groovy b/...deldefinition/ast/ModelASTTriggers.groovy → ...deldefinition/ast/ModelASTTriggers.groovy
diff --git a/.../modeldefinition/ast/ModelASTValue.groovy → .../modeldefinition/ast/ModelASTValue.groovy b/.../modeldefinition/ast/ModelASTValue.groovy → .../modeldefinition/ast/ModelASTValue.groovy