Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make mostly reuse conformant #502

Merged
merged 12 commits into from Sep 13, 2022
Merged

Make mostly reuse conformant #502

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
64c3240
Add .license files.
felixfontein Aug 20, 2022
8e90c16
Update README.
felixfontein Aug 21, 2022
cf44232
Normalize licenses test.
felixfontein Aug 21, 2022
7f9110e
Add reuse GHA.
felixfontein Aug 21, 2022
c003aa6
Add blanket rule for changelog fragments.
felixfontein Aug 21, 2022
35e1068
Add .license file for vendored third-party certificates.
felixfontein Aug 21, 2022
0bf5d40
Fix workflow's permissions.
felixfontein Aug 21, 2022
034b900
Revert "Add .license file for vendored third-party certificates."
felixfontein Sep 13, 2022
ad54897
Make reuse lint test optional.
felixfontein Sep 13, 2022
c749421
Add exceptions.
felixfontein Sep 13, 2022
b0ec28c
Update README.
felixfontein Sep 13, 2022
7eddfda
Improve reuse test.
felixfontein Sep 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
82 changes: 36 additions & 46 deletions tests/sanity/extra/licenses.py
View file
Open in desktop
Expand Up @@ -21,30 +21,35 @@ def find_licenses(filename, relax=False):
spdx_license_identifiers = []
other_license_identifiers = []
has_copyright = False
with open(filename, 'r', encoding='utf-8') as f:
for line in f:
line = line.rstrip()
if 'Copyright ' in line:
has_copyright = True
if 'Copyright: ' in line:
print('%s: found copyright line with "Copyright:". Please remove the colon.' % (filename, ))
idx = line.find('SPDX-License-Identifier: ')
if idx >= 0:
lic_id = line[idx + len('SPDX-License-Identifier: '):]
spdx_license_identifiers.extend(lic_id.split(' OR '))
if 'GNU General Public License' in line:
if 'v3.0+' in line:
other_license_identifiers.append('GPL-3.0-or-later')
if 'version 3 or later' in line:
other_license_identifiers.append('GPL-3.0-or-later')
if 'Simplified BSD License' in line:
other_license_identifiers.append('BSD-2-Clause')
if 'Apache License 2.0' in line:
other_license_identifiers.append('Apache-2.0')
if 'PSF License' in line or 'Python-2.0' in line:
other_license_identifiers.append('PSF-2.0')
if 'MIT License' in line:
other_license_identifiers.append('MIT')
try:
with open(filename, 'r', encoding='utf-8') as f:
for line in f:
line = line.rstrip()
if 'Copyright ' in line:
has_copyright = True
if 'Copyright: ' in line:
print('%s: found copyright line with "Copyright:". Please remove the colon.' % (filename, ))
if 'SPDX-FileCopyrightText: ' in line:
has_copyright = True
idx = line.find('SPDX-License-Identifier: ')
if idx >= 0:
lic_id = line[idx + len('SPDX-License-Identifier: '):]
spdx_license_identifiers.extend(lic_id.split(' OR '))
if 'GNU General Public License' in line:
if 'v3.0+' in line:
other_license_identifiers.append('GPL-3.0-or-later')
if 'version 3 or later' in line:
other_license_identifiers.append('GPL-3.0-or-later')
if 'Simplified BSD License' in line:
other_license_identifiers.append('BSD-2-Clause')
if 'Apache License 2.0' in line:
other_license_identifiers.append('Apache-2.0')
if 'PSF License' in line or 'Python-2.0' in line:
other_license_identifiers.append('PSF-2.0')
if 'MIT License' in line:
other_license_identifiers.append('MIT')
except Exception as exc:
print('%s: error while processing file: %s' % (filename, exc))
Comment on lines +24 to +52
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the only change here is putting it in a try-except block?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And support for SPDX-FileCopyrightText:. The try/except block comes from community.general, the SPDX-FileCopyrightText: block change too I think, and the other projects got the OR change from this one IIRC. Basically making sure that all projects have essentially the same copy of this whole file. (The only exception is community.dns, which has a special clause for plugins/public_suffix_list.dat having a non-GPL license outside of module_utils and modules.)

if len(set(spdx_license_identifiers)) < len(spdx_license_identifiers):
print('%s: found identical SPDX-License-Identifier values' % (filename, ))
if other_license_identifiers and set(other_license_identifiers) != set(spdx_license_identifiers):
Expand All @@ -62,30 +67,14 @@ def main():
# The following paths are allowed to have no license identifier
no_comments_allowed = [
'changelogs/fragments/*.yml',
'tests/sanity/extra/*.json',
'tests/sanity/ignore-2.*.txt',
'LICENSES/*.txt',
'COPYING',
]

# Files of this name are allowed to be empty
empty_allowed = [
'.keep',
'__init__.py',
]

# These files are completely ignored
ignore_paths = [
'CHANGELOG.rst',
'changelogs/changelog.yaml',
'tests/sanity/extra/licenses.py', # The strings in find_licenses() confuse this code :-)
'.ansible-test-timeout.json',
'tests/unit/plugins/module_utils/acme/fixtures/*.txt',
'tests/unit/plugins/module_utils/acme/fixtures/*.pem',
'tests/unit/plugins/module_utils/acme/fixtures/*.pem.old',
'tests/integration/targets/*/files/*.pem',
'tests/integration/targets/*/files/roots/*.pem',
'tests/integration/targets/luks_device/files/keyfile*',
'.reuse/dep5',
'LICENSES/*.txt',
'COPYING',
]

no_comments_allowed = [fn for pattern in no_comments_allowed for fn in glob.glob(pattern)]
Expand All @@ -98,9 +87,10 @@ def main():
path = path[2:]
if path in ignore_paths or path.startswith('tests/output/'):
continue
if os.path.basename(path) in empty_allowed:
if os.stat(path).st_size == 0:
continue
if os.stat(path).st_size == 0:
continue
if not path.endswith('.license') and os.path.exists(path + '.license'):
path = path + '.license'
valid_licenses_for_path = valid_licenses
if path.startswith('plugins/') and not path.startswith(('plugins/modules/', 'plugins/module_utils/')):
valid_licenses_for_path = [license for license in valid_licenses if license == 'GPL-3.0-or-later']
Expand Down