arpittyagi102 / LinkUp

Link Up is a real time chatting application project, it utilizes, MERN, socket.io
https://getlinkup.vercel.app
MIT License
23 stars 30 forks source link

Added intergration and unit testing for backend process #42

Closed DeshyDan closed 1 year ago

DeshyDan commented 1 year ago

This pull request adds tests for the API endpoints using the Jest and Supertest libraries. However, I have not tested all the endpoints, such as POST user/googleLogin, as I did not have enough time to investigate how Google logins work in the backend. The coverage report attached in the test/coverage folder show the coverage of the tests and the files that were not tested. To view the report, open the index.html file in the browser.

Additionally, I have created a testing environment with dotenv. I believe the corresponding file can be removed from this branch since users can create their own testing database with their preferred configuration. However, i still believe not removing will not cause any issues as the testing environment is not used in the production environment and the testing database is not used in the production database.

Furthermore, I have removed the console.log(errors) statements from the controllers. These statements were causing the testing terminal to be cluttered. I recommend logging these errors in a file instead. You could use the winston library to log errors in file.

To enhance the contribution process, I request the creation of a "To-Do" section in the contribution.md file. This section should specify the features or bugs, goals, and tasks the contributor should complete. This will help the contributor understand the scope of the issue and the tasks. For example it could include the following:

I have also added a "Testing" section to the contribution.md file. This section should specify the testing environment and the commands to run the tests. This will help the contributor understand how to run the tests.

vercel[bot] commented 1 year ago

Someone is attempting to deploy a commit to a Personal Account owned by @arpittyagi102 on Vercel.

@arpittyagi102 first needs to authorize it.

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
link-up ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 13, 2023 8:43am