bin/http_test_server not functional on Windows

[TimWolla]

PHP version: 7.4.9

Description

For guzzle/guzzle#2741 I attempted to set up Windows CI. This did not work, because bin/http_test_server cannot be used on Windows as is.

How to reproduce

Within a Guzzle clone attempt to use vendor/bin/http_test_server.bat.

Possible Solution

The issue appears to be that vendor/bin/http_test_server is not a symlink on Windows. Instead the file looks something like this:

#!/usr/bin/env sh

dir=$(cd "${0%[/\\]*}" > /dev/null; cd "../php-http/client-integration-tests/bin" && pwd)

if [ -d /proc/cygdrive ]; then
    case $(which php) in
        $(readlink -n /proc/cygdrive)/*)
            # We are in Cygwin using Windows php, so the path must be translated
            dir=$(cygpath -m "$dir");
            ;;
    esac
fi

"${dir}/http_test_server" "$@"

As ${dir}/http_test_server is executed and not vendor/bin/http_test_server as a symlink the BASH_SOURCE in http_test_server will point to vendor/php-http/client-integration-tests/bin/http_test_server, causing the script to search the autoloader in vendor/php-http/client-integration-tests/bin/../autoload.php:

https://github.com/TimWolla/guzzle/runs/1153859444?check_suite_focus=true

Additional context

From my patched GitHub Actions CI:

++ cd ./vendor/bin
++ cd ../php-http/client-integration-tests/bin
++ pwd
+ dir=/d/a/guzzle/guzzle/vendor/php-http/client-integration-tests/bin
+ '[' -d /proc/cygdrive ']'
+ case $(which php) in
++ which php
++ readlink -n /proc/cygdrive
+ /d/a/guzzle/guzzle/vendor/php-http/client-integration-tests/bin/http_test_server
+++ dirname /d/a/guzzle/guzzle/vendor/php-http/client-integration-tests/bin/http_test_server
++ cd /d/a/guzzle/guzzle/vendor/php-http/client-integration-tests/bin
++ pwd
+ DIR=/d/a/guzzle/guzzle/vendor/php-http/client-integration-tests/bin
+ '[' -f /d/a/guzzle/guzzle/vendor/php-http/client-integration-tests/bin/../autoload.php ']'
+ '[' -f /d/a/guzzle/guzzle/vendor/php-http/client-integration-tests/bin/../vendor/autoload.php ']'

[dbu]

ah, windows and symlinks 😢 .
imho the best approach is that in the integration you are building, you write your own version of that bash script (or make it a .bat file if thats more convenient). that shell script is not complex, but merely a convenience. does that sound reasonable?

[TimWolla]

imho the best approach is that in the integration you are building, you write your own version of that bash script (or make it a .bat file if thats more convenient). that shell script is not complex, but merely a convenience. does that sound reasonable?

In my specific case this is adding Windows CI support for Guzzle. For now I've used the following solution:

https://github.com/guzzle/guzzle/pull/2773/files#diff-e9f950f17198d3d5e3122a44230a09b9R109-R110

Of course I cannot comment on whether the Guzzle maintainers are happy with that. But as I mentioned in the PR over in Guzzle Tobias Nyholm appears to be a contributor to both Guzzle and this repository which makes this somewhat easier.

---

@dbu In any case I suggest adding an else part with an error message and exit 1. It took me quite a long time to figure out why the script silently failed to work until I added the -x to trace the script execution. Can you make an unbureaucratic commit for that or should I create an (untested) PR?

[dbu]

uh, i see what you mean. i created #47 to output a clear error message.