def test_create_header_template_no_spdx(template_no_spdx):
"""Create a header with a template that does not have all SPDX info."""
spdx_info = SpdxInfo({"GPL-3.0-or-later"},
{"SPDX"
"-FileCopyrightText: Mary Sue"})
with pytest.raises(MissingSpdxInfo):
create_header(spdx_info, template=template_no_spdx)
def test_create_header_existing_is_wrong():
"""If the existing header contains errors, raise a CommentCreateError."""
spdx_info = SpdxInfo({"GPL-3.0-or-later"},
{"SPDX"
"-FileCopyrightText: Mary Sue"})
existing = cleandoc("""
# spdx-FileCopyrightText: John Doe
#
# spdx-License-Identifier: MIT AND OR 0BSD
""").replace("spdx", "SPDX")
with pytest.raises(CommentCreateError):
create_header(spdx_info, header=existing)
def test_create_header_simple():
"""Create a super simple header."""
spdx_info = SpdxInfo({"GPL-3.0-or-later"},
{"SPDX"
"-FileCopyrightText: Mary Sue"})
expected = cleandoc("""
# spdx-FileCopyrightText: Mary Sue
#
# spdx-License-Identifier: GPL-3.0-or-later
""").replace("spdx", "SPDX")
assert create_header(spdx_info).strip() == expected
def test_create_header_old_syntax():
"""Old copyright syntax is preserved when creating a new header."""
spdx_info = SpdxInfo({"GPL-3.0-or-later"}, set())
existing = cleandoc("""
# Copyright John Doe
""")
expected = cleandoc("""
# Copyright John Doe
#
# spdx-License-Identifier: GPL-3.0-or-later
""").replace("spdx", "SPDX")
assert create_header(spdx_info, header=existing).strip() == expected
def test_create_header_template_simple(template_simple):
"""Create a header with a simple template."""
spdx_info = SpdxInfo(set(["GPL-3.0-or-later"]),
set(["SPDX"
"-FileCopyrightText: Mary Sue"]))
expected = cleandoc("""
# Hello, world!
#
# spdx-FileCopyrightText: Mary Sue
#
# spdx-License-Identifier: GPL-3.0-or-later
""").replace("spdx", "SPDX")
assert create_header(spdx_info, template=template_simple) == expected
def test_create_header_template_simple(template_simple):
"""Create a header with a simple template."""
spdx_info = SpdxInfo({"GPL-3.0-or-later"},
{"SPDX"
"-FileCopyrightText: Jane Doe"})
expected = cleandoc("""
# Hello, world!
#
# spdx-FileCopyrightText: Jane Doe
#
# spdx-License-Identifier: GPL-3.0-or-later
""").replace("spdx", "SPDX")
assert (create_header(spdx_info,
template=template_simple).strip() == expected)
def test_create_header_remove_fluff():
"""Any stuff that isn't SPDX info is removed when using create_header."""
spdx_info = SpdxInfo({"GPL-3.0-or-later"}, set())
existing = cleandoc("""
# spdx-FileCopyrightText: John Doe
#
# Hello, world!
pass
""").replace("spdx", "SPDX")
expected = cleandoc("""
# SPDX-FileCopyrightText: John Doe
#
# spdx-License-Identifier: GPL-3.0-or-later
""").replace("spdx", "SPDX")
assert create_header(spdx_info, header=existing).strip() == expected
def test_create_header_already_contains_spdx():
"""Create a new header from a header that already contains SPDX info."""
spdx_info = SpdxInfo({"GPL-3.0-or-later"},
{"SPDX"
"-FileCopyrightText: Mary Sue"})
existing = cleandoc("""
# spdx-FileCopyrightText: John Doe
#
# spdx-License-Identifier: MIT
""").replace("spdx", "SPDX")
expected = cleandoc("""
# spdx-FileCopyrightText: John Doe
# spdx-FileCopyrightText: Mary Sue
#
# spdx-License-Identifier: GPL-3.0-or-later
# spdx-License-Identifier: MIT
""").replace("spdx", "SPDX")
assert create_header(spdx_info, header=existing).strip() == expected
def test_create_header_template_commented(template_commented):
"""Create a header with an already-commented template."""
spdx_info = SpdxInfo({"GPL-3.0-or-later"},
{"SPDX"
"-FileCopyrightText: Mary Sue"})
expected = cleandoc("""
# Hello, world!
#
# spdx-FileCopyrightText: Mary Sue
#
# spdx-License-Identifier: GPL-3.0-or-later
""").replace("spdx", "SPDX")
assert (create_header(
spdx_info,
template=template_commented,
template_is_commented=True,
style=CCommentStyle,
).strip() == expected)
