[RFC] unifying containment-rpm approaches

README.rst

@@ -2,15 +2,50 @@
                       openSUSE/containment-rpm
 =====================================================================
 
-`openSUSE/containment-rpm`_ is the authoritative source for
-`Devel:StudioOnline:containment_common_packages/containment-rpm`_.
-``image.spec.in``, ``kiwi_post_run`` and ``containment-rpm.spec.in`` are
-the actual sources and metasources, and ``update-package`` takes care of
-updating the Build Service package from Github.
+This repository provides files which facilitate the building (via the
+`Open Build Service`_) of *containment rpms*.  A containment rpm is an
+rpm package which contains one or more files generated as the result
+of another package build within the same Build Service.  `.iso` files,
+`.qcow2` images, and Vagrant `.box` files are all typical examples of
+files contained within a containment rpm.
+
+.. _`Open Build Service`: http://openbuildservice.org/
+
+
+
+"Customers"
+===========
+
+Users of a version of this repository include:
+
+- SUSE Studio, via the `Devel:StudioOnline:containment_common_packages/containment-rpm`_
+  project.  For more information, see
+  https://github.com/SUSE/studio/wiki/Containment-guidelines
+  and https://github.com/SUSE/studio/tree/master/containment-rpm.
+
+- SUSE Cloud, via the `Devel:Cloud:Shared:11-SP3:Update`_ project.
+
+However the code is not yet being properly shared and co-maintained.
 
-.. _openSUSE/containment: https://github.com/openSUSE/containment-rpm
 .. _Devel:StudioOnline:containment_common_packages/containment-rpm:
   https://build.suse.de/package/show?package=containment-rpm&project=Devel:StudioOnline:containment_common_packages
+.. _Devel:Cloud:Shared:11-SP3:Update:
+  https://build.suse.de/package/show/home:aspiers:branches:Devel:Cloud:Shared:11-SP3:Update/containment-rpm
+
+
+Contents
+========
+
+* ``containment-rpm.spec.in`` is the template for the spec file which
+  enables kiwi build environments to build containment rpms.
+* ``kiwi_post_run`` is the hook which gets executed at the end of the
+  kiwi image building process.  This script will wrap the image
+  newly built by kiwi inside a containment rpm, and move it to the
+  right location so that the Build Service will consider it a build
+  artefact which can be published or used in other builds.
+* ``image.spec.in`` is the spec file used by ``kiwi_post_run`` to build
+  the containment rpm.
+
 
 Hacking
 =======
@@ -20,8 +55,9 @@ Hacking
 * ``update-package`` can be used with different BS projects;
   see ``update-package -h``.
 
+
 Example
-=======
+-------
 
 ::
 

containment-rpm.spec.in → containment-rpm.spec

@@ -1,4 +1,7 @@
-# Copyright (c) 2010 SUSE LINUX Products GmbH, Nuernberg, Germany.
+#
+# spec file for package containment-rpm
+#
+# Copyright (c) 2012 SUSE LINUX Products GmbH, Nuernberg, Germany.
 #
 # All modifications and additions to the file contributed by third parties
 # remain the property of their copyright owners, unless otherwise agreed
@@ -15,20 +18,31 @@
 # norootforbuild
 
 Name:           containment-rpm
-Version:        __VERSION__
+Version:        0
 Release:        0
 License:        MIT
-Summary:        Wraps OBS/kiwi-built images in rpms.
+Summary:        Wraps OBS/kiwi-built images in rpms
 Url:            https://github.com/openSUSE/%{name}
 Group:          System/Management
-Source:         %{name}-%{version}.tar.gz
+Source:         %{name}-%{version}.tar.bz2
 BuildRequires:  filesystem
+# BuildRequires from the generated spec file, that need to be installed
+Requires:       bsdtar
+Requires:       containment-rpm-config
+Requires:       fdupes
 BuildRoot:      %{_tmppath}/%{name}-%{version}-build
 BuildArch:      noarch
 
 %description
 OBS kiwi_post_run hook to wrap a kiwi-produced image in an rpm package.
 
+This package should be required by the Build Service project's meta
+prjconf, so that the kiwi_post_run hook is present in the kiwi image
+and gets executed at the end of the image build.  It will then build
+an rpm which contains the newly-produced image from kiwi (using
+image.spec.in), and place the rpm in the correct location that it
+becomes an additional build artefact.
+
 %prep
 %setup -q
 
@@ -38,11 +52,11 @@ OBS kiwi_post_run hook to wrap a kiwi-produced image in an rpm package.
 mkdir -p %{buildroot}/usr/lib/build/
 install -m 644 image.spec.in %{buildroot}/usr/lib/build/
 install -m 755 kiwi_post_run %{buildroot}/usr/lib/build/
+install -d                   %{buildroot}%{_sourcedir}
 
 %files
 %defattr(-,root,root)
 /usr/lib/build/kiwi_post_run
 /usr/lib/build/image.spec.in
 
 %changelog
-

image.spec.in

@@ -1,38 +1,39 @@
-Url:            http://www.susestudio.com
 Name:           __NAME__
-Summary:        Studio Build System
+Summary:        %{containment_image_description} product .iso
 Version:        __VERSION__
 Release:        __RELEASE__
+Url:            http://www.suse.com/cloud
 Group:          System/Management
-License:        GPLv2
-Source:         %{name}-%{version}-%{release}-vmx.tar.bz2
+License:        GPL-2.0
+Source0:        __SOURCE__
+BuildRequires:  containment-rpm-config
+BuildRequires:  bsdtar
+BuildRequires:  fdupes
 BuildRoot:      %{_tmppath}/%{name}-%{version}-build
 BuildArch:      noarch
 
 %description
