From 2dc22321abdc028091ea13ca8cc51f8c58bdc239 Mon Sep 17 00:00:00 2001 From: Animesh Pathak Date: Thu, 2 Jan 2025 17:47:06 +0530 Subject: [PATCH] feat: based on feedback iteration 2 Signed-off-by: Animesh Pathak --- docusaurus.config.js | 19 +- src/components/Community.js | 2 +- src/components/Intro.js | 38 ++- src/components/KeployCloud.js | 2 +- src/components/Product.js | 320 ++++++++++++------ src/components/QuickStart.js | 24 +- src/css/custom.css | 19 +- tailwind.config.js | 2 +- versioned_docs/version-2.0.0/ci-cd/github.md | 1 + versioned_docs/version-2.0.0/ci-cd/gitlab.md | 1 + versioned_docs/version-2.0.0/ci-cd/jenkins.md | 1 + .../version-2.0.0/concepts/installation.md | 109 +----- .../concepts/what-are-keploy-features.md | 1 + .../concepts/what-is-a-keploy-ebpf.md | 1 + .../version-2.0.0/concepts/what-is-keploy.md | 7 +- .../version-2.0.0/dependencies/http.md | 1 + .../version-2.0.0/dependencies/mongo.md | 1 + .../version-2.0.0/dependencies/postgresql.md | 1 + .../version-2.0.0/dependencies/redis.md | 1 + .../keploy-cloud/deduplication.md | 1 + .../keploy-cloud/installation.md | 1 + .../keploy-cloud/keploy-console.md | 1 + .../keploy-cloud/mock-registry.md | 1 + .../keploy-cloud/new-application.md | 1 + .../keploy-cloud/testgeneration.md | 1 + .../keploy-cloud/time-freezing.md | 1 + .../keploy-explained/debugger-guide.md | 2 - .../keploy-explained/mac-linux.md | 62 +--- .../keploy-explained/why-keploy.md | 2 + versioned_docs/version-2.0.0/migrate/index.md | 2 +- .../quickstart/csharp-dotnet-postgres.md | 5 +- .../quickstart/express-postgresql-prisma.md | 2 +- .../version-2.0.0/quickstart/flask-redis.md | 2 +- .../quickstart/go-fasthttp-postgres.md | 2 +- .../version-2.0.0/quickstart/go-gin-redis.md | 2 +- .../version-2.0.0/quickstart/go-mux-mysql.md | 2 +- .../version-2.0.0/quickstart/go-mux-sql.md | 3 +- .../quickstart/java-spring-boot-mongo.md | 4 +- .../quickstart/java-spring-postgres.md | 3 +- .../quickstart/nextjs-postgres.md | 2 +- .../quickstart/node-express-mongoose.md | 4 +- .../version-2.0.0/quickstart/node-jwt-sql.md | 2 +- .../quickstart/python-django-sql.md | 3 +- .../quickstart/python-fastapi-sql.md | 13 +- .../quickstart/python-fastapi-twilio.md | 3 +- .../quickstart/python-flask-mongo.md | 3 +- .../quickstart/rust-wrap-mongo.md | 3 +- .../quickstart/sample-rust-crud-mongo.md | 3 +- .../version-2.0.0/quickstart/sample-ts.md | 3 +- .../version-2.0.0/quickstart/samples-bunjs.md | 2 +- .../version-2.0.0/quickstart/samples-echo.md | 2 +- .../quickstart/samples-express-mongoose.md | 2 +- .../quickstart/samples-go-gin-mongo.md | 2 +- .../quickstart/samples-go-sse-svelte.md | 2 +- .../version-2.0.0/quickstart/samples-java.md | 3 +- .../quickstart/samples-node-mongo.md | 3 +- .../version-2.0.0/quickstart/samples-rust.md | 4 +- .../version-2.0.0/quickstart/sanic-mongo.md | 2 +- .../running-keploy/cli-commands.md | 19 +- .../running-keploy/docker-tls.md | 4 +- .../running-keploy/rename-testcases.md | 1 + .../running-keploy/unit-test-generator.md | 15 +- .../version-2.0.0/server/installation.md | 27 ++ .../version-2.0.0-sidebars.json | 43 +-- 64 files changed, 438 insertions(+), 383 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index a34b43459..52dab0625 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -138,23 +138,24 @@ module.exports = { { to: "/keploy-cloud/cloud-installation", label: "Enterprise", + activeBasePath: "none", }, { label: "Resources", items: [ { - label: 'Blogs', - href:'https://keploy.io/blog', + label: "Blogs", + href: "https://keploy.io/blog", }, { - label: 'Contributing', - href: '/keploy-explained/contribution-guide', + label: "Contributing", + href: "/keploy-explained/contribution-guide", }, { - label: 'FAQ', - href:'/keploy-explained/faq/', + label: "Glossary", + href: "/concepts/reference/glossary/", }, - ] + ], }, { type: "docsVersionDropdown", @@ -168,9 +169,9 @@ module.exports = { "aria-label": "GitHub repository", }, { - href: "https://app.keploy.io", + href: "https://app.keploy.io/pricing", position: "right", - label: 'Pricing' + label: "Pricing", }, // TODO : Add Blogging Section // { diff --git a/src/components/Community.js b/src/components/Community.js index 86dc1cd39..e320eef94 100644 --- a/src/components/Community.js +++ b/src/components/Community.js @@ -118,7 +118,7 @@ export const Community = () => { Docker logo @@ -156,7 +156,7 @@ function Frameworks() { data-tooltip="HTTP" > HTTP logo @@ -169,7 +169,7 @@ function Frameworks() { data-tooltip="PostgreSQL" > PostgresSQL logo @@ -180,33 +180,33 @@ function Frameworks() { to={useBaseUrl("/dependencies/redis")} className="hover-label-container flex flex-col items-center justify-center space-y-1 p-6 text-center hover:underline" data-tooltip="Redis" - > + > Redis logo
  • - MySQL logo
  • - DynamoDB logo @@ -231,12 +231,14 @@ export const Intro = () => { return (

    - Getting Started ✨ + Getting Started ✨

    -

    - Get up and running with Keploy in just a few minutes by integrating it with your applications. - Below are the quick-start guides for popular languages and frameworks. -


    +

    + Get up and running with Keploy in just a few minutes by integrating it + with your applications. Below are the quick-start guides for popular + languages and frameworks. +

    +
    diff --git a/src/components/KeployCloud.js b/src/components/KeployCloud.js index b00288ede..b7f80dffe 100644 --- a/src/components/KeployCloud.js +++ b/src/components/KeployCloud.js @@ -94,7 +94,7 @@ export const KeployCloud = () => { {/* />*/} {/**/} -

    +

    To request a Keploy Cloud account, please complete the request form. Our team will review your request and get back to you as soon as possible. - -

    -
      -
    • -

      - Keploy provides automated API testing for every project with test case generation, data mocking, CI/CD integration, and more. -

      -
      • -
    - -
    - ); -} - function UTG() { return ( -
    - +
      +
    • + -
      - - - -

      Unit Testing

      -
      -
        -
      • -

        - Creates unit tests for your functions, improving test coverage without manual effort. -

        + > +
        +
        + + + +

        Unit Testing

        +
        +
          +
        • +

          + Creates unit tests for your functions, improving test + coverage without manual effort in any languages. +

          +
          • +
        +
        +
        • -
      - -
    - ); -} - -function ATG() { - return ( -
    - + -
    - - - - - - - -

    E2E Testing

    -
    -
      -
    • -

      - Generate tests from schema or PRD, automating end-to-end validation for accurate, spec-compliant apps. -

      + > +
      +
      + + + + + + + +

      E2E Testing

      +
      +
        +
      • +

        + Generate tests from schema or PRD, automating end-to-end + validation for accurate, spec-compliant apps. +

        +
        • +
      +
      + +
      • +
    • + +
      +
      + + + + + + + + + + + + + + + + + + + + + + + + undefined + +

      API Testing

      +
      +
        +
      • +

        + Keploy provides automated API testing for every project with + test case generation, data mocking, CI/CD integration, and + more. +

        +
        • +
      +
      +
    -
    ); } @@ -125,8 +239,6 @@ export const Products = () => {
    - -
    ); diff --git a/src/components/QuickStart.js b/src/components/QuickStart.js index 1cef9e76a..8d686ca4b 100644 --- a/src/components/QuickStart.js +++ b/src/components/QuickStart.js @@ -9,18 +9,26 @@ export const QuickStart = () => { Keploy Documentation! πŸš€

    - Welcome to Keploy’s documentation! Whether you're new to backend testing or an experienced developer, this guide will help you get started with Keploy quickly and effectively.πŸ—ΊοΈ + Welcome to Keploy’s documentation! Whether you're new to backend testing + or an experienced developer, this guide will help you get started with + Keploy quickly and effectively.πŸ—ΊοΈ

    What is Keploy? πŸ€”

    - Keploy is an open-source backend testing tool that helps developers quickly create and run tests by capturing - real user traffic. It generates test cases and data mocks to ensure your code is reliable and helps speed up your release cycle..πŸ› οΈ -

    - With features like API testing, unit test generation, and schema/PRD-based test automation, Keploy helps teams release faster while maintaining high reliability. - It’s easy to use, extensible, and integrates seamlessly into CI/CD pipelines, making backend testing efficient and productive. + Keploy is an open-source backend testing tool that helps developers + quickly create and run tests by capturing real user traffic. It + generates test cases and data mocks to ensure your code is reliable and + helps speed up your release cycle..πŸ› οΈ +
    +
    + With features like API testing, unit test generation, and + schema/PRD-based test automation, Keploy helps teams release faster + while maintaining high reliability. It’s easy to use, extensible, and + integrates seamlessly into CI/CD pipelines, making backend testing + efficient and productive.

    Setup Guide πŸ“— @@ -65,7 +73,9 @@ export const QuickStart = () => {

    - ⚠️ Important Note: Keploy v2 is currently in Beta, and the best experience is on Linux. Docker support is experimental, and some limitations may apply. + ⚠️ Important Note: Keploy v2 is currently in Beta, and the best + experience is on Linux. Docker support is experimental, and some + limitations may apply.

    ); diff --git a/src/css/custom.css b/src/css/custom.css index b52d1313b..2f58b44a0 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -9,7 +9,6 @@ font-size:18px; line-height: 1.6; --ifm-color-primary: #000; - --ifm-color-primary-lighter: #FFF; --ifm-color-primary: #ff914d; --ifm-color-primary-dark: #e67643; @@ -87,6 +86,24 @@ html[data-theme="light"] { --ifm-card-shadow-color: rgba(0, 0, 0, 0.2); /* Dark shadow for light theme */ } +html[data-theme='light'] .theme-doc-sidebar-container { + border-right: 1px solid #676565; +} + +/* Sidebar border for dark theme */ +html[data-theme='dark'] .theme-doc-sidebar-container { + border-right: 1px solid #676565; +} + +html[data-theme='light'] .col--3 { + border-left: 1px solid #676565; +} + +/* TOC column border for dark theme */ +html[data-theme='dark'] .col--3 { + border-left: 1px solid #676565; +} + @font-face { font-family: "Roboto"; src: url("../fonts/Roboto-Light.woff2"); diff --git a/tailwind.config.js b/tailwind.config.js index 01d960f96..281b45496 100644 --- a/tailwind.config.js +++ b/tailwind.config.js @@ -14,7 +14,7 @@ module.exports = { "./src/theme/**/*.{js,ts,jsx,tsx}", ], corePlugins: { - preflight: false, + preflight: false, }, // corePlugins: { // // preflight: false, // to use Docusaurus base styles diff --git a/versioned_docs/version-2.0.0/ci-cd/github.md b/versioned_docs/version-2.0.0/ci-cd/github.md index 010dbca90..330308e71 100644 --- a/versioned_docs/version-2.0.0/ci-cd/github.md +++ b/versioned_docs/version-2.0.0/ci-cd/github.md @@ -13,6 +13,7 @@ tags: - cd - plugin --- + Integrating with GitHub CI | Keploy Docs diff --git a/versioned_docs/version-2.0.0/ci-cd/gitlab.md b/versioned_docs/version-2.0.0/ci-cd/gitlab.md index a5f72205d..c36c02174 100644 --- a/versioned_docs/version-2.0.0/ci-cd/gitlab.md +++ b/versioned_docs/version-2.0.0/ci-cd/gitlab.md @@ -13,6 +13,7 @@ tags: - cd - plugin --- + Integrating with GitLab CI | Keploy Docs diff --git a/versioned_docs/version-2.0.0/ci-cd/jenkins.md b/versioned_docs/version-2.0.0/ci-cd/jenkins.md index ec648519f..46ea0cb26 100644 --- a/versioned_docs/version-2.0.0/ci-cd/jenkins.md +++ b/versioned_docs/version-2.0.0/ci-cd/jenkins.md @@ -13,6 +13,7 @@ tags: - cd - plugin --- + Integrating with Jenkins | Keploy Docs diff --git a/versioned_docs/version-2.0.0/concepts/installation.md b/versioned_docs/version-2.0.0/concepts/installation.md index 486303d0c..eef71610c 100644 --- a/versioned_docs/version-2.0.0/concepts/installation.md +++ b/versioned_docs/version-2.0.0/concepts/installation.md @@ -20,6 +20,7 @@ keywords: - installation-guide - server-setup --- + Installation | Keploy Docs @@ -70,111 +71,3 @@ Use "keploy [command] --help" for more information about a command. ``` πŸŽ‰ Wohoo! You are all set to use Keploy. - -## Other Installation Methods - -
    -Install using Docker - -### Downloading and running Keploy in Docker - -#### On macOS - -Note : Keploy is not supported natively on MacOS, so you can follow the below method to run with docker - -1. Open up a terminal window. - -2. Create a bridge network in Docker using the following docker network create command: - -```bash -docker network create keploy-network -``` - -3. Run the following command to start the Keploy container: - -```bash -alias keploy="docker run --name keploy-v2 -p 16789:16789 --network keploy-network --privileged --pid=host -v $(pwd):$(pwd) -w $(pwd) -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm ghcr.io/keploy/keploy" -``` - -
    - -
    -Downloading and running Keploy in Native - -### Downloading and running Keploy in Native - -**Prequisites:** - -- Linux Kernel version 5.15 or higher -- Run `uname -a` to verify the system architecture. -- In case of Windows, use WSL with Ubuntu 20.04 LTS or higher. - -Downloading and running Keploy On WSL/Linux AMD - -#### On WSL/Linux AMD - -1. Open the terminal Session. -2. Run the following command to download and install Keploy: - -```bash -curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_amd64.tar.gz" | tar xz --overwrite -C /tmp -sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy -``` - -#### On WSL/Linux ARM - -1. Open the terminal Session -2. Run the following command to download and install Keploy: - -```bash -curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp -sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy - -``` - -> Note: Keploy is not supported on MacOS natively. - -### Setting up the Docker Desktop for WSL 2 - -1. Install Docker Desktop for Windows from [here](https://docs.docker.com/desktop/windows/install/). - -When developing on Windows with Docker Desktop and WSL 2, it's crucial to configure Docker Desktop to allow WSL 2 distributions to access the Docker daemon. This setup enables seamless integration between your Windows environment, WSL 2 Linux distros, and Docker. - -By default, Docker Desktop may not be configured to work with all WSL 2 distros out of the box. Proper configuration ensures that you can run Docker commands from within your WSL 2 environment, allowing for a more native Linux development experience while leveraging the power of Windows. - -> This setup is essential for Keploy to function correctly in a WSL 2 environment, as it needs to interact with the Docker daemon to manage containers and networks effectively. -> For detailed instructions on how to configure `Docker Desktop` for WSL 2, please refer to the [official Docker documentation](https://docs.docker.com/desktop/wsl/). - -
    - -
    -With Arkade - -### With Arkade - -1. Installing Arkade - -```bash -# Note: you can also run without `sudo` and move the binary yourself -curl -sLS https://get.arkade.dev | sudo sh - -arkade --help -ark --help # a handy alias - -# Windows users with Git Bash -curl -sLS https://get.arkade.dev | sh -``` - -2. Install Keploy - -```bash -arkade get keploy -``` - -Or you can also download specific version of Keploy using the following command: - -```bash -arkade get keploy@2.2.0-alpha23 -``` - -
    diff --git a/versioned_docs/version-2.0.0/concepts/what-are-keploy-features.md b/versioned_docs/version-2.0.0/concepts/what-are-keploy-features.md index 18c1f267c..f06271558 100644 --- a/versioned_docs/version-2.0.0/concepts/what-are-keploy-features.md +++ b/versioned_docs/version-2.0.0/concepts/what-are-keploy-features.md @@ -17,6 +17,7 @@ keywords: - record replay test - mock mutations --- + What are Keploy Features? | Keploy Docs diff --git a/versioned_docs/version-2.0.0/concepts/what-is-a-keploy-ebpf.md b/versioned_docs/version-2.0.0/concepts/what-is-a-keploy-ebpf.md index 814f14ec3..ebe5482df 100644 --- a/versioned_docs/version-2.0.0/concepts/what-is-a-keploy-ebpf.md +++ b/versioned_docs/version-2.0.0/concepts/what-is-a-keploy-ebpf.md @@ -10,6 +10,7 @@ keywords: - ebpf - Testing API --- + What is Keploy eBPF | Keploy Docs diff --git a/versioned_docs/version-2.0.0/concepts/what-is-keploy.md b/versioned_docs/version-2.0.0/concepts/what-is-keploy.md index 9546cd02b..5ad36675a 100644 --- a/versioned_docs/version-2.0.0/concepts/what-is-keploy.md +++ b/versioned_docs/version-2.0.0/concepts/what-is-keploy.md @@ -18,6 +18,7 @@ keywords: - API Tests - AI Generated Tests --- + What is Keploy? | Keploy Docs @@ -62,9 +63,3 @@ Now, when the application starts: You can test with Keploy locally or can integrate Keploy with popular testing-frameworks and existing CI pipelines. > **Note:** You can generate test cases from any environment which has all the infrastructure dependencies setup. Please consider using this to generate tests from low-traffic environments first. The deduplication feature necessary for high-traffic environments is currently experimental. - -Hope this helps you out, if you still have any questions, reach out to us . - -import GetSupport from '../concepts/support.md' - - diff --git a/versioned_docs/version-2.0.0/dependencies/http.md b/versioned_docs/version-2.0.0/dependencies/http.md index 1f0b0f606..546ddf7e2 100644 --- a/versioned_docs/version-2.0.0/dependencies/http.md +++ b/versioned_docs/version-2.0.0/dependencies/http.md @@ -3,6 +3,7 @@ id: http title: HTTP Support sidebar_label: HTTP --- + HTTP Support | Keploy Docs diff --git a/versioned_docs/version-2.0.0/dependencies/mongo.md b/versioned_docs/version-2.0.0/dependencies/mongo.md index 30b400761..121f7cfc7 100644 --- a/versioned_docs/version-2.0.0/dependencies/mongo.md +++ b/versioned_docs/version-2.0.0/dependencies/mongo.md @@ -3,6 +3,7 @@ id: mongo title: MongoDB Support sidebar_label: MongoDB Support --- + MongoDB Support | Keploy Docs diff --git a/versioned_docs/version-2.0.0/dependencies/postgresql.md b/versioned_docs/version-2.0.0/dependencies/postgresql.md index 75ed42d3c..fcb37435f 100644 --- a/versioned_docs/version-2.0.0/dependencies/postgresql.md +++ b/versioned_docs/version-2.0.0/dependencies/postgresql.md @@ -3,6 +3,7 @@ id: postgres title: PostgresSQL Support sidebar_label: PostgresSQL --- + PostgresSQL Support | Keploy Docs diff --git a/versioned_docs/version-2.0.0/dependencies/redis.md b/versioned_docs/version-2.0.0/dependencies/redis.md index 775157d98..7d8fac634 100644 --- a/versioned_docs/version-2.0.0/dependencies/redis.md +++ b/versioned_docs/version-2.0.0/dependencies/redis.md @@ -3,6 +3,7 @@ id: redis title: Redis Support sidebar_label: Redis Support --- + Redis Support | Keploy Docs diff --git a/versioned_docs/version-2.0.0/keploy-cloud/deduplication.md b/versioned_docs/version-2.0.0/keploy-cloud/deduplication.md index 4c9825566..857e2b657 100644 --- a/versioned_docs/version-2.0.0/keploy-cloud/deduplication.md +++ b/versioned_docs/version-2.0.0/keploy-cloud/deduplication.md @@ -17,6 +17,7 @@ keywords: - node - testcases --- + Remove Duplicates Tests | Keploy Docs diff --git a/versioned_docs/version-2.0.0/keploy-cloud/installation.md b/versioned_docs/version-2.0.0/keploy-cloud/installation.md index 6da4fe040..dd1054a4b 100644 --- a/versioned_docs/version-2.0.0/keploy-cloud/installation.md +++ b/versioned_docs/version-2.0.0/keploy-cloud/installation.md @@ -12,6 +12,7 @@ keywords: - installation - API key --- + Keploy Cloud Installation | Keploy Docs diff --git a/versioned_docs/version-2.0.0/keploy-cloud/keploy-console.md b/versioned_docs/version-2.0.0/keploy-cloud/keploy-console.md index b108cd103..7aba0f5ae 100644 --- a/versioned_docs/version-2.0.0/keploy-cloud/keploy-console.md +++ b/versioned_docs/version-2.0.0/keploy-cloud/keploy-console.md @@ -12,6 +12,7 @@ keywords: - installation - API key --- + Keploy Console | Keploy Docs diff --git a/versioned_docs/version-2.0.0/keploy-cloud/mock-registry.md b/versioned_docs/version-2.0.0/keploy-cloud/mock-registry.md index 6e45b12c5..f5a73caa5 100644 --- a/versioned_docs/version-2.0.0/keploy-cloud/mock-registry.md +++ b/versioned_docs/version-2.0.0/keploy-cloud/mock-registry.md @@ -12,6 +12,7 @@ keywords: - efficient testing - cloud storage --- + Mock Registry | Keploy Docs diff --git a/versioned_docs/version-2.0.0/keploy-cloud/new-application.md b/versioned_docs/version-2.0.0/keploy-cloud/new-application.md index b7ce16ba2..4cc962489 100644 --- a/versioned_docs/version-2.0.0/keploy-cloud/new-application.md +++ b/versioned_docs/version-2.0.0/keploy-cloud/new-application.md @@ -14,6 +14,7 @@ keywords: - installation - API key --- + Adding New Application to Keploy Cloud | Keploy Docs diff --git a/versioned_docs/version-2.0.0/keploy-cloud/testgeneration.md b/versioned_docs/version-2.0.0/keploy-cloud/testgeneration.md index c1e9252fc..57f0d71b5 100644 --- a/versioned_docs/version-2.0.0/keploy-cloud/testgeneration.md +++ b/versioned_docs/version-2.0.0/keploy-cloud/testgeneration.md @@ -13,6 +13,7 @@ keywords: - OpenAPI - Test Automation --- + Auto Test Generation πŸš€ | Keploy Docs diff --git a/versioned_docs/version-2.0.0/keploy-cloud/time-freezing.md b/versioned_docs/version-2.0.0/keploy-cloud/time-freezing.md index 22bb8eb5a..06985327c 100644 --- a/versioned_docs/version-2.0.0/keploy-cloud/time-freezing.md +++ b/versioned_docs/version-2.0.0/keploy-cloud/time-freezing.md @@ -13,6 +13,7 @@ keywords: - jwt - time sensitive fields --- + Time Freezing | Keploy Docs diff --git a/versioned_docs/version-2.0.0/keploy-explained/debugger-guide.md b/versioned_docs/version-2.0.0/keploy-explained/debugger-guide.md index e6f0d951c..08ba01f80 100644 --- a/versioned_docs/version-2.0.0/keploy-explained/debugger-guide.md +++ b/versioned_docs/version-2.0.0/keploy-explained/debugger-guide.md @@ -10,8 +10,6 @@ tags: # Debugger Guide πŸ‘¨β€πŸ”§ -In this blog, we will learn how to debug keploy using Visual Studio Code integrated debugger. - ## Setting Up Configuration File To bring up the **Run and Debug** view, select the **Run and Debug** icon in the **Activity Bar** on the side of VS Code. You can also use the keyboard shortcut `Cmd + Shift + D` for MacOS and `Ctrl + shift + D` for Windows. diff --git a/versioned_docs/version-2.0.0/keploy-explained/mac-linux.md b/versioned_docs/version-2.0.0/keploy-explained/mac-linux.md index 564563c83..b83429b36 100644 --- a/versioned_docs/version-2.0.0/keploy-explained/mac-linux.md +++ b/versioned_docs/version-2.0.0/keploy-explained/mac-linux.md @@ -27,10 +27,9 @@ brew install lima limactl show-ssh --format=config debian-12 & add it to its ssh config ``` -5. Open a remote window on your code editor -6. Click on connect to host -7. Now select the configured SSH as "lima-debian" -8. Once you are in the terminal run the following commands to go into your directory +5. Open a remote window on your code editor and Click on connect to host +6. Now select the configured SSH as "lima-debian" +7. Once you are in the terminal run the following commands to go into your directory ```bash cd /Users @@ -40,82 +39,33 @@ cd /Users cd /{Username} ``` -9. Run the following command to install Keploy +8. Run the following command to install Keploy ```bash curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy ``` -10. Run the following command to install Zsh - -```bash -sudo apt-get -y install zsh -``` - -**Why?** : zsh (Z Shell) is an advanced shell that offers enhanced features compared to the default bash shell. It provides better autocompletion, advanced globbing, improved history management, and more customization options. - -11. Install Git - -```bash -sudo apt-get -y install git -``` - -12. Install 'Oh-my-zsh' - -```bash -sh -c "$(wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)" -``` - -**Why?** : oh-my-zsh is a framework for managing your zsh configuration. It comes with a collection of plugins, themes, and helpful features that enhance the zsh experience. - -13. Commands to Install docker +9. Commands to Install docker ```bash sudo apt-get -y update -``` - -```bash sudo apt-get -y install ca-certificates curl -``` - -```bash sudo install -m 0755 -d /etc/apt/keyrings -``` - -```bash sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc -``` - -```bash sudo chmod a+r /etc/apt/keyrings/docker.asc -``` -```bash echo \ "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \ $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \ sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -``` - -```bash -sudo apt-get -y update -``` - -```bash -sudo apt-get -y update -``` -```bash sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin ``` -14. Add docker to sudoers +10. Add docker to sudoers ```bash sudo groupadd docker -``` - -```bash sudo gpasswd -a $USER docker ``` diff --git a/versioned_docs/version-2.0.0/keploy-explained/why-keploy.md b/versioned_docs/version-2.0.0/keploy-explained/why-keploy.md index df995a6c0..696d02d4e 100644 --- a/versioned_docs/version-2.0.0/keploy-explained/why-keploy.md +++ b/versioned_docs/version-2.0.0/keploy-explained/why-keploy.md @@ -11,6 +11,8 @@ tags: - record replay test --- +Keploy is designed to enhance your testing process by giving superpowers to developers. Whether you're looking for automated test scripting, easy CI/CD integration, or enhanced test coverage with zero effort, Keploy provides everything you need to elevate your testing workflow. + | **Feature** | **Automated Test-Scripting Tools** | **Record-Replay Traffic Tools** | **Keploy** | | ------------------------------------------ | ------------------------------------------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------- | | **Test Scripting** | Manual test script creation. | Record user traffic as tests scripts. | Automatic user traffic recording as test scripts. | diff --git a/versioned_docs/version-2.0.0/migrate/index.md b/versioned_docs/version-2.0.0/migrate/index.md index 373ec806e..613a46c62 100644 --- a/versioned_docs/version-2.0.0/migrate/index.md +++ b/versioned_docs/version-2.0.0/migrate/index.md @@ -11,4 +11,4 @@ minutes. ⏱️ - [Linux](versioned_docs/version-2.0.0/server/linux/installation.md) - [MacOS](versioned_docs/version-2.0.0/server/macos/installation.md) -⚠️ Please note that Keploy v2 is currently in development, with the best experience on Linux. Docker support is experimental and may have some limitations for certain use cases. \ No newline at end of file +⚠️ Please note that Keploy v2 is currently in development, with the best experience on Linux. Docker support is experimental and may have some limitations for certain use cases. diff --git a/versioned_docs/version-2.0.0/quickstart/csharp-dotnet-postgres.md b/versioned_docs/version-2.0.0/quickstart/csharp-dotnet-postgres.md index 02da93e20..214800c04 100644 --- a/versioned_docs/version-2.0.0/quickstart/csharp-dotnet-postgres.md +++ b/versioned_docs/version-2.0.0/quickstart/csharp-dotnet-postgres.md @@ -28,10 +28,9 @@ keyword: πŸͺ„ Dive into the world of User Authentication apps and see how seamlessly Keploy integrates with [.Net](https://dotnet.microsoft.com/en-us/) and [Postgres](https://www.postgresql.org/). Buckle up, it's gonna be a fun ride! 🎒 - ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh @@ -44,7 +43,7 @@ Or, you can follow the detailed instructions [here](https://keploy.io/docs/serve ### Clone a sample user authentication app πŸ§ͺ ```bash -git clone https://github.com/keploy/samples-csharp.git +git clone https://github.com/keploy/samples-csharp.git cd samples-csharp/crud-app # start the database instance diff --git a/versioned_docs/version-2.0.0/quickstart/express-postgresql-prisma.md b/versioned_docs/version-2.0.0/quickstart/express-postgresql-prisma.md index 9dabdf77a..a74379ca4 100644 --- a/versioned_docs/version-2.0.0/quickstart/express-postgresql-prisma.md +++ b/versioned_docs/version-2.0.0/quickstart/express-postgresql-prisma.md @@ -29,7 +29,7 @@ A sample Task Management application and see how seamlessly Keploy integrates wi ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/flask-redis.md b/versioned_docs/version-2.0.0/quickstart/flask-redis.md index 488c2dd26..b96a4ca19 100644 --- a/versioned_docs/version-2.0.0/quickstart/flask-redis.md +++ b/versioned_docs/version-2.0.0/quickstart/flask-redis.md @@ -32,7 +32,7 @@ keyword: ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/go-fasthttp-postgres.md b/versioned_docs/version-2.0.0/quickstart/go-fasthttp-postgres.md index fd608f367..104722623 100644 --- a/versioned_docs/version-2.0.0/quickstart/go-fasthttp-postgres.md +++ b/versioned_docs/version-2.0.0/quickstart/go-fasthttp-postgres.md @@ -30,7 +30,7 @@ keyword: ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/go-gin-redis.md b/versioned_docs/version-2.0.0/quickstart/go-gin-redis.md index d08dda465..a45c2cbf1 100644 --- a/versioned_docs/version-2.0.0/quickstart/go-gin-redis.md +++ b/versioned_docs/version-2.0.0/quickstart/go-gin-redis.md @@ -30,7 +30,7 @@ keyword: ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/go-mux-mysql.md b/versioned_docs/version-2.0.0/quickstart/go-mux-mysql.md index 946e0d09e..9b3b56462 100644 --- a/versioned_docs/version-2.0.0/quickstart/go-mux-mysql.md +++ b/versioned_docs/version-2.0.0/quickstart/go-mux-mysql.md @@ -31,7 +31,7 @@ A sample url shortener app to test Keploy integration capabilities using [Mux](h ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/go-mux-sql.md b/versioned_docs/version-2.0.0/quickstart/go-mux-sql.md index 15da942cc..cfa421b73 100644 --- a/versioned_docs/version-2.0.0/quickstart/go-mux-sql.md +++ b/versioned_docs/version-2.0.0/quickstart/go-mux-sql.md @@ -19,6 +19,7 @@ keyword: - API Test generator - Auto Testcase generation --- + Mux + Postgres | Keploy Docs @@ -30,7 +31,7 @@ keyword: ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/java-spring-boot-mongo.md b/versioned_docs/version-2.0.0/quickstart/java-spring-boot-mongo.md index 24b93123c..2fe6b3c37 100644 --- a/versioned_docs/version-2.0.0/quickstart/java-spring-boot-mongo.md +++ b/versioned_docs/version-2.0.0/quickstart/java-spring-boot-mongo.md @@ -23,6 +23,7 @@ keyword: - Auto Testcase generation - Junit --- + Spring-Boot + MongoDB | Keploy Docs @@ -34,7 +35,7 @@ keyword: ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh @@ -42,7 +43,6 @@ Get Started with One-Click Command: - Or, you can follow the detailed instructions [here](https://keploy.io/docs/server/installation/). - ## Pre-Requisite πŸ› οΈ - JDK and add JAVA_HOME in environment variable. diff --git a/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md b/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md index f95bb05c5..db230a4cd 100644 --- a/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md +++ b/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md @@ -24,6 +24,7 @@ keyword: - Test PetClinic - Junit --- + Keploy with PetClinic | Keploy Docs @@ -35,7 +36,7 @@ import Link from '@docusaurus/Link' ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/nextjs-postgres.md b/versioned_docs/version-2.0.0/quickstart/nextjs-postgres.md index 5f257a912..50460d4b8 100644 --- a/versioned_docs/version-2.0.0/quickstart/nextjs-postgres.md +++ b/versioned_docs/version-2.0.0/quickstart/nextjs-postgres.md @@ -24,7 +24,7 @@ This is a sample app to test Keploy integration capabilities using NextJS and Po ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/node-express-mongoose.md b/versioned_docs/version-2.0.0/quickstart/node-express-mongoose.md index e3bdbc87c..80f405b3e 100644 --- a/versioned_docs/version-2.0.0/quickstart/node-express-mongoose.md +++ b/versioned_docs/version-2.0.0/quickstart/node-express-mongoose.md @@ -1,6 +1,6 @@ --- id: samples-nodejs -title: NodeJS + MongoDB +title: NodeJS + MongoDB sidebar_label: NodeJS - Express + Mongoose description: The following sample app showcases how to use NodeJS framework and the Keploy Platform. tags: @@ -28,7 +28,7 @@ A simple sample CRUD application and see how seamlessly Keploy integrates with [ ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/node-jwt-sql.md b/versioned_docs/version-2.0.0/quickstart/node-jwt-sql.md index 9f631fa3b..9382f0e6d 100644 --- a/versioned_docs/version-2.0.0/quickstart/node-jwt-sql.md +++ b/versioned_docs/version-2.0.0/quickstart/node-jwt-sql.md @@ -28,7 +28,7 @@ A simple sample CRUD application to test using Keploy build with Node, JWT and P ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/python-django-sql.md b/versioned_docs/version-2.0.0/quickstart/python-django-sql.md index d449ffd26..6b97c450f 100644 --- a/versioned_docs/version-2.0.0/quickstart/python-django-sql.md +++ b/versioned_docs/version-2.0.0/quickstart/python-django-sql.md @@ -31,11 +31,12 @@ keyword: ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh ``` + Or, you can follow the detailed instructions [here](https://keploy.io/docs/server/installation/). ## Get Started! 🎬 diff --git a/versioned_docs/version-2.0.0/quickstart/python-fastapi-sql.md b/versioned_docs/version-2.0.0/quickstart/python-fastapi-sql.md index 3c57b1852..1640bd75d 100644 --- a/versioned_docs/version-2.0.0/quickstart/python-fastapi-sql.md +++ b/versioned_docs/version-2.0.0/quickstart/python-fastapi-sql.md @@ -20,6 +20,7 @@ keyword: - API Test generator - Auto case generation --- + FastAPI + Postgres | Keploy Docs @@ -31,7 +32,7 @@ keyword: ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh @@ -62,6 +63,10 @@ We will be using Docker compose to run the application as well as Postgres on Do ### Lights, Camera, Record! πŸŽ₯ +Since we have setup our sample-app with docker, we need to update the container name to postgres on line 6, in `application/database.py`, from `postgresql://postgres:postgres@localhost:5432/studentdb` to `postgresql://postgres:postgres@postgres:5432/studentdb`.\*\* + +> **Also, we need to update the container name to postgres on line 11, of `application/main.py`, from `postgresql://postgres:postgres@localhost:5432/studentdb` to `postgresql://postgres:postgres@postgres:5432/studentdb`.** + Capture the test-cases- ```shell @@ -238,6 +243,12 @@ We'll be running our sample application right on Linux, but just to make things ### πŸ“Ό Roll the Tape - Recording Time! +Start the database on Docker: + +```bash +docker compose up -d postgres +``` + Ready, set, record! Here's how: ```bash diff --git a/versioned_docs/version-2.0.0/quickstart/python-fastapi-twilio.md b/versioned_docs/version-2.0.0/quickstart/python-fastapi-twilio.md index 1a7ff9283..8f1876055 100644 --- a/versioned_docs/version-2.0.0/quickstart/python-fastapi-twilio.md +++ b/versioned_docs/version-2.0.0/quickstart/python-fastapi-twilio.md @@ -22,6 +22,7 @@ keyword: - API Test generator - Auto case generation --- + FastAPI + Twilio | Keploy Docs @@ -33,7 +34,7 @@ keyword: ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/python-flask-mongo.md b/versioned_docs/version-2.0.0/quickstart/python-flask-mongo.md index 6d27a6801..9096444dd 100644 --- a/versioned_docs/version-2.0.0/quickstart/python-flask-mongo.md +++ b/versioned_docs/version-2.0.0/quickstart/python-flask-mongo.md @@ -20,6 +20,7 @@ keyword: - API Test generator - Auto case generation --- + Flask + Mongo | Keploy Docs @@ -31,7 +32,7 @@ keyword: ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/rust-wrap-mongo.md b/versioned_docs/version-2.0.0/quickstart/rust-wrap-mongo.md index 4b8911e5e..4e14b7b7e 100644 --- a/versioned_docs/version-2.0.0/quickstart/rust-wrap-mongo.md +++ b/versioned_docs/version-2.0.0/quickstart/rust-wrap-mongo.md @@ -12,6 +12,7 @@ keyword: - API Test generator - Auto Testcase generation --- + Warp + Mongo | Keploy Docs @@ -23,7 +24,7 @@ This is a sample app to test Keploy integration capabilities using rust and Mong ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/sample-rust-crud-mongo.md b/versioned_docs/version-2.0.0/quickstart/sample-rust-crud-mongo.md index 5f7b2ea98..d561aaf8e 100644 --- a/versioned_docs/version-2.0.0/quickstart/sample-rust-crud-mongo.md +++ b/versioned_docs/version-2.0.0/quickstart/sample-rust-crud-mongo.md @@ -27,7 +27,7 @@ This is a sample CRUD REST API application to showcase Keploy integration capabi ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh @@ -35,7 +35,6 @@ Get Started with One-Click Command: - Or, you can follow the detailed instructions [here](https://keploy.io/docs/server/installation/). - ## Get Started! 🎬 ### Setup app diff --git a/versioned_docs/version-2.0.0/quickstart/sample-ts.md b/versioned_docs/version-2.0.0/quickstart/sample-ts.md index 1fa626672..c782297fd 100644 --- a/versioned_docs/version-2.0.0/quickstart/sample-ts.md +++ b/versioned_docs/version-2.0.0/quickstart/sample-ts.md @@ -24,7 +24,7 @@ This is a sample app to test Keploy integration capabilities using Typescript an ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh @@ -32,7 +32,6 @@ Get Started with One-Click Command: - Or, you can follow the detailed instructions [here](https://keploy.io/docs/server/installation/). - ## Get Started! 🎬 ### Setup app diff --git a/versioned_docs/version-2.0.0/quickstart/samples-bunjs.md b/versioned_docs/version-2.0.0/quickstart/samples-bunjs.md index 03a30c6ed..75af21734 100644 --- a/versioned_docs/version-2.0.0/quickstart/samples-bunjs.md +++ b/versioned_docs/version-2.0.0/quickstart/samples-bunjs.md @@ -32,7 +32,7 @@ This is a sample app to test Keploy integration capabilities using [Bun.js](http ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/samples-echo.md b/versioned_docs/version-2.0.0/quickstart/samples-echo.md index 0a0811aa1..e1d0a34ec 100644 --- a/versioned_docs/version-2.0.0/quickstart/samples-echo.md +++ b/versioned_docs/version-2.0.0/quickstart/samples-echo.md @@ -30,7 +30,7 @@ A sample url shortener app to test Keploy integration capabilities using [Echo]( ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/samples-express-mongoose.md b/versioned_docs/version-2.0.0/quickstart/samples-express-mongoose.md index c7c6fea47..a86e15954 100644 --- a/versioned_docs/version-2.0.0/quickstart/samples-express-mongoose.md +++ b/versioned_docs/version-2.0.0/quickstart/samples-express-mongoose.md @@ -28,7 +28,7 @@ A simple sample CRUD application and see how seamlessly Keploy integrates with [ ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/samples-go-gin-mongo.md b/versioned_docs/version-2.0.0/quickstart/samples-go-gin-mongo.md index 130d93977..b1bfb298d 100644 --- a/versioned_docs/version-2.0.0/quickstart/samples-go-gin-mongo.md +++ b/versioned_docs/version-2.0.0/quickstart/samples-go-gin-mongo.md @@ -30,7 +30,7 @@ keyword: ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/samples-go-sse-svelte.md b/versioned_docs/version-2.0.0/quickstart/samples-go-sse-svelte.md index 4dd2e5d3d..020ac77ae 100644 --- a/versioned_docs/version-2.0.0/quickstart/samples-go-sse-svelte.md +++ b/versioned_docs/version-2.0.0/quickstart/samples-go-sse-svelte.md @@ -30,7 +30,7 @@ keyword: ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/samples-java.md b/versioned_docs/version-2.0.0/quickstart/samples-java.md index 1841d16a7..4889fc577 100644 --- a/versioned_docs/version-2.0.0/quickstart/samples-java.md +++ b/versioned_docs/version-2.0.0/quickstart/samples-java.md @@ -38,7 +38,7 @@ and **PostgreSQL**. ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh @@ -46,7 +46,6 @@ Get Started with One-Click Command: - Or, you can follow the detailed instructions [here](https://keploy.io/docs/server/installation/). - ## Setup Employee-Manager App ### Application Pre-Requisites πŸ“‹ diff --git a/versioned_docs/version-2.0.0/quickstart/samples-node-mongo.md b/versioned_docs/version-2.0.0/quickstart/samples-node-mongo.md index 4f9e80955..8b9c2633e 100644 --- a/versioned_docs/version-2.0.0/quickstart/samples-node-mongo.md +++ b/versioned_docs/version-2.0.0/quickstart/samples-node-mongo.md @@ -20,6 +20,7 @@ keyword: - API Test generator - Auto Testcase generation --- + NodeJS - Express + Mongoose | Keploy Docs @@ -31,7 +32,7 @@ A sample **_CRUD_** application to see how Keploy integrates effortlessly with * ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/quickstart/samples-rust.md b/versioned_docs/version-2.0.0/quickstart/samples-rust.md index 64a28c3e6..0d0b8d783 100644 --- a/versioned_docs/version-2.0.0/quickstart/samples-rust.md +++ b/versioned_docs/version-2.0.0/quickstart/samples-rust.md @@ -14,6 +14,7 @@ keyword: - API Test generator - Auto Testcase generation --- + Rust + Mongo (GraphQL) | Keploy Docs @@ -25,7 +26,7 @@ This is a sample app to test Keploy integration capabilities using rust and Mong ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh @@ -33,7 +34,6 @@ Get Started with One-Click Command: - Or, you can follow the detailed instructions [here](https://keploy.io/docs/server/installation/). πŸŽ‰ Wohoo! We are all set to use Keploy. - ## Get Started! 🎬 ## Setup app diff --git a/versioned_docs/version-2.0.0/quickstart/sanic-mongo.md b/versioned_docs/version-2.0.0/quickstart/sanic-mongo.md index d1ef31921..7ef32f296 100644 --- a/versioned_docs/version-2.0.0/quickstart/sanic-mongo.md +++ b/versioned_docs/version-2.0.0/quickstart/sanic-mongo.md @@ -34,7 +34,7 @@ This application is a simple movie management API built using Python's [Sanic fr ## Install Keploy CLI πŸš€ -Get Started with One-Click Command: - +Get Started with One-Click Command: - ```bash curl -O -L https://keploy.io/install.sh && source install.sh diff --git a/versioned_docs/version-2.0.0/running-keploy/cli-commands.md b/versioned_docs/version-2.0.0/running-keploy/cli-commands.md index d13971160..094fe357e 100755 --- a/versioned_docs/version-2.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-2.0.0/running-keploy/cli-commands.md @@ -13,6 +13,7 @@ keywords: - keploy running guide - keploy oss --- + CLI Commands | Keploy Docs @@ -30,14 +31,14 @@ You can use `--help, -h` flag for all the commands to see available flag options Here are some examples of how to use some common flags: -| Mode | Flags Available| -| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `record` | `-a, --app-id`,`--app-name`,`-b, --build-delay`,`--cmd-type`,`-c, --command`,`--config-path`, `--containerName`, `--dns-port`,`--in-ci`,`-n, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `--record-timer`,`--debug`| +| Mode | Flags Available | +| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `record` | `-a, --app-id`,`--app-name`,`-b, --build-delay`,`--cmd-type`,`-c, --command`,`--config-path`, `--containerName`, `--dns-port`,`--in-ci`,`-n, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `--record-timer`,`--debug` | | `test` | `--apiTimeout`,`-a, --app-id`,`--app-name`,`-b, --build-delay`,`--cmd-type`,`-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `--disable-line-coverage`, `--disableMockUpload `,`--dns-port`, `--fallBack-on-miss`,`--host`, `--mocking`, `--mongoPassword`, `-n, --net, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `-t, --testsets`, `--debug`, `-g, --generateTestReport`, `--removeUnusedMocks`, `--ignoreOrdering`, `--skip-preview`, `--update-temp`, `--useLocalMock` | -| `gen` | `--sourceFilePath`, `--testFilePath`,`--coverageReportPath`,`--testCommand`,`--coverageFormat`,`--expectedCoverage`,`--maxIterations`,`--testDir`,`--llmBaseUrl`,`--model`,`--llmApiVersion`| -| `normailze` | `-p, --path`, `--test-run`, `--tests`| -| `rerecord` | `--test-sets`, `-t`| -| `config` | `--generate`,`-p, --path`| +| `gen` | `--sourceFilePath`, `--testFilePath`,`--coverageReportPath`,`--testCommand`,`--coverageFormat`,`--expectedCoverage`,`--maxIterations`,`--testDir`,`--llmBaseUrl`,`--model`,`--llmApiVersion` | +| `normailze` | `-p, --path`, `--test-run`, `--tests` | +| `rerecord` | `--test-sets`, `-t` | +| `config` | `--generate`,`-p, --path` | ### [Record](#Record) @@ -72,9 +73,11 @@ keploy record [flags] ```bash keploy record -c "node src/app.js" --config-path "./config-dir/" ``` + In the above command, `config-dir` is the directory in the CWD where the Keploy configuration file `keploy.yml` is stored. - `--container-name string` - Name of the docker container in which the user application is running. + ```bash keploy record -c "docker compose up" --container-name "my-app-container" ``` @@ -98,6 +101,7 @@ keploy record [flags] ```bash keploy record -c "node src/app.js" -p "./tests" ``` + Where `tests` is the directory with the recorded testcases and generated mocks are to be stored. - `--proxy-port uint32` - Port to choose to run Keploy as a proxy. The default is 16789. @@ -235,6 +239,7 @@ keploy test [flags] ```bash keploy test -c "node src/app.js" --delay 10 --remove-unused-mocks ``` + - `--update-temp` - Update the template with the result of the testcases. - `--useLocalMock` - Use local mocks instead of fetching from the cloud diff --git a/versioned_docs/version-2.0.0/running-keploy/docker-tls.md b/versioned_docs/version-2.0.0/running-keploy/docker-tls.md index b27ed07ba..b92fb6e56 100644 --- a/versioned_docs/version-2.0.0/running-keploy/docker-tls.md +++ b/versioned_docs/version-2.0.0/running-keploy/docker-tls.md @@ -19,15 +19,17 @@ keywords: ## Prerequisites + Before proceeding, ensure the following prerequisites are met: ### Docker Compose Setup: + - Add the `` under your application service in your docker-compose.yml file. Example. - Ensure all containers are on the same network. ### Docker Run Setup: -- When using the docker run command, include the --network flag to specify a custom network name. +- When using the docker run command, include the --network flag to specify a custom network name. ## Recording Testcases and Data Mocks diff --git a/versioned_docs/version-2.0.0/running-keploy/rename-testcases.md b/versioned_docs/version-2.0.0/running-keploy/rename-testcases.md index 9a256e682..4a3693b00 100644 --- a/versioned_docs/version-2.0.0/running-keploy/rename-testcases.md +++ b/versioned_docs/version-2.0.0/running-keploy/rename-testcases.md @@ -12,6 +12,7 @@ keywords: - rename - testsets --- + How to Rename Test-names? | Keploy Docs diff --git a/versioned_docs/version-2.0.0/running-keploy/unit-test-generator.md b/versioned_docs/version-2.0.0/running-keploy/unit-test-generator.md index ee08876d4..cf7efa347 100644 --- a/versioned_docs/version-2.0.0/running-keploy/unit-test-generator.md +++ b/versioned_docs/version-2.0.0/running-keploy/unit-test-generator.md @@ -1,13 +1,14 @@ --- id: unit-test-generator -title: Unit Testing with Keploy -sidebar_label: Unit Test Generator +title: Keploy Unit Testing Agent +sidebar_label: Unit Testing description: This section documents usecase of Keploy's Unit Test Generator tags: - utg - unit test generator - generate unit test - unit test + - unit testing keywords: - unit test generator - unit testing @@ -17,10 +18,13 @@ keywords: - AI testing - Gemini - OpenAI + - testing agent + - unit testing agent + - opensource testing agent --- - Unit Test Generator | Keploy Docs + Unit Testing Agent | Keploy Docs @@ -158,9 +162,10 @@ _Voila!! The Generated Testcases have provided with 71% coverage in just 2 itera ## Generate Unit Tests with VS Code Extension -The [Keploy VS Code extension](https://marketplace.visualstudio.com/items?itemName=Keploy.keployio) simplifies unit test generation by allowing users to create tests directly within their editor, eliminating the need for CLI commands or API key setup. With just a right-click on any source file, the extension auto-detects the necessary parameters and generates unit tests seamlessly. It integrates effortlessly into your workflow, saving generated test cases to the appropriate files and providing coverage reports within VS Code itself. +The [Keploy VS Code extension](https://marketplace.visualstudio.com/items?itemName=Keploy.keployio) simplifies unit test generation by allowing users to create tests directly within their editor, eliminating the need for CLI commands or API key setup. With just a right-click on any source file, the extension auto-detects the necessary parameters and generates unit tests seamlessly. It integrates effortlessly into your workflow, saving generated test cases to the appropriate files and providing coverage reports within VS Code itself. + +For example, in the [express-mongoose](https://github.com/keploy/samples-typescript/tree/main/express-mongoose) sample app: -For example, in the [express-mongoose](https://github.com/keploy/samples-typescript/tree/main/express-mongoose) sample app: 1. You can open `routes.js`, right-click, and select **Generate Unit Tests with Keploy** to instantly generate tests for `test/routes.test.js`. 2. The extension makes unit testing faster, easier, and more accessible for developers. diff --git a/versioned_docs/version-2.0.0/server/installation.md b/versioned_docs/version-2.0.0/server/installation.md index 7d737280c..3356957d2 100644 --- a/versioned_docs/version-2.0.0/server/installation.md +++ b/versioned_docs/version-2.0.0/server/installation.md @@ -55,4 +55,31 @@ To run the testcases and see if there are any regressions introduced, use this t keploy test -c "CMD_TO_RUN_APP" --delay 10 ``` +## Install Keploy via Arkade + +1. Installing Arkade + +```bash +# Note: you can also run without `sudo` and move the binary yourself +curl -sLS https://get.arkade.dev | sudo sh + +arkade --help +ark --help # a handy alias + +# Windows users with Git Bash +curl -sLS https://get.arkade.dev | sh +``` + +2. Install Keploy + +```bash +arkade get keploy +``` + +Or you can also download specific version of Keploy using the following command: + +```bash +arkade get keploy@2.3.0-beta47 +``` + Explore the [Test Coverage Generation Guide](https://keploy.io/docs/server/sdk-installation/go/) for seeing test-coverage with your unit testing library and [Keploy Running Guide](https://keploy.io/docs/running-keploy/configuration-file/) for additional options and tips on customizing your Keploy setup to perfection. diff --git a/versioned_sidebars/version-2.0.0-sidebars.json b/versioned_sidebars/version-2.0.0-sidebars.json index 01e001530..a65023772 100644 --- a/versioned_sidebars/version-2.0.0-sidebars.json +++ b/versioned_sidebars/version-2.0.0-sidebars.json @@ -2,7 +2,7 @@ "sidebarExplanation": [ { "type": "category", - "label": "Explanation", + "label": "Learn about Keploy", "collapsible": true, "collapsed": true, "items": [ @@ -17,13 +17,9 @@ "id": "server/installation" }, { - "type": "category", + "type": "doc", "label": "Unit Testing", - "collapsible": true, - "collapsed": false, - "items": [ - "running-keploy/unit-test-generator" - ] + "id": "running-keploy/unit-test-generator" }, { "type": "category", @@ -123,7 +119,18 @@ "items": ["quickstart/samples-csharp"] } ] - }, + }, + { + "type": "category", + "label": "CI/CD", + "collapsible": true, + "collapsed": false, + "items": [ + "ci-cd/github", + "ci-cd/gitlab", + "ci-cd/jenkins" + ] + }, { "type": "category", "label": "Dependencies", @@ -140,25 +147,23 @@ }, { "type": "category", - "label": "CI/CD Integrations", + "label": "Code Coverage", "collapsible": true, - "collapsed": false, + "collapsed": true, "items": [ - "ci-cd/github", - "ci-cd/gitlab", - "ci-cd/jenkins" + "server/sdk-installation/go", + "server/sdk-installation/java", + "server/sdk-installation/javascript", + "server/sdk-installation/python" ] }, { "type": "category", - "label": "Code Coverage", + "label": "Troubleshooting", "collapsible": true, "collapsed": true, "items": [ - "server/sdk-installation/go", - "server/sdk-installation/java", - "server/sdk-installation/javascript", - "server/sdk-installation/python" + "keploy-explained/faq" ] } ], @@ -183,10 +188,10 @@ "collapsible": true, "items": [ "keploy-cloud/cloud-installation", + "keploy-cloud/auto-test-generation", "keploy-cloud/time-freezing", "keploy-cloud/mock-registry", "keploy-cloud/keploy-console", - "keploy-cloud/auto-test-generation", "keploy-cloud/deduplication" ] }