mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
a84f7009ac
Only substitute copyright notice years with values from ``SOURCE_DATE_EPOCH`` for entries that match the current system clock year, and disallow substitution of future years. Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
82 lines
2.9 KiB
Python
82 lines
2.9 KiB
Python
import time
|
|
|
|
import pytest
|
|
|
|
LT = time.localtime()
|
|
LT_NEW = (2009, *LT[1:], LT.tm_zone, LT.tm_gmtoff)
|
|
LOCALTIME_2009 = type(LT)(LT_NEW)
|
|
|
|
|
|
@pytest.fixture(
|
|
params=[
|
|
1199145600, # 2008-01-01 00:00:00
|
|
1199145599, # 2007-12-31 23:59:59
|
|
]
|
|
)
|
|
def source_date_year(request, monkeypatch):
|
|
source_date_epoch = request.param
|
|
with monkeypatch.context() as m:
|
|
m.setattr(time, 'localtime', lambda *a: LOCALTIME_2009)
|
|
m.setenv('SOURCE_DATE_EPOCH', str(source_date_epoch))
|
|
yield time.gmtime(source_date_epoch).tm_year
|
|
|
|
|
|
@pytest.mark.sphinx('html', testroot='copyright-multiline')
|
|
def test_html_multi_line_copyright(app):
|
|
app.build(force_all=True)
|
|
|
|
content = (app.outdir / 'index.html').read_text(encoding='utf-8')
|
|
|
|
# check the copyright footer line by line (empty lines ignored)
|
|
assert ' © Copyright 2006.<br/>\n' in content
|
|
assert ' © Copyright 2006-2009, Alice.<br/>\n' in content
|
|
assert ' © Copyright 2010-2013, Bob.<br/>\n' in content
|
|
assert ' © Copyright 2014-2017, Charlie.<br/>\n' in content
|
|
assert ' © Copyright 2018-2021, David.<br/>\n' in content
|
|
assert ' © Copyright 2022-2025, Eve.' in content
|
|
|
|
# check the raw copyright footer block (empty lines included)
|
|
assert (
|
|
' © Copyright 2006.<br/>\n'
|
|
' \n'
|
|
' © Copyright 2006-2009, Alice.<br/>\n'
|
|
' \n'
|
|
' © Copyright 2010-2013, Bob.<br/>\n'
|
|
' \n'
|
|
' © Copyright 2014-2017, Charlie.<br/>\n'
|
|
' \n'
|
|
' © Copyright 2018-2021, David.<br/>\n'
|
|
' \n'
|
|
' © Copyright 2022-2025, Eve.'
|
|
) in content
|
|
|
|
|
|
@pytest.mark.sphinx('html', testroot='copyright-multiline')
|
|
def test_html_multi_line_copyright_sde(source_date_year, app):
|
|
app.build(force_all=True)
|
|
|
|
content = (app.outdir / 'index.html').read_text(encoding='utf-8')
|
|
|
|
# check the copyright footer line by line (empty lines ignored)
|
|
assert ' © Copyright 2006.<br/>\n' in content
|
|
assert f' © Copyright 2006-{source_date_year}, Alice.<br/>\n' in content
|
|
assert ' © Copyright 2010-2013, Bob.<br/>\n' in content
|
|
assert ' © Copyright 2014-2017, Charlie.<br/>\n' in content
|
|
assert ' © Copyright 2018-2021, David.<br/>\n' in content
|
|
assert ' © Copyright 2022-2025, Eve.' in content
|
|
|
|
# check the raw copyright footer block (empty lines included)
|
|
assert (
|
|
' © Copyright 2006.<br/>\n'
|
|
' \n'
|
|
f' © Copyright 2006-{source_date_year}, Alice.<br/>\n'
|
|
' \n'
|
|
' © Copyright 2010-2013, Bob.<br/>\n'
|
|
' \n'
|
|
' © Copyright 2014-2017, Charlie.<br/>\n'
|
|
' \n'
|
|
' © Copyright 2018-2021, David.<br/>\n'
|
|
' \n'
|
|
' © Copyright 2022-2025, Eve.'
|
|
) in content
|