Implement cabal upload --doc
#2890
Conversation
This patch was tested with curl, wget and plain-http, but it's still untested on powershell. The wget implementation will only work if the available wget supports the `--method` switch.
This will build (if not given as argument) a doc tarball and upload it to hackage. Closes haskell#2080
|
Thanks for working on this! Can you look into what's causing the Travis failure? |
|
Ok, the upload works on windows, but cabal still reports an error (this is related to the powershell code, which doesn't deal with non-empty response bodies well). There is also some misbehaviour (reporting failure while the upload actually worked) when using curl. I'll look into those two issues, after that the PR should be ready to merge. About the travis build, it seems that there is no longer any failure? Was it restarted? |
This commit refactors the powershell transport to avoid duplication and also fixes a few problems with it: * We now run powershell with the ExecutionPolicy bypass, is required when the default security policy disallows executing unsigned scripts (like our script) * The powershell script itself has been refactored to behave more like curl. In particular, it now prints HTTP status code errors in a nicer way instead of failing with a PowerShell Exception + backtrack. We also now only print the exception message when we get any other exception, since the user is likely not familar with the powershell script at all and the other information is thus only confusing and not helpful at all. * We now handle the case where the server returns some message after a POST or a PUT correctly. Previously, that resulted in the raw bytes being written to stdout before the HTTP status code, which confused the simplistic parser. We now always write the HTTP status code first and decode the bytes as UTF8 before sending them to stdout as well.
This fixes an issue in the curl transport when a text response is returned that doesn't end with a newline from a POST or PUT request. The code expects the HTTP status code to be on a new line, but that is not the case if the response doesn't have a trailing new line. We fix this by always printing a new line before printing the status code. To avoid duplicate new lines, we now strip trailing empty lines at the end of the response.
|
Fixed the remaining errors on Windows and the curl issue. Should be good to merge now. |
|
ping @23Skidoo (hope pinging is OK) |
|
Sorry for the delay. Will take a look now. |
|
LGTM except that small security issue. Also would be nice to see a changelog entry. Thanks again for working on this! |
Passing passwords via command line arguments is insecure: anyone who is able to read the process list on the system can read the passwords as well. For curl, we pass the password via stdin by using the --config option, which allows us to pass arbitrary additional options via stdin. Unfortunately, wget's --config option does not support - for stdin. So we instead use the --input-file option to pass an URI with the password via stdin.
|
@23Skidoo changelog entry added, security issues fixed. I'm not quite sure here about the powershell situation regarding password security: the password is in cleartext in the generated script, so anyone who can read the script also has access to the password. Are the temporary files generated by cabal only readable by the current user? |
The powershell script contains the password, so writing it to a file is a bit unsafe. We know pass it via stdin. This commit also improves the error message for network failures a little bit.
Implement `cabal upload --doc`
|
Merged, thanks! |
This is the second part that was still remaining for the implementation of #2080. I still need to test this on powershell though, I'll report back when I've done that.