Update cloud image list docs
[releng/builder.git] / jjb / integration / integration-macros.yaml
index 2ab9bb4fc9aa28687f0ebfa9ebfff99cd2c3e6e5..f874e911eeee23f175241f421187e0b238d3e435 100644 (file)
@@ -1,13 +1,96 @@
 ---
 # TODO: Make all bash constants more readable.
 # e.g.: DISTRIBUTION_BRANCH instead of DISTROBRANCH.
+
+- parameter:
+    name: integration-csit-parameters
+    parameters:
+      - opendaylight-infra-parameters:
+          os-cloud: "{os-cloud}"
+          project: "integration/test"
+          branch: "{branch}"
+          refspec: "refs/heads/{branch}"
+          artifacts: "{archive-artifacts}"
+      # CSIT
+      - integration-bundle-url:
+          bundle-url: "{bundle-url}"
+      - integration-repo-url:
+          repo-url: "{repo-url}"
+      - integration-test-options:
+          test-options: "{robot-options}"
+      - integration-controller-parameters:
+          controller-debug-map: "{debug-map}"
+          controller-features: "{install-features}"
+          controller-max-mem: "{controller-max-mem}"
+          controller-scope: "{controller-scope}"
+          controller-use-features-boot: "{use-features-boot}"
+          feature-elasticsearch-attribute: "{elasticsearch-attribute}"
+      - distribution-is-karaf-appl:
+          karaf-based-controller: "{karaf-based-controller}"
+      - distribution-karaf-version:
+          karaf-version: "{karaf-version}"
+
+- parameter:
+    name: integration-controller-parameters
+    parameters:
+      - string:
+          name: CONTROLLERSCOPE
+          default: "{controller-scope}"
+          description: "Feature Only or Feature All test"
+
+      - string:
+          name: CONTROLLERFEATURES
+          default: "{controller-features}"
+          description: |
+            Features to install in the controller separated by comma.
+            (note: Do not include decanter* features used for harvesting JVM metrics.
+             They are inserted in install scripts.)
+
+      - string:
+          name: CONTROLLERDEBUGMAP
+          default: "{controller-debug-map}"
+          description: |
+            Key:Value map of debugs to enable on the controller separated by spaces.
+            The module should not include org.opendaylight.
+            The levels must be one of: ERROR, WARN, INFO, DEBUG, TRACE.
+            (ex. ovsdb.lib:ERROR netvirt.vpnservice:INFO)
+
+      - string:
+          name: CONTROLLERMAXMEM
+          default: "{controller-max-mem}"
+          description: |
+            Max Heap size to use when starting the controller.
+
+      - string:
+          name: ELASTICSEARCHATTRIBUTE
+          default: "{feature-elasticsearch-attribute}"
+          description: |
+            Configure the period the script should harvest JVM metrics.
+            Possible values: long (=120000)
+                             short (=5000)
+                             any number between 5000 and 120000
+                             disabled (use for disabling harvesting)
+
+      - string:
+          name: USEFEATURESBOOT
+          default: "{controller-use-features-boot}"
+          description: "Boolean to toggle whether featuresBoot is appended or ignored"
+
 - parameter:
     name: integration-distribution-branch
     parameters:
       - string:
           name: DISTROBRANCH
-          default: '{branch}'
-          description: 'Distribution GIT branch'
+          default: "{branch}"
+          description: "Distribution GIT branch"
+
+- parameter:
+    name: distribution-is-karaf-appl
+    parameters:
+      - string:
+          name: IS_KARAF_APPL
+          default: "{karaf-based-controller}"
+          description: "Boolean to let pipeline know if the project has a different deployer"
 
 - parameter:
     name: distribution-karaf-version
     parameters:
       - string:
           name: KARAF_VERSION
-          default: '{karaf-version}'
-          description: 'karaf3, karaf4, odl, affects ODL deploy scripts'
+          default: "{karaf-version}"
+          description: "karaf3, karaf4, odl, bgpcep, controller, netconf affects ODL deploy scripts"
 
 - parameter:
     name: integration-bundle-url
     parameters:
       - string:
           name: BUNDLE_URL
-          default: '{bundle-url}'
-          description: 'URL to karaf distribution zip'
+          default: "{bundle-url}"
+          description: "URL to karaf distribution zip"
 
 - parameter:
     name: integration-repo-url
     parameters:
       - string:
           name: REPO_URL
