Skip to content

chore: introduce bin scripts including bin/run for running the tool #361

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
G-Rath merged 8 commits into from
Sep 2, 2026
Merged

chore: introduce bin scripts including bin/run for running the tool #361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
700c923
refactor: move `setup` into `bin`
G-Rath Aug 20, 2026
84891e6
fix: make sure `bin/setup` runs from root
G-Rath Aug 20, 2026
0f88a94
feat: add scripts for building and running the tool through docker
G-Rath Sep 1, 2026
023fe4f
test: use new `bin/run` script
G-Rath Sep 1, 2026
fffd605
fix: use the user id and group of the current user
G-Rath Sep 1, 2026
99b6af0
fix: disable sandbox and dev-shm usage
G-Rath Sep 1, 2026
ba5a591
feat: allow externally setting user and group id
G-Rath Sep 1, 2026
293a267
fix: make sure the results directory exists
G-Rath Sep 1, 2026
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
18 changes: 18 additions & 0 deletions bin/build
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#!/usr/bin/env bash

set -e

# make sure script runs from project root directory
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
PROJECT_ROOT="$(cd "${SCRIPT_DIR}/.." && pwd -P)"
cd "${PROJECT_ROOT}"

# default to the current user and group
: "${IMAGE_USER_ID:=$(id -u)}"
: "${IMAGE_GROUP_ID:=$(id -g)}"

docker build \
-t cwac \
--build-arg USER_ID="$IMAGE_USER_ID" \
--build-arg GROUP_ID="$IMAGE_GROUP_ID" \
.
20 changes: 20 additions & 0 deletions bin/run
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#!/usr/bin/env bash

set -e

# make sure script runs from project root directory
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
PROJECT_ROOT="$(cd "${SCRIPT_DIR}/.." && pwd -P)"
cd "${PROJECT_ROOT}"

bin/build

# make sure the "results" directory exists
mkdir -p results

docker run --rm \
--mount 'type=bind,src=./config,dst=/cwac/config' \
--mount 'type=bind,src=./base_urls,dst=/cwac/base_urls' \
--mount 'type=bind,src=./results,dst=/cwac/results' \
--env CHROME_EXTRA_ARGS='--no-sandbox,--disable-dev-shm-usage' \
cwac .venv/bin/python -u cwac.py "${@}"
7 changes: 7 additions & 0 deletions setup.sh → bin/setup
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
#!/bin/bash

set -e

# make sure script runs from project root directory
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
PROJECT_ROOT="$(cd "${SCRIPT_DIR}/.." && pwd -P)"
cd "${PROJECT_ROOT}"

# This script (attempts) to set up CWAC automatically.
# Ensure Python 3.12+ is 'python'.

Expand Down
16 changes: 1 addition & 15 deletions tests/e2e.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,4 @@ cat config/config_default.json | jq '
.audit_plugins |= map_values(.enabled = true)
' > config/config_e2e.json

# make sure the "results" directory exists
mkdir -p results

docker build \
--iidfile /tmp/cwac_image_id \
-t cwac-e2e-test-script:latest \
--build-arg USER_ID=$(id -u) \
--build-arg GROUP_ID=$(id -g) \
.
docker run --rm \
--mount "type=bind,src=./config,dst=/cwac/config" \
--mount "type=bind,src=./base_urls,dst=/cwac/base_urls" \
--mount "type=bind,src=./results,dst=/cwac/results" \
-e CHROME_EXTRA_ARGS='--no-sandbox,--disable-dev-shm-usage' \
$(cat /tmp/cwac_image_id) .venv/bin/python -u cwac.py config_e2e.json
bin/run config_e2e.json
Loading