Distro Module Preparation/Tests

[harvey0100]

Improvement of unit/functional tests, includes deprecation and new RST docstrings.

• Enhance RST docstrings for all public classes and methods
• Add deprecation warning for autils migration
• Remove from .pylintrc_utils ignore list to enable pylint checking
• Add to autils_migration_announcement workflow

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly refines the avocado.utils.distro module by enhancing its documentation with reStructuredText (RST) docstrings, making the code more understandable and maintainable. It also introduces a deprecation warning for the module, aligning with a broader migration strategy. Furthermore, Pylint checks are now enabled for distro.py, and comprehensive new tests have been added to ensure the accuracy and reliability of the distribution detection mechanisms.

Highlights

• Documentation Enhancement: RST docstrings were added or improved for all public classes and methods within the avocado/utils/distro.py module.
• Deprecation Warning: A deprecation warning was introduced for the avocado.utils.distro module, signaling its eventual migration.
• Pylint Integration: The distro.py module was removed from the .pylintrc_utils ignore list, enabling Pylint checks for this file.
• Test Coverage Expansion: New unit and functional tests were added to improve the coverage and robustness of the distro detection logic.

Ignored Files

• Ignored by pattern: .github/workflows/** (1)
  • .github/workflows/autils_migration_announcement.yml

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request primarily focuses on enhancing the avocado.utils.distro module. It removes distro.py from the pylint ignore list, ensuring code quality checks are applied. The module's docstrings have been refactored for conciseness and consistency, with type hints added to method parameters and return values. A deprecation warning has also been introduced for the distro module. Accompanying these changes, extensive new unit tests have been added for the LinuxDistro class, various Probe methods, regex pattern matching for different distributions, SUSE-specific version parsing, probe registration, and the detect function. A new functional test, DistroDetectLocal, has also been added to verify local distro detection. Finally, the expected test counts in selftests/check.py have been updated to reflect these new additions.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.79%. Comparing base (322254c) to head (76f6c6a).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6291      +/-   ##
==========================================
+ Coverage   73.67%   73.79%   +0.11%     
==========================================
  Files         206      206              
  Lines       22634    22636       +2     
==========================================
+ Hits        16676    16704      +28     
+ Misses       5958     5932      -26     

☔ 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.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.