Improvements

[CoMPaTech]

Summary by CodeRabbit

• New Features

  • Added detailed boolean flags to device data, indicating station/access point role and point-to-point or point-to-multipoint mode.
  • Introduced contribution guidelines to help users securely share and redact device configuration data.

• Bug Fixes

  • Improved fixture naming and test logic to better align with specific device models and modes.
  • Enhanced error handling and validation for malformed device data and discovery packets.

• Chores

  • Updated project version to 0.2.5.
  • Enhanced release workflow for more reliable versioning, publishing, and tagging.
  • Added and replaced device fixture files for improved test coverage and accuracy.
  • Updated .gitignore to exclude macOS system files.

• Documentation

  • Added a new changelog entry summarizing recent improvements.

[coderabbitai]

Walkthrough

This update restructures the GitHub workflow into three jobs for version determination, publishing, and tagging with conditional execution. It enhances device role detection by adding boolean flags for wireless mode characteristics, expands fixture coverage for NanoStation 5AC loco devices, refines test and fixture management, improves error handling in discovery and data deserialization, and adds contributor guidelines for secure data sharing.

Changes

Cohort / File(s)	Change Summary
Workflow Restructuring .github/workflows/merge.yml	Split workflow into determine_version, publishing, and create_tag jobs; added outputs and conditions to control publishing and tagging based on PyPI version existence.
Device Role & Mode Detection airos/airos8.py, airos/data.py	Enhanced derived_data to set boolean flags (station, access_point, ptp, ptmp) based on wireless mode; added new enum member and boolean fields to WirelessMode and Derived dataclass.
Fixtures Update & Expansion fixtures/airos_ap-ptp.json (deleted), fixtures/airos_loco5ac_ap-ptp.json, fixtures/airos_loco5ac_sta-ptp.json	Removed old generic fixture; added detailed device-specific fixtures for NanoStation 5AC loco in AP-PTP and STA-PTP modes.
Test & Script Alignment script/generate_ha_fixture.py, tests/test_stations.py	Updated fixture generation script to use new userdata directory and naming; modified tests to use new fixture names and parameterization; improved JSON formatting.
Error Handling Improvements airos/discovery.py, tests/test_discovery.py, tests/test_airos8.py, tests/test_data.py	Added stricter error raising on malformed packets; new tests for discovery error handling, missing JSON keys, and unknown enum values with logging verification.
Documentation & Metadata CHANGELOG.md, CONTRIBUTE.md, pyproject.toml, .gitignore	Added changelog entry for v0.2.5; new contributor guidelines for secure data sharing; incremented project version; added .DS_Store to .gitignore.

Sequence Diagram(s)

sequenceDiagram
    participant PR as Pull Request
    participant Workflow as GitHub Actions Workflow
    participant PyPI as PyPI
    participant Repo as Git Repository

    PR->>Workflow: Trigger merge.yml on PR merge
    Workflow->>Workflow: determine_version job
    Workflow->>PyPI: Check if version exists
    alt Version does not exist
        Workflow->>Workflow: Set should_publish=true
        Workflow->>Workflow: publishing job
        Workflow->>PyPI: Publish package
        Workflow->>Workflow: create_tag job
        Workflow->>Repo: Create v<package_version> tag
    else Version exists
        Workflow->>Workflow: Set should_publish=false
        Workflow-->>Workflow: Skip publishing and tagging
    end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~18 minutes

Possibly related PRs

• Unbreak workflows #18: Directly related as it introduced the version existence check and conditional publish logic now refined and extended in this PR.
• Fixture generation for derived #36: Related through fixture additions and enhancements to derived_data logic affecting device status representation.
• Bump json to mashumaro #23: Related through improvements in AirOS data modeling and status parsing, complementing changes to derived_data.

Poem

A hop, a skip, a wireless leap,
New flags for modes, more data to keep.
Fixtures fresh as morning dew,
Workflows split for tasks to do.
Contributors, come share your lore—
With careful paws, we grow some more!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3dcddd8 and 022a264.

📒 Files selected for processing (5)

