Skip to content

Commit

Permalink
Update usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
dshafer committed Apr 12, 2022
1 parent d1c0796 commit 6822f3a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 47 deletions.
30 changes: 13 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ 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:
Expand All @@ -17,39 +16,36 @@ See also:
git clone https://github.internet2.edu/internet2/md-query-saml-uat.git
```

2. Copy `variables.py.example` to `variables.py`:
2. Create and activate a new Python virtual environment:

```sh
cp variables.py.example variables.py
python3 -m venv .venv && source .venv/bin/activate
```

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

4. Run the test suite:
3. Install dependencies:

```sh
robot --noncritical optional .
pip install -r requirements.txt
```

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

Run all test cases in the current directory:
```sh
robot --skiponfailure optional .
```

```sh
robot .
```
## Usage

Treat any test cases tagged with `optional` as noncritical:
Read variables from another file:

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

Additionally skip long-running test cases (those that download and parse all
entities):
Skip downloading and parsing the complete aggregate:

```sh
robot --skiponfailure optional --exclude aggregate .
robot --exclude aggregate .
```

## Contributing
Expand Down
30 changes: 0 additions & 30 deletions variables.py.example

This file was deleted.

0 comments on commit 6822f3a

Please sign in to comment.