Re: [PATCH RESEND v2 10/16] check_whence: error if symlinks are in-tree

[Josh Boyer <jwboyer@kernel.org>]

On Wed, Mar 1, 2023 at 1:56 PM Emil Velikov via B4 Relay
<devnull+emil.l.velikov.gmail.com@kernel.org> wrote:
>
> From: Emil Velikov <emil.l.velikov@gmail.com>
>
> Currently we have no symlinks in-tree. Add a simple check, ensuring they
> don't get added in the future.
>
> This allows us to remove the clunky symlink checking code in
> copy-firmware.sh

I like the addition to check_whence, but this no longer applies
cleanly and I don't think we should remove checks from
copy-firmware.sh

josh

>
> v2:
>  - tweak helper to produce link and target (based off Adam's patch)
>
> Cc: Adam Sampson <ats@offog.org>
> Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
> ---
> Adam, you should be able to use this helper with your fixes.
>
> Note that symlinks should not point to another symlink, so you might
> want to tweak your patch to check and error out in such cases.
>
> HTH o/
> ---
>  check_whence.py | 22 ++++++++++++++++++++++
>  1 file changed, 22 insertions(+)
>
> diff --git a/check_whence.py b/check_whence.py
> index 92b104e..f94037d 100755
> --- a/check_whence.py
> +++ b/check_whence.py
> @@ -32,6 +32,23 @@ def list_whence_files():
>                  yield match.group(1).replace("\ ", " ")
>                  continue
>
> +def list_links_list():
> +    with open('WHENCE', encoding='utf-8') as whence:
> +        for line in whence:
> +            match = re.match(r'Link:\s*(.*)', line)
> +            if match:
> +                linkname, target = match.group(1).split("->")
> +
> +                linkname = linkname.strip().replace("\ ", " ")
> +                target = target.strip().replace("\ ", " ")
> +
> +                # Link target is relative to the link
> +                target = os.path.join(os.path.dirname(linkname), target)
> +                target = os.path.normpath(target)
> +
> +                yield (linkname, target)
> +                continue
> +
>  def list_git():
>      with os.popen('git ls-files') as git_files:
>          for line in git_files:
> @@ -41,6 +58,7 @@ def main():
>      ret = 0
>      whence_list = list(list_whence())
>      whence_files = list(list_whence_files())
> +    links_list = list(list_links_list())
>      known_files = set(name for name in whence_list if not name.endswith('/')) | \
>                    set(['check_whence.py', 'configure', 'Makefile',
>                         'README', 'copy-firmware.sh', 'WHENCE'])
> @@ -61,6 +79,10 @@ def main():
>                           name)
>          ret = 1
>
> +    for name in set(link[0] for link in links_list if os.path.islink(link[0])):
> +        sys.stderr.write('E: %s listed in WHENCE as Link, is in tree\n' % name)
> +        ret = 1
> +
>      for name in sorted(list(known_files - git_files)):
>          sys.stderr.write('E: %s listed in WHENCE does not exist\n' % name)
>          ret = 1
>
> --
> 2.39.2
>