Compare commits
7
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
08ced00f62 | ||
|
|
0301fd2f0b | ||
|
|
c0aa0b4b2b | ||
|
|
6871e54333 | ||
|
|
5d28e682b4 | ||
|
|
37f3cc436a | ||
|
|
a830e3ae5f |
@@ -0,0 +1,41 @@
|
|||||||
|
# Publish the project's wiki pages to the git host's wiki.
|
||||||
|
#
|
||||||
|
# On a push to main that changes docs/wiki/, this workflow calls the reusable
|
||||||
|
# workflow of TirSystem/github-action, which copies the Markdown pages of
|
||||||
|
# docs/wiki/ to the wiki of this repository (framework/process/wiki.md says
|
||||||
|
# what the folder holds: English and the PO language as a minimum).
|
||||||
|
#
|
||||||
|
# INSTALLING THIS FILE IS THE OPT-IN. There is no marker file. A project that
|
||||||
|
# does not copy it publishes nothing.
|
||||||
|
#
|
||||||
|
# Copy it to .gitea/workflows/publish-wiki.yml. Then:
|
||||||
|
# 1. Create the secret TOKEN_FOR_GITEA_WIKI in the organization of the
|
||||||
|
# repository: a Gitea token with scope write:repository for a user that
|
||||||
|
# can write this repository (see guides/credentials.md of github-action).
|
||||||
|
# 2. Enable the wiki in the repository settings.
|
||||||
|
# 3. Keep @v1, or pin the exact release tag together with tools-ref.
|
||||||
|
# A runner must be registered for the repository (or its organization).
|
||||||
|
#
|
||||||
|
# prune: "true" deletes wiki pages that are not in docs/wiki/, so the wiki
|
||||||
|
# always equals the folder. Leave it "false" to keep hand-written pages.
|
||||||
|
|
||||||
|
name: Publish wiki
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [ main ]
|
||||||
|
paths:
|
||||||
|
- "docs/wiki/**"
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
wiki:
|
||||||
|
uses: TirSystem/git-workflows/.gitea/workflows/publish-wiki-pages.yml@v1
|
||||||
|
with:
|
||||||
|
wiki_dir: docs/wiki
|
||||||
|
prune: "true"
|
||||||
|
secrets:
|
||||||
|
TOKEN_FOR_GITEA_WIKI: ${{ secrets.TOKEN_FOR_GITEA_WIKI }}
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
# Publish accepted milestones to the git host.
|
||||||
|
#
|
||||||
|
# On a push to main that changes docs/milestones/ or docs/sqa/reviews/, this
|
||||||
|
# workflow runs `sync-project.sh --accepted-only --apply`: every milestone whose
|
||||||
|
# latest Version History row is Accepted and whose latest review record is a Go
|
||||||
|
# is created or updated as a Milestone with its tasks as Issues. A Proposed
|
||||||
|
# milestone, or one without a Go review, is skipped. Nothing is closed or
|
||||||
|
# deleted. Each run updates the issues of every accepted milestone (the sync is
|
||||||
|
# idempotent, but the host records the edit).
|
||||||
|
#
|
||||||
|
# INSTALLING THIS FILE IS THE STANDING AUTHORIZATION TO PUBLISH. A project opts
|
||||||
|
# in by copying it; an agent does not install it on its own.
|
||||||
|
#
|
||||||
|
# Copy it to .gitea/workflows/sync-milestones.yml (Gitea Actions) or
|
||||||
|
# .github/workflows/sync-milestones.yml (GitHub Actions). Then:
|
||||||
|
# 1. Create a CI secret and put its name in the two `secrets.` lines below
|
||||||
|
# (SYNC_TOKEN is a placeholder). Gitea does not accept secret names that
|
||||||
|
# start with GITEA_ or GITHUB_.
|
||||||
|
# 2. Give the token the smallest scope that works: read and write on issues
|
||||||
|
# and milestones. If the framework submodule is a private repository, the
|
||||||
|
# token must also be able to read it (it is used to check it out).
|
||||||
|
# 3. Run it once by hand from the Actions page with dry_run left on: it prints
|
||||||
|
# the plan and creates nothing. Turn dry_run off only for a real run.
|
||||||
|
# A runner must be registered for the repository (or its organisation).
|
||||||
|
#
|
||||||
|
# The steps are one command each: the logic is framework/scripts/ci-publish-milestones.sh,
|
||||||
|
# a file that is linted and tested (QC-WF-001 criterion 20).
|
||||||
|
|
||||||
|
name: Publish accepted milestones
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
paths:
|
||||||
|
- "docs/milestones/**"
|
||||||
|
- "docs/sqa/reviews/**"
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
dry_run:
|
||||||
|
description: "Preview only: print the plan and create nothing"
|
||||||
|
type: boolean
|
||||||
|
default: true
|
||||||
|
|
||||||
|
# Two merges in a row queue instead of racing.
|
||||||
|
concurrency:
|
||||||
|
group: publish-accepted-milestones
|
||||||
|
cancel-in-progress: false
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
publish:
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 15
|
||||||
|
steps:
|
||||||
|
- name: Check out the project and its framework submodule
|
||||||
|
uses: actions/checkout@v4.2.2
|
||||||
|
with:
|
||||||
|
submodules: recursive
|
||||||
|
token: ${{ secrets.SYNC_TOKEN }}
|
||||||
|
|
||||||
|
- name: Make sure curl and jq are available
|
||||||
|
run: bash framework/scripts/ci-publish-milestones.sh ensure-tools
|
||||||
|
|
||||||
|
- name: Publish accepted milestones
|
||||||
|
env:
|
||||||
|
# Gitea reads GITEA_TOKEN, GitHub's gh reads GH_TOKEN; both come from
|
||||||
|
# the one secret named above.
|
||||||
|
GITEA_TOKEN: ${{ secrets.SYNC_TOKEN }}
|
||||||
|
GH_TOKEN: ${{ secrets.SYNC_TOKEN }}
|
||||||
|
# Empty on a push (a real run); "true" or "false" on a manual run.
|
||||||
|
DRY_RUN: ${{ inputs.dry_run }}
|
||||||
|
run: bash framework/scripts/ci-publish-milestones.sh publish
|
||||||
@@ -8,6 +8,7 @@ A Selenium bot that books classes at the fictional gym "Snack and Lift" for you:
|
|||||||
- [Requirements](#-requirements)
|
- [Requirements](#-requirements)
|
||||||
- [Setup](#-setup)
|
- [Setup](#-setup)
|
||||||
- [Run](#-run)
|
- [Run](#-run)
|
||||||
|
- [Lecture steps and screenshots](#-lecture-steps-and-screenshots)
|
||||||
- [Tests](#-tests)
|
- [Tests](#-tests)
|
||||||
- [License](#-license)
|
- [License](#-license)
|
||||||
- [Links](#-links)
|
- [Links](#-links)
|
||||||
@@ -112,6 +113,22 @@ docker build -t snack-and-lift .
|
|||||||
docker run --rm snack-and-lift
|
docker run --rm snack-and-lift
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 📸 Lecture steps and screenshots
|
||||||
|
|
||||||
|
Each step has a wiki page that explains what it teaches, in [English](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift/wiki/Home), [Dansk](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift/wiki/Home-da) and [Bahasa Melayu](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift/wiki/Home-ms). Only the screenshot of step 1 is in the repository yet: the others need a run with a real gym account, which the maintainer makes with `--screenshot-dir` (see [Getting started](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift/wiki/Getting-Started)). Until then their images do not show.
|
||||||
|
|
||||||
|
| Step | Wiki page | Screenshot |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| 1 | [Setup and navigation](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift/wiki/Step-1) |  |
|
||||||
|
| 2 | [Automated login](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift/wiki/Step-2) |  |
|
||||||
|
| 3 | [Book the next Tuesday class](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift/wiki/Step-3) |  |
|
||||||
|
| 4 | [Check if a class is booked](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift/wiki/Step-4) |  |
|
||||||
|
| 5 | [Counters and summary](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift/wiki/Step-5) |  |
|
||||||
|
| 6 | [Every Tuesday and Thursday class](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift/wiki/Step-6) |  |
|
||||||
|
| 7 | [Verify on My Bookings](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift/wiki/Step-7) |  |
|
||||||
|
| 8 | [Time travel QA](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift/wiki/Step-8) |  |
|
||||||
|
| 9 | [Resilience (retry)](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift/wiki/Step-9) |  |
|
||||||
|
|
||||||
## 🧪 Tests
|
## 🧪 Tests
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ document of a type. `Primary File` may contain a glob (e.g.
|
|||||||
| PP | Project Plan | docs/project-plan.md | 002 |
|
| PP | Project Plan | docs/project-plan.md | 002 |
|
||||||
| MIL | Milestone / Gateway | docs/milestones/*.md | 009 |
|
| MIL | Milestone / Gateway | docs/milestones/*.md | 009 |
|
||||||
| ADR | Architecture Decision Record | docs/adr/adr-NNNN-*.md | 0004 |
|
| ADR | Architecture Decision Record | docs/adr/adr-NNNN-*.md | 0004 |
|
||||||
| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 021 |
|
| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 023 |
|
||||||
| TM | Traceability Matrix | docs/sqa/traceability-matrix.md | 002 |
|
| TM | Traceability Matrix | docs/sqa/traceability-matrix.md | 002 |
|
||||||
| DICT | Domain Dictionary | docs/dictionary.md | 002 |
|
| DICT | Domain Dictionary | docs/dictionary.md | 002 |
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,62 @@
|
|||||||
|
# SQA Review Record
|
||||||
|
|
||||||
|
## Metadata
|
||||||
|
| Key | Value |
|
||||||
|
| --- | --- |
|
||||||
|
| ID | RC-021 |
|
||||||
|
| CrossReference | [MIL-007], [QC-PY-001] |
|
||||||
|
|
||||||
|
## Version History
|
||||||
|
| Date | Status | Author | Reviewer | Change | Commit |
|
||||||
|
| --- | --- | --- | --- | --- | --- |
|
||||||
|
| 2026-10-28 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S02 | Review record, full review of the source and tests of MIL-007 | [5d28e68] |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Artifact Under Review
|
||||||
|
|
||||||
|
- Instance reviewed: [MIL-007]
|
||||||
|
- Checklist used: [QC-PY-001] (`QC-PY-001`)
|
||||||
|
- Scope: full review of the source and tests of MIL-007
|
||||||
|
- Language and domain: n/a
|
||||||
|
- Language reviewer: none
|
||||||
|
- Mode: autonomous, not independent (the reviewer is `AI as stand-in for S02`)
|
||||||
|
|
||||||
|
## Checklist Results
|
||||||
|
|
||||||
|
| # | Criterion | Status | Evidence/Notes |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| 1 | Packages, modules, functions, variables, classes and constants follow PEP 8 casing (`snake_case`, `PascalCase`, `UPPER_SNAKE`) | Pass | Modules, functions and variables are `snake_case`, classes `PascalCase`, constants `UPPER_SNAKE`; `ruff check` with the N rules passes. |
|
||||||
|
| 2 | Names state purpose in the domain's language; no unexplained abbreviations, no single-letter names outside tiny scopes | Pass | Names state purpose (for example `retry`, `login`, `book_class`, `get_my_bookings`); no single-letter names outside comprehensions. |
|
||||||
|
| 3 | Code is produced by the project's formatter and passes its linter with no unexplained suppressions | Pass | `ruff format` leaves 0 files changed and `ruff check` reports 0 findings; there is no suppression. |
|
||||||
|
| 4 | Every function and method signature is type-annotated, including `-> None` | Pass | Every function and method has annotations (ruff ANN rules pass), including `-> None`. |
|
||||||
|
| 5 | No bare `except:`, no swallowed exceptions; specific exceptions are raised and the cause is kept (`raise ... from`) | Pass | No bare `except`; specific exceptions are caught, and re-raised with `raise ... from` where the cause matters. |
|
||||||
|
| 6 | No mutable default arguments and no shadowed builtins | Pass | No mutable default arguments; no builtin is shadowed (ruff B and A-style checks pass). |
|
||||||
|
| 7 | Files, locks and connections are managed with context managers | Pass | Files and the browser are managed with `with`/`try-finally`; no unmanaged file handle exists. |
|
||||||
|
| 8 | Public modules, classes and functions have docstrings that say what, not how | Pass | Public modules, classes and functions have Doxygen docstrings (`@brief`, `@param`, `@return`). |
|
||||||
|
| 9 | Logging uses `logging`, not `print`; no secrets or personal data in log output | Pass | No print calls; messages go through `logging`. |
|
||||||
|
| 10 | Classes and operations trace to the Design Class Diagram they implement; deviations are recorded | N-A | No Design Class Diagram exists; ADR-0001 records that design artifacts are skipped. Classes follow ADR-0002. |
|
||||||
|
| 11 | Tests exist for new behaviour, are named for the behaviour, and do not depend on order or the network | Pass | 237 unit tests (retry, resilient login, booking and bookings read, a seeded chaos test at 50% failure: 97 of 100 seeds complete, seeds 0 to 17 must all pass) need no browser or network; 20 container tests run the adapter against failing local fixtures; coverage of the non-infrastructure modules is 100%. |
|
||||||
|
| 12 | Type checker runs in strict mode without errors; `Any` is justified in a comment | N-A | No strict type checker is configured; annotations are complete and checked by ruff. |
|
||||||
|
| 13 | Dependencies are declared and pinned in the project's dependency file, none unused | Pass | `pyproject.toml` declares Selenium (runtime) and pytest, pytest-cov, ruff (dev) with lower bounds; none is unused. |
|
||||||
|
| 14 | Each piece of knowledge (a business rule, constant, format, validation or query) is defined in one place; code is merged only where it expresses the same knowledge, not where it merely looks alike | Pass | Each rule, constant and message exists once (constants in `constants.py`, rules in `domain/`). |
|
||||||
|
| 15 | Imports point inward: business-rule modules import no framework, database, UI or delivery-mechanism code, and there are no import cycles | Pass | `domain` and `application` import no Selenium; only `infrastructure` imports it; no import cycle exists. |
|
||||||
|
| 16 | SOLID holds: a class or module has one reason to change; new behaviour is added by extension, not by editing a type test in several places; subclasses honour the contract of their base; protocols are narrow; high-level code depends on protocols or abstract types and receives its implementations | Pass | One reason to change per module; the adapter hides Selenium behind a port; fakes honour the port contract. |
|
||||||
|
| 17 | Source is laid out in the layers and folders of the clean architecture folder structure (`domain`, `application`, `infrastructure`, `presentation` packages under `src/`, and `unit`, `integration` and `e2e` under `tests/`), in `snake_case`, and imports between the layers point inward | Pass | Layout follows `src/snack_and_lift/{domain,application,infrastructure}` and `tests/{unit,integration,e2e}`; there is no presentation layer for a command-line bot (ADR-0002). |
|
||||||
|
| 18 | File and folder names are English, contain no space and no character outside letters, digits, `-`, `_` and `.`, and follow the casing of the language for files | Pass | All file and folder names are English lowercase with `_`, `-` and `.` only. |
|
||||||
|
|
||||||
|
## Overall Verdict
|
||||||
|
|
||||||
|
Go-with-conditions - the code of MIL-007 meets every Mandatory criterion of QC-PY-001 and there is no blocking finding, but part of the gate evidence cannot be produced by the stand-in. Gate criteria 1 (retry unit tests) and 2 (a booking only counts when the page confirms it) are met in tests. Criterion 3 (three container runs on the live site at 50% simulated failure) is not verified, and criterion 4 is not met: `step-9.png` comes from a run with an account. The framework forbids the stand-in to enter passwords or register on a third-party site, and the network simulation is an admin control behind a login. Known behaviour: a wrong password or an empty bookings page is also retried seven times (about 3 seconds) before exit code 1. The review is not independent: the AI wrote and reviewed it as stand-in for S02, and S01 can challenge it in the end-of-run summary.
|
||||||
|
|
||||||
|
## Action Items
|
||||||
|
|
||||||
|
| Action | Owner | Due |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Enable the network simulation at 50% as admin, run the bot three times with your own account and keep `docs/images/step-9.png` | S01 | when S01 has time |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[MIL-007]: ../../milestones/mil-007-resilience.md
|
||||||
|
[QC-PY-001]: ../../../framework/qc/code/qc-programming-python.md
|
||||||
|
[5d28e68]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift/commit/5d28e682b41e1a03b0cac1a6b2ea4977750d45b8
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
# SQA Review Record
|
||||||
|
|
||||||
|
## Metadata
|
||||||
|
| Key | Value |
|
||||||
|
| --- | --- |
|
||||||
|
| ID | RC-022 |
|
||||||
|
| CrossReference | [MIL-008], [QC-WF-001] |
|
||||||
|
|
||||||
|
## Version History
|
||||||
|
| Date | Status | Author | Reviewer | Change | Commit |
|
||||||
|
| --- | --- | --- | --- | --- | --- |
|
||||||
|
| 2026-10-28 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S02 | Review record, the workflows publish-wiki.yml and sync-milestones.yml of MIL-008 task 5 | [0301fd2] |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Artifact Under Review
|
||||||
|
|
||||||
|
- Instance reviewed: [MIL-008]
|
||||||
|
- Checklist used: [QC-WF-001] (`QC-WF-001`)
|
||||||
|
- Scope: the workflows publish-wiki.yml and sync-milestones.yml of MIL-008 task 5
|
||||||
|
- Language and domain: n/a
|
||||||
|
- Language reviewer: none
|
||||||
|
- Mode: autonomous, not independent (the reviewer is `AI as stand-in for S02`)
|
||||||
|
|
||||||
|
## Checklist Results
|
||||||
|
|
||||||
|
| # | Criterion | Status | Evidence/Notes |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| 1 | The file meets the YAML checklist ([QC-YML-001]) | Pending | `yamllint` is not installed on the stand-in's machine, so the YAML checklist QC-YML-001 was not run; the files parse (actionlint reads them) and use 2-space indentation. |
|
||||||
|
| 2 | The file is in `.gitea/workflows/` or `.github/workflows/` with the extension `.yml` or `.yaml`, and the same workflow does not exist in both directories | Pass | Both files are in `.gitea/workflows/` with the extension `.yml`; neither exists in `.github/workflows/`. |
|
||||||
|
| 3 | The file declares `name`, `on` and `jobs`; `on` lists explicit events and, where it matters, `branches` or `paths` | Pass | Both files declare `name`, `on` and `jobs`; `on` lists `push` on `main` with `paths`, and `workflow_dispatch`. |
|
||||||
|
| 4 | A header comment states the purpose, the triggers, the inputs, the secrets it needs, what it changes outside the repository, and the decision or milestone it implements | Pass | Both headers state the purpose, triggers, secrets, what changes outside the repository and the installation steps (copied from the framework template); the decision is MIL-008 task 5. |
|
||||||
|
| 5 | Every job and step has a descriptive `name`, unique within its job | Pass | `sync-milestones.yml` names every step. `publish-wiki.yml` has one job that calls a reusable workflow and has no steps of its own. |
|
||||||
|
| 6 | The file passes `actionlint` (or the project's workflow validation test) and the tool version is stated | Pass | `actionlint` 1.7.12 reports no finding for both files (exit code 0). |
|
||||||
|
| 7 | Every job declares `permissions` explicitly with the least access that works (`contents: read` or none by default); write access only on the job that needs it | Pass | `sync-milestones.yml` sets `contents: read` on its job; `publish-wiki.yml` sets `contents: read` for the whole workflow (added to the framework template). The wiki write uses the token secret. |
|
||||||
|
| 8 | Every action used is pinned to a full commit SHA or an exact release tag, never to a branch; a moving major tag (`@v1`) is accepted only for an action published by the same organisation under a stated release policy | Pass | `actions/checkout@v4.2.2` is an exact release tag. `publish-wiki.yml` uses `TirSystem/git-workflows/.gitea/workflows/publish-wiki-pages.yml@v1`, a moving major tag of a reusable workflow of the same organisation, which the framework template accepts. |
|
||||||
|
| 9 | No secret is written in the file; a secret is read as `secrets.NAME`, passed to a step through `env:`, never placed on a command line or echoed | Pass | Both files read `secrets.SYNC_TOKEN` and `secrets.TOKEN_FOR_GITEA_WIKI` only; no secret value is in the repository. |
|
||||||
|
| 10 | Untrusted text (`inputs.*`, event fields such as a title, branch name or label, step outputs derived from them) is never interpolated into a `run:` script; it is passed through `env:` and used as a quoted variable | Pass | No `run:` block interpolates `inputs.*` or event text; `DRY_RUN` is passed through `env:`. |
|
||||||
|
| 11 | A trigger that gives a run secrets or a write token on code from a fork or an untrusted branch (`pull_request_target`, `workflow_run`) does not check out or execute that code | Pass | Neither workflow uses `pull_request_target` or `workflow_run`. |
|
||||||
|
| 12 | A workflow that changes state outside the repository (release, tag, publish, sync, deploy) is started by hand or by a protected branch, and a manual run defaults to a dry run with an explicit input to apply | Pass | Both run on a push to `main` or by hand; the manual run of `sync-milestones.yml` defaults to a dry run. `publish-wiki.yml` has no dry run (it is a call of the reusable workflow). |
|
||||||
|
| 13 | The token the workflow uses has only the scope the job needs, and where the host's built-in token is enough it is used instead of a personal token | Pending | The scope of both tokens is set by S01 when the secrets are created. |
|
||||||
|
| 14 | Every job sets `runs-on` to an explicit label and `timeout-minutes` | Pass | `sync-milestones.yml` sets `runs-on: ubuntu-latest` and `timeout-minutes: 15`. `publish-wiki.yml` calls a reusable workflow, where the called workflow sets them (a calling job cannot). |
|
||||||
|
| 15 | `concurrency` is set where two runs would conflict: a check cancels the older run (`cancel-in-progress: true`); a publishing job queues (`cancel-in-progress: false`) | Pass | `sync-milestones.yml` sets `concurrency` with `cancel-in-progress: false`; `publish-wiki.yml` leaves it to the reusable workflow. |
|
||||||
|
| 16 | Triggers are filtered (`branches`, `paths`, `types`) so the workflow runs only for the changes it concerns | Pass | Both are filtered by `branches: [main]` and `paths`. |
|
||||||
|
| 17 | Tools and dependencies are installed at pinned versions; a version is a workflow input with a default or a value in one place | Pass | `sync-milestones.yml` installs nothing itself; `curl` and `jq` are checked by the framework script. The wiki workflow installs nothing. |
|
||||||
|
| 18 | A dependency cache is used where the install is slow enough to matter | N-A | No dependency is installed that a cache would speed up. |
|
||||||
|
| 19 | A failing step names the tool, the file and the reason in its log (annotation or `::error::` line) | Pending | Not verified: the log messages come from the framework script and the reusable workflow, which the stand-in did not run. |
|
||||||
|
| 20 | A `run:` block is within the limit on embedded program text of criterion 7 of [QC-YML-001]; a longer script is a file (`tools/`, or a shared repository fetched at a pinned ref) that the step calls with one command, and the workflow passes its settings through `env:` | Pass | Each `run:` block is one command; the logic is in `framework/scripts/ci-publish-milestones.sh`. |
|
||||||
|
| 21 | Logic used by more than one workflow or repository is a reusable workflow (`workflow_call`) or a composite action; each input has a `description`, a `type` and a `default` where one is sensible | Pass | `publish-wiki.yml` calls the reusable workflow; `sync-milestones.yml` calls one framework script. The inputs of `workflow_dispatch` have a description, type and default. |
|
||||||
|
| 22 | Every workflow feature used is verified on the instance that runs it, and the host and version are recorded; a feature the target hosts differ on is noted in the header | Pending | Neither workflow has run on the Gitea instance yet: the secrets do not exist and a merge to `main` is what triggers the first run. |
|
||||||
|
| 23 | A reusable workflow states, in its header, how a caller pins it and the script it fetches, so the workflow and its script are the same release | N-A | Neither file is a reusable workflow; both are callers. |
|
||||||
|
| 24 | A static test of the repository's workflows exists and runs on every pull request: valid YAML, required keys, explicit permissions and runner, no inline script above the limit | N-A | No static test of the workflows exists in this project; the checks are `actionlint` on request. |
|
||||||
|
|
||||||
|
## Overall Verdict
|
||||||
|
|
||||||
|
Go-with-conditions - the two workflows are the framework's templates, copied into `.gitea/workflows/`, and pass `actionlint`. Mandatory criteria 1 (the YAML checklist: `yamllint` was not run) and 22 (feature checked on the instance) are Pending, because the stand-in cannot create the secrets `TOKEN_FOR_GITEA_WIKI` and `SYNC_TOKEN` or watch a run on the host. The workflows will fail or skip until S01 creates them. The review is not independent: the AI wrote and reviewed it as stand-in for S02, and S01 can challenge it in the end-of-run summary.
|
||||||
|
|
||||||
|
## Action Items
|
||||||
|
|
||||||
|
| Action | Owner | Due |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Create the secrets `TOKEN_FOR_GITEA_WIKI` (wiki write) and `SYNC_TOKEN` (issues and milestones) in the organisation, enable the wiki, then run both workflows once by hand | S01 | before the next merge to main |
|
||||||
|
| Run `yamllint` on `.gitea/workflows/` | S01 | when convenient |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[MIL-008]: ../../milestones/mil-008-documentation.md
|
||||||
|
[QC-WF-001]: ../../../framework/qc/code/qc-workflow.md
|
||||||
|
[0301fd2]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift/commit/0301fd2f0bc22a26ee8d71ec41dab2bce0d38dc3
|
||||||
@@ -41,6 +41,8 @@ Tracks backward and forward links between artifact instances so that the Busines
|
|||||||
| Source and tests of [MIL-004] | Python source code | - | - | [MIL-004], [ADR-0002] | - | RC-018 (Go-with-conditions) |
|
| Source and tests of [MIL-004] | Python source code | - | - | [MIL-004], [ADR-0002] | - | RC-018 (Go-with-conditions) |
|
||||||
| Source and tests of [MIL-005] | Python source code | - | - | [MIL-005], [ADR-0002] | - | RC-019 (Go-with-conditions) |
|
| Source and tests of [MIL-005] | Python source code | - | - | [MIL-005], [ADR-0002] | - | RC-019 (Go-with-conditions) |
|
||||||
| Source and tests of [MIL-006] | Python source code | - | - | [MIL-006], [ADR-0002] | - | RC-020 (Go-with-conditions) |
|
| Source and tests of [MIL-006] | Python source code | - | - | [MIL-006], [ADR-0002] | - | RC-020 (Go-with-conditions) |
|
||||||
|
| Source and tests of [MIL-007] | Python source code | - | - | [MIL-007], [ADR-0002] | - | RC-021 (Go-with-conditions) |
|
||||||
|
| Workflows and wiki of [MIL-008] | Workflow files, wiki pages | - | - | [MIL-008] | - | RC-022 (Go-with-conditions) |
|
||||||
|
|
||||||
## Concern Coverage
|
## Concern Coverage
|
||||||
|
|
||||||
@@ -50,8 +52,8 @@ Tracks backward and forward links between artifact instances so that the Busines
|
|||||||
| CN-002 | [PP-001], [MIL-001] | [ADR-0001] | Review records RC-001 onward | Covered |
|
| CN-002 | [PP-001], [MIL-001] | [ADR-0001] | Review records RC-001 onward | Covered |
|
||||||
| CN-003 | [MIL-006], [MIL-007] | [ADR-0002] | Unit tests of `retry`; container chaos run | Planned |
|
| CN-003 | [MIL-006], [MIL-007] | [ADR-0002] | Unit tests of `retry`; container chaos run | Planned |
|
||||||
| CN-004 | [MIL-003] to [MIL-007] | [ADR-0002] | Code review against QC-PY-001 | Planned |
|
| CN-004 | [MIL-003] to [MIL-007] | [ADR-0002] | Code review against QC-PY-001 | Planned |
|
||||||
| CN-005 | [MIL-002], [MIL-008] | - | `check-readme.sh` | Planned |
|
| CN-005 | [MIL-002], [MIL-008] | - | `check-readme.sh` | Covered |
|
||||||
| CN-006 | [MIL-008] | - | Page count per language | Planned |
|
| CN-006 | [MIL-008] | - | Page count per language (12 pages in each of en, da, ms) | Covered |
|
||||||
| CN-007 | [MIL-001] | - | Repository API response | Covered |
|
| CN-007 | [MIL-001] | - | Repository API response | Covered |
|
||||||
| CN-008 | [MIL-002] | [ADR-0002] | `pyproject.toml` | Planned |
|
| CN-008 | [MIL-002] | [ADR-0002] | `pyproject.toml` | Planned |
|
||||||
| CN-009 | [MIL-001] | - | `.gitignore` lists `.env` | Covered |
|
| CN-009 | [MIL-001] | - | `.gitignore` lists `.env` | Covered |
|
||||||
|
|||||||
@@ -0,0 +1,65 @@
|
|||||||
|
[English](Getting-Started) · **Dansk** · [Bahasa Melayu](Getting-Started-ms)
|
||||||
|
|
||||||
|
# Kom i gang
|
||||||
|
|
||||||
|
## Krav
|
||||||
|
|
||||||
|
Python 3.13 eller nyere, Chrome eller Chromium og (valgfrit) Docker.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m venv .venv
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
source .venv/bin/activate
|
||||||
|
```
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
.venv\Scripts\Activate.ps1
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m pip install --upgrade pip
|
||||||
|
python -m pip install -e ".[dev]"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Din konto
|
||||||
|
|
||||||
|
Botten indeholder ingen adgangskode. Opret en konto én gang i hånden på siden (kør med `--keep-open`, så mappen `chrome_profile` gemmer sidens data), og giv derefter botten kontoen:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export SNACK_AND_LIFT_EMAIL="yourname@test.com"
|
||||||
|
export SNACK_AND_LIFT_PASSWORD="your password"
|
||||||
|
```
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
$env:SNACK_AND_LIFT_EMAIL = "yourname@test.com"
|
||||||
|
$env:SNACK_AND_LIFT_PASSWORD = "your password"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Kør og test
|
||||||
|
|
||||||
|
```bash
|
||||||
|
snack-and-lift
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m pytest
|
||||||
|
```
|
||||||
|
|
||||||
|
Nyttige indstillinger: `--headless`, `--keep-open`, `--first-tuesday-only` (trin 3 og 4), `--retries N`, `--profile-dir DIR`, `--screenshot-dir DIR`.
|
||||||
|
|
||||||
|
## Exitkoder
|
||||||
|
|
||||||
|
0 færdig, 1 et trin fejlede (også når alle forsøg fejlede), 2 loginoplysninger mangler, 3 siden My Bookings passer ikke med de bookinger der blev lavet.
|
||||||
|
|
||||||
|
## Skærmbilleder (vedligeholder)
|
||||||
|
|
||||||
|
Siden gemmer sine data i browserens profil, så en kørsel i en container kræver en konto der findes i den profil. Brug `--env-file` til loginoplysningerne (aldrig på kommandolinjen eller i repositoriet) og et volume til profilen og skærmbillederne:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker build -t snack-and-lift .
|
||||||
|
docker run --rm --env-file my.env -v snack-profile:/app/chrome_profile -v "$PWD/docs/images:/app/screenshots" snack-and-lift --headless --screenshot-dir /app/screenshots
|
||||||
|
```
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
[English](Getting-Started) · [Dansk](Getting-Started-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
# Mula menggunakan
|
||||||
|
|
||||||
|
## Keperluan
|
||||||
|
|
||||||
|
Python 3.13 atau lebih baharu, Chrome atau Chromium, dan (pilihan) Docker.
|
||||||
|
|
||||||
|
## Pemasangan
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m venv .venv
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
source .venv/bin/activate
|
||||||
|
```
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
.venv\Scripts\Activate.ps1
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m pip install --upgrade pip
|
||||||
|
python -m pip install -e ".[dev]"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Akaun anda
|
||||||
|
|
||||||
|
Bot tidak mengandungi kata laluan. Daftar sekali secara manual di laman (jalankan dengan `--keep-open` supaya folder `chrome_profile` menyimpan data laman), kemudian beri bot akaun itu:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export SNACK_AND_LIFT_EMAIL="yourname@test.com"
|
||||||
|
export SNACK_AND_LIFT_PASSWORD="your password"
|
||||||
|
```
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
$env:SNACK_AND_LIFT_EMAIL = "yourname@test.com"
|
||||||
|
$env:SNACK_AND_LIFT_PASSWORD = "your password"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Jalankan dan uji
|
||||||
|
|
||||||
|
```bash
|
||||||
|
snack-and-lift
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m pytest
|
||||||
|
```
|
||||||
|
|
||||||
|
Pilihan berguna: `--headless`, `--keep-open`, `--first-tuesday-only` (langkah 3 dan 4), `--retries N`, `--profile-dir DIR`, `--screenshot-dir DIR`.
|
||||||
|
|
||||||
|
## Kod keluar
|
||||||
|
|
||||||
|
0 selesai, 1 satu langkah gagal (juga apabila semua percubaan gagal), 2 kelayakan tiada, 3 halaman My Bookings tidak sepadan dengan tempahan yang dibuat.
|
||||||
|
|
||||||
|
## Mengambil tangkapan skrin (penyelenggara)
|
||||||
|
|
||||||
|
Laman menyimpan datanya dalam profil pelayar, jadi larian dalam bekas memerlukan akaun yang wujud dalam profil itu. Gunakan `--env-file` untuk kelayakan (jangan pada baris arahan atau dalam repositori) dan volume untuk profil serta tangkapan skrin:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker build -t snack-and-lift .
|
||||||
|
docker run --rm --env-file my.env -v snack-profile:/app/chrome_profile -v "$PWD/docs/images:/app/screenshots" snack-and-lift --headless --screenshot-dir /app/screenshots
|
||||||
|
```
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
**English** · [Dansk](Getting-Started-da) · [Bahasa Melayu](Getting-Started-ms)
|
||||||
|
|
||||||
|
# Getting started
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
Python 3.13 or newer, Chrome or Chromium, and (optional) Docker.
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m venv .venv
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
source .venv/bin/activate
|
||||||
|
```
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
.venv\Scripts\Activate.ps1
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m pip install --upgrade pip
|
||||||
|
python -m pip install -e ".[dev]"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Your account
|
||||||
|
|
||||||
|
The bot contains no password. Register once by hand on the site (run with `--keep-open`, so the `chrome_profile` folder keeps the site's data), then give the bot the account:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export SNACK_AND_LIFT_EMAIL="yourname@test.com"
|
||||||
|
export SNACK_AND_LIFT_PASSWORD="your password"
|
||||||
|
```
|
||||||
|
|
||||||
|
```powershell
|
||||||
|
$env:SNACK_AND_LIFT_EMAIL = "yourname@test.com"
|
||||||
|
$env:SNACK_AND_LIFT_PASSWORD = "your password"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Run and test
|
||||||
|
|
||||||
|
```bash
|
||||||
|
snack-and-lift
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m pytest
|
||||||
|
```
|
||||||
|
|
||||||
|
Useful options: `--headless`, `--keep-open`, `--first-tuesday-only` (steps 3 and 4), `--retries N`, `--profile-dir DIR`, `--screenshot-dir DIR`.
|
||||||
|
|
||||||
|
## Exit codes
|
||||||
|
|
||||||
|
0 done, 1 a step failed (also when every retry failed), 2 credentials missing, 3 the My Bookings page does not match the bookings made.
|
||||||
|
|
||||||
|
## Taking the screenshots (maintainer)
|
||||||
|
|
||||||
|
The site keeps its data in the browser profile, so a container run needs an account that exists in that profile. Use `--env-file` for the credentials (never write them on the command line or into the repository) and a volume for the profile and the screenshots:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker build -t snack-and-lift .
|
||||||
|
docker run --rm --env-file my.env -v snack-profile:/app/chrome_profile -v "$PWD/docs/images:/app/screenshots" snack-and-lift --headless --screenshot-dir /app/screenshots
|
||||||
|
```
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
[English](Home) · **Dansk** · [Bahasa Melayu](Home-ms)
|
||||||
|
|
||||||
|
# Snack and Lift-bot
|
||||||
|
|
||||||
|
En Selenium-bot der booker hold på øvelsesgymmet [Snack and Lift](https://appbrewery.github.io/gym/). Den er løsningen på dag 49 i Udemys *100 Days of Code*. Hver side nedenfor forklarer hvad ét trin i lektionen lærer.
|
||||||
|
|
||||||
|
Botten logger ind, booker hvert tirsdags- og torsdagshold kl. 18 (eller kommer på ventelisten), bekræfter resultatet på siden My Bookings og prøver igen når siden fejler en forespørgsel.
|
||||||
|
|
||||||
|
- [Kom i gang](Getting-Started-da): `.venv`, din konto, kørsel og test.
|
||||||
|
- De ni trin, nedenfor.
|
||||||
|
- [Fejlfinding](Troubleshooting-da).
|
||||||
|
|
||||||
|
Kildekode og sager: [repository](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift).
|
||||||
|
|
||||||
|
## De ni trin
|
||||||
|
|
||||||
|
1. [Trin 1: Opsætning, Chrome-profil og navigation](Step-1-da)
|
||||||
|
2. [Trin 2: Automatisk login](Step-2-da)
|
||||||
|
3. [Trin 3: Book næste tirsdagshold](Step-3-da)
|
||||||
|
4. [Trin 4: Tjek om et hold allerede er booket](Step-4-da)
|
||||||
|
5. [Trin 5: Tællere og et resumé](Step-5-da)
|
||||||
|
6. [Trin 6: Alle tirsdags- og torsdagshold](Step-6-da)
|
||||||
|
7. [Trin 7: Bekræft på siden My Bookings](Step-7-da)
|
||||||
|
8. [Trin 8: Kvalitetssikring med tidsrejse](Step-8-da)
|
||||||
|
9. [Trin 9: Robusthed mod netværksfejl](Step-9-da)
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
[English](Home) · [Dansk](Home-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
# Bot Snack and Lift
|
||||||
|
|
||||||
|
Bot Selenium yang menempah kelas di gim latihan [Snack and Lift](https://appbrewery.github.io/gym/). Ia penyelesaian untuk hari 49 *100 Days of Code* Udemy. Setiap halaman di bawah menerangkan apa yang diajar oleh satu langkah kuliah.
|
||||||
|
|
||||||
|
Bot log masuk, menempah setiap kelas Selasa dan Khamis pukul 6 petang (atau menyertai senarai menunggu), mengesahkan hasilnya di halaman My Bookings dan mencuba semula apabila laman gagal memproses permintaan.
|
||||||
|
|
||||||
|
- [Mula menggunakan](Getting-Started-ms): `.venv`, akaun anda, menjalankan dan menguji.
|
||||||
|
- Sembilan langkah, di bawah.
|
||||||
|
- [Menyelesaikan masalah](Troubleshooting-ms).
|
||||||
|
|
||||||
|
Kod sumber dan isu: [repository](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift).
|
||||||
|
|
||||||
|
## Sembilan langkah
|
||||||
|
|
||||||
|
1. [Langkah 1: Persediaan, profil Chrome dan navigasi](Step-1-ms)
|
||||||
|
2. [Langkah 2: Log masuk automatik](Step-2-ms)
|
||||||
|
3. [Langkah 3: Tempah kelas Selasa seterusnya](Step-3-ms)
|
||||||
|
4. [Langkah 4: Semak sama ada kelas sudah ditempah](Step-4-ms)
|
||||||
|
5. [Langkah 5: Pembilang dan ringkasan](Step-5-ms)
|
||||||
|
6. [Langkah 6: Semua kelas Selasa dan Khamis](Step-6-ms)
|
||||||
|
7. [Langkah 7: Sahkan di halaman My Bookings](Step-7-ms)
|
||||||
|
8. [Langkah 8: Jaminan kualiti dengan perjalanan masa](Step-8-ms)
|
||||||
|
9. [Langkah 9: Ketahanan terhadap kegagalan rangkaian](Step-9-ms)
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
**English** · [Dansk](Home-da) · [Bahasa Melayu](Home-ms)
|
||||||
|
|
||||||
|
# Snack and Lift bot
|
||||||
|
|
||||||
|
A Selenium bot that books classes at the practice gym [Snack and Lift](https://appbrewery.github.io/gym/). It is the solution to day 49 of Udemy's *100 Days of Code*. Each page below explains what one lecture step teaches.
|
||||||
|
|
||||||
|
The bot logs in, books every Tuesday and Thursday 6pm class (or joins the waitlist), verifies the result on the My Bookings page and retries when the site fails a request.
|
||||||
|
|
||||||
|
- [Getting started](Getting-Started): the `.venv`, your account, running and testing.
|
||||||
|
- The nine steps, below.
|
||||||
|
- [Troubleshooting](Troubleshooting).
|
||||||
|
|
||||||
|
Source and issues: [repository](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift).
|
||||||
|
|
||||||
|
## The nine steps
|
||||||
|
|
||||||
|
1. [Step 1: Setup, Chrome profile and navigation](Step-1)
|
||||||
|
2. [Step 2: Automated login](Step-2)
|
||||||
|
3. [Step 3: Book the next Tuesday class](Step-3)
|
||||||
|
4. [Step 4: Check if a class is already booked](Step-4)
|
||||||
|
5. [Step 5: Counters and a summary](Step-5)
|
||||||
|
6. [Step 6: Every Tuesday and Thursday class](Step-6)
|
||||||
|
7. [Step 7: Verify on the My Bookings page](Step-7)
|
||||||
|
8. [Step 8: Time travel quality assurance](Step-8)
|
||||||
|
9. [Step 9: Resilience against network failures](Step-9)
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
[English](Step-1) · **Dansk** · [Bahasa Melayu](Step-1-ms)
|
||||||
|
|
||||||
|
# Trin 1: Opsætning, Chrome-profil og navigation
|
||||||
|
|
||||||
|
## Hvad du får ud af det
|
||||||
|
|
||||||
|
Du lærer at starte Chrome fra Selenium med en egen profilmappe (`chrome_profile`), så sidens data overlever mellem kørsler, og med indstillingen `detach`, så vinduet bliver åbent når scriptet slutter. Botten åbner forsiden og venter på login-knappen i stedet for at sove.
|
||||||
|
|
||||||
|
## Hvor det er i koden
|
||||||
|
|
||||||
|
`src/snack_and_lift/infrastructure/browser.py`
|
||||||
|
|
||||||
|
## Skærmbillede
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
[Forside](Home-da) · [Næste: 2](Step-2-da)
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
[English](Step-1) · [Dansk](Step-1-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
# Langkah 1: Persediaan, profil Chrome dan navigasi
|
||||||
|
|
||||||
|
## Apa yang anda peroleh
|
||||||
|
|
||||||
|
Anda belajar memulakan Chrome daripada Selenium dengan folder profil sendiri (`chrome_profile`) supaya data laman kekal antara larian, dan dengan pilihan `detach` supaya tetingkap kekal terbuka apabila skrip tamat. Bot membuka halaman utama dan menunggu butang log masuk, bukannya tidur.
|
||||||
|
|
||||||
|
## Di mana dalam kod
|
||||||
|
|
||||||
|
`src/snack_and_lift/infrastructure/browser.py`
|
||||||
|
|
||||||
|
## Tangkapan skrin
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
[Utama](Home-ms) · [Seterusnya: 2](Step-2-ms)
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
**English** · [Dansk](Step-1-da) · [Bahasa Melayu](Step-1-ms)
|
||||||
|
|
||||||
|
# Step 1: Setup, Chrome profile and navigation
|
||||||
|
|
||||||
|
## What you gain
|
||||||
|
|
||||||
|
You learn to start Chrome from Selenium with its own profile folder (`chrome_profile`), so the site's data survives between runs, and with the `detach` option, so the window stays open when the script ends. The bot opens the home page and waits for the login button instead of sleeping.
|
||||||
|
|
||||||
|
## Where it is in the code
|
||||||
|
|
||||||
|
`src/snack_and_lift/infrastructure/browser.py`
|
||||||
|
|
||||||
|
## Screenshot
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
[Home](Home) · [Next: 2](Step-2)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-2) · **Dansk** · [Bahasa Melayu](Step-2-ms)
|
||||||
|
|
||||||
|
# Trin 2: Automatisk login
|
||||||
|
|
||||||
|
## Hvad du får ud af det
|
||||||
|
|
||||||
|
Du lærer eksplicitte ventetider (`WebDriverWait`) og at udfylde en formular. `login()` skriver e-mail og adgangskode fra miljøvariabler, indsender og venter til timeplanen vises. En forkert adgangskode vises via sidens fejlmeddelelse.
|
||||||
|
|
||||||
|
## Hvor det er i koden
|
||||||
|
|
||||||
|
`src/snack_and_lift/application/session.py`
|
||||||
|
|
||||||
|
## Skærmbillede
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Dette skærmbillede kræver en kørsel med en rigtig gym-konto. Vedligeholderen tilføjer det med `--screenshot-dir` (se [Kom i gang](Getting-Started-da)); indtil da mangler filen `docs/images/step-2.png`, og billedet ovenfor vises ikke.
|
||||||
|
|
||||||
|
[Forrige: 1](Step-1-da) · [Forside](Home-da) · [Næste: 3](Step-3-da)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-2) · [Dansk](Step-2-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
# Langkah 2: Log masuk automatik
|
||||||
|
|
||||||
|
## Apa yang anda peroleh
|
||||||
|
|
||||||
|
Anda belajar menunggu secara eksplisit (`WebDriverWait`) dan mengisi borang. `login()` menaip e-mel dan kata laluan daripada pemboleh ubah persekitaran, menghantar, dan menunggu sehingga jadual kelas dipaparkan. Kata laluan salah dilaporkan melalui mesej ralat laman.
|
||||||
|
|
||||||
|
## Di mana dalam kod
|
||||||
|
|
||||||
|
`src/snack_and_lift/application/session.py`
|
||||||
|
|
||||||
|
## Tangkapan skrin
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Tangkapan skrin ini memerlukan larian dengan akaun gim sebenar. Penyelenggara menambahnya dengan `--screenshot-dir` (lihat [Mula menggunakan](Getting-Started-ms)); sehingga itu fail `docs/images/step-2.png` tiada dan imej di atas tidak dipaparkan.
|
||||||
|
|
||||||
|
[Sebelumnya: 1](Step-1-ms) · [Utama](Home-ms) · [Seterusnya: 3](Step-3-ms)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
**English** · [Dansk](Step-2-da) · [Bahasa Melayu](Step-2-ms)
|
||||||
|
|
||||||
|
# Step 2: Automated login
|
||||||
|
|
||||||
|
## What you gain
|
||||||
|
|
||||||
|
You learn explicit waits (`WebDriverWait`) and how to fill a form. `login()` types the e-mail and password from environment variables, submits, and waits until the class schedule is shown. A wrong password is reported by the site's error message.
|
||||||
|
|
||||||
|
## Where it is in the code
|
||||||
|
|
||||||
|
`src/snack_and_lift/application/session.py`
|
||||||
|
|
||||||
|
## Screenshot
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> This screenshot needs a run with a real gym account. The maintainer adds it with `--screenshot-dir` (see [Getting started](Getting-Started)); until then the file `docs/images/step-2.png` is missing and the image above does not show.
|
||||||
|
|
||||||
|
[Previous: 1](Step-1) · [Home](Home) · [Next: 3](Step-3)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-3) · **Dansk** · [Bahasa Melayu](Step-3-ms)
|
||||||
|
|
||||||
|
# Trin 3: Book næste tirsdagshold
|
||||||
|
|
||||||
|
## Hvad du får ud af det
|
||||||
|
|
||||||
|
Du lærer at finde et element relativt til et andet: næste tirsdags dagsgruppe findes med et XPath-opslag på forfædre, derefter 18-kortet og dets knap. `book_class()` klikker på knappen og venter til teksten ændres.
|
||||||
|
|
||||||
|
## Hvor det er i koden
|
||||||
|
|
||||||
|
`src/snack_and_lift/application/booking.py`
|
||||||
|
|
||||||
|
## Skærmbillede
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Dette skærmbillede kræver en kørsel med en rigtig gym-konto. Vedligeholderen tilføjer det med `--screenshot-dir` (se [Kom i gang](Getting-Started-da)); indtil da mangler filen `docs/images/step-3.png`, og billedet ovenfor vises ikke.
|
||||||
|
|
||||||
|
[Forrige: 2](Step-2-da) · [Forside](Home-da) · [Næste: 4](Step-4-da)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-3) · [Dansk](Step-3-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
# Langkah 3: Tempah kelas Selasa seterusnya
|
||||||
|
|
||||||
|
## Apa yang anda peroleh
|
||||||
|
|
||||||
|
Anda belajar mencari elemen berdasarkan elemen lain: kumpulan hari Selasa seterusnya dicari dengan carian XPath ancestor, kemudian kad pukul 6 petang dan butangnya. `book_class()` menekan butang dan menunggu teks berubah.
|
||||||
|
|
||||||
|
## Di mana dalam kod
|
||||||
|
|
||||||
|
`src/snack_and_lift/application/booking.py`
|
||||||
|
|
||||||
|
## Tangkapan skrin
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Tangkapan skrin ini memerlukan larian dengan akaun gim sebenar. Penyelenggara menambahnya dengan `--screenshot-dir` (lihat [Mula menggunakan](Getting-Started-ms)); sehingga itu fail `docs/images/step-3.png` tiada dan imej di atas tidak dipaparkan.
|
||||||
|
|
||||||
|
[Sebelumnya: 2](Step-2-ms) · [Utama](Home-ms) · [Seterusnya: 4](Step-4-ms)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
**English** · [Dansk](Step-3-da) · [Bahasa Melayu](Step-3-ms)
|
||||||
|
|
||||||
|
# Step 3: Book the next Tuesday class
|
||||||
|
|
||||||
|
## What you gain
|
||||||
|
|
||||||
|
You learn to find an element relative to another one: the day group of the next Tuesday is found with an XPath ancestor lookup, then the 6pm card and its button. `book_class()` clicks the button and waits until its text changes.
|
||||||
|
|
||||||
|
## Where it is in the code
|
||||||
|
|
||||||
|
`src/snack_and_lift/application/booking.py`
|
||||||
|
|
||||||
|
## Screenshot
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> This screenshot needs a run with a real gym account. The maintainer adds it with `--screenshot-dir` (see [Getting started](Getting-Started)); until then the file `docs/images/step-3.png` is missing and the image above does not show.
|
||||||
|
|
||||||
|
[Previous: 2](Step-2) · [Home](Home) · [Next: 4](Step-4)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-4) · **Dansk** · [Bahasa Melayu](Step-4-ms)
|
||||||
|
|
||||||
|
# Trin 4: Tjek om et hold allerede er booket
|
||||||
|
|
||||||
|
## Hvad du får ud af det
|
||||||
|
|
||||||
|
Du lærer at læse en knaps tilstand før du handler: "Book Class", "Join Waitlist", "Booked" eller "Waitlisted". Et hold der allerede er booket klikkes ikke igen, og botten udskriver en ✓-linje om hvad den gjorde.
|
||||||
|
|
||||||
|
## Hvor det er i koden
|
||||||
|
|
||||||
|
`src/snack_and_lift/domain/rules.py`
|
||||||
|
|
||||||
|
## Skærmbillede
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Dette skærmbillede kræver en kørsel med en rigtig gym-konto. Vedligeholderen tilføjer det med `--screenshot-dir` (se [Kom i gang](Getting-Started-da)); indtil da mangler filen `docs/images/step-4.png`, og billedet ovenfor vises ikke.
|
||||||
|
|
||||||
|
[Forrige: 3](Step-3-da) · [Forside](Home-da) · [Næste: 5](Step-5-da)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-4) · [Dansk](Step-4-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
# Langkah 4: Semak sama ada kelas sudah ditempah
|
||||||
|
|
||||||
|
## Apa yang anda peroleh
|
||||||
|
|
||||||
|
Anda belajar membaca keadaan butang sebelum bertindak: "Book Class", "Join Waitlist", "Booked" atau "Waitlisted". Kelas yang sudah ditempah tidak ditekan semula, dan bot mencetak baris ✓ tentang apa yang dilakukannya.
|
||||||
|
|
||||||
|
## Di mana dalam kod
|
||||||
|
|
||||||
|
`src/snack_and_lift/domain/rules.py`
|
||||||
|
|
||||||
|
## Tangkapan skrin
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Tangkapan skrin ini memerlukan larian dengan akaun gim sebenar. Penyelenggara menambahnya dengan `--screenshot-dir` (lihat [Mula menggunakan](Getting-Started-ms)); sehingga itu fail `docs/images/step-4.png` tiada dan imej di atas tidak dipaparkan.
|
||||||
|
|
||||||
|
[Sebelumnya: 3](Step-3-ms) · [Utama](Home-ms) · [Seterusnya: 5](Step-5-ms)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
**English** · [Dansk](Step-4-da) · [Bahasa Melayu](Step-4-ms)
|
||||||
|
|
||||||
|
# Step 4: Check if a class is already booked
|
||||||
|
|
||||||
|
## What you gain
|
||||||
|
|
||||||
|
You learn to read the state of a button before acting: "Book Class", "Join Waitlist", "Booked" or "Waitlisted". A class that is already booked is not clicked again, and the bot prints a ✓ line that says what it did.
|
||||||
|
|
||||||
|
## Where it is in the code
|
||||||
|
|
||||||
|
`src/snack_and_lift/domain/rules.py`
|
||||||
|
|
||||||
|
## Screenshot
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> This screenshot needs a run with a real gym account. The maintainer adds it with `--screenshot-dir` (see [Getting started](Getting-Started)); until then the file `docs/images/step-4.png` is missing and the image above does not show.
|
||||||
|
|
||||||
|
[Previous: 3](Step-3) · [Home](Home) · [Next: 5](Step-5)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-5) · **Dansk** · [Bahasa Melayu](Step-5-ms)
|
||||||
|
|
||||||
|
# Trin 5: Tællere og et resumé
|
||||||
|
|
||||||
|
## Hvad du får ud af det
|
||||||
|
|
||||||
|
Du lærer at føre tællere mens en løkke kører og at udskrive en rapport: BOOKING SUMMARY viser nye bookinger, nye ventelisteplaceringer og hold der allerede var booket eller på venteliste.
|
||||||
|
|
||||||
|
## Hvor det er i koden
|
||||||
|
|
||||||
|
`src/snack_and_lift/domain/report.py`
|
||||||
|
|
||||||
|
## Skærmbillede
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Dette skærmbillede kræver en kørsel med en rigtig gym-konto. Vedligeholderen tilføjer det med `--screenshot-dir` (se [Kom i gang](Getting-Started-da)); indtil da mangler filen `docs/images/step-5.png`, og billedet ovenfor vises ikke.
|
||||||
|
|
||||||
|
[Forrige: 4](Step-4-da) · [Forside](Home-da) · [Næste: 6](Step-6-da)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-5) · [Dansk](Step-5-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
# Langkah 5: Pembilang dan ringkasan
|
||||||
|
|
||||||
|
## Apa yang anda peroleh
|
||||||
|
|
||||||
|
Anda belajar menyimpan pembilang semasa gelung berjalan dan mencetak laporan: BOOKING SUMMARY menyenaraikan tempahan baharu, penyertaan senarai menunggu baharu, serta kelas yang sudah ditempah atau dalam senarai menunggu.
|
||||||
|
|
||||||
|
## Di mana dalam kod
|
||||||
|
|
||||||
|
`src/snack_and_lift/domain/report.py`
|
||||||
|
|
||||||
|
## Tangkapan skrin
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Tangkapan skrin ini memerlukan larian dengan akaun gim sebenar. Penyelenggara menambahnya dengan `--screenshot-dir` (lihat [Mula menggunakan](Getting-Started-ms)); sehingga itu fail `docs/images/step-5.png` tiada dan imej di atas tidak dipaparkan.
|
||||||
|
|
||||||
|
[Sebelumnya: 4](Step-4-ms) · [Utama](Home-ms) · [Seterusnya: 6](Step-6-ms)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
**English** · [Dansk](Step-5-da) · [Bahasa Melayu](Step-5-ms)
|
||||||
|
|
||||||
|
# Step 5: Counters and a summary
|
||||||
|
|
||||||
|
## What you gain
|
||||||
|
|
||||||
|
You learn to keep counters while a loop runs and to print a report: the BOOKING SUMMARY lists new bookings, new waitlist entries, and classes that were already booked or waitlisted.
|
||||||
|
|
||||||
|
## Where it is in the code
|
||||||
|
|
||||||
|
`src/snack_and_lift/domain/report.py`
|
||||||
|
|
||||||
|
## Screenshot
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> This screenshot needs a run with a real gym account. The maintainer adds it with `--screenshot-dir` (see [Getting started](Getting-Started)); until then the file `docs/images/step-5.png` is missing and the image above does not show.
|
||||||
|
|
||||||
|
[Previous: 4](Step-4) · [Home](Home) · [Next: 6](Step-6)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-6) · **Dansk** · [Bahasa Melayu](Step-6-ms)
|
||||||
|
|
||||||
|
# Trin 6: Alle tirsdags- og torsdagshold
|
||||||
|
|
||||||
|
## Hvad du får ud af det
|
||||||
|
|
||||||
|
Du lærer at gennemløbe alle matchende elementer: hvert tirsdags- og torsdagshold kl. 18 håndteres, og DETAILED CLASS LIST udskriver hvert hold med dato, tid og resultat (New Booking, New Waitlist, Already Booked, Already Waitlisted).
|
||||||
|
|
||||||
|
## Hvor det er i koden
|
||||||
|
|
||||||
|
`src/snack_and_lift/application/booking.py`
|
||||||
|
|
||||||
|
## Skærmbillede
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Dette skærmbillede kræver en kørsel med en rigtig gym-konto. Vedligeholderen tilføjer det med `--screenshot-dir` (se [Kom i gang](Getting-Started-da)); indtil da mangler filen `docs/images/step-6.png`, og billedet ovenfor vises ikke.
|
||||||
|
|
||||||
|
[Forrige: 5](Step-5-da) · [Forside](Home-da) · [Næste: 7](Step-7-da)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-6) · [Dansk](Step-6-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
# Langkah 6: Semua kelas Selasa dan Khamis
|
||||||
|
|
||||||
|
## Apa yang anda peroleh
|
||||||
|
|
||||||
|
Anda belajar mengulang semua elemen yang sepadan: setiap kelas Selasa dan Khamis pukul 6 petang diuruskan, dan DETAILED CLASS LIST mencetak setiap kelas dengan tarikh, masa dan hasil (New Booking, New Waitlist, Already Booked, Already Waitlisted).
|
||||||
|
|
||||||
|
## Di mana dalam kod
|
||||||
|
|
||||||
|
`src/snack_and_lift/application/booking.py`
|
||||||
|
|
||||||
|
## Tangkapan skrin
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Tangkapan skrin ini memerlukan larian dengan akaun gim sebenar. Penyelenggara menambahnya dengan `--screenshot-dir` (lihat [Mula menggunakan](Getting-Started-ms)); sehingga itu fail `docs/images/step-6.png` tiada dan imej di atas tidak dipaparkan.
|
||||||
|
|
||||||
|
[Sebelumnya: 5](Step-5-ms) · [Utama](Home-ms) · [Seterusnya: 7](Step-7-ms)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
**English** · [Dansk](Step-6-da) · [Bahasa Melayu](Step-6-ms)
|
||||||
|
|
||||||
|
# Step 6: Every Tuesday and Thursday class
|
||||||
|
|
||||||
|
## What you gain
|
||||||
|
|
||||||
|
You learn to loop over all matching elements: every Tuesday and Thursday 6pm class is handled, and the DETAILED CLASS LIST prints each class with its date, time and result (New Booking, New Waitlist, Already Booked, Already Waitlisted).
|
||||||
|
|
||||||
|
## Where it is in the code
|
||||||
|
|
||||||
|
`src/snack_and_lift/application/booking.py`
|
||||||
|
|
||||||
|
## Screenshot
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> This screenshot needs a run with a real gym account. The maintainer adds it with `--screenshot-dir` (see [Getting started](Getting-Started)); until then the file `docs/images/step-6.png` is missing and the image above does not show.
|
||||||
|
|
||||||
|
[Previous: 5](Step-5) · [Home](Home) · [Next: 7](Step-7)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-7) · **Dansk** · [Bahasa Melayu](Step-7-ms)
|
||||||
|
|
||||||
|
# Trin 7: Bekræft på siden My Bookings
|
||||||
|
|
||||||
|
## Hvad du får ud af det
|
||||||
|
|
||||||
|
Du lærer at kontrollere dit eget arbejde fra en anden kilde: `get_my_bookings()` læser siden My Bookings (bookinger og venteliste) og `verify_bookings()` sammenligner med det botten gjorde. Resultatet er SUCCESS eller MISMATCH (exitkode 3).
|
||||||
|
|
||||||
|
## Hvor det er i koden
|
||||||
|
|
||||||
|
`src/snack_and_lift/application/verification.py`
|
||||||
|
|
||||||
|
## Skærmbillede
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Dette skærmbillede kræver en kørsel med en rigtig gym-konto. Vedligeholderen tilføjer det med `--screenshot-dir` (se [Kom i gang](Getting-Started-da)); indtil da mangler filen `docs/images/step-7.png`, og billedet ovenfor vises ikke.
|
||||||
|
|
||||||
|
[Forrige: 6](Step-6-da) · [Forside](Home-da) · [Næste: 8](Step-8-da)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-7) · [Dansk](Step-7-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
# Langkah 7: Sahkan di halaman My Bookings
|
||||||
|
|
||||||
|
## Apa yang anda peroleh
|
||||||
|
|
||||||
|
Anda belajar menyemak kerja sendiri daripada sumber kedua: `get_my_bookings()` membaca halaman My Bookings (tempahan dan senarai menunggu) dan `verify_bookings()` membandingkannya dengan apa yang dilakukan bot. Hasilnya SUCCESS atau MISMATCH (kod keluar 3).
|
||||||
|
|
||||||
|
## Di mana dalam kod
|
||||||
|
|
||||||
|
`src/snack_and_lift/application/verification.py`
|
||||||
|
|
||||||
|
## Tangkapan skrin
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Tangkapan skrin ini memerlukan larian dengan akaun gim sebenar. Penyelenggara menambahnya dengan `--screenshot-dir` (lihat [Mula menggunakan](Getting-Started-ms)); sehingga itu fail `docs/images/step-7.png` tiada dan imej di atas tidak dipaparkan.
|
||||||
|
|
||||||
|
[Sebelumnya: 6](Step-6-ms) · [Utama](Home-ms) · [Seterusnya: 8](Step-8-ms)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
**English** · [Dansk](Step-7-da) · [Bahasa Melayu](Step-7-ms)
|
||||||
|
|
||||||
|
# Step 7: Verify on the My Bookings page
|
||||||
|
|
||||||
|
## What you gain
|
||||||
|
|
||||||
|
You learn to check your own work from a second source: `get_my_bookings()` reads the My Bookings page (bookings and waitlist entries) and `verify_bookings()` compares it with what the bot did. The result is SUCCESS or MISMATCH (exit code 3).
|
||||||
|
|
||||||
|
## Where it is in the code
|
||||||
|
|
||||||
|
`src/snack_and_lift/application/verification.py`
|
||||||
|
|
||||||
|
## Screenshot
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> This screenshot needs a run with a real gym account. The maintainer adds it with `--screenshot-dir` (see [Getting started](Getting-Started)); until then the file `docs/images/step-7.png` is missing and the image above does not show.
|
||||||
|
|
||||||
|
[Previous: 6](Step-6) · [Home](Home) · [Next: 8](Step-8)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-8) · **Dansk** · [Bahasa Melayu](Step-8-ms)
|
||||||
|
|
||||||
|
# Trin 8: Kvalitetssikring med tidsrejse
|
||||||
|
|
||||||
|
## Hvad du får ud af det
|
||||||
|
|
||||||
|
Du lærer at datoer er den almindelige fejlkilde: sidens admin-knap "advance 3 days" flytter dens ur. Botten læser dagsetiketterne ("Today", "Tomorrow", "Thu, Aug 14") i stedet for at antage en dato, så den også virker efter et tidshop.
|
||||||
|
|
||||||
|
## Hvor det er i koden
|
||||||
|
|
||||||
|
`src/snack_and_lift/domain/day_label.py`
|
||||||
|
|
||||||
|
## Skærmbillede
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Dette skærmbillede kræver en kørsel med en rigtig gym-konto. Vedligeholderen tilføjer det med `--screenshot-dir` (se [Kom i gang](Getting-Started-da)); indtil da mangler filen `docs/images/step-8.png`, og billedet ovenfor vises ikke.
|
||||||
|
|
||||||
|
[Forrige: 7](Step-7-da) · [Forside](Home-da) · [Næste: 9](Step-9-da)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-8) · [Dansk](Step-8-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
# Langkah 8: Jaminan kualiti dengan perjalanan masa
|
||||||
|
|
||||||
|
## Apa yang anda peroleh
|
||||||
|
|
||||||
|
Anda belajar bahawa tarikh ialah punca pepijat biasa: kawalan admin laman "advance 3 days" menggerakkan jamnya. Bot membaca label hari ("Today", "Tomorrow", "Thu, Aug 14") dan bukannya menganggap tarikh, jadi ia berfungsi selepas lompatan masa juga.
|
||||||
|
|
||||||
|
## Di mana dalam kod
|
||||||
|
|
||||||
|
`src/snack_and_lift/domain/day_label.py`
|
||||||
|
|
||||||
|
## Tangkapan skrin
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Tangkapan skrin ini memerlukan larian dengan akaun gim sebenar. Penyelenggara menambahnya dengan `--screenshot-dir` (lihat [Mula menggunakan](Getting-Started-ms)); sehingga itu fail `docs/images/step-8.png` tiada dan imej di atas tidak dipaparkan.
|
||||||
|
|
||||||
|
[Sebelumnya: 7](Step-7-ms) · [Utama](Home-ms) · [Seterusnya: 9](Step-9-ms)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
**English** · [Dansk](Step-8-da) · [Bahasa Melayu](Step-8-ms)
|
||||||
|
|
||||||
|
# Step 8: Time travel quality assurance
|
||||||
|
|
||||||
|
## What you gain
|
||||||
|
|
||||||
|
You learn that dates are the usual bug: the site's admin control "advance 3 days" moves its clock. The bot reads the day labels ("Today", "Tomorrow", "Thu, Aug 14") instead of assuming a date, so it works after a time jump too.
|
||||||
|
|
||||||
|
## Where it is in the code
|
||||||
|
|
||||||
|
`src/snack_and_lift/domain/day_label.py`
|
||||||
|
|
||||||
|
## Screenshot
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> This screenshot needs a run with a real gym account. The maintainer adds it with `--screenshot-dir` (see [Getting started](Getting-Started)); until then the file `docs/images/step-8.png` is missing and the image above does not show.
|
||||||
|
|
||||||
|
[Previous: 7](Step-7) · [Home](Home) · [Next: 9](Step-9)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-9) · **Dansk** · [Bahasa Melayu](Step-9-ms)
|
||||||
|
|
||||||
|
# Trin 9: Robusthed mod netværksfejl
|
||||||
|
|
||||||
|
## Hvad du får ud af det
|
||||||
|
|
||||||
|
Du lærer at prøve igen: `retry(func, retries=7, description=None)` gentager et kald der kaster en fejl, venter mellem forsøgene, logger en advarsel og kaster RetriesExhaustedError til sidst. `login()`, `book_class()` og `get_my_bookings()` er pakket ind i den, så en side der taber forespørgsler ikke stopper kørslen.
|
||||||
|
|
||||||
|
## Hvor det er i koden
|
||||||
|
|
||||||
|
`src/snack_and_lift/application/retry.py`
|
||||||
|
|
||||||
|
## Skærmbillede
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Dette skærmbillede kræver en kørsel med en rigtig gym-konto. Vedligeholderen tilføjer det med `--screenshot-dir` (se [Kom i gang](Getting-Started-da)); indtil da mangler filen `docs/images/step-9.png`, og billedet ovenfor vises ikke.
|
||||||
|
|
||||||
|
[Forrige: 8](Step-8-da) · [Forside](Home-da)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[English](Step-9) · [Dansk](Step-9-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
# Langkah 9: Ketahanan terhadap kegagalan rangkaian
|
||||||
|
|
||||||
|
## Apa yang anda peroleh
|
||||||
|
|
||||||
|
Anda belajar mencuba semula: `retry(func, retries=7, description=None)` mengulang panggilan yang gagal, menunggu antara percubaan, mencatat amaran dan melempar RetriesExhaustedError di akhir. `login()`, `book_class()` dan `get_my_bookings()` dibalut dengannya, jadi laman yang menjatuhkan permintaan tidak menghentikan larian.
|
||||||
|
|
||||||
|
## Di mana dalam kod
|
||||||
|
|
||||||
|
`src/snack_and_lift/application/retry.py`
|
||||||
|
|
||||||
|
## Tangkapan skrin
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> Tangkapan skrin ini memerlukan larian dengan akaun gim sebenar. Penyelenggara menambahnya dengan `--screenshot-dir` (lihat [Mula menggunakan](Getting-Started-ms)); sehingga itu fail `docs/images/step-9.png` tiada dan imej di atas tidak dipaparkan.
|
||||||
|
|
||||||
|
[Sebelumnya: 8](Step-8-ms) · [Utama](Home-ms)
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
**English** · [Dansk](Step-9-da) · [Bahasa Melayu](Step-9-ms)
|
||||||
|
|
||||||
|
# Step 9: Resilience against network failures
|
||||||
|
|
||||||
|
## What you gain
|
||||||
|
|
||||||
|
You learn to retry: `retry(func, retries=7, description=None)` repeats a call that raises, waits between attempts, logs a warning and raises RetriesExhaustedError at the end. `login()`, `book_class()` and `get_my_bookings()` are wrapped with it, so a site that drops requests does not stop the run.
|
||||||
|
|
||||||
|
## Where it is in the code
|
||||||
|
|
||||||
|
`src/snack_and_lift/application/retry.py`
|
||||||
|
|
||||||
|
## Screenshot
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
> This screenshot needs a run with a real gym account. The maintainer adds it with `--screenshot-dir` (see [Getting started](Getting-Started)); until then the file `docs/images/step-9.png` is missing and the image above does not show.
|
||||||
|
|
||||||
|
[Previous: 8](Step-8) · [Home](Home)
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
[English](Troubleshooting) · **Dansk** · [Bahasa Melayu](Troubleshooting-ms)
|
||||||
|
|
||||||
|
# Fejlfinding
|
||||||
|
|
||||||
|
| Symptom | Årsag og løsning |
|
||||||
|
| --- | --- |
|
||||||
|
| Exitkode 2 | `SNACK_AND_LIFT_EMAIL` eller `SNACK_AND_LIFT_PASSWORD` er ikke sat. |
|
||||||
|
| Login fejler 7 gange, derefter exit 1 | Forkert e-mail eller adgangskode, eller kontoen findes ikke i denne `chrome_profile` (siden gemmer konti i browseren). Opret den igen med `--keep-open`. |
|
||||||
|
| Exitkode 3 og MISMATCH | Siden My Bookings viser ikke det botten bookede. Kør igen; tjek om et hold var fyldt. |
|
||||||
|
| Advarsler "attempt 2 of 7" | Sidens fejlrate er slået til; det er retry der arbejder (trin 9). |
|
||||||
|
| Chrome advarer om adgangskoden | Chrome markerer svage adgangskoder som `12346`; vælg en anden. |
|
||||||
|
| Intet vindue i Docker | Containeren er headless med vilje; brug `--screenshot-dir`. |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
[English](Troubleshooting) · [Dansk](Troubleshooting-da) · **Bahasa Melayu**
|
||||||
|
|
||||||
|
# Menyelesaikan masalah
|
||||||
|
|
||||||
|
| Gejala | Punca dan penyelesaian |
|
||||||
|
| --- | --- |
|
||||||
|
| Kod keluar 2 | `SNACK_AND_LIFT_EMAIL` atau `SNACK_AND_LIFT_PASSWORD` tidak ditetapkan. |
|
||||||
|
| Log masuk gagal 7 kali, kemudian keluar 1 | E-mel atau kata laluan salah, atau akaun tiada dalam `chrome_profile` ini (laman menyimpan akaun dalam pelayar). Daftar semula dengan `--keep-open`. |
|
||||||
|
| Kod keluar 3 dan MISMATCH | Halaman My Bookings tidak menyenaraikan apa yang ditempah bot. Jalankan semula; semak sama ada kelas penuh. |
|
||||||
|
| Amaran "attempt 2 of 7" | Kadar kegagalan laman dihidupkan; ini retry sedang berfungsi (langkah 9). |
|
||||||
|
| Chrome memberi amaran tentang kata laluan | Chrome menandakan kata laluan lemah seperti `12346`; pilih yang lain. |
|
||||||
|
| Tiada tetingkap dalam Docker | Bekas ini tanpa kepala (headless) secara sengaja; gunakan `--screenshot-dir`. |
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
**English** · [Dansk](Troubleshooting-da) · [Bahasa Melayu](Troubleshooting-ms)
|
||||||
|
|
||||||
|
# Troubleshooting
|
||||||
|
|
||||||
|
| Symptom | Cause and fix |
|
||||||
|
| --- | --- |
|
||||||
|
| Exit code 2 | `SNACK_AND_LIFT_EMAIL` or `SNACK_AND_LIFT_PASSWORD` is not set. |
|
||||||
|
| Login fails 7 times, then exit 1 | Wrong e-mail or password, or the account is not in this `chrome_profile` (the site keeps accounts in the browser). Register again with `--keep-open`. |
|
||||||
|
| Exit code 3 and MISMATCH | The My Bookings page does not list what the bot booked. Run again; check whether a class was full. |
|
||||||
|
| Warnings "attempt 2 of 7" | The site's failure rate is on; this is the retry at work (step 9). |
|
||||||
|
| Chrome warns about the password | Chrome flags weak passwords such as `12346`; choose another. |
|
||||||
|
| No window in Docker | The container is headless by design; use `--screenshot-dir`. |
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
[Repository](https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/049-snack-and-lift) · [Snack and Lift](https://appbrewery.github.io/gym/) · AGPL-3.0
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
**English**
|
||||||
|
- [Home](Home) · [Getting started](Getting-Started) · [Troubleshooting](Troubleshooting)
|
||||||
|
- [1](Step-1) · [2](Step-2) · [3](Step-3) · [4](Step-4) · [5](Step-5) · [6](Step-6) · [7](Step-7) · [8](Step-8) · [9](Step-9)
|
||||||
|
|
||||||
|
**Dansk**
|
||||||
|
- [Forside](Home-da) · [Kom i gang](Getting-Started-da) · [Fejlfinding](Troubleshooting-da)
|
||||||
|
- [1](Step-1-da) · [2](Step-2-da) · [3](Step-3-da) · [4](Step-4-da) · [5](Step-5-da) · [6](Step-6-da) · [7](Step-7-da) · [8](Step-8-da) · [9](Step-9-da)
|
||||||
|
|
||||||
|
**Bahasa Melayu**
|
||||||
|
- [Utama](Home-ms) · [Mula menggunakan](Getting-Started-ms) · [Menyelesaikan masalah](Troubleshooting-ms)
|
||||||
|
- [1](Step-1-ms) · [2](Step-2-ms) · [3](Step-3-ms) · [4](Step-4-ms) · [5](Step-5-ms) · [6](Step-6-ms) · [7](Step-7-ms) · [8](Step-8-ms) · [9](Step-9-ms)
|
||||||
@@ -3,10 +3,12 @@
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
import time
|
||||||
from collections.abc import Callable
|
from collections.abc import Callable
|
||||||
|
|
||||||
from snack_and_lift import constants
|
from snack_and_lift import constants
|
||||||
from snack_and_lift.application.ports import GymPort
|
from snack_and_lift.application.ports import GymPort
|
||||||
|
from snack_and_lift.application.retry import Sleep, retry
|
||||||
from snack_and_lift.domain.errors import GymError
|
from snack_and_lift.domain.errors import GymError
|
||||||
from snack_and_lift.domain.models import ButtonState, ClassCard, ClassResult
|
from snack_and_lift.domain.models import ButtonState, ClassCard, ClassResult
|
||||||
from snack_and_lift.domain.rules import (
|
from snack_and_lift.domain.rules import (
|
||||||
@@ -41,12 +43,68 @@ def book_class(gym: GymPort, card: ClassCard) -> ClassResult:
|
|||||||
return ClassResult(card, outcome)
|
return ClassResult(card, outcome)
|
||||||
|
|
||||||
|
|
||||||
def book_next_tuesday(gym: GymPort) -> ClassResult | None:
|
def _read_current_card(gym: GymPort, card: ClassCard) -> ClassCard:
|
||||||
|
"""@brief Read a class again from the page, to see what an earlier attempt did.
|
||||||
|
|
||||||
|
@param gym The gym site.
|
||||||
|
@param card The class, as it was read before.
|
||||||
|
@return The class with the state the page shows now.
|
||||||
|
@exception GymError The schedule could not be read or the class is no longer on it.
|
||||||
|
"""
|
||||||
|
for current in gym.list_class_cards():
|
||||||
|
if current.card_id == card.card_id:
|
||||||
|
return current
|
||||||
|
raise GymError(constants.MESSAGE_CLASS_NOT_ON_SCHEDULE.format(card_id=card.card_id))
|
||||||
|
|
||||||
|
|
||||||
|
def book_class_with_retry(
|
||||||
|
gym: GymPort,
|
||||||
|
card: ClassCard,
|
||||||
|
retries: int = constants.RETRY_COUNT,
|
||||||
|
sleep: Sleep = time.sleep,
|
||||||
|
) -> ClassResult:
|
||||||
|
"""@brief Book a class, repeating it when the site drops the request.
|
||||||
|
|
||||||
|
Before each repeat the class is read from the page again. When the button now shows the
|
||||||
|
state that the click should give, the click did go through although its confirmation
|
||||||
|
failed, so the class counts as newly booked or waitlisted and is not clicked again.
|
||||||
|
|
||||||
|
@param gym The gym site.
|
||||||
|
@param card The class, as read from the page.
|
||||||
|
@param retries The most attempts to make.
|
||||||
|
@param sleep Waits between two attempts.
|
||||||
|
@return The class and what happened.
|
||||||
|
@exception RetriesExhaustedError Every attempt failed.
|
||||||
|
"""
|
||||||
|
attempts = 0
|
||||||
|
|
||||||
|
def attempt() -> ClassResult:
|
||||||
|
nonlocal attempts
|
||||||
|
attempts += 1
|
||||||
|
if attempts == 1:
|
||||||
|
return book_class(gym, card)
|
||||||
|
current = _read_current_card(gym, card)
|
||||||
|
action = decide_outcome_action(card)
|
||||||
|
if CONFIRMED_STATE.get(action) is current.state:
|
||||||
|
outcome = OUTCOME_OF_ACTION[action]
|
||||||
|
logger.info(format_outcome(outcome, card))
|
||||||
|
return ClassResult(card, outcome)
|
||||||
|
return book_class(gym, current)
|
||||||
|
|
||||||
|
description = constants.RETRY_DESCRIPTION_BOOK.format(name=card.name, day=card.day_label)
|
||||||
|
return retry(attempt, retries, description, sleep=sleep)
|
||||||
|
|
||||||
|
|
||||||
|
def book_next_tuesday(
|
||||||
|
gym: GymPort, retries: int = constants.RETRY_COUNT, sleep: Sleep = time.sleep
|
||||||
|
) -> ClassResult | None:
|
||||||
"""@brief Book the next Tuesday class at the target time.
|
"""@brief Book the next Tuesday class at the target time.
|
||||||
|
|
||||||
@param gym The gym site.
|
@param gym The gym site.
|
||||||
|
@param retries The most attempts to book the class.
|
||||||
|
@param sleep Waits between two attempts.
|
||||||
@return The result, or None when the schedule has no such class.
|
@return The result, or None when the schedule has no such class.
|
||||||
@exception GymError The page could not be read or the booking failed.
|
@exception GymError The page could not be read or the booking failed on every attempt.
|
||||||
"""
|
"""
|
||||||
card = find_next_class(gym.list_class_cards(), constants.NEXT_CLASS_WEEKDAY)
|
card = find_next_class(gym.list_class_cards(), constants.NEXT_CLASS_WEEKDAY)
|
||||||
if card is None:
|
if card is None:
|
||||||
@@ -57,11 +115,14 @@ def book_next_tuesday(gym: GymPort) -> ClassResult | None:
|
|||||||
)
|
)
|
||||||
)
|
)
|
||||||
return None
|
return None
|
||||||
return book_class(gym, card)
|
return book_class_with_retry(gym, card, retries, sleep)
|
||||||
|
|
||||||
|
|
||||||
def book_target_classes(
|
def book_target_classes(
|
||||||
gym: GymPort, on_result: Callable[[ClassResult], None] | None = None
|
gym: GymPort,
|
||||||
|
on_result: Callable[[ClassResult], None] | None = None,
|
||||||
|
retries: int = constants.RETRY_COUNT,
|
||||||
|
sleep: Sleep = time.sleep,
|
||||||
) -> list[ClassResult]:
|
) -> list[ClassResult]:
|
||||||
"""@brief Book every Tuesday and Thursday class at the target time, in page order.
|
"""@brief Book every Tuesday and Thursday class at the target time, in page order.
|
||||||
|
|
||||||
@@ -69,8 +130,10 @@ def book_target_classes(
|
|||||||
|
|
||||||
@param gym The gym site.
|
@param gym The gym site.
|
||||||
@param on_result Called after each class was handled, for example to take a screenshot.
|
@param on_result Called after each class was handled, for example to take a screenshot.
|
||||||
|
@param retries The most attempts to book one class.
|
||||||
|
@param sleep Waits between two attempts.
|
||||||
@return What happened to each class; empty when the schedule has none.
|
@return What happened to each class; empty when the schedule has none.
|
||||||
@exception GymError The page could not be read or a booking failed.
|
@exception GymError The page could not be read or a booking failed on every attempt.
|
||||||
"""
|
"""
|
||||||
cards = find_target_classes(gym.list_class_cards())
|
cards = find_target_classes(gym.list_class_cards())
|
||||||
if not cards:
|
if not cards:
|
||||||
@@ -78,7 +141,7 @@ def book_target_classes(
|
|||||||
return []
|
return []
|
||||||
results: list[ClassResult] = []
|
results: list[ClassResult] = []
|
||||||
for card in cards:
|
for card in cards:
|
||||||
result = book_class(gym, card)
|
result = book_class_with_retry(gym, card, retries, sleep)
|
||||||
results.append(result)
|
results.append(result)
|
||||||
if on_result is not None:
|
if on_result is not None:
|
||||||
on_result(result)
|
on_result(result)
|
||||||
|
|||||||
@@ -0,0 +1,67 @@
|
|||||||
|
"""@file retry.py
|
||||||
|
@brief Lecture step 9: repeat a step that failed because the site dropped a request.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import time
|
||||||
|
from collections.abc import Callable
|
||||||
|
|
||||||
|
from snack_and_lift import constants
|
||||||
|
from snack_and_lift.domain.errors import GymError, RetriesExhaustedError
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
## Waits for a number of seconds; tests pass a recorder so that they never really sleep.
|
||||||
|
Sleep = Callable[[float], None]
|
||||||
|
|
||||||
|
|
||||||
|
def retry[T](
|
||||||
|
func: Callable[[], T],
|
||||||
|
retries: int = constants.RETRY_COUNT,
|
||||||
|
description: str | None = None,
|
||||||
|
*,
|
||||||
|
delay: float = constants.RETRY_DELAY_SECONDS,
|
||||||
|
sleep: Sleep = time.sleep,
|
||||||
|
) -> T:
|
||||||
|
"""@brief Call a function until it succeeds, at most `retries` times.
|
||||||
|
|
||||||
|
Only a `GymError` is repeated: it is what a dropped request looks like. Any other error,
|
||||||
|
such as missing credentials, is a defect and passes through at once.
|
||||||
|
|
||||||
|
@param func The step, called without arguments.
|
||||||
|
@param retries The most attempts to make, at least 1.
|
||||||
|
@param description What the step does, for the log (never put a secret in it).
|
||||||
|
@param delay Seconds to wait between two attempts.
|
||||||
|
@param sleep Waits for a number of seconds.
|
||||||
|
@return What the function returned on its first successful attempt.
|
||||||
|
@exception ValueError `retries` is below 1.
|
||||||
|
@exception RetriesExhaustedError Every attempt raised a `GymError`; the last one is the cause.
|
||||||
|
"""
|
||||||
|
if retries < 1:
|
||||||
|
raise ValueError(constants.MESSAGE_RETRIES_INVALID.format(retries=retries))
|
||||||
|
name = description or constants.RETRY_DEFAULT_DESCRIPTION
|
||||||
|
for attempt in range(1, retries + 1):
|
||||||
|
try:
|
||||||
|
result = func()
|
||||||
|
except GymError as error:
|
||||||
|
if attempt == retries:
|
||||||
|
message = constants.MESSAGE_RETRIES_EXHAUSTED.format(
|
||||||
|
description=name, retries=retries, error=error
|
||||||
|
)
|
||||||
|
raise RetriesExhaustedError(message) from error
|
||||||
|
logger.warning(
|
||||||
|
constants.MESSAGE_RETRY_FAILED.format(
|
||||||
|
attempt=attempt,
|
||||||
|
retries=retries,
|
||||||
|
description=name,
|
||||||
|
error=str(error).rstrip("."),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
sleep(delay)
|
||||||
|
else:
|
||||||
|
if attempt > 1:
|
||||||
|
logger.info(
|
||||||
|
constants.MESSAGE_RETRY_SUCCEEDED.format(description=name, attempts=attempt)
|
||||||
|
)
|
||||||
|
return result
|
||||||
|
raise AssertionError("unreachable: the last attempt returns or raises") # pragma: no cover
|
||||||
@@ -3,9 +3,12 @@
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
import time
|
||||||
|
|
||||||
|
from snack_and_lift import constants
|
||||||
from snack_and_lift.application.credentials import Credentials
|
from snack_and_lift.application.credentials import Credentials
|
||||||
from snack_and_lift.application.ports import GymPort
|
from snack_and_lift.application.ports import GymPort
|
||||||
|
from snack_and_lift.application.retry import Sleep, retry
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
@@ -19,3 +22,25 @@ def login(gym: GymPort, credentials: Credentials) -> None:
|
|||||||
"""
|
"""
|
||||||
gym.log_in(credentials.email, credentials.password)
|
gym.log_in(credentials.email, credentials.password)
|
||||||
logger.info("✓ Logged in: the class schedule is shown")
|
logger.info("✓ Logged in: the class schedule is shown")
|
||||||
|
|
||||||
|
|
||||||
|
def login_with_retry(
|
||||||
|
gym: GymPort,
|
||||||
|
credentials: Credentials,
|
||||||
|
retries: int = constants.RETRY_COUNT,
|
||||||
|
sleep: Sleep = time.sleep,
|
||||||
|
) -> None:
|
||||||
|
"""@brief Log in, repeating the login when the site drops the request.
|
||||||
|
|
||||||
|
@param gym The gym site.
|
||||||
|
@param credentials The account to log in with.
|
||||||
|
@param retries The most attempts to make.
|
||||||
|
@param sleep Waits between two attempts.
|
||||||
|
@exception RetriesExhaustedError Every attempt failed.
|
||||||
|
"""
|
||||||
|
retry(
|
||||||
|
lambda: login(gym, credentials),
|
||||||
|
retries,
|
||||||
|
constants.RETRY_DESCRIPTION_LOGIN,
|
||||||
|
sleep=sleep,
|
||||||
|
)
|
||||||
|
|||||||
@@ -3,10 +3,12 @@
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
import time
|
||||||
from collections.abc import Sequence
|
from collections.abc import Sequence
|
||||||
|
|
||||||
from snack_and_lift import constants
|
from snack_and_lift import constants
|
||||||
from snack_and_lift.application.ports import GymPort
|
from snack_and_lift.application.ports import GymPort
|
||||||
|
from snack_and_lift.application.retry import Sleep, retry
|
||||||
from snack_and_lift.domain.booking_entry import BookingEntry, is_target_entry
|
from snack_and_lift.domain.booking_entry import BookingEntry, is_target_entry
|
||||||
from snack_and_lift.domain.errors import NoBookingsFoundError
|
from snack_and_lift.domain.errors import NoBookingsFoundError
|
||||||
from snack_and_lift.domain.models import ClassResult
|
from snack_and_lift.domain.models import ClassResult
|
||||||
@@ -30,18 +32,42 @@ def get_my_bookings(gym: GymPort) -> list[BookingEntry]:
|
|||||||
return entries
|
return entries
|
||||||
|
|
||||||
|
|
||||||
def verify_bookings(gym: GymPort, results: Sequence[ClassResult]) -> VerificationResult:
|
def get_my_bookings_with_retry(
|
||||||
|
gym: GymPort, retries: int = constants.RETRY_COUNT, sleep: Sleep = time.sleep
|
||||||
|
) -> list[BookingEntry]:
|
||||||
|
"""@brief Read the My Bookings page, repeating it when the page fails to load.
|
||||||
|
|
||||||
|
@param gym The gym site.
|
||||||
|
@param retries The most attempts to make.
|
||||||
|
@param sleep Waits between two attempts.
|
||||||
|
@return Every confirmed booking and waitlist entry.
|
||||||
|
@exception RetriesExhaustedError Every attempt failed.
|
||||||
|
"""
|
||||||
|
return retry(
|
||||||
|
lambda: get_my_bookings(gym), retries, constants.RETRY_DESCRIPTION_BOOKINGS, sleep=sleep
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def verify_bookings(
|
||||||
|
gym: GymPort,
|
||||||
|
results: Sequence[ClassResult],
|
||||||
|
retries: int = constants.RETRY_COUNT,
|
||||||
|
sleep: Sleep = time.sleep,
|
||||||
|
) -> VerificationResult:
|
||||||
"""@brief Compare what the bot booked with the My Bookings page.
|
"""@brief Compare what the bot booked with the My Bookings page.
|
||||||
|
|
||||||
The page is not opened when the bot handled no class.
|
The page is not opened when the bot handled no class.
|
||||||
|
|
||||||
@param gym The gym site.
|
@param gym The gym site.
|
||||||
@param results What happened to each class.
|
@param results What happened to each class.
|
||||||
|
@param retries The most attempts to read the page.
|
||||||
|
@param sleep Waits between two attempts.
|
||||||
@return The comparison of the expected entries with the Tuesday and Thursday 6pm entries.
|
@return The comparison of the expected entries with the Tuesday and Thursday 6pm entries.
|
||||||
@exception NoBookingsFoundError Classes were handled but the page shows no entry.
|
@exception RetriesExhaustedError The page could not be read on any attempt.
|
||||||
@exception GymError The page could not be opened or read.
|
|
||||||
"""
|
"""
|
||||||
if not results:
|
if not results:
|
||||||
return build_verification(results, [])
|
return build_verification(results, [])
|
||||||
entries = [entry for entry in get_my_bookings(gym) if is_target_entry(entry)]
|
entries = [
|
||||||
|
entry for entry in get_my_bookings_with_retry(gym, retries, sleep) if is_target_entry(entry)
|
||||||
|
]
|
||||||
return build_verification(results, entries)
|
return build_verification(results, entries)
|
||||||
|
|||||||
+52
-13
@@ -6,6 +6,7 @@ import argparse
|
|||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
|
import time
|
||||||
from collections.abc import Callable, Sequence
|
from collections.abc import Callable, Sequence
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
@@ -13,7 +14,8 @@ from snack_and_lift import constants
|
|||||||
from snack_and_lift.application.booking import book_next_tuesday, book_target_classes
|
from snack_and_lift.application.booking import book_next_tuesday, book_target_classes
|
||||||
from snack_and_lift.application.credentials import Credentials, load_credentials
|
from snack_and_lift.application.credentials import Credentials, load_credentials
|
||||||
from snack_and_lift.application.ports import GymPort
|
from snack_and_lift.application.ports import GymPort
|
||||||
from snack_and_lift.application.session import login
|
from snack_and_lift.application.retry import Sleep
|
||||||
|
from snack_and_lift.application.session import login_with_retry
|
||||||
from snack_and_lift.application.verification import verify_bookings
|
from snack_and_lift.application.verification import verify_bookings
|
||||||
from snack_and_lift.domain.errors import GymError, LoginFailedError, MissingCredentialsError
|
from snack_and_lift.domain.errors import GymError, LoginFailedError, MissingCredentialsError
|
||||||
from snack_and_lift.domain.models import ClassResult
|
from snack_and_lift.domain.models import ClassResult
|
||||||
@@ -40,6 +42,22 @@ def selenium_gym_factory(headless: bool, profile_dir: Path, keep_open: bool) ->
|
|||||||
return SeleniumGym(create_driver(headless, profile_dir, keep_open))
|
return SeleniumGym(create_driver(headless, profile_dir, keep_open))
|
||||||
|
|
||||||
|
|
||||||
|
def _at_least_one(text: str) -> int:
|
||||||
|
"""@brief Read a whole number of at least 1 for an option.
|
||||||
|
|
||||||
|
@param text The text of the option.
|
||||||
|
@return The number.
|
||||||
|
@exception argparse.ArgumentTypeError The text is not a whole number of at least 1.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
number = int(text)
|
||||||
|
except ValueError:
|
||||||
|
number = 0
|
||||||
|
if number < 1:
|
||||||
|
raise argparse.ArgumentTypeError(f"{text!r} is not a whole number of at least 1")
|
||||||
|
return number
|
||||||
|
|
||||||
|
|
||||||
def parse_args(argv: Sequence[str] | None = None) -> argparse.Namespace:
|
def parse_args(argv: Sequence[str] | None = None) -> argparse.Namespace:
|
||||||
"""@brief Read the command line.
|
"""@brief Read the command line.
|
||||||
|
|
||||||
@@ -50,8 +68,8 @@ def parse_args(argv: Sequence[str] | None = None) -> argparse.Namespace:
|
|||||||
prog="snack-and-lift",
|
prog="snack-and-lift",
|
||||||
description="Books the Tuesday and Thursday 6pm classes at the Snack and Lift gym.",
|
description="Books the Tuesday and Thursday 6pm classes at the Snack and Lift gym.",
|
||||||
epilog=(
|
epilog=(
|
||||||
"exit codes: 0 done, 1 a step failed, 2 credentials missing, "
|
"exit codes: 0 done, 1 a step failed (also when every retry failed), "
|
||||||
"3 the My Bookings page does not match the bookings made"
|
"2 credentials missing, 3 the My Bookings page does not match the bookings made"
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
@@ -82,6 +100,16 @@ def parse_args(argv: Sequence[str] | None = None) -> argparse.Namespace:
|
|||||||
action="store_true",
|
action="store_true",
|
||||||
help="book only the next Tuesday 6pm class (lecture steps 3 and 4); skips the verification",
|
help="book only the next Tuesday 6pm class (lecture steps 3 and 4); skips the verification",
|
||||||
)
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--retries",
|
||||||
|
type=_at_least_one,
|
||||||
|
default=constants.RETRY_COUNT,
|
||||||
|
metavar="N",
|
||||||
|
help=(
|
||||||
|
"attempts for the login, each booking and the My Bookings page when the site "
|
||||||
|
f"drops a request (default: {constants.RETRY_COUNT}, at least 1)"
|
||||||
|
),
|
||||||
|
)
|
||||||
args = parser.parse_args(argv)
|
args = parser.parse_args(argv)
|
||||||
if args.keep_open is None:
|
if args.keep_open is None:
|
||||||
args.keep_open = not args.headless
|
args.keep_open = not args.headless
|
||||||
@@ -121,7 +149,11 @@ def _save_console(gym: GymPort, screenshot_dir: Path | None, text: str, name: st
|
|||||||
|
|
||||||
|
|
||||||
def _run(
|
def _run(
|
||||||
gym: GymPort, args: argparse.Namespace, recorder: ConsoleRecorder, credentials: Credentials
|
gym: GymPort,
|
||||||
|
args: argparse.Namespace,
|
||||||
|
recorder: ConsoleRecorder,
|
||||||
|
credentials: Credentials,
|
||||||
|
sleep: Sleep,
|
||||||
) -> bool:
|
) -> bool:
|
||||||
"""@brief Open the site, log in, book the classes and verify them, saving the step images.
|
"""@brief Open the site, log in, book the classes and verify them, saving the step images.
|
||||||
|
|
||||||
@@ -133,15 +165,16 @@ def _run(
|
|||||||
@param args The parsed options.
|
@param args The parsed options.
|
||||||
@param recorder The recorded console lines, drawn for step 4.
|
@param recorder The recorded console lines, drawn for step 4.
|
||||||
@param credentials The account to log in with.
|
@param credentials The account to log in with.
|
||||||
|
@param sleep Waits between two attempts of a retried step.
|
||||||
@return False when the My Bookings page does not match the bookings made, else True.
|
@return False when the My Bookings page does not match the bookings made, else True.
|
||||||
@exception GymError A step failed.
|
@exception GymError A step failed on every attempt.
|
||||||
"""
|
"""
|
||||||
gym.open_site()
|
gym.open_site()
|
||||||
_save_step(gym, args.screenshot_dir, "step-1.png")
|
_save_step(gym, args.screenshot_dir, "step-1.png")
|
||||||
login(gym, credentials)
|
login_with_retry(gym, credentials, args.retries, sleep)
|
||||||
_save_step(gym, args.screenshot_dir, "step-2.png")
|
_save_step(gym, args.screenshot_dir, "step-2.png")
|
||||||
if args.first_tuesday_only:
|
if args.first_tuesday_only:
|
||||||
book_next_tuesday(gym)
|
book_next_tuesday(gym, args.retries, sleep)
|
||||||
_save_step(gym, args.screenshot_dir, constants.SCREENSHOT_STEP_3)
|
_save_step(gym, args.screenshot_dir, constants.SCREENSHOT_STEP_3)
|
||||||
_save_console(gym, args.screenshot_dir, recorder.text, constants.SCREENSHOT_STEP_4)
|
_save_console(gym, args.screenshot_dir, recorder.text, constants.SCREENSHOT_STEP_4)
|
||||||
return True
|
return True
|
||||||
@@ -153,7 +186,7 @@ def _run(
|
|||||||
_save_step(gym, args.screenshot_dir, constants.SCREENSHOT_STEP_3)
|
_save_step(gym, args.screenshot_dir, constants.SCREENSHOT_STEP_3)
|
||||||
window_saved = True
|
window_saved = True
|
||||||
|
|
||||||
results = book_target_classes(gym, save_window_once)
|
results = book_target_classes(gym, save_window_once, args.retries, sleep)
|
||||||
if not window_saved:
|
if not window_saved:
|
||||||
_save_step(gym, args.screenshot_dir, constants.SCREENSHOT_STEP_3)
|
_save_step(gym, args.screenshot_dir, constants.SCREENSHOT_STEP_3)
|
||||||
_save_console(gym, args.screenshot_dir, recorder.text, constants.SCREENSHOT_STEP_4)
|
_save_console(gym, args.screenshot_dir, recorder.text, constants.SCREENSHOT_STEP_4)
|
||||||
@@ -163,22 +196,25 @@ def _run(
|
|||||||
detail = format_detail_list(results)
|
detail = format_detail_list(results)
|
||||||
logger.info("%s", detail)
|
logger.info("%s", detail)
|
||||||
_save_console(gym, args.screenshot_dir, f"{summary}\n{detail}", constants.SCREENSHOT_STEP_6)
|
_save_console(gym, args.screenshot_dir, f"{summary}\n{detail}", constants.SCREENSHOT_STEP_6)
|
||||||
verification = verify_bookings(gym, results)
|
verification = verify_bookings(gym, results, args.retries, sleep)
|
||||||
_save_step(gym, args.screenshot_dir, constants.SCREENSHOT_STEP_7)
|
_save_step(gym, args.screenshot_dir, constants.SCREENSHOT_STEP_7)
|
||||||
verification_text = format_verification(verification)
|
verification_text = format_verification(verification)
|
||||||
logger.info("%s", verification_text)
|
logger.info("%s", verification_text)
|
||||||
_save_console(gym, args.screenshot_dir, verification_text, constants.SCREENSHOT_STEP_8)
|
_save_console(gym, args.screenshot_dir, verification_text, constants.SCREENSHOT_STEP_8)
|
||||||
|
_save_console(gym, args.screenshot_dir, recorder.text, constants.SCREENSHOT_STEP_9)
|
||||||
return verification.is_success
|
return verification.is_success
|
||||||
|
|
||||||
|
|
||||||
def main(
|
def main(
|
||||||
argv: Sequence[str] | None = None,
|
argv: Sequence[str] | None = None,
|
||||||
gym_factory: GymFactory = selenium_gym_factory,
|
gym_factory: GymFactory = selenium_gym_factory,
|
||||||
|
sleep: Sleep = time.sleep,
|
||||||
) -> int:
|
) -> int:
|
||||||
"""@brief Start the bot: open the site, log in and book the next Tuesday 6pm class.
|
"""@brief Start the bot: open the site, log in, book the classes and verify them.
|
||||||
|
|
||||||
@param argv Arguments without the program name; None reads `sys.argv`.
|
@param argv Arguments without the program name; None reads `sys.argv`.
|
||||||
@param gym_factory Builds the gym site; tests pass a fake.
|
@param gym_factory Builds the gym site; tests pass a fake.
|
||||||
|
@param sleep Waits between two attempts of a retried step; tests pass a recorder.
|
||||||
@return Process exit code: 0 done, 1 a step failed, 2 credentials missing, 3 mismatch.
|
@return Process exit code: 0 done, 1 a step failed, 2 credentials missing, 3 mismatch.
|
||||||
"""
|
"""
|
||||||
logging.basicConfig(level=logging.INFO, format="%(message)s")
|
logging.basicConfig(level=logging.INFO, format="%(message)s")
|
||||||
@@ -187,17 +223,20 @@ def main(
|
|||||||
recorder = ConsoleRecorder()
|
recorder = ConsoleRecorder()
|
||||||
root.addHandler(recorder)
|
root.addHandler(recorder)
|
||||||
try:
|
try:
|
||||||
return _main(argv, gym_factory, recorder)
|
return _main(argv, gym_factory, recorder, sleep)
|
||||||
finally:
|
finally:
|
||||||
root.removeHandler(recorder)
|
root.removeHandler(recorder)
|
||||||
|
|
||||||
|
|
||||||
def _main(argv: Sequence[str] | None, gym_factory: GymFactory, recorder: ConsoleRecorder) -> int:
|
def _main(
|
||||||
|
argv: Sequence[str] | None, gym_factory: GymFactory, recorder: ConsoleRecorder, sleep: Sleep
|
||||||
|
) -> int:
|
||||||
"""@brief The body of `main`, run while the recorder is attached.
|
"""@brief The body of `main`, run while the recorder is attached.
|
||||||
|
|
||||||
@param argv Arguments without the program name.
|
@param argv Arguments without the program name.
|
||||||
@param gym_factory Builds the gym site.
|
@param gym_factory Builds the gym site.
|
||||||
@param recorder The console recorder.
|
@param recorder The console recorder.
|
||||||
|
@param sleep Waits between two attempts of a retried step.
|
||||||
@return Process exit code.
|
@return Process exit code.
|
||||||
"""
|
"""
|
||||||
_use_utf8_output()
|
_use_utf8_output()
|
||||||
@@ -209,7 +248,7 @@ def _main(argv: Sequence[str] | None, gym_factory: GymFactory, recorder: Console
|
|||||||
return 2
|
return 2
|
||||||
gym = gym_factory(args.headless, args.profile_dir, args.keep_open)
|
gym = gym_factory(args.headless, args.profile_dir, args.keep_open)
|
||||||
try:
|
try:
|
||||||
verified = _run(gym, args, recorder, credentials)
|
verified = _run(gym, args, recorder, credentials, sleep)
|
||||||
except LoginFailedError as error:
|
except LoginFailedError as error:
|
||||||
logger.error("Login failed: %s", error)
|
logger.error("Login failed: %s", error)
|
||||||
return 1
|
return 1
|
||||||
|
|||||||
@@ -18,6 +18,31 @@ WAIT_TIMEOUT_SECONDS: Final[int] = 10
|
|||||||
## Attempts of the `retry` wrapper before it gives up (lecture step 9).
|
## Attempts of the `retry` wrapper before it gives up (lecture step 9).
|
||||||
RETRY_COUNT: Final[int] = 7
|
RETRY_COUNT: Final[int] = 7
|
||||||
|
|
||||||
|
## Seconds to wait between two attempts of the `retry` wrapper.
|
||||||
|
RETRY_DELAY_SECONDS: Final[float] = 0.5
|
||||||
|
|
||||||
|
## Name of a retried step that was given no description.
|
||||||
|
RETRY_DEFAULT_DESCRIPTION: Final[str] = "operation"
|
||||||
|
|
||||||
|
## Descriptions of the retried steps, as they appear in the log.
|
||||||
|
RETRY_DESCRIPTION_LOGIN: Final[str] = "login"
|
||||||
|
RETRY_DESCRIPTION_BOOK: Final[str] = "book {name} on {day}"
|
||||||
|
RETRY_DESCRIPTION_BOOKINGS: Final[str] = "get my bookings"
|
||||||
|
|
||||||
|
## Messages of the `retry` wrapper.
|
||||||
|
MESSAGE_RETRY_FAILED: Final[str] = (
|
||||||
|
"⚠ Attempt {attempt}/{retries} failed: {description}: {error}. Retrying..."
|
||||||
|
)
|
||||||
|
MESSAGE_RETRY_SUCCEEDED: Final[str] = "✓ {description} succeeded after {attempts} attempts"
|
||||||
|
MESSAGE_RETRIES_EXHAUSTED: Final[str] = "{description} failed after {retries} attempts: {error}"
|
||||||
|
MESSAGE_RETRIES_INVALID: Final[str] = "retries must be at least 1, got {retries}"
|
||||||
|
|
||||||
|
## Error raised when a class card is no longer on the schedule while a booking is repeated.
|
||||||
|
MESSAGE_CLASS_NOT_ON_SCHEDULE: Final[str] = "class {card_id} not found on the schedule"
|
||||||
|
|
||||||
|
## File name of the screenshot of lecture step 9 (the console with the retry warnings).
|
||||||
|
SCREENSHOT_STEP_9: Final[str] = "step-9.png"
|
||||||
|
|
||||||
## Weekdays of the classes the bot books, as the site abbreviates them.
|
## Weekdays of the classes the bot books, as the site abbreviates them.
|
||||||
TARGET_WEEKDAYS: Final[tuple[str, ...]] = ("Tue", "Thu")
|
TARGET_WEEKDAYS: Final[tuple[str, ...]] = ("Tue", "Thu")
|
||||||
|
|
||||||
|
|||||||
@@ -23,6 +23,10 @@ class PageFormatError(GymError):
|
|||||||
"""@brief A text read from the page (a day label or a time) has an unexpected format."""
|
"""@brief A text read from the page (a day label or a time) has an unexpected format."""
|
||||||
|
|
||||||
|
|
||||||
|
class RetriesExhaustedError(GymError):
|
||||||
|
"""@brief A step failed on every attempt; the cause is the error of the last attempt."""
|
||||||
|
|
||||||
|
|
||||||
class NoBookingsFoundError(GymError):
|
class NoBookingsFoundError(GymError):
|
||||||
"""@brief The My Bookings page shows no booking where the bot expects some.
|
"""@brief The My Bookings page shows no booking where the bot expects some.
|
||||||
|
|
||||||
|
|||||||
@@ -88,11 +88,18 @@ class SeleniumGym:
|
|||||||
@exception LoginFailedError The site shows a login error.
|
@exception LoginFailedError The site shows a login error.
|
||||||
@exception GymError The page did not behave as expected.
|
@exception GymError The page did not behave as expected.
|
||||||
"""
|
"""
|
||||||
self._wait.until(ec.element_to_be_clickable((By.ID, constants.NAV_LOGIN_BUTTON_ID))).click()
|
# After a failed login the form is still shown, so a repeated login skips the nav button.
|
||||||
|
if not self._driver.find_elements(By.ID, constants.LOGIN_EMAIL_INPUT_ID):
|
||||||
self._wait.until(
|
self._wait.until(
|
||||||
|
ec.element_to_be_clickable((By.ID, constants.NAV_LOGIN_BUTTON_ID))
|
||||||
|
).click()
|
||||||
|
email_input = self._wait.until(
|
||||||
ec.presence_of_element_located((By.ID, constants.LOGIN_EMAIL_INPUT_ID))
|
ec.presence_of_element_located((By.ID, constants.LOGIN_EMAIL_INPUT_ID))
|
||||||
).send_keys(email)
|
)
|
||||||
self._driver.find_element(By.ID, constants.LOGIN_PASSWORD_INPUT_ID).send_keys(password)
|
password_input = self._driver.find_element(By.ID, constants.LOGIN_PASSWORD_INPUT_ID)
|
||||||
|
for field, value in ((email_input, email), (password_input, password)):
|
||||||
|
field.clear()
|
||||||
|
field.send_keys(value)
|
||||||
self._driver.find_element(By.ID, constants.LOGIN_SUBMIT_BUTTON_ID).click()
|
self._driver.find_element(By.ID, constants.LOGIN_SUBMIT_BUTTON_ID).click()
|
||||||
self._wait.until(
|
self._wait.until(
|
||||||
ec.any_of(
|
ec.any_of(
|
||||||
|
|||||||
@@ -12,8 +12,19 @@
|
|||||||
// Dummy account of this fixture only; it is not a real account.
|
// Dummy account of this fixture only; it is not a real account.
|
||||||
const ACCEPTED_EMAIL = "fixture@example.invalid";
|
const ACCEPTED_EMAIL = "fixture@example.invalid";
|
||||||
const ACCEPTED_PASSWORD = "fixture-password";
|
const ACCEPTED_PASSWORD = "fixture-password";
|
||||||
|
// Imitates the network simulation: ?fail=N drops the first N submits after a short delay.
|
||||||
|
let failuresLeft = parseInt(new URLSearchParams(window.location.search).get("fail") || "0", 10);
|
||||||
document.getElementById("login-form").addEventListener("submit", function (event) {
|
document.getElementById("login-form").addEventListener("submit", function (event) {
|
||||||
event.preventDefault();
|
event.preventDefault();
|
||||||
|
document.getElementById("message-area").innerHTML = "";
|
||||||
|
if (failuresLeft > 0) {
|
||||||
|
failuresLeft -= 1;
|
||||||
|
setTimeout(function () {
|
||||||
|
document.getElementById("message-area").innerHTML =
|
||||||
|
'<div id="error-message">Network request failed. Please try again.</div>';
|
||||||
|
}, 100);
|
||||||
|
return;
|
||||||
|
}
|
||||||
const email = document.getElementById("email-input").value;
|
const email = document.getElementById("email-input").value;
|
||||||
const password = document.getElementById("password-input").value;
|
const password = document.getElementById("password-input").value;
|
||||||
if (email === ACCEPTED_EMAIL && password === ACCEPTED_PASSWORD) {
|
if (email === ACCEPTED_EMAIL && password === ACCEPTED_PASSWORD) {
|
||||||
|
|||||||
@@ -11,7 +11,13 @@
|
|||||||
<script>
|
<script>
|
||||||
// Imitates the site: a loading text, then the page for the state in the query
|
// Imitates the site: a loading text, then the page for the state in the query
|
||||||
// (?state=empty or ?state=error; anything else shows two bookings and a waitlist entry).
|
// (?state=empty or ?state=error; anything else shows two bookings and a waitlist entry).
|
||||||
const state = new URLSearchParams(window.location.search).get("state");
|
const params = new URLSearchParams(window.location.search);
|
||||||
|
const state = params.get("state");
|
||||||
|
// ?fail=N shows the error for the first N loads of the page in this tab (the network
|
||||||
|
// simulation); the count lives in sessionStorage because every load starts a new page.
|
||||||
|
const loads = parseInt(sessionStorage.getItem("loads") || "0", 10);
|
||||||
|
const dropped = loads < parseInt(params.get("fail") || "0", 10);
|
||||||
|
sessionStorage.setItem("loads", String(loads + 1));
|
||||||
// The nav link keeps the state, so opening the page from here shows the same state again.
|
// The nav link keeps the state, so opening the page from here shows the same state again.
|
||||||
document.getElementById("my-bookings-link").href = "my_bookings.html" + window.location.search;
|
document.getElementById("my-bookings-link").href = "my_bookings.html" + window.location.search;
|
||||||
const page = document.getElementById("my-bookings-page");
|
const page = document.getElementById("my-bookings-page");
|
||||||
@@ -19,7 +25,7 @@
|
|||||||
setTimeout(function () {
|
setTimeout(function () {
|
||||||
document.getElementById("loading-placeholder").remove();
|
document.getElementById("loading-placeholder").remove();
|
||||||
page.dataset.loading = "false";
|
page.dataset.loading = "false";
|
||||||
if (state === "error") {
|
if (state === "error" || dropped) {
|
||||||
content.innerHTML = '<div id="error-message">Failed to load bookings</div>';
|
content.innerHTML = '<div id="error-message">Failed to load bookings</div>';
|
||||||
} else if (state === "empty") {
|
} else if (state === "empty") {
|
||||||
content.innerHTML = '<div id="empty-bookings-state">You have no bookings yet</div>';
|
content.innerHTML = '<div id="empty-bookings-state">You have no bookings yet</div>';
|
||||||
|
|||||||
@@ -46,7 +46,7 @@
|
|||||||
<p id="class-time-301"><strong>Time:</strong> 7:00 AM</p>
|
<p id="class-time-301"><strong>Time:</strong> 7:00 AM</p>
|
||||||
<button id="book-button-301">Book Class</button>
|
<button id="book-button-301">Book Class</button>
|
||||||
</div>
|
</div>
|
||||||
<div id="class-card-302" data-class-type="spin" data-user-booked="false" data-fail-once="true">
|
<div id="class-card-302" data-class-type="spin" data-user-booked="false" data-fail-times="1">
|
||||||
<h3 id="class-name-302">Spin Class</h3>
|
<h3 id="class-name-302">Spin Class</h3>
|
||||||
<p id="class-time-302"><strong>Time:</strong> 6:00 PM</p>
|
<p id="class-time-302"><strong>Time:</strong> 6:00 PM</p>
|
||||||
<button id="book-button-302">Book Class</button>
|
<button id="book-button-302">Book Class</button>
|
||||||
@@ -55,6 +55,11 @@
|
|||||||
</div>
|
</div>
|
||||||
<script>
|
<script>
|
||||||
// Imitates the site: a busy text, then the new state; card 302 fails on its first click.
|
// Imitates the site: a busy text, then the new state; card 302 fails on its first click.
|
||||||
|
// ?fail=N makes every button fail on its first N clicks (the network simulation).
|
||||||
|
const failParam = parseInt(new URLSearchParams(window.location.search).get("fail") || "0", 10);
|
||||||
|
document.querySelectorAll("div[id^='class-card-']").forEach(function (card) {
|
||||||
|
card.dataset.failLeft = String(Math.max(failParam, parseInt(card.dataset.failTimes || "0", 10)));
|
||||||
|
});
|
||||||
document.querySelectorAll("button[id^='book-button-']").forEach(function (button) {
|
document.querySelectorAll("button[id^='book-button-']").forEach(function (button) {
|
||||||
button.addEventListener("click", function () {
|
button.addEventListener("click", function () {
|
||||||
const id = button.id.replace("book-button-", "");
|
const id = button.id.replace("book-button-", "");
|
||||||
@@ -66,8 +71,8 @@
|
|||||||
button.textContent = waitlist ? "Joining..." : "Booking...";
|
button.textContent = waitlist ? "Joining..." : "Booking...";
|
||||||
button.disabled = true;
|
button.disabled = true;
|
||||||
setTimeout(function () {
|
setTimeout(function () {
|
||||||
if (card.dataset.failOnce === "true") {
|
if (parseInt(card.dataset.failLeft, 10) > 0) {
|
||||||
card.dataset.failOnce = "false";
|
card.dataset.failLeft = String(parseInt(card.dataset.failLeft, 10) - 1);
|
||||||
button.textContent = oldText;
|
button.textContent = oldText;
|
||||||
button.disabled = false;
|
button.disabled = false;
|
||||||
const box = document.createElement("div");
|
const box = document.createElement("div");
|
||||||
|
|||||||
@@ -8,10 +8,17 @@ from pathlib import Path
|
|||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from snack_and_lift.application.booking import book_target_classes
|
from snack_and_lift.application.booking import book_class_with_retry, book_target_classes
|
||||||
from snack_and_lift.application.verification import get_my_bookings
|
from snack_and_lift.application.credentials import Credentials
|
||||||
|
from snack_and_lift.application.session import login_with_retry
|
||||||
|
from snack_and_lift.application.verification import get_my_bookings, get_my_bookings_with_retry
|
||||||
from snack_and_lift.domain.booking_entry import BookingEntry
|
from snack_and_lift.domain.booking_entry import BookingEntry
|
||||||
from snack_and_lift.domain.errors import GymError, LoginFailedError, NoBookingsFoundError
|
from snack_and_lift.domain.errors import (
|
||||||
|
GymError,
|
||||||
|
LoginFailedError,
|
||||||
|
NoBookingsFoundError,
|
||||||
|
RetriesExhaustedError,
|
||||||
|
)
|
||||||
from snack_and_lift.domain.models import Outcome
|
from snack_and_lift.domain.models import Outcome
|
||||||
from snack_and_lift.infrastructure.browser import create_driver
|
from snack_and_lift.infrastructure.browser import create_driver
|
||||||
from snack_and_lift.infrastructure.selenium_gym import SeleniumGym
|
from snack_and_lift.infrastructure.selenium_gym import SeleniumGym
|
||||||
@@ -119,13 +126,11 @@ def test_save_text_screenshot_writes_a_png_and_keeps_the_page(
|
|||||||
def test_book_target_classes_books_every_tuesday_and_thursday_class(
|
def test_book_target_classes_books_every_tuesday_and_thursday_class(
|
||||||
schedule_gym: SeleniumGym,
|
schedule_gym: SeleniumGym,
|
||||||
) -> None:
|
) -> None:
|
||||||
with pytest.raises(GymError, match="Network error"):
|
# Card 302 drops its first click; the booking repeats it and the page confirms the second.
|
||||||
book_target_classes(schedule_gym)
|
results = book_target_classes(schedule_gym, sleep=lambda _: None)
|
||||||
|
|
||||||
results = book_target_classes(schedule_gym)
|
|
||||||
|
|
||||||
assert [(r.card.card_id, r.outcome) for r in results] == [
|
assert [(r.card.card_id, r.outcome) for r in results] == [
|
||||||
("201", Outcome.ALREADY_WAITLISTED),
|
("201", Outcome.NEW_WAITLIST),
|
||||||
("302", Outcome.NEW_BOOKING),
|
("302", Outcome.NEW_BOOKING),
|
||||||
]
|
]
|
||||||
|
|
||||||
@@ -188,3 +193,80 @@ def test_list_my_bookings_raises_with_the_text_of_the_error_box(
|
|||||||
) -> None:
|
) -> None:
|
||||||
with pytest.raises(GymError, match="Failed to load bookings"):
|
with pytest.raises(GymError, match="Failed to load bookings"):
|
||||||
open_my_bookings_page("?state=error").list_my_bookings()
|
open_my_bookings_page("?state=error").list_my_bookings()
|
||||||
|
|
||||||
|
|
||||||
|
FIXTURE_LOGIN = (Path(__file__).parent / "fixtures" / "login.html").as_uri()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def open_fixture(tmp_path: Path) -> Iterator[Callable[[str], SeleniumGym]]:
|
||||||
|
"""@brief Opens a fixture page by its address, with the query that sets its failures."""
|
||||||
|
driver = create_driver(headless=True, profile_dir=tmp_path / "profile", keep_open=False)
|
||||||
|
|
||||||
|
def open_page(url: str) -> SeleniumGym:
|
||||||
|
driver.get(url)
|
||||||
|
return SeleniumGym(driver, base_url=url)
|
||||||
|
|
||||||
|
try:
|
||||||
|
yield open_page
|
||||||
|
finally:
|
||||||
|
driver.quit()
|
||||||
|
|
||||||
|
|
||||||
|
def test_login_with_retry_logs_in_after_two_dropped_requests(
|
||||||
|
open_fixture: Callable[[str], SeleniumGym],
|
||||||
|
) -> None:
|
||||||
|
gym = open_fixture(FIXTURE_LOGIN + "?fail=2")
|
||||||
|
sleeps: list[float] = []
|
||||||
|
|
||||||
|
login_with_retry(gym, Credentials(FIXTURE_EMAIL, FIXTURE_PASSWORD), sleep=sleeps.append)
|
||||||
|
|
||||||
|
assert len(sleeps) == 2
|
||||||
|
|
||||||
|
|
||||||
|
def test_login_with_retry_gives_up_when_every_request_is_dropped(
|
||||||
|
open_fixture: Callable[[str], SeleniumGym],
|
||||||
|
) -> None:
|
||||||
|
gym = open_fixture(FIXTURE_LOGIN + "?fail=5")
|
||||||
|
|
||||||
|
with pytest.raises(RetriesExhaustedError, match="Network request failed"):
|
||||||
|
login_with_retry(
|
||||||
|
gym, Credentials(FIXTURE_EMAIL, FIXTURE_PASSWORD), retries=3, sleep=lambda _: None
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_book_class_with_retry_books_after_two_dropped_clicks(
|
||||||
|
open_fixture: Callable[[str], SeleniumGym],
|
||||||
|
) -> None:
|
||||||
|
gym = open_fixture(FIXTURE_SCHEDULE + "?fail=2")
|
||||||
|
card = next(card for card in gym.list_class_cards() if card.card_id == "302")
|
||||||
|
|
||||||
|
result = book_class_with_retry(gym, card, sleep=lambda _: None)
|
||||||
|
|
||||||
|
assert result.outcome is Outcome.NEW_BOOKING
|
||||||
|
assert next(c for c in gym.list_class_cards() if c.card_id == "302").button_text == "Booked"
|
||||||
|
|
||||||
|
|
||||||
|
def test_book_target_classes_completes_when_every_class_drops_two_clicks(
|
||||||
|
open_fixture: Callable[[str], SeleniumGym],
|
||||||
|
) -> None:
|
||||||
|
gym = open_fixture(FIXTURE_SCHEDULE + "?fail=2")
|
||||||
|
|
||||||
|
results = book_target_classes(gym, sleep=lambda _: None)
|
||||||
|
|
||||||
|
assert [(r.card.card_id, r.outcome) for r in results] == [
|
||||||
|
("201", Outcome.NEW_WAITLIST),
|
||||||
|
("302", Outcome.NEW_BOOKING),
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_my_bookings_with_retry_reads_the_page_after_two_failed_loads(
|
||||||
|
open_fixture: Callable[[str], SeleniumGym],
|
||||||
|
) -> None:
|
||||||
|
gym = open_fixture(FIXTURE_MY_BOOKINGS + "?fail=2")
|
||||||
|
sleeps: list[float] = []
|
||||||
|
|
||||||
|
entries = get_my_bookings_with_retry(gym, sleep=sleeps.append)
|
||||||
|
|
||||||
|
assert [entry.name for entry in entries] == ["Spin Class", "Yoga Class", "HIIT Class"]
|
||||||
|
assert sleeps
|
||||||
|
|||||||
+70
-3
@@ -2,6 +2,8 @@
|
|||||||
@brief A fake of the GymPort for the unit tests.
|
@brief A fake of the GymPort for the unit tests.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
import random
|
||||||
|
from dataclasses import replace
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from snack_and_lift import constants
|
from snack_and_lift import constants
|
||||||
@@ -32,11 +34,20 @@ def _entry_of(card: ClassCard) -> BookingEntry | None:
|
|||||||
return BookingEntry(card.name, f"{card.date_text}, {time_text}", flag)
|
return BookingEntry(card.name, f"{card.date_text}, {time_text}", flag)
|
||||||
|
|
||||||
|
|
||||||
|
NETWORK_ERROR_TEXT = "Network request failed. Please try again."
|
||||||
|
|
||||||
|
|
||||||
class FakeGym:
|
class FakeGym:
|
||||||
"""@brief Records the calls; can refuse the login, serve cards and fail a click.
|
"""@brief Records the calls; can refuse the login, serve cards and fail a click.
|
||||||
|
|
||||||
Unless `bookings` is given, the My Bookings page shows every card that is, or by the
|
Unless `bookings` is given, the My Bookings page shows every card that is, or by the
|
||||||
click becomes, booked or waitlisted.
|
click becomes, booked or waitlisted. A successful click turns the card's button into its
|
||||||
|
new state, so a card read again shows what the click did.
|
||||||
|
|
||||||
|
`fail_first` is a deterministic failure schedule: it maps the name of a port method
|
||||||
|
(`log_in`, `press_class_button`, `open_my_bookings`, `list_my_bookings`) to the number of
|
||||||
|
its first calls that fail like a dropped request. With `click_goes_through`, a failing
|
||||||
|
`press_class_button` still turns the button (the click arrived, the answer did not).
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
@@ -47,6 +58,8 @@ class FakeGym:
|
|||||||
press_error: str | None = None,
|
press_error: str | None = None,
|
||||||
bookings: list[BookingEntry] | None = None,
|
bookings: list[BookingEntry] | None = None,
|
||||||
bookings_error: str | None = None,
|
bookings_error: str | None = None,
|
||||||
|
fail_first: dict[str, int] | None = None,
|
||||||
|
click_goes_through: bool = False,
|
||||||
) -> None:
|
) -> None:
|
||||||
self.login_error = login_error
|
self.login_error = login_error
|
||||||
self.cards = cards or []
|
self.cards = cards or []
|
||||||
@@ -54,6 +67,8 @@ class FakeGym:
|
|||||||
self.press_error = press_error
|
self.press_error = press_error
|
||||||
self.bookings = bookings
|
self.bookings = bookings
|
||||||
self.bookings_error = bookings_error
|
self.bookings_error = bookings_error
|
||||||
|
self.click_goes_through = click_goes_through
|
||||||
|
self._failures_left = dict(fail_first or {})
|
||||||
self.calls: list[str] = []
|
self.calls: list[str] = []
|
||||||
self.logins: list[tuple[str, str]] = []
|
self.logins: list[tuple[str, str]] = []
|
||||||
self.screenshots: list[Path] = []
|
self.screenshots: list[Path] = []
|
||||||
@@ -64,11 +79,29 @@ class FakeGym:
|
|||||||
def open_site(self) -> None:
|
def open_site(self) -> None:
|
||||||
self.calls.append("open_site")
|
self.calls.append("open_site")
|
||||||
|
|
||||||
|
def _should_fail(self, name: str) -> bool:
|
||||||
|
"""@brief Whether this call is one of the scheduled failures; counts it."""
|
||||||
|
left = self._failures_left.get(name, 0)
|
||||||
|
if left > 0:
|
||||||
|
self._failures_left[name] = left - 1
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
def _turn_button(self, card_id: str) -> str:
|
||||||
|
"""@brief Turn the button of a card to the state its click gives; return the new text."""
|
||||||
|
index = next(i for i, card in enumerate(self.cards) if card.card_id == card_id)
|
||||||
|
card = self.cards[index]
|
||||||
|
new_text = _PRESS_RESULTS[card.button_text]
|
||||||
|
self.cards[index] = replace(card, button_text=new_text)
|
||||||
|
return new_text
|
||||||
|
|
||||||
def log_in(self, email: str, password: str) -> None:
|
def log_in(self, email: str, password: str) -> None:
|
||||||
self.calls.append("log_in")
|
self.calls.append("log_in")
|
||||||
self.logins.append((email, password))
|
self.logins.append((email, password))
|
||||||
if self.login_error is not None:
|
if self.login_error is not None:
|
||||||
raise LoginFailedError(self.login_error)
|
raise LoginFailedError(self.login_error)
|
||||||
|
if self._should_fail("log_in"):
|
||||||
|
raise LoginFailedError(NETWORK_ERROR_TEXT)
|
||||||
|
|
||||||
def list_class_cards(self) -> list[ClassCard]:
|
def list_class_cards(self) -> list[ClassCard]:
|
||||||
self.calls.append("list_class_cards")
|
self.calls.append("list_class_cards")
|
||||||
@@ -81,14 +114,21 @@ class FakeGym:
|
|||||||
raise GymError(self.press_error)
|
raise GymError(self.press_error)
|
||||||
if self.press_result is not None:
|
if self.press_result is not None:
|
||||||
return self.press_result
|
return self.press_result
|
||||||
card = next(card for card in self.cards if card.card_id == card_id)
|
if self._should_fail("press_class_button"):
|
||||||
return _PRESS_RESULTS[card.button_text]
|
if self.click_goes_through:
|
||||||
|
self._turn_button(card_id)
|
||||||
|
raise GymError(NETWORK_ERROR_TEXT)
|
||||||
|
return self._turn_button(card_id)
|
||||||
|
|
||||||
def open_my_bookings(self) -> None:
|
def open_my_bookings(self) -> None:
|
||||||
self.calls.append("open_my_bookings")
|
self.calls.append("open_my_bookings")
|
||||||
|
if self._should_fail("open_my_bookings"):
|
||||||
|
raise GymError(NETWORK_ERROR_TEXT)
|
||||||
|
|
||||||
def list_my_bookings(self) -> list[BookingEntry]:
|
def list_my_bookings(self) -> list[BookingEntry]:
|
||||||
self.calls.append("list_my_bookings")
|
self.calls.append("list_my_bookings")
|
||||||
|
if self._should_fail("list_my_bookings"):
|
||||||
|
raise GymError(NETWORK_ERROR_TEXT)
|
||||||
if self.bookings_error is not None:
|
if self.bookings_error is not None:
|
||||||
raise GymError(self.bookings_error)
|
raise GymError(self.bookings_error)
|
||||||
if self.bookings is not None:
|
if self.bookings is not None:
|
||||||
@@ -107,3 +147,30 @@ class FakeGym:
|
|||||||
def close(self) -> None:
|
def close(self) -> None:
|
||||||
self.calls.append("close")
|
self.calls.append("close")
|
||||||
self.closed = True
|
self.closed = True
|
||||||
|
|
||||||
|
|
||||||
|
class ChaosGym(FakeGym):
|
||||||
|
"""@brief A gym whose login, click and bookings read each fail with a set probability.
|
||||||
|
|
||||||
|
The site's network simulation fails up to 50% of these requests and writes nothing when
|
||||||
|
one fails. The random numbers come from a seeded generator, so a run is repeatable.
|
||||||
|
"""
|
||||||
|
|
||||||
|
_FAILING_CALLS = frozenset({"log_in", "press_class_button", "list_my_bookings"})
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
rng: random.Random,
|
||||||
|
failure_probability: float = 0.5,
|
||||||
|
cards: list[ClassCard] | None = None,
|
||||||
|
) -> None:
|
||||||
|
super().__init__(cards=cards)
|
||||||
|
self._rng = rng
|
||||||
|
self._failure_probability = failure_probability
|
||||||
|
|
||||||
|
def _should_fail(self, name: str) -> bool:
|
||||||
|
return name in self._FAILING_CALLS and self._rng.random() < self._failure_probability
|
||||||
|
|
||||||
|
|
||||||
|
def no_sleep(seconds: float) -> None:
|
||||||
|
"""@brief A `sleep` that returns at once, so a retry test never waits."""
|
||||||
|
|||||||
@@ -3,13 +3,13 @@
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from tests.unit.fakes import FakeGym
|
from tests.unit.fakes import FakeGym, no_sleep
|
||||||
from tests.unit.test_booking_entry import make_entry
|
from tests.unit.test_booking_entry import make_entry
|
||||||
from tests.unit.test_models import make_card
|
from tests.unit.test_models import make_card
|
||||||
|
|
||||||
from snack_and_lift.application.booking import book_target_classes
|
from snack_and_lift.application.booking import book_target_classes
|
||||||
from snack_and_lift.application.verification import get_my_bookings, verify_bookings
|
from snack_and_lift.application.verification import get_my_bookings, verify_bookings
|
||||||
from snack_and_lift.domain.errors import GymError, NoBookingsFoundError
|
from snack_and_lift.domain.errors import GymError, NoBookingsFoundError, RetriesExhaustedError
|
||||||
from snack_and_lift.domain.models import ClassResult, Outcome
|
from snack_and_lift.domain.models import ClassResult, Outcome
|
||||||
|
|
||||||
|
|
||||||
@@ -67,8 +67,10 @@ def test_verify_bookings_raises_when_classes_were_booked_but_the_page_is_empty()
|
|||||||
gym = FakeGym(bookings=[])
|
gym = FakeGym(bookings=[])
|
||||||
results = [ClassResult(make_card("Tue, Aug 12"), Outcome.NEW_BOOKING)]
|
results = [ClassResult(make_card("Tue, Aug 12"), Outcome.NEW_BOOKING)]
|
||||||
|
|
||||||
with pytest.raises(NoBookingsFoundError):
|
with pytest.raises(RetriesExhaustedError) as caught:
|
||||||
verify_bookings(gym, results)
|
verify_bookings(gym, results, sleep=no_sleep)
|
||||||
|
|
||||||
|
assert isinstance(caught.value.__cause__, NoBookingsFoundError)
|
||||||
|
|
||||||
|
|
||||||
def test_verify_bookings_skips_the_page_when_nothing_is_expected() -> None:
|
def test_verify_bookings_skips_the_page_when_nothing_is_expected() -> None:
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
import logging
|
import logging
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from tests.unit.fakes import FakeGym
|
from tests.unit.fakes import FakeGym, no_sleep
|
||||||
from tests.unit.test_models import make_card
|
from tests.unit.test_models import make_card
|
||||||
|
|
||||||
from snack_and_lift.application.booking import (
|
from snack_and_lift.application.booking import (
|
||||||
@@ -147,4 +147,4 @@ def test_book_target_classes_propagates_a_failing_class() -> None:
|
|||||||
gym = FakeGym(cards=[make_card("Thu, Aug 14")], press_error="Network down")
|
gym = FakeGym(cards=[make_card("Thu, Aug 14")], press_error="Network down")
|
||||||
|
|
||||||
with pytest.raises(GymError, match="Network down"):
|
with pytest.raises(GymError, match="Network down"):
|
||||||
book_target_classes(gym)
|
book_target_classes(gym, sleep=no_sleep)
|
||||||
|
|||||||
+15
-6
@@ -6,7 +6,7 @@ import logging
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from tests.unit.fakes import FakeGym
|
from tests.unit.fakes import FakeGym, no_sleep
|
||||||
from tests.unit.test_booking_entry import make_entry
|
from tests.unit.test_booking_entry import make_entry
|
||||||
from tests.unit.test_models import make_card
|
from tests.unit.test_models import make_card
|
||||||
|
|
||||||
@@ -75,6 +75,7 @@ def test_main_saves_both_screenshots_on_success(tmp_path: Path) -> None:
|
|||||||
tmp_path / "step-5.png",
|
tmp_path / "step-5.png",
|
||||||
tmp_path / "step-6.png",
|
tmp_path / "step-6.png",
|
||||||
tmp_path / "step-8.png",
|
tmp_path / "step-8.png",
|
||||||
|
tmp_path / "step-9.png",
|
||||||
]
|
]
|
||||||
assert gym.calls == [
|
assert gym.calls == [
|
||||||
"open_site",
|
"open_site",
|
||||||
@@ -88,6 +89,7 @@ def test_main_saves_both_screenshots_on_success(tmp_path: Path) -> None:
|
|||||||
"save_text_screenshot",
|
"save_text_screenshot",
|
||||||
"save_screenshot",
|
"save_screenshot",
|
||||||
"save_text_screenshot",
|
"save_text_screenshot",
|
||||||
|
"save_text_screenshot",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
@@ -149,12 +151,18 @@ def test_main_saves_step_3_after_the_first_class_and_the_report_images(tmp_path:
|
|||||||
"list_my_bookings",
|
"list_my_bookings",
|
||||||
"save_screenshot",
|
"save_screenshot",
|
||||||
"save_text_screenshot",
|
"save_text_screenshot",
|
||||||
|
"save_text_screenshot",
|
||||||
]
|
]
|
||||||
assert gym.screenshots[-2:] == [tmp_path / "step-3.png", tmp_path / "step-7.png"]
|
assert gym.screenshots[-2:] == [tmp_path / "step-3.png", tmp_path / "step-7.png"]
|
||||||
(_, _), (step_5, _), (step_6, _), (step_8, step_8_path) = gym.text_screenshots
|
(_, _), (step_5, _), (step_6, _), (step_8, step_8_path), (step_9, step_9_path) = (
|
||||||
|
gym.text_screenshots
|
||||||
|
)
|
||||||
assert step_8_path == tmp_path / "step-8.png"
|
assert step_8_path == tmp_path / "step-8.png"
|
||||||
assert step_8.startswith("--- VERIFYING ON MY BOOKINGS PAGE ---")
|
assert step_8.startswith("--- VERIFYING ON MY BOOKINGS PAGE ---")
|
||||||
assert step_8.endswith("✅ SUCCESS: All bookings verified!")
|
assert step_8.endswith("✅ SUCCESS: All bookings verified!")
|
||||||
|
assert step_9_path == tmp_path / "step-9.png"
|
||||||
|
assert step_9.startswith("✓ Logged in")
|
||||||
|
assert step_9.endswith("✅ SUCCESS: All bookings verified!")
|
||||||
assert step_5.startswith("--- BOOKING SUMMARY ---\nNew bookings: 2")
|
assert step_5.startswith("--- BOOKING SUMMARY ---\nNew bookings: 2")
|
||||||
assert "--- DETAILED CLASS LIST ---" not in step_5
|
assert "--- DETAILED CLASS LIST ---" not in step_5
|
||||||
assert step_6.startswith(step_5)
|
assert step_6.startswith(step_5)
|
||||||
@@ -185,7 +193,8 @@ def test_main_returns_3_on_a_mismatch(tmp_path: Path, caplog: pytest.LogCaptureF
|
|||||||
assert "❌ MISMATCH: Missing 1 bookings" in caplog.text
|
assert "❌ MISMATCH: Missing 1 bookings" in caplog.text
|
||||||
assert " ✗ Missing: Spin Class on Tue, Aug 19" in caplog.text
|
assert " ✗ Missing: Spin Class on Tue, Aug 19" in caplog.text
|
||||||
assert gym.screenshots[-1] == tmp_path / "step-7.png"
|
assert gym.screenshots[-1] == tmp_path / "step-7.png"
|
||||||
assert gym.text_screenshots[-1][1] == tmp_path / "step-8.png"
|
assert gym.text_screenshots[-2][1] == tmp_path / "step-8.png"
|
||||||
|
assert gym.text_screenshots[-1][1] == tmp_path / "step-9.png"
|
||||||
assert gym.closed is True
|
assert gym.closed is True
|
||||||
|
|
||||||
|
|
||||||
@@ -193,7 +202,7 @@ def test_main_returns_3_on_a_mismatch(tmp_path: Path, caplog: pytest.LogCaptureF
|
|||||||
def test_main_returns_1_when_the_bookings_page_is_empty() -> None:
|
def test_main_returns_1_when_the_bookings_page_is_empty() -> None:
|
||||||
gym = FakeGym(cards=[make_card("Tue, Aug 19")], bookings=[])
|
gym = FakeGym(cards=[make_card("Tue, Aug 19")], bookings=[])
|
||||||
|
|
||||||
assert main([], lambda *_: gym) == 1
|
assert main([], lambda *_: gym, no_sleep) == 1
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.usefixtures("credentials_env")
|
@pytest.mark.usefixtures("credentials_env")
|
||||||
@@ -239,7 +248,7 @@ def test_first_tuesday_only_flag_is_read() -> None:
|
|||||||
def test_main_returns_1_when_the_booking_fails() -> None:
|
def test_main_returns_1_when_the_booking_fails() -> None:
|
||||||
gym = FakeGym(cards=[make_card("Tue, Aug 19")], press_error="Network down")
|
gym = FakeGym(cards=[make_card("Tue, Aug 19")], press_error="Network down")
|
||||||
|
|
||||||
assert main(["--headless"], lambda *_: gym) == 1
|
assert main(["--headless"], lambda *_: gym, no_sleep) == 1
|
||||||
assert gym.closed is True
|
assert gym.closed is True
|
||||||
|
|
||||||
|
|
||||||
@@ -269,7 +278,7 @@ def test_main_returns_2_when_credentials_are_missing(
|
|||||||
def test_main_returns_1_when_login_fails() -> None:
|
def test_main_returns_1_when_login_fails() -> None:
|
||||||
gym = FakeGym(login_error="Invalid credentials")
|
gym = FakeGym(login_error="Invalid credentials")
|
||||||
|
|
||||||
assert main(["--headless"], lambda *_: gym) == 1
|
assert main(["--headless"], lambda *_: gym, no_sleep) == 1
|
||||||
assert gym.closed is True
|
assert gym.closed is True
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -29,3 +29,7 @@ def test_retry_count_is_seven() -> None:
|
|||||||
|
|
||||||
def test_bot_books_tuesday_and_thursday() -> None:
|
def test_bot_books_tuesday_and_thursday() -> None:
|
||||||
assert constants.TARGET_WEEKDAYS == ("Tue", "Thu")
|
assert constants.TARGET_WEEKDAYS == ("Tue", "Thu")
|
||||||
|
|
||||||
|
|
||||||
|
def test_retry_delay_is_half_a_second() -> None:
|
||||||
|
assert constants.RETRY_DELAY_SECONDS == 0.5
|
||||||
|
|||||||
@@ -0,0 +1,316 @@
|
|||||||
|
"""@file test_resilience.py
|
||||||
|
@brief Lecture step 9: login, booking and bookings read survive a site that drops requests.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import random
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from tests.unit.fakes import ChaosGym, FakeGym, no_sleep
|
||||||
|
from tests.unit.test_booking_entry import make_entry
|
||||||
|
from tests.unit.test_models import make_card
|
||||||
|
|
||||||
|
from snack_and_lift import constants
|
||||||
|
from snack_and_lift.application.booking import (
|
||||||
|
book_class_with_retry,
|
||||||
|
book_next_tuesday,
|
||||||
|
book_target_classes,
|
||||||
|
)
|
||||||
|
from snack_and_lift.application.credentials import Credentials
|
||||||
|
from snack_and_lift.application.session import login_with_retry
|
||||||
|
from snack_and_lift.application.verification import get_my_bookings_with_retry, verify_bookings
|
||||||
|
from snack_and_lift.cli import main, parse_args
|
||||||
|
from snack_and_lift.domain.errors import GymError, LoginFailedError, RetriesExhaustedError
|
||||||
|
from snack_and_lift.domain.models import ButtonState, ClassResult, Outcome
|
||||||
|
|
||||||
|
DUMMY_EMAIL = "dummy@example.invalid"
|
||||||
|
DUMMY_PASSWORD = "dummy-password"
|
||||||
|
CREDENTIALS = Credentials(DUMMY_EMAIL, DUMMY_PASSWORD)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def credentials_env(monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
monkeypatch.setenv(constants.ACCOUNT_EMAIL_ENV, DUMMY_EMAIL)
|
||||||
|
monkeypatch.setenv(constants.ACCOUNT_PASSWORD_ENV, DUMMY_PASSWORD)
|
||||||
|
|
||||||
|
|
||||||
|
def test_login_with_retry_logs_in_after_two_dropped_requests(
|
||||||
|
caplog: pytest.LogCaptureFixture,
|
||||||
|
) -> None:
|
||||||
|
gym = FakeGym(fail_first={"log_in": 2})
|
||||||
|
sleeps: list[float] = []
|
||||||
|
|
||||||
|
with caplog.at_level(logging.INFO):
|
||||||
|
login_with_retry(gym, CREDENTIALS, sleep=sleeps.append)
|
||||||
|
|
||||||
|
assert gym.calls == ["log_in"] * 3
|
||||||
|
assert sleeps == [constants.RETRY_DELAY_SECONDS] * 2
|
||||||
|
assert "⚠ Attempt 2/7 failed: login: Network request failed. Please try again." in caplog.text
|
||||||
|
assert "✓ login succeeded after 3 attempts" in caplog.text
|
||||||
|
|
||||||
|
|
||||||
|
def test_login_with_retry_never_logs_the_password(caplog: pytest.LogCaptureFixture) -> None:
|
||||||
|
gym = FakeGym(fail_first={"log_in": 2})
|
||||||
|
|
||||||
|
with caplog.at_level(logging.DEBUG):
|
||||||
|
login_with_retry(gym, CREDENTIALS, sleep=no_sleep)
|
||||||
|
|
||||||
|
assert DUMMY_PASSWORD not in caplog.text
|
||||||
|
assert DUMMY_EMAIL not in caplog.text
|
||||||
|
|
||||||
|
|
||||||
|
def test_login_with_retry_gives_up_after_the_set_attempts() -> None:
|
||||||
|
gym = FakeGym(fail_first={"log_in": 10})
|
||||||
|
|
||||||
|
with pytest.raises(RetriesExhaustedError, match="login failed after 3 attempts") as caught:
|
||||||
|
login_with_retry(gym, CREDENTIALS, retries=3, sleep=no_sleep)
|
||||||
|
|
||||||
|
assert isinstance(caught.value.__cause__, LoginFailedError)
|
||||||
|
assert len(gym.logins) == 3
|
||||||
|
|
||||||
|
|
||||||
|
def test_book_class_with_retry_repeats_a_dropped_click() -> None:
|
||||||
|
card = make_card()
|
||||||
|
gym = FakeGym(cards=[card], fail_first={"press_class_button": 2})
|
||||||
|
|
||||||
|
result = book_class_with_retry(gym, card, sleep=no_sleep)
|
||||||
|
|
||||||
|
assert result.outcome is Outcome.NEW_BOOKING
|
||||||
|
assert gym.pressed == ["123", "123", "123"]
|
||||||
|
assert gym.calls.count("list_class_cards") == 2
|
||||||
|
|
||||||
|
|
||||||
|
def test_book_class_with_retry_reads_nothing_again_when_the_first_attempt_works() -> None:
|
||||||
|
card = make_card()
|
||||||
|
gym = FakeGym(cards=[card])
|
||||||
|
|
||||||
|
book_class_with_retry(gym, card, sleep=no_sleep)
|
||||||
|
|
||||||
|
assert gym.calls == ["press_class_button"]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("button_text", "outcome", "final_state"),
|
||||||
|
[
|
||||||
|
("Book Class", Outcome.NEW_BOOKING, ButtonState.BOOKED),
|
||||||
|
("Join Waitlist", Outcome.NEW_WAITLIST, ButtonState.WAITLISTED),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_book_class_with_retry_counts_a_click_that_went_through_as_new(
|
||||||
|
button_text: str,
|
||||||
|
outcome: Outcome,
|
||||||
|
final_state: ButtonState,
|
||||||
|
caplog: pytest.LogCaptureFixture,
|
||||||
|
) -> None:
|
||||||
|
card = make_card(button_text=button_text)
|
||||||
|
gym = FakeGym(cards=[card], fail_first={"press_class_button": 1}, click_goes_through=True)
|
||||||
|
|
||||||
|
with caplog.at_level(logging.INFO):
|
||||||
|
result = book_class_with_retry(gym, card, sleep=no_sleep)
|
||||||
|
|
||||||
|
assert result.outcome is outcome
|
||||||
|
assert gym.pressed == ["123"]
|
||||||
|
assert gym.cards[0].state is final_state
|
||||||
|
assert "Already" not in caplog.text
|
||||||
|
|
||||||
|
|
||||||
|
def test_book_class_with_retry_keeps_already_booked_as_it_is() -> None:
|
||||||
|
card = make_card(button_text="Booked")
|
||||||
|
gym = FakeGym(cards=[card])
|
||||||
|
|
||||||
|
result = book_class_with_retry(gym, card, sleep=no_sleep)
|
||||||
|
|
||||||
|
assert result.outcome is Outcome.ALREADY_BOOKED
|
||||||
|
assert gym.pressed == []
|
||||||
|
|
||||||
|
|
||||||
|
def test_book_class_with_retry_does_not_count_a_click_without_confirmation() -> None:
|
||||||
|
card = make_card()
|
||||||
|
gym = FakeGym(cards=[card], press_result="Book Class")
|
||||||
|
|
||||||
|
with pytest.raises(RetriesExhaustedError, match="click not confirmed"):
|
||||||
|
book_class_with_retry(gym, card, retries=2, sleep=no_sleep)
|
||||||
|
|
||||||
|
assert gym.pressed == ["123", "123"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_book_class_with_retry_fails_when_the_class_left_the_schedule() -> None:
|
||||||
|
card = make_card()
|
||||||
|
gym = FakeGym(cards=[card], fail_first={"press_class_button": 1})
|
||||||
|
gym.cards.clear()
|
||||||
|
|
||||||
|
with pytest.raises(RetriesExhaustedError, match="not found on the schedule"):
|
||||||
|
book_class_with_retry(gym, card, retries=2, sleep=no_sleep)
|
||||||
|
|
||||||
|
|
||||||
|
def test_book_class_with_retry_gives_up_after_the_set_attempts() -> None:
|
||||||
|
card = make_card()
|
||||||
|
gym = FakeGym(cards=[card], fail_first={"press_class_button": 9})
|
||||||
|
|
||||||
|
with pytest.raises(RetriesExhaustedError, match="book Spin Class on Tomorrow"):
|
||||||
|
book_class_with_retry(gym, card, retries=3, sleep=no_sleep)
|
||||||
|
|
||||||
|
assert len(gym.pressed) == 3
|
||||||
|
|
||||||
|
|
||||||
|
def test_book_next_tuesday_repeats_a_dropped_click() -> None:
|
||||||
|
gym = FakeGym(cards=[make_card("Tue, Aug 19")], fail_first={"press_class_button": 1})
|
||||||
|
|
||||||
|
result = book_next_tuesday(gym, sleep=no_sleep)
|
||||||
|
|
||||||
|
assert result is not None
|
||||||
|
assert result.outcome is Outcome.NEW_BOOKING
|
||||||
|
|
||||||
|
|
||||||
|
def test_book_target_classes_repeats_each_class_on_its_own() -> None:
|
||||||
|
gym = FakeGym(
|
||||||
|
cards=[make_card("Thu, Aug 14", card_id="1"), make_card("Tue, Aug 19", card_id="2")],
|
||||||
|
fail_first={"press_class_button": 3},
|
||||||
|
)
|
||||||
|
|
||||||
|
results = book_target_classes(gym, sleep=no_sleep)
|
||||||
|
|
||||||
|
assert [result.outcome for result in results] == [Outcome.NEW_BOOKING] * 2
|
||||||
|
assert gym.pressed == ["1", "1", "1", "1", "2"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_my_bookings_with_retry_opens_the_page_again_after_a_failure() -> None:
|
||||||
|
entries = [make_entry("Wed, Aug 13, 7:00 AM")]
|
||||||
|
gym = FakeGym(bookings=entries, fail_first={"open_my_bookings": 1, "list_my_bookings": 1})
|
||||||
|
|
||||||
|
assert get_my_bookings_with_retry(gym, sleep=no_sleep) == entries
|
||||||
|
assert gym.calls == [
|
||||||
|
"open_my_bookings",
|
||||||
|
"open_my_bookings",
|
||||||
|
"list_my_bookings",
|
||||||
|
"open_my_bookings",
|
||||||
|
"list_my_bookings",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_my_bookings_with_retry_gives_up_after_the_set_attempts() -> None:
|
||||||
|
gym = FakeGym(bookings_error="Failed to load bookings")
|
||||||
|
|
||||||
|
with pytest.raises(RetriesExhaustedError, match="Failed to load bookings"):
|
||||||
|
get_my_bookings_with_retry(gym, retries=2, sleep=no_sleep)
|
||||||
|
|
||||||
|
|
||||||
|
def test_verify_bookings_reads_the_page_through_retry() -> None:
|
||||||
|
card = make_card("Tue, Aug 12")
|
||||||
|
gym = FakeGym(cards=[card], fail_first={"list_my_bookings": 2})
|
||||||
|
results = [ClassResult(card, Outcome.NEW_BOOKING)]
|
||||||
|
|
||||||
|
verification = verify_bookings(gym, results, sleep=no_sleep)
|
||||||
|
|
||||||
|
assert verification.is_success
|
||||||
|
|
||||||
|
|
||||||
|
def test_main_completes_a_run_with_dropped_requests_and_draws_them_in_step_9(
|
||||||
|
credentials_env: None, tmp_path: Path, caplog: pytest.LogCaptureFixture
|
||||||
|
) -> None:
|
||||||
|
gym = FakeGym(
|
||||||
|
cards=[make_card("Thu, Aug 14", card_id="1"), make_card("Tue, Aug 19", card_id="2")],
|
||||||
|
fail_first={"log_in": 1, "press_class_button": 2, "list_my_bookings": 1},
|
||||||
|
)
|
||||||
|
|
||||||
|
with caplog.at_level(logging.INFO):
|
||||||
|
code = main(["--screenshot-dir", str(tmp_path)], lambda *_: gym, no_sleep)
|
||||||
|
|
||||||
|
assert code == 0
|
||||||
|
step_9, step_9_path = gym.text_screenshots[-1]
|
||||||
|
assert step_9_path == tmp_path / "step-9.png"
|
||||||
|
assert "⚠ Attempt 1/7 failed: login" in step_9
|
||||||
|
assert "succeeded after 2 attempts" in step_9
|
||||||
|
assert step_9.endswith("✅ SUCCESS: All bookings verified!")
|
||||||
|
|
||||||
|
|
||||||
|
def test_main_returns_1_when_every_retry_failed(
|
||||||
|
credentials_env: None, caplog: pytest.LogCaptureFixture
|
||||||
|
) -> None:
|
||||||
|
gym = FakeGym(fail_first={"log_in": 5})
|
||||||
|
|
||||||
|
with caplog.at_level(logging.INFO):
|
||||||
|
code = main(["--retries", "2"], lambda *_: gym, no_sleep)
|
||||||
|
|
||||||
|
assert code == 1
|
||||||
|
assert len(gym.logins) == 2
|
||||||
|
assert "Failed: login failed after 2 attempts" in caplog.text
|
||||||
|
|
||||||
|
|
||||||
|
def test_main_uses_one_attempt_when_asked() -> None:
|
||||||
|
assert parse_args(["--retries", "1"]).retries == 1
|
||||||
|
|
||||||
|
|
||||||
|
def test_retries_option_defaults_to_the_constant() -> None:
|
||||||
|
assert parse_args([]).retries == constants.RETRY_COUNT
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("value", ["0", "-3", "many", "1.5"])
|
||||||
|
def test_retries_option_rejects_less_than_one(value: str) -> None:
|
||||||
|
with pytest.raises(SystemExit):
|
||||||
|
parse_args(["--retries", value])
|
||||||
|
|
||||||
|
|
||||||
|
def test_help_epilog_mentions_retries(capsys: pytest.CaptureFixture[str]) -> None:
|
||||||
|
with pytest.raises(SystemExit):
|
||||||
|
parse_args(["--help"])
|
||||||
|
|
||||||
|
out = capsys.readouterr().out
|
||||||
|
assert "--retries N" in out
|
||||||
|
assert "every retry failed" in out
|
||||||
|
|
||||||
|
|
||||||
|
## Chance that a request fails in the chaos test: the site's maximum (50%).
|
||||||
|
CHAOS_FAILURE_PROBABILITY = 0.5
|
||||||
|
|
||||||
|
## Chaos runs, and how many must complete. With 7 attempts an operation fails for good with
|
||||||
|
## probability 0.5**7 (about 0.8%). A run has four such operations (login, two clicks, the
|
||||||
|
## bookings read), so about 3% of runs fail and about 97 of 100 complete; 90 leaves room for
|
||||||
|
## the spread of the seeds without hiding a real defect. The seeds are fixed, so it is stable.
|
||||||
|
CHAOS_RUNS = 100
|
||||||
|
CHAOS_MIN_COMPLETED = 90
|
||||||
|
|
||||||
|
## Seeds that were checked to complete fully (seed 18 is the first that runs out of attempts);
|
||||||
|
## a change that breaks one of them is a defect.
|
||||||
|
CHAOS_SEEDS_THAT_MUST_PASS = tuple(range(18))
|
||||||
|
|
||||||
|
|
||||||
|
def _run_chaos(seed: int) -> tuple[int, ChaosGym]:
|
||||||
|
gym = ChaosGym(
|
||||||
|
random.Random(seed),
|
||||||
|
CHAOS_FAILURE_PROBABILITY,
|
||||||
|
cards=[make_card("Thu, Aug 14", card_id="1"), make_card("Tue, Aug 19", card_id="2")],
|
||||||
|
)
|
||||||
|
return main(["--retries", "7"], lambda *_: gym, no_sleep), gym
|
||||||
|
|
||||||
|
|
||||||
|
def _is_consistent(gym: ChaosGym) -> bool:
|
||||||
|
"""@brief True when every target class is booked on the page after the run."""
|
||||||
|
return all(card.state is ButtonState.BOOKED for card in gym.cards)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.usefixtures("credentials_env")
|
||||||
|
def test_chaos_runs_with_half_of_the_requests_failing_mostly_complete() -> None:
|
||||||
|
completed = 0
|
||||||
|
for seed in range(CHAOS_RUNS):
|
||||||
|
code, gym = _run_chaos(seed)
|
||||||
|
assert code in (0, 1), f"seed {seed}: a verified run never ends in a mismatch"
|
||||||
|
if code == 0:
|
||||||
|
assert _is_consistent(gym), f"seed {seed}: verified but not booked"
|
||||||
|
completed += 1
|
||||||
|
|
||||||
|
assert completed >= CHAOS_MIN_COMPLETED
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.usefixtures("credentials_env")
|
||||||
|
@pytest.mark.parametrize("seed", CHAOS_SEEDS_THAT_MUST_PASS)
|
||||||
|
def test_chaos_seed_completes_with_a_consistent_verified_result(seed: int) -> None:
|
||||||
|
code, gym = _run_chaos(seed)
|
||||||
|
|
||||||
|
assert code == 0
|
||||||
|
assert _is_consistent(gym)
|
||||||
|
|
||||||
|
|
||||||
|
def test_retry_error_is_a_gym_error_for_the_exit_code() -> None:
|
||||||
|
assert issubclass(RetriesExhaustedError, GymError)
|
||||||
@@ -0,0 +1,167 @@
|
|||||||
|
"""@file test_retry.py
|
||||||
|
@brief The retry wrapper: success, repeats, exhaustion, what it logs and what it never retries.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from snack_and_lift import constants
|
||||||
|
from snack_and_lift.application.retry import retry
|
||||||
|
from snack_and_lift.domain.errors import (
|
||||||
|
GymError,
|
||||||
|
LoginFailedError,
|
||||||
|
MissingCredentialsError,
|
||||||
|
PageFormatError,
|
||||||
|
RetriesExhaustedError,
|
||||||
|
UnknownButtonError,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class Flaky:
|
||||||
|
"""@brief A step that raises the given errors in turn and then returns a value."""
|
||||||
|
|
||||||
|
def __init__(self, errors: list[Exception], value: str = "done") -> None:
|
||||||
|
self._errors = list(errors)
|
||||||
|
self._value = value
|
||||||
|
self.calls = 0
|
||||||
|
|
||||||
|
def __call__(self) -> str:
|
||||||
|
self.calls += 1
|
||||||
|
if self._errors:
|
||||||
|
raise self._errors.pop(0)
|
||||||
|
return self._value
|
||||||
|
|
||||||
|
|
||||||
|
def test_retry_returns_the_result_on_the_first_attempt() -> None:
|
||||||
|
step = Flaky([])
|
||||||
|
sleeps: list[float] = []
|
||||||
|
|
||||||
|
assert retry(step, sleep=sleeps.append) == "done"
|
||||||
|
assert step.calls == 1
|
||||||
|
assert sleeps == []
|
||||||
|
|
||||||
|
|
||||||
|
def test_retry_succeeds_after_some_failures(caplog: pytest.LogCaptureFixture) -> None:
|
||||||
|
step = Flaky([GymError("a"), GymError("b")])
|
||||||
|
|
||||||
|
with caplog.at_level(logging.INFO):
|
||||||
|
result = retry(step, 7, "login", sleep=lambda _: None)
|
||||||
|
|
||||||
|
assert result == "done"
|
||||||
|
assert step.calls == 3
|
||||||
|
assert "✓ login succeeded after 3 attempts" in caplog.text
|
||||||
|
|
||||||
|
|
||||||
|
def test_retry_does_not_log_success_after_a_single_attempt(
|
||||||
|
caplog: pytest.LogCaptureFixture,
|
||||||
|
) -> None:
|
||||||
|
with caplog.at_level(logging.INFO):
|
||||||
|
retry(Flaky([]), 7, "login", sleep=lambda _: None)
|
||||||
|
|
||||||
|
assert "succeeded" not in caplog.text
|
||||||
|
|
||||||
|
|
||||||
|
def test_retry_raises_after_the_last_attempt_with_the_last_error_as_cause() -> None:
|
||||||
|
last = GymError("third")
|
||||||
|
step = Flaky([GymError("first"), GymError("second"), last])
|
||||||
|
|
||||||
|
with pytest.raises(RetriesExhaustedError, match="login failed after 3 attempts") as caught:
|
||||||
|
retry(step, 3, "login", sleep=lambda _: None)
|
||||||
|
|
||||||
|
assert caught.value.__cause__ is last
|
||||||
|
assert "third" in str(caught.value)
|
||||||
|
assert step.calls == 3
|
||||||
|
|
||||||
|
|
||||||
|
def test_retries_exhausted_is_a_gym_error() -> None:
|
||||||
|
with pytest.raises(GymError):
|
||||||
|
retry(Flaky([GymError("x")]), 1, sleep=lambda _: None)
|
||||||
|
|
||||||
|
|
||||||
|
def test_retry_with_one_attempt_does_not_repeat_or_sleep() -> None:
|
||||||
|
step = Flaky([GymError("x"), GymError("y")])
|
||||||
|
sleeps: list[float] = []
|
||||||
|
|
||||||
|
with pytest.raises(RetriesExhaustedError):
|
||||||
|
retry(step, 1, sleep=sleeps.append)
|
||||||
|
|
||||||
|
assert step.calls == 1
|
||||||
|
assert sleeps == []
|
||||||
|
|
||||||
|
|
||||||
|
def test_retry_with_one_attempt_returns_on_success() -> None:
|
||||||
|
assert retry(Flaky([]), 1, sleep=lambda _: None) == "done"
|
||||||
|
|
||||||
|
|
||||||
|
def test_retry_waits_the_delay_between_attempts_but_not_after_the_last() -> None:
|
||||||
|
sleeps: list[float] = []
|
||||||
|
|
||||||
|
with pytest.raises(RetriesExhaustedError):
|
||||||
|
retry(Flaky([GymError("x")] * 4), 4, delay=1.5, sleep=sleeps.append)
|
||||||
|
|
||||||
|
assert sleeps == [1.5, 1.5, 1.5]
|
||||||
|
|
||||||
|
|
||||||
|
def test_retry_uses_the_default_delay_and_attempts() -> None:
|
||||||
|
sleeps: list[float] = []
|
||||||
|
step = Flaky([GymError("x")] * constants.RETRY_COUNT)
|
||||||
|
|
||||||
|
with pytest.raises(RetriesExhaustedError):
|
||||||
|
retry(step, sleep=sleeps.append)
|
||||||
|
|
||||||
|
assert step.calls == constants.RETRY_COUNT
|
||||||
|
assert sleeps == [constants.RETRY_DELAY_SECONDS] * (constants.RETRY_COUNT - 1)
|
||||||
|
|
||||||
|
|
||||||
|
def test_retry_logs_a_warning_with_attempt_description_and_error(
|
||||||
|
caplog: pytest.LogCaptureFixture,
|
||||||
|
) -> None:
|
||||||
|
step = Flaky([GymError("Network request failed. Please try again.")])
|
||||||
|
|
||||||
|
with caplog.at_level(logging.WARNING):
|
||||||
|
retry(step, 7, "login", sleep=lambda _: None)
|
||||||
|
|
||||||
|
assert (
|
||||||
|
"⚠ Attempt 1/7 failed: login: Network request failed. Please try again. Retrying..."
|
||||||
|
in caplog.text
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_retry_names_a_step_without_description(caplog: pytest.LogCaptureFixture) -> None:
|
||||||
|
with caplog.at_level(logging.WARNING):
|
||||||
|
retry(Flaky([GymError("x")]), sleep=lambda _: None)
|
||||||
|
|
||||||
|
assert f"failed: {constants.RETRY_DEFAULT_DESCRIPTION}: x" in caplog.text
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"error",
|
||||||
|
[LoginFailedError("no"), UnknownButtonError("busy"), PageFormatError("format")],
|
||||||
|
)
|
||||||
|
def test_retry_repeats_every_kind_of_gym_error(error: GymError) -> None:
|
||||||
|
step = Flaky([error])
|
||||||
|
|
||||||
|
assert retry(step, 2, sleep=lambda _: None) == "done"
|
||||||
|
assert step.calls == 2
|
||||||
|
|
||||||
|
|
||||||
|
def test_retry_lets_other_errors_pass_untouched() -> None:
|
||||||
|
error = MissingCredentialsError("missing")
|
||||||
|
step = Flaky([error])
|
||||||
|
|
||||||
|
with pytest.raises(MissingCredentialsError) as caught:
|
||||||
|
retry(step, 7, sleep=lambda _: None)
|
||||||
|
|
||||||
|
assert caught.value is error
|
||||||
|
assert step.calls == 1
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("retries", [0, -1])
|
||||||
|
def test_retry_rejects_fewer_than_one_attempt(retries: int) -> None:
|
||||||
|
step = Flaky([])
|
||||||
|
|
||||||
|
with pytest.raises(ValueError, match="at least 1"):
|
||||||
|
retry(step, retries)
|
||||||
|
|
||||||
|
assert step.calls == 0
|
||||||
Reference in New Issue
Block a user