[v9,03/13] scripts: Add archive-source.sh

Signed-off-by: Fam Zheng <famz@redhat.com>
---
 scripts/archive-source.sh | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100755 scripts/archive-source.sh

Fam Zheng <famz@redhat.com> writes:

> Signed-off-by: Fam Zheng <famz@redhat.com>

Reviewed-by: Alex Bennée <alex.bennee@linaro.org>

> ---
>  scripts/archive-source.sh | 46 ++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 46 insertions(+)
>  create mode 100755 scripts/archive-source.sh
>
> diff --git a/scripts/archive-source.sh b/scripts/archive-source.sh
> new file mode 100755
> index 0000000000..e155d980ee
> --- /dev/null
> +++ b/scripts/archive-source.sh
> @@ -0,0 +1,46 @@
> +#!/bin/sh
> +#
> +# Author: Fam Zheng <famz@redhat.com>
> +#
> +# Archive source tree, including submodules. This is created for test code to
> +# export the source files, in order to be built in a different enviornment,
> +# such as in a docker instance or VM.
> +#
> +# This code is licensed under the GPL version 2 or later.  See
> +# the COPYING file in the top-level directory.
> +
> +error() {
> +    echo "$@" >&2
> +    exit 1
> +}
> +
> +if test $# -lt 1; then
> +    error "Usage: $0 <output tarball>"
> +fi
> +
> +submodules=$(git submodule foreach --recursive --quiet 'echo $name')
> +
> +if test $? -ne 0; then
> +    error "git submodule command failed"
> +fi
> +
> +if test -n "$submodules"; then
> +    {
> +        git ls-files || error "git ls-files failed"
> +        for sm in $submodules; do
> +            (cd $sm; git ls-files) | sed "s:^:$sm/:"
> +            if test ${PIPESTATUS[0]} -ne 0 -o $? -ne 0; then
> +                error "git ls-files in submodule $sm failed"
> +            fi
> +        done
> +    } | grep -x -v $(for sm in $submodules; do echo "-e $sm"; done) > "$1".list
> +else
> +    git ls-files > "$1".list
> +fi
> +
> +if test $? -ne 0; then
> +    error "failed to generate list file"
> +fi
> +
> +tar -cf "$1" -T "$1".list || error "failed to create tar file"
> +rm "$1".list


--
Alex Bennée

On 09/19/2017 02:27 AM, Fam Zheng wrote:
> Signed-off-by: Fam Zheng <famz@redhat.com>
> ---
>  scripts/archive-source.sh | 46 ++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 46 insertions(+)
>  create mode 100755 scripts/archive-source.sh
> 
> diff --git a/scripts/archive-source.sh b/scripts/archive-source.sh
> new file mode 100755
> index 0000000000..e155d980ee
> --- /dev/null
> +++ b/scripts/archive-source.sh
> @@ -0,0 +1,46 @@
> +#!/bin/sh

Needs to be /bin/bash...

> +        git ls-files || error "git ls-files failed"
> +        for sm in $submodules; do
> +            (cd $sm; git ls-files) | sed "s:^:$sm/:"
> +            if test ${PIPESTATUS[0]} -ne 0 -o $? -ne 0; then
> +                error "git ls-files in submodule $sm failed"

...because $PIPESTATUS is a useful bashism not present in dash, where
the alternative is MUCH more verbose and painful to write in portable shell.

With just that fixed,
Reviewed-by: Eric Blake <eblake@redhat.com>

If desired, one other change (not mandatory, but if you want to do it,
I'll want to re-review):

> +
> +tar -cf "$1" -T "$1".list || error "failed to create tar file"

If we exit here, $1.list is not removed...

> +rm "$1".list

Should we make removal of the list be controlled by a cleanup trap, to
always happen even if something else fails in the interim?  Or is
leaving it around on failure useful for debugging?

On Tue, 09/19 10:10, Eric Blake wrote:
> On 09/19/2017 02:27 AM, Fam Zheng wrote:
> > Signed-off-by: Fam Zheng <famz@redhat.com>
> > ---
> >  scripts/archive-source.sh | 46 ++++++++++++++++++++++++++++++++++++++++++++++
> >  1 file changed, 46 insertions(+)
> >  create mode 100755 scripts/archive-source.sh
> > 
> > diff --git a/scripts/archive-source.sh b/scripts/archive-source.sh
> > new file mode 100755
> > index 0000000000..e155d980ee
> > --- /dev/null
> > +++ b/scripts/archive-source.sh
> > @@ -0,0 +1,46 @@
> > +#!/bin/sh
> 
> Needs to be /bin/bash...
> 
> > +        git ls-files || error "git ls-files failed"
> > +        for sm in $submodules; do
> > +            (cd $sm; git ls-files) | sed "s:^:$sm/:"
> > +            if test ${PIPESTATUS[0]} -ne 0 -o $? -ne 0; then
> > +                error "git ls-files in submodule $sm failed"
> 
> ...because $PIPESTATUS is a useful bashism not present in dash, where
> the alternative is MUCH more verbose and painful to write in portable shell.
> 
> With just that fixed,
> Reviewed-by: Eric Blake <eblake@redhat.com>
> 
> If desired, one other change (not mandatory, but if you want to do it,
> I'll want to re-review):
> 
> > +
> > +tar -cf "$1" -T "$1".list || error "failed to create tar file"
> 
> If we exit here, $1.list is not removed...
> 
> > +rm "$1".list
> 
> Should we make removal of the list be controlled by a cleanup trap, to
> always happen even if something else fails in the interim?  Or is
> leaving it around on failure useful for debugging?

Better to cleaned up. Will revise.

Fam