build: Use git submodules for Fuel git repos

This change reworks support for cloning (fetching) and patching all
Fuel components (fuel-library ... fuel-ui, see [1] for full list),
both outside the ISO build process (for development purposes, like
testing OPNFV patches apply cleanly to each component), and during
the ISO build.

The implementation relies heavily on git submodules and patches,
so backporting pending upstream gerrit changes, as well as adding new
out-of-upstream-tree patches, should be trivial.

Also, since without tracking remotes the repos rarely change, leverage
the in-place OPNFV build caching mechanism to drastically reduce the
number of git clones during each build.

The mechanism is detailed more in-depth in the JIRA ticket [3], and
it's merely a rehash of the submodule handling in Armband, implemented
initially by Stanislaw Kardach <stanislaw.kardach@cavium.com>.

Pros (+ new features):
 - OPNFV patches for Fuel components can be applied (imported) or
   developed (exported) outside of the ISO build process;
 - git repo caching reduces the number of external pulls;
 - reuse the same fuel-* componets in ALL targets
   e.g. fuel-mirror used to employ 2 slightly different git trees;
 - one step closer to Fuel/Armband merge (lots of steps left though);

Cons:
 - adds a lot complexity to solve a non-problem (handling the repos
   is fine in the current form, for the current goals);
   However, patching <fuel-astute> or <fuel-agent> seems to be
   quite complicated with the current mechanism, as env vars
   override our locally patched repos for these components).
   The proposed change should eliminate this issue completely.

CHANGE:
 Aligned divergent fuel-mirror in ISO vs local repo build by
 applying the 302 redirect fix ("Fixed handling http redirects") [2]
 on top of 9.0.1 tag in fuel-mirror repo, and using that for both.
 This obsoleted the followking mk file:
 - build/f_isoroot/f_repobuild/config.mk

CHANGE:
 Removed unused make target `get-fuel-repo` from build/config.mk.

FIXME:
 Remote tracking is currently deactivated for all branches.
 Change this when remote HEAD should be tracked instead,
 e.g. during Newton rebase.

[1] https://github.com/openstack/fuel-main/blob/stable/mitaka/repos.mk#L32
[2] https://review.openstack.org/#/c/334882/
[3] https://jira.opnfv.org/browse/FUEL-200

TODO: Extend build/f_repos/README.md with info about:
 - branch changes;
 - tag bumps;
 - patching now supports subdirs;

v5 -> v6:
 * Added support for nesting patches in subdirs, to be used for feature
   groups and related changes across submodules.
   E.g. Upcoming multiarch EFI support could go in:
    - .../f_repos/patch/fuel-agent/multiarch-efi/...;
    - .../f_repos/patch/fuel-astute/multiarch-efi/...;
   While Armband patches could go in:
    - .../f_repos/patch/fuel-agent/armband/...;
    - .../f_repos/patch/fuel-astute/armband/...;
   etc.
v6 -> v13:
 * fix wrong tag used for VERSION dump;
 * fix wrong tag used for patches-export;
 * move OPNFV_TAG to main config.mk and use it in FUEL_*_COMMIT;
 * only run `patches-import` when patches changed / not yet applied;
 * only run `clean` for stale `.cacheid` (avoid re-applying patches);
 * allow git submodule path/name to be different (FIXED);
 * put-cache should only run when artifact is not already cached;
 * `git am`: use 3-way merge so already applied patches are gently
   skipped (useful for upstreaming patches from Armband);
 * Properly support nested patch dirs;
 * Colorize the output a little;

JIRA: FUEL-200

Change-Id: I9dbdd9b3022896d4497d21be8dacc859730db489
Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>

1 files changed, 18 insertions, 21 deletions

diff --git a/build/Makefile b/build/Makefile
index 59d9096c6..56acb40fe 100644
--- a/build/Makefile
+++ b/build/Makefile
@@ -80,10 +80,7 @@ ORIGDIR := $(TOPDIR)/origiso
 # END of variables to customize
 #############################################################################
 
-# Fuel-main destination path and fuel-* submodule patching, for full list check:
-# https://github.com/openstack/fuel-main/blob/stable/mitaka/repos.mk#L32-L44
 FUEL_MAIN_DIR := /tmp/fuel-main
-FUEL_PATCHES  := $(shell find $(BUILD_BASE)/patch-repos -name '*.patch' | sort)
 
 SUBCLEAN = $(addsuffix .clean,$(SUBDIRS))
 
@@ -111,9 +108,12 @@ include cache.mk
 $(ISOCACHE):
 	# Clone Fuel to non-persistent location and build
 	sudo rm -rf $(FUEL_MAIN_DIR)
