Skip to main content

Write e2e tests in yml. Run with Selenium. Report with Markdown

Project description

# Django Spectacles

![Django Spectacles](http://phisick.com/core/wp-content/uploads/antique-spectacles-martin-margin-1011.jpg)

![pip install django-spectacles](https://badge.fury.io/py/django-spectacles.png)
[![Build Status](https://travis-ci.org/toast38coza/django-spectacles.svg?branch=master)](https://travis-ci.org/toast38coza/django-spectacles)

Write **end-to-end** tests in **YAML**, run them with **Python** and output your results in **Markdown**

# Installation

pip install django-spectacles

# Running spectals:

```
python spectacles/runner.py --help
Usage: runner.py [OPTIONS] BASE_URL

Options:
--driver TEXT Select the browser driver you would like to use
(phantomjs, chrome, firefox)
--spec-location TEXT A glob for finding spec files
--out-location TEXT path to the directory where we will output the
spec results
--screenshot-location TEXT path where we will save screenshots
--help Show this message and exit.

```

### Quickstart

The default project layout is like this:

```
.
|_ specs/ # put your yaml specs here
|_ reports/
|_ screenshots # any screenshots you take will be saved here
|_ specs # spec reports will be saved here
```

Let's create a quick spec:

`./specs/google_im_lucky.yml`

```yaml

---
- scenario: I'm feeling lucky
steps:
- goto: /
- screenshot: {}

- expect_elements :
- "#lst-ib": "search input"
- fill_fields:
- q: "testing"
- wait: 1
- click: "[name='btnG']"
- wait: 5
- wait_for_element : "#rcnt"
- screenshot:
widths: [375, 768, 990, 1200, 1600]

```

**Run your spec:**

```
python spectacles/runner.py https://www.google.com
```

**Results:**

1. You should find a collection of screenshots at: `./reports/screenshots`

**Output:**

##I'm feeling lucky

* Go to: /
* ✓ Check that search input exists
* enter django-spectacles into field:q
* ✓ Check that [name='btnG'] exists
* Click button:
* waiting for #rcnt to load
* ✓ Element has loaded: #rcnt
* Click the first link
* ✓ Check that h3.r a exists
* Click button: GitHub - toast38coza/django-spectacles: Write Integration tests in ...

---

**TODO:**

Some improvements I would like to ship in the near future:

[*] Remove dependency on Django
[] Print results
[*] Take arguments (e.g: domain, output directory, glob for yml files)
[*] Maybe we don't need to run this as a test?


**Note to self: deploying to pypi:**

1. Update version in setup.py
2. Upload to pypi:

python setup.py sdist upload -r pypi

Project details


Release history Release notifications

History Node

1.4.3

History Node

1.4.2

History Node

1.4.1

History Node

1.4.0

History Node

1.3.0

History Node

1.1.0

This version
History Node

1.0.1

History Node

1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
python-spectacles-1.0.1.tar.gz (7.3 kB) Copy SHA256 hash SHA256 Source None Jun 30, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page