Skip to content

Can't update functional test refs #9688

@sshane

Description

@sshane

Bug description

The message counter is checked first before the output text, so we never have a chance to write the updated output file.

Need to flip these two statements:

assert (
expected_messages == actual_messages
), self.error_msg_for_unequal_messages(
actual_messages, expected_messages, actual_output
)
self._check_output_text(expected_messages, expected_output, actual_output)

so this has a chance to run:

def _check_output_text(
self,
_: MessageCounter,
expected_output: list[OutputLine],
actual_output: list[OutputLine],
) -> None:

Configuration

No response

Command used

python tests/test_functional.py -k abstract --update-functional-output

Pylint output

Failure, depending on if you change the refs

Expected behavior

You can update the refs

Pylint version

pylint 3.3.0-dev0
astroid 3.2.2
Python 3.11.4 (main, Jul 20 2023, 22:46:38) [GCC 9.4.0]

OS / Environment

Ubuntu 20.04

Additional dependencies

No response

Activity

added
Needs triage 📥Just created, needs acknowledgment, triage, and proper labelling
on Jun 3, 2024
Pierre-Sassoulas

Pierre-Sassoulas commented on Jun 4, 2024

@Pierre-Sassoulas
Member

It's "by design", writing a new output file is useless (or misleading you into thinking it worked) if the functional test does not output the expected value. That said the functional test is still going to fail the line after, and you're only going to have a temporarily better output file while you fix the issue with the functional test. Feel free to open a MR to change the order :)

added
MaintenanceDiscussion or action around maintaining pylint or the dev workflow
Needs PRThis issue is accepted, sufficiently specified and now needs an implementation
and removed
Needs triage 📥Just created, needs acknowledgment, triage, and proper labelling
on Jun 4, 2024
sshane

sshane commented on Jun 4, 2024

@sshane
Author

Ah, maybe I'm confused about the relationship of the functional test and the output ref. I assumed that the output text file was a reference we compared the pylint output to, without any ignore tags. And the functional test was to assert certain warnings on certain lines.

Nvm that's correct. pylint already outputs "here's what you need to copy/paste" in response to a failed test, so I don't believe fixing this would mislead you any more that it already does.

linked a pull request that will close this issue on Jun 4, 2024
Pierre-Sassoulas

Pierre-Sassoulas commented on Jun 4, 2024

@Pierre-Sassoulas
Member

I assumed that the output text file was a reference we compared the pylint output to, without any ignore tags.

Yes, but I'm not sure if I understand the "without any ignore tags" part.

And the functional test was to assert certain warnings on certain lines.

Yes, or the absence of them, if you have unexpected warning the functional test file fail. (And if the functional test fail file updating the output is going to create a wrong output).

sshane

sshane commented on Jun 4, 2024

@sshane
Author

I just meant running pylint on the whole file, ignoring the warning annotations. Disregard.

Pierre-Sassoulas

Pierre-Sassoulas commented on Jun 4, 2024

@Pierre-Sassoulas
Member

It seems you're already deep in the truth/code so I'm not sure if this part of the doc might help (maybe to get a general idea): https://pylint.readthedocs.io/en/stable/development_guide/contributor_guide/tests/writing_test.html#functional-tests

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    MaintenanceDiscussion or action around maintaining pylint or the dev workflowNeeds PRThis issue is accepted, sufficiently specified and now needs an implementation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @Pierre-Sassoulas@sshane

      Issue actions

        Can't update functional test refs · Issue #9688 · pylint-dev/pylint