Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ctco/cukes
Cucumber DSL for testing RESTful Web Services
https://github.com/ctco/cukes
api-testing cucumber cucumber-jvm cukes-rest java restapi
Last synced: about 1 month ago
JSON representation
Cucumber DSL for testing RESTful Web Services
- Host: GitHub
- URL: https://github.com/ctco/cukes
- Owner: ctco
- License: apache-2.0
- Created: 2015-10-30T14:07:45.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-07-07T21:37:47.000Z (over 1 year ago)
- Last Synced: 2024-09-26T14:24:12.426Z (about 2 months ago)
- Topics: api-testing, cucumber, cucumber-jvm, cukes-rest, java, restapi
- Language: Java
- Size: 1.32 MB
- Stars: 112
- Watchers: 18
- Forks: 66
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://gitter.im/ctco/cukes?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://app.wercker.com/project/byKey/91bd08250ec1cee694c8d0e5c95f85ce)
[](http://search.maven.org/#search|ga|1|lv.ctco.cukes)
# 
**cukes-rest** takes simplicity of **Cucumber** and provides bindings for HTTP specification. As a sugar on top, **cukes-rest**
adds steps for storing and using request/response content from a file system, variable support in .features, context
inflation in all steps and a custom plug-in system to allow users to add additional project specific
content.
## Resources
- [Wiki](https://github.com/ctco/cukes/wiki)
- [Samples](https://github.com/ctco/cukes/wiki/Test-Samples)
- [Open Issues](https://github.com/ctco/cukes/issues)
## Sample Test
```gherkin
Feature: Gadgets are great!
Background:
Given baseUri is http://my-server.com/rest/
Scenario: Should create another Gadget object
Given request body from file gadgets/requests/newGadget.json
And content type is "application/json"
When the client performs POST request on /gadgets
Then status code is 201
And header Location contains "http://localhost:8080/gadgets/"
When the client performs GET request on {(header.Location)}
Then status code is 200
And response contains property "id" with value other than "2000"
And response contains property "name" with value "Nexus 9"
And response does not contain property "updatedDate"
```
There are three sections available to be used in a Feature files:
- Feature - a description of a feature under test
- Background - set of steps to be executed before every scenario (usually these are preconditions)
- Scenario - a single automated test case
As well as three groups of steps available
- Given - building up a HTTP request to be performed
- When - executing the request
- Then - assertions based on a response received
[More information can be found in the presentation right here!](https://speakerdeck.com/larchaon/getting-started-with-cukes-rest)
## Prerequisites
- JDK 1.6+
## Dependency
The dependencies are stored in [Maven Central](http://search.maven.org/#search|ga|1|lv.ctco.cukes)
### cukes-rest: core dependency with all you need to get started with the framework (Maven)
```xml
lv.ctco.cukes
cukes-rest
${cukes-rest.version}
```
## Getting Started
There are two options to start local server with Sample Application:
1. Run **SampleApplicaiton.java** with following params `server server.yml` from **$MODULE_DIR$**
2. Execute Package/Install Maven phase of the parent project **cukes-rest-all**
### Running tests
*Precondition*: in order for all tests to pass successfully, please make sure you started fresh instance of Sample Application.
- To start a specific Feature/Scenario, either change **CucumberOption** in **RunCukesTest.java** or run Feature file directly from you IDE
- To start all tests run **RunCukesTest.java** from sub-project **cukes-rest-sample**
- To start all tests right from Maven, execute _test_ phase in project **cukes-rest-sample**