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. Clone this repository:

    ```sh
    git clone https://github.internet2.edu/internet2/md-query-saml-uat.git
    ```

2. Create and activate a new Python virtual environment:

    ```sh
    python3 -m venv .venv && source .venv/bin/activate
    ```

3. Install dependencies:

    ```sh
    pip install -r requirements.txt
    ```

4. Run all tests in the current directory, skipping failures in any tests tagged as "optional":

    ```sh
    robot --skiponfailure optional .
    ```

## Usage

Read variables from another file:

```sh
robot --variablefile dev-variables.py .
```

Skip downloading and parsing the complete aggregate:

```sh
robot --exclude aggregate .
```

## 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