add verify-upstreams and sanity-tests subcommands

LICENSES/Python-2.0.1.txt

@@ -0,0 +1,193 @@
+PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
+--------------------------------------------
+
+1. This LICENSE AGREEMENT is between the Python Software Foundation
+("PSF"), and the Individual or Organization ("Licensee") accessing and
+otherwise using this software ("Python") in source or binary form and
+its associated documentation.
+
+2. Subject to the terms and conditions of this License Agreement, PSF hereby
+grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
+analyze, test, perform and/or display publicly, prepare derivative works,
+distribute, and otherwise use Python alone or in any derivative version,
+provided, however, that PSF's License Agreement and PSF's notice of copyright,
+i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
+2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022 Python Software Foundation;
+All Rights Reserved" are retained in Python alone or in any derivative version
+prepared by Licensee.
+
+3. In the event Licensee prepares a derivative work that is based on
+or incorporates Python or any part thereof, and wants to make
+the derivative work available to others as provided herein, then
+Licensee hereby agrees to include in any such work a brief summary of
+the changes made to Python.
+
+4. PSF is making Python available to Licensee on an "AS IS"
+basis.  PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
+INFRINGE ANY THIRD PARTY RIGHTS.
+
+5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
+FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
+A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
+OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
+
+6. This License Agreement will automatically terminate upon a material
+breach of its terms and conditions.
+
+7. Nothing in this License Agreement shall be deemed to create any
+relationship of agency, partnership, or joint venture between PSF and
+Licensee.  This License Agreement does not grant permission to use PSF
+trademarks or trade name in a trademark sense to endorse or promote
+products or services of Licensee, or any third party.
+
+8. By copying, installing or otherwise using Python, Licensee
+agrees to be bound by the terms and conditions of this License
+Agreement.
+
+
+BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0
+-------------------------------------------
+
+BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1
+
+1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an
+office at 160 Saratoga Avenue, Santa Clara, CA 95051, and the
+Individual or Organization ("Licensee") accessing and otherwise using
+this software in source or binary form and its associated
+documentation ("the Software").
+
+2. Subject to the terms and conditions of this BeOpen Python License
+Agreement, BeOpen hereby grants Licensee a non-exclusive,
+royalty-free, world-wide license to reproduce, analyze, test, perform
+and/or display publicly, prepare derivative works, distribute, and
+otherwise use the Software alone or in any derivative version,
+provided, however, that the BeOpen Python License is retained in the
+Software, alone or in any derivative version prepared by Licensee.
+
+3. BeOpen is making the Software available to Licensee on an "AS IS"
+basis.  BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE WILL NOT
+INFRINGE ANY THIRD PARTY RIGHTS.
+
+4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE
+SOFTWARE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS
+AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY
+DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
+
+5. This License Agreement will automatically terminate upon a material
+breach of its terms and conditions.
+
+6. This License Agreement shall be governed by and interpreted in all
+respects by the law of the State of California, excluding conflict of
+law provisions.  Nothing in this License Agreement shall be deemed to
+create any relationship of agency, partnership, or joint venture
+between BeOpen and Licensee.  This License Agreement does not grant
+permission to use BeOpen trademarks or trade names in a trademark
+sense to endorse or promote products or services of Licensee, or any
+third party.  As an exception, the "BeOpen Python" logos available at
+http://www.pythonlabs.com/logos.html may be used according to the
+permissions granted on that web page.
+
+7. By copying, installing or otherwise using the software, Licensee
+agrees to be bound by the terms and conditions of this License
+Agreement.
+
+
+CNRI LICENSE AGREEMENT FOR PYTHON 1.6.1
+---------------------------------------
+
+1. This LICENSE AGREEMENT is between the Corporation for National
+Research Initiatives, having an office at 1895 Preston White Drive,
+Reston, VA 20191 ("CNRI"), and the Individual or Organization
+("Licensee") accessing and otherwise using Python 1.6.1 software in
+source or binary form and its associated documentation.
+
+2. Subject to the terms and conditions of this License Agreement, CNRI
+hereby grants Licensee a nonexclusive, royalty-free, world-wide
+license to reproduce, analyze, test, perform and/or display publicly,
+prepare derivative works, distribute, and otherwise use Python 1.6.1
+alone or in any derivative version, provided, however, that CNRI's
+License Agreement and CNRI's notice of copyright, i.e., "Copyright (c)
+1995-2001 Corporation for National Research Initiatives; All Rights
+Reserved" are retained in Python 1.6.1 alone or in any derivative
+version prepared by Licensee.  Alternately, in lieu of CNRI's License
+Agreement, Licensee may substitute the following text (omitting the
+quotes): "Python 1.6.1 is made available subject to the terms and
+conditions in CNRI's License Agreement.  This Agreement together with
+Python 1.6.1 may be located on the internet using the following
+unique, persistent identifier (known as a handle): 1895.22/1013.  This
+Agreement may also be obtained from a proxy server on the internet
+using the following URL: http://hdl.handle.net/1895.22/1013".
+
+3. In the event Licensee prepares a derivative work that is based on
+or incorporates Python 1.6.1 or any part thereof, and wants to make
+the derivative work available to others as provided herein, then
+Licensee hereby agrees to include in any such work a brief summary of
+the changes made to Python 1.6.1.
+
+4. CNRI is making Python 1.6.1 available to Licensee on an "AS IS"
+basis.  CNRI MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, CNRI MAKES NO AND
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON 1.6.1 WILL NOT
+INFRINGE ANY THIRD PARTY RIGHTS.
+
+5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
+1.6.1 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
+A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 1.6.1,
+OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
+
+6. This License Agreement will automatically terminate upon a material
+breach of its terms and conditions.
+
+7. This License Agreement shall be governed by the federal
+intellectual property law of the United States, including without
+limitation the federal copyright law, and, to the extent such
+U.S. federal law does not apply, by the law of the Commonwealth of
+Virginia, excluding Virginia's conflict of law provisions.
+Notwithstanding the foregoing, with regard to derivative works based
+on Python 1.6.1 that incorporate non-separable material that was
+previously distributed under the GNU General Public License (GPL), the
+law of the Commonwealth of Virginia shall govern this License
+Agreement only as to issues arising under or with respect to
+Paragraphs 4, 5, and 7 of this License Agreement.  Nothing in this
+License Agreement shall be deemed to create any relationship of
+agency, partnership, or joint venture between CNRI and Licensee.  This
+License Agreement does not grant permission to use CNRI trademarks or
+trade name in a trademark sense to endorse or promote products or
+services of Licensee, or any third party.
+
+8. By clicking on the "ACCEPT" button where indicated, or by copying,
+installing or otherwise using Python 1.6.1, Licensee agrees to be
+bound by the terms and conditions of this License Agreement.
+
+        ACCEPT
+
+
+CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2
+--------------------------------------------------
+
+Copyright (c) 1991 - 1995, Stichting Mathematisch Centrum Amsterdam,
+The Netherlands.  All rights reserved.
+
+Permission to use, copy, modify, and distribute this software and its
+documentation for any purpose and without fee is hereby granted,
+provided that the above copyright notice appear in all copies and that
+both that copyright notice and this permission notice appear in
+supporting documentation, and that the name of Stichting Mathematisch
+Centrum or CWI not be used in advertising or publicity pertaining to
+distribution of the software without specific, written prior
+permission.
+
+STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
+THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
+FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
+OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

