Merge lp:~benji/juju-gui/npm-cache into lp:juju-gui/experimental

[Benji York]

Add a Makefile npm-cache target to upload to LP

There is a parallel charm branch that uses the cache file to speed deploying
of branch builds.

https://codereview.appspot.com/8686048/

[Richard Harding (rharding)]

LGTM very cool use of make to push updates to the cache.

https://codereview.appspot.com/8686048/

[Gary Poster (gary)]

LGTM with responses--changes preferred, but I'm open to counterarguments
instead--to comments.

Thank you! This is cool to have.

Gary

https://codereview.appspot.com/8686048/diff/1/Makefile
File Makefile (right):

https://codereview.appspot.com/8686048/diff/1/Makefile#newcode98
Makefile:98: NPM_CACHE_VERSION=$(shell date +%s)# Seconds since the
epoch.
I would prefer to connect this to the revid, since we have shrinkwrap
now. Is there a reason to prefer the date?

https://codereview.appspot.com/8686048/diff/1/Makefile#newcode553
Makefile:553: $(MAKE) clean-all
We really have to do that even if you specify a different cache location
in an environment variable? Yuck. :-(

https://codereview.appspot.com/8686048/diff/1/Makefile#newcode591
Makefile:591: main-doc npm-cache npm-cache-file npm-cache-file-signature
prep prod \
I wish you had divided things up the way you describe here--or at least
the file and the npm-cache. Would you be willing to add those in? If
not, clean these out.

https://codereview.appspot.com/8686048/

[lp:~benji/juju-gui/npm-cache]

594. By Benji York on 2013-04-30

review changes

=== modified file 'Makefile'
--- Makefile	2013-04-15 14:54:29 +0000
+++ Makefile	2013-04-30 14:58:26 +0000
@@ -95,6 +95,9 @@
 RELEASE_NAME=juju-gui-$(RELEASE_VERSION)
 RELEASE_FILE=releases/$(RELEASE_NAME).tgz
 RELEASE_SIGNATURE=releases/$(RELEASE_NAME).asc
+NPM_CACHE_VERSION=$(BZR_REVNO)
+NPM_CACHE_FILE=$(CURDIR)/releases/npm-cache-$(NPM_CACHE_VERSION).tgz
+NPM_SIGNATURE=$(NPM_CACHE_FILE).asc
 # Is the branch being released a branch of trunk?
 ifndef BRANCH_IS_GOOD
 ifndef IS_TRUNK_BRANCH
@@ -199,6 +202,8 @@
 	mkdir -p build-shared/juju-ui/assets/images
 	cp app/assets/images/non-sprites/* build-shared/juju-ui/assets/images/
 
+install-npm-packages: $(NODE_TARGETS)
+
 $(NODE_TARGETS): package.json
 	npm install
 	# Keep all targets up to date, not just new/changed ones.
@@ -531,7 +536,46 @@
 	@echo "Please run this target without the NO_BZR flag defined if you"
 	@echo "wish to upload a release."
 	@echo
-	@echo "See the README for more information"
+	@echo "See docs/process.rst for more information"
+	@echo
+	@false
+endif
+
+$(NPM_SIGNATURE): $(NPM_CACHE_FILE)
+	gpg --armor --sign --detach-sig $(NPM_CACHE_FILE)
+
+npm-cache-file: $(NPM_CACHE_FILE)
+
+$(NPM_CACHE_FILE):
+	# We store the NPM cache file in the "releases" directory.  It is kind
+	# of like a release.
+	mkdir -p releases
+	# Remove any old cache or generated cache archives.
+	rm -f releases/npm-cache-*.tgz*
+	rm -rf temp-npm-cache
+	# We have to get rid of all installed NPM packages so they will be
+	# reinstalled into the (presently) empty cache.
+	$(MAKE) clean-all
+	# Install all the NPM packages, overriding the NPM cache.
+	$(MAKE) npm_config_cache=temp-npm-cache install-npm-packages
+	(cd temp-npm-cache && tar czvf $(NPM_CACHE_FILE) .)
+	rm -rf temp-npm-cache
+
+npm-cache: $(NPM_CACHE_FILE) $(NPM_SIGNATURE)
+ifdef BRANCH_IS_GOOD
+	python2 upload_release.py juju-gui npm-cache $(NPM_CACHE_VERSION) \
+	    $(NPM_CACHE_FILE) $(LAUNCHPAD_API_ROOT)
+else
+	@echo "**************************************************************"
+	@echo "**************** NPM CACHE GENERATION FAILED *****************"
+	@echo "**************************************************************"
+	@echo
+	@echo "To create and upload an NPM cache file to Launchpad you must"
+	@echo "be in a branch of lp:juju-gui without uncommitted/unpushed"
+	@echo "changes, or you must override one of the pertinent variable "
+	@echo "names to force an upload."
+	@echo
+	@echo "See docs/process.rst for more information"
 	@echo
 	@false
 endif
@@ -550,8 +594,9 @@
 # targets are alphabetically sorted, they like it that way :-)
 .PHONY: appcache-force appcache-touch beautify build build-files \
 	build-devel clean clean-all clean-deps clean-docs code-doc debug \
-	devel docs dist gjslint help jshint lint main-doc prep prod recess \
-	server spritegen test test-debug test-prep test-prod undocumented \
-	view-code-doc view-docs view-main-doc yuidoc-lint
+	devel docs dist gjslint help install-npm-packages jshint lint \
+	main-doc npm-cache npm-cache-file prep prod recess server spritegen \
+	test test-debug test-prep test-prod undocumented view-code-doc \
+	view-docs view-main-doc yuidoc-lint
 
 .DEFAULT_GOAL := all

=== modified file 'docs/process.rst'
--- docs/process.rst	2013-04-10 00:36:48 +0000
+++ docs/process.rst	2013-04-30 14:58:26 +0000
@@ -254,6 +254,26 @@
 
 You are done!
 
+Making NPM Cache Files
+======================
+
+We use archives of NPM caches to speed up deployment of non-release
+branches of the Juju GUI via charm.  This section describes how to
+update the cache file stored in Launchpad.
+
+Checklist for Uploading a Cache File
+------------------------------------
+
+- Get a clean branch of the trunk:: ``bzr branch lp:juju-gui``.
+- If you are using a pre-existing branch, make sure it is up-to-date:
+  ``bzr pull``.
+- Run the tests and verify they pass: ``make test-prod`` and then
+  ``make test-debug``.
+- Create the tarball: ``PROD=1 make npm-cache``.  The cache
+  file (and a signature thereof) will be created and uploaded to
+  Launchpad.  If you wish to upload to staging.launchpad.net instead,
+  omit "PROD=1".
+
 Checklist for Running a Daily Meeting
 =====================================