README.md

# md-query-saml-uat

User acceptance tests for a service implementing the SAML metadata profile of
the Metadata Query Protocol.

See also:

* [Metadata Query Protocol](https://tools.ietf.org/html/draft-young-md-query-09)
* [SAML Profile for the Metadata Query Protocol](https://tools.ietf.org/html/draft-young-md-query-saml-09)


## Getting Started

1. Install Robot Framework (see https://github.com/robotframework/robotframework/blob/master/INSTALL.rst)

2. Install Requests library: `pip install robotframework-requests`

3. Clone this repository:
  ```
  git clone https://github.internet2.edu/internet2/md-query-saml-uat.git
  ```

4. Copy `variables.py.example` to `variables.py`: `cp variables.py.example variables.py`

5. Edit `variables.py` for your environment.

6. Run the test suite:
  ```
  robot --noncritical optional .
  ```


## Usage

Run all test cases in the current directory:
```
robot .
```

Treat any test cases tagged with `optional` as noncritical:
```
robot --noncritical optional .
```

Additionally skip long-running test cases (those that download and parse all
entities):
```
robot --noncritical optional --exclude aggregate .
```


## To Do

1. Isolate Python dependencies with `virtualenv` or similar.


## Contributing

1. Clone the repository
2. Create a new feature branch
3. Commit your changes and push to the repository
4. Create a pull request from your feature branch against the `master` branch
5. After your changes have been merged, you may delete your feature branch