Refactor packer ci templates 82/5882/1
authorThanh Ha <thanh.ha@linuxfoundation.org>
Fri, 11 Aug 2017 21:26:32 +0000 (17:26 -0400)
committerThanh Ha <thanh.ha@linuxfoundation.org>
Fri, 11 Aug 2017 21:44:05 +0000 (17:44 -0400)
Improve maintainability by refactoring some common code.

- Improve documentation
- Reorganize anchors for better maintainability
- Remove dependency on jjb_common anchor
  (updates to jjb code should not not break packer code)
- Do not run packer merge jobs concurrently
  (merge jobs should not be configured to run concurrently)

Change-Id: Ib796cfee44ae7b01b42ee400a04be79b243cac3b
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
jjb-test/expected-xml/gerrit-ciman-packer-merge-centos-java-builder
jjb-test/expected-xml/gerrit-ciman-packer-merge-centos-mininet
jjb-test/expected-xml/gerrit-ciman-packer-merge-ubuntu1604-java-builder
jjb-test/expected-xml/gerrit-ciman-packer-merge-ubuntu1604-mininet
jjb-test/expected-xml/github-ciman-packer-merge-centos-java-builder
jjb-test/expected-xml/github-ciman-packer-merge-centos-mininet
jjb-test/expected-xml/github-ciman-packer-merge-ubuntu1604-java-builder
jjb-test/expected-xml/github-ciman-packer-merge-ubuntu1604-mininet
jjb/lf-ci-jobs.yaml

index 869ba6d..730f528 100644 (file)
@@ -5,7 +5,7 @@
   <keepDependencies>false</keepDependencies>
   <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
   <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
-  <concurrentBuild>true</concurrentBuild>
+  <concurrentBuild>false</concurrentBuild>
   <assignedNode>build-vm</assignedNode>
   <canRoam>false</canRoam>
   <properties>
index bcfd891..367f17d 100644 (file)
@@ -5,7 +5,7 @@
   <keepDependencies>false</keepDependencies>
   <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
   <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
-  <concurrentBuild>true</concurrentBuild>
+  <concurrentBuild>false</concurrentBuild>
   <assignedNode>build-vm</assignedNode>
   <canRoam>false</canRoam>
   <properties>
index 4e2eaeb..27466db 100644 (file)
@@ -5,7 +5,7 @@
   <keepDependencies>false</keepDependencies>
   <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
   <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
-  <concurrentBuild>true</concurrentBuild>
+  <concurrentBuild>false</concurrentBuild>
   <assignedNode>build-vm</assignedNode>
   <canRoam>false</canRoam>
   <properties>
index 97ccd56..a62d877 100644 (file)
@@ -5,7 +5,7 @@
   <keepDependencies>false</keepDependencies>
   <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
   <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
-  <concurrentBuild>true</concurrentBuild>
+  <concurrentBuild>false</concurrentBuild>
   <assignedNode>build-vm</assignedNode>
   <canRoam>false</canRoam>
   <properties>
index 2f044d9..699ac5d 100644 (file)
@@ -5,7 +5,7 @@
   <keepDependencies>false</keepDependencies>
   <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
   <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
-  <concurrentBuild>true</concurrentBuild>
+  <concurrentBuild>false</concurrentBuild>
   <assignedNode>build-vm</assignedNode>
   <canRoam>false</canRoam>
   <properties>
index a2b2c66..64a5a7c 100644 (file)
@@ -5,7 +5,7 @@
   <keepDependencies>false</keepDependencies>
   <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
   <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
-  <concurrentBuild>true</concurrentBuild>
+  <concurrentBuild>false</concurrentBuild>
   <assignedNode>build-vm</assignedNode>
   <canRoam>false</canRoam>
   <properties>
index e734f84..719709c 100644 (file)
@@ -5,7 +5,7 @@
   <keepDependencies>false</keepDependencies>
   <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
   <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
-  <concurrentBuild>true</concurrentBuild>
+  <concurrentBuild>false</concurrentBuild>
   <assignedNode>build-vm</assignedNode>
   <canRoam>false</canRoam>
   <properties>
index ce8a79e..cac1b63 100644 (file)
@@ -5,7 +5,7 @@
   <keepDependencies>false</keepDependencies>
   <blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
   <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
-  <concurrentBuild>true</concurrentBuild>
+  <concurrentBuild>false</concurrentBuild>
   <assignedNode>build-vm</assignedNode>
   <canRoam>false</canRoam>
   <properties>
index 37467a5..ef8c665 100644 (file)
 
 - lf_packer: &lf_packer_common
     name: lf-packer-common
-    # Adds wrappers and parameters sections common to packer jobs.
+    # Provide configuration common in packer jobs.
 
     ######################
     # Default parameters #
     ######################
 
+    branch: master
     build-timeout: 45
+    stream: master
+    submodule-recursive: true
     packer-cloud-settings: packer-cloud-env
 
-    wrappers:
-      - lf-infra-wrappers:
-          build-timeout: '{build-timeout}'
-          jenkins-ssh-credential: '{jenkins-ssh-credential}'
+    #####################
+    # Job Configuration #
+    #####################
+
+    project-type: freestyle
+    node: '{build-node}'
+
+    properties:
+      - lf-infra-properties:
+          project: '{project}'
+          build-days-to-keep: 7
 
     parameters:
       - lf-infra-parameters:
       - lf-infra-packer-parameters:
           packer-version: '{packer-version}'
 
+    wrappers:
+      - lf-infra-wrappers:
+          build-timeout: '{build-timeout}'
+          jenkins-ssh-credential: '{jenkins-ssh-credential}'
+
+    publishers:
+      - lf-infra-publish
+
 - parameter:
     name: lf-infra-jjb-parameters
     parameters:
 # Packer Merge #
 ################
 
-- lf_packer_merge_builders: &lf_packer_merge_builders
-    name: lf-packer-merge-builders
+- lf_packer_merge: &lf_packer_merge
+    name: lf-packer-merge
 
-    # Adds builders section common to merge packer jobs.
-    # {packer-cloud-settings} is passed from the project, defines the managed
-    #                   file-id name created in Jenkins
-    #                   (default: packer-cloud-env)
-    # {packer-version}: is global defined in job group level, the version number
-    #                   can be updated to install the latest version of packer.
-    # {platforms}:      defines the packer platform file, passed from the project.
-    # {template}:       defines the packer template file, passed from the project.
+    # Packer Merge job runs `packer build` to build system images in the cloud.
+    #
+    # Required parameters:
+    #
+    #     :build-node: The node to run build on.
+    #     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
+    #         be configured in defaults.yaml)
+    #     :mvn-settings: The name of settings file containing credentials for
+    #         the project.
+    #     :platforms: Platform or distribution to build. Typically json file
+    #         found in the packer/vars directory. (Example: centos)
+    #     :template: System template to build. Typically shell script found in
+    #         the packer/provision directory. (Example: java-builder)
+    #
+    # Optional parameters:
+    #
+    #     :branch: Git branch to fetch for the build. (default: master)
+    #     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+    #     :build-timeout: Timeout in seconds before aborting build. (default: 10)
+    #     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+    #     :packer-cloud-settings: Name of settings file containing credentials
+    #         for the cloud that packer will build on. (default: packer-cloud-env)
+    #     :packer-version: Version of packer to install / use in build. (default: 1.0.2)
+    #     :stream: Keyword that can be used to represent a release code-name.
+    #         Often the same as the branch. (default: master)
+    #     :submodule-recursive: Whether to checkout submodules recursively.
+    #         (default: true)
+    #
+    #     :gerrit_verify_triggers: Override Gerrit Triggers.
+    #     :gerrit_trigger_file_paths: Override file paths which can be used to
+    #         filter which file modifications will trigger a build.
+    #         (default defined by lf_jjb_common)
+
+    ######################
+    # Default parameters #
+    ######################
+
+    gerrit_merge_triggers:
+      - change-merged-event
+      - comment-added-contains-event:
+          comment-contains-value: remerge$
+
+    #####################
+    # Job Configuration #
+    #####################
 
     builders:
       - lf-infra-packer-validate:
 - job-template:
     name: '{project-name}-packer-merge-{platforms}-{templates}'
     id: gerrit-packer-merge
-    concurrent: true
-    <<: *lf_jjb_common
-    # yamllint disable-line rule:key-duplicates
     <<: *lf_packer_common
     # yamllint disable-line rule:key-duplicates
-    <<: *lf_packer_merge_builders
-
-    ######################
-    # Default parameters #
-    ######################
+    <<: *lf_packer_merge
 
     git-url: '$GIT_URL/$GERRIT_PROJECT'
 
