Merge lp:~free.ekanayaka/fake-juju/simpler-makefile into lp:~landscape/fake-juju/trunk-old

[Free Ekanayaka]

Simplify the logic of the top-level Makefile by extracting to a separate common/Makefile the bits that are version-specific.

The result is that both Makefile and common/Makefile should be now easier to read, there's some ~50 lines of saving (since there's no duplication anymore between single-version and multi-version targets) and you can use completion to build specific versions, e.g.:

make -C 2.<type tab> build

or you can just:

cd 2.<tab>
make

and work locally inside a version.

Patches are also inside the version directory instead of in a the separate patches/ tree (there are some mechanical changes because the diffs are now relative to the version directory).

[🤖 Landscape Builder (landscape-builder)]

review: Abstain (executing tests)

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Fail
Revno: 60
Branch: lp:~free.ekanayaka/fake-juju/simpler-makefile
Jenkins: https://ci.lscape.net/job/latch-test-xenial/1023/

review: Needs Fixing (test results)

[lp:~free.ekanayaka/fake-juju/simpler-makefile]

61. By Free Ekanayaka on 2016-11-28

Fix target dependency

[🤖 Landscape Builder (landscape-builder)]

review: Abstain (executing tests)

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Success
Revno: 61
Branch: lp:~free.ekanayaka/fake-juju/simpler-makefile
Jenkins: https://ci.lscape.net/job/latch-test-xenial/1024/

review: Approve (test results)

[lp:~free.ekanayaka/fake-juju/simpler-makefile]

62. By Free Ekanayaka on 2016-11-28

Add missing dh-python build-dependency

[🤖 Landscape Builder (landscape-builder)]

review: Abstain (executing tests)

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Success
Revno: 62
Branch: lp:~free.ekanayaka/fake-juju/simpler-makefile
Jenkins: https://ci.lscape.net/job/latch-test-xenial/1025/

review: Approve (test results)

[Alberto Donato (ack)]

+1 looks good.

As discussed on IRC, I'd replace the Makefile symlink with an explicit import (and perhaps rename common/Makefile to something like common/makefile.mk since it's not supposed to be called from common)
If in the future we'll need to extend the makefile for a version, we don't risk editing the common one.

Also, please update the README about "adding a new version" to reflect changes.

review: Approve

[lp:~free.ekanayaka/fake-juju/simpler-makefile]

63. By Free Ekanayaka on 2016-11-28

Replace symlinks with actual files

[Free Ekanayaka (free.ekanayaka)]

> +1 looks good.
>
> As discussed on IRC, I'd replace the Makefile symlink with an explicit import
> (and perhaps rename common/Makefile to something like common/makefile.mk since
> it's not supposed to be called from common)
> If in the future we'll need to extend the makefile for a version, we don't
> risk editing the common one.
>
> Also, please update the README about "adding a new version" to reflect
> changes.

Fixed.

[lp:~free.ekanayaka/fake-juju/simpler-makefile]

64. By Free Ekanayaka on 2016-11-28

Address review comments

[🤖 Landscape Builder (landscape-builder)]

review: Abstain (executing tests)

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Fail
Revno: 63
Branch: lp:~free.ekanayaka/fake-juju/simpler-makefile
Jenkins: https://ci.lscape.net/job/latch-test-xenial/1026/

review: Needs Fixing (test results)

[🤖 Landscape Builder (landscape-builder)]

review: Abstain (executing tests)

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Success
Revno: 64
Branch: lp:~free.ekanayaka/fake-juju/simpler-makefile
Jenkins: https://ci.lscape.net/job/latch-test-xenial/1027/

review: Approve (test results)

=== modified file '.bzrignore'
--- .bzrignore	2015-09-22 02:46:32 +0000
+++ .bzrignore	2016-11-28 14:11:25 +0000
@@ -1,2 +1,3 @@
 juju-core_*.tar.gz
 */src
+__pycache__

=== added file '1.25.6/Makefile'
--- 1.25.6/Makefile	1970-01-01 00:00:00 +0000
+++ 1.25.6/Makefile	2016-11-28 14:11:25 +0000
@@ -0,0 +1,1 @@
+include ../common/makefile.mk

=== renamed file 'patches/juju-core_1.25.6.patch' => '1.25.6/juju-core.patch'
--- patches/juju-core_1.25.6.patch	2016-07-28 14:44:34 +0000
+++ 1.25.6/juju-core.patch	2016-11-28 14:11:25 +0000
@@ -1,5 +1,5 @@
---- 1.25.6/src/github.com/juju/juju/testcharms/charm.go.orig	2015-06-24 12:02:02.746416146 +0200
-+++ 1.25.6/src/github.com/juju/juju/testcharms/charm.go	2015-06-24 12:03:49.810418650 +0200
+--- .unpatched-clean/src/github.com/juju/juju/testcharms/charm.go.orig	2015-06-24 12:02:02.746416146 +0200
++++ src/github.com/juju/juju/testcharms/charm.go	2015-06-24 12:03:49.810418650 +0200
 @@ -10,4 +10,6 @@
  )
  
