Fix file comment

[mbunkus]

What does this PR do?

It fixes both the file.comment and file.uncomment state functions's behavior: both failed to do anything if the pattern is present in both commented and uncommented form.

What issues does this PR fix or reference?

It fixes #41818.

Previous Behavior

When both commented and uncommented lines with the pattern existed, both states did nothing and reported that the pattern was already (un)commented. Lines that could be (un)commented were not.

New Behavior

The logic is reversed. If there's at least one line to (un)comment, all relevant lines will be (un)commented. Only if there's nothing to do will a search for an already (un)commented line be made in order to make the return message more meaningful (either "pattern already (un)commented" or "pattern not found").

Tests written?

No

Commits signed with GPG?

Yes

[twangboy]

@mbunkus Looks like this is causing some test failures.

[mbunkus]

I'll be out of town for several days. I'd appreciate it if someone else could fix up the tests. If not, I'll try to get around to it end of next week or so.

[mbunkus]

I cannot run the tests at the moment. I've never done that before, so I don't know what the problem might be.

I have a venv set up & activated; it's the one I use for running my changed states/modules. I did read HACKING.rst and installed the dev requirements for Python 2.7 in the venv. However, running ./setup.py test results in:

# tons of messages about installing stuff, then:
running test
Traceback (most recent call last):
  File "/home/mosu/prog/salt/tests/runtests.py", line 61, in <module>
    from tests.integration import TestDaemon  # pylint: disable=W0403
  File "/home/mosu/prog/salt/tests/integration/__init__.py", line 34, in <module>
    from tests.support.processes import *  # pylint: disable=wildcard-import
  File "/home/mosu/prog/salt/tests/support/processes.py", line 18, in <module>
    from pytestsalt.utils import collect_child_processes, terminate_process, terminate_process_list  # pylint: disable=unused-import
ImportError: No module named pytestsalt.utils

Yeah… there's no file or directory whose name contains pytestsalt:

[0 mosu@sweet-chili (fix-file-comment) ~/prog/salt] find -iname '*pytestsalt*'
[0 mosu@sweet-chili (fix-file-comment) ~/prog/salt] find ~/opt/salt-dev/ -iname '*pytestsalt*'
[0 mosu@sweet-chili (fix-file-comment) ~/prog/salt]

So… what now?

[mbunkus]

Oh, pip install -r requirements/pytest.txt seems to fix that problem. Looks like HACKING.rst is outdated.

[mbunkus]

I've fixed the unit test logic to accommodate the change to the file.(un)comment state functions. That test (unit.states.test_file) passes for me now and should hopefully pass on the builders as well.