-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Anton Utz <[email protected]>
- Loading branch information
Showing
4 changed files
with
82 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
33 changes: 33 additions & 0 deletions
33
src/ros_license_toolkit/license_checks/license_tag_exists_check.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Copyright (c) 2024 - for information on the respective copyright owner | ||
# see the NOTICE file and/or the repository | ||
# https://github.com/boschresearch/ros_license_toolkit | ||
|
||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
|
||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
"""This Module contains LicenseTagExistsCheck, which implements Check.""" | ||
|
||
from ros_license_toolkit.checks import Check | ||
from ros_license_toolkit.package import Package | ||
from ros_license_toolkit.ui_elements import red | ||
|
||
|
||
class LicenseTagExistsCheck(Check): | ||
"""This ensures that a tag defining the license exists.""" | ||
|
||
def _check(self, package: Package): | ||
if len(package.license_tags) == 0: | ||
self._failed("No license tag defined.") | ||
self.verbose_output = red(str(package.package_xml)) | ||
else: | ||
self._success( | ||
f"Found licenses {list(map(str, package.license_tags))}") |
40 changes: 40 additions & 0 deletions
40
src/ros_license_toolkit/license_checks/license_tag_is_spdx.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Copyright (c) 2024 - for information on the respective copyright owner | ||
# see the NOTICE file and/or the repository | ||
# https://github.com/boschresearch/ros_license_toolkit | ||
|
||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
|
||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
"""This Module contains LicenseTagIsInSpdxListCheck, which implements Check.""" | ||
|
||
from ros_license_toolkit.checks import Check | ||
from ros_license_toolkit.license_tag import is_license_name_in_spdx_list | ||
from ros_license_toolkit.package import Package | ||
|
||
|
||
class LicenseTagIsInSpdxListCheck(Check): | ||
"""This ensures that the license tag is in the SPDX list of licenses.""" | ||
|
||
def _check(self, package: Package): | ||
licenses_not_in_spdx_list = [] | ||
for license_tag in package.license_tags.keys(): | ||
if not is_license_name_in_spdx_list( | ||
license_tag): | ||
licenses_not_in_spdx_list.append(license_tag) | ||
if len(licenses_not_in_spdx_list) > 0: | ||
self._warning( | ||
f"Licenses {licenses_not_in_spdx_list} are " | ||
"not in SPDX list of licenses. " | ||
"Make sure to exactly match one of https://spdx.org/licenses/." | ||
) | ||
else: | ||
self._success("All license tags are in SPDX list of licenses.") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters