[MOHAMED] 100% coverage on both function's tests #4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Implemented django mock tests for assumed branch cases on tests.py in web subdirectory of mygpo. - Need to clarify, and add better manual branch instrumentation, for proper testing and coverage enhancment
- Completed manual instrumentation over branches, and enhanced testing in tests.py for coverage enhancement
Adjusted format for test implementation, instrumentation, and coverage to match team formatting, and specific output to a text file.
Final major adjustment to episode_status_icon testing. Changed coverage.txt file location to be a universal project root, rather than a local directory. Full branch coverage achieved
Adjusted testing and instrumentation with additional helper methods to report coverage information to root
…ctions episode_status_icon and mark_outdated in class EpisodeUpdater Completed instrumentation, testing and coverage, with coverage reporting functionality. I have added additional instrumentation for hidden branches, and implicit branches. Branch instrumentation for EpisodeUpdater was only applied to mark_outdated as they had the only functional instrumentable branches in the class, with tests checking functionality of Updater, and also mark_outdated for proper functionality in Django. Please note, coverage.txt will be generated in the same directory of the test directory, regardless of local system. Please adjust as necessary to conform to team standards.
Had to change exporting behaviour for coverage reporting in accordance to team standards
…odeUpdater) - Modified branch naming conventions - Re-analysed and found instrumentatino and testing errors with EpisodeUpdater testing
andreas-stolle
approved these changes
Jun 26, 2024
| cls.mock_episode = Mock() | ||
| cls.mock_podcast = Mock() | ||
| cls.updater = EpisodeUpdater(cls.mock_episode, cls.mock_podcast) | ||
| cls.cumulative_branch_coverage = {"Branch 0": False, "Branch 1": False} |
There was a problem hiding this comment.
Good idea to use a map!
| self.assertEqual(self.mock_episode.title, 'new-title') | ||
| self.assertTrue(self.mock_episode.save.called) | ||
|
|
||
| self.assertFalse(self.updater.branch_coverage["Branch 0"]) |
There was a problem hiding this comment.
You didn't need to assert the branch coverage values, as they would be printed anyway on the file, but it does not negatively impact the code.
| staticfiles_storage.url("delete.png"), | ||
| "%s%s%s" | ||
| % (_("This episode has been deleted"), date_string, device_string), | ||
| ) | ||
| else: | ||
| coverage_data['Branch 11'] +=1 # Branch 12 taken, implicit branch |
There was a problem hiding this comment.
Nice job at covering all branches.
| self.assertEqual(result, mark_safe(expected)) | ||
|
|
||
| def test_unknown_action(self): | ||
| action = Action(action='unknown') |
There was a problem hiding this comment.
Very thought through test cases!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Assigned functions:
Testing for function assignments:
Results
There was no testing, covering or branch instrumentation for the functions I have been assigned. Given their relative cyclomatic complexity, and use within the repository this seemed like a higher priority set of functions to instrument, and complete coverage over.
Though by looking at the overall repository, we tend to see a pattern of mock django test classes being executed in */tests.py per directory.
I then used this pattern for testing to implement testing for episode_status_icon in mygpo/web/tests.py, and class_ EpisodeUpdater (more specifically it's function mark_outdated) in mygpo/data/tests.py.
Relative branch coverage reports, are automatically generated as episode_status_icon__coverage.txt and EPISODEUPDATER_mark_outdated_coverage.txt in the directory mygpo/coverage/mohamed.
Coverage improvements for the base files shown by coverage reports generated by coverage.py are shown below:
episodes.py:
Before instrumentation and testing episode_status_icon:
After instrumentation and testing episode_status_icon:
feeddownloader.py:
Before instrumentation and testing EpisodeUpdater:
After instrumentation and testing EpisodeUpdater:
