Fix windows compatibility (#98)

* Fix infinite loop on windows when searching config

On Windows the root directory includes the drive letter instead of simply being "DIRECTORY_SEPARATOR". This caused an infinite loop.

* Don't use an interactive process on windows

This lets us still watch the folder for changes and execute PHPUnit, we just don't get the benefits of the "runtime settings".

* Hide the manual when running on windows

* Fix OS compatibility PhpunitWatcherTest

* Add note for windows users to README

* Introduce OS utility to avoid code duplication

* Fix typo in Watcher class

Author: spaceemotion

README.md

@@ -67,6 +67,10 @@ Want to pass some arguments to PHPUnit? No problem, just tack them on:
 phpunit-watcher watch --filter=it_can_run_a_single_test
 ```
 
+#### A note for Windows users
+Currently, TTY is not being supported, so any interaction has been disabled. While watching for changes works,
+any arguments for PHPUnit have to be provided when initially calling `phpunit-watcher`.
+
 ## Customization
 
 Certain aspects of the behaviour of the tool can be modified. The file for options may be named `.phpunit-watcher.yml`, `phpunit-watcher.yml` or `phpunit-watcher.yml.dist`. The tool will look for a file in that order.

src/OS.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Spatie\PhpUnitWatcher;
+
+class OS
+{
+    /**
+     * Indicates if the process is being executed in a windows machine.
+     *
+     * @return bool
+     */
+    public static function isOnWindows()
+    {
+        return DIRECTORY_SEPARATOR !== '/';
+    }
+}

src/Screens/Phpunit.php

@@ -94,7 +94,7 @@ protected function writeHeader()
     protected function runTests()
     {
         $result = (new Process(array_merge([$this->phpunitBinaryPath], explode(' ', $this->phpunitArguments))))
-            ->setTty(true)
+            ->setTty(Process::isTtySupported())
             ->run(function ($type, $line) {
                 echo $line;
             });

src/Watcher.php

@@ -4,6 +4,7 @@
 
 use Clue\React\Stdio\Stdio;
 use React\EventLoop\Factory;
+use React\Stream\ThroughStream;
 use Symfony\Component\Finder\Finder;
 use Spatie\PhpUnitWatcher\Screens\Phpunit;
 use Yosymfony\ResourceWatcher\ResourceWatcher;
@@ -29,7 +30,7 @@ public function __construct(Finder $finder, array $options)
 
         $this->loop = Factory::create();
 
-        $this->terminal = new Terminal(new Stdio($this->loop));
+        $this->terminal = new Terminal($this->buildStdio());
 
         $this->options = $options;
     }
@@ -56,4 +57,22 @@ public function startWatching()
 
         $this->loop->run();
     }
+
+    protected function buildStdio()
+    {
+        $output = null;
+
+        if (OS::isOnWindows()) {
+            // Interaction on windows is currently not supported
+            fclose(STDIN);
+
+            // Simple fix for windows compatibility since we don't write a lot of data at once
+            // https://github.com/clue/reactphp-stdio/issues/83#issuecomment-546678609
+            $output = new ThroughStream(static function ($data) {
+                echo $data;
+            });
+        }
+
+        return new Stdio($this->loop, null, $output);
+    }
 }

src/WatcherCommand.php

@@ -40,6 +40,10 @@ protected function determineOptions(InputInterface $input): array
             $options['phpunit']['arguments'] = $commandLineArguments;
         }
 
+        if (OS::isOnWindows()) {
+            $options['hideManual'] = true;
+        }
+
         return $options;
     }
 
@@ -74,17 +78,23 @@ protected function getConfigFileLocation()
 
         while (is_dir($configDirectory)) {
             foreach ($configNames as $configName) {
-                $configFullPath = "{$configDirectory}/{$configName}";
+                $configFullPath = $configDirectory.DIRECTORY_SEPARATOR.$configName;
 
                 if (file_exists($configFullPath)) {
                     return $configFullPath;
                 }
             }
 
-            if ($configDirectory === DIRECTORY_SEPARATOR) {
+            $parentDirectory = dirname($configDirectory);
+
+            // We do a direct comparison here since there's a difference between
+            // the root directories on windows / *nix systems which does not
+            // let us compare it against the DIRECTORY_SEPARATOR directly
+            if ($parentDirectory === $configDirectory) {
                 return;
             }
-            $configDirectory = dirname($configDirectory);
+
+            $configDirectory = $parentDirectory;
         }
     }
 

tests/PhpunitWatcherTest.php

@@ -2,6 +2,7 @@
 
 namespace Spatie\PhpUnitWatcher\Test;
 
+use Spatie\PhpUnitWatcher\OS;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Process\Process;
 
@@ -10,7 +11,7 @@ class PhpunitWatcherTest extends TestCase
     /** @test */
     public function the_watcher_can_be_executed()
     {
-        $process = new Process('./phpunit-watcher');
+        $process = new Process(OS::isOnWindows() ? ['php', 'phpunit-watcher'] : ['./phpunit-watcher']);
 
         $process->run();