Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keploy/java-sdk
Official Keploy Java SDK 🔴
https://github.com/keploy/java-sdk
api-testing hacktoberfest-2023 java junit-testing keploy mock-data mocking mockito-alternative no-code springboot stub-backend stubbing test-automation testing testing-tools unit-testing
Last synced: 2 months ago
JSON representation
Official Keploy Java SDK 🔴
- Host: GitHub
- URL: https://github.com/keploy/java-sdk
- Owner: keploy
- License: apache-2.0
- Created: 2022-04-10T09:40:06.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-26T07:24:37.000Z (5 months ago)
- Last Synced: 2024-08-26T09:21:52.821Z (5 months ago)
- Topics: api-testing, hacktoberfest-2023, java, junit-testing, keploy, mock-data, mocking, mockito-alternative, no-code, springboot, stub-backend, stubbing, test-automation, testing, testing-tools, unit-testing
- Language: Java
- Homepage: https://docs.keploy.io/
- Size: 1.71 MB
- Stars: 26
- Watchers: 4
- Forks: 19
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](CODE_OF_CONDUCT.md)
[](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA)
[](https://opensource.org/licenses/Apache-2.0)
[](https://search.maven.org/search?q=g:%22io.keploy%22%20AND%20a:%22keploy-sdk%22)
[//]: # ([](https://search.maven.org/search?q=g:%22io.keploy%22%20AND%20a:%22keploy-sdk%22%20AND%20v:%221.2.6%22))
# Keploy
[Keploy](https://keploy.io) is a no-code testing platform that generates tests from API calls.
This is the client SDK for Keploy API testing platform. There are 2 modes:
1. **Record mode**
1. Record requests, response and all external calls and sends to Keploy server.
2. It runs the request on the API again to identify noisy fields.
3. Sends the noisy fields to the keploy server to be saved along with the testcase.
2. **Test mode**
1. Fetches testcases for the app from keploy server.
2. Calls the API with same request payload in testcase.
3. Validates the respones and uploads results to the keploy server
The Keploy Java SDK helps you to integrate keploy with java applications. (For other languages,
see [KEPLOY SDKs](https://docs.keploy.io/application-development))
## Contents
1. [Requirements](#requirements)
2. [Build configuration](#build-configuration)
3. [Usage](#usage)
4. [Community support](#community-support)
5. [Documentation(WIP)](#documentationwip)
## Requirements
- Java 1.8+
## Build configuration
[Find the latest release](https://search.maven.org/artifact/io.keploy/keploy-sdk) of the Keploy Java SDK at maven
central.
Add *keploy-sdk* as a dependency to your *pom.xml*:
io.keploy
keploy-sdk
N.N.N (eg: 1.2.9)
or to *build.gradle*:
implementation 'io.keploy:keploy-sdk:N.N.N' (eg: 1.2.9)
### KEPLOY_MODE
There are 3 modes:
- **Record**: Sets to record mode.
- **Test**: Sets to test mode.
- **Off**: Turns off all the functionality provided by the API
**Note:** `KEPLOY_MODE` value is case sensitive.
## Usage
- **Start keploy server [refer](https://github.com/keploy/keploy#start-keploy-server)**
- **For Spring based application**
- Add `@Import(KeployMiddleware.class)` below `@SpringBootApplication` in your main class.
- **For Java EE application**
- Specify the below filter above all other filters and servlets in the **web.xml** file.
```xml
middleware
io.keploy.servlet.KeployMiddleware
middleware
/*
```
- **Run along with agent to mock external calls of your API 🤩🔥**
- Download the latest - Download the latest agent jar
from [here](https://repo1.maven.org/maven2/io/keploy/agent/1.2.9/) (eg: 1.2.9)
- Prefix `-javaagent:` with absolute classpath of agent jar (
eg: `-javaagent:/agent-1.2.9.jar`).
1. **Using Intellij:** Go to Edit Configuration-> add VM options -> paste _java agent_ edited above.
2. **Using command line:**
- First add below plugins in your *pom.xml* file.
```xml
org.apache.maven.plugins
maven-dependency-plugin
3.1.1
copy-dependencies
package
copy-dependencies
org.apache.maven.plugins
maven-jar-plugin
3.2.2
true
dependency/
{your main class}
```
- And then run this
command:`java -javaagent:/agent-1.2.9.jar -jar .jar`
. This command will attach agent jar and also run the application. You need to set some required env
variables written below in order to generate test cases. So, run this command after setting the env
variables.
- **Configure Environment Variables**
- `APP_NAME` (default APP_NAME = myApp)
- `APP_PORT` (default APP_PORT = 8080)
- `DELAY` (default DELAY = 5)(It is the estimate application startup time (in sec))
- `KEPLOY_URL` (default KEPLOY_URL = http://localhost:6789/api)
- `KEPLOY_MODE` (default KEPLOY_MODE = off)
- `KEPLOY_TEST_PATH` (default **/src/test/e2e/keploy-tests** directory of your application)
- `KEPLOY_MOCK_PATH` (default **/src/test/e2e/mocks** directory of your application)
- `KEPLOY_ASSET_PATH` (default **/src/test/e2e/assets** directory of your application)
- `DENOISE` (default DENOISE = false)
**Note:** By enabling denoise, it will filter out noisy fields for the testcase.
- `RUN_TEST_BEFORE_RECORD` (default RUN_TEST_BEFORE_RECORD = false)
**Note:** It is used to maintain the same database state when mocking is disabled.
- `ACCEPT_URL_REGEX_LIST` (default ACCEPT_URL_REGEX_LIST = [])
**Note:** A list of regex which is used to filter out the urls which are required to be recorded and by default it is empty list. **e.g.,ACCEPT_URL_REGEX_LIST=^/api**
- `ACCEPT_HEADER_REGEX_LIST` (default ACCEPT_HEADER_REGEX_LIST = [])
**Note:** A list of regex which is used to filter out the headers which are required to be recorded and by default it is empty list. **e.g.,ACCEPT_HEADER_REGEX_LIST=token:bearer tgffd,content-type\s\*:\s\*application\\\/json**
- `REJECT_URL_REGEX_LIST` (default REJECT_URL_REGEX_LIST = [])
**Note:** A list of regex which is used to filter out the urls which are not required to be recorded and by default it is empty list. **e.g.,REJECT_URL_REGEX_LIST=^/assets**
- `REJECT_HEADER_REGEX_LIST` (default REJECT_HEADER_REGEX_LIST = [])
**Note:** A list of regex which is used to filter out the headers which are not required to be recorded and by default it is empty list. **e.g.,REJECT_HEADER_REGEX_LIST=token:token tgffd,content-length:\s\*:\s\*"100"**
- `SKIP_MOCK_OKHTTP` for okhttp service to be mocked or not (default SKIP_MOCK_OKHTTP = false)
- `SKIP_MOCK_APACHE` for apache service to be mocked or not (default SKIP_MOCK_APACHE = false)
- `SKIP_MOCK_GOOGLE_MAPS` for google_maps service to be mocked or not (default SKIP_MOCK_GOOGLE_MAPS = false)
- `SKIP_MOCK_SQL` for sql service to be mocked or not (default SKIP_MOCK_SQL = false)
- `SKIP_MOCK_REDIS` for redis service to be mocked or not (default SKIP_MOCK_REDIS = false)
- **Generate testcases**
- To generate/capture TestCases set and run your application.
1. Set `KEPLOY_MODE = record` (default "off")
2. Run your application.
3. Make some API calls.
- **Run the testcases**
- **Note:** Before running tests stop the sample application.
- Set `KEPLOY_MODE = test` (default "off")
- **Using IDE:** _(for local use-case we prefer running tests via IDE)_
1. Run your application.
2. You can also run the application with coverage to see the test coverage.
- If you want to run keploy tests along with other unit testcases. You will be required to set the `javaagent` again in your test profile just like below.
1. Add below code in your testfile and run it with or without coverage.
```java
@Test
public void TestKeploy() throws InterruptedException {
CountDownLatch countDownLatch = HaltThread.getInstance().getCountDownLatch();
Mode.setTestMode();
new Thread(() -> {
.main(new String[]{""});
countDownLatch.countDown();
}).start();
countDownLatch.await();
assertTrue(AssertKTests.result(), "Keploy Test Result");
}
```
2. **Using command line**
- Add maven-surefire-plugin to your *pom.xml*. In ` ` don't add jacoco agent if you don't want coverage report.
```xml
org.apache.maven.plugins
maven-surefire-plugin
2.22.2
-javaagent:.jar
-javaagent:${settings.localRepository}/org/jacoco/org.jacoco.agent/0.8.7/org.jacoco.agent-0.8.7-runtime.jar=destfile=target/jacoco.exec-->
target/jacoco.exec
```
- If you want coverage report also add Jacoco plugin to your *pom.xml*.
```xml
org.jacoco
jacoco-maven-plugin
0.8.5
prepare-agent
prepare-agent
report
prepare-package
report
post-unit-test
test
report
target/jacoco.exec
target/my-reports
```
- Run your tests using command : `mvn test`.
## Want stubs for unit test cases as well?
- Java-sdk also supports mocking feature for unit testcase, where you write your own unit test cases and use keploy generated mocks as stubs.
### Usage
- Set `javaagent` in your unit test file configuration.
- You just need to set the name of the mock as shown below.
```java
@Test
public void testHttpCall() throws Exception {
new MockLib("okhttpCall"); //setting name of the mock
``` your unit test case code goes here ```
}
```
- You can also provide location where your mocks can be stored using `KEPLOY_MOCK_PATH`. (default **/src/test/e2e/mocks** directory of your application)
- **Generate mocks**
1. Record mocks by setting `KEPLOY_MODE=record` and run your test file.
2. You will be able to see _editable_ and _readable_ mocks at your provided location.
- **Run your unit testcases**
1. Just set `KEPLOY_MODE=test`, run your test file and you are good to go.
#### 🤩 See, you didn't even need to create a stub for your unit test cases, it's all generated using the java-sdk mock library.
## Community support
We'd love to collaborate with you to make Keploy great. To get started:
* [Slack](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA) - Discussions with the
community and the team.
* [GitHub](https://github.com/keploy/java-sdk/issues) - For bug reports and feature requests.