Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Local testing. #2

Merged
merged 1 commit into from
Dec 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,47 @@ cluster. Following connectors are currently supported:
* Version of OVN installed on the cluster, by the MicroOVN, must roughly match the
version of the source file you are editing.

## Contributing

While this is admittedly very small and niche project, any contributions are welcome. Be
it in a form of Github issues or Pull Requests. For pul requests to be merged, they need
to pass CI pipeline (tests/linters). You can get ahead of the game by running them
locally before pushing.

## Running tests locally

All tests related to the python code are defined as "tox environments" and can be
executed using `poetry`, provided that dependencies from `dev` group are installed (
it should be taken care of by simply running `poetry install`.

### Formatting code

This project uses set of opinionated code formatters to keep the code style consistent,
you can run them with:

```bash
poetry run tox -e format
```

### Linting code

To see if any of the linters have objections to the code, run:

```bash
poetry run tox -e lint
```

### Unit tests

This project aims to keep 100% code coverage (with few explicit exemptions). To execute
all unit tests, along with the coverage report, run:

```bash
poetry run tox -e unit
```

Note that this command may "fail" if the coverage is not sufficient.

## Todo
* Support execution of arbitrary scripts aside from just restarting services on file
updates. This will enable syncing things like OVSDB schemas as they require migration
Expand Down
Loading