win_get_url: Add use_proxy, headers and timeout

[dagwieers]

SUMMARY

This PR includes:

• Add use_proxy parameter
• Add headers parameter
• Renamed username to url_username
• Renamed password to url_password
• Simplify logic
• Create separate CheckModified-File function
• Now use -LiteralPath instead of -Path
• Clean up documentation

This relates to #20160
This fixes #19573

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

win_get_url

ANSIBLE VERSION

v2.4

[jborean93]

Proxy stuff works but there are a few others issues I came across. If you can fix those I'll do a speedy merge before the freeze.

Also looks like you need to rebase this.

[jborean93]

Timeout is not a valid property of WebClient https://msdn.microsoft.com/en-us/library/system.net.webclient(v=vs.110).aspx. Might be best to remove this new feature so we can get the rest in for 2.4 but I'll let you have a look.

[dagwieers]

But this is not a WebClient object, it is a HttpWebRequest object, and it does have a Timeout property. I also see a ConnectTimeout property, which we also could add. https://msdn.microsoft.com/en-us/library/system.net.httpwebrequest(v=vs.110).aspx

[jborean93]

Sorry ignore this line, line 88 is the one that is the invalid property.

[jborean93]

Ditto for timeout

[dagwieers]

So here we do have a WebClient object. It's strange that it worked fine for me, I'll remove the timeout here.

[jborean93]

You will need to set the default to @{} so when call GetEnumerator() in the methods above it won't fail if a user doesn't pass anything in.

[dagwieers]

I assumed that the default would adapt to the type in Ansible, but we don't do that anywhere.
I learned something new today :-)

[jborean93]

dict isn't a real type right now, even if it was I'm not sure if it should. There may be a reason where we need to know if it is null vs when it is an empty dict.

[jborean93]

s/proxy_server/proxy/

[dagwieers]

Good catch !

[jborean93]

Can you add $ErrorActionPreference = 'Stop' to this, would have helped you to pick up some of the errors below and keeps it more inline with other PS modules we have.

[dagwieers]

Done.

[dagwieers]

Typo fixed.

[jborean93]

Thanks the work, merging in for 2.4

[ctal80]

Hi,
I'm not able to use the headers parameter (e.g. headers: 'X-JFrog-Art-Api: AKCp5Z2Y3oz3MRbmpthVW4omH3xymFRzGkrFfacGSbAU7abGDF5nGe6WXkJsM6UFeZqYLmeCx') and getting the following error:

FAILED! => {"changed": false, "module_stderr": "An error occurred while creating the pipeline.\r\n + CategoryInfo : NotSpecified: (:) [], ParentContainsErrorRecordE \r\n xception\r\n + FullyQualifiedErrorId : RuntimeException\r\n \r\nException calling "Add" with "2" argument(s): "The parameter 'name' cannot be \r\nan empty string.\r\nParameter name: name"\r\nAt line:94 char:9\r\n+ $extWebClient.Headers.Add($header.Name, $header.Value)\r\n+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\n + CategoryInfo : NotSpecified: (:) [], ParentContainsErrorRecordE \r\n xception\r\n + FullyQualifiedErrorId : ArgumentException\r\n \r\n\r\n", "module_stdout": "", "msg": "MODULE FAILURE", "rc": 1}
to retry, use: --limit @/home/ad_talcohen/ansibleEval/playbooks/win_package_demo.retry

Can you please advice?

Thanks
Tal

[dagwieers]

@ctal80 Please open a new issue, rather than hijack a closed PR. BTW according to the docs, the input expects a dictionary, but you provide a string.

PS If you open an issue, please provide all details because your current comment is not sufficient to understand what you're doing and how the error relates to what you're doing.

[ctal80]

Hi,

I'm sorry for hijacked the closed PR.

I changed the parameter from string to dictionary e.g {X-JFrog-Art-Api: AKCp5Z2Y3oz3MRbmpthVW4omH3xymFRzGkrFfacGSbAU7abGDF5nGe6WXkJsM6UFeZqYLmeCx}

and now it's working properly and i'm able to download the file.

Thanks

Tal

[dagwieers]

@ctal80 There's still use in opening an issue so we can fix the error-message and better test for the input.