Add `make lint` target and fix errors that were found
Change-Id: Ibb2886d07e0e1c8a4b8928721a12eb94c01178a0
diff --git a/Makefile b/Makefile
index 2d8c2ba..74377f4 100644
--- a/Makefile
+++ b/Makefile
@@ -14,6 +14,9 @@
$(JOBCONFIG_DIR):
mkdir $@
+lint:
+ yamllint -c yamllint.conf jjb/
+
test: $(VENV_DIR) $(JOBCONFIG_DIR)
source $(VENV_DIR)/bin/activate ; \
pipdeptree ; \
diff --git a/README.md b/README.md
index c8dca3d..0770dbe 100644
--- a/README.md
+++ b/README.md
@@ -106,20 +106,17 @@
### Testing job definitions
-JJB job definitions can be tested by running:
-
-```shell
-make test
-```
-
-Which will create a python virtualenv, install jenkins-job-builder in it, then
-try building all the job files, which are put in `job-configs` and can be
-inspected.
+JJB job definitions can be tested by running `make test`, which will create a
+python virtualenv, install jenkins-job-builder in it, then try building all the
+job files, which are put in `job-configs` and can be inspected.
The output of this is somewhat difficult to decipher, sometimes requiring you
to go through the python backtrace to figure out where the error occurred in
the jenkins-job-builder source code.
+There is also a `make lint` target which will run `yamllint` on all the JJB
+YAML files, which can catch a variety of formatting errors.
+
If you're writing a new shell script, it's a good idea to test it with
[shellcheck](https://github.com/koalaman/shellcheck) before including it -
failing to heed those messages then using `!include-escape` to add it to the
diff --git a/jjb/api-test.yaml b/jjb/api-test.yaml
index 3369ad5..595369f 100644
--- a/jjb/api-test.yaml
+++ b/jjb/api-test.yaml
@@ -35,6 +35,6 @@
script-path: 'Jenkinsfile/verify-api-tests-JenkinsFile'
scm:
- git:
- url: '{gerrit-server-url}/cord-tester'
- branches:
- - 'master'
+ url: '{gerrit-server-url}/cord-tester'
+ branches:
+ - 'master'
diff --git a/jjb/cord-macros.yaml b/jjb/cord-macros.yaml
index 8e43216..c287aab 100644
--- a/jjb/cord-macros.yaml
+++ b/jjb/cord-macros.yaml
@@ -69,7 +69,7 @@
- gerrit:
server-name: '{gerrit-server-name}'
dependency-jobs: '{dependency-jobs}'
- silent-start: True
+ silent-start: true
trigger-on:
- change-merged-event
projects:
diff --git a/jjb/cord-test/cord-test-pipeline.yaml b/jjb/cord-test/cord-test-pipeline.yaml
index 19f7402..73ba6fd 100644
--- a/jjb/cord-test/cord-test-pipeline.yaml
+++ b/jjb/cord-test/cord-test-pipeline.yaml
@@ -20,33 +20,33 @@
parameters:
- string:
- name: devNodeName
- default: '{pod}'
- description: 'Jenkins node name of Dev Node'
+ name: devNodeName
+ default: '{pod}'
+ description: 'Jenkins node name of Dev Node'
- string:
- name: configRepoUrl
- default: 'https://gerrit.opencord.org/pod-configs'
- description: 'The URL of the POD configs repository'
+ name: configRepoUrl
+ default: 'https://gerrit.opencord.org/pod-configs'
+ description: 'The URL of the POD configs repository'
- string:
- name: configRepoBaseDir
- default: 'pod-configs/'
- description: 'The directory inside the POD configs repository'
+ name: configRepoBaseDir
+ default: 'pod-configs/'
+ description: 'The directory inside the POD configs repository'
- string:
- name: configRepoFile
- default: 'deployment-configs/{pod}.yml'
- description: 'The deployment config file'
+ name: configRepoFile
+ default: 'deployment-configs/{pod}.yml'
+ description: 'The deployment config file'
- string:
- name: branch
- default: '{branch}'
+ name: branch
+ default: '{branch}'
- string:
- name: notificationEmail
- default: 'kailash@opennetworking.org, you@opennetworking.org, suchitra@opennetworking.org'
- description: ''
+ name: notificationEmail
+ default: 'kailash@opennetworking.org, you@opennetworking.org, suchitra@opennetworking.org'
+ description: ''
concurrent: true
@@ -66,14 +66,14 @@
script-path: '{Jenkinsfile}'
scm:
- git:
- url: '{gerrit-server-url}/cord'
- branches:
- - '{branch}'
+ url: '{gerrit-server-url}/cord'
+ branches:
+ - '{branch}'
triggers:
- - timed: |
- TZ=America/Los_Angeles
- H {time} * * *
+ - timed: |
+ TZ=America/Los_Angeles
+ H {time} * * *
- job-template:
name: 'build_{pod}_{branch}'
@@ -91,14 +91,14 @@
script-path: '{Jenkinsfile}'
scm:
- git:
- url: '{gerrit-server-url}/cord'
- branches:
- - '{branch}'
+ url: '{gerrit-server-url}/cord'
+ branches:
+ - '{branch}'
triggers:
- - reverse:
- jobs: 'build-{pod}-{fromBranch}-test'
- result: 'failure'
+ - reverse:
+ jobs: 'build-{pod}-{fromBranch}-test'
+ result: 'failure'
- job-template:
name: 'build_{pod}_{branch}_test'
@@ -118,9 +118,9 @@
script-path: '{Jenkinsfile}'
scm:
- git:
- url: '{gerrit-server-url}/cord-tester'
- branches:
- - '{branch}'
+ url: '{gerrit-server-url}/cord-tester'
+ branches:
+ - '{branch}'
triggers:
- reverse:
@@ -136,89 +136,90 @@
jobs:
- 'build_pod_first':
- pod: 'qct-pod1'
- branch: 'cord-4.0'
- Jenkinsfile: 'Jenkinsfile.newBuildSystem'
- time: '20'
+ pod: 'qct-pod1'
+ branch: 'cord-4.0'
+ Jenkinsfile: 'Jenkinsfile.newBuildSystem'
+ time: '20'
- 'build_pod':
- pod: 'qct-pod1'
- branch: 'cord-4.1'
- Jenkinsfile: 'Jenkinsfile.newBuildSystem'
- fromBranch: 'cord-4.0'
+ pod: 'qct-pod1'
+ branch: 'cord-4.1'
+ Jenkinsfile: 'Jenkinsfile.newBuildSystem'
+ fromBranch: 'cord-4.0'
- 'build_pod':
- pod: 'qct-pod1'
- branch: 'cord-5.0'
- Jenkinsfile: 'Jenkinsfile.newBuildSystem'
- fromBranch: 'cord-4.1'
+ pod: 'qct-pod1'
+ branch: 'cord-5.0'
+ Jenkinsfile: 'Jenkinsfile.newBuildSystem'
+ fromBranch: 'cord-4.1'
- 'build_pod':
- pod: 'qct-pod1'
- branch: 'master'
- Jenkinsfile: 'Jenkinsfile'
- fromBranch: 'cord-5.0'
+ pod: 'qct-pod1'
+ branch: 'master'
+ Jenkinsfile: 'Jenkinsfile'
+ fromBranch: 'cord-5.0'
- 'build_pod_first':
- pod: 'qct-pod3'
- branch: 'cord-4.0'
- Jenkinsfile: 'Jenkinsfile.newBuildSystem'
- time: '20'
+ pod: 'qct-pod3'
+ branch: 'cord-4.0'
+ Jenkinsfile: 'Jenkinsfile.newBuildSystem'
+ time: '20'
- 'build_pod':
- pod: 'qct-pod3'
- branch: 'cord-4.1'
- Jenkinsfile: 'Jenkinsfile.newBuildSystem'
- fromBranch: 'cord-4.0'
+ pod: 'qct-pod3'
+ branch: 'cord-4.1'
+ Jenkinsfile: 'Jenkinsfile.newBuildSystem'
+ fromBranch: 'cord-4.0'
- 'build_pod':
- pod: 'qct-pod3'
- branch: 'cord-5.0'
- Jenkinsfile: 'Jenkinsfile.newBuildSystem'
- fromBranch: 'cord-4.1'
+ pod: 'qct-pod3'
+ branch: 'cord-5.0'
+ Jenkinsfile: 'Jenkinsfile.newBuildSystem'
+ fromBranch: 'cord-4.1'
- 'build_pod':
- pod: 'qct-pod3'
- branch: 'master'
- Jenkinsfile: 'Jenkinsfile'
- fromBranch: 'cord-5.0'
+ pod: 'qct-pod3'
+ branch: 'master'
+ Jenkinsfile: 'Jenkinsfile'
+ fromBranch: 'cord-5.0'
- 'build_pod_test':
- pod: 'qct-pod1'
- branch: 'cord-4.0'
- Jenkinsfile: 'Jenkinsfile-rcord'
+ pod: 'qct-pod1'
+ branch: 'cord-4.0'
+ Jenkinsfile: 'Jenkinsfile-rcord'
- 'build_pod_test':
- pod: 'qct-pod1'
- branch: 'cord-4.1'
- Jenkinsfile: 'Jenkinsfile-rcord'
+ pod: 'qct-pod1'
+ branch: 'cord-4.1'
+ Jenkinsfile: 'Jenkinsfile-rcord'
- 'build_pod_test':
- pod: 'qct-pod1'
- branch: 'cord-5.0'
- Jenkinsfile: 'Jenkinsfile-rcord'
+ pod: 'qct-pod1'
+ branch: 'cord-5.0'
+ Jenkinsfile: 'Jenkinsfile-rcord'
- 'build_pod_test':
- pod: 'qct-pod1'
- branch: 'master'
- Jenkinsfile: 'Jenkinsfile-rcord'
+ pod: 'qct-pod1'
+ branch: 'master'
+ Jenkinsfile: 'Jenkinsfile-rcord'
- 'build_pod_test':
- pod: 'qct-pod3'
- branch: 'cord-4.0'
- Jenkinsfile: 'Jenkinsfile-rcord'
+ pod: 'qct-pod3'
+ branch: 'cord-4.0'
+ Jenkinsfile: 'Jenkinsfile-rcord'
- 'build_pod_test':
- pod: 'qct-pod3'
- branch: 'cord-4.1'
- Jenkinsfile: 'Jenkinsfile-rcord'
+ pod: 'qct-pod3'
+ branch: 'cord-4.1'
+ Jenkinsfile: 'Jenkinsfile-rcord'
- 'build_pod_test':
- pod: 'qct-pod3'
- branch: 'cord-5.0'
- Jenkinsfile: 'Jenkinsfile-rcord'
+ pod: 'qct-pod3'
+ branch: 'cord-5.0'
+ Jenkinsfile: 'Jenkinsfile-rcord'
- 'build_pod_test':
- pod: 'qct-pod3'
- branch: 'master'
- Jenkinsfile: 'Jenkinsfile-rcord'
+ pod: 'qct-pod3'
+ branch: 'master'
+ Jenkinsfile: 'Jenkinsfile-rcord'
+
diff --git a/jjb/sonar.yaml b/jjb/sonar.yaml
index a159abb..d7d3b9b 100644
--- a/jjb/sonar.yaml
+++ b/jjb/sonar.yaml
@@ -115,11 +115,6 @@
project-type: freestyle
concurrent: true
-# coverage checks with sonarqube
-# module docs: https://docs.openstack.org/infra/jenkins-job-builder/builders.html?highlight=sonar#builders.sonar
-# Sonarqube docs:
-# https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner+for+Jenkins
-# https://docs.sonarqube.org/display/SCAN/Advanced+SonarQube+Scanner+Usages
builders:
- sonar:
sonar-name: 'sonarqube.opencord.org'
diff --git a/jjb/verify/manifest.yaml b/jjb/verify/manifest.yaml
index e5cdd15..b79a915 100644
--- a/jjb/verify/manifest.yaml
+++ b/jjb/verify/manifest.yaml
@@ -14,4 +14,3 @@
jobs:
- 'verify-repo-manifest'
-