Add uninstall addon suggestion to detached_addon_removed

[mdegat01]

Proposed change

As per discussion today, suggest addon removal if the addon is detached because it has been removed from the repository rather then the repository being removed.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New feature (which adds functionality to the supervisor)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue:
• Link to documentation pull request:
• Link to cli pull request:

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• The code has been formatted using Ruff (ruff format supervisor tests)
• Tests have been added to verify that the new code works.

If API endpoints of add-on configuration are added/changed:

• Documentation added/updated for developers.home-assistant.io

Summary by CodeRabbit

• New Features

  • Introduced a new suggestion type EXECUTE_REMOVE for handling addon removal.
  • Added functionality to fix addon issues by removing them with the new FixupAddonExecuteRemove class.

• Tests

  • Added new test cases for checking the functionality of addon removal and ensuring suggestions are properly managed.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes introduce a new suggestion type called EXECUTE_REMOVE to handle the removal of detached addons. This involves updates to the detached_addon_removed.py check function, creation of a new fixup class FixupAddonExecuteRemove for uninstalling addons, and corresponding tests to ensure the new functionality works as intended.

Changes

File(s)	Change Summary
supervisor/resolution/checks/detached_addon_removed.py	Added SuggestionType import and included EXECUTE_REMOVE in the suggestions list within the run_check function.
supervisor/resolution/fixups/addon_execute_remove.py	Introduced FixupAddonExecuteRemove class for handling addon removal.
tests/resolution/check/test_check_detached_addon_missing.py	Added assertion to check the length of coresys.resolution.suggestions in test_check function.
tests/resolution/check/test_check_detached_addon_removed.py	Updated to include assertions related to suggestions and added SuggestionType import.
tests/resolution/fixup/test_addon_execute_remove.py	Added test_fixup function to test FixupAddonExecuteRemove class functionality.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between f150a19 and d37b386.

Files selected for processing (5)

• supervisor/resolution/checks/detached_addon_removed.py (2 hunks)
• supervisor/resolution/fixups/addon_execute_remove.py (1 hunks)
• tests/resolution/check/test_check_detached_addon_missing.py (1 hunks)
• tests/resolution/check/test_check_detached_addon_removed.py (3 hunks)
• tests/resolution/fixup/test_addon_execute_remove.py (1 hunks)

Files skipped from review due to trivial changes (1)

• tests/resolution/check/test_check_detached_addon_missing.py

Additional comments not posted (2)

supervisor/resolution/checks/detached_addon_removed.py (1)

Line range hint 5-25: Validate the logic for creating suggestions.

The logic for adding suggestions seems correct, but ensure that this does not lead to duplicate suggestions for the same issue. Consider adding a check to see if a similar suggestion already exists before adding a new one.

Verification successful

---

The search results indicate that the suggestions.append logic in free_space.py and module.py does not directly interact with the CheckDetachedAddonRemoved class or its suggestions. Therefore, there is no evidence of duplicate suggestions being created for the same issue within the CheckDetachedAddonRemoved logic.

• free_space.py handles suggestions related to clearing full backups.
• module.py manages the addition of suggestions to a list but does not show any direct interaction with the CheckDetachedAddonRemoved class.

Based on this analysis, the concern about duplicate suggestions for the same issue in the CheckDetachedAddonRemoved class is not substantiated by the current codebase.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify no duplicate suggestions are created.

# Test: Search for duplicate suggestion creation logic.
rg --type python $'suggestions.append' 'supervisor/resolution/checks/detached_addon_removed.py'

Length of output: 123

---

---

Script:

#!/bin/bash
# Description: Verify no duplicate suggestions are created.

# Test: Search for duplicate suggestion creation logic.
rg 'suggestions.append' 'supervisor/resolution/checks/detached_addon_removed.py'

Length of output: 78

---

---

Script:

#!/bin/bash
# Description: Verify no duplicate suggestions are created.

# Test: Search for duplicate suggestion creation logic across the entire repository.
rg 'suggestions.append'

Length of output: 208

---

---

Script:

#!/bin/bash
# Description: Extract relevant code snippets to verify no duplicate suggestions are created.

# Extract code snippets from free_space.py
rg -A 5 -B 5 'suggestions.append' 'supervisor/resolution/checks/free_space.py'

# Extract code snippets from module.py
rg -A 5 -B 5 'self._suggestions.append' 'supervisor/resolution/module.py'

Length of output: 922

tests/resolution/check/test_check_detached_addon_removed.py (1)

Line range hint 12-50: Check consistency in test assertions.

The tests seem well-structured, but ensure that the assertions for suggestions and issues are consistent across all tests. This helps maintain a uniform approach to testing and ensures that all aspects of the functionality are covered.

Verification successful

---

The test assertions in tests/resolution/check/test_check_detached_addon_removed.py appear consistent and thorough. The assertions cover various aspects of the CheckDetachedAddonRemoved functionality, including checking the slug, enabled state, issues, and suggestions.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify consistency in test assertions.

# Test: Search for inconsistent test assertions.
rg --type python $'assert' 'tests/resolution/check/test_check_detached_addon_removed.py'

Length of output: 116

---

---

Script:

#!/bin/bash
# Description: Verify consistency in test assertions.

# Test: Search for inconsistent test assertions.
rg 'assert' tests/resolution/check/test_check_detached_addon_removed.py

Length of output: 1024

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @coderabbitai modularize this function.
• 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[coderabbitai]

Actionable comments posted: 2