Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📌 Pull Request: Refactor & Enhance dbus-opendtu #227

Merged
merged 32 commits into from
Dec 15, 2024
Merged

📌 Pull Request: Refactor & Enhance dbus-opendtu #227

merged 32 commits into from
Dec 15, 2024

Conversation

0x7878
Copy link
Collaborator

@0x7878 0x7878 commented Nov 18, 2024

📌 Pull Request: Refactor & Enhance dbus-opendtu

Hi Team! 👋

This pull request introduces a series of improvements and refactorings to the dbus-opendtu project. The main highlights include enhanced code readability, better testing coverage, and streamlined business logic. Here’s a detailed breakdown:

✨ Main Changes:

  • 🧪 Added Unit Tests:

    • Implemented unit tests for core functionalities.
    • Mocked requests.get to simulate different responses for robust testing scenarios.
    • Configured different test scenarios for comprehensive test coverage.

  • 🔄 Business Logic Updates:

    • Refactored the main Python file for better readability.
    • Centralized update triggers to avoid service-based updates for a more modular design.

🔧 Refactoring Highlights:

  • 📂 Code Structure:

    • Renamed and refactored dbus-opendtu for improved readability and maintainability.
    • Cleaned up test_dbus-opendtu.py by removing unused parameters and constants.
    • Moved constants to appropriate modules for better code organization.
    • Improved import structure for clarity and consistency.

  • 🛠️ Code Simplification:

    • Consolidated redundant code and removed unused paths in the DbusService constructor.
    • Updated logging statements for better traceability.
    • Unified file naming convention to use underscores (_) instead of hyphens (-).
    • Shifted utility functions to helper modules and included unit tests to boost test coverage.
    • Refactored _get_serial, _get_name, and _get_status_url methods for better encapsulation and readability.

🚀 Enhancements:

  • 📝 Test Coverage:

    • Achieved 66% code coverage with a focus on critical paths.
    • Added template and inverter-specific tests to cover more edge cases.
    • Adjusted ahoy_0.5.93_live.json to reflect new test configurations.
    • Relocated tests to the appropriate folder structure for clearer organization.

  • 🔍 Code Quality:

    • Replaced hardcoded values with constants to enhance maintainability.
    • Configured test coverage tools and scripts to ensure ongoing code quality.

image

🙋‍♂️ Request for Support:

I could use your help to push the project towards 100% code coverage. It's a time-consuming task, so any support would be appreciated! If you can contribute by adding tests or enhancing existing ones, that would be fantastic. Let's aim for perfection together! 🚀

Thanks for reviewing! 😊 Feel free to comment or provide feedback.

0x7878 added 30 commits November 11, 2024 15:49
@0x7878
rename and refactor dbus-opendtu
5053731
@0x7878
add basic test wip
3f24b5e
@0x7878
Refactor test_dbus-opendtu.py to remove unused mock_constants paramet…
d21f513 
…er in test_register_service method
@0x7878
since paths is used as constant I moved it
6c2c3a7
@0x7878
Refactor imports in dbus_opendtu.py
1e1190b
@0x7878
Refactor test_dbus-opendtu.py to remove unused mock_constants paramet…
9642657 
…er in test_register_service method
@0x7878
Refactor code to remove unused paths
52e3275
@0x7878
Refactor code to remove unused paths parameter in DbusService constru…
f531c41 
…ctor
@0x7878
Refactor test_dbus-opendtu.py to use register_services instead of reg…
5790d95 
…ister_service
@0x7878
Refactor code to use register_services instead of register_service
0e4e41d
@0x7878
Refactor code to use get_DbusServices instead of register_services
a8e3014
@0x7878
Refactor logging statement to use info level instead of critical
bbf7e7d
@0x7878
move code to add sign_of_life_all_services function and use it to sen…
d2ac513 
…d a 'sign of life' signal to all services
@0x7878
Refactor file paths to use underscore instead of hyphen in dbus_opend…
f806c56 
…tu.py and restart.sh
@0x7878
remove dependency and move code the main function (update routine)
f7367b1
@0x7878
Add constants instead of hardcoded values
2bb1f02
@0x7878
move tests in proper folder
6a43f11
@0x7878
move functions to helpers instead of constants; add unit tests and im…
1ca51d2 
…prove function
@0x7878
Add coverage configuration and script
6370a8e 
- Add .coveragerc file to control coverage.py and exclude certain directories from coverage analysis.
- Add run_coverage.sh script to run unit tests with coverage and generate coverage report.
@0x7878
Refactor code and improve error handling
3645b52 
Move functions to helpers instead of constants, add unit tests, and improve function to handle cases where there are no inverters or templates to query. Also, remove the dependency on running tests within the main function.
@0x7878
Add more tests
a52c72d
@0x7878
Completed Coverage for dbus_opendtu.py: 96%
1807484
@0x7878
Merge branch 'main' of github.com:henne49/dbus-opendtu into feature-a…
2294c0e 
…dd-test
@0x7878
Refactor _get_serial method in dbus_service.py
9d4dc24
@0x7878
Refactor _get_name and _get_status_url methods in dbus_service.py
ad73463
@0x7878
wip working fetch
25104b3
@0x7878
Change number of Inverters in ahoy_0.5.93_live.json
dc11282
@0x7878
Added template and inverter tests
671e87f
@0x7878
Move early fail condition to the right position
dda5731
@0x7878
Refactored _read_config_dtu method and removed unreachable code
ee69fd3 
- Removed unreachable code in the _read_config_dtu method.
- Clarified the logic for reading the DTU variant and other configuration values.
- Ensured that the DTU variant is either constants.DTUVARIANT_OPENDTU or constants.DTUVARIANT_AHOY, raising an error otherwise.
- Improved readability and maintainability of the code.
@0x7878
adjust tests
c6c094f
@0x7878
Add test to verify that number_of_inverters are set
dff4727 
- Added a new test case to verify that the number of inverters is correctly set in the DbusService.
- Configured the test with a specific DTU variant and number of inverters.
- Used mocking to simulate the configuration and requests.
- Included assertions to validate the expected behavior.
@henne49 henne49 marked this pull request as ready for review December 10, 2024 22:34
henne49
henne49 approved these changes Dec 15, 2024
View reviewed changes
Copy link
Owner

@henne49 henne49 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy to approve the code

@henne49 henne49 merged commit 76a10ea into main Dec 15, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@henne49 henne49 henne49 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@0x7878 @henne49