# AKAS Functional Tests

[![Software License](https://img.shields.io/badge/license-MIT-informational.svg?style=for-the-badge)](LICENSE)
[![Pipeline Status](https://img.shields.io/gitlab/pipeline-status/op_so/projects/akas-tests?style=for-the-badge
)](https://gitlab.com/op_so/projects/akas-tests/pipelines)

This project provides a suite of functional tests written with [Robot Framework](https://robotframework.org/) to automate testing of the [AKAS: API Key Authorization Server](https://gitlab.com/op_so/projects/akas).

## Prerequisites

* **[Rye](https://rye.astral.sh/guide/installation/):** A Python-based build tool.
* **Python Dependencies:** Ensure you have the required Python packages installed by running `rye sync`

## Setting Up the Environment

* **Create a release directory:**

```shell
mkdir release
```

* **Install AKAS Binary**: Place the AKAS binary in the `release` directory.

## Running Tests

```shell
rye run robot --outputdir results tests/
```

or

```shell
rye run tests
```

## Development and Maintenance

* **Formatting** with [Robotidy](https://robotidy.readthedocs.io/en/stable/)

```shell
rye run tidy
```

* **Linting** with [Robocop](https://robocop.readthedocs.io/en/stable/) :

```shell
rye run cop
```

## Additional Information

* Robot Framework Documentation: For in-depth information on Robot Framework usage, refer to the official: [Robot Framework User Guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html)

## Authors

<!-- vale off -->
* **FX Soubirou** - *Initial work* - [GitLab repositories](https://gitlab.com/op_so)
<!-- vale on -->

## License

<!-- vale off -->
This program is free software: you can redistribute it and/or modify it under the terms of the MIT License (MIT).
See the [LICENSE](https://opensource.org/licenses/MIT) for details.
<!-- vale on -->