Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Setting up Karate Test for GraphQl #42

Closed
wants to merge 9 commits into from
Closed

Setting up Karate Test for GraphQl #42

wants to merge 9 commits into from

Conversation

olisaagbafor
Copy link
Contributor

@olisaagbafor olisaagbafor commented Dec 2, 2024 •
edited
Loading

This PR is being superseded by #56 to align with project commit guidelines.

Pull Request for SafeTrust - Add Automated API Testing Framework

❗ Pull Request Information

This PR implements comprehensive automated testing for the SafeTrust GraphQL API using the Karate framework. It establishes a robust testing infrastructure focusing on user authentication, permissions, and wallet functionality.

🌀 Summary of Changes

  • Test Infrastructure Setup:

    • Added Karate testing framework configuration
    • Created Docker test environment
    • Implemented test reporting system

  • Test Suite Implementation:

    • Authentication tests (Firebase token validation, JWT claims)
    • User management tests (CRUD operations, permissions)
    • Wallet functionality tests (creation, validation)
    • Error scenario coverage

  • Project Structure:

    • Organized test files in feature-based hierarchy
    • Added reusable test helpers and schemas
    • Implemented environment-specific configurations

🛠 Testing

Evidence Before Solution

  • No automated testing infrastructure
  • Manual verification required for API changes
  • Inconsistent test coverage

Evidence After Solution

  • Automated test execution via Docker
  • Comprehensive test coverage for:
    • User authentication flows
    • RBAC permissions
    • Wallet operations
    • Error scenarios
  • Generated test reports showing coverage metrics

📂 Related Issue

This pull request will close #29 - Implement automated API testing infrastructure

🎉 Thank you for reviewing this PR!

@olisaagbafor olisaagbafor marked this pull request as ready for review December 2, 2024 11:35
@diegoTech14
Copy link
Contributor

Hi @olisaagbafor

  1. Could you change the dependencies from package.json in the tests directory to the main package.json?
  2. We would like to see the setup working in a video. Could you make us a video, please?

For the video you can use loom -> https://www.loom.com/looms/videos

@diegoTech14
Copy link
Contributor

@olisaagbafor Hey man, PR looks good, just would like to see a video please 🚀

@olisaagbafor
Add test reporting configuration
614ef80 
- Add Cucumber reporting dependencies
- Configure Maven Surefire plugin for report generation
- Add TestRunner class with report generation logic
- Update Docker configuration for report persistence
- Add .gitignore for report directories
@olisaagbafor
Copy link
Contributor Author

@diegoTech14 The video link is here

@diegoTech14
Copy link
Contributor

@diegoTech14 The video link is here

Will check ASAP, thanks!

rvalenciano
rvalenciano requested changes Dec 3, 2024
View reviewed changes
Copy link
Contributor

@rvalenciano rvalenciano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@olisaagbafor this is looking great, some mino comments;

Also, can we add some instructions on the README on how to run the tests?

Best

@diegoTech14
Copy link
Contributor

@olisaagbafor Hey man, any updates?

@olisaagbafor
Copy link
Contributor Author

Yeah, am on it, Just had some buds to clear up...

@sotoJ24 sotoJ24 self-requested a review December 6, 2024 19:18
@zleypner
Copy link
Contributor

zleypner commented Dec 8, 2024

Hello @olisaagbafor ,
May please have your Telegram or contact me at https://t.me/anwar_zlcr ?
I am having an error while running the Karate Tests.

@zleypner
Copy link
Contributor

Hello @olisaagbafor! As per our conversation in telegram. Do you have any updates regarding the errors for the tests?

@olisaagbafor
Copy link
Contributor Author

@zleypner Yeah I do will update soon

@olisaagbafor
Resolving Error while running test
8a9a580
@olisaagbafor
feat(tests): configure Karate test environment with Docker
6cb1a79 
- Add Docker Compose setup for test environment
- Configure Karate test framework
- Set up test result reporting to tests/results
- Add README with test execution instructions

This commit sets up the initial testing infrastructure using Karate
framework and Docker Compose, enabling automated API testing against
a containerized Hasura GraphQL engine.
@olisaagbafor
Merge branch 'main' into fix#29
7bfc1ea
@olisaagbafor
Copy link
Contributor Author

@zleypner the errors should be gone now, and I have updated the README for the instruction on how to run the test

@olisaagbafor
Copy link
Contributor Author

Please let me know if there is anything else...

@zleypner
Copy link
Contributor

zleypner commented Dec 11, 2024 •
edited
Loading

Hello @olisaagbafor Thank you for the updates! Checking

@zleypner
Copy link
Contributor

We are almost there @olisaagbafor , thank you! Would yo be so kind to please update the Loom video?

@olisaagbafor
Copy link
Contributor Author

Ok will do that shortly @zleypner

@olisaagbafor
Copy link
Contributor Author

@zleypner the video link is here

@zleypner
Copy link
Contributor

zleypner commented Dec 12, 2024 •
edited
Loading

Thanks @olisaagbafor for this outstanding work! The implementation of the Karate testing framework is extremely well-structured and thorough. I particularly appreciate:

Your responsiveness to feedback and willingness to iterate on improvements
The clear documentation and testing instructions you've added to the README
Your professional approach to addressing all review comments and technical issues

Your attention to detail and commitment to quality really shows through in this PR. This testing infrastructure will be invaluable for maintaining code quality as we scale. Great job on delivering such a robust solution! 🎯 👏

I will proceed to merge asap

@olisaagbafor
Copy link
Contributor Author

@zleypner thanks alot for your complements ❤️, I truly appreciate 🙏

@zleypner
Copy link
Contributor

zleypner commented Dec 12, 2024 •
edited
Loading

@olisaagbafor There is one detail pending mentioned in the Contributors guideline. Please update the atomic commits based on the git guidelines.
safetrustcr/Frontend#35
image

@olisaagbafor olisaagbafor deleted the fix#29 branch December 12, 2024 20:00
@olisaagbafor olisaagbafor restored the fix#29 branch December 12, 2024 20:04
@olisaagbafor olisaagbafor reopened this Dec 12, 2024
@olisaagbafor olisaagbafor mentioned this pull request Dec 12, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sotoJ24 sotoJ24 sotoJ24 approved these changes

@diegoTech14 diegoTech14 diegoTech14 approved these changes

@rvalenciano rvalenciano Awaiting requested review from rvalenciano

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Set up Karate Testing Framework for GraphQL API - Users Module
5 participants
@olisaagbafor @diegoTech14 @zleypner @rvalenciano @sotoJ24