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

Ensure coverage entries are sorted #114424

Merged
merged 7 commits into from
Apr 1, 2024

Conversation

epenet
Copy link
Contributor

@epenet epenet commented Mar 29, 2024

Proposed change

Sample:

Integrations: 1256
Invalid integrations: 5

Integration recollect_waste:
* [ERROR] [COVERAGE] homeassistant/components/recollect_waste/sensor.py is unsorted in .coveragerc file

Integration russound_rio:
* [ERROR] [COVERAGE] homeassistant/components/russound_rio/media_player.py is unsorted in .coveragerc file

Integration screenlogic:
* [ERROR] [COVERAGE] homeassistant/components/screenlogic/const.py is unsorted in .coveragerc file

Integration solarlog:
* [ERROR] [COVERAGE] homeassistant/components/solarlog/coordinator.py is unsorted in .coveragerc file

Integration starlingbank:
* [ERROR] [COVERAGE] homeassistant/components/starlingbank/sensor.py is unsorted in .coveragerc file

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • 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:

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
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@epenet epenet requested a review from a team as a code owner March 29, 2024 07:53
@home-assistant home-assistant bot added cla-signed code-quality small-pr PRs with less than 30 lines. labels Mar 29, 2024
@epenet
Copy link
Contributor Author

epenet commented Mar 29, 2024

Linked to #113914

joostlek
joostlek previously approved these changes Mar 29, 2024
@davet2001
Copy link
Contributor

Looks good to me. I don't see any reasons not to sort and just checked that it runs on pre-commit too which will reduce annoyance to developers.

Thanks @epenet!

Aside: beyond this making things even more 'neat and tidy', does having the list sorted enable something that was not possible before?

davet2001
davet2001 previously approved these changes Mar 29, 2024
@epenet
Copy link
Contributor Author

epenet commented Mar 29, 2024

Looks good to me. I don't see any reasons not to sort and just checked that it runs on pre-commit too which will reduce annoyance to developers.

Thanks @epenet!

Aside: beyond this making things even more 'neat and tidy', does having the list sorted enable something that was not possible before?

It's just to be more "neat and tidy".

Your comment made me realise that we could autofix so I implemented it that way instead in 3a880fa

@davet2001
Copy link
Contributor

@epenet I could be missing something, but it looks like 3a880fa just removed the sort functionality you added.

@epenet
Copy link
Contributor Author

epenet commented Mar 29, 2024

@epenet I could be missing something, but it looks like 3a880fa just removed the sort functionality you added.

No, I simply moved the functionnality out of "validate" and into "generate".
This means that pre-commit will sort and save the file for the developper.

@epenet epenet marked this pull request as draft March 29, 2024 10:34
@davet2001
Copy link
Contributor

No, I simply moved the functionnality out of "validate" and into "generate". This means that pre-commit will sort and save the file for the developper.

Ah ok, I see now. In that case maybe the prefix should have a comment pointing to where the autogenerated prefix/suffixes are coming from.

@epenet epenet marked this pull request as ready for review March 29, 2024 10:55
@epenet epenet marked this pull request as draft March 29, 2024 10:56
@epenet
Copy link
Contributor Author

epenet commented Mar 29, 2024

I've added the comment.
Sadly - it looks like we need to have both bits of code:

  • in validate to show a message on CI
  • in generate to autofix locally

@epenet epenet marked this pull request as ready for review March 29, 2024 11:10
@epenet epenet dismissed stale reviews from davet2001 and joostlek March 29, 2024 12:38

Obsolete

Copy link
Contributor

@davet2001 davet2001 left a comment

Choose a reason for hiding this comment

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

Looks good to me

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Thanks!

@MartinHjelmare
Copy link
Member

Merging dev to check again before merge.

@epenet epenet merged commit ad35778 into home-assistant:dev Apr 1, 2024
31 checks passed
@epenet epenet deleted the epenet-20240329-0851 branch April 1, 2024 12:12
@epenet
Copy link
Contributor Author

epenet commented Apr 1, 2024

Thanks all 👍

@github-actions github-actions bot locked and limited conversation to collaborators Apr 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed code-quality small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants