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.

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

Remove netdaemon support #3588

Merged
merged 4 commits into from
Jul 5, 2024
Merged

Remove netdaemon support #3588

merged 4 commits into from
Jul 5, 2024

Conversation

emontnemery
Copy link
Contributor

@emontnemery emontnemery commented Apr 9, 2024

Remove deprecated netdaemon support

@emontnemery emontnemery marked this pull request as draft April 9, 2024 06:27
@emontnemery
Copy link
Contributor Author

emontnemery commented Apr 9, 2024

HacsConfiguration.update_from_dict needs to be adjusted to ignore saved netdaemon configuration

Edit:
Fixed + test added

@emontnemery emontnemery added the Breaking Change Added to pull requests that adds a breaking change label Apr 12, 2024
@emontnemery emontnemery marked this pull request as ready for review May 24, 2024 09:02
@emontnemery
Copy link
Contributor Author

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented May 24, 2024

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.

Copy link
Contributor

coderabbitai bot commented May 24, 2024

Walkthrough

Walkthrough

The updates focus on the removal of netdaemon related configurations and test cases. This includes deleting specific tests checking netdaemon features, altering JSON configuration files to exclude netdaemon options, and refining the code format for better readability. Collectively, these changes streamline the codebase by discarding obsolete or unnecessary components linked to netdaemon.

Changes

Files Change Summary
tests/hacsbase/…/test_backup.py, tests/helpers/download/…/test_… Removed test_netdaemon_backup and test_gather_netdaemon_files_base.
tests/snapshots/diagnostics/… Removed netdaemon options and settings from JSON configuration files.
tests/test_config_flow.py Reformatted code for improved structure and readability.
tests/utils/test_validate.py Removed "netdaemon" string from the list tested in test_critical_repo_data_json_schema_bad_data.

Sequence Diagram(s)

No sequence diagrams are needed as the changes are focused on code cleanup and reformatting without introducing new features or altering existing control flow mechanisms.


Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 7d41e23 and 86fbe60.

Files selected for processing (21)
  • action/action.py (1 hunks)
  • custom_components/hacs/base.py (3 hunks)
  • custom_components/hacs/config_flow.py (2 hunks)
  • custom_components/hacs/diagnostics.py (1 hunks)
  • custom_components/hacs/enums.py (1 hunks)
  • custom_components/hacs/repositories/init.py (2 hunks)
  • custom_components/hacs/repositories/base.py (4 hunks)
  • custom_components/hacs/translations/en.json (1 hunks)
  • custom_components/hacs/utils/backup.py (1 hunks)
  • custom_components/hacs/utils/configuration_schema.py (1 hunks)
  • custom_components/hacs/utils/path.py (2 hunks)
  • custom_components/hacs/utils/validate.py (1 hunks)
  • tests/conftest.py (3 hunks)
  • tests/hacsbase/test_backup.py (2 hunks)
  • tests/hacsbase/test_configuration.py (2 hunks)
  • tests/helpers/download/test_gather_files_to_download.py (1 hunks)
  • tests/output/proxy_calls.json (2 hunks)
  • tests/snapshots/diagnostics/base.json (2 hunks)
  • tests/snapshots/diagnostics/exception.json (2 hunks)
  • tests/test_config_flow.py (10 hunks)
  • tests/utils/test_validate.py (1 hunks)
Additional context used
Path-based instructions (3)
tests/snapshots/diagnostics/exception.json (1)

Pattern tests/**/*.json: Never suggest changes to the JSON files located under the tests directory

tests/snapshots/diagnostics/base.json (1)

Pattern tests/**/*.json: Never suggest changes to the JSON files located under the tests directory

tests/output/proxy_calls.json (1)

Pattern tests/**/*.json: Never suggest changes to the JSON files located under the tests directory

Additional comments not posted (17)
tests/hacsbase/test_backup.py (1)

5-5: Import statement is correct.

The import statement for Backup is necessary for the test cases.

tests/hacsbase/test_configuration.py (1)

49-55: LGTM!

The new test function test_ignore_netdaemon correctly verifies that the netdaemon setting is ignored.

tests/snapshots/diagnostics/exception.json (1)

10-10: Approved: Removed netdaemon option.

The removal of the netdaemon option is consistent with the PR objectives to remove deprecated support.

custom_components/hacs/utils/backup.py (1)

Line range hint 1-70:
No changes detected.

This file has no changes related to the removal of netdaemon support.

tests/snapshots/diagnostics/base.json (1)

10-10: Approved: Removed netdaemon option.

The removal of the netdaemon option is consistent with the PR objectives to remove deprecated support.

action/action.py (1)

Line range hint 1-111:
No changes detected.

This file has no changes related to the removal of netdaemon support.

tests/helpers/download/test_gather_files_to_download.py (1)

Line range hint 1-1:
Confirm removal of test_gather_netdaemon_files_base.

The test function test_gather_netdaemon_files_base has been removed, aligning with the objective of removing netdaemon support.

tests/test_config_flow.py (6)

70-71: Confirm formatting improvements.

The formatting improvements enhance code readability without changing functionality.


149-150: Confirm formatting improvements.

The formatting improvements enhance code readability without changing functionality.


197-198: Confirm formatting improvements.

The formatting improvements enhance code readability without changing functionality.


267-268: Confirm formatting improvements.

The formatting improvements enhance code readability without changing functionality.


300-301: Confirm formatting improvements.

The formatting improvements enhance code readability without changing functionality.


324-325: Confirm formatting improvements.

The formatting improvements enhance code readability without changing functionality.

tests/conftest.py (1)

Line range hint 1-200:
No changes detected.

This file does not contain any marked changes.

tests/utils/test_validate.py (1)

Line range hint 1-200:
LGTM! "netdaemon" removal confirmed.

The removal of the "netdaemon" string from the test data is consistent with the PR objective to remove deprecated netdaemon support. The rest of the test function remains logical and functional.

custom_components/hacs/base.py (1)

143-145: LGTM! "netdaemon" removal confirmed.

The removal of the "netdaemon" key from the update_from_dict method is consistent with the PR objective to remove deprecated netdaemon support. The rest of the method remains logical and functional.

tests/output/proxy_calls.json (1)

Line range hint 1-1:
JSON Structure Validation

The JSON structure appears to be correctly formatted and valid. No issues found.


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
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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range and nitpick comments (7)
custom_components/hacs/repositories/__init__.py (1)

Line range hint 1-14: Potential oversight: HacsNetdaemonRepository removal not reflected.

It appears that the removal of HacsNetdaemonRepository is not reflected in this file. Please verify if this is an oversight and if the repository should indeed be removed from the REPOSITORY_CLASSES dictionary.

custom_components/hacs/utils/path.py (1)

Line range hint 9-9: Remove unused import.

- from ..base import HacsConfiguration

The import HacsConfiguration is unused and should be removed to clean up the code.

custom_components/hacs/enums.py (1)

Line range hint 1-60: Potential oversight: NETDAEMON enum removal not reflected.

It appears that the removal of the NETDAEMON enum is not reflected in this file. Please verify if this is an oversight and if the enum should indeed be removed.

tests/test_config_flow.py (1)

Line range hint 13-13: The import of HacsBase is unused and should be removed to clean up the code.

- from custom_components.hacs.base import HacsBase
tests/conftest.py (1)

Line range hint 5-5: The import of OrderedDict is unused and should be removed to clean up the code.

- from collections import OrderedDict
tests/utils/test_validate.py (1)

Line range hint 17-17: Correct the typographical error in the function name.

- def test_hacs_manufest_json_schema():
+ def test_hacs_manifest_json_schema():
tests/output/proxy_calls.json (1)

[!TIP]
Codebase Verification

The search results indicate that there are still multiple references to appdaemon in the tests/output/proxy_calls.json file. This suggests that the removal of netdaemon support might not be fully complete, as appdaemon-related entries are still present.

  • Lines referencing appdaemon in various test cases and API calls need to be reviewed and potentially removed or updated to align with the PR's objective of removing netdaemon support.

Locations in the codebase that need attention:

  • tests/helpers/download/test_gather_files_to_download.py
  • tests/repositories/test_download_repository.py
  • tests/repositories/test_remove_repository.py
  • tests/repositories/test_update_repository.py
  • tests/scripts/data/test_generate_category_data.py
  • tests/test_data_client.py
  • tests/test_update.py
Analysis chain

Line range hint 1-1: Ensure removal of all netdaemon-related entries.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that no netdaemon-related entries exist in the proxy_calls.json file.

# Test: Search for 'netdaemon' in the file. Expect: No occurrences.
rg --type json 'netdaemon' tests/output/proxy_calls.json

Length of output: 56



Script:

#!/bin/bash
# Description: Verify that no netdaemon-related entries exist in the proxy_calls.json file by searching for additional potential keywords.

# Test: Search for 'netdaemon', 'NetDaemon', 'netd', and 'daemon' in the file. Expect: No occurrences.
rg --type json 'netdaemon|NetDaemon|netd|daemon' tests/output/proxy_calls.json

Length of output: 7001

@ludeeus
Copy link
Member

ludeeus commented Jul 5, 2024

@coderabbitai full review

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

custom_components/hacs/repositories/base.py Show resolved Hide resolved
@ludeeus ludeeus merged commit 5ba94e2 into hacs:main Jul 5, 2024
23 checks passed
@hacs-bot hacs-bot bot added this to the next milestone Jul 5, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Jul 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Breaking Change Added to pull requests that adds a breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants