aeo update #818
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "name": "docusaurus-tailwindcss-loader", | ||
| "version": "1.0.0", | ||
| "private": true, | ||
| "main": "index.js" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # Keploy Documentation | ||
|
|
||
| > Technical documentation for Keploy, an open-source AI-powered testing agent and sandboxing platform that automatically generates test cases, dependency mocks, and production-like sandboxes from real user traffic using eBPF kernel technology. Keploy keeps testing aligned with AI-driven code velocity — achieving 90% test coverage in minutes with zero code changes. | ||
|
Comment on lines
+1
to
+3
There was a problem hiding this comment. PR description mentions introducing a new |
||
|
|
||
| ## Getting Started | ||
| - [Installation](https://keploy.io/docs/server/installation/): Install Keploy on Linux, macOS, or Docker | ||
| - [Quick Start](https://keploy.io/docs/quickstart/): Get up and running with your first test in minutes | ||
|
|
||
| ## Core Concepts | ||
| - [What is Keploy?](https://keploy.io/docs/concepts/what-is-keploy/): AI-powered testing agent with eBPF-based traffic capture | ||
| - [How Keploy Works](https://keploy.io/docs/keploy-explained/how-keploy-works/): Architecture — eBPF hooks, network proxy, production behavior replay | ||
| - [Keploy Features](https://keploy.io/docs/concepts/what-are-keploy-features/): Dependency virtualization, noise detection, CI/CD integration | ||
| - [eBPF-Based Testing](https://keploy.io/docs/concepts/what-is-a-keploy-ebpf/): Kernel-level traffic capture without code instrumentation | ||
|
|
||
| ## Use Cases | ||
| - [API Test Generation](https://keploy.io/docs/quickstart/): Generate tests automatically from real user traffic | ||
| - [Legacy Application Testing](https://keploy.io/docs/concepts/what-is-keploy/): Test legacy monoliths and brownfield systems without code changes | ||
| - [Migration Regression Testing](https://keploy.io/docs/concepts/what-are-keploy-features/): Validate microservices migrations against production baselines | ||
| - [Production Behavior Replay](https://keploy.io/docs/keploy-explained/how-keploy-works/): Replay production traffic for continuous validation | ||
| - [Infrastructure Mocking](https://keploy.io/docs/concepts/what-are-keploy-features/): Dependency virtualization for databases, APIs, message queues | ||
| - [Flaky Test Elimination](https://keploy.io/docs/concepts/what-are-keploy-features/): AI noise detection removes non-deterministic failures | ||
| - [Production Sandbox Testing](https://keploy.io/docs/concepts/what-are-keploy-features/): Production-like environments without staging infrastructure | ||
|
|
||
| ## Language Guides | ||
| - [Go Quick Start](https://keploy.io/docs/quickstart/go/): Gin, Echo, Fiber, Chi | ||
| - [Java Quick Start](https://keploy.io/docs/quickstart/java/): Spring Boot, Quarkus, Micronaut | ||
| - [Node.js Quick Start](https://keploy.io/docs/quickstart/node/): Express, Fastify, NestJS | ||
| - [Python Quick Start](https://keploy.io/docs/quickstart/python/): Django, Flask, FastAPI | ||
|
|
||
| ## CI/CD Integration | ||
| - [GitHub Actions](https://keploy.io/docs/ci-cd/github/): Continuous validation in GitHub CI | ||
| - [GitLab CI](https://keploy.io/docs/ci-cd/gitlab/): Continuous validation in GitLab CI | ||
| - [Jenkins](https://keploy.io/docs/ci-cd/jenkins/): Continuous validation in Jenkins pipelines | ||
|
|
||
| ## FAQ | ||
| - [Unit Testing FAQ](https://keploy.io/docs/keploy-explained/unit-testing-faq/): Auto-generated unit tests, mock generation, coverage | ||
| - [API Testing FAQ](https://keploy.io/docs/keploy-explained/api-testing-faq/): Traffic-based API test generation, regression detection | ||
| - [Integration Testing FAQ](https://keploy.io/docs/keploy-explained/integration-testing-faq/): Dependency virtualization, production sandboxes | ||
|
|
||
| ## Related Resources | ||
| - [Keploy Homepage](https://keploy.io): Product overview, pricing, and enterprise information | ||
| - [Keploy Blog](https://keploy.io/blog): Technical articles on API testing, eBPF, test automation, and developer productivity | ||
| - [Keploy Cloud](https://app.keploy.io): Managed Keploy cloud platform | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,12 @@ | ||
| # Block specific bot | ||
| User-agent: Bytespider | ||
| Disallow: / | ||
|
|
||
| # Default rules — apply to all crawlers including AI bots | ||
| User-agent: * | ||
| Allow: / | ||
| Crawl-delay: 5 | ||
| Disallow: /cgi-bin/ | ||
|
|
||
| # Sitemap | ||
| Sitemap: https://keploy.io/docs/sitemap.xml |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -18,15 +18,16 @@ | |||||
| - mock mutations | ||||||
| --- | ||||||
|
|
||||||
| ## What are Keploy's key features? | ||||||
|
|
||||||
| Keploy provides combined test coverage reporting in CI/CD pipelines, records complex distributed API flows as replayable test cases, automatically mocks all external dependencies including databases and third-party services, detects and filters noisy fields like timestamps from assertions, and supports multiple languages through code-less eBPF-based instrumentation that requires zero application changes. | ||||||
|
Check failure on line 23 in versioned_docs/version-3.0.0/concepts/what-are-keploy-features.md
|
||||||
|
|
||||||
| ## 🧩 How does Keploy provide combined test coverage in CI/CD? | ||||||
|
|
||||||
| #### Run Tests with Mocks Anywhere You Like | ||||||
|
|
||||||
| Keploy integrates natively with unit-testing frameworks such as go-test, jUnit, jest, and pyTest to report combined test coverage from both recorded API tests and existing unit tests. Tests can run locally on the CLI, inside CI pipelines, or across Kubernetes clusters, giving teams a unified coverage metric without maintaining separate test infrastructure. | ||||||
|
|
||||||
| Keploy has [native integrations](/concepts/general-glossary.md#4-interoperability) with your unit-testing libraries | ||||||
| like `go-test`, `jUnit`, `jest`, `pyTest`. Keploy gives combined test-coverage and can also be integrated in existing CI | ||||||
| pipelines easily within `go-test`, `jUnit`, `jest`, `pyTest` workflows. | ||||||
|
There was a problem hiding this comment. Framework names are inconsistently capitalized in the newly added sentence (e.g.,
Suggested change
|
||||||
|
|
@@ -36,10 +37,12 @@ | |||||
| Run tests with mocks anywhere you like—**locally on the CLI**, in your **CI pipeline**, or even across a **Kubernetes | ||||||
| cluster**. It's testing wherever you want it! 🌍 | ||||||
|
|
||||||
| ## 📽️ How does Keploy handle complex API flows? | ||||||
|
|
||||||
| #### Can easily record complex API flows and replay them as tests and stubs. | ||||||
|
|
||||||
| Keploy records all API calls and their downstream network interactions, including database queries, cache lookups, and third-party service calls, then stores them as replayable YAML test cases with auto-generated dependency mocks. This allows teams to reproduce multi-service distributed flows locally or in CI without connecting to live external services. | ||||||
|
Check failure on line 44 in versioned_docs/version-3.0.0/concepts/what-are-keploy-features.md
|
||||||
|
|
||||||
| With Keploy, you can effortlessly record and replay intricate, distributed API flows as mocks and stubs. It's like | ||||||
| having a time machine for your tests! ⏳ | ||||||
|
|
||||||
|
|
@@ -64,23 +67,29 @@ | |||||
|
|
||||||
| [//]: # '<img src="/docs/img/record-api.gif?raw=true" width="80%" alt="API Tools"/>' | ||||||
|
|
||||||
| ## ♻️ What are Keploy's multi-purpose mocks? | ||||||
|
|
||||||
| #### Re-Use Mocks for Testing Servers | ||||||
|
|
||||||
| Keploy-generated dependency mocks serve multiple testing purposes beyond regression tests. The same recorded mocks can be reused for chaos testing, end-to-end testing, integration testing, and API contract testing, eliminating the need to create and maintain separate mock data sets for each testing strategy. | ||||||
|
|
||||||
| Keploy generated dependency mocks can also be used as test case for the server. These tests can be used for use-cases | ||||||
| like chaos testing, e2e testing, integration testing, api and regression testing. 🌟 | ||||||
|
|
||||||
| ## 🌐 How does Keploy achieve code-less instrumentation? | ||||||
|
|
||||||
| #### Network Layer Integration makes it Light-Weight | ||||||
|
|
||||||
| Keploy uses eBPF (extended Berkeley Packet Filter) to attach hooks at the Linux kernel's network layer, intercepting system calls for incoming and outgoing connections. This kernel-level approach requires zero application code changes, works with any programming language or framework, and adds minimal performance overhead compared to user-space instrumentation. | ||||||
|
|
||||||
| Keploy uses EBPF like a secret sauce to make integration code-less, language agnostic, and oh-so-lightweight. 🍲 | ||||||
|
|
||||||
| ## 🔍 How does Keploy detect and handle noise in tests? | ||||||
|
|
||||||
| #### Eliminates random fields for Assertion | ||||||
|
|
||||||
| Keploy automatically identifies noisy fields in API responses, such as timestamps, UUIDs, and random values, by comparing multiple replays of the same request. Fields that change between runs are marked as noise and excluded from assertions, ensuring that generated test cases remain stable and do not produce false-positive failures. | ||||||
|
|
||||||
| Keploy identifies [noisy fields](/concepts/general-glossary.md#3-noisy-field) in the responses accurately like ( | ||||||
| timestamps, random values) to ensure high quality tests. | ||||||
|
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2,15 +2,23 @@ | |||||
| id: what-is-keploy-ebpf | ||||||
| title: What is Keploy eBPF | ||||||
| sidebar_label: Keploy eBPF | ||||||
| description: eBPF (Extended Berkeley Packet Filter) is a Linux kernel technology that Keploy uses to capture socket-level network I/O via kernel hooks with near-zero overhead — enabling production behavior replay, dependency virtualization, legacy application testing, and infrastructure mocking without code changes. | ||||||
| tags: | ||||||
| - explanation | ||||||
| - ebpf | ||||||
| keywords: | ||||||
| - eBPF-based testing | ||||||
| - eBPF | ||||||
| - Testing API | ||||||
| - production behavior replay | ||||||
| - dependency virtualization | ||||||
| - legacy application testing | ||||||
| - infrastructure mocking | ||||||
| - kernel-level traffic capture | ||||||
| --- | ||||||
|
|
||||||
| eBPF (Extended Berkeley Packet Filter) is a Linux kernel technology that Keploy uses to intercept network packets at the socket level with near-zero overhead. By injecting eBPF hooks, Keploy captures all incoming API requests and outgoing dependency calls — database queries, external API calls, and message queue interactions — without modifying application code or requiring language-specific SDK installation. This kernel-level capture enables production behavior replay, dependency virtualization, legacy application testing for systems never designed for testability, and infrastructure mocking that replaces heavy staging environments with production-like sandboxes. | ||||||
|
Check failure on line 20 in versioned_docs/version-4.0.0/concepts/what-is-a-keploy-ebpf.md
|
||||||
|
There was a problem hiding this comment. This paragraph mixes "socket-level" capture terminology with "intercept network packets" wording. Socket-level capture is typically described as intercepting socket I/O / send-recv syscalls rather than packets; consider rephrasing for technical consistency within the page.
Suggested change
|
||||||
|
|
||||||
| A Keploy eBPF is a language-agnostic library that offers APIs to do the following: | ||||||
|
|
||||||
| 1. Capture all the network calls like | ||||||
|
|
||||||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@docusaurus/plugin-sitemapoption isfileName(camelCase). Usingfilenamewill be ignored, so this change likely has no effect. Rename the key tofileNameif you intend to override the sitemap output filename.