Add unit tests for helper functions

[Disane87]

🎯 Description

Add unit tests for helper functions in the custom_components/spoolman/helpers/ directory to improve code coverage.

💡 Hints

• Test files go in tests/ directory
• Look at existing test files like tests/test_sensor.py for patterns
• Focus on helpers/ directory functions
• Use pytest framework

✅ Acceptance Criteria

• Add tests for at least 2-3 helper functions
• Tests cover both success and error cases
• All tests pass: pytest tests/
• Code coverage increases

🚀 Getting Started

1. Fork the repository
2. Set up development environment (see CONTRIBUTING.md)
3. Look at custom_components/spoolman/helpers/
4. Create corresponding test files in tests/
5. Run tests locally
6. Submit PR to dev branch

📚 Resources

• Pytest Documentation
• Existing test examples in tests/ directory
• CONTRIBUTING.md for development setup

[dosubot]

To add unit tests for the helper functions in custom_components/spoolman/helpers/, create a new test file like tests/test_helpers.py following the structure of existing test files (e.g., tests/test_sensor.py). Use the pytest framework.

For add_trailing_slash, write tests that check: adding a slash to a string without one, leaving a string with a slash unchanged, and handling an empty string. Since the function doesn't handle non-string inputs, you can skip those cases or expect a failure if you want to be thorough (source).

For the SchemaHelper class (in custom_components/spoolman/schema_helper.py), write tests for each static method:

• For get_spoolman_patch_spool_schema and get_spoolman_use_spool_filament_schema, test valid data (all required and optional fields), missing required fields, wrong types, and out-of-range values.
• For get_config_schema, test valid config, missing required fields, invalid types, and boundary values for ranges. Also, check that default values are set correctly when get_values is True and config_data is provided (source).

Use pytest.raises to assert that invalid inputs raise the expected exceptions. Place your new tests in the tests/ directory and run them with pytest tests/ to ensure they pass and increase code coverage. This approach will cover both success and error cases for at least 2-3 helper functions.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}

   

[souvikchand]

Hi @dosu @Disane87
I am interested in this task. I forked a copy of main branch. I noticed, there is no file called tests/test_sensor.py or any test/ folder.
I can create a folder test/ but I don't have patterns for test files
So can you please guide me about this?

[Disane87]

@souvikchand thank you for the interest in this project — highly appreciated.

At the moment, the tests in this repository are not functional. The current test structure comes from an old template repository and hasn’t been implemented yet. There is also no existing pattern or example such as tests/test_sensor.py.

Experience in writing Python unit tests is limited here, so contributions in this area are more than welcome. Whether already familiar with Python testing or wanting to explore it within this project — feel free to experiment and set up a proper tests/ structure.

It would be great if the work on tests happens in the dev branch so it can be integrated properly into the workflows/CI.

[souvikchand]

@Disane87 thanks for your reply!
I will fork the dev branch and add the tests/ there. I will create PR as soon as it is ready 😊