Compare commits

...
Author SHA1 Message Date
Tirsvad aa129cb5d3 Resolve pending commit links 2026-10-28 16:33:56 +08:00
Tirsvad 68c439137f Implement bot core: open game, select language, click cookie, read count
Domain number parser, GamePort, the four lecture step functions, the
Selenium adapter and offline tests (fake game, fake driver). Reviewed in
RC-011.

Task: MIL-002#1
Task: MIL-002#2
Task: MIL-002#3
Task: MIL-002#4
Task: MIL-002#5
Closes #8
Closes #9
Closes #10
Closes #11
Closes #12
2026-10-28 16:33:33 +08:00
Tirsvad 853aacf999 Merge pull request 'MIL-001: Project setup and tooling' (#29) from mil-001-project-setup into main
TirSystem/git-workflows: Sync GitHub mirror metadata / sync-metadata (push) Successful in 12s
2026-10-28 09:29:49 +01:00
Tirsvad 1a67f10266 Resolve pending commit links 2026-10-28 16:29:09 +08:00
Tirsvad ad3334fa13 Set up project tooling, skeleton, ADR-0001 and repository metadata
pyproject.toml (Python 3.13+, selenium only runtime dependency), layered
src/ and tests/ skeleton with constants.py, Python .gitignore (ignores
.env), Doxyfile, ADR-0001, git hooks with the plan gate. Repository
description and topics were set through the host API.

Task: MIL-001#1
Task: MIL-001#2
Task: MIL-001#3
Task: MIL-001#4
Task: MIL-001#5
Task: MIL-001#6
Closes #2
Closes #3
Closes #4
Closes #5
Closes #6
Closes #7
2026-10-28 16:29:05 +08:00
Tirsvad 179459d70a Merge pull request 'Baseline: Business Case, Stakeholder Analysis, Project Plan and milestones' (#1) from baseline-plan-and-reviews into main
TirSystem/git-workflows: Sync GitHub mirror metadata / sync-metadata (push) Successful in 8s
2026-10-28 09:23:52 +01:00
33 changed files with 1521 additions and 73 deletions
+11
View File
@@ -0,0 +1,11 @@
root = true
[*]
end_of_line = lf
insert_final_newline = true
charset = utf-8
indent_style = space
indent_size = 4
[*.{yml,yaml,md}]
indent_size = 2
+1
View File
@@ -0,0 +1 @@
* text=auto eol=lf
+230
View File
@@ -0,0 +1,230 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[codz]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py.cover
*.lcov
.hypothesis/
.pytest_cache/
cover/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
.pybuilder/
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
# Pipfile.lock
# uv
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# uv.lock
# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
# poetry.lock
# poetry.toml
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
# pdm.lock
# pdm.toml
.pdm-python
.pdm-build/
# pixi
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
# pixi.lock
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
# in the .venv directory. It is recommended not to include this directory in version control.
.pixi/*
!.pixi/config.toml
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/
# Celery stuff
celerybeat-schedule*
celerybeat.pid
# Redis
*.rdb
*.aof
*.pid
# RabbitMQ
mnesia/
rabbitmq/
rabbitmq-data/
# ActiveMQ
activemq-data/
# SageMath parsed files
*.sage.py
# Environments
.env
.envrc
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs/Zensical documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/
# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
# .idea/
# Abstra
# Abstra is an AI-powered process automation framework.
# Ignore directories containing user credentials, local state, and settings.
# Learn more at https://abstra.io/docs
.abstra/
# Visual Studio Code
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
# can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
# and can be added to the global gitignore or merged into this file. However, if you prefer, you
# could uncomment the following to ignore the entire vscode folder
# .vscode/
# Temporary file for partial code execution
tempCodeRunnerFile.py
# Ruff stuff:
.ruff_cache/
# PyPI configuration file
.pypirc
# Marimo
marimo/_static/
marimo/_lsp/
__marimo__/
# Streamlit
.streamlit/secrets.toml
# Project specific
# Local secrets, personal use only (never imported by the project)
.env
# Generated API documentation (doxygen Doxyfile)
/docs/api/
# Scratch output of local and Docker runs; published screenshots live in docs/images/
/runs/
# AI prompt log: this repository is public
/docs/ai-prompts/
+374
View File
@@ -0,0 +1,374 @@
# Doxyfile 1.15.0
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "Cookie Clicker Bot"
PROJECT_NUMBER =
PROJECT_BRIEF = "Selenium bot for Cookie Clicker (Udemy 100 Days of Code, day 48)"
PROJECT_LOGO =
PROJECT_ICON =
OUTPUT_DIRECTORY = docs/api
CREATE_SUBDIRS = NO
CREATE_SUBDIRS_LEVEL = 8
ALLOW_UNICODE_NAMES = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
JAVADOC_BANNER = NO
QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
PYTHON_DOCSTRING = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 4
ALIASES =
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = YES
OPTIMIZE_FOR_FORTRAN = NO
OPTIMIZE_OUTPUT_VHDL = NO
OPTIMIZE_OUTPUT_SLICE = NO
EXTENSION_MAPPING =
MARKDOWN_SUPPORT = YES
MARKDOWN_STRICT = YES
TOC_INCLUDE_HEADINGS = 6
MARKDOWN_ID_STYLE = DOXYGEN
AUTOLINK_SUPPORT = YES
AUTOLINK_IGNORE_WORDS =
BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
SIP_SUPPORT = NO
IDL_PROPERTY_SUPPORT = YES
DISTRIBUTE_GROUP_DOC = NO
GROUP_NESTED_COMPOUNDS = NO
SUBGROUPING = YES
INLINE_GROUPED_CLASSES = NO
INLINE_SIMPLE_STRUCTS = NO
TYPEDEF_HIDES_STRUCT = NO
LOOKUP_CACHE_SIZE = 0
NUM_PROC_THREADS = 1
TIMESTAMP = NO
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = YES
EXTRACT_PRIVATE = NO
EXTRACT_PRIV_VIRTUAL = NO
EXTRACT_PACKAGE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
RESOLVE_UNNAMED_PARAMS = YES
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
HIDE_UNDOC_NAMESPACES = YES
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = SYSTEM
HIDE_SCOPE_NAMES = NO
HIDE_COMPOUND_REFERENCE= NO
SHOW_HEADERFILE = YES
SHOW_INCLUDE_FILES = YES
SHOW_GROUPED_MEMB_INC = NO
FORCE_LOCAL_INCLUDES = NO
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
SORT_MEMBERS_CTORS_1ST = NO
SORT_GROUP_NAMES = NO
SORT_BY_SCOPE_NAME = NO
STRICT_PROTO_MATCHING = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
SHOW_FILES = YES
SHOW_NAMESPACES = YES
FILE_VERSION_FILTER =
LAYOUT_FILE =
CITE_BIB_FILES =
EXTERNAL_TOOL_PATH =
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = YES
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_IF_INCOMPLETE_DOC = YES
WARN_NO_PARAMDOC = NO
WARN_IF_UNDOC_ENUM_VAL = NO
WARN_LAYOUT_FILE = YES
WARN_AS_ERROR = NO
WARN_FORMAT = "$file:$line: $text"
WARN_LINE_FORMAT = "at line $line of file $file"
WARN_LOGFILE =
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = src README.md
INPUT_ENCODING = UTF-8
INPUT_FILE_ENCODING =
FILE_PATTERNS = *.py
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
FILTER_SOURCE_PATTERNS =
USE_MDFILE_AS_MAINPAGE = README.md
IMPLICIT_DIR_DOCS = YES
FORTRAN_COMMENT_AFTER = 72
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = NO
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = NO
REFERENCES_RELATION = NO
REFERENCES_LINK_SOURCE = YES
SOURCE_TOOLTIPS = YES
USE_HTAGS = NO
VERBATIM_HEADERS = YES
CLANG_ASSISTED_PARSING = NO
CLANG_ADD_INC_PATHS = YES
CLANG_OPTIONS =
CLANG_DATABASE_PATH =
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_EXTRA_STYLESHEET =
HTML_EXTRA_FILES =
HTML_COLORSTYLE = AUTO_LIGHT
HTML_COLORSTYLE_HUE = 220
HTML_COLORSTYLE_SAT = 100
HTML_COLORSTYLE_GAMMA = 80
HTML_DYNAMIC_MENUS = YES
HTML_DYNAMIC_SECTIONS = NO
HTML_CODE_FOLDING = YES
HTML_COPY_CLIPBOARD = YES
HTML_PROJECT_COOKIE =
HTML_INDEX_NUM_ENTRIES = 100
GENERATE_DOCSET = NO
DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_FEEDURL =
DOCSET_BUNDLE_ID = org.doxygen.Project
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
DOCSET_PUBLISHER_NAME = Publisher
GENERATE_HTMLHELP = NO
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
CHM_INDEX_ENCODING =
BINARY_TOC = NO
TOC_EXPAND = NO
SITEMAP_URL =
GENERATE_QHP = NO
QCH_FILE =
QHP_NAMESPACE = org.doxygen.Project
QHP_VIRTUAL_FOLDER = doc
QHP_CUST_FILTER_NAME =
QHP_CUST_FILTER_ATTRS =
QHP_SECT_FILTER_ATTRS =
QHG_LOCATION =
GENERATE_ECLIPSEHELP = NO
ECLIPSE_DOC_ID = org.doxygen.Project
DISABLE_INDEX = NO
GENERATE_TREEVIEW = YES
PAGE_OUTLINE_PANEL = YES
FULL_SIDEBAR = NO
ENUM_VALUES_PER_LINE = 4
SHOW_ENUM_VALUES = NO
TREEVIEW_WIDTH = 250
EXT_LINKS_IN_WINDOW = NO
OBFUSCATE_EMAILS = YES
HTML_FORMULA_FORMAT = png
FORMULA_FONTSIZE = 10
FORMULA_MACROFILE =
USE_MATHJAX = NO
MATHJAX_VERSION = MathJax_2
MATHJAX_FORMAT = HTML-CSS
MATHJAX_RELPATH =
MATHJAX_EXTENSIONS =
MATHJAX_CODEFILE =
SEARCHENGINE = YES
SERVER_BASED_SEARCH = NO
EXTERNAL_SEARCH = NO
SEARCHENGINE_URL =
SEARCHDATA_FILE = searchdata.xml
EXTERNAL_SEARCH_ID =
EXTRA_SEARCH_MAPPINGS =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
LATEX_OUTPUT = latex
LATEX_CMD_NAME =
MAKEINDEX_CMD_NAME = makeindex
LATEX_MAKEINDEX_CMD = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4
EXTRA_PACKAGES =
LATEX_HEADER =
LATEX_FOOTER =
LATEX_EXTRA_STYLESHEET =
LATEX_EXTRA_FILES =
PDF_HYPERLINKS = YES
USE_PDFLATEX = YES
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
LATEX_BIB_STYLE = plainnat
LATEX_EMOJI_DIRECTORY =
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
RTF_EXTRA_FILES =
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_SUBDIR =
MAN_LINKS = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = NO
XML_OUTPUT = xml
XML_PROGRAMLISTING = YES
XML_NS_MEMB_FILE_SCOPE = NO
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
GENERATE_DOCBOOK = NO
DOCBOOK_OUTPUT = docbook
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# Configuration options related to Sqlite3 output
#---------------------------------------------------------------------------
GENERATE_SQLITE3 = NO
SQLITE3_OUTPUT = sqlite3
SQLITE3_RECREATE_DB = YES
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration options related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
EXTERNAL_PAGES = YES
#---------------------------------------------------------------------------
# Configuration options related to diagram generator tools
#---------------------------------------------------------------------------
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = NO
DOT_NUM_THREADS = 0
DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
DOT_FONTPATH =
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = NO
UML_LIMIT_NUM_FIELDS = 10
UML_MAX_EDGE_LABELS = 10
DOT_UML_DETAILS = NO
DOT_WRAP_THRESHOLD = 17
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DIR_GRAPH_MAX_DEPTH = 1
DOT_IMAGE_FORMAT = png
INTERACTIVE_SVG = NO
DOT_PATH =
DOTFILE_DIRS =
DIA_PATH =
DIAFILE_DIRS =
PLANTUML_JAR_PATH =
PLANTUML_CFG_FILE =
PLANTUML_INCLUDE_PATH =
PLANTUMLFILE_DIRS =
DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 0
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
MSCGEN_TOOL =
MSCFILE_DIRS =
@@ -0,0 +1,56 @@
# Selenium as the single runtime dependency
## Metadata
| Key | Value |
| --- | --- |
| ID | ADR-0001 |
| CrossReference | [BC-001], [SA-001] |
## Version History
| Date | Status | Author | Reviewer | Change | Commit |
| --- | --- | --- | --- | --- | --- |
| 2026-10-28 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version (reviewed in RC-009) | [ad3334f] |
Allowed Status values: `Proposed`, `Accepted`, `Rejected`, `Deprecated`, `Superseded by ADR-NNNN`.
---
## Context
The assignment is to automate the Cookie Clicker game in a real browser with Selenium ([BC-001], objective O1). GitHub viewers (S03) asked for no runtime dependencies (concern CN-006 in [SA-001]), and the Business Case constraint says to avoid runtime dependencies unless needed. The bot must read the page and click elements, so something has to drive a browser.
Options evaluated:
1. **Selenium** as the one runtime dependency. It is what the assignment and the course use, and Selenium Manager downloads a matching driver.
2. **No dependency**, driving Chrome through the DevTools protocol with the standard library only. This needs a hand-written WebSocket client and protocol code, which is long, fragile and unreadable for S02.
3. **Playwright**. A comparable dependency, but not the library of the assignment, so S02 could not compare solutions.
4. **Selenium plus a threading helper** (the author's earlier solution used `continuous_threading`). A second dependency for something the standard library `threading` or a single loop already does.
## Decision
Selenium is the only runtime dependency; pytest, ruff and mypy are development dependencies, and everything else uses the standard library.
## Consequences
**Positive:**
- The code matches the assignment, so S02 can compare solutions directly.
- Only one package is installed to run the bot (`pip install .`).
- The decision logic is behind a port, so tests need neither Selenium nor a browser.
**Negative:**
- S03's wish for no dependencies is met only in part; the README states why Selenium is needed.
- Running the bot needs Chrome installed (Selenium Manager fetches the driver); the Docker image covers this for the screenshots.
- Performance Efficiency: Selenium calls cost milliseconds each, which limits the clicks per second.
## Affected Artifacts
- [BC-001] — fixes the runtime dependency list for success criterion 4.
- [SA-001] — records the mitigation of the conflict between CN-006 and the assignment.
---
[BC-001]: ../business-case.md
[SA-001]: ../stakeholder-analysis.md
[ad3334f]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/048-the-coockie-factory/commit/ad3334fa13c4261c3d034fbffcc7b43fe95fbb31
+2 -2
View File
@@ -15,9 +15,9 @@ document of a type. `Primary File` may contain a glob (e.g.
| SA | Stakeholder Analysis | docs/stakeholder-analysis.md | 002 |
| PP | Project Plan | docs/project-plan.md | 002 |
| MIL | Milestone / Gateway | docs/milestones/mil-*.md | 006 |
| ADR | Architecture Decision Record | docs/adr/adr-*.md | 0001 |
| ADR | Architecture Decision Record | docs/adr/adr-*.md | 0002 |
| TM | Traceability Matrix | docs/sqa/traceability-matrix.md | 002 |
| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 009 |
| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 012 |
## Languages
@@ -0,0 +1,55 @@
# SQA Review Record
## Metadata
| Key | Value |
| --- | --- |
| ID | RC-009 |
| CrossReference | [ADR-0001], [QC-ADR-001] |
## Version History
| Date | Status | Author | Reviewer | Change | Commit |
| --- | --- | --- | --- | --- | --- |
| 2026-10-28 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [ad3334f] |
---
## Artifact Under Review
- Instance reviewed: ADR-0001 ([ADR-0001])
- Checklist used: [QC-ADR-001]
- Scope: full review
- Language and domain: n/a (technical type)
- Language reviewer: none
- Mode: autonomous, not independent (the reviewer is `AI as stand-in for S01`)
## Checklist Results
| # | Criterion | Status | Evidence/Notes |
| --- | --- | --- | --- |
| 1 | The ID (`ADR-NNNN`, 4-digit) matches the filename number and is unique and sequential | Pass | ID ADR-0001 matches the file name adr-0001 and is the first. |
| 2 | Context states the problem, the forces (cost, risk, constraints) and the options evaluated | Pass | Context names the forces (S03 concern, constraint) and four options. |
| 3 | At least two options were considered, or the absence of alternatives is justified | Pass | Four options evaluated. |
| 4 | Decision is stated in one or two unhedged sentences and matches one of the evaluated options | Pass | One sentence, matches option 1. |
| 5 | Consequences list both Positive and Negative outcomes | Pass | Positive and Negative lists present. |
| 6 | Quality-attribute impacts (performance, security, portability, etc.) are named where the decision affects them | Pass | Performance Efficiency cost of Selenium calls named. |
| 7 | Affected Artifacts are listed as links, and each is also in CrossReference | Pass | BC-001 and SA-001 are linked and in CrossReference. |
| 8 | Status changes are recorded as new Version History rows with a Change summary and Commit link; retained rows are never rewritten | Pass | Single row with Change and Commit columns. |
| 9 | A superseded or deprecated ADR names its successor, and the successor links back | N-A | Not superseded. |
| 10 | Written in business or technical language of the domain, with no unexplained abbreviations | Pass | Abbreviation Selenium is a product name; others spelled out. |
| 11 | Status is one of `Proposed`, `Accepted`, `Rejected`, `Deprecated` or `Superseded by ADR-NNNN`, and every Version History row uses only these | Pass | Status Accepted. |
## Overall Verdict
Go - All Mandatory criteria pass. Stand-in review, not independent.
## Action Items
| Action | Owner | Due |
| --- | --- | --- |
| None | S01 | - |
---
[ADR-0001]: ../../adr/adr-0001-selenium-runtime-dependency.md
[QC-ADR-001]: ../../../framework/qc/artifacts/qc-adr.md
[ad3334f]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/048-the-coockie-factory/commit/ad3334fa13c4261c3d034fbffcc7b43fe95fbb31
+62
View File
@@ -0,0 +1,62 @@
# SQA Review Record
## Metadata
| Key | Value |
| --- | --- |
| ID | RC-010 |
| CrossReference | [MIL-001], [QC-PY-001] |
## Version History
| Date | Status | Author | Reviewer | Change | Commit |
| --- | --- | --- | --- | --- | --- |
| 2026-10-28 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [ad3334f] |
---
## Artifact Under Review
- Instance reviewed: source of milestone MIL-001 (src/cookie_clicker_bot, tests/, pyproject.toml) ([MIL-001])
- Checklist used: [QC-PY-001]
- Scope: full review
- Language and domain: n/a (technical type)
- Language reviewer: none
- Mode: autonomous, not independent (the reviewer is `AI as stand-in for S01`)
## Checklist Results
| # | Criterion | Status | Evidence/Notes |
| --- | --- | --- | --- |
| 1 | Packages, modules, functions, variables, classes and constants follow PEP 8 casing (`snake_case`, `PascalCase`, `UPPER_SNAKE`) | Pass | snake_case modules, UPPER_SNAKE constants. |
| 2 | Names state purpose in the domain's language; no unexplained abbreviations, no single-letter names outside tiny scopes | Pass | Names state purpose (RUN_DURATION_SECONDS). |
| 3 | Code is produced by the project's formatter and passes its linter with no unexplained suppressions | Pass | `ruff check src tests` reports no findings; ruff configured in pyproject.toml. |
| 4 | Every function and method signature is type-annotated, including `-> None` | Pass | Test functions annotated with -> None; constants annotated. |
| 5 | No bare `except:`, no swallowed exceptions; specific exceptions are raised and the cause is kept (`raise ... from`) | N-A | No exception handling in this milestone. |
| 6 | No mutable default arguments and no shadowed builtins | Pass | None present. |
| 7 | Files, locks and connections are managed with context managers | N-A | No files or connections yet. |
| 8 | Public modules, classes and functions have docstrings that say what, not how | Pass | Module docstrings use Doxygen @file/@brief. |
| 9 | Logging uses `logging`, not `print`; no secrets or personal data in log output | N-A | No logging yet. |
| 10 | Classes and operations trace to the Design Class Diagram they implement; deviations are recorded | N-A | Plain technical task; no Design Class Diagram exists or is required. |
| 11 | Tests exist for new behaviour, are named for the behaviour, and do not depend on order or the network | Pass | tests/unit/test_constants.py runs offline; `pytest` passes 2 tests. |
| 12 | Type checker runs in strict mode without errors; `Any` is justified in a comment | Pass | mypy strict configured; no Any. |
| 13 | Dependencies are declared and pinned in the project's dependency file, none unused | Pass | selenium>=4.25 is the only runtime dependency (ADR-0001). |
| 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 | Timing constants defined once in constants.py. |
| 15 | Imports point inward: business-rule modules import no framework, database, UI or delivery-mechanism code, and there are no import cycles | Pass | Layer packages exist; no cross imports yet. |
| 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 | N-A | No classes yet. |
| 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 | domain, application, infrastructure and presentation under src/; unit, integration and e2e under tests/. |
| 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 names English, snake_case, no spaces. |
## Overall Verdict
Go - All Mandatory criteria pass or are not applicable to this skeleton. Stand-in review, not independent.
## Action Items
| Action | Owner | Due |
| --- | --- | --- |
| None | S01 | - |
---
[MIL-001]: ../../milestones/mil-001-project-setup.md
[QC-PY-001]: ../../../framework/qc/code/qc-programming-python.md
[ad3334f]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/048-the-coockie-factory/commit/ad3334fa13c4261c3d034fbffcc7b43fe95fbb31
+62
View File
@@ -0,0 +1,62 @@
# SQA Review Record
## Metadata
| Key | Value |
| --- | --- |
| ID | RC-011 |
| CrossReference | [MIL-002], [QC-PY-001] |
## Version History
| Date | Status | Author | Reviewer | Change | Commit |
| --- | --- | --- | --- | --- | --- |
| 2026-10-28 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [68c4391] |
---
## Artifact Under Review
- Instance reviewed: source of milestone MIL-002 (open_game, select_language, click_cookie, get_cookie_count, parser, Selenium adapter) ([MIL-002])
- Checklist used: [QC-PY-001]
- Scope: full review
- Language and domain: n/a (technical type)
- Language reviewer: none
- Mode: autonomous, not independent (the reviewer is `AI as stand-in for S01`)
## Checklist Results
| # | Criterion | Status | Evidence/Notes |
| --- | --- | --- | --- |
| 1 | Packages, modules, functions, variables, classes and constants follow PEP 8 casing (`snake_case`, `PascalCase`, `UPPER_SNAKE`) | Pass | snake_case modules and functions, PascalCase classes, UPPER_SNAKE constants. |
| 2 | Names state purpose in the domain's language; no unexplained abbreviations, no single-letter names outside tiny scopes | Pass | Names state purpose: parse_game_number, wait_for_element, ELEMENT_TIMEOUT_SECONDS. |
| 3 | Code is produced by the project's formatter and passes its linter with no unexplained suppressions | Pass | `ruff check` and `ruff format --check` clean; no suppressions. |
| 4 | Every function and method signature is type-annotated, including `-> None` | Pass | All signatures annotated, including -> None; mypy strict passes. |
| 5 | No bare `except:`, no swallowed exceptions; specific exceptions are raised and the cause is kept (`raise ... from`) | Pass | No bare except; ValueError and UnreadableNumberError are raised with a message. |
| 6 | No mutable default arguments and no shadowed builtins | Pass | No mutable defaults; no builtin shadowed. |
| 7 | Files, locks and connections are managed with context managers | N-A | The browser is released by SeleniumGame.close(); the composition root in MIL-003 calls it in a finally block. |
| 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 | N-A | No logging yet; added with the run loop in MIL-003. |
| 10 | Classes and operations trace to the Design Class Diagram they implement; deviations are recorded | N-A | Plain technical tasks; no Design Class Diagram exists or is required. |
| 11 | Tests exist for new behaviour, are named for the behaviour, and do not depend on order or the network | Pass | 33 tests (unit and integration) run offline with a fake game and a fake driver; positive, negative, boundary and edge cases covered. |
| 12 | Type checker runs in strict mode without errors; `Any` is justified in a comment | Pass | mypy --strict: no issues in 22 files; no Any. |
| 13 | Dependencies are declared and pinned in the project's dependency file, none unused | Pass | selenium is declared and is the only runtime dependency. |
| 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 | URL, ids and number words are defined once in constants.py. |
| 15 | Imports point inward: business-rule modules import no framework, database, UI or delivery-mechanism code, and there are no import cycles | Pass | domain imports only constants; application imports domain and its own port; only infrastructure/selenium_game.py imports selenium; no cycles. |
| 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 | GamePort is a narrow Protocol (4 methods); SeleniumGame receives its driver (dependency inversion); each module has one purpose. |
| 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 | domain, application (ports, use_cases), infrastructure and presentation under src/; unit, integration and e2e under tests/. |
| 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 names English, snake_case, no spaces. |
## Overall Verdict
Go - All Mandatory criteria pass or are not applicable; the live-game behaviour is verified in MIL-004. Stand-in review, not independent.
## Action Items
| Action | Owner | Due |
| --- | --- | --- |
| None | S01 | - |
---
[MIL-002]: ../../milestones/mil-002-bot-core-open-and-click.md
[QC-PY-001]: ../../../framework/qc/code/qc-programming-python.md
[68c4391]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/048-the-coockie-factory/commit/68c439137f13299e20cf6271e392365d9f5371c4
+12 -5
View File
@@ -9,7 +9,8 @@
## Version History
| Date | Status | Author | Reviewer | Change | Commit |
| --- | --- | --- | --- | --- | --- |
| 2026-10-28 | Proposed | Jens Tirsvad Nielsen | <reviewer S-ID> | Initial version | [96a9a78] |
| 2026-10-28 | Proposed | Jens Tirsvad Nielsen | AI as stand-in for S01 | Added ADR-0001, RC-009 and RC-010 | [ad3334f] |
| 2026-10-28 | Proposed | Jens Tirsvad Nielsen | AI as stand-in for S01 | Added RC-011 (MIL-002 source review) | [68c4391] |
---
@@ -26,11 +27,12 @@ updated whenever an artifact instance is created or reviewed.
| [BC-001] | BC | en | it | - | [SA-001], [PP-001] | [RC-001] |
| [SA-001] | SA | en | it | [BC-001] | [PP-001] | [RC-002] |
| [PP-001] | PP | en | it | [BC-001], [SA-001] | [MIL-001], [MIL-002], [MIL-003], [MIL-004], [MIL-005] | [RC-003] |
| [MIL-001] | MIL | en | it | [PP-001] | [MIL-002] | [RC-004] |
| [MIL-002] | MIL | en | it | [MIL-001] | [MIL-003] | [RC-005] |
| [MIL-001] | MIL | en | it | [PP-001] | [MIL-002], [ADR-0001] | [RC-004], [RC-010] |
| [MIL-002] | MIL | en | it | [MIL-001] | [MIL-003] | [RC-005], [RC-011] |
| [MIL-003] | MIL | en | it | [MIL-002] | [MIL-004] | [RC-006] |
| [MIL-004] | MIL | en | it | [MIL-003] | [MIL-005] | [RC-007] |
| [MIL-005] | MIL | en | it | [MIL-004] | - | [RC-008] |
| [ADR-0001] | ADR | - | - | [BC-001], [SA-001], [MIL-001] | - | [RC-009] |
## Concern Coverage
@@ -41,7 +43,7 @@ updated whenever an artifact instance is created or reviewed.
| CN-003 | [MIL-002] | - | - | Covered |
| CN-004 | [MIL-004] | - | - | Covered |
| CN-005 | [MIL-001] | - | - | Covered |
| CN-006 | [MIL-001] | - | - | Covered |
| CN-006 | [MIL-001] | [ADR-0001] | - | Covered |
| CN-007 | [MIL-005] | - | - | Covered |
## Open Inconsistencies
@@ -53,6 +55,7 @@ updated whenever an artifact instance is created or reviewed.
---
[BC-001]: ../business-case.md
[ADR-0001]: ../adr/adr-0001-selenium-runtime-dependency.md
[SA-001]: ../stakeholder-analysis.md
[PP-001]: ../project-plan.md
[MIL-001]: ../milestones/mil-001-project-setup.md
@@ -68,4 +71,8 @@ updated whenever an artifact instance is created or reviewed.
[RC-006]: ./reviews/rc-006-mil-003-upgrades-and-five-minute-run.md
[RC-007]: ./reviews/rc-007-mil-004-screenshots-and-readme.md
[RC-008]: ./reviews/rc-008-mil-005-wiki-and-release.md
[96a9a78]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/048-the-coockie-factory/commit/96a9a78f010ce8ae3fce8d84602317d8b5808a13
[RC-009]: ./reviews/rc-009-adr-0001-selenium-runtime-dependency.md
[RC-010]: ./reviews/rc-010-mil-001-source.md
[ad3334f]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/048-the-coockie-factory/commit/ad3334fa13c4261c3d034fbffcc7b43fe95fbb31
[RC-011]: ./reviews/rc-011-mil-002-source.md
[68c4391]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/048-the-coockie-factory/commit/68c439137f13299e20cf6271e392365d9f5371c4
+55
View File
@@ -0,0 +1,55 @@
[build-system]
requires = ["setuptools>=75"]
build-backend = "setuptools.build_meta"
[project]
name = "cookie-clicker-bot"
version = "0.1.0"
description = "A Selenium bot that plays Cookie Clicker for five minutes and reports its cookies per second (Udemy 100 Days of Code, day 48)."
readme = "README.md"
requires-python = ">=3.13"
license = "AGPL-3.0-or-later"
license-files = ["LICENSE"]
keywords = ["selenium", "cookie-clicker", "automation", "udemy", "100-days-of-code"]
classifiers = [
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.13",
"Intended Audience :: Education",
]
dependencies = [
"selenium>=4.25",
]
[project.optional-dependencies]
dev = [
"pytest>=8",
"ruff>=0.6",
"mypy>=1.11",
]
[project.scripts]
cookie-clicker-bot = "cookie_clicker_bot.presentation.cli:main"
[project.urls]
Repository = "https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/048-the-coockie-factory"
[tool.setuptools.packages.find]
where = ["src"]
[tool.pytest.ini_options]
testpaths = ["tests"]
pythonpath = ["src"]
addopts = "-ra"
[tool.ruff]
line-length = 88
target-version = "py313"
src = ["src", "tests"]
[tool.ruff.lint]
select = ["E", "F", "I", "N", "UP", "B"]
[tool.mypy]
strict = true
python_version = "3.13"
mypy_path = "src"
+3
View File
@@ -0,0 +1,3 @@
"""@file
@brief Cookie Clicker bot: a Selenium player for the Cookie Clicker browser game.
"""
@@ -0,0 +1,3 @@
"""@file
@brief Application layer: the bot's use cases and the ports they need.
"""
@@ -0,0 +1,3 @@
"""@file
@brief Ports: what the application needs from the outside world.
"""
@@ -0,0 +1,34 @@
"""@file
@brief The port through which the bot sees and operates the game.
"""
from typing import Protocol
class GamePort(Protocol):
"""@brief A running game page. The Selenium adapter implements it."""
def open_page(self, url: str) -> None:
"""@brief Load the page at the address.
@param url The address of the game.
"""
...
def wait_for_element(self, element_id: str) -> None:
"""@brief Block until the element is on the page.
@param element_id The HTML id of the element.
"""
...
def click_element(self, element_id: str) -> None:
"""@brief Click the element the way a user does.
@param element_id The HTML id of the element.
"""
...
def read_text(self, element_id: str) -> str:
"""@brief Return the visible text of the element.
@param element_id The HTML id of the element.
@return The text as shown on the page.
"""
...
@@ -0,0 +1,3 @@
"""@file
@brief Use cases of the bot, one function per lecture step.
"""
@@ -0,0 +1,51 @@
"""@file
@brief Lecture steps 1 to 3: open the game, click the cookie, read the count.
"""
from cookie_clicker_bot.application.ports.game_port import GamePort
from cookie_clicker_bot.constants import (
BIG_COOKIE_ID,
COOKIE_COUNTER_ID,
GAME_URL,
LANGUAGE_BUTTON_PREFIX,
LANGUAGE_CODE,
)
from cookie_clicker_bot.domain.number_parsing import parse_game_number
def open_game(game: GamePort) -> None:
"""@brief Load the game and wait until it asks for a language.
@param game The game page to operate.
"""
game.open_page(GAME_URL)
game.wait_for_element(LANGUAGE_BUTTON_PREFIX + LANGUAGE_CODE)
def select_language(game: GamePort) -> None:
"""@brief Choose the language and wait until the big cookie is playable.
@param game The game page to operate.
"""
game.click_element(LANGUAGE_BUTTON_PREFIX + LANGUAGE_CODE)
game.wait_for_element(BIG_COOKIE_ID)
def click_cookie(game: GamePort, times: int = 1) -> None:
"""@brief Click the big cookie.
@param game The game page to operate.
@param times How many clicks to make, zero or more.
@throws ValueError When times is negative.
"""
if times < 0:
raise ValueError(f"times must not be negative, got {times}")
for _ in range(times):
game.click_element(BIG_COOKIE_ID)
def get_cookie_count(game: GamePort) -> int:
"""@brief Read how many cookies the bakery has now.
@param game The game page to read.
@return The number of cookies, rounded to a whole number.
@throws UnreadableNumberError When the counter shows no number.
"""
first_line = game.read_text(COOKIE_COUNTER_ID).strip().splitlines()[0]
return parse_game_number(first_line)
+45
View File
@@ -0,0 +1,45 @@
"""@file
@brief Constants shared by every layer of the bot.
"""
## Seconds the bot plays before it reads the cookies per second (lecture step 5).
RUN_DURATION_SECONDS: int = 300
## Seconds between two looks at the store while the bot keeps clicking.
STORE_CHECK_INTERVAL_SECONDS: int = 5
## Seconds to wait for an element before the bot gives up.
ELEMENT_TIMEOUT_SECONDS: int = 20
## Address of the game the bot plays.
GAME_URL: str = "https://ozh.github.io/cookieclicker/"
## Element id prefix of the language buttons shown on the first launch.
LANGUAGE_BUTTON_PREFIX: str = "langSelect-"
## Language the bot chooses (the game's own code for English).
LANGUAGE_CODE: str = "EN"
## Element id of the big cookie that is clicked to earn cookies.
BIG_COOKIE_ID: str = "bigCookie"
## Element id of the counter that shows the cookies and the cookies per second.
COOKIE_COUNTER_ID: str = "cookies"
## Element id of the line that shows the cookies per second.
CPS_ID: str = "cookiesPerSecond"
## Number words the game prints for large amounts, with their value.
NUMBER_SCALES: dict[str, int] = {
"thousand": 10**3,
"million": 10**6,
"billion": 10**9,
"trillion": 10**12,
"quadrillion": 10**15,
"quintillion": 10**18,
"sextillion": 10**21,
"septillion": 10**24,
"octillion": 10**27,
"nonillion": 10**30,
"decillion": 10**33,
}
@@ -0,0 +1,3 @@
"""@file
@brief Domain layer: game rules that know nothing about Selenium.
"""
+7
View File
@@ -0,0 +1,7 @@
"""@file
@brief Errors raised by the game rules.
"""
class UnreadableNumberError(ValueError):
"""@brief Raised when text from the game does not contain a readable number."""
@@ -0,0 +1,30 @@
"""@file
@brief Turns the amounts the game prints ("1.234 million") into numbers.
"""
import re
from decimal import ROUND_HALF_UP, Decimal
from cookie_clicker_bot.constants import NUMBER_SCALES
from cookie_clicker_bot.domain.errors import UnreadableNumberError
_AMOUNT = re.compile(r"^\s*(\d[\d,]*(?:\.\d+)?)(?:\s+([a-z]+))?", re.IGNORECASE)
def parse_game_number(text: str) -> int:
"""@brief Read the first amount in a text printed by the game.
The game groups thousands with commas ("12,345") and writes large amounts
with a number word ("1.234 million"). Any other word after the number, such
as "cookies", is ignored.
@param text The text, for example "1.234 million" or "12,345 cookies".
@return The amount, rounded to a whole number.
@throws UnreadableNumberError When the text does not start with a number.
"""
match = _AMOUNT.match(text)
if match is None:
raise UnreadableNumberError(f"No number at the start of {text!r}")
value = Decimal(match.group(1).replace(",", ""))
scale = NUMBER_SCALES.get((match.group(2) or "").lower(), 1)
return int((value * scale).to_integral_value(rounding=ROUND_HALF_UP))
@@ -0,0 +1,3 @@
"""@file
@brief Infrastructure layer: the Selenium adapter that implements the game port.
"""
@@ -0,0 +1,81 @@
"""@file
@brief Selenium adapter for the GamePort, and the factory for the Chrome driver.
"""
from selenium import webdriver
from selenium.webdriver.common.by import By
from selenium.webdriver.remote.webdriver import WebDriver
from selenium.webdriver.support import expected_conditions
from selenium.webdriver.support.ui import WebDriverWait
from cookie_clicker_bot.constants import ELEMENT_TIMEOUT_SECONDS
_HEADLESS_ARGUMENTS: tuple[str, ...] = (
"--headless=new",
"--no-sandbox",
"--disable-dev-shm-usage",
"--window-size=1280,1024",
)
class SeleniumGame:
"""@brief Operates the game page through a Selenium web driver."""
def __init__(self, driver: WebDriver) -> None:
"""@brief Create the adapter.
@param driver The web driver to operate; the caller owns its creation.
"""
self._driver = driver
def open_page(self, url: str) -> None:
"""@brief Load the page at the address.
@param url The address of the game.
"""
self._driver.get(url)
def wait_for_element(self, element_id: str) -> None:
"""@brief Block until the element is on the page.
@param element_id The HTML id of the element.
@throws selenium.common.exceptions.TimeoutException When it never appears.
"""
WebDriverWait(self._driver, ELEMENT_TIMEOUT_SECONDS).until(
expected_conditions.presence_of_element_located((By.ID, element_id))
)
def click_element(self, element_id: str) -> None:
"""@brief Click the element with a real click, never a script click.
The game rate-limits synthetic clicks, so the click must come from the
browser the way a user's does.
@param element_id The HTML id of the element.
@throws selenium.common.exceptions.TimeoutException When it never
becomes clickable.
"""
element = WebDriverWait(self._driver, ELEMENT_TIMEOUT_SECONDS).until(
expected_conditions.element_to_be_clickable((By.ID, element_id))
)
element.click()
def read_text(self, element_id: str) -> str:
"""@brief Return the visible text of the element.
@param element_id The HTML id of the element.
@return The text as shown on the page.
"""
return self._driver.find_element(By.ID, element_id).text
def close(self) -> None:
"""@brief Quit the browser and end the driver session."""
self._driver.quit()
def create_chrome_driver(headless: bool = False) -> WebDriver:
"""@brief Build a Chrome web driver.
@param headless True to run without a window, for a container or CI.
@return The started Chrome driver.
"""
options = webdriver.ChromeOptions()
if headless:
for argument in _HEADLESS_ARGUMENTS:
options.add_argument(argument)
return webdriver.Chrome(options=options)
@@ -0,0 +1,3 @@
"""@file
@brief Presentation layer: the command line entry point.
"""
+2
View File
@@ -0,0 +1,2 @@
"""@file
@brief Tests for the Cookie Clicker bot."""
+2
View File
@@ -0,0 +1,2 @@
"""@file
@brief End to end tests (headless Chrome in Docker only)."""
+2
View File
@@ -0,0 +1,2 @@
"""@file
@brief Tests that cross a boundary."""
+105
View File
@@ -0,0 +1,105 @@
"""@file
@brief Tests of the Selenium adapter against a hand-written fake driver.
No browser and no network: the fake driver records what the adapter asks for.
"""
from typing import cast
import pytest
from selenium.common.exceptions import NoSuchElementException
from selenium.webdriver.common.by import By
from selenium.webdriver.remote.webdriver import WebDriver
from cookie_clicker_bot.infrastructure.selenium_game import SeleniumGame
class FakeElement:
"""@brief An element that counts its real clicks."""
def __init__(self, text: str = "") -> None:
self.text = text
self.clicks = 0
def is_displayed(self) -> bool:
return True
def is_enabled(self) -> bool:
return True
def click(self) -> None:
self.clicks += 1
class FakeDriver:
"""@brief A driver with elements by id; it records its calls."""
def __init__(self, elements: dict[str, FakeElement]) -> None:
self.elements = elements
self.visited: list[str] = []
self.lookups: list[tuple[str, str]] = []
self.quit_calls = 0
def get(self, url: str) -> None:
self.visited.append(url)
def find_element(self, by: str, value: str) -> FakeElement:
self.lookups.append((by, value))
if value not in self.elements:
raise NoSuchElementException(value)
return self.elements[value]
def quit(self) -> None:
self.quit_calls += 1
def make_game(driver: FakeDriver) -> SeleniumGame:
return SeleniumGame(cast(WebDriver, driver))
def test_open_page_loads_the_url() -> None:
driver = FakeDriver({})
make_game(driver).open_page("https://example.test/")
assert driver.visited == ["https://example.test/"]
def test_wait_for_element_looks_up_by_id() -> None:
driver = FakeDriver({"bigCookie": FakeElement()})
make_game(driver).wait_for_element("bigCookie")
assert driver.lookups == [(By.ID, "bigCookie")]
def test_read_text_returns_the_element_text() -> None:
driver = FakeDriver({"cookies": FakeElement("12 cookies")})
assert make_game(driver).read_text("cookies") == "12 cookies"
assert driver.lookups == [(By.ID, "cookies")]
def test_click_element_makes_one_real_click() -> None:
element = FakeElement()
driver = FakeDriver({"bigCookie": element})
make_game(driver).click_element("bigCookie")
assert element.clicks == 1
assert all(by == By.ID for by, _ in driver.lookups)
def test_read_text_raises_when_element_is_missing() -> None:
game = make_game(FakeDriver({}))
with pytest.raises(NoSuchElementException):
game.read_text("missing")
def test_close_quits_the_driver() -> None:
driver = FakeDriver({})
make_game(driver).close()
assert driver.quit_calls == 1
+2
View File
@@ -0,0 +1,2 @@
"""@file
@brief Tests of the pure logic (no browser needed)."""
+25
View File
@@ -0,0 +1,25 @@
"""@file
@brief A fake game page for tests that must not start a browser.
"""
class FakeGame:
"""@brief Records what the bot does and answers reads from a dictionary."""
def __init__(self, texts: dict[str, str] | None = None) -> None:
self.texts: dict[str, str] = texts or {}
self.opened: list[str] = []
self.waited: list[str] = []
self.clicked: list[str] = []
def open_page(self, url: str) -> None:
self.opened.append(url)
def wait_for_element(self, element_id: str) -> None:
self.waited.append(element_id)
def click_element(self, element_id: str) -> None:
self.clicked.append(element_id)
def read_text(self, element_id: str) -> str:
return self.texts[element_id]
+66
View File
@@ -0,0 +1,66 @@
"""@file
@brief Tests of lecture steps 1 to 3 against a fake game.
"""
import pytest
from cookie_clicker_bot.application.use_cases.bot_core import (
click_cookie,
get_cookie_count,
open_game,
select_language,
)
from cookie_clicker_bot.constants import (
BIG_COOKIE_ID,
COOKIE_COUNTER_ID,
GAME_URL,
LANGUAGE_BUTTON_PREFIX,
LANGUAGE_CODE,
)
from tests.unit.fakes import FakeGame
LANGUAGE_BUTTON = LANGUAGE_BUTTON_PREFIX + LANGUAGE_CODE
def test_open_game_loads_the_url_and_waits_for_the_language_prompt() -> None:
game = FakeGame()
open_game(game)
assert game.opened == [GAME_URL]
assert game.waited == [LANGUAGE_BUTTON]
def test_select_language_clicks_the_button_and_waits_for_the_cookie() -> None:
game = FakeGame()
select_language(game)
assert game.clicked == [LANGUAGE_BUTTON]
assert game.waited == [BIG_COOKIE_ID]
@pytest.mark.parametrize("times", [0, 1, 2, 50])
def test_click_cookie_clicks_the_requested_number_of_times(times: int) -> None:
game = FakeGame()
click_cookie(game, times)
assert game.clicked == [BIG_COOKIE_ID] * times
def test_click_cookie_defaults_to_one_click() -> None:
game = FakeGame()
click_cookie(game)
assert game.clicked == [BIG_COOKIE_ID]
def test_click_cookie_refuses_a_negative_count() -> None:
game = FakeGame()
with pytest.raises(ValueError, match="negative"):
click_cookie(game, -1)
assert game.clicked == []
def test_get_cookie_count_reads_the_first_line_of_the_counter() -> None:
game = FakeGame({COOKIE_COUNTER_ID: "12,345 cookies\nper second: 3.5"})
assert get_cookie_count(game) == 12345
def test_get_cookie_count_reads_large_amounts_split_over_lines() -> None:
game = FakeGame({COOKIE_COUNTER_ID: "1.234 million\ncookies\nper second: 900"})
assert get_cookie_count(game) == 1_234_000
+13
View File
@@ -0,0 +1,13 @@
"""@file
@brief Guards the timing constants the bot relies on.
"""
from cookie_clicker_bot import constants
def test_run_duration_is_five_minutes() -> None:
assert constants.RUN_DURATION_SECONDS == 300
def test_store_check_happens_inside_the_run() -> None:
assert 0 < constants.STORE_CHECK_INTERVAL_SECONDS < constants.RUN_DURATION_SECONDS
+49
View File
@@ -0,0 +1,49 @@
"""@file
@brief Tests of parse_game_number.
"""
import pytest
from cookie_clicker_bot.domain.errors import UnreadableNumberError
from cookie_clicker_bot.domain.number_parsing import parse_game_number
@pytest.mark.parametrize(
("text", "expected"),
[
("0", 0),
("1 cookie", 1),
("15 cookies", 15),
("12,345 cookies", 12345),
("1,234,567", 1234567),
],
)
def test_parse_plain_amounts(text: str, expected: int) -> None:
assert parse_game_number(text) == expected
@pytest.mark.parametrize(
("text", "expected"),
[
("1.234 million", 1_234_000),
("2 billion", 2_000_000_000),
("1.500 Thousand", 1500),
("3 decillion", 3 * 10**33),
],
)
def test_parse_amounts_with_number_word(text: str, expected: int) -> None:
assert parse_game_number(text) == expected
def test_parse_ignores_unknown_word_after_the_number() -> None:
assert parse_game_number("42 bakers") == 42
def test_parse_rounds_decimals() -> None:
assert parse_game_number("7.6 cookies") == 8
@pytest.mark.parametrize("text", ["", "cookies", "-5", "per second: 3"])
def test_parse_rejects_text_without_a_leading_number(text: str) -> None:
with pytest.raises(UnreadableNumberError):
parse_game_number(text)