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.

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

Integrate Keploy for Testing and Add to CI Pipeline #120

Open
SkySingh04 opened this issue Dec 8, 2024 · 6 comments
Open

Integrate Keploy for Testing and Add to CI Pipeline #120

SkySingh04 opened this issue Dec 8, 2024 · 6 comments
Assignees
Labels
Devops Devops issue enhancement New feature or request Testing Issues related to tests

Comments

@SkySingh04
Copy link
Member

We need to integrate [Keploy](https://keploy.io/) into our project for automated end-to-end testing and mock generation. Keploy will help us improve test coverage by capturing API interactions and replaying them during testing. Additionally, it will be integrated into the CI pipeline to ensure consistent and automated testing during the development lifecycle.

Tasks:

  1. Setup Keploy Locally:

    • Install and configure Keploy in the development environment.
    • Capture API interactions to generate test cases and mocks.
    • Validate the accuracy and completeness of the generated test cases.
  2. Integration with Codebase:

    • Add Keploy to the backend services for capturing and replaying API requests.
    • Update existing test suites to incorporate Keploy's replay capabilities.
    • Ensure compatibility with the current tech stack (Next.js, TypeScript, etc.).
  3. CI Pipeline Integration:

    • Add Keploy to the CI pipeline configuration.
    • Run Keploy tests as part of the CI workflow.
    • Ensure the CI pipeline fails when tests do not pass.
  4. Documentation:

    • Update project documentation to include steps for running Keploy locally and troubleshooting issues.
    • Document the new CI process with Keploy.
  5. Testing and Verification:

    • Perform a dry run of the CI pipeline to ensure Keploy tests execute correctly.
    • Verify that the test coverage includes edge cases and commonly used scenarios.

Acceptance Criteria:

  • Keploy is successfully integrated into the backend and the testing workflow.
  • CI pipeline runs Keploy tests and reports results.
  • Documentation is updated with clear instructions for setting up and using Keploy.
  • All existing and new tests pass in both local and CI environments.

Additional Context:
Keploy will capture API interactions during local development and replay them in test environments. This ensures deterministic and reliable tests, reducing the effort needed for manual test case creation.

Please ensure compatibility with our existing CI pipeline tools and ensure no disruptions to other workflows.

@SkySingh04 SkySingh04 added enhancement New feature or request Devops Devops issue labels Dec 8, 2024
@slashexx
Copy link

slashexx commented Dec 8, 2024

I'll be working on this !

Can you please assign ?

@SkySingh04
Copy link
Member Author

@slashexx we need da integration tests, you can probably mock the firebase dependency and see if that works?

@SkySingh04 SkySingh04 added the Testing Issues related to tests label Dec 14, 2024
@slashexx
Copy link

@SkySingh04 I'm trying to use firebase emulators to mock the firebase functionality in the CI and it's kinda unable to access the emulator ports. I'm stuck on that, elephant in the room is the firebase login could it be related to it ?

image

here's a snap of the firebase.json I made
image

PS: I have tried changing the ports and it's all the same error on this.

@SkySingh04
Copy link
Member Author

Hey @slashexx, let’s dive right in,
The Firebase ports? A battle to win!
The "elephant in the room" you claim,
Might just be login—but skill’s to blame. 😉

A Google search, a well-placed cue,
Could bring the answers right to you.
With debugging grit and a dash of flair,
You’ll solve this puzzle, I’m sure, I swear!

So take a breath, don’t lose the fight,
Your victory’s near—just keep it tight.
If it gets too tough, give me a shout,
We’ll figure this Firebase mystery out!

@slashexx
Copy link

Hey @SkySingh04 , I hear your call,
But this issue’s wall’s too tall.
The Firebase beast I tried to tame,
Yet here I stand—no closer to fame.

The ports are wild, the logs unclear,
No breakthrough seems to be near.
So with respect, I’ll bow away,
This ticket’s yours another day.

Close this one, let’s call it done,
For now, my battle’s lost—not won.
If the clouds do part, I’ll rise anew,
But today, this task, I must bid adieu. 🚪✨

@SkySingh04 SkySingh04 closed this as not planned Won't fix, can't repro, duplicate, stale Dec 17, 2024
@SkySingh04 SkySingh04 reopened this Dec 24, 2024
@SkySingh04
Copy link
Member Author

Wake up Boys, we are migrating to mongo, so Keploy is on

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Devops Devops issue enhancement New feature or request Testing Issues related to tests
Projects
None yet
Development

No branches or pull requests

2 participants