From e8c79296780f24abde28fcad2d526f7cd8b1521e Mon Sep 17 00:00:00 2001 From: kkalev Date: Fri, 8 Dec 2023 10:33:05 +0200 Subject: [PATCH] docs: better puppeteer documentation --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2a3e6d5..62fa66c 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ console.log(url[0]); - Example: `await gunet.casLogin(page, process.env.CAS_USER, process.env.CAS_PASSWORD,process.env.CAS_LANG);` ## Scripts -* `run_test.sh `: Run a specific specified scenario against the ``. For example: `./run_test.sh cas https://host.docker.internal:8443/cas` +* `run_test.sh `: Run a specific specified scenario against the ``. For example: `run_test.sh cas https://host.docker.internal:8443/cas`. The `scenario` is a folder under `scenarios/` containing a file `script.js` ## Usage * Build: `docker compose -f docker-compose.build.yaml build` @@ -134,9 +134,9 @@ COPY scenarios/ ${PUPPETEER_ROOT}/scenarios/ - `CAS_TYPE`: The CAS type. Can be one of `simple-cas` for typical CAS (default) or `gunet-cas` (for GUNet CAS) * Show module version: `docker run --rm ghcr.io/gunet/puppeteer npm list` * General Run: `docker run -it --cap-add=SYS_ADMIN --rm ghcr.io/gunet/puppeteer node --unhandled-rejections=strict ` -* Using the `run_test.sh`: `docker run -it --cap-add=SYS_ADMIN --rm ghcr.io/gunet/puppeteer ./run_test.sh ` * Specific scenarios: - `cas`: `./login.js ` +* Using the `run_test.sh` (scenarios ): `docker run -it --cap-add=SYS_ADMIN --rm ghcr.io/gunet/puppeteer bash run_test.sh ` * Arguments - ``: An example might be `https://sso.uoi.gr` or `https://worker-01.dev.gunet.gr:8443/cas` (in the case of `simple-cas`) * Automatic testig with docker compose stack: `docker compose -f up --exit-code-from --attach