[U-Boot] [PATCH v2] tools: buildman: Don't use the working dir as build dir

[Lothar Waßmann]

Hi,

On Mon,  2 Apr 2018 02:43:12 -0600 Simon Glass wrote:
> From: Lothar Waßmann <LW at KARO-electronics.de>
> 
> When the U-Boot base directory happens to have the same name as the branch
> that buildman is directed to use via the '-b' option and no output
> directory is specified with '-o', buildman happily starts removing the
> whole U-Boot sources eventually only stopped with the error message:
> 
> OSError: [Errno 20] Not a directory: '../<branch-name>/boards.cfg
> 
> Add a check to avoid this and also deal with the case where '-o' points
> to the source directory, or any subdirectory of it.
> 
> Finally, tidy up the confusing logic for removing the old tree when using
> -b. This is only done when building a branch.
> 
> Signed-off-by: Lothar Waßmann <LW at KARO-electronics.de>
> Signed-off-by: Simon Glass <sjg at chromium.org>
> ---
> 
> Changes in v2:
> - Updated to check directories on start-up as per comments on v1 patch
> - Added a test
> - Expanded check to handle subdirectories
> 
>  tools/buildman/builderthread.py |  4 ++++
>  tools/buildman/control.py       | 28 +++++++++++++++++++++++++---
>  tools/buildman/func_test.py     |  9 +++++++++
>  3 files changed, 38 insertions(+), 3 deletions(-)
> 
[...]
> diff --git a/tools/buildman/control.py b/tools/buildman/control.py
> index 3cac9f7cf6..5bf128357d 100644
> --- a/tools/buildman/control.py
> +++ b/tools/buildman/control.py
> @@ -81,6 +81,28 @@ def ShowActions(series, why_selected, boards_selected, builder, options):
>      print ('Total boards to build for each commit: %d\n' %
>              len(why_selected['all']))
>  
> +def CheckOutputDir(output_dir):
> +    """Make sure that the output directory is not within the current directory
> +
> +    If we try to use an output directory which is within the current directory
> +    (which is assumed to hold the U-Boot source) we may end up deleting the
> +    U-Boot source code. Detect this and print an error in this case.
> +
> +    Args:
> +        output_dir: Output directory path to check
> +    """
> +    path = os.path.realpath(output_dir)
> +    cwd_path = os.path.realpath('.')
> +    while True:
> +        if os.path.realpath(path) == cwd_path:
> +            Print("Cannot use output directory '%s' since it is within the "
> +                  "current directtory '%s'" % (path, cwd_path))
s/directtory/directory/
NB: IMO its a bad habit to split format strings across multiple lines,
    since it makes it harder to grep the source code for a message
    that was printed on the terminal.

Otherwise, looks good to me.

Tested-by: Lothar Waßmann <LW at KARO-electronics.de>


Lothar Waßmann