Fix global licensing being ignored with a .license file #1058
Conversation
nea89o
force-pushed
the
fix/dotlicensewithgloballicensinginfo
branch
3 times, most recently
from
3cd76de to
56d6a34
Compare
There was a problem hiding this comment.
Hi @nea89o and thanks for your contribution! I struggled a bit with the reading of the issue, so I'm going to re-summarise to make sure I understand correctly:
Using closest logic, if there is copyright information inside of a file, and licensing information inside of REUSE.toml, then they are both applied to the file.
However, as I understand it, the tool currently poorly/incorrectly handles the situation where the copyright information is inside of the file's .license file.
Does that seem right?
Thanks again for your contribution!
tests/test_project.py
Outdated
| [[annotations]] | ||
| path = "*.py" | ||
| SPDX-FileCopyrightText = "2017 Jane Doe" | ||
| SPDX-License-Identifier = "CC0-1.0" | ||
|
|
||
| [[annotations]] | ||
| path = "*.py.license" | ||
| SPDX-FileCopyrightText = "2017 Jane Doe" | ||
| SPDX-License-Identifier = "MIT" |
There was a problem hiding this comment.
This is a little strange to me, and seems incorrect. A .license file cannot/does not have licensing itself. The logic of REUSE is that these .license files are direct substitutes licensing-wise. This means that foo.py.license completely overrides the REUSE information inside of foo.py, and whenever foo.py is referenced anywhere (in REUSE.toml or in the code), we should really be looking at the contents of foo.py.license instead.
The second [[annotations]] table should probably be removed.
There was a problem hiding this comment.
The old behaviour would look up the information for the .license file path in the REUSE.toml instead of looking up the non .license file path. Because of that I thought i would add an explicit test that the .license file information in the REUSE.toml is ignored. If you think that test should not exist i can also remove those parts (which includes the "MIT" not in check down there.
There was a problem hiding this comment.
I had another look at this. It took me a while to get it, but I think I understand. You're testing here that .license files are not valid targets inside of a REUSE.toml files, and should therefore be ignored.
I've moved this to a different test, to reduce the amount of stuff happening inside of one test. I've also simplified the initial test a little by reducing the amount of files, and by using aggregate instead of closest.
Thanks for your contribution!
The old test tried to do way too much at the same time. It has been thoroughly simplified where possible, and split up where not possible. Signed-off-by: Carmen Bianca BAKKER <[email protected]>
carmenbianca
force-pushed
the
fix/dotlicensewithgloballicensinginfo
branch
from
56d6a34 to
985bfba
Compare
Fixes #1057
changelog.d/<directory>/.AUTHORS.rst.docs/man/or elsewhere. (n/a)the current specification.
changed files.