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

Fix synology_dsm test side effects #114722

Merged
merged 1 commit into from
Apr 3, 2024
Merged

Conversation

edenhaus
Copy link
Contributor

@edenhaus edenhaus commented Apr 3, 2024

Breaking change

Proposed change

Fix the side effects introduced by synology_dsm by using patch instead of setting tempdir globally

Before this fix the shell_commands tests would fail as they expect tempdir to be None
Can be reproduced with pytest tests/components/synology_dsm/test_media_source.py tests/components/shell_command/test_init.py
Noticed in https://github.com/home-assistant/core/actions/runs/8535313705/job/23382222724

=================================== FAILURES ===================================
____________________________ test_executing_service ____________________________
[gw0] linux -- Python 3.12.2 /home/runner/work/core/core/venv/bin/python3

hass = <HomeAssistant RUNNING>

    async def test_executing_service(hass: HomeAssistant) -> None:
        """Test if able to call a configured service."""
        with tempfile.TemporaryDirectory() as tempdirname:
>           path = os.path.join(tempdirname, "called.txt")

tests/components/shell_command/test_init.py:37: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
<frozen posixpath>:90: in join
    ???
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

funcname = 'join'
args = (b'/tmp/pytest-of-runner/pytest-0/popen-gw0/test_media_view0/tmpgbg9deoo', 'called.txt')
hasstr = True, hasbytes = True, s = 'called.txt'

>   ???
E   TypeError: Can't mix strings and bytes in path components

<frozen genericpath>:167: TypeError

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:

@edenhaus edenhaus added the smash Indicator this PR is close to finish for merging or closing label Apr 3, 2024
@home-assistant
Copy link

home-assistant bot commented Apr 3, 2024

Hey there @hacf-fr, @Quentame, @mib1185, mind taking a look at this pull request as it has been labeled with an integration (synology_dsm) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of synology_dsm can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign synology_dsm Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@edenhaus edenhaus merged commit 74d8c6c into dev Apr 3, 2024
21 checks passed
@edenhaus edenhaus deleted the edenhaus-fix-synology_dsm-tests branch April 3, 2024 09:11
tempfile.tempdir = tmp_path
result = await view.get(request, "mocked_syno_dsm_entry", "10_1298753/filename.jpg")
assert isinstance(result, web.Response)
with patch.object(tempfile, "tempdir", tmp_path):
Copy link
Member

Choose a reason for hiding this comment

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

This is weird. Does this test actually save a file in a temporary directory? The library should just be patched instead and it's enough to assert that the library is called correctly. And of course we shouldn't create the view directly in the test but use our client to make a request to the server endpoint.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The issue was that the test set the tempdir globally with tempfile.tempdir = tmp_path.
As I'm not familiar with the integration I fixed it in the least invasive way, and that was to patch it instead.

Copy link
Member

Choose a reason for hiding this comment

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

Sure. This was just a side note.

@github-actions github-actions bot locked and limited conversation to collaborators Apr 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed has-tests integration: synology_dsm Quality Scale: No score small-pr PRs with less than 30 lines. smash Indicator this PR is close to finish for merging or closing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants