Merge lp:~danilo/landscape-client/ci-check-and-deps into lp:~landscape/landscape-client/trunk

[Данило Шеган]

Split depends installation from "check" target

So far, we've depended on accidental installation of deps on our build slaves (eg. Landscape itself might install them), or manual installation.

Make separate ci-check target similar to our other codebases that installs the deps for both py2 and py3, and remove deps installation from py3 check targets.

Add makefile help similar to our more recent projects too.

Split depends installation from "check" target

So far, we've depended on accidental installation of deps on our build slaves (eg. Landscape itself might install them), or manual installation.

Make separate ci-check target similar to our other codebases that installs the deps for both py2 and py3, and remove deps installation from py3 check targets.

Add makefile help similar to our more recent projects too.

NOTE: tarmac-config will need to be updated to make tarmac/latch run "make ci-check" on landscape-client once this lands.

Testing instructions:

"make help" and then follow the instructions :-)

[lp:~danilo/landscape-client/ci-check-and-deps]

972. By Данило Шеган on 2017-03-23

Merge trunk, resolve conflicts.

[🤖 Landscape Builder (landscape-builder)]

review: Abstain (executing tests)

[🤖 Landscape Builder (landscape-builder)]

Command: TRIAL_ARGS=-j4 make check
Result: Success
Revno: 972
Branch: lp:~danilo/landscape-client/ci-check-and-deps
Jenkins: https://ci.lscape.net/job/latch-test-xenial/3773/

review: Approve (test results)

[Alberto Donato (ack)]

+1 looks good

review: Approve

[lp:~danilo/landscape-client/ci-check-and-deps]

973. By Данило Шеган on 2017-03-26

Use PYTHON3 var for python3 runs.

[🤖 Landscape Builder (landscape-builder)]

review: Abstain (executing tests)

[🤖 Landscape Builder (landscape-builder)]

Command: TRIAL_ARGS=-j4 make check
Result: Fail
Revno: 973
Branch: lp:~danilo/landscape-client/ci-check-and-deps
Jenkins: https://ci.lscape.net/job/latch-test-xenial/3775/

review: Needs Fixing (test results)

[🤖 Landscape Builder (landscape-builder)]

review: Abstain (executing tests)

[🤖 Landscape Builder (landscape-builder)]

Command: TRIAL_ARGS=-j4 make check
Result: Success
Revno: 973
Branch: lp:~danilo/landscape-client/ci-check-and-deps
Jenkins: https://ci.lscape.net/job/latch-test-xenial/3776/

review: Approve (test results)

[Adam Collard (adam-collard)]

+1

review: Approve

[Eric Snow (ericsnowcurrently)]

LGTM

review: Approve

[Eric Snow (ericsnowcurrently)]

FTR: Using "make ci-check": https://code.launchpad.net/~ericsnowcurrently/landscape/tarmac-ls-client-ci-check/+merge/321098

=== modified file 'Makefile'
--- Makefile	2017-03-23 08:10:14 +0000
+++ Makefile	2017-03-26 04:08:15 +0000
@@ -1,6 +1,7 @@
 PYDOCTOR ?= pydoctor
 TXT2MAN ?= txt2man
 PYTHON ?= python
+PYTHON3 ?= python3
 TRIAL_ARGS ?=
 TEST_COMMAND_PY2 = trial --unclean-warnings $(TRIAL_ARGS) landscape
 TEST_COMMAND_PY3 = trial3 --unclean-warnings $(TRIAL_ARGS) landscape
@@ -21,36 +22,63 @@
 TARBALL_VERSION := $(UPSTREAM_VERSION)+bzr$(BZR_REVNO)
 endif
 
+.PHONY: help
+help:  ## Print help about available targets
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: depends
+depends: depends2 depends3  ## Install py2 and py3 dependencies.
+
+.PHONY: depends2
+depends2:
+	sudo apt -y install python-twisted-core python-distutils-extra python-mock python-configobj python-passlib
+
+.PHONY: depends3
+depends3:
+	sudo apt -y install python3-twisted python3-distutils-extra python3-mock python3-configobj python3-passlib
+
 all: build
 
+.PHONY: build
+build: build2 build3   ## Build.
+
+.PHONY: build2
+build2:
+	$(PYTHON) setup.py build_ext -i
+
+.PHONY: build3
 build3:
-	python3 setup.py build_ext -i
-
-build:
-	$(PYTHON) setup.py build_ext -i
-
+	$(PYTHON3) setup.py build_ext -i
+
+.PHONY: check5
 check5:
 	-trial --unclean-warnings --reporter=summary landscape > _last_py2_res
 	-trial3 --unclean-warnings landscape
 	./display_py2_testresults
 
+.PHONY: check
+check: check2 check3-ready  ## Run all the tests.
+
+.PHONY: check2
+check2: build
+	LC_ALL=C $(TEST_COMMAND_PY2)
+
+.PHONY: check3
 check3: build3
 	LC_ALL=C $(TEST_COMMAND_PY3)
 
-check: check2	check3-ready
-
-check2: build
-	LC_ALL=C $(TEST_COMMAND_PY2)
-
-check3-ready: depends3 build3
+.PHONY: check3-ready
+check3-ready:  ## Run py3 tests for ported modules (listed in py3_ready_tests).
 	LC_ALL=C $(TEST_COMMAND_PY3_READY)
 
-depends3:
-	sudo apt -y install python3-twisted python3-distutils-extra python3-mock python3-configobj python3-passlib
+.PHONY: ci-check
+ci-check: depends build check  ## Install dependencies and run all the tests.
 
+.PHONY: lint
 lint:
 	bzr ls-lint
 
+.PHONY: pyflakes
 pyflakes:
 	-pyflakes `find landscape -name \*py`
 
@@ -140,4 +168,5 @@
 	cd sdist && md5sum landscape-client-$(TARBALL_VERSION).tar.gz > landscape-client-$(TARBALL_VERSION).tar.gz.md5
 	rm -rf sdist/landscape-client-$(TARBALL_VERSION)
 
-.PHONY: tags etags freshdata run freshrun package sourcepackage updateversion origtarball prepchangelog lint build build3 check check2 check3 check3-ready check5 depends3 releasetarball
+.PHONY: tags etags freshdata run freshrun package sourcepackage updateversion origtarball prepchangelog lint releasetarball
+.DEFAULT_GOAL := help