From c6dbaafc2cf57dad1cb1279cadc13999cfcdbbe4 Mon Sep 17 00:00:00 2001 From: pratik-mahalle Date: Thu, 21 Aug 2025 18:22:52 +0530 Subject: [PATCH 1/8] fix: update the version 3 for the lint issue Signed-off-by: pratik-mahalle --- .github/CLA.md | 6 +- STYLE.md | 12 +-- docs/hacktoberfest/contribution-guide.md | 2 +- .../config/vocabularies/Base/accept.txt | 77 ++++++++++++++++++- versioned_docs/version-3.0.0/ci-cd/github.md | 2 +- versioned_docs/version-3.0.0/ci-cd/gitlab.md | 6 +- versioned_docs/version-3.0.0/ci-cd/jenkins.md | 4 +- .../version-3.0.0/concepts/installation.md | 4 +- .../reference/glossary/black-box-testing.md | 2 +- .../reference/glossary/component-testing.md | 4 +- .../reference/glossary/defect-management.md | 16 ++-- .../concepts/reference/glossary/grpc.md | 6 +- .../concepts/reference/glossary/junit.md | 4 +- .../glossary/software-testing-life-cycle.md | 2 +- .../glossary/unit-test-automation.md | 2 +- .../reference/glossary/white-box-testing.md | 4 +- .../version-3.0.0/dependencies/mongo.md | 2 +- .../hacktoberfest/contribution-guide.md | 2 +- .../keploy-cloud/deduplication.md | 2 +- .../keploy-cloud/testgeneration.md | 2 +- .../keploy-cloud/time-freezing.md | 2 +- .../keploy-explained/api-testing-faq.md | 10 +-- .../keploy-explained/testing-guide.md | 2 +- .../keploy-explained/utg-best-practices.md | 2 +- .../keploy-explained/why-keploy.md | 2 +- .../operation/browser-extension.md | 4 +- .../version-3.0.0/operation/record.md | 2 +- .../version-3.0.0/quickstart/go-mux-sql.md | 2 +- .../java-spring-boot-openhospital.md | 2 +- .../quickstart/java-spring-postgres.md | 2 +- .../quickstart/nextjs-postgres.md | 2 +- .../quickstart/python-django-sql.md | 2 +- .../quickstart/sample-rust-crud-mongo.md | 2 +- .../version-3.0.0/quickstart/samples-bunjs.md | 2 +- .../version-3.0.0/quickstart/samples-echo.md | 4 +- .../quickstart/samples-go-sse-svelte.md | 2 +- .../version-3.0.0/quickstart/samples-java.md | 2 +- .../quickstart/samples-node-mongo.md | 4 +- .../running-keploy/about-api-testing.md | 4 +- .../api-testing-chrome-extension.md | 22 +++--- .../api-testing-tool-ai-powered.md | 6 +- .../best-practices-api-testing.md | 2 +- .../running-keploy/cli-commands.md | 10 +-- .../generate-api-tests-using-ai.md | 18 ++--- .../running-keploy/keploy-templatize.md | 2 +- .../review-and-improve-ai-generated-tests.md | 21 ++--- .../run-ai-generated-api-tests.md | 4 +- .../running-keploy/share-tests.md | 4 +- .../running-keploy/test-generate.md | 2 +- .../running-keploy/test-run-reports.md | 4 +- .../running-keploy/utg-pr-agent.md | 2 +- .../running-keploy/utg-vsc-extension.md | 2 +- 52 files changed, 195 insertions(+), 119 deletions(-) diff --git a/.github/CLA.md b/.github/CLA.md index 6302b5d34..bfb1d6e9b 100644 --- a/.github/CLA.md +++ b/.github/CLA.md @@ -12,14 +12,14 @@ You accept and agree to the following terms and conditions for Your present and 2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You grant to "Keploy" and to recipients of software distributed by "Keploy" a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works. -3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You grant to "Keploy" and to recipients of software distributed by "Keploy" a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. +3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You grant to "Keploy" and to recipients of software distributed by "Keploy" a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contributions alone or by combination of Your Contributions with the Work to which such Contributions was submitted. -4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to "Keploy", or that your employer has executed a separate Contributor License Agreement with "Keploy". +4. You represent that you are legally entitled to grant the above license. If your employers has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to "Keploy", or that your employer has executed a separate Contributor License Agreement with "Keploy". 5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions. 6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. -7. Should You wish to submit work that is not Your original creation, You may submit it to "Keploy" separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]". +7. Should You wish to submit work that is not Your original creation, You may submit it to "Keploy" separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]." 8. You agree to notify "Keploy" of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect. \ No newline at end of file diff --git a/STYLE.md b/STYLE.md index 3c80efe43..76dd49783 100644 --- a/STYLE.md +++ b/STYLE.md @@ -43,8 +43,8 @@ Use **sentence case** for all titles and headings. This means only the **first w ### 🧾 Infinitive Verb Forms in Headings -Use **infinitive verb forms** (e.g., "to install", "to create", "to configure") in titles and headings. -This improves searchability and aligns with common SEO practices. +Use **infinitive verb forms** (e.g., "to install," "to create," "to configure") in titles and headings. +This improves search ability and aligns with common SEO practices. ✅ Correct: @@ -60,18 +60,18 @@ This improves searchability and aligns with common SEO practices. ### 🧮 En Dashes in Ranges -Use **en dashes (–)** to indicate numeric ranges. Do **not** mix styles or use hyphens inconsistently. -You may also use words like _from_, _to_, or _through_ — but be consistent throughout the doc. +Use **en dashes (—)** to indicate numeric ranges. Do **not** mix styles or use hyphens inconsistently. +You may also use words like _from_, _to_, or _through_—but be consistent throughout the doc. ✅ Correct: -- 5–10 GB +- 5—10 GB - 5 to 10 GB ❌ Incorrect: - from 5-10 GB -- 5–10 GB and 10 to 20 MB (mixed style) +- 5—10 GB and 10 to 20 MB (mixed style) --- diff --git a/docs/hacktoberfest/contribution-guide.md b/docs/hacktoberfest/contribution-guide.md index 78bbf333c..a1f29ef11 100644 --- a/docs/hacktoberfest/contribution-guide.md +++ b/docs/hacktoberfest/contribution-guide.md @@ -18,7 +18,7 @@ If you’ve ever wanted to contribute to open source, now is your chance! You ca Anyone around the globe who desires to help drive the growth of open source and make positive contributions to an ever-growing community. All backgrounds and skill levels are encouraged to participate. -- Code Contributribution to Keploy Projects includes: +- Code Contribution to Keploy Projects includes: - Bug fixes - New features diff --git a/vale_styles/config/vocabularies/Base/accept.txt b/vale_styles/config/vocabularies/Base/accept.txt index a2361fb0a..9133702c4 100644 --- a/vale_styles/config/vocabularies/Base/accept.txt +++ b/vale_styles/config/vocabularies/Base/accept.txt @@ -63,6 +63,81 @@ testmode timeFreezing templatize wiremessages +oss +Ktest +Sanic middleware distros -url \ No newline at end of file +url +KTests +sudo +cli +mongoDB +Prisma +walkthrough +VScode +essentially +openhospital +yaml +Mux +Javascript +Neovim +traceroute +repo +DTOs +sanitization +args +linux +env +homebrew +Zsh +debian +hardcoded +Behat +Reusability +LLM's +RSpec +Chai +anonymized +PHPUnit +shopify +param +performant +js +dedup +invaliduser +Autogenerate +eg +http +dev +Ngrok +Karaf +subequent +renametest +SLAs +hardcoding +signup +nyc +subcommand +xml +mins +globbing +Passthrough +async +substring +llm +shorteners +matchType +anonymization +Jira +interdependencies +teardown +protobuf +protoc +Unary +RPCs +viewport +Gradle +sublicense +doxing +vale_styles \ No newline at end of file diff --git a/versioned_docs/version-3.0.0/ci-cd/github.md b/versioned_docs/version-3.0.0/ci-cd/github.md index 4a19473b9..639710ed3 100644 --- a/versioned_docs/version-3.0.0/ci-cd/github.md +++ b/versioned_docs/version-3.0.0/ci-cd/github.md @@ -21,7 +21,7 @@ Keploy can be integrated with GitHub by two methods:- ## Shell Scripts -GitHub scripts are the easiest way to integrate Keploy with GitHub. We will be using [express-mongoose](https://github.com/keploy/samples-typescript/tree/main/express-mongoose) sample-application for the example. You can either add the following script to yout `github workflow` or create a new worflow `.github/workflows/keploy-test.yml`:- +GitHub scripts are the easiest way to integrate Keploy with GitHub. We will be using [express-mongoose](https://github.com/keploy/samples-typescript/tree/main/express-mongoose) sample-application for the example. You can either add the following script to your `github workflow` or create a new workflow `.github/workflows/keploy-test.yml`:- ```yaml - name: Checkout Commit diff --git a/versioned_docs/version-3.0.0/ci-cd/gitlab.md b/versioned_docs/version-3.0.0/ci-cd/gitlab.md index 0ed2341a8..7366250c8 100644 --- a/versioned_docs/version-3.0.0/ci-cd/gitlab.md +++ b/versioned_docs/version-3.0.0/ci-cd/gitlab.md @@ -68,11 +68,11 @@ In your `.gitlab-ci.yml file`, in last step we have `keploy test` command to run Did you notice some weird stuff in the pipeline? Like `kmod`, `linux-headers`, `/sys/kernel/debug`...and thought, _"Wait, am I hacking the kernel or something?"_ 😅 -Don’t worry — these are just there because **Keploy uses eBPF** (a cool Linux feature) to trace your app’s behavior. +Don’t worry—these are just there because **Keploy uses eBPF** (a cool Linux feature) to trace your app’s behavior. So we install `kmod`, `linux-headers-generic`, and `bpfcc-tools` to make that tracing possible. -Some CI systems don’t have `/sys/kernel/debug` and `/sys/kernel/tracing` by default, so we create them and mount `debugfs` and `tracefs` — it’s like giving Keploy the **backstage pass** it needs to watch your app in action. +Some CI systems don’t have `/sys/kernel/debug` and `/sys/kernel/tracing` by default, so we create them and mount `debugfs` and `tracefs`—it’s like giving Keploy the **backstage pass** it needs to watch your app in action. No black magic. Just some low-level Linux stuff helping your tests run like magic! 🪄✨ @@ -145,6 +145,6 @@ Integrating Keploy with GitLab CI automates the testing process, ensuring that t ### 📦 Need the Full Pipeline? -If you’re thinking, “This pipeline looks cool, but I need the _whole thing_ to integrate with your application!” — well, you're in luck! Check it out [here](https://github.com/keploy/samples-python) and get ready to copy-paste your way to success! ✨🚀 +If you’re thinking, “This pipeline looks cool, but I need the _whole thing_ to integrate with your application!”—well, you're in luck! Check it out [here](https://github.com/keploy/samples-python) and get ready to copy-paste your way to success! ✨🚀 Hope this helps you out, if you still have any questions, reach out to us . diff --git a/versioned_docs/version-3.0.0/ci-cd/jenkins.md b/versioned_docs/version-3.0.0/ci-cd/jenkins.md index 6bfad8f9e..064da223c 100644 --- a/versioned_docs/version-3.0.0/ci-cd/jenkins.md +++ b/versioned_docs/version-3.0.0/ci-cd/jenkins.md @@ -108,11 +108,11 @@ pipeline { Did you notice some weird stuff in the pipeline? Like `kmod`, `linux-headers`, `/sys/kernel/debug`...and thought, _"Wait, am I hacking the kernel or something?"_ 😅 -Don’t worry — these are just there because **Keploy uses eBPF** (a cool Linux feature) to trace your app’s behavior. +Don’t worry—these are just there because **Keploy uses eBPF** (a cool Linux feature) to trace your app’s behavior. So we install `kmod`, `linux-headers-generic`, and `bpfcc-tools` to make that tracing possible. -Some CI systems don’t have `/sys/kernel/debug` and `/sys/kernel/tracing` by default, so we create them and mount `debugfs` and `tracefs` — it’s like giving Keploy the **backstage pass** it needs to watch your app in action. +Some CI systems don’t have `/sys/kernel/debug` and `/sys/kernel/tracing` by default, so we create them and mount `debugfs` and `tracefs`—it’s like giving Keploy the **backstage pass** it needs to watch your app in action. No black magic. Just some low-level Linux stuff helping your tests run like magic! 🪄✨ diff --git a/versioned_docs/version-3.0.0/concepts/installation.md b/versioned_docs/version-3.0.0/concepts/installation.md index cdd72f03d..66397d955 100644 --- a/versioned_docs/version-3.0.0/concepts/installation.md +++ b/versioned_docs/version-3.0.0/concepts/installation.md @@ -64,7 +64,7 @@ Flags: Use "keploy [command] --help" for more information about a command. ``` -🎉 Wohoo! You are all set to use Keploy. +🎉 Woohoo! You are all set to use Keploy. ## Other Installation Methods @@ -98,7 +98,7 @@ alias keploy="docker run --name keploy-v2 -p 16789:16789 --network keploy-networ ### Downloading and running Keploy in Native -**Prequisites:** +**Prerequisites:** - Linux Kernel version 5.15 or higher - Run `uname -a` to verify the system architecture. diff --git a/versioned_docs/version-3.0.0/concepts/reference/glossary/black-box-testing.md b/versioned_docs/version-3.0.0/concepts/reference/glossary/black-box-testing.md index 05e8fe2d7..6fad385fd 100644 --- a/versioned_docs/version-3.0.0/concepts/reference/glossary/black-box-testing.md +++ b/versioned_docs/version-3.0.0/concepts/reference/glossary/black-box-testing.md @@ -51,7 +51,7 @@ This testing approach is essential for several reasons: 5. **Detection of Defects**: Identifies functional errors, security vulnerabilities, and performance bottlenecks. 6. **Accessibility**: Suitable for testers with diverse backgrounds and skill sets, adaptable to various software applications. -## Whate are types of Black-Box Testing Techniques ? +## What are types of Black-Box Testing Techniques ? ![How Black Box testing Works?](https://keploy-devrel.s3.us-west-2.amazonaws.com/thumbnail_Black-box.jpg) diff --git a/versioned_docs/version-3.0.0/concepts/reference/glossary/component-testing.md b/versioned_docs/version-3.0.0/concepts/reference/glossary/component-testing.md index abd44e5c9..8d58e730a 100644 --- a/versioned_docs/version-3.0.0/concepts/reference/glossary/component-testing.md +++ b/versioned_docs/version-3.0.0/concepts/reference/glossary/component-testing.md @@ -56,7 +56,7 @@ Testing your code in small parts does not have to be complex. Here are the steps ## Types of Software Component Testing -![Typinge of Component test](/img/glossary/types-of-component-testing.webp) +![Types of Component testing](/img/glossary/types-of-component-testing.webp) Component testing validates separate parts of a given system before integration. This testing generally consists of unit testing, module testing, and program testing. @@ -80,7 +80,7 @@ Not entirely, but they are very similar and often confused. | ------------- | ----------------------------------------- | ---------------------------------------------- | | What it tests | Smallest parts (functions, methods) | Groups of parts working together (modules) | | Goal | Check if each small piece works correctly | Check if the combined parts work well together | -| Dependencies | No dependencies — tests are isolated | May use stubs or drivers for missing pieces | +| Dependencies | No dependencies—tests are isolated | May use stubs or drivers for missing pieces | | Speed | Very fast | A bit slower, tests bigger parts | | Example | A sum() function | A payment module | diff --git a/versioned_docs/version-3.0.0/concepts/reference/glossary/defect-management.md b/versioned_docs/version-3.0.0/concepts/reference/glossary/defect-management.md index 11d969f0d..14fd185c8 100644 --- a/versioned_docs/version-3.0.0/concepts/reference/glossary/defect-management.md +++ b/versioned_docs/version-3.0.0/concepts/reference/glossary/defect-management.md @@ -45,12 +45,12 @@ The **Defect Management Process (DMP)** is a systematic process of detecting, do ### A proper Defect Management Process involves: -- **Detection** – Detecting defects during testing. -- **Logging** – Recording defects with detailed information. -- **Prioritization** – Prioritizing defects based on severity and impact. -- **Assignment** – Assigning the defect to developers. -- **Resolution** – Fix implementation. -- **Verification** – Testing the fix. +- **Detection**—Detecting defects during testing. +- **Logging**—Recording defects with detailed information. +- **Prioritization**—Prioritizing defects based on severity and impact. +- **Assignment**—Assigning the defect to developers. +- **Resolution**—Fix implementation. +- **Verification**—Testing the fix. ## Why is Defect Management Process Important? @@ -224,7 +224,7 @@ Attach a screenshot of the unresponsive login button and a video showing the ste - Include extra details that might help developers understand the defect better. **Example:** -\_The issue seems to occur only when the device is in low battery mode. +The issue seems to occur only when the device is in low battery mode. ### Step 8: Review and Revise @@ -242,7 +242,7 @@ Good defect management leads to good test management. Platforms like **Keploy** ## Conclusion -In this blog, we covered the fundamentals of **Defect Management in software testing** — from defect identification, reporting, tracking, verification, to closure. +In this blog, we covered the fundamentals of **Defect Management in software testing**—from defect identification, reporting, tracking, verification, to closure. By following a disciplined defect management process: diff --git a/versioned_docs/version-3.0.0/concepts/reference/glossary/grpc.md b/versioned_docs/version-3.0.0/concepts/reference/glossary/grpc.md index 8f246258f..a4dfb410f 100644 --- a/versioned_docs/version-3.0.0/concepts/reference/glossary/grpc.md +++ b/versioned_docs/version-3.0.0/concepts/reference/glossary/grpc.md @@ -26,7 +26,7 @@ The framework's design philosophy centers around efficiency, type safety, and cr ## Core Architecture and Components -gRPC's architecture consists of several key components that work together to provide a robust communication framework. The Protocol Buffer compiler (protoc) generates code from service definitions, creating strongly-typed interfaces that eliminate runtime errors common in loosely-typed systems. +gRPC`s architecture consists of several key components that work together to provide a robust communication framework. The Protocol Buffer compiler (protoc) generates code from service definitions, creating strongly typed interfaces that eliminate runtime errors common in loosely typed systems. ![gRPC Architecture](/img/glossary/gRPC-architecture.webp) @@ -40,7 +40,7 @@ The performance benefits of gRPC become apparent in high-throughput scenarios. P HTTP/2's multiplexing capabilities eliminate the head-of-line blocking issues that plague HTTP/1.1 connections. Multiple requests can be processed simultaneously over a single connection, reducing the overhead associated with establishing multiple TCP connections. This improvement is especially noticeable in microservices architectures where services frequently communicate with each other. -The strongly-typed nature of Protocol Buffers enables compile-time validation, catching errors early in the development process. This type safety extends to the wire format, ensuring that data corruption during transmission is detected and handled appropriately. +The strongly typed nature of Protocol Buffers enables compile-time validation, catching errors early in the development process. This type safety extends to the wire format, ensuring that data corruption during transmission is detected and handled appropriately. ## Communication Patterns @@ -146,7 +146,7 @@ gRPC uses Protocol Buffers' backward compatibility features. You can add new fie ### Is gRPC suitable for mobile applications? -Absolutely. gRPC's efficient binary protocol and HTTP/2 multiplexing make it ideal for mobile environments where bandwidth and battery life are concerns. The smaller message sizes and reduced connection overhead provide significant benefits. +Absolutely. gRPC`s efficient binary protocol and HTTP/2 multiplexing make it ideal for mobile environments where bandwidth and battery life are concerns. The smaller message sizes and reduced connection overhead provide significant benefits. ### What programming languages support gRPC? diff --git a/versioned_docs/version-3.0.0/concepts/reference/glossary/junit.md b/versioned_docs/version-3.0.0/concepts/reference/glossary/junit.md index 4b0a2cf5a..9b0ba92db 100644 --- a/versioned_docs/version-3.0.0/concepts/reference/glossary/junit.md +++ b/versioned_docs/version-3.0.0/concepts/reference/glossary/junit.md @@ -12,11 +12,11 @@ keywords: - Java --- -Testing remains one of the most critical aspects of software development, yet many developers struggle to implement effective testing strategies. JUnit has emerged as the de facto standard for Java testing, providing a robust framework that enables developers to write reliable, maintainable tests that drive quality throughout the development lifecycle. +Testing remains one of the most critical aspects of software development, yet many developers struggle to implement effective testing strategies. JUnit has emerged as the de-facto standard for Java testing, providing a robust framework that enables developers to write reliable, maintainable tests that drive quality throughout the development lifecycle. ## The Evolution of JUnit -JUnit's journey began in the late 1990s when Kent Beck and Erich Gamma recognized the need for a simple, effective testing framework for Java applications. What started as a lightweight solution has evolved into a comprehensive testing ecosystem that powers millions of applications worldwide. +JUnit's journey began in the late 1990's when Kent Beck and Erich Gamma recognized the need for a simple, effective testing framework for Java applications. What started as a lightweight solution has evolved into a comprehensive testing ecosystem that powers millions of applications worldwide. The framework's design philosophy centers on simplicity and effectiveness. Rather than overwhelming developers with complex configurations, JUnit provides intuitive annotations and assertions that make test writing straightforward and maintainable. This approach has contributed significantly to its widespread adoption across enterprises of all sizes. diff --git a/versioned_docs/version-3.0.0/concepts/reference/glossary/software-testing-life-cycle.md b/versioned_docs/version-3.0.0/concepts/reference/glossary/software-testing-life-cycle.md index 634165238..ee36f2289 100644 --- a/versioned_docs/version-3.0.0/concepts/reference/glossary/software-testing-life-cycle.md +++ b/versioned_docs/version-3.0.0/concepts/reference/glossary/software-testing-life-cycle.md @@ -67,7 +67,7 @@ Software Testing Life Cycle (STLC) comprises several phases that guide the testi - **Risk-Based Testing**: Prioritize tests based on potential impact and likelihood of failure. - **Performance Testing**: Evaluate software performance under various conditions and loads. -## How Keploy helps in accelrating the Software Testing Life Cycle process? +## How Keploy helps in accelerating the Software Testing Life Cycle process? Keploy enhances the STLC with its advanced features tailored for modern software testing needs: diff --git a/versioned_docs/version-3.0.0/concepts/reference/glossary/unit-test-automation.md b/versioned_docs/version-3.0.0/concepts/reference/glossary/unit-test-automation.md index e90cff4cf..eec1b235d 100644 --- a/versioned_docs/version-3.0.0/concepts/reference/glossary/unit-test-automation.md +++ b/versioned_docs/version-3.0.0/concepts/reference/glossary/unit-test-automation.md @@ -139,7 +139,7 @@ JUnit 5 is the next generation of the JUnit framework, introducing new features ### TestNG (Java): TestNG is another testing framework for Java, designed to cover a broader range of testing categories, including unit, functional, and integration testing. It supports parallel execution, data-driven testing, and easy configuration through annotations. -![testng](../../../../../static/img/glossary/testng.png) +![testing](../../../../../static/img/glossary/testng.png) ## Conclusion diff --git a/versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md b/versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md index f40891fa7..16c3e5a68 100644 --- a/versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md +++ b/versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md @@ -99,7 +99,7 @@ As code evolves, test cases must be updated, requiring ongoing coordination with | Skill Level | Requires specialized technical skills | Can be performed by testers with various skill levels | | Types of Defects Found | Internal logic errors, security vulnerabilities | Functional, usability, and performance issues | -## How to perform Whitebox testing with Keploy ? +## How to perform White Box testing with Keploy ? Firstly, install [Keploy](https://keploy.io/), a testing tool that helps you automate the testing process. Here’s how you can perform white box testing with Keploy: @@ -113,7 +113,7 @@ Firstly, install [Keploy](https://keploy.io/), a testing tool that helps you aut - **Error Analysis and Debugging:** Utilize Keploy’s built-in error analysis tools to identify and resolve issues within your code. Keploy provides detailed insights into errors, helping you quickly pinpoint and fix problems in the internal logic of your application. -- C**ontinuous Integration and Testing:** Integrate Keploy with your CI pipeline to automate white box testing. This ensures that internal testing is part of your regular development workflow, helping maintain high code quality and quickly catch regressions or new issues. +- **Continuous Integration and Testing:** Integrate Keploy with your CI pipeline to automate white box testing. This ensures that internal testing is part of your regular development workflow, helping maintain high code quality and quickly catch regressions or new issues. ## Conclusion diff --git a/versioned_docs/version-3.0.0/dependencies/mongo.md b/versioned_docs/version-3.0.0/dependencies/mongo.md index 267da17be..5683055d2 100644 --- a/versioned_docs/version-3.0.0/dependencies/mongo.md +++ b/versioned_docs/version-3.0.0/dependencies/mongo.md @@ -22,7 +22,7 @@ When the application sends requests to MongoDB, those requests/responses are in Once intercepted, the proxy's functionality includes parsing these wiremessages, which involves extracting the relevant data and metadata from the packets. After parsing, the extracted information is transformed into a human-readable and editable format. This format could be more user-friendly and easy to understand, making it convenient for developers and administrators to analyze and manipulate the data if necessary. Hence, this proxy serves as an intermediary that captures and mocks the traffic calls. -The system is built to support wiremessage `MongoDB version => 5.1.X`, which refers to the specific version of the communication protocol used between the application and the MongoDB server. This version indicates the specific structure and rules governing the wiremessages exchanged between the two components. +The system is built to support wiremessages `MongoDB version => 5.1.X`, which refers to the specific version of the communication protocol used between the application and the MongoDB server. This version indicates the specific structure and rules governing the wiremessages exchanged between the two components. ## Example of message queries diff --git a/versioned_docs/version-3.0.0/hacktoberfest/contribution-guide.md b/versioned_docs/version-3.0.0/hacktoberfest/contribution-guide.md index 8efbe4b43..34fe7d168 100644 --- a/versioned_docs/version-3.0.0/hacktoberfest/contribution-guide.md +++ b/versioned_docs/version-3.0.0/hacktoberfest/contribution-guide.md @@ -20,7 +20,7 @@ If you’ve ever wanted to contribute to open source, now is your chance! You ca Anyone around the globe who desires to help drive the growth of open source and make positive contributions to an ever-growing community. All backgrounds and skill levels are encouraged to participate. -#### Code Contributribution to Keploy Projects includes: +#### Code Contribution to Keploy Projects includes: - 🛠️ Bug fixes - 👉 New features diff --git a/versioned_docs/version-3.0.0/keploy-cloud/deduplication.md b/versioned_docs/version-3.0.0/keploy-cloud/deduplication.md index 0b1d00e2d..88422b5d6 100644 --- a/versioned_docs/version-3.0.0/keploy-cloud/deduplication.md +++ b/versioned_docs/version-3.0.0/keploy-cloud/deduplication.md @@ -42,7 +42,7 @@ Install the `keploy/sdk` and `nyc` package : - npm i @keploy/sdk nyc@15.0.0 ``` -Add the the following on top of your main application js file (index.js/server.js/app.js/main.js) : - +Add the following on top of your main application js file (index.js/server.js/app.js/main.js) : - ```bash const kmiddleware = require('@keploy/sdk/dist/v2/dedup/middleware.js') diff --git a/versioned_docs/version-3.0.0/keploy-cloud/testgeneration.md b/versioned_docs/version-3.0.0/keploy-cloud/testgeneration.md index 892d42c48..56be74993 100644 --- a/versioned_docs/version-3.0.0/keploy-cloud/testgeneration.md +++ b/versioned_docs/version-3.0.0/keploy-cloud/testgeneration.md @@ -416,7 +416,7 @@ docker-compose up -d postgres ## Generate test-cases -Now that we have our schema file, we need to create create jar file since we are using java sample-application :- +Now that we have our schema file, we need to create jar file since we are using java sample-application :- ```sh mvn clean install -DskipTests diff --git a/versioned_docs/version-3.0.0/keploy-cloud/time-freezing.md b/versioned_docs/version-3.0.0/keploy-cloud/time-freezing.md index 5297af402..ab6d9fa1f 100644 --- a/versioned_docs/version-3.0.0/keploy-cloud/time-freezing.md +++ b/versioned_docs/version-3.0.0/keploy-cloud/time-freezing.md @@ -46,7 +46,7 @@ For Docker-based applications, you'll need to make a few adjustments to your Doc uname -a ``` -2. Download the the appropriate time freeze agent for your architecture & set the `LD_PRELOAD` Environment Variable in your Dockerfile +2. Download the appropriate time freeze agent for your architecture & set the `LD_PRELOAD` Environment Variable in your Dockerfile ### For Golang(Go) Applications - diff --git a/versioned_docs/version-3.0.0/keploy-explained/api-testing-faq.md b/versioned_docs/version-3.0.0/keploy-explained/api-testing-faq.md index fa82c39ea..d318d296f 100644 --- a/versioned_docs/version-3.0.0/keploy-explained/api-testing-faq.md +++ b/versioned_docs/version-3.0.0/keploy-explained/api-testing-faq.md @@ -16,11 +16,11 @@ Let's get to the heart of Keploy API Testing with some fun Q&A! Keploy automatically creates: -- **Functional Tests** – CRUD operations, endpoint validation -- **Edge Case Tests** – Invalid payloads, error responses -- **Performance Tests** – Response time checks -- **Security Tests** – Input sanitization, auth validation -- **Dependency Tests** – Mocked external service calls +- **Functional Tests**—CRUD operations, endpoint validation +- **Edge Case Tests**—Invalid payloads, error responses +- **Performance Tests**—Response time checks +- **Security Tests**—Input sanitization, auth validation +- **Dependency Tests**—Mocked external service calls ### 2. How does Keploy handle authentication in API tests? diff --git a/versioned_docs/version-3.0.0/keploy-explained/testing-guide.md b/versioned_docs/version-3.0.0/keploy-explained/testing-guide.md index 5452cd1a2..b56a27f46 100644 --- a/versioned_docs/version-3.0.0/keploy-explained/testing-guide.md +++ b/versioned_docs/version-3.0.0/keploy-explained/testing-guide.md @@ -69,7 +69,7 @@ These two scenarios are designed to ensure the detection of changes, including a ### Recording and testing of tests and mocks via test-bench -Right now, in this guide i am only showing the first scenario, to run the second scenario you just need to replace the binaries as mentioned in the **4th** step. +Right now, in this guide i am only showing the first scenario, to run the second scenario you just need to replace the binaries as mentioned in the **Fourth** step. #### Recording Phase 🎥 diff --git a/versioned_docs/version-3.0.0/keploy-explained/utg-best-practices.md b/versioned_docs/version-3.0.0/keploy-explained/utg-best-practices.md index cf08dd5c7..3724534f6 100644 --- a/versioned_docs/version-3.0.0/keploy-explained/utg-best-practices.md +++ b/versioned_docs/version-3.0.0/keploy-explained/utg-best-practices.md @@ -13,7 +13,7 @@ tags: > **Master the art of automated testing with proven strategies, expert insights, and advanced techniques for maximizing your testing ROI.** -This comprehensive guide outlines battle-tested best practices for writing exceptional unit tests, leveraging automation effectively, and extracting maximum value from Keploy's Unit Test Generation ecosystem — including the PR Agent and VS Code extension. +This comprehensive guide outlines battle-tested best practices for writing exceptional unit tests, leveraging automation effectively, and extracting maximum value from Keploy's Unit Test Generation ecosystem—including the PR Agent and VS Code extension. ## **Foundational Unit Testing Principles** diff --git a/versioned_docs/version-3.0.0/keploy-explained/why-keploy.md b/versioned_docs/version-3.0.0/keploy-explained/why-keploy.md index 9c89c229c..cfa1fa4f4 100644 --- a/versioned_docs/version-3.0.0/keploy-explained/why-keploy.md +++ b/versioned_docs/version-3.0.0/keploy-explained/why-keploy.md @@ -28,4 +28,4 @@ tags: ⭐ If you're excited about what's coming, show some love by [starring Keploy on GitHub](https://github.com/keploy/keploy) -🤙 We're happy to hear from you in-case you want to deep-dive. [Schedule a demo](https://calendar.app.google/3mHeyaoKg3A2qkqF6) – because the best tests are yet to come! 🚀🎉 +🤙 We're happy to hear from you in-case you want to deep-dive. [Schedule a demo](https://calendar.app.google/3mHeyaoKg3A2qkqF6)—because the best tests are yet to come! 🚀🎉 diff --git a/versioned_docs/version-3.0.0/operation/browser-extension.md b/versioned_docs/version-3.0.0/operation/browser-extension.md index dacc6d56d..969c0682a 100644 --- a/versioned_docs/version-3.0.0/operation/browser-extension.md +++ b/versioned_docs/version-3.0.0/operation/browser-extension.md @@ -56,7 +56,7 @@ once keploy server is up. ![Project name](https://miro.medium.com/max/750/1*lEwF0okhMyKzaS2a8dPA7Q.png) -**Step-2**: Give a title to your 1st test case +**Step-2**: Give a title to your First test case ![Test case](https://miro.medium.com/max/828/1*u1VNf-nXXvekruNphAIfIQ.png) ![Rename test case](https://miro.medium.com/max/378/1*CL3156yKX4UhklO3l_vH4Q.png) @@ -88,7 +88,7 @@ mongo DB. Let’s see inside mongo DB using mongo compass. ![Compass Screenshot](https://miro.medium.com/max/828/1*WYChY6_nwLcmUJw5I-j7Dg.jpeg) **Step-9**: Now we will replay the recorded data in selenium, but this time data will not come from live servers of -google, instead of that data will come from the moc database made by keploy +google, instead of that data will come from the mock database made by keploy ![Re-Run with Keploy](https://miro.medium.com/max/828/1*9wXASZ3JLur3r_Gk2Q-gug.jpeg) ![Test Run](https://miro.medium.com/max/828/1*4ur53dlBZ94Y2gbJCZLYJA.jpeg) diff --git a/versioned_docs/version-3.0.0/operation/record.md b/versioned_docs/version-3.0.0/operation/record.md index efb309a40..720ad6108 100644 --- a/versioned_docs/version-3.0.0/operation/record.md +++ b/versioned_docs/version-3.0.0/operation/record.md @@ -19,7 +19,7 @@ export KEPLOY_MODE="record" That's it! 🔥 As you make API calls to your application, new test-cases are being generated locally in `keploy-tests` directory. -> > KTest directory path (`KEPLOY_TEST_PATH`) is configurable. +> > KTests directory path (`KEPLOY_TEST_PATH`) is configurable. ![Record Tests and Mocks](/gif/record-tc.gif "Record Tests and Mocks") diff --git a/versioned_docs/version-3.0.0/quickstart/go-mux-sql.md b/versioned_docs/version-3.0.0/quickstart/go-mux-sql.md index 257a0699e..a9b76e2e0 100644 --- a/versioned_docs/version-3.0.0/quickstart/go-mux-sql.md +++ b/versioned_docs/version-3.0.0/quickstart/go-mux-sql.md @@ -22,7 +22,7 @@ keyword: ## Introduction -🪄 Dive into the world of Product catelog and see how seamlessly Keploy integrates with [Mux](https://github.com/gorilla/mux) and [Postgres](https://www.postgresql.org/). Buckle up, it's gonna be a fun ride! 🎢 +🪄 Dive into the world of Product catalog and see how seamlessly Keploy integrates with [Mux](https://github.com/gorilla/mux) and [Postgres](https://www.postgresql.org/). Buckle up, it's gonna be a fun ride! 🎢 import InstallationGuide from '../concepts/installation.md' diff --git a/versioned_docs/version-3.0.0/quickstart/java-spring-boot-openhospital.md b/versioned_docs/version-3.0.0/quickstart/java-spring-boot-openhospital.md index 4712440de..9b72bd22b 100644 --- a/versioned_docs/version-3.0.0/quickstart/java-spring-boot-openhospital.md +++ b/versioned_docs/version-3.0.0/quickstart/java-spring-boot-openhospital.md @@ -110,7 +110,7 @@ Your CLI should look something like this This is a summary of the test cases recorded Sample Keploy Test Summary Java -Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10s to get started, you can change the `delay` accordingly. +Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10's to get started, you can change the `delay` accordingly. `buildDelay` is the time that it takes for the image to get built. This is useful when you are building the docker image from your docker compose file itself. Hope this helps you out, if you still have any questions, reach out to us . diff --git a/versioned_docs/version-3.0.0/quickstart/java-spring-postgres.md b/versioned_docs/version-3.0.0/quickstart/java-spring-postgres.md index 956f5037c..c609ffeba 100644 --- a/versioned_docs/version-3.0.0/quickstart/java-spring-postgres.md +++ b/versioned_docs/version-3.0.0/quickstart/java-spring-postgres.md @@ -145,7 +145,7 @@ Your CLI should look something like this This is a summary of the test cases recorded Sample Keploy Test Summary Java -Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10s to get started, you can change the `delay` accordingly. +Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10's to get started, you can change the `delay` accordingly. `buildDelay` is the time that it takes for the image to get built. This is useful when you are building the docker image from your docker compose file itself. Hope this helps you out, if you still have any questions, reach out to us . diff --git a/versioned_docs/version-3.0.0/quickstart/nextjs-postgres.md b/versioned_docs/version-3.0.0/quickstart/nextjs-postgres.md index 27981beaf..4220718fb 100644 --- a/versioned_docs/version-3.0.0/quickstart/nextjs-postgres.md +++ b/versioned_docs/version-3.0.0/quickstart/nextjs-postgres.md @@ -23,7 +23,7 @@ import InstallationGuide from '../concepts/installation.md' ## Get Started! 🎬 -Now that we have bun installed, we will se tup our application. +Now that we have bun installed, we will setup our application. ```bash git clone https://github.com/keploy/samples-typescript && cd samples-typscript/nextjs-postgres diff --git a/versioned_docs/version-3.0.0/quickstart/python-django-sql.md b/versioned_docs/version-3.0.0/quickstart/python-django-sql.md index 44afb3d72..9f0aeda27 100644 --- a/versioned_docs/version-3.0.0/quickstart/python-django-sql.md +++ b/versioned_docs/version-3.0.0/quickstart/python-django-sql.md @@ -22,7 +22,7 @@ keyword: # Introduction -🪄 Dive into the world of User CRUD Apps and see how seamlessly Keploy integrated with Djangoand [PostgreSQL](https://www.postgresql.org/). Buckle up, it's gonna be a fun ride! 🎢 +🪄 Dive into the world of User CRUD Apps and see how seamlessly Keploy integrated with Django and [PostgreSQL](https://www.postgresql.org/). Buckle up, it's gonna be a fun ride! 🎢 import InstallationGuide from '../concepts/installation.md' diff --git a/versioned_docs/version-3.0.0/quickstart/sample-rust-crud-mongo.md b/versioned_docs/version-3.0.0/quickstart/sample-rust-crud-mongo.md index bd4dc6fff..67b8b05bb 100644 --- a/versioned_docs/version-3.0.0/quickstart/sample-rust-crud-mongo.md +++ b/versioned_docs/version-3.0.0/quickstart/sample-rust-crud-mongo.md @@ -95,7 +95,7 @@ Afterward, create a GET all request, and you will get the following output in yo ![Test-case](/img/rust-mongo-rest-postman-get-all-success.png?raw=true) -We peformed two requests, one to create a note and one to get all notes. These requests are captured as testcases by Keploy. +We performed two requests, one to create a note and one to get all notes. These requests are captured as testcases by Keploy. ### Run the testcases diff --git a/versioned_docs/version-3.0.0/quickstart/samples-bunjs.md b/versioned_docs/version-3.0.0/quickstart/samples-bunjs.md index cfe696180..78de8a1a4 100644 --- a/versioned_docs/version-3.0.0/quickstart/samples-bunjs.md +++ b/versioned_docs/version-3.0.0/quickstart/samples-bunjs.md @@ -61,7 +61,7 @@ Install the dependencies. Note: using this command directly without installing b bun install ``` -This command will essentailly make a fresh docker-network named as `keploy-network ` +This command will essentially make a fresh docker-network named as `keploy-network ` ```bash docker network create keploy-network diff --git a/versioned_docs/version-3.0.0/quickstart/samples-echo.md b/versioned_docs/version-3.0.0/quickstart/samples-echo.md index ec8811ace..d90a6d309 100644 --- a/versioned_docs/version-3.0.0/quickstart/samples-echo.md +++ b/versioned_docs/version-3.0.0/quickstart/samples-echo.md @@ -127,7 +127,7 @@ Want to see if everything works as expected? Now that we have our testcase captured, we will add `ts` to noise field in `test-*.yaml` files. -**1. On line 32 we will add "`- body.ts`" under the "`header.data`".** +**1. On line 32 we will add "`- body.ts`" under the "`header.data`."** Now let's run the test mode (in the echo-sql directory, not the Keploy directory). @@ -174,7 +174,7 @@ sudo -E PATH=$PATH keploy record -c "./echo-psql-url-shortener" #### Generate testcases -To genereate testcases we just need to make some API calls. You can use Postman, Hoppscotch, or simply curl +To generate testcases we just need to make some API calls. You can use Postman, Hoppscotch, or simply curl ```bash curl --request POST \ diff --git a/versioned_docs/version-3.0.0/quickstart/samples-go-sse-svelte.md b/versioned_docs/version-3.0.0/quickstart/samples-go-sse-svelte.md index 417838616..104963980 100644 --- a/versioned_docs/version-3.0.0/quickstart/samples-go-sse-svelte.md +++ b/versioned_docs/version-3.0.0/quickstart/samples-go-sse-svelte.md @@ -59,7 +59,7 @@ Now, we will create the binary of our application:- go build -cover ``` -Once we have our applicaiton binary ready, we will start the application with keploy to start capturing the testcases. +Once we have our application binary ready, we will start the application with keploy to start capturing the testcases. ## Capture the test cases diff --git a/versioned_docs/version-3.0.0/quickstart/samples-java.md b/versioned_docs/version-3.0.0/quickstart/samples-java.md index 7d41d39e6..f10fe6e4c 100644 --- a/versioned_docs/version-3.0.0/quickstart/samples-java.md +++ b/versioned_docs/version-3.0.0/quickstart/samples-java.md @@ -286,7 +286,7 @@ Your CLI should look something like this This is a summary of the test cases recorded Sample Keploy Test Summary Java -Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10s to get started, you can change the `delay` accordingly. +Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10's to get started, you can change the `delay` accordingly. `buildDelay` is the time that it takes for the image to get built. This is useful when you are building the docker image from your docker compose file itself. ### 🎉 Wrapping it up diff --git a/versioned_docs/version-3.0.0/quickstart/samples-node-mongo.md b/versioned_docs/version-3.0.0/quickstart/samples-node-mongo.md index a781ff78a..4ae2a14d5 100644 --- a/versioned_docs/version-3.0.0/quickstart/samples-node-mongo.md +++ b/versioned_docs/version-3.0.0/quickstart/samples-node-mongo.md @@ -21,7 +21,7 @@ keyword: - Auto Testcase generation --- -## Intoduction 📌 +## Introduction 📌 A sample **_CRUD_** application to see how Keploy integrates effortlessly with **_Express.js_** and **_MongoDB_**. Get ready to see the power of Keploy 🔅🔅. @@ -40,7 +40,7 @@ import InstallationGuide from '../concepts/installation.md' -🎉 Wohoo! We are all set to use Keploy. +🎉 Woohoo! We are all set to use Keploy. ## 🎬 Capturing Testcases diff --git a/versioned_docs/version-3.0.0/running-keploy/about-api-testing.md b/versioned_docs/version-3.0.0/running-keploy/about-api-testing.md index 02f9f7171..227c49930 100644 --- a/versioned_docs/version-3.0.0/running-keploy/about-api-testing.md +++ b/versioned_docs/version-3.0.0/running-keploy/about-api-testing.md @@ -22,7 +22,7 @@ keywords: **API Testing** is a type of software testing that focuses on verifying that **Application Programming Interfaces (APIs)** function as expected. Instead of testing the UI, API tests validate business logic, data responses, and the performance of an application’s backend services. -APIs act as the _bridge_ between different software systems — enabling communication and data exchange. Testing ensures these bridges are **reliable, secure, and performant**. +APIs act as the _bridge_ between different software systems—enabling communication and data exchange. Testing ensures these bridges are **reliable, secure, and performant**. ## ✅ Why Do We Need API Testing? @@ -31,7 +31,7 @@ APIs act as the _bridge_ between different software systems — enabling communi | **1. Early Bug Detection** | API testing is usually done before UI testing, allowing faster detection and resolution of critical bugs. | | **2. Improved Test Coverage** | Validates all layers of the application including edge cases, error codes, and data responses. | | **3. Faster Execution** | API tests are faster than UI tests, enabling quicker feedback loops in CI/CD pipelines. | -| **4. Language-Agnostic** | APIs can be tested independently of the frontend technology — enabling broader automation. | +| **4. Language-Agnostic** | APIs can be tested independently of the frontend technology—enabling broader automation. | | **5. Enhanced Security** | Validates authentication, authorization, and data privacy mechanisms. | | **6. Enables Continuous Testing** | Ideal for automated pipelines to ensure every build meets quality standards. | diff --git a/versioned_docs/version-3.0.0/running-keploy/api-testing-chrome-extension.md b/versioned_docs/version-3.0.0/running-keploy/api-testing-chrome-extension.md index ced1b627c..26098ade9 100644 --- a/versioned_docs/version-3.0.0/running-keploy/api-testing-chrome-extension.md +++ b/versioned_docs/version-3.0.0/running-keploy/api-testing-chrome-extension.md @@ -9,13 +9,13 @@ Install the extension, hit **Record API Calls**, exercise your web app, then pre ## What the API Test Recorder does -**Browser-side traffic capture** — Sniffs XHR / fetch calls as you click around. +**Browser-side traffic capture**—Sniffs XHR / fetch calls as you click around. -**Instant replay formats** — Export the captured calls as cURL, JSON, or native Keploy YAML. +**Instant replay formats**—Export the captured calls as cURL, JSON, or native Keploy YAML. -**URL filtering & debugging** — Limit capture to specific endpoints and auto-repair partial request/response pairs. +**URL filtering & debugging**—Limit capture to specific endpoints and auto-repair partial request/response pairs. -**One-click test generation** — Push traffic to Keploy Console and instantly get ready-to-run API tests with assertions. +**One-click test generation**—Push traffic to Keploy Console and instantly get ready-to-run API tests with assertions. ## Installation @@ -33,8 +33,8 @@ Install the extension, hit **Record API Calls**, exercise your web app, then pre 2. Click **Record API Calls**. 3. In another tab, **exercise your app** as a normal user (create an account, add to cart, etc.). 4. Watch the live counters: - - **Captured calls** – total XHR/fetch requests intercepted. - - **Complete req/resp** – pairs where both request _and_ response were fully captured. + - **Captured calls**—total XHR/fetch requests intercepted. + - **Complete req/resp**—pairs where both request _and_ response were fully captured. 5. If the count of req/res is lower than expected, hit **Debug** to repair missing pairs. Example : @@ -55,9 +55,9 @@ Records repaired: 15 - Your browser opens a new tab showing test-case generation progress. - When done, you’ll see a **Test Suite** with runnable cases 7. From **Export Format**, choose: - - **cURL Commands** – one-liner per call, shareable in Slack/Gist. - - **Keploy YAML** – ready for `keploy run`. - - **JSON** – raw payloads for custom tooling. + - **cURL Commands**—one-liner per call, shareable in Slack/Gist. + - **Keploy YAML**—ready for `keploy run`. + - **JSON**—raw payloads for custom tooling. 8. Click **Export Data** to download **or** **Copy** to clipboard. ## UI reference @@ -77,8 +77,8 @@ Records repaired: 15 ## Best practices -- **Enter URL** – Set the URL Filter to the base domain you want Keploy to record. This keeps captures focused on the traffic that matters. -- **Keep sessions short** – Generate tests for one functional flow at a time; iterate rather than record everything in one go. +- **Enter URL**—Set the URL Filter to the base domain you want Keploy to record. This keeps captures focused on the traffic that matters. +- **Keep sessions short**—Generate tests for one functional flow at a time; iterate rather than record everything in one go. ## Troubleshooting diff --git a/versioned_docs/version-3.0.0/running-keploy/api-testing-tool-ai-powered.md b/versioned_docs/version-3.0.0/running-keploy/api-testing-tool-ai-powered.md index 508e13d26..03fc8ef07 100644 --- a/versioned_docs/version-3.0.0/running-keploy/api-testing-tool-ai-powered.md +++ b/versioned_docs/version-3.0.0/running-keploy/api-testing-tool-ai-powered.md @@ -26,7 +26,7 @@ keywords: | ----------------------------------------------- | --------------------------------------------------------------------------------------------- | | Edge-case, bugs, coverage flows gets missed | Higher test coverage across CRUD and failure scenarios | | APIs change frequently, leading to broken tests | Self-healing keeps tests even when APIs evolves | -| 30–50% of time spent writing tests | 50–80% reduction in test creation
Covers more edge cases within limited resources, time | +| 30—50% of time spent writing tests | 50—80% reduction in test creation
Covers more edge cases within limited resources, time | ## 💥 Why Keploy? Not Other AI Testing Tools @@ -43,7 +43,7 @@ keywords: ## 🚀 Keploy's API Test Generator -AI-powered testing engine that turns your API specs or traffic into stable, end-to-end test suites — no scripts, mocks, or manual setup required. +AI-powered testing engine that turns your API specs or traffic into stable, end-to-end test suites—no scripts, mocks, or manual setup required. It supports: @@ -61,7 +61,7 @@ Every test includes: - Deduplication and flaky test detection - Self-healing for minor API changes -Whether you're a developer, SDET, or QA manager — Keploy helps you increase test coverage, reduce test debt, and ensure reliable releases across environments. +Whether you're a developer, SDET, or QA manager—Keploy helps you increase test coverage, reduce test debt, and ensure reliable releases across environments. ## 🛠️ How It Works diff --git a/versioned_docs/version-3.0.0/running-keploy/best-practices-api-testing.md b/versioned_docs/version-3.0.0/running-keploy/best-practices-api-testing.md index 020bad6a9..78b2e3855 100644 --- a/versioned_docs/version-3.0.0/running-keploy/best-practices-api-testing.md +++ b/versioned_docs/version-3.0.0/running-keploy/best-practices-api-testing.md @@ -25,7 +25,7 @@ API testing ensures the reliability, security, and performance of your applicati ### ✅ 1. Define Clear Test Objectives -- Understand what you're testing — functionality, security, performance, or error handling. +- Understand what you're testing—functionality, security, performance, or error handling. - Align tests with business logic and expected user workflows. ### 🧪 2. Cover Both Positive and Negative Scenarios diff --git a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md index 4f0546daf..e725e2e65 100755 --- a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md @@ -52,7 +52,7 @@ keploy record [flags] In the command above, `node src/app.js` is the command which starts the user application. -- `--config-path string` - Path to the Keploy configuration file. The default is ".". +- `--config-path string` - Path to the Keploy configuration file. The default is "." ```bash keploy record -c "node src/app.js" --config-path "./config-dir/" @@ -143,7 +143,7 @@ keploy test [flags] In the command above, `node src/app.js` is the command which starts the user application. -- `--config-path string` - Path to the Keploy configuration file. The default is ".". +- `--config-path string` - Path to the Keploy configuration file. The default is "." ```bash keploy test -c "node src/app.js" --config-path "./config-dir/" @@ -163,7 +163,7 @@ keploy test [flags] keploy test -c "node src/app.js" --delay 10 ``` -- `--mongo-password string` - Authentication password for mocking MongoDB connection. The default password is "default123". +- `--mongo-password string` - Authentication password for mocking MongoDB connection. The default password is "default123." ```bash keploy test -c "node src/app.js" --mongo-password "my-password" @@ -299,7 +299,7 @@ keploy normalize [flags] ## [rerecord](#rerecord) -The `rerecord` command allows users to record new Keploy test cases and mocks from existing test cases for the given testset(s). +The `rerecord` command allows users to record new Keploy test cases and mocks from existing test cases for the given testsets. **Usage:** @@ -351,7 +351,7 @@ keploy config [flags] keploy config --generate ``` -- `-p, --path string` - Path to the local directory where the Keploy Configuration File will be stored. The default is ".". +- `-p, --path string` - Path to the local directory where the Keploy Configuration File will be stored. The default is "." ```bash keploy config --generate --path "./config-dir/" diff --git a/versioned_docs/version-3.0.0/running-keploy/generate-api-tests-using-ai.md b/versioned_docs/version-3.0.0/running-keploy/generate-api-tests-using-ai.md index 339042370..7a016b0ff 100644 --- a/versioned_docs/version-3.0.0/running-keploy/generate-api-tests-using-ai.md +++ b/versioned_docs/version-3.0.0/running-keploy/generate-api-tests-using-ai.md @@ -44,15 +44,15 @@ If your API is not publicly accessible, Keploy will show a warning when attempti Use a **base API path, not a homepage** or static resource, for generating test flows. -| URL Example | | Why It's Good or Bad | -| --------------------------------------- | --- | -------------------------------------------- | -| `https://api.example.com` | ✅ | API subdomain — general and testable | -| `https://example.com/api` | ✅ | API under path — works across many endpoints | -| `https://example.com/api/v2` | ✅ | Versioned API route | -| `https://example.com/v2/orders` | ✅ | Specific API group — stable path | -| `https://example.com` | ❌ | Homepage — not an API | -| `https://example.com/index.html` | ❌ | Static file — not useful for API testing | -| `https://api.example.com/orders/126789` | ❌ | Too specific — single object, not general | +| URL Example | | Why It's Good or Bad | +| --------------------------------------- | --- | ------------------------------------------ | +| `https://api.example.com` | ✅ | API subdomain—general and testable | +| `https://example.com/api` | ✅ | API under path—works across many endpoints | +| `https://example.com/api/v2` | ✅ | Versioned API route | +| `https://example.com/v2/orders` | ✅ | Specific API group—stable path | +| `https://example.com` | ❌ | Homepage—not an API | +| `https://example.com/index.html` | ❌ | Static file—not useful for API testing | +| `https://api.example.com/orders/126789` | ❌ | Too specific—single object, not general | > ⚠️ Avoid using URLs pointing to static resources or deeply nested objects. diff --git a/versioned_docs/version-3.0.0/running-keploy/keploy-templatize.md b/versioned_docs/version-3.0.0/running-keploy/keploy-templatize.md index 5b6101699..3febe5e3b 100644 --- a/versioned_docs/version-3.0.0/running-keploy/keploy-templatize.md +++ b/versioned_docs/version-3.0.0/running-keploy/keploy-templatize.md @@ -26,7 +26,7 @@ You can use the following command to templatize your testsets. sudo -E env 'PATH=$PATH' keploy templatize ``` -By default, it templatizes all the testsets in the keploy folder. If you want to templatize a particular testset, you can pass the testset flag like +By default, it templatizes all the testsets in the keploy folder. If you want to templatize a particular testsets, you can pass the testsets flag like ```zsh sudo -E env 'PATH=$PATH' keploy templatize -t="test-set-1" diff --git a/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md b/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md index 2d6cc25be..dbfa56aa7 100644 --- a/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md +++ b/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md @@ -2,10 +2,10 @@ id: review-and-improve-ai-generated-tests title: Review & Improve AI-Generated API Tests sidebar_label: Review & Improve Tests -description: Learn how to inspect, edit, self-heal, and enhance Keploy’s AI-generated API test suites for maximum coverage and reliability. +description: Learn how to inspect, edit, self-heal, and enhance Keploy's AI-generated API test suites for maximum coverage and reliability. --- -After you’ve generated a starter test suite with Keploy’s AI engine, the next step is to review, refine, and harden those tests so they stay trustworthy as your API evolves. +After you've generated a starter test suite with Keploy's AI engine, the next step is to review, refine, and harden those tests so they stay trustworthy as your API evolves. ## Open the Test Review Workspace @@ -24,7 +24,7 @@ Use the **Filter Options** bar in the left **Test‑Suites** pane to slice large You can **combine these filters** with the search bar—for example, view only failed `DELETE` calls on eg: `/employees`—making it painless to triage huge test suites. -## Edit Test Step – Request & Assertions +## Edit Test Step—Request & Assertions Keploy lets you refine both the **request definition** and the **assertions** from a single modal: @@ -51,7 +51,7 @@ Keploy lets you refine both the **request definition** and the **assertions** fr ### Save & Rollback -Hit **Save Changes** – every edit is version‑controlled so you can roll back anytime. +Hit **Save Changes**—every edit is version‑controlled so you can roll back anytime. ## 📚 Assertion Types & Examples @@ -66,23 +66,24 @@ Mix-and-match them as needed—every example below can live inside the same `ass | **JSON Equal** | **Entire** JSON body matches exactly (order-agnostic). | `yaml
- type: json_equal
expected:
id: 42
status: "shipped"
` | Warehouse service returns `{ "status": "shipped", "id": 42 }` | | **JSON Contains** | Body **contains** a subset of fields/values. | `yaml
- type: json_contains
expected:
status: "error"
message: "invalid token"
` | Auth service returns a long error payload that **includes** those two fields | | **Header Contains** | Specific header **includes** a substring. | `yaml
- type: header_contains
field: content-type
expected: json
` | `content-type: application/**json**; charset=utf-8` | -| **Header Equal** | Header equals an exact value (case-insensitive). | `yaml
- type: header_equal
field: cache-control
expected: "no-store"
` | `cache-control: No-Store` (case doesn’t matter) | +| **Header Equal** | Header equals an exact value (case-insensitive). | `yaml
- type: header_equal
field: cache-control
expected: "no-store"
` | `cache-control: No-Store` (case doesn't matter) | | **Header Exists** | Header key is present (value ignored). | `yaml
- type: header_exists
field: x-request-id
` | Reverse-proxy injects `x-request-id: 4b087…` | | **Header Matches** | Header value matches a **regex** pattern. | `yaml
- type: header_matches
field: set-cookie
pattern: "sessionId=.*; Path=/; HttpOnly"
` | `set-cookie: sessionId=abc123; Path=/; HttpOnly; SameSite=Lax` | > **Tip** + > Combine multiple assertions in one step to cover status, headers **and** body in a single round-trip. Every assertion is evaluated independently, so one failure pinpoints the exact mismatch. -## Edit and Manage Test Suites +## Edit or Delete a Test Suite In the Test Suites list, hover over any row to reveal the ︙ (more-options) menu: **︙ Menu**: Hover over any suite row to reveal options: -- **Add Test Suite** – Create a new suite and give it a clear, descriptive title. -- **Select Test Suite** – Choose an existing suite for running or further changes. -- **Edit Test Suite** – Update the suite’s name, description, or included tests. -- **Delete Test Suite** – Permanently remove a suite you no longer need. +- **Add Test Suite**—Create a new suite and give it a clear, descriptive title. +- **Select Test Suite**—Choose an existing suite for running or further changes. +- **Edit Test Suite**—Update the suite’s name, description, or included tests. +- **Delete Test Suite**—Permanently remove a suite you no longer need. All changes are saved instantly and logged. ⚠️ Deletion is irreversible. Use Git history or backups to restore. diff --git a/versioned_docs/version-3.0.0/running-keploy/run-ai-generated-api-tests.md b/versioned_docs/version-3.0.0/running-keploy/run-ai-generated-api-tests.md index d2b548259..409b18a86 100644 --- a/versioned_docs/version-3.0.0/running-keploy/run-ai-generated-api-tests.md +++ b/versioned_docs/version-3.0.0/running-keploy/run-ai-generated-api-tests.md @@ -15,7 +15,7 @@ Once you’ve finished curating a suite , it’s time to hit **Run** and see how | Tab | What to Fill In | | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | **Endpoint** | **API Endpoint URL** – the base URL Keploy will prepend to every request in the suite (e.g. `https://jsonplaceholder.typicode.com`). | + | **Endpoint** | **API Endpoint URL**—the base URL Keploy will prepend to every request in the suite (e.g. `https://jsonplaceholder.typicode.com`). | | **Authentication** | (Optional) Drop in a **Bearer**, **Basic**, or **API-key** credential that applies to every step.
You can also add per-step auth later in the test-step editor. | 3. Click **Run Tests** to start execution. A toast confirmation appears and the modal closes. @@ -43,7 +43,7 @@ A **Run Badge** next to each suite row flips from _queued_ → _running_ → _ Iterate quickly: -1. Patch your API or tweak assertions from the "Test Suite". +1. Patch your API or tweak assertions from the "Test Suite." 2. Re-click **Run Tests**—Keploy re-uses the same Endpoint/Auth settings you last entered. 3. Compare the new report with the previous one right in the dashboard to verify the fix. diff --git a/versioned_docs/version-3.0.0/running-keploy/share-tests.md b/versioned_docs/version-3.0.0/running-keploy/share-tests.md index 1a4e58a66..b243180f8 100644 --- a/versioned_docs/version-3.0.0/running-keploy/share-tests.md +++ b/versioned_docs/version-3.0.0/running-keploy/share-tests.md @@ -15,8 +15,8 @@ In the **Test Suites** list, hover over a suite row and click the **Share** icon The **Share Test Suites** modal appears with two tabs: -- **Find People** – Search existing workspace members. -- **Add New User** – Invite someone via email. +- **Find People**—Search existing workspace members. +- **Add New User**—Invite someone via email. ## Confirm & Notify diff --git a/versioned_docs/version-3.0.0/running-keploy/test-generate.md b/versioned_docs/version-3.0.0/running-keploy/test-generate.md index 3ccc34dec..5bf4be841 100644 --- a/versioned_docs/version-3.0.0/running-keploy/test-generate.md +++ b/versioned_docs/version-3.0.0/running-keploy/test-generate.md @@ -47,7 +47,7 @@ If your API requires authentication, make sure you: - Add API keys or bearer tokens in headers - Or include auth flows via test inputs below -#### 📎 Paste cURL Snippets _(Recommended: 3–5)_ +#### 📎 Paste cURL Snippets _(Recommended: 3—5)_ Add working `curl` commands representing real user flows. These help the AI infer request types, payloads, and expected outcomes. diff --git a/versioned_docs/version-3.0.0/running-keploy/test-run-reports.md b/versioned_docs/version-3.0.0/running-keploy/test-run-reports.md index 91a3ddc8a..0958f6a52 100644 --- a/versioned_docs/version-3.0.0/running-keploy/test-run-reports.md +++ b/versioned_docs/version-3.0.0/running-keploy/test-run-reports.md @@ -114,5 +114,5 @@ Update the request configuration for each test case: ### 💾 Actions -- ✅ **Save Changes** — Apply edits to the test step and update the suite. -- ❌ **Cancel** — Discard any unsaved modifications and revert to the last saved state. +- ✅ **Save Changes**—Apply edits to the test step and update the suite. +- ❌ **Cancel**—Discard any unsaved modifications and revert to the last saved state. diff --git a/versioned_docs/version-3.0.0/running-keploy/utg-pr-agent.md b/versioned_docs/version-3.0.0/running-keploy/utg-pr-agent.md index 0bde9477e..61902b7dc 100644 --- a/versioned_docs/version-3.0.0/running-keploy/utg-pr-agent.md +++ b/versioned_docs/version-3.0.0/running-keploy/utg-pr-agent.md @@ -69,7 +69,7 @@ In the PR comment left by Keploy: Once the process is complete: -- Click **"Go back to the PR"**. +- Click **"Go back to the PR."** - The PR comment will be updated with: - All the **unit test files** generated for your recent changes. - A **test summary** presented in a **clean tabular format** showing: - File names - Number of test cases - Coverage details - Edge cases handled (if any) diff --git a/versioned_docs/version-3.0.0/running-keploy/utg-vsc-extension.md b/versioned_docs/version-3.0.0/running-keploy/utg-vsc-extension.md index deffc6f11..777ae8a0a 100644 --- a/versioned_docs/version-3.0.0/running-keploy/utg-vsc-extension.md +++ b/versioned_docs/version-3.0.0/running-keploy/utg-vsc-extension.md @@ -124,4 +124,4 @@ Don't let testing slow down your development velocity. With Keploy's AI-powered 3. **Click "Generate Unit Tests"** and experience the magic 4. **Watch your test coverage soar** while maintaining development speed -\_Transform your IDE. Elevate your code quality. Join 500k+ developers building better software with Keploy. +Transform your IDE. Elevate your code quality. Join 500k+ developers building better software with Keploy. From 059fc954da4529a6410fc917aa8bc1b3907f1d67 Mon Sep 17 00:00:00 2001 From: pratik-mahalle Date: Thu, 21 Aug 2025 18:23:44 +0530 Subject: [PATCH 2/8] fix: update the version 3 for the lint issue Signed-off-by: pratik-mahalle --- .../running-keploy/review-and-improve-ai-generated-tests.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md b/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md index dbfa56aa7..08f5d0d21 100644 --- a/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md +++ b/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md @@ -70,7 +70,7 @@ Mix-and-match them as needed—every example below can live inside the same `ass | **Header Exists** | Header key is present (value ignored). | `yaml
- type: header_exists
field: x-request-id
` | Reverse-proxy injects `x-request-id: 4b087…` | | **Header Matches** | Header value matches a **regex** pattern. | `yaml
- type: header_matches
field: set-cookie
pattern: "sessionId=.*; Path=/; HttpOnly"
` | `set-cookie: sessionId=abc123; Path=/; HttpOnly; SameSite=Lax` | -> **Tip** +> **Tip** > Combine multiple assertions in one step to cover status, headers **and** body in a single round-trip. Every assertion is evaluated independently, so one failure pinpoints the exact mismatch. From 81cde4f0ddd001e994615c86efa30e0d03b543a9 Mon Sep 17 00:00:00 2001 From: Pratik Mahalle Date: Tue, 15 Jul 2025 15:55:57 +0530 Subject: [PATCH 3/8] docs: fix the linters for the version3 Signed-off-by: Pratik Mahalle --- vale_styles/config/vocabularies/Base/accept.txt | 6 +++++- .../concepts/reference/glossary/white-box-testing.md | 4 ++++ versioned_docs/version-3.0.0/running-keploy/cli-commands.md | 2 +- .../running-keploy/review-and-improve-ai-generated-tests.md | 4 ++++ 4 files changed, 14 insertions(+), 2 deletions(-) diff --git a/vale_styles/config/vocabularies/Base/accept.txt b/vale_styles/config/vocabularies/Base/accept.txt index 9133702c4..c9ae40cf7 100644 --- a/vale_styles/config/vocabularies/Base/accept.txt +++ b/vale_styles/config/vocabularies/Base/accept.txt @@ -126,6 +126,7 @@ Passthrough async substring llm +<<<<<<< HEAD shorteners matchType anonymization @@ -140,4 +141,7 @@ viewport Gradle sublicense doxing -vale_styles \ No newline at end of file +vale_styles +======= +shorteners +>>>>>>> 5a03cd82 (docs: fix the linters for the version3) diff --git a/versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md b/versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md index 16c3e5a68..ca50a9357 100644 --- a/versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md +++ b/versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md @@ -28,7 +28,11 @@ White box testing, also known as clear box or glass box testing, is a software t The primary goal of white box testing is to validate the software's internal operations, ensuring that it functions correctly and efficiently. This involves checking all pathways and conditions, optimizing code for speed and performance, and ensuring that there are no hidden errors. +<<<<<<< HEAD ![Types of Testing](/img/glossary/types-of-testing.webp) +======= +![Types of Testing](https://keploy-devrel.s3.us-west-2.amazonaws.com/types-of-testing.jpeg) +>>>>>>> 5a03cd82 (docs: fix the linters for the version3) ## Fundamentals of White Box Testing diff --git a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md index e725e2e65..b121322df 100755 --- a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md @@ -299,7 +299,7 @@ keploy normalize [flags] ## [rerecord](#rerecord) -The `rerecord` command allows users to record new Keploy test cases and mocks from existing test cases for the given testsets. +The `rerecord`cmd allow user to record new keploy testcases/mocks from the existing test cases for the given testsets. **Usage:** diff --git a/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md b/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md index 08f5d0d21..75aa4375e 100644 --- a/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md +++ b/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md @@ -70,8 +70,12 @@ Mix-and-match them as needed—every example below can live inside the same `ass | **Header Exists** | Header key is present (value ignored). | `yaml
- type: header_exists
field: x-request-id
` | Reverse-proxy injects `x-request-id: 4b087…` | | **Header Matches** | Header value matches a **regex** pattern. | `yaml
- type: header_matches
field: set-cookie
pattern: "sessionId=.*; Path=/; HttpOnly"
` | `set-cookie: sessionId=abc123; Path=/; HttpOnly; SameSite=Lax` | +<<<<<<< HEAD > **Tip** +======= +> **Tip 🛠️** +>>>>>>> 5a03cd82 (docs: fix the linters for the version3) > Combine multiple assertions in one step to cover status, headers **and** body in a single round-trip. Every assertion is evaluated independently, so one failure pinpoints the exact mismatch. ## Edit or Delete a Test Suite From 024e2b404ad734bba5425c3693887c9dcb31142f Mon Sep 17 00:00:00 2001 From: Pratik Mahalle Date: Tue, 22 Jul 2025 12:25:12 +0530 Subject: [PATCH 4/8] fix: the lint in the version 3 docs Signed-off-by: Pratik Mahalle --- vale_styles/config/vocabularies/Base/accept.txt | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/vale_styles/config/vocabularies/Base/accept.txt b/vale_styles/config/vocabularies/Base/accept.txt index c9ae40cf7..fbfe0fead 100644 --- a/vale_styles/config/vocabularies/Base/accept.txt +++ b/vale_styles/config/vocabularies/Base/accept.txt @@ -127,6 +127,7 @@ async substring llm <<<<<<< HEAD +<<<<<<< HEAD shorteners matchType anonymization @@ -145,3 +146,7 @@ vale_styles ======= shorteners >>>>>>> 5a03cd82 (docs: fix the linters for the version3) +======= +shorteners +matchType +>>>>>>> 028ca181 (fix: the lint in the version 3 docs) From 3eff50ac5e13b2de69e3320aaed94fd41e1b025b Mon Sep 17 00:00:00 2001 From: Pratik Mahalle Date: Wed, 23 Jul 2025 11:55:18 +0530 Subject: [PATCH 5/8] fix: lint issues Signed-off-by: Pratik Mahalle --- vale_styles/config/vocabularies/Base/accept.txt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/vale_styles/config/vocabularies/Base/accept.txt b/vale_styles/config/vocabularies/Base/accept.txt index fbfe0fead..3e1b5a945 100644 --- a/vale_styles/config/vocabularies/Base/accept.txt +++ b/vale_styles/config/vocabularies/Base/accept.txt @@ -139,6 +139,7 @@ protoc Unary RPCs viewport +<<<<<<< HEAD Gradle sublicense doxing @@ -150,3 +151,6 @@ shorteners shorteners matchType >>>>>>> 028ca181 (fix: the lint in the version 3 docs) +======= +Gradle +>>>>>>> 0ff6d0b2 (fix: lint issues) From d54c1cbf85cbbec489d412df523c903f6c04eac6 Mon Sep 17 00:00:00 2001 From: Pratik Mahalle Date: Wed, 23 Jul 2025 12:33:04 +0530 Subject: [PATCH 6/8] fix: minor-changes Signed-off-by: Pratik Mahalle --- vale_styles/config/vocabularies/Base/accept.txt | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) diff --git a/vale_styles/config/vocabularies/Base/accept.txt b/vale_styles/config/vocabularies/Base/accept.txt index 3e1b5a945..9133702c4 100644 --- a/vale_styles/config/vocabularies/Base/accept.txt +++ b/vale_styles/config/vocabularies/Base/accept.txt @@ -126,8 +126,6 @@ Passthrough async substring llm -<<<<<<< HEAD -<<<<<<< HEAD shorteners matchType anonymization @@ -139,18 +137,7 @@ protoc Unary RPCs viewport -<<<<<<< HEAD Gradle sublicense doxing -vale_styles -======= -shorteners ->>>>>>> 5a03cd82 (docs: fix the linters for the version3) -======= -shorteners -matchType ->>>>>>> 028ca181 (fix: the lint in the version 3 docs) -======= -Gradle ->>>>>>> 0ff6d0b2 (fix: lint issues) +vale_styles \ No newline at end of file From 0859b69817cff362a3c406492af084b2accbe350 Mon Sep 17 00:00:00 2001 From: pratik-mahalle Date: Thu, 21 Aug 2025 18:16:45 +0530 Subject: [PATCH 7/8] fix: remove the paranthesis s for cli file Signed-off-by: pratik-mahalle --- versioned_docs/version-3.0.0/running-keploy/cli-commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md index b121322df..e725e2e65 100755 --- a/versioned_docs/version-3.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-3.0.0/running-keploy/cli-commands.md @@ -299,7 +299,7 @@ keploy normalize [flags] ## [rerecord](#rerecord) -The `rerecord`cmd allow user to record new keploy testcases/mocks from the existing test cases for the given testsets. +The `rerecord` command allows users to record new Keploy test cases and mocks from existing test cases for the given testsets. **Usage:** From a24c3f12ebdb188ad78c5847e0de793e9684c883 Mon Sep 17 00:00:00 2001 From: pratik-mahalle Date: Thu, 21 Aug 2025 19:06:03 +0530 Subject: [PATCH 8/8] fix: did rebase and add the dco to missing commit Signed-off-by: pratik-mahalle --- .../concepts/reference/glossary/white-box-testing.md | 4 ---- .../running-keploy/review-and-improve-ai-generated-tests.md | 6 +----- 2 files changed, 1 insertion(+), 9 deletions(-) diff --git a/versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md b/versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md index ca50a9357..a2f8e9ddb 100644 --- a/versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md +++ b/versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md @@ -28,11 +28,7 @@ White box testing, also known as clear box or glass box testing, is a software t The primary goal of white box testing is to validate the software's internal operations, ensuring that it functions correctly and efficiently. This involves checking all pathways and conditions, optimizing code for speed and performance, and ensuring that there are no hidden errors. -<<<<<<< HEAD -![Types of Testing](/img/glossary/types-of-testing.webp) -======= ![Types of Testing](https://keploy-devrel.s3.us-west-2.amazonaws.com/types-of-testing.jpeg) ->>>>>>> 5a03cd82 (docs: fix the linters for the version3) ## Fundamentals of White Box Testing diff --git a/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md b/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md index 75aa4375e..f27f99b2a 100644 --- a/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md +++ b/versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md @@ -70,15 +70,11 @@ Mix-and-match them as needed—every example below can live inside the same `ass | **Header Exists** | Header key is present (value ignored). | `yaml
- type: header_exists
field: x-request-id
` | Reverse-proxy injects `x-request-id: 4b087…` | | **Header Matches** | Header value matches a **regex** pattern. | `yaml
- type: header_matches
field: set-cookie
pattern: "sessionId=.*; Path=/; HttpOnly"
` | `set-cookie: sessionId=abc123; Path=/; HttpOnly; SameSite=Lax` | -<<<<<<< HEAD > **Tip** -======= -> **Tip 🛠️** ->>>>>>> 5a03cd82 (docs: fix the linters for the version3) > Combine multiple assertions in one step to cover status, headers **and** body in a single round-trip. Every assertion is evaluated independently, so one failure pinpoints the exact mismatch. -## Edit or Delete a Test Suite +## Edit or and Manage Test Suites In the Test Suites list, hover over any row to reveal the ︙ (more-options) menu: