Skip to content

Commit

Permalink
code review feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
NiniOak committed Jul 19, 2023
1 parent 0e781b5 commit ce01138
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions test-integ/peering_commontopo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ make test-compat-integ-setup

## Non-Shared CommonTopo Tests

The tests in question are designed in a manner that modifies the topology. As a result, it is noy possible to share the testing environment across these tests.
The tests in question are designed in a manner that modifies the topology. As a result, it is not possible to share the testing environment across these tests.

## Shared CommonTopo Tests

Expand All @@ -34,18 +34,18 @@ To run individual peering topology tests:

```
cd /path/to/peering_commontopo
go test -timeout=10m -run '^ExampleTestSuite' -v -no-share-topo .
go test -timeout=10m -run '^TestSuiteExample' -v -no-share-topo .
```

## Local Development and Testing

All the methods in the `commonTopoSuite` interface must be implemented.
If writing tests for peering with no shared topology, this recommendation does not apply. The following methods below not necessarily need to be implmented. For shared topology tests, all the methods in the `sharedTopoSuite` interface must be implemented.

- `testName()` prepends the test suite name to each test in the test suite.
- `setup()` phase must ensure that any resources added to the topology cannot interfere with other tests. Principally by prefixing.
- `test()` phase must be "passive" and not mutate the topology in any way that would interfere with other tests.

Common topology peering tests are defined in the [test-integ/peering_commontopo/](/test-integ/peering_commontopo/) subdirectory and new peering integration tests should always be added to this location. Adding integration tests that does not modify the topology should always start by invoking
Common topology peering tests are defined in the [test-integ/peering_commontopo/](/test-integ/peering_commontopo/) directory and new peering integration tests should always be added to this location. Adding integration tests that does not modify the topology should always start by invoking

```go
runShareableSuites(t, testSuiteExample)
Expand Down

0 comments on commit ce01138

Please sign in to comment.