README.md

@@ -20,11 +20,19 @@ Related projects are [antsibull-changelog](https://pypi.org/project/antsibull-ch
 
 You can find a list of changes in [the Antsibull changelog](./CHANGELOG.rst).
 
-Unless otherwise noted in the code, it is licensed under the terms of the GNU
-General Public License v3 or, at your option, later.
-
 antsibull is covered by the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
 
+## Licensing
+
+This repository abides by the [REUSE specification](https://reuse.software).
+See the copyright headers in each file for the exact license and copyright.
+Summarily:
+
+- The default license is the GNU Public License v3+
+  ([`GPL-3.0-or-later`](LICENSES/GPL-3.0-or-later.txt)).
+- `src/antsibull/_vendor/shutil.py` includes code derived from CPython, licensed
+  under the Python 2.0 License ([`Python-2.0.1`](LICENSES/Python-2.0.1.txt)).
+
 ## Versioning and compatibility
 
 From version 0.1.0 on, antsibull sticks to semantic versioning and aims at providing no backwards compatibility breaking changes **to the command line API (antsibull)** during a major release cycle. We might make exceptions from this in case of security fixes for vulnerabilities that are severe enough.

changelogs/fragments/556-verify-upstream.yaml

@@ -0,0 +1,11 @@
+---
+minor_changes:
+  - Add a ``verify-upstreams`` subcommand to ensure that files in a
+    collections' Galaxy collection artifact match its upstream repository
+    (https://github.com/ansible-community/antsibull/pull/556).
+  - Change the license from ``GPL-3.0-or-later`` to ``GPL-3.0-or-later AND Python-2.0.1``.
+    Antsibull now contains a small amount of code derived from CPython
+    (https://github.com/ansible-community/antsibull/pull/556).
+  - Add a ``sanity-tests`` subcommand to run sanity tests accross the
+    collection tree created by ``verify-upstreams`` and display the results
+    (https://github.com/ansible-community/antsibull/pull/556).

pyproject.toml

@@ -12,7 +12,7 @@ dynamic = [
     "version",
 ]
 description = "Tools for building the Ansible Distribution"
-license = "GPL-3.0-or-later"
+license = "GPL-3.0-or-later AND Python-2.0.1"
 license-files = {globs=["LICENSES/*.txt"]}
 readme = "README.md"
 classifiers = [

src/antsibull/_vendor/__init__.py

@@ -0,0 +1,10 @@
+# Copyright (C) 2023 Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or
+# https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+"""
+Vendored or modified code from other sources
+"""
+
+from __future__ import annotations

src/antsibull/_vendor/shutil.py

@@ -0,0 +1,143 @@
+# SPDX-License-Identifier: Python-2.0.1
+# Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007,
+# 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
+# 2020, 2021, 2022, 2023 Python Software Foundation; All Rights Reserved
+
+"""
+Modifed code derived from Cpython's `shutil` module to suit our own needs
+"""
+
+from __future__ import annotations
+
+import os
+import typing as t
+from pathlib import Path
+from shutil import Error, copy2, copystat
+
+if t.TYPE_CHECKING:
+    from _typeshed import StrPath
+
+
+def copytree_and_symlinks(
+    src: StrPath | os.DirEntry,
+    dest: StrPath | os.DirEntry,
+    *,
+    ignore_dangling_symlinks: bool = True,
+    dirs_exist_ok: bool = False,
+    _origsrc: Path | None = None,
+) -> None:
+    """
+    Modified version of `shutil.copytree()` that handles symlinks more inteligently.
+
+    * Relative symlink to files within the `src` directory -> symlink is preserved
+    * Relative symlink to files outside the `src` directory -> files are copied
+    * `ignore_dangling_symlinks` is the default.
+
+    Windows code branches are removed. Antsibull does not support Windows.
+    """
+    # Ensure that the generator is closed
+    with os.scandir(src) as itr:  # type: ignore[type-var]
+        entries = list(itr)
+    _copytree(
+        entries,
+        src,
+        dest,
+        ignore_dangling_symlinks=ignore_dangling_symlinks,
+        dirs_exist_ok=dirs_exist_ok,
+        _origsrc=_origsrc,
+    )
+
+
+def _should_symlink(src: Path, target: Path, origsrc: Path) -> bool:
+    """
+    Check if `src`'s symlink target is a path outside `src` that cannot be
+    symlinked
+
+    Args:
+        src:
+            Source directory
+        target:
+            Symlink target
+    """
+    if target.is_absolute():
+        return True
+    try:
+        srcr = src.resolve()
+        targetr = (srcr / target).resolve()
+        if not targetr.is_dir():
+            targetr = targetr.parent
+        is_relative = origsrc.is_relative_to(targetr)
+        return origsrc == targetr or not is_relative
+    except Exception:  # pragma: no cover pylint: disable=broad-exception-caught
+        return False
+
+
+def _copytree(  # noqa: C901
+    entries: list[os.DirEntry],
+    src: StrPath,
+    dst: StrPath,
+    ignore_dangling_symlinks: bool,
+    dirs_exist_ok: bool = False,
+    *,
+    _origsrc: Path | None = None,
+) -> None:
+    copy_function = copy2
+    _origsrc = _origsrc if _origsrc else Path(src).resolve()
+
+    os.makedirs(dst, exist_ok=dirs_exist_ok)
+    errors = []
+
+    for srcentry in entries:
+        srcname = os.path.join(src, srcentry.name)
+        dstname = os.path.join(dst, srcentry.name)
+        srcobj = srcentry
+        try:
+            is_symlink = srcentry.is_symlink()
+            if is_symlink:
+                linkto = os.readlink(srcname)
+                if _should_symlink(Path(src), Path(linkto), _origsrc):
+                    # We can't just leave it to `copy_function` because legacy
+                    # code with a custom `copy_function` may rely on copytree
+                    # doing the right thing.
+                    os.symlink(linkto, dstname)
+                    copystat(srcobj, dstname, follow_symlinks=False)
+                else:
+                    # ignore dangling symlink if the flag is on
+                    if (
+                        not os.path.exists(os.path.join(src, linkto))
+                        and ignore_dangling_symlinks
+                    ):
+                        continue
+                    if srcentry.is_dir():
+                        copytree_and_symlinks(
+                            srcobj,
+                            dstname,
+                            ignore_dangling_symlinks=ignore_dangling_symlinks,
+                            dirs_exist_ok=dirs_exist_ok,
+                            _origsrc=_origsrc,
+                        )
+                    else:
+                        copy_function(srcobj, dstname)
+            elif srcentry.is_dir():
+                copytree_and_symlinks(
+                    srcobj,
+                    dstname,
+                    ignore_dangling_symlinks=ignore_dangling_symlinks,
+                    dirs_exist_ok=dirs_exist_ok,
+                    _origsrc=_origsrc,
+                )
+            else:
+                # Will raise a SpecialFileError for unsupported file types
+                copy_function(srcobj, dstname)
+        # catch the Error from the recursive copytree so that we can
+        # continue with other files
+        except Error as err:
+            errors.extend(err.args[0])
+        except OSError as why:
+            errors.append((srcname, dstname, str(why)))
+    copystat(src, dst)
+    if errors:
+        raise Error(errors)
+
+
+__all__ = ("copytree_and_symlinks",)