aglsetup: generate setup manifest file

This patch modifies aglsetup to output the execution context in a
"setup manifest" located in $builddir/aglsetup.manifest

This file can then be processed by another script (distro-manifest-generator.sh)
to generate a complete distro manifest at build time.

Bug-AGL: SPEC-720, SPEC-1741

Change-Id: I1f9bc8a6d8bc4c659e59ed0025f71ad9e1c86355
Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>

diff --git a/scripts/.aglsetup_genconfig.bash b/scripts/.aglsetup_genconfig.bash
index b0d24e5..97ae676 100755 (executable)
--- a/scripts/.aglsetup_genconfig.bash
+++ b/scripts/.aglsetup_genconfig.bash
@@ -455,6 +455,8 @@ EOF
        $BUILDDIR/conf/setup.* \
        $BUILDDIR/conf/*.log
 
+####### step 1: generate configuration file #######
+
 if [[ -f $BUILDDIR/conf/local.conf || -f $BUILDDIR/conf/bblayers.conf ]]; then
        info "Configuration files already exist:"
        for x in $BUILDDIR/conf/local.conf $BUILDDIR/conf/bblayers.conf; do
@@ -466,6 +468,42 @@ else
        genconfig
 fi
 
+####### step 2: generate aglsetup.manifest #######
+
+SETUP_MANIFEST=aglsetup.manifest
+
+infon "Generating setup manifest: $BUILDDIR/$SETUP_MANIFEST ... "
+for x in /etc/os-release /usr/lib/os-release; do
+       [[ -f $x ]] && . $x
+done
+FEATURES_md5=$(echo $FEATURES|md5sum -|awk '{print $1;}')
+cat <<EOF >$BUILDDIR/$SETUP_MANIFEST
+# ----------------------------------------------
+# This fragment has been generated by $SCRIPT at setup time
+
+# target machine as passed to $SCRIPT
+DIST_MACHINE="$MACHINE"
+
+# features as resolved by $SCRIPT
+DIST_FEATURES="$FEATURES"
+DIST_FEATURES_MD5="${FEATURES_md5}"
+
+# build host information deduced from os-release
+DIST_BUILD_HOST="$(id -un)@$(hostname -f)"
+DIST_BUILD_OS="${PRETTY_NAME:-${NAME} ${VERSION} [COMPUTED]}"
+
+# meta directory
+DIST_METADIR="$METADIR"
+
+# timestamp
+DIST_SETUP_TS="$(date -u +%Y%m%d_%H%M%S_%Z)"
+
+# ------------ end of $SCRIPT fragment --------
+EOF
+info "OK"
+
+####### step 3: generate agl-init-build-env #######
+
 # always generate setup script in builddir: it can be sourced later manually without re-running the setup
 infon "Generating setup file: $BUILDDIR/agl-init-build-env ... "
 
@@ -477,11 +515,19 @@ fi
 if [ -n "\$SSTATE_DIR" ]; then
        BB_ENV_EXTRAWHITE="\$BB_ENV_EXTRAWHITE SSTATE_DIR"
 fi
+
+# build manifest generator used in distro-build-manifest.bb
+BB_ENV_EXTRAWHITE="\$BB_ENV_EXTRAWHITE DISTRO_SETUP_MANIFEST DISTRO_MANIFEST_GENERATOR"
+export DISTRO_SETUP_MANIFEST=$(realpath -Ls $BUILDDIR)/$SETUP_MANIFEST
+export DISTRO_MANIFEST_GENERATOR=$(dirname $(realpath $BASH_SOURCE))/distro-manifest-generator.sh
+
 export BB_ENV_EXTRAWHITE
 unset TEMPLATECONF
 EOF
 info "OK"
 
+####### step 4: generate output script #######
+
 # finally, generate output script if requested by caller
 if [[ -n "$SETUPSCRIPT" ]]; then
        debug "generating setupscript in $SETUPSCRIPT"

diff --git a/scripts/distro-manifest-generator.sh b/scripts/distro-manifest-generator.sh
new file mode 100755 (executable)
index 0000000..ff88fe1
--- /dev/null
+++ b/scripts/distro-manifest-generator.sh
@@ -0,0 +1,103 @@
+#!/usr/bin/env bash
+
+################################################################################
+#
+# The MIT License (MIT)
+#
+# Copyright (c) 2018 Stéphane Desneux <sdx@iot.bzh>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+################################################################################
+
+function _getgitmanifest() {
+       # this function takes the aglsetup.manifest generated by aglsetup and uses DIST_METADIR
+       # to analyze git repos
+
+       local manifest=$1
+       [[ -f $manifest ]] && source $manifest || { echo "Invalid setup manifest '$manifest'" >&2; return 1; }
+       [[ ! -d "$DIST_METADIR" ]] && {
+               echo "Invalid meta directory. Check variable DIST_METADIR in manifest file '$manifest'." >&2
+               echo "Also, check directory '$DIST_METADIR'." >&2
+               return 2
+       }
+       local GIT=$(which git) REALPATH=$(which realpath)
+       [[ ! -x $GIT ]] && { echo "Unable to find git command." >&2; return 3; }
+       [[ ! -x $REALPATH ]] && { echo "Unable to find realpath command." >&2; return 3; }
+
+       local gitrepo gitrev metagitdir sep="" layers=""
+       for metagitdir in $(ls -d $DIST_METADIR/*/.git); do
+               gitrepo=$($REALPATH -Ls $metagitdir/.. --relative-to=$DIST_METADIR)
+               pushd $DIST_METADIR/$gitrepo &>/dev/null && {
+                       gitrev=$( { $GIT describe --long --dirty --always 2>/dev/null || echo "unknown_revision"; } | tr ' \t' '__' )
+                       popd &>/dev/null
+               } || {
+                       gitrev=unknown
+               }
+               layers="${layers}${sep}${gitrepo}:${gitrev}"
+               sep=" "
+       done
+       local layersmd5=$(echo $layers|md5sum -|awk '{print $1;}')
+
+       # add extra layers infos
+       cat <<END
+
+# Setup manifest used
+DIST_SETUP_MANIFEST="$($REALPATH $manifest)"
+
+# Manifest build timestamp
+DIST_BUILD_TS="$(date -u +%Y%m%d_%H%M%S_%Z)"
+
+# Git repositories found in $DIST_METADIR
+# Revision is given by 'git describe --long --dirty --always'
+DIST_LAYERS="$layers"
+
+# Layers Checksum
+DIST_LAYERS_MD5="$layersmd5"
+
+# Build ID
+DIST_BUILD_ID="AGL-${DIST_MACHINE}-F${DIST_FEATURES_MD5:0:8}-L${layersmd5:0:8}"
+END
+}
+
+function getmanifest() {
+       local manifest=$1
+
+       echo "# DISTRO BUILD MANIFEST"
+       echo
+
+       # copy setup manifest to output
+       cat $manifest
+       echo
+
+       # add layers manifest
+       echo "# ----- this fragment has been generated by $BASH_SOURCE"
+       _getgitmanifest $manifest
+       echo "# ------------ end of $BASH_SOURCE fragment --------"
+}
+
+if [[ "$1" =~ ^(-v|--verbose)$ ]]; then
+       shift
+       getmanifest $1
+elif [[ -f "$1" ]]; then
+       getmanifest $1 | sed -e 's/#.*$//g;/^\s*$/d'
+else
+       echo "Usage: $0 [-v|--verbose] <setup_manifest_file>" >&2
+fi
+