Merge lp:~verterok/ols-jenkaas/job-lint into lp:~ols-jenkaas-admins/ols-jenkaas/trunk

[Guillermo Gonzalez]

Add very basic job linting target to the Makefile

This will render the jobs in ./tmp/test and barf in case of syntax errors (yaml identation, etc)

[Przemysław Suliga (suligap)]

lgtm.

(Maybe it makes sense to start using ols pypi too.)

review: Approve

[Guillermo Gonzalez (verterok)]

> lgtm.
>
> (Maybe it makes sense to start using ols pypi too.)

Indeed, but didn't want to pull too much things at once.

My aim with this is to allow anyone changing a job to render and inspect the generated jobs, even if that means using upstream pypi for the time being.

Need to collect the dependencies and probably submit a couple of sdists to ols-goodyear before we can use the pypi.ols.

[Guillermo Gonzalez (verterok)]

updated it to use pypi.ols

=== modified file 'Makefile'
--- Makefile	2017-01-04 15:39:20 +0000
+++ Makefile	2023-05-16 14:21:29 +0000
@@ -1,4 +1,9 @@
 FLAKE8 = flake8
+ENV = $(CURDIR)/env
+PIP = $(ENV)/bin/pip
+TMPDIR = $(CURDIR)/tmp
+
+OLS_WHEELS_URI ?= https://pypi.ols.canonical.com
 
 test:
 	PYTHONPATH=`pwd` ols-run-tests2
@@ -6,3 +11,17 @@
 lint:
 	$(FLAKE8) --filename='*.py' . testing/jenkaas-run \
 		testing/new-launchpad-oauth-token
+
+$(ENV):
+	python3 -m venv $(ENV)
+	$(PIP) install -f $(OLS_WHEELS_URI) --no-index jenkins-job-builder==2.10.1 jenkins-jobs-mattermost
+
+$(TMPDIR):
+	mkdir -p $@
+
+lint-jobs: $(ENV) $(TMPDIR)
+	testing/setup-job-lint-env $(TMPDIR)/job-lint
+	cd $(TMPDIR)/job-lint && $(ENV)/bin/jenkins-jobs --ignore-cache --flush-cache --conf $(TMPDIR)/job-lint/jenkins_jobs.ini test $(CURDIR)/jobs -o $(TMPDIR)/test/
+
+clean:
+	rm -rf $(TMPDIR)

=== added file 'testing/setup-job-lint-env'
--- testing/setup-job-lint-env	1970-01-01 00:00:00 +0000
+++ testing/setup-job-lint-env	2023-05-16 14:21:29 +0000
@@ -0,0 +1,20 @@
+#!/bin/bash
+# create a barebones config that alllow us to just render the jobs
+BASE_DIR=$1
+INCLUDE_DIR=$BASE_DIR/includes
+SECRETS_DIR=$BASE_DIR/secrets
+mkdir -p ${INCLUDE_DIR} ${SECRETS_DIR}
+echo true > ${INCLUDE_DIR}/is-testing.yaml
+echo false > ${INCLUDE_DIR}/is-production.yaml
+echo '[worker1,worker2]' > ${INCLUDE_DIR}/slaves.yaml
+echo "" > ${INCLUDE_DIR}/create-slave-envrc
+echo "" > ${SECRETS_DIR}/mattermost.endpoint
+cat << EOF > ${BASE_DIR}/jenkins_jobs.ini
+[job_builder]
+# Reminder: this is the default
+allow_duplicates=False
+keep_descriptions=True
+ignore_cache=True
+include_path=.:${INCLUDE_DIR}
+recursive=False
+EOF