Skip to content

Commit f71b586

Browse files
authored
Merge pull request #992 from juanjemdIos/fix-634
resolve license spdx in readme headers and merge. Fixes #634
2 parents 78240b7 + 88732d5 commit f71b586

5 files changed

Lines changed: 385 additions & 4 deletions

File tree

src/somef/header_analysis.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
from .process_results import Result
1010
from .parser import mardown_parser
1111
from .utils import constants
12+
from .regular_expressions import detect_license_spdx
1213
from typing import Dict, Iterable, List, Tuple
1314
from functools import lru_cache
1415
pd.options.mode.chained_assignment = None # default='warn'
@@ -450,7 +451,8 @@ def extract_categories(repo_data: str, repository_metadata: Result) -> Tuple[Res
450451
'ParentHeader': constants.PROP_PARENT_HEADER,
451452
})
452453

453-
source = None
454+
# source = None
455+
source = ''
454456
if constants.CAT_README_URL in repository_metadata.results:
455457
source = repository_metadata.results[constants.CAT_README_URL][0]
456458
source = source[constants.PROP_RESULT][constants.PROP_VALUE]
@@ -491,6 +493,16 @@ def extract_categories(repo_data: str, repository_metadata: Result) -> Tuple[Res
491493
if row[constants.PROP_PARENT_HEADER]:
492494
result[constants.PROP_PARENT_HEADER] = row[constants.PROP_PARENT_HEADER]
493495

496+
if row['Group'] == constants.CAT_LICENSE:
497+
license_text = row[constants.PROP_VALUE]
498+
license_info = detect_license_spdx(license_text, 'HEADER')
499+
if license_info:
500+
result[constants.PROP_TYPE] = constants.PROP_LICENSE
501+
result[constants.PROP_NAME] = license_info['name']
502+
result[constants.PROP_SPDX_ID] = license_info['spdx_id']
503+
result[constants.PROP_URL] = license_info.get('url', '')
504+
result[constants.PROP_VALUE] = license_info['spdx_id']
505+
494506
repository_metadata.add_result(
495507
row['Group'],
496508
result,

src/somef/test/test_JSON_export.py

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1071,6 +1071,42 @@ def test_issue_770(self):
10711071

10721072
os.remove(test_data_path + "test_issue_770.json")
10731073

1074+
def test_issue_634_header_license(self):
1075+
"""
1076+
Checks that a license mentioned in a README header is resolved to SPDX and merged with other license entries into a single unified entry.
1077+
"""
1078+
1079+
output_path = test_data_path + "test_issue_634_header_license.json"
1080+
1081+
somef_cli.run_cli(threshold=0.8,
1082+
ignore_classifiers=False,
1083+
repo_url=None,
1084+
local_repo=test_data_repositories + "mira",
1085+
doc_src=None,
1086+
in_file=None,
1087+
output=output_path,
1088+
graph_out=None,
1089+
graph_format="turtle",
1090+
codemeta_out=None,
1091+
pretty=True,
1092+
missing=False,
1093+
readme_only=False)
1094+
1095+
with open(output_path, "r") as text_file:
1096+
json_content = json.loads(text_file.read())
1097+
1098+
licenses = json_content[constants.CAT_LICENSE]
1099+
# print(licenses)
1100+
assert len(licenses) == 1, f"Expected just a merged license entry, found {len(licenses)}: {licenses}"
1101+
1102+
result = licenses[0][constants.PROP_RESULT]
1103+
1104+
assert result.get(constants.PROP_SPDX_ID) == "Apache-2.0", f"Expected spdx_id 'Apache-2.0', got: {result.get(constants.PROP_SPDX_ID)}"
1105+
1106+
techniques = licenses[0].get("technique", [])
1107+
assert "header_analysis" in techniques, f"Expected 'header_analysis' in techniques, got: {techniques}"
1108+
1109+
os.remove(output_path)
10741110

10751111
def test_issue_533_choosealicense_badge(self):
10761112
"""
@@ -1107,3 +1143,5 @@ def test_issue_533_choosealicense_badge(self):
11071143
assert constants.TECHNIQUE_REGULAR_EXPRESSION in techniques, f"Expected 'regular_expressions' in techniques, got: {techniques}"
11081144

11091145
os.remove(output_path)
1146+
1147+

src/somef/test/test_codemeta_parser.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
import unittest
22
import os
33
import yaml
4+
import logging
45
from pathlib import Path
56

67
from somef.parser.codemeta_parser import parse_codemeta_json_file
78
from somef.process_results import Result
89
from somef.utils import constants
910

11+
logging.basicConfig(level=logging.INFO)
1012
TEST_ROOT = Path(__file__).parent
1113
REPOS_DIR = TEST_ROOT / "test_data" / "repositories"
1214
EXPECT_DIR = TEST_ROOT / "test_data" / "expected"
@@ -19,19 +21,23 @@ def load_expected(self, repo_name):
1921
if not yaml_path.exists():
2022
if repo_name == "codemeta_repo":
2123
return {}
22-
self.skipTest(f"No expected YAML for repository '{repo_name}'")
24+
# self.skipTest(f"No expected YAML for repository '{repo_name}'")
25+
logging.warning(f"No expected YAML for repository '{repo_name}'")
26+
return None
2327
with open(yaml_path, "r", encoding="utf-8") as f:
2428
return yaml.safe_load(f)
2529

2630
def test_parse_multiple_codemeta_files(self):
2731
for repo_folder in os.listdir(REPOS_DIR):
28-
print(f"################# Testing {repo_folder} #################")
32+
logging.info(f"################# Testing {repo_folder} #################")
2933
repo_path = REPOS_DIR / repo_folder
3034
codemeta_path = repo_path / "codemeta.json"
3135
if not codemeta_path.is_file():
3236
continue
3337

3438
expected = self.load_expected(repo_folder)
39+
if expected is None:
40+
continue
3541
result = Result()
3642
metadata_result = parse_codemeta_json_file(
3743
str(codemeta_path),
@@ -42,7 +48,7 @@ def test_parse_multiple_codemeta_files(self):
4248
with self.subTest(repo=repo_folder):
4349
# In order for us to check every test, we need every file in "expected" directory to be of .yaml,
4450
# and make sure the name is the same as the repo folder
45-
print(f"################# Processing expectation of {repo_folder} #################")
51+
logging.info(f"################# Processing expectation of {repo_folder} #################")
4652
for cat_name, expected_val in expected.items():
4753
cat_const = getattr(constants, cat_name)
4854
actual_list = metadata_result.results.get(cat_const, [])
Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

0 commit comments

Comments
 (0)