-          default: '{repo-url}'
-          description: 'URL to feature repo artifact'
+          default: "{repo-url}"
+          description: "URL to feature repo artifact"
 
 - parameter:
     name: integration-jdk-version
     parameters:
       - string:
           name: JDKVERSION
-          default: '{jdkversion}'
-          description: 'Parameter to indicate JAVA Version'
-
-- parameter:
-    name: integration-controller-scope
-    parameters:
-      - string:
-          name: CONTROLLERSCOPE
-          default: '{controller-scope}'
-          description: 'Feature Only or Feature All test'
-
-- parameter:
-    name: integration-controller-features
-    parameters:
-      - string:
-          name: CONTROLLERFEATURES
-          default: '{controller-features}'
-          description: 'Features to install in the controller separated by comma'
-
-- parameter:
-    name: integration-controller-debug-map
-    parameters:
-      - string:
-          name: CONTROLLERDEBUGMAP
-          default: '{controller-debug-map}'
-          description: |
-              Key:Value map of debugs to enable on the controller separated by spaces.
-              The module should not include org.opendaylight.
-              The levels must be one of: ERROR, WARN, INFO, DEBUG, TRACE.
-              (ex. ovsdb.lib:ERROR netvirt.vpnservice:INFO)
+          default: "{jdkversion}"
+          description: "Parameter to indicate JAVA Version"
 
 - parameter:
     name: integration-distribution-stream
     parameters:
       - string:
           name: DISTROSTREAM
-          default: '{stream}'
-          description: 'Distribution stream string, for suites to know which behavior to expect'
+          default: "{stream}"
+          description: "Distribution stream string, for suites to know which behavior to expect"
 
 - parameter:
     name: integration-script-plan
     parameters:
       - string:
           name: SCRIPTPLAN
-          default: '{script-plan}'
-          description: 'Script plan we will run before downloading and un-archiving am ODL distribution'
+          default: "{script-plan}"
+          description: "Script plan we will run before downloading and un-archiving am ODL distribution"
 
 - parameter:
     name: integration-config-plan
     parameters:
       - string:
           name: CONFIGPLAN
-          default: '{config-plan}'
-          description: 'Config plan we will run after un-archiving and starting an ODL distribution'
+          default: "{config-plan}"
+          description: "Config plan we will run after un-archiving and starting an ODL distribution"
 
 - parameter:
     name: integration-stream-test-plan
     parameters:
       - string:
           name: STREAMTESTPLAN
-          default: '{stream-test-plan}'
-          description: 'Stream-specific test plan we will run'
+          default: "{stream-test-plan}"
+          description: "Stream-specific test plan we will run"
 
 - parameter:
     name: integration-test-plan
     parameters:
       - string:
           name: TESTPLAN
-          default: '{test-plan}'
-          description: 'General test plan we will run unless stream-specific one is found'
+          default: "{test-plan}"
+          description: "General test plan we will run unless stream-specific one is found"
 
 - parameter:
     name: integration-test-suites
     parameters:
       - string:
           name: SUITES
-          default: '{test-suites}'
+          default: "{test-suites}"
           description: |
-              List of space-separated suites. Useful when running specific suites within a testplan.
-              Do not include ${{WORKSPACE}}/test/csit/suites/ in the values:
-              (ex. openstack/connectivity/l2.robot openstack/clustering/ha_l2.robot
-               openstack/tempest/tempest.robot netvirt/elan/elan.robot).
+            List of space-separated suites. Useful when running specific suites within a testplan.
+            Do not include ${{WORKSPACE}}/test/csit/suites/ in the values:
+            (ex. openstack/connectivity/l2.robot openstack/clustering/ha_l2.robot
+             openstack/tempest/tempest.robot netvirt/elan/elan.robot).
 
 - parameter:
     name: integration-test-options
     parameters:
       - string:
           name: TESTOPTIONS
-          default: '{test-options}'
-          description: 'Robot command options'
+          default: "{test-options}"
+          description: "Robot command options"
 
 - parameter:
     name: integration-distribution-git-url
     parameters:
       - string:
           name: DISTROGITURL
-          default: '{git-url}/integration/distribution'
-          description: 'Distribution GIT URL (do not modify)'
+          default: "{git-url}/integration/distribution"
+          description: "Distribution GIT URL (do not modify)"
 
 - parameter:
     name: integration-patch-refspec
     parameters:
       - string:
           name: PATCHREFSPEC
-          default: '{branch}'
-          description: 'Integration Patch Refspec'
-
-- parameter:
-    name: integration-use-features-boot
-    parameters:
-      - string:
-          name: USEFEATURESBOOT
-          default: '{use-features-boot}'
-          description: 'Boolean to toggle whether featuresBoot is appended or ignored'
+          default: "{branch}"
+          description: "Integration Patch Refspec"
 
 # Macro: integration-gerrit-scm
 # Operation: this macro downloads a project gerrit
     name: integration-gerrit-scm
     scm:
       - git:
-          credentials-id: 'opendaylight-jenkins-ssh'
-          url: '$GIT_BASE'
-          basedir: '{basedir}'
-          refspec: '{refspec}'
+          credentials-id: "opendaylight-jenkins-ssh"
+          url: "$GIT_BASE"
+          basedir: "{basedir}"
+          refspec: "{refspec}"
           branches:
-            - 'origin/{branch}'
+            - "origin/{branch}"
           skip-tag: true
-          choosing-strategy: 'gerrit'
+          choosing-strategy: "gerrit"
 
 # Macro: integration-distribution-scm
 # Operation: this macro downloads the integration/distribution repo using distribution as basedir
     name: integration-distribution-scm
     scm:
       - git:
-          credentials-id: 'opendaylight-jenkins-ssh'
-          basedir: 'distribution'
-          url: '$DISTROGITURL'
-          refspec: ''
+          credentials-id: "opendaylight-jenkins-ssh"
+          basedir: "distribution"
+          url: "$DISTROGITURL"
+          refspec: ""
           branches:
-            - 'origin/{branch}'
+            - "origin/{branch}"
           skip-tag: true
 
 # Macro: integration-trigger-patch-submitted
     name: integration-trigger-patch-submitted
     triggers:
       - gerrit:
-          server-name: '{gerrit-server-name}'
+          server-name: "{gerrit-server-name}"
           trigger-on:
             - patchset-created-event:
                 exclude-drafts: true
           gerrit-build-unstable-codereview-value: 0
           projects:
             - project-compare-type: ANT
-              project-pattern: '{project}'
+              project-pattern: "{project}"
               branches:
                 - branch-compare-type: ANT
-                  branch-pattern: '**/{branch}'
+                  branch-pattern: "**/{branch}"
               file-paths:
                 - compare-type: ANT
-                  pattern: '{files}'
+                  pattern: "{files}"
 
 # Macro: integration-csit-only
 # Operation: this macro sets a trigger on reverse job list
     name: integration-csit-trigger
     triggers:
       - reverse:
-          jobs: '{jobs}'
-          result: 'success'
-
-# Macro: integration-openstack-controller-mininet
-# Operation: this macro will spin the controller and mininet vms
-# Used by: {project}-csit-* job templates
-
-- wrapper:
-    name: integration-openstack-controller-mininet
-    wrappers:
-      - openstack:
-          instances:
-            - cloud-name: 'ODLRPC'
-              template-name: '{controller-image}'
-              count: '{controller-vms}'
-            - cloud-name: 'ODLRPC'
-              template-name: '{mininet-image}'
-              count: '{mininet-vms}'
-
-# Macro: integration-openstack-controller-devstack
-# Operation: this macro will spin the controller and devstack vms
-# Used by: {project}-csit-openstack job templates
-- wrapper:
-    name: integration-openstack-controller-devstack
-    wrappers:
-      - openstack:
-          instances:
-            - cloud-name: 'ODLRPC'
-              template-name: '{controller-image}'
-              count: '{controller-vms}'
-            - cloud-name: 'ODLRPC'
-              template-name: '{openstack-image}'
-              count: '{openstack-vms}'
+          jobs: "{jobs}"
+          result: "success"
 
 #################
 # Shell Scripts #
 #################
 
-# Macro: integration-infra-stack
-# Operation: Sets environment and then calls opendaylight-infra-stack to spin
-#            up csit lab using openstack-heat.
-# Used by: {project}-csit-* job templates
-
-- builder:
-    name: integration-infra-stack
-    builders:
-      - integration-cleanup-workspace
-      - shell: |
-          #!/bin/bash
-          # Setup openstack envirnoment file for use by
-          # the opendaylight-infra-stack macro
-          cat > $WORKSPACE/opendaylight-infra-environment.yaml << EOF
-          parameters:
-              vm_0_count: {vm_0_count}
-              vm_0_flavor: {vm_0_flavor}
-              vm_0_image: {vm_0_image}
-              vm_1_count: {vm_1_count}
-              vm_1_flavor: {vm_1_flavor}
-              vm_1_image: {vm_1_image}
-          EOF
-          echo "Contents of opendaylight-infra-environment.yaml ..."
-          cat $WORKSPACE/opendaylight-infra-environment.yaml
-      - opendaylight-infra-stack:
-          stack-template: '{stack-template}'
-
-# Macro: integration-infra-stack-3-type
-# Operation: Sets environment and then calls opendaylight-infra-stack to spin
-#            up csit lab using openstack-heat.
-# Used by: {project}-csit-* job templates
-
-- builder:
-    name: integration-infra-stack-3-type
-    builders:
-      - integration-cleanup-workspace
-      - shell: |
-          #!/bin/bash
-          # Setup openstack envirnoment file for use by
-          # the opendaylight-infra-stack macro
-          cat > $WORKSPACE/opendaylight-infra-environment.yaml << EOF
-          parameters:
-              vm_0_count: {vm_0_count}
-              vm_0_flavor: {vm_0_flavor}
-              vm_0_image: {vm_0_image}
-              vm_1_count: {vm_1_count}
-              vm_1_flavor: {vm_1_flavor}
-              vm_1_image: {vm_1_image}
-              vm_2_count: {vm_2_count}
-              vm_2_flavor: {vm_2_flavor}
-              vm_2_image: {vm_2_image}
-          EOF
-          echo "Contents of opendaylight-infra-environment.yaml ..."
-          cat $WORKSPACE/opendaylight-infra-environment.yaml
-      - opendaylight-infra-stack:
-          stack-template: 'csit-3-instance-type.yaml'
-
-# Macro: integration-infra-stack-4-type
-# Operation: Sets environment and then calls opendaylight-infra-stack to spin
-#            up csit lab using openstack-heat.
-# Used by: {project}-csit-* job templates
-
-- builder:
-    name: integration-infra-stack-4-type
-    builders:
-      - integration-cleanup-workspace
-      - shell: |
-          #!/bin/bash
-          # Setup openstack envirnoment file for use by
-          # the opendaylight-infra-stack macro
-          cat > $WORKSPACE/opendaylight-infra-environment.yaml << EOF
-          parameters:
-              vm_0_count: {vm_0_count}
-              vm_0_flavor: {vm_0_flavor}
-              vm_0_image: {vm_0_image}
-              vm_1_count: {vm_1_count}
-              vm_1_flavor: {vm_1_flavor}
-              vm_1_image: {vm_1_image}
-              vm_2_count: {vm_2_count}
-              vm_2_flavor: {vm_2_flavor}
-              vm_2_image: {vm_2_image}
-              vm_3_count: {vm_3_count}
-              vm_3_flavor: {vm_3_flavor}
-              vm_3_image: {vm_3_image}
-          EOF
-          echo "Contents of opendaylight-infra-environment.yaml ..."
-          cat $WORKSPACE/opendaylight-infra-environment.yaml
-      - opendaylight-infra-stack:
-          stack-template: 'csit-4-instance-type.yaml'
-
 # Macro: integration-get-slave-addresses
 # Operation: this macro gets the IP addresses of the dynamic vms
 # Used by: {project}-csit-* job templates
 - builder:
     name: integration-get-slave-addresses
     builders:
-      - shell: !include-raw: integration-get-slave-addresses.sh
+      - shell: !include-raw-escape: integration-get-slave-addresses.sh
 
 - builder:
     name: integration-set-variables
     # Required bash variables:
     #   KARAF_VERSION: 'karaf4' or 'karaf3'. Use distribution-karaf-version macro to set.
     builders:
-      - shell: !include-raw: integration-set-variables.sh
+      - shell: !include-raw-escape: integration-set-variables.sh
       - inject:
           properties-file: set_variables.env
 
     #   KARAF_VERSION: 'karaf4' or 'karaf3'. Use distribution-karaf-version macro to set.
     builders:
       - integration-set-variables
-      - shell: !include-raw: integration-detect-variables.sh
+      - shell: !include-raw-escape: integration-detect-variables.sh
       - inject:
           properties-file: detect_variables.env
 
 - builder:
     name: integration-deploy-controller-run-test
     builders:
-      - shell: !include-raw: integration-deploy-controller-run-test.sh
+      - shell: !include-raw-escape: integration-deploy-controller-run-test.sh
+
+# Macro: integration-deply-non-karaf-controller-run-test
+# Operation: this macro deploys non-karaf controller application and run test
+# Used by: {project}-csit-1node-* job templates
+
+- builder:
+    name: integration-run-test
+    builders:
+      - shell: !include-raw-escape: integration-run-test.sh
 
 # Macro: integration-configure-clustering
 # Operation: this macro configures the clustering
 - builder:
     name: integration-configure-clustering
     builders:
-      - shell: !include-raw: integration-configure-clustering.sh
+      - shell: !include-raw-escape: integration-configure-clustering.sh
 
 # Macro: integration-start-cluster-run-test
 # Operation: this macro starts the 3-node cluster and runs test
 - builder:
     name: integration-start-cluster-run-test
     builders:
-      - shell: !include-raw: integration-start-cluster-run-test.sh
+      - shell: !include-raw-escape: integration-start-cluster-run-test.sh
 
 # Macro: integration-install-robotframework
 # Operation: Installs robotframework using pip to a virtualenv
 - builder:
     name: integration-install-robotframework
     builders:
-      - shell: !include-raw: integration-install-robotframework.sh
+      - shell: !include-raw-escape: integration-install-robotframework.sh
 
 # Macro: integration-cleanup-tmp
 # Operation: Cleans up temporary files created by build
 - builder:
     name: integration-cleanup-tmp
     builders:
-      - shell: !include-raw: integration-cleanup-tmp.sh
+      - shell: !include-raw-escape: integration-cleanup-tmp.sh
 
 # Macro: integration-multipatch-builder
 # Operation: checks out multiple patches and builds custom distribution
 - builder:
     name: integration-multipatch-builder
     builders:
-      - shell: !include-raw: multipatch-distribution.sh
-
-# Macro: integration-cleanup-workspace
-# Operation: Cleans up files possibly left there by the previous build
-# Used by: {project}-csit-* job templates
-
-- builder:
-    name: integration-cleanup-workspace
-    builders:
-      - shell: !include-raw: integration-cleanup-workspace.sh
+      - shell: !include-raw-escape: multipatch-distribution.sh
 
 # Macro: integration-rebase-patch
 # Operation: For cloned project, rebase checked-out Gerrit patch onto $DISTROBRANCH.
 - builder:
     name: integration-rebase-gerrit-patch
     builders:
-      - shell: !include-raw: integration-rebase-gerrit-patch.sh
+      - shell: !include-raw-escape: integration-rebase-gerrit-patch.sh
 
 # Macro: integration-install-common-functions
 # Operation: Copy the common-functions.sh script to csit nodes
 - builder:
     name: integration-install-common-functions
     builders:
-      - shell: !include-raw:
+      - shell: !include-raw-escape:
           - copy-common-functions.sh
           - common-functions.sh
 
-- builder:
-    name: integration-deploy-openstack-run-test
-    builders:
-      - shell: !include-raw:
-          - integration-deploy-openstack-run-test.sh
-
 - builder:
     name: integration-compare-distributions
     # Operation: will compare an already created distribtion (probably last
     # Required bash variables:
     #   KARAF_ARTIFACT: 'karaf' or 'distribution-karaf'. Use integration-set-variables.
     builders:
-      - shell: !include-raw: integration-compare-distributions.sh
+      - shell: !include-raw-escape: integration-compare-distributions.sh
+
+- builder:
+    name: integration-csit-archive-artifacts
+    builders:
+      - shell: !include-raw-escape: integration-csit-archive-artifacts.sh
 
 - builder:
     name: integration-upload-distribution
           files:
             - file-id: global-settings
               variable: GLOBAL_SETTINGS_FILE