+	$(MAKE) -C f_repos -f Makefile release
 	git clone $(FUEL_MAIN_REPO) $(FUEL_MAIN_DIR)
-	git -C $(FUEL_MAIN_DIR) checkout $(FUEL_MAIN_TAG)
-	@echo "fuel" `git -C $(FUEL_MAIN_DIR) rev-parse HEAD` >> $(VERSION_FILE)
+	# Save upstream ref, checkout OPNFV tag (upstream ref + patches)
+	@echo "fuel" `git -C $(FUEL_MAIN_DIR) \
+		rev-parse $(F_OPNFV_TAG)-root` >> $(VERSION_FILE)
+	git -C $(FUEL_MAIN_DIR) checkout $(F_OPNFV_TAG)
 	# Remove Docker optimizations, otherwise multistrap will fail during
 	# Fuel build.
 	sudo rm -f /etc/apt/apt.conf.d/docker*
@@ -134,14 +134,7 @@ $(ISOCACHE):
 	sudo docker info
 	# fuel-main Makefiles do not like `make -C`
 	cd $(FUEL_MAIN_DIR) && make repos
-	$(REPOINFO) -r $(FUEL_MAIN_DIR) > gitinfo_fuel.txt
-	# OPNFV patches at Fuel build time
-	# Need to be commited in order for them to be considered by the Fuel
-	# build system
-	$(foreach patch,$(FUEL_PATCHES),git \
-		-C $(subst $(BUILD_BASE)/patch-repos,$(FUEL_MAIN_DIR),$(dir $(patch))) \
-		am --whitespace=nowarn --committer-date-is-author-date $(patch) || \
-		(echo 'Error: Failed patching Fuel repos!' ; exit 1);)
+	cp f_repos/.cachefuelinfo gitinfo_fuel.txt
 
 	# Repeat build up to three times
 	sudo -E ./fuel_build_loop
@@ -172,6 +165,7 @@ patch-packages:
 
 .PHONY: clean $(SUBCLEAN)
 clean:  $(SUBCLEAN)
+	$(MAKE) -C f_repos -f Makefile clean
 	$(MAKE) -C patch-packages -f Makefile clean
 	@rm -f *.iso
 	@rm -Rf release
@@ -182,7 +176,8 @@ clean:  $(SUBCLEAN)
 
 .PHONY: deepclean
 deepclean: clean clean-cache
-	make -C docker clean
+	$(MAKE) -C f_repos -f Makefile deepclean
+	$(MAKE) -C docker clean
 	docker rmi opnfv.org/ubuntu-builder:14.04 &>/dev/null || exit 0
 	docker rmi opnfv.org/ubuntu-builder:latest &>/dev/null || exit 0
 	docker rmi ubuntu:14.04 &>/dev/null || exit 0
@@ -224,24 +219,26 @@ debug:
 #############################################################################
 
 # Create a unique hash to be used for getting and putting cache, based on:
-#   - The commit ID of the full Fuel repo structre
+#   - The commit ID of the full Fuel repo structure
 #   - The contents of all local Fuel patches
+#   - Makefile, config and sensitive build scripts fingerprints
+# NOTE: Patching is deterministic, so we can fingerprint (submodule root commit
+#       info + OPNFV patches) at once, after patches-import.
+# NOTE: When git submodule remote tracking is active, `git submodule status`
+#       will point to the latest commits (remote/branch/HEAD) + OPNFV patches.
 .cacheid:
-	git clone $(FUEL_MAIN_REPO) $(FUEL_MAIN_DIR)
-	git -C $(FUEL_MAIN_DIR) checkout $(FUEL_MAIN_TAG)
-	make -C $(FUEL_MAIN_DIR) repos
-	$(REPOINFO) -r $(FUEL_MAIN_DIR) > .cachedata
-	$(foreach patch,$(FUEL_PATCHES),sha1sum $(patch) >> .cachedata;)
+	$(MAKE) -C f_repos -f Makefile get-cache release
+	git submodule status | cut -c2-41 > .cachedata
 	sha1sum fuel_build_loop >> .cachedata
 	sha1sum config.mk >> .cachedata
 	sha1sum Makefile >> .cachedata
 	$(CACHETOOL) getbiweek >> .cachedata
 	cat .cachedata | $(CACHETOOL) getid > .cacheid
-	# Not removing fuel-main as it is re-used in build
 
 # Clean local data related to caching - called prior to ordinary build
 .PHONY: clean-cache
 clean-cache: $(SUBCLEANCACHE)
+	$(MAKE) -C f_repos -f Makefile clean-cache
 	rm -f .cachedata .cacheid
 
 # Try to download cache - called prior to ordinary build