Skip to content

Commit 78cb591

Browse files
Copilotevan-forbes
andcommitted
Update documentation to clarify contract tests are not available
Co-authored-by: evan-forbes <[email protected]>
1 parent 0600625 commit 78cb591

File tree

3 files changed

+12
-17
lines changed

3 files changed

+12
-17
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -416,16 +416,11 @@ Run: `cd test/fuzz && make fuzz-{PACKAGE-COMPONENT}`
416416
**If you contribute to the RPC endpoints it's important to document your
417417
changes in the [Openapi file](./rpc/openapi/openapi.yaml)**.
418418

419-
To test your changes you must install `nodejs` and run:
420-
421-
```bash
422-
npm i -g dredd
423-
make build-linux build-contract-tests-hooks
424-
make contract-tests
425-
```
426-
427-
**WARNING: these are currently broken due to <https://github.com/apiaryio/dredd>
428-
not supporting complete OpenAPI 3**.
429-
430-
This command will popup a network and check every endpoint against what has
431-
been documented.
419+
**WARNING: contract tests are currently not available. They previously depended
420+
on a local network setup that has been removed due to maintenance issues. The
421+
tests were also broken due to <https://github.com/apiaryio/dredd> not supporting
422+
complete OpenAPI 3**.
423+
424+
The contract tests would check every endpoint against what has been documented
425+
in the OpenAPI specification. Alternative testing approaches should be used to
426+
validate API changes.

Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -329,9 +329,9 @@ endif
329329
.PHONY: build-contract-tests-hooks
330330

331331
#? contract-tests: Run a nodejs tool to test endpoints against a testnet
332-
# The command takes care of starting and stopping the network
333-
# prerequisits: build-contract-tests-hooks build-linux
334-
# the two build commands were not added to let this command run from generic containers or machines.
332+
# NOTE: Currently not functional due to removal of localnet infrastructure
333+
# prerequisits: build-contract-tests-hooks
334+
# The binary build commands were not added to let this command run from generic containers or machines.
335335
# The binaries should be built beforehand
336336
contract-tests:
337337
dredd

dredd.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ dry-run: null
33
hookfiles: build/contract_tests
44
language: go
55
require: null
6-
# server: # localnet functionality has been removed - see CONTRIBUTING.md for current status
6+
# server: # localnet functionality has been removed - contract tests not currently available
77
server-wait: 30
88
init: false
99
custom: {}

0 commit comments

Comments
 (0)