[APM-CI] APM UI pipeline version 0

resources/JenkinsfileTemplate.groovy

@@ -16,6 +16,7 @@ pipeline {
   parameters {
     string(name: 'PARAM_WITH_DEFAULT_VALUE', defaultValue: "defaultValue", description: "it would not be defined on the first build, see JENKINS-41929.")
     booleanParam(name: 'Run_As_Master_Branch', defaultValue: false, description: 'Allow to run any steps on a PR, some steps normally only run on master branch.')
+    booleanParam(name: 'doc_ci', defaultValue: true, description: 'Enable build docs.')
   }
   stages {
     stage('Initializing'){
@@ -87,7 +88,7 @@ pipeline {
                 tag "v\\d+\\.\\d+\\.\\d+*"
                 environment name: 'Run_As_Master_Branch', value: 'true'
               }
-              environment name: 'doc_ci', value: 'true'
+              expression { return params.doc_ci }
             }
           }
           steps {

src/test/groovy/DummyStepTests.groovy

@@ -19,6 +19,25 @@ class DummyStepTests extends BasePipelineTest {
     helper.registerAllowedMethod("sh", [String.class], { "OK" })
     helper.registerAllowedMethod("withEnvWrapper", [Closure.class], { closure -> closure.call() })
     helper.registerAllowedMethod("script", [Closure.class], { closure -> closure.call() })
+    helper.registerAllowedMethod("pipeline", [Closure.class], { body -> body() })
+    helper.registerAllowedMethod("agent", [String.class], { "OK" })
+    helper.registerAllowedMethod("agent", [Closure.class], { body -> body() })
+    helper.registerAllowedMethod("label", [String.class], { "OK" })
+    helper.registerAllowedMethod("stages", [Closure.class], { body -> body() })
+    helper.registerAllowedMethod("steps", [Closure.class], { body -> body() })
+    helper.registerAllowedMethod("post", [Closure.class], { body -> body() })
+    helper.registerAllowedMethod("success", [Closure.class], { body -> body() })
+    helper.registerAllowedMethod("aborted", [Closure.class], { body -> body() })
+    helper.registerAllowedMethod("failure", [Closure.class], { body -> body() })
+    helper.registerAllowedMethod("unstable", [Closure.class], { body -> body() })
+    helper.registerAllowedMethod("always", [Closure.class], { body -> body() })
+    helper.registerAllowedMethod("dir", [String.class, Closure.class], { path, body -> body() })
+    helper.registerAllowedMethod("when", [Closure.class], { "OK" })
+    helper.registerAllowedMethod("parallel", [Closure.class], { body -> body() })
+    helper.registerAllowedMethod("failFast", [Boolean.class], { "OK" })
+    helper.registerAllowedMethod("script", [Closure.class], { body -> body() })
+    helper.registerAllowedMethod("options", [Closure.class], { "OK" })
+    helper.registerAllowedMethod("environment", [Closure.class], { "OK" })
   }
 
   @Test

src/test/groovy/GitCheckoutStepTests.groovy

@@ -18,7 +18,7 @@ class GitCheckoutStepTests extends BasePipelineTest {
     helper.registerAllowedMethod("sh", [Map.class], { "OK" })
     helper.registerAllowedMethod("sh", [String.class], { "OK" })
     helper.registerAllowedMethod("checkout", [String.class], { "OK" })
-    helper.registerAllowedMethod("github_enterprise_constructor", [], { "OK" })
+    helper.registerAllowedMethod("githubEnv", [], { "OK" })
     helper.registerAllowedMethod("withEnvWrapper", [Closure.class], { closure -> closure.call() })
   }
 

src/test/groovy/LogStepTests.groovy

@@ -0,0 +1,116 @@
+import com.lesfurets.jenkins.unit.BasePipelineTest
+import org.junit.Before;
+import org.junit.Test;
+import static com.lesfurets.jenkins.unit.MethodCall.callArgsToString
+import static org.junit.Assert.assertTrue
+
+class LogStepTests extends BasePipelineTest {
+  Map env = [:]
+
+  @Override
+  @Before
+  void setUp() throws Exception {
+    super.setUp()
+
+    env.WORKSPACE = "WS"
+    binding.setVariable('env', env)
+    helper.registerAllowedMethod("echoColor", [Map.class], { m -> 
+      def echoColor = loadScript("vars/echoColor.groovy")
+      echoColor.call(m)
+    })
+  }
+
+  @Test
+  void test() throws Exception {
+    def script = loadScript("vars/log.groovy")
+    env.PIPELINE_LOG_LEVEL = 'DEBUG'
+    script.call(text: "message")
+    printCallStack()
+    assertTrue(helper.callStack.findAll { call ->
+        call.methodName == "echo"
+    }.any { call ->
+        callArgsToString(call).contains("message")
+        callArgsToString(call).contains("[DEBUG]")
+    })
+    assertJobStatusSuccess()
+  }
+
+  @Test
+  void testDebug() throws Exception {
+    def script = loadScript("vars/log.groovy")
+    env.PIPELINE_LOG_LEVEL = 'DEBUG'
+    script.call(level: 'DEBUG', text: "message")
+    printCallStack()
+    assertTrue(helper.callStack.findAll { call ->
+        call.methodName == "echo"
+    }.any { call ->
+        callArgsToString(call).contains("message")
+        callArgsToString(call).contains("[DEBUG]")
+    })
+    assertJobStatusSuccess()
+  }
+
+  @Test
+  void testInfo() throws Exception {
+    def script = loadScript("vars/log.groovy")
+    script.call(level: 'INFO', text: "message")
+    printCallStack()
+    assertTrue(helper.callStack.findAll { call ->
+        call.methodName == "echo"
+    }.any { call ->
+        callArgsToString(call).contains("message")
+        callArgsToString(call).contains("[INFO]")
+    })
+    assertJobStatusSuccess()
+  }
+
+  @Test
+  void testWarn() throws Exception {
+    def script = loadScript("vars/log.groovy")
+    env.PIPELINE_LOG_LEVEL = 'WARN'
+    script.call(level: 'WARN', text: "message")
+    printCallStack()
+    assertTrue(helper.callStack.findAll { call ->
+        call.methodName == "echo"
+    }.any { call ->
+        callArgsToString(call).contains("message")
+        callArgsToString(call).contains("[WARN]")
+    })
+    assertJobStatusSuccess()
+  }
+
+  @Test
+  void testError() throws Exception {
+    def script = loadScript("vars/log.groovy")
+    env.PIPELINE_LOG_LEVEL = 'ERROR'
+    script.call(level: 'ERROR', text: "message")
+    printCallStack()
+    assertTrue(helper.callStack.findAll { call ->
+        call.methodName == "echo"
+    }.any { call ->
+        callArgsToString(call).contains("message")
+        callArgsToString(call).contains("[ERROR]")
+    })
+    assertJobStatusSuccess()
+  }
+
+  @Test
+  void testLevel() throws Exception {
+    def script = loadScript("vars/log.groovy")
+    env.PIPELINE_LOG_LEVEL = 'WARN'
+    script.call(level: 'DEBUG', text: "messageDEBUG")
+    script.call(level: 'INFO', text: "messageINFO")
+    script.call(level: 'WARN', text: "messageWARN")
+    script.call(level: 'ERROR', text: "messageERROR")
+    printCallStack()
+    assertTrue(helper.callStack.findAll { call ->
+        call.methodName == "echo"
+    }.any { call ->
+        !callArgsToString(call).contains("[DEBUG]")
+        !callArgsToString(call).contains("[INFO]")
+        callArgsToString(call).contains("[WARN]")
+        callArgsToString(call).contains("[ERROR]")
+    })
+    assertJobStatusSuccess()
+  }
+}

src/test/groovy/WithEnvWrapperStepTests.groovy

@@ -3,6 +3,8 @@ import org.junit.Before;
 import org.junit.Test;
 import static com.lesfurets.jenkins.unit.MethodCall.callArgsToString
 import static org.junit.Assert.assertTrue
+import static org.junit.Assert.assertFalse
+
 
 class WithEnvWrapperStepTests extends BasePipelineTest {
 
@@ -46,6 +48,7 @@ class WithEnvWrapperStepTests extends BasePipelineTest {
     helper.registerAllowedMethod("wrap", [Map.class, Closure.class], wrapInterceptor)
     helper.registerAllowedMethod("deleteDir", [], { "OK" })
     helper.registerAllowedMethod("withEnv", [List.class, Closure.class], withEnvInterceptor)
+    helper.registerAllowedMethod("dir", [String.class, Closure.class], { path, body -> body() })
   }
 
   @Test
@@ -64,6 +67,35 @@ class WithEnvWrapperStepTests extends BasePipelineTest {
       })
     printCallStack()
     assertTrue(isOK)
+    assertTrue(helper.callStack.findAll { call ->
+        call.methodName == "deleteDir"
+    }?.size()==1)
+    assertJobStatusSuccess()
+  }
+
+  @Test
+  void testCleanAfter() throws Exception {
+    def script = loadScript("vars/withEnvWrapper.groovy")
+    def isOK = false
+    script.call(cleanBefore: false, {isOK = true})
+    printCallStack()
+    assertTrue(isOK)
+    assertTrue(helper.callStack.findAll { call ->
+        call.methodName == "deleteDir"
+    }?.size()==0)
+    assertJobStatusSuccess()
+  }
+
+  @Test
+  void testCleanAfterBefore() throws Exception {
+    def script = loadScript("vars/withEnvWrapper.groovy")
+    def isOK = false
+    script.call(cleanAfter: true, cleanBefore: true, baseDir: 'src', {isOK = true})
+    printCallStack()
+    assertTrue(isOK)
+    assertTrue(helper.callStack.findAll { call ->
+        call.methodName == "deleteDir"
+    }?.size()==2)
     assertJobStatusSuccess()
   }
 }