@@ -9,8 +9,8 @@
 +//var Repo = testing.NewRepo("charm-repo", "quantal")
 +var Repo = &testing.Repo{}
 
---- 1.25.6/src/github.com/juju/juju/provider/dummy/environs.go.orig	2015-07-06 15:01:14.200568258 +0200
-+++ 1.25.6/src/github.com/juju/juju/provider/dummy/environs.go	2015-07-06 15:18:32.648549661 +0200
+--- .unpatched-clean/src/github.com/juju/juju/provider/dummy/environs.go.orig	2015-07-06 15:01:14.200568258 +0200
++++ src/github.com/juju/juju/provider/dummy/environs.go	2015-07-06 15:18:32.648549661 +0200
 @@ -690,9 +690,9 @@
  
  // PrecheckInstance is specified in the state.Prechecker interface.
@@ -24,8 +24,8 @@
  	return nil
  }
  
---- 1.25.6/src/github.com/juju/juju/testing/cert.go	2016-03-18 09:25:34 +0000
-+++ 1.25.6/src/github.com/juju/juju/testing/cert.go	2016-03-18 09:26:04 +0000
+--- .unpatched-clean/src/github.com/juju/juju/testing/cert.go	2016-03-18 09:25:34 +0000
++++ src/github.com/juju/juju/testing/cert.go	2016-03-18 09:26:04 +0000
 @@ -52,7 +52,7 @@
  }
  

=== added file '2.0.0/Makefile'
--- 2.0.0/Makefile	1970-01-01 00:00:00 +0000
+++ 2.0.0/Makefile	2016-11-28 14:11:25 +0000
@@ -0,0 +1,1 @@
+include ../common/makefile.mk

=== renamed file 'patches/juju-core_2.0.0.patch' => '2.0.0/juju-core.patch'
--- patches/juju-core_2.0.0.patch	2016-11-21 14:18:56 +0000
+++ 2.0.0/juju-core.patch	2016-11-28 14:11:25 +0000
@@ -1,6 +1,6 @@
-diff -U 3 -r --no-dereference ./2.0.0/.unpacked-clean/src/github.com/juju/juju/apiserver/charms.go ./2.0.0/src/github.com/juju/juju/apiserver/charms.go
---- ./2.0.0/.unpacked-clean/src/github.com/juju/juju/apiserver/charms.go	2016-10-13 14:31:49.000000000 +0000
-+++ ./2.0.0/src/github.com/juju/juju/apiserver/charms.go	2016-11-03 15:55:24.773085965 +0000
+diff -U 3 -r --no-dereference ./.unpacked-clean/github.com/juju/juju/apiserver/charms.go ./src/github.com/juju/juju/apiserver/charms.go
+--- ./.unpacked-clean/github.com/juju/juju/apiserver/charms.go	2016-10-13 14:31:49.000000000 +0000
++++ ./src/github.com/juju/juju/apiserver/charms.go	2016-11-03 15:55:24.773085965 +0000
 @@ -284,7 +284,8 @@
  		if isImporting, err := modelIsImporting(st); err != nil {
  			return nil, errors.Trace(err)
@@ -11,10 +11,10 @@
  		}
  
  		// If a revision argument is provided, it takes precedence
-Only in ./2.0.0/src/github.com/juju/juju/apiserver: charms.go~
-diff -U 3 -r --no-dereference ./2.0.0/.unpacked-clean/src/github.com/juju/juju/provider/dummy/environs.go ./2.0.0/src/github.com/juju/juju/provider/dummy/environs.go
---- ./2.0.0/.unpacked-clean/src/github.com/juju/juju/provider/dummy/environs.go	2016-10-13 14:31:49.000000000 +0000
-+++ ./2.0.0/src/github.com/juju/juju/provider/dummy/environs.go	2016-11-03 13:52:34.827516374 +0000
+Only in ./src/github.com/juju/juju/apiserver: charms.go~
+diff -U 3 -r --no-dereference ./.unpacked-clean/github.com/juju/juju/provider/dummy/environs.go ./src/github.com/juju/juju/provider/dummy/environs.go
+--- ./.unpacked-clean/github.com/juju/juju/provider/dummy/environs.go	2016-10-13 14:31:49.000000000 +0000
++++ ./src/github.com/juju/juju/provider/dummy/environs.go	2016-11-03 13:52:34.827516374 +0000
 @@ -643,9 +643,9 @@
  
  // PrecheckInstance is specified in the state.Prechecker interface.
@@ -28,9 +28,9 @@
  	return nil
  }
  
-diff -U 3 -r --no-dereference ./2.0.0/.unpacked-clean/src/github.com/juju/juju/testcharms/charm.go ./2.0.0/src/github.com/juju/juju/testcharms/charm.go
---- ./2.0.0/.unpacked-clean/src/github.com/juju/juju/testcharms/charm.go	2016-10-13 14:31:49.000000000 +0000
-+++ ./2.0.0/src/github.com/juju/juju/testcharms/charm.go	2016-11-03 13:52:34.827516374 +0000
+diff -U 3 -r --no-dereference ./.unpacked-clean/github.com/juju/juju/testcharms/charm.go ./src/github.com/juju/juju/testcharms/charm.go
+--- ./.unpacked-clean/github.com/juju/juju/testcharms/charm.go	2016-10-13 14:31:49.000000000 +0000
++++ ./src/github.com/juju/juju/testcharms/charm.go	2016-11-03 13:52:34.827516374 +0000
 @@ -17,7 +17,9 @@
  )
  
@@ -42,9 +42,9 @@
  
  // UploadCharmWithMeta pushes a new charm to the charmstore.
  // The uploaded charm takes the supplied charmURL with metadata.yaml and metrics.yaml
-diff -U 3 -r --no-dereference ./2.0.0/.unpacked-clean/src/github.com/juju/juju/testing/cert.go ./2.0.0/src/github.com/juju/juju/testing/cert.go
---- ./2.0.0/.unpacked-clean/src/github.com/juju/juju/testing/cert.go	2016-10-13 14:31:49.000000000 +0000
-+++ ./2.0.0/src/github.com/juju/juju/testing/cert.go	2016-11-03 13:52:34.827516374 +0000
+diff -U 3 -r --no-dereference ./.unpacked-clean/github.com/juju/juju/testing/cert.go ./src/github.com/juju/juju/testing/cert.go
+--- ./.unpacked-clean/github.com/juju/juju/testing/cert.go	2016-10-13 14:31:49.000000000 +0000
++++ ./src/github.com/juju/juju/testing/cert.go	2016-11-03 13:52:34.827516374 +0000
 @@ -52,7 +52,7 @@
  }
  