-    gerrit_merge_triggers:
-      - change-merged-event
-      - comment-added-contains-event:
-          comment-contains-value: remerge$
-
-    #####################
-    # Job Configuration #
-    #####################
-
     scm:
       - lf-infra-gerrit-scm:
           git-url: '{git-url}'
 - job-template:
     name: '{project-name}-packer-merge-{platforms}-{templates}'
     id: github-packer-merge
-    concurrent: true
-    <<: *lf_jjb_common
-    # yamllint disable-line rule:key-duplicates
     <<: *lf_packer_common
     # yamllint disable-line rule:key-duplicates
-    <<: *lf_packer_merge_builders
-
-    #####################
-    # Job Configuration #
-    #####################
+    <<: *lf_packer_merge
 
     properties:
       - github:
 # Packer Verify #
 #################
 
-- lf_packer_verify_builders: &lf_packer_verify_builders
-    name: lf-packer-verify-builders
-
-    # Adds builders section common to verify packer jobs.
-    # {packer-cloud-settings} is passed from the project, defines the managed
-    #                   file-id name created in Jenkins
-    #                   (default: packer-cloud-env)
-    # {packer-version}: is global defined in job group level, the version number
-    #                   can be updated to install the latest version of packer.
+- lf_packer_verify: &lf_packer_verify
+    name: lf-packer-verify
 
-    builders:
-      - lf-infra-packer-validate:
-          packer-cloud-settings: '{packer-cloud-settings}'
-          packer-version: '{packer-version}'
-
-- job-template:
-    name: '{project-name}-packer-verify'
-    id: gerrit-packer-verify
-    concurrent: true
-    <<: *lf_jjb_common
-    # yamllint disable-line rule:key-duplicates
-    <<: *lf_packer_common
-    # yamllint disable-line rule:key-duplicates
-    <<: *lf_packer_verify_builders
+    # Packer Verify job runs `packer validate` to verify packer configuration.
+    #
+    # Required parameters:
+    #
+    #     :build-node: The node to run build on.
+    #     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
+    #         be configured in defaults.yaml)
+    #     :mvn-settings: The name of settings file containing credentials for
+    #         the project.
+    #
+    # Optional parameters:
+    #
+    #     :branch: Git branch to fetch for the build. (default: master)
+    #     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+    #     :build-timeout: Timeout in seconds before aborting build. (default: 10)
+    #     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+    #     :packer-cloud-settings: Name of settings file containing credentials
+    #         for the cloud that packer will build on. (default: packer-cloud-env)
+    #     :packer-version: Version of packer to install / use in build. (default: 1.0.2)
+    #     :stream: Keyword that can be used to represent a release code-name.
+    #         Often the same as the branch. (default: master)
+    #     :submodule-recursive: Whether to checkout submodules recursively.
+    #         (default: true)
+    #
+    #     :gerrit_verify_triggers: Override Gerrit Triggers.
+    #     :gerrit_trigger_file_paths: Override file paths which can be used to
+    #         filter which file modifications will trigger a build.
+    #         (default defined by lf_jjb_common)
 
     ######################
     # Default parameters #
     ######################
 
     build-timeout: 10
-    git-url: '$GIT_URL/$GERRIT_PROJECT'
 
     gerrit_verify_triggers:
       - patchset-created-event:
     # Job Configuration #
     #####################
 
+    concurrent: true
+
+    builders:
+      - lf-infra-packer-validate:
+          packer-cloud-settings: '{packer-cloud-settings}'
+          packer-version: '{packer-version}'
+
+- job-template:
+    name: '{project-name}-packer-verify'
+    id: gerrit-packer-verify
+    <<: *lf_packer_common
+    # yamllint disable-line rule:key-duplicates
+    <<: *lf_packer_verify
+
+    git-url: '$GIT_URL/$GERRIT_PROJECT'
+
     scm:
       - lf-infra-gerrit-scm:
           git-url: '{git-url}'
 - job-template:
     name: '{project-name}-packer-verify'
     id: github-packer-verify
-    concurrent: true
-    <<: *lf_jjb_common
-    # yamllint disable-line rule:key-duplicates
     <<: *lf_packer_common
     # yamllint disable-line rule:key-duplicates
-    <<: *lf_packer_verify_builders
-
-    ######################
-    # Default parameters #
-    ######################
-
-    build-timeout: 10
-
-    #####################
-    # Job Configuration #
-    #####################
+    <<: *lf_packer_verify
 
     properties:
       - github: