Skip to content

[codex] Address testbed procedure review #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Joncallim merged 1 commit into from
Jun 26, 2026
Merged

[codex] Address testbed procedure review #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 18 additions & 13 deletions docs/testing/TESTBED_DOCKER_PROCEDURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,20 @@ the fixture-labeled Docker resources.
Run from the repository root:

```bash
cd /Users/jonathanlim/Documents/GitHub/DockerMap
cd /path/to/DockerMap
```

If you already have the repository open in a shell, stay in that repository
root and run the commands from there.

Confirm required tools are available:

```bash
node --version
npm --version
cargo --version
docker version
docker compose version
(docker version && docker compose version) || \
(sudo -n docker version && sudo -n docker compose version)
curl --version
```

Expand Down Expand Up @@ -99,6 +102,7 @@ STATE_FILE="${TMPDIR:-/tmp}/dockermap-fixture-current.env"
set -a
source "$STATE_FILE"
set +a
IFS=' ' read -r -a DOCKER_CMD <<< "${DOCKER_CMD_TEXT:-docker}"
```

For a custom state file:
Expand All @@ -108,6 +112,7 @@ STATE_FILE="/tmp/dockermap-testbed.env"
set -a
source "$STATE_FILE"
set +a
IFS=' ' read -r -a DOCKER_CMD <<< "${DOCKER_CMD_TEXT:-docker}"
```

Confirm the recorded URLs:
Expand All @@ -124,7 +129,7 @@ The default state file is `${TMPDIR:-/tmp}/dockermap-fixture-current.env`.
List the fixture containers:

```bash
docker ps --filter "label=$LABEL_EXPR" \
"${DOCKER_CMD[@]}" ps --filter "label=$LABEL_EXPR" \
--format 'table {{.Names}}\t{{.Image}}\t{{.Status}}\t{{.Ports}}'
```

Expand All @@ -140,15 +145,15 @@ Expected:
Confirm the unlabeled control container exists outside the label filter:

```bash
docker ps --filter "name=$CONTROL_CONTAINER" \
"${DOCKER_CMD[@]}" ps --filter "name=$CONTROL_CONTAINER" \
--format 'table {{.Names}}\t{{.Status}}'
```

List fixture networks and volumes:

```bash
docker network ls --filter "label=$LABEL_EXPR"
docker volume ls --filter "label=$LABEL_EXPR"
"${DOCKER_CMD[@]}" network ls --filter "label=$LABEL_EXPR"
"${DOCKER_CMD[@]}" volume ls --filter "label=$LABEL_EXPR"
```

Expected networks:
Expand Down Expand Up @@ -349,9 +354,9 @@ The testbed pass is acceptable when:
If a step fails, capture:

```bash
docker ps -a --filter "label=$LABEL_EXPR"
docker network ls --filter "label=$LABEL_EXPR"
docker volume ls --filter "label=$LABEL_EXPR"
"${DOCKER_CMD[@]}" ps -a --filter "label=$LABEL_EXPR"
"${DOCKER_CMD[@]}" network ls --filter "label=$LABEL_EXPR"
"${DOCKER_CMD[@]}" volume ls --filter "label=$LABEL_EXPR"
tail -200 "$FIXTURE_DIR/logs/daemon.log"
tail -200 "$FIXTURE_DIR/logs/api.log"
tail -200 "$FIXTURE_DIR/logs/web.log"
Expand Down Expand Up @@ -380,9 +385,9 @@ scripts/dockermap-fixture-down.sh --state-file /tmp/dockermap-testbed.env
Confirm no fixture-labeled resources remain:

```bash
docker ps -a --filter "label=$LABEL_EXPR"
docker network ls --filter "label=$LABEL_EXPR"
docker volume ls --filter "label=$LABEL_EXPR"
"${DOCKER_CMD[@]}" ps -a --filter "label=$LABEL_EXPR"
"${DOCKER_CMD[@]}" network ls --filter "label=$LABEL_EXPR"
"${DOCKER_CMD[@]}" volume ls --filter "label=$LABEL_EXPR"
```

The teardown script removes DockerMap processes, the unlabeled control
Expand Down
6 changes: 3 additions & 3 deletions scripts/dockermap-fixture-up.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,15 @@ if [[ -e "$STATE_FILE" ]]; then
fi

detect_docker() {
if docker version --format '{{.Server.Version}}' >/dev/null 2>&1; then
if docker version --format '{{.Server.Version}}' >/dev/null 2>&1 && docker compose version >/dev/null 2>&1; then
DOCKER_CMD=(docker)
return
fi
if sudo -n docker version --format '{{.Server.Version}}' >/dev/null 2>&1; then
if sudo -n docker version --format '{{.Server.Version}}' >/dev/null 2>&1 && sudo -n docker compose version >/dev/null 2>&1; then
DOCKER_CMD=(sudo -n docker)
return
fi
echo "Docker is not reachable by the current user or sudo -n docker." >&2
echo "Docker and Docker Compose are not reachable together by the current user or sudo -n docker." >&2
exit 2
}

Expand Down
Loading