Implement Backend Test Cases for fAIr

kshitijrajsharma commented 6 months ago

Issue Description:

Objective:

We are seeking an enthusiastic intern to collaborate on enhancing our Django backend project by integrating backend test cases. This issue aims to ensure the robustness and reliability of our application through systematic testing practices. Your contribution will involve writing test cases, determining code coverage, and ensuring all functionalities are tested following industry best practices.

Responsibilities:

Understand the current project structure and functionality by reviewing the existing models, views, and URLs. Backend is available here. If you have trouble installing the application to do raise issue or ask for help
Collaborate with the development team to identify critical areas lacking test coverage.
Write comprehensive test cases for the Django backend, focusing on models, APIs, and integration points.
Utilize Django's testing framework effectively to automate tests.
Ensure test cases are well-documented and maintainable.
Measure and report code coverage to identify untested code segments.
Propose improvements or bug fixes identified during testing.
Participate in code reviews to receive feedback and iterate on your work.

Expected Outcomes:

A suite of automated tests covering critical functionalities of the Django backend.
Documentation accompanying each test case, explaining its purpose and methodology.
A code coverage report highlighting tested vs. untested code segments.
Recommendations for improving code quality and application performance based on test findings.

Resources

Test Folder Structure :

└── backend
    └── tests
        ├── __init__.py
        ├── test_worker_example.py
        ├── test_models_example.py
        └── test_views_example.py

Tests should cover Any of the following :

models
views
& the API. Find API swagger here

Videos and docs :

Find begineer guide to contribute to HOTOSM Tools here
Know about fAIr as a project and what does is do here
Django test coverage tool : https://coverage.readthedocs.io/en/latest/
Find HOTOSM Developer guidelines here
factory_boy, model_backery, and mock: all are used in place of fixtures or the ORM for populating needed data for testing. Both fixtures and the ORM can be slow and need to be updated whenever your model changes.
Documentation on getting started with django projects testing by realpython

What should be included in PR:

Black formatter should be used
At least mention following section

--- What does this PR do ?

Detail summary about the changes you have done, Which backend functionality you have worked on , Mention link of issue you have worked on

--- Consideration:

What are the steps/alternatives you have considered while developing

--- How to test ?

Steps to tests

Support:

Feel free to ask questions or seek clarifications by commenting on this issue. We're excited to see your contributions.

How to Proceed:

Fork the repository and set up the project locally.
Comment on this issue mentioning you will be contributing
Familiarize yourself with the codebase and Django's testing framework.
Start by creating new branch in your fork with functional branch name like tests/aoi-models
Write a few test cases and submit them as a pull request in your own fork
Come back to this issue thread and drop your pull request URL for initial feedback.
Gradually work on covering more components and functionalities. Once approved, you can raise PR to this main repo

Issue will be completed when :

All critical backend functionalities are covered by test cases.
Code coverage is significantly improved, aiming at least 80%.
Tests are well-documented and follow coding standards.

kshitijrajsharma commented 5 months ago

@kshitijrajsharma I have received an invite to the HOTOSM slack community but I am able to join due to an org email being required. Should I go ahead and work on this issue?

Yes sure !

TMicha commented 5 months ago

Hello @kshitijrajsharma, I would like to work on this also...I will revert as soon as I have created a PR. Thank you

chiomaubaezuonu commented 5 months ago

Hello @kshitijrajsharma, I would also be working on this issue.

azharcodeit commented 5 months ago

Hey @kshitijrajsharma, appreciate the opportunity to contribute, will drop a PR as soon as possible!

nifedara commented 5 months ago

Hi @kshitijrajsharma, I will be contributing

princyym commented 5 months ago

Hello @kshitijrajsharma, I want to contribute for the same!!

nifedara commented 5 months ago

Hello @kshitijrajsharma, when I hit the login to get an access token, I get this:

Another time, it redirects here to the frontend:

I can't seem to get the access token. I don't know where to get it from here. Please point me to how to get it

mvhammedali commented 5 months ago

@nifedara inspect > Application > LocalStorage

nifedara commented 5 months ago

@nifedara inspect > Application > LocalStorage

Thank youu. I have gotten it now

nwekealex65 commented 5 months ago

@kshitijrajsharma Please review my PR https://github.com/nwekealex65/fAIr/pull/6

medinasheriff commented 5 months ago

Hi, I will be contributing to this project. Thank you.

nifedara commented 5 months ago

Hi, @kshitijrajsharma, here is my PR: Oluwanifemi PR

tony-nyagah commented 5 months ago

Hi @kshitijrajsharma, here is my PR: https://github.com/tony-nyagah/fAIr/pull/3

durotimmi-sk commented 5 months ago

hi, i will like to contribute to this project. Thank you

Pazil24 commented 5 months ago

I would like to contribute to this @kshitijrajsharma , I an still analyzing and learning. However I love the challenge this project brings.

princyym commented 5 months ago

hello @kshitijrajsharma,. Do I need to create all three files (models, views, and API) or is it sufficient to create just one of them? Additionally, should I document the test cases in Notion?

nifedara commented 5 months ago

Hello, @kshitijrajsharma, Here's another PR:

hotosm / fAIr