Strange behavior between file.comment and file.uncomment

[ArthurREGNARD]

Description of Issue

I can't comment and uncomment the same line in a file with the same regex.

Setup

An example.sls:

edit_file:
  file.managed:
    - name: /tmp/test
    - contents: |
        /dev/mapper/centos-swap swap                    swap    defaults        0 0

# Here the content of the file is in not commented line state : OK

comment_file:
  file.comment:
    - name: /tmp/test
    - regex: "^.*swap.*$"

# Here the content of the file is in commented line state : OK

uncomment_file:
  file.uncomment:
    - name: /tmp/test
    - regex: "^.*swap.*$"

# Here the state return  comment : Pattern already uncommented
# But the line still commented. 

Steps to Reproduce Issue

Up.

Versions Report

[root@master ~]# salt --versions-report
Salt Version:
           Salt: 2019.2.3

Dependency Versions:
           cffi: Not Installed
       cherrypy: Not Installed
       dateutil: Not Installed
      docker-py: Not Installed
          gitdb: Not Installed
      gitpython: Not Installed
          ioflo: Not Installed
         Jinja2: 2.8.1
        libgit2: Not Installed
        libnacl: Not Installed
       M2Crypto: 0.35.2
           Mako: Not Installed
   msgpack-pure: Not Installed
 msgpack-python: 0.5.6
   mysql-python: Not Installed
      pycparser: Not Installed
       pycrypto: Not Installed
   pycryptodome: Not Installed
         pygit2: Not Installed
         Python: 3.6.8 (default, Aug  7 2019, 17:28:10)
   python-gnupg: Not Installed
         PyYAML: 3.12
          PyZMQ: 15.3.0
           RAET: Not Installed
          smmap: Not Installed
        timelib: Not Installed
        Tornado: 4.4.2
            ZMQ: 4.1.4

System Versions:
           dist: centos 7.6.1810 Core
         locale: UTF-8
        machine: x86_64
        release: 3.10.0-957.1.3.el7.x86_64
         system: Linux
        version: CentOS Linux 7.6.1810 Core

[ArthurREGNARD]

Related with #24907 ?

[ArthurREGNARD]

Related with #55085 ?

[DmitryKuzmenko]

@ArthurREGNARD the problem is in your regex: it's too greedy. It matches both commented and not commented lines in your file. So state thinks your line is already uncommented because it matched with your regex.
Try to use something like ^[^#].*swap.*$.
You could omit ^ and $ symbols, btw: [^#].*swap.*.

[DmitryKuzmenko]

Feel free to re-open this if you'll have more questions, though.

[ArthurREGNARD]

I'm not agree, the documentation say :

A regular expression used to find the lines that are to be uncommented.
This regex should not include the comment character. <<<<<<<<<<<<<<<<<< HERE !!
A leading ^ character will be stripped for convenience (for easily switching between comment() and uncomment()). <<<<<<<<<<<<<<<< HERE !!
The regex will be searched for from the beginning of the line, ignoring leading spaces (we prepend '^[ t]*')

https://docs.saltstack.com/en/latest/ref/states/all/salt.states.file.html#salt.states.file.uncomment

[ArthurREGNARD]

@DmitryKuzmenko I can't re-open.

[OrangeDog]

Possibly same issue as #54260

[sagetherage]

@ArthurREGNARD does this look similar to #54260?

[DmitryKuzmenko]

@ArthurREGNARD sorry for that I didn't know =) I've reopened this

[DmitryKuzmenko]

@OrangeDog @sagetherage it's not. I've just checked the issue #54260 is fixed.

[DmitryKuzmenko]

What about this one now I see this is confusing for users so we should consider possibility of fixing this if it's possible.

[OrangeDog]

I've just checked the issue #54260 is fixed.

Confirmed it's not fixed.

[DmitryKuzmenko]

@OrangeDog anyway this one is another issue, not the same as #54260.