Skip to content

Commit

Permalink
ci: add prettify code ci workflow (keploy#206)
Browse files Browse the repository at this point in the history
Signed-off-by: Akash Kumar <meakash7902@gmail.com>
Signed-off-by: schauhan2 <swati_chauhan@intuit.com>
  • Loading branch information
AkashKumar7902 authored and swatichauhan814 committed Oct 7, 2023
1 parent b924bda commit 77baab5
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 17 deletions.
2 changes: 0 additions & 2 deletions versioned_docs/version-1.0.0/devtools/sdk-contrib-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ keywords:
- Java
---


### HLD for Java SDK

The following contains the HLD for Java SDK demonstrating all important components:
Expand All @@ -21,7 +20,6 @@ The following contains the HLD for Java SDK demonstrating all important componen

![Test Mode](https://user-images.githubusercontent.com/50234097/222137583-d6eda9fa-3903-4222-9a23-faf24a089e06.png)


We held a session explaining every core-concept of Keploy-SDK

import { ResponsivePlayer } from '../../../src/components'
Expand Down
4 changes: 3 additions & 1 deletion versioned_docs/version-1.0.0/go/quickstart/gin-mongo.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ keywords:
- golang gin
---

# URL Shortener Sample App
# URL Shortener Sample App

A sample url shortener app to test Keploy integration capabilities using [Gin](https://gin-gonic.com) and [mongoDB](https://www.mongodb.com/).

Expand All @@ -34,7 +34,9 @@ go mod download
```bash
export KEPLOY_MODE=record
```

### Start the MongoDB server

```bash
docker container run -it -p27017:27017 mongo
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -204,9 +204,11 @@ Testrun passed for testcase with id: "test-1"


```

</details>

---

### Make a code change

Now try changing something like commenting line numbers 115 and 116 and uncommenting line 119 in `main.go` and running ` go test -coverpkg=./... -covermode=atomic ./...` again
Expand Down
1 change: 0 additions & 1 deletion versioned_docs/version-1.0.0/java/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ tags:

</details>


## Build configuration

1. [Find the latest release](https://search.maven.org/artifact/io.keploy/keploy-sdk) of the Keploy Java SDK at maven
Expand Down
7 changes: 3 additions & 4 deletions versioned_docs/version-1.0.0/operation/record.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,16 @@ tags:

> Note that Testcases are exported as files in the project directory by default

To record API calls as test cases set `KEPLOY_MODE` environment variable to `record`.

```
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.
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.
> > KTest directory path (`KEPLOY_TEST_PATH`) is configurable.
![Record Tests and Mocks](/gif/record-tc.gif "Record Tests and Mocks")

>> KMock directory path (`KEPLOY_MOCK_PATH`) is configurable.
> > KMock directory path (`KEPLOY_MOCK_PATH`) is configurable.
13 changes: 6 additions & 7 deletions versioned_docs/version-1.0.0/operation/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,22 @@ tags:
- replay-tests
---

To run KTests and KMocks you can follow any one of these methods:

### Method 1
To run KTests and KMocks you can follow any one of these methods:

### Method 1

<details><summary>
Set Environment Variable `KEPLOY_MODE`

</summary>

```
export KEPLOY_MODE="test"
export KEPLOY_MODE="test"
```

Run application and find test report summary on the Keploy Server Logs and detailed test report
in directory where Keploy Server is running.
Run application and find test report summary on the Keploy Server Logs and detailed test report
in directory where Keploy Server is running.

![Test report summary](/gif/replay-tc.gif)

</details>
</details>
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: what-are-keploy-features
title: Keploy Features
title: Keploy Features
sidebar_label: Keploy Features
description: Keploy platform automatically mocks application dependencies and safely replay writes. It does accurate noise detection and statistical de-duplication.
tags:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: what-is-keploy-ebpf
title: What is Keploy eBPF
title: What is Keploy eBPF
sidebar_label: Keploy eBPF
description: Keploy eBPF is a language-agnostic library that captures and replays API calls and subsequent network interactions.
tags:
Expand Down
1 change: 1 addition & 0 deletions versioned_docs/version-2.0.0/quickstart/samples-gin.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ docker network create keploy-network
```

Then, create an alias for Keploy:

```bash
alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --network keploy-network --privileged --pid=host -it -v "$(pwd)":/files -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''
```
Expand Down

0 comments on commit 77baab5

Please sign in to comment.