refactor(test): rename test cases for clarity

The test case names in `ufw-docker-service.test.sh` and `ufw-docker.test.sh` were grammatically incorrect and did not clearly describe their purpose.

This commit renames the test cases to be more descriptive and adhere to the Bach testing framework's conventions, using hyphens to improve readability in the test output.
This commit is contained in:
Chai Feng 2025-07-11 17:21:04 +08:00
parent bc04ef1309
commit a90e1fbbe9
No known key found for this signature in database
GPG key ID: 2DCD9A24E523FFD2
2 changed files with 189 additions and 189 deletions

View file

@ -42,142 +42,142 @@ function load-ufw-docker-function() {
}
test-ufw-docker--service-not-parameters() {
test-service-called-without-parameters() {
load-ufw-docker-function ufw-docker--service
ufw-docker--service
}
test-ufw-docker--service-not-parameters-assert() {
test-service-called-without-parameters-assert() {
ufw-docker--help
}
test-ufw-docker--service-allow() {
test-service-allow-requires-service-name() {
load-ufw-docker-function ufw-docker--service
ufw-docker--service allow
}
test-ufw-docker--service-allow-assert() {
test-service-allow-requires-service-name-assert() {
@do-nothing
@fail
}
test-ufw-docker--service-allow-webapp() {
test-service-allow-requires-port() {
load-ufw-docker-function ufw-docker--service
ufw-docker--service allow webapp
}
test-ufw-docker--service-allow-webapp-assert() {
test-service-allow-requires-port-assert() {
#ufw-docker--service-allow webapp "" ""
@do-nothing
@fail
}
test-ufw-docker--service-allow-webapp-80tcp() {
test-service-allow-succeeds-with-service-and-port() {
load-ufw-docker-function ufw-docker--service
ufw-docker--service allow webapp 80/tcp
}
test-ufw-docker--service-allow-webapp-80tcp-assert() {
test-service-allow-succeeds-with-service-and-port-assert() {
ufw-docker--service-allow webapp 80/tcp
}
test-ufw-docker--service-delete-deny() {
test-service-delete-deny-is-not-supported() {
load-ufw-docker-function ufw-docker--service
ufw-docker--service delete deny
}
test-ufw-docker--service-delete-deny-assert() {
test-service-delete-deny-is-not-supported-assert() {
@do-nothing
@fail
}
test-ufw-docker--service-delete-allow-no-service() {
test-service-delete-allow-requires-service-name() {
load-ufw-docker-function ufw-docker--service
ufw-docker--service delete allow
}
test-ufw-docker--service-delete-allow-no-service-assert() {
test-service-delete-allow-requires-service-name-assert() {
@do-nothing
@fail
}
test-ufw-docker--service-delete-allow-webapp() {
test-service-delete-allow-succeeds-with-service-name() {
load-ufw-docker-function ufw-docker--service
ufw-docker--service delete allow webapp
}
test-ufw-docker--service-delete-allow-webapp-assert() {
test-service-delete-allow-succeeds-with-service-name-assert() {
ufw-docker--service-delete webapp
}
test-ufw-docker--service-delete-allow-webapp-8080-tcp() {
test-service-delete-allow-succeeds-with-service-name-and-port-protocol() {
load-ufw-docker-function ufw-docker--service
ufw-docker--service delete allow webapp 8080/tcp
}
test-ufw-docker--service-delete-allow-webapp-8080-tcp-assert() {
test-service-delete-allow-succeeds-with-service-name-and-port-protocol-assert() {
ufw-docker--service-delete webapp 8080/tcp
}
test-ufw-docker--service-delete-allow-webapp-8080() {
test-service-delete-allow-succeeds-with-service-name-and-port() {
load-ufw-docker-function ufw-docker--service
ufw-docker--service delete allow webapp 8080
}
test-ufw-docker--service-delete-allow-webapp-8080-assert() {
test-service-delete-allow-succeeds-with-service-name-and-port-assert() {
ufw-docker--service-delete webapp 8080
}
test-ufw-docker--get-service-id() {
test-get-service-id() {
load-ufw-docker-function ufw-docker--get-service-id
ufw-docker--get-service-id database
}
test-ufw-docker--get-service-id-assert() {
test-get-service-id-assert() {
docker service inspect database --format "{{.ID}}"
}
test-ufw-docker--get-service-name() {
test-get-service-name() {
load-ufw-docker-function ufw-docker--get-service-name
ufw-docker--get-service-name database
}
test-ufw-docker--get-service-name-assert() {
test-get-service-name-assert() {
docker service inspect database --format "{{.Spec.Name}}"
}
test-ufw-docker--service-allow-invalid-port-syntax() {
test-service-allow-requires-service-name-invalid-port-syntax() {
load-ufw-docker-function ufw-docker--service-allow
ufw-docker--service-allow webapp invalid-port
}
test-ufw-docker--service-allow-invalid-port-syntax-assert() {
test-service-allow-requires-service-name-invalid-port-syntax-assert() {
@do-nothing
@fail
}
test-ufw-docker--service-allow-an-non-existed-service() {
test-service-allow-requires-service-name-an-non-existed-service() {
@mock ufw-docker--get-service-id web404 === @stdout ""
load-ufw-docker-function ufw-docker--service-allow
ufw-docker--service-allow web404 80/tcp
}
test-ufw-docker--service-allow-an-non-existed-service-assert() {
test-service-allow-requires-service-name-an-non-existed-service-assert() {
@do-nothing
@fail
}
test-ufw-docker--service-allow-a-service-without-ports-published() {
test-service-allow-requires-service-name-a-service-without-ports-published() {
@mock ufw-docker--get-service-id private-web === @stdout abcd1234
@mock ufw-docker--get-service-name private-web === @stdout private-web
@mock ufw-docker--list-service-ports private-web === @stdout ""
@ -185,13 +185,13 @@ test-ufw-docker--service-allow-a-service-without-ports-published() {
load-ufw-docker-function ufw-docker--service-allow
ufw-docker--service-allow private-web 80/tcp
}
test-ufw-docker--service-allow-a-service-without-ports-published-assert() {
test-service-allow-requires-service-name-a-service-without-ports-published-assert() {
@do-nothing
@fail
}
test-ufw-docker--service-allow-a-service-while-agent-not-running() {
test-service-allow-requires-service-name-a-service-while-agent-not-running() {
@mock ufw-docker--get-service-id webapp === @stdout abcd1234
@mock ufw-docker--get-service-name webapp === @stdout webapp
@mock ufw-docker--list-service-ports webapp === @stdout "53 53/udp" "80 80/tcp" "8080 8080/tcp"
@ -200,7 +200,7 @@ test-ufw-docker--service-allow-a-service-while-agent-not-running() {
load-ufw-docker-function ufw-docker--service-allow
ufw-docker--service-allow webapp 80/tcp
}
test-ufw-docker--service-allow-a-service-while-agent-not-running-assert() {
test-service-allow-requires-service-name-a-service-while-agent-not-running-assert() {
docker service create --name ufw-docker-agent --mode global \
--mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock \
--mount type=bind,source=/etc/ufw,target=/etc/ufw,readonly=true \
@ -211,7 +211,7 @@ test-ufw-docker--service-allow-a-service-while-agent-not-running-assert() {
}
test-ufw-docker--service-allow-a-service-add-new-env() {
test-service-allow-requires-service-name-a-service-add-new-env() {
@mock ufw-docker--get-service-id webapp === @stdout abcd1234
@mock ufw-docker--get-service-name webapp === @stdout webapp
@mock ufw-docker--list-service-ports webapp === @stdout "53 53/udp" "80 80/tcp" "8080 8080/tcp"
@ -221,7 +221,7 @@ test-ufw-docker--service-allow-a-service-add-new-env() {
load-ufw-docker-function ufw-docker--service-allow
ufw-docker--service-allow webapp 80/tcp
}
test-ufw-docker--service-allow-a-service-add-new-env-assert() {
test-service-allow-requires-service-name-a-service-add-new-env-assert() {
docker service update --update-parallelism=0 \
--env-add ufw_docker_agent_image="chaifeng/ufw-docker-agent:090502" \
--env-add DEBUG="false" \
@ -231,7 +231,7 @@ test-ufw-docker--service-allow-a-service-add-new-env-assert() {
}
test-ufw-docker--service-allow-a-service-update-a-env() {
test-service-allow-requires-service-name-a-service-update-a-env() {
@mock ufw-docker--get-service-id webapp === @stdout abcd1234
@mock ufw-docker--get-service-name webapp === @stdout webapp
@mock ufw-docker--list-service-ports webapp === @stdout "53 53/udp" "80 80/tcp" "8080 8080/tcp"
@ -241,7 +241,7 @@ test-ufw-docker--service-allow-a-service-update-a-env() {
load-ufw-docker-function ufw-docker--service-allow
ufw-docker--service-allow webapp 80/tcp
}
test-ufw-docker--service-allow-a-service-update-a-env-assert() {
test-service-allow-requires-service-name-a-service-update-a-env-assert() {
docker service update --update-parallelism=0 \
--env-add ufw_docker_agent_image="chaifeng/ufw-docker-agent:090502" \
--env-add DEBUG="false" \
@ -252,7 +252,7 @@ test-ufw-docker--service-allow-a-service-update-a-env-assert() {
}
test-ufw-docker--service-allow-a-service-add-value-to-an-env() {
test-service-allow-requires-service-name-a-service-add-value-to-an-env() {
@mock ufw-docker--get-service-id webapp === @stdout abcd1234
@mock ufw-docker--get-service-name webapp === @stdout webapp
@mock ufw-docker--list-service-ports webapp === @stdout "5353 53/udp" "8080 80/tcp" "18080 8080/tcp"
@ -263,7 +263,7 @@ test-ufw-docker--service-allow-a-service-add-value-to-an-env() {
ufw-docker--service-allow webapp 80/tcp
ufw-docker--service-allow webapp 8080/tcp
}
test-ufw-docker--service-allow-a-service-add-value-to-an-env-assert() {
test-service-allow-requires-service-name-a-service-add-value-to-an-env-assert() {
docker service update --update-parallelism=0 \
--env-add ufw_docker_agent_image="chaifeng/ufw-docker-agent:090502" \
--env-add DEBUG="false" \
@ -280,7 +280,7 @@ test-ufw-docker--service-allow-a-service-add-value-to-an-env-assert() {
ufw-docker-agent
}
test-ufw-docker--service-allow-a-service-denied-port() {
test-service-allow-requires-service-name-a-service-denied-port() {
@mock ufw-docker--get-service-id webapp === @stdout abcd1234
@mock ufw-docker--get-service-name webapp === @stdout webapp
@mock ufw-docker--list-service-ports webapp === @stdout "5353 53/udp" "8080 80/tcp" "18080 8080/tcp"
@ -290,7 +290,7 @@ test-ufw-docker--service-allow-a-service-denied-port() {
load-ufw-docker-function ufw-docker--service-allow
ufw-docker--service-allow webapp 80/tcp
}
test-ufw-docker--service-allow-a-service-denied-port-assert() {
test-service-allow-requires-service-name-a-service-denied-port-assert() {
docker service update --update-parallelism=0 \
--env-add ufw_docker_agent_image="chaifeng/ufw-docker-agent:090502" \
--env-add DEBUG="false" \
@ -301,7 +301,7 @@ test-ufw-docker--service-allow-a-service-denied-port-assert() {
}
test-ufw-docker--get-env-list() {
test-get-env-list() {
@mock docker service inspect ufw-docker-agent \
--format '{{range $k,$v := .Spec.TaskTemplate.ContainerSpec.Env}}{{ $v }}{{"\n"}}{{end}}' \
=== @stdout \
@ -317,12 +317,12 @@ test-ufw-docker--get-env-list() {
load-ufw-docker-function ufw-docker--get-env-list
ufw-docker--get-env-list
}
test-ufw-docker--get-env-list-assert() {
test-get-env-list-assert() {
@stdout "id111111 webapp/9090/tcp"
@stdout "id222222 foo/2222/udp"
}
test-ufw-docker--get-env-list-multiple() {
test-get-env-list-with-multiple-values() {
@mock docker service inspect ufw-docker-agent \
--format '{{range $k,$v := .Spec.TaskTemplate.ContainerSpec.Env}}{{ $v }}{{"\n"}}{{end}}' \
=== @stdout \
@ -338,7 +338,7 @@ test-ufw-docker--get-env-list-multiple() {
load-ufw-docker-function ufw-docker--get-env-list
ufw-docker--get-env-list
}
test-ufw-docker--get-env-list-multiple-assert() {
test-get-env-list-with-multiple-values-assert() {
@stdout "id111111 webapp/9090/tcp"
@stdout "id111111 webapp/8888/tcp"
@stdout "id111111 webapp/5555/udp"
@ -347,13 +347,13 @@ test-ufw-docker--get-env-list-multiple-assert() {
}
test-ufw-docker--service-delete-no-matches() {
test-service-delete-fails-for-non-existent-service() {
@mockfalse ufw-docker--get-service-id webapp
load-ufw-docker-function ufw-docker--service-delete
ufw-docker--service-delete webapp
}
test-ufw-docker--service-delete-no-matches-assert() {
test-service-delete-fails-for-non-existent-service-assert() {
@do-nothing
@fail
}
@ -364,14 +364,14 @@ function mock-abcd1234-webapp() {
@mock ufw-docker--list-service-ports webapp === @stdout "22 2222/tcp" "80 8080/tcp" "53 5353/udp"
}
test-ufw-docker--service-delete-matches() {
test-service-delete-all-ports-for-service() {
mock-abcd1234-webapp
@mock ufw-docker--get-env-list === @stdout "xxx 888/tcp" "abcd1234 webapp/22/tcp"
load-ufw-docker-function ufw-docker--service-delete
ufw-docker--service-delete webapp
}
test-ufw-docker--service-delete-matches-assert() {
test-service-delete-all-ports-for-service-assert() {
docker service update --update-parallelism=0 \
--env-add ufw_docker_agent_image="${ufw_docker_agent_image}" \
--env-add "ufw_public_abcd1234=webapp/deny" \
@ -380,14 +380,14 @@ test-ufw-docker--service-delete-matches-assert() {
"${ufw_docker_agent}"
}
test-ufw-docker--service-delete-matches2() {
test-service-delete-all-ports-for-service-with-multiple-rules() {
mock-abcd1234-webapp
@mock ufw-docker--get-env-list === @stdout "xxx 888/tcp" "abcd1234 webapp/22/tcp" "abcd1234 webapp/53/udp" "abcd1234 webapp/80/tcp"
load-ufw-docker-function ufw-docker--service-delete
ufw-docker--service-delete webapp
}
test-ufw-docker--service-delete-matches2-assert() {
test-service-delete-all-ports-for-service-with-multiple-rules-assert() {
docker service update --update-parallelism=0 \
--env-add ufw_docker_agent_image="${ufw_docker_agent_image}" \
--env-add "ufw_public_abcd1234=webapp/deny" \
@ -397,14 +397,14 @@ test-ufw-docker--service-delete-matches2-assert() {
}
test-ufw-docker--service-delete-matches-with-a-port() {
test-service-delete-specific-port-for-service() {
mock-abcd1234-webapp
@mock ufw-docker--get-env-list === @stdout "xxx 888/tcp" "abcd1234 webapp/80/tcp"
load-ufw-docker-function ufw-docker--service-delete
ufw-docker--service-delete webapp 8080
}
test-ufw-docker--service-delete-matches-with-a-port-assert() {
test-service-delete-specific-port-for-service-assert() {
docker service update --update-parallelism=0 \
--env-add ufw_docker_agent_image="${ufw_docker_agent_image}" \
--env-add "ufw_public_abcd1234=webapp/80/tcp/deny" \
@ -414,14 +414,14 @@ test-ufw-docker--service-delete-matches-with-a-port-assert() {
}
test-ufw-docker--service-delete-matches-with-a-port2() {
test-service-delete-specific-port-for-service-from-multiple-rules() {
mock-abcd1234-webapp
@mock ufw-docker--get-env-list === @stdout "xxx 888/tcp" "abcd1234 webapp/80/tcp" "abcd1234 webapp/53/udp" "abcd1234 webapp/53/tcp"
load-ufw-docker-function ufw-docker--service-delete
ufw-docker--service-delete webapp 8080
}
test-ufw-docker--service-delete-matches-with-a-port2-assert() {
test-service-delete-specific-port-for-service-from-multiple-rules-assert() {
docker service update --update-parallelism=0 \
--env-add ufw_docker_agent_image="${ufw_docker_agent_image}" \
--env-add "ufw_public_abcd1234=webapp/80/tcp/deny,webapp/53/udp,webapp/53/tcp" \
@ -431,14 +431,14 @@ test-ufw-docker--service-delete-matches-with-a-port2-assert() {
}
test-ufw-docker--service-delete-matches-with-a-port-but-no-previous-rule() {
test-service-delete-adds-deny-rule-for-port-without-previous-rule() {
mock-abcd1234-webapp
@mock ufw-docker--get-env-list === @stdout "xxx 888/tcp" "abcd1234 webapp/53/tcp"
load-ufw-docker-function ufw-docker--service-delete
ufw-docker--service-delete webapp 2222
}
test-ufw-docker--service-delete-matches-with-a-port-but-no-previous-rule-assert() {
test-service-delete-adds-deny-rule-for-port-without-previous-rule-assert() {
docker service update --update-parallelism=0 \
--env-add ufw_docker_agent_image="${ufw_docker_agent_image}" \
--env-add "ufw_public_abcd1234=webapp/22/tcp/deny,webapp/53/tcp" \
@ -448,14 +448,14 @@ test-ufw-docker--service-delete-matches-with-a-port-but-no-previous-rule-assert(
}
test-ufw-docker--service-delete-matches-with-a-port-proto-pair() {
test-service-delete-specific-port-protocol-for-service() {
mock-abcd1234-webapp
@mock ufw-docker--get-env-list === @stdout "xxx 888/tcp" "abcd1234 webapp/80/tcp"
load-ufw-docker-function ufw-docker--service-delete
ufw-docker--service-delete webapp 8080/tcp
}
test-ufw-docker--service-delete-matches-with-a-port-proto-pair-assert() {
test-service-delete-specific-port-protocol-for-service-assert() {
docker service update --update-parallelism=0 \
--env-add ufw_docker_agent_image="${ufw_docker_agent_image}" \
--env-add "ufw_public_abcd1234=webapp/80/tcp/deny" \
@ -464,14 +464,14 @@ test-ufw-docker--service-delete-matches-with-a-port-proto-pair-assert() {
"${ufw_docker_agent}"
}
test-ufw-docker--service-delete-matches-with-a-port-proto-pair2() {
test-service-delete-specific-port-protocol-for-service-from-multiple-rules() {
mock-abcd1234-webapp
@mock ufw-docker--get-env-list === @stdout "xxx 888/tcp" "abcd1234 webapp/80/tcp" "abcd1234 webapp/53/udp" "abcd1234 webapp/53/tcp"
load-ufw-docker-function ufw-docker--service-delete
ufw-docker--service-delete webapp 5353/udp
}
test-ufw-docker--service-delete-matches-with-a-port-proto-pair2-assert() {
test-service-delete-specific-port-protocol-for-service-from-multiple-rules-assert() {
docker service update --update-parallelism=0 \
--env-add ufw_docker_agent_image="${ufw_docker_agent_image}" \
--env-add "ufw_public_abcd1234=webapp/53/udp/deny,webapp/80/tcp,webapp/53/tcp" \
@ -480,18 +480,18 @@ test-ufw-docker--service-delete-matches-with-a-port-proto-pair2-assert() {
"${ufw_docker_agent}"
}
test-ufw-docker--service-delete-matches-with-a-not-matched-port() {
test-service-delete-fails-for-unmatched-port() {
mock-abcd1234-webapp
load-ufw-docker-function ufw-docker--service-delete
ufw-docker--service-delete webapp 3333
}
test-ufw-docker--service-delete-matches-with-a-not-matched-port-assert() {
test-service-delete-fails-for-unmatched-port-assert() {
@do-nothing
@fail
}
test-ufw-docker--service-delete-matches-with-a-not-matched-protocal() {
test-service-delete-fails-for-unmatched-protocol() {
@mock ufw-docker--get-service-id webapp === @stdout "abcd1234"
@mock ufw-docker--get-service-name webapp === @stdout webapp
@mock ufw-docker--list-service-ports webapp === @stdout "22 2222/tcp" "80 8080/tcp" "53 5353/udp"
@ -499,16 +499,16 @@ test-ufw-docker--service-delete-matches-with-a-not-matched-protocal() {
load-ufw-docker-function ufw-docker--service-delete
ufw-docker--service-delete webapp 8080/udp
}
test-ufw-docker--service-delete-matches-with-a-not-matched-protocal-assert() {
test-service-delete-fails-for-unmatched-protocol-assert() {
@do-nothing
@fail
}
test-ufw-docker--list-service-ports() {
test-list-service-ports() {
load-ufw-docker-function ufw-docker--list-service-ports
ufw-docker--list-service-ports foo
}
test-ufw-docker--list-service-ports-assert() {
test-list-service-ports-assert() {
docker service inspect foo --format '{{range .Endpoint.Spec.Ports}}{{.PublishedPort}} {{.TargetPort}}/{{.Protocol}}{{"\n"}}{{end}}'
}
@ -523,13 +523,13 @@ function setup-mock-for-testing-docker-entrypoint() {
@allow-real tr ',' '\n'
}
test-dockerentrypoint() {
test-docker-entrypoint-updates-ufw-rules() {
setup-mock-for-testing-docker-entrypoint
declare -x ufw_public_id333333=gamma/8080/tcp/deny,gamma/5353/udp
@run "$working_dir"/../docker-entrypoint.sh update-ufw-rules
}
test-dockerentrypoint-assert() {
test-docker-entrypoint-updates-ufw-rules-assert() {
declare -a docker_opts=(run --rm -t --name ufw-docker-agent-42-200902140731
--cap-add NET_ADMIN --network host --env DEBUG=false
-v /var/run/docker.sock:/var/run/docker.sock
@ -542,13 +542,13 @@ test-dockerentrypoint-assert() {
docker "${docker_opts[@]}" add-service-rule id333333 5353/udp
}
test-dockerentrypoint-deny-first() {
test-docker-entrypoint-updates-ufw-rules-with-deny-first() {
setup-mock-for-testing-docker-entrypoint
declare -x ufw_public_id333333=gamma/5353/udp,gamma/8080/tcp/deny
@run "$working_dir"/../docker-entrypoint.sh update-ufw-rules
}
test-dockerentrypoint-deny-first-assert() {
test-docker-entrypoint-updates-ufw-rules-with-deny-first-assert() {
declare -a docker_opts=(run --rm -t --name ufw-docker-agent-42-200902140731
--cap-add NET_ADMIN --network host --env DEBUG=false
-v /var/run/docker.sock:/var/run/docker.sock