@@ -63,9 +63,9 @@
  	var hostnames []string
  	srvCert, srvKey, err := cert.NewServer(CACert, CAKey, time.Now().AddDate(10, 0, 0), hostnames)
  	if err != nil {
-diff -U 3 -r --no-dereference ./2.0.0/.unpacked-clean/src/gopkg.in/mgo.v2/bson/json.go ./2.0.0/src/gopkg.in/mgo.v2/bson/json.go
---- ./2.0.0/.unpacked-clean/src/gopkg.in/mgo.v2/bson/json.go	2016-10-13 09:32:16.000000000 -0500
-+++ ./2.0.0/src/gopkg.in/mgo.v2/bson/json.go	2016-11-21 07:55:31.696036251 -0600
+diff -U 3 -r --no-dereference ./.unpacked-clean/gopkg.in/mgo.v2/bson/json.go ./src/gopkg.in/mgo.v2/bson/json.go
+--- ./.unpacked-clean/gopkg.in/mgo.v2/bson/json.go	2016-10-13 09:32:16.000000000 -0500
++++ ./src/gopkg.in/mgo.v2/bson/json.go	2016-11-21 07:55:31.696036251 -0600
 @@ -317,7 +317,8 @@
  func jencInt(v interface{}) ([]byte, error) {
  	n := v.(int)

=== modified file 'Makefile'
--- Makefile	2016-11-28 07:08:52 +0000
+++ Makefile	2016-11-28 14:11:25 +0000
@@ -1,140 +1,38 @@
-
-ifdef JUJU_VERSIONS
-# If someone explicitly set JUJU_VERSIONS then we ignore JUJU_VERSION.
-JUJU_VERSION =
-endif
-
-
-ifdef JUJU_VERSION  #############################
-# for one version
-
-GO_VERSION = 1.6
-JUJU_TARBALL = juju-core_$(JUJU_VERSION).tar.gz
-JUJU_PATCH = patches/juju-core_$(JUJU_VERSION).patch
-GO_PATH = $(JUJU_VERSION)
-JUJU_SRC = $(GO_PATH)/src
-JUJU_UNPACKED_CLEAN = $(JUJU_VERSION)/.unpacked-clean
-INSTALLDIR = $(DESTDIR)/usr/bin
-INSTALLED = $(INSTALLDIR)/fake-juju-$(JUJU_VERSION)
-
-$(JUJU_VERSION)/$(JUJU_VERSION): $(JUJU_VERSION)/fake-juju.go $(JUJU_PATCH)
-	case $(JUJU_VERSION) in \
-		1.*) $(MAKE) build-common PATH=$$PATH JUJU_VERSION=$(JUJU_VERSION) ;;\
-		2.*) $(MAKE) build-common PATH=/usr/lib/go-$(GO_VERSION)/bin:$$PATH JUJU_VERSION=$(JUJU_VERSION) ;;\
-	esac
-
-juju-core_%.tar.gz:
-	case $* in \
-		1.*) PROJECT="juju-core" ;;\
-		2.*) PROJECT="juju" ;;\
-	esac;\
-	wget https://launchpad.net/$$PROJECT/$(shell (echo $* | cut -f 1 -d - | cut -f 1,2 -d .))/$*/+download/$@
-
-$(JUJU_UNPACKED_CLEAN): $(JUJU_TARBALL)
-	mkdir -p $(JUJU_UNPACKED_CLEAN)
-	tar -C $(JUJU_UNPACKED_CLEAN) --strip=1 -z -xf $(JUJU_TARBALL)
-
-.PHONY: update-patch
-update-patch: $(JUJU_SRC) $(JUJU_UNPACKED_CLEAN)
-	diff -U 3 -r --no-dereference ./$(JUJU_UNPACKED_CLEAN)/src ./$(JUJU_SRC) > $(JUJU_PATCH); \
-	echo " -- diff exited with $$? --"
-	rm -rf $(JUJU_UNPACKED_CLEAN)
-
-.PHONY: build
-build: $(JUJU_VERSION)/$(JUJU_VERSION)
-
-.PHONY: build-common
-build-common: $(JUJU_TARBALL) $(JUJU_PATCH)
-	rm -rf $(JUJU_SRC)  # Go doesn't play nice with existing files.
-	tar -C $(JUJU_VERSION) --strip=1 -z -xf $(JUJU_TARBALL)
-	patch -p0 < $(JUJU_PATCH)
-	cd $(JUJU_VERSION) && GOPATH=$(shell pwd)/$(GO_PATH) PATH=$(PATH) go build
-
-.PHONY: install
-install: $(JUJU_VERSION)/$(JUJU_VERSION)
-	install -D $(JUJU_VERSION)/$(JUJU_VERSION) $(INSTALLED)
-
-.PHONY: install-dev
-install-dev: $(JUJU_VERSION)/$(JUJU_VERSION)
-	mkdir -p $(INSTALLDIR)
-	ln -s --backup=existing --suffix .orig $(shell pwd)/$(JUJU_VERSION)/$(JUJU_VERSION) $(INSTALLED)
-
-.PHONY: clean
-clean:
-	rm -f $(JUJU_TARBALL)
-	rm -rf $(JUJU_SRC)
-	rm -f $(JUJU_VERSION)/$(JUJU_VERSION)
-	rm -rf _trial_temp
-
-.PHONY: test
-test: $(JUJU_VERSION)/$(JUJU_VERSION) py-test
-	env JUJU_VERSION=$(JUJU_VERSION) python3 -m unittest tests.test_fake
-
-
-else  ###########################################
-# for all versions
-
-ifndef JUJU_VERSIONS
-JUJU1_VERSIONS = 1.25.6
-JUJU2_VERSIONS = 2.0.0
-JUJU_VERSIONS = $(JUJU1_VERSIONS) $(JUJU2_VERSIONS)
-endif
-BUILT_VERSIONS = $(foreach version,$(JUJU_VERSIONS),$(version)/$(version))
-
-$(BUILT_VERSIONS):
-	for VERSION in $(JUJU_VERSIONS); do \
-	    $(MAKE) build JUJU_VERSION=$$VERSION; \
-	done
-
-.PHONY: update-patch
-update-patch:
-	for VERSION in $(JUJU_VERSIONS); do \
-	    $(MAKE) update-patch JUJU_VERSION=$$VERSION; \
-	done
-
-.PHONY: build
-build: $(BUILT_VERSIONS)
+JUJU_VERSIONS = 1.25.6 2.0.0
+
+JUJUCLIENT_DOWNLOADS = $(shell pwd)/tests/jujuclient-archive
+JUJUCLIENT_REQ = $(JUJUCLIENT_DOWNLOADS)/requirements
+
+PYTHON = python
+
+.PHONY: build
+build:
+	for VERSION in $(JUJU_VERSIONS); do \
+	    $(MAKE) -C $$VERSION build; \
+	done
 
 .PHONY: install
 install:
 	for VERSION in $(JUJU_VERSIONS); do \
