def test_changelog_fragment_lint_broken( # pylint: disable=redefined-outer-name
collection_changelog): # noqa: F811
collection_changelog.set_config(collection_changelog.config)
collection_changelog.add_fragment_line('list-instead-of-string.yml', 'release_summary', ['List', 'asfd'])
collection_changelog.add_fragment_line('int-instead-of-string.yml', 'release_summary', 42)
collection_changelog.add_fragment_line('int-instead-of-list.yml', 'bugfixes', 42)
collection_changelog.add_fragment_line('string-instead-of-list.yml', 'minor_changes', 'test')
collection_changelog.add_fragment_line('list-of-ints.yaml', 'minor_changes', [42, 37])
collection_changelog.add_fragment_line('wrong-category.yaml', 'minor_change', ['a'])
collection_changelog.add_fragment('not-a-dict.yaml', '23')
collection_changelog.add_fragment('invalid-yaml.yaml', 'test: {')
# Lint fragments
rc, stdout, stderr = collection_changelog.run_tool_w_output('lint', [])
assert rc == 3
assert stdout == r'''
changelogs/fragments/int-instead-of-list.yml:0:0: section "bugfixes" must be type list not int
changelogs/fragments/int-instead-of-string.yml:0:0: section "release_summary" must be type str not int
changelogs/fragments/invalid-yaml.yaml:0:0: yaml parsing error
changelogs/fragments/list-instead-of-string.yml:0:0: section "release_summary" must be type str not list
changelogs/fragments/list-of-ints.yaml:0:0: section "minor_changes" list items must be type str not int
changelogs/fragments/not-a-dict.yaml:0:0: file must be a mapping not int
changelogs/fragments/string-instead-of-list.yml:0:0: section "minor_changes" must be type list not str
changelogs/fragments/wrong-category.yaml:0:0: invalid section: minor_change
'''.lstrip()
# Lint non-existing fragment
rc, stdout, stderr = collection_changelog.run_tool_w_output('lint', ['changelogs/fragments/non-existing'])
assert rc == 3
assert stdout == r'''
changelogs/fragments/non-existing:0:0: yaml parsing error
'''.lstrip()
def test_changelog_release_empty(collection_changelog):
collection_changelog.set_galaxy({
'version': '1.0.0',
})
collection_changelog.set_config(collection_changelog.config)
collection_changelog.add_fragment_line(
'1.0.0.yml', 'release_summary', 'This is the first proper release.')
collection_changelog.set_plugin_cache('1.0.0', {})
assert collection_changelog.run_tool('release',
['-v', '--date', '2020-01-02']) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == [
'changelogs/CHANGELOG.rst', 'changelogs/changelog.yaml'
]
assert diff.removed_dirs == []
assert diff.removed_files == ['changelogs/fragments/1.0.0.yml']
assert diff.changed_files == []
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['ancestor'] is None
assert list(changelog['releases']) == ['1.0.0']
assert changelog['releases']['1.0.0']['release_date'] == '2020-01-02'
assert changelog['releases']['1.0.0']['changes'] == {
'release_summary': 'This is the first proper release.'
}
assert changelog['releases']['1.0.0']['fragments'] == ['1.0.0.yml']
assert 'modules' not in changelog['releases']['1.0.0']
assert 'plugins' not in changelog['releases']['1.0.0']
assert 'codename' not in changelog['releases']['1.0.0']
def test_changelog_fragment_lint_correct( # pylint: disable=redefined-outer-name
collection_changelog): # noqa: F811
collection_changelog.set_config(collection_changelog.config)
collection_changelog.add_fragment_line(
'1.0.0.yml', 'release_summary', 'This is the first proper release.')
collection_changelog.add_fragment_line(
'test-new-option.yml', 'minor_changes',
['test - has a new option ``foo``.'])
collection_changelog.add_fragment_line(
'baz-new-option.yaml', 'minor_changes',
['baz lookup - no longer ignores the ``bar`` option.'])
# Lint fragments
rc, stdout, stderr = collection_changelog.run_tool_w_output('lint', [])
assert rc == 0
assert stdout == ''
# Lint explicitly named fragment
rc, stdout, stderr = collection_changelog.run_tool_w_output(
'lint', ['changelogs/fragments/1.0.0.yml'])
assert rc == 0
assert stdout == ''
def test_changelog_release_simple_no_galaxy( # pylint: disable=redefined-outer-name
collection_changelog): # noqa: F811
collection_changelog.config.title = 'Test Collection'
collection_changelog.set_config(collection_changelog.config)
collection_changelog.add_fragment_line(
'1.0.0.yml', 'release_summary', 'This is the first proper release.')
collection_changelog.add_fragment_line(
'test-new-option.yml', 'minor_changes',
['test - has a new option ``foo``.'])
collection_changelog.add_fragment_line(
'baz-new-option.yaml', 'minor_changes',
['baz lookup - no longer ignores the ``bar`` option.'])
# If we don't specify all options, the call will fail
assert collection_changelog.run_tool('release',
['-v', '--date', '2020-01-02']) == 5
assert collection_changelog.run_tool(
'release',
[ # without --version
'-v',
'--date',
'2020-01-02',
'--is-collection',
'true',
'--collection-namespace',
'cloud',
'--collection-name',
'sky',
'--collection-flatmap',
'yes',
]) == 5
assert collection_changelog.run_tool(
'release',
[ # without --is-collection
'-v',
'--date',
'2020-01-02',
'--version',
'1.0.0',
'--collection-namespace',
'cloud',
'--collection-name',
'sky',
'--collection-flatmap',
'yes',
]) == 5
assert collection_changelog.run_tool(
'release',
[ # without --collection-namespace
'-v',
'--date',
'2020-01-02',
'--version',
'1.0.0',
'--is-collection',
'true',
'--collection-name',
'sky',
'--collection-flatmap',
'yes',
]) == 5
assert collection_changelog.run_tool(
'release',
[ # without --collection-name
'-v',
'--date',
'2020-01-02',
'--version',
'1.0.0',
'--is-collection',
'true',
'--collection-namespace',
'cloud',
'--collection-flatmap',
'yes',
]) == 5
assert collection_changelog.run_tool(
'release',
[ # without --collection-flatmap
'-v',
'--date',
'2020-01-02',
'--version',
'1.0.0',
'--is-collection',
'true',
'--collection-namespace',
'cloud',
'--collection-name',
'sky',
]) == 5
# Add plugin cache content
collection_changelog.set_plugin_cache(
'1.0.0', {
'module': {
'test': {
'name': 'test',
'description': 'This is a test module',
'namespace': '',
'version_added': '1.0.0',
},
'test1': {
'name': 'test1',
'description': 'This is a test module',
'namespace': 'test',
'version_added': '1.0.0',
},
'test2': {
'name': 'test2',
'description': 'This is a test module',
'namespace': 'test.foo',
'version_added': '1.0.0',
},
'test3': {
'name': 'test3',
'description': 'This is a test module',
'namespace': 'test.bar',
'version_added': '1.0.0',
},
'test4': {
'name': 'test4',
'description': 'This is a test module',
'namespace': 'foo',
'version_added': '1.0.0',
},
'test5': {
'name': 'test5',
'description': 'This is a test module',
'namespace': 'bar.baz',
'version_added': '1.0.0',
},
'test6': {
'name': 'test6',
'description': 'This is a test module',
'namespace': 'foo.bar.baz',
'version_added': '1.0.0',
},
},
'lookup': {
'bar': {
'name': 'bar',
'description': 'A foo bar lookup',
'namespace': None,
'version_added': '1.0.0',
},
'baz': {
'name': 'baz',
'description': 'Has already been here',
'namespace': None,
'version_added': None,
},
},
})
# If we specify all options, the call will succeed
assert collection_changelog.run_tool(
'release',
[
'-v',
'--date',
'2020-01-02',
'--version',
'1.0.0',
'--is-collection',
'true',
# The following two options are not needed since the tool doesn't have to scan for plugins:
# '--collection-namespace', 'cloud',
# '--collection-name', 'sky',
'--collection-flatmap',
'yes',
]) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == [
'changelogs/CHANGELOG.rst', 'changelogs/changelog.yaml'
]
assert diff.removed_dirs == []
assert diff.removed_files == [
'changelogs/fragments/1.0.0.yml',
'changelogs/fragments/baz-new-option.yaml',
'changelogs/fragments/test-new-option.yml',
]
assert diff.changed_files == []
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['ancestor'] is None
assert list(changelog['releases']) == ['1.0.0']
assert changelog['releases']['1.0.0']['release_date'] == '2020-01-02'
assert changelog['releases']['1.0.0']['changes'] == {
'release_summary':
'This is the first proper release.',
'minor_changes': [
'baz lookup - no longer ignores the ``bar`` option.',
'test - has a new option ``foo``.',
],
}
assert changelog['releases']['1.0.0']['fragments'] == [
'1.0.0.yml',
'baz-new-option.yaml',
'test-new-option.yml',
]
assert changelog['releases']['1.0.0']['modules'] == [
{
'name': 'test',
'description': 'This is a test module',
'namespace': '',
},
{
'name': 'test1',
'description': 'This is a test module',
'namespace': 'test',
},
{
'name': 'test2',
'description': 'This is a test module',
'namespace': 'test.foo',
},
{
'name': 'test3',
'description': 'This is a test module',
'namespace': 'test.bar',
},
{
'name': 'test4',
'description': 'This is a test module',
'namespace': 'foo',
},
{
'name': 'test5',
'description': 'This is a test module',
'namespace': 'bar.baz',
},
{
'name': 'test6',
'description': 'This is a test module',
'namespace': 'foo.bar.baz',
},
]
assert changelog['releases']['1.0.0']['plugins'] == {
'lookup': [
{
'name': 'bar',
'description': 'A foo bar lookup',
'namespace': None,
},
],
}
assert 'codename' not in changelog['releases']['1.0.0']
assert diff.file_contents['changelogs/CHANGELOG.rst'].decode('utf-8') == (
r'''=============================
Test Collection Release Notes
=============================
.. contents:: Topics
v1.0.0
======
Release Summary
---------------
This is the first proper release.
Minor Changes
-------------
- baz lookup - no longer ignores the ``bar`` option.
- test - has a new option ``foo``.
New Plugins
-----------
Lookup
~~~~~~
- bar - A foo bar lookup
New Modules
-----------
- test - This is a test module
Bar
~~~
baz
^^^
- test5 - This is a test module
Foo
~~~
- test4 - This is a test module
bar.baz
^^^^^^^
- test6 - This is a test module
Test
~~~~
- test1 - This is a test module
bar
^^^
- test3 - This is a test module
foo
^^^
- test2 - This is a test module
''')
def test_changelog_release_empty( # pylint: disable=redefined-outer-name
collection_changelog): # noqa: F811
collection_changelog.set_galaxy({
'version': '1.0.0',
})
collection_changelog.set_config(collection_changelog.config)
collection_changelog.add_fragment_line(
'1.0.0.yml', 'release_summary', 'This is the first proper release.')
collection_changelog.set_plugin_cache('1.0.0', {})
assert collection_changelog.run_tool('release',
['-v', '--date', '2020-01-02']) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == [
'changelogs/CHANGELOG.rst', 'changelogs/changelog.yaml'
]
assert diff.removed_dirs == []
assert diff.removed_files == ['changelogs/fragments/1.0.0.yml']
assert diff.changed_files == []
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['ancestor'] is None
assert list(changelog['releases']) == ['1.0.0']
assert changelog['releases']['1.0.0']['release_date'] == '2020-01-02'
assert changelog['releases']['1.0.0']['changes'] == {
'release_summary': 'This is the first proper release.'
}
assert changelog['releases']['1.0.0']['fragments'] == ['1.0.0.yml']
assert 'modules' not in changelog['releases']['1.0.0']
assert 'plugins' not in changelog['releases']['1.0.0']
assert 'codename' not in changelog['releases']['1.0.0']
assert diff.file_contents['changelogs/CHANGELOG.rst'].decode('utf-8') == (
r'''=====================
Ansible Release Notes
=====================
.. contents:: Topics
v1.0.0
======
Release Summary
---------------
This is the first proper release.
''')
assert collection_changelog.run_tool('generate', ['-v', '--refresh']) == 0
assert collection_changelog.diff().unchanged
# Version 1.1.0
collection_changelog.set_galaxy({
'version': '1.1.0',
})
collection_changelog.set_plugin_cache('1.1.0', {})
assert collection_changelog.run_tool('release',
['-v', '--date', '2020-02-29']) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == []
assert diff.removed_dirs == []
assert diff.removed_files == []
assert diff.changed_files == [
'changelogs/CHANGELOG.rst', 'changelogs/changelog.yaml'
]
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['ancestor'] is None
assert list(changelog['releases']) == ['1.0.0', '1.1.0']
assert changelog['releases']['1.1.0']['release_date'] == '2020-02-29'
assert 'changes' not in changelog['releases']['1.1.0']
assert 'fragments' not in changelog['releases']['1.1.0']
assert 'modules' not in changelog['releases']['1.1.0']
assert 'plugins' not in changelog['releases']['1.1.0']
assert 'codename' not in changelog['releases']['1.1.0']
assert diff.file_contents['changelogs/CHANGELOG.rst'].decode('utf-8') == (
r'''=====================
Ansible Release Notes
=====================
.. contents:: Topics
v1.1.0
======
v1.0.0
======
Release Summary
---------------
This is the first proper release.
''')
assert collection_changelog.run_tool('generate', ['-v', '--refresh']) == 0
assert collection_changelog.diff().unchanged
def test_changelog_release_simple( # pylint: disable=redefined-outer-name
collection_changelog): # noqa: F811
collection_changelog.set_galaxy({
'version': '1.0.0',
})
collection_changelog.config.changelog_filename_version_depth = 2
collection_changelog.set_config(collection_changelog.config)
collection_changelog.add_fragment_line(
'1.0.0.yml', 'release_summary', 'This is the first proper release.')
collection_changelog.add_fragment_line(
'test-new-option.yml', 'minor_changes',
['test - has a new option ``foo``.'])
collection_changelog.add_fragment_line(
'baz-new-option.yaml', 'minor_changes',
['baz lookup - no longer ignores the ``bar`` option.'])
collection_changelog.set_plugin_cache(
'1.0.0', {
'module': {
'test': {
'name': 'test',
'description': 'This is a test module',
'namespace': '',
'version_added': '1.0.0',
},
},
'lookup': {
'bar': {
'name': 'bar',
'description': 'A foo bar lookup',
'namespace': None,
'version_added': '1.0.0',
},
'baz': {
'name': 'baz',
'description': 'Has already been here',
'namespace': None,
'version_added': None,
},
'boom': {
'name': 'boom',
'description': 'Something older',
'namespace': None,
'version_added': '0.5.0',
},
},
})
# Lint fragments
assert collection_changelog.run_tool('lint', ['-vv']) == 0
# Release
assert collection_changelog.run_tool('release',
['-v', '--date', '2020-01-02']) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == [
'changelogs/CHANGELOG.rst', 'changelogs/changelog.yaml'
]
assert diff.removed_dirs == []
assert diff.removed_files == [
'changelogs/fragments/1.0.0.yml',
'changelogs/fragments/baz-new-option.yaml',
'changelogs/fragments/test-new-option.yml',
]
assert diff.changed_files == []
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['ancestor'] is None
assert list(changelog['releases']) == ['1.0.0']
assert changelog['releases']['1.0.0']['release_date'] == '2020-01-02'
assert changelog['releases']['1.0.0']['changes'] == {
'release_summary':
'This is the first proper release.',
'minor_changes': [
'baz lookup - no longer ignores the ``bar`` option.',
'test - has a new option ``foo``.',
],
}
assert changelog['releases']['1.0.0']['fragments'] == [
'1.0.0.yml',
'baz-new-option.yaml',
'test-new-option.yml',
]
assert changelog['releases']['1.0.0']['modules'] == [
{
'name': 'test',
'description': 'This is a test module',
'namespace': '',
},
]
assert changelog['releases']['1.0.0']['plugins'] == {
'lookup': [
{
'name': 'bar',
'description': 'A foo bar lookup',
'namespace': None,
},
],
}
assert 'codename' not in changelog['releases']['1.0.0']
assert diff.file_contents['changelogs/CHANGELOG.rst'].decode('utf-8') == (
r'''=========================
Ansible 1.0 Release Notes
=========================
.. contents:: Topics
v1.0.0
======
Release Summary
---------------
This is the first proper release.
Minor Changes
-------------
- baz lookup - no longer ignores the ``bar`` option.
- test - has a new option ``foo``.
New Plugins
-----------
Lookup
~~~~~~
- bar - A foo bar lookup
New Modules
-----------
- test - This is a test module
''')
# Check that regenerate doesn't change anything
assert collection_changelog.run_tool('generate', ['-v']) == 0
assert collection_changelog.diff().unchanged
# Update plugin descriptions
collection_changelog.set_plugin_cache(
'1.0.0', {
'module': {
'test': {
'name': 'test',
'description': 'This is a TEST module',
'namespace': '',
'version_added': '1.0.0',
},
},
'lookup': {
'bar': {
'name': 'bar',
'description': 'A foo_bar lookup',
'namespace': None,
'version_added': '1.0.0',
},
'baz': {
'name': 'baz',
'description': 'Has already been here before',
'namespace': None,
'version_added': None,
},
'boom': {
'name': 'boom',
'description': 'Something older',
'namespace': None,
'version_added': '0.5.0',
},
},
})
# Add another fragment
collection_changelog.add_fragment_line('test-new-fragment.yml',
'minor_changes',
['Another new fragment.'])
# Check that regenerate without --refresh doesn't change anything
assert collection_changelog.run_tool('generate', ['-v']) == 0
assert collection_changelog.diff().unchanged
# Check that regenerate with --refresh changes
assert collection_changelog.run_tool('generate', ['-v', '--refresh']) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == []
assert diff.removed_dirs == []
assert diff.removed_files == []
assert diff.changed_files == [
'changelogs/CHANGELOG.rst', 'changelogs/changelog.yaml'
]
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['releases']['1.0.0']['modules'] == [
{
'name': 'test',
'description': 'This is a TEST module',
'namespace': '',
},
]
assert changelog['releases']['1.0.0']['plugins'] == {
'lookup': [
{
'name': 'bar',
'description': 'A foo_bar lookup',
'namespace': None,
},
],
}
assert diff.file_contents['changelogs/CHANGELOG.rst'].decode('utf-8') == (
r'''=========================
Ansible 1.0 Release Notes
=========================
.. contents:: Topics
v1.0.0
======
Release Summary
---------------
This is the first proper release.
Minor Changes
-------------
- baz lookup - no longer ignores the ``bar`` option.
- test - has a new option ``foo``.
New Plugins
-----------
Lookup
~~~~~~
- bar - A foo_bar lookup
New Modules
-----------
- test - This is a TEST module
''')
# Update plugin descriptions for 1.1.0 beta 1
collection_changelog.set_plugin_cache(
'1.1.0-beta-1', {
'module': {
'test': {
'name': 'test',
'description': 'This is a TEST module',
'namespace': '',
'version_added': '1.0.0',
},
'test_new': {
'name': 'test_new',
'description': 'This is ANOTHER test module',
'namespace': '',
'version_added': '1.1.0',
},
},
'lookup': {
'bar': {
'name': 'bar',
'description': 'A foo_bar lookup',
'namespace': None,
'version_added': '1.0.0',
},
'baz': {
'name': 'baz',
'description': 'Has already been here before',
'namespace': None,
'version_added': None,
},
'boom': {
'name': 'boom',
'description': 'Something older',
'namespace': None,
'version_added': '0.5.0',
},
},
})
collection_changelog.add_fragment_line('1.1.0-beta-1.yml',
'release_summary', 'Beta of 1.1.0.')
# Release 1.1.0-beta-1
assert collection_changelog.run_tool('release', [
'-v',
'--date',
'2020-02-14',
'--version',
'1.1.0-beta-1',
]) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == []
assert diff.removed_dirs == []
assert diff.removed_files == [
'changelogs/fragments/1.1.0-beta-1.yml',
'changelogs/fragments/test-new-fragment.yml',
]
assert diff.changed_files == [
'changelogs/CHANGELOG.rst', 'changelogs/changelog.yaml'
]
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['ancestor'] is None
assert list(changelog['releases']) == ['1.0.0', '1.1.0-beta-1']
assert changelog['releases']['1.1.0-beta-1'][
'release_date'] == '2020-02-14'
assert changelog['releases']['1.1.0-beta-1']['changes'] == {
'release_summary': 'Beta of 1.1.0.',
'minor_changes': [
'Another new fragment.',
],
}
assert changelog['releases']['1.1.0-beta-1']['fragments'] == [
'1.1.0-beta-1.yml',
'test-new-fragment.yml',
]
assert changelog['releases']['1.1.0-beta-1']['modules'] == [
{
'name': 'test_new',
'description': 'This is ANOTHER test module',
'namespace': '',
},
]
assert 'plugins' not in changelog['releases']['1.1.0-beta-1']
assert 'codename' not in changelog['releases']['1.1.0-beta-1']
assert diff.file_contents['changelogs/CHANGELOG.rst'].decode('utf-8') == (
r'''=========================
Ansible 1.1 Release Notes
=========================
.. contents:: Topics
v1.1.0-beta-1
=============
Release Summary
---------------
Beta of 1.1.0.
Minor Changes
-------------
- Another new fragment.
New Modules
-----------
- test_new - This is ANOTHER test module
v1.0.0
======
Release Summary
---------------
This is the first proper release.
Minor Changes
-------------
- baz lookup - no longer ignores the ``bar`` option.
- test - has a new option ``foo``.
New Plugins
-----------
Lookup
~~~~~~
- bar - A foo_bar lookup
New Modules
-----------
- test - This is a TEST module
''')
# Update plugin descriptions for 1.1.0
collection_changelog.set_plugin_cache(
'1.1.0', {
'module': {
'test': {
'name': 'test',
'description': 'This is a TEST module',
'namespace': '',
'version_added': '1.0.0',
},
'test_new': {
'name': 'test_new',
'description': 'This is ANOTHER test module',
'namespace': '',
'version_added': '1.1.0',
},
'test_new2': {
'name': 'test_new2',
'description': 'This is ANOTHER test module!!!11',
'namespace': '',
'version_added': '1.1.0',
},
'test_new3': {
'name': 'test_new3',
'description': 'This is yet another test module.',
'namespace': '',
'version_added': '1.1.0',
},
},
'lookup': {
'bar': {
'name': 'bar',
'description': 'A foo_bar lookup',
'namespace': None,
'version_added': '1.0.0',
},
'baz': {
'name': 'baz',
'description': 'Has already been here before',
'namespace': None,
'version_added': None,
},
'boom': {
'name': 'boom',
'description': 'Something older',
'namespace': None,
'version_added': '0.5.0',
},
},
})
collection_changelog.add_fragment_line('1.1.0.yml', 'release_summary',
'Final release of 1.1.0.')
collection_changelog.add_fragment_line('minorchange.yml', 'minor_changes',
['A minor change.'])
collection_changelog.add_fragment_line('bugfix.yml', 'bugfixes',
['A bugfix.'])
# Final release 1.1.0
assert collection_changelog.run_tool('release', [
'-vvv',
'--date',
'2020-02-29',
'--version',
'1.1.0',
]) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == []
assert diff.removed_dirs == []
assert diff.removed_files == [
'changelogs/fragments/1.1.0.yml',
'changelogs/fragments/bugfix.yml',
'changelogs/fragments/minorchange.yml',
]
assert diff.changed_files == [
'changelogs/CHANGELOG.rst', 'changelogs/changelog.yaml'
]
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['ancestor'] is None
assert list(changelog['releases']) == ['1.0.0', '1.1.0', '1.1.0-beta-1']
assert changelog['releases']['1.1.0']['release_date'] == '2020-02-29'
assert changelog['releases']['1.1.0']['changes'] == {
'release_summary': 'Final release of 1.1.0.',
'bugfixes': ['A bugfix.'],
'minor_changes': ['A minor change.'],
}
assert changelog['releases']['1.1.0']['fragments'] == [
'1.1.0.yml',
'bugfix.yml',
'minorchange.yml',
]
assert changelog['releases']['1.1.0']['modules'] == [
{
'name': 'test_new2',
'description': 'This is ANOTHER test module!!!11',
'namespace': '',
},
{
'name': 'test_new3',
'description': 'This is yet another test module.',
'namespace': '',
},
]
assert 'plugins' not in changelog['releases']['1.1.0']
assert 'codename' not in changelog['releases']['1.1.0']
assert diff.file_contents['changelogs/CHANGELOG.rst'].decode('utf-8') == (
r'''=========================
Ansible 1.1 Release Notes
=========================
.. contents:: Topics
v1.1.0
======
Release Summary
---------------
Final release of 1.1.0.
Minor Changes
-------------
- A minor change.
- Another new fragment.
Bugfixes
--------
- A bugfix.
New Modules
-----------
- test_new - This is ANOTHER test module
- test_new2 - This is ANOTHER test module!!!11
- test_new3 - This is yet another test module.
v1.0.0
======
Release Summary
---------------
This is the first proper release.
Minor Changes
-------------
- baz lookup - no longer ignores the ``bar`` option.
- test - has a new option ``foo``.
New Plugins
-----------
Lookup
~~~~~~
- bar - A foo_bar lookup
New Modules
-----------
- test - This is a TEST module
''')
# Final release 1.1.0 - should not change
assert collection_changelog.run_tool('release', [
'-vvv',
'--date',
'2020-03-01',
'--version',
'1.1.0',
]) == 0
assert collection_changelog.diff().unchanged
def test_changelog_release_plugin_cache( # pylint: disable=redefined-outer-name
collection_changelog): # noqa: F811
collection_changelog.set_galaxy({
'version': '1.0.0',
})
collection_changelog.config.title = 'My Amazing Collection'
collection_changelog.set_config(collection_changelog.config)
collection_changelog.add_fragment_line(
'1.0.0.yml', 'release_summary', 'This is the first proper release.')
collection_changelog.add_plugin(
'module', 'test_module.py',
create_plugin(
DOCUMENTATION={
'name': 'test_module',
'short_description': 'A test module',
'version_added': '1.0.0',
'description': ['This is a test module.'],
'author': ['Someone'],
'options': {},
},
EXAMPLES='',
RETURN={},
))
collection_changelog.add_plugin(
'module',
'__init__.py',
create_plugin(
DOCUMENTATION={
'name': 'bad_module',
'short_description': 'Bad module',
'description':
['This should be ignored, not found as a module!.'],
'author': ['badguy'],
'options': {},
},
EXAMPLES='# Some examples\n',
RETURN={},
),
subdirs=['cloud'])
collection_changelog.add_plugin('module',
'old_module.py',
create_plugin(
DOCUMENTATION={
'name':
'old_module',
'short_description':
'An old module',
'description':
['This is an old module.'],
'author': ['Elder'],
'options': {},
},
EXAMPLES='# Some examples\n',
RETURN={},
),
subdirs=['cloud', 'sky'])
collection_changelog.add_plugin('module',
'bad_module2',
create_plugin(
DOCUMENTATION={
'name':
'bad_module2',
'short_description':
'An bad module',
'description':
['Shold not be found either.'],
'author': ['Elder'],
'options': {},
},
EXAMPLES='# Some examples\n',
RETURN={},
),
subdirs=['cloud', 'sky'])
collection_changelog.add_plugin(
'callback', 'test_callback.py',
create_plugin(
DOCUMENTATION={
'name': 'test_callback',
'short_description': 'A not so old callback',
'version_added': '0.5.0',
'description':
['This is a relatively new callback added before.'],
'author': ['Someone else'],
'options': {},
},
EXAMPLES='# Some examples\n',
RETURN={},
))
collection_changelog.add_plugin(
'callback',
'test_callback2.py',
create_plugin(
DOCUMENTATION={
'name': 'test_callback2',
'short_description': 'This one should not be found.',
'version_added': '2.9',
'description':
['This is a relatively new callback added before.'],
'author': ['Someone else'],
'options': {},
},
EXAMPLES='# Some examples\n',
RETURN={},
),
subdirs=['dont', 'find', 'me'])
assert collection_changelog.run_tool('release',
['-v', '--date', '2020-01-02']) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == [
'changelogs/.plugin-cache.yaml',
'changelogs/CHANGELOG.rst',
'changelogs/changelog.yaml',
]
assert diff.removed_dirs == []
assert diff.removed_files == ['changelogs/fragments/1.0.0.yml']
assert diff.changed_files == []
plugin_cache = diff.parse_yaml('changelogs/.plugin-cache.yaml')
assert plugin_cache['version'] == '1.0.0'
# Plugin cache: modules
assert sorted(
plugin_cache['plugins']['module']) == ['old_module', 'test_module']
assert plugin_cache['plugins']['module']['old_module'][
'name'] == 'old_module'
assert plugin_cache['plugins']['module']['old_module'][
'namespace'] == 'cloud.sky'
assert plugin_cache['plugins']['module']['old_module'][
'description'] == 'An old module'
assert plugin_cache['plugins']['module']['old_module'][
'version_added'] is None
assert plugin_cache['plugins']['module']['test_module'][
'name'] == 'test_module'
assert plugin_cache['plugins']['module']['test_module']['namespace'] == ''
assert plugin_cache['plugins']['module']['test_module'][
'description'] == 'A test module'
assert plugin_cache['plugins']['module']['test_module'][
'version_added'] == '1.0.0'
# Plugin cache: callbacks
assert sorted(plugin_cache['plugins']['callback']) == ['test_callback']
assert plugin_cache['plugins']['callback']['test_callback'][
'name'] == 'test_callback'
assert plugin_cache['plugins']['callback']['test_callback']['description'] == \
'A not so old callback'
assert plugin_cache['plugins']['callback']['test_callback'][
'version_added'] == '0.5.0'
assert 'namespace' not in plugin_cache['plugins']['callback'][
'test_callback']
# Changelog
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['ancestor'] is None
assert sorted(changelog['releases']) == ['1.0.0']
assert changelog['releases']['1.0.0']['release_date'] == '2020-01-02'
assert changelog['releases']['1.0.0']['changes'] == {
'release_summary': 'This is the first proper release.'
}
assert changelog['releases']['1.0.0']['fragments'] == ['1.0.0.yml']
assert len(changelog['releases']['1.0.0']['modules']) == 1
assert changelog['releases']['1.0.0']['modules'][0][
'name'] == 'test_module'
assert changelog['releases']['1.0.0']['modules'][0]['namespace'] == ''
assert changelog['releases']['1.0.0']['modules'][0][
'description'] == 'A test module'
assert 'version_added' not in changelog['releases']['1.0.0']['modules'][0]
assert diff.file_contents['changelogs/CHANGELOG.rst'].decode('utf-8') == (
r'''===================================
My Amazing Collection Release Notes
===================================
.. contents:: Topics
v1.0.0
======
Release Summary
---------------
This is the first proper release.
New Modules
-----------
- test_module - A test module
''')
def test_changelog_release_simple( # pylint: disable=redefined-outer-name
collection_changelog): # noqa: F811
collection_changelog.set_galaxy({
'version': '1.0.0',
})
collection_changelog.config.changelog_filename_version_depth = 2
collection_changelog.set_config(collection_changelog.config)
collection_changelog.add_fragment_line(
'1.0.0.yml', 'release_summary', 'This is the first proper release.')
collection_changelog.add_fragment_line(
'test-new-option.yml', 'minor_changes',
['test - has a new option ``foo``.'])
collection_changelog.add_fragment_line(
'baz-new-option.yaml', 'minor_changes',
['baz lookup - no longer ignores the ``bar`` option.'])
collection_changelog.set_plugin_cache(
'1.0.0', {
'module': {
'test': {
'name': 'test',
'description': 'This is a test module',
'namespace': '',
'version_added': '1.0.0',
},
},
'lookup': {
'bar': {
'name': 'bar',
'description': 'A foo bar lookup',
'namespace': None,
'version_added': '1.0.0',
},
'baz': {
'name': 'baz',
'description': 'Has already been here',
'namespace': None,
'version_added': None,
},
'boom': {
'name': 'boom',
'description': 'Something older',
'namespace': None,
'version_added': '0.5.0',
},
},
})
# Lint fragments
assert collection_changelog.run_tool('lint', ['-vv']) == 0
# Release
assert collection_changelog.run_tool('release',
['-v', '--date', '2020-01-02']) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == ['CHANGELOG.rst', 'changelogs/changelog.yaml']
assert diff.removed_dirs == []
assert diff.removed_files == [
'changelogs/fragments/1.0.0.yml',
'changelogs/fragments/baz-new-option.yaml',
'changelogs/fragments/test-new-option.yml',
]
assert diff.changed_files == []
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['ancestor'] is None
assert list(changelog['releases']) == ['1.0.0']
assert changelog['releases']['1.0.0']['release_date'] == '2020-01-02'
assert changelog['releases']['1.0.0']['changes'] == {
'release_summary':
'This is the first proper release.',
'minor_changes': [
'baz lookup - no longer ignores the ``bar`` option.',
'test - has a new option ``foo``.',
],
}
assert changelog['releases']['1.0.0']['fragments'] == [
'1.0.0.yml',
'baz-new-option.yaml',
'test-new-option.yml',
]
assert changelog['releases']['1.0.0']['modules'] == [
{
'name': 'test',
'description': 'This is a test module',
'namespace': '',
},
]
assert changelog['releases']['1.0.0']['plugins'] == {
'lookup': [
{
'name': 'bar',
'description': 'A foo bar lookup',
'namespace': None,
},
],
}
assert 'codename' not in changelog['releases']['1.0.0']
assert diff.file_contents['CHANGELOG.rst'].decode('utf-8') == (
r'''=========================
Ansible 1.0 Release Notes
=========================
.. contents:: Topics
v1.0.0
======
Release Summary
---------------
This is the first proper release.
Minor Changes
-------------
- baz lookup - no longer ignores the ``bar`` option.
- test - has a new option ``foo``.
New Plugins
-----------
Lookup
~~~~~~
- acme.test.bar - A foo bar lookup
New Modules
-----------
- acme.test.test - This is a test module
''')
# Check that regenerate doesn't change anything
assert collection_changelog.run_tool('generate', ['-v']) == 0
assert collection_changelog.diff().unchanged
# Update plugin descriptions
collection_changelog.set_plugin_cache(
'1.0.0', {
'module': {
'test': {
'name': 'test',
'description': 'This is a TEST module',
'namespace': '',
'version_added': '1.0.0',
},
},
'lookup': {
'bar': {
'name': 'bar',
'description': 'A foo_bar lookup',
'namespace': None,
'version_added': '1.0.0',
},
'baz': {
'name': 'baz',
'description': 'Has already been here before',
'namespace': None,
'version_added': None,
},
'boom': {
'name': 'boom',
'description': 'Something older',
'namespace': None,
'version_added': '0.5.0',
},
},
})
# Add another fragment
collection_changelog.add_fragment_line('test-new-fragment.yml',
'minor_changes',
['Another new fragment.'])
# Check that regenerate without --refresh* doesn't change anything
assert collection_changelog.run_tool('generate', ['-v']) == 0
assert collection_changelog.diff().unchanged
# Check that regenerate with --refresh-fragments does not change
assert collection_changelog.run_tool('generate',
['-v', '--refresh-fragments']) == 0
diff = collection_changelog.diff()
assert diff.unchanged
# Check that regenerate with --refresh-plugins changes
assert collection_changelog.run_tool('generate',
['-v', '--refresh-plugins']) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == []
assert diff.removed_dirs == []
assert diff.removed_files == []
assert diff.changed_files == ['CHANGELOG.rst', 'changelogs/changelog.yaml']
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['releases']['1.0.0']['modules'] == [
{
'name': 'test',
'description': 'This is a TEST module',
'namespace': '',
},
]
assert changelog['releases']['1.0.0']['plugins'] == {
'lookup': [
{
'name': 'bar',
'description': 'A foo_bar lookup',
'namespace': None,
},
],
}
assert diff.file_contents['CHANGELOG.rst'].decode('utf-8') == (
r'''=========================
Ansible 1.0 Release Notes
=========================
.. contents:: Topics
v1.0.0
======
Release Summary
---------------
This is the first proper release.
Minor Changes
-------------
- baz lookup - no longer ignores the ``bar`` option.
- test - has a new option ``foo``.
New Plugins
-----------
Lookup
~~~~~~
- acme.test.bar - A foo_bar lookup
New Modules
-----------
- acme.test.test - This is a TEST module
''')
# Update plugin descriptions for 1.1.0 beta 1
collection_changelog.set_plugin_cache(
'1.1.0-beta-1', {
'module': {
'test': {
'name': 'test',
'description': 'This is a TEST module',
'namespace': '',
'version_added': '1.0.0',
},
'test_new': {
'name': 'test_new',
'description': 'This is ANOTHER test module',
'namespace': '',
'version_added': '1.1.0',
},
},
'lookup': {
'bar': {
'name': 'bar',
'description': 'A foo_bar lookup',
'namespace': None,
'version_added': '1.0.0',
},
'baz': {
'name': 'baz',
'description': 'Has already been here before',
'namespace': None,
'version_added': None,
},
'boom': {
'name': 'boom',
'description': 'Something older',
'namespace': None,
'version_added': '0.5.0',
},
},
})
collection_changelog.add_fragment_line('1.1.0-beta-1.yml',
'release_summary', 'Beta of 1.1.0.')
# Release 1.1.0-beta-1
assert collection_changelog.run_tool('release', [
'-v',
'--date',
'2020-02-14',
'--version',
'1.1.0-beta-1',
]) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == []
assert diff.removed_dirs == []
assert diff.removed_files == [
'changelogs/fragments/1.1.0-beta-1.yml',
'changelogs/fragments/test-new-fragment.yml',
]
assert diff.changed_files == ['CHANGELOG.rst', 'changelogs/changelog.yaml']
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['ancestor'] is None
assert list(changelog['releases']) == ['1.0.0', '1.1.0-beta-1']
assert changelog['releases']['1.1.0-beta-1'][
'release_date'] == '2020-02-14'
assert changelog['releases']['1.1.0-beta-1']['changes'] == {
'release_summary': 'Beta of 1.1.0.',
'minor_changes': [
'Another new fragment.',
],
}
assert changelog['releases']['1.1.0-beta-1']['fragments'] == [
'1.1.0-beta-1.yml',
'test-new-fragment.yml',
]
assert changelog['releases']['1.1.0-beta-1']['modules'] == [
{
'name': 'test_new',
'description': 'This is ANOTHER test module',
'namespace': '',
},
]
assert 'plugins' not in changelog['releases']['1.1.0-beta-1']
assert 'objects' not in changelog['releases']['1.1.0-beta-1']
assert 'codename' not in changelog['releases']['1.1.0-beta-1']
assert diff.file_contents['CHANGELOG.rst'].decode('utf-8') == (
r'''=========================
Ansible 1.1 Release Notes
=========================
.. contents:: Topics
v1.1.0-beta-1
=============
Release Summary
---------------
Beta of 1.1.0.
Minor Changes
-------------
- Another new fragment.
New Modules
-----------
- acme.test.test_new - This is ANOTHER test module
v1.0.0
======
Release Summary
---------------
This is the first proper release.
Minor Changes
-------------
- baz lookup - no longer ignores the ``bar`` option.
- test - has a new option ``foo``.
New Plugins
-----------
Lookup
~~~~~~
- acme.test.bar - A foo_bar lookup
New Modules
-----------
- acme.test.test - This is a TEST module
''')
# Update plugin descriptions for 1.1.0
collection_changelog.set_plugin_cache(
'1.1.0', {
'module': {
'test': {
'name': 'test',
'description': 'This is a TEST module',
'namespace': '',
'version_added': '1.0.0',
},
'test_new': {
'name': 'test_new',
'description': 'This is ANOTHER test module',
'namespace': '',
'version_added': '1.1.0',
},
'test_new2': {
'name': 'test_new2',
'description': 'This is ANOTHER test module!!!11',
'namespace': '',
'version_added': '1.1.0',
},
'test_new3': {
'name': 'test_new3',
'description': 'This is yet another test module.',
'namespace': '',
'version_added': '1.1.0',
},
},
'lookup': {
'bar': {
'name': 'bar',
'description': 'A foo_bar lookup',
'namespace': None,
'version_added': '1.0.0',
},
'baz': {
'name': 'baz',
'description': 'Has already been here before',
'namespace': None,
'version_added': None,
},
'boom': {
'name': 'boom',
'description': 'Something older',
'namespace': None,
'version_added': '0.5.0',
},
},
})
collection_changelog.add_fragment_line('1.1.0.yml', 'release_summary',
'Final release of 1.1.0.')
collection_changelog.add_fragment_line('minorchange.yml', 'minor_changes',
['A minor change.'])
collection_changelog.add_fragment_line('bugfix.yml', 'bugfixes',
['A bugfix.'])
# Lint fragments
assert collection_changelog.run_tool('lint', [
'-vvv',
]) == 0
# Final release 1.1.0
assert collection_changelog.run_tool('release', [
'-vvv',
'--date',
'2020-02-29',
'--version',
'1.1.0',
]) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == []
assert diff.removed_dirs == []
assert diff.removed_files == [
'changelogs/fragments/1.1.0.yml',
'changelogs/fragments/bugfix.yml',
'changelogs/fragments/minorchange.yml',
]
assert diff.changed_files == ['CHANGELOG.rst', 'changelogs/changelog.yaml']
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['ancestor'] is None
assert list(changelog['releases']) == ['1.0.0', '1.1.0', '1.1.0-beta-1']
assert changelog['releases']['1.1.0']['release_date'] == '2020-02-29'
assert changelog['releases']['1.1.0']['changes'] == {
'release_summary': 'Final release of 1.1.0.',
'bugfixes': ['A bugfix.'],
'minor_changes': ['A minor change.'],
}
assert changelog['releases']['1.1.0']['fragments'] == [
'1.1.0.yml',
'bugfix.yml',
'minorchange.yml',
]
assert changelog['releases']['1.1.0']['modules'] == [
{
'name': 'test_new2',
'description': 'This is ANOTHER test module!!!11',
'namespace': '',
},
{
'name': 'test_new3',
'description': 'This is yet another test module.',
'namespace': '',
},
]
assert 'plugins' not in changelog['releases']['1.1.0']
assert 'objects' not in changelog['releases']['1.1.0']
assert 'codename' not in changelog['releases']['1.1.0']
assert diff.file_contents['CHANGELOG.rst'].decode('utf-8') == (
r'''=========================
Ansible 1.1 Release Notes
=========================
.. contents:: Topics
v1.1.0
======
Release Summary
---------------
Final release of 1.1.0.
Minor Changes
-------------
- A minor change.
- Another new fragment.
Bugfixes
--------
- A bugfix.
New Modules
-----------
- acme.test.test_new - This is ANOTHER test module
- acme.test.test_new2 - This is ANOTHER test module!!!11
- acme.test.test_new3 - This is yet another test module.
v1.0.0
======
Release Summary
---------------
This is the first proper release.
Minor Changes
-------------
- baz lookup - no longer ignores the ``bar`` option.
- test - has a new option ``foo``.
New Plugins
-----------
Lookup
~~~~~~
- acme.test.bar - A foo_bar lookup
New Modules
-----------
- acme.test.test - This is a TEST module
''')
# Final release 1.1.0 - should not change
assert collection_changelog.run_tool('release', [
'-vvv',
'--date',
'2020-03-01',
'--version',
'1.1.0',
]) == 0
assert collection_changelog.diff().unchanged
# Update plugin descriptions for 1.2.0
collection_changelog.set_plugin_cache(
'1.2.0', {
'module': {
'test': {
'name': 'test',
'description': 'This is a TEST module',
'namespace': '',
'version_added': '1.0.0',
},
'test_new': {
'name': 'test_new',
'description': 'This is ANOTHER test module',
'namespace': '',
'version_added': '1.1.0',
},
'test_new2': {
'name': 'test_new2',
'description': 'This is ANOTHER test module!!!11',
'namespace': '',
'version_added': '1.1.0',
},
'test_new3': {
'name': 'test_new3',
'description': 'This is yet another test module.',
'namespace': '',
'version_added': '1.1.0',
},
'test_new4': {
'name': 'test_new4',
'description': 'This is yet another test module!',
'namespace': '',
'version_added': '1.2.0',
},
},
'lookup': {
'bar': {
'name': 'bar',
'description': 'A foo_bar lookup',
'namespace': None,
'version_added': '1.0.0',
},
'baz': {
'name': 'baz',
'description': 'Has already been here before',
'namespace': None,
'version_added': None,
},
'boom': {
'name': 'boom',
'description': 'Something older',
'namespace': None,
'version_added': '0.5.0',
},
},
})
collection_changelog.add_fragment_line('1.2.0.yml', 'release_summary',
'Release of 1.2.0.')
collection_changelog.add_fragment_generic(
'new-plugins.yml', {
'add plugin.filter': [
{
'name': 'to_time_unit',
'description':
'Converts a time expression to a given unit',
},
{
'name': 'to_seconds',
'description': 'Converts a time expression to seconds',
},
],
'add object.role': [
{
'name': 'nginx',
'description':
'The most awesome nginx installation role ever',
},
],
'add object.playbook': [
{
'name': 'wipe_server',
'description': 'Totally wipes a server',
},
],
})
collection_changelog.add_fragment_generic(
'new-test-plugin.yml', {
'add plugin.test': [
{
'name': 'similar',
'description': 'Tests whether two objects are similar',
},
],
})
collection_changelog.add_fragment_generic(
'new-module.yml', {
'add plugin.module': [
{
'name': 'meh',
'description': 'A meh module',
'namespace': 'foo'
},
],
})
# Release 1.2.0
assert collection_changelog.run_tool('release', [
'-vvv',
'--date',
'2020-03-01',
'--version',
'1.2.0',
]) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == []
assert diff.removed_dirs == []
assert diff.removed_files == [
'changelogs/fragments/1.2.0.yml',
'changelogs/fragments/new-module.yml',
'changelogs/fragments/new-plugins.yml',
'changelogs/fragments/new-test-plugin.yml',
]
assert diff.changed_files == ['CHANGELOG.rst', 'changelogs/changelog.yaml']
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['ancestor'] is None
assert list(
changelog['releases']) == ['1.0.0', '1.1.0', '1.1.0-beta-1', '1.2.0']
assert changelog['releases']['1.2.0']['release_date'] == '2020-03-01'
assert changelog['releases']['1.2.0']['changes'] == {
'release_summary': 'Release of 1.2.0.',
}
assert changelog['releases']['1.2.0']['fragments'] == [
'1.2.0.yml',
'new-module.yml',
'new-plugins.yml',
'new-test-plugin.yml',
]
assert changelog['releases']['1.2.0']['modules'] == [
{
'name': 'meh',
'description': 'A meh module',
'namespace': 'foo',
},
{
'name': 'test_new4',
'description': 'This is yet another test module!',
'namespace': '',
},
]
assert changelog['releases']['1.2.0']['plugins'] == {
'filter': [
{
'name': 'to_seconds',
'description': 'Converts a time expression to seconds',
'namespace': None,
},
{
'name': 'to_time_unit',
'description': 'Converts a time expression to a given unit',
'namespace': None,
},
],
'test': [
{
'name': 'similar',
'description': 'Tests whether two objects are similar',
'namespace': None,
},
],
}
assert changelog['releases']['1.2.0']['objects'] == {
'playbook': [
{
'name': 'wipe_server',
'description': 'Totally wipes a server',
'namespace': None,
},
],
'role': [
{
'name': 'nginx',
'description': 'The most awesome nginx installation role ever',
'namespace': None,
},
],
}
assert 'codename' not in changelog['releases']['1.2.0']
assert diff.file_contents['CHANGELOG.rst'].decode('utf-8') == (
r'''=========================
Ansible 1.2 Release Notes
=========================
.. contents:: Topics
v1.2.0
======
Release Summary
---------------
Release of 1.2.0.
New Plugins
-----------
Filter
~~~~~~
- acme.test.to_seconds - Converts a time expression to seconds
- acme.test.to_time_unit - Converts a time expression to a given unit
Test
~~~~
- acme.test.similar - Tests whether two objects are similar
New Modules
-----------
- acme.test.test_new4 - This is yet another test module!
Foo
~~~
- acme.test.foo.meh - A meh module
New Playbooks
-------------
- acme.test.wipe_server - Totally wipes a server
New Roles
---------
- acme.test.nginx - The most awesome nginx installation role ever
v1.1.0
======
Release Summary
---------------
Final release of 1.1.0.
Minor Changes
-------------
- A minor change.
- Another new fragment.
Bugfixes
--------
- A bugfix.
New Modules
-----------
- acme.test.test_new - This is ANOTHER test module
- acme.test.test_new2 - This is ANOTHER test module!!!11
- acme.test.test_new3 - This is yet another test module.
v1.0.0
======
Release Summary
---------------
This is the first proper release.
Minor Changes
-------------
- baz lookup - no longer ignores the ``bar`` option.
- test - has a new option ``foo``.
New Plugins
-----------
Lookup
~~~~~~
- acme.test.bar - A foo_bar lookup
New Modules
-----------
- acme.test.test - This is a TEST module
''')
# Release 1.2.0 - should not change
assert collection_changelog.run_tool('release', [
'-vvv',
'--date',
'2020-03-02',
'--version',
'1.2.0',
]) == 0
assert collection_changelog.diff().unchanged
def test_changelog_release_archive_fragments( # pylint: disable=redefined-outer-name
collection_changelog): # noqa: F811
collection_changelog.set_galaxy({
'version': '1.0.0',
})
collection_changelog.config.changelog_filename_version_depth = 2
collection_changelog.config.keep_fragments = False
collection_changelog.config.archive_path_template = '.archive/v{version}'
collection_changelog.set_config(collection_changelog.config)
collection_changelog.add_fragment_line(
'1.0.0.yml', 'release_summary', 'This is the first proper release.')
collection_changelog.add_fragment_line(
'test-new-option.yml', 'minor_changes',
['test - has a new option ``foo``.'])
collection_changelog.add_fragment_line(
'baz-new-option.yaml', 'minor_changes',
['baz lookup - no longer ignores the ``bar`` option.'])
collection_changelog.set_plugin_cache('1.0.0', {})
# Release
assert collection_changelog.run_tool('release',
['-v', '--date', '2020-01-02']) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == ['.archive', '.archive/v1.0.0']
assert diff.added_files == [
'.archive/v1.0.0/1.0.0.yml',
'.archive/v1.0.0/baz-new-option.yaml',
'.archive/v1.0.0/test-new-option.yml',
'CHANGELOG.rst',
'changelogs/changelog.yaml',
]
assert diff.removed_dirs == []
assert diff.removed_files == [
'changelogs/fragments/1.0.0.yml',
'changelogs/fragments/baz-new-option.yaml',
'changelogs/fragments/test-new-option.yml',
]
assert diff.changed_files == []
assert diff.file_contents['CHANGELOG.rst'].decode('utf-8') == (
r'''=========================
Ansible 1.0 Release Notes
=========================
.. contents:: Topics
v1.0.0
======
Release Summary
---------------
This is the first proper release.
Minor Changes
-------------
- baz lookup - no longer ignores the ``bar`` option.
- test - has a new option ``foo``.
''')
# Modify archived fragment
collection_changelog.add_fragment_line(
'baz-new-option.yaml',
'minor_changes',
['baz lookup - no longer ignores the ``bar`` option!'],
fragment_dir='.archive/v1.0.0')
# Refresh
assert collection_changelog.run_tool('generate',
['-v', '--refresh-fragments']) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == []
assert diff.removed_dirs == []
assert diff.removed_files == []
assert diff.changed_files == ['CHANGELOG.rst', 'changelogs/changelog.yaml']
assert diff.file_contents['CHANGELOG.rst'].decode('utf-8') == (
r'''=========================
Ansible 1.0 Release Notes
=========================
.. contents:: Topics
v1.0.0
======
Release Summary
---------------
This is the first proper release.
Minor Changes
-------------
- baz lookup - no longer ignores the ``bar`` option!
- test - has a new option ``foo``.
''')
# Modify archived fragment back
collection_changelog.add_fragment_line(
'baz-new-option.yaml',
'minor_changes',
['baz lookup - no longer ignores the ``bar`` option.'],
fragment_dir='.archive/v1.0.0')
# Refresh with --without-archives should be ignored
assert collection_changelog.run_tool(
'generate', ['-v', '--refresh-fragments', 'without-archives']) == 0
assert collection_changelog.diff().unchanged
def test_changelog_release_remove_fragments( # pylint: disable=redefined-outer-name
collection_changelog): # noqa: F811
collection_changelog.set_galaxy({
'version': '1.0.0',
})
collection_changelog.config.changelog_filename_version_depth = 2
collection_changelog.config.keep_fragments = False
collection_changelog.config.archive_path_template = None
collection_changelog.set_config(collection_changelog.config)
collection_changelog.add_fragment_line(
'1.0.0.yml', 'release_summary', 'This is the first proper release.')
collection_changelog.add_fragment_line(
'test-new-option.yml', 'minor_changes',
['test - has a new option ``foo``.'])
collection_changelog.add_fragment_line(
'baz-new-option.yaml', 'minor_changes',
['baz lookup - no longer ignores the ``bar`` option.'])
collection_changelog.set_plugin_cache('1.0.0', {})
# Release
assert collection_changelog.run_tool('release',
['-v', '--date', '2020-01-02']) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == ['CHANGELOG.rst', 'changelogs/changelog.yaml']
assert diff.removed_dirs == []
assert diff.removed_files == [
'changelogs/fragments/1.0.0.yml',
'changelogs/fragments/baz-new-option.yaml',
'changelogs/fragments/test-new-option.yml',
]
assert diff.changed_files == []
assert diff.file_contents['CHANGELOG.rst'].decode('utf-8') == (
r'''=========================
Ansible 1.0 Release Notes
=========================
.. contents:: Topics
v1.0.0
======
Release Summary
---------------
This is the first proper release.
Minor Changes
-------------
- baz lookup - no longer ignores the ``bar`` option.
- test - has a new option ``foo``.
''')
# Refresh should be ignored
assert collection_changelog.run_tool('generate',
['-v', '--refresh-fragments']) == 0
assert collection_changelog.diff().unchanged
# Add fragment with same filename, but different content
collection_changelog.add_fragment_line('baz-new-option.yaml',
'minor_changes',
['baz - do something crazy.'])
collection_changelog.set_plugin_cache('1.1.0', {})
# Release
assert collection_changelog.run_tool(
'release', ['-v', '--version', '1.1.0', '--date', '2020-01-02']) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == []
assert diff.removed_dirs == []
assert diff.removed_files == [
'changelogs/fragments/baz-new-option.yaml',
]
assert diff.changed_files == ['CHANGELOG.rst', 'changelogs/changelog.yaml']
assert diff.file_contents['CHANGELOG.rst'].decode('utf-8') == (
r'''=========================
Ansible 1.1 Release Notes
=========================
.. contents:: Topics
v1.1.0
======
Minor Changes
-------------
- baz - do something crazy.
v1.0.0
======
Release Summary
---------------
This is the first proper release.
Minor Changes
-------------
- baz lookup - no longer ignores the ``bar`` option.
- test - has a new option ``foo``.
''')
# Set prevent_known_fragments to True
collection_changelog.config.prevent_known_fragments = True
collection_changelog.set_config(collection_changelog.config)
# Add fragment with same filename, but different content
collection_changelog.add_fragment_line(
'baz-new-option.yaml', 'minor_changes',
['baz - do something even more crazy.'])
collection_changelog.set_plugin_cache('1.2.0', {})
# Release
assert collection_changelog.run_tool(
'release', ['-v', '--version', '1.2.0', '--date', '2020-01-02']) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == []
assert diff.removed_dirs == []
assert diff.removed_files == []
assert diff.changed_files == ['CHANGELOG.rst', 'changelogs/changelog.yaml']
assert diff.file_contents['CHANGELOG.rst'].decode('utf-8') == (
r'''=========================
Ansible 1.2 Release Notes
=========================
.. contents:: Topics
v1.2.0
======
v1.1.0
======
Minor Changes
-------------
- baz - do something crazy.
v1.0.0
======
Release Summary
---------------
This is the first proper release.
Minor Changes
-------------
- baz lookup - no longer ignores the ``bar`` option.
- test - has a new option ``foo``.
''')
def test_changelog_release_simple(collection_changelog):
collection_changelog.set_galaxy({
'version': '1.0.0',
})
collection_changelog.set_config(collection_changelog.config)
collection_changelog.add_fragment_line(
'1.0.0.yml', 'release_summary', 'This is the first proper release.')
collection_changelog.add_fragment_line(
'test-new-option.yml', 'minor_changes',
['test - has a new option ``foo``.'])
collection_changelog.add_fragment_line(
'baz-new-option.yaml', 'minor_changes',
['baz lookup - no longer ignores the ``bar`` option.'])
collection_changelog.set_plugin_cache(
'1.0.0', {
'module': {
'test': {
'name': 'test',
'description': 'This is a test module',
'namespace': '',
'version_added': '1.0.0',
},
},
'lookup': {
'bar': {
'name': 'bar',
'description': 'A foo bar lookup',
'namespace': None,
'version_added': '1.0.0',
},
'baz': {
'name': 'baz',
'description': 'Has already been here',
'namespace': None,
'version_added': None,
},
},
})
assert collection_changelog.run_tool('release',
['-v', '--date', '2020-01-02']) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == [
'changelogs/CHANGELOG.rst', 'changelogs/changelog.yaml'
]
assert diff.removed_dirs == []
assert diff.removed_files == [
'changelogs/fragments/1.0.0.yml',
'changelogs/fragments/baz-new-option.yaml',
'changelogs/fragments/test-new-option.yml',
]
assert diff.changed_files == []
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['ancestor'] is None
assert list(changelog['releases']) == ['1.0.0']
assert changelog['releases']['1.0.0']['release_date'] == '2020-01-02'
assert changelog['releases']['1.0.0']['changes'] == {
'release_summary':
'This is the first proper release.',
'minor_changes': [
'baz lookup - no longer ignores the ``bar`` option.',
'test - has a new option ``foo``.',
],
}
assert changelog['releases']['1.0.0']['fragments'] == [
'1.0.0.yml',
'baz-new-option.yaml',
'test-new-option.yml',
]
assert changelog['releases']['1.0.0']['modules'] == [
{
'name': 'test',
'description': 'This is a test module',
'namespace': '',
},
]
assert changelog['releases']['1.0.0']['plugins'] == {
'lookup': [
{
'name': 'bar',
'description': 'A foo bar lookup',
'namespace': None,
},
],
}
assert 'codename' not in changelog['releases']['1.0.0']
def test_changelog_release_plugin_cache(collection_changelog):
collection_changelog.set_galaxy({
'version': '1.0.0',
})
collection_changelog.set_config(collection_changelog.config)
collection_changelog.add_fragment_line(
'1.0.0.yml', 'release_summary', 'This is the first proper release.')
collection_changelog.add_plugin(
'module', 'test_module.py',
create_plugin(
DOCUMENTATION={
'name': 'test_module',
'short_description': 'A test module',
'version_added': '1.0.0',
'description': ['This is a test module.'],
'author': ['Someone'],
'options': {},
},
EXAMPLES='',
RETURN={},
))
collection_changelog.add_plugin('module',
'old_module.py',
create_plugin(
DOCUMENTATION={
'name':
'old_module',
'short_description':
'An old module',
'description':
['This is an old module.'],
'author': ['Elder'],
'options': {},
},
EXAMPLES='# Some examples\n',
RETURN={},
),
subdirs=['cloud', 'sky'])
assert collection_changelog.run_tool('release',
['-v', '--date', '2020-01-02']) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == [
'changelogs/.plugin-cache.yaml', 'changelogs/CHANGELOG.rst',
'changelogs/changelog.yaml'
]
assert diff.removed_dirs == []
assert diff.removed_files == ['changelogs/fragments/1.0.0.yml']
assert diff.changed_files == []
plugin_cache = diff.parse_yaml('changelogs/.plugin-cache.yaml')
assert plugin_cache['version'] == '1.0.0'
# Plugin cache: modules
assert sorted(
plugin_cache['plugins']['module']) == ['old_module', 'test_module']
assert plugin_cache['plugins']['module']['old_module'][
'name'] == 'old_module'
assert plugin_cache['plugins']['module']['old_module'][
'namespace'] == 'cloud.sky'
assert plugin_cache['plugins']['module']['old_module'][
'description'] == 'An old module'
assert plugin_cache['plugins']['module']['old_module'][
'version_added'] is None
assert plugin_cache['plugins']['module']['test_module'][
'name'] == 'test_module'
assert plugin_cache['plugins']['module']['test_module']['namespace'] == ''
assert plugin_cache['plugins']['module']['test_module'][
'description'] == 'A test module'
assert plugin_cache['plugins']['module']['test_module'][
'version_added'] == '1.0.0'
# Changelog
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['ancestor'] is None
assert sorted(changelog['releases']) == ['1.0.0']
assert changelog['releases']['1.0.0']['release_date'] == '2020-01-02'
assert changelog['releases']['1.0.0']['changes'] == {
'release_summary': 'This is the first proper release.'
}
assert changelog['releases']['1.0.0']['fragments'] == ['1.0.0.yml']
assert len(changelog['releases']['1.0.0']['modules']) == 1
assert changelog['releases']['1.0.0']['modules'][0][
'name'] == 'test_module'
assert changelog['releases']['1.0.0']['modules'][0]['namespace'] == ''
assert changelog['releases']['1.0.0']['modules'][0][
'description'] == 'A test module'
assert 'version_added' not in changelog['releases']['1.0.0']['modules'][0]
def test_changelog_release_simple_no_galaxy(collection_changelog):
collection_changelog.set_config(collection_changelog.config)
collection_changelog.add_fragment_line(
'1.0.0.yml', 'release_summary', 'This is the first proper release.')
collection_changelog.add_fragment_line(
'test-new-option.yml', 'minor_changes',
['test - has a new option ``foo``.'])
collection_changelog.add_fragment_line(
'baz-new-option.yaml', 'minor_changes',
['baz lookup - no longer ignores the ``bar`` option.'])
# If we don't specify all options, the call will fail
assert collection_changelog.run_tool('release',
['-v', '--date', '2020-01-02']) == 5
assert collection_changelog.run_tool(
'release',
[ # without --version
'-v',
'--date',
'2020-01-02',
'--is-collection',
'true',
'--collection-namespace',
'cloud',
'--collection-name',
'sky',
'--collection-flatmap',
'yes',
]) == 5
assert collection_changelog.run_tool(
'release',
[ # without --is-collection
'-v',
'--date',
'2020-01-02',
'--version',
'1.0.0',
'--collection-namespace',
'cloud',
'--collection-name',
'sky',
'--collection-flatmap',
'yes',
]) == 5
assert collection_changelog.run_tool(
'release',
[ # without --collection-namespace
'-v',
'--date',
'2020-01-02',
'--version',
'1.0.0',
'--is-collection',
'true',
'--collection-name',
'sky',
'--collection-flatmap',
'yes',
]) == 5
assert collection_changelog.run_tool(
'release',
[ # without --collection-name
'-v',
'--date',
'2020-01-02',
'--version',
'1.0.0',
'--is-collection',
'true',
'--collection-namespace',
'cloud',
'--collection-flatmap',
'yes',
]) == 5
assert collection_changelog.run_tool(
'release',
[ # without --collection-flatmap
'-v',
'--date',
'2020-01-02',
'--version',
'1.0.0',
'--is-collection',
'true',
'--collection-namespace',
'cloud',
'--collection-name',
'sky',
]) == 5
# Add plugin cache content
collection_changelog.set_plugin_cache(
'1.0.0', {
'module': {
'test': {
'name': 'test',
'description': 'This is a test module',
'namespace': '',
'version_added': '1.0.0',
},
},
'lookup': {
'bar': {
'name': 'bar',
'description': 'A foo bar lookup',
'namespace': None,
'version_added': '1.0.0',
},
'baz': {
'name': 'baz',
'description': 'Has already been here',
'namespace': None,
'version_added': None,
},
},
})
# If we specify all options, the call will succeed
assert collection_changelog.run_tool(
'release',
[
'-v',
'--date',
'2020-01-02',
'--version',
'1.0.0',
'--is-collection',
'true',
# The following two options are not needed since the tool doesn't have to scan for plugins:
# '--collection-namespace', 'cloud',
# '--collection-name', 'sky',
'--collection-flatmap',
'yes',
]) == 0
diff = collection_changelog.diff()
assert diff.added_dirs == []
assert diff.added_files == [
'changelogs/CHANGELOG.rst', 'changelogs/changelog.yaml'
]
assert diff.removed_dirs == []
assert diff.removed_files == [
'changelogs/fragments/1.0.0.yml',
'changelogs/fragments/baz-new-option.yaml',
'changelogs/fragments/test-new-option.yml',
]
assert diff.changed_files == []
changelog = diff.parse_yaml('changelogs/changelog.yaml')
assert changelog['ancestor'] is None
assert list(changelog['releases']) == ['1.0.0']
assert changelog['releases']['1.0.0']['release_date'] == '2020-01-02'
assert changelog['releases']['1.0.0']['changes'] == {
'release_summary':
'This is the first proper release.',
'minor_changes': [
'baz lookup - no longer ignores the ``bar`` option.',
'test - has a new option ``foo``.',
],
}
assert changelog['releases']['1.0.0']['fragments'] == [
'1.0.0.yml',
'baz-new-option.yaml',
'test-new-option.yml',
]
assert changelog['releases']['1.0.0']['modules'] == [
{
'name': 'test',
'description': 'This is a test module',
'namespace': '',
},
]
assert changelog['releases']['1.0.0']['plugins'] == {
'lookup': [
{
'name': 'bar',
'description': 'A foo bar lookup',
'namespace': None,
},
],
}
assert 'codename' not in changelog['releases']['1.0.0']
def test_changelog_fragment_lint_broken( # pylint: disable=redefined-outer-name
collection_changelog): # noqa: F811
collection_changelog.set_config(collection_changelog.config)
collection_changelog.add_fragment_line('list-instead-of-string.yml',
'release_summary', ['List', 'asfd'])
collection_changelog.add_fragment_line('int-instead-of-string.yml',
'release_summary', 42)
collection_changelog.add_fragment_line('int-instead-of-list.yml',
'bugfixes', 42)
collection_changelog.add_fragment_line('string-instead-of-list.yml',
'minor_changes', 'test')
collection_changelog.add_fragment_line('list-of-ints.yaml',
'minor_changes', [42, 37])
collection_changelog.add_fragment_line('wrong-category.yaml',
'minor_change', ['a'])
collection_changelog.add_fragment('not-a-dict.yaml', '23')
collection_changelog.add_fragment('invalid-yaml.yaml', 'test: {')
collection_changelog.add_fragment_generic(
'invalid-add-obj.yaml', {
'add object.foo': [],
'add object.role': [
'bah',
{
'meh': 'bar',
},
],
'add moo.role': [],
'add plugin.asdf': [],
'add plugin.test': 'str',
'add plugin.module': [
{
'meh': '',
},
],
})
# Lint fragments
rc, stdout, stderr = collection_changelog.run_tool_w_output('lint', [])
assert rc == 3
assert stdout == r'''
changelogs/fragments/int-instead-of-list.yml:0:0: section "bugfixes" must be type list not int
changelogs/fragments/int-instead-of-string.yml:0:0: section "release_summary" must be type str not int
changelogs/fragments/invalid-add-obj.yaml:0:0: section "add moo.role"'s name must be of format "add (object|plugin).(type)"
changelogs/fragments/invalid-add-obj.yaml:0:0: section "add object.foo"'s type must be one of role, playbook, not "foo"
changelogs/fragments/invalid-add-obj.yaml:0:0: section "add object.role" entry #1 has invalid keys "meh"
changelogs/fragments/invalid-add-obj.yaml:0:0: section "add object.role" entry #1 must have a "description" entry of type string
changelogs/fragments/invalid-add-obj.yaml:0:0: section "add object.role" entry #1 must have a "name" entry of type string
changelogs/fragments/invalid-add-obj.yaml:0:0: section "add object.role" list items must be type dict not str
changelogs/fragments/invalid-add-obj.yaml:0:0: section "add plugin.asdf"'s type must be one of become, cache, callback, cliconf, connection, httpapi, inventory, lookup, netconf, shell, vars, module, strategy, module, test, filter, not "asdf"
changelogs/fragments/invalid-add-obj.yaml:0:0: section "add plugin.module" entry #0 has invalid keys "meh"
changelogs/fragments/invalid-add-obj.yaml:0:0: section "add plugin.module" entry #0 must have a "description" entry of type string
changelogs/fragments/invalid-add-obj.yaml:0:0: section "add plugin.module" entry #0 must have a "name" entry of type string
changelogs/fragments/invalid-add-obj.yaml:0:0: section "add plugin.module" entry #0 must not have a non-null "namespace" entry
changelogs/fragments/invalid-add-obj.yaml:0:0: section "add plugin.test" must be type list not str
changelogs/fragments/invalid-yaml.yaml:0:0: yaml parsing error
changelogs/fragments/list-instead-of-string.yml:0:0: section "release_summary" must be type str not list
changelogs/fragments/list-of-ints.yaml:0:0: section "minor_changes" list items must be type str not int
changelogs/fragments/not-a-dict.yaml:0:0: file must be a mapping not int
changelogs/fragments/string-instead-of-list.yml:0:0: section "minor_changes" must be type list not str
changelogs/fragments/wrong-category.yaml:0:0: invalid section: minor_change
'''.lstrip()
# Lint non-existing fragment
rc, stdout, stderr = collection_changelog.run_tool_w_output(
'lint', ['changelogs/fragments/non-existing'])
assert rc == 3
assert stdout == r'''
changelogs/fragments/non-existing:0:0: yaml parsing error
'''.lstrip()
