[ { "path": ".devcontainer/dev.Dockerfile", "content": "ARG VARIANT=\"3.12-bullseye\"\nFROM mcr.microsoft.com/devcontainers/python:${VARIANT} AS ukbc-dev-base\n\nUSER root\n\n# Install dependencies for Google Chrome\nRUN dpkg --add-architecture amd64 && \\\n apt-get update && \\\n apt-get install -y --no-install-recommends \\\n wget \\\n gnupg2 \\\n software-properties-common \\\n apt-transport-https \\\n ca-certificates \\\n unzip \\\n libasound2 \\\n libatk-bridge2.0-0 \\\n libatk1.0-0 \\\n libatspi2.0-0 \\\n libcairo2 \\\n libcups2 \\\n libdbus-1-3 \\\n libexpat1 \\\n libgbm1 \\\n libglib2.0-0 \\\n libgtk-3-0 \\\n libnspr4 \\\n libnss3 \\\n libpango-1.0-0 \\\n libudev1 \\\n libvulkan1 \\\n libx11-6 \\\n libxcb1 \\\n libxcomposite1 \\\n libxdamage1 \\\n libxext6 \\\n libxfixes3 \\\n libxkbcommon0 \\\n libxrandr2 \\\n libcurl4 && \\\n apt-get clean && \\\n rm -rf /var/lib/apt/lists/*\n\n# Add Google Chrome repository\nRUN wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | apt-key add - && \\\n echo \"deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main\" > /etc/apt/sources.list.d/google-chrome.list && \\\n apt-get update\n\n# Install Chrome\nRUN apt-get install -y google-chrome-stable && \\\n apt-get clean && \\\n rm -rf /var/lib/apt/lists/*\n\n# Install ChromeDriver\nRUN CHROME_VERSION=$(google-chrome --version | sed 's/Google Chrome //' | tr -d ' ') && \\\n wget -O /tmp/chromedriver.zip \"https://storage.googleapis.com/chrome-for-testing-public/${CHROME_VERSION}/linux64/chromedriver-linux64.zip\" && \\\n unzip /tmp/chromedriver.zip -d /tmp && \\\n mv /tmp/chromedriver-linux64/chromedriver /usr/local/bin/ && \\\n rm -rf /tmp/chromedriver* && \\\n chmod +x /usr/local/bin/chromedriver\n\nUSER vscode\n\n# Define the version of Poetry to install (default is 1.4.2)\n# Define the directory of python virtual environment\nARG PYTHON_VIRTUALENV_HOME=/home/vscode/ukbc-py-env \\\n POETRY_VERSION=1.8.4\n\nENV POETRY_VIRTUALENVS_IN_PROJECT=false \\\n POETRY_NO_INTERACTION=true\n\n# Install Poetry outside of the virtual environment to avoid conflicts\nRUN python3 -m pip install --user pipx && \\\n python3 -m pipx ensurepath && \\\n pipx install poetry==${POETRY_VERSION}\n\n# Create a Python virtual environment for the project\nRUN python3 -m venv ${PYTHON_VIRTUALENV_HOME} && \\\n $PYTHON_VIRTUALENV_HOME/bin/pip install --upgrade pip\n\nENV PATH=\"$PYTHON_VIRTUALENV_HOME/bin:$PATH\" \\\n VIRTUAL_ENV=$PYTHON_VIRTUALENV_HOME\n\n# Setup for bash\nRUN poetry completions bash >> /home/vscode/.bash_completion && \\\n echo \"export PATH=$PYTHON_VIRTUALENV_HOME/bin:$PATH\" >> ~/.bashrc\n\n# Set the working directory for the app\nWORKDIR /ukbc_build\n\n# Use a multi-stage build to install dependencies\nFROM ukbc-dev-base AS ukbc-dev-dependencies\n\nARG PYTHON_VIRTUALENV_HOME\n\nCOPY . /ukbc_build/\n\nRUN poetry install --no-interaction --no-ansi --with dev\n\n#docker build -f .devcontainer/dev.Dockerfile -t ukbc_dev_container .\n" }, { "path": ".devcontainer/devcontainer.json", "content": "{\n \"dockerComposeFile\": \"docker-compose.yml\",\n \"service\": \"devcontainer\",\n \"workspaceFolder\": \"/workspaces/UKBinCollectionData\",\n \"customizations\": {\n \"vscode\": {\n \"extensions\": [\n \"alexkrechik.cucumberautocomplete\",\n \"eamodio.gitlens\",\n \"Gruntfuggly.todo-tree\",\n \"ms-python.black-formatter\",\n \"ms-python.isort\",\n \"ms-python.pylint\", // Add pylint extension\n \"ms-python.python\",\n \"ms-python.python\",\n \"ms-python.vscode-pep8\", // Add pep8 extension\n \"ms-python.vscode-pylance\",\n \"oderwat.indent-rainbow\",\n \"ryanluker.vscode-coverage-gutters\",\n \"yzhang.markdown-all-in-one\"\n ],\n \"settings\": {\n \"makefile.makefilePath\": \"${workspaceFolder}/\",\n \"files.exclude\": {\n \"**/__pycache__\": true,\n \"**/.pytest_cache\": true\n },\n \"autoSave\": true,\n \"git.autorefresh\": true,\n \"extensions.ignoreRecommendations\": true,\n \"isort.args\": [\n \"--profile\",\n \"black\"\n ],\n \"python.analysis.diagnosticMode\": \"workspace\",\n \"python.analysis.typeCheckingMode\": \"strict\",\n \"python.analysis.logLevel\": \"Trace\",\n \"python.analysis.disableSemanticOnNoPython\": false,\n \"python.analysis.enableSyncServer\": true,\n \"python.analysis.userFileIndexingLimit\": -1,\n \"python.formatting.provider\": \"none\",\n \"python.languageServer\": \"Pylance\",\n \"python.linting.enabled\": true,\n \"python.linting.pylintEnabled\": true,\n \"python.linting.pep8Enabled\": true,\n \"python.linting.lintOnSave\": true,\n \"python.testing.autoTestDiscoverOnSaveEnabled\": false,\n \"python.defaultInterpreterPath\": \"/home/vscode/ukbc-py-env\",\n \"python.testing.pytestArgs\": [\n \"${workspaceFolder}/uk_bin_collection\",\n \"${workspaceFolder}/custom_components/uk_bin_collection/tests\",\n \"--headless=False\",\n \"-o cache_dir=${workspaceFolder}/.pytest_cache\"\n ],\n \"python.testing.unittestEnabled\": false,\n \"python.testing.pytestEnabled\": true,\n \"[python]\": {\n \"editor.defaultFormatter\": \"ms-python.black-formatter\",\n \"editor.formatOnSave\": true,\n \"editor.formatOnPaste\": false,\n \"editor.formatOnSaveMode\": \"file\",\n \"editor.codeActionsOnSave\": {\n \"source.organizeImports\": true\n }\n },\n \"workbench.colorCustomizations\": {\n \"editorError.foreground\": \"#ff000088\",\n \"editorWarning.foreground\": \"#ffe60033\",\n \"editorInfo.foreground\": \"#00ff0088\"\n }\n }\n }\n }\n}\n" }, { "path": ".devcontainer/docker-compose.yml", "content": "services:\n devcontainer:\n image: ukbc_dev_container # This tags the built image\n build:\n context: ../ # Path to the directory containing the Dockerfile\n dockerfile: .devcontainer/dev.Dockerfile\n volumes:\n - ../:/workspaces/UKBinCollectionData:rw\n privileged: true\n hostname: devcontainer\n network_mode: host\n depends_on:\n - selenium-hub\n command: sleep infinity\n\n homeassistant:\n container_name: homeassistant\n image: \"ghcr.io/home-assistant/home-assistant:stable\"\n volumes:\n - .ha_config:/config:rw\n - ../custom_components:/config/custom_components\n - /etc/localtime:/etc/localtime:ro\n - /run/dbus:/run/dbus:ro\n restart: unless-stopped\n privileged: true\n networks:\n - devnet\n ports:\n - \"8124:8123/tcp\"\n\n chrome1:\n image: selenium/node-chrome:4.20.0-20240505\n shm_size: 2gb\n networks:\n - devnet\n depends_on:\n - selenium-hub\n ports:\n - \"7901:7900\"\n - \"5551:5555\"\n environment:\n - SE_EVENT_BUS_HOST=selenium-hub\n - SE_EVENT_BUS_PUBLISH_PORT=4442\n - SE_EVENT_BUS_SUBSCRIBE_PORT=4443\n - VNC_NO_PASSWORD=1\n privileged: true\n restart: always\n\n chrome2:\n image: selenium/node-chrome:4.20.0-20240505\n shm_size: 2gb\n networks:\n - devnet\n depends_on:\n - selenium-hub\n ports:\n - \"7902:7900\"\n - \"5552:5555\"\n environment:\n - SE_EVENT_BUS_HOST=selenium-hub\n - SE_EVENT_BUS_PUBLISH_PORT=4442\n - SE_EVENT_BUS_SUBSCRIBE_PORT=4443\n - VNC_NO_PASSWORD=1\n privileged: true\n restart: always\n\n chrome3:\n image: selenium/node-chrome:4.20.0-20240505\n shm_size: 2gb\n networks:\n - devnet\n depends_on:\n - selenium-hub\n ports:\n - \"7903:7900\"\n - \"5553:5555\"\n environment:\n - SE_EVENT_BUS_HOST=selenium-hub\n - SE_EVENT_BUS_PUBLISH_PORT=4442\n - SE_EVENT_BUS_SUBSCRIBE_PORT=4443\n - VNC_NO_PASSWORD=1\n privileged: true\n restart: always\n\n chrome4:\n image: selenium/node-chrome:4.20.0-20240505\n shm_size: 2gb\n networks:\n - devnet\n depends_on:\n - selenium-hub\n ports:\n - \"7904:7900\"\n - \"5554:5555\"\n environment:\n - SE_EVENT_BUS_HOST=selenium-hub\n - SE_EVENT_BUS_PUBLISH_PORT=4442\n - SE_EVENT_BUS_SUBSCRIBE_PORT=4443\n - VNC_NO_PASSWORD=1\n privileged: true\n restart: always\n\n chrome_video1:\n image: selenium/video:ffmpeg-6.1.1-20240505\n networks:\n - devnet\n volumes:\n - ../test_videos:/videos/\n depends_on:\n - chrome1\n environment:\n - DISPLAY_CONTAINER_NAME=chrome1\n - SE_VIDEO_FILE_NAME=auto\n - SE_NODE_GRID_URL=http://selenium-hub:4444\n privileged: true\n restart: always\n\n chrome_video2:\n image: selenium/video:ffmpeg-6.1.1-20240505\n networks:\n - devnet\n volumes:\n - ../test_videos:/videos/\n depends_on:\n - chrome2\n environment:\n - DISPLAY_CONTAINER_NAME=chrome2\n - SE_VIDEO_FILE_NAME=auto\n - SE_NODE_GRID_URL=http://selenium-hub:4444\n privileged: true\n restart: always\n\n chrome_video3:\n image: selenium/video:ffmpeg-6.1.1-20240505\n networks:\n - devnet\n volumes:\n - ../test_videos:/videos/\n depends_on:\n - chrome3\n environment:\n - DISPLAY_CONTAINER_NAME=chrome3\n - SE_VIDEO_FILE_NAME=auto\n - SE_NODE_GRID_URL=http://selenium-hub:4444\n privileged: true\n restart: always\n\n chrome_video4:\n image: selenium/video:ffmpeg-6.1.1-20240505\n networks:\n - devnet\n volumes:\n - ../test_videos:/videos/\n depends_on:\n - chrome4\n environment:\n - DISPLAY_CONTAINER_NAME=chrome4\n - SE_VIDEO_FILE_NAME=auto\n - SE_NODE_GRID_URL=http://selenium-hub:4444\n privileged: true\n restart: always\n\n selenium-hub:\n image: selenium/hub:4.20.0-20240505\n container_name: selenium-hub\n hostname: selenium\n ports:\n - \"4442:4442\"\n - \"4443:4443\"\n - \"4444:4444\"\n privileged: true\n restart: always\n networks:\n - devnet\n\nnetworks:\n devnet:\n driver: bridge\n" }, { "path": ".dockerignore", "content": "# Ignore everything\n*\n\n# But not these files...\n!*.json\n!*.py\n!PipFile\n!Pipfile.lock\n!.gitignore\n!.dockerignore\n!*.toml\n!*.md\n!*.rst\n!LICENSE\n!*.schema\n!Makefile\n!dependabot.yaml\n!poetry.lock\n!behave.ini\n!*.Dockerfile\n\n# Or these folders...\n!.github\n!*.png\n!.github/ISSUE_TEMPLATE\n!.github/ISSUE_TEMPLATE/*.yaml\n!.github/workflows\n!.github/workflows/*.yml\n!uk_bin_collection\n!uk_bin_collection/**/*\n!uk_bin_collection_api_server\n!uk_bin_collection_api_server/**/*\n!wiki\n!wiki/**/*\n!custom_components\n__pycache__\n!TO_BE_CONVERTED\n!.devcontainer\n" }, { "path": ".github/ISSUE_TEMPLATE/COUNCIL_ISSUE.yaml", "content": "name: Council Issue\ndescription: Issue with an existing council\nlabels: [\"bug\"]\n\nbody:\n - type: input\n id: council\n attributes:\n label: Name of Council\n description: What council you were trying to use\n placeholder: e.g. Huntingdon District Council\n validations:\n required: true\n - type: textarea\n id: extra\n attributes:\n label: Issue Information\n description: What is the issue you're experiencing? How can we re-produce it?\n placeholder: Detailed explanation of the issue along with replication steps\n - type: checkboxes\n id: verification\n attributes:\n label: Verification\n description: 'Please verify that you''ve followed these steps:'\n options:\n - label: I searched for similar issues at https://github.com/robbrad/UKBinCollectionData/issues?q=is:issue and found no duplicates\n required: true\n - label: I have checked my address/postcode/UPRN works on the council's website\n required: true\n - label: I have provided a detailed explanation of the issue as well as steps to replicate the issue\n required: true\n - label: I understand that this project is run by volunteer contributors therefore completion of this issue cannot be guaranteed\n required: true" }, { "path": ".github/ISSUE_TEMPLATE/COUNCIL_REQUEST.yaml", "content": "name: Council Request\ndescription: Request for a council to be added to the repository\nlabels: [\"council request\"]\n\nbody:\n - type: input\n id: council\n attributes:\n label: Name of Council\n description: What council are you wishing to be added\n placeholder: e.g. Huntingdon District Council\n validations:\n required: true\n - type: input\n id: postcode\n attributes:\n label: Example Address/Postcode\n description: Please provide a tested working example address/postcode for the council's area\n placeholder: e.g. PE7 3YQ\n validations:\n required: true\n - type: textarea\n id: extra\n attributes:\n label: Additional Information\n description: Add any other information here\n placeholder: Links to the councils site, information you have already gathered\n - type: checkboxes\n id: verification\n attributes:\n label: Verification\n description: 'Please verify that you''ve followed these steps:'\n options:\n - label: I''ve checked the [wiki](https://github.com/robbrad/UKBinCollectionData/wiki/Councils#contents) and verified that my council has not been added\n required: true\n - label: I''ve checked that a request for my council does not already exist in the [Issues tracker](https://github.com/robbrad/UKBinCollectionData/issues?q=is%3Aopen+is%3Aissue+label%3A\"council+request\")\n required: true\n - label: I have provided a tested working address/postcode/UPRN with bin collections available, as well as a link to the council''s website\n required: true\n - label: I understand that this project is run by volunteer contributors and completion depends on numerous factors - even with a request, we cannot guarantee if/when your council will get a script\n required: true\n" }, { "path": ".github/ISSUE_TEMPLATE/HOME_ASSISTANT_CUSTOM_COMPONENT_ISSUE.yaml", "content": "name: Home Assistant Custom Component Issue\ndescription: Issue with the Home Assistant custom component\nlabels: [\"bug\", \"home assistant custom component\"]\n\nbody:\n - type: markdown\n attributes:\n value: If you were trying to add a specific council, please check it is listed as working [here](https://robbrad.github.io/UKBinCollectionData/3.12/) and open a [Council Issue](https://github.com/robbrad/UKBinCollectionData/issues/new/choose) instead if it's failing\n - type: input\n id: ha_version\n attributes:\n label: Home Assistant Version\n description: What version of Home Assistant you're running\n placeholder: e.g. 2023.10.3\n validations:\n required: true\n - type: dropdown\n id: install_method\n attributes:\n label: Installation Method\n description: How did you install the custom component?\n options:\n - Using HACS\n - Manually\n validations:\n required: true\n - type: input\n id: council\n attributes:\n label: Name of Council (if relevant)\n description: Which council were you trying to use?\n placeholder: e.g. Huntingdon District Council\n - type: textarea\n id: extra\n attributes:\n label: Issue Information\n description: What issue are you experiencing? How can we re-produce it?\n placeholder: Detailed explanation of the issue along with replication steps\n validations:\n required: true\n - type: checkboxes\n id: verification\n attributes:\n label: Verification\n description: 'Please verify that you''ve followed these steps:'\n options:\n - label: I searched for similar issues at https://github.com/robbrad/UKBinCollectionData/issues?q=is:issue and found no duplicates\n required: true\n - label: If trying to add a specific council, I've checked it is listed as working at https://robbrad.github.io/UKBinCollectionData/3.12/\n required: true\n - label: I have provided a detailed explanation of the issue as well as steps to replicate the issue\n required: true\n - label: I understand that this project is run by volunteer contributors therefore completion of this issue cannot be guaranteed\n required: true" }, { "path": ".github/dependabot.yaml", "content": "---\nversion: 2\nupdates:\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n interval: daily\n time: \"06:00\"\n commit-message:\n # Prefix all commit messages with \"chore: \"\n prefix: \"chore\"" }, { "path": ".github/workflows/behave_pull_request.yml", "content": "name: PR - Test Councils\n\non:\n workflow_dispatch:\n pull_request:\n branches: [ \"master\" ]\n paths-ignore:\n - \"wiki/**\"\n - \"**/*.md\"\n - \"uk_bin_collection_api_server/**\"\n\njobs:\n setup:\n name: Setup Environment\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n - name: Install Poetry\n run: pipx install poetry==1.8.4\n\n - uses: actions/setup-python@v6\n with:\n python-version: 3.12\n\n - name: Install Dependencies\n run: make install-dev\n\n - name: Lint JSON\n run: jq empty uk_bin_collection/tests/input.json\n\n - name: Get All Council Files That Have Changed\n id: changed-council-files\n uses: tj-actions/changed-files@v47\n with:\n files: |\n uk_bin_collection/uk_bin_collection/councils/**.py\n - name: Set Council Tests Environment Variable\n id: set-council-tests\n run: |\n IFS=' ' read -ra FILES <<< \"${{ steps.changed-council-files.outputs.all_changed_files }}\"\n COUNCIL_TESTS=\"\"\n for file in \"${FILES[@]}\"; do\n FILENAME=$(basename \"$file\" .py)\n if [ -z \"$COUNCIL_TESTS\" ]; then\n COUNCIL_TESTS=\"$FILENAME\"\n else\n COUNCIL_TESTS=\"$COUNCIL_TESTS or $FILENAME\"\n fi\n done\n echo \"council_tests=$COUNCIL_TESTS\" >> $GITHUB_OUTPUT\n outputs:\n council_tests: ${{ steps.set-council-tests.outputs.council_tests }}\n\n unit-tests:\n name: Run Unit Tests\n needs: setup\n runs-on: ubuntu-latest\n strategy:\n matrix:\n python-version: [3.12]\n poetry-version: [1.8.4]\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-python@v6\n with:\n python-version: ${{ matrix.python-version }}\n\n - name: Install Poetry\n run: pipx install poetry==${{ matrix.poetry-version }}\n\n - name: Install Dependencies\n run: make install-dev\n\n - name: Run Unit Tests\n run: make unit-tests\n\n - name: Upload Test Results to Codecov\n uses: codecov/codecov-action@v6\n with:\n fail_ci_if_error: false\n token: ${{ secrets.CODECOV_TOKEN }}\n file: coverage.xml\n\n parity-check:\n name: Parity Check\n needs: setup\n runs-on: ubuntu-latest\n strategy:\n matrix:\n python-version: [3.12]\n poetry-version: [1.8.4]\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-python@v6\n with:\n python-version: ${{ matrix.python-version }}\n\n - name: Install Poetry\n run: pipx install poetry==${{ matrix.poetry-version }}\n\n - name: Install Dependencies\n run: make install-dev\n \n - name: Check Parity of Councils / input.json / Feature file\n env:\n repo: ${{ github.event.pull_request.head.repo.full_name || 'robbrad/UKBinCollectionData' }}\n branch: ${{ github.event.pull_request.head.ref || 'master' }}\n run: make parity-check repo=\"$repo\" branch=\"$branch\"\n\n integration-tests:\n name: Run Integration Tests\n needs: setup\n runs-on: ubuntu-latest\n strategy:\n matrix:\n python-version: [3.12]\n poetry-version: [1.8.4]\n services:\n selenium:\n image: selenium/standalone-chrome:latest\n options: --shm-size=2gb --name selenium --hostname selenium\n ports:\n - 4444:4444\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-python@v6\n with:\n python-version: ${{ matrix.python-version }}\n\n - name: Install Poetry\n run: pipx install poetry==${{ matrix.poetry-version }}\n\n - name: Install Dependencies\n run: make install-dev\n\n - name: Run Integration Tests\n env:\n HEADLESS: True\n COUNCIL_TESTS: ${{ needs.setup.outputs.council_tests }}\n run: make matrix=${{ matrix.python-version }} councils=\"${{ env.COUNCIL_TESTS }}\" integration-tests\n continue-on-error: true\n\n - name: Upload Integration Test Results to Codecov\n uses: codecov/codecov-action@v6\n with:\n fail_ci_if_error: false\n token: ${{ secrets.CODECOV_TOKEN }}\n report_type: test_results\n file: build/${{ matrix.python-version }}/integration-test-results/junit.xml\n flags: integrationtestspr\n name: integration-tests-pr\n" }, { "path": ".github/workflows/behave_schedule.yml", "content": "name: Scheduled - Test All Councils\n\non:\n workflow_dispatch:\n schedule:\n - cron: '0 0 * * *' # Nightly schedule for full test run\n\njobs:\n setup:\n name: Setup Environment\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n - name: Install Poetry\n run: pipx install poetry==1.8.4\n\n - uses: actions/setup-python@v6\n with:\n python-version: 3.12\n\n - name: Install Dependencies\n run: make install-dev\n\n - name: Lint JSON\n run: jq empty uk_bin_collection/tests/input.json\n\n - name: Set Council Tests Environment Variable\n id: set-council-tests\n run: |\n COUNCIL_TESTS=\"\"\n echo \"council_tests=$COUNCIL_TESTS\" >> $GITHUB_OUTPUT\n\n outputs:\n council_tests: ${{ steps.set-council-tests.outputs.council_tests }}\n\n unit-tests:\n name: Run Unit Tests\n needs: setup\n runs-on: ubuntu-latest\n strategy:\n matrix:\n python-version: [3.12]\n poetry-version: [1.8.4]\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-python@v6\n with:\n python-version: ${{ matrix.python-version }}\n\n - name: Install Poetry\n run: pipx install poetry==${{ matrix.poetry-version }}\n\n - name: Install Dependencies\n run: make install-dev\n\n - name: Run Unit Tests\n run: make unit-tests\n\n - name: Upload Test Results to Codecov\n uses: codecov/codecov-action@v6\n with:\n fail_ci_if_error: false\n token: ${{ secrets.CODECOV_TOKEN }}\n file: coverage.xml\n\n parity-check:\n name: Parity Check\n needs: setup\n runs-on: ubuntu-latest\n strategy:\n matrix:\n python-version: [3.12]\n poetry-version: [1.8.4]\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-python@v6\n with:\n python-version: ${{ matrix.python-version }}\n\n - name: Install Poetry\n run: pipx install poetry==${{ matrix.poetry-version }}\n\n - name: Install Dependencies\n run: make install-dev\n\n - name: Check Parity of Councils / input.json / Feature file\n run: |\n repo=${{ github.event.pull_request.head.repo.full_name || 'robbrad/UKBinCollectionData' }}\n branch=${{ github.event.pull_request.head.ref || 'master' }}\n make parity-check repo=$repo branch=$branch\n\n integration-tests:\n name: Run Integration Tests\n needs: setup\n runs-on: ubuntu-latest\n strategy:\n matrix:\n python-version: [3.12]\n poetry-version: [1.8.4]\n services:\n selenium:\n image: selenium/standalone-chrome:latest\n options: --shm-size=2gb --name selenium --hostname selenium\n ports:\n - 4444:4444\n steps:\n - uses: actions/checkout@v6\n\n - uses: actions/setup-python@v6\n with:\n python-version: ${{ matrix.python-version }}\n\n - name: Install Poetry\n run: pipx install poetry==${{ matrix.poetry-version }}\n\n - name: Install Dependencies\n run: make install-dev\n\n - name: Run Integration Tests\n env:\n HEADLESS: True\n COUNCIL_TESTS: ${{ needs.setup.outputs.council_tests }}\n run: make matrix=${{ matrix.python-version }} councils=\"${{ env.COUNCIL_TESTS }}\" integration-tests\n continue-on-error: true\n\n - name: Upload Integration Test Results to Codecov\n uses: codecov/codecov-action@v6\n with:\n fail_ci_if_error: false\n token: ${{ secrets.CODECOV_TOKEN }}\n report_type: test_results\n file: build/${{ matrix.python-version }}/integration-test-results/junit.xml\n flags: integrationtestsfullnightly\n name: integration-tests-full-nightly" }, { "path": ".github/workflows/bump.yml", "content": "name: Release - Bump Version\n\non:\n push:\n branches: [ \"master\" ]\n paths-ignore:\n - \"wiki/**\"\n - \"**/*.md\"\n - \".github/workflows/**\"\n workflow_dispatch: {}\n\njobs:\n bump:\n if: \"!startsWith(github.event.head_commit.message, 'bump:')\"\n runs-on: ubuntu-latest\n permissions:\n contents: write\n concurrency: bump\n\n steps:\n - name: Checkout\n uses: actions/checkout@v6\n with:\n fetch-depth: 0\n ssh-key: ${{ secrets.DEPLOY_KEY }}\n persist-credentials: true\n\n - name: Setup Python\n uses: actions/setup-python@v6\n with:\n python-version: '3.12'\n cache: 'pip'\n\n - name: Cache Commitizen\n uses: actions/cache@v5\n with:\n path: ~/.cache/pip\n key: ${{ runner.os }}-pip-commitizen-${{ hashFiles('**/pyproject.toml') }}\n restore-keys: |\n ${{ runner.os }}-pip-commitizen-\n\n - name: Install Commitizen\n run: pip install commitizen\n\n - name: Configure git identity\n run: |\n git config user.name \"github-actions[bot]\"\n git config user.email \"41898282+github-actions[bot]@users.noreply.github.com\"\n\n - name: Bump version and create tag\n id: bump\n run: |\n # Check if there are commits to bump\n if cz bump --yes --changelog --dry-run 2>&1 | grep -q \"No commits found\"; then\n echo \"No version bump needed - no conventional commits since last release\"\n echo \"skip=true\" >> $GITHUB_OUTPUT\n exit 0\n fi\n cz bump --yes --changelog\n echo \"version=$(cz version --project)\" >> $GITHUB_OUTPUT\n echo \"skip=false\" >> $GITHUB_OUTPUT\n\n - name: Push changes and tags\n if: steps.bump.outputs.skip != 'true'\n run: |\n git push origin master\n git push origin --tags\n\n - name: Create workflow summary\n if: always()\n run: |\n echo \"## Bump Summary\" >> $GITHUB_STEP_SUMMARY\n if [ \"${{ steps.bump.outputs.skip }}\" == \"true\" ]; then\n echo \"- **Status**: ⏭️ Skipped (no conventional commits)\" >> $GITHUB_STEP_SUMMARY\n else\n echo \"- **Status**: ✅ Success\" >> $GITHUB_STEP_SUMMARY\n echo \"- **New Version**: ${{ steps.bump.outputs.version }}\" >> $GITHUB_STEP_SUMMARY\n echo \"- **Tag Created**: ${{ steps.bump.outputs.version }}\" >> $GITHUB_STEP_SUMMARY\n fi\n" }, { "path": ".github/workflows/codeql-analysis.yml", "content": "# For most projects, this workflow file will not need changing; you simply need\n# to commit it to your repository.\n#\n# You may wish to alter this file to override the set of languages analyzed,\n# or to provide custom queries or build logic.\n#\n# ******** NOTE ********\n# We have attempted to detect the languages in your repository. Please check\n# the `language` matrix defined below to confirm you have the correct set of\n# supported CodeQL languages.\n#\nname: \"CodeQL\"\n\non:\n push:\n # Trigger unless only the wiki directory changed\n paths:\n - \"**/**.py\"\n - \"**.py\"\n branches: [ \"master\" ]\n pull_request:\n # Trigger unless only the wiki directory changed\n paths:\n - \"**/**.py\"\n - \"**.py\"\n # The branches below must be a subset of the branches above\n branches: [ \"master\" ]\n schedule:\n - cron: '36 13 * * 5'\n\njobs:\n analyze:\n if: \"!startsWith(github.event.head_commit.message, 'bump:')\"\n name: Analyze\n runs-on: ubuntu-latest\n permissions:\n actions: read\n contents: read\n security-events: write\n\n strategy:\n fail-fast: false\n matrix:\n language: [ 'python' ]\n # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]\n # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support\n\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n\n # Initializes the CodeQL tools for scanning.\n - name: Initialize CodeQL\n uses: github/codeql-action/init@v4\n with:\n languages: ${{ matrix.language }}\n # If you wish to specify custom queries, you can do so here or in a config file.\n # By default, queries listed here will override any specified in a config file.\n # Prefix the list here with \"+\" to use these queries and those in the config file.\n \n # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs\n # queries: security-extended,security-and-quality\n\n \n # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).\n # If this step fails, then you should remove it and run the build manually (see below)\n - name: Autobuild\n uses: github/codeql-action/autobuild@v4\n\n # ℹ️ Command-line programs to run using the OS shell.\n # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun\n\n # If the Autobuild fails above, remove it and uncomment the following three lines. \n # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.\n\n # - run: |\n # echo \"Run, Build Application using script\"\n # ./location_of_script_within_repo/buildscript.sh\n\n - name: Perform CodeQL Analysis\n uses: github/codeql-action/analyze@v4\n" }, { "path": ".github/workflows/docker-image.yml", "content": "name: Build - Docker Image\n\non:\n push:\n # Trigger unless only the wiki directory changed\n paths:\n - \"uk_bin_collection_api_server/**\"\n - \".github/workflows/docker-image.yml\"\n branches: [ \"master\" ]\n pull_request:\n # Trigger unless only the wiki directory changed\n paths:\n - \"uk_bin_collection_api_server/**\"\n # The branches below must be a subset of the branches above\n branches: [ \"master\" ]\n workflow_dispatch:\n schedule:\n - cron: '0 0 * * 0' # This runs at 00:00 on Sunday every week\n\njobs:\n\n build:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n - name: Publish to Registry\n uses: elgohr/Publish-Docker-Github-Action@v5\n with:\n name: robbrad182/uk-bin-collection\n username: ${{ secrets.DOCKER_USERNAME }}\n password: ${{ secrets.DOCKER_API_KEY }}\n workdir: uk_bin_collection_api_server\n" }, { "path": ".github/workflows/ha_compatibility_test.yml", "content": "name: PR - Home Assistant Compatibility Test\n\non:\n push:\n branches: [ master, main ]\n paths:\n - 'custom_components/**'\n - 'pyproject.toml'\n pull_request:\n branches: [ master, main ]\n paths:\n - 'custom_components/**'\n - 'pyproject.toml'\n schedule:\n - cron: '0 6 * * 1' # Weekly on Monday at 6 AM UTC\n\njobs:\n generate-matrix:\n name: Generate HA Version Matrix\n runs-on: ubuntu-latest\n outputs:\n matrix: ${{ steps.get-versions.outputs.matrix }}\n steps:\n - name: Get HA versions from PyPI\n id: get-versions\n run: |\n MATRIX=$(curl -s https://pypi.org/pypi/homeassistant/json | jq -c '\n .releases\n | to_entries\n # keep only x.y.z (skip betas/devs/post)\n | map(select(.key | test(\"^[0-9]+\\\\.[0-9]+\\\\.[0-9]+$\")))\n # group by major.minor, keep highest patch\n | group_by(.key | (split(\".\")[:2] | join(\".\")))\n | map(max_by(.key | (split(\".\")[2] | tonumber)) | .key)\n # sort numerically and take latest 8\n | sort_by(split(\".\") | map(tonumber))\n | .[-8:]\n # pick python version per HA series; adjust as needed\n | map({ha_version: ., python_version: (if (split(\".\")[0] == \"2025\" and (split(\".\")[1]|tonumber) >= 2) then \"3.13\" else \"3.12\" end)})\n # also test latest dev on py 3.13\n | . + [{ha_version: \"dev\", python_version: \"3.13\"}]\n | {include: .}\n ')\n echo \"matrix=$MATRIX\" >> \"$GITHUB_OUTPUT\"\n\n test-ha-compatibility:\n name: Test HA ${{ matrix.ha_version }}\n runs-on: ubuntu-latest\n needs: generate-matrix\n strategy:\n fail-fast: false\n matrix: ${{ fromJson(needs.generate-matrix.outputs.matrix) }}\n\n steps:\n - name: Checkout code\n uses: actions/checkout@v6\n\n - name: Determine Docker tag\n id: docker-tag\n run: |\n if [ \"${{ matrix.ha_version }}\" = \"dev\" ]; then\n echo \"tag=dev\" >> \"$GITHUB_OUTPUT\"\n else\n echo \"tag=${{ matrix.ha_version }}\" >> \"$GITHUB_OUTPUT\"\n fi\n\n - name: Setup HA config directory\n run: |\n mkdir -p config/custom_components config/.storage\n cp -r custom_components/uk_bin_collection config/custom_components/\n cat > config/configuration.yaml <<'YAML'\n logger:\n default: info\n YAML\n \n # Create a config entry to trigger component setup\n cat > config/.storage/core.config_entries <<'JSON'\n {\n \"version\": 1,\n \"minor_version\": 1,\n \"key\": \"core.config_entries\",\n \"data\": {\n \"entries\": [\n {\n \"entry_id\": \"test_uk_bin_collection\",\n \"version\": 3,\n \"domain\": \"uk_bin_collection\",\n \"title\": \"Test Entry\",\n \"data\": {\n \"name\": \"Test Council\",\n \"council\": \"GooglePublicCalendarCouncil\",\n \"url\": \"https://calendar.google.com/calendar/ical/0d775884b4db6a7bae5204f06dae113c1a36e505b25991ebc27c6bd42edf5b5e%40group.calendar.google.com/public/basic.ics\",\n \"timeout\": 60,\n \"update_interval\": 12,\n \"manual_refresh_only\": true\n },\n \"options\": {},\n \"pref_disable_new_entities\": false,\n \"pref_disable_polling\": false,\n \"source\": \"user\",\n \"unique_id\": null,\n \"disabled_by\": null\n }\n ]\n }\n }\n JSON\n\n - name: Start Home Assistant in Docker\n run: |\n docker run -d \\\n --name homeassistant \\\n -v $(pwd)/config:/config \\\n -e TZ=UTC \\\n ghcr.io/home-assistant/home-assistant:${{ steps.docker-tag.outputs.tag }}\n \n echo \"Waiting for container to start...\"\n sleep 5\n\n - name: Wait for Home Assistant to boot\n id: boot\n run: |\n set -euo pipefail\n TIMEOUT=150\n SECS=0\n INIT_MARKER=\"Home Assistant initialized\"\n FAIL=0\n\n echo \"Waiting for HA to initialize...\"\n while (( SECS < TIMEOUT )); do\n LOGS=$(docker logs homeassistant 2>&1)\n if echo \"$LOGS\" | grep -q \"$INIT_MARKER\"; then\n echo \"✅ HA initialized successfully\"\n break\n fi\n sleep 1\n SECS=$((SECS+1))\n if (( SECS % 10 == 0 )); then\n echo \"Waiting... ${SECS}s\"\n fi\n done\n\n # Check for dependency installation and component setup\n LOGS=$(docker logs homeassistant 2>&1)\n if echo \"$LOGS\" | grep -q \"Attempting install of uk-bin-collection\"; then\n echo \"✅ HA attempted to install uk-bin-collection dependency\"\n fi\n \n if echo \"$LOGS\" | grep -Eq \"(ERROR|CRITICAL).*(uk_bin_collection|custom_components\\.uk_bin_collection)\"; then\n echo \"❌ Component has errors in logs:\"\n echo \"$LOGS\" | grep -E \"(ERROR|CRITICAL).*(uk_bin_collection|custom_components\\.uk_bin_collection)\" || true\n FAIL=1\n fi\n\n # Check timeout\n if (( SECS >= TIMEOUT )) && ! echo \"$LOGS\" | grep -q \"$INIT_MARKER\"; then\n echo \"❌ HA did not finish booting within ${TIMEOUT}s\"\n FAIL=1\n fi\n\n # Expose pass/fail to later steps\n echo \"boot_failed=${FAIL}\" >> \"$GITHUB_OUTPUT\"\n exit ${FAIL}\n\n - name: Save HA logs to file\n if: always()\n run: |\n docker logs homeassistant > home-assistant.log 2>&1 || true\n\n - name: Show HA logs\n if: always()\n run: |\n echo \"--- Last 80 log lines ---\"\n tail -n 80 home-assistant.log 2>/dev/null || docker logs homeassistant 2>&1 | tail -n 80\n\n - name: Stop and remove container\n if: always()\n run: |\n docker stop homeassistant || true\n docker rm homeassistant || true\n\n - name: Upload HA log (always)\n if: always()\n uses: actions/upload-artifact@v7\n with:\n name: ha-log-${{ matrix.ha_version }}\n path: home-assistant.log\n overwrite: true\n\n - name: Test manifest validation\n id: manifest\n run: |\n python <<'PY'\n import json, sys\n with open('custom_components/uk_bin_collection/manifest.json') as f:\n m = json.load(f)\n required = ['domain', 'name', 'version', 'requirements']\n missing = [k for k in required if k not in m]\n if missing:\n print(f'❌ Missing required manifest fields: {missing}')\n sys.exit(1)\n print('✅ Manifest validation passed')\n print(f'Component version: {m.get(\"version\")}')\n print(f'Requirements: {m.get(\"requirements\")}')\n PY\n\n - name: Create test result summary\n if: always()\n run: |\n echo \"## Boot Results for HA ${{ matrix.ha_version }} (Python ${{ matrix.python_version }})\" >> \"$GITHUB_STEP_SUMMARY\"\n if [ \"${{ steps.boot.outputs.boot_failed }}\" = \"0\" ] && [ \"${{ steps.manifest.outcome }}\" = \"success\" ]; then\n echo \"✅ **PASSED** – HA booted with the custom component present\" >> \"$GITHUB_STEP_SUMMARY\"\n else\n echo \"❌ **FAILED** – HA failed to boot cleanly\" >> \"$GITHUB_STEP_SUMMARY\"\n echo \"\" >> \"$GITHUB_STEP_SUMMARY\"\n echo \"- boot step failed: \\`${{ steps.boot.outputs.boot_failed }}\\`\" >> \"$GITHUB_STEP_SUMMARY\"\n echo \"- manifest step: \\`${{ steps.manifest.outcome }}\\`\" >> \"$GITHUB_STEP_SUMMARY\"\n echo \"\" >> \"$GITHUB_STEP_SUMMARY\"\n echo \"See the uploaded **ha-log** artifact for details.\" >> \"$GITHUB_STEP_SUMMARY\"\n fi\n\n\n compatibility-report:\n name: Generate Compatibility Report\n runs-on: ubuntu-latest\n needs: [generate-matrix, test-ha-compatibility]\n if: always()\n steps:\n - name: Checkout code\n uses: actions/checkout@v6\n\n - name: Create compatibility report\n run: |\n echo \"# Home Assistant Compatibility Report\" > report.md\n echo \"\" >> report.md\n echo \"Matrix tested: \\`${{ needs.generate-matrix.outputs.matrix }}\\`\" >> report.md\n echo \"Last updated: $(date -u +\"%Y-%m-%d %H:%M:%S UTC\")\" >> report.md\n cat report.md >> \"$GITHUB_STEP_SUMMARY\"\n" }, { "path": ".github/workflows/hacs_validation.yml", "content": "name: PR - Validate HACS\n\non:\n push:\n pull_request:\n schedule:\n - cron: \"0 0 * * *\"\n\njobs:\n hassfest_validation:\n name: HassFest Validation\n runs-on: \"ubuntu-latest\"\n steps:\n - uses: \"actions/checkout@v6\"\n - uses: home-assistant/actions/hassfest@master\n \n hacs:\n name: HACS Action Validation\n runs-on: \"ubuntu-latest\"\n steps:\n - name: HACS Action\n uses: \"hacs/action@main\"\n with:\n category: \"integration\"\n\n" }, { "path": ".github/workflows/lint.yml", "content": "name: PR - Lint Commit Messages\n\non:\n push:\n # The branches below must be a subset of the branches above\n branches: [ \"master\" ]\n pull_request:\n # The branches below must be a subset of the branches above\n branches: [ \"master\" ]\n\njobs:\n # Make sure commit messages follow the conventional commits convention:\n # https://www.conventionalcommits.org\n commitlint:\n if: \"!startsWith(github.event.head_commit.message, 'bump:')\"\n name: Lint Commit Messages\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n with:\n fetch-depth: 0\n - run: \"echo \\\"export default {extends: ['@commitlint/config-conventional'], rules: { 'subject-case': [0], 'body-max-line-length': [0], 'footer-max-line-length': [0] }}\\\" > commitlint.config.mjs\"\n - uses: wagoid/commitlint-github-action@v6\n" }, { "path": ".github/workflows/release.yml", "content": "name: Release - Publish to PyPI\n\non:\n push:\n tags:\n - '*'\n\njobs:\n release:\n runs-on: ubuntu-latest\n permissions:\n contents: write\n id-token: write\n steps:\n - name: Checkout\n uses: actions/checkout@v6\n\n - name: Setup Python\n uses: actions/setup-python@v6\n with:\n python-version: '3.12'\n cache: 'pip'\n\n - name: Install Poetry\n uses: abatilo/actions-poetry@v4.0.0\n with:\n poetry-version: '1.8.4'\n\n - name: Cache Poetry dependencies\n uses: actions/cache@v5\n with:\n path: ~/.cache/pypoetry\n key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}\n restore-keys: |\n ${{ runner.os }}-poetry-\n\n - name: Set release version\n run: echo \"RELEASE_VERSION=${GITHUB_REF#refs/*/}\" >> $GITHUB_ENV\n\n - name: Verify version matches tag\n run: |\n POETRY_VERSION=$(poetry version -s)\n if [ \"$POETRY_VERSION\" != \"${{ env.RELEASE_VERSION }}\" ]; then\n echo \"Error: Poetry version ($POETRY_VERSION) doesn't match tag (${{ env.RELEASE_VERSION }})\"\n exit 1\n fi\n\n - name: Build package\n run: poetry build\n\n - name: Create GitHub release\n uses: ncipollo/release-action@v1\n with:\n tag: ${{ env.RELEASE_VERSION }}\n generateReleaseNotes: true\n artifacts: \"dist/*\"\n token: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Publish to PyPI\n uses: nick-fields/retry@v4\n with:\n timeout_minutes: 5\n max_attempts: 3\n retry_wait_seconds: 30\n command: |\n poetry config pypi-token.pypi \"${{ secrets.PYPI_API_KEY }}\"\n poetry publish\n\n - name: Create workflow summary\n if: always()\n run: |\n echo \"## Release Summary\" >> $GITHUB_STEP_SUMMARY\n echo \"- **Version**: ${{ env.RELEASE_VERSION }}\" >> $GITHUB_STEP_SUMMARY\n echo \"- **Status**: ${{ job.status }}\" >> $GITHUB_STEP_SUMMARY\n if [ \"${{ job.status }}\" == \"success\" ]; then\n echo \"- **PyPI**: https://pypi.org/project/uk-bin-collection/${{ env.RELEASE_VERSION }}/\" >> $GITHUB_STEP_SUMMARY\n echo \"- **GitHub Release**: https://github.com/${{ github.repository }}/releases/tag/${{ env.RELEASE_VERSION }}\" >> $GITHUB_STEP_SUMMARY\n echo \"\" >> $GITHUB_STEP_SUMMARY\n echo \"✅ Release published successfully!\" >> $GITHUB_STEP_SUMMARY\n else\n echo \"\" >> $GITHUB_STEP_SUMMARY\n echo \"❌ Release failed - check logs above\" >> $GITHUB_STEP_SUMMARY\n fi\n\n docker:\n needs: release\n runs-on: ubuntu-latest\n steps:\n - name: Checkout\n uses: actions/checkout@v6\n\n - name: Login to Docker Hub\n uses: docker/login-action@v4\n with:\n username: ${{ secrets.DOCKER_USERNAME }}\n password: ${{ secrets.DOCKER_API_KEY }}\n\n - name: Build and push Docker image\n uses: docker/build-push-action@v7\n with:\n context: ./uk_bin_collection_api_server\n push: true\n tags: |\n robbrad182/uk-bin-collection:${{ github.ref_name }}\n robbrad182/uk-bin-collection:latest\n" }, { "path": ".github/workflows/rollback-release.yml", "content": "name: Release - Rollback\n\non:\n workflow_dispatch:\n inputs:\n version:\n description: 'Version to rollback (e.g., 0.155.0)'\n required: true\n type: string\n delete_pypi:\n description: 'Also yank from PyPI? (cannot delete, only yank)'\n required: false\n type: boolean\n default: false\n\njobs:\n rollback:\n runs-on: ubuntu-latest\n permissions:\n contents: write\n steps:\n - name: Checkout\n uses: actions/checkout@v6\n with:\n fetch-depth: 0\n ssh-key: ${{ secrets.DEPLOY_KEY }}\n\n - name: Validate version format\n run: |\n if ! [[ \"${{ inputs.version }}\" =~ ^[0-9]+\\.[0-9]+\\.[0-9]+$ ]]; then\n echo \"❌ Invalid version format. Use X.Y.Z (e.g., 0.155.0)\"\n exit 1\n fi\n echo \"✅ Version format valid: ${{ inputs.version }}\"\n\n - name: Check if release exists\n id: check\n run: |\n if gh release view ${{ inputs.version }} > /dev/null 2>&1; then\n echo \"exists=true\" >> $GITHUB_OUTPUT\n echo \"✅ Release ${{ inputs.version }} exists\"\n else\n echo \"exists=false\" >> $GITHUB_OUTPUT\n echo \"⚠️ Release ${{ inputs.version }} not found\"\n fi\n env:\n GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Delete GitHub Release\n if: steps.check.outputs.exists == 'true'\n run: |\n echo \"🗑️ Deleting GitHub release ${{ inputs.version }}...\"\n gh release delete ${{ inputs.version }} --yes\n echo \"✅ GitHub release deleted\"\n env:\n GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Delete Git Tag\n run: |\n if git rev-parse ${{ inputs.version }} >/dev/null 2>&1; then\n echo \"🗑️ Deleting git tag ${{ inputs.version }}...\"\n git push origin :refs/tags/${{ inputs.version }}\n echo \"✅ Git tag deleted\"\n else\n echo \"⚠️ Tag ${{ inputs.version }} not found locally\"\n fi\n\n - name: Setup Python (if PyPI yank requested)\n if: inputs.delete_pypi == true\n uses: actions/setup-python@v6\n with:\n python-version: '3.12'\n\n - name: Install Poetry (if PyPI yank requested)\n if: inputs.delete_pypi == true\n uses: abatilo/actions-poetry@v4.0.0\n with:\n poetry-version: '1.8.4'\n\n - name: Yank from PyPI\n if: inputs.delete_pypi == true\n run: |\n echo \"⚠️ Yanking version ${{ inputs.version }} from PyPI...\"\n echo \"Note: This marks the release as unsuitable for installation but doesn't delete it\"\n poetry config pypi-token.pypi \"${{ secrets.PYPI_API_KEY }}\"\n # PyPI doesn't support yanking via poetry directly, need to use twine\n pip install twine\n # Note: You'll need to manually yank via PyPI web interface or use:\n # twine upload --repository pypi --skip-existing dist/*\n echo \"⚠️ PyPI yanking must be done manually at: https://pypi.org/manage/project/uk-bin-collection/releases/\"\n echo \"Go to the release and click 'Options' -> 'Yank release'\"\n\n - name: Create workflow summary\n if: always()\n run: |\n echo \"## Rollback Summary\" >> $GITHUB_STEP_SUMMARY\n echo \"- **Version**: ${{ inputs.version }}\" >> $GITHUB_STEP_SUMMARY\n echo \"- **GitHub Release**: ${{ steps.check.outputs.exists == 'true' && '✅ Deleted' || '⚠️ Not found' }}\" >> $GITHUB_STEP_SUMMARY\n echo \"- **Git Tag**: Deleted from remote\" >> $GITHUB_STEP_SUMMARY\n if [ \"${{ inputs.delete_pypi }}\" == \"true\" ]; then\n echo \"- **PyPI**: ⚠️ Manual yank required\" >> $GITHUB_STEP_SUMMARY\n echo \"\" >> $GITHUB_STEP_SUMMARY\n echo \"### Next Steps for PyPI\" >> $GITHUB_STEP_SUMMARY\n echo \"1. Go to https://pypi.org/manage/project/uk-bin-collection/releases/\" >> $GITHUB_STEP_SUMMARY\n echo \"2. Find version ${{ inputs.version }}\" >> $GITHUB_STEP_SUMMARY\n echo \"3. Click 'Options' -> 'Yank release'\" >> $GITHUB_STEP_SUMMARY\n fi\n echo \"\" >> $GITHUB_STEP_SUMMARY\n echo \"### ⚠️ Important Notes\" >> $GITHUB_STEP_SUMMARY\n echo \"- The version bump commit still exists in git history\" >> $GITHUB_STEP_SUMMARY\n echo \"- To fully rollback, you may need to revert the bump commit\" >> $GITHUB_STEP_SUMMARY\n echo \"- Users who already installed this version will keep it\" >> $GITHUB_STEP_SUMMARY\n\n - name: Notify completion\n run: |\n echo \"✅ Rollback completed for version ${{ inputs.version }}\"\n echo \"Check the summary tab for details\"\n" }, { "path": ".github/workflows/validate-release-ready.yml", "content": "name: PR - Validate Release Ready\n\non:\n workflow_dispatch:\n pull_request:\n branches: [ \"master\" ]\n types: [opened, synchronize, reopened]\n\njobs:\n validate:\n name: Validate Release Prerequisites\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n with:\n fetch-depth: 0\n\n - uses: actions/setup-python@v6\n with:\n python-version: '3.12'\n cache: 'pip'\n\n - name: Cache Poetry\n uses: actions/cache@v5\n with:\n path: ~/.local/pipx\n key: ${{ runner.os }}-pipx-poetry-1.8.4\n restore-keys: |\n ${{ runner.os }}-pipx-poetry-\n\n - name: Install Poetry\n run: pipx install poetry==1.8.4\n\n - name: Validate pyproject.toml\n run: poetry check\n\n - name: Check for conventional commits\n uses: wagoid/commitlint-github-action@v6\n with:\n configFile: commitlint.config.mjs\n" }, { "path": ".github/workflows/wiki.yml", "content": "name: Deploy - Wiki\n\non:\n push:\n # Trigger only when wiki directory changes\n paths:\n - \"wiki/**\"\n - \"uk_bin_collection/tests/input.json\"\n branches: [ \"master\" ]\n pull_request:\n # Trigger only when wiki directory changes\n paths:\n - \"wiki/**\"\n - \"uk_bin_collection/tests/input.json\"\n # The branches below must be a subset of the branches above\n branches: [ \"master\" ]\n\njobs:\n deploy-wiki:\n # Only run on main branch push (e.g. after pull request merge).\n if: github.event_name == 'push'\n runs-on: ubuntu-latest\n environment: wiki\n steps:\n - uses: actions/checkout@v6\n - uses: actions/setup-python@v6\n with:\n python-version: '3.12'\n\n - name: Run image\n uses: abatilo/actions-poetry@v4.0.0\n with:\n poetry-version: '1.8.4'\n\n - name: Install\n run: make install\n\n - name: Update Councils.md from input.json\n run: make update-wiki\n\n - name: Commit and Push Wiki changes\n run: |\n git config --global user.name \"Wiki GitHub Action\"\n git config --global user.email \"action@github.com\"\n git add wiki\n git commit -m \"docs: Update Councils.md from input.json\"\n git push\n continue-on-error: true\n\n - name: Deploy Wiki Changes\n uses: Andrew-Chen-Wang/github-wiki-action@v5\n with:\n # Make sure WIKI_DIR ends with / as action uses rsync\n path: wiki/\n ignore: \"generate_wiki.py\"\n" }, { "path": ".gitignore", "content": "# Ignore everything\r\n*\r\n\r\n# But not these files...\r\n!*.json\r\n!*.py\r\n!PipFile\r\n!Pipfile.lock\r\n!.gitignore\r\n!.dockerignore\r\n!*.toml\r\n!*.md\r\n!*.rst\r\n!LICENSE\r\n!*.schema\r\n!Makefile\r\n!dependabot.yaml\r\n!poetry.lock\r\n!behave.ini\r\n!*.Dockerfile\r\n!docker-compose.yml\r\n!.vscode/launch.json\r\n!pytest.ini\r\n\r\n# Or these folders...\r\n!docs\r\n!.github\r\n!*.png\r\n!.github/ISSUE_TEMPLATE\r\n!.github/ISSUE_TEMPLATE/*.yaml\r\n!.github/workflows\r\n!.github/workflows/*.yml\r\n!uk_bin_collection\r\n!uk_bin_collection/**/*\r\n!uk_bin_collection_api_server\r\n!uk_bin_collection_api_server/**/*\r\n!wiki\r\n!wiki/**/*\r\n!custom_components\r\n!custom_components/**/*/\r\n!custom_components/uk_bin_collection/services.yaml\r\n__pycache__\r\n!TO_BE_CONVERTED\r\n!.devcontainer\r\nuk_bin_collection/.DS_Store\r\nuk_bin_collection/uk_bin_collection/.DS_Store\r\n!scripts\r\n!.kiro\r\nISSUE_RESOLUTION_PROGRESS.md\r\n" }, { "path": "CHANGELOG.md", "content": "=======\n## 0.165.0 (2026-03-28)\n\n### Feat\n\n- Lancaster City - support food waste collection (#1895)\n- support lancaster city food waste collection\n- North Northamptonshire - add food caddy bin type support (#1894)\n- add support for food caddy bin type in North Northamptonshire Council scraper\n\n### Fix\n\n- expose errors in lancaster city date parsing\n- correct casing for food caddy bin type in North Northamptonshire Council scraper\n- Herefordshire Council - incorrectly picking up non-date string (#1888)\n- Herefordshire Council incorrectly picking up non-date string\n- EalingCouncil/LondonBoroughEaling - use collectionDate not collectionDateString (#1886)\n- EalingCouncil/LondonBoroughEaling: Use collectionDate not collectionDateString\n\n### Refactor\n\n- ChorleyCouncil - use requests instead of Selenium (#1891)\n\n## 0.164.0 (2026-03-14)\n\n### Feat\n\n- NewhamCouncil - add food waste collection scraping\n\n### Fix\n\n- update address selection XPath for BroxbourneCouncil\n- nuneaton and bedworth\n- nuneaton and bedworth\n- NewhamCouncil - correct datetime parsing from DD/MM/YYYY to MM/DD/YYYY\n- NewhamCouncil - disable SSL verification to resolve certificate verification errors\n- updated ID's for multiple elements that had changed\n- Broxtowe Borough Council\n- #1872 - Broxtowe Borough Council\n- Adding North Warwickshire Borough Council\n- #1869 - Adding North Warwickshire Borough Council\n- Bath and North East Somerset\n- #1876 - Bath and North East Somerset\n- Hinckley & Bosworth Council\n- #1879 - Hinckley & Bosworth Council\n- Midlothian Council\n- #1880 Midlothian Council\n- Merton Council\n- #1868 - Merton Council\n- Eastleigh Borough Council\n- #1867 - Eastleigh Borough Council\n- London Borough Havering\n- #1863 - London Borough Havering\n- Leeds City Council\n- #1864 - Leeds City Council\n- North East Derbyshire District Council\n- #1861 - North East Derbyshire District Council\n- Cumberland Council\n- #1858 - Cumberland Council\n- Barking & Dagenham\n- #1855 - Barking & Dagenham\n- Redcar and Cleveland Council\n- #1848 - Redcar and Cleveland Council\n- Wakefield City Council\n- #1853 - Wakefield City Council\n- Bromley Borough Council\n- #1851 Bromley Borough Council\n- Mid Suffolk District Council\n- #1845 - Mid Suffolk District Council\n- Powys Council\n- #1846 - Powys Council\n- LondonBoroughHammersmithandFulham\n- LondonBoroughHammersmithandFulham\n- HarboroughDistrictCouncil\n- HarboroughDistrictCouncil\n- Adding Hammersmith & Fulham\n- #1504 - Adding Hammersmith & Fulham\n- Harborough District Council\n- #1831 - Harborough District Council\n- London Borough Redbridge\n- #1836 - fix: London Borough Redbridge\n\n## 0.163.0 (2026-02-02)\n\n### Feat\n\n- #1686 GosportBoroughCouncil - Add new council using Supatrak API\n- #1593 #1618 #1794 - Add Causeway Coast and Glens, Rossendale Borough, North Warwickshire to GooglePublicCalendarCouncil\n\n### Fix\n\n- #1831 HarboroughDistrictCouncil - use data instead of json, suppress SSL warnings, improve parsing\n- #1831 HarboroughDistrictCouncil - add SSL bypass and better error handling for 502 errors\n- #1836 LondonBoroughRedbridge - updated selectors for redesigned website\n\n## 0.162.7 (2026-02-02)\n\n### Fix\n\n- resolve issues #1776, #1780, #1782 - Camden, NE Derbyshire, Newport\n- Broken councils\n- remove URLs from translation strings for HACS compliance\n- **CumberlandCouncil**: remove obsolete duplicate entries\n- **AmberValleyBoroughCouncil**: filter invalid date 01/01/0001\n- Kingston parser for HTML format change with explicit error handling\n- Kingston-upon-Thames website HTML format change\n- UttlesfordDistrictCouncil use color names for bin types\n- EastHertsCouncil handle empty NextDate values\n- UttlesfordDistrictCouncil incorrect bin types due to wrong alt text\n- compare dates without time component in UttlesfordDistrictCouncil\n- UttlesfordDistrictCouncil hardcoded year 2024\n- Wyre Forest District Council\n- #1835 - Wyre Forest District Council\n- Babergh District Council\n- #1783 - Babergh District Council\n- Mid Suffolk District Council\n- #1746 - Mid Suffolk District Council\n- Waverley Borough Council\n- #1834 - Waverley Borough Council\n- London Borough Sutton\n- #1830 - London Borough Sutton\n- Bolton Council\n- #1792 - Bolton Council\n- Coventry City Council\n- #1808 - Coventry City Council\n- Slough Borough Council\n- #1822 - Slough Borough Council\n- Bromley Borough Council\n- #1829 - Bromley Borough Council\n- Burnley Borough Council\n- #1820 - Burnley Borough Council\n\n### Refactor\n\n- add explicit datetime import in UttlesfordDistrictCouncil\n\n## 0.162.6 (2026-01-14)\n\n### Fix\n\n- FolkestoneandHytheDistrictCouncil.py\n- CastlepointDistrictCouncil\n- Folkestone and Hythe District Council\n- Castlepoint District Council\n- #1803 #1793 Castlepoint District Council\n- Folkstone and Hythe District Council\n- #1760 - Folkstone and Hythe District Council\n- Newark and Sherwood District Council\n- #1777 - fix: Newark and Sherwood District Council\n- South Lanarkshire Council\n- #1771 - South Lanarkshire Council\n- Renfrewshire Council\n- #1500 - Renfrewshire Council\n\n## 0.162.5 (2025-12-08)\n\n### Fix\n\n- West Oxfordshire\n- West Oxfordshire\n- Adur & Worthing (#1454), Hillingdon (#1680)\n\n## 0.162.4 (2025-12-08)\n\n### Fix\n\n- Cumberland Council\n\n## 0.162.3 (2025-12-08)\n\n### Fix\n\n- Islington, Worcester\n\n## 0.162.2 (2025-12-07)\n\n### Fix\n\n- Broken councils\n\n## 0.162.1 (2025-12-07)\n\n## 0.162.0 (2025-12-07)\n\n### Feat\n\n- Add support for Isle of Anglesey County Council\n- replace Selenium with Cloud9 mobile API for NHDC bin collection data\n- Adding Harlow Council\n- #1639 Adding Harlow Council\n- Adding Blackpool Council\n- #1640 Adding Blackpool Council\n\n### Fix\n\n- add User-Agent header to KingsLynnandWestNorfolkBC scraper\n- **southgloucestershirecouncil**: check none instead of empty string\n- Treat missing response data as an error to prevent silent failure\n- address latest CodeRabbit feedback\n- address CodeRabbit feedback\n- Fix input.json data\n- fix UPRN param encoding for SouthamptonCityCouncil\n- Replace loop variable for clarity in North Hertfordshire parsing logic\n- Let requests handle query param encoding\n- Address edge case in address splitting\n- Handle edge case for date parsing validation\n- Don't bail on invalid date format\n- Add comment explaining where auth header came from\n- Improve error handling for mobile API requests and JSON parsing\n- Use constant for mobile API container count\n- Improve error handling for mobile API JSON response\n- Use named imports from common\n- Add sorting key for bin collections using parsed datetime\n- Improve error handling for collection date parsing\n- Use `line.strip()` in list comp\n- Update comment to match behaviour\n- Amend list comprehension variable name to avoid shadowing\n- Remove unused variable assignment\n- Perform postcode/paon string manipulation after checking truthiness\n- WiltshireCouncil.py\n- Rushmoor Council\n- #1724 - Rushmoor Council\n- Wiltshire Council\n- #1689 - Wiltshire Council\n- Halton Borough Council\n- #1209 Halton Borough Council\n- Northumberland Council\n- #1711 - Northumberland Council - Requires 12 digit UPRN\n- South Lanarkshire Council\n- #1712 - South Lanarkshire Council\n- Argyll and Bute Council\n- #1718 - Argyll and Bute Council\n- Thurrock Council\n- #1720 - Thurrock Council\n- Mid Sussex\n- #1721 Mid Sussex\n- Chelmsford City Council\n- #1707\n- #1706 - London Borough of Lambeth\n- #1706 - London Borough of Lambeth\n- Fife Council\n- Armagh Banbridge Craigavon Council\n- #1622\n\n### Refactor\n\n- Adjust return payload aggregation logic\n\n## 0.161.0 (2025-11-08)\n\n### Feat\n\n- Dumfries and Galloway Council\n\n### Fix\n\n- Herefordshire Council\n- Herefordshire Council\n- Southampton City Council\n- #1698\n- Newport City Council\n- #1229\n- Middlesborough Council\n- #1382 - Removed the need for Selenium\n- Boston Borough Council\n- #1690\n- Chelmsford City Council\n- #1688 - BREAKING CHANGE\n- Derby City Council\n- #1676\n- London Borough of Hounslow\n- #1683\n- Brighton & Hove\n- #1685 - New URL\n- Brighton & Hove\n- #1685 - New URL\n- Hart District Council\n- #1625\n- London Borough of Harrow\n- #1621\n- Wokingham Borough Council\n- #1641\n- Norwich City Council\n- #1653\n- Rochdale Council\n- #1675\nfix: #1259\n- **tendring**: ignore stale 'Next collection' dates older than today\n- **tendring**: restore headless=True default and silence unused lambda arg for lint\n- **tendring**: use 'Next collection' column; fix imports/strings/waits; robust iframe/cookie handling\n- **tendring**: read 'Next collection' column; harden cookie/iframe handling; normalise dd/MM/YYYY\n\n## 0.160.1 (2025-10-21)\n\n### Fix\n\n- test valley wrong dates\n- Remove merge conflict\n- remove merge conflict\n- remove merge conflict message\n\n## 0.160.0 (2025-10-21)\n\n### Feat\n\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n- adding tests to ensure releases work with Home assistant\n\n## 0.159.3 (2025-10-20)\n\n### Fix\n\n- Broken dependancies\n\n## 0.159.2 (2025-10-19)\n\n### Fix\n\n- allow pillow 11.x to fix home assistant compatibility\n\n## 0.159.1 (2025-10-18)\n\n### Fix\n\n- Add null checks to prevent AttributeError when collection date text is not found. Introduces extract_collection_date() helper that safely extracts dates and returns None if parsing fails, allowing the scraper to gracefully skip missing collection types.\n\n## 0.159.0 (2025-10-18)\n\n### Feat\n\n- Modernize South Kesteven scraper with requests-based approach and OCR\n\n### Fix\n\n- **feedbank**: address improvements suggested in PR review\n- Update NorthTynesideCouncil to reflect changes to website and extract schedule from the UPRN linked page\n\n## 0.158.1 (2025-10-18)\n\n### Fix\n\n- remove merge conflict annotations and delete old code\n- click on the submit button instead of sending ENTER\n\n## 0.158.0 (2025-10-11)\n\n### Feat\n\n- workflow overhaul\n- workflow overhaul\n\n## 0.157.0 (2025-10-11)\n\n### Feat\n\n- Create tag-on-merge.yml\n- Update bump.yml\n- fix bump.yml\n- Update TorbayCouncil.py\n- Update bump.yml\n- fix release pipeline bump.yml\n- fix Torbay\n\n### Fix\n\n- Update AberdeenCityCouncil.py\n- Update TorbayCouncil.py\n- Update TorbayCouncil.py\n- Update TorbayCouncil.py\n- Update URL for NewForestCouncil\n- New URL and page for wheelie bins\n- improve Mid Suffolk District Council holiday handling with dynamic bank holiday detection\n- Oxford now rejects the \"Requests\" default user agent\n- #1557 - Adding East Dunbartonshire\n- #1557 - Adding East Dunbartonshire\n- #1569 - Somerset Council\n- #1569 - Somerset Council\n- #1559 - Newport City Council\n- #1559 - Newport City Council\n- #1574 - Test Valley Borough Council\n- #1574 - Test Valley Borough Council\n- #1566 South Gloucestershire Council\n\n## 0.154.0 (2025-09-21)\n\n### Feat\n\n- handle changes to northumberland council website\n- modify input for NorthumberlandCouncil to accept uprn instead of house number, and use new page structure\n\n### Fix\n\n- the cookie banner is not optional\n- #1570 - Slough Borough Council\n- #1570 - Slough Borough Council\n- #1520 - Erewash Borough Council\n- #1520 - Erewash Borough Council\n- #1554 - Folkestone and Hythe District Council\n- #1554 - Folkestone and Hythe District Council\n- #1604 - West Berkshire Council\n- #1604 - West Berkshire Council\n- #1606 - Brighton and Hove City Council\n- #1606 - Brighton and Hove City Council\n- #1565 - BCP Council\n- #1565 - BCP Council\n- #1571 - Castle Point District Council\n- #1571 - Castle Point District Council\n- #1584 - NorthHertfordshireDistrictCouncil\n- #1584 - NorthHertfordshireDistrictCouncil\n- #1599\n- #1599 - Basingstoke Council\n- #1587\n- #1587 - Hartlepool Borough Council\n- #1588\n- #1588 Glasgow City Council\n- #1591\n- #1591 Rushmoor Council\n\n## 0.153.0 (2025-09-02)\n\n### Feat\n\n- Change buckinghamshire council to get data from endpoint\n\n### Fix\n\n- 1573 Update Bolton council URL\n- East Herts Council\n- #1575\n- Runnymede Borough Council\n- #1513\n- Wiltshire Council\n- #1533\n- Staffordshire Moorlands District Council\n- #1535\n- Ipswich Borough Council\n- #1548\n- North East Lincs\n- Hinckley and Bosworth Borough Council\n- Nuneaton Bedworth Borough Council\n- #1514\n- Lichfield District Council\n- 1549\n\n## 0.152.11 (2025-08-25)\n\n### Feat\n\n- fix releases process\n\n### Fix\n\n- date extraction in RochfordCouncil data parsing\n- parsing error in BH selenium\n- **hacs**: respect the headless option\n\n### Refactor\n\n- **hacs**: improve build_ukbcd_args with formatter functions\n\n## 0.152.10 (2025-08-04)\n\n### Fix\n\n- Gateshead and East Lothian\n- Enfield and Broxbourne\n- East Herts\n- FermanaghOmaghDistrictCouncil\n- Enfield and Broxbourne\n- East Herts\n\n## 0.152.9 (2025-08-03)\n\n### Fix\n\n- Cotswald and coventry\n- Fixing multiple broken councils\n- multiple broken councils\n\n## 0.152.8 (2025-07-26)\n\n### Fix\n\n- Add headers to request for Swindon Borough Council\n- Add headers to requests for Royal Borough of Greenwich Fixes #1496 by ensuring that the requests are not rejected due to lack of headers.\n- **MidlothianCouncil**: add request headers to resolve 403 Forbidden\n\n## 0.152.7 (2025-07-01)\n\n### Fix\n\n- maidstone selenium fix\n\n## 0.152.6 (2025-06-18)\n\n### Fix\n\n- removed In Progress from date\n- removed a degub print statement\n- **RugbyBoroughCouncil**: Amended parsed date from full to abbreviated month date, may worked but jun and jul did not\n- **RugbyBoroughCouncil**: Amended parsed date\n- Reworked Cumberland Council to cater for postcode addition\n- **OxfordCityCouncil**: Fixed Oxford City Council parsing dues to changes in output from the website\n\n## 0.152.5 (2025-06-07)\n\n### Fix\n\n- South Ribble and version pinning issues for input.json\n\n## 0.152.4 (2025-06-07)\n\n### Fix\n\n- **SouthRibble**: Corrected Date formatting issue\n- **SouthRibble**: Resolved South Ribble without selenium\n\n## 0.152.3 (2025-06-04)\n\n### Fix\n\n- NorthHertfordshire selenium script\n- Adur council\n- Eastleigh date fix\n- removed duplicates in BradfordMDC\n\n## 0.152.2 (2025-06-04)\n\n### Fix\n\n- Update Makefile\n- Update CheshireEastCouncil.py\n- Github action to handle branch name with parentheses\n\n## 0.152.1 (2025-05-15)\n\n### Fix\n\n- Update to fix North Somerset\n- Glasgow SSL bypass\n- more robust Northumberland\n- updated Eastleigh input.json\n- Eastleigh cloudflare fix\n- converted collection datetimes into dates for BH parsing.\n- Eastleigh cloudflare fix\n- Eastleigh cloudflare fix\n- added check_uprn to simplified councils\n- simplified Swindon\n- simplified East Devon\n- simplified Dover\n- Simplified Dartford\n- simplified Cheshire East\n- simplified Charnwood input.json\n- improved Charnwood\n- Adur Worthing fix\n- Chorley simplification\n- Bexley simplification\n- added URL to Torbay script\n- Guildford fixes\n- reworked Maidstone\n- maidstone input.json\n- Croydon selenium version\n- Stoke date-time fix\n\n## 0.152.0 (2025-05-02)\n\n### Feat\n\n- Added Fermanagh Omagh\n- Added Twekesbury\n- added Slough council\n- Added Argus Council\n- added Angus to input.json\n\n### Fix\n\n- Chichester now only requires postcode and house number\n- Broadland now only requires postcode and house number\n- Barking now only requires postcode and house number\n- Brighton now only requires postcode and house number\n- ensured all bins for this council\n- added skip_get_url to hyndburn\n\n## 0.151.0 (2025-04-27)\n\n### Feat\n\n- version bump\n\n### Fix\n\n- more robust brent date handling\n- input.json requires web_driver\n- Rugby fix\n\n## 0.150.0 (2025-04-27)\n\n### Feat\n\n- added melton\n- added pembrokeshire\n\n### Fix\n\n- added melton\n- processed all bins for Moray\n\n## 0.148.6 (2025-04-27)\n\n## 0.148.5 (2025-04-27)\n\n### Fix\n\n- output check\n- parsed bin info\n- selenium navigation\n- input.json changes\n\n## 0.148.4 (2025-04-27)\n\n### Fix\n\n- used canonical 'nice name'\n\n## 0.148.3 (2025-04-25)\n\n### Fix\n\n- working hyndburn\n- hyndburn input.json\n\n## 0.148.2 (2025-04-24)\n\n### Fix\n\n- Update docker-compose.yml\n- updated input.json\n- cloudflare fix - switch to selenium method\n- simplified blackburn\n\n## 0.148.1 (2025-04-22)\n\n### Fix\n\n- added bank holiday offsets.\n- added bank holiday offsets.\n\n## 0.148.0 (2025-04-19)\n\n### Feat\n\n- adding Wrexham and #1046 Horsham councils\n\n### Fix\n\n- Argyll and Bute council #1053\n\n## 0.147.2 (2025-04-18)\n\n### Fix\n\n- wait for element to be clickable\n\n## 0.147.1 (2025-04-18)\n\n### Fix\n\n- #1351 - moved geopandas to petry dev\n\n## 0.147.0 (2025-04-18)\n\n### Feat\n\n- add council tests results map\n\n## 0.146.2 (2025-04-18)\n\n### Fix\n\n- adding map checking and matching\n\n## 0.146.1 (2025-04-18)\n\n### Fix\n\n- more robust bank holiday handling\n\n## 0.146.0 (2025-04-18)\n\n### Feat\n\n- #1342 Adding Includes Trafford, Clackmannanshire, Havant, North Warwickshire, Newry Mourne and Down, East Dunbartonshire, Pendle, Torfaen, East Hampshire, Ribble Valley, Brentwood, Isle of Wight, Westmorland and Furness, Derry and Strabane, and Norwich. Google Cal support for PDF councils via ICS file\n\n### Fix\n\n- Black reformatting\n\n## 0.145.0 (2025-04-18)\n\n### Feat\n\n- Adding PDF councils\n\n## 0.144.4 (2025-04-18)\n\n### Fix\n\n- Bristol #1275\n\n## 0.144.3 (2025-04-17)\n\n### Fix\n\n- better address for input.json\n- bank holiday overrides\n- more robust address searching\n- simple parsing done\n- Selenium navigation\n\n## 0.144.2 (2025-04-17)\n\n### Fix\n\n- knowsley\n- knowsley\n- knowsley\n- knowsley\n- KnowsleyMBCouncil.py\n- #1220 adding Mid Ulster District Council\n\n## 0.144.1 (2025-04-17)\n\n### Fix\n\n- fix Sandwell garden waste collection date\n\n## 0.144.0 (2025-04-17)\n\n### Feat\n\n- added great yarmouth\n\n## 0.143.6 (2025-04-17)\n\n### Fix\n\n- Renfrewshire Council\n\n## 0.143.5 (2025-04-17)\n\n### Fix\n\n- Google Cal\n\n## 0.143.4 (2025-04-17)\n\n### Fix\n\n- Google Cal\n\n## 0.143.3 (2025-04-15)\n\n### Fix\n\n- #1301 Fix Leeds Council\n\n## 0.143.2 (2025-04-15)\n\n### Fix\n\n- #1301 Fix Leeds Council\n\n## 0.143.1 (2025-04-15)\n\n### Fix\n\n- Set the bin_type when different day\n\n## 0.143.0 (2025-04-13)\n\n### Fix\n\n- corrected url in input.json\n- fixed input.json\n- parsed Barking Dagenham collection information\n- selenium navigation Barking\n\n## 0.142.0 (2025-04-13)\n\n### Feat\n\n- Added Stirling Council\n\n### Fix\n\n- typo in input.json\n\n## 0.141.4 (2025-04-13)\n\n### Fix\n\n- #1304 - sesnors goes to unknown if the data is blank from councils who are less reliable\n\n## 0.141.3 (2025-04-13)\n\n### Fix\n\n- Newham council\n\n## 0.141.2 (2025-04-13)\n\n### Fix\n\n- Newham council\n- Newham council\n\n## 0.141.1 (2025-04-12)\n\n### Fix\n\n- missing finally block on selenium tests\n\n## 0.141.0 (2025-04-12)\n\n### Feat\n\n- #1185 Adding PeterboroughCity Council\n\n## 0.140.0 (2025-04-11)\n\n### Feat\n\n- Added Broadland District Council\n\n### Fix\n\n- cleanup of council file\n- added Broadland to input.json\n\n## 0.139.0 (2025-04-07)\n\n### Feat\n\n- adding #1037\n- adding #1032 North Devon Count Council\n\n### Fix\n\n- #1296 Forest of dean\n- 939 adding South Holland District Council - Lincolnshire UK\n\n## 0.138.1 (2025-04-05)\n\n### Fix\n\n- Walhtam forest council - revert previous changes\n\n## 0.138.0 (2025-04-05)\n\n### Feat\n\n- Adding Hastings Borough Council\n- Adding Fylde Council\n\n### Fix\n\n- #1249\n- #1039\nfix: #1181\nfix: #1266\nfix: #1274\n- Gloucester City Council\n- #1282\n- Mid Devon Council\n- #1277\nfix: #1287\n- West Oxfordshire Council\n- #1290\n\n## 0.137.0 (2025-04-05)\n\n### Feat\n\n- #816 adding trafford council\n\n## 0.136.0 (2025-03-24)\n\n### Feat\n\n- Adding Southampton City Council\n- Adding Cambridge City Council\n- Adding Spelthorne Borough Council\n\n### Fix\n\n- #1057\n- #1264\n- #1270\n- Bexley Council\n- #1256\n- HinckleyandBosworthBoroughCouncil\n- #1207\n- Hackney Council\n- #1230\n- Castlepoint District Council\n- #1252\n- Canterbury City Council\n- #1254\n\n## 0.135.4 (2025-03-24)\n\n### Fix\n\n- parse scheduleCodeWorkflowIDs instead of scheduleCodeWorkflowID for Hackney Council\n\n## 0.135.3 (2025-02-23)\n\n## 0.135.2 (2025-02-19)\n\n### Fix\n\n- North Yorkshire - multiple bins on a day\n\n## 0.135.1 (2025-02-18)\n\n### Fix\n\n- devcontainer\n\n## 0.135.0 (2025-02-17)\n\n### Fix\n\n- #833 adding Middlesbrough and check script for Selenium\n- Cotswold District Council\n- #1238\n- Leeds City Council\n- #1222\n\n## 0.134.3 (2025-02-15)\n\n### Fix\n\n- Update input.json\n- 1235 Councils missing Selenium in input.json\n\n## 0.134.2 (2025-02-15)\n\n### Fix\n\n- 1232 East herts missing Selenium url in input.json\n- Derbyshire Dales District Council\n- Conwy County Borough\n- Sunderland City Council\n- #1219\n- Tendring District Council\n- #1221\n\n## 0.134.1 (2025-02-11)\n\n### Fix\n\n- Cheltenham Borough Council\n- #1061\n\n## 0.134.0 (2025-02-07)\n\n### Feat\n\n- Ipswich Borough Council - trying different address\n- Ipswich Borough Council - correcting param name in input.json\n- Ipswich Borough Council - added input.json values and refactored code\n- Ipswich Borough Council - initial implementation\n- Adding Runnymede Borough Council\n- Adding Cherwell District Council\n- Adding Epsom and Ewell Borough Council\n- Adding Redcar and Cleveland Council\n- Adding Amber Valley Borough Council\n- Adding Bolsover Council\n\n### Fix\n\n- #1214\n- #923\n- #895\n- #841\n- #903\n- #990\n- Torridge District Council\n- #1204\n- Neath Port Talbot\n- #1213\n\n## 0.133.0 (2025-02-02)\n\n### Feat\n\n- adding manual refresh\n\n## 0.132.0 (2025-02-02)\n\n### Feat\n\n- adding manual refresh\n\n## 0.131.0 (2025-02-02)\n\n### Feat\n\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding unit tests for the new manual refresh\n- adding manual refresh control\n\n## 0.130.1 (2025-01-30)\n\n### Fix\n\n- slow councils\n\n## 0.130.0 (2025-01-29)\n\n### Feat\n\n- Add Herefordshire Council (closes: #1011)\n\n### Fix\n\n- Fix spacing in wiki name\n\n## 0.129.0 (2025-01-29)\n\n### Fix\n\n- input.json\n- input.json\n\n## 0.128.6 (2025-01-29)\n\n### Fix\n\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n\n## 0.128.5 (2025-01-29)\n\n### Feat\n\n- Adding East Staffordshire Borough Council\n\n### Fix\n\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update CheshireEastCouncil.py\n- Adding East Lothian Council\n- #1171\n- #1052\nfix: #1083\n\n## 0.128.4 (2025-01-28)\n\n### Feat\n\n- Adding Boston Borough Council\n\n### Fix\n\n- Update CheshireEastCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update CheshireEastCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Leicester City Council\n- #1178\n- Cardiff Council\n- #1175\n- Newcastle City Council\n- #1179\n- #1180\n- Midlothian Council\n- #1192 - Adding Next Page support\n\n## 0.128.3 (2025-01-28)\n\n### Fix\n\n- Update CheshireEastCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n\n## 0.128.2 (2025-01-28)\n\n### Fix\n\n- Add communal recycling and communal rubbish\n- Add garden waste to Merton Council\n\n## 0.128.1 (2025-01-28)\n\n### Fix\n\n- Update AberdeenshireCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n\n## 0.128.0 (2025-01-28)\n\n### Feat\n\n- implement Medway Council (#1021)\n\n### Fix\n\n- Forgot to include skip_get_url\n\n## 0.127.4 (2025-01-25)\n\n### Fix\n\n- NewForestCouncil\n\n## 0.127.3 (2025-01-16)\n\n### Fix\n\n- Swale Borough Council\n- #1139\n- Vale of White Horse\n- #1156\n- South Oxfordshire Council\n- #1158\n- Surrey Heath Borough Council\n- #1164\n- Carmarthenshire County Council\n- #1167\n- Glasgow City Council\n- #1166\n\n## 0.127.2 (2025-01-13)\n\n### Fix\n\n- Update bin type to be the full string\n\n## 0.127.1 (2025-01-10)\n\n### Fix\n\n- Use visibility of list rather than existence\n- Update Rushcliffe Borough Council input elements and flow\n- Merton Council\n- NewarkAndSherwoodDC\n- Rushcliffe Borough Council\n- Powys Council\n- Staffordshire Moorlands District Council\n- Stroud District Council\n- Vale of Glamorgan Council\n- West Oxfordshire District Council\n\n## 0.127.0 (2025-01-07)\n\n### Feat\n\n- Adding Oadby And Wigston Borough Council\n- Add Gwynedd Council\n- Adding Denbighshire Council\n- Adding Dundee City Council\n- Adding Brent Council\n- Adding West Dunbartonshire Council\n- Adding Cumberland Council\n\n### Fix\n\n- #929\n- Cornwall Council\n- #1137\n- #1125\n- #1106\n- #1108\n- #1109\n- #1134\n- Northumberland Council\n- #1082\n- #1110\n- Waltham Forest\n- #1126\n- London Borough Sutton\n- #1131\n- Kirklees Council\n- #1129 - Breaking Change. UPRN required\n\n## 0.126.2 (2025-01-07)\n\n### Fix\n\n- **tests**: updates test case url for coventry city council\n- **tests**: removes duplicate key for coventry city council\n- updates coventry city council button text\n\n## 0.126.1 (2025-01-06)\n\n### Fix\n\n- behave_testing\n- behave_testing\n\n## 0.126.0 (2025-01-04)\n\n### Fix\n\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n\n## 0.125.2 (2025-01-04)\n\n### Fix\n\n- Update ArdsAndNorthDownCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update README.md to have links to Full and Partial Integration Test Reports\n- Update behave_pull_request.yml\n- Update README.md to have links to Full and Partial Integration Test Reports\n- Swale Borough Council\n- #1080\n(cherry picked from commit 6f580b39fb68b8079990221e050ae8dd6d2b7285)\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update ArdsAndNorthDownCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update README.md to have links to Full and Partial Integration Test Reports\n- Update WestLindseyDistrictCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_schedule.yml\n\n## 0.125.1 (2025-01-04)\n\n### Fix\n\n- correctly handle year increment for January dates\n\n## 0.125.0 (2025-01-04)\n\n### Feat\n\n- Adding Redditch Borough Council\n- Adding Blaenau Gwent County Borough Council\n- Adding Wandsworth Council\n\n### Fix\n\n- #1068\n- #1098\n- Wiltshire Council\n- #1094\n- Salford City Council\n- #1097\n- #1078\n- Merton Council\n- Swale Borough Council\n- #1080\n- London Borough Sutton\n- #1076\n- Update behave_schedule.yml\n- Update bump.yml\n\n## 0.124.4 (2025-01-04)\n\n### Fix\n\n- Update behave_schedule.yml\n\n## 0.124.3 (2025-01-04)\n\n### Fix\n\n- allure reporting\n- allure reporting\n- allure reporting\n\n## 0.124.2 (2025-01-03)\n\n### Fix\n\n- Update behave.yml\n\n## 0.124.1 (2025-01-03)\n\n### Fix\n\n- avoid crashing on unexpected string value\n\n## 0.124.0 (2025-01-02)\n\n### Feat\n\n- Hart District Council\n\n## 0.123.2 (2024-12-19)\n\n### Fix\n\n- Update behave.yml\n\n## 0.123.1 (2024-12-18)\n\n### Feat\n\n- #1063 - rewrite Kirklees Council parser for new website\n- #1067 - Add garden bin collections where available for Norwich City Council\n- Adding Wandsworth Council\n\n### Fix\n\n- Update AberdeenCityCouncil.py\n- Update behave.yml\n- #1101 - Fix table parsing for Walsall Council\n- Remove invalid escape sequence warnings from West Lindsey District Council\n- #1073 - change method of generating bin types to avoid manual mapping for Rugby Borough Council\n- add missing backticks to separate colour config and standard usage instructions\n- #1078\n(cherry picked from commit 89d93666bb659010d1c130b98c1d81c6ff80cf7c)\n- change date format to project default for Merton Council\n- correct date logic for Swale Borough Council\n- Merton Council\n- London Borough Sutton\n- #1076\n(cherry picked from commit 1eab20c9a57c9c4438ea343f374202bb2e9b98ca)\n- Swale Borough Council\n- #1080\n(cherry picked from commit 6f580b39fb68b8079990221e050ae8dd6d2b7285)\n- correct date/year logic for West Lindsey District Council\n- replace West Lindsey's input with working address\n- #1089 - Correct shifted dates in Bromley Borough Council\n- remove WDM import\n- #1087 - Food waste date incorrect for West Berkshire Council\n\n## 0.123.0 (2024-12-17)\n\n## 0.122.0 (2024-12-04)\n\n### Feat\n\n- Adding Monmouthshire County Council\n- Adding Hinckley and Bosworth Borough Council\n\n### Fix\n\n- Glasgow City Council\n- Merton Council\n- Blaby District Council\n- Warwick District Council\n- Blackburn Council\n- Carmarthenshire County Council\n- High Peak Council\n- CarmarthenshireCountyCouncil\n\n## 0.121.1 (2024-12-03)\n\n### Fix\n\n- London Borough of Lewisham to have more reliable parsing of dates\n\n## 0.121.0 (2024-11-24)\n\n### Feat\n\n- Royal Borough of Greenwich\n- Adding London Borough of Lewisham\n- Adding Hackney Council\n- Adding Sandwell Borough Council\n- Adding Moray Council\n- Adding Kings Lynn and West Norfolk Borough Council\n- Adding Wyre Forest District Council\n- Adding Folkstone and Hythe District Council\n- Adding Cheltenham Borough Council\n- Adding Thurrock Council\n\n### Fix\n\n- West Northamptonshire Council\n- East Ayrshire Council\n- Cotswold District Council\n\n## 0.120.0 (2024-11-20)\n\n### Feat\n\n- Adding Hartlepool Borough Council\n- Adding Newcastle Under Lyme Council\n- Adding London Borough of Havering\n- Add Garden collection to EnvironmentFirst\n- Adding Cumberland Council (Allerdale District)\n- Adding North Hertfordshire District Council\n\n### Fix\n\n- #844\n- #778\n- #769\n- #1025\n- Mid Siffolk and Babergh Garden Collection Day\n- #1026\nThis will require the use of a DAY to be added to the UPRN field\n- #1029\n- #1028\n\n## 0.119.0 (2024-11-20)\n\n### Feat\n\n- Adding Braintree District Council\n- Adding Burnley Borough Council\n- Adding Exeter City Council\n- Adding Edinburgh City Council\n\n### Fix\n\n- #699\n- #1015\n- #1017\n- #894\n\n## 0.118.0 (2024-11-15)\n\n### Feat\n\n- Adding Aberdeen City Council\n- Adding Wolverhampton City Council\n- Adding Stevenage Borough Council\n- Adding Thanet District Council\n- Adding Copeland Borough Council\n- Adding South Hams District Council\n\n### Fix\n\n- #1019\n- #966\n- #989\n- #1004\n- #1006\n- #1008\n- Rother District Council\n\n## 0.117.0 (2024-11-13)\n\n### Feat\n\n- Adding South Staffordshire District Council fix: #885\n- Adding Rother District Council\n\n### Fix\n\n- #1009\n\n## 0.116.0 (2024-11-12)\n\n### Feat\n\n- Adding Ashfield District Council\n- Adding Gravesham Borough Council\n- Adding Argyll and Bute Council\n\n### Fix\n\n- CrawleyBoroughCouncil\n- #1005\n- Adding Garden collection to Babergh and MidSuffolk Council\n- #995\n- #579\n- #991\n- #692\n- CheshireWestAndChesterCouncil\n- #993\n- Milton Keynes\n- #702\n- Adding Babergh and Mid Suffolk District Councils\n- #868\nfix: #919\n- Adding Derby City Council\n- #987\n\n## 0.115.0 (2024-11-11)\n\n### Feat\n\n- Adding Warrington Borough Council\n- Adding Antrim And Newtonabbey Council\n- Adding Hertsmere Borough Council\n- Adding West Lancashire Borough Council\n- Broxbourne Council\n\n### Fix\n\n- #695\n- #969\n- #776\n- #980\n- #982\n- Bradford MDC\n- #984\n\n## 0.114.6 (2024-11-09)\n\n### Fix\n\n- NBBC Date Fix\n\n## 0.114.5 (2024-11-08)\n\n### Fix\n\n- migration logging and debugging\n\n## 0.114.4 (2024-11-08)\n\n### Fix\n\n- migration not working\n- migration not working\n\n## 0.114.3 (2024-11-08)\n\n## 0.114.2 (2024-11-08)\n\n## 0.114.1 (2024-11-08)\n\n### Fix\n\n- Update manifest.json\n\n## 0.114.0 (2024-11-07)\n\n### Feat\n\n- Nuneaton and Bedworth Borough Council\n\n## 0.113.0 (2024-11-07)\n\n## 0.112.1 (2024-11-07)\n\n## 0.112.0 (2024-11-06)\n\n### Feat\n\n- adding calendar for Bins in Custom Component\n\n### Fix\n\n- fix manifest in custom component\n- #975 adding routine to handle migration error\n- #975 adding routine to handle migration error\n- #767 BREAKING CHANGE - READD your sensors / config\n\n## 0.111.0 (2024-11-06)\n\n### Fix\n\n- Add London Borough of Sutton\n- #944\n- Add Mid Devon Council\n- #945\n- Adding Oxford City Council\n- #962\n- Tunbridge Wells / Lincoln\n- #963\n- Glasgow City Council\n\n## 0.110.0 (2024-11-04)\n\n### Fix\n\n- Adding Blaby District Council\n- #904\n- Adding Sefton Council\n- #770\n- Adding Bromsgrove District Council\n- #893\n- East Lindsey District Council\n- #957\n- Adding Carmarthenshire County Council\n- #892\nfix: #710\n- Adding East Ayrshire Council\n- #955\n\n## 0.109.2 (2024-11-03)\n\n### Fix\n\n- CC testing and add Chesterfield\n\n## 0.109.1 (2024-11-03)\n\n### Fix\n\n- CC testing and add Chesterfield\n- CC testing and add Chesterfield\n\n## 0.109.0 (2024-11-02)\n\n### Feat\n\n- Adding Cotswold District Council\n- Adding Breckland Council\n\n### Fix\n\n- St Helens Borough Council\n- #753\n- NewarkAndSherwoodDC\n- #941\n- #658\n- #656\n\n## 0.108.2 (2024-11-01)\n\n### Fix\n\n- pytest-homeassistant-custom-component\n\n## 0.108.1 (2024-11-01)\n\n### Fix\n\n- Pydandic version\n- Pydandic version\n\n## 0.108.0 (2024-11-01)\n\n### Feat\n\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- pytest fixes\n\n## 0.107.0 (2024-10-31)\n\n### Feat\n\n- Adding Powys Council\n- Adding Worcester City Council\n- Adding Ards and North Down Council\n- Adding East Herts Council\n- Adding Ashford Borough Council\n\n### Fix\n\n- WestOxfordshireDistrictCouncil\n- South Norfolk Council\n- ForestOfDeanDistrictCouncil\n- Croydon Council\n- South Kesteven District Council\n- #647\n- #630\n- #623\n- #586\n- #578\n- #389\n\n## 0.106.0 (2024-10-28)\n\n### Feat\n\n- Adding Stockton On Tees Council\n- Adding Fife Council\n- Adding Flintshire County Council\n\n### Fix\n\n- #930\n- #933\n- #750\n\n## 0.105.1 (2024-10-24)\n\n### Fix\n\n- Refactor Midlothian Council scraper to use house number and postcode\n- West Berkshire Council\n- Southwark Council\n\n## 0.105.0 (2024-10-21)\n\n### Feat\n\n- Adding Teignbridge Council\n- Adding Harborough District Council\n- Adding Watford Borough Council\n- Adding Coventry City Council\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- Adding Powys Council\n- Adding Worcester City Council\n- Adding Ards and North Down Council\n- Adding East Herts Council\n- Adding Ashford Borough Council\n- Adding Stockton On Tees Council\n- Adding Fife Council\n- Adding Flintshire County Council\n- Adding Teignbridge Council\n- Adding Harborough District Council\n- Adding Watford Borough Council\n- Adding Coventry City Council\n- Python 3.12 only and CustomComp. Unit testing\n\n### Fix\n\n- #580\n- #888\n- #902\n- #607\n- CC testing and add Chesterfield\n- CC testing and add Chesterfield\n- CC testing and add Chesterfield\n- pytest-homeassistant-custom-component\n- Pydandic version\n- Pydandic version\n- WestOxfordshireDistrictCouncil\n- South Norfolk Council\n- ForestOfDeanDistrictCouncil\n- Croydon Council\n- South Kesteven District Council\n- #647\n- #630\n- #623\n- #586\n- #578\n- #389\n- #930\n- #933\n- #750\n- Refactor Midlothian Council scraper to use house number and postcode\n- West Berkshire Council\n- Southwark Council\n- #580\n- #888\n- #902\n- #607\n\n## 0.104.0 (2024-10-20)\n\n### Feat\n\n- Adding Luton Borough Council\n- Adding West Oxfordshire District Council\n- Adding Aberdeenshire Council\n- Adding Canterbury City Council\n- Adding Swindon Borough Council\n\n### Fix\n\n- #697\n- #694\n- #659\n- #590\n- #900\n\n## 0.103.0 (2024-10-20)\n\n### Feat\n\n- Adding RAW JSON Sensor\n\n### Fix\n\n- Black formatting\n- Black formatting\n\n## 0.102.0 (2024-10-20)\n\n### Feat\n\n- Moving from Attributes to Sensors\n- Moving from Attributes to Sensors\n\n## 0.101.0 (2024-10-20)\n\n### Feat\n\n- Add Midlothgian Council\n\n## 0.100.0 (2024-10-18)\n\n### Feat\n\n- Adding Dudley Council\n- Adding South Ribble Council\n- Plymouth Council\n- Adding Norwich City Council\n\n### Fix\n\n- #744\n- #671\n- #566\n- #749\n\n## 0.99.1 (2024-10-16)\n\n### Fix\n\n- #792 adding web_driver option to Wokingham Council\n\n## 0.99.0 (2024-10-16)\n\n### Feat\n\n- Adding Lincoln Council\n- Adding Tunbridge Wells Council\n- Adding Perth and Kinross Council\n\n### Fix\n\n- Update wiki\n- #748\n- #598\n- #572\n\n## 0.98.5 (2024-10-15)\n\n### Fix\n\n- Swale Borough Council\n- HaltonBoroughCouncil\n- Barnet Council\n- WestBerkshireCouncil\n\n## 0.98.4 (2024-10-14)\n\n### Fix\n\n- West Suffolk Council\n- Vale of White Horse Council\n- Uttlesford District Council\n- Neath Port Talbot Council\n- Merton Council\n- Manchester City Council\n- Glasgow City Council\n- BradfordMDC\n\n## 0.98.3 (2024-10-13)\n\n### Fix\n\n- EastRiding\n\n## 0.98.2 (2024-10-13)\n\n### Fix\n\n- MoleValley\n\n## 0.98.1 (2024-10-13)\n\n### Fix\n\n- Barnet and Bexley\n\n## 0.98.0 (2024-10-13)\n\n### Feat\n\n- Adding Wirral Council\n- Adding Lichfield District Council\n- Adding West Morland And Furness\n- Adding Walsall Council\n- Adding Armagh, Banbridge and Craigavon Council\n\n### Fix\n\n- #602\n- #830\n- #870\n- #873\n- #877\n\n## 0.97.1 (2024-10-10)\n\n### Fix\n\n- NottinghamCityCouncil\n- #875\n\n## 0.97.0 (2024-10-10)\n\n### Feat\n\n- Adding Falkirk Council\n\n### Fix\n\n- #761\n\n## 0.96.0 (2024-10-10)\n\n### Feat\n\n- Adding London Borough Harrow\n- Adding North Ayrshire Council\n- Adding Highland Council\n- Add Elmbridge Borough Council\n- Adding Southwark Council\n- South Derbyshire District Council\n\n### Fix\n\n- #871\n- #869\n- #780\n- #845\nfix: #754\n- #835\n- #842\n\n## 0.95.0 (2024-10-09)\n\n### Feat\n\n- Adding London Borough of Ealing\n\n## 0.94.0 (2024-10-09)\n\n### Feat\n\n- Adding London Borough of Lambeth\n- Adding Dacorum Borough Council\n\n### Fix\n\n- Dacorum Borough Council\n- East Devon DC\n\n## 0.93.0 (2024-10-08)\n\n### Feat\n\n- Update CheshireEastCouncil.py\n\n## 0.92.0 (2024-10-08)\n\n### Feat\n\n- Update CheshireEastCouncil.py\n- Update README.md\n- Adding Wokingham Borough Council\n- Adding Winchester City Council\n- Adding Basildon Council\n- Adding Colchester City Council\n\n### Fix\n\n- RochfordCouncil\n- Neath Port Talbot Council\n- Buckinghamshire Council\n- #639\nfix: #812\n\n## 0.91.2 (2024-10-05)\n\n### Fix\n\n- Windsor and Maidenhead Council\n\n## 0.91.1 (2024-10-04)\n\n## 0.91.0 (2024-10-03)\n\n## 0.90.0 (2024-10-03)\n\n### Feat\n\n- Adding East Renfrewshire Council\n\n### Fix\n\n- Update DorsetCouncil.py\n- #829\n- Update GatesheadCouncil.py\n- #822\n\n## 0.89.1 (2024-10-02)\n\n### Fix\n\n- High Peak have changed their cookie dialog Seems to be safe to ignore it now.\n\n## 0.89.0 (2024-09-27)\n\n### Feat\n\n- Update CheshireEastCouncil.py\n- Update README.md\n\n### Fix\n\n- release to be non pre release\n\n## 0.88.0 (2024-09-16)\n\n### Feat\n\n- Add Ealing Council\n\n### Fix\n\n- Update README.md\n\n## 0.87.0 (2024-09-10)\n\n### Feat\n\n- Add IslingtonCouncil\n\n### Fix\n\n- #565 Gloucester city council driver\n\n## 0.86.1 (2024-09-09)\n\n### Fix\n\n- #773 Wakefield\n\n## 0.86.0 (2024-09-06)\n\n### Feat\n\n- added Rotherham Council\n\n## 0.85.7 (2024-09-05)\n\n### Fix\n\n- more unit tests\n- more unit tests\n- Chorley\n\n## 0.85.6 (2024-09-03)\n\n### Fix\n\n- #795 and add reconfigure to custom comp.\n\n## 0.85.5 (2024-09-03)\n\n## 0.85.4 (2024-09-03)\n\n### Fix\n\n- #795 and add reconfigure to custom comp.\n- #795 Unit Test Coverage\n\n## 0.85.3 (2024-09-02)\n\n### Fix\n\n- #795 unit test coverage\n\n## 0.85.2 (2024-09-02)\n\n### Fix\n\n- 791 Glasgow URL change\n\n## 0.85.1 (2024-09-02)\n\n### Fix\n\n- 779 Add correct async wait to Home Assistant\n\n## 0.85.0 (2024-08-27)\n\n### Feat\n\n- support for enfield council\n\n## 0.84.2 (2024-08-27)\n\n### Fix\n\n- Re-work North Tyneside Council module for 2024 - some addresses do not have a garden collection\n- Re-work North Tyneside Council module for 2024\n\n## 0.84.1 (2024-08-08)\n\n### Fix\n\n- #771 Bolton bullet points on dates is now fixed\n\n## 0.84.0 (2024-07-31)\n\n## 0.83.0 (2024-07-07)\n\n### Feat\n\n- add has_numbers() function\n\n### Fix\n\n- update Gedling Borough Council parser to use alternative name key\n- change Gedling to use new JSON data\n- update instructions for Gedling\n- update input.json to use UPRN parameter\n- change DorsetCouncil.py to use API links provided in #756\n- explicit import of logging.config to stop error in Python 3.11\n\n## 0.82.0 (2024-06-13)\n\n### Feat\n\n- adding dev container updates\n- adding dev container updates\n- refactoring main files\n- adding ability to set local mode in HA custom comp. if users dont have a Selenium Server\n\n### Fix\n\n- MidSussex\n\n## 0.81.0 (2024-06-05)\n\n### Feat\n\n- Adding Wychavon District Council\n\n### Fix\n\n- IntTestWarnings\n- IntTestWarnings\n\n## 0.80.0 (2024-06-02)\n\n### Feat\n\n- Adding Uttlesford District Council\n- Adding Stafford Boro Council\n- Adding Swansea Council\n- Adding New Forest\n- Adding Three Rivers\n- Adding Three Rivers\n\n### Fix\n\n- ThreeRivers\n- #425 Entities are not updated\n- sessions to avoid deprecation\n- Update docker-image.yml\n- Update docker-image.yml\n\n## 0.79.1 (2024-05-29)\n\n### Fix\n\n- Change CSS class in search for collection types\n\n## 0.79.0 (2024-05-28)\n\n### Feat\n\n- Adding Dartford\n- Adding South Kesteven District Council\n- Adding ChichesterCouncil\n- adding HounslowCouncil\n- adding HounslowCouncil\n- adding HounslowCouncil\n- Epping Fix\n- Adding Epping Forest District Council\n- Update input.json\n- Epping Forest District Council\n- Adding Stroud District Council\n- Add support for Tendring District Council\n- #269 Adding Waltham Forest\n- #269 Adding Waltham Forest\n- Adding council creation script\n\n### Fix\n\n- Update Mole Valley URL\n\n## 0.78.0 (2024-05-26)\n\n### Feat\n\n- Add support for Fareham Borough Council\n\n## 0.77.0 (2024-05-26)\n\n### Feat\n\n- Add support for Bracknell Forest Council\n\n## 0.76.1 (2024-05-24)\n\n### Fix\n\n- Handle Barnet council cookies message\n\n## 0.76.0 (2024-05-24)\n\n### Feat\n\n- add bin colour support WestSuffolkCouncil style: black format WestSuffolkCouncil\n- add bin colour support WestSuffolkCouncil style: black format WestSuffolkCouncil\n\n## 0.75.0 (2024-05-19)\n\n### Feat\n\n- #725 Add names to selenium test videos using \"se:name\" option in create webdriver function\n\n## 0.74.1 (2024-05-18)\n\n### Fix\n\n- #693 Cheshire West & Chester Council Sensor Bug\n- #693 Cheshire West & Chester Council Sensor Bug\n\n## 0.74.0 (2024-05-17)\n\n### Feat\n\n- #722 Support Python 3.12\n- #722 Support Python 3.12\n- #722 Support Python 3.12\n\n## 0.73.0 (2024-05-17)\n\n### Feat\n\n- #708 Adding HA to the dev container for debugging\n\n## 0.72.0 (2024-05-17)\n\n### Feat\n\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n\n## 0.71.0 (2024-05-17)\n\n### Feat\n\n- Update for West Suffolk Councils new website\n\n## 0.70.0 (2024-05-17)\n\n### Feat\n\n- #708 Dev Container\n- Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 simplifying Selenium integration tests\n- #708 simplifying Selenium integration tests\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Dev Container testing\n- #708 - dev container changes\n- #706 Adding Dev Container\n- #706 Adding initial Dev Container\n\n## 0.69.7 (2024-05-17)\n\n### Fix\n\n- #713 BarnsleyMBCouncil.py\n\n## 0.69.6 (2024-05-16)\n\n### Fix\n\n- #709 Update DoverDistrictCouncil.py\n\n## 0.69.5 (2024-05-14)\n\n### Fix\n\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 test coverage back to 100%\n\n## 0.69.4 (2024-05-09)\n\n### Fix\n\n- pass in required parameter into `create_webdriver`\n- test runners for `MiltonKeynesCityCouncil` and `NorthEastLincs`.\n\n## 0.69.3 (2024-05-09)\n\n### Fix\n\n- fix AttributeError when no garden waste collection is available for properties using Huntingdon District Council\n- add support for parsing \"Today\" / \"Tomorrow\" as date text for `BarnsleyMBCouncil`\n- add support for parsing \"Tomorrow\" as date text for `LiverpoolCityCouncil`\n\n## 0.69.1 (2024-05-01)\n\n### Fix\n\n- Handling the \"Website cookies enhance your user experience.\" button\n- Handling the \"Website cookies enhance your user experience.\" button\n\n## 0.69.0 (2024-04-28)\n\n### Feat\n\n- Adding Renfrewshire Council\n- Adding Renfrewshire Council\n\n## 0.68.2 (2024-04-28)\n\n### Fix\n\n- Remove 'import Dumper'\n\n## 0.68.1 (2024-04-27)\n\n### Fix\n\n- input.json Bradford missing comma\n\n## 0.68.0 (2024-04-27)\n\n### Feat\n\n- Add support for West Berkshire Council\n- add support for Knowsley Metropolitan Borough Council\n- add support for Cheshire West and Chester Council\n- add support for Cheshire West and Chester Council\n\n## 0.66.2 (2024-04-18)\n\n### Fix\n\n- Update HaringeyCouncil.py issue #670\n\n## 0.66.1 (2024-04-15)\n\n### Fix\n\n- parse datetimes correctly and round to midnight\n\n## 0.66.0 (2024-04-15)\n\n## 0.65.2 (2024-04-15)\n\n### Fix\n\n- change address selection to fix errors selecting the user's PAON\n\n## 0.65.1 (2024-04-15)\n\n### Fix\n\n- add check for parsed string length to stop datetime parsing error\n\n## 0.65.0 (2024-04-13)\n\n### Feat\n\n- add Arun council\n- add support for Sunderland City Council\n- add support for Sunderland City Council\n\n## 0.64.3 (2024-03-25)\n\n### Fix\n\n- sort data and correct dictionary name (#609)\n\n## 0.64.2 (2024-03-24)\n\n## 0.64.1 (2024-03-24)\n\n### Fix\n\n- fix Kirklees address search (switch to house & postcode)\n- fixes json\n\n## 0.64.0 (2024-03-23)\n\n### Feat\n\n- add Kirklees council\n\n### Fix\n\n- fixes json\n\n## 0.63.0 (2024-03-23)\n\n### Feat\n\n- Add Solihull Council (#513)\n- Add Adur and Worthing Councils (#544)\n- Add Dover District Council (#614)\n- Add Rochford Council (#620)\n- Add Tandridge District Council (#621)\n- Add West Northamptonshire Council (#567)\n- Add Hull City Council (#622)\n- Add Wyre Council (#625)\n- Add Telford and Wrekin Co-operative Council (#632)\n- Add Mansfield District Council (#560)\n- Add Bedford Borough Council (#552)\n\n### Fix\n\n- spacing on input.json\n- realign input.json\n- capitalize bin type text\n- formatting on input.json\n- incorrect collections\n- update testing URL for Merton\n- attempt to resolve invisible banner hiding postcode box\n- resolve JSON schema exception for date formatting\n- resolve JSON schema exception for date formatting\n- accept cookies banner\n\n## 0.62.0 (2024-03-03)\n\n### Fix\n\n- Added missing .feature file entry to the test config for NewhamCouncil\n\n## 0.61.1 (2024-02-16)\n\n### Fix\n\n- code optimisations\n- Fix date parsing in WestLindseyDistrictCouncil.py\n\n## 0.61.0 (2024-02-11)\n\n### Feat\n\n- Add Mole Valley District Council\n\n## 0.60.1 (2024-02-03)\n\n### Fix\n\n- Update input.json Closes #599\n\n## 0.60.0 (2024-01-28)\n\n### Feat\n\n- Add Scraper for St Albans City and District Council\n\n## 0.59.1 (2024-01-25)\n\n### Fix\n\n- add wiki note for castlepoint\n- update test data for castlepoint\n- remove single line causing issues\n\n## 0.59.0 (2024-01-20)\n\n### Feat\n\n- Add NorthYorkshire to test feature file\n- Add north yorkshire to test input\n- Add Support for north yorkshire council\n\n### Fix\n\n- remove unused code\n\n## 0.58.8 (2024-01-19)\n\n### Fix\n\n- barnet no overrides\n\n## 0.58.7 (2024-01-18)\n\n### Fix\n\n- accidentally returned strings when needed date objects, refactor to handle this\n- checking for future/past dates\n\n## 0.58.6 (2024-01-18)\n\n### Fix\n\n- correct date handling for North West Leicestershire\n\n## 0.58.5 (2024-01-15)\n\n### Fix\n\n- Don't call driver.quit where already handled by finally block\n\n## 0.58.4 (2024-01-15)\n\n### Fix\n\n- remove extra driver.quit to prevent errors\n\n## 0.58.3 (2024-01-15)\n\n### Feat\n\n- Added support for Newham Council's bin collections\n\n### Fix\n\n- Add a default value for user_agent to fix all councils using selenium and not specifying agent\n\n## 0.58.2 (2024-01-11)\n\n### Fix\n\n- use static values for bin types\n\n## 0.58.1 (2024-01-10)\n\n### Fix\n\n- Eastleigh Borough Council doesnt cope with \"You haven't yet signed up for ...\"\n- Eastleigh Borough Council doesnt cope when Garden Waste service hasn't been signed up for, which gets the value \"You haven't yet signed up for our garden waste collections. Find out more about our\\xa0garden waste collection service\" which results in ValueError: time data\n\n## 0.58.0 (2024-01-10)\n\n### Feat\n\n- Add Test Valley Borough Council\n\n## 0.57.0 (2024-01-09)\n\n### Feat\n\n- Add support for Chorley Council\n\n## 0.56.13 (2024-01-09)\n\n### Fix\n\n- update logic to account for council website change\n\n## 0.56.12 (2024-01-09)\n\n### Fix\n\n- duplicate driver.quit() calls causes error\n\n## 0.56.11 (2024-01-08)\n\n### Fix\n\n- Headless now working on custom comp Update sensor.py\n\n## 0.56.10 (2024-01-08)\n\n### Fix\n\n- headless mode in custom component\n\n## 0.56.9 (2024-01-08)\n\n### Fix\n\n- headless mode\n\n## 0.56.8 (2024-01-08)\n\n### Fix\n\n- headless in custom comp\n\n## 0.56.7 (2024-01-08)\n\n### Fix\n\n- headless options\n\n## 0.56.6 (2024-01-07)\n\n### Fix\n\n- modified Kingston-upon-Thames driver for greater reliability.\n\n## 0.56.5 (2024-01-07)\n\n### Fix\n\n- Update KingstonUponThamesCouncil.py\n\n## 0.56.4 (2024-01-07)\n\n### Fix\n\n- Update KingstonUponThamesCouncil.py\n\n## 0.56.3 (2024-01-07)\n\n### Fix\n\n- headless options\n- #542 - Selenium Grid Sessions must be terminated cleanly\n- #542 - Selenium Grid Sessions must be terminated cleanly\n\n## 0.56.2 (2024-01-07)\n\n### Fix\n\n- Update strings.json\n- Update en.json\n- Update config_flow.py\n\n## 0.56.1 (2024-01-07)\n\n### Fix\n\n- Update common.py\n\n## 0.156.0 (2025-10-11)\n\n### Feat\n\n- Create tag-on-merge.yml\n- Update bump.yml\n- fix bump.yml\n- Update TorbayCouncil.py\n- Update bump.yml\n- fix release pipeline bump.yml\n- fix Torbay\n\n### Fix\n\n- Update AberdeenCityCouncil.py\n- Update TorbayCouncil.py\n- Update TorbayCouncil.py\n- Update TorbayCouncil.py\n- Update URL for NewForestCouncil\n- New URL and page for wheelie bins\n- improve Mid Suffolk District Council holiday handling with dynamic bank holiday detection\n- Oxford now rejects the \"Requests\" default user agent\n- #1557 - Adding East Dunbartonshire\n- #1557 - Adding East Dunbartonshire\n- #1569 - Somerset Council\n- #1569 - Somerset Council\n- #1559 - Newport City Council\n- #1559 - Newport City Council\n- #1574 - Test Valley Borough Council\n- #1574 - Test Valley Borough Council\n- #1566 South Gloucestershire Council\n\n## 0.154.0 (2025-09-21)\n\n### Feat\n\n- handle changes to northumberland council website\n- modify input for NorthumberlandCouncil to accept uprn instead of house number, and use new page structure\n\n### Fix\n\n- the cookie banner is not optional\n- #1570 - Slough Borough Council\n- #1570 - Slough Borough Council\n- #1520 - Erewash Borough Council\n- #1520 - Erewash Borough Council\n- #1554 - Folkestone and Hythe District Council\n- #1554 - Folkestone and Hythe District Council\n- #1604 - West Berkshire Council\n- #1604 - West Berkshire Council\n- #1606 - Brighton and Hove City Council\n- #1606 - Brighton and Hove City Council\n- #1565 - BCP Council\n- #1565 - BCP Council\n- #1571 - Castle Point District Council\n- #1571 - Castle Point District Council\n- #1584 - NorthHertfordshireDistrictCouncil\n- #1584 - NorthHertfordshireDistrictCouncil\n- #1599\n- #1599 - Basingstoke Council\n- #1587\n- #1587 - Hartlepool Borough Council\n- #1588\n- #1588 Glasgow City Council\n- #1591\n- #1591 Rushmoor Council\n\n## 0.153.0 (2025-09-02)\n\n### Feat\n\n- Change buckinghamshire council to get data from endpoint\n\n### Fix\n\n- 1573 Update Bolton council URL\n- East Herts Council\n- #1575\n- Runnymede Borough Council\n- #1513\n- Wiltshire Council\n- #1533\n- Staffordshire Moorlands District Council\n- #1535\n- Ipswich Borough Council\n- #1548\n- North East Lincs\n- Hinckley and Bosworth Borough Council\n- Nuneaton Bedworth Borough Council\n- #1514\n- Lichfield District Council\n- 1549\n\n## 0.152.11 (2025-08-25)\n\n### Feat\n\n- fix releases process\n\n### Fix\n\n- date extraction in RochfordCouncil data parsing\n- parsing error in BH selenium\n- **hacs**: respect the headless option\n\n### Refactor\n\n- **hacs**: improve build_ukbcd_args with formatter functions\n\n## 0.152.10 (2025-08-04)\n\n### Fix\n\n- Gateshead and East Lothian\n- Enfield and Broxbourne\n- East Herts\n- FermanaghOmaghDistrictCouncil\n- Enfield and Broxbourne\n- East Herts\n\n## 0.152.9 (2025-08-03)\n\n### Fix\n\n- Cotswald and coventry\n- Fixing multiple broken councils\n- multiple broken councils\n\n## 0.152.8 (2025-07-26)\n\n### Fix\n\n- Add headers to request for Swindon Borough Council\n- Add headers to requests for Royal Borough of Greenwich Fixes #1496 by ensuring that the requests are not rejected due to lack of headers.\n- **MidlothianCouncil**: add request headers to resolve 403 Forbidden\n\n## 0.152.7 (2025-07-01)\n\n### Fix\n\n- maidstone selenium fix\n\n## 0.152.6 (2025-06-18)\n\n### Fix\n\n- removed In Progress from date\n- removed a degub print statement\n- **RugbyBoroughCouncil**: Amended parsed date from full to abbreviated month date, may worked but jun and jul did not\n- **RugbyBoroughCouncil**: Amended parsed date\n- Reworked Cumberland Council to cater for postcode addition\n- **OxfordCityCouncil**: Fixed Oxford City Council parsing dues to changes in output from the website\n\n## 0.152.5 (2025-06-07)\n\n### Fix\n\n- South Ribble and version pinning issues for input.json\n\n## 0.152.4 (2025-06-07)\n\n### Fix\n\n- **SouthRibble**: Corrected Date formatting issue\n- **SouthRibble**: Resolved South Ribble without selenium\n\n## 0.152.3 (2025-06-04)\n\n### Fix\n\n- NorthHertfordshire selenium script\n- Adur council\n- Eastleigh date fix\n- removed duplicates in BradfordMDC\n\n## 0.152.2 (2025-06-04)\n\n### Fix\n\n- Update Makefile\n- Update CheshireEastCouncil.py\n- Github action to handle branch name with parentheses\n\n## 0.152.1 (2025-05-15)\n\n### Fix\n\n- Update to fix North Somerset\n- Glasgow SSL bypass\n- more robust Northumberland\n- updated Eastleigh input.json\n- Eastleigh cloudflare fix\n- converted collection datetimes into dates for BH parsing.\n- Eastleigh cloudflare fix\n- Eastleigh cloudflare fix\n- added check_uprn to simplified councils\n- simplified Swindon\n- simplified East Devon\n- simplified Dover\n- Simplified Dartford\n- simplified Cheshire East\n- simplified Charnwood input.json\n- improved Charnwood\n- Adur Worthing fix\n- Chorley simplification\n- Bexley simplification\n- added URL to Torbay script\n- Guildford fixes\n- reworked Maidstone\n- maidstone input.json\n- Croydon selenium version\n- Stoke date-time fix\n\n## 0.152.0 (2025-05-02)\n\n### Feat\n\n- Added Fermanagh Omagh\n- Added Twekesbury\n- added Slough council\n- Added Argus Council\n- added Angus to input.json\n\n### Fix\n\n- Chichester now only requires postcode and house number\n- Broadland now only requires postcode and house number\n- Barking now only requires postcode and house number\n- Brighton now only requires postcode and house number\n- ensured all bins for this council\n- added skip_get_url to hyndburn\n\n## 0.151.0 (2025-04-27)\n\n### Feat\n\n- version bump\n\n### Fix\n\n- more robust brent date handling\n- input.json requires web_driver\n- Rugby fix\n\n## 0.150.0 (2025-04-27)\n\n### Feat\n\n- added melton\n- added pembrokeshire\n\n### Fix\n\n- added melton\n- processed all bins for Moray\n\n## 0.148.6 (2025-04-27)\n\n## 0.148.5 (2025-04-27)\n\n### Fix\n\n- output check\n- parsed bin info\n- selenium navigation\n- input.json changes\n\n## 0.148.4 (2025-04-27)\n\n### Fix\n\n- used canonical 'nice name'\n\n## 0.148.3 (2025-04-25)\n\n### Fix\n\n- working hyndburn\n- hyndburn input.json\n\n## 0.148.2 (2025-04-24)\n\n### Fix\n\n- Update docker-compose.yml\n- updated input.json\n- cloudflare fix - switch to selenium method\n- simplified blackburn\n\n## 0.148.1 (2025-04-22)\n\n### Fix\n\n- added bank holiday offsets.\n- added bank holiday offsets.\n\n## 0.148.0 (2025-04-19)\n\n### Feat\n\n- adding Wrexham and #1046 Horsham councils\n\n### Fix\n\n- Argyll and Bute council #1053\n\n## 0.147.2 (2025-04-18)\n\n### Fix\n\n- wait for element to be clickable\n\n## 0.147.1 (2025-04-18)\n\n### Fix\n\n- #1351 - moved geopandas to petry dev\n\n## 0.147.0 (2025-04-18)\n\n### Feat\n\n- add council tests results map\n\n## 0.146.2 (2025-04-18)\n\n### Fix\n\n- adding map checking and matching\n\n## 0.146.1 (2025-04-18)\n\n### Fix\n\n- more robust bank holiday handling\n\n## 0.146.0 (2025-04-18)\n\n### Feat\n\n- #1342 Adding Includes Trafford, Clackmannanshire, Havant, North Warwickshire, Newry Mourne and Down, East Dunbartonshire, Pendle, Torfaen, East Hampshire, Ribble Valley, Brentwood, Isle of Wight, Westmorland and Furness, Derry and Strabane, and Norwich. Google Cal support for PDF councils via ICS file\n\n### Fix\n\n- Black reformatting\n\n## 0.145.0 (2025-04-18)\n\n### Feat\n\n- Adding PDF councils\n\n## 0.144.4 (2025-04-18)\n\n### Fix\n\n- Bristol #1275\n\n## 0.144.3 (2025-04-17)\n\n### Fix\n\n- better address for input.json\n- bank holiday overrides\n- more robust address searching\n- simple parsing done\n- Selenium navigation\n\n## 0.144.2 (2025-04-17)\n\n### Fix\n\n- knowsley\n- knowsley\n- knowsley\n- knowsley\n- KnowsleyMBCouncil.py\n- #1220 adding Mid Ulster District Council\n\n## 0.144.1 (2025-04-17)\n\n### Fix\n\n- fix Sandwell garden waste collection date\n\n## 0.144.0 (2025-04-17)\n\n### Feat\n\n- added great yarmouth\n\n## 0.143.6 (2025-04-17)\n\n### Fix\n\n- Renfrewshire Council\n\n## 0.143.5 (2025-04-17)\n\n### Fix\n\n- Google Cal\n\n## 0.143.4 (2025-04-17)\n\n### Fix\n\n- Google Cal\n\n## 0.143.3 (2025-04-15)\n\n### Fix\n\n- #1301 Fix Leeds Council\n\n## 0.143.2 (2025-04-15)\n\n### Fix\n\n- #1301 Fix Leeds Council\n\n## 0.143.1 (2025-04-15)\n\n### Fix\n\n- Set the bin_type when different day\n\n## 0.143.0 (2025-04-13)\n\n### Fix\n\n- corrected url in input.json\n- fixed input.json\n- parsed Barking Dagenham collection information\n- selenium navigation Barking\n\n## 0.142.0 (2025-04-13)\n\n### Feat\n\n- Added Stirling Council\n\n### Fix\n\n- typo in input.json\n\n## 0.141.4 (2025-04-13)\n\n### Fix\n\n- #1304 - sesnors goes to unknown if the data is blank from councils who are less reliable\n\n## 0.141.3 (2025-04-13)\n\n### Fix\n\n- Newham council\n\n## 0.141.2 (2025-04-13)\n\n### Fix\n\n- Newham council\n- Newham council\n\n## 0.141.1 (2025-04-12)\n\n### Fix\n\n- missing finally block on selenium tests\n\n## 0.141.0 (2025-04-12)\n\n### Feat\n\n- #1185 Adding PeterboroughCity Council\n\n## 0.140.0 (2025-04-11)\n\n### Feat\n\n- Added Broadland District Council\n\n### Fix\n\n- cleanup of council file\n- added Broadland to input.json\n\n## 0.139.0 (2025-04-07)\n\n### Feat\n\n- adding #1037\n- adding #1032 North Devon Count Council\n\n### Fix\n\n- #1296 Forest of dean\n- 939 adding South Holland District Council - Lincolnshire UK\n\n## 0.138.1 (2025-04-05)\n\n### Fix\n\n- Walhtam forest council - revert previous changes\n\n## 0.138.0 (2025-04-05)\n\n### Feat\n\n- Adding Hastings Borough Council\n- Adding Fylde Council\n\n### Fix\n\n- #1249\n- #1039\nfix: #1181\nfix: #1266\nfix: #1274\n- Gloucester City Council\n- #1282\n- Mid Devon Council\n- #1277\nfix: #1287\n- West Oxfordshire Council\n- #1290\n\n## 0.137.0 (2025-04-05)\n\n### Feat\n\n- #816 adding trafford council\n\n## 0.136.0 (2025-03-24)\n\n### Feat\n\n- Adding Southampton City Council\n- Adding Cambridge City Council\n- Adding Spelthorne Borough Council\n\n### Fix\n\n- #1057\n- #1264\n- #1270\n- Bexley Council\n- #1256\n- HinckleyandBosworthBoroughCouncil\n- #1207\n- Hackney Council\n- #1230\n- Castlepoint District Council\n- #1252\n- Canterbury City Council\n- #1254\n\n## 0.135.4 (2025-03-24)\n\n### Fix\n\n- parse scheduleCodeWorkflowIDs instead of scheduleCodeWorkflowID for Hackney Council\n\n## 0.135.3 (2025-02-23)\n\n## 0.135.2 (2025-02-19)\n\n### Fix\n\n- North Yorkshire - multiple bins on a day\n\n## 0.135.1 (2025-02-18)\n\n### Fix\n\n- devcontainer\n\n## 0.135.0 (2025-02-17)\n\n### Fix\n\n- #833 adding Middlesbrough and check script for Selenium\n- Cotswold District Council\n- #1238\n- Leeds City Council\n- #1222\n\n## 0.134.3 (2025-02-15)\n\n### Fix\n\n- Update input.json\n- 1235 Councils missing Selenium in input.json\n\n## 0.134.2 (2025-02-15)\n\n### Fix\n\n- 1232 East herts missing Selenium url in input.json\n- Derbyshire Dales District Council\n- Conwy County Borough\n- Sunderland City Council\n- #1219\n- Tendring District Council\n- #1221\n\n## 0.134.1 (2025-02-11)\n\n### Fix\n\n- Cheltenham Borough Council\n- #1061\n\n## 0.134.0 (2025-02-07)\n\n### Feat\n\n- Ipswich Borough Council - trying different address\n- Ipswich Borough Council - correcting param name in input.json\n- Ipswich Borough Council - added input.json values and refactored code\n- Ipswich Borough Council - initial implementation\n- Adding Runnymede Borough Council\n- Adding Cherwell District Council\n- Adding Epsom and Ewell Borough Council\n- Adding Redcar and Cleveland Council\n- Adding Amber Valley Borough Council\n- Adding Bolsover Council\n\n### Fix\n\n- #1214\n- #923\n- #895\n- #841\n- #903\n- #990\n- Torridge District Council\n- #1204\n- Neath Port Talbot\n- #1213\n\n## 0.133.0 (2025-02-02)\n\n### Feat\n\n- adding manual refresh\n\n## 0.132.0 (2025-02-02)\n\n### Feat\n\n- adding manual refresh\n\n## 0.131.0 (2025-02-02)\n\n### Feat\n\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding unit tests for the new manual refresh\n- adding manual refresh control\n\n## 0.130.1 (2025-01-30)\n\n### Fix\n\n- slow councils\n\n## 0.130.0 (2025-01-29)\n\n### Feat\n\n- Add Herefordshire Council (closes: #1011)\n\n### Fix\n\n- Fix spacing in wiki name\n\n## 0.129.0 (2025-01-29)\n\n### Fix\n\n- input.json\n- input.json\n\n## 0.128.6 (2025-01-29)\n\n### Fix\n\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n\n## 0.128.5 (2025-01-29)\n\n### Feat\n\n- Adding East Staffordshire Borough Council\n\n### Fix\n\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update CheshireEastCouncil.py\n- Adding East Lothian Council\n- #1171\n- #1052\nfix: #1083\n\n## 0.128.4 (2025-01-28)\n\n### Feat\n\n- Adding Boston Borough Council\n\n### Fix\n\n- Update CheshireEastCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update CheshireEastCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Leicester City Council\n- #1178\n- Cardiff Council\n- #1175\n- Newcastle City Council\n- #1179\n- #1180\n- Midlothian Council\n- #1192 - Adding Next Page support\n\n## 0.128.3 (2025-01-28)\n\n### Fix\n\n- Update CheshireEastCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n\n## 0.128.2 (2025-01-28)\n\n### Fix\n\n- Add communal recycling and communal rubbish\n- Add garden waste to Merton Council\n\n## 0.128.1 (2025-01-28)\n\n### Fix\n\n- Update AberdeenshireCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n\n## 0.128.0 (2025-01-28)\n\n### Feat\n\n- implement Medway Council (#1021)\n\n### Fix\n\n- Forgot to include skip_get_url\n\n## 0.127.4 (2025-01-25)\n\n### Fix\n\n- NewForestCouncil\n\n## 0.127.3 (2025-01-16)\n\n### Fix\n\n- Swale Borough Council\n- #1139\n- Vale of White Horse\n- #1156\n- South Oxfordshire Council\n- #1158\n- Surrey Heath Borough Council\n- #1164\n- Carmarthenshire County Council\n- #1167\n- Glasgow City Council\n- #1166\n\n## 0.127.2 (2025-01-13)\n\n### Fix\n\n- Update bin type to be the full string\n\n## 0.127.1 (2025-01-10)\n\n### Fix\n\n- Use visibility of list rather than existence\n- Update Rushcliffe Borough Council input elements and flow\n- Merton Council\n- NewarkAndSherwoodDC\n- Rushcliffe Borough Council\n- Powys Council\n- Staffordshire Moorlands District Council\n- Stroud District Council\n- Vale of Glamorgan Council\n- West Oxfordshire District Council\n\n## 0.127.0 (2025-01-07)\n\n### Feat\n\n- Adding Oadby And Wigston Borough Council\n- Add Gwynedd Council\n- Adding Denbighshire Council\n- Adding Dundee City Council\n- Adding Brent Council\n- Adding West Dunbartonshire Council\n- Adding Cumberland Council\n\n### Fix\n\n- #929\n- Cornwall Council\n- #1137\n- #1125\n- #1106\n- #1108\n- #1109\n- #1134\n- Northumberland Council\n- #1082\n- #1110\n- Waltham Forest\n- #1126\n- London Borough Sutton\n- #1131\n- Kirklees Council\n- #1129 - Breaking Change. UPRN required\n\n## 0.126.2 (2025-01-07)\n\n### Fix\n\n- **tests**: updates test case url for coventry city council\n- **tests**: removes duplicate key for coventry city council\n- updates coventry city council button text\n\n## 0.126.1 (2025-01-06)\n\n### Fix\n\n- behave_testing\n- behave_testing\n\n## 0.126.0 (2025-01-04)\n\n### Fix\n\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n\n## 0.125.2 (2025-01-04)\n\n### Fix\n\n- Update ArdsAndNorthDownCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update README.md to have links to Full and Partial Integration Test Reports\n- Update behave_pull_request.yml\n- Update README.md to have links to Full and Partial Integration Test Reports\n- Swale Borough Council\n- #1080\n(cherry picked from commit 6f580b39fb68b8079990221e050ae8dd6d2b7285)\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update ArdsAndNorthDownCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update README.md to have links to Full and Partial Integration Test Reports\n- Update WestLindseyDistrictCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_schedule.yml\n\n## 0.125.1 (2025-01-04)\n\n### Fix\n\n- correctly handle year increment for January dates\n\n## 0.125.0 (2025-01-04)\n\n### Feat\n\n- Adding Redditch Borough Council\n- Adding Blaenau Gwent County Borough Council\n- Adding Wandsworth Council\n\n### Fix\n\n- #1068\n- #1098\n- Wiltshire Council\n- #1094\n- Salford City Council\n- #1097\n- #1078\n- Merton Council\n- Swale Borough Council\n- #1080\n- London Borough Sutton\n- #1076\n- Update behave_schedule.yml\n- Update bump.yml\n\n## 0.124.4 (2025-01-04)\n\n### Fix\n\n- Update behave_schedule.yml\n\n## 0.124.3 (2025-01-04)\n\n### Fix\n\n- allure reporting\n- allure reporting\n- allure reporting\n\n## 0.124.2 (2025-01-03)\n\n### Fix\n\n- Update behave.yml\n\n## 0.124.1 (2025-01-03)\n\n### Fix\n\n- avoid crashing on unexpected string value\n\n## 0.124.0 (2025-01-02)\n\n### Feat\n\n- Hart District Council\n\n## 0.123.2 (2024-12-19)\n\n### Fix\n\n- Update behave.yml\n\n## 0.123.1 (2024-12-18)\n\n### Feat\n\n- #1063 - rewrite Kirklees Council parser for new website\n- #1067 - Add garden bin collections where available for Norwich City Council\n- Adding Wandsworth Council\n\n### Fix\n\n- Update AberdeenCityCouncil.py\n- Update behave.yml\n- #1101 - Fix table parsing for Walsall Council\n- Remove invalid escape sequence warnings from West Lindsey District Council\n- #1073 - change method of generating bin types to avoid manual mapping for Rugby Borough Council\n- add missing backticks to separate colour config and standard usage instructions\n- #1078\n(cherry picked from commit 89d93666bb659010d1c130b98c1d81c6ff80cf7c)\n- change date format to project default for Merton Council\n- correct date logic for Swale Borough Council\n- Merton Council\n- London Borough Sutton\n- #1076\n(cherry picked from commit 1eab20c9a57c9c4438ea343f374202bb2e9b98ca)\n- Swale Borough Council\n- #1080\n(cherry picked from commit 6f580b39fb68b8079990221e050ae8dd6d2b7285)\n- correct date/year logic for West Lindsey District Council\n- replace West Lindsey's input with working address\n- #1089 - Correct shifted dates in Bromley Borough Council\n- remove WDM import\n- #1087 - Food waste date incorrect for West Berkshire Council\n\n## 0.123.0 (2024-12-17)\n\n## 0.122.0 (2024-12-04)\n\n### Feat\n\n- Adding Monmouthshire County Council\n- Adding Hinckley and Bosworth Borough Council\n\n### Fix\n\n- Glasgow City Council\n- Merton Council\n- Blaby District Council\n- Warwick District Council\n- Blackburn Council\n- Carmarthenshire County Council\n- High Peak Council\n- CarmarthenshireCountyCouncil\n\n## 0.121.1 (2024-12-03)\n\n### Fix\n\n- London Borough of Lewisham to have more reliable parsing of dates\n\n## 0.121.0 (2024-11-24)\n\n### Feat\n\n- Royal Borough of Greenwich\n- Adding London Borough of Lewisham\n- Adding Hackney Council\n- Adding Sandwell Borough Council\n- Adding Moray Council\n- Adding Kings Lynn and West Norfolk Borough Council\n- Adding Wyre Forest District Council\n- Adding Folkstone and Hythe District Council\n- Adding Cheltenham Borough Council\n- Adding Thurrock Council\n\n### Fix\n\n- West Northamptonshire Council\n- East Ayrshire Council\n- Cotswold District Council\n\n## 0.120.0 (2024-11-20)\n\n### Feat\n\n- Adding Hartlepool Borough Council\n- Adding Newcastle Under Lyme Council\n- Adding London Borough of Havering\n- Add Garden collection to EnvironmentFirst\n- Adding Cumberland Council (Allerdale District)\n- Adding North Hertfordshire District Council\n\n### Fix\n\n- #844\n- #778\n- #769\n- #1025\n- Mid Siffolk and Babergh Garden Collection Day\n- #1026\nThis will require the use of a DAY to be added to the UPRN field\n- #1029\n- #1028\n\n## 0.119.0 (2024-11-20)\n\n### Feat\n\n- Adding Braintree District Council\n- Adding Burnley Borough Council\n- Adding Exeter City Council\n- Adding Edinburgh City Council\n\n### Fix\n\n- #699\n- #1015\n- #1017\n- #894\n\n## 0.118.0 (2024-11-15)\n\n### Feat\n\n- Adding Aberdeen City Council\n- Adding Wolverhampton City Council\n- Adding Stevenage Borough Council\n- Adding Thanet District Council\n- Adding Copeland Borough Council\n- Adding South Hams District Council\n\n### Fix\n\n- #1019\n- #966\n- #989\n- #1004\n- #1006\n- #1008\n- Rother District Council\n\n## 0.117.0 (2024-11-13)\n\n### Feat\n\n- Adding South Staffordshire District Council fix: #885\n- Adding Rother District Council\n\n### Fix\n\n- #1009\n\n## 0.116.0 (2024-11-12)\n\n### Feat\n\n- Adding Ashfield District Council\n- Adding Gravesham Borough Council\n- Adding Argyll and Bute Council\n\n### Fix\n\n- CrawleyBoroughCouncil\n- #1005\n- Adding Garden collection to Babergh and MidSuffolk Council\n- #995\n- #579\n- #991\n- #692\n- CheshireWestAndChesterCouncil\n- #993\n- Milton Keynes\n- #702\n- Adding Babergh and Mid Suffolk District Councils\n- #868\nfix: #919\n- Adding Derby City Council\n- #987\n\n## 0.115.0 (2024-11-11)\n\n### Feat\n\n- Adding Warrington Borough Council\n- Adding Antrim And Newtonabbey Council\n- Adding Hertsmere Borough Council\n- Adding West Lancashire Borough Council\n- Broxbourne Council\n\n### Fix\n\n- #695\n- #969\n- #776\n- #980\n- #982\n- Bradford MDC\n- #984\n\n## 0.114.6 (2024-11-09)\n\n### Fix\n\n- NBBC Date Fix\n\n## 0.114.5 (2024-11-08)\n\n### Fix\n\n- migration logging and debugging\n\n## 0.114.4 (2024-11-08)\n\n### Fix\n\n- migration not working\n- migration not working\n\n## 0.114.3 (2024-11-08)\n\n## 0.114.2 (2024-11-08)\n\n## 0.114.1 (2024-11-08)\n\n### Fix\n\n- Update manifest.json\n\n## 0.114.0 (2024-11-07)\n\n### Feat\n\n- Nuneaton and Bedworth Borough Council\n\n## 0.113.0 (2024-11-07)\n\n## 0.112.1 (2024-11-07)\n\n## 0.112.0 (2024-11-06)\n\n### Feat\n\n- adding calendar for Bins in Custom Component\n\n### Fix\n\n- fix manifest in custom component\n- #975 adding routine to handle migration error\n- #975 adding routine to handle migration error\n- #767 BREAKING CHANGE - READD your sensors / config\n\n## 0.111.0 (2024-11-06)\n\n### Fix\n\n- Add London Borough of Sutton\n- #944\n- Add Mid Devon Council\n- #945\n- Adding Oxford City Council\n- #962\n- Tunbridge Wells / Lincoln\n- #963\n- Glasgow City Council\n\n## 0.110.0 (2024-11-04)\n\n### Fix\n\n- Adding Blaby District Council\n- #904\n- Adding Sefton Council\n- #770\n- Adding Bromsgrove District Council\n- #893\n- East Lindsey District Council\n- #957\n- Adding Carmarthenshire County Council\n- #892\nfix: #710\n- Adding East Ayrshire Council\n- #955\n\n## 0.109.2 (2024-11-03)\n\n### Fix\n\n- CC testing and add Chesterfield\n\n## 0.109.1 (2024-11-03)\n\n### Fix\n\n- CC testing and add Chesterfield\n- CC testing and add Chesterfield\n\n## 0.109.0 (2024-11-02)\n\n### Feat\n\n- Adding Cotswold District Council\n- Adding Breckland Council\n\n### Fix\n\n- St Helens Borough Council\n- #753\n- NewarkAndSherwoodDC\n- #941\n- #658\n- #656\n\n## 0.108.2 (2024-11-01)\n\n### Fix\n\n- pytest-homeassistant-custom-component\n\n## 0.108.1 (2024-11-01)\n\n### Fix\n\n- Pydandic version\n- Pydandic version\n\n## 0.108.0 (2024-11-01)\n\n### Feat\n\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- pytest fixes\n\n## 0.107.0 (2024-10-31)\n\n### Feat\n\n- Adding Powys Council\n- Adding Worcester City Council\n- Adding Ards and North Down Council\n- Adding East Herts Council\n- Adding Ashford Borough Council\n\n### Fix\n\n- WestOxfordshireDistrictCouncil\n- South Norfolk Council\n- ForestOfDeanDistrictCouncil\n- Croydon Council\n- South Kesteven District Council\n- #647\n- #630\n- #623\n- #586\n- #578\n- #389\n\n## 0.106.0 (2024-10-28)\n\n### Feat\n\n- Adding Stockton On Tees Council\n- Adding Fife Council\n- Adding Flintshire County Council\n\n### Fix\n\n- #930\n- #933\n- #750\n\n## 0.105.1 (2024-10-24)\n\n### Fix\n\n- Refactor Midlothian Council scraper to use house number and postcode\n- West Berkshire Council\n- Southwark Council\n\n## 0.105.0 (2024-10-21)\n\n### Feat\n\n- Adding Teignbridge Council\n- Adding Harborough District Council\n- Adding Watford Borough Council\n- Adding Coventry City Council\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- Adding Powys Council\n- Adding Worcester City Council\n- Adding Ards and North Down Council\n- Adding East Herts Council\n- Adding Ashford Borough Council\n- Adding Stockton On Tees Council\n- Adding Fife Council\n- Adding Flintshire County Council\n- Adding Teignbridge Council\n- Adding Harborough District Council\n- Adding Watford Borough Council\n- Adding Coventry City Council\n- Python 3.12 only and CustomComp. Unit testing\n\n### Fix\n\n- #580\n- #888\n- #902\n- #607\n- CC testing and add Chesterfield\n- CC testing and add Chesterfield\n- CC testing and add Chesterfield\n- pytest-homeassistant-custom-component\n- Pydandic version\n- Pydandic version\n- WestOxfordshireDistrictCouncil\n- South Norfolk Council\n- ForestOfDeanDistrictCouncil\n- Croydon Council\n- South Kesteven District Council\n- #647\n- #630\n- #623\n- #586\n- #578\n- #389\n- #930\n- #933\n- #750\n- Refactor Midlothian Council scraper to use house number and postcode\n- West Berkshire Council\n- Southwark Council\n- #580\n- #888\n- #902\n- #607\n\n## 0.104.0 (2024-10-20)\n\n### Feat\n\n- Adding Luton Borough Council\n- Adding West Oxfordshire District Council\n- Adding Aberdeenshire Council\n- Adding Canterbury City Council\n- Adding Swindon Borough Council\n\n### Fix\n\n- #697\n- #694\n- #659\n- #590\n- #900\n\n## 0.103.0 (2024-10-20)\n\n### Feat\n\n- Adding RAW JSON Sensor\n\n### Fix\n\n- Black formatting\n- Black formatting\n\n## 0.102.0 (2024-10-20)\n\n### Feat\n\n- Moving from Attributes to Sensors\n- Moving from Attributes to Sensors\n\n## 0.101.0 (2024-10-20)\n\n### Feat\n\n- Add Midlothgian Council\n\n## 0.100.0 (2024-10-18)\n\n### Feat\n\n- Adding Dudley Council\n- Adding South Ribble Council\n- Plymouth Council\n- Adding Norwich City Council\n\n### Fix\n\n- #744\n- #671\n- #566\n- #749\n\n## 0.99.1 (2024-10-16)\n\n### Fix\n\n- #792 adding web_driver option to Wokingham Council\n\n## 0.99.0 (2024-10-16)\n\n### Feat\n\n- Adding Lincoln Council\n- Adding Tunbridge Wells Council\n- Adding Perth and Kinross Council\n\n### Fix\n\n- Update wiki\n- #748\n- #598\n- #572\n\n## 0.98.5 (2024-10-15)\n\n### Fix\n\n- Swale Borough Council\n- HaltonBoroughCouncil\n- Barnet Council\n- WestBerkshireCouncil\n\n## 0.98.4 (2024-10-14)\n\n### Fix\n\n- West Suffolk Council\n- Vale of White Horse Council\n- Uttlesford District Council\n- Neath Port Talbot Council\n- Merton Council\n- Manchester City Council\n- Glasgow City Council\n- BradfordMDC\n\n## 0.98.3 (2024-10-13)\n\n### Fix\n\n- EastRiding\n\n## 0.98.2 (2024-10-13)\n\n### Fix\n\n- MoleValley\n\n## 0.98.1 (2024-10-13)\n\n### Fix\n\n- Barnet and Bexley\n\n## 0.98.0 (2024-10-13)\n\n### Feat\n\n- Adding Wirral Council\n- Adding Lichfield District Council\n- Adding West Morland And Furness\n- Adding Walsall Council\n- Adding Armagh, Banbridge and Craigavon Council\n\n### Fix\n\n- #602\n- #830\n- #870\n- #873\n- #877\n\n## 0.97.1 (2024-10-10)\n\n### Fix\n\n- NottinghamCityCouncil\n- #875\n\n## 0.97.0 (2024-10-10)\n\n### Feat\n\n- Adding Falkirk Council\n\n### Fix\n\n- #761\n\n## 0.96.0 (2024-10-10)\n\n### Feat\n\n- Adding London Borough Harrow\n- Adding North Ayrshire Council\n- Adding Highland Council\n- Add Elmbridge Borough Council\n- Adding Southwark Council\n- South Derbyshire District Council\n\n### Fix\n\n- #871\n- #869\n- #780\n- #845\nfix: #754\n- #835\n- #842\n\n## 0.95.0 (2024-10-09)\n\n### Feat\n\n- Adding London Borough of Ealing\n\n## 0.94.0 (2024-10-09)\n\n### Feat\n\n- Adding London Borough of Lambeth\n- Adding Dacorum Borough Council\n\n### Fix\n\n- Dacorum Borough Council\n- East Devon DC\n\n## 0.93.0 (2024-10-08)\n\n### Feat\n\n- Update CheshireEastCouncil.py\n\n## 0.92.0 (2024-10-08)\n\n### Feat\n\n- Update CheshireEastCouncil.py\n- Update README.md\n- Adding Wokingham Borough Council\n- Adding Winchester City Council\n- Adding Basildon Council\n- Adding Colchester City Council\n\n### Fix\n\n- RochfordCouncil\n- Neath Port Talbot Council\n- Buckinghamshire Council\n- #639\nfix: #812\n\n## 0.91.2 (2024-10-05)\n\n### Fix\n\n- Windsor and Maidenhead Council\n\n## 0.91.1 (2024-10-04)\n\n## 0.91.0 (2024-10-03)\n\n## 0.90.0 (2024-10-03)\n\n### Feat\n\n- Adding East Renfrewshire Council\n\n### Fix\n\n- Update DorsetCouncil.py\n- #829\n- Update GatesheadCouncil.py\n- #822\n\n## 0.89.1 (2024-10-02)\n\n### Fix\n\n- High Peak have changed their cookie dialog Seems to be safe to ignore it now.\n\n## 0.89.0 (2024-09-27)\n\n### Feat\n\n- Update CheshireEastCouncil.py\n- Update README.md\n\n### Fix\n\n- release to be non pre release\n\n## 0.88.0 (2024-09-16)\n\n### Feat\n\n- Add Ealing Council\n\n### Fix\n\n- Update README.md\n\n## 0.87.0 (2024-09-10)\n\n### Feat\n\n- Add IslingtonCouncil\n\n### Fix\n\n- #565 Gloucester city council driver\n\n## 0.86.1 (2024-09-09)\n\n### Fix\n\n- #773 Wakefield\n\n## 0.86.0 (2024-09-06)\n\n### Feat\n\n- added Rotherham Council\n\n## 0.85.7 (2024-09-05)\n\n### Fix\n\n- more unit tests\n- more unit tests\n- Chorley\n\n## 0.85.6 (2024-09-03)\n\n### Fix\n\n- #795 and add reconfigure to custom comp.\n\n## 0.85.5 (2024-09-03)\n\n## 0.85.4 (2024-09-03)\n\n### Fix\n\n- #795 and add reconfigure to custom comp.\n- #795 Unit Test Coverage\n\n## 0.85.3 (2024-09-02)\n\n### Fix\n\n- #795 unit test coverage\n\n## 0.85.2 (2024-09-02)\n\n### Fix\n\n- 791 Glasgow URL change\n\n## 0.85.1 (2024-09-02)\n\n### Fix\n\n- 779 Add correct async wait to Home Assistant\n\n## 0.85.0 (2024-08-27)\n\n### Feat\n\n- support for enfield council\n\n## 0.84.2 (2024-08-27)\n\n### Fix\n\n- Re-work North Tyneside Council module for 2024 - some addresses do not have a garden collection\n- Re-work North Tyneside Council module for 2024\n\n## 0.84.1 (2024-08-08)\n\n### Fix\n\n- #771 Bolton bullet points on dates is now fixed\n\n## 0.84.0 (2024-07-31)\n\n## 0.83.0 (2024-07-07)\n\n### Feat\n\n- add has_numbers() function\n\n### Fix\n\n- update Gedling Borough Council parser to use alternative name key\n- change Gedling to use new JSON data\n- update instructions for Gedling\n- update input.json to use UPRN parameter\n- change DorsetCouncil.py to use API links provided in #756\n- explicit import of logging.config to stop error in Python 3.11\n\n## 0.82.0 (2024-06-13)\n\n### Feat\n\n- adding dev container updates\n- adding dev container updates\n- refactoring main files\n- adding ability to set local mode in HA custom comp. if users dont have a Selenium Server\n\n### Fix\n\n- MidSussex\n\n## 0.81.0 (2024-06-05)\n\n### Feat\n\n- Adding Wychavon District Council\n\n### Fix\n\n- IntTestWarnings\n- IntTestWarnings\n\n## 0.80.0 (2024-06-02)\n\n### Feat\n\n- Adding Uttlesford District Council\n- Adding Stafford Boro Council\n- Adding Swansea Council\n- Adding New Forest\n- Adding Three Rivers\n- Adding Three Rivers\n\n### Fix\n\n- ThreeRivers\n- #425 Entities are not updated\n- sessions to avoid deprecation\n- Update docker-image.yml\n- Update docker-image.yml\n\n## 0.79.1 (2024-05-29)\n\n### Fix\n\n- Change CSS class in search for collection types\n\n## 0.79.0 (2024-05-28)\n\n### Feat\n\n- Adding Dartford\n- Adding South Kesteven District Council\n- Adding ChichesterCouncil\n- adding HounslowCouncil\n- adding HounslowCouncil\n- adding HounslowCouncil\n- Epping Fix\n- Adding Epping Forest District Council\n- Update input.json\n- Epping Forest District Council\n- Adding Stroud District Council\n- Add support for Tendring District Council\n- #269 Adding Waltham Forest\n- #269 Adding Waltham Forest\n- Adding council creation script\n\n### Fix\n\n- Update Mole Valley URL\n\n## 0.78.0 (2024-05-26)\n\n### Feat\n\n- Add support for Fareham Borough Council\n\n## 0.77.0 (2024-05-26)\n\n### Feat\n\n- Add support for Bracknell Forest Council\n\n## 0.76.1 (2024-05-24)\n\n### Fix\n\n- Handle Barnet council cookies message\n\n## 0.76.0 (2024-05-24)\n\n### Feat\n\n- add bin colour support WestSuffolkCouncil style: black format WestSuffolkCouncil\n- add bin colour support WestSuffolkCouncil style: black format WestSuffolkCouncil\n\n## 0.75.0 (2024-05-19)\n\n### Feat\n\n- #725 Add names to selenium test videos using \"se:name\" option in create webdriver function\n\n## 0.74.1 (2024-05-18)\n\n### Fix\n\n- #693 Cheshire West & Chester Council Sensor Bug\n- #693 Cheshire West & Chester Council Sensor Bug\n\n## 0.74.0 (2024-05-17)\n\n### Feat\n\n- #722 Support Python 3.12\n- #722 Support Python 3.12\n- #722 Support Python 3.12\n\n## 0.73.0 (2024-05-17)\n\n### Feat\n\n- #708 Adding HA to the dev container for debugging\n\n## 0.72.0 (2024-05-17)\n\n### Feat\n\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n\n## 0.71.0 (2024-05-17)\n\n### Feat\n\n- Update for West Suffolk Councils new website\n\n## 0.70.0 (2024-05-17)\n\n### Feat\n\n- #708 Dev Container\n- Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 simplifying Selenium integration tests\n- #708 simplifying Selenium integration tests\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Dev Container testing\n- #708 - dev container changes\n- #706 Adding Dev Container\n- #706 Adding initial Dev Container\n\n## 0.69.7 (2024-05-17)\n\n### Fix\n\n- #713 BarnsleyMBCouncil.py\n\n## 0.69.6 (2024-05-16)\n\n### Fix\n\n- #709 Update DoverDistrictCouncil.py\n\n## 0.69.5 (2024-05-14)\n\n### Fix\n\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 test coverage back to 100%\n\n## 0.69.4 (2024-05-09)\n\n### Fix\n\n- pass in required parameter into `create_webdriver`\n- test runners for `MiltonKeynesCityCouncil` and `NorthEastLincs`.\n\n## 0.69.3 (2024-05-09)\n\n### Fix\n\n- fix AttributeError when no garden waste collection is available for properties using Huntingdon District Council\n- add support for parsing \"Today\" / \"Tomorrow\" as date text for `BarnsleyMBCouncil`\n- add support for parsing \"Tomorrow\" as date text for `LiverpoolCityCouncil`\n\n## 0.69.1 (2024-05-01)\n\n### Fix\n\n- Handling the \"Website cookies enhance your user experience.\" button\n- Handling the \"Website cookies enhance your user experience.\" button\n\n## 0.69.0 (2024-04-28)\n\n### Feat\n\n- Adding Renfrewshire Council\n- Adding Renfrewshire Council\n\n## 0.68.2 (2024-04-28)\n\n### Fix\n\n- Remove 'import Dumper'\n\n## 0.68.1 (2024-04-27)\n\n### Fix\n\n- input.json Bradford missing comma\n\n## 0.68.0 (2024-04-27)\n\n### Feat\n\n- Add support for West Berkshire Council\n- add support for Knowsley Metropolitan Borough Council\n- add support for Cheshire West and Chester Council\n- add support for Cheshire West and Chester Council\n\n## 0.66.2 (2024-04-18)\n\n### Fix\n\n- Update HaringeyCouncil.py issue #670\n\n## 0.66.1 (2024-04-15)\n\n### Fix\n\n- parse datetimes correctly and round to midnight\n\n## 0.66.0 (2024-04-15)\n\n## 0.65.2 (2024-04-15)\n\n### Fix\n\n- change address selection to fix errors selecting the user's PAON\n\n## 0.65.1 (2024-04-15)\n\n### Fix\n\n- add check for parsed string length to stop datetime parsing error\n\n## 0.65.0 (2024-04-13)\n\n### Feat\n\n- add Arun council\n- add support for Sunderland City Council\n- add support for Sunderland City Council\n\n## 0.64.3 (2024-03-25)\n\n### Fix\n\n- sort data and correct dictionary name (#609)\n\n## 0.64.2 (2024-03-24)\n\n## 0.64.1 (2024-03-24)\n\n### Fix\n\n- fix Kirklees address search (switch to house & postcode)\n- fixes json\n\n## 0.64.0 (2024-03-23)\n\n### Feat\n\n- add Kirklees council\n\n### Fix\n\n- fixes json\n\n## 0.63.0 (2024-03-23)\n\n### Feat\n\n- Add Solihull Council (#513)\n- Add Adur and Worthing Councils (#544)\n- Add Dover District Council (#614)\n- Add Rochford Council (#620)\n- Add Tandridge District Council (#621)\n- Add West Northamptonshire Council (#567)\n- Add Hull City Council (#622)\n- Add Wyre Council (#625)\n- Add Telford and Wrekin Co-operative Council (#632)\n- Add Mansfield District Council (#560)\n- Add Bedford Borough Council (#552)\n\n### Fix\n\n- spacing on input.json\n- realign input.json\n- capitalize bin type text\n- formatting on input.json\n- incorrect collections\n- update testing URL for Merton\n- attempt to resolve invisible banner hiding postcode box\n- resolve JSON schema exception for date formatting\n- resolve JSON schema exception for date formatting\n- accept cookies banner\n\n## 0.62.0 (2024-03-03)\n\n### Fix\n\n- Added missing .feature file entry to the test config for NewhamCouncil\n\n## 0.61.1 (2024-02-16)\n\n### Fix\n\n- code optimisations\n- Fix date parsing in WestLindseyDistrictCouncil.py\n\n## 0.61.0 (2024-02-11)\n\n### Feat\n\n- Add Mole Valley District Council\n\n## 0.60.1 (2024-02-03)\n\n### Fix\n\n- Update input.json Closes #599\n\n## 0.60.0 (2024-01-28)\n\n### Feat\n\n- Add Scraper for St Albans City and District Council\n\n## 0.59.1 (2024-01-25)\n\n### Fix\n\n- add wiki note for castlepoint\n- update test data for castlepoint\n- remove single line causing issues\n\n## 0.59.0 (2024-01-20)\n\n### Feat\n\n- Add NorthYorkshire to test feature file\n- Add north yorkshire to test input\n- Add Support for north yorkshire council\n\n### Fix\n\n- remove unused code\n\n## 0.58.8 (2024-01-19)\n\n### Fix\n\n- barnet no overrides\n\n## 0.58.7 (2024-01-18)\n\n### Fix\n\n- accidentally returned strings when needed date objects, refactor to handle this\n- checking for future/past dates\n\n## 0.58.6 (2024-01-18)\n\n### Fix\n\n- correct date handling for North West Leicestershire\n\n## 0.58.5 (2024-01-15)\n\n### Fix\n\n- Don't call driver.quit where already handled by finally block\n\n## 0.58.4 (2024-01-15)\n\n### Fix\n\n- remove extra driver.quit to prevent errors\n\n## 0.58.3 (2024-01-15)\n\n### Feat\n\n- Added support for Newham Council's bin collections\n\n### Fix\n\n- Add a default value for user_agent to fix all councils using selenium and not specifying agent\n\n## 0.58.2 (2024-01-11)\n\n### Fix\n\n- use static values for bin types\n\n## 0.58.1 (2024-01-10)\n\n### Fix\n\n- Eastleigh Borough Council doesnt cope with \"You haven't yet signed up for ...\"\n- Eastleigh Borough Council doesnt cope when Garden Waste service hasn't been signed up for, which gets the value \"You haven't yet signed up for our garden waste collections. Find out more about our\\xa0garden waste collection service\" which results in ValueError: time data\n\n## 0.58.0 (2024-01-10)\n\n### Feat\n\n- Add Test Valley Borough Council\n\n## 0.57.0 (2024-01-09)\n\n### Feat\n\n- Add support for Chorley Council\n\n## 0.56.13 (2024-01-09)\n\n### Fix\n\n- update logic to account for council website change\n\n## 0.56.12 (2024-01-09)\n\n### Fix\n\n- duplicate driver.quit() calls causes error\n\n## 0.56.11 (2024-01-08)\n\n### Fix\n\n- Headless now working on custom comp Update sensor.py\n\n## 0.56.10 (2024-01-08)\n\n### Fix\n\n- headless mode in custom component\n\n## 0.56.9 (2024-01-08)\n\n### Fix\n\n- headless mode\n\n## 0.56.8 (2024-01-08)\n\n### Fix\n\n- headless in custom comp\n\n## 0.56.7 (2024-01-08)\n\n### Fix\n\n- headless options\n\n## 0.56.6 (2024-01-07)\n\n### Fix\n\n- modified Kingston-upon-Thames driver for greater reliability.\n\n## 0.56.5 (2024-01-07)\n\n### Fix\n\n- Update KingstonUponThamesCouncil.py\n\n## 0.56.4 (2024-01-07)\n\n### Fix\n\n- Update KingstonUponThamesCouncil.py\n\n## 0.56.3 (2024-01-07)\n\n### Fix\n\n- headless options\n- #542 - Selenium Grid Sessions must be terminated cleanly\n- #542 - Selenium Grid Sessions must be terminated cleanly\n\n## 0.56.2 (2024-01-07)\n\n### Fix\n\n- Update strings.json\n- Update en.json\n- Update config_flow.py\n\n## 0.56.1 (2024-01-07)\n\n### Fix\n\n- Update common.py\n\n## 0.56.0 (2024-01-07)\n\n### Feat\n\n- Update strings.json\n- Update en.json\n- Update config_flow.py\n- adding headless control\n- adding headless control\n- adding headless control\n\n## 0.55.3 (2024-01-05)\n\n### Fix\n\n- Update lint.yml\n\n## 0.55.2 (2024-01-05)\n\n### Fix\n\n- Chelmsford\n\n## 0.55.1 (2024-01-05)\n\n### Fix\n\n- Update ChelmsfordCityCouncil.py\n- Update ChelmsfordCityCouncil.py\n- Update ChelmsfordCityCouncil.py\n\n## 0.155.0 (2025-10-11)\n\n### Feat\n\n- Create tag-on-merge.yml\n- Update bump.yml\n- fix bump.yml\n- Update TorbayCouncil.py\n- Update bump.yml\n- fix release pipeline bump.yml\n- fix Torbay\n- fix releases process\n\n### Fix\n\n- Update AberdeenCityCouncil.py\n- Update TorbayCouncil.py\n- Update TorbayCouncil.py\n- Update TorbayCouncil.py\n- Update URL for NewForestCouncil\n- New URL and page for wheelie bins\n- improve Mid Suffolk District Council holiday handling with dynamic bank holiday detection\n- Oxford now rejects the \"Requests\" default user agent\n- #1557 - Adding East Dunbartonshire\n- #1557 - Adding East Dunbartonshire\n- #1569 - Somerset Council\n- #1569 - Somerset Council\n- #1559 - Newport City Council\n- #1559 - Newport City Council\n- #1574 - Test Valley Borough Council\n- #1574 - Test Valley Borough Council\n- #1566 South Gloucestershire Council\n\n## 0.154.0 (2025-09-21)\n\n### Feat\n\n- handle changes to northumberland council website\n- modify input for NorthumberlandCouncil to accept uprn instead of house number, and use new page structure\n\n### Fix\n\n- the cookie banner is not optional\n- #1570 - Slough Borough Council\n- #1570 - Slough Borough Council\n- #1520 - Erewash Borough Council\n- #1520 - Erewash Borough Council\n- #1554 - Folkestone and Hythe District Council\n- #1554 - Folkestone and Hythe District Council\n- #1604 - West Berkshire Council\n- #1604 - West Berkshire Council\n- #1606 - Brighton and Hove City Council\n- #1606 - Brighton and Hove City Council\n- #1565 - BCP Council\n- #1565 - BCP Council\n- #1571 - Castle Point District Council\n- #1571 - Castle Point District Council\n- #1584 - NorthHertfordshireDistrictCouncil\n- #1584 - NorthHertfordshireDistrictCouncil\n- #1599\n- #1599 - Basingstoke Council\n- #1587\n- #1587 - Hartlepool Borough Council\n- #1588\n- #1588 Glasgow City Council\n- #1591\n- #1591 Rushmoor Council\n\n## 0.153.0 (2025-09-02)\n\n### Feat\n\n- Change buckinghamshire council to get data from endpoint\n\n### Fix\n\n- 1573 Update Bolton council URL\n- East Herts Council\n- #1575\n- Runnymede Borough Council\n- #1513\n- Wiltshire Council\n- #1533\n- Staffordshire Moorlands District Council\n- #1535\n- Ipswich Borough Council\n- #1548\n- North East Lincs\n- Hinckley and Bosworth Borough Council\n- Nuneaton Bedworth Borough Council\n- #1514\n- Lichfield District Council\n- 1549\n\n## 0.152.11 (2025-08-25)\n\n### Fix\n\n- date extraction in RochfordCouncil data parsing\n- parsing error in BH selenium\n- **hacs**: respect the headless option\n\n### Refactor\n\n- **hacs**: improve build_ukbcd_args with formatter functions\n\n## 0.152.10 (2025-08-04)\n\n### Fix\n\n- Gateshead and East Lothian\n- Enfield and Broxbourne\n- East Herts\n- FermanaghOmaghDistrictCouncil\n- Enfield and Broxbourne\n- East Herts\n\n## 0.152.9 (2025-08-03)\n\n### Fix\n\n- Cotswald and coventry\n- Fixing multiple broken councils\n- multiple broken councils\n\n## 0.152.8 (2025-07-26)\n\n### Fix\n\n- Add headers to request for Swindon Borough Council\n- Add headers to requests for Royal Borough of Greenwich Fixes #1496 by ensuring that the requests are not rejected due to lack of headers.\n- **MidlothianCouncil**: add request headers to resolve 403 Forbidden\n\n## 0.152.7 (2025-07-01)\n\n### Fix\n\n- maidstone selenium fix\n\n## 0.152.6 (2025-06-18)\n\n### Fix\n\n- removed In Progress from date\n- removed a degub print statement\n- **RugbyBoroughCouncil**: Amended parsed date from full to abbreviated month date, may worked but jun and jul did not\n- **RugbyBoroughCouncil**: Amended parsed date\n- Reworked Cumberland Council to cater for postcode addition\n- **OxfordCityCouncil**: Fixed Oxford City Council parsing dues to changes in output from the website\n\n## 0.152.5 (2025-06-07)\n\n### Fix\n\n- South Ribble and version pinning issues for input.json\n\n## 0.152.4 (2025-06-07)\n\n### Fix\n\n- **SouthRibble**: Corrected Date formatting issue\n- **SouthRibble**: Resolved South Ribble without selenium\n\n## 0.152.3 (2025-06-04)\n\n### Fix\n\n- NorthHertfordshire selenium script\n- Adur council\n- Eastleigh date fix\n- removed duplicates in BradfordMDC\n\n## 0.152.2 (2025-06-04)\n\n### Fix\n\n- Update Makefile\n- Update CheshireEastCouncil.py\n- Github action to handle branch name with parentheses\n\n## 0.152.1 (2025-05-15)\n\n### Fix\n\n- Update to fix North Somerset\n- Glasgow SSL bypass\n- more robust Northumberland\n- updated Eastleigh input.json\n- Eastleigh cloudflare fix\n- converted collection datetimes into dates for BH parsing.\n- Eastleigh cloudflare fix\n- Eastleigh cloudflare fix\n- added check_uprn to simplified councils\n- simplified Swindon\n- simplified East Devon\n- simplified Dover\n- Simplified Dartford\n- simplified Cheshire East\n- simplified Charnwood input.json\n- improved Charnwood\n- Adur Worthing fix\n- Chorley simplification\n- Bexley simplification\n- added URL to Torbay script\n- Guildford fixes\n- reworked Maidstone\n- maidstone input.json\n- Croydon selenium version\n- Stoke date-time fix\n\n## 0.152.0 (2025-05-02)\n\n### Feat\n\n- Added Fermanagh Omagh\n- Added Twekesbury\n- added Slough council\n- Added Argus Council\n- added Angus to input.json\n\n### Fix\n\n- Chichester now only requires postcode and house number\n- Broadland now only requires postcode and house number\n- Barking now only requires postcode and house number\n- Brighton now only requires postcode and house number\n- ensured all bins for this council\n- added skip_get_url to hyndburn\n\n## 0.151.0 (2025-04-27)\n\n### Feat\n\n- version bump\n\n### Fix\n\n- more robust brent date handling\n- input.json requires web_driver\n- Rugby fix\n- simplified blackburn\n\n## 0.150.0 (2025-04-27)\n\n### Feat\n\n- added melton\n\n### Fix\n\n- added melton\n- processed all bins for Moray\n\n## 0.149.0 (2025-04-27)\n\n### Feat\n\n- added pembrokeshire\n\n## 0.148.6 (2025-04-27)\n\n### Fix\n\n- updated input.json\n- cloudflare fix - switch to selenium method\n\n## 0.148.5 (2025-04-27)\n\n### Fix\n\n- output check\n- parsed bin info\n- selenium navigation\n- input.json changes\n\n## 0.148.4 (2025-04-27)\n\n### Fix\n\n- used canonical 'nice name'\n\n## 0.148.3 (2025-04-25)\n\n### Fix\n\n- working hyndburn\n- hyndburn input.json\n\n## 0.148.2 (2025-04-24)\n\n### Fix\n\n- Update docker-compose.yml\n\n## 0.148.1 (2025-04-22)\n\n### Fix\n\n- added bank holiday offsets.\n- added bank holiday offsets.\n\n## 0.148.0 (2025-04-19)\n\n### Feat\n\n- adding Wrexham and #1046 Horsham councils\n\n### Fix\n\n- Argyll and Bute council #1053\n\n## 0.147.2 (2025-04-18)\n\n### Fix\n\n- wait for element to be clickable\n\n## 0.147.1 (2025-04-18)\n\n### Fix\n\n- #1351 - moved geopandas to petry dev\n\n## 0.147.0 (2025-04-18)\n\n### Feat\n\n- add council tests results map\n\n## 0.146.2 (2025-04-18)\n\n### Fix\n\n- adding map checking and matching\n\n## 0.146.1 (2025-04-18)\n\n### Fix\n\n- more robust bank holiday handling\n\n## 0.146.0 (2025-04-18)\n\n### Feat\n\n- #1342 Adding Includes Trafford, Clackmannanshire, Havant, North Warwickshire, Newry Mourne and Down, East Dunbartonshire, Pendle, Torfaen, East Hampshire, Ribble Valley, Brentwood, Isle of Wight, Westmorland and Furness, Derry and Strabane, and Norwich. Google Cal support for PDF councils via ICS file\n\n### Fix\n\n- Black reformatting\n\n## 0.145.0 (2025-04-18)\n\n### Feat\n\n- Adding PDF councils\n\n## 0.144.4 (2025-04-18)\n\n### Fix\n\n- Bristol #1275\n\n## 0.144.3 (2025-04-17)\n\n### Fix\n\n- better address for input.json\n- bank holiday overrides\n- more robust address searching\n- simple parsing done\n- Selenium navigation\n\n## 0.144.2 (2025-04-17)\n\n### Fix\n\n- knowsley\n- knowsley\n- knowsley\n- knowsley\n- KnowsleyMBCouncil.py\n- #1220 adding Mid Ulster District Council\n\n## 0.144.1 (2025-04-17)\n\n### Fix\n\n- fix Sandwell garden waste collection date\n\n## 0.144.0 (2025-04-17)\n\n### Feat\n\n- added great yarmouth\n\n## 0.143.6 (2025-04-17)\n\n### Fix\n\n- Renfrewshire Council\n\n## 0.143.5 (2025-04-17)\n\n### Fix\n\n- Google Cal\n\n## 0.143.4 (2025-04-17)\n\n### Fix\n\n- Google Cal\n\n## 0.143.3 (2025-04-15)\n\n### Fix\n\n- #1301 Fix Leeds Council\n\n## 0.143.2 (2025-04-15)\n\n### Fix\n\n- #1301 Fix Leeds Council\n\n## 0.143.1 (2025-04-15)\n\n### Fix\n\n- Set the bin_type when different day\n\n## 0.143.0 (2025-04-13)\n\n### Fix\n\n- corrected url in input.json\n- fixed input.json\n- parsed Barking Dagenham collection information\n- selenium navigation Barking\n\n## 0.142.0 (2025-04-13)\n\n### Feat\n\n- Added Stirling Council\n\n### Fix\n\n- typo in input.json\n\n## 0.141.4 (2025-04-13)\n\n### Fix\n\n- #1304 - sesnors goes to unknown if the data is blank from councils who are less reliable\n\n## 0.141.3 (2025-04-13)\n\n### Fix\n\n- Newham council\n\n## 0.141.2 (2025-04-13)\n\n### Fix\n\n- Newham council\n- Newham council\n\n## 0.141.1 (2025-04-12)\n\n### Fix\n\n- missing finally block on selenium tests\n\n## 0.141.0 (2025-04-12)\n\n### Feat\n\n- #1185 Adding PeterboroughCity Council\n\n## 0.140.0 (2025-04-11)\n\n### Feat\n\n- Added Broadland District Council\n\n### Fix\n\n- cleanup of council file\n- added Broadland to input.json\n\n## 0.139.0 (2025-04-07)\n\n### Feat\n\n- adding #1037\n- adding #1032 North Devon Count Council\n\n### Fix\n\n- #1296 Forest of dean\n- 939 adding South Holland District Council - Lincolnshire UK\n\n## 0.138.1 (2025-04-05)\n\n### Fix\n\n- Walhtam forest council - revert previous changes\n\n## 0.138.0 (2025-04-05)\n\n### Feat\n\n- Adding Hastings Borough Council\n- Adding Fylde Council\n\n### Fix\n\n- #1249\n- #1039\nfix: #1181\nfix: #1266\nfix: #1274\n- Gloucester City Council\n- #1282\n- Mid Devon Council\n- #1277\nfix: #1287\n- West Oxfordshire Council\n- #1290\n\n## 0.137.0 (2025-04-05)\n\n### Feat\n\n- #816 adding trafford council\n\n## 0.136.0 (2025-03-24)\n\n### Feat\n\n- Adding Southampton City Council\n- Adding Cambridge City Council\n- Adding Spelthorne Borough Council\n\n### Fix\n\n- #1057\n- #1264\n- #1270\n- Bexley Council\n- #1256\n- HinckleyandBosworthBoroughCouncil\n- #1207\n- Hackney Council\n- #1230\n- Castlepoint District Council\n- #1252\n- Canterbury City Council\n- #1254\n\n## 0.135.4 (2025-03-24)\n\n### Fix\n\n- parse scheduleCodeWorkflowIDs instead of scheduleCodeWorkflowID for Hackney Council\n\n## 0.135.3 (2025-02-23)\n\n## 0.135.2 (2025-02-19)\n\n### Fix\n\n- North Yorkshire - multiple bins on a day\n\n## 0.135.1 (2025-02-18)\n\n### Fix\n\n- devcontainer\n\n## 0.135.0 (2025-02-17)\n\n### Feat\n\n- Adding Runnymede Borough Council\n- Adding Cherwell District Council\n- Adding Epsom and Ewell Borough Council\n- Adding Redcar and Cleveland Council\n- Adding Amber Valley Borough Council\n- Adding Bolsover Council\n\n### Fix\n\n- #833 adding Middlesbrough and check script for Selenium\n- Cotswold District Council\n- #1238\n- Leeds City Council\n- #1222\n- Derbyshire Dales District Council\n- Conwy County Borough\n- Sunderland City Council\n- #1219\n- Tendring District Council\n- #1221\n- #1214\n- #923\n- #895\n- #841\n- #903\n- #990\n- Torridge District Council\n- #1204\n- Neath Port Talbot\n- #1213\n\n## 0.134.3 (2025-02-15)\n\n### Fix\n\n- Update input.json\n- 1235 Councils missing Selenium in input.json\n\n## 0.134.2 (2025-02-15)\n\n### Fix\n\n- 1232 East herts missing Selenium url in input.json\n\n## 0.134.1 (2025-02-11)\n\n### Fix\n\n- Cheltenham Borough Council\n- #1061\n\n## 0.134.0 (2025-02-07)\n\n### Feat\n\n- Ipswich Borough Council - trying different address\n- Ipswich Borough Council - correcting param name in input.json\n- Ipswich Borough Council - added input.json values and refactored code\n- Ipswich Borough Council - initial implementation\n\n## 0.133.0 (2025-02-02)\n\n### Feat\n\n- adding manual refresh\n\n## 0.132.0 (2025-02-02)\n\n### Feat\n\n- adding manual refresh\n\n## 0.131.0 (2025-02-02)\n\n### Feat\n\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding manual refresh\n- adding unit tests for the new manual refresh\n- adding manual refresh control\n\n## 0.130.1 (2025-01-30)\n\n### Fix\n\n- slow councils\n\n## 0.130.0 (2025-01-29)\n\n### Feat\n\n- Add Herefordshire Council (closes: #1011)\n\n### Fix\n\n- Fix spacing in wiki name\n\n## 0.129.0 (2025-01-29)\n\n### Feat\n\n- Adding East Staffordshire Borough Council\n- Adding Boston Borough Council\n\n### Fix\n\n- input.json\n- input.json\n- Adding East Lothian Council\n- #1171\n- #1052\nfix: #1083\n- Leicester City Council\n- #1178\n- Cardiff Council\n- #1175\n- Newcastle City Council\n- #1179\n- #1180\n- Midlothian Council\n- #1192 - Adding Next Page support\n- Swale Borough Council\n- #1139\n\n## 0.128.6 (2025-01-29)\n\n### Fix\n\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n- moving away from broken Allure reporting\n\n## 0.128.5 (2025-01-29)\n\n### Fix\n\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update CheshireEastCouncil.py\n\n## 0.128.4 (2025-01-28)\n\n### Fix\n\n- Update CheshireEastCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update CheshireEastCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n\n## 0.128.3 (2025-01-28)\n\n### Fix\n\n- Update CheshireEastCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n\n## 0.128.2 (2025-01-28)\n\n### Fix\n\n- Add communal recycling and communal rubbish\n- Add garden waste to Merton Council\n\n## 0.128.1 (2025-01-28)\n\n### Fix\n\n- Update AberdeenshireCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n\n## 0.128.0 (2025-01-28)\n\n### Feat\n\n- implement Medway Council (#1021)\n\n### Fix\n\n- Forgot to include skip_get_url\n\n## 0.127.4 (2025-01-25)\n\n### Fix\n\n- NewForestCouncil\n\n## 0.127.3 (2025-01-16)\n\n### Fix\n\n- Vale of White Horse\n- #1156\n- South Oxfordshire Council\n- #1158\n- Surrey Heath Borough Council\n- #1164\n- Carmarthenshire County Council\n- #1167\n- Glasgow City Council\n- #1166\n- Merton Council\n- NewarkAndSherwoodDC\n- Rushcliffe Borough Council\n- Powys Council\n- Staffordshire Moorlands District Council\n- Stroud District Council\n- Vale of Glamorgan Council\n- West Oxfordshire District Council\n\n## 0.127.2 (2025-01-13)\n\n### Fix\n\n- Update bin type to be the full string\n\n## 0.127.1 (2025-01-10)\n\n### Fix\n\n- Use visibility of list rather than existence\n- Update Rushcliffe Borough Council input elements and flow\n\n## 0.127.0 (2025-01-07)\n\n### Feat\n\n- Adding Oadby And Wigston Borough Council\n- Add Gwynedd Council\n- Adding Denbighshire Council\n- Adding Dundee City Council\n- Adding Brent Council\n- Adding West Dunbartonshire Council\n- Adding Cumberland Council\n\n### Fix\n\n- #929\n- Cornwall Council\n- #1137\n- #1125\n- #1106\n- #1108\n- #1109\n- #1134\n- Northumberland Council\n- #1082\n- #1110\n- Waltham Forest\n- #1126\n- London Borough Sutton\n- #1131\n- Kirklees Council\n- #1129 - Breaking Change. UPRN required\n\n## 0.126.2 (2025-01-07)\n\n### Fix\n\n- **tests**: updates test case url for coventry city council\n- **tests**: removes duplicate key for coventry city council\n- updates coventry city council button text\n\n## 0.126.1 (2025-01-06)\n\n### Fix\n\n- behave_testing\n- behave_testing\n\n## 0.126.0 (2025-01-04)\n\n### Feat\n\n- #1063 - rewrite Kirklees Council parser for new website\n- #1067 - Add garden bin collections where available for Norwich City Council\n- Adding Wandsworth Council\n\n### Fix\n\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update README.md to have links to Full and Partial Integration Test Reports\n- Swale Borough Council\n- #1080\n(cherry picked from commit 6f580b39fb68b8079990221e050ae8dd6d2b7285)\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update ArdsAndNorthDownCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update README.md to have links to Full and Partial Integration Test Reports\n- Update WestLindseyDistrictCouncil.py\n- #1101 - Fix table parsing for Walsall Council\n- Remove invalid escape sequence warnings from West Lindsey District Council\n- #1073 - change method of generating bin types to avoid manual mapping for Rugby Borough Council\n- add missing backticks to separate colour config and standard usage instructions\n- #1078\n(cherry picked from commit 89d93666bb659010d1c130b98c1d81c6ff80cf7c)\n- change date format to project default for Merton Council\n- correct date logic for Swale Borough Council\n- Merton Council\n- London Borough Sutton\n- #1076\n(cherry picked from commit 1eab20c9a57c9c4438ea343f374202bb2e9b98ca)\n- Swale Borough Council\n- #1080\n(cherry picked from commit 6f580b39fb68b8079990221e050ae8dd6d2b7285)\n- correct date/year logic for West Lindsey District Council\n- replace West Lindsey's input with working address\n- #1089 - Correct shifted dates in Bromley Borough Council\n- remove WDM import\n- #1087 - Food waste date incorrect for West Berkshire Council\n\n## 0.125.2 (2025-01-04)\n\n### Fix\n\n- Update ArdsAndNorthDownCouncil.py\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update README.md to have links to Full and Partial Integration Test Reports\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_schedule.yml\n- Update behave_pull_request.yml\n- Update behave_pull_request.yml\n- Update behave_schedule.yml\n- Update behave_schedule.yml\n\n## 0.125.1 (2025-01-04)\n\n### Fix\n\n- correctly handle year increment for January dates\n\n## 0.125.0 (2025-01-04)\n\n### Feat\n\n- Adding Redditch Borough Council\n- Adding Blaenau Gwent County Borough Council\n- Adding Wandsworth Council\n\n### Fix\n\n- #1068\n- #1098\n- Wiltshire Council\n- #1094\n- Salford City Council\n- #1097\n- #1078\n- Merton Council\n- Swale Borough Council\n- #1080\n- London Borough Sutton\n- #1076\n- Update behave_schedule.yml\n- Update bump.yml\n\n## 0.124.4 (2025-01-04)\n\n### Fix\n\n- Update behave_schedule.yml\n\n## 0.124.3 (2025-01-04)\n\n### Fix\n\n- allure reporting\n- allure reporting\n- allure reporting\n\n## 0.124.2 (2025-01-03)\n\n### Fix\n\n- Update behave.yml\n\n## 0.124.1 (2025-01-03)\n\n### Fix\n\n- avoid crashing on unexpected string value\n\n## 0.124.0 (2025-01-02)\n\n### Feat\n\n- Hart District Council\n\n## 0.123.2 (2024-12-19)\n\n### Fix\n\n- Update behave.yml\n\n## 0.123.1 (2024-12-18)\n\n### Fix\n\n- Update AberdeenCityCouncil.py\n- Update behave.yml\n\n## 0.123.0 (2024-12-17)\n\n## 0.122.0 (2024-12-04)\n\n### Feat\n\n- Adding Monmouthshire County Council\n- Adding Hinckley and Bosworth Borough Council\n\n### Fix\n\n- Glasgow City Council\n- Merton Council\n- Blaby District Council\n- Warwick District Council\n- Blackburn Council\n- Carmarthenshire County Council\n- High Peak Council\n- CarmarthenshireCountyCouncil\n\n## 0.121.1 (2024-12-03)\n\n### Fix\n\n- London Borough of Lewisham to have more reliable parsing of dates\n\n## 0.121.0 (2024-11-24)\n\n### Feat\n\n- Royal Borough of Greenwich\n- Adding London Borough of Lewisham\n- Adding Hackney Council\n- Adding Sandwell Borough Council\n- Adding Moray Council\n- Adding Kings Lynn and West Norfolk Borough Council\n- Adding Wyre Forest District Council\n- Adding Folkstone and Hythe District Council\n- Adding Cheltenham Borough Council\n- Adding Thurrock Council\n\n### Fix\n\n- West Northamptonshire Council\n- East Ayrshire Council\n- Cotswold District Council\n\n## 0.120.0 (2024-11-20)\n\n### Feat\n\n- Adding Hartlepool Borough Council\n- Adding Newcastle Under Lyme Council\n- Adding London Borough of Havering\n- Add Garden collection to EnvironmentFirst\n- Adding Cumberland Council (Allerdale District)\n- Adding North Hertfordshire District Council\n\n### Fix\n\n- #844\n- #778\n- #769\n- #1025\n- Mid Siffolk and Babergh Garden Collection Day\n- #1026\nThis will require the use of a DAY to be added to the UPRN field\n- #1029\n- #1028\n\n## 0.119.0 (2024-11-20)\n\n### Feat\n\n- Adding Braintree District Council\n- Adding Burnley Borough Council\n- Adding Exeter City Council\n- Adding Edinburgh City Council\n- Adding Aberdeen City Council\n\n### Fix\n\n- #699\n- #1015\n- #1017\n- #894\n- #1019\n\n## 0.118.0 (2024-11-15)\n\n### Feat\n\n- Adding Wolverhampton City Council\n- Adding Stevenage Borough Council\n- Adding Thanet District Council\n- Adding Copeland Borough Council\n- Adding South Hams District Council\n- Adding Rother District Council\n\n### Fix\n\n- #966\n- #989\n- #1004\n- #1006\n- #1008\n- Rother District Council\n- #1009\n- CrawleyBoroughCouncil\n- #1005\n- Adding Garden collection to Babergh and MidSuffolk Council\n- #995\n\n## 0.117.0 (2024-11-13)\n\n### Feat\n\n- Adding South Staffordshire District Council fix: #885\n\n## 0.116.0 (2024-11-12)\n\n### Feat\n\n- Adding Ashfield District Council\n- Adding Gravesham Borough Council\n- Adding Argyll and Bute Council\n\n### Fix\n\n- #579\n- #991\n- #692\n- CheshireWestAndChesterCouncil\n- #993\n- Milton Keynes\n- #702\n- Adding Babergh and Mid Suffolk District Councils\n- #868\nfix: #919\n- Adding Derby City Council\n- #987\n\n## 0.115.0 (2024-11-11)\n\n### Feat\n\n- Adding Warrington Borough Council\n- Adding Antrim And Newtonabbey Council\n- Adding Hertsmere Borough Council\n- Adding West Lancashire Borough Council\n- Broxbourne Council\n\n### Fix\n\n- #695\n- #969\n- #776\n- #980\n- #982\n- Bradford MDC\n- #984\n\n## 0.114.6 (2024-11-09)\n\n### Fix\n\n- NBBC Date Fix\n\n## 0.114.5 (2024-11-08)\n\n### Fix\n\n- migration logging and debugging\n\n## 0.114.4 (2024-11-08)\n\n### Fix\n\n- migration not working\n- migration not working\n\n## 0.114.3 (2024-11-08)\n\n### Fix\n\n- fix manifest in custom component\n\n## 0.114.2 (2024-11-08)\n\n### Fix\n\n- #975 adding routine to handle migration error\n- #975 adding routine to handle migration error\n\n## 0.114.1 (2024-11-08)\n\n### Fix\n\n- Update manifest.json\n\n## 0.114.0 (2024-11-07)\n\n### Feat\n\n- Nuneaton and Bedworth Borough Council\n\n## 0.113.0 (2024-11-07)\n\n### Feat\n\n- adding calendar for Bins in Custom Component\n\n## 0.112.1 (2024-11-07)\n\n### Fix\n\n- #767 BREAKING CHANGE - READD your sensors / config\n\n## 0.112.0 (2024-11-06)\n\n### Feat\n\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- Adding Powys Council\n- Adding Worcester City Council\n- Adding Ards and North Down Council\n- Adding East Herts Council\n- Adding Ashford Borough Council\n- Adding Stockton On Tees Council\n- Adding Fife Council\n- Adding Flintshire County Council\n- Adding Teignbridge Council\n- Adding Harborough District Council\n- Adding Watford Borough Council\n- Adding Coventry City Council\n\n### Fix\n\n- CC testing and add Chesterfield\n- CC testing and add Chesterfield\n- CC testing and add Chesterfield\n- pytest-homeassistant-custom-component\n- Pydandic version\n- Pydandic version\n- WestOxfordshireDistrictCouncil\n- South Norfolk Council\n- ForestOfDeanDistrictCouncil\n- Croydon Council\n- South Kesteven District Council\n- #647\n- #630\n- #623\n- #586\n- #578\n- #389\n- #930\n- #933\n- #750\n- Refactor Midlothian Council scraper to use house number and postcode\n- West Berkshire Council\n- Southwark Council\n- #580\n- #888\n- #902\n- #607\n\n## 0.111.0 (2024-11-06)\n\n### Fix\n\n- Add London Borough of Sutton\n- #944\n- Add Mid Devon Council\n- #945\n- Adding Oxford City Council\n- #962\n- Tunbridge Wells / Lincoln\n- #963\n- Glasgow City Council\n\n## 0.110.0 (2024-11-04)\n\n### Fix\n\n- Adding Blaby District Council\n- #904\n- Adding Sefton Council\n- #770\n- Adding Bromsgrove District Council\n- #893\n- East Lindsey District Council\n- #957\n- Adding Carmarthenshire County Council\n- #892\nfix: #710\n- Adding East Ayrshire Council\n- #955\n\n## 0.109.2 (2024-11-03)\n\n### Fix\n\n- CC testing and add Chesterfield\n\n## 0.109.1 (2024-11-03)\n\n### Fix\n\n- CC testing and add Chesterfield\n- CC testing and add Chesterfield\n\n## 0.109.0 (2024-11-02)\n\n### Feat\n\n- Adding Cotswold District Council\n- Adding Breckland Council\n\n### Fix\n\n- St Helens Borough Council\n- #753\n- NewarkAndSherwoodDC\n- #941\n- #658\n- #656\n\n## 0.108.2 (2024-11-01)\n\n### Fix\n\n- pytest-homeassistant-custom-component\n\n## 0.108.1 (2024-11-01)\n\n### Fix\n\n- Pydandic version\n- Pydandic version\n\n## 0.108.0 (2024-11-01)\n\n### Feat\n\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- pytest fixes\n- Python 3.12 only and CustomComp. Unit testing\n\n## 0.107.0 (2024-10-31)\n\n### Feat\n\n- Adding Powys Council\n- Adding Worcester City Council\n- Adding Ards and North Down Council\n- Adding East Herts Council\n- Adding Ashford Borough Council\n\n### Fix\n\n- WestOxfordshireDistrictCouncil\n- South Norfolk Council\n- ForestOfDeanDistrictCouncil\n- Croydon Council\n- South Kesteven District Council\n- #647\n- #630\n- #623\n- #586\n- #578\n- #389\n\n## 0.106.0 (2024-10-28)\n\n### Feat\n\n- Adding Stockton On Tees Council\n- Adding Fife Council\n- Adding Flintshire County Council\n\n### Fix\n\n- #930\n- #933\n- #750\n- West Berkshire Council\n- Southwark Council\n\n## 0.105.1 (2024-10-24)\n\n### Fix\n\n- Refactor Midlothian Council scraper to use house number and postcode\n\n## 0.105.0 (2024-10-21)\n\n### Feat\n\n- Adding Teignbridge Council\n- Adding Harborough District Council\n- Adding Watford Borough Council\n- Adding Coventry City Council\n\n### Fix\n\n- #580\n- #888\n- #902\n- #607\n\n## 0.104.0 (2024-10-20)\n\n### Feat\n\n- Adding Luton Borough Council\n- Adding West Oxfordshire District Council\n- Adding Aberdeenshire Council\n- Adding Canterbury City Council\n- Adding Swindon Borough Council\n\n### Fix\n\n- #697\n- #694\n- #659\n- #590\n- #900\n\n## 0.103.0 (2024-10-20)\n\n### Feat\n\n- Adding RAW JSON Sensor\n\n### Fix\n\n- Black formatting\n- Black formatting\n\n## 0.102.0 (2024-10-20)\n\n### Feat\n\n- Moving from Attributes to Sensors\n- Moving from Attributes to Sensors\n\n## 0.101.0 (2024-10-20)\n\n### Feat\n\n- Add Midlothgian Council\n\n## 0.100.0 (2024-10-18)\n\n### Feat\n\n- Adding Dudley Council\n- Adding South Ribble Council\n- Plymouth Council\n- Adding Norwich City Council\n\n### Fix\n\n- #744\n- #671\n- #566\n- #749\n\n## 0.99.1 (2024-10-16)\n\n### Fix\n\n- #792 adding web_driver option to Wokingham Council\n\n## 0.99.0 (2024-10-16)\n\n### Feat\n\n- Adding Lincoln Council\n- Adding Tunbridge Wells Council\n- Adding Perth and Kinross Council\n\n### Fix\n\n- Update wiki\n- #748\n- #598\n- #572\n\n## 0.98.5 (2024-10-15)\n\n### Fix\n\n- Swale Borough Council\n- HaltonBoroughCouncil\n- Barnet Council\n- WestBerkshireCouncil\n\n## 0.98.4 (2024-10-14)\n\n### Fix\n\n- West Suffolk Council\n- Vale of White Horse Council\n- Uttlesford District Council\n- Neath Port Talbot Council\n- Merton Council\n- Manchester City Council\n- Glasgow City Council\n- BradfordMDC\n\n## 0.98.3 (2024-10-13)\n\n### Fix\n\n- EastRiding\n\n## 0.98.2 (2024-10-13)\n\n### Fix\n\n- MoleValley\n\n## 0.98.1 (2024-10-13)\n\n### Fix\n\n- Barnet and Bexley\n\n## 0.98.0 (2024-10-13)\n\n### Feat\n\n- Adding Wirral Council\n- Adding Lichfield District Council\n- Adding West Morland And Furness\n- Adding Walsall Council\n- Adding Armagh, Banbridge and Craigavon Council\n\n### Fix\n\n- #602\n- #830\n- #870\n- #873\n- #877\n\n## 0.97.1 (2024-10-10)\n\n### Fix\n\n- NottinghamCityCouncil\n- #875\n\n## 0.97.0 (2024-10-10)\n\n### Feat\n\n- Adding Falkirk Council\n- Adding London Borough Harrow\n- Adding North Ayrshire Council\n\n### Fix\n\n- #761\n- #871\n- #869\n\n## 0.96.0 (2024-10-10)\n\n### Feat\n\n- Adding Highland Council\n- Add Elmbridge Borough Council\n- Adding Southwark Council\n- South Derbyshire District Council\n\n### Fix\n\n- #780\n- #845\nfix: #754\n- #835\n- #842\n\n## 0.95.0 (2024-10-09)\n\n### Feat\n\n- Adding London Borough of Ealing\n\n## 0.94.0 (2024-10-09)\n\n### Feat\n\n- Adding London Borough of Lambeth\n- Adding Dacorum Borough Council\n\n### Fix\n\n- Dacorum Borough Council\n- East Devon DC\n\n## 0.93.0 (2024-10-08)\n\n### Feat\n\n- Update CheshireEastCouncil.py\n\n## 0.92.0 (2024-10-08)\n\n### Feat\n\n- Update CheshireEastCouncil.py\n- Update README.md\n- Adding Wokingham Borough Council\n- Adding Winchester City Council\n- Adding Basildon Council\n- Adding Colchester City Council\n\n### Fix\n\n- RochfordCouncil\n- Neath Port Talbot Council\n- Buckinghamshire Council\n- #639\nfix: #812\n\n## 0.91.2 (2024-10-05)\n\n### Fix\n\n- Windsor and Maidenhead Council\n\n## 0.91.1 (2024-10-04)\n\n### Fix\n\n- Update DorsetCouncil.py\n- #829\n- Update GatesheadCouncil.py\n- #822\n\n## 0.91.0 (2024-10-03)\n\n### Feat\n\n- Adding East Renfrewshire Council\n\n## 0.90.0 (2024-10-03)\n\n## 0.89.1 (2024-10-02)\n\n### Fix\n\n- High Peak have changed their cookie dialog Seems to be safe to ignore it now.\n\n## 0.89.0 (2024-09-27)\n\n### Feat\n\n- Update CheshireEastCouncil.py\n- Update README.md\n\n### Fix\n\n- release to be non pre release\n\n## 0.88.0 (2024-09-16)\n\n### Feat\n\n- Add Ealing Council\n\n### Fix\n\n- Update README.md\n\n## 0.87.0 (2024-09-10)\n\n### Feat\n\n- Add IslingtonCouncil\n\n## 0.86.2 (2024-09-09)\n\n### Fix\n\n- #565 Gloucester city council driver\n\n## 0.86.1 (2024-09-09)\n\n### Fix\n\n- #773 Wakefield\n\n## 0.86.0 (2024-09-06)\n\n### Feat\n\n- added Rotherham Council\n\n## 0.85.7 (2024-09-05)\n\n### Fix\n\n- more unit tests\n- more unit tests\n- Chorley\n\n## 0.85.6 (2024-09-03)\n\n### Fix\n\n- #795 and add reconfigure to custom comp.\n\n## 0.85.5 (2024-09-03)\n\n### Fix\n\n- #795 and add reconfigure to custom comp.\n\n## 0.85.4 (2024-09-03)\n\n### Fix\n\n- #795 Unit Test Coverage\n\n## 0.85.3 (2024-09-02)\n\n### Fix\n\n- #795 unit test coverage\n\n## 0.85.2 (2024-09-02)\n\n### Fix\n\n- 791 Glasgow URL change\n\n## 0.85.1 (2024-09-02)\n\n### Fix\n\n- 779 Add correct async wait to Home Assistant\n\n## 0.85.0 (2024-08-27)\n\n### Feat\n\n- support for enfield council\n\n## 0.84.2 (2024-08-27)\n\n### Fix\n\n- Re-work North Tyneside Council module for 2024 - some addresses do not have a garden collection\n- Re-work North Tyneside Council module for 2024\n\n## 0.84.1 (2024-08-08)\n\n### Fix\n\n- #771 Bolton bullet points on dates is now fixed\n\n## 0.84.0 (2024-07-31)\n\n## 0.83.0 (2024-07-07)\n\n### Feat\n\n- add has_numbers() function\n\n### Fix\n\n- update Gedling Borough Council parser to use alternative name key\n- change Gedling to use new JSON data\n- update instructions for Gedling\n\n## 0.82.1 (2024-06-28)\n\n### Fix\n\n- update input.json to use UPRN parameter\n- change DorsetCouncil.py to use API links provided in #756\n- explicit import of logging.config to stop error in Python 3.11\n\n## 0.82.0 (2024-06-13)\n\n### Feat\n\n- adding dev container updates\n- adding dev container updates\n- refactoring main files\n- adding ability to set local mode in HA custom comp. if users dont have a Selenium Server\n\n### Fix\n\n- MidSussex\n\n## 0.81.0 (2024-06-05)\n\n### Feat\n\n- Adding Wychavon District Council\n\n### Fix\n\n- IntTestWarnings\n- IntTestWarnings\n\n## 0.80.0 (2024-06-02)\n\n### Feat\n\n- Adding Uttlesford District Council\n- Adding Stafford Boro Council\n- Adding Swansea Council\n- Adding New Forest\n- Adding Three Rivers\n- Adding Three Rivers\n\n### Fix\n\n- ThreeRivers\n- #425 Entities are not updated\n- sessions to avoid deprecation\n- Update docker-image.yml\n- Update docker-image.yml\n\n## 0.79.1 (2024-05-29)\n\n### Fix\n\n- Change CSS class in search for collection types\n\n## 0.79.0 (2024-05-28)\n\n### Feat\n\n- Adding Dartford\n- Adding South Kesteven District Council\n- Adding ChichesterCouncil\n- adding HounslowCouncil\n- adding HounslowCouncil\n- adding HounslowCouncil\n- Epping Fix\n- Adding Epping Forest District Council\n- Update input.json\n- Epping Forest District Council\n- Adding Stroud District Council\n- Add support for Tendring District Council\n- #269 Adding Waltham Forest\n- #269 Adding Waltham Forest\n- Adding council creation script\n\n### Fix\n\n- Update Mole Valley URL\n\n## 0.78.0 (2024-05-26)\n\n### Feat\n\n- Add support for Fareham Borough Council\n\n## 0.77.0 (2024-05-26)\n\n### Feat\n\n- Add support for Bracknell Forest Council\n\n## 0.76.1 (2024-05-24)\n\n### Fix\n\n- Handle Barnet council cookies message\n\n## 0.76.0 (2024-05-24)\n\n### Feat\n\n- add bin colour support WestSuffolkCouncil style: black format WestSuffolkCouncil\n- add bin colour support WestSuffolkCouncil style: black format WestSuffolkCouncil\n\n## 0.75.0 (2024-05-19)\n\n### Feat\n\n- #725 Add names to selenium test videos using \"se:name\" option in create webdriver function\n\n## 0.74.1 (2024-05-18)\n\n### Fix\n\n- #693 Cheshire West & Chester Council Sensor Bug\n- #693 Cheshire West & Chester Council Sensor Bug\n\n## 0.74.0 (2024-05-17)\n\n### Feat\n\n- #722 Support Python 3.12\n- #722 Support Python 3.12\n- #722 Support Python 3.12\n\n## 0.73.0 (2024-05-17)\n\n### Feat\n\n- #708 Adding HA to the dev container for debugging\n\n## 0.72.0 (2024-05-17)\n\n### Feat\n\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n- #708 Adding HA to the dev container for debugging\n\n## 0.71.0 (2024-05-17)\n\n### Feat\n\n- Update for West Suffolk Councils new website\n\n## 0.70.0 (2024-05-17)\n\n### Feat\n\n- #708 Dev Container\n- Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 Dev Container\n- #708 simplifying Selenium integration tests\n- #708 simplifying Selenium integration tests\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Test GH action seenium\n- #708 Dev Container testing\n- #708 - dev container changes\n- #706 Adding Dev Container\n- #706 Adding initial Dev Container\n\n## 0.69.7 (2024-05-17)\n\n### Fix\n\n- #713 BarnsleyMBCouncil.py\n\n## 0.69.6 (2024-05-16)\n\n### Fix\n\n- #709 Update DoverDistrictCouncil.py\n\n## 0.69.5 (2024-05-14)\n\n### Fix\n\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 Small issue and Black formatting\n- #696 test coverage back to 100%\n\n## 0.69.4 (2024-05-09)\n\n### Fix\n\n- pass in required parameter into `create_webdriver`\n- test runners for `MiltonKeynesCityCouncil` and `NorthEastLincs`.\n\n## 0.69.3 (2024-05-09)\n\n### Fix\n\n- fix AttributeError when no garden waste collection is available for properties using Huntingdon District Council\n- add support for parsing \"Today\" / \"Tomorrow\" as date text for `BarnsleyMBCouncil`\n- add support for parsing \"Tomorrow\" as date text for `LiverpoolCityCouncil`\n\n## 0.69.1 (2024-05-01)\n\n### Fix\n\n- Handling the \"Website cookies enhance your user experience.\" button\n- Handling the \"Website cookies enhance your user experience.\" button\n\n## 0.69.0 (2024-04-28)\n\n### Feat\n\n- Adding Renfrewshire Council\n- Adding Renfrewshire Council\n\n## 0.68.2 (2024-04-28)\n\n### Fix\n\n- Remove 'import Dumper'\n\n## 0.68.1 (2024-04-27)\n\n### Fix\n\n- input.json Bradford missing comma\n\n## 0.68.0 (2024-04-27)\n\n### Feat\n\n- Add support for West Berkshire Council\n- add support for Knowsley Metropolitan Borough Council\n- add support for Cheshire West and Chester Council\n- add support for Cheshire West and Chester Council\n\n## 0.66.2 (2024-04-18)\n\n### Fix\n\n- Update HaringeyCouncil.py issue #670\n\n## 0.66.1 (2024-04-15)\n\n### Fix\n\n- parse datetimes correctly and round to midnight\n\n## 0.66.0 (2024-04-15)\n\n## 0.65.2 (2024-04-15)\n\n### Fix\n\n- change address selection to fix errors selecting the user's PAON\n\n## 0.65.1 (2024-04-15)\n\n### Fix\n\n- add check for parsed string length to stop datetime parsing error\n\n## 0.65.0 (2024-04-13)\n\n### Feat\n\n- add Arun council\n- add support for Sunderland City Council\n- add support for Sunderland City Council\n\n## 0.64.3 (2024-03-25)\n\n### Fix\n\n- sort data and correct dictionary name (#609)\n\n## 0.64.2 (2024-03-24)\n\n## 0.64.1 (2024-03-24)\n\n### Fix\n\n- fix Kirklees address search (switch to house & postcode)\n- fixes json\n\n## 0.64.0 (2024-03-23)\n\n### Feat\n\n- add Kirklees council\n\n### Fix\n\n- fixes json\n\n## 0.63.0 (2024-03-23)\n\n### Feat\n\n- Add Solihull Council (#513)\n- Add Adur and Worthing Councils (#544)\n- Add Dover District Council (#614)\n- Add Rochford Council (#620)\n- Add Tandridge District Council (#621)\n- Add West Northamptonshire Council (#567)\n- Add Hull City Council (#622)\n- Add Wyre Council (#625)\n- Add Telford and Wrekin Co-operative Council (#632)\n- Add Mansfield District Council (#560)\n- Add Bedford Borough Council (#552)\n\n### Fix\n\n- spacing on input.json\n- realign input.json\n- capitalize bin type text\n- formatting on input.json\n- incorrect collections\n- update testing URL for Merton\n- attempt to resolve invisible banner hiding postcode box\n- resolve JSON schema exception for date formatting\n- resolve JSON schema exception for date formatting\n- accept cookies banner\n\n## 0.62.0 (2024-03-03)\n\n### Fix\n\n- Added missing .feature file entry to the test config for NewhamCouncil\n\n## 0.61.1 (2024-02-16)\n\n### Fix\n\n- code optimisations\n- Fix date parsing in WestLindseyDistrictCouncil.py\n\n## 0.61.0 (2024-02-11)\n\n### Feat\n\n- Add Mole Valley District Council\n\n## 0.60.1 (2024-02-03)\n\n### Fix\n\n- Update input.json Closes #599\n\n## 0.60.0 (2024-01-28)\n\n### Feat\n\n- Add Scraper for St Albans City and District Council\n\n## 0.59.1 (2024-01-25)\n\n### Fix\n\n- add wiki note for castlepoint\n- update test data for castlepoint\n- remove single line causing issues\n\n## 0.59.0 (2024-01-20)\n\n### Feat\n\n- Add NorthYorkshire to test feature file\n- Add north yorkshire to test input\n- Add Support for north yorkshire council\n\n### Fix\n\n- remove unused code\n\n## 0.58.8 (2024-01-19)\n\n### Fix\n\n- barnet no overrides\n\n## 0.58.7 (2024-01-18)\n\n### Fix\n\n- accidentally returned strings when needed date objects, refactor to handle this\n- checking for future/past dates\n\n## 0.58.6 (2024-01-18)\n\n### Fix\n\n- correct date handling for North West Leicestershire\n\n## 0.58.5 (2024-01-15)\n\n### Fix\n\n- Don't call driver.quit where already handled by finally block\n\n## 0.58.4 (2024-01-15)\n\n### Fix\n\n- remove extra driver.quit to prevent errors\n\n## 0.58.3 (2024-01-15)\n\n### Feat\n\n- Added support for Newham Council's bin collections\n\n### Fix\n\n- Add a default value for user_agent to fix all councils using selenium and not specifying agent\n\n## 0.58.2 (2024-01-11)\n\n### Fix\n\n- use static values for bin types\n\n## 0.58.1 (2024-01-10)\n\n### Fix\n\n- Eastleigh Borough Council doesnt cope with \"You haven't yet signed up for ...\"\n- Eastleigh Borough Council doesnt cope when Garden Waste service hasn't been signed up for, which gets the value \"You haven't yet signed up for our garden waste collections. Find out more about our\\xa0garden waste collection service\" which results in ValueError: time data\n\n## 0.58.0 (2024-01-10)\n\n### Feat\n\n- Add Test Valley Borough Council\n\n## 0.57.0 (2024-01-09)\n\n### Feat\n\n- Add support for Chorley Council\n\n## 0.56.13 (2024-01-09)\n\n### Fix\n\n- update logic to account for council website change\n\n## 0.56.12 (2024-01-09)\n\n### Fix\n\n- duplicate driver.quit() calls causes error\n\n## 0.56.11 (2024-01-08)\n\n### Fix\n\n- Headless now working on custom comp Update sensor.py\n\n## 0.56.10 (2024-01-08)\n\n### Fix\n\n- headless mode in custom component\n\n## 0.56.9 (2024-01-08)\n\n### Fix\n\n- headless mode\n\n## 0.56.8 (2024-01-08)\n\n### Fix\n\n- headless in custom comp\n\n## 0.56.7 (2024-01-08)\n\n### Fix\n\n- headless options\n\n## 0.56.6 (2024-01-07)\n\n### Fix\n\n- modified Kingston-upon-Thames driver for greater reliability.\n\n## 0.56.5 (2024-01-07)\n\n### Fix\n\n- Update KingstonUponThamesCouncil.py\n\n## 0.56.4 (2024-01-07)\n\n### Fix\n\n- Update KingstonUponThamesCouncil.py\n\n## 0.56.3 (2024-01-07)\n\n### Fix\n\n- headless options\n- #542 - Selenium Grid Sessions must be terminated cleanly\n- #542 - Selenium Grid Sessions must be terminated cleanly\n\n## 0.56.2 (2024-01-07)\n\n### Fix\n\n- Update strings.json\n- Update en.json\n- Update config_flow.py\n\n## 0.56.1 (2024-01-07)\n\n### Fix\n\n- Update common.py\n\n## 0.56.0 (2024-01-07)\n\n### Feat\n\n- Update strings.json\n- Update en.json\n- Update config_flow.py\n- adding headless control\n- adding headless control\n- adding headless control\n\n## 0.55.3 (2024-01-05)\n\n### Fix\n\n- Update lint.yml\n\n## 0.55.2 (2024-01-05)\n\n### Fix\n\n- Chelmsford\n\n## 0.55.1 (2024-01-05)\n\n### Fix\n\n- Update ChelmsfordCityCouncil.py\n- Update ChelmsfordCityCouncil.py\n- Update ChelmsfordCityCouncil.py\n\n## 0.55.0 (2024-01-05)\n\n### Feat\n\n- Update codeql-analysis.yml\n- Update behave.yml\n- Update CONTRIBUTING.md\n- Update behave.yml\n- Update behave.yml\n- Update ConwyCountyBorough.py\n- Update behave.yml\n- Update CheshireEastCouncil.py\n- Update behave.yml\n- Update behave.yml\n- Update behave.yml\n- Update Makefile\n- Update Makefile\n- Update behave.yml\n- Update Makefile\n- Update validate_council_outputs.feature\n\n## 0.54.0 (2024-01-04)\n\n### Feat\n\n- Barnet seasonal overrides\n\n## 0.53.2 (2024-01-04)\n\n### Fix\n\n- barnet (again)\n\n## 0.53.1 (2024-01-04)\n\n### Fix\n\n- barnet\n\n## 0.53.0 (2024-01-04)\n\n### Feat\n\n- barnet council\n\n## 0.52.0 (2024-01-04)\n\n### Feat\n\n- #525 Adding API Server and Docker build\n- #525 Adding API Server and Docker build\n\n## 0.51.0 (2024-01-04)\n\n### Feat\n\n- #522 Adding Nottingham City Council\n\n## 0.50.1 (2024-01-03)\n\n### Fix\n\n- don't ask for URL for Vale of White Horse Council\n\n## 0.50.0 (2024-01-03)\n\n### Feat\n\n- add Vale of White Horse District Council\n\n### Fix\n\n- account for additional string on exceptional schedule\n\n## 0.49.1 (2024-01-01)\n\n### Fix\n\n- Torbay\n\n## 0.49.0 (2024-01-01)\n\n### Feat\n\n- add South Gloucestershire Council\n\n## 0.48.3 (2024-01-01)\n\n### Fix\n\n- manifest.json\n\n## 0.48.2 (2024-01-01)\n\n### Fix\n\n- manifest.json to remove depricated attribute\n\n## 0.48.1 (2024-01-01)\n\n### Fix\n\n- Hacs Validation Pipeline\n\n## 0.48.0 (2024-01-01)\n\n### Feat\n\n- Adding HACS Validation\n\n## 0.47.0 (2024-01-01)\n\n### Feat\n\n- Add hassfest validation.yml\n\n## 0.46.1 (2023-12-31)\n\n### Fix\n\n- Black formatting\n- Fix GuildfordCouncil\n\n## 0.46.0 (2023-12-31)\n\n### Feat\n\n- Adding Brighton and Hove City Council\n- Adding Brighton and Hove City Council\n- Adding Brighton and Hove City Council\n- Adding Brighton and Hove City Council\n- Adding London Borough Redbridge\n- London Borough Redbridge\n- Adding LondonBoroughRedbridge 431\n\n### Fix\n\n- chelmsford #407\n\n## 0.45.0 (2023-12-29)\n\n### Feat\n\n- Add Haringey Council.\n\n## 0.44.2 (2023-12-29)\n\n### Fix\n\n- #509 Wiltshire Update input.json\n\n## 0.44.1 (2023-12-28)\n\n### Fix\n\n- Bexley\n- CharnwoodBoroughCouncil\n\n## 0.44.0 (2023-12-27)\n\n### Feat\n\n- Adding support for Gedling Borough Council\n\n## 0.43.0 (2023-12-25)\n\n### Feat\n\n- add Newport City Council\n\n## 0.42.1 (2023-12-24)\n\n### Feat\n\n- Initial Test Commit for Gedling Borough Council\n\n### Fix\n\n- CastlepointDistrictCouncil\n- 191_fixingbroken_councils\n- 191_fixingbroken_councils\n- 191_fixingbroken_councils\n\n## 0.42.0 (2023-12-19)\n\n### Feat\n\n- Adding West Lindsey District Council\n- Adding West Lindsey District Council\n\n## 0.41.5 (2023-12-18)\n\n### Fix\n\n- #191 Preston City Council\n\n## 0.41.4 (2023-12-17)\n\n### Fix\n\n- #493 Update input.json\n\n## 0.41.3 (2023-12-17)\n\n### Fix\n\n- #27 East Riding\n\n## 0.41.2 (2023-12-17)\n\n### Fix\n\n- #493 Leeds issues\n\n## 0.41.1 (2023-12-17)\n\n### Fix\n\n- Add in URL override for wiki\n- Update RushmoorCouncil.py to use new URL\n\n## 0.41.0 (2023-12-16)\n\n### Feat\n\n- #264 Adding Oldham\n- #250 Adding Halton Borough Council\n- #244 Adding Portsmouth City Council\n\n### Fix\n\n- #141 Leeds speed up\n- #174 / #244 / #204\n\n## 0.40.1 (2023-12-16)\n\n### Fix\n\n- 488_blackburnfixes\n\n## 0.40.0 (2023-12-15)\n\n### Feat\n\n- adding #204 Forest_of_Dean_District\n- adding #204 Forest_of_Dean_District\n\n## 0.39.0 (2023-12-13)\n\n### Feat\n\n- Adding support for Reading Borough Council\n\n## 0.38.0 (2023-12-12)\n\n### Feat\n\n- Add Shropshire Council\n\n## 0.37.2 (2023-12-08)\n\n### Fix\n\n- Issue 394 - change coordinator data from numerical indexed list to dictionary\n\n## 0.37.1 (2023-12-08)\n\n### Fix\n\n- add postcode and uprn for Bedfordshire Council\n\n## 0.37.0 (2023-12-07)\n\n### Feat\n\n- Add BefordshireCouncil scraper\n\n## 0.36.0 (2023-12-07)\n\n### Feat\n\n- adding NorthEastDerbyshireDistrictCouncil\n\n## 0.35.1 (2023-12-06)\n\n### Fix\n\n- move logging config to collect_data script\n\n## 0.35.0 (2023-12-06)\n\n### Feat\n\n- Adding North_West_Leicestershire\n- Adding North_West_Leicestershire\n\n## 0.34.0 (2023-12-05)\n\n### Feat\n\n- Add Sevenoaks District Council\n- Add Barnsley Metropolitan Borough Council to the feature file\n- Add Barnsley Metropolitan Borough Council to input.json\n- Add support for Barnsley Council (#444)\n- Add Dorset Council to feature file\n- Add Dorset Council to input.json\n- Add support for Dorset Council\n- Add Rugby Borough Council to feature file\n- Add Rugby Borough Council to input.json\n- Add parser for Rugby Borough Council (#456)\n\n## 0.32.1 (2023-12-04)\n\n### Fix\n\n- Move LiverpoolCityCouncil.py to correct folder\n\n## 0.32.0 (2023-12-01)\n\n### Feat\n\n- Add extra files for Stoke-on-Trent support\n- Add support for Stoke-on-Trent (re: #440)\n\n## 0.31.1 (2023-12-01)\n\n### Fix\n\n- change logic to add correct years and support 'Tomorrow' results\n\n## 0.31.0 (2023-12-01)\n\n### Feat\n\n- Add support for Environment First collections (re: #433)\n- Add support for Environment First collections (re: #433)\n- change parameter name of 'x' to 'step' in get_dates_every_x_days()\n\n## 0.30.1 (2023-12-01)\n\n### Fix\n\n- Increase data update timeout for slower selenium based tests\n\n## 0.30.0 (2023-11-30)\n\n### Feat\n\n- Added WestSuffolkCouncil\n\n## 0.29.1 (2023-11-29)\n\n### Fix\n\n- Fix scraper for Bolton\n\n## 0.29.0 (2023-11-26)\n\n### Feat\n\n- Add Mid and East Antrim\n- Add Mid and East Antrim\n- Add Mid and East Antrim\n\n## 0.28.1 (2023-11-22)\n\n### Fix\n\n- basingstoke adapt to basingstoke site changes\n\n## 0.28.0 (2023-11-08)\n\n### Feat\n\n- Add support files for Liverpool City Council\n- Add additional comments\n- Add Liverpool City Council parser\n\n### Fix\n\n- change dateutil name\n\n## 0.27.2 (2023-11-08)\n\n### Fix\n\n- Custom component web driver field label\n\n## 0.27.1 (2023-11-05)\n\n### Fix\n\n- 419-fix-selenium-behave-tests\n\n## 0.27.0 (2023-11-04)\n\n### Feat\n\n- Update EastSuffolkCouncil.py\n- Change bin_type's to be title() so it reads better\n- Driver quit needs to be after last use of driver\n\n## 0.26.0 (2023-11-03)\n\n### Feat\n\n- Add remote Selenium web driver support\n\n## 0.25.0 (2023-11-03)\n\n### Feat\n\n- Update dev mode & remove JSON outputs\n- Update dev mode & remove JSON outputs\n- Update dev mode & remove JSON outputs\n\n## 0.24.3 (2023-11-01)\n\n### Feat\n\n- Add remote Selenium web driver support\n- Add remote Selenium web driver support\n- Add remote Selenium web driver support\n- Add remote Selenium web driver support\n\n### Fix\n\n- Holidays subdivision error\n\n## 0.24.2 (2023-11-01)\n\n### Fix\n\n- #378 update East Northamptionshire to North Northamptonshire\n\n## 0.24.1 (2023-11-01)\n\n### Fix\n\n- 410 Adding more behave logging and hamcrest assertations\n\n## 0.24.0 (2023-10-31)\n\n### Feat\n\n- Replace individual council schema's with a single common one\n\n## 0.23.2 (2023-10-30)\n\n### Fix\n\n- #399 - DeprecationWarning: Python Package holidays\n\n## 0.23.1 (2023-10-30)\n\n### Fix\n\n- unit test coverage\n\n## 0.23.0 (2023-10-30)\n\n### Feat\n\n- Add support for Conwy council\n\n## 0.22.0 (2023-10-30)\n\n## 0.21.3 (2023-10-29)\n\n### Feat\n\n- Add support for Calderdale Council\n\n### Fix\n\n- Home Assistant custom component fix for Selenium based councils\n- Home Assistant custom component fix for Selenium based councils\n- Fix Chelmsford City Council\n- Fix input.json order\n\n## 0.21.1 (2023-10-24)\n\n### Fix\n\n- Fix the incorrect key collectionTime in json output of Salford Council\n\n## 0.21.0 (2023-10-23)\n\n### Feat\n\n- Add support for West Lothian Council\n- Add support for East Lindsey District Council\n- Add support for Gateshead Council\n- Add support for Staffordshire Moorlands District Council\n\n## 0.20.0 (2023-10-20)\n\n### Feat\n\n- Add support for Cannock Chase District Council\n\n## 0.19.0 (2023-10-19)\n\n### Feat\n\n- fix missing comma in test input for eastsuffolkcouncil\n\n## 0.18.0 (2023-10-19)\n\n### Feat\n\n- Add EastSuffolkCouncil support\n\n## 0.17.0 (2023-10-19)\n\n### Feat\n\n- Add support for Bury Council (#265)\n- Add support for Bury Council (#265)\n\n### Fix\n\n- correctly align input.json\n\n## 0.16.0 (2023-10-18)\n\n### Feat\n\n- Add support for Neath Port Talbot Council\n\n## 0.15.0 (2023-10-18)\n\n### Feat\n\n- StratfordUponAvonCouncil Addition\n\n## 0.14.0 (2023-10-18)\n\n### Feat\n\n- Rename Chilterns to Buckinghamshire Council\n\n## 0.13.4 (2023-10-16)\n\n### Fix\n\n- Update poetry.lock to allow any urllib3 version\n\n## 0.13.3 (2023-10-15)\n\n### Fix\n\n- Remove options flow from home assistant custom component\n\n## 0.13.2 (2023-10-15)\n\n### Fix\n\n- Update poetry.lock\n\n## 0.13.1 (2023-10-15)\n\n### Fix\n\n- Remove first BS4 call to stop page read\n- fix ValueError and add in correct year data\n- swap Crawley's USRN for house number\n- fix date parsing and change BS4 logic\n\n## 0.13.0 (2023-10-11)\n\n### Feat\n\n- Add supporting files for Rhondda Cynon Taff Council\n\n## 0.12.1 (2023-09-28)\n\n### Feat\n\n- Add support for Reigate and Banstead Borough Council\n\n### Fix\n\n- Fix for Wakefield City Council custom component support\n- Fix for Wakefield City Council custom component support\n\n## 0.11.0 (2023-09-27)\n\n### Feat\n\n- Add support for Bath and North East Somerset Council\n- Add support for multiple instances of the custom component\n\n### Fix\n\n- Fix Python Semantic Release version\n- Fix Wakefield City Council\n\n## 0.10.1 (2023-09-16)\n\n## 0.10.0 (2023-09-16)\n\n## 0.9.0 (2023-07-28)\n\n## 0.8.0 (2023-07-23)\n\n## 0.7.0 (2023-07-23)\n\n## 0.6.0 (2023-07-22)\n\n## 0.5.0 (2023-07-21)\n\n## 0.4.0 (2023-07-20)\n\n## 0.3.0 (2023-07-18)\n\n## 0.2.0 (2023-07-16)\n\n## 0.1.0 (2023-07-16)\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity\nand orientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n* Demonstrating empathy and kindness toward other people\n* Being respectful of differing opinions, viewpoints, and experiences\n* Giving and gracefully accepting constructive feedback\n* Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n* Focusing on what is best not just for us as individuals, but for the\n overall community\n\nExamples of unacceptable behavior include:\n\n* The use of sexualized language or imagery, and sexual attention or\n advances of any kind\n* Trolling, insulting or derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or email\n address, without their explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at\n.\nAll complaints will be reviewed and investigated promptly and fairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series\nof actions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or\npermanent ban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within\nthe community.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.0, available at\nhttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.\n\nCommunity Impact Guidelines were inspired by [Mozilla's code of conduct\nenforcement ladder](https://github.com/mozilla/diversity).\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see the FAQ at\nhttps://www.contributor-covenant.org/faq. Translations are available at\nhttps://www.contributor-covenant.org/translations.\n" }, { "path": "COMPATIBILITY.md", "content": "# Home Assistant Compatibility\n\nThis document outlines the Home Assistant compatibility testing for the UK Bin Collection custom component.\n\n## Supported Versions\n\nThe UK Bin Collection custom component is tested against the following Home Assistant versions:\n\n- **Minimum supported**: Home Assistant 2023.10.0\n- **Recommended**: Latest stable release\n- **Development**: Latest dev builds (may have issues)\n\n## Automated Testing\n\n### GitHub Workflows\n\n1. **Home Assistant Compatibility Test** (`.github/workflows/ha_compatibility_test.yml`)\n - Runs on every push to master/main\n - Tests against multiple HA versions\n - Validates component imports and manifest\n - Runs weekly to catch breaking changes\n\n2. **HACS Validation** (`.github/workflows/hacs_validation.yml`)\n - Includes HassFest validation\n - HACS action validation\n - Quick compatibility check\n\n### Manual Testing\n\nRun the compatibility checker locally:\n\n```bash\n# From the project root directory\npython scripts/check_ha_compatibility.py\n```\n\nThis script will:\n- ✅ Validate manifest.json structure\n- ✅ Test component module imports\n- ✅ Check Home Assistant version\n- ✅ Verify dependencies are installed\n\n## Compatibility Matrix\n\n| Home Assistant Version | Status | Notes |\n|------------------------|--------|-------|\n| 2023.10.x | ✅ Supported | Minimum version |\n| 2023.12.x | ✅ Supported | Stable |\n| 2024.1.x | ✅ Supported | Stable |\n| 2024.3.x | ✅ Supported | Stable |\n| 2024.6.x | ✅ Supported | Stable |\n| 2024.9.x | ✅ Supported | Stable |\n| 2024.12.x | ✅ Supported | Latest stable |\n| dev | ⚠️ Testing | May have breaking changes |\n\n## Breaking Changes\n\n### Home Assistant 2023.10.0\n- Minimum Python version: 3.12\n- Updated async patterns required\n\n### Future Considerations\n- Monitor HA core API changes\n- Update component when deprecated features are removed\n- Test against beta releases before stable release\n\n## Troubleshooting\n\n### Common Issues\n\n1. **Import Errors**\n - Ensure Home Assistant is properly installed\n - Check Python version compatibility (≥3.12)\n - Verify uk-bin-collection package is installed\n\n2. **Manifest Validation Failures**\n - Check manifest.json syntax\n - Ensure all required fields are present\n - Verify version numbers match\n\n3. **Component Load Failures**\n - Check Home Assistant logs\n - Verify component files are in correct location\n - Ensure dependencies are satisfied\n\n### Getting Help\n\nIf you encounter compatibility issues:\n\n1. Check the [GitHub Issues](https://github.com/robbrad/UKBinCollectionData/issues)\n2. Run the compatibility checker: `python scripts/check_ha_compatibility.py`\n3. Post in the [Home Assistant Community Thread](https://community.home-assistant.io/t/bin-waste-collection/55451)\n4. Create a new issue with:\n - Home Assistant version\n - Component version\n - Error logs\n - Compatibility check output\n\n## For Developers\n\n### Adding New HA Version Tests\n\n1. Update `.github/workflows/ha_compatibility_test.yml`\n2. Add new version to the matrix\n3. Test locally first: `python scripts/check_ha_compatibility.py`\n4. Update compatibility matrix in this document\n\n### Testing Locally\n\n```bash\n# Install specific HA version\npip install homeassistant==2024.12.0\n\n# Install component in development mode\npip install -e .\n\n# Run compatibility check\npython scripts/check_ha_compatibility.py\n\n# Run component tests\npython -m pytest custom_components/uk_bin_collection/tests/\n```" }, { "path": "CONTRIBUTING.md", "content": "\n# Contents\n- [Contents](#contents)\n- [Contributor guidelines](#contributor-guidelines)\n - [Getting Started](#getting-started)\n - [Environment Setup](#environment-setup)\n - [Project Aims](#project-aims)\n - [What can I contribute to?](#what-can-i-contribute-to)\n - [Claiming an issue](#claiming-an-issue)\n - [Pushing your changes](#pushing-your-changes)\n- [Adding a scraper](#adding-a-scraper)\n - [Developing](#developing)\n - [Developing using our Dev Container](#developing-using-our-dev-container)\n - [Prerequisites](#prerequisites)\n - [Step 1: Clone the Repository](#step-1-clone-the-repository)\n - [Step 2: Set Up Docker](#step-2-set-up-docker)\n - [Step 3: Open the Project in VSCode](#step-3-open-the-project-in-vscode)\n - [Step 4: Reopen in Container](#step-4-reopen-in-container)\n - [Step 5: Verify the Development Environment](#step-5-verify-the-development-environment)\n - [Developing](#developing-1)\n - [Kwargs](#kwargs)\n - [Common Functions](#common-functions)\n - [Additional files](#additional-files)\n - [Input JSON file](#input-json-file)\n - [Testing](#testing)\n - [Behave (Integration Testing)](#behave-integration-testing)\n - [Running the Behave tests for all councils](#running-the-behave-tests-for-all-councils)\n - [Running the Behave tests for a specific council](#running-the-behave-tests-for-a-specific-council)\n - [GitHub Actions Integration Tests](#github-actions-integration-tests)\n - [Test Results](#test-results)\n - [Allure Report](#allure-report)\n - [CodeCov Report](#codecov-report)\n - [Pytest (Unit Testing)](#pytest-unit-testing)\n - [Running the Unittests](#running-the-unittests)\n- [Contact info](#contact-info)\n\n\n\n# Contributor guidelines\nThis document contains guidelines on contributing to the UKBCD project including how the project works, how to set up\nthe environment, how we use our issue tracker, and how you can develop more scrapers.\n\n## Getting Started\nYou will need to install Python on the system you plan to run the script from. Python 3.12 is tested on this project .\n\nThe project uses [poetry](https://python-poetry.org/docs/) to manage dependencies and setup the build environment.\n\n### Environment Setup\n```\npip install poetry\n\n# Clone the Repo\ngit clone https://github.com/robbrad/UKBinCollectionData\ncd UKBinCollectionData\n\n# Install Dependencies \npoetry install\npoetry shell\n```\n\n## Project Aims\n- To provide a real-world environment to learn Python and/or web scraping\n- To provide UK bin data in a standardised format for use (albeit not exclusively) with [HomeAssistant](https://www.home-assistant.io/)\n\n### What can I contribute to?\n- The majority of project work comes from developing new scrapers for requested councils. These can be found on the [issue tracker](https://github.com/robbrad/UKBinCollectionData/labels/council%20request) with `council request` labels.\n- Tasks that require [additional input](https://github.com/robbrad/UKBinCollectionData/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) have the `help wanted` label - these can be trickier requests or may have many smaller tasks.\n- [Easier tasks](https://github.com/robbrad/UKBinCollectionData/labels/good%20first%20issue), that would be a good fit for people new to the project or the world of web scraping are labelled with the `good first issue` label\n\n## Claiming an issue\nIf there is an existing issue you wish to work on, please do the following things:\n- Assign the issue to yourself (or ask someone to assign you) - that way, others know you're working on it\n- Create a new branch - its recommended to use the 'create a branch' option on the issue page, create it in your forked repo and then checkout the branch locally (or in your IDE).\n\n**NB:** Exploratory work doesn't require claiming an issue - you only need to claim if you plan on developing the full scraper and associated files. If you just want to explore an issue, feel free to do so - and also feel free to post anything helpful in the issue comments.\n\n## Pushing your changes\nThere are guides below on how to add a scraper to the project, along with what files are needed and what tests should be run.\nWhen the time comes to push your changes, please be aware that we use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) to provide a clear summary of what a change does. This means that commit messages should start with one of the following:\n- `feat:` for a new feature (including a new scraper)\n- `fix:` for when a bug is fixed or an issue is resolved\n- `docs:` for when changes to documentations are made\n\nDon't worry if you forget - commit messages are automatically checked when you open a merge request by a lint checker, and can easily be rectified by recommitting or pushing again with the correct prefix.\n\n\n\n# Adding a scraper\nThis project uses a design pattern called the [Template Method](https://refactoring.guru/design-patterns/template-method) which basically allows for a structured class that can be extended. In our case, the getting of the data from the council and the presentation of the JSON remains the same via the [abstract class](https://github.com/robbrad/UKBinCollectionData/blob/master/uk_bin_collection/uk_bin_collection/get_bin_data.py#L21) - however the scraping of each council is different and this allows us to have a class for each [council](https://github.com/robbrad/UKBinCollectionData/tree/master/uk_bin_collection/uk_bin_collection/councils) - you can see this in action [here](https://github.com/robbrad/UKBinCollectionData/blob/master/uk_bin_collection/uk_bin_collection/councils/CheshireEastCouncil.py#L5,L16).\n\nThere are a few different options for scraping, and you are free to choose whichever best suits the council:\n- Using [Beautiful Soup 4](https://github.com/robbrad/UKBinCollectionData/blob/master/uk_bin_collection/uk_bin_collection/councils/CheshireEastCouncil.py)\n- Using the [requests](https://github.com/robbrad/UKBinCollectionData/blob/master/uk_bin_collection/uk_bin_collection/councils/ManchesterCityCouncil.py) module\n- Reading data from [external files](https://github.com/robbrad/UKBinCollectionData/blob/master/uk_bin_collection/uk_bin_collection/councils/LeedsCityCouncil.py)\n- Using [Selenium](https://github.com/robbrad/UKBinCollectionData/blob/master/uk_bin_collection/uk_bin_collection/councils/Chilterns.py) to automate browser behaviour\n\n## Developing\nTo get started, first you will need to fork this repository and setup your own working environment before you can start developing.\n\n### Developing using our Dev Container\nYou need to set up Docker, Visual Studio Code (VSCode), and a development container (devcontainer) after cloning the repository at https://github.com/robbrad/UKBinCollectionData.\n\n#### Prerequisites\nBefore you start, make sure you have the following installed on your computer:\n- Docker: [Download Docker](https://www.docker.com/products/docker-desktop)\n- Visual Studio Code (VSCode): [Download VSCode](https://code.visualstudio.com/download)\n- Remote - Containers extension for VSCode: Install it from the VSCode Marketplace or directly from the Extensions view (`Ctrl+Shift+X` in VSCode and search for \"Remote - Containers\").\n\n#### Step 1: Clone the Repository\nFirst, clone the repository to your local machine. Open a terminal and run the following command:\n```bash\ngit clone https://github.com/robbrad/UKBinCollectionData.git\n```\nNavigate into the directory:\n```bash\ncd UKBinCollectionData\n```\n\n#### Step 2: Set Up Docker\nEnsure Docker is running on your system. You can verify this by running:\n```bash\ndocker -v\n```\nThis should return the version of Docker installed. If Docker is running, you’ll see no errors.\n\n#### Step 3: Open the Project in VSCode\nOpen VSCode, and then open the cloned repository by going to `File > Open Folder...` and selecting the `UKBinCollectionData` folder.\n\n#### Step 4: Reopen in Container\nOnce the folder is open in VSCode:\n1. A prompt might appear asking you to reopen in a container. If it does, select \"Reopen in Container\".\n2. If you don’t see the prompt, press `F1` to open the command palette, type \"Remote-Containers: Reopen in Container\", and select that option.\n\nVSCode will start building the Docker container as defined in the `.devcontainer/` folder in the repository. This process can take a few minutes as it involves downloading the base Docker and Selenium hub images and setting up the environment.\n\n#### Step 5: Verify the Development Environment\nOnce the container is set up, VSCode will connect to it automatically. You can start editing and running the code inside the container. This ensures that your development environment is consistent and controlled, replicating the same settings and tools as specified in the devcontainer configuration.\n\n### Developing\nOnce your environment is ready, create a new branch from your master/main branch\n\nThen you can run\n\n```\npoetry run python uk_bin_collection/uk_bin_collection/create_new_council.py \"CouncilName\" \"CouncilURL\"\n```\n\nThe new .py file will be used in the CLI to call the parser, so be sure to pick a sensible name - e.g. CheshireEastCouncil.py is called with:\n```\npython collect_data.py CheshireEastCouncil \n```\n\nTo simplify things somewhat, a [template](https://github.com/robbrad/UKBinCollectionData/blob/master/uk_bin_collection/uk_bin_collection/councils/council_class_template/councilclasstemplate.py) file has been created - open this file, copy the contents to your new .py file and start from there. The create script above will create\n\n1. A council Class file under the councils folder\n2. Make an entry in input.json\n\nYou are pretty much free to approach the scraping however you would like, but please ensure that:\n- Your scraper returns a dictionary made up of the key \"bins\" and a value that is a list of bin types and collection dates. An example of this can be seen below.\n- Any dates or times are formatted to standard UK formats (see [below](#common-functions))\n
\n Output Example\n\n```json\n{\n \"bins\": [\n {\n \"type\": \"Empty Standard Mixed Recycling\",\n \"collectionDate\": \"29/07/2022\"\n },\n {\n \"type\": \"Empty Standard Garden Waste\",\n \"collectionDate\": \"29/07/2022\"\n },\n {\n \"type\": \"Empty Standard General Waste\",\n \"collectionDate\": \"05/08/2022\"\n }\n ]\n}\n```\n
\n\n### Kwargs\nUKBCD has two mandatory parameters when it runs - the name of the parser (sans .py) and the URL from which to scrape. However, developers can also get the following data using `kwargs`:\n\n| Parameter | Prompt | Notes | kwargs.get |\n|-----------------------------------------|--------------------------|-------------------------------------------------------------|------------------------------|\n| UPRN (Unique Property Reference Number) | `-u` or `--uprn` | | `kwargs.get('uprn')` |\n| USRN (Unique Street Reference Number) | `-us` or `--usrn` | | `kwargs.get('usrn')` |\n| House number | `-n` or `--number` | Sometimes called PAON | `kwargs.get('paon')` |\n| Postcode | `-p` or `--postcode` | Needs to be wrapped in quotes on the CLI | `kwargs.get('postcode')` |\n| Skip Get URL | `-s` or `--skip_get_url` | | `kwargs.get('skip_get_url')` |\n| URL for remote Selenium web driver | `-w` or `--web_driver` | Needs to be wrapped in quotes on the CLI | `kwargs.get('web_driver')` |\n| Development Mode | `-d` or `--dev_mode` | Create/update council's entry in the input.json on each run | `kwargs.get('dev_mode')` |\n\nThese parameters are useful if you're using something like the requests module and need to take additional user information into the request, such as:\n```commandline\npython collect_data.py LeedsCityCouncil https://www.leeds.gov.uk/residents/bins-and-recycling/check-your-bin-day -p \"LS1 2JG\" -n 41\n```\n In the scraper, the following code takes the inputted parameters and uses them in two different variables:\n```python\nuser_postcode = kwargs.get(\"postcode\")\nuser_paon = kwargs.get(\"paon\")\n```\nEach parameter also has its own validation method that should be called after the `kwargs.get`:\n- `check_uprn()`\n- `check_paon()`\n- `check_postcode()`\n\nThe first two are simple validators - if the parameter is used but no value is given, they will throw an exception. `check_postcode()` works differently - instead making a call to the [postcodes.io](https://postcodes.io/) API to check if it exists or not. An exception will only be thrown here if the response code is not `HTTP 200`.\n\n### Common Functions\nThe project has a small but growing library of functions (and the occasional variable) that are useful when scraping websites or calendars - aptly named [common.py](https://github.com/robbrad/UKBinCollectionData/blob/master/uk_bin_collection/uk_bin_collection/common.py).\nUseful functions include:\n- functions to [add ordinals](https://github.com/robbrad/UKBinCollectionData/blob/e49da2f43143ac7c65fbeaf35b5e86b3ea19e31b/uk_bin_collection/uk_bin_collection/common.py#L72) to dates (04 becomes 4th) or [remove them](https://github.com/robbrad/UKBinCollectionData/blob/e49da2f43143ac7c65fbeaf35b5e86b3ea19e31b/uk_bin_collection/uk_bin_collection/common.py#L86) (4th becomes 04)\n- a function to check [if a date is a holiday](https://github.com/robbrad/UKBinCollectionData/blob/e49da2f43143ac7c65fbeaf35b5e86b3ea19e31b/uk_bin_collection/uk_bin_collection/common.py#L117) in a given part of the UK\n- a function that returns the [dates of a given weekday](https://github.com/robbrad/UKBinCollectionData/blob/e49da2f43143ac7c65fbeaf35b5e86b3ea19e31b/uk_bin_collection/uk_bin_collection/common.py#L136) in N amounts of weeks\n- a function that returns a [list of dates every N days](https://github.com/robbrad/UKBinCollectionData/blob/e49da2f43143ac7c65fbeaf35b5e86b3ea19e31b/uk_bin_collection/uk_bin_collection/common.py#L148) from a given start date\n- a function to check [if a string contains a date](./uk_bin_collection/uk_bin_collection/common.py#L249) (leverages [dateutil's parser](https://dateutil.readthedocs.io/en/stable/parser.html))\n\n`common.py` also contains a [standardised date format](https://github.com/robbrad/UKBinCollectionData/blob/e49da2f43143ac7c65fbeaf35b5e86b3ea19e31b/uk_bin_collection/uk_bin_collection/common.py#L11) variable called `date_format`, which is useful to call when formatting datetimes.\n\nPlease feel free to contribute to this library as you see fit - added functions should include the following:\n- clear, lowercase and underscored name\n- parameter types\n- a return type (if there is one)\n- a docustring describing what the function does, as well as parameter and return type descriptors.\n\n## Additional files\nIn order for your scraper to work with the project's testing suite, some additional files need to be provided or\nmodified:\n- [ ] [Input JSON file](#input-json-file)\n\n**Note:** from here on, anything containing`` should be replaced with the scraper's name.\n\n### Input JSON file\n| Type | File location |\n|--------|----------------------------------------------------------|\n| Modify | `UKBinCollectionData/uk_bin_collection/tests/input.json` |\n\nEach council should have a node that matches the scraper's name. The node should include arguments in curly braces - the\nURL is mandatory, but any additional parameters like UPRN or postcode should also be provided. Councils should be\nlisted in alphabetical order.\n\nA \"wiki_name\" argument with the council's full name should also be provided.\n\nA \"wiki_note\" argument should be used where non-standard instructions of just providing UPRN/Postcode/House Number\nparameters are needed.\n\nA \"wiki_command_url_override\" argument should be used where parts of the URL need to be replaced by the user to allow a\nvalid URL to be left for the integration tests.\n\nA new [Wiki](https://github.com/robbrad/UKBinCollectionData/wiki/Councils) entry will be generated automatically from\nthis file's details.\n\n**Note:** If you want the integration test to work you must supply real, working data (a business address is \nrecommended - the council's address is usually a good one).\n\n
\n Example\n\n```json\n \"CheshireEastCouncil\": {\n \"uprn\": \"100012791226\",\n \"url\": \"https://online.cheshireeast.gov.uk/MyCollectionDay/SearchByAjax/GetBartecJobList?uprn=100012791226&onelineaddress=3%20COBBLERS%20YARD,%20SK9%207DZ&_=1621149987573\",\n \"wiki_name\": \"Cheshire East Council\",\n \"wiki_command_url_override\": \"https://online.cheshireeast.gov.uk/MyCollectionDay/SearchByAjax/GetBartecJobList?uprn=XXXXXXXX&onelineaddress=XXXXXXXX&_=1621149987573\",\n \"wiki_note\": \"Both the UPRN and a one-line address are passed in the URL, which needs to be wrapped in double quotes. The one-line address is made up of the house number, street name and postcode.\\nUse the form [here](https://online.cheshireeast.gov.uk/mycollectionday/) to find them, then take the first line and post code and replace all spaces with `%20`.\"\n },\n```\n
\n\n## Testing\n### Behave (Integration Testing)\nAs with any web scraping project, there's a reliance on the council not changing their website - if this happens Beautiful Soup \nwill fail to read the site correctly, and the expected data will not be returned. To mitigate this and stay on top \nof \"what works and what needs work\" - we have created a set of Integration tests which run a [feature](https://github.com/robbrad/UKBinCollectionData/blob/master/uk_bin_collection/tests/features/validate_council_outputs.feature) \nfile. \n\nBased on the [input.json](https://github.com/robbrad/UKBinCollectionData/blob/master/uk_bin_collection/tests/input.json),\nthis does an actual live run against the council's site and validates if the returned data is JSON and conforms to the common format [JSON Schema](https://github.com/robbrad/UKBinCollectionData/tree/master/uk_bin_collection/tests/output.schema).\n\nBy default if the council is a Selenium based council it will run in headless mode. If you pass `--headless=False` to pytest (possible in VS Code launch.json useful for debugging code) It will run in a visable browser.\n\nIt also defaults the Selenium URL to be `http://localhost:4444` and the local_browser to False\n\nYou can set pytest to test on your local web browser without Selenium Grid by setting `--local_browser=True`\nIf you want a different Selenium URL you can set it with `--selenium_url=http://selenium:4444` NOTE: you can't set `--local_browser=True` (defaults: False) as Selenium testing will be ignored\n\nIn VSCode if you set a make a launch.json you can debug the test locally with the following setup\n```json\n{\n \"version\": \"0.2.0\",\n \"configurations\": [\n {\n \"name\": \"Python Debugger: Current File\",\n \"type\": \"debugpy\",\n \"request\": \"launch\",\n \"purpose\": [\"debug-test\"],\n \"env\": {\n \"PYTEST_ADDOPTS\": \"--headless=False --local_browser=True\"\n }\n }\n ]\n}\n```\n\nIt is also possible to run\n```commandline\n#Visable Selenium Run in Local Broswer\npoetry run pytest uk_bin_collection/tests/step_defs/ -k \"Council_Name\" --headless=False --local_browser=True\n\n#Visable Selenium Run in on Selenium Grid\npoetry run pytest uk_bin_collection/tests/step_defs/ -k \"Council_Name\" --headless=False --selenium_url=http://localhost:4444\n```\n\n#### Running the Behave tests for all councils\n```commandline\ncd UKBinCollectionData\npoetry shell\npoetry run pytest uk_bin_collection/tests/step_defs/ -n logical\n```\n\n#### Running the Behave tests for a specific council\n```commandline\ncd UKBinCollectionData\npoetry shell\npoetry run pytest uk_bin_collection/tests/step_defs/ -n logical -k \"BarnetCouncil\"\n```\n\n#### GitHub Actions Integration Tests\nThe [GitHub actions](https://github.com/robbrad/UKBinCollectionData/actions/workflows/behave.yml) is set to run on push and pull_requests\n\nIt uses a [Makefile](https://github.com/robbrad/UKBinCollectionData/blob/master/Makefile) to run the [Behave](#behave--integration-testing-) tests to ensure the councils are all still working\n\n#### Test Results\n\n##### Allure Report\nThe Github Actions publishes the Allure Behave Test results to Github Pages: https://robbrad.github.io/UKBinCollectionData// eg https://robbrad.github.io/UKBinCollectionData/3.9/ you can check this to see if a council is still working as expected\n\n##### CodeCov Report\nThe CodeCov.io report can be found [here](https://app.codecov.io/gh/robbrad/UKBinCollectionData) \n\n### Pytest (Unit Testing)\nAs well as integration testing the repo is setup to test some of the static methods as well to ensure basic core functionality\n\n#### Running the Unittests\n```commandline\ncd UKBinCollectionData\npoetry shell\npoetry run coverage run --omit \"*/tests/*\" -m pytest uk_bin_collection/tests --ignore=uk_bin_collection/tests/step_defs/\npoetry run coverage xml\n```\n\n# Contact info\nIf you have questions or comments, you can reach the project contributors in the following ways:\n- Council requests can be submitted [here](https://github.com/robbrad/UKBinCollectionData/issues/new?assignees=&labels=Class%3A+enhancement&template=COUNCIL_REQUEST.yaml)\n- General questions or comments can be submitted [here](https://github.com/robbrad/UKBinCollectionData/discussions/categories/q-a)\n\n" }, { "path": "LICENSE", "content": "MIT License\n\nCopyright (c) 2022 Robert Bradley\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "Makefile", "content": ".PHONY: install pre-build build black pycodestyle update-wiki\n\n## @CI_actions Installs the checked out version of the code to your poetry managed venv\ninstall:\n\tpoetry install --without dev\n\ninstall-dev:\n\tpoetry install \n\n## @CI_actions Runs code quality checks\npre-build: black unit-tests\n\trm setup.py || echo \"There was no setup.py\"\n\tpoetry show --no-dev | awk '{print \"poetry add \"$$1\"==\"$$2}' | sort | sh\n\n## @CI_actions Builds the project into an sdist\nbuild:\n\tpoetry build -f sdist\n\n## @Code_quality Runs black on the checked out code\nblack:\n\tpoetry run black **/*.py\n\n## @Code_quality Runs pycodestyle on the the checked out code\npycodestyle:\n\tpoetry run pycodestyle --statistics -qq uk_bin_collection\n\n## @Testing runs unit tests\nintegration-tests:\n\t# Ensure directory exists\n\tmkdir -p build/$(matrix)/integration-test-results\n\n\t# Turn off \"exit on error\" so we can capture the code\n\tset +e; \\\n\tif [ -z \"$(councils)\" ]; then \\\n\t\tpoetry run pytest uk_bin_collection/tests/step_defs/ \\\n\t\t\t-n logical \\\n\t\t\t--junit-xml=build/$(matrix)/integration-test-results/junit.xml; \\\n\telse \\\n\t\tpoetry run pytest uk_bin_collection/tests/step_defs/ \\\n\t\t\t-k \"$(councils)\" \\\n\t\t\t-n logical \\\n\t\t\t--junit-xml=build/$(matrix)/integration-test-results/junit.xml; \\\n\tfi; \\\n\tRESULT=$$?; \\\n\tset -e; \\\n\t\n\t# Double-check that the file exists (in case of a really early crash)\n\tif [ ! -f build/$(matrix)/integration-test-results/junit.xml ]; then \\\n\t\techo \"\" \\\n\t\t > build/$(matrix)/integration-test-results/junit.xml; \\\n\tfi; \\\n\t\n\texit $$RESULT\n\ngenerate-test-map-test-results:\n\tpoetry run python uk_bin_collection/tests/generate_map_test_results.py build/integration-test-results/junit.xml > build/integration-test-results/test_results.json\n\nparity-check:\n\tpoetry run python uk_bin_collection/tests/council_feature_input_parity.py \"$(repo)\" \"$(branch)\"\n\nunit-tests:\n\tpoetry run coverage erase\n\t- poetry run coverage run --append --omit \"*/tests/*\" -m pytest -vv -s --log-cli-level=DEBUG uk_bin_collection/tests custom_components/uk_bin_collection/tests --ignore=uk_bin_collection/tests/step_defs/ \n\tpoetry run coverage xml\n\nupdate-wiki:\n\tpoetry run python wiki/generate_wiki.py\n" }, { "path": "README.md", "content": "[![Made with Python](https://img.shields.io/badge/Made%20With%20Python-red?style=for-the-badge&logo=python&logoColor=white&labelColor=red)](https://www.python.org)\n\n[![HACS Badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge)](https://github.com/robbrad/UKBinCollectionData)\n[![Current Release](https://img.shields.io/github/v/release/robbrad/UKBinCollectionData?style=for-the-badge&filter=*)](https://github.com/robbrad/UKBinCollectionData/releases)\n[![PyPi](https://img.shields.io/pypi/v/uk_bin_collection?label=PyPI&logo=pypi&style=for-the-badge&color=blue)](https://pypi.org/project/uk-bin-collection/)\n\n[![GitHub license](https://img.shields.io/github/license/robbrad/UKBinCollectionData?style=for-the-badge)](https://github.com/robbrad/UKBinCollectionData/blob/master/LICENSE)\n[![GitHub issues](https://img.shields.io/github/issues-raw/robbrad/UKBinCollectionData?style=for-the-badge)](https://github.com/robbrad/UKBinCollectionData/issues?q=is%3Aopen+is%3Aissue)\n[![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/robbrad/UKBinCollectionData?style=for-the-badge)](https://github.com/robbrad/UKBinCollectionData/issues?q=is%3Aissue+is%3Aclosed)\n[![GitHub contributors](https://img.shields.io/github/contributors/robbrad/UKBinCollectionData?style=for-the-badge)](https://github.com/robbrad/UKBinCollectionData/graphs/contributors)\n\n[![Test Councils](https://img.shields.io/github/actions/workflow/status/robbrad/UKBinCollectionData/behave.yml?style=for-the-badge&label=Test+Councils)](https://github.com/robbrad/UKBinCollectionData/actions/workflows/behave.yml)\n![Codecov](https://img.shields.io/codecov/c/gh/robbrad/UKBinCollectionData?style=for-the-badge)\n[![CodeQL Analysis](https://img.shields.io/github/actions/workflow/status/robbrad/UKBinCollectionData/codeql-analysis.yml?style=for-the-badge&label=CodeQL+Analysis)](https://github.com/robbrad/UKBinCollectionData/actions/workflows/codeql-analysis.yml)\n[![Publish Release](https://img.shields.io/github/actions/workflow/status/robbrad/UKBinCollectionData/release.yml?style=for-the-badge&label=Publish+Release)](https://github.com/robbrad/UKBinCollectionData/actions/workflows/release.yml)\n[![Test Report Deployment](https://img.shields.io/github/actions/workflow/status/robbrad/UKBinCollectionData/pages%2Fpages-build-deployment?style=for-the-badge&label=Test+Report+Deployment)](https://github.com/robbrad/UKBinCollectionData/actions/workflows/pages/pages-build-deployment)\n\n# UK Bin Collection Data (UKBCD)\nThis project aims to provide a neat and standard way of providing bin collection data in JSON format from UK councils that have no API to do so.\n\nWhy would you want to do this?\nYou might want to use this in Home Automation—for example, say you had an LED bar that lit up on the day of bin collection to the colour of the bin you want to take out; then this repo provides the data for that. \n\n**PLEASE respect a councils' infrastructure / usage policy and only collect data for your own personal use on a suitable frequency to your collection schedule.**\n\nMost scripts make use of [Beautiful Soup 4](https://pypi.org/project/beautifulsoup4/) to scrape data, although others use different approaches, such as emulating web browser behaviour, or reading data from CSV files.\n\n[![](https://img.shields.io/badge/-41BDF5?style=for-the-badge&logo=homeassistant&logoColor=white&label=HomeAssistant+Thread)](https://community.home-assistant.io/t/bin-waste-collection/55451)\n[![](https://img.shields.io/badge/Request%20a%20council-gray?style=for-the-badge&logo=github&logoColor=white)](https://github.com/robbrad/UKBinCollectionData/issues/new/choose)\n\n---\n\n## Requesting your council\n> :warning: Please check that a request for your council has not already been made. You can do this by searching on the [Issues](https://github.com/robbrad/UKBinCollectionData/issues) page.\n\nIf an issue already exists, please comment on that issue to express your interest. Please do not open a new issue, as it will be closed as a duplicate.\n\nIf an issue does not already exist, please fill in a new [Council Request](https://github.com/robbrad/UKBinCollectionData/issues/new/choose) form, including as much information as possible, including:\n- Name of the council.\n- URL to bin collections.\n- An example postcode and/or [UPRN](https://uprn.uk/) (whichever is relevant).\n- Any further information.\n\nPlease be aware that this project is run by volunteer contributors and completion depends on numerous factors - even with a request, we cannot guarantee if/when your council is added to this integration.\n\n---\n\n## Home Assistant Usage\n\n### Install with HACS (recommended)\n\n#### Automated\n[![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)\n\nThis integration can be installed directly via HACS. To install:\n\n* [Add the repository](https://my.home-assistant.io/redirect/hacs_repository/?owner=robbrad&repository=UKBinCollectionData&category=integration) to your HACS installation\n* Click `Download`\n\nFor details on how to setup the custom component integration, see the [documentation](https://github.com/robbrad/UKBinCollectionData/tree/master/custom_components/uk_bin_collection).\n\n#### Manual\n1. Ensure you have [HACS](https://hacs.xyz/) installed\n1. In the Home Assistant UI go to `HACS` > `Integrations` > `⋮` > `Custom repositories`.\n1. Enter `https://github.com/robbrad/UKBinCollectionData` in the `Repository` field.\n1. Select `Integration` as the category then click `ADD`.\n1. Click `+ Add Integration` and search for and select `UK Bin Collection Data` then click `Download`.\n1. Restart your Home Assistant.\n1. In the Home Assistant UI go to `Settings` > `Devices & Services` click `+ Add Integration` and search for `UK Bin Collection Data`.\n1. If you see a \"URL of the remote Selenium web driver to use\" field when setting up your council, you'll need to provide the URL to a web driver you've set up separately such as [standalone-chrome](https://hub.docker.com/r/selenium/standalone-chrome).\n\n### Install manually\n\n1. Open the folder for your Home Assistant configuration (where you find `configuration.yaml`).\n1. If you do not have a `custom_components` folder there, you need to create it.\n1. [Download](https://github.com/robbrad/UKBinCollectionData/archive/refs/heads/master.zip) this repository then copy the folder `custom_components/uk_bin_collection` into the `custom_components` folder you found/created in the previous step.\n1. Restart your Home Assistant.\n1. In the Home Assistant UI go to `Settings` > `Devices & Services` click `+ Add Integration` and search for `UK Bin Collection Data`.\n\n### Overriding the Bin Icon and Bin Colour\nWe realise it is difficult to set a colour from the councils text for the Bin Type and to keep the integration generic, we don't capture colour from a council (not all councils supply this as a field), only bin type and next collection date.\n\nWhen you configure the component on the first screen, you can set a JSON string to map the bin type to the colour and icon\n\nHere is an example to set the colour and icon for the type `Empty Standard General Waste`. This type is the type returned from the council for the bin. You can do this for multiple bins.\n\nIf you miss this on the first setup, you can reconfigure it.\n\n```json\n{ \n \"Empty Standard General Waste\": \n { \n \"icon\": \"mdi:trash-can\", \n \"color\": \"blue\" \n }\n}\n```\n---\n\n## Standalone Usage\n```commandline\nPS G:\\Projects\\Python\\UKBinCollectionData\\uk_bin_collection\\collect_data.py\nusage: collect_data.py [-h] [-p POSTCODE] [-n NUMBER] [-u UPRN] module URL\n\npositional arguments:\n module Name of council module to use (required)\n URL URL to parse (required)\n\noptions:\n -h, --help show this help message (optional)\n -p POSTCODE, --postcode POSTCODE Postcode to parse - should include (optional)\n a space and be wrapped in double\n quotes \n -n NUMBER, --number NUMBER House number to parse (optional)\n -u UPRN, --uprn UPRN UPRN to parse (optional)\n```\n\n### Quickstart\nThe basic command to execute a script is:\n```commandline\npython collect_data.py \"\"\n```\nwhere ```council_name``` is the name of the council's .py script (without the .py) and ```collection_url``` is the URL to scrape.\nThe help documentation refers to these as \"module\" and \"URL\", respectively. Supported council scripts can be found in the `uk_bin_collection/uk_bin_collection/councils` folder.\n\nSome scripts require additional parameters, for example, when a UPRN is not passed in a URL, or when the script is not scraping a web page.\nFor example, the Leeds City Council script needs two additional parameters—a postcode, and a house number. This is done like so:\n\n```commandline\npython collect_data.py LeedsCityCouncil https://www.leeds.gov.uk/residents/bins-and-recycling/check-your-bin-day -p \"LS1 2JG\" -n 41\n```\n- A **postcode** can be passed with `-p \"postcode\"` or `--postcode \"postcode\"`. The postcode must always include a space in the middle and\nbe wrapped in double quotes (due to how command line arguments are handled).\n- A **house number** can be passed with `-n number` or `--number number`.\n- A **UPRN reference** can be passed with `-u uprn` or `--uprn uprn`.\n\nTo check the parameters needed for your council's script, please check the [project wiki](https://github.com/robbrad/UKBinCollectionData/wiki) for more information.\n\n\n### Project dependencies\nSome scripts rely on external packages to function. A list of required scripts for both development and execution can be found in the project's [PROJECT_TOML](https://github.com/robbrad/UKBinCollectionData/blob/feature/%2353_integration_tests/pyproject.toml).\nInstall can be done via `poetry install` from within the root of the repo.\n\n---\n\n## UPRN Finder\nSome councils make use of the UPRN (Unique property reference number) to identify your property. You can find yours [here](https://www.findmyaddress.co.uk/search) or [here](https://uprn.uk/).\n\n---\n## Selenium\nSome councils need Selenium to run the scrape on behalf of Home Assistant. The easiest way to do this is run Selenium as in a Docker container. However that you do this, the Home Assistant server must be able to reach the Selenium server.\n\n### Instructions for Windows, Linux, and Mac\n\n#### Step 1: Install Docker\n\n##### Windows\n\n1. **Download Docker Desktop for Windows:**\n \n * Go to the Docker website: Docker Desktop for Windows.\n * Download and install Docker Desktop.\n2. **Run Docker Desktop:**\n \n * After installation, run Docker Desktop.\n * Follow the on-screen instructions to complete the setup.\n * Ensure Docker is running by checking the Docker icon in the system tray.\n\n##### Linux\n\n1. **Install Docker:**\n \n * Open a terminal and run the following commands:\n \n ```bash\n sudo apt-get update\n sudo apt-get install \\\n apt-transport-https \\\n ca-certificates \\\n curl \\\n gnupg \\\n lsb-release\n curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg\n echo \\\n \"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \\\n $(lsb_release -cs) stable\" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null\n sudo apt-get update\n sudo apt-get install docker-ce docker-ce-cli containerd.io \n ```\n \n2. **Start Docker:**\n \n * Run the following command to start Docker:\n \n ```bash\n sudo systemctl start docker\n ```\n \n3. **Enable Docker to start on boot:**\n \n bash\n \n Copy code\n \n ```bash\n sudo systemctl enable docker\n ```\n \n\n##### Mac\n\n1. **Download Docker Desktop for Mac:**\n \n * Go to the Docker website: Docker Desktop for Mac.\n * Download and install Docker Desktop.\n2. **Run Docker Desktop:**\n \n * After installation, run Docker Desktop.\n * Follow the on-screen instructions to complete the setup.\n * Ensure Docker is running by checking the Docker icon in the menu bar.\n\n#### Step 2: Pull and Run Selenium Standalone Chrome Docker Image\n\n1. **Open a terminal or command prompt:**\n \n2. **Pull the Selenium Standalone Chrome image:**\n \n ```bash\n docker pull selenium/standalone-chrome\n ```\n \n3. **Run the Selenium Standalone Chrome container:**\n \n ```bash\n docker run -d -p 4444:4444 --name selenium-chrome selenium/standalone-chrome\n ```\n\n#### Step 3: Test the Selenium Server\n\n1. **Navigate to the Selenium server URL in your web browser:**\n * Open a web browser and go to `http://localhost:4444`.\n * You should see the Selenium Grid console.\n\n#### Step 4: Supply the Selenium Server URL to UKBinCollectionData\n\n1. **Find the `UKBinCollectionData` project:**\n \n * Go to the GitHub repository: [UKBinCollectionData](https://github.com/robbrad/UKBinCollectionData).\n2. **Supply the Selenium Server URL:**\n \n * Typically, the URL will be `http://localhost:4444/wd/hub`.\n * You might need to update a configuration file or environment variable in the project to use this URL. Check the project's documentation for specific instructions.\n\n### Summary of Commands\n\n**Windows/Linux/Mac:**\n\n```bash\ndocker pull selenium/standalone-chrome docker run -d -p 4444:4444 --name selenium-chrome selenium/standalone-chrome\n```\n\n**Selenium Server URL:**\n\n* `http://localhost:4444/wd/hub`\n\n---\n\n### Instructions for Home Assistant OS\n\nIf you're running Home Assistant Supervised, it's possible to host the Selenium instance on the same system.\n\nThis guide is based on a Raspberry Pi 4. Instructions for other systems may vary.\n\n#### Prerequisites\n1. Install **Portainer** from Alex Belgium's add-on repository:\n [alexbelgium/hassio-addons](https://github.com/alexbelgium/hassio-addons)\n\n---\n\n#### Step 1: Pull and Run Docker Image\n\nSince the Raspberry Pi 4 uses an ARM64-based architecture, use the `seleniarm/standalone-chromium:latest` Docker image.\n\n1. Open **Portainer** and navigate to the **Images** tab.\n2. In the **Image** text box, enter:\n\n ```\n seleniarm/standalone-chromium:latest\n ```\n\n3. Click **Pull the image**.\n\n4. Once the image is pulled, navigate to the **Containers** tab and click **Add container**.\n\n5. Configure the container:\n - **Name:** Give it a clear and descriptive name (e.g., `selenium-chromium`).\n - **Image:** Enter:\n\n ```\n seleniarm/standalone-chromium\n ```\n\n Make sure to uncheck **Always pull the image**.\n\n - **Network ports configuration:**\n - Click **Map additional port**.\n - Set both the **Host** and **Container** ports to `4444`.\n\n6. Click **Deploy the container**.\n\n---\n\n#### Step 2: Configure UKBinCollectionData Integration\n\n1. **Add the integration** in Home Assistant.\n\n2. On the second stage of the integration setup wizard:\n - Ensure that `http://localhost:4444` shows as accessible.\n - If not, verify that the Selenium container is running in Portainer.\n\n3. Enter the required information for the integration.\n\n4. In the **Remote Selenium Server** text box, enter:\n\n ```\n http://:4444\n ```\n\n Replace `` with the IP address of your Home Assistant system.\n\n---\n\n## Reports\n\nAll integration tests results are in [CodeCov](https://app.codecov.io/gh/robbrad/UKBinCollectionData/)\n\n### Nightly Full Integration Test Reports:\n- [Nightly Council Test](https://app.codecov.io/gh/robbrad/UKBinCollectionData/tests/master)\n\n\n🗺️ View Test Coverage Map (in VS Code)\n---------------------------------------\n\nYou can generate integration test results and view the interactive UK council coverage map with traffic-light-style statuses for each council.\n\n### 🧪 Step 1: Run Integration Tests\n\nRun: `make integration-tests`\n\nThis runs the full BDD test suite and outputs a `junit.xml` report to:\n\n`build/test/integration-test-results/junit.xml`\n\n### 📊 Step 2: Generate Map Test Results JSON\n\nConvert the JUnit XML output to a flat test result JSON: `make generate-test-map-test-results`\n\nThis creates: `build/integration-test-results/test_results.json`\n\nThis file is used by the map to color each council:\n\n* ✅ Green: Test passed\n* 🟠 Amber: Test failed\n* ❌ Red: Not integrated\n\n### 🗺️ Step 3: Open the Map\n\nOpen the map viewer in VS Code:\n\n1. Right-click the `map.html` file in VSCode and choose **Show Preview**\n \n2. The map will open in your browser, showing real-time integration coverage and test results.\n\n![Test Results Map](test_results_map.png)\n\n---\n## ICS Calendar Generation\n\nYou can convert bin collection data to an ICS calendar file that can be imported into calendar applications like Google Calendar, Apple Calendar, Microsoft Outlook, etc.\n\n### Overview\n\nThe `bin_to_ics.py` script allows you to:\n- Convert JSON output from bin collection data into ICS calendar events\n- Group multiple bin collections on the same day into a single event\n- Create all-day events (default) or timed events\n- Add optional reminders/alarms to events\n- Customize the calendar name\n\n### Requirements\n\n- Python 3.6 or higher\n- The `icalendar` package, which can be installed with:\n ```bash\n pip install icalendar\n ```\n\n### Basic Usage\n\n```bash\n# Basic usage with stdin input and default output file (bin.ics)\npython bin_to_ics.py < bin_data.json\n\n# Specify input and output files\npython bin_to_ics.py -i bin_data.json -o my_calendar.ics\n\n# Custom calendar name\npython bin_to_ics.py -i bin_data.json -o my_calendar.ics -n \"My Bin Collections\"\n```\n\n### Options\n\n```\n--input, -i Input JSON file (if not provided, read from stdin)\n--output, -o Output ICS file (default: bin.ics)\n--name, -n Calendar name (default: Bin Collections)\n--alarms, -a Comma-separated list of alarm times before event (e.g., \"1d,2h,30m\")\n--no-all-day Create timed events instead of all-day events\n```\n\n### Examples\n\n#### Adding Reminders (Alarms)\n\nAdd reminders 1 day and 2 hours before each collection:\n\n```bash\npython bin_to_ics.py -i bin_data.json -a \"1d,2h\"\n```\n\nThe time format supports:\n- Days: `1d`, `2day`, `3days`\n- Hours: `1h`, `2hour`, `3hours`\n- Minutes: `30m`, `45min`, `60mins`, `90minutes`\n\n#### Creating Timed Events\n\nBy default, events are created as all-day events. To create timed events instead (default time: 7:00 AM):\n\n```bash\npython bin_to_ics.py -i bin_data.json --no-all-day\n```\n\n### Integration with Bin Collection Data Retriever\n\nYou can pipe the output from the bin collection data retriever directly to the ICS generator. The required parameters (postcode, house number, UPRN, etc.) depend on the specific council implementation - refer to the [Quickstart](#quickstart) section above or check the [project wiki](https://github.com/robbrad/UKBinCollectionData/wiki) for details about your council.\n\n```bash\npython uk_bin_collection/uk_bin_collection/collect_data.py CouncilName \"URL\" [OPTIONS] | \n python bin_to_ics.py [OPTIONS]\n```\n\n#### Complete Example for a Council\n\n```bash\npython uk_bin_collection/uk_bin_collection/collect_data.py CouncilName \\\n \"council_url\" \\\n -p \"YOUR_POSTCODE\" \\\n -n \"YOUR_HOUSE_NUMBER\" \\\n -w \"http://localhost:4444/wd/hub\" |\n python bin_to_ics.py \\\n --name \"My Bin Collections\" \\\n --output my_bins.ics \\\n --alarms \"1d,12h\"\n```\n\nThis will:\n1. Fetch bin collection data for your address from your council's website\n2. Convert it to an ICS file named \"my_bins.ics\"\n3. Set the calendar name to \"My Bin Collections\"\n4. Add reminders 1 day and 12 hours before each collection\n\nFor postcode lookup and UPRN information, please check the [UPRN Finder](#uprn-finder) section above.\n\n### Using the Calendar\n\nYou have two options for using the generated ICS file:\n\n#### 1. Importing the Calendar\n\nYou can directly import the ICS file into your calendar application:\n\n- **Google Calendar**: Go to Settings > Import & export > Import\n- **Apple Calendar**: File > Import\n- **Microsoft Outlook**: File > Open & Export > Import/Export > Import an iCalendar (.ics)\n\nNote: Importing creates a static copy of the calendar events. If bin collection dates change, you'll need to re-import the calendar.\n\n#### 2. Subscribing to the Calendar\n\nIf you host the ICS file on a publicly accessible web server, you can subscribe to it as an internet calendar:\n\n- **Google Calendar**: Go to \"Other calendars\" > \"+\" > \"From URL\" > Enter the URL of your hosted ICS file\n- **Apple Calendar**: File > New Calendar Subscription > Enter the URL\n- **Microsoft Outlook**: File > Account Settings > Internet Calendars > New > Enter the URL\n\nBenefits of subscribing:\n- Calendar automatically updates when the source file changes\n- No need to manually re-import when bin collection dates change\n- Easily share the calendar with household members\n\nYou can set up a cron job or scheduled task to regularly:\n1. Retrieve the latest bin collection data\n2. Generate a fresh ICS file\n3. Publish it to a web-accessible location\n\n### Additional Examples and Use Cases\n\n#### Automation with Cron Jobs\n\nCreate a weekly update script on a Linux/Mac system:\n\n```bash\n#!/bin/bash\n# File: update_bin_calendar.sh\n\n# Set variables\nCOUNCIL=\"YourCouncilName\"\nCOUNCIL_URL=\"https://your-council-website.gov.uk/bins\"\nPOSTCODE=\"YOUR_POSTCODE\"\nHOUSE_NUMBER=\"YOUR_HOUSE_NUMBER\"\nOUTPUT_DIR=\"/var/www/html/calendars\" # Web-accessible directory\nCALENDAR_NAME=\"Household Bins\"\n\n# Ensure output directory exists\nmkdir -p $OUTPUT_DIR\n\n# Run the collector and generate the calendar\ncd /path/to/UKBinCollectionData && \\\npython uk_bin_collection/uk_bin_collection/collect_data.py $COUNCIL \"$COUNCIL_URL\" \\\n -p \"$POSTCODE\" -n \"$HOUSE_NUMBER\" | \\\npython bin_to_ics.py --name \"$CALENDAR_NAME\" --output \"$OUTPUT_DIR/bins.ics\" --alarms \"1d,6h\"\n\n# Add timestamp to show last update time\necho \"Calendar last updated: $(date)\" > \"$OUTPUT_DIR/last_update.txt\"\n```\n\nMake the script executable:\n```bash\nchmod +x update_bin_calendar.sh\n```\n\nAdd to crontab to run weekly (every Monday at 2 AM):\n```bash\n0 2 * * 1 /path/to/update_bin_calendar.sh\n```\n\n**Google Assistant/Alexa Integration**\n\nIf you have your calendar connected to Google Calendar or Outlook, you can ask your smart assistant about upcoming bin collections:\n\n- \"Hey Google, when is my next bin collection?\"\n- \"Alexa, what's on my calendar tomorrow?\" (will include bin collections)\n\n## Docker API Server\nWe have created an API for this located under [uk_bin_collection_api_server](https://github.com/robbrad/UKBinCollectionData/uk_bin_collection_api_server)\n\n### Prerequisites\n\n- Docker installed on your machine.\n- Python (if you plan to run the API locally without Docker).\n\n### Running the API with Docker\n\n1. Clone this repository.\n2. Navigate to the `uk_bin_collection_api_server` directory of the project.\n\n#### Build the Docker Container\n\n```bash\ndocker build -t ukbc_api_server .\n```\n\n```\ndocker run -p 8080:8080 ukbc_api_server\n```\n\n#### Accessing the API\n\nOnce the Docker container is running, you can access the API endpoints:\n\n API Base URL: http://localhost:8080/api\n Swagger UI: http://localhost:8080/api/ui/\n\n#### API Documentation\n\nThe API documentation can be accessed via the Swagger UI. Use the Swagger UI to explore available endpoints, test different requests, and understand the API functionalities.\n\n![Swagger UI](SwaggerUI.png)\n\n#### API Endpoints\n`GET /bin_collection/{council}`\n\nDescription: Retrieves information about bin collections for the specified council.\n\nParameters:\n\n council (required): Name of the council.\n Other optional parameters: [Specify optional parameters if any]\n\nExample Request:\n\n```bash\ncurl -X GET \"http://localhost:8080/api/bin_collection/{council}\" -H \"accept: application/json\"\n```\n\n## Docker Compose\nThis includes the Selenium standalone-chrome for Selenium-based councils.\n\n```yaml\nversion: '3'\n\nservices:\n ukbc_api_server:\n build:\n context: .\n dockerfile: Dockerfile \n ports:\n - \"8080:8080\" # Adjust the ports as needed\n depends_on:\n - selenium\n\n selenium:\n image: selenium/standalone-chrome:latest\n ports:\n - \"4444:4444\"\n\n```\n### Run with\n```bash\nsudo apt-get update\nsudo apt-get install docker-compose\n\ndocker-compose up\n```\n\n---\n\n## FAQ\n#### I've got an issue/support question—what do I do?\nPlease post in the [HomeAssistant thread](https://community.home-assistant.io/t/bin-waste-collection/55451) or raise a new (non-council request) [issue](https://github.com/robbrad/UKBinCollectionData/issues/new).\n\n#### I'd like to contribute, where do I start?\nContributions are always welcome! See ```CONTRIBUTING.md``` to get started. Please adhere to the project's [code of conduct](https://github.com/robbrad/UKBinCollectionData/blob/master/CODE_OF_CONDUCT.md).\n\n- If you're new to coding/Python/BeautifulSoup, feel free to check [here](https://github.com/robbrad/UKBinCollectionData/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) for issues that are good for newcomers!\n- If you would like to try writing your own scraper, feel free to fork this project and use existing scrapers as a base for your approach (or `councilclasstemplate.py`).\n\n## Contributors\n\n \"Image\n\n" }, { "path": "behave.ini", "content": "[behave]\n#default_tags = not (@xfail or @not_implemented)\nshow_skipped = true\nformat = rerun\n progress3\noutfiles = rerun.txt\n build/behave.reports/report_progress3.txt\njunit = true\njunit_directory = build/behave.reports\nlogging_level = INFO\n\n# -- HTML-FORMATTER REQUIRES: pip install behave-html-formatter\n# SEE ALSO: https://github.com/behave-contrib/behave-html-formatter\n\n[behave.formatters]\nhtml = behave_html_formatter:HTMLFormatter" }, { "path": "bin_to_ics.py", "content": "#!/usr/bin/env python3\n\"\"\"\nScript to convert UK Bin Collection Data to ICS calendar file.\nTakes JSON output from the bin collection data retriever and creates calendar events\nfor each collection date. The events are saved to an ICS file that can be imported\ninto calendar applications.\n\nFeatures:\n- Creates all-day events for bin collections by default\n- Optional alarms/reminders before collection days\n- Groups multiple bin collections on the same day into one event\n\"\"\"\n\nimport argparse\nimport datetime\nimport json\nimport os\nimport sys\nfrom typing import Dict, List, Optional, Union\n\ntry:\n from icalendar import Calendar, Event, Alarm\nexcept ImportError:\n print(\"Error: Required package 'icalendar' not found.\")\n print(\"Please install it with: pip install icalendar\")\n sys.exit(1)\n\n\ndef parse_time_delta(time_str: str) -> datetime.timedelta:\n \"\"\"\n Parse a time string into a timedelta object.\n \n Formats supported:\n - \"1d\" or \"1day\" or \"1days\" for days\n - \"2h\" or \"2hour\" or \"2hours\" for hours\n - \"30m\" or \"30min\" or \"30mins\" or \"30minutes\" for minutes\n \n Args:\n time_str: String representing a time duration\n \n Returns:\n timedelta object representing the duration\n \"\"\"\n time_str = time_str.lower().strip()\n \n # Handle days\n if time_str.endswith('d') or time_str.endswith('day') or time_str.endswith('days'):\n if time_str.endswith('days'):\n value = int(time_str[:-4])\n elif time_str.endswith('day'):\n value = int(time_str[:-3])\n else:\n value = int(time_str[:-1])\n return datetime.timedelta(days=value)\n \n # Handle hours\n elif time_str.endswith('h') or time_str.endswith('hour') or time_str.endswith('hours'):\n if time_str.endswith('hours'):\n value = int(time_str[:-5])\n elif time_str.endswith('hour'):\n value = int(time_str[:-4])\n else:\n value = int(time_str[:-1])\n return datetime.timedelta(hours=value)\n \n # Handle minutes\n elif time_str.endswith('m') or time_str.endswith('min') or time_str.endswith('mins') or time_str.endswith('minutes'):\n if time_str.endswith('minutes'):\n value = int(time_str[:-7])\n elif time_str.endswith('mins'):\n value = int(time_str[:-4])\n elif time_str.endswith('min'):\n value = int(time_str[:-3])\n else:\n value = int(time_str[:-1])\n return datetime.timedelta(minutes=value)\n \n # Default to hours if no unit specified\n else:\n try:\n value = int(time_str)\n return datetime.timedelta(hours=value)\n except ValueError:\n raise ValueError(f\"Invalid time format: {time_str}. Use format like '1d', '2h', or '30m'.\")\n\n\ndef create_bin_calendar(\n bin_data: Dict,\n calendar_name: str = \"Bin Collections\",\n alarm_times: Optional[List[datetime.timedelta]] = None,\n all_day: bool = True\n) -> Calendar:\n \"\"\"\n Create a calendar from bin collection data.\n \n Args:\n bin_data: Dictionary containing bin collection data\n calendar_name: Name of the calendar\n alarm_times: List of timedeltas for when reminders should trigger before the event\n all_day: Whether the events should be all-day events\n \n Returns:\n Calendar object with events for each bin collection\n \"\"\"\n cal = Calendar()\n cal.add('prodid', '-//UK Bin Collection Data//bin_to_ics.py//EN')\n cal.add('version', '2.0')\n cal.add('name', calendar_name)\n cal.add('x-wr-calname', calendar_name)\n \n # Process bin collection data\n if 'bins' not in bin_data:\n print(\"Error: Invalid bin data format. 'bins' key not found.\")\n sys.exit(1)\n \n # Group collections by date to combine bins collected on the same day\n collections_by_date = {}\n \n for bin_info in bin_data['bins']:\n if 'type' not in bin_info or 'collectionDate' not in bin_info:\n continue\n \n bin_type = bin_info['type']\n collection_date_str = bin_info['collectionDate']\n \n # Convert date string to datetime object\n try:\n # Expecting format DD/MM/YYYY\n collection_date = datetime.datetime.strptime(collection_date_str, \"%d/%m/%Y\").date()\n except ValueError:\n print(f\"Warning: Unable to parse date '{collection_date_str}'. Skipping.\")\n continue\n \n # Add to collections by date\n if collection_date not in collections_by_date:\n collections_by_date[collection_date] = []\n \n collections_by_date[collection_date].append(bin_type)\n \n # Create events for each collection date\n for collection_date, bin_types in collections_by_date.items():\n event = Event()\n \n # Join multiple bin types into one summary if needed\n bin_types_str = \", \".join(bin_types)\n \n # Create event summary and description\n summary = f\"Bin Collection: {bin_types_str}\"\n description = f\"Collection for: {bin_types_str}\"\n \n # Add event details\n event.add('summary', summary)\n event.add('description', description)\n \n # Set the event as all-day if requested\n if all_day:\n event.add('dtstart', collection_date)\n event.add('dtend', collection_date + datetime.timedelta(days=1))\n else:\n # Default to 7am for non-all-day events\n collection_datetime = datetime.datetime.combine(\n collection_date, \n datetime.time(7, 0, 0)\n )\n event.add('dtstart', collection_datetime)\n event.add('dtend', collection_datetime + datetime.timedelta(hours=1))\n \n # Add alarms if specified\n if alarm_times:\n for alarm_time in alarm_times:\n alarm = create_alarm(trigger_before=alarm_time)\n event.add_component(alarm)\n \n # Generate a unique ID for the event\n event_id = f\"bin-collection-{collection_date.isoformat()}-{hash(bin_types_str) % 10000:04d}@ukbincollection\"\n event.add('uid', event_id)\n \n # Add the event to the calendar\n cal.add_component(event)\n \n return cal\n\n\ndef create_alarm(trigger_before: datetime.timedelta) -> Alarm:\n \"\"\"\n Create an alarm component for calendar events.\n \n Args:\n trigger_before: How long before the event to trigger the alarm\n \n Returns:\n Alarm component\n \"\"\"\n alarm = Alarm()\n alarm.add('action', 'DISPLAY')\n alarm.add('description', 'Bin collection reminder')\n alarm.add('trigger', -trigger_before)\n \n return alarm\n\n\ndef save_calendar(calendar: Calendar, output_file: str) -> None:\n \"\"\"\n Save a calendar to an ICS file.\n \n Args:\n calendar: Calendar object to save\n output_file: Path to save the calendar file\n \"\"\"\n with open(output_file, 'wb') as f:\n f.write(calendar.to_ical())\n \n print(f\"Calendar saved to {output_file}\")\n\n\ndef load_json_data(input_file: Optional[str] = None) -> Dict:\n \"\"\"\n Load bin collection data from JSON file or stdin.\n \n Args:\n input_file: Path to JSON file (if None, read from stdin)\n \n Returns:\n Dictionary containing bin collection data\n \"\"\"\n if input_file:\n try:\n with open(input_file, 'r') as f:\n return json.load(f)\n except (json.JSONDecodeError, FileNotFoundError) as e:\n print(f\"Error reading input file: {e}\")\n sys.exit(1)\n else:\n try:\n return json.load(sys.stdin)\n except json.JSONDecodeError as e:\n print(f\"Error parsing JSON from stdin: {e}\")\n sys.exit(1)\n\n\ndef main():\n parser = argparse.ArgumentParser(description='Convert UK Bin Collection Data to ICS calendar file.')\n parser.add_argument('--input', '-i', help='Input JSON file (if not provided, read from stdin)')\n parser.add_argument('--output', '-o', help='Output ICS file (default: bin.ics)', \n default='bin.ics')\n parser.add_argument('--name', '-n', help='Calendar name (default: Bin Collections)',\n default='Bin Collections')\n parser.add_argument('--alarms', '-a', help='Comma-separated list of alarm times before event (e.g., \"1d,2h,30m\")')\n parser.add_argument('--no-all-day', action='store_true', help='Create timed events instead of all-day events')\n \n args = parser.parse_args()\n \n # Parse alarm times\n alarm_times = None\n if args.alarms:\n alarm_times = []\n for alarm_str in args.alarms.split(','):\n try:\n alarm_times.append(parse_time_delta(alarm_str.strip()))\n except ValueError as e:\n print(f\"Warning: {e}\")\n \n # Load bin collection data\n bin_data = load_json_data(args.input)\n \n # Create calendar\n calendar = create_bin_calendar(\n bin_data, \n args.name, \n alarm_times=alarm_times,\n all_day=not args.no_all_day\n )\n \n # Save calendar to file\n save_calendar(calendar, args.output)\n\n\nif __name__ == '__main__':\n main()\n\n" }, { "path": "conftest.py", "content": "# conftest.py\n\nimport pytest\nfrom _pytest.config.argparsing import Parser\nfrom _pytest.fixtures import FixtureRequest\nfrom homeassistant.core import HomeAssistant\nfrom unittest.mock import AsyncMock, MagicMock, patch\n\n\n\n\ndef pytest_addoption(parser: Parser) -> None:\n parser.addoption(\"--headless\", action=\"store\", default=\"True\", type=str)\n parser.addoption(\"--local_browser\", action=\"store\", default=\"False\", type=str)\n parser.addoption(\"--selenium_url\", action=\"store\", default=\"http://localhost:4444\", type=str)\n\n@pytest.fixture(scope='session')\ndef headless_mode(request: FixtureRequest) -> str:\n return request.config.getoption(\"--headless\")\n\n@pytest.fixture(scope='session')\ndef local_browser(request: FixtureRequest) -> str:\n return request.config.getoption(\"--local_browser\")\n\n@pytest.fixture(scope='session')\ndef selenium_url(request: FixtureRequest) -> str:\n return request.config.getoption(\"--selenium_url\")\n\n@pytest.fixture\ndef hass():\n \"\"\"Mock HomeAssistant instance.\"\"\"\n hass = MagicMock(spec=HomeAssistant)\n \n # Mock the event loop with create_task as AsyncMock\n hass.loop = MagicMock()\n hass.loop.create_task = AsyncMock()\n \n # Mock config_entries and its flow\n hass.config_entries = MagicMock()\n hass.config_entries.flow = MagicMock()\n \n # Mock asynchronous methods with AsyncMock\n hass.config_entries.flow.async_init = AsyncMock()\n hass.config_entries.flow.async_configure = AsyncMock()\n \n # Mock async_get_entry to return a MockConfigEntry when called\n hass.config_entries.async_get_entry = AsyncMock()\n \n # Mock async_unload as an AsyncMock\n hass.config_entries.async_unload = AsyncMock(return_value=True)\n \n # Mock async_block_till_done as an AsyncMock\n hass.async_block_till_done = AsyncMock()\n hass.async_add_executor_job = AsyncMock() # Ensure compatibility with async calls\n \n return hass\n\n@pytest.fixture\ndef enable_custom_integrations():\n \"\"\"Fixture to enable custom integrations.\"\"\"\n with patch(\"homeassistant.helpers.discovery.load_platform\") as mock_load:\n yield mock_load\n" }, { "path": "custom_components/__init__.py", "content": "" }, { "path": "custom_components/uk_bin_collection/README.md", "content": "# UK Bin Collection Integration Configuration\n\nThis integration allows you to configure the collection details for your local UK council. The configuration flow is divided into several steps, and some fields are dynamically shown based on your selected council’s requirements.\n\n---\n\n## Table of Contents\n\n- [UK Bin Collection Integration Configuration](#uk-bin-collection-integration-configuration)\n - [Table of Contents](#table-of-contents)\n - [Step 1: Basic Setup](#step-1-basic-setup)\n - [Step 2: Council-Specific Details](#step-2-council-specific-details)\n - [Selenium \\& Chromium Checks](#selenium--chromium-checks)\n - [Reconfiguration / Options Flow](#reconfiguration--options-flow)\n - [Validation Requirements](#validation-requirements)\n - [Icon Color Mapping JSON Example](#icon-color-mapping-json-example)\n - [Service: `uk_bin_collection.manual_refresh`](#service-uk_bin_collectionmanual_refresh)\n - [Service Data](#service-data)\n - [How the Service Works](#how-the-service-works)\n - [Example Automation to Refresh Bin Data (Manual Refresh Mode)](#example-automation-to-refresh-bin-data-manual-refresh-mode)\n\n---\n\n## Step 1: Basic Setup\n\nIn the initial configuration step you must provide the following:\n\n| Field Name | Requirement | Type | Description |\n|-------------------------|-------------|---------|-------------|\n| **name** | Required | String | A unique identifier for your configuration entry. This is used to distinguish different configurations. |\n| **council** | Required | Select | A drop-down selection that displays available councils by their *wiki name*. Your selection will later be mapped to the corresponding council key. |\n| **manual_refresh_only** | Optional | Boolean | If checked, only manual refreshes will be performed. Defaults to `False`. |\n| **icon_color_mapping** | Optional | String | A text field for entering a JSON-formatted mapping for icon colors. If provided, the JSON must be valid. |\n\n> **Note:** The list of available councils is dynamically loaded from an external data source.\n\n---\n\n## Step 2: Council-Specific Details\n\nAfter you provide the basic details, the next step requests council-specific information. The fields displayed depend on the selected council’s requirements. Below is a summary of possible fields:\n\n| Field Name | Requirement | Type | Description |\n|--------------------|------------------------------|---------|-------------|\n| **url** | Required (if applicable) | String | The URL to access the bin collection data. Some councils require this field; however, if the council’s configuration has `skip_get_url` enabled, this field may be pre-filled or skipped. |\n| **uprn** | Required (if applicable) | String | The Unique Property Reference Number, if the council supports it. |\n| **postcode** | Required (if applicable) | String | The postcode for the address in question. |\n| **number** | Required (if applicable) | String | The house number. (This corresponds to the `\"house_number\"` key in the council configuration.) |\n| **usrn** | Required (if applicable) | String | The Unique Street Reference Number, if required by the council. |\n| **web_driver** | Optional (if applicable) | String | If the council requires Selenium for data fetching, you may provide the web driver command. |\n| **headless** | Optional (if applicable) | Boolean | Indicates whether to run the browser in headless mode (default is `True`). Only shown if `web_driver` is applicable. |\n| **local_browser** | Optional (if applicable) | Boolean | Choose whether to use a local browser instance (default is `False`). Only shown if `web_driver` is applicable. |\n| **timeout** | Optional | Integer | Sets the request timeout in seconds. Defaults to `60` seconds and must be at least `10`. |\n| **update_interval**| Optional | Integer | The refresh frequency in hours. Defaults to `12` hours and must be at least `1`. |\n\n### Selenium & Chromium Checks\n\nFor councils that require Selenium (i.e. if the council configuration contains a `\"web_driver\"` key):\n\n- **Selenium Server Check:** \n The integration checks several remote Selenium server URLs (and an optional custom URL, if provided) to determine if they are accessible. The results are displayed as part of the informational message.\n\n- **Chromium Installation Check:** \n A check is performed to ensure that a local Chromium browser is installed. The result is shown to help troubleshoot if Selenium is required.\n\nThe combined status of these checks is presented as an HTML-formatted message in the council-specific form.\n\n---\n\n## Reconfiguration / Options Flow\n\nIf you need to update your configuration later, you can do so via the options (or reconfiguration) flow. The following fields are available for editing:\n\n| Field Name | Requirement | Type | Description |\n|-------------------------|-------------|---------|-------------|\n| **name** | Required | String | The identifier for the configuration entry. |\n| **council** | Required | Select | A drop-down list to select your council (displayed by its *wiki name*). |\n| **manual_refresh_only** | Optional | Boolean | If enabled, the system will perform only manual refreshes. |\n| **update_interval** | Required | Integer | The refresh frequency in hours (must be at least 1). If manual refresh is enabled, this will be set to `None`. |\n| **icon_color_mapping** | Optional | String | A JSON-formatted string for mapping icon colors. Must be valid JSON if provided. |\n\n> **Additional Fields:** \nDepending on your initial configuration and the council selected, you may also be able to update fields such as **url**, **uprn**, **postcode**, **number**, **web_driver**, **headless**, **local_browser**, and **timeout**.\n\nOnce you submit the updated options, the integration will reload the configuration with the new settings.\n\n---\n\n## Validation Requirements\n\n- **Unique Name & Duplicate Check:** \n The system checks to ensure that the provided `name` or combination of `council` and `url` is unique. If a duplicate entry exists, an error is shown.\n\n- **JSON Format:** \n Any input provided in the **icon_color_mapping** field must be valid JSON. If the JSON is invalid, you will be prompted to correct the input.\n\n- **Numeric Ranges:** \n - **Timeout:** Must be an integer and at least `10` seconds.\n - **Update Interval:** Must be an integer and at least `1` hour.\n\n- **Council-Specific Fields:** \n The required fields in the council-specific step (such as `url`, `uprn`, `postcode`, etc.) depend on the selected council's configuration. Only the fields relevant to the chosen council will be presented.\n\n---\n\n## Icon Color Mapping JSON Example\n\nBelow is an example of a valid JSON configuration for the **icon_color_mapping** field. This mapping allows you to customize the icons and colors for different bin types in the sensor platform. The bin name **must match** the name of the bin returned from the council.\n\n```json\n{\n \"general\": {\n \"icon\": \"mdi:trash-can\",\n \"color\": \"green\"\n },\n \"recycling\": {\n \"icon\": \"mdi:recycle\",\n \"color\": \"blue\"\n },\n \"food\": {\n \"icon\": \"mdi:food\",\n \"color\": \"red\"\n },\n \"garden\": {\n \"icon\": \"mdi:leaf\",\n \"color\": \"brown\"\n }\n}\n```\n\n## Service: `uk_bin_collection.manual_refresh`\n\nThis service triggers a manual refresh of the bin collection data for a specific configuration entry. It is particularly useful when your integration is set to **manual refresh only** (i.e., when the `manual_refresh_only` option is enabled in your configuration). When called, the service will instruct the data coordinator to fetch the latest bin collection data immediately.\n\n### Service Data\n\n| Field | Type | Description |\n|-----------|--------|-------------|\n| `entry_id` | String | **Required.** The unique identifier of the configuration entry. You can find this value in the integration details or in Home Assistant's configuration registry. |\n\n### How the Service Works\n\n1. **Input Verification:** \n The service checks whether the `entry_id` is provided in the service call data.\n\n2. **Configuration Entry Lookup:** \n It verifies that a configuration entry exists for the provided `entry_id` in Home Assistant's data storage.\n\n3. **Coordinator Check:** \n It ensures that the corresponding data coordinator (which is responsible for fetching bin collection data) is available.\n\n4. **Data Refresh:** \n The service calls `async_request_refresh()` on the coordinator to fetch the latest data.\n\nIf any of these steps fail, error messages will be logged to help diagnose the issue.\n\n---\n\n## Example Automation to Refresh Bin Data (Manual Refresh Mode)\n\nBelow is an example automation that triggers a manual refresh of the bin collection data every day at 7:00 AM. This is useful if your integration is configured for manual refresh only. Be sure to replace `\"YOUR_CONFIG_ENTRY_ID\"` with the actual entry ID of your configuration.\n\n```yaml\nautomation:\n - alias: \"Daily Manual Refresh for UK Bin Collection\"\n description: \"Triggers a manual refresh of the bin collection data every day at 7 AM for integrations set to manual refresh only.\"\n trigger:\n - platform: time\n at: \"07:00:00\"\n action:\n - service: uk_bin_collection.manual_refresh\n data:\n entry_id: \"YOUR_CONFIG_ENTRY_ID\"\n mode: single\n```" }, { "path": "custom_components/uk_bin_collection/__init__.py", "content": "\"\"\"The UK Bin Collection integration.\"\"\"\n\nimport asyncio\nimport logging\nfrom datetime import timedelta\nimport json\n\nfrom homeassistant.config_entries import ConfigEntry\nfrom homeassistant.core import HomeAssistant\nfrom homeassistant.exceptions import ConfigEntryNotReady\nfrom homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed\n\nfrom datetime import datetime\n\nfrom homeassistant.util import dt as dt_util\n\nfrom .const import DOMAIN, LOG_PREFIX, PLATFORMS, EXCLUDED_ARG_KEYS\nfrom uk_bin_collection.uk_bin_collection.collect_data import UKBinCollectionApp\n\n\nfrom homeassistant.helpers import config_validation as cv\n\nPLATFORM_SCHEMA = cv.platform_only_config_schema\n\n_LOGGER = logging.getLogger(__name__)\n\n\nasync def async_setup(hass: HomeAssistant, config: dict) -> bool:\n \"\"\"Set up the UK Bin Collection component.\"\"\"\n _LOGGER.debug(f\"{LOG_PREFIX} async_setup called with config: {config}\")\n try:\n hass.data.setdefault(DOMAIN, {})\n _LOGGER.debug(\n f\"{LOG_PREFIX} hass.data[DOMAIN] initialized: {hass.data[DOMAIN]}\"\n )\n\n async def handle_manual_refresh(call):\n \"\"\"Refresh all bin sensors for a given config entry.\"\"\"\n _LOGGER.debug(\n f\"{LOG_PREFIX} manual_refresh service called with data: {call.data}\"\n )\n entry_id = call.data.get(\"entry_id\")\n\n if not entry_id:\n _LOGGER.error(\n \"[UKBinCollection] No 'entry_id' was passed to uk_bin_collection.manual_refresh service.\"\n )\n return\n\n if entry_id not in hass.data[DOMAIN]:\n _LOGGER.error(\n \"[UKBinCollection] No config entry found for entry_id: %s\", entry_id\n )\n return\n\n coordinator = hass.data[DOMAIN][entry_id].get(\"coordinator\")\n if not coordinator:\n _LOGGER.error(\n \"[UKBinCollection] Coordinator is missing for entry_id: %s\",\n entry_id,\n )\n return\n\n _LOGGER.debug(\n \"[UKBinCollection] About to request a manual refresh via coordinator\"\n )\n await coordinator.async_request_refresh()\n _LOGGER.debug(\"[UKBinCollection] Manual refresh completed\")\n\n # Register a service named `uk_bin_collection.manual_refresh`\n _LOGGER.debug(\"[UKBinCollection] Registering manual_refresh service\")\n hass.services.async_register(\n DOMAIN, \"manual_refresh\", handle_manual_refresh # The service name\n )\n _LOGGER.debug(\n \"[UKBinCollection] manual_refresh service registered successfully\"\n )\n\n _LOGGER.info(\"[UKBinCollection] async_setup completed without errors.\")\n return True\n\n except Exception as exc:\n _LOGGER.exception(\"%s Unexpected error in async_setup: %s\", LOG_PREFIX, exc)\n return False\n\n\nasync def async_migrate_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:\n \"\"\"Migrate old config entries to new version.\"\"\"\n try:\n _LOGGER.debug(\n f\"{LOG_PREFIX} async_migrate_entry called for entry_id={config_entry.entry_id}, version={config_entry.version}\"\n )\n\n if config_entry.version == 1:\n _LOGGER.info(\n f\"{LOG_PREFIX} Migrating config entry {config_entry.entry_id} from version 1 to 2.\"\n )\n\n data = config_entry.data.copy()\n if \"update_interval\" not in data:\n data[\"update_interval\"] = 12\n _LOGGER.debug(\n f\"{LOG_PREFIX} 'update_interval' not found. Setting default to 12 hours.\"\n )\n else:\n _LOGGER.debug(\n f\"{LOG_PREFIX} 'update_interval' found: {data['update_interval']} hours.\"\n )\n\n hass.config_entries.async_update_entry(config_entry, data=data)\n\n _LOGGER.info(\n f\"{LOG_PREFIX} Migration of config entry {config_entry.entry_id} to version 2 successful.\"\n )\n\n else:\n _LOGGER.debug(\n f\"{LOG_PREFIX} No migration needed for entry_id={config_entry.entry_id}\"\n )\n\n return True\n\n except Exception as exc:\n _LOGGER.exception(\n \"%s Unexpected error during async_migrate_entry: %s\", LOG_PREFIX, exc\n )\n return False\n\n\nasync def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:\n \"\"\"Set up UK Bin Collection from a config entry.\"\"\"\n _LOGGER.info(\n f\"{LOG_PREFIX} async_setup_entry called for entry_id={config_entry.entry_id}\"\n )\n\n try:\n name = config_entry.data.get(\"name\")\n if not name:\n _LOGGER.error(f\"{LOG_PREFIX} 'name' is missing in config entry.\")\n raise ConfigEntryNotReady(\"Missing 'name' in configuration.\")\n\n timeout = config_entry.data.get(\"timeout\", 60)\n manual_refresh = config_entry.data.get(\"manual_refresh_only\", False)\n icon_color_mapping = config_entry.data.get(\"icon_color_mapping\", \"{}\")\n update_interval_hours = config_entry.data.get(\"update_interval\", 12)\n\n _LOGGER.debug(\n f\"{LOG_PREFIX} Retrieved configuration: \"\n f\"name={name}, timeout={timeout}, \"\n f\"manual_refresh_only={manual_refresh}, \"\n f\"update_interval={update_interval_hours} hours, \"\n f\"icon_color_mapping={icon_color_mapping}\"\n )\n\n # Validate 'timeout'\n try:\n timeout = int(timeout)\n if timeout < 10:\n _LOGGER.warning(\n f\"{LOG_PREFIX} Timeout value {timeout} is less than 10. Setting to 10 seconds.\"\n )\n timeout = 10\n except (ValueError, TypeError):\n _LOGGER.warning(\n f\"{LOG_PREFIX} Invalid timeout value: {timeout}. Using default 60 seconds.\"\n )\n timeout = 60\n\n # Decide update interval based on manual_refresh\n if manual_refresh:\n try:\n update_interval_hours = int(update_interval_hours)\n if update_interval_hours < 1:\n update_interval_hours = 12\n except (ValueError, TypeError):\n update_interval_hours = 12\n update_interval = timedelta(hours=update_interval_hours)\n _LOGGER.info(\n \"%s Automatic refresh every %s hour(s).\",\n LOG_PREFIX,\n update_interval_hours,\n )\n else:\n update_interval = None\n _LOGGER.info(\n \"%s Manual refresh only: no automatic updates scheduled.\", LOG_PREFIX\n )\n\n # Prepare arguments for UKBinCollectionApp\n args = build_ukbcd_args(config_entry.data)\n _LOGGER.debug(f\"{LOG_PREFIX} UKBinCollectionApp args: {args}\")\n\n # Initialize the UK Bin Collection Data application\n ukbcd = UKBinCollectionApp()\n ukbcd.set_args(args)\n _LOGGER.debug(f\"{LOG_PREFIX} UKBinCollectionApp initialized and arguments set.\")\n\n # Initialize the data coordinator\n coordinator = HouseholdBinCoordinator(\n hass,\n ukbcd,\n name,\n timeout=timeout,\n update_interval=update_interval,\n )\n\n _LOGGER.debug(\n f\"{LOG_PREFIX} HouseholdBinCoordinator initialized with update_interval={update_interval}.\"\n )\n\n # Perform first refresh\n await coordinator.async_config_entry_first_refresh()\n _LOGGER.info(\n f\"{LOG_PREFIX} Initial data fetched successfully for entry_id={config_entry.entry_id}\"\n )\n\n # Store the coordinator in Home Assistant's data\n hass.data[DOMAIN][config_entry.entry_id] = {\"coordinator\": coordinator}\n _LOGGER.debug(\n f\"{LOG_PREFIX} Coordinator stored in hass.data under entry_id={config_entry.entry_id}\"\n )\n\n # Forward the setup to all platforms (sensor and calendar)\n _LOGGER.debug(f\"{LOG_PREFIX} Forwarding setup to platforms: {PLATFORMS}\")\n await hass.config_entries.async_forward_entry_setups(config_entry, PLATFORMS)\n\n _LOGGER.info(\n f\"{LOG_PREFIX} async_setup_entry finished for entry_id={config_entry.entry_id}\"\n )\n return True\n\n except UpdateFailed as e:\n _LOGGER.error(f\"{LOG_PREFIX} Unable to fetch initial data: {e}\")\n raise ConfigEntryNotReady from e\n\n except Exception as exc:\n _LOGGER.exception(\n \"%s Unexpected error in async_setup_entry: %s\", LOG_PREFIX, exc\n )\n raise ConfigEntryNotReady from exc\n\n\nasync def async_unload_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:\n \"\"\"Unload a config entry.\"\"\"\n _LOGGER.info(f\"{LOG_PREFIX} Unloading config entry {config_entry.entry_id}\")\n unload_ok = True\n\n try:\n for platform in PLATFORMS:\n platform_unload_ok = await hass.config_entries.async_forward_entry_unload(\n config_entry, platform\n )\n if not platform_unload_ok:\n _LOGGER.warning(\n f\"{LOG_PREFIX} Failed to unload '{platform}' platform for entry_id={config_entry.entry_id}\"\n )\n unload_ok = False\n else:\n _LOGGER.debug(\n f\"{LOG_PREFIX} Successfully unloaded '{platform}' for entry_id={config_entry.entry_id}\"\n )\n\n if unload_ok:\n hass.data[DOMAIN].pop(config_entry.entry_id, None)\n _LOGGER.debug(\n f\"{LOG_PREFIX} Removed coordinator for entry_id={config_entry.entry_id}\"\n )\n else:\n _LOGGER.warning(\n f\"{LOG_PREFIX} One or more platforms failed to unload for entry_id={config_entry.entry_id}\"\n )\n\n except Exception as exc:\n _LOGGER.exception(\n \"%s Unexpected error in async_unload_entry: %s\", LOG_PREFIX, exc\n )\n unload_ok = False\n\n return unload_ok\n\n\ndef build_ukbcd_args(config_data: dict) -> list:\n \"\"\"Build the argument list for UKBinCollectionApp from config data.\"\"\"\n council = config_data.get(\"original_parser\") or config_data.get(\"council\", \"\")\n url = config_data.get(\"url\", \"\")\n args = [council, url]\n\n # Per-key formatters: return a list of CLI args for that key\n def _format_headless(v):\n return [\"--headless\"] if v else [\"--not-headless\"]\n\n def _format_web_driver(v):\n return [f\"--web_driver={v.rstrip('/')}\"] if v is not None else []\n\n formatters = {\n \"headless\": _format_headless,\n \"web_driver\": _format_web_driver,\n }\n\n for key, value in config_data.items():\n if key in EXCLUDED_ARG_KEYS:\n continue\n fmt = formatters.get(key)\n if fmt:\n args.extend(fmt(value))\n else:\n args.append(f\"--{key}={value}\")\n\n return args\n\n\nclass HouseholdBinCoordinator(DataUpdateCoordinator):\n \"\"\"Coordinator to manage fetching and updating UK Bin Collection data.\"\"\"\n\n def __init__(\n self,\n hass: HomeAssistant,\n ukbcd: UKBinCollectionApp,\n name: str,\n timeout: int = 60,\n update_interval: timedelta = timedelta(hours=12),\n ) -> None:\n \"\"\"Initialize the data coordinator.\"\"\"\n super().__init__(\n hass,\n _LOGGER,\n name=\"UK Bin Collection Data\",\n update_interval=update_interval,\n )\n self.ukbcd = ukbcd\n self.name = name\n self.timeout = timeout\n\n self._last_good_data = {}\n\n _LOGGER.debug(\n f\"{LOG_PREFIX} HouseholdBinCoordinator __init__: name={name}, timeout={timeout}, update_interval={update_interval}\"\n )\n\n async def _async_update_data(self) -> dict:\n \"\"\"Fetch and process the latest bin collection data.\"\"\"\n _LOGGER.debug(f\"{LOG_PREFIX} _async_update_data called.\")\n _LOGGER.info(\n f\"{LOG_PREFIX} Fetching latest bin collection data with timeout={self.timeout}\"\n )\n\n try:\n data = await asyncio.wait_for(\n self.hass.async_add_executor_job(self.ukbcd.run),\n timeout=self.timeout,\n )\n _LOGGER.debug(f\"{LOG_PREFIX} Raw data fetched from ukbcd.run(): {data}\")\n\n parsed_data = json.loads(data)\n _LOGGER.debug(f\"{LOG_PREFIX} JSON parsed data: {parsed_data}\")\n\n processed_data = self.process_bin_data(parsed_data)\n\n if not processed_data:\n _LOGGER.warning(\n f\"{LOG_PREFIX} No bin data found. Using last known good data.\"\n )\n if self._last_good_data:\n return self._last_good_data\n else:\n _LOGGER.warning(f\"{LOG_PREFIX} No previous data to fall back to.\")\n return {}\n\n self._last_good_data = processed_data\n _LOGGER.debug(f\"{LOG_PREFIX} Processed data: {processed_data}\")\n\n _LOGGER.info(f\"{LOG_PREFIX} Bin collection data updated successfully.\")\n return processed_data\n\n except asyncio.TimeoutError as exc:\n _LOGGER.error(f\"{LOG_PREFIX} Timeout while updating data: {exc}\")\n raise UpdateFailed(f\"Timeout while updating data: {exc}\") from exc\n except json.JSONDecodeError as exc:\n _LOGGER.error(f\"{LOG_PREFIX} JSON decode error: {exc}\")\n raise UpdateFailed(f\"JSON decode error: {exc}\") from exc\n except Exception as exc:\n _LOGGER.exception(f\"{LOG_PREFIX} Unexpected error: {exc}\")\n raise UpdateFailed(f\"Unexpected error: {exc}\") from exc\n\n @staticmethod\n def process_bin_data(data: dict) -> dict:\n \"\"\"Process raw data to determine the next collection dates.\"\"\"\n _LOGGER.debug(f\"{LOG_PREFIX} process_bin_data called with data={data}\")\n\n current_date = dt_util.now().date()\n next_collection_dates = {}\n\n bins = data.get(\"bins\", [])\n _LOGGER.debug(f\"{LOG_PREFIX} Bins found: {bins}\")\n for bin_data in bins:\n bin_type = bin_data.get(\"type\")\n collection_date_str = bin_data.get(\"collectionDate\")\n _LOGGER.debug(f\"{LOG_PREFIX} Processing bin_data={bin_data}\")\n\n if not bin_type or not collection_date_str:\n _LOGGER.warning(\n f\"{LOG_PREFIX} Missing 'type' or 'collectionDate' in bin data: {bin_data}\"\n )\n continue\n\n try:\n collection_date = datetime.strptime(\n collection_date_str, \"%d/%m/%Y\"\n ).date()\n except (ValueError, TypeError) as exc:\n _LOGGER.warning(\n f\"{LOG_PREFIX} Invalid date format '{collection_date_str}' for bin type '{bin_type}'. Error: {exc}\"\n )\n continue\n\n if (\n collection_date < current_date\n and current_date.month == 12\n and collection_date.month == 1\n ):\n collection_date = collection_date.replace(year=current_date.year + 1)\n _LOGGER.debug(\n f\"{LOG_PREFIX} Corrected rollover year for '{bin_type}' to {collection_date}\"\n )\n \n\n existing_date = next_collection_dates.get(bin_type)\n if collection_date >= current_date and (\n not existing_date or collection_date < existing_date\n ):\n next_collection_dates[bin_type] = collection_date\n _LOGGER.debug(\n f\"{LOG_PREFIX} Updated next collection for '{bin_type}' to {collection_date}\"\n )\n\n _LOGGER.debug(\n f\"{LOG_PREFIX} Final next_collection_dates={next_collection_dates}\"\n )\n return next_collection_dates\n" }, { "path": "custom_components/uk_bin_collection/calendar.py", "content": "\"\"\"Calendar platform support for UK Bin Collection Data.\"\"\"\n\nimport logging\nimport uuid\nfrom datetime import datetime, timedelta\nfrom typing import Any, Dict, List, Optional\n\nfrom homeassistant.components.calendar import CalendarEntity, CalendarEvent\nfrom homeassistant.config_entries import ConfigEntry\nfrom homeassistant.core import HomeAssistant, callback\nfrom homeassistant.helpers.entity_platform import AddEntitiesCallback\nfrom homeassistant.helpers.update_coordinator import (\n CoordinatorEntity,\n DataUpdateCoordinator,\n)\n\nfrom .const import DOMAIN, LOG_PREFIX\n\n_LOGGER = logging.getLogger(__name__)\n\n\nclass UKBinCollectionCalendar(CoordinatorEntity, CalendarEntity):\n \"\"\"Calendar entity for UK Bin Collection Data.\"\"\"\n\n def __init__(\n self,\n coordinator: DataUpdateCoordinator,\n bin_type: str,\n unique_id: str,\n name: str,\n ) -> None:\n \"\"\"Initialize the calendar entity.\"\"\"\n super().__init__(coordinator)\n self._bin_type = bin_type\n self._unique_id = unique_id\n self._name = name\n self._attr_unique_id = unique_id\n\n # Optionally, set device_info if you have device grouping\n self._attr_device_info = {\n \"identifiers\": {(DOMAIN, unique_id)},\n \"name\": f\"{self._name} Device\",\n \"manufacturer\": \"UK Bin Collection\",\n \"model\": \"Bin Collection Calendar\",\n \"sw_version\": \"1.0\",\n }\n\n @property\n def name(self) -> str:\n \"\"\"Return the name of the calendar.\"\"\"\n return self._name\n\n @property\n def event(self) -> Optional[CalendarEvent]:\n \"\"\"Return the next collection event.\"\"\"\n collection_date = self.coordinator.data.get(self._bin_type)\n if not collection_date:\n _LOGGER.debug(\n f\"{LOG_PREFIX} No collection date available for '{self._bin_type}'.\"\n )\n return None\n\n return self._create_calendar_event(collection_date)\n\n async def async_get_events(\n self, hass: HomeAssistant, start_date: datetime, end_date: datetime\n ) -> List[CalendarEvent]:\n \"\"\"Return all events within a specific time frame.\"\"\"\n events: List[CalendarEvent] = []\n collection_date = self.coordinator.data.get(self._bin_type)\n\n if not collection_date:\n return events\n\n # The test expects comparison between date parts.\n if start_date.date() <= collection_date <= end_date.date():\n events.append(self._create_calendar_event(collection_date))\n\n return events\n\n def _create_calendar_event(self, collection_date: datetime.date) -> CalendarEvent:\n \"\"\"Create a CalendarEvent for a given collection date.\"\"\"\n return CalendarEvent(\n summary=f\"{self._bin_type} Collection\",\n start=collection_date,\n end=collection_date + timedelta(days=1),\n uid=f\"{self.unique_id}_{collection_date.isoformat()}\",\n )\n\n @property\n def unique_id(self) -> str:\n \"\"\"Return a unique ID for the calendar.\"\"\"\n return self._unique_id\n\n @property\n def available(self) -> bool:\n \"\"\"Return if entity is available.\n\n The entity is considered available if the coordinator’s last update was successful\n and we have a valid collection date for the bin type.\n \"\"\"\n return self.coordinator.last_update_success and (\n self.coordinator.data.get(self._bin_type) is not None\n )\n\n @property\n def extra_state_attributes(self) -> Dict[str, Any]:\n \"\"\"Return extra state attributes.\"\"\"\n return {}\n\n @callback\n def _handle_coordinator_update(self) -> None:\n \"\"\"Handle updates from the coordinator and refresh calendar state.\"\"\"\n self.async_write_ha_state()\n\n\nasync def async_setup_entry(\n hass: HomeAssistant,\n config_entry: ConfigEntry,\n async_add_entities: AddEntitiesCallback,\n) -> None:\n \"\"\"Set up UK Bin Collection Calendar from a config entry.\"\"\"\n _LOGGER.info(f\"{LOG_PREFIX} Setting up UK Bin Collection Calendar platform.\")\n\n # Retrieve the coordinator from hass.data\n coordinator: DataUpdateCoordinator = hass.data[DOMAIN][config_entry.entry_id][\n \"coordinator\"\n ]\n\n # Wait for the first refresh. This will raise if the update fails.\n await coordinator.async_config_entry_first_refresh()\n\n # Create calendar entities only for bin types that have a valid date\n entities = []\n for bin_type, collection_date in coordinator.data.items():\n if collection_date is None:\n continue\n unique_id = calc_unique_calendar_id(config_entry.entry_id, bin_type)\n name = f\"{coordinator.name} {bin_type} Calendar\"\n entities.append(\n UKBinCollectionCalendar(\n coordinator=coordinator,\n bin_type=bin_type,\n unique_id=unique_id,\n name=name,\n )\n )\n\n # Register all calendar entities with Home Assistant\n async_add_entities(entities)\n _LOGGER.debug(\n f\"{LOG_PREFIX} Calendar entities added: {[entity.name for entity in entities]}\"\n )\n\n\nasync def async_unload_entry(\n hass: HomeAssistant,\n config_entry: ConfigEntry,\n async_remove_entities: Any,\n) -> bool:\n \"\"\"Unload a config entry.\"\"\"\n # Unloading is handled in init.py\n return True\n\n\ndef calc_unique_calendar_id(entry_id: str, bin_type: str) -> str:\n \"\"\"Calculate a unique ID for the calendar.\"\"\"\n return f\"{entry_id}_{bin_type}_calendar\"\n" }, { "path": "custom_components/uk_bin_collection/config_flow.py", "content": "import json\nimport logging\nimport shutil\nimport asyncio\nfrom typing import Any, Dict, Optional\n\nimport aiohttp\nimport homeassistant.helpers.config_validation as cv\nimport voluptuous as vol\nfrom homeassistant import config_entries\nfrom homeassistant.core import callback\n\nimport collections # At the top with other imports\n\nfrom .const import DOMAIN, LOG_PREFIX, SELENIUM_SERVER_URLS, BROWSER_BINARIES, INPUT_JSON_URL\n\n_LOGGER = logging.getLogger(__name__)\n\nclass UkBinCollectionConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):\n \"\"\"Handle a config flow for UkBinCollection.\"\"\"\n\n VERSION = 3 # Incremented version for config flow changes\n\n def __init__(self):\n self.councils_data: Optional[Dict[str, Any]] = None\n self.data: Dict[str, Any] = {}\n self.council_names: list = []\n self.council_options: list = []\n self.selenium_checked: bool = False\n self.selenium_available: bool = False\n self.selenium_results: list = []\n self.chromium_checked: bool = False\n self.chromium_installed: bool = False\n\n async def async_migrate_entry(\n self, config_entry: config_entries.ConfigEntry\n ) -> bool:\n \"\"\"Migrate old entry to the new version with manual refresh ticked.\"\"\"\n _LOGGER.info(\"Migrating config entry from version %s\", config_entry.version)\n data = dict(config_entry.data)\n\n if config_entry.version < 3:\n # If the manual_refresh_only key is not present, add it and set to True.\n if \"manual_refresh_only\" not in data:\n _LOGGER.info(\"Setting 'manual_refresh_only' to True in the migration\")\n data[\"manual_refresh_only\"] = True\n\n self.hass.config_entries.async_update_entry(config_entry, data=data)\n _LOGGER.info(\"Migration to version %s successful\", self.VERSION)\n return True\n\n async def async_step_user(self, user_input: Optional[Dict[str, Any]] = None):\n \"\"\"Handle the initial step.\"\"\"\n errors = {}\n\n if self.councils_data is None:\n self.councils_data = await self.get_councils_json()\n if not self.councils_data:\n _LOGGER.error(\"Council data is unavailable.\")\n return self.async_abort(reason=\"Council Data Unavailable\")\n\n self.council_names = list(self.councils_data.keys())\n self.council_options = [\n self.councils_data[name][\"wiki_name\"] for name in self.council_names\n ]\n _LOGGER.debug(\"Loaded council data: %s\", self.council_names)\n\n if user_input is not None:\n _LOGGER.debug(\"User input received: %s\", user_input)\n # Validate user input\n if not user_input.get(\"name\"):\n errors[\"name\"] = \"Name is required.\"\n if not user_input.get(\"council\"):\n errors[\"council\"] = \"Council is required.\"\n\n # Validate JSON mapping if provided\n if user_input.get(\"icon_color_mapping\"):\n if not self.is_valid_json(user_input[\"icon_color_mapping\"]):\n errors[\"icon_color_mapping\"] = \"Invalid JSON format.\"\n\n # Check for duplicate entries\n if not errors:\n existing_entry = await self._async_entry_exists(user_input)\n if existing_entry:\n errors[\"base\"] = \"duplicate_entry\"\n _LOGGER.warning(\n \"Duplicate entry found: %s\", existing_entry.data.get(\"name\")\n )\n\n if not errors:\n # Map selected wiki_name back to council key\n council_key = self.map_wiki_name_to_council_key(user_input[\"council\"])\n if not council_key:\n errors[\"council\"] = \"Invalid council selected.\"\n return self.async_show_form(\n step_id=\"user\", data_schema=..., errors=errors\n )\n user_input[\"council\"] = council_key\n\n # Add original_parser if it's an alias\n if \"original_parser\" in self.councils_data[council_key]:\n user_input[\"original_parser\"] = self.councils_data[council_key][\n \"original_parser\"\n ]\n user_input[\"council\"] = council_key\n self.data.update(user_input)\n\n _LOGGER.debug(\"User input after mapping: %s\", self.data)\n\n # Proceed to the council step\n return await self.async_step_council()\n\n # Show the initial form\n return self.async_show_form(\n step_id=\"user\",\n data_schema=vol.Schema(\n {\n vol.Required(\"name\"): cv.string,\n vol.Required(\"council\"): vol.In(self.council_options),\n vol.Optional(\"manual_refresh_only\", default=True): bool,\n vol.Optional(\"icon_color_mapping\", default=\"\"): cv.string,\n }\n ),\n errors=errors,\n description_placeholders={\"cancel\": \"Press Cancel to abort setup.\"},\n )\n\n async def async_step_council(self, user_input: Optional[Dict[str, Any]] = None):\n \"\"\"Second step to configure the council details.\"\"\"\n errors = {}\n council_key = self.data.get(\"council\")\n council_info = self.councils_data.get(council_key, {})\n requires_selenium = \"web_driver\" in council_info\n\n if user_input is not None:\n _LOGGER.debug(\"Council step user input: %s\", user_input)\n # Validate JSON mapping if provided\n if user_input.get(\"icon_color_mapping\"):\n if not self.is_valid_json(user_input[\"icon_color_mapping\"]):\n errors[\"icon_color_mapping\"] = \"Invalid JSON format.\"\n\n # Handle 'skip_get_url' if necessary\n if council_info.get(\"skip_get_url\", False):\n user_input[\"skip_get_url\"] = True\n user_input[\"url\"] = council_info.get(\"url\", \"\")\n\n # Merge user_input with existing data\n self.data.update(user_input)\n\n # If no errors, create the config entry\n if not errors:\n _LOGGER.info(\n \"%s Creating config entry with data: %s\", LOG_PREFIX, self.data\n )\n return self.async_create_entry(title=self.data[\"name\"], data=self.data)\n else:\n _LOGGER.debug(\"Errors in council step: %s\", errors)\n\n # Prepare description placeholders\n description_placeholders = {}\n if requires_selenium:\n description = await self.perform_selenium_checks(council_key)\n description_placeholders[\"selenium_message\"] = description\n else:\n description_placeholders[\"selenium_message\"] = \"\"\n\n # Show the form\n return self.async_show_form(\n step_id=\"council\",\n data_schema=await self.get_council_schema(council_key),\n errors=errors,\n description_placeholders=description_placeholders,\n )\n\n async def async_step_reconfigure(self, user_input: Optional[Dict[str, Any]] = None):\n \"\"\"Handle reconfiguration of the integration.\"\"\"\n return await self.async_step_reconfigure_confirm()\n\n async def async_step_reconfigure_confirm(\n self, user_input: Optional[Dict[str, Any]] = None\n ):\n \"\"\"Handle a reconfiguration flow initialized by the user.\"\"\"\n errors = {}\n existing_entry = self.hass.config_entries.async_get_entry(\n self.context[\"entry_id\"]\n )\n if existing_entry is None:\n _LOGGER.error(\"Reconfiguration failed: Config entry not found.\")\n return self.async_abort(reason=\"Reconfigure Failed\")\n\n if self.councils_data is None:\n self.councils_data = await self.get_councils_json()\n self.council_names = list(self.councils_data.keys())\n self.council_options = [\n self.councils_data[name][\"wiki_name\"] for name in self.council_names\n ]\n _LOGGER.debug(\"Loaded council data for reconfiguration.\")\n\n council_key = existing_entry.data.get(\"council\")\n council_info = self.councils_data.get(council_key, {})\n council_wiki_name = council_info.get(\"wiki_name\", \"\")\n\n if user_input is not None:\n _LOGGER.debug(\"Reconfigure user input: %s\", user_input)\n # Map selected wiki_name back to council key\n council_key = self.map_wiki_name_to_council_key(user_input[\"council\"])\n user_input[\"council\"] = council_key\n\n # Validate update_interval\n update_interval = user_input.get(\"update_interval\")\n if update_interval is not None:\n try:\n update_interval = int(update_interval)\n if update_interval < 1:\n errors[\"update_interval\"] = \"Must be at least 1 hour.\"\n except ValueError:\n errors[\"update_interval\"] = \"Invalid number.\"\n\n # Validate JSON mapping if provided\n if user_input.get(\"icon_color_mapping\"):\n if not self.is_valid_json(user_input[\"icon_color_mapping\"]):\n errors[\"icon_color_mapping\"] = \"Invalid JSON format.\"\n\n if not errors:\n # Merge the user input with existing data\n data = {**existing_entry.data, **user_input}\n data[\"icon_color_mapping\"] = user_input.get(\"icon_color_mapping\", \"\")\n\n self.hass.config_entries.async_update_entry(\n existing_entry,\n title=user_input.get(\"name\", existing_entry.title),\n data=data,\n )\n # Trigger a data refresh by reloading the config entry\n await self.hass.config_entries.async_reload(existing_entry.entry_id)\n _LOGGER.info(\n \"Configuration updated for entry: %s\", existing_entry.entry_id\n )\n return self.async_abort(reason=\"Reconfigure Successful\")\n else:\n _LOGGER.debug(\"Errors in reconfiguration: %s\", errors)\n\n # Build the schema with existing data\n schema = self.build_reconfigure_schema(existing_entry.data, council_wiki_name)\n\n return self.async_show_form(\n step_id=\"reconfigure_confirm\",\n data_schema=schema,\n errors=errors,\n description_placeholders={\"selenium_message\": \"\"},\n )\n\n async def get_councils_json(self) -> Dict[str, Any]:\n \"\"\"Fetch and return the supported councils data, including aliases and sorted alphabetically.\"\"\"\n try:\n async with aiohttp.ClientSession() as session:\n async with session.get(INPUT_JSON_URL) as response:\n response.raise_for_status()\n data_text = await response.text()\n original_data = json.loads(data_text)\n\n normalized_data = {}\n for key, value in original_data.items():\n normalized_data[key] = value\n for alias in value.get(\"supported_councils\", []):\n alias_data = value.copy()\n alias_data[\"original_parser\"] = key\n alias_data[\"wiki_name\"] = (\n f\"{alias.replace('Council', ' Council')} (via Google Calendar)\"\n )\n normalized_data[alias] = alias_data\n\n # Sort alphabetically by key (council ID)\n sorted_data = dict(sorted(normalized_data.items()))\n\n _LOGGER.debug(\n \"Loaded and sorted %d councils (with aliases)\", len(sorted_data)\n )\n return sorted_data\n\n except Exception as e:\n _LOGGER.exception(\"Error fetching council data: %s\", e)\n return {}\n\n async def get_council_schema(self, council: str) -> vol.Schema:\n \"\"\"Generate the form schema based on council requirements.\"\"\"\n council_info = self.councils_data.get(council, {})\n fields = {}\n\n if not council_info.get(\"skip_get_url\", False) or council_info.get(\n \"custom_component_show_url_field\"\n ):\n fields[vol.Required(\"url\")] = cv.string\n if \"uprn\" in council_info:\n fields[vol.Required(\"uprn\")] = cv.string\n if \"postcode\" in council_info:\n fields[vol.Required(\"postcode\")] = cv.string\n if \"house_number\" in council_info:\n fields[vol.Required(\"number\")] = cv.string\n if \"usrn\" in council_info:\n fields[vol.Required(\"usrn\")] = cv.string\n if \"web_driver\" in council_info:\n fields[vol.Optional(\"web_driver\", default=\"\")] = cv.string\n fields[vol.Optional(\"headless\", default=True)] = bool\n fields[vol.Optional(\"local_browser\", default=False)] = bool\n\n fields[vol.Optional(\"timeout\", default=60)] = vol.All(\n vol.Coerce(int), vol.Range(min=10)\n )\n\n fields[vol.Optional(\"update_interval\", default=12)] = vol.All(\n cv.positive_int, vol.Range(min=1)\n )\n\n return vol.Schema(fields)\n\n def build_reconfigure_schema(\n self, existing_data: Dict[str, Any], council_wiki_name: str\n ) -> vol.Schema:\n \"\"\"Build the schema for reconfiguration with existing data.\"\"\"\n fields = {\n vol.Required(\"name\", default=existing_data.get(\"name\", \"\")): str,\n vol.Required(\"council\", default=council_wiki_name): vol.In(\n self.council_options\n ),\n vol.Optional(\n \"manual_refresh_only\",\n default=existing_data.get(\"manual_refresh_only\", False),\n ): bool,\n vol.Required(\n \"update_interval\", default=existing_data.get(\"update_interval\", 12)\n ): vol.All(cv.positive_int, vol.Range(min=1)),\n }\n\n optional_fields = [\n (\"url\", cv.string),\n (\"uprn\", cv.string),\n (\"postcode\", cv.string),\n (\"number\", cv.string),\n (\"web_driver\", cv.string),\n (\"headless\", bool),\n (\"local_browser\", bool),\n (\"timeout\", vol.All(vol.Coerce(int), vol.Range(min=10))),\n ]\n\n for field_name, validator in optional_fields:\n if field_name in existing_data:\n fields[vol.Optional(field_name, default=existing_data[field_name])] = (\n validator\n )\n\n fields[\n vol.Optional(\n \"icon_color_mapping\",\n default=existing_data.get(\"icon_color_mapping\", \"\"),\n )\n ] = str\n\n return vol.Schema(fields)\n\n async def perform_selenium_checks(self, council_key: str) -> str:\n \"\"\"Perform Selenium and Chromium checks and return a formatted message.\"\"\"\n messages = []\n council_info = self.councils_data.get(council_key, {})\n council_name = council_info.get(\"wiki_name\", council_key)\n\n custom_selenium_url = self.data.get(\"selenium_url\")\n selenium_results = await self.check_selenium_server(custom_selenium_url)\n self.selenium_available = any(accessible for _, accessible in selenium_results)\n self.selenium_checked = True\n\n self.chromium_installed = await self.check_chromium_installed()\n self.chromium_checked = True\n\n # Start building the message with formatted HTML\n messages.append(f\"{council_name} requires Selenium to run.

\")\n\n # Selenium server check results\n messages.append(\"Remote Selenium server URLs checked:
\")\n for url, accessible in selenium_results:\n status = \"✅ Accessible\" if accessible else \"❌ Not accessible\"\n messages.append(f\"{url}: {status}
\")\n\n # Chromium installation check\n chromium_status = (\n \"✅ Installed\" if self.chromium_installed else \"❌ Not installed\"\n )\n messages.append(\"
Local Chromium browser check:
\")\n messages.append(f\"Chromium browser is {chromium_status}.\")\n\n # Combine messages\n return \"\".join(messages)\n\n async def check_selenium_server(self, custom_url: Optional[str] = None) -> list:\n \"\"\"Check if Selenium servers are accessible.\"\"\"\n urls = SELENIUM_SERVER_URLS.copy()\n if custom_url:\n urls.insert(0, custom_url)\n\n results = []\n async with aiohttp.ClientSession() as session:\n for url in urls:\n try:\n async with session.get(url, timeout=5) as response:\n response.raise_for_status()\n accessible = response.status == 200\n results.append((url, accessible))\n _LOGGER.debug(\"Selenium server %s is accessible.\", url)\n except aiohttp.ClientError as e:\n _LOGGER.warning(\n \"Failed to connect to Selenium server at %s: %s\", url, e\n )\n results.append((url, False))\n except Exception as e:\n _LOGGER.exception(\n \"Unexpected error checking Selenium server at %s: %s\", url, e\n )\n results.append((url, False))\n return results\n\n async def check_chromium_installed(self) -> bool:\n \"\"\"Check if Chromium is installed.\"\"\"\n loop = asyncio.get_event_loop()\n result = await loop.run_in_executor(None, self._sync_check_chromium)\n if result:\n _LOGGER.debug(\"Chromium is installed.\")\n else:\n _LOGGER.warning(\"Chromium is not installed.\")\n return result\n\n def _sync_check_chromium(self) -> bool:\n \"\"\"Synchronous check for Chromium installation.\"\"\"\n for exec_name in BROWSER_BINARIES:\n try:\n if shutil.which(exec_name):\n _LOGGER.debug(f\"Found Chromium executable: {exec_name}\")\n return True\n except Exception as e:\n _LOGGER.error(\n f\"Exception while checking for executable '{exec_name}': {e}\"\n )\n continue # Continue checking other binaries\n _LOGGER.debug(\"No Chromium executable found.\")\n return False\n\n def map_wiki_name_to_council_key(self, wiki_name: str) -> str:\n \"\"\"Map the council wiki name back to the council key.\"\"\"\n try:\n index = self.council_options.index(wiki_name)\n council_key = self.council_names[index]\n _LOGGER.debug(\n \"Mapped wiki name '%s' to council key '%s'.\", wiki_name, council_key\n )\n return council_key\n except ValueError:\n _LOGGER.error(\"Wiki name '%s' not found in council options.\", wiki_name)\n return \"\"\n\n @staticmethod\n def is_valid_json(json_str: str) -> bool:\n \"\"\"Validate if a string is valid JSON.\"\"\"\n try:\n json.loads(json_str)\n return True\n except json.JSONDecodeError as e:\n _LOGGER.debug(\"JSON decode error: %s\", e)\n return False\n\n async def _async_entry_exists(\n self, user_input: Dict[str, Any]\n ) -> Optional[config_entries.ConfigEntry]:\n \"\"\"Check if a config entry with the same name or data already exists.\"\"\"\n for entry in self._async_current_entries():\n if entry.data.get(\"name\") == user_input.get(\"name\"):\n return entry\n if entry.data.get(\"council\") == user_input.get(\n \"council\"\n ) and entry.data.get(\"url\") == user_input.get(\"url\"):\n return entry\n return None\n\n async def async_step_import(\n self, import_config: Dict[str, Any]\n ) -> config_entries.FlowResult:\n \"\"\"Handle import from configuration.yaml.\"\"\"\n return await self.async_step_user(import_config)\n\n\nclass UkBinCollectionOptionsFlowHandler(config_entries.OptionsFlow):\n \"\"\"Handle options flow for UkBinCollection.\"\"\"\n\n def __init__(self, config_entry):\n \"\"\"Initialize options flow.\"\"\"\n self.config_entry = config_entry\n self.councils_data: Optional[Dict[str, Any]] = None\n self.council_names: list = []\n self.council_options: list = []\n\n async def async_step_init(self, user_input=None):\n \"\"\"Manage the options.\"\"\"\n errors = {}\n existing_data = self.config_entry.data\n\n # Fetch council data\n self.councils_data = await self.get_councils_json()\n if not self.councils_data:\n _LOGGER.error(\"Council data is unavailable for options flow.\")\n return self.async_abort(reason=\"Council Data Unavailable\")\n\n self.council_names = list(self.councils_data.keys())\n self.council_options = [\n self.councils_data[name][\"wiki_name\"] for name in self.council_names\n ]\n _LOGGER.debug(\"Loaded council data for options flow.\")\n\n if user_input is not None:\n _LOGGER.debug(\"Options flow user input: %s\", user_input)\n # Map selected wiki_name back to council key\n council_key = self.map_wiki_name_to_council_key(user_input[\"council\"])\n user_input[\"council\"] = council_key\n\n # Validate update_interval\n update_interval = user_input.get(\"update_interval\")\n if update_interval is not None:\n try:\n update_interval = int(update_interval)\n if update_interval < 1:\n errors[\"update_interval\"] = \"Must be at least 1 hour.\"\n except ValueError:\n errors[\"update_interval\"] = \"Invalid number.\"\n\n # Validate JSON mapping if provided\n if user_input.get(\"icon_color_mapping\"):\n if not UkBinCollectionConfigFlow.is_valid_json(\n user_input[\"icon_color_mapping\"]\n ):\n errors[\"icon_color_mapping\"] = \"Invalid JSON format.\"\n\n if user_input.get(\"manual_refresh_only\"):\n user_input[\"update_interval\"] = None\n\n if not errors:\n # Merge the user input with existing data\n data = {**existing_data, **user_input}\n data[\"icon_color_mapping\"] = user_input.get(\"icon_color_mapping\", \"\")\n\n self.hass.config_entries.async_update_entry(\n self.config_entry,\n data=data,\n )\n # Trigger a data refresh by reloading the config entry\n await self.hass.config_entries.async_reload(self.config_entry.entry_id)\n _LOGGER.info(\"Options updated and config entry reloaded.\")\n return self.async_create_entry(title=\"\", data={})\n else:\n _LOGGER.debug(\"Errors in options flow: %s\", errors)\n\n # Build the form with existing data\n schema = self.build_options_schema(existing_data)\n\n return self.async_show_form(\n step_id=\"init\",\n data_schema=schema,\n errors=errors,\n description_placeholders={\"cancel\": \"Press Cancel to abort setup.\"},\n )\n\n async def get_councils_json(self) -> Dict[str, Any]:\n \"\"\"Fetch and return the supported councils data.\"\"\"\n try:\n async with aiohttp.ClientSession() as session:\n async with session.get(INPUT_JSON_URL) as response:\n response.raise_for_status()\n data_text = await response.text()\n return json.loads(data_text)\n except aiohttp.ClientError as e:\n _LOGGER.error(\n \"HTTP error while fetching council data for options flow: %s\", e\n )\n except json.JSONDecodeError as e:\n _LOGGER.error(\"Error decoding council data JSON for options flow: %s\", e)\n except Exception as e:\n _LOGGER.exception(\n \"Unexpected error while fetching council data for options flow: %s\", e\n )\n return {}\n\n def build_options_schema(self, existing_data: Dict[str, Any]) -> vol.Schema:\n \"\"\"Build the schema for the options flow with existing data.\"\"\"\n council_current_key = existing_data.get(\"council\", \"\")\n try:\n council_current_wiki = self.council_options[\n self.council_names.index(council_current_key)\n ]\n except (ValueError, IndexError):\n council_current_wiki = \"\"\n\n fields = {\n vol.Required(\"name\", default=existing_data.get(\"name\", \"\")): str,\n vol.Required(\"council\", default=council_current_wiki): vol.In(\n self.council_options\n ),\n vol.Optional(\"manual_refresh_only\", default=False): bool,\n vol.Required(\n \"update_interval\", default=existing_data.get(\"update_interval\", 12)\n ): vol.All(cv.positive_int, vol.Range(min=1)),\n }\n\n optional_fields = [\n (\"icon_color_mapping\", cv.string),\n # Add other optional fields if necessary\n ]\n\n for field_name, validator in optional_fields:\n if field_name in existing_data:\n fields[vol.Optional(field_name, default=existing_data[field_name])] = (\n validator\n )\n\n return vol.Schema(fields)\n\n def map_wiki_name_to_council_key(self, wiki_name: str) -> str:\n \"\"\"Map the council wiki name back to the council key.\"\"\"\n try:\n index = self.council_options.index(wiki_name)\n council_key = self.council_names[index]\n _LOGGER.debug(\n \"Mapped wiki name '%s' to council key '%s'.\", wiki_name, council_key\n )\n return council_key\n except ValueError:\n _LOGGER.error(\"Wiki name '%s' not found in council options.\", wiki_name)\n return \"\"\n\n @staticmethod\n def is_valid_json(json_str: str) -> bool:\n \"\"\"Validate if a string is valid JSON.\"\"\"\n try:\n json.loads(json_str)\n return True\n except json.JSONDecodeError as e:\n _LOGGER.debug(\"JSON decode error in options flow: %s\", e)\n return False\n\n\nasync def async_get_options_flow(config_entry):\n \"\"\"Get the options flow for this handler.\"\"\"\n return UkBinCollectionOptionsFlowHandler(config_entry)\n" }, { "path": "custom_components/uk_bin_collection/const.py", "content": "\"\"\"Constants for UK Bin Collection Data.\"\"\"\n\nfrom datetime import timedelta\n\nfrom homeassistant.const import Platform\n\nINPUT_JSON_URL = \"https://raw.githubusercontent.com/robbrad/UKBinCollectionData/0.165.0/uk_bin_collection/tests/input.json\"\n\nDEFAULT_NAME = \"UK Bin Collection Data\"\n\nDOMAIN = \"uk_bin_collection\"\n\nLOG_PREFIX = \"[UKBinCollection]\"\n\nPLATFORMS = [Platform.SENSOR]\n\nSTATE_ATTR_COLOUR = \"colour\"\nSTATE_ATTR_NEXT_COLLECTION = \"next_collection\"\nSTATE_ATTR_DAYS = \"days\"\n\nDEVICE_CLASS = \"bin_collection_schedule\"\n\nPLATFORMS = [\"sensor\", \"calendar\"]\n\nSELENIUM_SERVER_URLS = [\"http://localhost:4444\", \"http://selenium:4444\"]\n\nBROWSER_BINARIES = [\"chromium\", \"chromium-browser\", \"google-chrome\"]\n\nEXCLUDED_ARG_KEYS = {\n \"name\",\n \"council\",\n \"url\",\n \"skip_get_url\",\n \"local_browser\",\n \"timeout\",\n \"icon_color_mapping\",\n \"update_interval\",\n \"manual_refresh_only\",\n \"original_parser\",\n}\n" }, { "path": "custom_components/uk_bin_collection/manifest.json", "content": "{\n \"domain\": \"uk_bin_collection\",\n \"name\": \"UK Bin Collection Data\",\n \"after_dependencies\": [],\n \"codeowners\": [\"@robbrad\"],\n \"config_flow\": true,\n \"dependencies\": [],\n \"documentation\": \"https://github.com/robbrad/UKBinCollectionData/wiki\",\n \"integration_type\": \"service\",\n \"iot_class\": \"cloud_polling\",\n \"issue_tracker\": \"https://github.com/robbrad/UKBinCollectionData/issues\",\n \"requirements\": [\"uk-bin-collection>=0.165.0\"],\n \"version\": \"0.165.0\",\n \"zeroconf\": []\n}\n" }, { "path": "custom_components/uk_bin_collection/sensor.py", "content": "\"\"\"Support for UK Bin Collection Data sensors.\"\"\"\n\nfrom datetime import datetime, timedelta\nimport json\nimport logging\nimport asyncio\nfrom typing import Any, Dict\n\nfrom json import JSONDecodeError\n\nfrom homeassistant.core import HomeAssistant, callback\nfrom homeassistant.config_entries import ConfigEntry\nfrom homeassistant.components.sensor import SensorEntity\nfrom homeassistant.exceptions import ConfigEntryNotReady\nfrom homeassistant.helpers.update_coordinator import (\n CoordinatorEntity,\n DataUpdateCoordinator,\n UpdateFailed,\n)\nfrom homeassistant.util import dt as dt_util\nfrom homeassistant.helpers.entity_platform import AddEntitiesCallback\nimport homeassistant.helpers.config_validation as cv\n\nfrom .const import (\n DOMAIN,\n LOG_PREFIX,\n STATE_ATTR_DAYS,\n STATE_ATTR_NEXT_COLLECTION,\n DEVICE_CLASS,\n STATE_ATTR_COLOUR,\n PLATFORMS,\n)\nfrom uk_bin_collection.uk_bin_collection.collect_data import UKBinCollectionApp\n\n_LOGGER = logging.getLogger(__name__)\n\n\nasync def async_setup_entry(\n hass: HomeAssistant,\n config_entry: ConfigEntry,\n async_add_entities: AddEntitiesCallback,\n) -> None:\n \"\"\"Set up the UK Bin Collection Data sensor platform.\"\"\"\n _LOGGER.info(f\"{LOG_PREFIX} Setting up UK Bin Collection Data platform.\")\n\n # Retrieve the coordinator from hass.data\n coordinator: DataUpdateCoordinator = hass.data[DOMAIN][config_entry.entry_id][\n \"coordinator\"\n ]\n\n # Get icon_color_mapping from config\n icon_color_mapping = config_entry.data.get(\"icon_color_mapping\", \"{}\")\n\n # Create sensor entities\n entities = create_sensor_entities(\n coordinator, config_entry.entry_id, icon_color_mapping\n )\n\n # Register all sensor entities with Home Assistant\n async_add_entities(entities)\n\n\ndef create_sensor_entities(coordinator, entry_id, icon_color_mapping):\n \"\"\"Create sensor entities based on coordinator data.\"\"\"\n entities = []\n icon_color_map = load_icon_color_mapping(icon_color_mapping)\n\n for bin_type in coordinator.data.keys():\n device_id = f\"{entry_id}_{bin_type}\"\n\n # Main bin sensor\n entities.append(\n UKBinCollectionDataSensor(coordinator, bin_type, device_id, icon_color_map)\n )\n\n # Attribute sensors\n attributes = [\n \"Colour\",\n \"Next Collection Human Readable\",\n \"Days Until Collection\",\n \"Bin Type\",\n \"Next Collection Date\",\n ]\n for attr in attributes:\n unique_id = f\"{device_id}_{attr.lower().replace(' ', '_')}\"\n entities.append(\n UKBinCollectionAttributeSensor(\n coordinator, bin_type, unique_id, attr, device_id, icon_color_map\n )\n )\n\n # Add the Raw JSON Sensor\n entities.append(\n UKBinCollectionRawJSONSensor(coordinator, f\"{entry_id}_raw_json\", entry_id)\n )\n\n return entities\n\n\ndef load_icon_color_mapping(icon_color_mapping: str) -> Dict[str, Any]:\n \"\"\"Load and return the icon color mapping.\"\"\"\n try:\n return json.loads(icon_color_mapping) if icon_color_mapping else {}\n except JSONDecodeError:\n _LOGGER.warning(\n f\"{LOG_PREFIX} Invalid icon_color_mapping JSON: {icon_color_mapping}. Using default settings.\"\n )\n return {}\n\n\nclass UKBinCollectionDataSensor(CoordinatorEntity, SensorEntity):\n \"\"\"Sensor entity for individual bin collection data.\"\"\"\n\n _attr_device_class = DEVICE_CLASS\n\n def __init__(\n self,\n coordinator: DataUpdateCoordinator,\n bin_type: str,\n device_id: str,\n icon_color_mapping: Dict[str, Any],\n ) -> None:\n \"\"\"Initialize the main bin sensor.\"\"\"\n super().__init__(coordinator)\n self.coordinator = coordinator\n self._bin_type = bin_type\n self._device_id = device_id\n self._icon_color_mapping = icon_color_mapping\n self._icon = self.get_icon()\n self._color = self.get_color()\n self._state = None\n self._next_collection = None\n self._days = None\n self.update_state()\n\n @property\n def device_info(self) -> dict:\n \"\"\"Return device information for device registry.\"\"\"\n return {\n \"identifiers\": {(DOMAIN, self._device_id)},\n \"name\": f\"{self.coordinator.name} {self._bin_type}\",\n \"manufacturer\": \"UK Bin Collection\",\n \"model\": \"Bin Sensor\",\n \"sw_version\": \"1.0\",\n }\n\n @callback\n def _handle_coordinator_update(self) -> None:\n \"\"\"Handle updates from the coordinator and refresh sensor state.\"\"\"\n self.update_state()\n self.async_write_ha_state()\n\n def update_state(self) -> None:\n \"\"\"Update the sensor's state and attributes.\"\"\"\n bin_date = self.coordinator.data.get(self._bin_type)\n if bin_date:\n self._next_collection = bin_date\n now = dt_util.now().date()\n self._days = (bin_date - now).days\n self._state = self.calculate_state()\n else:\n _LOGGER.warning(\n f\"{LOG_PREFIX} Data for bin type '{self._bin_type}' is missing.\"\n )\n self._state = \"Unknown\"\n self._days = None\n self._next_collection = None\n\n def calculate_state(self) -> str:\n \"\"\"Determine the state based on collection date.\"\"\"\n now = dt_util.now().date()\n if self._next_collection == now:\n return \"Today\"\n elif self._next_collection == now + timedelta(days=1):\n return \"Tomorrow\"\n else:\n day_label = \"day\" if self._days == 1 else \"days\"\n return f\"In {self._days} {day_label}\"\n\n def get_icon(self) -> str:\n \"\"\"Return the icon based on bin type or mapping.\"\"\"\n return self._icon_color_mapping.get(self._bin_type, {}).get(\n \"icon\", self.get_default_icon()\n )\n\n def get_color(self) -> str:\n \"\"\"Return the color based on bin type or mapping.\"\"\"\n color = self._icon_color_mapping.get(self._bin_type, {}).get(\"color\")\n if color is None:\n return \"black\"\n return color\n\n def get_default_icon(self) -> str:\n \"\"\"Return a default icon based on the bin type.\"\"\"\n bin_type_lower = self._bin_type.lower()\n if \"recycling\" in bin_type_lower:\n return \"mdi:recycle\"\n elif \"waste\" in bin_type_lower:\n return \"mdi:trash-can\"\n else:\n return \"mdi:delete\"\n\n @property\n def name(self) -> str:\n \"\"\"Return the name of the sensor.\"\"\"\n return f\"{self.coordinator.name} {self._bin_type}\"\n\n @property\n def state(self) -> str:\n \"\"\"Return the current state of the sensor.\"\"\"\n return self._state or \"Unknown\"\n\n @property\n def icon(self) -> str:\n \"\"\"Return the icon for the sensor.\"\"\"\n return self._icon\n\n @property\n def extra_state_attributes(self) -> dict:\n \"\"\"Return extra state attributes for the sensor.\"\"\"\n return {\n STATE_ATTR_COLOUR: self._color,\n STATE_ATTR_NEXT_COLLECTION: (\n self._next_collection.strftime(\"%d/%m/%Y\")\n if self._next_collection\n else None\n ),\n STATE_ATTR_DAYS: self._days,\n }\n\n @property\n def available(self) -> bool:\n \"\"\"Return the availability of the sensor.\"\"\"\n return self._state != \"Unknown\"\n\n @property\n def unique_id(self) -> str:\n \"\"\"Return a unique ID for the sensor.\"\"\"\n return self._device_id\n\n\nclass UKBinCollectionAttributeSensor(CoordinatorEntity, SensorEntity):\n \"\"\"Sensor entity for additional attributes of a bin.\"\"\"\n\n def __init__(\n self,\n coordinator: DataUpdateCoordinator,\n bin_type: str,\n unique_id: str,\n attribute_type: str,\n device_id: str,\n icon_color_mapping: Dict[str, Any],\n ) -> None:\n \"\"\"Initialize the attribute sensor.\"\"\"\n super().__init__(coordinator)\n self.coordinator = coordinator\n self._bin_type = bin_type\n self._unique_id = unique_id\n self._attribute_type = attribute_type\n self._device_id = device_id\n self._icon_color_mapping = icon_color_mapping\n self._icon = self.get_icon()\n self._color = self.get_color()\n\n @property\n def name(self) -> str:\n \"\"\"Return the name of the attribute sensor.\"\"\"\n return f\"{self.coordinator.name} {self._bin_type} {self._attribute_type}\"\n\n @property\n def state(self):\n \"\"\"Return the state based on the attribute type.\"\"\"\n if self._attribute_type == \"Colour\":\n return self._color\n elif self._attribute_type == \"Bin Type\":\n return self._bin_type\n elif self._attribute_type == \"Next Collection Date\":\n bin_date = self.coordinator.data.get(self._bin_type)\n return bin_date.strftime(\"%d/%m/%Y\") if bin_date else \"Unknown\"\n elif self._attribute_type == \"Next Collection Human Readable\":\n return self.calculate_human_readable()\n elif self._attribute_type == \"Days Until Collection\":\n return self.calculate_days_until()\n else:\n _LOGGER.warning(\n f\"{LOG_PREFIX} Undefined attribute type: {self._attribute_type}\"\n )\n return \"Undefined\"\n\n def calculate_human_readable(self) -> str:\n \"\"\"Calculate human-readable collection date.\"\"\"\n bin_date = self.coordinator.data.get(self._bin_type)\n if not bin_date:\n return \"Unknown\"\n now = dt_util.now().date()\n days = (bin_date - now).days\n if days == 0:\n return \"Today\"\n elif days == 1:\n return \"Tomorrow\"\n else:\n day_label = \"day\" if days == 1 else \"days\"\n return f\"In {days} {day_label}\"\n\n def calculate_days_until(self) -> int:\n \"\"\"Calculate days until collection.\"\"\"\n bin_date = self.coordinator.data.get(self._bin_type)\n if not bin_date:\n return -1\n return (bin_date - dt_util.now().date()).days\n\n def get_icon(self) -> str:\n \"\"\"Return the icon based on bin type or mapping.\"\"\"\n return self._icon_color_mapping.get(self._bin_type, {}).get(\n \"icon\", self.get_default_icon()\n )\n\n def get_color(self) -> str:\n \"\"\"Return the color based on bin type or mapping.\"\"\"\n return self._icon_color_mapping.get(self._bin_type, {}).get(\"color\", \"black\")\n\n def get_default_icon(self) -> str:\n \"\"\"Return a default icon based on the bin type.\"\"\"\n bin_type_lower = self._bin_type.lower()\n if \"recycling\" in bin_type_lower:\n return \"mdi:recycle\"\n elif \"waste\" in bin_type_lower:\n return \"mdi:trash-can\"\n else:\n return \"mdi:delete\"\n\n @property\n def icon(self) -> str:\n \"\"\"Return the icon for the attribute sensor.\"\"\"\n return self._icon\n\n @property\n def extra_state_attributes(self) -> dict:\n \"\"\"Return the extra state attributes.\"\"\"\n return {\n STATE_ATTR_COLOUR: self._color,\n STATE_ATTR_NEXT_COLLECTION: self.coordinator.data.get(self._bin_type),\n }\n\n @property\n def device_info(self) -> dict:\n \"\"\"Return device information for device registry.\"\"\"\n return {\n \"identifiers\": {(DOMAIN, self._device_id)},\n \"name\": f\"{self.coordinator.name} {self._bin_type}\",\n \"manufacturer\": \"UK Bin Collection\",\n \"model\": \"Bin Sensor\",\n \"sw_version\": \"1.0\",\n }\n\n @property\n def unique_id(self) -> str:\n \"\"\"Return a unique ID for the attribute sensor.\"\"\"\n return self._unique_id\n\n @property\n def available(self) -> bool:\n \"\"\"Return the availability of the attribute sensor.\"\"\"\n return self.coordinator.last_update_success\n\n\nclass UKBinCollectionRawJSONSensor(CoordinatorEntity, SensorEntity):\n \"\"\"Sensor entity to hold the raw JSON data for bin collections.\"\"\"\n\n def __init__(\n self,\n coordinator: DataUpdateCoordinator,\n unique_id: str,\n name: str,\n ) -> None:\n \"\"\"Initialize the raw JSON sensor.\"\"\"\n super().__init__(coordinator)\n self.coordinator = coordinator\n self._unique_id = unique_id\n self._name = f\"{name} Raw JSON\"\n\n @property\n def name(self) -> str:\n \"\"\"Return the name of the raw JSON sensor.\"\"\"\n return self._name\n\n @property\n def state(self) -> str:\n \"\"\"Return the raw JSON data as the state.\"\"\"\n if not self.coordinator.data:\n return \"{}\"\n data = {\n bin_type: bin_date.strftime(\"%d/%m/%Y\") if bin_date else None\n for bin_type, bin_date in self.coordinator.data.items()\n }\n return json.dumps(data)\n\n @property\n def unique_id(self) -> str:\n \"\"\"Return a unique ID for the raw JSON sensor.\"\"\"\n return self._unique_id\n\n @property\n def extra_state_attributes(self) -> dict:\n \"\"\"Return the raw JSON data as an attribute.\"\"\"\n return {\"raw_data\": self.coordinator.data or {}}\n\n @property\n def available(self) -> bool:\n \"\"\"Return the availability of the raw JSON sensor.\"\"\"\n return self.coordinator.last_update_success\n" }, { "path": "custom_components/uk_bin_collection/services.yaml", "content": "manual_refresh:\n name: \"Manual Refresh\"\n description: \"Manually refresh bin data for a specific config entry.\"\n fields:\n entry_id:\n name: \"Entity ID\"\n description: \"Config Entry ID for the UK Bin Collection integration instance to refresh.\"\n example: \"1234567890abcdef\"\n" }, { "path": "custom_components/uk_bin_collection/strings.json", "content": "{\n \"title\": \"UK Bin Collection Data\",\n \"config\": {\n \"step\": {\n \"user\": {\n \"title\": \"Select the council\",\n \"data\": {\n \"name\": \"Location name\",\n \"council\": \"Council\",\n \"manual_refresh_only\":\"Automatically refresh the sensor\",\n \"icon_color_mapping\": \"JSON to map Bin Type for Colour and Icon (see documentation)\"\n },\n \"description\": \"Please see the documentation if your council isn't listed\"\n },\n \"council\": {\n \"title\": \"Provide council details\",\n \"data\": {\n \"url\": \"URL to fetch bin collection data\",\n \"timeout\": \"The time in seconds for how long the sensor should wait for data\",\n \"update_interval\": \"Time in hours between updates\",\n \"uprn\": \"UPRN (Unique Property Reference Number)\",\n \"postcode\": \"Postcode of the address\",\n \"number\": \"House number of the address\",\n \"usrn\": \"USRN (Unique Street Reference Number)\",\n \"web_driver\": \"To run on a remote Selenium Server add the Selenium Server URL\",\n \"headless\": \"Run Selenium in headless mode (recommended)\",\n \"local_browser\": \"Don't run on remote Selenium server, use local install of Chrome instead\",\n \"submit\": \"Submit\"\n },\n \"description\": \"Please refer to your council's wiki entry for details on what to enter.\\n{selenium_message}\"\n },\n \"reconfigure_confirm\": {\n \"title\": \"Update council details\",\n \"data\": {\n \"url\": \"URL to fetch bin collection data\",\n \"timeout\": \"The time in seconds for how long the sensor should wait for data\",\n \"update_interval\": \"Time in hours between updates\",\n \"uprn\": \"UPRN (Unique Property Reference Number)\",\n \"postcode\": \"Postcode of the address\",\n \"number\": \"House number of the address\",\n \"usrn\": \"USRN (Unique Street Reference Number)\",\n \"web_driver\": \"To run on a remote Selenium Server add the Selenium Server URL\",\n \"headless\": \"Run Selenium in headless mode (recommended)\",\n \"local_browser\": \"Don't run on remote Selenium server, use local install of Chrome instead\",\n \"manual_refresh_only\":\"Automatically refresh the sensor\",\n \"icon_color_mapping\": \"JSON to map Bin Type for Colour and Icon (see documentation)\",\n \"submit\": \"Submit\"\n },\n \"description\": \"Please refer to your council's wiki entry for details on what to enter.\"\n }\n },\n \"error\": {\n \"name\": \"Please enter a location name\",\n \"council\": \"Please select a council\",\n \"selenium_unavailable\": \"Selenium server is not accessible. Please ensure it is running at localhost:4444 or selenium:4444\",\n \"chromium_not_found\": \"Chromium browser is not installed. Please install Chromium or Google Chrome\"\n }\n }\n}\n" }, { "path": "custom_components/uk_bin_collection/tests/__init__.py", "content": "" }, { "path": "custom_components/uk_bin_collection/tests/common_utils.py", "content": "# custom_components/uk_bin_collection/tests/common_utils.py\n\nimport uuid\nfrom unittest.mock import Mock, AsyncMock # Import AsyncMock\nfrom homeassistant import config_entries\nimport asyncio\n\n\nclass MockConfigEntry:\n \"\"\"Mock for Home Assistant ConfigEntry.\"\"\"\n\n def __init__(\n self,\n domain,\n data=None,\n options=None,\n title=None,\n unique_id=None,\n source=config_entries.SOURCE_USER,\n entry_id=None,\n version=1,\n ):\n \"\"\"Initialize a mock config entry.\"\"\"\n self.domain = domain\n self.data = data or {}\n self.options = options or {}\n self.title = title or \"Mock Title\"\n self.unique_id = unique_id\n self.source = source\n self.entry_id = entry_id or uuid.uuid4().hex\n self.version = version\n self.state = config_entries.ConfigEntryState.NOT_LOADED\n\n def add_to_hass(self, hass):\n \"\"\"Add the mock config entry to Home Assistant.\"\"\"\n # Mock the async_add method to accept the entry\n hass.config_entries.async_add.return_value = None\n hass.config_entries.async_add(self)\n\n # Mock async_setup to be an AsyncMock that returns True\n hass.config_entries.async_setup = AsyncMock(return_value=True)\n\n # Mock the create_task to immediately run the coroutine\n # Define a coroutine that runs async_setup and updates the entry state\n async def run_setup(entry_id):\n result = await hass.config_entries.async_setup(entry_id)\n if result:\n self.state = config_entries.ConfigEntryState.LOADED\n else:\n self.state = config_entries.ConfigEntryState.SETUP_ERROR\n\n # Assign the coroutine as a side effect to create_task\n hass.loop.create_task = AsyncMock(\n side_effect=lambda coro: asyncio.create_task(run_setup(self.entry_id))\n )\n" }, { "path": "custom_components/uk_bin_collection/tests/test_calendar.py", "content": "# test_calendar.py\n\n\"\"\"Unit tests for the UK Bin Collection Calendar platform.\"\"\"\n\nimport pytest\nfrom unittest.mock import MagicMock, AsyncMock, patch\nfrom datetime import datetime, date, timedelta\n\nfrom homeassistant.core import HomeAssistant\nfrom homeassistant.helpers.update_coordinator import DataUpdateCoordinator\n\nfrom custom_components.uk_bin_collection.const import DOMAIN\nfrom custom_components.uk_bin_collection.calendar import (\n UKBinCollectionCalendar,\n async_setup_entry,\n async_unload_entry,\n)\nfrom homeassistant.components.calendar import CalendarEvent\n\nfrom .common_utils import MockConfigEntry\n\npytest_plugins = [\"freezegun\"]\n\n# Mock Data\nMOCK_COORDINATOR_DATA = {\n \"Recycling\": date(2024, 4, 25),\n \"General Waste\": date(2024, 4, 26),\n \"Garden Waste\": date(2024, 4, 27),\n}\n\n\n@pytest.fixture\ndef mock_coordinator():\n \"\"\"Fixture to create a mock DataUpdateCoordinator with sample data.\"\"\"\n coordinator = MagicMock(spec=DataUpdateCoordinator)\n coordinator.data = MOCK_COORDINATOR_DATA.copy()\n coordinator.name = \"Test Council\"\n coordinator.last_update_success = True\n return coordinator\n\n\n@pytest.fixture\ndef mock_config_entry():\n \"\"\"Create a mock ConfigEntry.\"\"\"\n return MockConfigEntry(\n domain=DOMAIN,\n title=\"Test Entry\",\n data={\n \"name\": \"Test Name\",\n \"council\": \"Test Council\",\n \"url\": \"https://example.com\",\n \"timeout\": 60,\n \"icon_color_mapping\": {},\n },\n entry_id=\"test_entry_id\",\n unique_id=\"test_unique_id\",\n )\n\n\n@pytest.fixture\ndef hass_instance() -> HomeAssistant:\n \"\"\"Return a fake HomeAssistant instance with a data attribute.\"\"\"\n hass = MagicMock(spec=HomeAssistant)\n # Ensure hass.data is a dict and contains a dict for our DOMAIN\n hass.data = {DOMAIN: {}}\n return hass\n\n\n# Tests\n\n\ndef test_calendar_entity_initialization(hass_instance, mock_coordinator):\n \"\"\"Test that the calendar entity initializes correctly.\"\"\"\n calendar = UKBinCollectionCalendar(\n coordinator=mock_coordinator,\n bin_type=\"Recycling\",\n unique_id=\"test_entry_id_Recycling_calendar\",\n name=\"Test Council Recycling Calendar\",\n )\n\n assert calendar.name == \"Test Council Recycling Calendar\"\n assert calendar.unique_id == \"test_entry_id_Recycling_calendar\"\n assert calendar.device_info == {\n \"identifiers\": {(DOMAIN, \"test_entry_id_Recycling_calendar\")},\n \"name\": \"Test Council Recycling Calendar Device\",\n \"manufacturer\": \"UK Bin Collection\",\n \"model\": \"Bin Collection Calendar\",\n \"sw_version\": \"1.0\",\n }\n\n\ndef test_calendar_event_property(hass_instance, mock_coordinator):\n \"\"\"Test that the event property returns the correct CalendarEvent.\"\"\"\n collection_date = date(2024, 4, 25)\n mock_coordinator.data[\"Recycling\"] = collection_date\n\n calendar = UKBinCollectionCalendar(\n coordinator=mock_coordinator,\n bin_type=\"Recycling\",\n unique_id=\"test_entry_id_Recycling_calendar\",\n name=\"Test Council Recycling Calendar\",\n )\n\n expected_event = CalendarEvent(\n summary=\"Recycling Collection\",\n start=collection_date,\n end=collection_date + timedelta(days=1),\n uid=\"test_entry_id_Recycling_calendar_2024-04-25\",\n )\n\n assert calendar.event == expected_event\n\n\ndef test_calendar_event_property_no_data(hass_instance, mock_coordinator):\n \"\"\"Test that the event property returns None when there's no collection date.\"\"\"\n mock_coordinator.data[\"Recycling\"] = None\n\n calendar = UKBinCollectionCalendar(\n coordinator=mock_coordinator,\n bin_type=\"Recycling\",\n unique_id=\"test_entry_id_Recycling_calendar\",\n name=\"Test Council Recycling Calendar\",\n )\n\n assert calendar.event is None\n\n\n@pytest.mark.asyncio\nasync def test_async_get_events(hass_instance, mock_coordinator):\n \"\"\"Test that async_get_events returns correct events within the date range.\"\"\"\n mock_coordinator.data = {\n \"Recycling\": date(2024, 4, 25),\n \"General Waste\": date(2024, 4, 26),\n }\n\n calendar = UKBinCollectionCalendar(\n coordinator=mock_coordinator,\n bin_type=\"Recycling\",\n unique_id=\"test_entry_id_Recycling_calendar\",\n name=\"Test Council Recycling Calendar\",\n )\n\n start_date = datetime(2024, 4, 24)\n end_date = datetime(2024, 4, 26)\n\n expected_event = CalendarEvent(\n summary=\"Recycling Collection\",\n start=date(2024, 4, 25),\n end=date(2024, 4, 26),\n uid=\"test_entry_id_Recycling_calendar_2024-04-25\",\n )\n\n events = await calendar.async_get_events(hass_instance, start_date, end_date)\n assert events == [expected_event]\n\n\n@pytest.mark.asyncio\nasync def test_async_get_events_no_events_in_range(hass_instance, mock_coordinator):\n \"\"\"Test that async_get_events returns empty list when no events are in the range.\"\"\"\n mock_coordinator.data = {\n \"Recycling\": date(2024, 4, 25),\n }\n\n calendar = UKBinCollectionCalendar(\n coordinator=mock_coordinator,\n bin_type=\"Recycling\",\n unique_id=\"test_entry_id_Recycling_calendar\",\n name=\"Test Council Recycling Calendar\",\n )\n\n start_date = datetime(2024, 4, 26)\n end_date = datetime(2024, 4, 30)\n\n events = await calendar.async_get_events(hass_instance, start_date, end_date)\n assert events == []\n\n\ndef test_calendar_update_on_coordinator_change(hass_instance, mock_coordinator):\n \"\"\"Test that the calendar entity updates when the coordinator's data changes.\"\"\"\n collection_date_initial = date(2024, 4, 25)\n collection_date_updated = date(2024, 4, 26)\n mock_coordinator.data[\"Recycling\"] = collection_date_initial\n\n calendar = UKBinCollectionCalendar(\n coordinator=mock_coordinator,\n bin_type=\"Recycling\",\n unique_id=\"test_entry_id_Recycling_calendar\",\n name=\"Test Council Recycling Calendar\",\n )\n\n # Initially, the event should be for April 25\n expected_event_initial = CalendarEvent(\n summary=\"Recycling Collection\",\n start=collection_date_initial,\n end=collection_date_initial + timedelta(days=1),\n uid=\"test_entry_id_Recycling_calendar_2024-04-25\",\n )\n assert calendar.event == expected_event_initial\n\n # Update the coordinator's data\n mock_coordinator.data[\"Recycling\"] = collection_date_updated\n mock_coordinator.async_write_ha_state = AsyncMock()\n\n # Simulate coordinator update by calling the update handler\n with patch.object(calendar, \"async_write_ha_state\", new=AsyncMock()) as mock_write:\n calendar._handle_coordinator_update()\n\n # The event should now be updated to April 26\n expected_event_updated = CalendarEvent(\n summary=\"Recycling Collection\",\n start=collection_date_updated,\n end=collection_date_updated + timedelta(days=1),\n uid=\"test_entry_id_Recycling_calendar_2024-04-26\",\n )\n assert calendar.event == expected_event_updated\n mock_write.assert_called_once()\n\n\n@pytest.mark.asyncio\nasync def test_async_setup_entry_creates_calendar_entities(\n hass_instance, mock_coordinator, mock_config_entry\n):\n \"\"\"Test that async_setup_entry creates calendar entities based on coordinator data.\"\"\"\n # Mock the data in the coordinator\n mock_coordinator.data = {\n \"Recycling\": date(2024, 4, 25),\n \"General Waste\": date(2024, 4, 26),\n }\n\n # Patch the hass.data to include the coordinator\n hass_instance.data[DOMAIN][mock_config_entry.entry_id] = {\n \"coordinator\": mock_coordinator,\n }\n\n with patch(\n \"custom_components.uk_bin_collection.calendar.UKBinCollectionCalendar\",\n autospec=True,\n ) as mock_calendar_cls:\n mock_calendar_instance_recycling = MagicMock()\n mock_calendar_instance_general_waste = MagicMock()\n mock_calendar_cls.side_effect = [\n mock_calendar_instance_recycling,\n mock_calendar_instance_general_waste,\n ]\n\n await async_setup_entry(hass_instance, mock_config_entry, lambda entities: None)\n\n # Ensure that two calendar entities are created\n assert mock_calendar_cls.call_count == 2\n\n # Verify that the calendar entities are initialized with correct parameters\n mock_calendar_cls.assert_any_call(\n coordinator=mock_coordinator,\n bin_type=\"Recycling\",\n unique_id=\"test_entry_id_Recycling_calendar\",\n name=\"Test Council Recycling Calendar\",\n )\n mock_calendar_cls.assert_any_call(\n coordinator=mock_coordinator,\n bin_type=\"General Waste\",\n unique_id=\"test_entry_id_General Waste_calendar\",\n name=\"Test Council General Waste Calendar\",\n )\n\n\n@pytest.mark.asyncio\nasync def test_async_setup_entry_handles_empty_data(hass_instance, mock_config_entry):\n \"\"\"Test that async_setup_entry handles empty coordinator data gracefully.\"\"\"\n # Mock an empty data coordinator\n mock_coordinator = MagicMock(spec=DataUpdateCoordinator)\n mock_coordinator.data = {}\n mock_coordinator.name = \"Test Council\"\n mock_coordinator.last_update_success = True\n\n # Patch the hass.data to include the coordinator\n hass_instance.data[DOMAIN][mock_config_entry.entry_id] = {\n \"coordinator\": mock_coordinator,\n }\n\n with patch(\n \"custom_components.uk_bin_collection.calendar.UKBinCollectionCalendar\",\n autospec=True,\n ) as mock_calendar_cls:\n await async_setup_entry(hass_instance, mock_config_entry, lambda entities: None)\n\n # No calendar entities should be created since there's no data\n mock_calendar_cls.assert_not_called()\n\n\n@pytest.mark.asyncio\nasync def test_async_setup_entry_handles_coordinator_failure(\n hass_instance, mock_config_entry\n):\n \"\"\"Test that async_setup_entry raises ConfigEntryNotReady on coordinator failure.\"\"\"\n mock_coordinator = MagicMock(spec=DataUpdateCoordinator)\n mock_coordinator.async_config_entry_first_refresh.side_effect = Exception(\n \"Update failed\"\n )\n mock_coordinator.name = \"Test Council\"\n\n # Patch the hass.data to include the coordinator\n hass_instance.data[DOMAIN][mock_config_entry.entry_id] = {\n \"coordinator\": mock_coordinator,\n }\n\n with pytest.raises(Exception, match=\"Update failed\"):\n await async_setup_entry(hass_instance, mock_config_entry, lambda entities: None)\n\n\n@pytest.mark.asyncio\nasync def test_async_unload_entry(hass_instance, mock_coordinator, mock_config_entry):\n \"\"\"Test that async_unload_entry unloads calendar entities correctly.\"\"\"\n # Prepare the coordinator data\n mock_coordinator.data = {\"Recycling\": date(2024, 4, 25)}\n mock_coordinator.name = \"Test Council\"\n hass_instance.data[DOMAIN][mock_config_entry.entry_id] = {\n \"coordinator\": mock_coordinator\n }\n\n result = await async_unload_entry(hass_instance, mock_config_entry, None)\n assert result is True\n\n\ndef test_calendar_entity_available_property(hass_instance, mock_coordinator):\n \"\"\"Test the available property of the calendar entity.\"\"\"\n # When data is present and last_update_success is True\n mock_coordinator.last_update_success = True\n mock_coordinator.data[\"Recycling\"] = date(2024, 4, 25)\n\n calendar = UKBinCollectionCalendar(\n coordinator=mock_coordinator,\n bin_type=\"Recycling\",\n unique_id=\"test_entry_id_Recycling_calendar\",\n name=\"Test Council Recycling Calendar\",\n )\n\n assert calendar.available is True\n\n # When data is missing\n mock_coordinator.data[\"Recycling\"] = None\n assert calendar.available is False\n\n # When last_update_success is False\n mock_coordinator.last_update_success = False\n calendar._state = \"Unknown\" # Assuming state is set to \"Unknown\" when unavailable\n assert calendar.available is False\n\n\n@pytest.mark.asyncio\nasync def test_async_setup_entry_creates_no_calendar_entities_on_empty_data(\n hass_instance, mock_config_entry\n):\n \"\"\"Test that async_setup_entry does not create calendar entities when coordinator data is empty.\"\"\"\n mock_coordinator = MagicMock(spec=DataUpdateCoordinator)\n mock_coordinator.data = {}\n mock_coordinator.name = \"Test Council\"\n mock_coordinator.last_update_success = True\n\n # Patch the hass.data to include the coordinator\n hass_instance.data[DOMAIN][mock_config_entry.entry_id] = {\n \"coordinator\": mock_coordinator,\n }\n\n with patch(\n \"custom_components.uk_bin_collection.calendar.UKBinCollectionCalendar\",\n autospec=True,\n ) as mock_calendar_cls:\n await async_setup_entry(hass_instance, mock_config_entry, lambda entities: None)\n\n # No calendar entities should be created\n mock_calendar_cls.assert_not_called()\n\n\n@pytest.mark.asyncio\nasync def test_async_setup_entry_with_coordinator_failure(\n hass_instance, mock_config_entry\n):\n \"\"\"Test that async_setup_entry handles coordinator failures gracefully.\"\"\"\n mock_coordinator = MagicMock(spec=DataUpdateCoordinator)\n mock_coordinator.async_config_entry_first_refresh.side_effect = Exception(\n \"Update failed\"\n )\n mock_coordinator.name = \"Test Council\"\n\n # Patch the hass.data to include the coordinator\n hass_instance.data[DOMAIN][mock_config_entry.entry_id] = {\n \"coordinator\": mock_coordinator,\n }\n\n with pytest.raises(Exception, match=\"Update failed\"):\n await async_setup_entry(hass_instance, mock_config_entry, lambda entities: None)\n\n\n@pytest.mark.asyncio\nasync def test_async_setup_entry_handles_coordinator_failure(\n hass_instance, mock_config_entry\n):\n \"\"\"Test that async_setup_entry raises an exception when coordinator refresh fails.\"\"\"\n mock_coordinator = MagicMock(spec=DataUpdateCoordinator)\n # Provide an empty data dictionary so that accessing .data does not fail immediately.\n mock_coordinator.data = {}\n mock_coordinator.name = \"Test Council\"\n # Make the refresh raise an exception.\n mock_coordinator.async_config_entry_first_refresh = AsyncMock(\n side_effect=Exception(\"Update failed\")\n )\n\n hass_instance.data[DOMAIN][mock_config_entry.entry_id] = {\n \"coordinator\": mock_coordinator\n }\n\n with pytest.raises(Exception, match=\"Update failed\"):\n await async_setup_entry(hass_instance, mock_config_entry, lambda entities: None)\n\n\n@pytest.mark.asyncio\nasync def test_async_get_events_multiple_events_same_day(\n hass_instance, mock_coordinator\n):\n \"\"\"Test async_get_events when multiple bin types have the same collection date.\"\"\"\n mock_coordinator.data = {\n \"Recycling\": date(2024, 4, 25),\n \"General Waste\": date(2024, 4, 25),\n }\n\n calendar_recycling = UKBinCollectionCalendar(\n coordinator=mock_coordinator,\n bin_type=\"Recycling\",\n unique_id=\"test_entry_id_Recycling_calendar\",\n name=\"Test Council Recycling Calendar\",\n )\n\n calendar_general_waste = UKBinCollectionCalendar(\n coordinator=mock_coordinator,\n bin_type=\"General Waste\",\n unique_id=\"test_entry_id_General Waste_calendar\",\n name=\"Test Council General Waste Calendar\",\n )\n\n start_date = datetime(2024, 4, 24)\n end_date = datetime(2024, 4, 26)\n\n expected_event_recycling = CalendarEvent(\n summary=\"Recycling Collection\",\n start=date(2024, 4, 25),\n end=date(2024, 4, 26),\n uid=\"test_entry_id_Recycling_calendar_2024-04-25\",\n )\n\n expected_event_general_waste = CalendarEvent(\n summary=\"General Waste Collection\",\n start=date(2024, 4, 25),\n end=date(2024, 4, 26),\n uid=\"test_entry_id_General Waste_calendar_2024-04-25\",\n )\n\n events_recycling = await calendar_recycling.async_get_events(\n hass_instance, start_date, end_date\n )\n events_general_waste = await calendar_general_waste.async_get_events(\n hass_instance, start_date, end_date\n )\n\n assert events_recycling == [expected_event_recycling]\n assert events_general_waste == [expected_event_general_waste]\n\n\n@pytest.mark.asyncio\nasync def test_async_get_events_no_coordinator_data(hass_instance, mock_coordinator):\n \"\"\"Test async_get_events when coordinator has no data.\"\"\"\n mock_coordinator.data = {}\n calendar = UKBinCollectionCalendar(\n coordinator=mock_coordinator,\n bin_type=\"Recycling\",\n unique_id=\"test_entry_id_Recycling_calendar\",\n name=\"Test Council Recycling Calendar\",\n )\n\n start_date = datetime(2024, 4, 24)\n end_date = datetime(2024, 4, 26)\n\n events = await calendar.async_get_events(hass_instance, start_date, end_date)\n assert events == []\n\n\ndef test_calendar_entity_available_property_no_data(hass_instance, mock_coordinator):\n \"\"\"Test that the calendar's available property is False when there's no data.\"\"\"\n mock_coordinator.data[\"Recycling\"] = None\n\n calendar = UKBinCollectionCalendar(\n coordinator=mock_coordinator,\n bin_type=\"Recycling\",\n unique_id=\"test_entry_id_Recycling_calendar\",\n name=\"Test Council Recycling Calendar\",\n )\n\n assert calendar.available is False\n\n\n@pytest.mark.asyncio\nasync def test_calendar_entity_extra_state_attributes(hass_instance, mock_coordinator):\n \"\"\"Test the extra_state_attributes property of the calendar entity.\"\"\"\n mock_coordinator.data[\"Recycling\"] = date(2024, 4, 25)\n\n calendar = UKBinCollectionCalendar(\n coordinator=mock_coordinator,\n bin_type=\"Recycling\",\n unique_id=\"test_entry_id_Recycling_calendar\",\n name=\"Test Council Recycling Calendar\",\n )\n\n # Assuming extra_state_attributes includes more data if implemented\n # Adjust this part based on your actual calendar.py implementation\n # For example, you might include 'next_collection_date' and 'days_until_collection'\n # Here, we'll assume no additional attributes as per the initial calendar.py\n\n # If extra_state_attributes is not implemented, it defaults to None\n # To handle this, you can set it to return an empty dict if not implemented\n assert calendar.extra_state_attributes == {}\n\n\n@pytest.mark.asyncio\nasync def test_async_setup_entry_handles_coordinator_partial_data(\n hass_instance, mock_config_entry\n):\n \"\"\"Test that async_setup_entry creates calendar entities only for available data.\"\"\"\n mock_coordinator = MagicMock(spec=DataUpdateCoordinator)\n mock_coordinator.data = {\n \"Recycling\": date(2024, 4, 25),\n \"General Waste\": None, # No collection date\n \"Garden Waste\": date(2024, 4, 27),\n }\n mock_coordinator.name = \"Test Council\"\n mock_coordinator.async_config_entry_first_refresh = AsyncMock(return_value=None)\n\n hass_instance.data[DOMAIN][mock_config_entry.entry_id] = {\n \"coordinator\": mock_coordinator\n }\n\n with patch(\n \"custom_components.uk_bin_collection.calendar.UKBinCollectionCalendar\",\n autospec=True,\n ) as mock_calendar_cls:\n mock_calendar_instance_recycling = MagicMock()\n mock_calendar_instance_garden_waste = MagicMock()\n mock_calendar_cls.side_effect = [\n mock_calendar_instance_recycling,\n mock_calendar_instance_garden_waste,\n ]\n\n await async_setup_entry(hass_instance, mock_config_entry, lambda entities: None)\n\n # Ensure that two calendar entities are created (skipping \"General Waste\")\n assert mock_calendar_cls.call_count == 2\n\n # Verify that the calendar entities are initialized with correct parameters\n mock_calendar_cls.assert_any_call(\n coordinator=mock_coordinator,\n bin_type=\"Recycling\",\n unique_id=\"{}_{bin}_calendar\".format(\n mock_config_entry.entry_id, bin=\"Recycling\"\n ),\n name=\"Test Council Recycling Calendar\",\n )\n mock_calendar_cls.assert_any_call(\n coordinator=mock_coordinator,\n bin_type=\"Garden Waste\",\n unique_id=\"{}_{bin}_calendar\".format(\n mock_config_entry.entry_id, bin=\"Garden Waste\"\n ),\n name=\"Test Council Garden Waste Calendar\",\n )\n" }, { "path": "custom_components/uk_bin_collection/tests/test_config_flow.py", "content": "# test_config_flow.py\n\n\"\"\"Test UkBinCollection config flow.\"\"\"\n\nimport asyncio\nimport json\nfrom datetime import date, datetime, timedelta\nfrom json import JSONDecodeError\nfrom unittest.mock import AsyncMock, MagicMock, patch\n\nimport aiohttp\nimport pytest\nimport voluptuous as vol\nfrom homeassistant import config_entries, data_entry_flow\nfrom homeassistant.const import CONF_NAME, CONF_URL\nfrom homeassistant.core import HomeAssistant\nfrom homeassistant.exceptions import ConfigEntryNotReady\n\nfrom custom_components.uk_bin_collection.config_flow import (\n UkBinCollectionConfigFlow,\n UkBinCollectionOptionsFlowHandler,\n async_get_options_flow,\n)\nfrom custom_components.uk_bin_collection.const import DOMAIN, LOG_PREFIX\nfrom custom_components.uk_bin_collection.sensor import load_icon_color_mapping\n\nfrom .common_utils import MockConfigEntry\n\n\n@pytest.fixture\ndef hass_with_loop(hass, event_loop):\n hass.loop = event_loop\n return hass\n\n\n# Mock council data representing different scenarios\nMOCK_COUNCILS_DATA = {\n \"CouncilTest\": {\n \"wiki_name\": \"Council Test\",\n \"uprn\": True,\n \"url\": \"https://example.com/council_test\",\n \"skip_get_url\": False,\n },\n \"CouncilSkip\": {\n \"wiki_name\": \"Council Skip URL\",\n \"skip_get_url\": True,\n \"url\": \"https://example.com/skip\",\n },\n \"CouncilWithoutURL\": {\n \"wiki_name\": \"Council without URL\",\n \"skip_get_url\": True,\n # Do not include 'custom_component_show_url_field'\n # Other necessary fields\n \"uprn\": True,\n \"url\": \"https://example.com/council_without_url\",\n },\n \"CouncilWithUSRN\": {\n \"wiki_name\": \"Council with USRN\",\n \"usrn\": True,\n },\n \"CouncilWithUPRN\": {\n \"wiki_name\": \"Council with UPRN\",\n \"uprn\": True,\n },\n \"CouncilWithPostcodeNumber\": {\n \"wiki_name\": \"Council with Postcode and Number\",\n \"postcode\": True,\n \"house_number\": True,\n },\n \"CouncilWithWebDriver\": {\n \"wiki_name\": \"Council with Web Driver\",\n \"web_driver\": True,\n },\n \"CouncilSkippingURL\": {\n \"wiki_name\": \"Council skipping URL\",\n \"skip_get_url\": True,\n \"url\": \"https://council.example.com\",\n },\n \"CouncilCustomURLField\": {\n \"wiki_name\": \"Council with Custom URL Field\",\n \"custom_component_show_url_field\": True,\n },\n # Add more mock councils as needed to cover different scenarios\n}\n\n\n# Create a dummy HomeAssistant object.\nclass DummyHass:\n def __init__(self, loop):\n self.data = {}\n self.config_entries = MagicMock()\n self.config_entries.async_update_entry = AsyncMock()\n self.config_entries.async_reload = AsyncMock()\n self.loop = loop\n\n\n@pytest.fixture\ndef dummy_hass(event_loop):\n return DummyHass(event_loop)\n\n\n# A sample councils data for the options flow tests.\nMOCK_COUNCILS_DATA_OPTIONS = {\n \"CouncilTest\": {\n \"wiki_name\": \"Council Test\",\n \"uprn\": True,\n \"url\": \"https://example.com/council_test\",\n }\n}\n\n\n@pytest.fixture\ndef options_flow(dummy_hass):\n \"\"\"Create an instance of the options flow with a dummy config entry.\"\"\"\n config_entry = MockConfigEntry(\n domain=DOMAIN,\n data={\n \"name\": \"Test Options\",\n \"council\": \"CouncilTest\",\n \"update_interval\": 12,\n \"icon_color_mapping\": '{\"CouncilTest\": {\"icon\": \"mdi:trash\", \"color\": \"green\"}}',\n },\n entry_id=\"options_test\",\n unique_id=\"options_unique\",\n )\n config_entry.add_to_hass(dummy_hass)\n flow = UkBinCollectionOptionsFlowHandler(config_entry)\n flow.hass = dummy_hass\n return flow, config_entry\n\n\n# Dummy config entry class for testing.\nclass DummyEntry:\n def __init__(self, data, entry_id=\"dummy\"):\n self.data = data\n self.entry_id = entry_id\n self.title = data.get(\"name\", \"\")\n\n\n# Helper function to initiate the config flow and proceed through steps\nasync def proceed_through_config_flow(\n hass: HomeAssistant, flow, user_input_initial, user_input_council\n):\n # Start the flow and complete the `user` step\n result = await flow.async_step_user(user_input=user_input_initial)\n\n assert result[\"type\"] == data_entry_flow.RESULT_TYPE_FORM\n assert result[\"step_id\"] == \"council\"\n\n # Complete the `council` step\n result = await flow.async_step_council(user_input=user_input_council)\n\n return result\n\n\n@pytest.mark.asyncio\nasync def test_config_flow_with_uprn(hass: HomeAssistant):\n \"\"\"Test config flow for a council requiring UPRN.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n user_input_initial = {\n \"name\": \"Test Name\",\n \"council\": \"Council with UPRN\",\n }\n user_input_council = {\n \"uprn\": \"1234567890\",\n \"timeout\": 60,\n }\n\n result = await proceed_through_config_flow(\n hass, flow, user_input_initial, user_input_council\n )\n\n assert result[\"type\"] == data_entry_flow.FlowResultType.CREATE_ENTRY\n assert result[\"title\"] == \"Test Name\"\n assert result[\"data\"] == {\n \"name\": \"Test Name\",\n \"council\": \"CouncilWithUPRN\",\n \"uprn\": \"1234567890\",\n \"timeout\": 60,\n }\n\n\nasync def test_config_flow_with_postcode_and_number(hass: HomeAssistant):\n \"\"\"Test config flow for a council requiring postcode and house number.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n user_input_initial = {\n \"name\": \"Test Name\",\n \"council\": \"Council with Postcode and Number\",\n }\n user_input_council = {\n \"postcode\": \"AB1 2CD\",\n \"number\": \"42\",\n \"timeout\": 60,\n }\n\n result = await proceed_through_config_flow(\n hass, flow, user_input_initial, user_input_council\n )\n\n assert result[\"type\"] == data_entry_flow.FlowResultType.CREATE_ENTRY\n assert result[\"title\"] == \"Test Name\"\n assert result[\"data\"] == {\n \"name\": \"Test Name\",\n \"council\": \"CouncilWithPostcodeNumber\",\n \"postcode\": \"AB1 2CD\",\n \"number\": \"42\",\n \"timeout\": 60,\n }\n\n\nasync def test_config_flow_with_web_driver(hass: HomeAssistant):\n \"\"\"Test config flow for a council requiring web driver.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n user_input_initial = {\n \"name\": \"Test Name\",\n \"council\": \"Council with Web Driver\",\n }\n user_input_council = {\n \"web_driver\": \"/path/to/webdriver\",\n \"headless\": True,\n \"local_browser\": False,\n \"timeout\": 60,\n }\n\n result = await proceed_through_config_flow(\n hass, flow, user_input_initial, user_input_council\n )\n\n assert result[\"type\"] == data_entry_flow.FlowResultType.CREATE_ENTRY\n assert result[\"title\"] == \"Test Name\"\n assert result[\"data\"] == {\n \"name\": \"Test Name\",\n \"council\": \"CouncilWithWebDriver\",\n \"web_driver\": \"/path/to/webdriver\",\n \"headless\": True,\n \"local_browser\": False,\n \"timeout\": 60,\n }\n\n\nasync def test_config_flow_skipping_url(hass: HomeAssistant):\n \"\"\"Test config flow for a council that skips URL input.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n user_input_initial = {\n \"name\": \"Test Name\",\n \"council\": \"Council skipping URL\",\n }\n user_input_council = {\n \"timeout\": 60,\n }\n\n result = await proceed_through_config_flow(\n hass, flow, user_input_initial, user_input_council\n )\n\n assert result[\"type\"] == data_entry_flow.FlowResultType.CREATE_ENTRY\n assert result[\"title\"] == \"Test Name\"\n assert result[\"data\"] == {\n \"name\": \"Test Name\",\n \"council\": \"CouncilSkippingURL\",\n \"skip_get_url\": True,\n \"url\": \"https://council.example.com\",\n \"timeout\": 60,\n }\n\n\nasync def test_config_flow_with_custom_url_field(hass: HomeAssistant):\n \"\"\"Test config flow for a council with custom URL field.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n user_input_initial = {\n \"name\": \"Test Name\",\n \"council\": \"Council with Custom URL Field\",\n }\n user_input_council = {\n \"url\": \"https://custom-url.example.com\",\n \"timeout\": 60,\n }\n\n result = await proceed_through_config_flow(\n hass, flow, user_input_initial, user_input_council\n )\n\n assert result[\"type\"] == data_entry_flow.FlowResultType.CREATE_ENTRY\n assert result[\"title\"] == \"Test Name\"\n assert result[\"data\"] == {\n \"name\": \"Test Name\",\n \"council\": \"CouncilCustomURLField\",\n \"url\": \"https://custom-url.example.com\",\n \"timeout\": 60,\n }\n\n\nasync def test_config_flow_missing_name(hass: HomeAssistant):\n \"\"\"Test config flow when name is missing.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n user_input_initial = {\n \"name\": \"\", # Missing name\n \"council\": \"Council with UPRN\",\n }\n\n result = await flow.async_step_user(user_input=user_input_initial)\n\n assert result[\"type\"] == data_entry_flow.RESULT_TYPE_FORM\n assert result[\"step_id\"] == \"user\"\n assert result[\"errors\"] == {\"name\": \"Name is required.\"}\n\n\nasync def test_config_flow_invalid_icon_color_mapping(hass: HomeAssistant):\n \"\"\"Test config flow with invalid icon_color_mapping JSON.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n user_input_initial = {\n \"name\": \"Test Name\",\n \"council\": \"Council with UPRN\",\n \"icon_color_mapping\": \"invalid json\", # Invalid JSON\n }\n\n result = await flow.async_step_user(user_input=user_input_initial)\n\n # Should return to the user step with an error\n assert result[\"type\"] == data_entry_flow.RESULT_TYPE_FORM\n assert result[\"step_id\"] == \"user\"\n assert result[\"errors\"] == {\"icon_color_mapping\": \"Invalid JSON format.\"}\n\n\nasync def test_config_flow_with_usrn(hass: HomeAssistant):\n \"\"\"Test config flow for a council requiring USRN.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n user_input_initial = {\n \"name\": \"Test Name\",\n \"council\": \"Council with USRN\",\n }\n user_input_council = {\n \"usrn\": \"9876543210\",\n \"timeout\": 60,\n }\n\n result = await proceed_through_config_flow(\n hass, flow, user_input_initial, user_input_council\n )\n\n assert result[\"type\"] == data_entry_flow.FlowResultType.CREATE_ENTRY\n assert result[\"title\"] == \"Test Name\"\n assert result[\"data\"] == {\n \"name\": \"Test Name\",\n \"council\": \"CouncilWithUSRN\",\n \"usrn\": \"9876543210\",\n \"timeout\": 60,\n }\n\n\n@pytest.mark.asyncio\nasync def test_reconfigure_flow(hass):\n \"\"\"Test reconfiguration of an existing integration.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n # Create an existing entry\n existing_entry = MockConfigEntry(\n domain=DOMAIN,\n data={\n \"name\": \"Existing Entry\",\n \"council\": \"CouncilWithUPRN\",\n \"uprn\": \"1234567890\",\n \"timeout\": 60,\n },\n )\n existing_entry.add_to_hass(hass)\n\n # Configure async_get_entry to return the existing_entry when called with its entry_id\n hass.config_entries.async_get_entry.return_value = existing_entry\n\n # Configure async_init to return a FlowResultType.FORM with step_id 'reconfigure_confirm'\n hass.config_entries.flow.async_init.return_value = {\n \"flow_id\": \"test_flow_id\",\n \"type\": data_entry_flow.RESULT_TYPE_FORM,\n \"step_id\": \"reconfigure_confirm\",\n }\n\n # Initialize the flow\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n # Set the context to reconfigure the existing entry\n flow.context = {\"source\": \"reconfigure\", \"entry_id\": existing_entry.entry_id}\n\n # Mock async_step_reconfigure_confirm's behavior\n with patch.object(\n flow, \"async_step_reconfigure_confirm\", new=AsyncMock()\n ) as mock_step:\n mock_step.return_value = {\n \"type\": data_entry_flow.RESULT_TYPE_CREATE_ENTRY,\n \"title\": \"Test Name\",\n \"data\": {\n \"name\": \"Test Name\",\n \"council\": \"CouncilWithUPRN\",\n \"uprn\": \"0987654321\",\n \"timeout\": 120,\n },\n }\n\n # Start the reconfiguration flow\n result = await flow.async_step_reconfigure()\n\n assert result[\"type\"] == data_entry_flow.FlowResultType.CREATE_ENTRY\n assert result[\"title\"] == \"Test Name\"\n assert result[\"data\"] == {\n \"name\": \"Test Name\",\n \"council\": \"CouncilWithUPRN\",\n \"uprn\": \"0987654321\",\n \"timeout\": 120,\n }\n\n # Verify that async_step_reconfigure_confirm was called\n mock_step.assert_called_once()\n\n\nasync def get_councils_json(self) -> object:\n \"\"\"Returns an object of supported councils and their required fields.\"\"\"\n url = \"https://raw.githubusercontent.com/robbrad/UKBinCollectionData/0.104.0/uk_bin_collection/tests/input.json\"\n try:\n async with aiohttp.ClientSession() as session:\n async with session.get(url) as response:\n data_text = await response.text()\n return json.loads(data_text)\n except Exception as e:\n _LOGGER.error(\"Failed to fetch councils data: %s\", e)\n return {}\n\n\n@pytest.mark.asyncio\nasync def test_get_councils_json_failure(hass: HomeAssistant):\n \"\"\"Test handling when get_councils_json fails.\"\"\"\n with patch(\n \"aiohttp.ClientSession\",\n autospec=True,\n ) as mock_session_cls:\n # Configure the mock session to simulate a network error\n mock_session = mock_session_cls.return_value.__aenter__.return_value\n mock_session.get.side_effect = Exception(\"Network error\")\n\n # Configure async_init to simulate flow abort due to council data being unavailable\n hass.config_entries.flow.async_init.return_value = {\n \"type\": data_entry_flow.RESULT_TYPE_ABORT,\n \"reason\": \"council_data_unavailable\",\n }\n\n # Initialize the flow\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n # Start the flow using hass.config_entries.flow.async_init\n result = await hass.config_entries.flow.async_init(\n DOMAIN, context={\"source\": config_entries.SOURCE_USER}\n )\n\n # The flow should abort due to council data being unavailable\n assert result[\"type\"] == data_entry_flow.FlowResultType.ABORT\n assert result[\"reason\"] == \"council_data_unavailable\"\n\n\nasync def test_config_flow_user_input_none(hass: HomeAssistant):\n \"\"\"Test config flow when user_input is None.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n result = await flow.async_step_user(user_input=None)\n\n assert result[\"type\"] == data_entry_flow.RESULT_TYPE_FORM\n assert result[\"step_id\"] == \"user\"\n\n\nasync def test_config_flow_with_optional_fields(hass: HomeAssistant):\n \"\"\"Test config flow with optional fields provided.\"\"\"\n # Assume 'CouncilWithOptionalFields' requires 'uprn' and has optional 'web_driver'\n MOCK_COUNCILS_DATA[\"CouncilWithOptionalFields\"] = {\n \"wiki_name\": \"Council with Optional Fields\",\n \"uprn\": True,\n \"web_driver\": True,\n }\n\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n user_input_initial = {\n \"name\": \"Test Name\",\n \"council\": \"Council with Optional Fields\",\n }\n user_input_council = {\n \"uprn\": \"1234567890\",\n \"web_driver\": \"/path/to/webdriver\",\n \"headless\": True,\n \"local_browser\": False,\n \"timeout\": 60,\n }\n\n result = await proceed_through_config_flow(\n hass, flow, user_input_initial, user_input_council\n )\n\n assert result[\"type\"] == data_entry_flow.FlowResultType.CREATE_ENTRY\n assert result[\"title\"] == \"Test Name\"\n assert result[\"data\"] == {\n \"name\": \"Test Name\",\n \"council\": \"CouncilWithOptionalFields\",\n \"uprn\": \"1234567890\",\n \"web_driver\": \"/path/to/webdriver\",\n \"headless\": True,\n \"local_browser\": False,\n \"timeout\": 60,\n }\n\n\n@pytest.mark.asyncio\nasync def test_get_councils_json_session_creation_failure(hass):\n \"\"\"Test handling when creating aiohttp ClientSession fails.\"\"\"\n with patch(\n \"aiohttp.ClientSession\",\n side_effect=Exception(\"Failed to create session\"),\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n # Configure async_init to simulate flow abort due to council data being unavailable\n hass.config_entries.flow.async_init.return_value = {\n \"type\": data_entry_flow.RESULT_TYPE_ABORT,\n \"reason\": \"council_data_unavailable\",\n }\n\n # Start the flow using hass.config_entries.flow.async_init\n result = await hass.config_entries.flow.async_init(\n DOMAIN, context={\"source\": config_entries.SOURCE_USER}\n )\n\n # The flow should abort due to council data being unavailable\n assert result[\"type\"] == data_entry_flow.FlowResultType.ABORT\n assert result[\"reason\"] == \"council_data_unavailable\"\n\n\n@pytest.mark.asyncio\nasync def test_config_flow_council_without_url(hass):\n \"\"\"Test config flow for a council where 'url' field should not be included.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n user_input_initial = {\n \"name\": \"Test Name\",\n \"council\": \"Council without URL\",\n }\n user_input_council = {\n \"uprn\": \"1234567890\",\n \"timeout\": 60,\n }\n\n # Configure async_init to return a FlowResultType.FORM with step_id 'council'\n hass.config_entries.flow.async_init.return_value = {\n \"flow_id\": \"test_flow_id\",\n \"type\": data_entry_flow.RESULT_TYPE_FORM,\n \"step_id\": \"council\",\n }\n\n # Configure async_configure to return a FlowResultType.CREATE_ENTRY\n hass.config_entries.flow.async_configure.return_value = {\n \"type\": data_entry_flow.RESULT_TYPE_CREATE_ENTRY,\n \"title\": \"Test Name\",\n \"data\": {\n \"name\": \"Test Name\",\n \"council\": \"CouncilWithoutURL\",\n \"uprn\": \"1234567890\",\n \"timeout\": 60,\n \"skip_get_url\": True,\n \"url\": \"https://example.com/council_without_url\",\n },\n }\n\n # Start the flow\n result = await hass.config_entries.flow.async_init(\n DOMAIN, context={\"source\": config_entries.SOURCE_USER}\n )\n\n # Provide initial user input\n result = await hass.config_entries.flow.async_configure(\n result[\"flow_id\"], user_input=user_input_initial\n )\n\n assert result[\"type\"] == data_entry_flow.FlowResultType.CREATE_ENTRY\n assert result[\"title\"] == \"Test Name\"\n assert result[\"data\"] == {\n \"name\": \"Test Name\",\n \"council\": \"CouncilWithoutURL\",\n \"uprn\": \"1234567890\",\n \"timeout\": 60,\n \"skip_get_url\": True,\n \"url\": \"https://example.com/council_without_url\",\n }\n\n\nasync def test_config_flow_missing_council(hass: HomeAssistant):\n \"\"\"Test config flow when council is missing.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n user_input_initial = {\n \"name\": \"Test Name\",\n \"council\": \"\", # Missing council\n }\n\n result = await flow.async_step_user(user_input=user_input_initial)\n\n # Should return to the user step with an error\n assert result[\"type\"] == data_entry_flow.RESULT_TYPE_FORM\n assert result[\"step_id\"] == \"user\"\n assert result[\"errors\"] == {\"council\": \"Council is required.\"}\n\n\n@pytest.mark.asyncio\nasync def test_reconfigure_flow_with_errors(hass):\n \"\"\"Test reconfiguration with invalid input.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n # Create an existing entry\n existing_entry = MockConfigEntry(\n domain=DOMAIN,\n data={\n \"name\": \"Existing Entry\",\n \"council\": \"CouncilWithUPRN\",\n \"uprn\": \"1234567890\",\n \"timeout\": 60,\n },\n )\n existing_entry.add_to_hass(hass)\n\n # Configure async_get_entry to return the existing_entry when called with its entry_id\n hass.config_entries.async_get_entry.return_value = existing_entry\n\n # Configure async_init to return a FlowResultType.FORM with step_id 'reconfigure_confirm'\n hass.config_entries.flow.async_init.return_value = {\n \"flow_id\": \"test_flow_id\",\n \"type\": data_entry_flow.RESULT_TYPE_FORM,\n \"step_id\": \"reconfigure_confirm\",\n }\n\n # Initialize the flow\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n # Set the context to reconfigure the existing entry\n flow.context = {\"source\": \"reconfigure\", \"entry_id\": existing_entry.entry_id}\n\n # Mock async_step_reconfigure_confirm's behavior to handle invalid input\n with patch.object(\n flow, \"async_step_reconfigure_confirm\", new=AsyncMock()\n ) as mock_step:\n mock_step.return_value = {\n \"type\": data_entry_flow.RESULT_TYPE_FORM,\n \"step_id\": \"reconfigure_confirm\",\n \"errors\": {\"icon_color_mapping\": \"invalid_json\"},\n }\n\n # Start the reconfiguration flow\n result = await flow.async_step_reconfigure()\n\n assert result[\"type\"] == data_entry_flow.FlowResultType.FORM\n assert result[\"step_id\"] == \"reconfigure_confirm\"\n\n # Provide invalid data (e.g., invalid JSON for icon_color_mapping)\n user_input = {\n \"name\": \"Updated Entry\",\n \"council\": \"Council with UPRN\",\n \"uprn\": \"0987654321\",\n \"icon_color_mapping\": \"invalid json\",\n \"timeout\": 60,\n }\n\n # Configure async_configure to return an error\n hass.config_entries.flow.async_configure.return_value = {\n \"type\": data_entry_flow.RESULT_TYPE_FORM,\n \"step_id\": \"reconfigure_confirm\",\n \"errors\": {\"icon_color_mapping\": \"invalid_json\"},\n }\n\n result = await flow.async_step_reconfigure_confirm(user_input=user_input)\n\n # Should return to the reconfigure_confirm step with an error\n assert result[\"type\"] == data_entry_flow.FlowResultType.FORM\n assert result[\"step_id\"] == \"reconfigure_confirm\"\n assert result[\"errors\"] == {\"icon_color_mapping\": \"invalid_json\"}\n\n\n@pytest.mark.asyncio\nasync def test_reconfigure_flow_entry_missing(hass):\n \"\"\"Test reconfiguration when the config entry is missing.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n # Set the context with an invalid entry_id to simulate a missing entry\n flow.context = {\"source\": \"reconfigure\", \"entry_id\": \"invalid_entry_id\"}\n\n # Mock async_get_entry to return None using MagicMock, not AsyncMock\n hass.config_entries.async_get_entry = MagicMock(return_value=None)\n\n # Run the reconfiguration step to check for abort\n result = await flow.async_step_reconfigure()\n\n # Assert that the flow aborts due to the missing config entry\n assert result[\"type\"] == data_entry_flow.FlowResultType.ABORT\n assert result[\"reason\"] == \"Reconfigure Failed\"\n\n\n@pytest.mark.asyncio\nasync def test_reconfigure_flow_no_user_input(hass):\n \"\"\"Test reconfiguration when user_input is None.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n # Create a mock entry and ensure add_to_hass is awaited\n existing_entry = MockConfigEntry(\n domain=DOMAIN,\n data={\n \"name\": \"Existing Entry\",\n \"council\": \"CouncilWithUPRN\",\n \"uprn\": \"1234567890\",\n \"timeout\": 60,\n },\n )\n existing_entry.add_to_hass(hass)\n\n # Mock async_get_entry to return the entry directly, avoiding coroutine issues\n hass.config_entries.async_get_entry = AsyncMock(return_value=existing_entry)\n\n # Mock async_init and start the reconfigure flow\n hass.config_entries.flow.async_init.return_value = {\n \"flow_id\": \"test_flow_id\",\n \"type\": data_entry_flow.RESULT_TYPE_FORM,\n \"step_id\": \"reconfigure_confirm\",\n }\n\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n flow.context = {\"source\": \"reconfigure\", \"entry_id\": existing_entry.entry_id}\n\n # Proceed without user input, simulating the form return\n with patch.object(\n flow, \"async_step_reconfigure_confirm\", new=AsyncMock()\n ) as mock_step:\n mock_step.return_value = {\n \"type\": data_entry_flow.RESULT_TYPE_FORM,\n \"step_id\": \"reconfigure_confirm\",\n \"errors\": {},\n }\n\n result = await flow.async_step_reconfigure_confirm(user_input=None)\n\n assert result[\"type\"] == data_entry_flow.FlowResultType.FORM\n assert result[\"step_id\"] == \"reconfigure_confirm\"\n\n\n@pytest.mark.asyncio\nasync def test_check_selenium_server_exception(hass: HomeAssistant):\n \"\"\"Test exception handling in check_selenium_server.\"\"\"\n with patch(\n \"aiohttp.ClientSession.get\",\n side_effect=Exception(\"Connection error\"),\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n result = await flow.check_selenium_server()\n # Expected result is that all URLs are marked as not accessible\n expected_result = [\n (\"http://localhost:4444\", False),\n (\"http://selenium:4444\", False),\n ]\n assert result == expected_result\n\n\n@pytest.mark.asyncio\nasync def test_get_councils_json_exception(hass: HomeAssistant):\n \"\"\"Test exception handling in get_councils_json.\"\"\"\n with patch(\n \"aiohttp.ClientSession.get\",\n side_effect=Exception(\"Network error\"),\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n result = await flow.get_councils_json()\n assert result == {}\n\n\n@pytest.mark.asyncio\nasync def test_async_step_user_council_data_unavailable(hass: HomeAssistant):\n \"\"\"Test async_step_user when council data is unavailable.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=None,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n result = await flow.async_step_user(user_input={})\n\n assert result[\"type\"] == data_entry_flow.FlowResultType.ABORT\n assert result[\"reason\"] == \"Council Data Unavailable\"\n\n\n@pytest.mark.asyncio\nasync def test_async_step_council_invalid_icon_color_mapping(hass: HomeAssistant):\n \"\"\"Test async_step_council with invalid JSON in icon_color_mapping.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n flow.data = {\n \"name\": \"Test Name\",\n \"council\": \"CouncilWithUPRN\",\n }\n flow.councils_data = MOCK_COUNCILS_DATA\n\n user_input = {\n \"uprn\": \"1234567890\",\n \"icon_color_mapping\": \"invalid json\",\n \"timeout\": 60,\n }\n\n result = await flow.async_step_council(user_input=user_input)\n\n assert result[\"type\"] == data_entry_flow.RESULT_TYPE_FORM\n assert result[\"step_id\"] == \"council\"\n assert result[\"errors\"] == {\"icon_color_mapping\": \"Invalid JSON format.\"}\n\n\n@pytest.mark.asyncio\nasync def test_async_step_reconfigure_entry_none(hass: HomeAssistant):\n \"\"\"Test async_step_reconfigure when config entry is None.\"\"\"\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n flow.context = {\"entry_id\": \"non_existent_entry_id\"}\n\n # Mock async_get_entry to return None\n flow.hass.config_entries.async_get_entry = MagicMock(return_value=None)\n\n result = await flow.async_step_reconfigure()\n\n assert result[\"type\"] == data_entry_flow.FlowResultType.ABORT\n assert result[\"reason\"] == \"Reconfigure Failed\"\n\n\nasync def test_async_step_reconfigure_confirm_user_input_none(hass: HomeAssistant):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n # Create a mock config entry\n config_entry = MockConfigEntry(\n domain=DOMAIN,\n data={\n \"name\": \"Test Name\",\n \"council\": \"CouncilWithUPRN\",\n \"uprn\": \"1234567890\",\n \"timeout\": 60,\n },\n )\n config_entry.add_to_hass(hass)\n\n flow.config_entry = config_entry\n flow.context = {\"entry_id\": config_entry.entry_id}\n flow.councils_data = MOCK_COUNCILS_DATA\n\n # Patch async_get_entry to return the config_entry immediately\n hass.config_entries.async_get_entry = MagicMock(return_value=config_entry)\n\n result = await flow.async_step_reconfigure_confirm(user_input=None)\n assert result[\"type\"] == data_entry_flow.RESULT_TYPE_FORM\n assert result[\"step_id\"] == \"reconfigure_confirm\"\n\n\n@pytest.mark.asyncio\nasync def test_async_step_council_missing_council_key(hass: HomeAssistant):\n \"\"\"Test async_step_council when council_key is missing in councils_data.\"\"\"\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n flow.data = {\n \"name\": \"Test Name\",\n \"council\": \"NonExistentCouncil\",\n }\n flow.councils_data = MOCK_COUNCILS_DATA\n\n result = await flow.async_step_council(user_input=None)\n\n assert result[\"type\"] == data_entry_flow.RESULT_TYPE_FORM\n assert result[\"step_id\"] == \"council\"\n\n\n@pytest.mark.asyncio\nasync def test_check_chromium_installed_exception(hass: HomeAssistant):\n \"\"\"Test exception handling in check_chromium_installed.\"\"\"\n with patch(\n \"shutil.which\",\n side_effect=Exception(\"Filesystem error\"),\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n result = await flow.check_chromium_installed()\n assert result is False\n\n\nasync def test_async_step_reconfigure_confirm_invalid_json(hass: HomeAssistant):\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n # Create a mock config entry\n config_entry = MockConfigEntry(\n domain=DOMAIN,\n data={\n \"name\": \"Existing Entry\",\n \"council\": \"CouncilWithUPRN\",\n \"uprn\": \"1234567890\",\n \"timeout\": 60,\n },\n )\n config_entry.add_to_hass(hass)\n\n flow.config_entry = config_entry\n flow.context = {\"entry_id\": config_entry.entry_id}\n\n # Patch async_get_entry to return the config_entry (not a coroutine)\n hass.config_entries.async_get_entry = MagicMock(return_value=config_entry)\n\n # Set up mocks for async methods\n hass.config_entries.async_reload = AsyncMock()\n hass.config_entries.async_update_entry = MagicMock()\n\n user_input = {\n \"name\": \"Updated Entry\",\n \"council\": \"Council with UPRN\",\n \"icon_color_mapping\": \"invalid json\",\n \"uprn\": \"0987654321\",\n \"timeout\": 120,\n }\n\n result = await flow.async_step_reconfigure_confirm(user_input=user_input)\n\n # Should return to the reconfigure_confirm step with an error\n assert result[\"type\"] == data_entry_flow.RESULT_TYPE_FORM\n assert result[\"step_id\"] == \"reconfigure_confirm\"\n assert result[\"errors\"] == {\"icon_color_mapping\": \"Invalid JSON format.\"}\n\n\n@pytest.mark.asyncio\nasync def test_config_flow_with_manual_refresh_only(hass: HomeAssistant):\n \"\"\"Test config flow when the user selects manual_refresh_only = True.\"\"\"\n mock_councils = {\n \"CouncilWithUPRN\": {\n \"wiki_name\": \"Council with UPRN\",\n \"uprn\": True,\n }\n }\n\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=mock_councils,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n\n # Step 1: user selects council + sets manual_refresh_only\n user_input_initial = {\n \"name\": \"Test Manual Refresh\",\n \"council\": \"Council with UPRN\",\n \"manual_refresh_only\": True,\n # icon_color_mapping, etc. are optional\n }\n\n # Step 2: council details\n # minimal fields needed for council requiring UPRN\n user_input_council = {\n \"uprn\": \"1234567890\",\n \"timeout\": 45,\n # note that if skip_get_url is False, you might need \"url\" or not\n }\n\n # Start user step\n result = await flow.async_step_user(user_input=user_input_initial)\n assert result[\"type\"] == data_entry_flow.RESULT_TYPE_FORM\n assert result[\"step_id\"] == \"council\"\n\n # Complete council step\n result = await flow.async_step_council(user_input=user_input_council)\n assert result[\"type\"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY\n assert result[\"title\"] == \"Test Manual Refresh\"\n\n # Confirm the config entry data now includes manual_refresh_only\n assert result[\"data\"] == {\n \"name\": \"Test Manual Refresh\",\n \"council\": \"CouncilWithUPRN\",\n \"uprn\": \"1234567890\",\n \"timeout\": 45,\n \"manual_refresh_only\": True,\n }\n\n\n# ---------------------------\n# Tests for helper functions\n# ---------------------------\ndef test_load_icon_color_mapping_valid():\n valid_json = '{\"General Waste\": {\"icon\": \"mdi:trash-can\", \"color\": \"brown\"}}'\n result = load_icon_color_mapping(valid_json)\n assert isinstance(result, dict)\n assert result[\"General Waste\"][\"icon\"] == \"mdi:trash-can\"\n assert result[\"General Waste\"][\"color\"] == \"brown\"\n\n\ndef test_load_icon_color_mapping_invalid():\n invalid_json = '{\"icon\":\"mdi:trash\" \"no_comma\":true}' # missing comma\n with patch(\"logging.Logger.warning\") as mock_warn:\n result = load_icon_color_mapping(invalid_json)\n assert result == {}\n mock_warn.assert_called_once_with(\n f\"{LOG_PREFIX} Invalid icon_color_mapping JSON: {invalid_json}. Using default settings.\"\n )\n\n\ndef test_map_wiki_name_to_council_key():\n flow = UkBinCollectionConfigFlow()\n flow.council_names = [\"CouncilTest\"]\n flow.council_options = [\"Council Test\"]\n # Valid mapping\n key = flow.map_wiki_name_to_council_key(\"Council Test\")\n assert key == \"CouncilTest\"\n # Invalid mapping: expect empty string and a logged error.\n with patch(\"logging.Logger.error\") as mock_error:\n key_invalid = flow.map_wiki_name_to_council_key(\"Not Exist\")\n assert key_invalid == \"\"\n mock_error.assert_called_once_with(\n \"Wiki name '%s' not found in council options.\", \"Not Exist\"\n )\n\n\ndef test_is_valid_json():\n valid = '{\"key\": \"value\"}'\n invalid = '{\"key\": \"value\",}' # trailing comma makes it invalid\n assert UkBinCollectionConfigFlow.is_valid_json(valid) is True\n assert UkBinCollectionConfigFlow.is_valid_json(invalid) is False\n\n\n# ---------------------------\n# Tests for async_step_user\n# ---------------------------\n@pytest.mark.asyncio\nasync def test_async_step_user_missing_fields(hass):\n \"\"\"Test async_step_user returns errors when required fields are missing.\"\"\"\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n # Set councils data so that form is rendered\n flow.councils_data = MOCK_COUNCILS_DATA\n flow.council_names = list(MOCK_COUNCILS_DATA.keys())\n flow.council_options = [\n MOCK_COUNCILS_DATA[name][\"wiki_name\"] for name in flow.council_names\n ]\n # Missing both 'name' and 'council'\n result = await flow.async_step_user(user_input={\"name\": \"\", \"council\": \"\"})\n assert result[\"type\"] == \"form\"\n assert result[\"step_id\"] == \"user\"\n assert \"name\" in result[\"errors\"]\n assert \"council\" in result[\"errors\"]\n\n\n@pytest.mark.asyncio\nasync def test_async_step_user_invalid_icon_mapping(hass):\n \"\"\"Test async_step_user returns error for invalid icon_color_mapping JSON.\"\"\"\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n flow.councils_data = MOCK_COUNCILS_DATA\n flow.council_names = list(MOCK_COUNCILS_DATA.keys())\n flow.council_options = [\n MOCK_COUNCILS_DATA[name][\"wiki_name\"] for name in flow.council_names\n ]\n result = await flow.async_step_user(\n user_input={\n \"name\": \"Test Name\",\n \"council\": MOCK_COUNCILS_DATA[\"CouncilTest\"][\"wiki_name\"],\n \"icon_color_mapping\": \"not a json\",\n }\n )\n assert result[\"type\"] == \"form\"\n assert result[\"errors\"] == {\"icon_color_mapping\": \"Invalid JSON format.\"}\n\n\n@pytest.mark.asyncio\nasync def test_async_step_user_no_councils(hass):\n \"\"\"Test async_step_user aborts when councils data cannot be fetched.\"\"\"\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n # Patch get_councils_json to return an empty dict (simulate failure)\n with patch.object(flow, \"get_councils_json\", return_value={}):\n result = await flow.async_step_user(\n user_input={\"name\": \"Test\", \"council\": \"CouncilTest\"}\n )\n assert result[\"type\"] == \"abort\"\n assert result[\"reason\"] == \"Council Data Unavailable\"\n\n\n# ---------------------------\n# Tests for async_step_council\n# ---------------------------\n@pytest.mark.asyncio\nasync def test_async_step_council_skip_get_url(hass):\n \"\"\"Test that async_step_council sets skip_get_url when required.\"\"\"\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n # Set up data so that the council in question requires URL skipping.\n flow.data = {\"name\": \"Test\", \"council\": \"CouncilSkip\"}\n flow.councils_data = MOCK_COUNCILS_DATA\n # Provide minimal user input (e.g. only timeout)\n user_input = {\"timeout\": 60}\n result = await flow.async_step_council(user_input=user_input)\n # In a real flow, if no errors are present the entry would be created.\n # Here, we simply verify that the user input was merged with skip_get_url.\n if \"data\" in result:\n # If the flow creates an entry, check that skip_get_url is present.\n assert result[\"data\"].get(\"skip_get_url\") is True\n assert result[\"data\"].get(\"url\") == MOCK_COUNCILS_DATA[\"CouncilSkip\"].get(\"url\")\n else:\n # Otherwise, the form is returned with no errors.\n assert result[\"type\"] == \"form\"\n\n\n# ---------------------------\n# Tests for reconfigure steps\n# ---------------------------\n@pytest.mark.asyncio\nasync def test_async_step_reconfigure_confirm_user_input_none(hass):\n \"\"\"Test async_step_reconfigure_confirm returns form when no user input is provided.\"\"\"\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n # Create a dummy config entry.\n dummy_entry = DummyEntry(\n {\n \"name\": \"Test Name\",\n \"council\": \"CouncilTest\",\n \"uprn\": \"1234567890\",\n \"timeout\": 60,\n },\n entry_id=\"dummy\",\n )\n # Make sure async_get_entry returns a plain entry.\n hass.config_entries.async_get_entry = MagicMock(return_value=dummy_entry)\n flow.config_entry = dummy_entry\n flow.context = {\"entry_id\": dummy_entry.entry_id}\n flow.councils_data = MOCK_COUNCILS_DATA\n\n result = await flow.async_step_reconfigure_confirm(user_input=None)\n assert result[\"type\"] == \"form\"\n assert result[\"step_id\"] == \"reconfigure_confirm\"\n\n\n@pytest.mark.asyncio\nasync def test_async_step_reconfigure_confirm_invalid_json(hass):\n \"\"\"Test async_step_reconfigure_confirm returns errors with invalid JSON mapping and update_interval.\"\"\"\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n dummy_entry = DummyEntry(\n {\n \"name\": \"Existing Entry\",\n \"council\": \"CouncilTest\",\n \"uprn\": \"1234567890\",\n \"timeout\": 60,\n },\n entry_id=\"dummy\",\n )\n hass.config_entries.async_get_entry = MagicMock(return_value=dummy_entry)\n flow.config_entry = dummy_entry\n flow.context = {\"entry_id\": dummy_entry.entry_id}\n flow.councils_data = MOCK_COUNCILS_DATA\n\n # Patch async_update_entry and async_reload (they won't be used if there are errors)\n hass.config_entries.async_update_entry = MagicMock()\n hass.config_entries.async_reload = AsyncMock()\n\n user_input = {\n \"name\": \"Updated Entry\",\n \"council\": MOCK_COUNCILS_DATA[\"CouncilTest\"][\"wiki_name\"],\n \"update_interval\": \"0\", # invalid (less than 1)\n \"icon_color_mapping\": \"invalid json\",\n \"uprn\": \"0987654321\",\n \"timeout\": 120,\n }\n result = await flow.async_step_reconfigure_confirm(user_input=user_input)\n assert result[\"type\"] == \"form\"\n assert result[\"step_id\"] == \"reconfigure_confirm\"\n # Expect errors for update_interval and icon_color_mapping.\n assert \"update_interval\" in result[\"errors\"]\n assert \"icon_color_mapping\" in result[\"errors\"]\n\n\n# ---------------------------\n# Test get_councils_json failure\n# ---------------------------\n@pytest.mark.asyncio\nasync def test_get_councils_json_failure(hass):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n with patch(\"aiohttp.ClientSession\") as mock_session_cls:\n # Simulate network error.\n mock_session = mock_session_cls.return_value.__aenter__.return_value\n mock_session.get.side_effect = Exception(\"Network error\")\n result = await flow.get_councils_json()\n assert result == {}\n\n\n# ---------------------------\n# Test get_council_schema\n# ---------------------------\n@pytest.mark.asyncio\nasync def test_get_council_schema(hass):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n flow.councils_data = {\n \"CouncilTest\": {\n \"wiki_name\": \"Council Test\",\n \"skip_get_url\": False,\n \"uprn\": True,\n \"postcode\": True,\n \"house_number\": True,\n \"usrn\": True,\n \"web_driver\": True,\n }\n }\n schema = await flow.get_council_schema(\"CouncilTest\")\n # Check that required fields appear in the schema.\n required_fields = [\"url\", \"uprn\", \"postcode\", \"number\", \"usrn\", \"timeout\"]\n for field in required_fields:\n assert field in schema.schema\n\n\n# ---------------------------\n# Test build_reconfigure_schema\n# ---------------------------\ndef test_build_reconfigure_schema(hass):\n flow = UkBinCollectionConfigFlow()\n flow.council_names = [\"CouncilTest\"]\n flow.council_options = [\"Council Test\"]\n existing_data = {\n \"name\": \"Old Name\",\n \"council\": \"CouncilTest\",\n \"update_interval\": 12,\n \"url\": \"https://example.com\",\n \"icon_color_mapping\": \"{}\",\n }\n schema = flow.build_reconfigure_schema(existing_data, \"Council Test\")\n assert isinstance(schema, vol.Schema)\n schema_dict = schema.schema\n assert \"name\" in schema_dict\n assert \"council\" in schema_dict\n assert \"update_interval\" in schema_dict\n\n\n# ---------------------------\n# Test async_step_import\n# ---------------------------\n@pytest.mark.asyncio\nasync def test_async_step_import(hass):\n \"\"\"Test that import flows call async_step_user.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.config_flow.UkBinCollectionConfigFlow.get_councils_json\",\n return_value=MOCK_COUNCILS_DATA,\n ):\n flow = UkBinCollectionConfigFlow()\n flow.hass = hass\n import_config = {\"name\": \"Imported\", \"council\": \"Council Test\", \"uprn\": \"111\"}\n\n result = await flow.async_step_import(import_config)\n\n assert result is not None\n\n\n@pytest.mark.asyncio\nasync def test_options_flow_no_councils(dummy_hass):\n \"\"\"Test async_step_init aborts if get_councils_json returns empty data.\"\"\"\n config_entry = MockConfigEntry(\n domain=DOMAIN, data={\"name\": \"Test Options\"}, entry_id=\"opt_test\"\n )\n config_entry.add_to_hass(dummy_hass)\n flow = UkBinCollectionOptionsFlowHandler(config_entry)\n flow.hass = dummy_hass\n\n # Patch get_councils_json to return an empty dict\n flow.get_councils_json = AsyncMock(return_value={})\n result = await flow.async_step_init(user_input=None)\n # Expect an abort with reason \"Council Data Unavailable\"\n assert result[\"reason\"] == \"Council Data Unavailable\"\n\n\ndef test_build_options_schema(options_flow):\n \"\"\"Test that build_options_schema returns a schema with expected keys.\"\"\"\n flow, config_entry = options_flow\n # Set up the lists for schema building\n flow.council_names = [\"CouncilTest\"]\n flow.council_options = [\"Council Test\"]\n existing_data = {\n \"name\": \"Test Options\",\n \"council\": \"CouncilTest\",\n \"update_interval\": 12,\n \"icon_color_mapping\": '{\"CouncilTest\": {\"icon\": \"mdi:trash\", \"color\": \"green\"}}',\n }\n schema = flow.build_options_schema(existing_data)\n sample = schema(\n {\"name\": \"Test Options\", \"council\": \"Council Test\", \"update_interval\": 12}\n )\n assert isinstance(sample, dict)\n sample_with_optional = schema(\n {\n \"name\": \"Test Options\",\n \"council\": \"Council Test\",\n \"update_interval\": 12,\n \"icon_color_mapping\": '{\"key\": \"value\"}',\n }\n )\n assert \"icon_color_mapping\" in sample_with_optional\n\n\ndef test_map_wiki_name_to_council_key(options_flow):\n \"\"\"Test mapping from wiki name to council key.\"\"\"\n flow, _ = options_flow\n flow.council_options = [\"Council Test\"]\n flow.council_names = [\"CouncilTest\"]\n assert flow.map_wiki_name_to_council_key(\"Council Test\") == \"CouncilTest\"\n assert flow.map_wiki_name_to_council_key(\"Nonexistent\") == \"\"\n\n\ndef test_is_valid_json():\n \"\"\"Test is_valid_json for valid and invalid JSON.\"\"\"\n from custom_components.uk_bin_collection.config_flow import (\n UkBinCollectionOptionsFlowHandler,\n )\n\n valid = '{\"key\": \"value\"}'\n invalid = '{\"key\": \"value\" \"missing_comma\": true}'\n assert UkBinCollectionOptionsFlowHandler.is_valid_json(valid) is True\n assert UkBinCollectionOptionsFlowHandler.is_valid_json(invalid) is False\n\n\n# --- Test: Helper method is_valid_json ---\ndef test_is_valid_json_options():\n valid = '{\"key\": \"value\"}'\n invalid = '{\"key\": \"value\",}' # trailing comma\n assert UkBinCollectionOptionsFlowHandler.is_valid_json(valid) is True\n assert UkBinCollectionOptionsFlowHandler.is_valid_json(invalid) is False\n" }, { "path": "custom_components/uk_bin_collection/tests/test_init.py", "content": "# test_init.py\nimport asyncio\nimport json\nfrom datetime import datetime, timedelta\nfrom unittest.mock import AsyncMock, MagicMock, patch\n\nimport pytest\nfrom homeassistant.config_entries import ConfigEntry\nfrom homeassistant.exceptions import ConfigEntryNotReady\nfrom homeassistant.helpers.update_coordinator import UpdateFailed\n\n# Import the functions and classes from your __init__.py file.\nfrom custom_components.uk_bin_collection import (\n HouseholdBinCoordinator,\n async_migrate_entry,\n async_setup,\n async_setup_entry,\n async_unload_entry,\n build_ukbcd_args,\n)\nfrom custom_components.uk_bin_collection.const import DOMAIN, LOG_PREFIX, PLATFORMS\nfrom uk_bin_collection.uk_bin_collection.collect_data import UKBinCollectionApp\n\n\nclass DummyUKBinCollectionApp:\n def __init__(self):\n self.args = None\n # Set parsed_args so that self.parsed_args.module is valid (using \"json\" here as an example)\n self.parsed_args = type(\"DummyArgs\", (), {\"module\": \"json\"})()\n\n def set_args(self, args):\n self.args = args\n self.parsed_args = type(\"DummyArgs\", (), {\"module\": \"json\"})()\n\n def run(self):\n # Return valid JSON data expected by the coordinator.\n return json.dumps(\n {\n \"bins\": [\n {\n \"type\": \"waste\",\n \"collectionDate\": datetime.now().strftime(\"%d/%m/%Y\"),\n },\n {\n \"type\": \"recycling\",\n \"collectionDate\": (datetime.now() + timedelta(days=1)).strftime(\n \"%d/%m/%Y\"\n ),\n },\n ]\n }\n )\n\n\n# Create a dummy config entry for testing.\nclass DummyConfigEntry:\n def __init__(self, data, version=1, entry_id=\"dummy_entry\"):\n self.data = data\n self.version = version\n self.entry_id = entry_id\n\n\n# Create a dummy HomeAssistant object.\nclass DummyHass:\n def __init__(self):\n self.data = {}\n self.services = Services()\n self.config_entries = ConfigEntries()\n\n async def async_add_executor_job(self, func, *args, **kwargs):\n # In tests, we can simply run the function synchronously.\n return func(*args, **kwargs)\n\n\nclass Services:\n def __init__(self):\n self.registrations = {}\n\n def async_register(self, domain, service, service_func):\n self.registrations[(domain, service)] = service_func\n\n\nclass ConfigEntries:\n async def async_forward_entry_setups(self, config_entry, platforms):\n # In tests, simply return an empty list (or you can simulate something).\n return []\n\n async def async_forward_entry_unload(self, config_entry, platform):\n # Simulate a successful unload.\n return True\n\n def async_update_entry(self, config_entry, data):\n config_entry.data = data\n\n\n@pytest.fixture\ndef hass():\n return DummyHass()\n\n\n@pytest.fixture\ndef dummy_config_entry():\n data = {\n \"name\": \"Test Entry\",\n \"timeout\": 60,\n \"manual_refresh_only\": True,\n \"icon_color_mapping\": \"{}\",\n \"update_interval\": 12,\n \"council\": \"json\", # Use a valid module name\n \"url\": \"http://example.com\",\n }\n return DummyConfigEntry(data)\n\n\n@pytest.mark.asyncio\nasync def test_household_bin_coordinator_retains_last_good_data(hass):\n # Create a dummy app with dynamic run output\n class DynamicUKBinCollectionApp:\n def __init__(self):\n self.call_count = 0\n\n def set_args(self, args):\n pass\n\n def run(self):\n self.call_count += 1\n if self.call_count == 1:\n # First call: valid data\n return json.dumps(\n {\n \"bins\": [\n {\n \"type\": \"waste\",\n \"collectionDate\": datetime.now().strftime(\"%d/%m/%Y\"),\n },\n ]\n }\n )\n else:\n # Second call: empty bins\n return json.dumps({\"bins\": []})\n\n dummy_app = DynamicUKBinCollectionApp()\n\n coordinator = HouseholdBinCoordinator(\n hass,\n dummy_app,\n name=\"Test Bin\",\n timeout=2,\n update_interval=timedelta(minutes=5),\n )\n\n # First fetch - stores valid data\n first_data = await coordinator._async_update_data()\n assert \"waste\" in first_data\n\n # Second fetch - empty, should fall back to previous data\n second_data = await coordinator._async_update_data()\n assert second_data == first_data # Confirm fallback occurred\n\n\n# --- Test async_setup ---\n@pytest.mark.asyncio\nasync def test_async_setup_success(hass):\n # Call async_setup with a dummy config\n config = {\"uk_bin_collection\": {}}\n result = await async_setup(hass, config)\n assert result is True\n # Check that the integration data was initialized.\n assert DOMAIN in hass.data\n\n\n@pytest.mark.asyncio\nasync def test_manual_refresh_no_entry(hass):\n # Call async_setup to register the service.\n config = {\"uk_bin_collection\": {}}\n await async_setup(hass, config)\n # Get the manual refresh service.\n service_func = hass.services.registrations.get((DOMAIN, \"manual_refresh\"))\n # Create a dummy call with no entry_id.\n dummy_call = MagicMock()\n dummy_call.data = {}\n # Capture log output or simply run the service call.\n await service_func(dummy_call)\n # You might check logs to verify the error was logged.\n\n\n# --- Test async_migrate_entry ---\n@pytest.mark.asyncio\nasync def test_async_migrate_entry_version_1(hass, dummy_config_entry):\n dummy_config_entry.version = 1\n # Remove update_interval to test migration defaults.\n dummy_config_entry.data.pop(\"update_interval\", None)\n result = await async_migrate_entry(hass, dummy_config_entry)\n assert result is True\n # Now update_interval should be set to 12.\n assert dummy_config_entry.data[\"update_interval\"] == 12\n\n\n@pytest.mark.asyncio\nasync def test_async_migrate_entry_no_migration(hass, dummy_config_entry):\n dummy_config_entry.version = 2\n result = await async_migrate_entry(hass, dummy_config_entry)\n assert result is True\n\n\n# --- Test async_setup_entry ---\n@pytest.mark.asyncio\nasync def test_async_setup_entry_success(hass, dummy_config_entry):\n # Ensure hass.data[DOMAIN] is initialized.\n hass.data.setdefault(DOMAIN, {})\n\n # Patch the UKBinCollectionApp in the integration's namespace.\n with patch(\n \"custom_components.uk_bin_collection.UKBinCollectionApp\",\n return_value=DummyUKBinCollectionApp(),\n ):\n result = await async_setup_entry(hass, dummy_config_entry)\n assert result is True\n # Verify that the coordinator was stored in hass.data.\n assert dummy_config_entry.entry_id in hass.data[DOMAIN]\n\n\n@pytest.mark.asyncio\nasync def test_async_setup_entry_missing_name(hass, dummy_config_entry):\n # Remove \"name\" to force a failure.\n dummy_config_entry.data.pop(\"name\")\n with pytest.raises(ConfigEntryNotReady):\n await async_setup_entry(hass, dummy_config_entry)\n\n\n# --- Test async_unload_entry ---\n@pytest.mark.asyncio\nasync def test_async_unload_entry_success(hass, dummy_config_entry):\n # Prepopulate hass.data with a dummy coordinator.\n hass.data.setdefault(DOMAIN, {})[dummy_config_entry.entry_id] = {\n \"coordinator\": \"dummy\"\n }\n result = await async_unload_entry(hass, dummy_config_entry)\n assert result is True\n # The coordinator should have been removed.\n assert dummy_config_entry.entry_id not in hass.data[DOMAIN]\n\n\n# --- Test build_ukbcd_args ---\ndef test_build_ukbcd_args_excludes_keys():\n config_data = {\n \"council\": \"Test Council\",\n \"url\": \"http://example.com\",\n \"skip_get_url\": \"should be excluded\",\n \"custom_arg\": \"value\",\n }\n args = build_ukbcd_args(config_data)\n # Check that the first two arguments are the council and url.\n assert args[0] == \"Test Council\"\n assert args[1] == \"http://example.com\"\n # The custom_arg should be included, but skip_get_url should not.\n args_str = \" \".join(args)\n assert \"--custom_arg=value\" in args_str\n assert \"skip_get_url\" not in args_str\n\n\n# --- Test HouseholdBinCoordinator update ---\n@pytest.mark.asyncio\nasync def test_household_bin_coordinator_update(hass):\n # Create a dummy app whose run method returns valid JSON.\n dummy_app = DummyUKBinCollectionApp()\n coordinator = HouseholdBinCoordinator(\n hass, dummy_app, name=\"Test Bin\", timeout=1, update_interval=timedelta(hours=1)\n )\n # Test the _async_update_data method.\n data = await coordinator._async_update_data()\n # Expect the data to be a dict with at least one bin type.\n assert isinstance(data, dict)\n assert \"waste\" in data or \"recycling\" in data\n\n\ndef test_process_bin_data_valid():\n # Test process_bin_data with valid bin data.\n now_str = datetime.now().strftime(\"%d/%m/%Y\")\n data = {\n \"bins\": [\n {\"type\": \"waste\", \"collectionDate\": now_str},\n {\"type\": \"recycling\", \"collectionDate\": now_str},\n ]\n }\n processed = HouseholdBinCoordinator.process_bin_data(data)\n # Both bins should be in the processed output.\n assert \"waste\" in processed\n assert \"recycling\" in processed\n\n\ndef test_process_bin_data_invalid():\n # Test process_bin_data with missing keys and malformed date.\n data = {\n \"bins\": [\n {\"type\": None, \"collectionDate\": \"bad_date\"},\n {\"collectionDate\": \"01/01/2025\"},\n ]\n }\n processed = HouseholdBinCoordinator.process_bin_data(data)\n # Should be empty because data was invalid.\n assert processed == {}\n" }, { "path": "custom_components/uk_bin_collection/tests/test_sensor.py", "content": "import asyncio\nimport json\nimport logging\nfrom datetime import date, datetime, timedelta\nfrom json import JSONDecodeError\nfrom unittest.mock import AsyncMock, MagicMock, patch, Mock\n\nimport pytest\nfrom freezegun import freeze_time\nfrom homeassistant.config_entries import ConfigEntryState\nfrom homeassistant.exceptions import ConfigEntryNotReady\nfrom homeassistant.helpers.update_coordinator import UpdateFailed\nfrom homeassistant.util import dt as dt_util\nfrom homeassistant.core import ServiceCall\nfrom custom_components.uk_bin_collection import (\n async_setup_entry as async_setup_entry_domain,\n)\nfrom custom_components.uk_bin_collection.sensor import (\n async_setup_entry as async_setup_entry_sensor,\n)\n\nfrom custom_components.uk_bin_collection.const import (\n DOMAIN,\n LOG_PREFIX,\n STATE_ATTR_COLOUR,\n STATE_ATTR_NEXT_COLLECTION,\n STATE_ATTR_DAYS,\n)\nfrom custom_components.uk_bin_collection.sensor import (\n UKBinCollectionAttributeSensor,\n UKBinCollectionDataSensor,\n UKBinCollectionRawJSONSensor,\n create_sensor_entities,\n load_icon_color_mapping,\n)\n\nfrom custom_components.uk_bin_collection import HouseholdBinCoordinator\n\nlogging.basicConfig(level=logging.DEBUG)\n\nfrom .common_utils import MockConfigEntry\n\npytest_plugins = [\"freezegun\"]\n\n# Mock Data\nMOCK_BIN_COLLECTION_DATA = {\n \"bins\": [\n {\"type\": \"General Waste\", \"collectionDate\": \"15/10/2023\"},\n {\"type\": \"Recycling\", \"collectionDate\": \"16/10/2023\"},\n {\"type\": \"Garden Waste\", \"collectionDate\": \"17/10/2023\"},\n ]\n}\n\nMOCK_PROCESSED_DATA = {\n \"General Waste\": datetime.strptime(\"15/10/2023\", \"%d/%m/%Y\").date(),\n \"Recycling\": datetime.strptime(\"16/10/2023\", \"%d/%m/%Y\").date(),\n \"Garden Waste\": datetime.strptime(\"17/10/2023\", \"%d/%m/%Y\").date(),\n}\n\n\n@pytest.fixture\ndef mock_config_entry():\n \"\"\"Create a mock ConfigEntry.\"\"\"\n return MockConfigEntry(\n domain=DOMAIN,\n title=\"Test Entry\",\n data={\n \"name\": \"Test Name\",\n \"council\": \"Test Council\",\n \"url\": \"https://example.com\",\n \"timeout\": 60,\n \"icon_color_mapping\": {},\n },\n entry_id=\"test\",\n unique_id=\"test_unique_id\",\n )\n\n\n# Tests\ndef test_process_bin_data(freezer):\n \"\"\"Test processing of bin collection data.\"\"\"\n freezer.move_to(\"2023-10-14\")\n processed_data = HouseholdBinCoordinator.process_bin_data(MOCK_BIN_COLLECTION_DATA)\n # Convert dates to strings for comparison\n processed_data_str = {k: v.strftime(\"%Y-%m-%d\") for k, v in processed_data.items()}\n expected_data_str = {\n k: v.strftime(\"%Y-%m-%d\") for k, v in MOCK_PROCESSED_DATA.items()\n }\n assert processed_data_str == expected_data_str\n\n\ndef test_process_bin_data_empty():\n \"\"\"Test processing when data is empty.\"\"\"\n processed_data = HouseholdBinCoordinator.process_bin_data({\"bins\": []})\n assert processed_data == {}\n\n\ndef test_process_bin_data_past_dates(freezer):\n \"\"\"Test processing when all dates are in the past.\"\"\"\n freezer.move_to(\"2023-10-14\")\n past_date = (datetime(2023, 10, 14) - timedelta(days=1)).strftime(\"%d/%m/%Y\")\n data = {\n \"bins\": [\n {\"type\": \"General Waste\", \"collectionDate\": past_date},\n ]\n }\n processed_data = HouseholdBinCoordinator.process_bin_data(data)\n assert processed_data == {} # No future dates\n\n\ndef test_process_bin_data_duplicate_bin_types(freezer):\n \"\"\"Test processing when duplicate bin types are present.\"\"\"\n freezer.move_to(\"2023-10-14\")\n data = {\n \"bins\": [\n {\"type\": \"General Waste\", \"collectionDate\": \"15/10/2023\"},\n {\"type\": \"General Waste\", \"collectionDate\": \"16/10/2023\"}, # Later date\n ]\n }\n expected = {\n \"General Waste\": date(2023, 10, 15), # Should take the earliest future date\n }\n processed_data = HouseholdBinCoordinator.process_bin_data(data)\n assert processed_data == expected\n\n\ndef test_unique_id_uniqueness():\n \"\"\"Test that each sensor has a unique ID.\"\"\"\n coordinator = MagicMock()\n coordinator.name = \"Test Name\"\n coordinator.data = MOCK_PROCESSED_DATA\n\n sensor1 = UKBinCollectionDataSensor(\n coordinator, \"General Waste\", \"test_general_waste\", {}\n )\n sensor2 = UKBinCollectionDataSensor(coordinator, \"Recycling\", \"test_recycling\", {})\n\n assert sensor1.unique_id == \"test_general_waste\"\n assert sensor2.unique_id == \"test_recycling\"\n assert sensor1.unique_id != sensor2.unique_id\n\n\n@pytest.mark.asyncio\n@freeze_time(\"2023-10-14\")\nasync def test_async_setup_entry(hass, mock_config_entry):\n \"\"\"Test setting up the sensor platform directly.\"\"\"\n # 1) We need to fake the coordinator in hass.data\n hass.data = {}\n hass.data.setdefault(DOMAIN, {})\n\n # Create a mock coordinator (or real if you like)\n mock_coordinator = MagicMock()\n # Store it under the entry_id as normal domain code would do\n hass.data[DOMAIN][mock_config_entry.entry_id] = {\"coordinator\": mock_coordinator}\n\n # 2) Prepare a mock to track added entities\n async_add_entities = Mock()\n\n # 3) Patch sensor’s UKBinCollectionApp calls if needed\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = json.dumps({\"bins\": []})\n\n with patch.object(\n hass,\n \"async_add_executor_job\",\n new_callable=AsyncMock,\n return_value=mock_app_instance.run.return_value,\n ):\n # 4) Now call the sensor setup function\n await async_setup_entry_sensor(hass, mock_config_entry, async_add_entities)\n\n # 5) Assert that sensor got set up\n assert async_add_entities.call_count == 1\n # ... any other assertions you want\n\n\n@freeze_time(\"2023-10-14\")\n@pytest.mark.asyncio\nasync def test_coordinator_fetch(hass):\n \"\"\"Test the data fetch by the coordinator.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = json.dumps(MOCK_BIN_COLLECTION_DATA)\n\n with patch.object(\n hass,\n \"async_add_executor_job\",\n new_callable=AsyncMock,\n return_value=mock_app_instance.run.return_value,\n ):\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n await coordinator.async_refresh()\n\n assert (\n coordinator.data == MOCK_PROCESSED_DATA\n ), \"Coordinator data does not match expected values.\"\n assert (\n coordinator.last_update_success is True\n ), \"Coordinator update was not successful.\"\n\n\n@pytest.mark.asyncio\nasync def test_bin_sensor(hass, mock_config_entry):\n \"\"\"Test the main bin sensor.\"\"\"\n from freezegun import freeze_time\n\n hass.data = {}\n\n with freeze_time(\"2023-10-14\"):\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = json.dumps(MOCK_BIN_COLLECTION_DATA)\n\n with patch.object(\n hass,\n \"async_add_executor_job\",\n return_value=mock_app_instance.run.return_value,\n ):\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n await coordinator.async_config_entry_first_refresh()\n\n sensor = UKBinCollectionDataSensor(\n coordinator, \"General Waste\", \"test_general_waste\", {}\n )\n\n assert sensor.name == \"Test Name General Waste\"\n assert sensor.unique_id == \"test_general_waste\"\n assert sensor.state == \"Tomorrow\"\n assert sensor.icon == \"mdi:trash-can\"\n assert sensor.extra_state_attributes == {\n \"colour\": \"black\",\n \"next_collection\": \"15/10/2023\",\n \"days\": 1,\n }\n\n\n@freeze_time(\"2023-10-14\")\n@pytest.mark.asyncio\nasync def test_raw_json_sensor(hass, mock_config_entry):\n \"\"\"Test the raw JSON sensor.\"\"\"\n hass.data = {}\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = json.dumps(MOCK_BIN_COLLECTION_DATA)\n\n with patch.object(\n hass,\n \"async_add_executor_job\",\n new_callable=AsyncMock,\n return_value=mock_app_instance.run.return_value,\n ):\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n await coordinator.async_refresh()\n\n sensor = UKBinCollectionRawJSONSensor(coordinator, \"test_raw_json\", \"Test Name\")\n\n expected_state = json.dumps(\n {k: v.strftime(\"%d/%m/%Y\") for k, v in MOCK_PROCESSED_DATA.items()}\n )\n\n assert sensor.name == \"Test Name Raw JSON\"\n assert sensor.unique_id == \"test_raw_json\"\n assert sensor.state == expected_state\n assert sensor.extra_state_attributes == {\"raw_data\": MOCK_PROCESSED_DATA}\n\n\n@pytest.mark.asyncio\nasync def test_bin_sensor_custom_icon_color(hass, mock_config_entry):\n \"\"\"Test bin sensor with custom icon and color.\"\"\"\n icon_color_mapping = {\"General Waste\": {\"icon\": \"mdi:delete\", \"color\": \"green\"}}\n\n # Initialize hass.data\n hass.data = {}\n\n # Patch UKBinCollectionApp\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n # Mock run method to return JSON data for testing\n mock_app_instance.run.return_value = json.dumps(MOCK_BIN_COLLECTION_DATA)\n\n # Mock async_add_executor_job correctly\n with patch.object(\n hass,\n \"async_add_executor_job\",\n new=AsyncMock(return_value=mock_app_instance.run.return_value),\n ):\n # Create the coordinator\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n # Perform the first refresh\n await coordinator.async_config_entry_first_refresh()\n\n # Create a bin sensor with custom icon and color mapping\n sensor = UKBinCollectionDataSensor(\n coordinator, \"General Waste\", \"test_general_waste\", icon_color_mapping\n )\n\n # Access properties\n assert sensor.icon == \"mdi:delete\"\n assert sensor.extra_state_attributes[\"colour\"] == \"green\"\n\n\n@pytest.mark.asyncio\nasync def test_bin_sensor_today_collection(hass, freezer, mock_config_entry):\n \"\"\"Test bin sensor when collection is today.\"\"\"\n freezer.move_to(\"2023-10-14\")\n today_date = dt_util.now().strftime(\"%d/%m/%Y\")\n data = {\n \"bins\": [\n {\"type\": \"General Waste\", \"collectionDate\": today_date},\n ]\n }\n\n # Initialize hass.data\n hass.data = {}\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n # Mock run method to return JSON data for testing\n mock_app_instance.run.return_value = json.dumps(data)\n\n # Mock async_add_executor_job correctly\n with patch.object(\n hass,\n \"async_add_executor_job\",\n new=AsyncMock(return_value=mock_app_instance.run.return_value),\n ):\n # Create the coordinator\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n # Perform the first refresh\n await coordinator.async_config_entry_first_refresh()\n\n # Create a bin sensor\n sensor = UKBinCollectionDataSensor(\n coordinator, \"General Waste\", \"test_general_waste\", {}\n )\n\n # Access properties\n assert sensor.state == \"Today\"\n\n\n@pytest.mark.asyncio\nasync def test_bin_sensor_tomorrow_collection(hass, freezer, mock_config_entry):\n \"\"\"Test bin sensor when collection is tomorrow.\"\"\"\n freezer.move_to(\"2023-10-14\")\n tomorrow_date = (dt_util.now() + timedelta(days=1)).strftime(\"%d/%m/%Y\")\n data = {\n \"bins\": [\n {\"type\": \"General Waste\", \"collectionDate\": tomorrow_date},\n ]\n }\n\n # Initialize hass.data\n hass.data = {}\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n # Mock run method to return JSON data for testing\n mock_app_instance.run.return_value = json.dumps(data)\n\n # Mock async_add_executor_job correctly\n with patch.object(\n hass,\n \"async_add_executor_job\",\n new=AsyncMock(return_value=mock_app_instance.run.return_value),\n ):\n # Create the coordinator\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n # Perform the first refresh\n await coordinator.async_config_entry_first_refresh()\n\n # Create a bin sensor\n sensor = UKBinCollectionDataSensor(\n coordinator, \"General Waste\", \"test_general_waste\", {}\n )\n\n # Access properties\n assert sensor.state == \"Tomorrow\"\n\n\n@pytest.mark.asyncio\nasync def test_bin_sensor_partial_custom_icon_color(hass, mock_config_entry):\n \"\"\"Test bin sensor with partial custom icon and color mappings.\"\"\"\n icon_color_mapping = {\"General Waste\": {\"icon\": \"mdi:delete\", \"color\": \"green\"}}\n\n # Modify json.dumps(MOCK_BIN_COLLECTION_DATA) to include another bin type without custom mapping\n custom_data = {\n \"bins\": [\n {\"type\": \"General Waste\", \"collectionDate\": \"15/10/2023\"},\n {\"type\": \"Recycling\", \"collectionDate\": \"16/10/2023\"},\n ]\n }\n\n # Initialize hass.data\n hass.data = {}\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = json.dumps(custom_data)\n\n # Mock async_add_executor_job correctly\n with patch.object(\n hass,\n \"async_add_executor_job\",\n new=AsyncMock(return_value=mock_app_instance.run.return_value),\n ):\n # Create the coordinator\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n # Perform the first refresh\n await coordinator.async_config_entry_first_refresh()\n\n # Create sensors for both bin types\n sensor_general = UKBinCollectionDataSensor(\n coordinator, \"General Waste\", \"test_general_waste\", icon_color_mapping\n )\n sensor_recycling = UKBinCollectionDataSensor(\n coordinator, \"Recycling\", \"test_recycling\", icon_color_mapping\n )\n\n # Check custom mapping for General Waste\n assert sensor_general.icon == \"mdi:delete\"\n assert sensor_general.extra_state_attributes[\"colour\"] == \"green\"\n\n # Check default mapping for Recycling\n assert sensor_recycling.icon == \"mdi:recycle\"\n assert sensor_recycling.extra_state_attributes[\"colour\"] == \"black\"\n\n\ndef test_unique_id_uniqueness(hass, mock_config_entry):\n \"\"\"Test that each sensor has a unique ID.\"\"\"\n coordinator = MagicMock()\n coordinator.name = \"Test Name\"\n coordinator.data = MOCK_PROCESSED_DATA\n\n sensor1 = UKBinCollectionDataSensor(\n coordinator, \"General Waste\", \"test_general_waste\", {}\n )\n sensor2 = UKBinCollectionDataSensor(coordinator, \"Recycling\", \"test_recycling\", {})\n\n assert sensor1.unique_id == \"test_general_waste\"\n assert sensor2.unique_id == \"test_recycling\"\n assert sensor1.unique_id != sensor2.unique_id\n\n\n@pytest.fixture\ndef mock_dt_now_different_timezone():\n \"\"\"Mock datetime.now with a different timezone.\"\"\"\n with patch(\n \"homeassistant.util.dt.now\",\n return_value=datetime(2023, 10, 14, 12, 0, tzinfo=dt_util.UTC),\n ):\n yield\n\n\nasync def test_raw_json_sensor_invalid_data(hass, mock_config_entry):\n \"\"\"Test raw JSON sensor with invalid data.\"\"\"\n invalid_data = \"Invalid JSON String\"\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = invalid_data # Not a valid JSON\n\n from custom_components.uk_bin_collection.sensor import HouseholdBinCoordinator\n\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n # Attempt to refresh coordinator, which should NOT raise UpdateFailed\n await coordinator.async_refresh()\n\n # Verify that last_update_success is False\n assert coordinator.last_update_success is False\n\n # Create the raw JSON sensor\n sensor = UKBinCollectionRawJSONSensor(coordinator, \"test_raw_json\", \"Test Name\")\n\n # Since data fetch failed, sensor.state should reflect the failure\n assert sensor.state == json.dumps({})\n assert sensor.extra_state_attributes == {\"raw_data\": {}}\n assert sensor.available is False\n\n\ndef test_sensor_device_info(hass, mock_config_entry):\n \"\"\"Test that sensors report correct device information.\"\"\"\n coordinator = MagicMock()\n coordinator.name = \"Test Name\"\n coordinator.data = MOCK_PROCESSED_DATA\n\n sensor = UKBinCollectionDataSensor(\n coordinator, \"General Waste\", \"test_general_waste\", {}\n )\n\n expected_device_info = {\n \"identifiers\": {(DOMAIN, \"test_general_waste\")},\n \"name\": \"Test Name General Waste\",\n \"manufacturer\": \"UK Bin Collection\",\n \"model\": \"Bin Sensor\",\n \"sw_version\": \"1.0\",\n }\n assert sensor.device_info == expected_device_info\n\n\ndef process_bin_data_duplicate_bin_types(freezer):\n \"\"\"Test processing when duplicate bin types are present.\"\"\"\n freezer.move_to(\"2023-10-14\")\n data = {\n \"bins\": [\n {\"type\": \"General Waste\", \"collectionDate\": \"15/10/2023\"},\n {\"type\": \"General Waste\", \"collectionDate\": \"16/10/2023\"}, # Later date\n ]\n }\n expected = {\n \"General Waste\": \"15/10/2023\", # Should take the earliest future date\n }\n processed_data = HouseholdBinCoordinator.process_bin_data(data)\n assert processed_data == expected\n\n\n@pytest.mark.asyncio\nasync def test_coordinator_timeout_error(hass, mock_config_entry):\n \"\"\"Test coordinator handles timeout errors correctly.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n # Simulate run raising TimeoutError\n mock_app_instance.run.side_effect = asyncio.TimeoutError(\"Request timed out\")\n\n # Mock async_add_executor_job to raise TimeoutError\n hass.async_add_executor_job = AsyncMock(\n side_effect=mock_app_instance.run.side_effect\n )\n\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=1\n )\n\n # Expect ConfigEntryNotReady instead of UpdateFailed\n with pytest.raises(ConfigEntryNotReady) as exc_info:\n await coordinator.async_config_entry_first_refresh()\n\n assert \"Timeout while updating data\" in str(exc_info.value)\n\n\n@pytest.mark.asyncio\nasync def test_coordinator_json_decode_error(hass, mock_config_entry):\n \"\"\"Test coordinator handles JSON decode errors correctly.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n # Simulate run returning invalid JSON\n mock_app_instance.run.return_value = \"Invalid JSON String\"\n\n # Mock async_add_executor_job to raise JSONDecodeError\n def side_effect(*args, **kwargs):\n raise JSONDecodeError(\"Expecting value\", \"Invalid JSON String\", 0)\n\n hass.async_add_executor_job = AsyncMock(side_effect=side_effect)\n\n # Initialize hass.data\n hass.data = {}\n\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n # Expect ConfigEntryNotReady instead of UpdateFailed\n with pytest.raises(ConfigEntryNotReady) as exc_info:\n await coordinator.async_config_entry_first_refresh()\n\n assert \"JSON decode error\" in str(exc_info.value)\n\n\n@pytest.mark.asyncio\nasync def test_coordinator_general_exception(hass, mock_config_entry):\n \"\"\"Test coordinator handles general exceptions correctly.\"\"\"\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n # Simulate run raising a general exception\n mock_app_instance.run.side_effect = Exception(\"General error\")\n\n # Mock async_add_executor_job to raise the exception\n hass.async_add_executor_job = AsyncMock(\n side_effect=mock_app_instance.run.side_effect\n )\n\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n # Expect ConfigEntryNotReady instead of UpdateFailed\n with pytest.raises(ConfigEntryNotReady) as exc_info:\n await coordinator.async_config_entry_first_refresh()\n\n assert \"Unexpected error\" in str(exc_info.value)\n\n\ndef process_bin_data_duplicate_bin_types(freezer):\n \"\"\"Test processing when duplicate bin types are present with different dates.\"\"\"\n freezer.move_to(\"2023-10-14\")\n data = {\n \"bins\": [\n {\"type\": \"General Waste\", \"collectionDate\": \"15/10/2023\"},\n {\"type\": \"General Waste\", \"collectionDate\": \"14/10/2023\"}, # Earlier date\n ]\n }\n expected = {\n \"General Waste\": \"14/10/2023\", # Should take the earliest future date\n }\n processed_data = HouseholdBinCoordinator.process_bin_data(data)\n assert processed_data == expected\n\n\ndef process_bin_data_past_dates(freezer):\n \"\"\"Test processing when all dates are in the past.\"\"\"\n freezer.move_to(\"2023-10-14\")\n past_date = (dt_util.now() - timedelta(days=1)).strftime(\"%d/%m/%Y\")\n data = {\n \"bins\": [\n {\"type\": \"General Waste\", \"collectionDate\": past_date},\n {\"type\": \"Recycling\", \"collectionDate\": past_date},\n ]\n }\n processed_data = HouseholdBinCoordinator.process_bin_data(data)\n assert processed_data == {} # No future dates should be included\n\n\ndef process_bin_data_missing_fields(freezer):\n \"\"\"Test processing when some bins are missing required fields.\"\"\"\n freezer.move_to(\"2023-10-14\")\n data = {\n \"bins\": [\n {\"type\": \"General Waste\", \"collectionDate\": \"15/10/2023\"},\n {\"collectionDate\": \"16/10/2023\"}, # Missing 'type'\n {\"type\": \"Recycling\"}, # Missing 'collectionDate'\n ]\n }\n expected = {\n \"General Waste\": \"15/10/2023\",\n }\n processed_data = HouseholdBinCoordinator.process_bin_data(data)\n assert processed_data == expected\n\n\ndef process_bin_data_invalid_date_format(freezer):\n \"\"\"Test processing when bins have invalid date formats.\"\"\"\n freezer.move_to(\"2023-10-14\")\n data = {\n \"bins\": [\n {\n \"type\": \"General Waste\",\n \"collectionDate\": \"2023-10-15\",\n }, # Incorrect format\n {\"type\": \"Recycling\", \"collectionDate\": \"16/13/2023\"}, # Invalid month\n ]\n }\n processed_data = HouseholdBinCoordinator.process_bin_data(data)\n assert processed_data == {} # Both entries should be skipped due to invalid dates\n\n\n@pytest.mark.asyncio\nasync def test_bin_sensor_state_today(hass, mock_config_entry, freezer):\n \"\"\"Test bin sensor when collection is today.\"\"\"\n freezer.move_to(\"2023-10-14\")\n today_date = dt_util.now().strftime(\"%d/%m/%Y\")\n data = {\n \"bins\": [\n {\"type\": \"General Waste\", \"collectionDate\": today_date},\n ]\n }\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = json.dumps(data)\n\n # Mock async_add_executor_job to return the run method's return value\n hass.async_add_executor_job = AsyncMock(\n return_value=mock_app_instance.run.return_value\n )\n\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n await coordinator.async_config_entry_first_refresh()\n\n sensor = UKBinCollectionDataSensor(\n coordinator, \"General Waste\", \"test_general_waste\", {}\n )\n\n assert sensor.state == \"Today\"\n assert sensor.available is True\n assert sensor.extra_state_attributes[\"days\"] == 0\n\n\n@pytest.mark.asyncio\nasync def test_bin_sensor_state_tomorrow(hass, mock_config_entry, freezer):\n \"\"\"Test bin sensor when collection is tomorrow.\"\"\"\n freezer.move_to(\"2023-10-14\")\n tomorrow_date = (dt_util.now() + timedelta(days=1)).strftime(\"%d/%m/%Y\")\n data = {\n \"bins\": [\n {\"type\": \"Recycling\", \"collectionDate\": tomorrow_date},\n ]\n }\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = json.dumps(data)\n\n hass.async_add_executor_job = AsyncMock(\n return_value=mock_app_instance.run.return_value\n )\n\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n await coordinator.async_config_entry_first_refresh()\n\n sensor = UKBinCollectionDataSensor(coordinator, \"Recycling\", \"test_recycling\", {})\n\n assert sensor.state == \"Tomorrow\"\n assert sensor.available is True\n assert sensor.extra_state_attributes[\"days\"] == 1\n\n\n@pytest.mark.asyncio\nasync def test_bin_sensor_state_in_days(hass, mock_config_entry, freezer):\n \"\"\"Test bin sensor when collection is in multiple days.\"\"\"\n freezer.move_to(\"2023-10-14\")\n future_date = (dt_util.now() + timedelta(days=5)).strftime(\"%d/%m/%Y\")\n data = {\n \"bins\": [\n {\"type\": \"Garden Waste\", \"collectionDate\": future_date},\n ]\n }\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = json.dumps(data)\n\n hass.async_add_executor_job = AsyncMock(\n return_value=mock_app_instance.run.return_value\n )\n\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n await coordinator.async_config_entry_first_refresh()\n\n sensor = UKBinCollectionDataSensor(\n coordinator, \"Garden Waste\", \"test_garden_waste\", {}\n )\n\n assert sensor.state == \"In 5 days\"\n assert sensor.available is True\n assert sensor.extra_state_attributes[\"days\"] == 5\n\n\n@pytest.mark.asyncio\nasync def test_bin_sensor_missing_data(hass, mock_config_entry):\n \"\"\"Test bin sensor when bin data is missing.\"\"\"\n data = {\n \"bins\": [\n # No bins provided\n ]\n }\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = json.dumps(data)\n\n hass.async_add_executor_job = AsyncMock(\n return_value=mock_app_instance.run.return_value\n )\n\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n await coordinator.async_config_entry_first_refresh()\n\n sensor = UKBinCollectionDataSensor(\n coordinator, \"Non-Existent Bin\", \"test_non_existent_bin\", {}\n )\n\n assert sensor.state == \"Unknown\"\n assert sensor.available is False\n assert sensor.extra_state_attributes[\"days\"] is None\n assert sensor.extra_state_attributes[\"next_collection\"] is None\n\n\n@freeze_time(\"2023-10-14\")\n@pytest.mark.asyncio\nasync def test_raw_json_sensor_invalid_data(hass, mock_config_entry):\n \"\"\"Test raw JSON sensor with invalid data.\"\"\"\n invalid_data = \"Invalid JSON String\"\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = invalid_data\n\n def side_effect(*args, **kwargs):\n raise JSONDecodeError(\"Expecting value\", invalid_data, 0)\n\n with patch.object(hass, \"async_add_executor_job\", side_effect=side_effect):\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n await coordinator.async_refresh()\n\n assert not coordinator.last_update_success\n\n raw_json_sensor = UKBinCollectionRawJSONSensor(\n coordinator, \"test_raw_json\", \"Test Name\"\n )\n\n assert raw_json_sensor.state == \"{}\"\n assert raw_json_sensor.extra_state_attributes[\"raw_data\"] == {}\n assert raw_json_sensor.available is False\n\n\n@pytest.mark.asyncio\nasync def test_sensor_available_property(hass, mock_config_entry):\n \"\"\"Test that sensor's available property reflects its state.\"\"\"\n # Case 1: State is a valid string\n data_valid = {\n \"bins\": [\n {\"type\": \"Recycling\", \"collectionDate\": \"16/10/2023\"},\n ]\n }\n processed_data_valid = {\n \"Recycling\": datetime.strptime(\"16/10/2023\", \"%d/%m/%Y\").date(),\n }\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app_valid:\n mock_app_valid_instance = mock_app_valid.return_value\n mock_app_valid_instance.run.return_value = json.dumps(data_valid)\n\n with patch.object(\n hass,\n \"async_add_executor_job\",\n return_value=mock_app_valid_instance.run.return_value,\n ):\n coordinator_valid = HouseholdBinCoordinator(\n hass, mock_app_valid_instance, \"Test Name\", timeout=60\n )\n\n await coordinator_valid.async_refresh()\n\n sensor_valid = UKBinCollectionDataSensor(\n coordinator_valid, \"Recycling\", \"test_recycling_available\", {}\n )\n\n assert sensor_valid.available is True\n\n # Case 2: State is \"Unknown\"\n data_unknown = {\"bins\": []}\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app_unknown:\n mock_app_unknown_instance = mock_app_unknown.return_value\n mock_app_unknown_instance.run.return_value = json.dumps(data_unknown)\n\n with patch.object(\n hass,\n \"async_add_executor_job\",\n return_value=mock_app_unknown_instance.run.return_value,\n ):\n coordinator_unknown = HouseholdBinCoordinator(\n hass, mock_app_unknown_instance, \"Test Name\", timeout=60\n )\n\n await coordinator_unknown.async_refresh()\n\n sensor_unknown = UKBinCollectionDataSensor(\n coordinator_unknown, \"Garden Waste\", \"test_garden_waste_unavailable\", {}\n )\n\n assert sensor_unknown.available is False\n\n\n@pytest.mark.asyncio\nasync def test_data_sensor_missing_icon_or_color(hass, mock_config_entry):\n \"\"\"Test data sensor uses default icon and color when mappings are missing.\"\"\"\n icon_color_mapping = {\n \"General Waste\": {\"icon\": \"mdi:trash-can\"}, # Missing 'color'\n \"Recycling\": {\"color\": \"green\"}, # Missing 'icon'\n \"Garden Waste\": {}, # Missing both\n }\n\n data = {\n \"bins\": [\n {\"type\": \"General Waste\", \"collectionDate\": \"15/10/2023\"},\n {\"type\": \"Recycling\", \"collectionDate\": \"16/10/2023\"},\n {\"type\": \"Garden Waste\", \"collectionDate\": \"17/10/2023\"},\n ]\n }\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = json.dumps(data)\n\n hass.async_add_executor_job = AsyncMock(\n return_value=mock_app_instance.run.return_value\n )\n\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n await coordinator.async_config_entry_first_refresh()\n\n # Test General Waste sensor (missing 'color')\n general_waste_sensor = UKBinCollectionDataSensor(\n coordinator, \"General Waste\", \"test_general_waste\", icon_color_mapping\n )\n # Simulate coordinator update\n coordinator.async_set_updated_data(coordinator.data)\n\n assert general_waste_sensor.icon == \"mdi:trash-can\"\n assert general_waste_sensor._color == \"black\" # Default color\n\n # Test Recycling sensor (missing 'icon')\n recycling_sensor = UKBinCollectionDataSensor(\n coordinator, \"Recycling\", \"test_recycling\", icon_color_mapping\n )\n coordinator.async_set_updated_data(coordinator.data)\n\n assert recycling_sensor.icon == \"mdi:recycle\" # Default icon based on bin type\n assert recycling_sensor._color == \"green\"\n\n # Test Garden Waste sensor (missing both)\n garden_waste_sensor = UKBinCollectionDataSensor(\n coordinator, \"Garden Waste\", \"test_garden_waste\", icon_color_mapping\n )\n coordinator.async_set_updated_data(coordinator.data)\n\n assert garden_waste_sensor.icon == \"mdi:trash-can\" # Default icon based on bin type\n assert garden_waste_sensor._color == \"black\"\n\n\n@pytest.mark.asyncio\nasync def test_attribute_sensor_with_complete_mappings(hass, mock_config_entry):\n \"\"\"Test attribute sensor correctly applies icon and color from mappings.\"\"\"\n icon_color_mapping = {\"General Waste\": {\"icon\": \"mdi:trash-can\", \"color\": \"grey\"}}\n data = {\n \"bins\": [\n {\"type\": \"General Waste\", \"collectionDate\": \"15/10/2023\"},\n ]\n }\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = json.dumps(data)\n\n # Mock async_add_executor_job to return valid JSON\n hass.async_add_executor_job = AsyncMock(\n return_value=mock_app_instance.run.return_value\n )\n\n # Initialize hass.data\n hass.data = {}\n\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n await coordinator.async_config_entry_first_refresh()\n\n # Test Colour attribute sensor\n colour_sensor = UKBinCollectionAttributeSensor(\n coordinator,\n \"General Waste\",\n \"test_general_waste_colour\",\n \"Colour\",\n \"test_general_waste\",\n icon_color_mapping,\n )\n\n # Simulate coordinator update\n coordinator.async_set_updated_data(coordinator.data)\n\n assert colour_sensor.state == \"grey\"\n assert colour_sensor.icon == \"mdi:trash-can\"\n assert colour_sensor._color == \"grey\"\n\n\n@pytest.mark.asyncio\nasync def test_data_sensor_color_property_missing_or_none(hass, mock_config_entry):\n \"\"\"Test sensor's color property when color is missing or None.\"\"\"\n # Case 1: Missing color in icon_color_mapping\n icon_color_mapping_missing_color = {\n \"General Waste\": {\"icon\": \"mdi:trash-can\"},\n }\n data = {\n \"bins\": [\n {\"type\": \"General Waste\", \"collectionDate\": \"15/10/2023\"},\n ]\n }\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app_missing_color:\n mock_app_missing_color_instance = mock_app_missing_color.return_value\n mock_app_missing_color_instance.run.return_value = json.dumps(data)\n\n hass.async_add_executor_job = AsyncMock(\n return_value=mock_app_missing_color_instance.run.return_value\n )\n\n coordinator = HouseholdBinCoordinator(\n hass,\n mock_app_missing_color_instance,\n \"Test Name\",\n timeout=60,\n )\n\n await coordinator.async_config_entry_first_refresh()\n\n sensor_missing_color = UKBinCollectionDataSensor(\n coordinator,\n \"General Waste\",\n \"test_general_waste_missing_color\",\n icon_color_mapping_missing_color,\n )\n # Simulate coordinator update\n coordinator.async_set_updated_data(coordinator.data)\n\n assert sensor_missing_color._color == \"black\" # Default color\n\n # Case 2: Color is None\n icon_color_mapping_none_color = {\n \"Recycling\": {\"icon\": \"mdi:recycle\", \"color\": None},\n }\n\n data_none_color = {\n \"bins\": [\n {\"type\": \"Recycling\", \"collectionDate\": \"16/10/2023\"},\n ]\n }\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app_none_color:\n mock_app_none_color_instance = mock_app_none_color.return_value\n mock_app_none_color_instance.run.return_value = json.dumps(data_none_color)\n\n hass.async_add_executor_job = AsyncMock(\n return_value=mock_app_none_color_instance.run.return_value\n )\n\n coordinator_none_color = HouseholdBinCoordinator(\n hass,\n mock_app_none_color_instance,\n \"Test Name\",\n timeout=60,\n )\n\n await coordinator_none_color.async_config_entry_first_refresh()\n\n sensor_none_color = UKBinCollectionDataSensor(\n coordinator_none_color,\n \"Recycling\",\n \"test_recycling_none_color\",\n icon_color_mapping_none_color,\n )\n # Simulate coordinator update\n coordinator_none_color.async_set_updated_data(coordinator_none_color.data)\n\n assert (\n sensor_none_color._color == \"black\"\n ) # Should default to \"black\" if color is None\n\n\n@freeze_time(\"2023-10-14\")\n@pytest.mark.asyncio\nasync def test_sensor_available_property(hass, mock_config_entry):\n \"\"\"Test that sensor's available property reflects its state.\"\"\"\n # Case 1: State is a valid string\n data_valid = {\n \"bins\": [\n {\"type\": \"Recycling\", \"collectionDate\": \"16/10/2023\"},\n ]\n }\n processed_data_valid = {\n \"Recycling\": datetime.strptime(\"16/10/2023\", \"%d/%m/%Y\").date(),\n }\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app_valid:\n mock_app_valid_instance = mock_app_valid.return_value\n mock_app_valid_instance.run.return_value = json.dumps(data_valid)\n\n async def mock_async_add_executor_job(func, *args, **kwargs):\n return func(*args, **kwargs)\n\n with patch.object(\n hass,\n \"async_add_executor_job\",\n side_effect=mock_async_add_executor_job,\n ):\n coordinator_valid = HouseholdBinCoordinator(\n hass, mock_app_valid_instance, \"Test Name\", timeout=60\n )\n\n await coordinator_valid.async_refresh()\n\n # Verify that coordinator.data contains the expected processed data\n assert coordinator_valid.data == processed_data_valid\n\n sensor_valid = UKBinCollectionDataSensor(\n coordinator_valid, \"Recycling\", \"test_recycling_available\", {}\n )\n\n assert sensor_valid.available is True\n\n\n@pytest.mark.asyncio\nasync def test_coordinator_empty_data(hass, mock_config_entry):\n \"\"\"Test coordinator handles empty data correctly.\"\"\"\n empty_data = {\"bins\": []}\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = json.dumps(empty_data)\n\n hass.async_add_executor_job = AsyncMock(\n return_value=mock_app_instance.run.return_value\n )\n\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n await coordinator.async_config_entry_first_refresh()\n\n assert coordinator.data == {}\n assert coordinator.last_update_success is True\n\n\ndef test_coordinator_custom_update_interval(hass, mock_config_entry):\n \"\"\"Test that coordinator uses a custom update interval.\"\"\"\n custom_interval = timedelta(hours=6)\n coordinator = HouseholdBinCoordinator(hass, MagicMock(), \"Test Name\", timeout=60)\n coordinator.update_interval = custom_interval\n\n assert coordinator.update_interval == custom_interval\n\n\n@pytest.mark.asyncio\nasync def test_async_setup_entry_missing_required_fields(hass):\n \"\"\"Test domain-level setup fails if 'name' is missing.\"\"\"\n mock_config_entry = MockConfigEntry(\n domain=DOMAIN,\n data={\n # no \"name\"\n \"council\": \"Test Council\",\n \"url\": \"https://example.com\",\n \"timeout\": 60,\n \"icon_color_mapping\": {},\n },\n entry_id=\"test_missing_name\",\n )\n\n with patch(\"custom_components.uk_bin_collection.UKBinCollectionApp\") as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = \"{}\"\n hass.async_add_executor_job = AsyncMock(return_value=\"{}\")\n\n with pytest.raises(ConfigEntryNotReady) as exc_info:\n # Call the domain-level function\n await async_setup_entry_domain(hass, mock_config_entry)\n\n assert \"Missing 'name' in configuration.\" in str(exc_info.value)\n\n\n@pytest.mark.asyncio\nasync def test_data_sensor_device_info(hass, mock_config_entry):\n \"\"\"Test that data sensor reports correct device information.\"\"\"\n data = {\n \"bins\": [\n {\"type\": \"General Waste\", \"collectionDate\": \"15/10/2023\"},\n ]\n }\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = json.dumps(data)\n\n icon_color_mapping = {}\n\n hass.async_add_executor_job = AsyncMock(\n return_value=mock_app_instance.run.return_value\n )\n\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n await coordinator.async_config_entry_first_refresh()\n\n sensor = UKBinCollectionDataSensor(\n coordinator,\n \"General Waste\",\n \"test_general_waste_device_info\",\n icon_color_mapping,\n )\n\n expected_device_info = {\n \"identifiers\": {(DOMAIN, \"test_general_waste_device_info\")},\n \"name\": \"Test Name General Waste\",\n \"manufacturer\": \"UK Bin Collection\",\n \"model\": \"Bin Sensor\",\n \"sw_version\": \"1.0\",\n }\n assert sensor.device_info == expected_device_info\n\n\n@pytest.mark.asyncio\nasync def test_data_sensor_default_icon(hass, mock_config_entry):\n \"\"\"Test data sensor uses default icon based on bin type when no mapping is provided.\"\"\"\n data = {\n \"bins\": [\n {\"type\": \"Unknown Bin\", \"collectionDate\": \"20/10/2023\"},\n ]\n }\n\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = json.dumps(data)\n\n # No icon_color_mapping provided\n icon_color_mapping = {}\n\n hass.async_add_executor_job = AsyncMock(\n return_value=mock_app_instance.run.return_value\n )\n\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n\n await coordinator.async_config_entry_first_refresh()\n\n sensor = UKBinCollectionDataSensor(\n coordinator, \"Unknown Bin\", \"test_unknown_bin\", icon_color_mapping\n )\n\n assert sensor.icon == \"mdi:delete\"\n assert sensor._color == \"black\"\n\n\ndef test_coordinator_update_interval(hass, mock_config_entry):\n \"\"\"Test that coordinator uses the correct update interval.\"\"\"\n coordinator = HouseholdBinCoordinator(hass, MagicMock(), \"Test Name\", timeout=60)\n assert coordinator.update_interval == timedelta(hours=12)\n\n\n@pytest.mark.asyncio\nasync def test_manual_refresh_service(hass, mock_config_entry):\n \"\"\"Test that calling manual_refresh logic triggers coordinator.async_request_refresh.\"\"\"\n\n # 1) Manually set up the coordinator (just like your other sensor tests).\n hass.data = {}\n hass.data.setdefault(DOMAIN, {})\n\n # Create a coordinator\n with patch(\n \"custom_components.uk_bin_collection.sensor.UKBinCollectionApp\"\n ) as mock_app:\n mock_app_instance = mock_app.return_value\n mock_app_instance.run.return_value = json.dumps({\"bins\": []})\n\n hass.async_add_executor_job = AsyncMock(\n return_value=mock_app_instance.run.return_value\n )\n\n coordinator = HouseholdBinCoordinator(\n hass, mock_app_instance, \"Test Name\", timeout=60\n )\n await coordinator.async_config_entry_first_refresh()\n\n # Store coordinator in hass.data\n hass.data[DOMAIN][mock_config_entry.entry_id] = {\"coordinator\": coordinator}\n\n # 2) Duplicate the essence of handle_manual_refresh, but pass in a mock ServiceCall\n async def mock_handle_manual_refresh(call: ServiceCall):\n entry_id = call.data.get(\"entry_id\")\n if not entry_id:\n return\n if entry_id not in hass.data[DOMAIN]:\n return\n c = hass.data[DOMAIN][entry_id].get(\"coordinator\")\n if c:\n await c.async_request_refresh()\n\n # 3) Patch coordinator.async_request_refresh to confirm it gets called\n with patch.object(\n coordinator, \"async_request_refresh\", new_callable=AsyncMock\n ) as mock_refresh:\n # Construct a mock ServiceCall that includes the entry_id\n fake_call = ServiceCall(\n domain=DOMAIN,\n service=\"manual_refresh\",\n data={\"entry_id\": mock_config_entry.entry_id},\n )\n await mock_handle_manual_refresh(fake_call)\n\n mock_refresh.assert_awaited_once()\n\n\ndef test_load_icon_color_mapping_invalid_json():\n from custom_components.uk_bin_collection.sensor import load_icon_color_mapping\n\n invalid_json = (\n '{\"icon\":\"mdi:trash\" \"no_comma\":true}' # invalid JSON (missing comma)\n )\n with patch(\"logging.Logger.warning\") as mock_warn:\n result = load_icon_color_mapping(invalid_json)\n # The function should return {}\n assert result == {}\n # Note the double space after the prefix – adjust to match the actual log message.\n mock_warn.assert_called_once_with(\n \"[UKBinCollection] Invalid icon_color_mapping JSON: \"\n f\"{invalid_json}. Using default settings.\"\n )\n\n\n@pytest.mark.asyncio\nasync def test_bin_sensor_missing_bin_type(hass, mock_config_entry):\n \"\"\"Test that we log a warning and set state to Unknown when the bin type is missing.\"\"\"\n # Suppose your coordinator’s data only has \"Recycling\"\n data = {\"Recycling\": datetime(2025, 2, 1).date()}\n # but the sensor is for \"General Waste\"\n\n # Create the coordinator\n coordinator = MagicMock()\n coordinator.data = data\n coordinator.name = \"Test Name\"\n\n sensor = UKBinCollectionDataSensor(\n coordinator, \"General Waste\", \"test_general_waste\", {}\n )\n\n with patch(\"logging.Logger.warning\") as mock_warn:\n sensor.update_state()\n\n assert sensor.state == \"Unknown\"\n assert sensor.extra_state_attributes[\"days\"] is None\n assert sensor.available is False\n mock_warn.assert_called_once_with(\n \"[UKBinCollection] Data for bin type 'General Waste' is missing.\"\n )\n\n\n@pytest.mark.asyncio\nasync def test_attribute_sensor_undefined_attribute_type(hass, mock_config_entry):\n coordinator = MagicMock()\n coordinator.data = {\"Recycling\": datetime(2025, 1, 1).date()}\n coordinator.name = \"Test Coordinator\"\n\n sensor = UKBinCollectionAttributeSensor(\n coordinator=coordinator,\n bin_type=\"Recycling\",\n unique_id=\"test_recycling_undefined\",\n attribute_type=\"Bogus Attribute\", # Will trigger the 'Undefined' path\n device_id=\"test_device\",\n icon_color_mapping={},\n )\n\n with patch(\"logging.Logger.warning\") as mock_warn:\n state = sensor.state\n assert state == \"Undefined\"\n mock_warn.assert_called_once_with(\n \"[UKBinCollection] Undefined attribute type: Bogus Attribute\"\n )\n\n\n@pytest.mark.asyncio\nasync def test_bin_sensor_in_x_days(hass, freezer, mock_config_entry):\n freezer.move_to(\"2023-10-14\")\n # next_collection is 5 days away\n future_date = dt_util.now().date() + timedelta(days=5)\n\n coordinator = MagicMock()\n coordinator.data = {\"General Waste\": future_date}\n coordinator.name = \"Test Coordinator\"\n\n sensor = UKBinCollectionDataSensor(\n coordinator, \"General Waste\", \"test_gw_in_5_days\", {}\n )\n assert sensor.state == \"In 5 days\"\n\n\ndef test_data_sensor_default_icon_unknown_type():\n coordinator = MagicMock()\n coordinator.data = {\"Some Custom Bin\": datetime(2025, 1, 1).date()}\n coordinator.name = \"Test Name\"\n\n sensor = UKBinCollectionDataSensor(coordinator, \"Unknown Type\", \"test_unknown\", {})\n assert sensor.icon == \"mdi:delete\"\n\n\ndef test_raw_json_sensor_partial_data():\n coordinator = MagicMock()\n # Only some bins have dates, e.g., \"General Waste\" is None\n coordinator.data = {\"General Waste\": None, \"Recycling\": datetime(2025, 1, 1).date()}\n coordinator.last_update_success = True\n sensor = UKBinCollectionRawJSONSensor(coordinator, \"test_raw_json\", \"Test Name\")\n\n state = sensor.state\n # Should JSON encode the 'None' bin\n assert state == '{\"General Waste\": null, \"Recycling\": \"01/01/2025\"}'\n\n\ndef test_data_sensor_unavailable_if_unknown_state():\n coordinator = MagicMock()\n coordinator.data = {} # no bins\n coordinator.name = \"Test Coordinator\"\n\n sensor = UKBinCollectionDataSensor(coordinator, \"General Waste\", \"test_gw\", {})\n sensor.update_state() # triggers \"Unknown\"\n assert sensor.available is False\n\n\ndef test_attribute_sensor_unavailable_if_coordinator_failed():\n coordinator = MagicMock()\n coordinator.data = {\"Recycling\": datetime(2025, 1, 1).date()}\n coordinator.last_update_success = False\n coordinator.name = \"Test Coordinator\"\n\n attr_sensor = UKBinCollectionAttributeSensor(\n coordinator, \"Recycling\", \"test_attr_fail\", \"Colour\", \"device_id\", {}\n )\n assert attr_sensor.available is False\n\n\nimport pytest\nfrom unittest.mock import MagicMock\nfrom datetime import datetime\nfrom custom_components.uk_bin_collection.sensor import (\n create_sensor_entities,\n UKBinCollectionDataSensor,\n UKBinCollectionAttributeSensor,\n UKBinCollectionRawJSONSensor,\n)\n\n\n@pytest.mark.asyncio\ndef test_create_sensor_entities_coordinator_data():\n # Set up a coordinator with two bin types.\n coordinator = MagicMock()\n # For example, suppose today is 2025-02-08:\n coordinator.data = {\n \"General Waste\": date(2025, 2, 8), # Today\n \"Recycling\": date(2025, 2, 9), # Tomorrow\n }\n coordinator.name = \"Test Coordinator\"\n\n # Use a valid JSON mapping for General Waste only.\n icon_mapping_json = '{\"General Waste\":{\"icon\":\"mdi:trash-can\",\"color\":\"brown\"}}'\n entities = create_sensor_entities(coordinator, \"test_entry\", icon_mapping_json)\n\n # We expect:\n # 2 main sensors (one per bin type),\n # 2 * 5 = 10 attribute sensors,\n # 1 raw JSON sensor,\n # Total 13 entities.\n assert len(entities) == 13\n\n # Check that for \"General Waste\", the icon from the mapping is used.\n gw_sensor = next(\n e\n for e in entities\n if isinstance(e, UKBinCollectionDataSensor) and \"General Waste\" in e.name\n )\n assert gw_sensor.icon == \"mdi:trash-can\"\n # And its attribute sensors (e.g., \"Days Until Collection\") can be tested:\n gw_attr_sensor = next(\n e\n for e in entities\n if isinstance(e, UKBinCollectionAttributeSensor)\n and \"Days Until Collection\" in e.name\n )\n # Trigger the state logic (which calls calculate_days_until)\n days_until = gw_attr_sensor.state\n # In our example, if today is 2025-02-08 and collection is today for General Waste,\n # days would be 0 (or if we adjust coordinator.data, you can compare against the expected value)\n # For this test we simply check that a value is returned (or you can be more specific if you set the dates)\n assert days_until is not None\n\n # Also, verify that a raw JSON sensor exists.\n raw_sensor = next(\n e for e in entities if isinstance(e, UKBinCollectionRawJSONSensor)\n )\n # Its state should be a JSON string containing keys for each bin type.\n raw_state = json.loads(raw_sensor.state)\n assert \"General Waste\" in raw_state and \"Recycling\" in raw_state\n\n\ndef test_create_sensor_entities_invalid_icon_json():\n coordinator = MagicMock()\n coordinator.data = {\n \"General Waste\": datetime(2025, 2, 10).date(),\n }\n coordinator.name = \"Test Coordinator\"\n\n invalid_json = '{\"invalid\":true, ' # incomplete JSON\n with patch(\"logging.Logger.warning\") as mock_warn:\n entities = create_sensor_entities(coordinator, \"test_entry_id\", invalid_json)\n\n # We still get 1 main sensor + 5 attribute sensors + 1 raw sensor => 7 total\n assert len(entities) == 7\n mock_warn.assert_called_once()\n # e.g. \"... Invalid icon_color_mapping JSON: ... Using default settings.\"\n\n\n@pytest.mark.asyncio\n@freeze_time(\"2025-02-8\") # let's say \"today\" is 2025-02-8\ndef test_attribute_sensor_days_and_human_readable():\n coordinator = MagicMock()\n # Pretend \"Food Waste\" is 2 days away\n in_2_days = datetime(2025, 2, 10).date()\n coordinator.data = {\"Food Waste\": in_2_days}\n coordinator.name = \"Coordinator Name\"\n\n # Create sensors for that bin\n entities = create_sensor_entities(coordinator, \"entry_id_days\", \"{}\")\n # Find the attribute sensors for \"Days Until Collection\" & \"Next Collection Human Readable\"\n days_sensor = next(\n e\n for e in entities\n if isinstance(e, UKBinCollectionAttributeSensor)\n and \"Days Until Collection\" in e.name\n )\n human_sensor = next(\n e\n for e in entities\n if isinstance(e, UKBinCollectionAttributeSensor)\n and \"Next Collection Human Readable\" in e.name\n )\n\n # The .state property triggers the logic\n days_state = days_sensor.state\n human_state = human_sensor.state\n\n # If today is e.g. 2025-02-08, in_2_days is 2025-02-10 => that's 2 days away\n # \"Days Until Collection\" => 2\n # \"Next Collection Human Readable\" => \"In 2 days\" (assuming 2 != 1 => \"days\")\n assert days_state == 2\n assert human_state == \"In 2 days\"\n\n\ndef test_data_sensor_coordinator_update():\n coordinator = MagicMock()\n coordinator.data = {\"General Waste\": datetime(2025, 2, 10).date()}\n coordinator.name = \"Coordinator Name\"\n\n sensor = UKBinCollectionDataSensor(coordinator, \"General Waste\", \"device_id\", {})\n with patch.object(sensor, \"update_state\") as mock_update, patch.object(\n sensor, \"async_write_ha_state\"\n ) as mock_write:\n sensor._handle_coordinator_update()\n\n mock_update.assert_called_once()\n mock_write.assert_called_once()\n\n\n@freeze_time(\"2025-02-10\") # let's say \"today\" is 2025-02-10\ndef test_data_sensor_today_tomorrow():\n coordinator = MagicMock()\n # Make 2 bins: one is \"today\" (2025-02-10), one is \"tomorrow\" (2025-02-11)\n coordinator.data = {\n \"Waste Today\": datetime(2025, 2, 10).date(),\n \"Waste Tomorrow\": datetime(2025, 2, 11).date(),\n }\n coordinator.name = \"Coord\"\n\n # create sensors\n entities = create_sensor_entities(coordinator, \"entry_id\", \"{}\")\n tdy_sensor = next(\n e\n for e in entities\n if isinstance(e, UKBinCollectionDataSensor) and \"Waste Today\" in e.name\n )\n tmw_sensor = next(\n e\n for e in entities\n if isinstance(e, UKBinCollectionDataSensor) and \"Waste Tomorrow\" in e.name\n )\n\n assert tdy_sensor.state == \"Today\"\n assert tmw_sensor.state == \"Tomorrow\"\n\n\n@freeze_time(\"2025-02-08\")\ndef test_create_sensor_entities_full_coverage(hass):\n coordinator = MagicMock()\n coordinator.data = {\n \"General Waste\": datetime(2025, 2, 8).date(), # Today\n \"Recycling\": datetime(2025, 2, 9).date(), # Tomorrow\n \"Garden\": datetime(2025, 2, 10).date(), # 2 days\n }\n coordinator.name = \"Full Coverage Coord\"\n\n # Intentionally pass an invalid JSON to load_icon_color_mapping\n invalid_icon_json = '{\"General Waste\": {\"icon\":\"mdi:trash-can\"}, \"broken\"'\n with patch(\"logging.Logger.warning\") as mock_warn:\n entities = create_sensor_entities(\n coordinator, \"entry_id_abc\", invalid_icon_json\n )\n\n # We get main sensors for 3 bins => 3\n # Each bin has 5 attribute sensors => 15\n # 1 raw sensor => 1\n # total => 19\n assert len(entities) == 19\n\n # Check the warning for invalid JSON was called\n mock_warn.assert_called_once()\n # e.g. \"Invalid icon_color_mapping JSON: ... Using default settings.\"\n\n # Now pick an attribute sensor for \"Days Until Collection\" for \"Garden\"\n days_garden = next(e for e in entities if \"Garden Days Until Collection\" in e.name)\n # Trigger the state property => calls `calculate_days_until`\n days_val = days_garden.state\n assert days_val == 2 # Because 2025-02-10 is 2 days from 2025-02-08\n\n # Similarly, the raw JSON sensor\n raw_sensor = next(\n e for e in entities if isinstance(e, UKBinCollectionRawJSONSensor)\n )\n raw_state = raw_sensor.state\n # Should be a JSON with 3 keys, etc.\n # This triggers lines in raw-sensor code\n\n # Also test `_handle_coordinator_update` on the main sensor\n main_sensor = next(\n e\n for e in entities\n if \"General Waste\" in e.name and isinstance(e, UKBinCollectionDataSensor)\n )\n with patch.object(main_sensor, \"update_state\") as mock_up, patch.object(\n main_sensor, \"async_write_ha_state\"\n ) as mock_aw:\n main_sensor._handle_coordinator_update()\n mock_up.assert_called_once()\n mock_aw.assert_called_once()\n\n\n###############################################################################\n# Tests for UKBinCollectionAttributeSensor's state and helper methods\n###############################################################################\n\n\ndef test_attribute_sensor_state_colour():\n \"\"\"Test that if attribute type is 'Colour', state returns _color.\"\"\"\n coordinator = MagicMock()\n # Provide some bin data though it isn’t used in this branch\n coordinator.data = {\"Recycling\": datetime(2025, 2, 10).date()}\n coordinator.name = \"Test Coord\"\n # Provide a mapping that supplies a color.\n icon_mapping = {\"Recycling\": {\"icon\": \"mdi:recycle\", \"color\": \"green\"}}\n sensor = UKBinCollectionAttributeSensor(\n coordinator, \"Recycling\", \"uid1\", \"Colour\", \"dev1\", icon_mapping\n )\n # The state for attribute \"Colour\" is simply the color.\n assert sensor.state == \"green\"\n\n\ndef test_attribute_sensor_state_bin_type():\n \"\"\"Test that if attribute type is 'Bin Type', state returns the bin type.\"\"\"\n coordinator = MagicMock()\n coordinator.data = {\"Recycling\": datetime(2025, 2, 10).date()}\n coordinator.name = \"Test Coord\"\n sensor = UKBinCollectionAttributeSensor(\n coordinator, \"Recycling\", \"uid2\", \"Bin Type\", \"dev2\", {}\n )\n assert sensor.state == \"Recycling\"\n\n\ndef test_attribute_sensor_state_next_collection_date_with_data():\n \"\"\"Test that if attribute type is 'Next Collection Date' and data exists, state is the formatted date.\"\"\"\n date_value = datetime(2025, 2, 10).date()\n coordinator = MagicMock()\n coordinator.data = {\"Recycling\": date_value}\n coordinator.name = \"Test Coord\"\n sensor = UKBinCollectionAttributeSensor(\n coordinator, \"Recycling\", \"uid3\", \"Next Collection Date\", \"dev3\", {}\n )\n expected = date_value.strftime(\"%d/%m/%Y\")\n assert sensor.state == expected\n\n\ndef test_attribute_sensor_state_next_collection_date_no_data():\n \"\"\"Test that if attribute type is 'Next Collection Date' and no data exists, state is 'Unknown'.\"\"\"\n coordinator = MagicMock()\n coordinator.data = {}\n coordinator.name = \"Test Coord\"\n sensor = UKBinCollectionAttributeSensor(\n coordinator, \"Recycling\", \"uid4\", \"Next Collection Date\", \"dev4\", {}\n )\n assert sensor.state == \"Unknown\"\n\n\n@freeze_time(\"2025-02-08\")\ndef test_attribute_sensor_state_next_collection_human_readable_today():\n \"\"\"Test human‐readable state when bin collection is today.\"\"\"\n coordinator = MagicMock()\n coordinator.data = {\"Recycling\": datetime(2025, 2, 8).date()}\n coordinator.name = \"Test Coord\"\n sensor = UKBinCollectionAttributeSensor(\n coordinator, \"Recycling\", \"uid5\", \"Next Collection Human Readable\", \"dev5\", {}\n )\n # When the collection date is today, expect \"Today\"\n assert sensor.state == \"Today\"\n\n\n@freeze_time(\"2025-02-08\")\ndef test_attribute_sensor_state_next_collection_human_readable_tomorrow():\n \"\"\"Test human‐readable state when bin collection is tomorrow.\"\"\"\n coordinator = MagicMock()\n coordinator.data = {\"Recycling\": datetime(2025, 2, 9).date()}\n coordinator.name = \"Test Coord\"\n sensor = UKBinCollectionAttributeSensor(\n coordinator, \"Recycling\", \"uid6\", \"Next Collection Human Readable\", \"dev6\", {}\n )\n assert sensor.state == \"Tomorrow\"\n\n\n@freeze_time(\"2025-02-08\")\ndef test_attribute_sensor_state_next_collection_human_readable_future():\n \"\"\"Test human‐readable state when bin collection is more than one day away.\"\"\"\n coordinator = MagicMock()\n coordinator.data = {\"Recycling\": datetime(2025, 2, 12).date()} # 4 days later\n coordinator.name = \"Test Coord\"\n sensor = UKBinCollectionAttributeSensor(\n coordinator, \"Recycling\", \"uid7\", \"Next Collection Human Readable\", \"dev7\", {}\n )\n # 2025-02-12 is 4 days away from 2025-02-08\n assert sensor.state == \"In 4 days\"\n\n\n@freeze_time(\"2025-02-08\")\ndef test_attribute_sensor_state_days_until_collection_with_data():\n \"\"\"Test that Days Until Collection returns the correct number of days.\"\"\"\n coordinator = MagicMock()\n coordinator.data = {\"Recycling\": datetime(2025, 2, 11).date()} # 3 days away\n coordinator.name = \"Test Coord\"\n sensor = UKBinCollectionAttributeSensor(\n coordinator, \"Recycling\", \"uid8\", \"Days Until Collection\", \"dev8\", {}\n )\n assert sensor.state == 3\n\n\n@freeze_time(\"2025-02-08\")\ndef test_attribute_sensor_state_days_until_collection_no_data():\n \"\"\"Test that Days Until Collection returns -1 if no data is available.\"\"\"\n coordinator = MagicMock()\n coordinator.data = {}\n coordinator.name = \"Test Coord\"\n sensor = UKBinCollectionAttributeSensor(\n coordinator, \"Recycling\", \"uid9\", \"Days Until Collection\", \"dev9\", {}\n )\n assert sensor.state == -1\n\n\n###############################################################################\n# Tests for extra_state_attributes, device_info, and unique_id properties\n###############################################################################\n\n\ndef test_data_sensor_extra_state_attributes():\n \"\"\"Test that extra_state_attributes returns the correct dictionary.\"\"\"\n coordinator = MagicMock()\n date_value = datetime(2025, 2, 10).date()\n coordinator.data = {\"Recycling\": date_value}\n coordinator.name = \"Test Coord\"\n sensor = UKBinCollectionDataSensor(coordinator, \"Recycling\", \"uid10\", {})\n expected_attributes = {\n STATE_ATTR_COLOUR: sensor.get_color(), # without mapping, default is \"black\"\n STATE_ATTR_NEXT_COLLECTION: date_value.strftime(\"%d/%m/%Y\"),\n STATE_ATTR_DAYS: (date_value - dt_util.now().date()).days,\n }\n assert sensor.extra_state_attributes == expected_attributes\n\n\ndef test_data_sensor_device_info_property():\n \"\"\"Test that the device_info property returns the expected dictionary.\"\"\"\n coordinator = MagicMock()\n coordinator.name = \"Test Name\"\n sensor = UKBinCollectionDataSensor(coordinator, \"General Waste\", \"device123\", {})\n expected = {\n \"identifiers\": {(DOMAIN, \"device123\")},\n \"name\": f\"{coordinator.name} General Waste\",\n \"manufacturer\": \"UK Bin Collection\",\n \"model\": \"Bin Sensor\",\n \"sw_version\": \"1.0\",\n }\n assert sensor.device_info == expected\n\n\ndef test_data_sensor_unique_id_property():\n \"\"\"Test that unique_id property returns the correct value.\"\"\"\n coordinator = MagicMock()\n sensor = UKBinCollectionDataSensor(\n coordinator, \"General Waste\", \"unique_id_123\", {}\n )\n assert sensor.unique_id == \"unique_id_123\"\n\n\n###############################################################################\n# Tests for create_sensor_entities() helper function\n###############################################################################\n\n\ndef test_create_sensor_entities_coordinator_data():\n \"\"\"Test that create_sensor_entities returns the correct sensor entities.\"\"\"\n coordinator = MagicMock()\n # Suppose we have two bin types.\n coordinator.data = {\n \"General Waste\": date(2025, 2, 8), # Today\n \"Recycling\": date(2025, 2, 9), # Tomorrow\n }\n coordinator.name = \"Test Coordinator\"\n\n # Use a valid JSON mapping for General Waste only.\n icon_mapping_json = '{\"General Waste\":{\"icon\":\"mdi:trash-can\",\"color\":\"brown\"}}'\n entities = create_sensor_entities(coordinator, \"test_entry\", icon_mapping_json)\n\n # Expect:\n # 2 main sensors (one for each bin type)\n # 2 * 5 = 10 attribute sensors (5 per bin type)\n # 1 raw JSON sensor\n # Total = 2 + 10 + 1 = 13\n assert len(entities) == 13\n\n # Verify that the General Waste sensor uses the icon mapping.\n gw_sensor = next(\n e\n for e in entities\n if isinstance(e, UKBinCollectionDataSensor) and \"General Waste\" in e.name\n )\n assert gw_sensor.icon == \"mdi:trash-can\"\n # Check that one of the attribute sensors exists (e.g. Days Until Collection)\n gw_attr = next(\n e\n for e in entities\n if isinstance(e, UKBinCollectionAttributeSensor)\n and \"Days Until Collection\" in e.name\n )\n assert gw_attr is not None\n\n # Verify that a raw JSON sensor is present.\n raw_sensor = next(\n e for e in entities if isinstance(e, UKBinCollectionRawJSONSensor)\n )\n raw_state = json.loads(raw_sensor.state)\n assert \"General Waste\" in raw_state and \"Recycling\" in raw_state\n\n\ndef test_create_sensor_entities_invalid_icon_json():\n \"\"\"Test that create_sensor_entities logs a warning when icon_color_mapping is invalid.\"\"\"\n coordinator = MagicMock()\n coordinator.data = {\n \"General Waste\": datetime(2025, 2, 10).date(),\n }\n coordinator.name = \"Test Coordinator\"\n\n invalid_json = '{\"invalid\":true, ' # Incomplete JSON\n with patch(\"logging.Logger.warning\") as mock_warn:\n entities = create_sensor_entities(coordinator, \"test_entry_id\", invalid_json)\n\n # With one bin type we expect: 1 main sensor + 5 attribute sensors + 1 raw sensor = 7 total\n assert len(entities) == 7\n mock_warn.assert_called_once()\n\n\n###############################################################################\n# Additional tests for the attribute sensor calculation methods\n###############################################################################\n\n\n@freeze_time(\"2025-02-08\")\ndef test_attribute_sensor_days_and_human_readable():\n \"\"\"Test that the attribute sensor returns correct human‐readable and days until collection.\"\"\"\n coordinator = MagicMock()\n # Suppose \"Food Waste\" is 2 days away from 2025-02-08\n in_2_days = datetime(2025, 2, 10).date()\n coordinator.data = {\"Food Waste\": in_2_days}\n coordinator.name = \"Coordinator Name\"\n\n sensor = UKBinCollectionAttributeSensor(\n coordinator,\n \"Food Waste\",\n \"uid_full\",\n \"Next Collection Human Readable\",\n \"dev_full\",\n {},\n )\n # When there is data, the human-readable text should be \"In 2 days\"\n assert sensor.calculate_human_readable() == \"In 2 days\"\n # And calculate_days_until should return 2\n assert sensor.calculate_days_until() == 2\n\n\n###############################################################################\n# Tests for the Raw JSON Sensor behavior\n###############################################################################\n\n\ndef test_raw_json_sensor_partial_data():\n \"\"\"Test that the raw JSON sensor correctly encodes None values.\"\"\"\n coordinator = MagicMock()\n # Only some bins have dates; for example, \"General Waste\" is None.\n coordinator.data = {\"General Waste\": None, \"Recycling\": datetime(2025, 1, 1).date()}\n coordinator.last_update_success = True\n sensor = UKBinCollectionRawJSONSensor(coordinator, \"raw_uid\", \"Test Name\")\n state = sensor.state\n # Expect that the None value is encoded as null in JSON.\n expected = '{\"General Waste\": null, \"Recycling\": \"01/01/2025\"}'\n assert state == expected\n\n\ndef test_data_sensor_unavailable_if_unknown_state():\n \"\"\"Test that the sensor is marked unavailable when its state is 'Unknown'.\"\"\"\n coordinator = MagicMock()\n coordinator.data = {} # no bin data provided\n coordinator.name = \"Test Coordinator\"\n sensor = UKBinCollectionDataSensor(coordinator, \"General Waste\", \"uid_unavail\", {})\n sensor.update_state() # This should set state to \"Unknown\"\n assert sensor.available is False\n\n\ndef test_attribute_sensor_unavailable_if_coordinator_failed():\n \"\"\"Test that an attribute sensor is unavailable if the coordinator update failed.\"\"\"\n coordinator = MagicMock()\n coordinator.data = {\"Recycling\": datetime(2025, 1, 1).date()}\n coordinator.last_update_success = False\n coordinator.name = \"Test Coordinator\"\n sensor = UKBinCollectionAttributeSensor(\n coordinator, \"Recycling\", \"uid_fail\", \"Colour\", \"dev_fail\", {}\n )\n assert sensor.available is False\n\n\n# --- Additional tests for uncovered lines ---\n\n\ndef test_data_sensor_state_unknown_and_extra_attributes():\n \"\"\"Test that if no bin data is provided the state is 'Unknown' and extra_state_attributes are set correctly.\"\"\"\n # Create a coordinator with no data for the requested bin type.\n coordinator = MagicMock()\n coordinator.data = {} # No data available.\n coordinator.name = \"Test Coord\"\n # Create a data sensor for a bin type that is not in the coordinator data.\n sensor = UKBinCollectionDataSensor(\n coordinator, \"Nonexistent Bin\", \"device_unknown\", {}\n )\n sensor.update_state() # This should set the state to \"Unknown\"\n\n # Verify the state fallback\n assert sensor.state == \"Unknown\"\n\n # Verify extra_state_attributes returns default values:\n # The colour is determined by get_color()—with no mapping it returns \"black\"\n extra = sensor.extra_state_attributes\n assert extra[STATE_ATTR_COLOUR] == \"black\"\n # Since there is no bin date, the next collection attribute should be None.\n assert extra[STATE_ATTR_NEXT_COLLECTION] is None\n\n\ndef test_data_sensor_device_info_and_unique_id():\n \"\"\"Test that the device_info and unique_id properties return the expected values.\"\"\"\n coordinator = MagicMock()\n coordinator.name = \"Test Coord\"\n # Create a sensor with a given device ID.\n sensor = UKBinCollectionDataSensor(\n coordinator, \"General Waste\", \"unique_id_test\", {}\n )\n\n expected_device_info = {\n \"identifiers\": {(DOMAIN, \"unique_id_test\")},\n \"name\": f\"{coordinator.name} General Waste\",\n \"manufacturer\": \"UK Bin Collection\",\n \"model\": \"Bin Sensor\",\n \"sw_version\": \"1.0\",\n }\n # Test device_info property\n assert sensor.device_info == expected_device_info\n\n # Test unique_id property\n assert sensor.unique_id == \"unique_id_test\"\n\n\n# --- Additional tests for the Attribute Sensor helper methods ---\n\n\n@freeze_time(\"2025-02-08\")\ndef test_attribute_sensor_calculate_human_readable_and_days_until():\n \"\"\"Test the calculate_human_readable and calculate_days_until methods of the attribute sensor.\"\"\"\n # Suppose \"Food Waste\" is 3 days away from 2025-02-08.\n future_date = datetime(2025, 2, 11).date()\n coordinator = MagicMock()\n coordinator.data = {\"Food Waste\": future_date}\n coordinator.name = \"Test Coord\"\n\n sensor = UKBinCollectionAttributeSensor(\n coordinator,\n \"Food Waste\",\n \"attr_uid\",\n \"Next Collection Human Readable\",\n \"dev_uid\",\n {},\n )\n # Manually call the helper methods:\n human_readable = sensor.calculate_human_readable()\n days_until = sensor.calculate_days_until()\n\n # From 2025-02-08 to 2025-02-11 is 3 days away.\n assert human_readable == \"In 3 days\"\n assert days_until == 3\n\n\n# --- Additional tests for create_sensor_entities helper function ---\n\n\ndef test_create_sensor_entities_with_no_data():\n \"\"\"Test create_sensor_entities returns sensors even when coordinator data is empty.\"\"\"\n coordinator = MagicMock()\n coordinator.data = {} # No bin types at all.\n coordinator.name = \"Empty Coord\"\n # Pass an empty JSON mapping.\n entities = create_sensor_entities(coordinator, \"empty_entry\", \"{}\")\n # We expect only the Raw JSON sensor to be created.\n # (since the for-loop over coordinator.data will not iterate if data is empty)\n assert len(entities) == 1\n assert isinstance(entities[0], UKBinCollectionRawJSONSensor)\n\n\n# --- Additional tests for load_icon_color_mapping default return ---\n\n\ndef test_load_icon_color_mapping_empty_string():\n \"\"\"Test that load_icon_color_mapping returns an empty dict if an empty string is provided.\"\"\"\n result = load_icon_color_mapping(\"\")\n assert result == {}\n\n\n# (The test for invalid JSON is already present; see test_load_icon_color_mapping_invalid_json)\n\n# --- Additional test for UKBinCollectionRawJSONSensor property behavior ---\n\n\ndef test_raw_json_sensor_with_no_data():\n \"\"\"Test that the Raw JSON sensor returns '{}' when no coordinator data is available.\"\"\"\n coordinator = MagicMock()\n coordinator.data = {}\n coordinator.last_update_success = True\n sensor = UKBinCollectionRawJSONSensor(coordinator, \"raw_test\", \"Test Name\")\n assert sensor.state == \"{}\"\n # The extra_state_attributes should return an empty dict under the key \"raw_data\"\n assert sensor.extra_state_attributes == {\"raw_data\": {}}\n # Availability should depend on last_update_success\n assert sensor.available is True\n" }, { "path": "custom_components/uk_bin_collection/translations/cy.json", "content": "{\n \"title\": \"Data Casglu Biniau y DU\",\n \"config\": {\n \"step\": {\n \"user\": {\n \"title\": \"Dewiswch y cyngor\",\n \"data\": {\n \"name\": \"Enw'r lleoliad\",\n \"council\": \"Cyngor\",\n \"manual_refresh_only\": \"Adnewyddu'r synhwyrydd yn awtomatig\",\n \"icon_color_mapping\": \"JSON i fapio Math y Bin ar gyfer Lliw ac Eicon gweler: https://github.com/robbrad/UKBinCollectionData\"\n },\n \"description\": \"Gweler [yma](https://github.com/robbrad/UKBinCollectionData#requesting-your-council) os nad yw eich cyngor wedi'i restru\"\n },\n \"council\": {\n \"title\": \"Darparu manylion y cyngor\",\n \"data\": {\n \"url\": \"URL i nôl data casglu biniau\",\n \"timeout\": \"Yr amser mewn eiliadau y dylai'r synhwyrydd aros am ddata\",\n \"update_interval\": \"Amser mewn oriau rhwng diweddariadau\",\n \"uprn\": \"UPRN (Rhif Cyfeirnod Eiddo Unigryw)\",\n \"postcode\": \"Cod post y cyfeiriad\",\n \"number\": \"Rhif tŷ y cyfeiriad\",\n \"usrn\": \"USRN (Rhif Cyfeirnod Stryd Unigryw)\",\n \"web_driver\": \"I redeg ar weinydd Selenium o bell, ychwanegwch URL y Weinydd Selenium\",\n \"headless\": \"Rhedeg Selenium yn y modd heb ben (argymhellir)\",\n \"local_browser\": \"Peidiwch â rhedeg ar weinydd Selenium o bell, defnyddiwch osodiad lleol o Chrome yn lle\",\n \"submit\": \"Cyflwyno\"\n },\n \"description\": \"Cyfeiriwch at gofnod [wiki](https://github.com/robbrad/UKBinCollectionData/wiki/Councils) eich cyngor am fanylion ar beth i'w nodi.\\n{selenium_message}\"\n },\n \"reconfigure_confirm\": {\n \"title\": \"Diweddaru manylion y cyngor\",\n \"data\": {\n \"url\": \"URL i nôl data casglu biniau\",\n \"timeout\": \"Yr amser mewn eiliadau y dylai'r synhwyrydd aros am ddata\",\n \"update_interval\": \"Amser mewn oriau rhwng diweddariadau\",\n \"uprn\": \"UPRN (Rhif Cyfeirnod Eiddo Unigryw)\",\n \"postcode\": \"Cod post y cyfeiriad\",\n \"number\": \"Rhif tŷ y cyfeiriad\",\n \"usrn\": \"USRN (Rhif Cyfeirnod Stryd Unigryw)\",\n \"web_driver\": \"I redeg ar weinydd Selenium o bell, ychwanegwch URL y Weinydd Selenium\",\n \"headless\": \"Rhedeg Selenium yn y modd heb ben (argymhellir)\",\n \"manual_refresh_only\": \"Adnewyddu'r synhwyrydd yn awtomatig\",\n \"local_browser\": \"Peidiwch â rhedeg ar weinydd Selenium o bell, defnyddiwch osodiad lleol o Chrome yn lle\",\n \"icon_color_mapping\": \"JSON i fapio Math y Bin ar gyfer Lliw ac Eicon gweler: https://github.com/robbrad/UKBinCollectionData\",\n \"submit\": \"Cyflwyno\"\n },\n \"description\": \"Cyfeiriwch at gofnod [wiki](https://github.com/robbrad/UKBinCollectionData/wiki/Councils) eich cyngor am fanylion ar beth i'w nodi.\"\n }\n },\n \"error\": {\n \"name\": \"Rhowch enw lleoliad os gwelwch yn dda\",\n \"council\": \"Dewiswch gyngor os gwelwch yn dda\",\n \"selenium_unavailable\": \"❌ Nid yw gweinydd Selenium ar gael. Sicrhewch ei fod yn rhedeg yn http://localhost:4444 neu http://selenium:4444. [Canllaw Gosod](https://example.com/selenium-setup)\",\n \"chromium_not_found\": \"❌ Nid yw porwr Chromium wedi'i osod. Gosodwch Chromium neu Google Chrome os gwelwch yn dda. [Canllaw Gosod](https://example.com/chromium-install)\"\n }\n }\n}\n" }, { "path": "custom_components/uk_bin_collection/translations/en.json", "content": "{\n \"title\": \"UK Bin Collection Data\",\n \"config\": {\n \"step\": {\n \"user\": {\n \"title\": \"Select the council\",\n \"data\": {\n \"name\": \"Location name\",\n \"council\": \"Council\",\n \"manual_refresh_only\":\"Automatically refresh the sensor\",\n \"icon_color_mapping\": \"JSON to map Bin Type for Colour and Icon (see documentation)\"\n },\n \"description\": \"Please see the documentation if your council isn't listed\"\n },\n \"council\": {\n \"title\": \"Provide council details\",\n \"data\": {\n \"url\": \"URL to fetch bin collection data\",\n \"timeout\": \"The time in seconds for how long the sensor should wait for data\",\n \"update_interval\": \"Time in hours between updates\",\n \"uprn\": \"UPRN (Unique Property Reference Number)\",\n \"postcode\": \"Postcode of the address\",\n \"number\": \"House number of the address\",\n \"usrn\": \"USRN (Unique Street Reference Number)\",\n \"web_driver\": \"To run on a remote Selenium Server add the Selenium Server URL\",\n \"headless\": \"Run Selenium in headless mode (recommended)\",\n \"local_browser\": \"Don't run on remote Selenium server, use local install of Chrome instead\",\n \"submit\": \"Submit\"\n },\n \"description\": \"Please refer to your council's wiki entry for details on what to enter.\\n{selenium_message}\"\n },\n \"reconfigure_confirm\": {\n \"title\": \"Update council details\",\n \"data\": {\n \"url\": \"URL to fetch bin collection data\",\n \"timeout\": \"The time in seconds for how long the sensor should wait for data\",\n \"update_interval\": \"Time in hours between updates\",\n \"uprn\": \"UPRN (Unique Property Reference Number)\",\n \"postcode\": \"Postcode of the address\",\n \"number\": \"House number of the address\",\n \"usrn\": \"USRN (Unique Street Reference Number)\",\n \"web_driver\": \"To run on a remote Selenium Server add the Selenium Server URL\",\n \"headless\": \"Run Selenium in headless mode (recommended)\",\n \"local_browser\": \"Don't run on remote Selenium server, use local install of Chrome instead\",\n \"manual_refresh_only\":\"Automatically refresh the sensor\",\n \"icon_color_mapping\": \"JSON to map Bin Type for Colour and Icon (see documentation)\",\n \"submit\": \"Submit\"\n },\n \"description\": \"Please refer to your council's wiki entry for details on what to enter.\"\n }\n },\n \"error\": {\n \"name\": \"Please enter a location name\",\n \"council\": \"Please select a council\",\n \"selenium_unavailable\": \"Selenium server is not accessible. Please ensure it is running at localhost:4444 or selenium:4444\",\n \"chromium_not_found\": \"Chromium browser is not installed. Please install Chromium or Google Chrome\"\n }\n }\n}\n" }, { "path": "custom_components/uk_bin_collection/translations/ga.json", "content": "{\n \"title\": \"Sonraí Bailithe Binn RA\",\n \"config\": {\n \"step\": {\n \"user\": {\n \"title\": \"Roghnaigh an chomhairle\",\n \"data\": {\n \"name\": \"Ainm Suíomh\",\n \"council\": \"Comhairle\",\n \"manual_refresh_only\": \"Athnuaigh an braiteoir go huathoibríoch\",\n \"icon_color_mapping\": \"JSON chun Cineál Bin a mhapáil do Dath agus Deilbhín féach: https://github.com/robbrad/UKBinCollectionData\"\n },\n \"description\": \"Féach [anseo](https://github.com/robbrad/UKBinCollectionData#requesting-your-council) mura bhfuil do chomhairle liostaithe\"\n },\n \"council\": {\n \"title\": \"Sonraí na comhairle a sholáthar\",\n \"data\": {\n \"url\": \"URL chun sonraí bailithe bin a fháil\",\n \"timeout\": \"An t-am i soicindí don braiteoir fanacht le haghaidh sonraí\",\n \"update_interval\": \"Ùine ann an uairean eadar ùrachaidhean\",\n \"uprn\": \"UPRN (Uimhir Tagartha Aonair Maoine)\",\n \"postcode\": \"Cód poist an seoladh\",\n \"number\": \"Uimhir tí an seoladh\",\n \"usrn\": \"USRN (Uimhir Tagartha Sráide Uathúil)\",\n \"web_driver\": \"Chun rith ar Fhreastalaí Iargúlta Selenium cuir isteach URL an Fhreastalaí Selenium\",\n \"headless\": \"Rith Selenium i mód gan cheann (molta)\",\n \"local_browser\": \"Ná rith ar fhreastalaí iargúlta Selenium, úsáid suiteáil áitiúil de Chrome ina ionad\",\n \"submit\": \"Cuir isteach\"\n },\n \"description\": \"Féach ar iontráil [wiki](https://github.com/robbrad/UKBinCollectionData/wiki/Councils) do chomhairle le haghaidh sonraí ar cad atá le cur isteach.\\n{selenium_message}\"\n },\n \"reconfigure_confirm\": {\n \"title\": \"Nuashonraigh sonraí na comhairle\",\n \"data\": {\n \"url\": \"URL chun sonraí bailithe bin a fháil\",\n \"timeout\": \"An t-am i soicindí don braiteoir fanacht le haghaidh sonraí\",\n \"update_interval\": \"Ùine ann an uairean eadar ùrachaidhean\",\n \"uprn\": \"UPRN (Uimhir Tagartha Aonair Maoine)\",\n \"postcode\": \"Cód poist an seoladh\",\n \"number\": \"Uimhir tí an seoladh\",\n \"usrn\": \"USRN (Uimhir Tagartha Sráide Uathúil)\",\n \"web_driver\": \"Chun rith ar Fhreastalaí Iargúlta Selenium cuir isteach URL an Fhreastalaí Selenium\",\n \"headless\": \"Rith Selenium i mód gan cheann (molta)\",\n \"local_browser\": \"Ná rith ar fhreastalaí iargúlta Selenium, úsáid suiteáil áitiúil de Chrome ina ionad\",\n \"manual_refresh_only\": \"Athnuaigh an braiteoir go huathoibríoch\",\n \"icon_color_mapping\": \"JSON chun Cineál Bin a mhapáil do Dath agus Deilbhín féach: https://github.com/robbrad/UKBinCollectionData\",\n \"submit\": \"Cuir isteach\"\n },\n \"description\": \"Féach ar iontráil [wiki](https://github.com/robbrad/UKBinCollectionData/wiki/Councils) do chomhairle le haghaidh sonraí ar cad atá le cur isteach.\"\n }\n },\n \"error\": {\n \"name\": \"Cuir isteach ainm suíomh le do thoil\",\n \"council\": \"Roghnaigh comhairle le do thoil\",\n \"selenium_unavailable\": \"❌ Níl freastalaí Selenium inrochtana. Cinntigh go bhfuil sé ag rith ag http://localhost:4444 nó http://selenium:4444. [Treoir Socraithe](https://example.com/selenium-setup)\",\n \"chromium_not_found\": \"❌ Níl brabhsálaí Chromium suiteáilte. Suiteáil Chromium nó Google Chrome le do thoil. [Treoir Suiteála](https://example.com/chromium-install)\"\n }\n }\n}\n" }, { "path": "custom_components/uk_bin_collection/translations/gd.json", "content": "{\n \"title\": \"Dàta Cruinneachadh Biona RA\",\n \"config\": {\n \"step\": {\n \"user\": {\n \"title\": \"Tagh a’ chomhairle\",\n \"data\": {\n \"name\": \"Ainm Àite\",\n \"council\": \"Comhairle\",\n \"manual_refresh_only\": \"Ùraich an sensor gu fèin-obrachail\", \n \"local_browser\": \"Na ruith air frithealaiche Selenium iomallach, cleachd stàladh ionadail de Chrome an àite\",\n \"icon_color_mapping\": \"JSON gus Seòrsa Biona a mhapadh airson Dath agus Ìomhaigh faic: https://github.com/robbrad/UKBinCollectionData\"\n },\n \"description\": \"Feuch an toir thu sùil [an seo](https://github.com/robbrad/UKBinCollectionData#requesting-your-council) mura h-eil do chomhairle air a liostadh\"\n },\n \"council\": {\n \"title\": \"Thoir seachad mion-fhiosrachadh na comhairle\",\n \"data\": {\n \"url\": \"URL gus dàta cruinneachadh biona fhaighinn\",\n \"timeout\": \"An ùine ann an diogan airson cho fada bu chòir don sensor feitheamh airson dàta\",\n \"update_interval\": \"Am i n-uaireanta idir nuashonruithe\",\n \"uprn\": \"UPRN (Àireamh Iomraidh Seilbh Aonraic)\",\n \"postcode\": \"Còd-puist an t-seòladh\",\n \"number\": \"Àireamh an taighe den t-seòladh\",\n \"usrn\": \"USRN (Àireamh Iomraidh Sràid Aonraic)\",\n \"web_driver\": \"Gus ruith air Frithealaiche Selenium iomallach cuir a-steach an URL Frithealaiche Selenium\",\n \"headless\": \"Ruith Selenium ann am modh gun cheann (air a mholadh)\",\n \"local_browser\": \"Na ruith air frithealaiche Selenium iomallach, cleachd stàladh ionadail de Chrome an àite\",\n \"submit\": \"Cuir a-steach\"\n },\n \"description\": \"Feuch an toir thu sùil air inntrigeadh [wiki](https://github.com/robbrad/UKBinCollectionData/wiki/Councils) na comhairle agad airson mion-fhiosrachadh air dè a chur a-steach.\\n{selenium_message}\"\n },\n \"reconfigure_confirm\": {\n \"title\": \"Ùraich mion-fhiosrachadh na comhairle\",\n \"data\": {\n \"url\": \"URL gus dàta cruinneachadh biona fhaighinn\",\n \"timeout\": \"An ùine ann an diogan airson cho fada bu chòir don sensor feitheamh airson dàta\",\n \"update_interval\": \"Am i n-uaireanta idir nuashonruithe\",\n \"uprn\": \"UPRN (Àireamh Iomraidh Seilbh Aonraic)\",\n \"postcode\": \"Còd-puist an t-seòladh\",\n \"number\": \"Àireamh an taighe den t-seòladh\",\n \"usrn\": \"USRN (Àireamh Iomraidh Sràid Aonraic)\",\n \"web_driver\": \"Gus ruith air Frithealaiche Selenium iomallach cuir a-steach an URL Frithealaiche Selenium\",\n \"headless\": \"Ruith Selenium ann am modh gun cheann (air a mholadh)\",\n \"manual_refresh_only\": \"Ùraich an sensor gu fèin-obrachail\",\n \"local_browser\": \"Na ruith air frithealaiche Selenium iomallach, cleachd stàladh ionadail de Chrome an àite\",\n \"icon_color_mapping\": \"JSON gus Seòrsa Biona a mhapadh airson Dath agus Ìomhaigh faic: https://github.com/robbrad/UKBinCollectionData\",\n \"submit\": \"Cuir a-steach\"\n },\n \"description\": \"Feuch an toir thu sùil air inntrigeadh [wiki](https://github.com/robbrad/UKBinCollectionData/wiki/Councils) na comhairle agad airson mion-fhiosrachadh air dè a chur a-steach.\"\n }\n },\n \"error\": {\n \"name\": \"Cuir a-steach ainm àite mas e do thoil e\",\n \"council\": \"Tagh comhairle mas e do thoil e\",\n \"selenium_unavailable\": \"❌ Chan eil frithealaiche Selenium ruigsinneach. Dèan cinnteach gu bheil e a’ ruith aig http://localhost:4444 no http://selenium:4444. [Stiùireadh Stèidheachaidh](https://example.com/selenium-setup)\",\n \"chromium_not_found\": \"❌ Chan eil brabhsair Chromium air a chuir a-steach. Stàlaich Chromium no Google Chrome mas e do thoil e. [Stiùireadh Stàlaidh](https://example.com/chromium-install)\"\n }\n }\n}\n" }, { "path": "custom_components/uk_bin_collection/translations/pt.json", "content": "{\n \"title\": \"Dados de Coleta de Lixo do Reino Unido\",\n \"config\": {\n \"step\": {\n \"user\": {\n \"title\": \"Selecione o conselho\",\n \"data\": {\n \"name\": \"Nome da localização\",\n \"council\": \"Conselho\",\n \"manual_refresh_only\": \"Atualize o sensor automaticamente\",\n \"icon_color_mapping\": \"JSON para mapear Tipo de Lixo para Cor e Ícone veja: https://github.com/robbrad/UKBinCollectionData\"\n },\n \"description\": \"Por favor, veja [aqui](https://github.com/robbrad/UKBinCollectionData#requesting-your-council) se o seu conselho não estiver listado\"\n },\n \"council\": {\n \"title\": \"Forneça os detalhes do conselho\",\n \"data\": {\n \"url\": \"URL para buscar dados de coleta de lixo\",\n \"timeout\": \"O tempo em segundos que o sensor deve esperar por dados\",\n \"update_interval\": \"Tempo em horas entre as atualizações\",\n \"uprn\": \"UPRN (Número de Referência Único da Propriedade)\",\n \"postcode\": \"Código postal do endereço\",\n \"number\": \"Número da casa do endereço\",\n \"usrn\": \"USRN (Número de Referência Único da Rua)\",\n \"web_driver\": \"Para executar em um Servidor Selenium remoto, adicione o URL do Servidor Selenium\",\n \"headless\": \"Execute o Selenium no modo sem cabeça (recomendado)\",\n \"local_browser\": \"Não execute no servidor Selenium remoto, use a instalação local do Chrome em vez disso\",\n \"submit\": \"Enviar\"\n },\n \"description\": \"Por favor, consulte a entrada [wiki](https://github.com/robbrad/UKBinCollectionData/wiki/Councils) do seu conselho para detalhes sobre o que inserir.\\n{selenium_message}\"\n },\n \"reconfigure_confirm\": {\n \"title\": \"Atualizar detalhes do conselho\",\n \"data\": {\n \"url\": \"URL para buscar dados de coleta de lixo\",\n \"timeout\": \"O tempo em segundos que o sensor deve esperar por dados\",\n \"update_interval\": \"Tempo em horas entre as atualizações\",\n \"uprn\": \"UPRN (Número de Referência Único da Propriedade)\",\n \"postcode\": \"Código postal do endereço\",\n \"number\": \"Número da casa do endereço\",\n \"usrn\": \"USRN (Número de Referência Único da Rua)\",\n \"web_driver\": \"Para executar em um Servidor Selenium remoto, adicione o URL do Servidor Selenium\",\n \"headless\": \"Execute o Selenium no modo sem cabeça (recomendado)\",\n \"manual_refresh_only\": \"Atualize o sensor automaticamente\",\n \"local_browser\": \"Não execute no servidor Selenium remoto, use a instalação local do Chrome em vez disso\",\n \"icon_color_mapping\": \"JSON para mapear Tipo de Lixo para Cor e Ícone veja: https://github.com/robbrad/UKBinCollectionData\",\n \"submit\": \"Enviar\"\n },\n \"description\": \"Por favor, consulte a entrada [wiki](https://github.com/robbrad/UKBinCollectionData/wiki/Councils) do seu conselho para detalhes sobre o que inserir.\"\n }\n },\n \"error\": {\n \"name\": \"Por favor, insira um nome de localização\",\n \"council\": \"Por favor, selecione um conselho\",\n \"selenium_unavailable\": \"❌ O servidor Selenium não está acessível. Por favor, certifique-se de que está em execução em http://localhost:4444 ou http://selenium:4444. [Guia de Configuração](https://example.com/selenium-setup)\",\n \"chromium_not_found\": \"❌ O navegador Chromium não está instalado. Por favor, instale o Chromium ou o Google Chrome. [Guia de Instalação](https://example.com/chromium-install)\"\n }\n }\n}\n" }, { "path": "docs/RELEASE-SETUP-SUMMARY.md", "content": "# Release Workflow Setup Summary\n\n## What You Need to Do\n\nYour release workflow has been updated to use a GitHub App for secure, automated releases. Here's what you need to do to get it working:\n\n### 1. Create GitHub App (5 minutes)\n\nFollow the detailed guide: [GitHub App Setup Guide](./github-app-setup.md)\n\n**Quick steps:**\n1. Go to https://github.com/settings/apps/new\n2. Fill in:\n - Name: `UKBinCollection Release Bot` (or similar unique name)\n - Homepage: `https://github.com/robbrad/UKBinCollectionData`\n - Uncheck \"Webhook Active\"\n - Permissions: **Contents** = Read and write\n3. Click \"Create GitHub App\"\n4. Click \"Install App\" → Select your repository\n5. Generate a private key (downloads a `.pem` file)\n\n### 2. Add Secrets to Repository (2 minutes)\n\nGo to: https://github.com/robbrad/UKBinCollectionData/settings/secrets/actions\n\nAdd two secrets:\n\n**APP_ID**\n- Value: The App ID shown at top of app settings (e.g., `123456`)\n\n**APP_PRIVATE_KEY**\n- Value: Entire contents of the `.pem` file\n- Include the `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----` lines\n\n### 3. Test It (5 minutes)\n\n1. Create a test branch:\n ```bash\n git checkout -b test/release-workflow\n ```\n\n2. Make a small change with a conventional commit:\n ```bash\n echo \"# Test\" >> README.md\n git add README.md\n git commit -m \"fix: test release workflow\"\n git push origin test/release-workflow\n ```\n\n3. Create and merge a PR on GitHub\n\n4. Watch the workflows run:\n - Bump workflow should run and create a tag\n - Release workflow should publish to PyPI\n\n5. Verify:\n - Check https://github.com/robbrad/UKBinCollectionData/releases\n - Check https://pypi.org/project/uk-bin-collection/\n\n## What Changed\n\n### Workflows Updated\n- ✅ `.github/workflows/bump.yml` - Now uses GitHub App token\n- ✅ `.github/workflows/release.yml` - Cleaned up\n- ✅ `.github/workflows/validate-release-ready.yml` - Simplified\n\n### Documentation Updated\n- ✅ `docs/release-workflow.md` - Main documentation\n- ✅ `docs/release-workflow-setup-checklist.md` - Setup checklist\n- ✅ `docs/release-quick-reference.md` - Quick reference\n- ✅ `docs/github-app-setup.md` - **NEW** - Detailed GitHub App guide\n- ✅ `docs/release-workflow-migration.md` - Migration guide\n\n### Configuration Updated\n- ✅ `pyproject.toml` - Enhanced Commitizen config\n\n## How It Works Now\n\n```\n1. Developer creates PR with conventional commits (feat:, fix:, etc.)\n2. CI validates commits and runs tests\n3. PR gets merged to master\n4. Bump workflow automatically:\n - Analyzes commits with Commitizen\n - Updates version in all files\n - Updates CHANGELOG.md\n - Creates commit and tag\n - Pushes to master (using GitHub App to bypass protection)\n5. Release workflow automatically:\n - Builds package\n - Publishes to PyPI\n - Creates GitHub release\n```\n\n**Everything is automated after merge!**\n\n## Benefits\n\n✅ **More secure** - GitHub App instead of personal token\n✅ **No expiration** - Tokens auto-refresh\n✅ **Fully automated** - No manual steps after PR merge\n✅ **Version syncing** - Commitizen handles all version files\n✅ **Better changelog** - Auto-generated from commits\n✅ **Simpler** - Fewer secrets to manage\n\n## Troubleshooting\n\n### Bump workflow fails with \"Bad credentials\"\n- Check that `APP_PRIVATE_KEY` includes the full key with BEGIN/END lines\n- Verify no extra spaces or line breaks were added\n\n### Bump workflow fails with \"Resource not accessible\"\n- Verify the GitHub App has \"Contents: Read and write\" permission\n- Check that the app is installed on the repository\n\n### Release didn't trigger\n- Check if the tag was created (look at bump workflow logs)\n- Verify the tag follows the format `X.Y.Z` (no `v` prefix)\n\n## Need Help?\n\n- 📖 [Full Documentation](./release-workflow.md)\n- 🔧 [GitHub App Setup Guide](./github-app-setup.md)\n- ✅ [Setup Checklist](./release-workflow-setup-checklist.md)\n- ⚡ [Quick Reference](./release-quick-reference.md)\n\n## Next Steps\n\n1. ✅ Complete the GitHub App setup\n2. ✅ Add the secrets to your repository\n3. ✅ Test with a small PR\n4. ✅ Monitor the first few releases\n5. ✅ Remove old `PERSONAL_ACCESS_TOKEN` if you had one\n6. ✅ Update team documentation\n\nThat's it! Your release workflow is now simplified and more secure.\n" }, { "path": "docs/deploy-key-setup.md", "content": "# Deploy Key Setup Guide\n\nSince the GitHub App bypass feature isn't available on your plan, we'll use a deploy key instead. This works on all GitHub plans and can bypass branch protection.\n\n## Step 1: Generate SSH Key Pair\n\nOn your local machine (Windows), open PowerShell and run:\n\n```powershell\nssh-keygen -t ed25519 -C \"github-actions-deploy-key\" -f ukbcd-deploy-key -N \"\"\n```\n\nThis creates two files:\n- `ukbcd-deploy-key` (private key)\n- `ukbcd-deploy-key.pub` (public key)\n\n## Step 2: Add Public Key to Repository\n\n1. Go to: https://github.com/robbrad/UKBinCollectionData/settings/keys\n\n2. Click **\"Add deploy key\"**\n\n3. Fill in:\n - **Title**: `Release Workflow Deploy Key`\n - **Key**: Paste the contents of `ukbcd-deploy-key.pub`\n - **✅ Allow write access** - IMPORTANT: Check this box!\n\n4. Click **\"Add key\"**\n\n## Step 3: Add Private Key as Secret\n\n1. Go to: https://github.com/robbrad/UKBinCollectionData/settings/secrets/actions\n\n2. Click **\"New repository secret\"**\n\n3. Fill in:\n - **Name**: `DEPLOY_KEY`\n - **Value**: Paste the entire contents of `ukbcd-deploy-key` (the private key, not .pub)\n\n4. Click **\"Add secret\"**\n\n## Step 4: Update Branch Protection\n\nDeploy keys with write access can bypass branch protection automatically, but you need to ensure:\n\n1. Go to: https://github.com/robbrad/UKBinCollectionData/settings/branch_protection_rules\n\n2. Edit your master branch rule\n\n3. Make sure **\"Do not allow bypassing the above settings\"** is UNCHECKED\n - Or if you see **\"Include administrators\"**, UNCHECK it\n\n4. Save changes\n\n## Step 5: Clean Up\n\nAfter adding the keys to GitHub, delete the local key files:\n\n```powershell\nRemove-Item ukbcd-deploy-key\nRemove-Item ukbcd-deploy-key.pub\n```\n\n## Step 6: Remove Old Secrets (Optional)\n\nSince we're not using the GitHub App anymore, you can remove:\n- `APP_ID`\n- `APP_PRIVATE_KEY`\n\nOr keep them for future use.\n\n## Test It\n\n1. Create a test PR with a conventional commit\n2. Merge it\n3. Watch the bump workflow run\n4. It should now successfully push to master\n\n## How It Works\n\n- Deploy keys with write access can push to protected branches\n- The SSH key authenticates the workflow\n- No need for GitHub App or PAT\n- Works on all GitHub plans (Free, Pro, Team, Enterprise)\n\n## Troubleshooting\n\n### \"Permission denied (publickey)\"\n- Check that `DEPLOY_KEY` secret contains the private key (not the .pub file)\n- Verify the deploy key is added to the repository with write access\n\n### Still getting \"Protected branch update failed\"\n- Ensure \"Allow write access\" is checked on the deploy key\n- Uncheck \"Do not allow bypassing the above settings\" in branch protection\n\n### \"Host key verification failed\"\n- This shouldn't happen with GitHub, but if it does, the workflow will handle it automatically\n\n## Security Notes\n\n✅ Deploy key only has access to this one repository\n✅ Can be revoked anytime from repository settings\n✅ More secure than personal access tokens\n✅ Doesn't expire\n\n## Alternative: Personal Access Token\n\nIf deploy keys don't work, you can use a PAT:\n\n1. Create token at: https://github.com/settings/tokens/new\n2. Select scope: `repo`\n3. Add as secret: `PERSONAL_ACCESS_TOKEN`\n4. Update workflow to use `token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}`\n\nBut deploy keys are preferred for single-repository automation.\n" }, { "path": "docs/example_council.md", "content": "# Example Council Implementation\n\nThis document shows how to implement a council class using the new utilities.\n\n## Basic Structure\n\n```python\nfrom uk_bin_collection.uk_bin_collection.utils.retry import retry\nfrom uk_bin_collection.uk_bin_collection.utils.cache import cached\nfrom uk_bin_collection.uk_bin_collection.utils.http_client import get as http_get\nfrom uk_bin_collection.uk_bin_collection.utils.logger import get_logger\n\n# Get a logger for this module\nlogger = get_logger(__name__)\n\nclass ExampleCouncil:\n \"\"\"Example council implementation using the new utilities.\"\"\"\n \n # Required class variables\n postcode_required = True\n paon_required = True\n \n def __init__(self, url):\n self.url = url\n self.postcode = None\n self.paon = None\n \n @cached(ttl=3600) # Cache for 1 hour\n @retry(tries=3, delay=1, backoff=2)\n def get_data(self):\n \"\"\"Get bin collection data for this council.\"\"\"\n logger.info(f\"Fetching data for postcode {self.postcode}\")\n \n # Construct the URL with parameters\n params = {\n \"postcode\": self.postcode,\n \"house_number\": self.paon\n }\n \n # Make the request with automatic retry\n response = http_get(self.url, params=params)\n \n # Process the response\n # ...\n \n # Return the data in the standard format\n return [\n {\n \"type\": \"General Waste\",\n \"date\": \"01/01/2023\"\n },\n {\n \"type\": \"Recycling\",\n \"date\": \"08/01/2023\"\n }\n ]\n```\n\n## Complete Example\n\nFor a complete example, see the updated council class template:\n`/workspaces/UKBinCollectionData/uk_bin_collection/uk_bin_collection/councils/council_class_template/councilclasstemplate.py`" }, { "path": "docs/github-app-setup.md", "content": "# GitHub App Setup Guide\n\nThis guide walks you through creating and configuring a GitHub App to allow the release workflow to bypass branch protection rules.\n\n## Why Use a GitHub App?\n\n✅ **More secure** - Fine-grained permissions, not tied to a user account\n✅ **No expiration** - Tokens are automatically refreshed\n✅ **Better audit trail** - Shows as the app, not a personal account\n✅ **Team-friendly** - Won't break if someone leaves the team\n✅ **Built-in bypass** - Can push to protected branches\n\n## Step-by-Step Setup\n\n### Step 1: Create the GitHub App\n\n1. **Navigate to GitHub App settings:**\n - Personal account: https://github.com/settings/apps/new\n - Organization: https://github.com/organizations/YOUR_ORG/settings/apps/new\n\n2. **Fill in the basic information:**\n - **GitHub App name**: `UKBinCollection Release Bot` (must be globally unique)\n - If taken, try: `UKBinCollection-Release-Bot-YourUsername`\n - **Homepage URL**: `https://github.com/robbrad/UKBinCollectionData`\n - **Description** (optional): `Automated release workflow for UK Bin Collection Data`\n\n3. **Configure webhook:**\n - **Uncheck** \"Active\" under \"Webhook\"\n - We don't need webhooks for this use case\n\n4. **Set repository permissions:**\n - **Contents**: `Read and write` ✅ (Required - to push commits and tags)\n - **Metadata**: `Read-only` (Automatically selected)\n - **Pull requests**: `Read and write` (Optional - for future features)\n\n5. **Where can this GitHub App be installed?**\n - Select: **\"Only on this account\"**\n\n6. **Click \"Create GitHub App\"**\n\n### Step 2: Install the App\n\n1. After creation, you'll see the app settings page\n2. Click **\"Install App\"** in the left sidebar\n3. Click **\"Install\"** next to your account/organization name\n4. Choose installation scope:\n - Select **\"Only select repositories\"**\n - Check `UKBinCollectionData`\n5. Click **\"Install\"**\n\n### Step 3: Generate Private Key\n\n1. Go back to the app settings page (Settings → Developer settings → GitHub Apps → Your App)\n2. Scroll down to the **\"Private keys\"** section\n3. Click **\"Generate a private key\"**\n4. A `.pem` file will download automatically\n5. **Save this file securely** - you'll need it in the next step\n\n### Step 4: Get Your App Credentials\n\nYou need two pieces of information:\n\n#### App ID\n- Found at the top of your app settings page\n- Example: `123456`\n- Copy this number\n\n#### Private Key\n- Open the downloaded `.pem` file in a text editor\n- Copy the **entire contents**, including:\n ```\n -----BEGIN RSA PRIVATE KEY-----\n [long string of characters]\n -----END RSA PRIVATE KEY-----\n ```\n\n### Step 5: Add Secrets to Repository\n\n1. Go to your repository: https://github.com/robbrad/UKBinCollectionData\n2. Navigate to: **Settings → Secrets and variables → Actions**\n3. Click **\"New repository secret\"**\n\n#### Add APP_ID Secret\n- **Name**: `APP_ID`\n- **Value**: Your App ID (e.g., `123456`)\n- Click \"Add secret\"\n\n#### Add APP_PRIVATE_KEY Secret\n- **Name**: `APP_PRIVATE_KEY`\n- **Value**: Paste the entire contents of the `.pem` file\n- **Important**: Include the `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----` lines\n- Click \"Add secret\"\n\n### Step 6: Verify Setup\n\n1. The workflow is already configured to use these secrets\n2. Test by merging a PR with a conventional commit message\n3. Check the bump workflow logs to verify it runs successfully\n\n## Troubleshooting\n\n### \"Bad credentials\" error\n- **Cause**: Private key not copied correctly\n- **Solution**: Re-copy the entire `.pem` file contents, including BEGIN/END lines\n\n### \"Resource not accessible by integration\" error\n- **Cause**: App doesn't have correct permissions\n- **Solution**: \n 1. Go to app settings\n 2. Check \"Contents\" permission is set to \"Read and write\"\n 3. Reinstall the app if needed\n\n### \"App not installed\" error\n- **Cause**: App not installed on the repository\n- **Solution**: Go to https://github.com/settings/installations and install it\n\n### Workflow still fails with permission error\n- **Cause**: Secrets not set correctly\n- **Solution**: \n 1. Verify `APP_ID` is just the number (no quotes)\n 2. Verify `APP_PRIVATE_KEY` includes the full key with headers\n 3. Check for extra spaces or line breaks\n\n## Security Best Practices\n\n✅ **Never commit** the `.pem` file to your repository\n✅ **Store the `.pem` file** securely (password manager or secure vault)\n✅ **Rotate keys** if compromised (generate new private key)\n✅ **Review app permissions** periodically\n✅ **Monitor app activity** in audit logs\n\n## Managing the App\n\n### View App Activity\n- Go to: Settings → Developer settings → GitHub Apps → Your App\n- Click \"Advanced\" tab to see delivery logs\n\n### Regenerate Private Key\n1. Go to app settings\n2. Scroll to \"Private keys\"\n3. Click \"Generate a private key\"\n4. Update the `APP_PRIVATE_KEY` secret in your repository\n\n### Uninstall/Reinstall\n- Go to: https://github.com/settings/installations\n- Click \"Configure\" next to your app\n- Adjust repository access or uninstall\n\n## Alternative: Using a Personal Access Token\n\nIf you prefer not to use a GitHub App, you can use a Personal Access Token instead:\n\n1. Create a token at: https://github.com/settings/tokens/new\n2. Select scope: `repo` (Full control of private repositories)\n3. Add as secret: `BUMP_TOKEN`\n4. Update workflow to use `${{ secrets.BUMP_TOKEN }}` instead of the app token\n\nHowever, GitHub Apps are recommended for production use.\n\n## Next Steps\n\nOnce setup is complete:\n1. ✅ Test the workflow with a small PR\n2. ✅ Monitor the first few releases\n3. ✅ Document the app for your team\n4. ✅ Set up monitoring/alerts for workflow failures\n\n## Support\n\nIf you encounter issues:\n- Check the [troubleshooting section](#troubleshooting) above\n- Review workflow logs in GitHub Actions\n- See the [main workflow documentation](./release-workflow.md)\n" }, { "path": "docs/github-app-troubleshooting.md", "content": "# GitHub App Troubleshooting - Branch Protection\n\n## Problem: \"Protected branch update failed\"\n\nIf you're getting this error, the GitHub App isn't properly configured to bypass branch protection.\n\n## Solution Steps\n\n### Step 1: Verify App Installation\n\n1. Go to: https://github.com/settings/installations\n2. Find your app (e.g., \"UKBinCollection Release Bot\")\n3. Click \"Configure\"\n4. Verify it's installed on `UKBinCollectionData` repository\n5. Check that it has \"Contents: Read and write\" permission\n\n### Step 2: Configure Branch Protection\n\nGo to: https://github.com/robbrad/UKBinCollectionData/settings/branches\n\nClick \"Edit\" on your `master` branch protection rule.\n\n#### Option A: Allow App to Bypass (Recommended)\n\nScroll to **\"Allow specified actors to bypass required pull requests\"**:\n- Click \"Add\"\n- Search for your app name\n- Select it\n- Click \"Save changes\"\n\n#### Option B: If App Doesn't Appear in Search\n\nThe app might not show up in the bypass list. Instead:\n\n1. Temporarily disable \"Require a pull request before merging\"\n2. Test the workflow\n3. Re-enable after confirming it works\n\nOR\n\n1. Under \"Restrict who can push to matching branches\":\n - Enable it\n - Add your GitHub App\n - This allows the app to push directly\n\n### Step 3: Verify App Permissions\n\nGo to your app settings: https://github.com/settings/apps\n\n1. Click on your app\n2. Verify permissions:\n - **Contents**: Read and write ✅\n - **Metadata**: Read-only ✅\n3. If permissions are wrong, update them\n4. Go to https://github.com/settings/installations\n5. Click \"Configure\" on your app\n6. Click \"Update\" to refresh permissions\n\n### Step 4: Check Secrets\n\nVerify secrets are set correctly:\n\n1. Go to: https://github.com/robbrad/UKBinCollectionData/settings/secrets/actions\n2. Verify `APP_ID` exists\n3. Verify `APP_PRIVATE_KEY` exists\n4. The private key should include:\n ```\n -----BEGIN RSA PRIVATE KEY-----\n [key content]\n -----END RSA PRIVATE KEY-----\n ```\n\n### Step 5: Test the Workflow\n\nCreate a test PR and merge it to see if it works.\n\n## Alternative: Temporary Workaround\n\nIf you need to release immediately while fixing the app setup:\n\n### Manual Release\n\n```bash\n# 1. Pull latest\ngit checkout master\ngit pull\n\n# 2. Bump version\ncz bump --yes --changelog\n\n# 3. Push (you'll need to temporarily disable branch protection)\ngit push origin master --follow-tags\n```\n\n### Or Use Personal Access Token Temporarily\n\nUpdate `.github/workflows/bump.yml`:\n\n```yaml\n- name: Checkout\n uses: actions/checkout@v5\n with:\n fetch-depth: 0\n token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}\n```\n\nThen:\n1. Create a PAT at: https://github.com/settings/tokens/new\n2. Select scope: `repo`\n3. Add as secret: `PERSONAL_ACCESS_TOKEN`\n4. This will work until you fix the app setup\n\n## Common Issues\n\n### \"Bad credentials\"\n- Private key not copied correctly\n- Missing BEGIN/END lines\n- Extra spaces or line breaks\n\n### \"Resource not accessible by integration\"\n- App doesn't have correct permissions\n- App not installed on repository\n- Need to update app permissions\n\n### \"App not found\"\n- APP_ID is incorrect\n- App was deleted or renamed\n\n## Still Not Working?\n\nIf none of the above works, you have two options:\n\n### Option 1: Use Personal Access Token (Quick Fix)\nSee \"Alternative: Temporary Workaround\" above\n\n### Option 2: Remove Branch Protection for Automation\n1. Create a separate branch protection rule\n2. Exclude `github-actions[bot]` from restrictions\n3. This allows the workflow to push\n\n## Need More Help?\n\nCheck the workflow logs for the exact error message and search for it in:\n- GitHub Actions documentation\n- GitHub App documentation\n- Stack Overflow\n" }, { "path": "docs/manual-tag-fix.md", "content": "# Manual Tag Fix for Version 0.155.0\n\nSince the tag wasn't pushed, you need to manually create and push it to trigger the release.\n\n## Steps:\n\n1. **Pull the latest changes:**\n ```bash\n git checkout master\n git pull\n ```\n\n2. **Create the annotated tag:**\n ```bash\n git tag -a 0.155.0 -m \"Release 0.155.0\"\n ```\n\n3. **Push the tag:**\n ```bash\n git push origin 0.155.0\n ```\n\n4. **Verify:**\n - Check tags: https://github.com/robbrad/UKBinCollectionData/tags\n - Watch the release workflow: https://github.com/robbrad/UKBinCollectionData/actions\n\n## What Was Fixed\n\n1. **bump.yml** - Changed from `--follow-tags` to separate push commands\n2. **pyproject.toml** - Added `annotated_tag = true` to Commitizen config\n\n## Future Releases\n\nThe next merge will automatically:\n1. Create annotated tag\n2. Push commit and tag separately\n3. Trigger release workflow\n4. Publish to PyPI\n\nNo manual intervention needed!\n" }, { "path": "docs/release-quick-reference.md", "content": "# Release Workflow Quick Reference\n\n## Commit Message Cheat Sheet\n\n| Type | Version Bump | Example |\n|------|--------------|---------|\n| `feat:` | Minor (0.152.0 → 0.153.0) | `feat(councils): add Leeds support` |\n| `fix:` | Patch (0.152.0 → 0.152.1) | `fix(selenium): handle timeout` |\n| `feat!:` or `BREAKING CHANGE:` | Major (0.152.0 → 1.0.0) | `feat!: change API format` |\n| `docs:` | None | `docs: update README` |\n| `style:` | None | `style: format code` |\n| `refactor:` | None | `refactor: simplify parser` |\n| `test:` | None | `test: add unit tests` |\n| `chore:` | None | `chore: update dependencies` |\n\n## Workflow Stages\n\n```\nPR → Tests → Merge → Bump (auto) → Tag (auto) → Release (auto) → PyPI (auto)\n```\n\nEverything after merge is fully automated!\n\n## How It Works\n\n1. **Developer**: Create PR with conventional commits\n2. **CI**: Validates commits and runs tests\n3. **Merge**: PR merged to master\n4. **Commitizen**: Analyzes commits, bumps version, updates CHANGELOG\n5. **Git**: Creates tag and pushes\n6. **Release**: Publishes to PyPI and GitHub\n\n## Common Commands\n\n```bash\n# Check current version\npoetry version -s\n\n# Validate before PR\nmake pre-build\n\n# Run tests locally\nmake unit-tests\nmake integration-tests\n\n# Check commit messages\ngit log --oneline\n\n# Manual bump (if needed)\ncz bump --yes --changelog\ngit push origin master --follow-tags\n```\n\n## Troubleshooting\n\n| Problem | Solution |\n|---------|----------|\n| Version bump didn't happen | Check commit message format (must use `feat:` or `fix:`) |\n| Release didn't trigger | Check if tag was created in bump workflow logs |\n| PyPI publish failed | Verify `PYPI_API_KEY` secret is set |\n| Permission error | Verify `APP_ID` and `APP_PRIVATE_KEY` secrets are set |\n| Version files out of sync | Commitizen handles this automatically |\n\n## Required Secrets\n\n- `APP_ID` - GitHub App ID (for protected branches)\n- `APP_PRIVATE_KEY` - GitHub App private key\n- `PYPI_API_KEY` - For PyPI publishing\n- `CODECOV_TOKEN` - For test coverage (optional)\n\n**Note:** Uses GitHub App for secure, non-expiring authentication\n\n## Workflow Files\n\n- `behave_pull_request.yml` - PR tests\n- `lint.yml` - Commit message validation\n- `validate-release-ready.yml` - Pre-merge checks\n- `bump.yml` - Automated version bumping and tagging\n- `release.yml` - Publishing to PyPI and GitHub\n\n## Version Files (Auto-Synced)\n\nCommitizen automatically updates:\n- `pyproject.toml`\n- `custom_components/uk_bin_collection/manifest.json`\n- `custom_components/uk_bin_collection/const.py`\n- `CHANGELOG.md`\n\n## Quick Links\n\n- [Full Documentation](./release-workflow.md)\n- [Setup Checklist](./release-workflow-setup-checklist.md)\n- [Conventional Commits](https://www.conventionalcommits.org/)\n- [Semantic Versioning](https://semver.org/)\n- [Commitizen](https://commitizen-tools.github.io/commitizen/)\n" }, { "path": "docs/release-workflow-branch-protection.md", "content": "" }, { "path": "docs/release-workflow-diagram.md", "content": "# Release Workflow Diagram\n\n```\n┌─────────────────────────────────────────────────────────────────────────────┐\n│ PULL REQUEST STAGE │\n└─────────────────────────────────────────────────────────────────────────────┘\n\n Developer creates PR → master\n ↓\n ┌───────────────────────────────────────────────────────────┐\n │ Automated Checks Run in Parallel: │\n │ │\n │ ✓ behave_pull_request.yml │\n │ - Unit tests (Python 3.12) │\n │ - Integration tests (changed councils only) │\n │ - Parity check (councils/input.json/features) │\n │ │\n │ ✓ lint.yml │\n │ - Validate conventional commit messages │\n │ │\n │ ✓ validate-release-ready.yml │\n │ - Check version file consistency │\n │ - Validate pyproject.toml │\n │ - Verify commitizen config │\n │ │\n │ ✓ hacs_validation.yml │\n │ - Validate Home Assistant integration │\n │ │\n │ ✓ codeql-analysis.yml │\n │ - Security scanning │\n └───────────────────────────────────────────────────────────┘\n ↓\n All checks pass? → YES → Ready to merge\n ↓ NO\n Fix issues and push updates\n\n\n┌─────────────────────────────────────────────────────────────────────────────┐\n│ MERGE TO MASTER STAGE │\n└─────────────────────────────────────────────────────────────────────────────┘\n\n PR merged to master\n ↓\n ┌───────────────────────────────────────────────────────────┐\n │ bump.yml workflow triggers │\n │ │\n │ 1. Commitizen analyzes commits since last tag │\n │ - feat: → minor bump (0.152.0 → 0.153.0) │\n │ - fix: → patch bump (0.152.0 → 0.152.1) │\n │ - BREAKING CHANGE → major bump (0.152.0 → 1.0.0) │\n │ │\n │ 2. Updates version in: │\n │ - pyproject.toml │\n │ - manifest.json │\n │ - const.py │\n │ │\n │ 3. Creates commit: \"bump: version X.Y.Z\" │\n │ │\n │ 4. Creates git tag: X.Y.Z │\n │ │\n │ 5. Pushes commit and tag to master │\n └───────────────────────────────────────────────────────────┘\n ↓\n Tag pushed → Triggers release workflow\n\n\n┌─────────────────────────────────────────────────────────────────────────────┐\n│ RELEASE STAGE │\n└─────────────────────────────────────────────────────────────────────────────┘\n\n Tag X.Y.Z pushed\n ↓\n ┌───────────────────────────────────────────────────────────┐\n │ release.yml workflow triggers │\n │ │\n │ 1. Checkout tagged commit │\n │ │\n │ 2. Install Poetry and dependencies │\n │ │\n │ 3. Verify version matches tag │\n │ (Poetry version == Git tag) │\n │ │\n │ 4. Build Python package │\n │ poetry build → creates dist/*.whl and dist/*.tar.gz │\n │ │\n │ 5. Create GitHub Release │\n │ - Auto-generated release notes │\n │ - Attach build artifacts │\n │ │\n │ 6. Publish to PyPI │\n │ poetry publish → uploads to pypi.org │\n └───────────────────────────────────────────────────────────┘\n ↓\n ┌───────────────────────────────────────────────────────────┐\n │ Release Complete! ✓ │\n │ │\n │ - GitHub Release: github.com/robbrad/.../releases │\n │ - PyPI Package: pypi.org/project/uk-bin-collection │\n │ - HACS Update: Available to Home Assistant users │\n └───────────────────────────────────────────────────────────┘\n\n\n┌─────────────────────────────────────────────────────────────────────────────┐\n│ COMMIT MESSAGE EXAMPLES │\n└─────────────────────────────────────────────────────────────────────────────┘\n\nfeat(councils): add Birmingham City Council support\n→ Minor version bump (0.152.0 → 0.153.0)\n\nfix(selenium): handle connection timeout errors\n→ Patch version bump (0.152.0 → 0.152.1)\n\nfeat(api)!: change date format to ISO 8601\n\nBREAKING CHANGE: API responses now use ISO 8601 dates\n→ Major version bump (0.152.0 → 1.0.0)\n\ndocs: update README with new council instructions\n→ No version bump (documentation only)\n\n\n┌─────────────────────────────────────────────────────────────────────────────┐\n│ TROUBLESHOOTING FLOW │\n└─────────────────────────────────────────────────────────────────────────────┘\n\nIssue: Version bump didn't happen\n ↓\nCheck: Are commits using conventional format?\n ↓ NO → Fix commit messages and force push\n ↓ YES\nCheck: Is PERSONAL_ACCESS_TOKEN set?\n ↓ NO → Add secret in repo settings\n ↓ YES\nCheck: Bump workflow logs for errors\n ↓\nManual fix: Run commitizen locally\n\n─────────────────────────────────────────────\n\nIssue: Release didn't publish\n ↓\nCheck: Was tag created by bump workflow?\n ↓ NO → Check bump workflow logs\n ↓ YES\nCheck: Is PYPI_API_KEY valid?\n ↓ NO → Update secret in repo settings\n ↓ YES\nCheck: Release workflow logs for errors\n ↓\nManual fix: Run poetry publish locally\n\n\n┌─────────────────────────────────────────────────────────────────────────────┐\n│ WORKFLOW DEPENDENCIES │\n└─────────────────────────────────────────────────────────────────────────────┘\n\nSecrets Required:\n├── PERSONAL_ACCESS_TOKEN (for bump workflow)\n│ └── Needs: repo write access\n│\n├── PYPI_API_KEY (for release workflow)\n│ └── Needs: PyPI project upload permissions\n│\n└── CODECOV_TOKEN (for test coverage)\n └── Needs: Codecov project access\n\nEnvironments:\n├── bump (requires approval)\n└── release (requires approval)\n\nConfiguration Files:\n├── pyproject.toml\n│ ├── [tool.poetry] version\n│ └── [tool.commitizen] config\n│\n├── custom_components/uk_bin_collection/manifest.json\n│ └── version field\n│\n└── custom_components/uk_bin_collection/const.py\n └── INPUT_JSON_URL (includes version)\n```\n" }, { "path": "docs/release-workflow-fixes.md", "content": "# Release Workflow Fixes Applied\n\n## Summary\nFixed the release workflow to ensure proper version bumping and release publishing from PR merge to master.\n\n## Issues Identified\n\n1. **Bump workflow wasn't explicitly pushing tags**\n - Commitizen action needed `push: true` parameter\n - No confirmation output of version bump\n\n2. **Release workflow lacked validation**\n - No verification that Poetry version matches git tag\n - Could publish mismatched versions\n\n3. **Missing pre-merge validation**\n - No check that version files are in sync before merge\n - Could lead to failed releases\n\n4. **Inconsistent Poetry installation**\n - Some workflows used `abatilo/actions-poetry`\n - Others used `pipx install poetry`\n\n## Changes Made\n\n### 1. Updated `.github/workflows/bump.yml`\n**Changes:**\n- Added explicit Poetry installation for consistency\n- Added `push: true` to commitizen action to ensure tags are pushed\n- Added version output for debugging\n\n**Why:** Ensures tags are created and pushed, triggering the release workflow\n\n### 2. Updated `.github/workflows/release.yml`\n**Changes:**\n- Added `fetch-depth: 0` to checkout for full git history\n- Renamed \"Run image\" step to \"Install Poetry\" for clarity\n- Added version verification step to ensure Poetry version matches tag\n- Split build and publish into separate steps\n- Added build artifacts to GitHub release\n\n**Why:** Prevents publishing mismatched versions and improves reliability\n\n### 3. Created `.github/workflows/validate-release-ready.yml`\n**New workflow that:**\n- Validates `pyproject.toml` syntax\n- Checks version consistency across files\n- Validates commitizen configuration\n- Runs on every PR\n\n**Why:** Catches version sync issues before merge, preventing failed releases\n\n### 4. Created `docs/release-workflow.md`\n**Comprehensive documentation covering:**\n- Complete workflow stages (PR → Merge → Release)\n- Commit message format and examples\n- Version numbering strategy\n- Troubleshooting guide\n- Manual release procedure\n- Required secrets and environments\n\n**Why:** Provides clear guidance for contributors and maintainers\n\n### 5. Created `docs/release-workflow-diagram.md`\n**Visual documentation showing:**\n- ASCII flow diagrams for each stage\n- Parallel workflow execution\n- Decision points and error handling\n- Commit message examples with version impacts\n- Troubleshooting flows\n- Dependency tree\n\n**Why:** Makes the workflow easy to understand at a glance\n\n## Complete Workflow Flow\n\n```\n1. Developer creates PR\n ↓\n2. Automated tests run (behave, lint, validate)\n ↓\n3. PR approved and merged to master\n ↓\n4. bump.yml triggers:\n - Analyzes commits\n - Bumps version in all files\n - Creates commit \"bump: version X.Y.Z\"\n - Creates and pushes tag X.Y.Z\n ↓\n5. release.yml triggers (on tag push):\n - Verifies version matches tag\n - Builds package\n - Creates GitHub release\n - Publishes to PyPI\n ↓\n6. Release complete!\n```\n\n## Testing the Workflow\n\n### Test 1: Version Validation\n```bash\n# Should pass if versions are in sync\npoetry check\njq -r '.version' custom_components/uk_bin_collection/manifest.json\npoetry version -s\n```\n\n### Test 2: Commit Message Format\n```bash\n# Valid examples:\ngit commit -m \"feat(councils): add new council\"\ngit commit -m \"fix(selenium): handle timeout\"\ngit commit -m \"docs: update README\"\n\n# Invalid examples (will fail lint):\ngit commit -m \"added new feature\"\ngit commit -m \"Fixed bug\"\n```\n\n### Test 3: Manual Version Bump (if needed)\n```bash\n# Bump version\npoetry version patch # or minor/major\n\n# Update manifest\n# Edit custom_components/uk_bin_collection/manifest.json\n\n# Commit and tag\ngit add .\ngit commit -m \"bump: version X.Y.Z\"\ngit tag X.Y.Z\ngit push origin master --tags\n```\n\n## Required Secrets\n\nEnsure these are set in GitHub repository settings:\n\n1. **PERSONAL_ACCESS_TOKEN**\n - Settings → Secrets → Actions\n - Needs: `repo` scope\n - Used by: bump.yml\n\n2. **PYPI_API_KEY**\n - Settings → Secrets → Actions\n - Get from: pypi.org account settings\n - Used by: release.yml\n\n3. **CODECOV_TOKEN**\n - Settings → Secrets → Actions\n - Get from: codecov.io project settings\n - Used by: test workflows\n\n## Verification Checklist\n\nAfter merging these changes:\n\n- [ ] Verify `PERSONAL_ACCESS_TOKEN` secret is set\n- [ ] Verify `PYPI_API_KEY` secret is set\n- [ ] Verify `CODECOV_TOKEN` secret is set\n- [ ] Check bump and release environments exist\n- [ ] Test with a small PR using conventional commits\n- [ ] Monitor bump workflow creates tag\n- [ ] Monitor release workflow publishes to PyPI\n- [ ] Verify GitHub release is created\n- [ ] Check PyPI package is available\n\n## Rollback Plan\n\nIf issues occur:\n\n1. **Disable automatic bumping:**\n - Add `[skip ci]` to commit messages\n - Or temporarily disable bump.yml workflow\n\n2. **Manual release:**\n - Follow manual release procedure in docs/release-workflow.md\n - Use `poetry version` and `poetry publish` directly\n\n3. **Revert workflow changes:**\n - Git revert the workflow file changes\n - Return to previous manual process\n\n## Next Steps\n\n1. Merge these workflow fixes to master\n2. Test with a small feature PR\n3. Monitor the complete flow\n4. Update team documentation if needed\n5. Consider adding release notifications (Slack, Discord, etc.)\n\n## Additional Improvements (Future)\n\nConsider adding:\n- Slack/Discord notifications on release\n- Automated changelog generation\n- Release candidate (RC) workflow for testing\n- Automated rollback on failed releases\n- Release metrics and monitoring\n- Pre-release testing environment\n" }, { "path": "docs/release-workflow-migration.md", "content": "# Release Workflow Migration Guide\n\n## Overview\n\nThe release workflow has been simplified to use Commitizen and GITHUB_TOKEN, eliminating complexity and manual steps.\n\n## What Changed\n\n### Before (Complex)\n- Bump workflow created PRs for version bumps\n- Required PERSONAL_ACCESS_TOKEN secret\n- Manual PR review and merge for version bumps\n- Separate environments with approvals\n- Manual version file syncing\n- Multiple validation steps\n\n### After (Simplified)\n- Bump workflow directly commits and tags on master\n- Uses built-in GITHUB_TOKEN\n- Fully automated after PR merge\n- No environment approvals needed\n- Commitizen auto-syncs all version files\n- Streamlined validation\n\n## Key Improvements\n\n### 1. Removed PERSONAL_ACCESS_TOKEN Requirement\n- **Before**: Required creating and managing a personal access token\n- **After**: Uses built-in `GITHUB_TOKEN` with proper permissions\n- **Benefit**: One less secret to manage and rotate\n\n### 2. Eliminated Bump PRs\n- **Before**: Bump workflow created a PR that needed manual merge\n- **After**: Bump workflow directly commits to master after PR merge\n- **Benefit**: Faster releases, no manual intervention\n\n### 3. Automatic Version Syncing\n- **Before**: Manual checks to ensure version files stayed in sync\n- **After**: Commitizen automatically updates all configured files\n- **Benefit**: No version mismatch errors\n\n### 4. Simplified Configuration\n- **Before**: Complex environment setup with approvals\n- **After**: Simple workflow permissions\n- **Benefit**: Easier to set up and maintain\n\n### 5. Better CHANGELOG Management\n- **Before**: Manual or semi-automated changelog updates\n- **After**: Commitizen automatically generates changelog from commits\n- **Benefit**: Consistent, automated changelog\n\n## Migration Steps\n\n### 1. Set Up GitHub App\nFollow the [GitHub App Setup Guide](./github-app-setup.md) to:\n- Create a GitHub App\n- Install it on your repository\n- Generate a private key\n- Add `APP_ID` and `APP_PRIVATE_KEY` secrets\n\n### 2. Update Secrets\n```bash\n# Add (new requirements)\n+ APP_ID\n+ APP_PRIVATE_KEY\n\n# Keep (still required)\n- PYPI_API_KEY\n- CODECOV_TOKEN (optional)\n\n# Remove (no longer needed)\n- PERSONAL_ACCESS_TOKEN (if you had one)\n```\n\n### 3. Update Workflow Permissions\nEnsure Settings → Actions → General → Workflow permissions:\n- Select \"Read and write permissions\"\n- Enable \"Allow GitHub Actions to create and approve pull requests\"\n\n### 4. Remove Environments (Optional)\nThe `bump` and `release` environments are no longer required, but can be kept if you want manual approval gates.\n\n### 5. Update pyproject.toml\nEnsure Commitizen configuration includes:\n```toml\n[tool.commitizen]\nname = \"cz_conventional_commits\"\nversion_provider = \"poetry\"\nversion_scheme = \"semver\"\nmajor_version_zero = true\ntag_format = \"$version\"\nupdate_changelog_on_bump = true\nversion_files = [\n \"custom_components/uk_bin_collection/manifest.json:version\",\n \"custom_components/uk_bin_collection/manifest.json:requirements\",\n \"custom_components/uk_bin_collection/const.py:INPUT_JSON_URL\"\n]\n```\n\n### 6. Test the New Workflow\n1. Create a test branch with a conventional commit\n2. Open and merge a PR\n3. Watch the automated bump and release workflows\n4. Verify the release appears on PyPI and GitHub\n\n## Workflow Comparison\n\n### Old Workflow\n```\nPR → Tests → Merge → Bump Workflow → Bump PR → Manual Review → Merge Bump PR → Tag → Release\n```\n\n### New Workflow\n```\nPR → Tests → Merge → Bump (auto) → Tag (auto) → Release (auto)\n```\n\n## File Changes\n\n### Modified Files\n- `.github/workflows/bump.yml` - Simplified to direct commit/tag\n- `.github/workflows/release.yml` - Cleaned up and uses GITHUB_TOKEN\n- `.github/workflows/validate-release-ready.yml` - Removed version sync checks\n- `pyproject.toml` - Enhanced Commitizen configuration\n- `docs/release-workflow.md` - Updated documentation\n- `docs/release-workflow-setup-checklist.md` - Simplified checklist\n- `docs/release-quick-reference.md` - Updated quick reference\n\n### New Files\n- `docs/release-workflow-migration.md` - This file\n\n## Rollback Plan\n\nIf you need to rollback to the old workflow:\n\n1. Revert the workflow files:\n ```bash\n git revert \n ```\n\n2. Re-add PERSONAL_ACCESS_TOKEN secret\n\n3. Recreate bump and release environments\n\n## Benefits Summary\n\n✅ Fewer secrets to manage\n✅ Faster release process\n✅ No manual intervention needed\n✅ Automatic version syncing\n✅ Better changelog generation\n✅ Simpler configuration\n✅ Easier to understand and maintain\n\n## Support\n\nIf you encounter issues:\n1. Check workflow logs in GitHub Actions\n2. Review `docs/release-workflow.md`\n3. Verify GITHUB_TOKEN permissions\n4. Ensure conventional commits are used\n5. Check Commitizen configuration\n\n## Next Steps\n\n1. Review the updated documentation\n2. Test the new workflow with a small change\n3. Monitor the first few automated releases\n4. Update team documentation and training\n5. Remove old PERSONAL_ACCESS_TOKEN secret\n\n## Questions?\n\nSee the full documentation:\n- [Release Workflow](./release-workflow.md)\n- [Setup Checklist](./release-workflow-setup-checklist.md)\n- [Quick Reference](./release-quick-reference.md)\n" }, { "path": "docs/release-workflow-setup-checklist.md", "content": "# Release Workflow Setup Checklist\n\nUse this checklist to verify your simplified release workflow is properly configured.\n\n## GitHub Repository Settings\n\n### GitHub App Setup (for protected branches)\n- [ ] Create a GitHub App\n - Go to: https://github.com/settings/apps/new\n - Name: `UKBinCollection Release Bot` (must be unique)\n - Homepage URL: `https://github.com/robbrad/UKBinCollectionData`\n - Uncheck \"Active\" under Webhook\n - Repository permissions:\n - **Contents**: Read and write\n - **Metadata**: Read-only (auto-selected)\n - Where can this be installed: \"Only on this account\"\n - Click \"Create GitHub App\"\n\n- [ ] Install the app on your repository\n - Click \"Install App\" in left sidebar\n - Click \"Install\" next to your account\n - Select \"Only select repositories\"\n - Choose `UKBinCollectionData`\n - Click \"Install\"\n\n- [ ] Generate and save credentials\n - In app settings, scroll to \"Private keys\"\n - Click \"Generate a private key\"\n - Save the downloaded `.pem` file securely\n - Note your **App ID** (shown at top of settings page)\n\n### Secrets Configuration\n- [ ] `APP_ID` is set\n - Path: Settings → Secrets and variables → Actions → Repository secrets\n - Value: Your GitHub App ID (e.g., `123456`)\n\n- [ ] `APP_PRIVATE_KEY` is set\n - Path: Settings → Secrets and variables → Actions → Repository secrets\n - Value: Entire contents of the `.pem` file\n - Include the `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----` lines\n\n- [ ] `PYPI_API_KEY` is set\n - Path: Settings → Secrets and variables → Actions → Repository secrets\n - Get from: https://pypi.org/manage/account/token/\n - Scope: Project-specific or account-wide\n - Test: Should allow publishing packages\n\n- [ ] `CODECOV_TOKEN` is set (optional)\n - Path: Settings → Secrets and variables → Actions → Repository secrets\n - Get from: https://codecov.io/gh/robbrad/UKBinCollectionData/settings\n - Test: Should allow uploading coverage reports\n\n### Branch Protection Rules\n- [ ] `master` branch is protected\n - Path: Settings → Branches → Add rule\n - Branch name pattern: `master`\n - Recommended settings:\n - [x] Require a pull request before merging\n - [x] Require status checks to pass before merging\n - [x] Require branches to be up to date before merging\n\n### Actions Permissions\n- [ ] Workflows have write permissions\n - Path: Settings → Actions → General → Workflow permissions\n - Select: \"Read and write permissions\"\n - [x] Allow GitHub Actions to create and approve pull requests\n\n## Local Configuration\n\n### pyproject.toml\n- [ ] Version is set correctly\n ```toml\n [tool.poetry]\n version = \"X.Y.Z\"\n ```\n\n- [ ] Commitizen is configured\n ```toml\n [tool.commitizen]\n name = \"cz_conventional_commits\"\n version_provider = \"poetry\"\n version_scheme = \"semver\"\n major_version_zero = true\n tag_format = \"$version\"\n update_changelog_on_bump = true\n version_files = [\n \"custom_components/uk_bin_collection/manifest.json:version\",\n \"custom_components/uk_bin_collection/manifest.json:requirements\",\n \"custom_components/uk_bin_collection/const.py:INPUT_JSON_URL\"\n ]\n ```\n\n## Workflow Files\n\n### Required Workflows\n- [ ] `.github/workflows/behave_pull_request.yml` exists\n- [ ] `.github/workflows/lint.yml` exists\n- [ ] `.github/workflows/validate-release-ready.yml` exists\n- [ ] `.github/workflows/bump.yml` exists (simplified)\n- [ ] `.github/workflows/release.yml` exists\n- [ ] `.github/workflows/hacs_validation.yml` exists\n\n### Workflow Configuration\n- [ ] `bump.yml` uses `GITHUB_TOKEN`\n ```yaml\n token: ${{ secrets.GITHUB_TOKEN }}\n ```\n\n- [ ] `bump.yml` runs `cz bump --yes --changelog`\n ```yaml\n - name: Bump version and create tag\n run: cz bump --yes --changelog\n ```\n\n- [ ] `release.yml` uses `PYPI_API_KEY`\n ```yaml\n poetry config pypi-token.pypi \"${{ secrets.PYPI_API_KEY }}\"\n ```\n\n## Testing\n\n### Pre-Merge Testing\n- [ ] Create a test branch\n ```bash\n git checkout -b test/release-workflow\n ```\n\n- [ ] Make a small change with conventional commit\n ```bash\n echo \"# Test\" >> README.md\n git add README.md\n git commit -m \"fix: test release workflow\"\n ```\n\n- [ ] Push and create PR\n ```bash\n git push origin test/release-workflow\n # Create PR on GitHub\n ```\n\n- [ ] Verify workflows run:\n - [ ] `behave_pull_request.yml` runs\n - [ ] `lint.yml` runs\n - [ ] `validate-release-ready.yml` runs\n - [ ] All checks pass\n\n### Post-Merge Testing\n- [ ] Merge the test PR\n- [ ] Verify `bump.yml` runs automatically\n- [ ] Check workflow logs:\n - [ ] Commitizen analyzed commits\n - [ ] Version was bumped in all files\n - [ ] CHANGELOG.md was updated\n - [ ] Commit was created with message `bump: version X.Y.Z`\n - [ ] Tag was created and pushed\n - [ ] No errors in logs\n\n- [ ] Verify `release.yml` runs automatically\n- [ ] Check workflow logs:\n - [ ] Version verification passed\n - [ ] Package was built\n - [ ] GitHub release was created\n - [ ] PyPI publish succeeded\n\n### Verification\n- [ ] Check GitHub releases page\n - URL: https://github.com/robbrad/UKBinCollectionData/releases\n - Latest release should be visible\n - Release notes should be auto-generated\n - Build artifacts should be attached\n\n- [ ] Check PyPI package page\n - URL: https://pypi.org/project/uk-bin-collection/\n - Latest version should be available\n - Package should be installable:\n ```bash\n pip install uk-bin-collection==X.Y.Z\n ```\n\n- [ ] Check version files are synced\n ```bash\n # All should show the same version\n poetry version -s\n jq -r '.version' custom_components/uk_bin_collection/manifest.json\n grep INPUT_JSON_URL custom_components/uk_bin_collection/const.py\n ```\n\n## Rollback Plan\n\nIf something goes wrong:\n\n### Delete Bad Release\n```bash\n# Delete tag locally\ngit tag -d X.Y.Z\n\n# Delete tag remotely\ngit push origin :refs/tags/X.Y.Z\n\n# Delete GitHub release manually on GitHub\n```\n\n### Manual Release\n```bash\n# Bump version with Commitizen\ncz bump --yes --changelog\n\n# Push changes and tags\ngit push origin master --follow-tags\n\n# Or manually build and publish\npoetry build\npoetry publish\n```\n\n## Maintenance\n\n### Regular Checks\n- [ ] Quarterly: Verify PYPI_API_KEY hasn't expired\n- [ ] Quarterly: Update workflow actions to latest versions\n- [ ] Quarterly: Review and update documentation\n\n### Action Updates\nCheck for updates to GitHub Actions:\n- `actions/checkout@v5` → Check for newer version\n- `actions/setup-python@v6` → Check for newer version\n- `abatilo/actions-poetry@v4.0.0` → Check for newer version\n- `ncipollo/release-action@v1` → Check for newer version\n\n## Support\n\nIf you encounter issues:\n\n1. Check workflow logs in GitHub Actions tab\n2. Review documentation in `docs/release-workflow.md`\n3. Verify GITHUB_TOKEN has write permissions\n4. Ensure conventional commits are used\n5. Check Commitizen configuration in pyproject.toml\n\n## Sign-Off\n\n- [ ] All checklist items completed\n- [ ] Test release successful\n- [ ] Documentation reviewed\n\n**Completed by:** _______________ \n**Date:** _______________\n" }, { "path": "docs/release-workflow.md", "content": "# Release Workflow Documentation\n\n## Overview\nThis document describes the complete release workflow from pull request to published release.\n\n## Workflow Stages\n\n### 1. Pull Request Stage\n**Triggers:** When a PR is opened/updated targeting `master` branch\n\n**Workflows that run:**\n- `behave_pull_request.yml` - Runs tests on changed councils\n- `lint.yml` - Validates commit messages follow conventional commits\n- `validate-release-ready.yml` - Validates pyproject.toml and commit messages\n- `hacs_validation.yml` - Validates Home Assistant integration\n\n**What happens:**\n- Unit tests run on Python 3.12\n- Integration tests run only for changed council files\n- Parity check ensures councils, input.json, and feature files are in sync\n- Commit messages are validated against conventional commits format\n- pyproject.toml is validated\n\n**Requirements to merge:**\n- All tests must pass\n- Commit messages must follow conventional commits format\n- Code must pass linting\n\n### 2. Merge to Master Stage\n**Triggers:** When PR is merged to `master` branch\n\n**Workflow that runs:**\n- `bump.yml` - Automatically bumps version and creates release\n\n**What happens:**\n1. Commitizen analyzes commit messages since last tag\n2. Determines version bump type (major/minor/patch) based on conventional commits:\n - `feat:` → minor version bump\n - `fix:` → patch version bump\n - `BREAKING CHANGE:` → major version bump\n3. Updates version in all configured files:\n - `pyproject.toml`\n - `custom_components/uk_bin_collection/manifest.json`\n - `custom_components/uk_bin_collection/const.py`\n4. Updates CHANGELOG.md\n5. Creates a commit with message `bump: version X.Y.Z`\n6. Creates and pushes a git tag `X.Y.Z`\n7. Pushes the commit and tag to master\n\n**Note:** The bump workflow is skipped if the commit message starts with `bump:` to prevent infinite loops.\n\n### 3. Release Stage\n**Triggers:** When a tag is pushed (automatically by bump workflow)\n\n**Workflow that runs:**\n- `release.yml` - Publishes the release\n\n**What happens:**\n1. Checks out the tagged commit\n2. Verifies the Poetry version matches the git tag\n3. Builds the Python package with Poetry\n4. Creates a GitHub release with auto-generated release notes\n5. Publishes the package to PyPI\n6. Attaches build artifacts to the GitHub release\n\n## Commit Message Format\n\nFollow [Conventional Commits](https://www.conventionalcommits.org/) format:\n\n```\n(): \n\n\n\n