PSRP: Add read_timeout connection parameters

[dagwieers]

SUMMARY

This PR adds read_timeout parameters for PSRP.
The WinRM variant is in #49701.

This PR requires jborean93/pypsrp#13

This relates to #46108

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

WinRM/PSRP

[ansibot]

cc @jborean93 @nitzmahone
click here for bot help

[dagwieers]

@jborean93 I added a check for read_timeout support. Please review !

@nitzmahone What else do we want to do here for WinRM ? Moved to #49701

[jborean93]

I think you should split out the psrp and winrm changes into separate PRs for 2 reasons;

• Not sure when the pywinrm PR will be reviewed and merged so I don't want to hold up these changes making it into psrp
• The current setup with read/connection/operational timeouts and how they relate to Ansible extra vars is a bit convoluted. It will require some more complex kwarg inspection handling and other changes to properly implement.

wrong PR

Fixed version_added

[jborean93]

Just need to change the display.debug to a warning and I'm good with the changes here.

[dagwieers]

Ready for re-review.

Implemented warning()

[jseiser]

Im not able to get this to function.

From my Docker File

pip install git+https://github.com/dagwieers/ansible.git@winrm-psrp-read-timeout pywinrm[credssp] git+https://github.com/pymssql/pymssql.git git+https://github.com/jborean93/pypsrp.git python-ldap pymysql

From Ansible Log

TASK [roles/ansible-role-dc : Check if Public Key Installed] *******************
[WARNING]: ansible_psrp_read_timeout is unsupported by the current psrp version installed
ok: [10.254.74.5]

From My Group Var

ansible_port: 5986 
ansible_connection: psrp 
ansible_psrp_auth: credssp 
ansible_psrp_cert_validation: ignore 
ansible_psrp_connection_timeout: 1800 
ansible_psrp_operation_timeout: 1200 
ansible_psrp_read_timeout: 1100 
ansible_winrm_read_timeout: 1100 
ansible_psrp_reconnection_retries: 10

/ $ ansible --version
ansible 2.8.0.dev0
  config file = None
  configured module search path = [u'/home/jenkins/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python2.7/site-packages/ansible
  executable location = /usr/bin/ansible
  python version = 2.7.15 (default, Aug 16 2018, 14:17:09) [GCC 6.4.0]
/ $ pip show pypsrp
Name: pypsrp
Version: 0.3.1
Summary: PowerShell Remoting Protocol and WinRM for Python
Home-page: https://github.com/jborean93/pypsrp
Author: Jordan Borean
Author-email: jborean93@gmail.com
License: MIT
Location: /usr/lib/python2.7/site-packages
Requires: cryptography, ntlm-auth, requests, six
Required-by: 
/ $ which ansible
/usr/bin/ansible
/ $ python --version
Python 2.7.15
/ $ 

[dagwieers]

@jseiser I don't know why it fails for you. I just verified on a new system and it works as expected. Can you perform the following on your system:

$ python -c 'import pypsrp; print pypsrp.FEATURES'

[jseiser]

@dagwieers

pip install git+https://github.com/jborean93/pypsrp.git

[cicd-docker-devops] docker exec -it 4c078b1ed1c5 /bin/sh                                                                                                                                                                                                                                               8:16:41  ☁  master ☀
/ $ which python
/usr/bin/python
/ $ python --version
Python 2.7.15
/ $ python -c 'import pypsrp; print pypsrp.FEATURES'
['wsman_locale', 'wsman_read_timeout', 'wsman_reconnections']

[dagwieers]

@jseiser Then it is up to you to figure out why this is not working ;-)

ansible/lib/ansible/plugins/connection/psrp.py

Lines 561 to 566 in 153e669

	# Check if PSRP version supports newer read_timeout argument (needs pypsrp 0.3.0+)
	if hasattr(pypsrp, 'FEATURES') and 'wsman_read_timeout' in pypsrp.FEATURES:
	self._psrp_conn_kwargs['read_timeout'] = self._psrp_read_timeout
	elif self._psrp_read_timeout is not None:
	display.warning("ansible_psrp_read_timeout is unsupported by the current psrp version installed, "
	"using ansible_psrp_connection_timeout value for read_timeout instead.")

[jborean93]

Because we set a default value for read_timeout of 30, the current change will always display a warning for a user if they are running on an older version of pypsrp. I think this is an ok tradeoff to make the code simpler and considering this is mostly a new and undocumented connection plugin I doubt many people would be using it right now. Testing it locally I can confirm the values are being passed down to the right location and am happy with the changes here.

[jborean93]

@jseiser I'm not sure why the Ansible environment is not picking up your changes, I've tested this code on both Python 2 and 3 and can confirm it works as expected. The 0.3.0 release of pypsrp contains the changes for the read_timeout configuration so you don't need to install it directly from the master branch, a simple pip install pypsrp will work fine.

[jborean93]

@jseiser so I did come across this issue today but it was because the version of Ansible I was using did not have this PR applied. You would need to make sure you are running from the devel checkout for it to work.

[jseiser]

I rebuilt the container today. And it all worked. No idea what changed, the docker file didn't

…

On Tue, Jan 29, 2019, 6:36 PM Jordan Borean ***@***.*** wrote: @jseiser <https://github.com/jseiser> so I did come across this issue today but it was because the version of Ansible I was using did not have this PR applied. You would need to make sure you are running from the devel checkout for it to work. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#46850 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AEoW56ajsA_RjKxQVPQYF0AXejv5PcgXks5vINrkgaJpZM4XYdCQ> .