TESTING.md

Testing the API

Back to README.md(README.md)

Table of Contents

• User Story Testing
• Code validation
  • Python validation
• Manual feature testing
  • Tasks manual testing
  • Comments manual testing
  • Profiles manual testing
  • Watchers manual testing
• Automated testing
• Bugs
  • Known bugs
  • Solved bugs

Table of contents generated with readme-toc

User Story Testing

See the front end documentation.

Code validation

Python validation

All self-written or modified Python files in the project were validated with the Code Institute PEP8 Linter. Some minor errors were found, which were corrected (#22). The present version of the project contains no errors.

Validation screenshots are found in this folder.

Manual feature testing

Tasks manual testing

API name	Method	Path	Expected result	Result
Task List	GET	/tasks	Get all tasks	✅
Create Task	POST	/tasks	Create new task	✅
Task Detail	GET	/tasks/${id}	View existing task	✅
Edit Task	PUT	/tasks/${id}	Edit existing task	✅
Delete Task	DELETE	/tasks/${id}	Delete existing task	✅

Comments manual testing

API name	Method	Path	Expected result	Result
Comment List	GET	/comments	Get all comments	✅
Create Comment	POST	/comments	Create new comment	✅
Comment Detail	GET	/comments/${id}	View existing comment	✅
Edit Comment	PUT	/comments/${id}	Edit existing comment	✅
Delete Comment	DELETE	/comments/${id}	Delete existing comment	✅

Profiles manual testing

API name	Method	Path	Expected result	Result
Profile List	GET	/profiles	Get all profiles	✅
Profile Detail	GET	/profiles/${id}	View existing profile	✅
Edit Profile	PUT	/profiles/${id}	Edit existing profile	✅

Watchers manual testing

API name	Method	Path	Expected result	Result
Watchers List	GET	/watchers	Get all watcher instances	✅
Watch	POST	/watchers	Create new watcher instance	✅
Watcher Detail	GET	/watchers/${id}	View existing watcher instance	✅
Unwatch	DELETE	/watchers/${id}	Delete existing watcher instance	✅

Automated testing

Since the tasks app is the most important one of the API, automated testing concentrated on this app. A total of 7 are present, all pass as expected without issues.

Bugs

All bugs are tracked in GitHub Issues.

Known bugs

Known bugs are listed in GitHub Issues.

Solved bugs

Solved bugs are listed in GitHub Issues.