raoul/openlp
1
0
Fork 0
forked from openlp/openlp
Code Issues Pull Requests Projects Releases Wiki Activity

Add docstrings to tests

Browse Source
This commit is contained in:
Simon Hanna 2016-01-05 22:35:35 +01:00
parent c7563a5a64
commit 46301b63f4
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
tests/functional/openlp_plugins/songs/test_songformat.py
View File

@ -28,8 +28,14 @@ from openlp.plugins.songs.lib.importer import SongFormat
class TestSongFormat(TestCase): class TestSongFormat(TestCase):
"""
Test the functions in the :class:`SongFormat` class.
"""
def test_get_format_list(self): def test_get_format_list(self):
"""
Test that get_format_list() returns all available formats
"""
# GIVEN: The SongFormat class # GIVEN: The SongFormat class
# WHEN: Retrieving the format list # WHEN: Retrieving the format list
# THEN: All SongFormats should be returned # THEN: All SongFormats should be returned
@ -37,6 +43,9 @@ class TestSongFormat(TestCase):
"The returned SongFormats don't match the stored ones") "The returned SongFormats don't match the stored ones")
def test_get_attributed_no_attributes(self): def test_get_attributed_no_attributes(self):
"""
Test that SongFormat.get(song_format) returns all attributes associated with the given song_format
"""
# GIVEN: A SongFormat # GIVEN: A SongFormat
# WHEN: Retrieving all attributes of a SongFormat # WHEN: Retrieving all attributes of a SongFormat
for song_format in SongFormat.get_format_list(): for song_format in SongFormat.get_format_list():
@ -45,6 +54,9 @@ class TestSongFormat(TestCase):
"The returned attributes don't match the stored ones") "The returned attributes don't match the stored ones")
def test_get_attributed_single_attribute(self): def test_get_attributed_single_attribute(self):
"""
Test that SongFormat.get(song_format, attribute) returns only one -and the correct- attribute
"""
# GIVEN: A SongFormat # GIVEN: A SongFormat
for song_format in SongFormat.get_format_list(): for song_format in SongFormat.get_format_list():
# WHEN: Retrieving an attribute that overrides the default values # WHEN: Retrieving an attribute that overrides the default values
@ -60,6 +72,9 @@ class TestSongFormat(TestCase):
"The returned attribute does not match the default values stored") "The returned attribute does not match the default values stored")
def test_get_attributed_multiple_attributes(self): def test_get_attributed_multiple_attributes(self):
"""
Test that multiple attributes can be retrieved for a song_format
"""
# GIVEN: A SongFormat # GIVEN: A SongFormat
# WHEN: Retrieving multiple attributes at the same time # WHEN: Retrieving multiple attributes at the same time
for song_format in SongFormat.get_format_list(): for song_format in SongFormat.get_format_list():