Merge lp:~benji/charmworld/makefile-tweaks into lp:~juju-jitsu/charmworld/trunk

[Benji York]

Several tweaks to the Makefile:

- added a debugging tool at the top (normally commented out)
- removed some single-use and tiny constants in favor of less indirection
- added "canaries" to several rules so they are only run when needed
- wrapped long lines
- added a dependency on requirements.txt so that changes will trigger a
  re-install of Python dependencies
- made a test script (bin/test) so we don't have to remember the
  spelling to invoke the tests outside of the Makefile (preserving the
  existing make targets for continuity, especially for CI)
- removed some unnecessary phoney entries
- added "install" as the default goal
- removed unneeded indirection in phoney definition

As a result of the above you can run just "make" in a new checkout and
everything will be built. If "make" is run again, no work will be
done. There is also now a bin/test script that is friendlier than
having to remember the spelling to invoke the test runner (directly or
through the Makefile, but that still works too).

Several tweaks to the Makefile:

- added a debugging tool at the top (normally commented out)
- removed some single-use and tiny constants in favor of less indirection
- added "canaries" to several rules so they are only run when needed
- wrapped long lines
- added a dependency on requirements.txt so that changes will trigger a
  re-install of Python dependencies
- made a test script (bin/test) so we don't have to remember the
  spelling to invoke the tests outside of the Makefile (preserving the
  existing make targets for continuity, especially for CI)
- removed some unnecessary phoney entries
- added "install" as the default goal
- removed unneeded indirection in phoney definition

As a result of the above you can run just "make" in a new checkout and
everything will be built. If "make" is run again, no work will be
done. There is also now a bin/test script that is friendlier than
having to remember the spelling to invoke the test runner (directly or
through the Makefile, but that still works too).

[Brad Crittenden (bac)]

Thanks, this behaves much nicer and with bin/test i can get rid of my ./tr.sh script! :)

Do you know how the charmworld charm invokes make for production? I see 'install' depends on 'develop' ... is that appropriate for the production environment?

review: Approve (code)

[Benji York (benji)]

> Do you know how the charmworld charm invokes make for production?

That's a good question, let me look...

> I see
> 'install' depends on 'develop' ... is that appropriate for the production
> environment?

Yep, the charm uses "make install" which previously depended on charmworld.egg-info, but that was replaced with "deploy", so we should be good there.

[Charmworld Lander (charmworld-lander)]

No commit message specified.

=== modified file 'Makefile'
--- Makefile	2013-08-05 20:16:49 +0000
+++ Makefile	2013-09-05 13:40:44 +0000
@@ -1,11 +1,15 @@
+# Makefile debugging hack: uncomment the two lines below and make will tell you
+# more about what is happening.  The output generated is of the form
+# "FILE:LINE [TARGET (DEPENDENCIES) (NEWER)]" where DEPENDENCIES are all the
+# things TARGET depends on and NEWER are all the files that are newer than
+# TARGET.  DEPENDENCIES will be colored green and NEWER will be blue.
+#OLD_SHELL := $(SHELL)
+#SHELL = $(warning [$@ ($^) ($?) ])$(OLD_SHELL)
+
 WD := $(shell pwd)
-PY := bin/python
-FLAKE8 := bin/flake8
-PIP := bin/pip
 CACHE := download-cache/dist
 CSS_PATH := charmworld/static/css
 LESSC := node_modules/less/bin/lessc
-NOSE := INI="test.ini" bin/nosetests
 PSERVE := bin/pserve
 SYSTEM_DEPS := \
 	build-essential bzr charm-tools libyaml-dev python-dev python-virtualenv\
@@ -36,27 +40,27 @@
 # INSTALL targets
 # ###############
 
-install: charmworld.egg-info
-
-venv: bin/python
+bin/pip:
+	virtualenv .
 
 bin/python:
 	virtualenv .
 
-# Made PHONY so that setup.py develop is rerun to include new entry point for
-# mongo sessions.
-.PHONY: charmworld.egg-info
-charmworld.egg-info: deps bin/python $(INI) charmworld/static/css/theme.css
-	$(PY) setup.py develop
-
-bin/es-update: $(PY)
-	$(PY) setup.py develop
-
-es_update:
-	bin/es-update
+# We use a "canary" file to tell us if the charmworld package has been
+# installed in "develop" mode.
+DEVELOP_CANARY := lib/__develop_canary
+develop: $(DEVELOP_CANARY) 
+$(DEVELOP_CANARY): | bin/python
+	bin/python setup.py develop
+	touch $(DEVELOP_CANARY)
+
+install: deps bin/python bin/pip $(INI) develop css bin/test
+
+bin/es-update: bin/python
+	bin/python setup.py develop
 
 clean_venv:
-	- rm -r bin include lib local
+	rm -rf bin include lib local
 
 css: charmworld/static/css/theme.css
 charmworld/static/css/theme.css: $(LESSC) $(CSS_PATH)/theme.less $(CSS_PATH)/variables.less
@@ -66,7 +70,8 @@
 	sudo add-apt-repository -y ppa:juju/pkgs
 	sudo add-apt-repository -y ppa:ce-orange-squad/experimental
 	sudo apt-get update
-	sudo apt-get install -y $(SYSTEM_DEPS) mongodb-server elasticsearch-java;
+	sudo apt-get install -y $(SYSTEM_DEPS) mongodb-server \
+	    elasticsearch-java;
 	# On quantal need to provide node bin for deps to work.
 	if test ! -e /usr/bin/node; \
 	    then - sudo ln -s /usr/bin/nodejs /usr/bin/node; \
@@ -75,33 +80,54 @@
 deploy_sysdeps:
 	sudo apt-get install -y $(SYSTEM_DEPS) mongodb-clients;
 
-deps: venv
+# We use a "canary" file to tell us if the Python packages have been installed.
+PYTHON_PACKAGE_CANARY := lib/python2.7/site-packages/___canary
+python-deps: $(PYTHON_PACKAGE_CANARY)
+$(PYTHON_PACKAGE_CANARY): requirements.txt | bin/pip
 	if test -d download-cache; \
-		then bzr up download-cache; \
-		else bzr checkout lp:~juju-jitsu/charmworld/download-cache; \
+	    then : bzr up download-cache; \
+	    else bzr checkout lp:~juju-jitsu/charmworld/download-cache; \
 	fi
-	$(PIP) install --no-index --no-dependencies --find-links file:///$(WD)/$(CACHE) -r requirements.txt
+	bin/pip install --no-index --no-dependencies --find-links \
+	    file:///$(WD)/$(CACHE) -r requirements.txt
+	touch $(PYTHON_PACKAGE_CANARY)
+
+# We use a "canary" file to tell us if the Node packages have been installed.
+NODE_CANARY := node_modules/___canary
+node-deps: $(NODE_CANARY)
+$(NODE_CANARY):
 	npm install download-cache/npm/ycssmin.tar.gz
 	npm install download-cache/npm/less.tar.gz
-	- rm -r build
-	- rm -r share;
+	rm -rf build
+	rm -rf share
+	touch $(NODE_CANARY)
+
+deps: python-deps node-deps
+
 
 # ###################
 # Development helpers
 # ###################
 
-test: test.ini $(INI) bin/nosetests
-	$(NOSE) charmworld
-
-testid: test.ini bin/nosetests
+bin/nosetests: python-deps
+
+bin/test: | test.ini $(INI) bin/nosetests
+	echo "#!/bin/sh" > $@
+	echo INI="test.ini" bin/nosetests '$$@' >> $@
+	chmod +x $@
+
+test: bin/test
+	bin/test
+
+testid: bin/test
 	# Run specific nose id tests.
 	# To set up the index you must run `make testid` once to completion to
 	# setup the index.  Then you can run a group of tests like:
 	# Call with `ID="3 5" make testid`
-	$(NOSE) -v -s -x --with-id $(ID) charmworld
+	bin/test -v -s -x --with-id $(ID) charmworld
 
-testdebug: test.ini bin/nosetests
-	$(NOSE) --with-id --pdb --pdb-failures charmworld
+testdebug: bin/test
+	bin/test --with-id --pdb --pdb-failures charmworld
 
 check: clear_ini clean sysdeps install testid
 
@@ -124,7 +150,8 @@
 doc-upload: doc
 	scp -r docs/_build/html/* people.canonical.com:/home/rharding/public_html/charmworld
 
-run: $(INI) charmworld/static/css/theme.css es_update
+run: $(INI) charmworld/static/css/theme.css bin/es_update
+	bin/es-update
 	$(PSERVE) --reload --monitor-restart $(INI)
 
 start_supervisor:
@@ -146,26 +173,28 @@
 	bin/supervisorctl -c charmworld/jobs/supervisord.conf status ingest
 
 clean:
-	find . -type f -name '*.py[co]' -print0 | xargs -r0 $(RM)
-	find . -type f -name '*~' -print0 | xargs -r0 $(RM)
+	find . -type f -name '*.py[co]' -print0 | xargs -r0 rm -rf
+	find . -type f -name '*~' -print0 | xargs -r0 rm -rf
+	rm -rf node_modules
 
 clear_ini:
-	- rm -f charmworld.ini
+	rm -f charmworld.ini
 
 distclean: clean clean_venv
-	$(RM) tags TAGS .installed.cfg
+	rm -rf tags TAGS .installed.cfg lib
+
 
 
 #
 # Phony stuff.
 #
-define phony_targets
+define phony
   check
   css
   clean_venv
   clean
-  deploy
   deps
+  develop
   distclean
   doc
   doc-open
@@ -176,18 +205,13 @@
   tags
   test
   testid
-  venv
-  start_supervisord
-  stop_supervisord
   start_worker
   stop_worker
   worker_status
 endef
 
-define phony
-  $(phony_targets)
-endef
-
 phony := $(sort $(strip $(phony)))
 
 .PHONY: $(phony)
+
+.DEFAULT_GOAL := install