+ +
+
Installation
++
+
+
+
+
+ Start Keploy Server
++
+
+ git clone https://github.com/keploy/keploy.git && cd keploy
+
+ docker-compose up
+
+
+ The UI can be accessed at http://localhost:8081
++
Helm Chart
+Keploy can also be installed to your Kubernetes cluster using the Helm chart available here
++
Run Sample application
+
+
+
+
+
+
+ +
Demos using Echo/PostgreSQL and Gin/MongoDB are available here. For this example, we will use the Echo/PostgreSQL sample.
+
+
+ git clone https://github.com/keploy/samples-go && cd samples-go/echo-sql
+
+ go mod download
+
+
+ +
Start PostgreSQL instance
+
+
+ docker-compose up -d
+
+
+ +
Run the application
+
+
+ go run handler.go main.go
+
+
+ +
+
Generate testcases
+
+
+
+
+
+
+
+
+
+
+
+ +
+ +
+
To genereate testcases we just need to make some API calls. You can use Postman,Hoppscotch, or simply curl
++
1. Generate shortned url
++
+
+ {`curl --request POST`} \{`\n`}
+ {`--url http://localhost:8080/url`} \{`\n`}
+ {`--header 'content-type: application/json'`} \{`\n`}
+ {`--data `}'{`{\n`}
+ {` `}"url :" "https://github.com"{`\n`}
+ {`}`}'
+
+
+ +
2. Redirect to original url from shortened url
++
+
+ {`curl --request GET`} \{`\n`}
+ {` `}--url http://localhost:8080/GuwHCgoQ
+
+
+ +
+
Integration with native Go test framework
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+ +
+
You just need 3 lines of code in your unit test file and that's it!!🔥🔥🔥
++
+
+ {`import (\n`}
+ {` `}{`github.com/keploy/go-sdk/keploy\n`}
+ {` `}{`testing\n`}
+ {`)\n`}
+ {`func TestKeploy(t *testing.T) {\n`}
+ {` `}{`keploy.SetTestMode()\n`}
+ {` `}{`go main()\n`}
+ {` `}{`keploy.AssertTests(t)\n`}
+ {`}`}
+
+
+ +
Run the testcases
++
Note: Before running tests stop the sample application
++
+
+ go test -coverpkg=./... -covermode=atomic ./...
+
+
+ +
this should show you have 74.4% coverage without writing any code!
++
+
+ ok echo-psql-url-shortener 5.820s coverage: 74.4% of statements in ./...
+
+
+ +
All of these can be visualised here - http://localhost:8081/testlist
+