You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
324 lines
13 KiB
Python
324 lines
13 KiB
Python
import os.path
|
|
import unittest
|
|
import traceback
|
|
|
|
import git
|
|
from click.testing import CliRunner
|
|
|
|
import yaclog.changelog
|
|
from yaclog.cli.__main__ import cli
|
|
|
|
|
|
def check_result(runner, result, success: bool = True):
|
|
runner.assertEqual((result.exit_code == 0), success,
|
|
f'\noutput: {result.output}\ntraceback: ' + ''.join(
|
|
traceback.format_exception(*result.exc_info)))
|
|
|
|
|
|
class TestCreation(unittest.TestCase):
|
|
def test_init(self):
|
|
"""Test creating and overwriting a changelog"""
|
|
runner = CliRunner()
|
|
location = 'CHANGELOG.md'
|
|
err_str = 'THIS FILE WILL BE OVERWRITTEN'
|
|
|
|
with runner.isolated_filesystem():
|
|
result = runner.invoke(cli, ['init'])
|
|
check_result(self, result)
|
|
self.assertTrue(os.path.exists(os.path.abspath(location)), 'yaclog init did not create a file')
|
|
self.assertIn(location, result.output, "yaclog init did not echo the file's correct location")
|
|
|
|
with open(location, 'r') as fp:
|
|
self.assertEqual('# Changelog\n', fp.readline())
|
|
self.assertEqual('\n', fp.readline())
|
|
self.assertEqual('All notable changes to this project will be documented in this file',
|
|
fp.readline().rstrip())
|
|
|
|
with open(location, 'w') as fp:
|
|
fp.write(err_str)
|
|
|
|
result = runner.invoke(cli, ['init'], input='y\n')
|
|
check_result(self, result)
|
|
self.assertTrue(os.path.exists(os.path.abspath(location)), 'file no longer exists after overwrite')
|
|
self.assertIn(location, result.output, "yaclog init did not echo the file's correct location")
|
|
|
|
with open(location, 'r') as fp:
|
|
self.assertNotEqual(fp.read(), err_str, 'file was not overwritten')
|
|
|
|
def test_init_path(self):
|
|
"""Test creating a changelog with a non-default filename"""
|
|
runner = CliRunner()
|
|
location = 'A different file.md'
|
|
|
|
with runner.isolated_filesystem():
|
|
result = runner.invoke(cli, ['--path', location, 'init'])
|
|
check_result(self, result)
|
|
self.assertTrue(os.path.exists(os.path.abspath(location)), 'yaclog init did not create a file')
|
|
self.assertIn(location, result.output, "yaclog init did not echo the file's correct location")
|
|
|
|
def test_does_not_exist(self):
|
|
"""Test if an error is thrown when the file does not exist"""
|
|
runner = CliRunner()
|
|
|
|
with runner.isolated_filesystem():
|
|
result = runner.invoke(cli, ['show'])
|
|
check_result(self, result, False)
|
|
self.assertIn('does not exist', result.output)
|
|
|
|
|
|
class TestTagging(unittest.TestCase):
|
|
def test_tag_addition(self):
|
|
"""Test adding tags to versions"""
|
|
runner = CliRunner()
|
|
location = 'CHANGELOG.md'
|
|
|
|
with runner.isolated_filesystem():
|
|
in_log = yaclog.Changelog(location)
|
|
in_log.versions = [yaclog.changelog.VersionEntry(), yaclog.changelog.VersionEntry()]
|
|
|
|
in_log.versions[0].name = '1.0.0'
|
|
in_log.versions[1].name = '0.9.0'
|
|
in_log.write()
|
|
|
|
result = runner.invoke(cli, ['tag', 'tag1'])
|
|
check_result(self, result)
|
|
|
|
result = runner.invoke(cli, ['tag', 'tag2', '0.9.0'])
|
|
check_result(self, result)
|
|
|
|
out_log = yaclog.read(location)
|
|
self.assertEqual(out_log.versions[0].tags, ['TAG1'])
|
|
self.assertEqual(out_log.versions[1].tags, ['TAG2'])
|
|
|
|
result = runner.invoke(cli, ['tag', 'tag3', '0.8.0'])
|
|
check_result(self, result, False)
|
|
|
|
def test_tag_deletion(self):
|
|
"""Test deleting tags from versions"""
|
|
runner = CliRunner()
|
|
location = 'CHANGELOG.md'
|
|
|
|
with runner.isolated_filesystem():
|
|
in_log = yaclog.Changelog(location)
|
|
in_log.versions = [None, None]
|
|
in_log.versions = [yaclog.changelog.VersionEntry(), yaclog.changelog.VersionEntry()]
|
|
|
|
in_log.versions[0].name = '1.0.0'
|
|
in_log.versions[0].tags = ['TAG1']
|
|
|
|
in_log.versions[1].name = '0.9.0'
|
|
in_log.versions[1].tags = ['TAG2']
|
|
in_log.write()
|
|
|
|
result = runner.invoke(cli, ['tag', '-d', 'tag2', '0.8.0'])
|
|
check_result(self, result, False)
|
|
|
|
result = runner.invoke(cli, ['tag', '-d', 'tag3', '0.9.0'])
|
|
check_result(self, result, False)
|
|
|
|
result = runner.invoke(cli, ['tag', '-d', 'tag1'])
|
|
check_result(self, result)
|
|
|
|
out_log = yaclog.read(location)
|
|
self.assertEqual(out_log.versions[0].tags, [])
|
|
self.assertEqual(out_log.versions[1].tags, ['TAG2'])
|
|
|
|
result = runner.invoke(cli, ['tag', '-d', 'tag2', '0.9.0'])
|
|
check_result(self, result)
|
|
|
|
out_log = yaclog.read(location)
|
|
self.assertEqual(out_log.versions[0].tags, [])
|
|
self.assertEqual(out_log.versions[1].tags, [])
|
|
|
|
|
|
class TestRelease(unittest.TestCase):
|
|
def test_increment(self):
|
|
"""Test version incrementing on release"""
|
|
runner = CliRunner()
|
|
location = 'CHANGELOG.md'
|
|
|
|
with runner.isolated_filesystem():
|
|
runner.invoke(cli, ['init']) # create the changelog
|
|
runner.invoke(cli, ['entry', '-b', 'entry number 1'])
|
|
|
|
result = runner.invoke(cli, ['release', '1.0.0'])
|
|
check_result(self, result)
|
|
self.assertEqual(yaclog.read(location).versions[0].name, '1.0.0')
|
|
self.assertIn('1.0.0', result.output)
|
|
|
|
runner.invoke(cli, ['entry', '-b', 'entry number 2'])
|
|
|
|
result = runner.invoke(cli, ['release', '-p'])
|
|
check_result(self, result)
|
|
self.assertEqual(yaclog.read(location).versions[0].name, '1.0.1')
|
|
self.assertIn('1.0.1', result.output)
|
|
|
|
result = runner.invoke(cli, ['release', '-y', '-s', 2])
|
|
check_result(self, result)
|
|
self.assertEqual(yaclog.read(location).versions[0].name, '1.0.2')
|
|
self.assertIn('1.0.2', result.output)
|
|
|
|
runner.invoke(cli, ['entry', '-b', 'entry number 3'])
|
|
|
|
result = runner.invoke(cli, ['release', '-m'])
|
|
check_result(self, result)
|
|
self.assertEqual(yaclog.read(location).versions[0].name, '1.1.0')
|
|
self.assertIn('1.1.0', result.output)
|
|
|
|
runner.invoke(cli, ['entry', '-b', 'entry number 4'])
|
|
|
|
result = runner.invoke(cli, ['release', '-M'])
|
|
check_result(self, result)
|
|
self.assertEqual(yaclog.read(location).versions[0].name, '2.0.0')
|
|
self.assertIn('2.0.0', result.output)
|
|
|
|
runner.invoke(cli, ['entry', '-b', 'entry number 5'])
|
|
|
|
result = runner.invoke(cli, ['release', '-Ma'])
|
|
check_result(self, result)
|
|
self.assertEqual(yaclog.read(location).versions[0].name, '3.0.0a1')
|
|
self.assertIn('3.0.0a1', result.output)
|
|
|
|
result = runner.invoke(cli, ['release', '-b'])
|
|
check_result(self, result)
|
|
self.assertEqual(yaclog.read(location).versions[0].name, '3.0.0b1')
|
|
self.assertIn('3.0.0b1', result.output)
|
|
|
|
result = runner.invoke(cli, ['release', '-r'])
|
|
check_result(self, result)
|
|
self.assertEqual(yaclog.read(location).versions[0].name, '3.0.0rc1')
|
|
self.assertIn('3.0.0rc1', result.output)
|
|
|
|
result = runner.invoke(cli, ['release', '-r'])
|
|
check_result(self, result)
|
|
self.assertEqual(yaclog.read(location).versions[0].name, '3.0.0rc2')
|
|
self.assertIn('3.0.0rc1', result.output)
|
|
|
|
result = runner.invoke(cli, ['release', '-f'])
|
|
check_result(self, result)
|
|
self.assertEqual(yaclog.read(location).versions[0].name, '3.0.0')
|
|
self.assertIn('3.0.0', result.output)
|
|
|
|
result = runner.invoke(cli, ['release', '-p', '-n'])
|
|
check_result(self, result)
|
|
self.assertEqual(yaclog.read(location).versions[0].name, '3.0.1')
|
|
self.assertEqual(yaclog.read(location).versions[1].name, '3.0.0')
|
|
self.assertIn('3.0.1', result.output)
|
|
|
|
def test_commit(self):
|
|
"""Test committing and tagging releases"""
|
|
runner = CliRunner()
|
|
|
|
with runner.isolated_filesystem():
|
|
repo = git.Repo.init(os.path.join(os.curdir, 'testing'))
|
|
os.chdir('testing')
|
|
repo.index.commit('initial commit')
|
|
|
|
with repo.config_writer() as cw:
|
|
cw.set_value('user', 'email', 'unit-tester@example.com')
|
|
cw.set_value('user', 'name', 'unit-tester')
|
|
|
|
runner.invoke(cli, ['init']) # create the changelog
|
|
runner.invoke(cli, ['entry', '-b', 'entry number 1'])
|
|
|
|
result = runner.invoke(cli, ['release', 'Version 1.0.0', '-c'], input='y\n')
|
|
check_result(self, result)
|
|
self.assertIn('Created commit', result.output)
|
|
self.assertIn('Created tag', result.output)
|
|
self.assertIn(repo.head.commit.hexsha[0:7], result.output)
|
|
self.assertEqual(repo.tags[0].name, '1.0.0')
|
|
|
|
def test_cargo(self):
|
|
"""Test updating cargo.toml files"""
|
|
runner = CliRunner()
|
|
with runner.isolated_filesystem():
|
|
with open("Cargo.toml", "w") as fp:
|
|
fp.write((
|
|
'[package]\n'
|
|
'name = "dummy"\n'
|
|
'version = "0.3.4"\n'
|
|
'authors = ["Andrew Cassidy <drewcassidy@me.com>"]\n'
|
|
'description = "A dummy crate used for testing yaclog"\n'
|
|
'keywords = ["does", "not", "exist"]\n'
|
|
'edition = "2018"\n'
|
|
))
|
|
|
|
runner.invoke(cli, ['init']) # create the changelog
|
|
runner.invoke(cli, ['entry', '-b', 'entry number 1'])
|
|
|
|
result = runner.invoke(cli, ['release', 'Version 1.0.0', '-C'])
|
|
check_result(self, result)
|
|
|
|
with open("Cargo.toml", "r") as fp:
|
|
self.assertIn('version = "1.0.0"', fp.read())
|
|
# we're just going to trust tomlkit not to mangle everything else
|
|
|
|
|
|
class TestShow(unittest.TestCase):
|
|
|
|
# noinspection PyShadowingNames
|
|
def setUp(self):
|
|
self.runner = CliRunner()
|
|
self.location = 'CHANGELOG.md'
|
|
|
|
self.log = yaclog.Changelog()
|
|
|
|
self.log.add_version(name='1.0.0').add_entry('- entry number 1')
|
|
self.log.add_version(name='Version 2.0.0').add_entry('- entry number 2', 'Added')
|
|
self.log.add_version(name='Three Point Oh').add_entry('entry number 3')
|
|
v = self.log.add_version(name='4.0.0 "Euclid"')
|
|
v.add_entry('- entry number 4')
|
|
v.add_entry('- entry number 5')
|
|
v.tags.append('TAGGED')
|
|
|
|
self.modes = {
|
|
'full': ([], lambda v, k: v.text(**k), '\n\n'),
|
|
'name': (['-n'], lambda v, k: v.name, '\n'),
|
|
'body': (['-b'], lambda v, k: v.body(**k), '\n\n'),
|
|
'header': (['-h'], lambda v, k: v.header(**k), '\n'),
|
|
}
|
|
|
|
def test_show_all(self):
|
|
"""Test showing all version information"""
|
|
|
|
with self.runner.isolated_filesystem():
|
|
self.log.write(self.location)
|
|
|
|
for mode, t in self.modes.items():
|
|
with self.subTest(mode, flags=t[0]):
|
|
check_result(self, result := self.runner.invoke(cli, ['show', '-a'] + t[0]))
|
|
self.assertEqual(t[2].join([t[1](v, {'md': False}) for v in self.log.versions]),
|
|
result.output.strip(), 'incorrect plaintext output')
|
|
|
|
check_result(self, result := self.runner.invoke(cli, ['show', '-am'] + t[0]))
|
|
self.assertEqual(t[2].join([t[1](v, {'md': True}) for v in self.log.versions]),
|
|
result.output.strip(), 'incorrect markdown output')
|
|
|
|
def test_show_version(self):
|
|
with self.runner.isolated_filesystem():
|
|
self.log.write(self.location)
|
|
|
|
for mode, t in self.modes.items():
|
|
with self.subTest(mode, flags=t[0]):
|
|
|
|
for version in self.log.versions:
|
|
check_result(self, result := self.runner.invoke(cli, ['show', version.name] + t[0]))
|
|
self.assertEqual(t[1](version, {'md': False}),
|
|
result.output.strip(), 'incorrect plaintext output')
|
|
|
|
check_result(self, result := self.runner.invoke(cli, ['show', version.name[-5:]] + t[0]))
|
|
self.assertEqual(t[1](version, {'md': False}),
|
|
result.output.strip(), 'incorrect plaintext output')
|
|
|
|
check_result(self, result := self.runner.invoke(cli, ['show', version.name, '-m'] + t[0]))
|
|
self.assertEqual(t[1](version, {'md': True}),
|
|
result.output.strip(), 'incorrect markdown output')
|
|
|
|
check_result(self, result := self.runner.invoke(cli, ['show', version.name[-5:], '-m'] + t[0]))
|
|
self.assertEqual(t[1](version, {'md': True}),
|
|
result.output.strip(), 'incorrect markdown output')
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|