-Containment appliance to build studio images secured by a VM layer
+This package installs the unpacked %{containment_image_description} product .iso into:
 
-Authors:
---------
-    Marcus Schaefer <[email protected]>
-    Jordi Massaguer Pla <[email protected]>
+  %{containment_image_dest_dir}
+
+It is intended to be installed on the SUSE Cloud admin server.
 
 %prep
-%setup -c -n %name
 
 %build
-# empty no compile job
+bsdtar xf %{SOURCE0}
+chmod -R u+w *
 
 %install
+install -d -m 755 %{buildroot}%{containment_image_dest_dir}
+cp -pr * %{buildroot}%{containment_image_dest_dir}
+%fdupes %{buildroot}%{containment_image_dest_dir}
 
-install -d -m 755 $RPM_BUILD_ROOT/usr/share/studio/image
-mv *.qcow2 $RPM_BUILD_ROOT/usr/share/studio/image
-
-%clean
-rm -rf $RPM_BUILD_ROOT
+install -d -m 755 %{_rpmdir}/OTHER
+cp -pr %{S:0} %{_rpmdir}/OTHER
 
 %files
 %defattr(-, root, root)
-%dir /usr/share/studio
-/usr/share/studio/image
-
+%{containment_extra_files}
+%{containment_image_dest_dir}

kiwi_post_run

@@ -1,38 +1,73 @@
-#!/bin/sh -eu
+#!/bin/bash
+
+set -e
+set -u
 
 : ${TOPDIR:=/usr/src/packages}
 
-TARGET_DIR=$TOPDIR/KIWI-vmx/
-RPM_SOURCE_DIR=$TOPDIR/SOURCES
-FILES_DIR=/usr/lib/build
+IMAGE_DIR=$TOPDIR/KIWI
+BUILD_DIR=/usr/lib/build
+
+cd $IMAGE_DIR
+
+NAME=$(rpm --eval '%containment_image_name')
+EXT=$( rpm --eval '%containment_image_extension')
+PREFIX=$(rpm --eval '%containment_image_prefix')
+SUFFIX=$( rpm --eval '%containment_image_suffix')
+MAIL=$( rpm --eval '%containment_image_mail')
+
+shopt -s nullglob
+IMAGE=$(echo ${PREFIX}*${SUFFIX})
 
-cd $TARGET_DIR
+if [ -z "$IMAGE" ]; then
+    echo "Couldn't find anything in $IMAGE_DIR matching ${PREFIX}*${SUFFIX}."
+    echo "Will skip containment rpm wrapping steps."
+    exit 0
+fi
 
-STEM=Containment-Studio
-EXT=.qcow2
-SOURCE=$(echo $STEM-*$EXT)
+echo "Attempting to wrap $IMAGE in a containment rpm ..."
 
-# extract os/platform, version, release from the source tarball
-set -- $(echo $SOURCE | sed -r "s/(.*)-(.*)$EXT/\1 \2/")
-NAME=$(echo $1 | sed -r "s/.x86_64//g")
-VERSION=$2
+NAME="${NAME}-${EXT}"
 RELEASE=$(date +%Y%m%d%H%M%S)
 
+# Extracting the version is a bit more complicated.
+# For some reason, .isos from local builds look something like this:
+#
+#    SUSE-CLOUD-4-x86_64{1,2,3}.iso
+#
+# whereas .isos from OBS builds look something like this:
+#
+#    SUSE-CLOUD-4-x86_64-Build0007-Media{1,2,3}.iso
+#    SUSE-CLOUD-SLE11-SP3-DEPS-x86_64-Build0003-Media.iso
+#
+# This discrepancy is filed as https://bugzilla.suse.com/show_bug.cgi?id=900109
+#
+# $IMAGE should contain the filename of the first of these 3 .isos.
+VERSION="${IMAGE#$PREFIX}"
+VERSION="${VERSION%$SUFFIX}"
+if [ -z "$VERSION" ]; then
+    echo "Local build detected"
+    # Just arbitrarily assign the version since we have nothing else
+    # to go on.
+    VERSION=1
+fi
+
 echo "name $NAME"
 echo "version $VERSION"
 echo "release $RELEASE"
 
+mkdir -p $TOPDIR/OTHER
+
 sed -e "s/__NAME__/$NAME/g" \
     -e "s/__VERSION__/$VERSION/g" \
     -e "s/__RELEASE__/$RELEASE/g" \
-    -e "s/__SOURCE__/$SOURCE/g" \
-    < $FILES_DIR/image.spec.in \
-    > $FILES_DIR/image.spec
+    -e "s/__SOURCE__/$IMAGE/g" \
+    < $BUILD_DIR/image.spec.in \
+    > "$TOPDIR/OTHER/$NAME.followup.spec"
 
-tar -cjf $RPM_SOURCE_DIR/$NAME-$VERSION-$RELEASE-vmx.tar.bz2 $SOURCE
-rpmbuild -ba $FILES_DIR/image.spec
+cat <<EOF >> "$TOPDIR/OTHER/$NAME.followup.spec"
 
-# required for the BS to find the rpm, because it is
-# a "non-standard result file for KIWI"
-mkdir -p $TOPDIR/OTHER
-mv $TOPDIR/RPMS/noarch/$NAME-$VERSION-$RELEASE.noarch.rpm $TOPDIR/OTHER/
+%changelog
+* $(date +"%a %b %d %Y") $MAIL
+- Automatic build.
+EOF