diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a51f915fa8..28203bda8c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,10 @@ Welcome to this repository and thank you for your interest in contributing to it Contributions should follow [the general InterUSS contributions process](https://github.com/interuss/tsc/blob/main/repo_contributions.md). Additional information specific to this repository is provided below. +## Formatting and verification + +This repository has a very strict Python linter, as well as very strict expected formats for a number of other artifacts such as Markdown files. Correct formatting can be verified with `make lint` from the repository root. But, in most cases manual formatting is not necessary to resolve issues -- instead, `make format` from the repository root should automatically reformat Python and most other mere-formatting issues without changing functionality. Because `make lint` is part of the integration tests, `make format` should generally be run before integration tests. + ## Integration tests When [a PR is created](https://github.com/interuss/tsc/blob/main/repo_contributions.md#create-draft-pr-in-interuss-repository), the [continuous integration (CI) tests for this repository](./.github/workflows/CI.md) will run, and the PR will generally not be reviewed until they pass (unless [committer help is requested](https://github.com/interuss/tsc/blob/main/repo_contributions.md#request-committer-help-via-comment-in-pr) to address the failure). See [the continuous integration test documentation](./.github/workflows/CI.md) for how to run these tests on your local system more quickly and efficiently to be confident your PR will pass the CI tests when created (or when updates are made). diff --git a/README.md b/README.md index ee3fcb188d..4010c39b04 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Monitoring Tools [![GoDoc](https://godoc.org/github.com/interuss/monitoring?status.svg)](https://godoc.org/github.com/interuss/monitoring) +# Monitoring Tools @@ -15,6 +15,11 @@ The monitoring tools target compliance with the following standards and regulati - [ASTM F3548-21](https://www.astm.org/f3548-21.html): UAS Traffic Management (UTM) UAS Service Supplier (USS) Interoperability Specification. - [F3548-22 OpenAPI interface](./interfaces/astm-utm) + - Useful resources for understanding this standard include these Drone Talk videos: + - [Interoperability standard](https://www.youtube.com/watch?v=ukbjIU_Ojh0) + - [Interoperability standard, part 2](https://www.youtube.com/watch?v=qKW2PkzZ_mE) + - [DSS and ASTM UTM interoperability paradigm](https://youtu.be/Nh53ibxcnBM) + - [Operational intents](https://www.youtube.com/watch?v=lS6tTQTmVO4) U-Space specific: - [COMMISSION IMPLEMENTING REGULATION (EU) 2021/664](https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=CELEX:32021R0664&from=EN#d1e32-178-1) @@ -26,7 +31,7 @@ services such as Remote ID (ASTM F3411-19/22) and Strategic Conflict Detection d Management (UTM) UAS Service Supplier (USS) Interoperability Specification. - [Introduction to monitoring, conformance and interoperability testing](./monitoring/README.md)
Modules: - - [USS qualifier](./monitoring/uss_qualifier) + - [USS qualifier](./monitoring/uss_qualifier) (automated testing framework) - [DSS integration test: prober](./monitoring/prober) - [DSS load test](./monitoring/loadtest) - [Mock USS](./monitoring/mock_uss), with multiple capabilities diff --git a/monitoring/uss_qualifier/local_testing.md b/monitoring/uss_qualifier/local_testing.md index 9aee120add..b854dd4801 100644 --- a/monitoring/uss_qualifier/local_testing.md +++ b/monitoring/uss_qualifier/local_testing.md @@ -32,6 +32,8 @@ To tear down the complete set of local mocks (or ensure it is completely torn do Once the local interoperability ecosystem infrastructure and complete set of local mocks are deployed, execute uss_qualifier with [`./monitoring/uss_qualifier/run_locally.sh [CONFIG_NAME]`](run_locally.sh). If no `CONFIG_NAME` is specified, all configurations used for the [continuous integration](../../.github/workflows) are executed; this involves multiple invocations of uss_qualifier. Otherwise, a specific [configuration name](configurations/README.md#specifying) can be specified; e.g., [`configurations.dev.uspace`](configurations/dev/uspace.yaml). +To cause uss_qualifier to stop at the first test failure (this is often useful when attempting to debug a test that should run fully successfully), set the USS_QUALIFIER_STOP_FAST environment variable with `export USS_QUALIFIER_STOP_FAST=true`. To disable this behavior, `unset USS_QUALIFIER_STOP_FAST`. + ## Presubmit testing The command `make presubmit` will perform local actions equivalent to the full [continuous integration pipeline](../../.github/workflows) including, relevant to local testing: