Process: Enhance docs and tests related to newline handling

pekkaklarck · pekkaklarck · commit bd92295e7156 · 2025-05-21T13:28:10.000+03:00
See #5083.
diff --git a/atest/robot/standard_libraries/process/newlines.robot b/atest/robot/standard_libraries/process/newlines.robot
@@ -9,5 +9,8 @@ Trailing newline is removed
 Internal newlines are preserved
     Check Test Case    ${TESTNAME}
 
+CRLF is converted to LF
+    Check Test Case    ${TESTNAME}
+
 Newlines with custom stream
     Check Test Case    ${TESTNAME}
diff --git a/atest/testdata/standard_libraries/process/newlines.robot b/atest/testdata/standard_libraries/process/newlines.robot
@@ -5,16 +5,27 @@ Resource          process_resource.robot
 Trailing newline is removed
     ${result}=    Run Process    python    -c    import sys; sys.stdout.write('nothing to remove')
     Result should equal    ${result}    stdout=nothing to remove
-    ${result}=    Run Process    python    -c    import sys; sys.stdout.write('one is removed\\n')
-    Result should equal    ${result}    stdout=one is removed
+    ${result}=    Run Process    python    -c    import sys; sys.stdout.write('removed\\n')
+    Result should equal    ${result}    stdout=removed
     ${result}=    Run Process    python    -c    import sys; sys.stdout.write('only one is removed\\n\\n\\n')
     Result should equal    ${result}    stdout=only one is removed\n\n
 
 Internal newlines are preserved
-    ${result}=    Run Process    python    -c    print('1\\n2\\n3')
+    ${result}=    Run Process    python    -c    import sys; sys.stdout.write('1\\n2\\n3\\n')
     Result should equal    ${result}    stdout=1\n2\n3
 
+CRLF is converted to LF
+    ${result}=    Run Process    python    -c    import sys; sys.stdout.write('1\\r\\n2\\r3\\n4')
+    # On Windows \r\n is turned \r\r\n when writing and thus the result is \r\n.
+    # Elsewhere \r\n is not changed when writing and thus the result is \n.
+    # ${\n} is \r\n or \n depending on the OS and thus works as the expected result.
+    Result should equal    ${result}    stdout=1${\n}2\r3\n4
+
 Newlines with custom stream
-    ${result}=    Run Process    python    -c    print('1\\n2\\n3')    stdout=${STDOUT}
-    Result should equal    ${result}    stdout=1\n2\n3    stdout_path=${STDOUT}
+    ${result}=    Run Process    python    -c    import sys; sys.stdout.write('1\\n2\\n3\\n')
+    Result should equal    ${result}    stdout=1\n2\n3
+    ${result}=    Run Process    python    -c    import sys; sys.stdout.write('1\\n2\\r\\n3\\n')    stdout=${STDOUT}
+    Result should equal    ${result}    stdout=1\n2${\n}3    stdout_path=${STDOUT}
+    ${output} =    Get Binary File    ${STDOUT}
+    Should Be Equal    ${output}    1${\n}2\r${\n}3${\n}    type=bytes
     [Teardown]    Safe Remove File    ${STDOUT}
diff --git a/src/robot/libraries/Process.py b/src/robot/libraries/Process.py
@@ -279,8 +279,10 @@ class Process:
     | `Should Be Equal`      | ${stdout}             | ${result.stdout}      |
     | `File Should Be Empty` | ${result.stderr_path} |                       |
 
-    Notice that possible trailing newlines in captured``stdout`` and ``stderr``
-    are removed automatically.
+    Notice that in ``stdout`` and ``stderr`` content possible trailing newline
+    is removed and ``\\r\\n`` converted to ``\\n`` automatically. If you
+    need to see the original process output, redirect it to a file using
+    `process configuration` and read it from there.
 
     = Boolean arguments =
 