-	    $(MAKE) install JUJU_VERSION=$$VERSION; \
-	done
-
-.PHONY: install-dev
-install-dev:
-	for VERSION in $(JUJU_VERSIONS); do \
-	    $(MAKE) install-dev JUJU_VERSION=$$VERSION; \
+	    $(MAKE) -C $$VERSION install; \
 	done
 
 .PHONY: clean
 clean:
 	for VERSION in $(JUJU_VERSIONS) ; do \
-		$(MAKE) clean JUJU_VERSION=$$VERSION; \
+	    $(MAKE) -C $$VERSION clean; \
 	done	
 
-.PHONY: test
-# Use xargs here so that we don't throw away the return codes, and correctly fail if any of the tests fail
-test: $(BUILT_VERSIONS)
-	#@echo -n $(JUJU_VERSIONS) | xargs -t -d' ' -I {} env JUJU_VERSION={} python3 -m unittest tests.test_fake
-	@echo -n $(JUJU_VERSIONS) | xargs -t -d' ' -I {} $(MAKE) test JUJU_VERSION={}
-
-
-endif  ##########################################
-
-PYTHON = python
+.PHONY: test py-test
+test: build
+	# Use xargs here so that we don't throw away the return codes, and
+	# correctly fail if any of the tests fail
+	@echo -n $(JUJU_VERSIONS) | xargs -t -d' ' -I {} $(MAKE) -C {} test JUJU_VERSION={}
 
 .PHONY: py-test
 py-test:
 	$(PYTHON) -m unittest discover -t python -s python/fakejuju
 
-
-#################################################
-# other targets
-
-JUJUCLIENT_DOWNLOADS = $(shell pwd)/tests/jujuclient-archive
-JUJUCLIENT_REQ = $(JUJUCLIENT_DOWNLOADS)/requirements
-
 .PHONY: ci-test
 ci-test:
 	sudo apt-get -y install --force-yes \

=== modified file 'README'
--- README	2016-11-18 12:49:28 +0000
+++ README	2016-11-28 14:11:25 +0000
@@ -8,8 +8,8 @@
 ---------------------
 
 1) Edit the Makefile and add the desired version on the very first line.
