Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/defra/quke-example
An example Quke project. See https://github.com/Defra/quke
https://github.com/defra/quke-example
acceptance-testing capybara cucumber quke
Last synced: 6 days ago
JSON representation
An example Quke project. See https://github.com/Defra/quke
- Host: GitHub
- URL: https://github.com/defra/quke-example
- Owner: DEFRA
- License: other
- Created: 2017-06-09T11:24:26.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-05T21:49:46.000Z (8 months ago)
- Last Synced: 2024-04-14T07:53:29.298Z (7 months ago)
- Topics: acceptance-testing, capybara, cucumber, quke
- Language: Ruby
- Homepage:
- Size: 182 KB
- Stars: 0
- Watchers: 6
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quke example
[](https://hakiri.io/github/DEFRA/quke-example/main)
[](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3)
This repo serves as an example [Quke](https://github.com/Defra/quke) project. Refer to it for examples on how to setup your own projects, and how to use either [Capybara](https://github.com/teamcapybara/capybara) or [SitePrism](https://github.com/site-prism/site_prism) in your steps to interact with a web page.
## Pre-requisites
This project is setup to run against version 2.4.2 of Ruby, though as long as you have this or something greater it shouldn't matter. You'll also need the [Bundler](http://bundler.io/) gem.
The rest of the pre-requisites are the same as those for [Quke](https://github.com/DEFRA/quke#pre-requisites).
## Installation
First clone the repository and then drop into your new local repo
```bash
git clone https://github.com/DEFRA/quke-example.git && cd quke-example
```
Next download and install the dependencies
```bash
bundle install
```
## Configuration
You can figure out how the project runs using [Quke config files](https://github.com/DEFRA/quke#configuration). This project comes with an existing `.config.yml` file setup to allow the tests to pass.
### Experimenting & testing
You can amend the values in `.config.yml` to see how they effect the way Quke runs or alternatively create your own, for example `.config.test.yml`. If you stick to the convention of `.config.[my name].yml` [Git](https://git-scm.com/) will ignore your file which means you can put whatever you like in them and not risk the content being committed to source control!
## Setup
You'll then need to start the demo app which the examples run against
```bash
bundle exec rake run
```
You'll want to do this in a separate terminal window as its a long lived task, which means the only way to get back to the command line is with `ctrl+c`!
## Running the tests
Simply call
```bash
bundle exec quke
```
All being well all the tests should pass. You can now experiment with the examples provided, add your own, and get familiar with how to write your own **Cucumber** scenarios.
## Contributing to this project
If you have an idea you'd like to contribute please log an issue.
All contributions should be submitted via a pull request.
## License
THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
The following attribution statement MUST be cited in your products and applications when using this information.
> Contains public sector information licensed under the Open Government license v3
### About the license
The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.