win_lineinfile: windows paths have \r and \n stripped

[dannietjoh]

ISSUE TYPE

Bug Report

COMPONENT NAME

win_lineinfile

ANSIBLE VERSION

ansible 2.4.1.0
  config file = None
  configured module search path = [u'/none/of/your/business', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/local/lib/python2.7/dist-packages/ansible
  executable location = /usr/local/bin/ansible
  python version = 2.7.14 (default, Sep 23 2017, 22:06:14) [GCC 7.2.0]

CONFIGURATION

OS / ENVIRONMENT

SUMMARY

this:

ansible/lib/ansible/modules/windows/win_lineinfile.ps1

Line 348 in e76e8ae

$line = $line.Replace("\r", "`r");

butchers any windows path and also makes regexes fail and destroys idempotency

STEPS TO REPRODUCE

use win_lineinefile to add a windows path containing \r or \n

- win_lineinfile:
    path: C:\temp\testfile.txt
    line: 'C:\path\returning\from\nowhere'

OR

- win_lineinfile:
    path: C:\temp\testfile.txt
    line: "C:\\path\\returning\\from\\nowhere"

EXPECTED RESULTS

file C:\temp\testfile.tx contains C:\path\returning\from\nowhere

ACTUAL RESULTS

file C:\temp\testfile.tx contains C:\patheturning\fromowhere

Current workaround is to use forward slashes, but that requires forward slash compatibility in any program that uses this file

[ansibot]

Files identified in the description:

• lib/ansible/modules/windows/win_lineinfile.ps1

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibot]

cc @brianlloyd @dagwieers @jborean93 @jhawkesworth
click here for bot help

[ansibot]

Files identified in the description:

• lib/ansible/modules/windows/win_lineinfile.py

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibot]

cc @nitzmahone
click here for bot help

[ansibot]

Files identified in the description:

• lib/ansible/modules/windows/win_lineinfile.ps1

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

[nwsparks]

I think there are two ways of approaching this.

1. Always treat line as literal. Multiple lines don't fit into the purpose of the module. I did test the Linux version of this module however, and it does allow line breaks....so this may not be an acceptable answer.
2. Remove this validation block. If people want to insert line breaks they should do it as a PowerShell native/acceptable format.

ansible/lib/ansible/modules/windows/win_lineinfile.ps1

Lines 347 to 352 in e76e8ae

	If ($line) {
	$line = $line.Replace("\r", "`r");
	$line = $line.Replace("\n", "`n");
	$line = $line.Replace("``r", "`r");
	$line = $line.Replace("``n", "`n");
	}

In addition, lines 350-351 don't make sense as they are converting what is an attempt to escape the line break and print it literally, into a line break. I can't see a good reason for doing this conversion.

I'll bring it up in the WWG today.