-            - file-id: integration-settings
+            - file-id: "{settings-project}-settings"
               variable: SETTINGS_FILE
       - integration-set-variables
       - inject:
 # Publishers #
 ##############
 
-# Macro: integration-robot
-# Operation: this macro publishes robot results
-# Used by: {project}-csit-* job templates
-
 - publisher:
-    name: integration-robot
+    name: integration-csit-publish
     publishers:
       - robot:
-          output-path: ''
-          other-files: ''
-          unstable-threshold: '{unstable-if}'
-          pass-threshold: '{pass-if}'
-          only-critical: false
-
-- publisher:
-    name: integration-robot-tempest
-    publishers:
-      - robot:
-          output-path: ''
-          other-files:
-            - tempest_results.html
-          unstable-threshold: '{unstable-if}'
-          pass-threshold: '{pass-if}'
+          output-path: ""
+          other-files: "{obj:robot_other_files}"
+          unstable-threshold: "{robot-unstable-threshold}"
+          pass-threshold: "{robot-pass-threshold}"
           only-critical: false
+      - integration-csit-archive-build
+      - integration-csit-run-postscript
 
 - publisher:
     name: integration-csit-archive-build
                 - SUCCESS
                 - UNSTABLE
               build-steps:
-                - shell: |
-                    #!/bin/bash
-                    cd $WORKSPACE
-                    mkdir -p ./archives
-                    for i in `seq 1 ${NUM_ODL_SYSTEM}`; do
-                        NODE_FOLDER="./archives/odl_${i}"
-                        mkdir -p ${NODE_FOLDER}
-                        mv odl${i}_karaf* ${NODE_FOLDER} || true
-                        mv karaf_${i}_*_threads* ${NODE_FOLDER} || true
-                        mv *_${i}.png ${NODE_FOLDER} || true
-                    done
-                    curl --output robot-plugin.zip "$BUILD_URL/robot/report/*zip*/robot-plugin.zip"
-                    unzip -d ./archives robot-plugin.zip
-                    mv *.log *.log.gz *.csv *.png ./archives || true  # Don't fail if file missing
-                    # TODO: Can the following line ever fail?
-                    find . -type f -name *.hprof -print0 \
-                        | tar -cvf - --null -T - | xz --threads=0 > ./archives/hprof.tar.xz
-                    # TODO: Tweak the compression level if better ratio (or speed) is needed.
+                - shell: !include-raw-escape: integration-csit-archive-artifacts.sh
           mark-unstable-if-failed: true
 
-
 - publisher:
     name: integration-csit-run-postscript
     publishers:
                 - SUCCESS
                 - UNSTABLE
               build-steps:
-                - config-file-provider:
-                    files:
-                      - file-id: 'odl-elastic-cloud'
-                        target: '${HOME}/.netrc'
-                - shell: |
-                    #!/bin/bash
-                    #The following script runs any configurable postplan stored in test/csit/postplans.
-                    if [ -f "${WORKSPACE}/test/csit/postplans/${TESTPLAN}" ]; then
-                        echo "postplan exists!!!"
-                        echo "Changing the postplan path..."
-                        script_name=${WORKSPACE}/test/csit/postplans/${TESTPLAN}
-                        cat ${script_name} | sed "s:integration:${WORKSPACE}:" > postplan.txt
-                        cat postplan.txt
-                        egrep -v '(^[[:space:]]*#|^[[:space:]]*$)' postplan.txt | while read -r line ; do
-                            echo "Executing ${line}..."
-                            ${line}
-                        done
-                    fi
-                    rm ${HOME}/.netrc
-          mark-unstable-if-failed: true
-
-- publisher:
-    name: integration-csit-collect-netvirt-logs
-    publishers:
-      - postbuildscript:
-          builders:
-            - role: BOTH
-              build-on:
-                - ABORTED
-                - FAILURE
-                - NOT_BUILT
-                - SUCCESS
-                - UNSTABLE
-              build-steps:
-                - inject:
-                    properties-file: 'slave_addresses.txt'
-                - shell: |
-                    #!/bin/bash
-                    source /tmp/common-functions.sh ${BUNDLEFOLDER}
-                    collect_netvirt_logs
+                - shell: !include-raw-escape: integration-csit-run-postscript.sh
           mark-unstable-if-failed: true