vars/README.md

@@ -113,6 +113,20 @@ githubEnv()
 * `REPO_NAME`: repository name in the git URL, it sets this environment variable processing the GIT_URL.
 * `GIT_SHA`: current commit SHA1, it sets this getting it from local repo.
 * `GIT_BUILD_CAUSE`: build cause can be a pull request(pr), a commit, or a merge
+## log
+Allow to print messages with different levels of verbosity. It will show all messages that match 
+to an upper log level than defined, the default level is debug. 
+You have to define the environment variable PIPELINE_LOG_LEVEL to select 
+the log level by default is INFO.
+
+ Levels: DEBUG, INFO, WARN, ERROR
+
+```
+ log(level: 'INFO', text: 'message')
+```
+
+* `level`: sets the verbosity of the messages (DEBUG, INFO, WARN, ERROR)
+* `text`: Message to print. The color of the messages depends on the level.
 ## runIntegrationTestAxis
 Run a set of integration test against a Axis of versions.(go, java, nodejs, python, ruby)
 It needs the integration test sources stashed.
@@ -123,14 +137,7 @@ runIntegrationTestAxis(source: 'source', agentType: 'go')
 * *agentType*: Agent type to test (all, go, java, python, nodejs, ruby, ...).
 * *source*: Stash name that contains the source code.
 * *baseDir*: Directory where the code is in the stash code(default 'src/github.com/elastic/apm-integration-testing').
-* *elasticStack*: Elastic Stack branch/tag to use(default 'master').## runPipeline
-Run a pipeline passed as parameter.
-
-```
-runPipeline(name: 'pipeline-name')
-```
-
-* name: the pipeline name to execute. ## sendBenchmarks
+* *elasticStack*: Elastic Stack branch/tag to use(default 'master').## sendBenchmarks
 Send the benchmarks to the cloud service.
 Requires Go installed.
 
@@ -232,6 +239,16 @@ withEnvWrapper(){
 }
 ```
 
+```
+withEnvWrapper(cleanBefore: true, cleanAfter: true, baseDir: 'src'){
+  //block
+}
+```
+
+* cleanBefore: clean the workspace before execute the code block.
+* cleanAfter: clean the workspace after execute the code block.
+* baseDir: directory to work into, if does not exists would be created.
+
 *TODO* replace each variable with a secret text credential type, then use withCredentials step.
 
 ```

vars/gitCheckout.groovy

@@ -27,7 +27,7 @@ def call(Map params = [:]){
       } else if (branch && branch != ""
           && repo
           && credentialsId){
-        echo "Checkout ${branch}"
+        echo "Checkout ${branch} from ${repo} with credentials ${credentialsId}"
         checkout([$class: 'GitSCM', branches: [[name: "${branch}"]], 
           doGenerateSubmoduleConfigurations: false, 
           extensions: [],