mirror of https://github.com/Second-Hand-Friends/kleinanzeigen-bot.git synced 2026-03-12 10:31:50 +01:00

Files

Jens 89df56bf8b test: strengthen coverage for sessions, logging, and update check (#686 )

## ℹ️ Description
* Strengthen the session/logging/update-check tests to exercise real
resources and guards while bringing the update-check docs in line with
the supported interval units.
- Link to the related issue(s): Issue #N/A

## 📋 Changes Summary
- Reworked the `WebScrapingMixin` session tests so they capture each
`stop` handler before the browser reference is nulled, ensuring cleanup
logic is exercised without crashing.
- Added targeted publish and update-check tests that patch the async
helpers, guard logic, and logging handlers while confirming
`requests.get` is skipped when the state gate is closed.
- Updated `docs/update-check.md` to list only the actually supported
interval units (up to 30 days) and noted the new guard coverage in the
changelog.

### ⚙️ Type of Change
- [x] 🐞 Bug fix (non-breaking change which fixes an issue)
- [ ] ✨ New feature (adds new functionality without breaking existing
usage)
- [ ] 💥 Breaking change (changes that might break existing user setups,
scripts, or configurations)

## ✅ Checklist
- [x] I have reviewed my changes to ensure they meet the project's
standards.
- [x] I have tested my changes and ensured that all tests pass (`pdm run
test`).
- [x] I have formatted the code (`pdm run format`).
- [x] I have verified that linting passes (`pdm run lint`).
- [x] I have updated documentation where necessary.

By submitting this pull request, I confirm that you can use, modify,
copy, and redistribute this contribution, under the terms of your
choice.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Tests**
* Expanded test coverage for publish workflow orchestration and update
checking interval behavior.
* Added comprehensive browser session cleanup tests, including
idempotent operations and edge case handling.
* Consolidated logging configuration tests with improved handler
management validation.
  * Refined test fixtures and assertions for better test reliability.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

2025-11-17 11:02:18 +01:00

2.5 KiB

Raw Blame History

Update Check Feature

Overview

The update check feature automatically checks for newer versions of the bot on GitHub. It supports two channels:

latest: Only final releases
prerelease: Includes pre-releases

Configuration

update_check:
  enabled: true  # Enable/disable update checks
  channel: latest  # One of: latest, prerelease
  interval: 7d    # Check interval (e.g. 7d for 7 days)

Interval Format

The interval is specified as a number followed by a unit:

s: seconds
m: minutes
h: hours
d: days

Examples:

7d: Check every 7 days
12h: Check every 12 hours
30d: Check every 30 days

Validation rules:

Minimum interval: 1 day (1d)
Maximum interval: 30 days (30d, roughly 4 weeks)
Value must be positive
Only supported units are allowed

State File

The update check state is stored in .temp/update_check_state.json. The file format is:

{
  "version": 1,
  "last_check": "2024-03-20T12:00:00+00:00"
}

Fields

version: Current state file format version (integer)
last_check: ISO 8601 timestamp of the last check (UTC)

Migration

The state file supports version migration:

Version 0 to 1: Added version field
Future versions will be migrated automatically

Timezone Handling

All timestamps are stored in UTC:

When loading:
- Timestamps without timezone are assumed to be UTC
- Timestamps with timezone are converted to UTC
When saving:
- All timestamps are converted to UTC before saving
- Timezone information is preserved in ISO 8601 format

Edge Cases

The following edge cases are handled:

Missing state file: Creates new state file
Corrupted state file: Creates new state file
Invalid timestamp format: Logs warning, uses current time
Permission errors: Logs warning, continues without saving
Invalid interval format: Logs warning, performs check
Interval too short/long: Logs warning, performs check

Error Handling

The update check feature handles various error scenarios:

Network errors: Logs error, continues without check
GitHub API errors: Logs error, continues without check
Version parsing errors: Logs error, continues without check
State file errors: Logs error, creates new state file
Permission errors: Logs error, continues without saving

Logging

The feature logs various events:

Check results (new version available, up to date, etc.)
State file operations (load, save, migration)
Error conditions (network, API, parsing, etc.)
Interval validation warnings
Timezone conversion information

2.5 KiB Raw Blame History