Skip to content

Commit b6fcd0d

Browse files
committed
update docs
1 parent 472b64e commit b6fcd0d

File tree

10 files changed

+37
-105
lines changed

10 files changed

+37
-105
lines changed

book/src/SUMMARY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@
4444
- [Performance]()
4545
- [Chaos]()
4646
- [Interactive](framework/interactive.md)
47-
- [Continuous Integration](ci/ci.md)
4847
- [Libraries](./libraries.md)
4948
- [Seth](./libs/seth.md)
5049
- [WASP](./libs/wasp.md)

book/src/ci/ci.md

Lines changed: 0 additions & 88 deletions
This file was deleted.

book/src/framework/components/blockchains/anvil.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ type Config struct {
5151
func TestDON(t *testing.T) {
5252
in, err := framework.Load[Config](t)
5353
require.NoError(t, err)
54-
pkey := os.Getenv("PRIVATE_KEY")
5554

5655
// deploy anvil blockchain simulator
5756
bc, err := blockchain.NewBlockchainNetwork(in.BlockchainA)

book/src/framework/components/external.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ For example, to integrate with remote `k8s` environment you can use `CTF_CONFIGS
1717

1818
[[blockchain_a.out.nodes]]
1919
# set up your RPC URLs
20-
docker_internal_http_url = "http://anvil-2cfcf:8545"
21-
docker_internal_ws_url = "ws://anvil-2cfcf:8545"
2220
http_url = "http://127.0.0.1:8545"
2321
ws_url = "ws://127.0.0.1:8545"
2422

@@ -34,7 +32,6 @@ For example, to integrate with remote `k8s` environment you can use `CTF_CONFIGS
3432

3533
[data_provider.out]
3634
# setup your data provider URLs
37-
base_url_docker = "http://host.docker.internal:9111"
3835
base_url_host = "http://localhost:9111"
3936

4037
[nodeset]
@@ -49,8 +46,6 @@ For example, to integrate with remote `k8s` environment you can use `CTF_CONFIGS
4946

5047
[nodeset.out.cl_nodes.node]
5148
# set up each node URLs
52-
docker_internal_url = "http://node0:6688"
53-
p2p_docker_internal_url = "http://node0:6690"
5449
p2p_url = "http://127.0.0.1:12000"
5550
url = "http://127.0.0.1:10000"
5651

book/src/framework/getting_started.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,7 @@ Spin up your `Blockscout` stack
5959
ctf bs up
6060
```
6161
More [docs](observability/blockscout.md)
62+
63+
## Interactive
64+
65+
If you're a non-technical user or want to integrate with Chainlink using a language other than Golang, please follow our Interactive [setup](interactive.md) guide.

book/src/framework/interactive.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ Allow it to run in `System Settings -> Security Settings` (OS X)
3333
```
3434
./ctf b ns
3535
```
36-
Press `Ctrl+C` to remove the stack.
36+
Use `Tab/Shift+Tab` to select an option, use `<-`, `->` to change the option, `enter` to submit.
37+
38+
Press `Ctrl+C` to remove the services.
3739

3840
![img.png](images/interactive-node-set.png)

book/src/framework/overview.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
11
## Framework
22

3-
The Framework module a lightweight, modular, and data-driven framework designed for combining off-chain and on-chain components while implementing best practices for end-to-end system-level testing:
3+
The primary focus of the Chainlink Testing Framework is to reduce the complexity of end-to-end testing, making complex system-level tests appear straightforward.
4+
It enables tests to run in any environment and serves as a single source of truth for system behavior as defined by requirements.
5+
6+
### Features
7+
- **Straightforward and sequential test composition**: Tests are readable and give you precise control over key aspects in a strict step-by-step order.
8+
9+
- **Modular configuration**: No arcane knowledge of framework settings is required; the config is simply a reflection of the components being used in the test. Components declare their own configuration— `what you see is what you get`.
410

5-
- **Modular configuration**: No arcane knowledge of framework settings is required; the config is simply a reflection of the components being used in the test. Components declare their own configuration—'what you see is what you get.'
611
- **Component isolation**: Components are decoupled via input/output structs, without exposing internal details.
12+
713
- **Replaceability and extensibility**: Since components are decoupled via outputs, any deployment component can be swapped with a real service without altering the test code.
8-
- **Caching**: any component can use cached configs to skip setup for faster test development.
14+
15+
- **Quick local environments**: A common setup can be launched in just `15` seconds 🚀 [*](#cached).
16+
17+
- **Caching**: Any component can use cached configs to skip setup for even faster test development.
18+
919
- **Integrated observability stack**: get all the info you need to develop end-to-end tests: metrics, logs, traces, profiles.
1020

21+
###### * If all the images are cached, you are using [OrbStack](https://orbstack.dev/) with M1/M2/M3 chips and have at least 8CPU dedicated to Docker
22+

book/src/framework/testing.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@
99

1010
These tests act as a maturity model and are implemented across all our products.
1111

12+
Run them locally:
13+
```
14+
CTF_CONFIGS=smoke.toml go test -v -run TestSmoke
15+
CTF_CONFIGS=load.toml go test -v -run TestLoad
16+
CTF_CONFIGS=chaos.toml go test -v -run TestChaos
17+
CTF_CONFIGS=upgrade_some.toml go test -v -run TestUpgradeSome
18+
```
19+
1220
Use this [workflow](https://github.com/smartcontractkit/chainlink-testing-framework/actions/runs/11739154666/workflow?pr=1311) as a starting point for developing a new end-to-end integration test.
1321

14-
Set the count to 5-10 during development, and once stable, set the timeout and proceed to merge.
22+
Set the count to 5-10 during development, and once stable, set the timeout and proceed to merge.
23+
24+
If you need to structure a lot of different tests (not only end-to-end) follow [this](https://github.com/smartcontractkit/.github/tree/main/.github/workflows) guide.

book/src/overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
The Chainlink Testing Framework (CTF) is a blockchain development framework written in Go.
44

5-
Its primary purpose is to help Chainlink developers create extensive integration, e2e, performance, and chaos tests to ensure the stability of the chainlink project.
5+
Its primary purpose is to help Chainlink developers create extensive integration, e2e, performance, and chaos tests to ensure the stability of the Chainlink project.
66

7-
It can also be helpful to those who just want to use chainlink oracles in their projects to help test their contracts, or even for those that aren't using chainlink.
7+
It can also be helpful to those who just want to use Chainlink oracles in their projects to help test their contracts, or even for those that aren't using Chainlink.
88

99
This documentation is primarily for:
10-
- Developers looking to write end-to-end tests
11-
- Quality Assurance Engineers aiming to test locally
10+
- Engineers looking to write end-to-end tests
11+
- Non-technical users or external developers who want to [setup](framework/interactive.md) `Chainlink` nodes locally
1212

1313
To get started with writing tests, refer to the [Framework](./framework/getting_started.md) chapter, where we guide you from basic to more complex scenarios.
1414

book/src/testing.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)