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

docs for mysql app integration with keploy #305

Merged
merged 11 commits into from
Jan 31, 2024
Merged

docs for mysql app integration with keploy #305

merged 11 commits into from
Jan 31, 2024

Conversation

EraKin575
Copy link
Contributor

@EraKin575 EraKin575 commented Jan 16, 2024

Pull Request Template

Description

sample app doc for mysql sample app

Fixes #1383

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Additional Context (Please include any Screenshots/gifs if relevant)

...

Checklist:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.
  • I have added corresponding tests.
  • Any dependent changes have been merged and published in downstream modules.

Signed-off-by: EraKin575 <[email protected]>
Signed-off-by: EraKin575 <[email protected]>
@EraKin575 EraKin575 changed the title docs for mysql app docs for mysql app integration with keploy Jan 16, 2024
> The `--delay` flag? Oh, that's just giving your app a little breather (in seconds) before the test cases come knocking.

Your results should be looking all _snazzy_, like this:
<img src="/docs/img/testrun-node-fail.png" alt="Sample Keploy Test Result Gin MongoDB" width="100%" style={{ borderRadius: '5px' }}/>
Copy link
Member

Choose a reason for hiding this comment

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

MongoDb is present instead of MySQL

Copy link
Member

Choose a reason for hiding this comment

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

image added is incorrect as well

Copy link
Member

Choose a reason for hiding this comment

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

https://github.com/Sonichigo/samples-typescript/blob/main/js-mysql/keploy/test-set-0/tests/test-1.yaml

please update based on the actual output of the test results, ts is not present in this application.


We'll be running our sample application right on Linux, but just to make things a tad more thrilling, we'll have the database (MySql) chill on Docker. Ready? Let's get the party started!🎉

#### 🍃 Kickstart MongoDB
Copy link
Member

Choose a reason for hiding this comment

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

Here too:-


Worry not, just add the ever-changing fields (like our **ts** here) to the **noise parameter** to **dodge those assertions**.

<img src="/docs/img/testrun-node-pass.png" alt="Sample Keploy Test Result Node MongoDB" width="100%" style={{ borderRadius: '5px' }}/>
Copy link
Member

Choose a reason for hiding this comment

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

here as well

Copy link
Member

Choose a reason for hiding this comment

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

same with here image is incorrect

Copy link
Member

Choose a reason for hiding this comment

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

Worry not, just add the ever-changing fields (like our ts here) to the noise parameter to dodge those assertions.

Sample Keploy Test Result Node sql

same here as well

> The `--delay` flag? Oh, that's just giving your app a little breather (in seconds) before the test cases come knocking.

Your results should be looking all _snazzy_, like this:
<img src="/docs/img/testrun-node-fail.png" alt="Sample Keploy Test Result Gin MongoDB" width="100%" style={{ borderRadius: '5px' }}/>
Copy link
Member

Choose a reason for hiding this comment

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

image added is incorrect as well


Make API Calls using [Hoppscotch](https://hoppscotch.io), [Postman](https://postman.com) or cURL command. Keploy with capture those calls to generate the test-suites containing testcases and data mocks.

````bash
Copy link
Member

Choose a reason for hiding this comment

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

Styling format is breaking
Uploading image.png…

> The `--delay` flag? Oh, that's just giving your app a little breather (in seconds) before the test cases come knocking.

Your results should be looking all _snazzy_, like this:
<img src="/docs/img/testrun-node-fail.png" alt="Sample Keploy Test Result Gin MongoDB" width="100%" style={{ borderRadius: '5px' }}/>
Copy link
Member

Choose a reason for hiding this comment

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

https://github.com/Sonichigo/samples-typescript/blob/main/js-mysql/keploy/test-set-0/tests/test-1.yaml

please update based on the actual output of the test results, ts is not present in this application.

`--containerName`: The container name in the `docker-compose.yml` for traffic interception.

```sh
keploy record -c "docker compose up" --containerName "nodesqlapp"
Copy link
Member

Choose a reason for hiding this comment

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

https://github.com/Sonichigo/samples-typescript/blob/main/js-mysql/docker-compose.yaml

In the docker-compose.yml file the containerName is not present. there this method won't work unless add manually by user following the guide.

`--containerName`: The container name in the `docker-compose.yml` for traffic interception.

```sh
keploy record -c "docker compose up" --containerName "nodesqlapp"
Copy link
Member

Choose a reason for hiding this comment

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

https://github.com/Sonichigo/samples-typescript/blob/main/js-mysql/docker-compose.yaml

In the docker-compose.yml file the containerName is not present. there this method won't work unless add manually by user following the guide.

@Sarthak160
Copy link
Member

@EraKin575 Please update the PR with the requested review.

@Sarthak160
Copy link
Member

@Sonichigo @EraKin575 Is this ready to merge ??

@Sarthak160 Sarthak160 merged commit b331450 into keploy:main Jan 31, 2024
3 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs]: docs for mysql app
3 participants