From f78cdaac0995d023c700af9f3ecffcd782ea342a Mon Sep 17 00:00:00 2001 From: ramin Date: Mon, 8 Jan 2024 11:13:26 +0000 Subject: [PATCH] refactor(makefile + ci): rename swamp -> integration (#3065) Renames `swamp` to `integration` in Makefile and where called in github actions workflows Fixes #2104 --- .github/workflows/go-ci.yml | 8 ++++---- Makefile | 18 +++++++++--------- nodebuilder/tests/README.md | 4 ++-- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/.github/workflows/go-ci.yml b/.github/workflows/go-ci.yml index b004dcfb59..e4cd0e83cc 100644 --- a/.github/workflows/go-ci.yml +++ b/.github/workflows/go-ci.yml @@ -133,8 +133,8 @@ jobs: with: go-version: ${{ inputs.go-version }} - - name: Swamp Tests - run: make test-swamp + - name: Integration Tests + run: make test-integration - - name: Swamp Tests with Race Detector - run: make test-swamp-race + - name: Integration Tests with Race Detector + run: make test-integration-race diff --git a/Makefile b/Makefile index 9e1635308b..b3b3739cb7 100644 --- a/Makefile +++ b/Makefile @@ -121,19 +121,19 @@ test-unit-race: @go test -race `go list ./... | grep -v nodebuilder/tests` .PHONY: test-unit-race -## test-swamp: Running swamp tests located in nodebuilder/tests -test-swamp: - @echo "--> Running swamp tests" +## test-integration: Running /integration tests located in nodebuilder/tests +test-integration: + @echo "--> Running integrations tests" @go test ./nodebuilder/tests -.PHONY: test-swamp +.PHONY: test-integration -## test-swamp-race: Running swamp tests with data race detector located in node/tests -test-swamp-race: - @echo "--> Running swamp tests with data race detector" +## test-integration-race: Running integration tests with data race detector located in node/tests +test-integration-race: + @echo "--> Running integration tests with data race detector" @go test -race ./nodebuilder/tests -.PHONY: test-swamp-race +.PHONY: test-integration-race -## test: Running both unit and swamp tests +## test: Running both unit and integrations tests test: @echo "--> Running all tests without data race detector" @go test ./... diff --git a/nodebuilder/tests/README.md b/nodebuilder/tests/README.md index 176ee2ba21..dd2040ab42 100644 --- a/nodebuilder/tests/README.md +++ b/nodebuilder/tests/README.md @@ -1,6 +1,6 @@ # Swamp: In-Memory Test Tool -Swamp is a testing tool that creates an environment for deploying `celestia-node` and testing instances against each other. +Swamp is our integration testing tool that creates an environment for deploying `celestia-node` and testing instances against each other. While the swamp takes care of setting up networking and initial configuration of node types, the user can focus on tailoring test scenarios. ## Usage @@ -38,7 +38,7 @@ require.NoError(t, err) light := sw.NewLightClient(node.WithTrustedPeer(addrs[0].String())) ``` -## Concenptual overview +## Conceptual overview Each of the test scenario requires flexibility in network topology. The user can define the necessary amount of each type of node and be able to control each of them.