• .gitignore (1 hunks)
• airos/discovery.py (3 hunks)
• tests/test_airos8.py (2 hunks)
• tests/test_data.py (1 hunks)
• tests/test_discovery.py (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• .gitignore

🔇 Additional comments (9)

airos/discovery.py (3)

178-184: LGTM: Improved logging consolidation and error handling.

The consolidation of the log message into a single formatted string improves readability and reduces logging overhead. The comprehensive error message includes all necessary debugging information (TLV type, length, remaining data, hex dump) and the immediate exception raising ensures consistent error handling.

---

197-197: LGTM: Consistent error handling for malformed TLV.

Adding explicit exception raising after logging ensures that malformed TLV type 0x02 packets with unexpected lengths are handled consistently with other validation failures. This prevents potential undefined behavior from continuing to parse malformed data.

---

216-216: LGTM: Consistent validation for uptime TLV.

Adding exception raising for malformed uptime TLV (type 0x0A) maintains consistency with other TLV validation failures. Since uptime expects exactly 4 bytes for a 32-bit unsigned integer, rejecting packets with incorrect lengths is appropriate.

tests/test_data.py (1)

9-54: LGTM: Comprehensive test for unknown enum handling.

This test provides excellent coverage for the graceful handling of unknown enum values:

• Tests both single (Host.netrole) and multiple (Wireless enums) unknown value scenarios
• Verifies that unknown values are properly removed while preserving other fields
• Confirms appropriate warning messages are logged with helpful GitHub issue URL
• Uses proper mocking techniques to isolate the logging behavior

The test design ensures robustness when encountering new enum values not yet supported by the library.

tests/test_airos8.py (2)

11-11: LGTM: Appropriate import for testing dataclass validation.

Adding the MissingField import is necessary for testing the specific exception type raised by mashumaro during dataclass deserialization failures.

---

230-261: LGTM: Comprehensive test for missing required field handling.

This test provides excellent coverage for dataclass deserialization error handling:

• Simulates a realistic scenario with valid JSON missing a required field
• Properly mocks HTTP response and logging to isolate the test
• Verifies both the custom exception type and the underlying mashumaro cause
• Ensures error logging occurs with appropriate message
• Tests the complete error propagation chain from deserialization to custom exception

The test helps ensure robust error handling when devices return incomplete data structures.

tests/test_discovery.py (3)

309-334: LGTM: Thorough test for generic exception handling.

This test provides excellent coverage for the generic exception handling path in datagram_received:

• Properly mocks parse_airos_packet to simulate unexpected errors
• Verifies that generic exceptions are caught and re-raised as AirOSDiscoveryError
• Ensures callback is not called when parsing fails
• Confirms appropriate error logging with expected message content
• Tests the complete error handling flow from parsing failure to exception propagation

---

336-360: LGTM: Comprehensive parameterized test for TLV edge cases.

This parameterized test efficiently covers multiple malformed TLV scenarios:

• Tests wrong TLV length (uptime with 2 bytes instead of 4)
• Tests TLV length exceeding remaining packet data
• Tests unknown TLV types
• Verifies appropriate AirOSEndpointError exceptions with expected messages
• Complements the stricter validation added to the discovery module

The parameterized approach provides good coverage while keeping the test code concise.

---

362-380: LGTM: Proper test for generic OSError handling.

This test provides good coverage for generic OSError scenarios during endpoint creation:

• Tests a different OSError (permission denied) than the specific "address in use" case
• Verifies appropriate AirOSEndpointError with "cannot_connect" message
• Confirms proper resource management by ensuring transport.close is not called when endpoint creation fails
• Complements existing OSError handling tests for comprehensive error coverage

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch improvements

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

❌ Patch coverage is 95.19231% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.37%. Comparing base (4e5c486) to head (c09dc79).
⚠️ Report is 10 commits behind head on main.

Files with missing lines	Patch %	Lines
airos/airos8.py	80.95%	4 Missing ⚠️
airos/discovery.py	75.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##             main      #47       +/-   ##
===========================================
+ Coverage   79.72%   95.37%   +15.64%     
===========================================
  Files           4        9        +5     
  Lines         666     1168      +502     
===========================================
+ Hits          531     1114      +583     
+ Misses        135       54       -81     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[CoMPaTech]

@coderabbitai review please

[coderabbitai]

@CoMPaTech I'll review the changes in this PR for you.

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.