Skip to content

Commit

Permalink
refactor(makefile + ci): rename swamp -> integration (celestiaorg#3065)
Browse files Browse the repository at this point in the history
<!--
Thank you for submitting a pull request!

Please make sure you have reviewed our contributors guide before
submitting your
first PR.

Please ensure you've addressed or included references to any related
issues.

Tips:
- Use keywords like "closes" or "fixes" followed by an issue number to
automatically close related issues when the PR is merged (e.g., "closes
#123" or "fixes #123").
- Describe the changes made in the PR.
- Ensure the PR has one of the required tags (kind:fix, kind:misc,
kind:break!, kind:refactor, kind:feat, kind:deps, kind:docs, kind:ci,
kind:chore, kind:testing)

-->

Renames `swamp` to `integration` in Makefile and where called in github
actions workflows

Fixes celestiaorg#2104
  • Loading branch information
ramin authored and renaynay committed Jan 15, 2024
1 parent daa8d75 commit f78cdaa
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/go-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
18 changes: 9 additions & 9 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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 ./...
Expand Down
4 changes: 2 additions & 2 deletions nodebuilder/tests/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit f78cdaa

Please sign in to comment.