Skip to content

Commit

Permalink
feat: based on feedback iteration 2
Browse files Browse the repository at this point in the history
Signed-off-by: Animesh Pathak <[email protected]>
  • Loading branch information
Sonichigo committed Jan 2, 2025
1 parent be5f389 commit 420f280
Show file tree
Hide file tree
Showing 15 changed files with 169 additions and 253 deletions.
7 changes: 4 additions & 3 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ module.exports = {
{
to: "/keploy-cloud/cloud-installation",
label: "Enterprise",
activeBasePath: "none",
},
{
label: "Resources",
Expand All @@ -151,8 +152,8 @@ module.exports = {
href: '/keploy-explained/contribution-guide',
},
{
label: 'FAQ',
href:'/keploy-explained/faq/',
label: 'Glossary',
href:'/concepts/reference/glossary/',
},
]
},
Expand All @@ -168,7 +169,7 @@ module.exports = {
"aria-label": "GitHub repository",
},
{
href: "https://app.keploy.io",
href: "https://app.keploy.io/pricing",
position: "right",
label: 'Pricing'
},
Expand Down
2 changes: 1 addition & 1 deletion src/components/Community.js
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ export const Community = () => {
<svg
fill="currentColor"
className="h-12 w-12 flex-none text-black"
viewBox="0 0 48 48"
viewBox="0 0 512 509.64"
>
<rect width="509.64" height="512" rx="120" />
<path
Expand Down
12 changes: 6 additions & 6 deletions src/components/Intro.js
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ function Frameworks() {
data-tooltip="MongoDB"
>
<img
className="h-8 w-8"
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/mongodb-logo.svg"
alt="Docker logo"
/>
Expand All @@ -156,7 +156,7 @@ function Frameworks() {
data-tooltip="HTTP"
>
<img
className="h-8 w-8"
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/http-logo.svg"
alt="HTTP logo"
/>
Expand All @@ -169,7 +169,7 @@ function Frameworks() {
data-tooltip="PostgreSQL"
>
<img
className="h-8 w-8"
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/postgres-logo.svg"
alt="PostgresSQL logo"
/>
Expand All @@ -182,7 +182,7 @@ function Frameworks() {
data-tooltip="Redis"
>
<img
className="h-8 w-8"
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/redis-logo.svg"
alt="Redis logo"
/>
Expand All @@ -194,7 +194,7 @@ function Frameworks() {
data-tooltip="MySQL"
>
<img
className="h-8 w-8"
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/mysql-logo.svg"
alt="MySQL logo"
/>
Expand All @@ -206,7 +206,7 @@ function Frameworks() {
data-tooltip="DynamoDB"
>
<img
className="h-8 w-8"
className="h-8 w-8 transition hover:scale-110"
src="/docs/img/dynamodb-logo.svg"
alt="DynamoDB logo"
/>
Expand Down
2 changes: 1 addition & 1 deletion src/components/KeployCloud.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

108 changes: 61 additions & 47 deletions src/components/Product.js

Large diffs are not rendered by default.

19 changes: 18 additions & 1 deletion src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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");
Expand Down
110 changes: 1 addition & 109 deletions versioned_docs/version-2.0.0/concepts/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,112 +69,4 @@ Flags:
Use "keploy [command] --help" for more information about a command.
```

🎉 Wohoo! You are all set to use Keploy.

## Other Installation Methods

<details>
<summary>Install using Docker</summary>

### 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"
```

</details>

<details>
<summary>Downloading and running Keploy in Native</summary>

### 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.

<summary>Downloading and running Keploy On WSL/Linux AMD</summary>

#### 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/).
</details>

<details>
<summary>With Arkade</summary>

### 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 [email protected]
```

</details>
🎉 Wohoo! You are all set to use Keploy.
5 changes: 0 additions & 5 deletions versioned_docs/version-2.0.0/concepts/what-is-keploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,3 @@ You can test with Keploy locally or can integrate Keploy with popular testing-fr

> **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'

<GetSupport/>
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
62 changes: 6 additions & 56 deletions versioned_docs/version-2.0.0/keploy-explained/mac-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
2 changes: 2 additions & 0 deletions versioned_docs/version-2.0.0/keploy-explained/why-keploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
10 changes: 10 additions & 0 deletions versioned_docs/version-2.0.0/quickstart/python-fastapi-sql.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,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
Expand Down Expand Up @@ -238,6 +242,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
Expand Down
Loading

0 comments on commit 420f280

Please sign in to comment.