-2) Create a new version subdirectory, copy fake_juju.go there.
-3) Make sure there is a corresponding .patch file in the patches/ subdirectory.
+2) Create a new version subdirectory, copy fake_juju.go and other files
+   there (e.g. Makefile and juju-core.patch)
 
 Dependencies
 ------------

=== added directory 'common'
=== added file 'common/makefile.mk'
--- common/makefile.mk	1970-01-01 00:00:00 +0000
+++ common/makefile.mk	2016-11-28 14:11:25 +0000
@@ -0,0 +1,57 @@
+GO_VERSION = 1.6
+GO_PATH = $(CURDIR)
+
+JUJU_VERSION = $(shell basename $(CURDIR))
+JUJU_MAJOR = $(shell echo $(JUJU_VERSION) | cut -f1 -d.)
+JUJU_MAJOR_MINOR = $(shell (echo $(JUJU_VERSION) | cut -f 1,2 -d .))
+JUJU_PATCH = juju-core.patch
+JUJU_SRC = $(GO_PATH)/src
+JUJU_UNPACKED_CLEAN = $(GO_PATH)/.unpacked-clean
+JUJU_INSTALLDIR = $(DESTDIR)/usr/bin
+JUJU_INSTALLED = $(JUJU_INSTALLDIR)/fake-juju-$(JUJU_VERSION)
+
+ifeq (1, $(JUJU_MAJOR))
+  JUJU_PROJECT=juju-core
+else
+  JUJU_PROJECT=juju
+endif
+
+JUJU_TARBALL = juju-core_$(JUJU_VERSION).tar.gz
+JUJU_TARBALL_URL=https://launchpad.net/$(JUJU_PROJECT)/$(JUJU_MAJOR_MINOR)/$(JUJU_VERSION)/+download/$(JUJU_TARBALL)
+
+.PHONY: build
+build: $(JUJU_TARBALL) $(JUJU_PATCH)
+	rm -rf $(JUJU_SRC)  # Go doesn't play nice with existing files.
+	tar --strip=1 -z -xf $(JUJU_TARBALL)
+	patch -p0 < $(JUJU_PATCH)
+	GOPATH=$(GO_PATH) PATH=$(PATH) go build
+
+.PHONY: test
+test: $(JUJU_VERSION)
+	cd .. && JUJU_VERSION=$(JUJU_VERSION) python3 -m unittest tests.test_fake
+
+.PHONY: install
+install: $(JUJU_VERSION)
+	install -D $(JUJU_VERSION) $(JUJU_INSTALLED)
+
+.PHONY: clean
+clean:
+	rm -f $(JUJU_TARBALL)
+	rm -rf $(JUJU_SRC)
+	rm -f $(JUJU_VERSION)
+
+.PHONY: update-patch
+update-patch: $(JUJU_SRC) $(JUJU_UNPACKED_CLEAN)
+	diff -U 3 -r --no-dereference $(JUJU_UNPACKED_CLEAN) $(JUJU_SRC) > $(JUJU_PATCH); \
+		echo " -- diff exited with $$? --"
+	rm -rf $(JUJU_UNPACKED_CLEAN)
+
+$(JUJU_TARBALL):
+	wget $(JUJU_TARBALL_URL)
+
+$(JUJU_UNPACKED_CLEAN): $(JUJU_TARBALL)
+	mkdir -p $(JUJU_UNPACKED_CLEAN)
+	tar -C $(JUJU_UNPACKED_CLEAN) --strip=2 -z -xf $(JUJU_TARBALL)
+
+$(JUJU_VERSION):
+	GOPATH=$(GO_PATH) PATH=$(PATH) go build

=== modified file 'debian/control'
--- debian/control	2016-10-24 20:38:25 +0000
+++ debian/control	2016-11-28 14:11:25 +0000
@@ -4,6 +4,7 @@
 Priority: optional
 Standards-Version: 3.9.2
 Build-Depends: debhelper (>= 9),
+               dh-python,
                golang,
                golang-1.6,
                python-all (>= 2.6.6-3),

=== removed directory 'patches'
=== removed directory 'patches/src'