Skip to content

Commit

Permalink
psrp - Fix raw and script tests for connection plugin (ansible#55357)
Browse files Browse the repository at this point in the history
* psrp - Fix raw and script tests for connection plugin

* Fix error propagation with raw in psrp

* uncomment test

(cherry picked from commit fdf9df8)
  • Loading branch information
jborean93 committed Apr 16, 2019
1 parent ca49ae7 commit 6d9afbb
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 22 deletions.
3 changes: 3 additions & 0 deletions changelogs/fragments/psrp-output.yaml
@@ -0,0 +1,3 @@
bugfixes:
- psrp - Fix blank newlines appearing before ``stdout`` when using ``script`` or ``raw`` with the ``psrp`` connection plugin
- psrp - Fix issues with propagating errors back to Ansible with ``raw`` tasks
25 changes: 13 additions & 12 deletions lib/ansible/plugins/connection/psrp.py
Expand Up @@ -282,9 +282,10 @@ def exec_command(self, cmd, in_data=None, sudoable=True):
else:
display.vvv("PSRP: EXEC %s" % script, host=self._psrp_host)
else:
# in other cases we want to execute the cmd as the script
script = cmd
display.vvv("PSRP: EXEC %s" % script, host=self._psrp_host)
# In other cases we want to execute the cmd as the script. We add on the 'exit $LASTEXITCODE' to ensure the
# rc is propagated back to the connection plugin.
script = to_text(u"%s\nexit $LASTEXITCODE" % cmd)
display.vvv(u"PSRP: EXEC %s" % script, host=self._psrp_host)

rc, stdout, stderr = self._exec_psrp_script(script, in_data)
return rc, stdout, stderr
Expand Down Expand Up @@ -563,29 +564,29 @@ def _parse_pipeline_result(self, pipeline):

stdout_list.append(output_msg)

stdout = u"\r\n".join(stdout_list)
if len(self.host.ui.stdout) > 0:
stdout += u"\r\n" + u"".join(self.host.ui.stdout)
stdout_list += self.host.ui.stdout
stdout = u"\r\n".join(stdout_list)

stderr_list = []
for error in pipeline.streams.error:
# the error record is not as fully fleshed out like we usually get
# in PS, we will manually create it here
error_msg = "%s : %s\r\n" \
"%s\r\n" \
command_name = "%s : " % error.command_name if error.command_name else ''
position = "%s\r\n" % error.invocation_position_message if error.invocation_position_message else ''
error_msg = "%s%s\r\n%s" \
" + CategoryInfo : %s\r\n" \
" + FullyQualifiedErrorId : %s" \
% (error.command_name, str(error),
error.invocation_position_message, error.message,
error.fq_error)
% (command_name, str(error), position,
error.message, error.fq_error)
stacktrace = error.script_stacktrace
if self._play_context.verbosity >= 3 and stacktrace is not None:
error_msg += "\r\nStackTrace:\r\n%s" % stacktrace
stderr_list.append(error_msg)

stderr = "\r\n".join(stderr_list)
if len(self.host.ui.stderr) > 0:
stderr += "\r\n" + "".join(self.host.ui.stderr)
stderr_list += self.host.ui.stderr
stderr = u"\r\n".join([to_text(o) for o in stderr_list])

display.vvvvv("PSRP RC: %d" % rc, host=self._psrp_host)
display.vvvvv("PSRP STDOUT: %s" % stdout, host=self._psrp_host)
Expand Down
33 changes: 24 additions & 9 deletions test/integration/targets/win_raw/tasks/main.yml
Expand Up @@ -93,15 +93,30 @@
that:
- "raw_result.stdout_lines[0] == 'wwe=raw'"

# TODO: this test doesn't work anymore since we had to internally map Write-Host to Write-Output
- name: run a raw command with unicode chars and quoted args (from https://github.com/ansible/ansible-modules-core/issues/1929)
raw: Write-Host --% icacls D:\somedir\ /grant "! ЗАО. Руководство":F
register: raw_result2

- name: make sure raw passes command as-is and doesn't split/rejoin args
assert:
that:
- "raw_result2.stdout_lines[0] == '--% icacls D:\\\\somedir\\\\ /grant \"! ЗАО. Руководство\":F'"
- name: unicode tests for winrm
when: ansible_connection != 'psrp' # Write-Host does not work over PSRP
block:
- name: run a raw command with unicode chars and quoted args (from https://github.com/ansible/ansible-modules-core/issues/1929)
raw: Write-Host --% icacls D:\somedir\ /grant "! ЗАО. Руководство":F
register: raw_result2

- name: make sure raw passes command as-is and doesn't split/rejoin args
assert:
that:
- "raw_result2.stdout_lines[0] == '--% icacls D:\\\\somedir\\\\ /grant \"! ЗАО. Руководство\":F'"

- name: unicode tests for psrp
when: ansible_connection == 'psrp'
block:
# Cannot test unicode passed into separate exec as PSRP doesn't run with a preset CP of 65001 which reuslts in ? for unicode chars
- name: run a raw command with unicode chars
raw: Write-Output "! ЗАО. Руководство"
register: raw_result2

- name: make sure raw passes command as-is and doesn't split/rejoin args
assert:
that:
- "raw_result2.stdout_lines[0] == '! ЗАО. Руководство'"

# Assumes MaxShellsPerUser == 30 (the default)

Expand Down
13 changes: 12 additions & 1 deletion test/integration/targets/win_script/tasks/main.yml
Expand Up @@ -67,11 +67,22 @@
assert:
that:
- test_script_with_large_args_result.rc == 0
- test_script_with_large_args_result.stdout == long_string + "\r\n"
- not test_script_with_large_args_result.stderr
- test_script_with_large_args_result is not failed
- test_script_with_large_args_result is changed

- name: check that script ran and received arguments correctly with winrm output
assert:
that:
- test_script_with_large_args_result.stdout == long_string + "\r\n"
when: ansible_connection != 'psrp'

- name: check that script ran and received arguments correctly with psrp output
assert:
that:
- test_script_with_large_args_result.stdout == long_string
when: ansible_connection == 'psrp'

- name: run test script that takes parameters passed via splatting
script: test_script_with_splatting.ps1 @{ This = 'this'; That = '{{ test_win_script_value }}'; Other = 'other'}
register: test_script_with_splatting_result
Expand Down

0 comments on commit 6d9afbb

Please sign in to comment.