Project for Intern Reeya Gupta
Closed Sep 26, 2023
100% complete
Biocompute project (Deliverables approved by @HadleyKing):
High Level Project Deliverables:
- Develop a test DB that can be applied using Django and pytest Fixtures
- API Documentation: Create documentation that explains the available endpoints, their functionalities, and how to interact with the API.
- API Testing: Write comprehensive tests for the API using…
Biocompute project (Deliverables approved by @HadleyKing):
High Level Project Deliverables:
- Develop a test DB that can be applied using Django and pytest Fixtures
- API Documentation: Create documentation that explains the available endpoints, their functionalities, and how to interact with the API.
- API Testing: Write comprehensive tests for the API using the Django testing framework. Verify that the API endpoints behave as expected and return the correct responses.
Specific Tasks:
- Read and understand the BCO API documentation (github repo). Review the README file and any additional documentation in the repository.
- Follow the Django tutorial on pytest fixtures (Tutorial links provided by Hadley). Learn about pytest fixtures and how they can simplify testing setup and teardown procedures.
- Follow the first tutorial on "Testing in Django Part 1: Best Practices and Examples" to gain insights into testing Django applications, including unit tests, integration tests, and using the Django testing framework.
- Implement the BCO API endpoints using Django, following the guidelines provided in the GitHub repository.
- Apply the concepts from the second tutorial on "Testing in Django Part 2: Model Mommy vs. Django Testing Fixtures" to create fixtures and populate test data for the BCO API tests.
- Develop a comprehensive suite of tests for the BCO API, covering different aspects such as API endpoints, data validation, and error handling.
- Utilize pytest fixtures to create reusable test setup code for the BCO API tests, enhancing test organization and efficiency.
- Follow the third tutorial on "Django and pytest Fixtures" to deepen your understanding of pytest fixtures and how they can be applied in Django testing.
- Document the API endpoints, their expected inputs, outputs, and functionalities, providing clear and concise instructions for API consumers.
- Perform thorough testing and debugging of the BCO API to ensure its stability, reliability, and compliance with the BCO schema.
This milestone is closed.
No open issues remain. View closed issues or see open milestones in this repository.