def bugs_before_major_releases_associate_with_previous_release_only(self):
b1 = b(1)
b2 = b(2)
f3 = f(3)
f4 = f(4)
f5 = f(5, spec="<2.0")
b6 = b(6)
entries = (
'2.0.0',
'1.2.0',
'1.1.1',
b6,
f5,
f4,
'1.1.0',
'1.0.1',
f3,
b2,
b1,
)
expected = {
'2.0.0': [f4], # but not f5
'1.2.0': [f5], # but not f4
'1.1.1': [b6],
'1.1.0': [f3],
'1.0.1': [b1, b2]
}
expect_releases(entries, expected)
def release_line_bugfix_specifier(self):
b50 = b(50)
b42 = b(42, spec='1.1+')
f25 = f(25)
b35 = b(35)
b34 = b(34)
f22 = f(22)
b20 = b(20)
c = changelog2dict(releases(
'1.2.1', '1.1.2', '1.0.3',
b50, b42,
'1.2.0', '1.1.1', '1.0.2',
f25, b35, b34,
'1.1.0', '1.0.1',
f22, b20
))
for rel, issues in (
('1.0.1', [b20]),
('1.1.0', [f22]),
('1.0.2', [b34, b35]),
('1.1.1', [b34, b35]),
('1.2.0', [f25]),
('1.0.3', [b50]), # the crux - is not b50 + b42
('1.1.2', [b50, b42]),
('1.2.1', [b50, b42]),
):
eq_(set(c[rel]), set(issues))
def plus_annotations_let_old_lines_continue_getting_released(self):
b9 = b(9)
f8 = f(8)
f7 = f(7, spec="1.0+")
b6 = b(6, spec="1.0+")
f5 = f(5)
f4 = f(4)
f3 = f(3)
b2 = b(2)
b1 = b(1)
entries = (
'2.1.0', '2.0.1', '1.2.0', '1.1.1', '1.0.2', b9, f8, f7, b6,
'2.0.0', f5, f4, '1.1.0', '1.0.1', f3, b2, b1,
)
expected = {
'2.1.0': [f7, f8],
'2.0.1': [b6, b9],
'1.2.0': [f7], # but not f8
'1.1.1': [b6], # but not b9
'1.0.2': [b6], # but not b9
'2.0.0': [f4, f5],
'1.1.0': [f3],
'1.0.1': [b1, b2],
}
expect_releases(entries, expected)
def specs_and_keywords_play_together_nicely(self):
b1 = b(1)
b2 = b(2, major=True, spec='1.0+')
f3 = f(3)
# Feature copied to both 1.x and 2.x branches
f4 = f(4, spec='1.0+')
# Support item backported to bugfix line + 1.17 + 2.0.0
s5 = s(5, spec='1.0+', backported=True)
entries = (
'2.0.0',
'1.17.0',
'1.16.1',
s5,
f4,
f3,
b2,
b1,
'1.16.0',
)
expected = {
'1.16.1': [b1, s5], # s5 backported ok
'1.17.0': [b2, f4, s5], # s5 here too, plus major bug b2
'2.0.0': [b2, f3, f4, s5], # all featurelike items here
}
expect_releases(entries, expected)
def explicit_bugfix_releases_get_removed_from_unreleased(self):
b1 = b(1)
b2 = b(2)
changelog = release_list('1.0.1', b1, b2)
# Ensure that 1.0.1 specifies bug 2
changelog[0][0].append(Text('2'))
rendered, _ = construct_releases(changelog, make_app())
# 1.0.1 should have bug 2 only
assert b2 in rendered[1]['entries']
assert b1 not in rendered[1]['entries']
# unreleased bug list should still get/see bug 1
assert b1 in rendered[2]['entries']
def unreleased_buckets_display_major_version_when_multiple(self):
entries = (
b(3), # should appear in unreleased bugs for 2.x
"2.0.0",
b(2), # should appear in unreleased bugs for 1.x
"1.0.1",
b(1),
)
# Expectation: [2.x unreleased, 1.x unreleased, 1.0.1]
two_x, one_x, _ = self._generate(*entries, raw=True)
html = str(two_x[0][0])
assert "Next 2.x bugfix release" in html
html = str(one_x[0][0])
assert "Next 1.x bugfix release" in html
def unreleased_buckets_display_major_version_when_multiple(self):
entries = (
b(3), # should appear in unreleased bugs for 2.x
'2.0.0',
b(2), # should appear in unreleased bugs for 1.x
'1.0.1',
b(1),
)
# Expectation: [2.x unreleased, 1.x unreleased, 1.0.1]
two_x, one_x, _ = self._generate(*entries, raw=True)
html = str(two_x[0][0])
assert "Next 2.x bugfix release" in html
html = str(one_x[0][0])
assert "Next 1.x bugfix release" in html
def all_bugs_before_first_release_act_featurelike(self):
b1 = b(1)
f2 = f(2)
b3 = b(3)
implicit = list_item('', paragraph('', '', raw('', 'whatever')))
changelog = changelog2dict(
releases('0.1.1', b3, '0.1.0', f2, b1, implicit,
skip_initial=True))
first = changelog['0.1.0']
second = changelog['0.1.1']
assert b1 in first
assert f2 in first
eq_(len(first), 3) # Meh, hard to assert about the implicit one
eq_(second, [b3])
def all_bugs_before_first_release_act_featurelike(self):
b1 = b(1)
f2 = f(2)
b3 = b(3)
implicit = list_item('', paragraph('', '', raw('', 'whatever')))
changelog = changelog2dict(releases(
'0.1.1', b3, '0.1.0', f2, b1, implicit,
skip_initial=True
))
first = changelog['0.1.0']
second = changelog['0.1.1']
assert b1 in first
assert f2 in first
eq_(len(first), 3) # Meh, hard to assert about the implicit one
eq_(second, [b3])
def unreleased_displays_version_when_only_some_lines_displayed(self):
# I.e. if there's unreleased 1.x stuff but no unreleased 2.x, still
# display the "1.x".
entries = (
# Note lack of any bugfixes post 2.0.0
"2.0.0",
b(2),
"1.0.1",
b(1),
)
# Expectation: [1.x unreleased, 1.0.1] - no 2.x.
result = self._generate(*entries, raw=True)
assert len(result) == 2
html = str(result[0][0][0])
assert "Next 1.x bugfix release" in html
def all_issue_types_rolled_up_together(self):
# Pre-1.0-only base case
entries = (
'0.1.1',
f(4),
b(3),
'0.1.0',
f(2),
b(1),
)
expected = {
'0.1.1': [b(3), f(4)],
'0.1.0': [b(1), f(2)],
}
self._expect_releases(entries, expected, skip_initial=True)
def unreleased_displays_version_when_only_some_lines_displayed(self):
# I.e. if there's unreleased 1.x stuff but no unreleased 2.x, still
# display the "1.x".
entries = (
# Note lack of any bugfixes post 2.0.0
'2.0.0',
b(2),
'1.0.1',
b(1),
)
# Expectation: [1.x unreleased, 1.0.1] - no 2.x.
result = self._generate(*entries, raw=True)
eq_(len(result), 2)
html = str(result[0][0][0])
assert "Next 1.x bugfix release" in html
def issues_are_sorted_by_type_within_releases(self):
b1 = b(123, major=True)
b2 = b(124, major=True)
s1 = s(25)
s2 = s(26)
f1 = f(3455)
f2 = f(3456)
# Semi random definitely-not-in-desired-order order
changelog = changelog2dict(releases('1.1', b1, s1, s2, f1, b2, f2))
# Order should be feature, bug, support. While it doesn't REALLY
# matter, assert that within each category the order matches the old
# 'reverse chronological' order.
eq_(changelog['1.1'], [f2, f1, b2, b1, s2, s1])
def oddly_ordered_bugfix_releases_and_unreleased_list(self):
# Release set up w/ non-contiguous feature+bugfix releases; catches
# funky problems with 'unreleased' buckets
b2 = b(2)
f3 = f(3)
changelog = releases('1.1.1', '1.0.2', self.f, b2, '1.1.0', f3, self.b)
assert f3 in changelog[1]['entries']
assert b2 in changelog[2]['entries']
assert b2 in changelog[3]['entries']
def rolling_release_works_without_annotation(self):
b1 = b(1)
b2 = b(2)
f3 = f(3)
f4 = f(4)
f5 = f(5)
b6 = b(6)
f7 = f(7)
entries = ('2.1.0', '2.0.1', f7, b6, '2.0.0', f5, f4, '1.1.0', '1.0.1',
f3, b2, b1)
expected = {
'1.0.1': [b1, b2],
'1.1.0': [f3],
'2.0.0': [f4, f5],
'2.0.1': [b6],
'2.1.0': [f7],
}
expect_releases(entries, expected)
def semver_spec_annotations_allow_preventing_forward_porting(self):
f9 = f(9, spec=">=1.0")
f8 = f(8)
b7 = b(7, spec="<2.0")
b6 = b(6, spec="1.0+")
f5 = f(5)
f4 = f(4)
f3 = f(3)
b2 = b(2)
b1 = b(1)
entries = (
'2.1.0',
'2.0.1',
'1.2.0',
'1.1.1',
'1.0.2',
f9,
f8,
b7,
b6,
'2.0.0',
f5,
f4,
'1.1.0',
'1.0.1',
f3,
b2,
b1,
)
expected = {
'2.1.0': [f8, f9],
'2.0.1': [b6], # (but not #7)
'1.2.0': [f9], # (but not #8)
'1.1.1': [b6, b7],
'1.0.2': [b6, b7],
'2.0.0': [f4, f5],
'1.1.0': [f3],
'1.0.1': [b1, b2],
}
expect_releases(entries, expected)
def releases_can_specify_issues_explicitly(self):
# Build regular list-o-entries
b2 = b(2)
b3 = b(3)
changelog = release_list('1.0.1', '1.1.1', b3, b2, self.b, '1.1.0',
self.f)
# Modify 1.0.1 release to be speshul
changelog[0][0].append(Text("2, 3"))
rendered = construct_releases(changelog, make_app())
# 1.0.1 includes just 2 and 3, not bug 1
one_0_1 = rendered[3]['entries']
one_1_1 = rendered[2]['entries']
assert self.b not in one_0_1
assert b2 in one_0_1
assert b3 in one_0_1
# 1.1.1 includes all 3 (i.e. the explicitness of 1.0.1 didn't affect
# the 1.1 line bucket.)
assert self.b in one_1_1
assert b2 in one_1_1
assert b3 in one_1_1
def rolling_release_works_without_annotation(self):
b1 = b(1)
b2 = b(2)
f3 = f(3)
f4 = f(4)
f5 = f(5)
b6 = b(6)
f7 = f(7)
entries = (
'2.1.0', '2.0.1', f7, b6, '2.0.0', f5, f4, '1.1.0', '1.0.1', f3,
b2, b1
)
expected = {
'1.0.1': [b1, b2],
'1.1.0': [f3],
'2.0.0': [f4, f5],
'2.0.1': [b6],
'2.1.0': [f7],
}
expect_releases(entries, expected)
def oddly_ordered_bugfix_releases_and_unreleased_list(self):
# Release set up w/ non-contiguous feature+bugfix releases; catches
# funky problems with 'unreleased' buckets
b2 = b(2)
f3 = f(3)
changelog = releases(
'1.1.1', '1.0.2', self.f, b2, '1.1.0', f3, self.b
)
assert f3 in changelog[1]['entries']
assert b2 in changelog[2]['entries']
assert b2 in changelog[3]['entries']
def releases_can_specify_issues_explicitly(self):
# Build regular list-o-entries
b2 = b(2)
b3 = b(3)
changelog = release_list(
'1.0.1', '1.1.1', b3, b2, self.b, '1.1.0', self.f
)
# Modify 1.0.1 release to be speshul
changelog[0][0].append(Text("2, 3"))
rendered, _ = construct_releases(changelog, make_app())
# 1.0.1 includes just 2 and 3, not bug 1
one_0_1 = rendered[3]['entries']
one_1_1 = rendered[2]['entries']
assert self.b not in one_0_1
assert b2 in one_0_1
assert b3 in one_0_1
# 1.1.1 includes all 3 (i.e. the explicitness of 1.0.1 didn't affect
# the 1.1 line bucket.)
assert self.b in one_1_1
assert b2 in one_1_1
assert b3 in one_1_1
def features_before_first_release_function_correctly(self):
f0 = f(0)
b1 = b(1)
f2 = f(2)
entries = ('0.2.0', f2, '0.1.1', b1, '0.1.0', f0)
expected = {
'0.1.0': [f0],
'0.1.1': [b1],
'0.2.0': [f2],
}
# Make sure to skip typically-implicit 1.0.0 release.
# TODO: consider removing that entirely; arguably needing it is a bug?
expect_releases(entries, expected, skip_initial=True)
def _test_link(self, kwargs, type_, expected):
app = make_app(**kwargs)
nodes = construct_nodes(construct_releases([
release('1.0.2', app=app),
entry(b(15, app=app)),
release('1.0.0'),
], app=app))
if type_ == 'release':
header = nodes[0][0][0].astext()
assert expected in header
elif type_ == 'issue':
link = nodes[0][1][0][0][2]
eq_(link['refuri'], expected)
else:
raise Exception("Gave unknown type_ kwarg to _test_link()!")
def features_before_first_release_function_correctly(self):
f0 = f(0)
b1 = b(1)
f2 = f(2)
entries = (
'0.2.0', f2, '0.1.1', b1, '0.1.0', f0
)
expected = {
'0.1.0': [f0],
'0.1.1': [b1],
'0.2.0': [f2],
}
# Make sure to skip typically-implicit 1.0.0 release.
# TODO: consider removing that entirely; arguably needing it is a bug?
expect_releases(entries, expected, skip_initial=True)
def _test_link(self, kwargs, type_, expected):
app = make_app(**kwargs)
nodes = construct_nodes(
construct_releases([
release('1.0.2', app=app),
entry(b(15, app=app)),
release('1.0.0'),
],
app=app))
if type_ == 'release':
header = nodes[0][0][0].astext()
assert expected in header
elif type_ == 'issue':
link = nodes[0][1][0][0][2]
eq_(link['refuri'], expected)
else:
raise Exception("Gave unknown type_ kwarg to _test_link()!")
def _test_link(self, kwargs, type_, expected):
app = make_app(**kwargs)
nodes = construct_nodes(
construct_releases(
[
release("1.0.2", app=app),
entry(b(15, app=app)),
release("1.0.0"),
],
app=app,
)[0])
# Shorthand for "I'll do my own asserts"
if expected is None:
return nodes
if type_ == "release":
header = nodes[0][0][0].astext()
assert expected in header
elif type_ == "issue":
link = nodes[0][1][0][0][2]
assert link["refuri"] == expected
else:
raise Exception("Gave unknown type_ kwarg to _test_link()!")
def doesnt_care_if_you_skipped_1_0_entirely(self):
# Mixed changelog where 1.0 is totally skipped and one goes to 2.0
entries = (
'2.1.0',
'2.0.1',
f(6),
b(5),
'2.0.0',
f(4),
b(3),
'0.1.0',
f(2),
b(1),
)
expected = {
'2.1.0': [f(6)],
'2.0.1': [b(5)],
'2.0.0': [b(3), f(4)],
'0.1.0': [b(1), f(2)],
}
self._expect_releases(entries, expected, skip_initial=True)
def does_not_affect_releases_after_1_0(self):
# Mixed changelog crossing 1.0 boundary
entries = (
'1.1.0',
'1.0.1',
f(6),
b(5),
'1.0.0',
f(4),
b(3),
'0.1.0',
f(2),
b(1),
)
expected = {
'1.1.0': [f(6)],
'1.0.1': [b(5)],
'1.0.0': [b(3), f(4)],
'0.1.0': [b(1), f(2)],
}
self._expect_releases(entries, expected, skip_initial=True)
def duplicate_zeroes_dont_error(self):
cl = releases('1.0.1', b(0), b(0))
cl = changelog2dict(cl)
assert len(cl['1.0.1']) == 2
def unstable_prehistory_active_means_only_one_unreleased_release(self):
app = make_app(unstable_prehistory=True)
entries = (b(2), f(3), '0.1.0', b(1))
result = self._generate(*entries, app=app, raw=True, skip_initial=True)
html = str(result[0][0][0])
assert "Next release" in html
def dashed_issues_appear_as_unlinked_issues(self):
node = self._generate('1.0.2', b('-'))
assert not isinstance(node[0][2], reference)
def zeroed_issues_appear_as_unlinked_issues(self):
node = self._generate("1.0.2", b(0))
assert not isinstance(node[0][2], reference)
def unreleased_buckets_omit_major_version_when_only_one_exists(self):
result = self._generate(b(1), raw=True)[0][0][0]
html = str(result) # since repr() from test-fail hides actual text
assert "Next bugfix release" in html
def zeroed_issues_appear_as_unlinked_issues(self):
node = self._generate('1.0.2', b(0))
assert not isinstance(node[0][2], reference)
def unreleased_buckets_omit_major_version_when_only_one_exists(self):
result = self._generate(b(1), raw=True)[0][0][0]
html = str(result) # since repr() from test-fail hides actual text
assert "Next bugfix release" in html
def unstable_prehistory_active_means_only_one_unreleased_release(self):
app = make_app(unstable_prehistory=True)
entries = (b(2), f(3), "0.1.0", b(1))
result = self._generate(*entries, app=app, raw=True, skip_initial=True)
html = str(result[0][0][0])
assert "Next release" in html
def explicit_release_list_split_works_with_unicode(self):
changelog = release_list('1.0.1', b(17))
changelog[0][0].append(Text(six.text_type('17')))
# When using naive method calls, this explodes
construct_releases(changelog, make_app())
