Skip to content

Commit

Permalink
Add SPDX License identifier
Browse files Browse the repository at this point in the history
  • Loading branch information
mzfr authored and mzfr committed Sep 20, 2020
1 parent dade408 commit e0224aa
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
4 changes: 4 additions & 0 deletions kodi_addon_checker/check_addon.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ def start(addon_path, args, all_repo_addons, config=None):

check_files.check_file_permission(addon_report, file_index)

check_files.check_license_identifier(addon_report, addon_path)

check_files.check_license_tag(addon_report, parsed_xml)

check_files.check_for_invalid_xml_files(addon_report, file_index)

check_files.check_for_invalid_json_files(addon_report, file_index)
Expand Down
34 changes: 33 additions & 1 deletion kodi_addon_checker/check_files.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@
See LICENSES/README.md for more information.
"""

import json
import os
import re
import json
import ast
import xml.etree.ElementTree as ET
from pathlib import Path

from . import handle_files
from .common import relative_path
Expand Down Expand Up @@ -148,3 +150,33 @@ def check_file_permission(report: Report, file_index: list):
file = os.path.join(file["path"], file["name"])
if os.path.isfile(file) and os.access(str(file), os.X_OK):
report.add(Record(PROBLEM, "%s is marked as stand-alone executable" % relative_path(str(file))))


def check_license_identifier(report: Report, addon_path: str):
"""Check whether all the files present in the addon
contains the SPDX license header or not
:addon_path: Path of the addon
"""

files = Path(addon_path).glob('**/*.py')

for file in files:
with open(str(file), 'r') as f:
tree = ast.parse(f.read())

docstring = ast.get_docstring(tree)
if docstring and "SPDX-License-Identifier" not in docstring:
report.add(Record(WARNING, "SPDX-License-Identifier is missing from addon file %s" %
relative_path(str(file))))


def check_license_tag(report: Report, parsed_xml):
"""Check license tag in addon xml file
:parsed_xml: parsed tree for xml file
"""

license_text = parsed_xml.find("extension/license").text
spdx_string = "GNU General Public License v2.0 or later"

if spdx_string != license_text:
report.add(Record(WARNING, "License is not of SPDX format"))

0 comments on commit e0224aa

Please sign in to comment.