up: add new method for find bin file

Author: inhere

.github/workflows/php.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [7.3, 7.4] # 7.2,
+        php: [7.2, 7.3, 7.4] #
         os: [ubuntu-latest, macOS-latest] # windows-latest,
 
     steps:
@@ -49,4 +49,4 @@ jobs:
       # Docs: https://getcomposer.org/doc/articles/scripts.md
 
       - name: Run test suite
-        run: echo 'hello'
+        run: phpunit -vv

.gitignore

@@ -7,4 +7,5 @@ composer.lock
 *.log
 *.pid
 *.patch
+*.cache
 .DS_Store

phpunit.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" backupStaticAttributes="false" bootstrap="test/bootstrap.php" colors="false" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="Php Library Test Suite">
+      <directory>test/</directory>
+    </testsuite>
+  </testsuites>
+</phpunit>

phpunit.xml.dist

@@ -15,12 +15,14 @@
 use function exec;
 use function function_exists;
 use function implode;
+use function is_file;
 use function ob_start;
 use function preg_match;
 use function preg_replace;
 use function shell_exec;
 use function system;
 use function trim;
+use const DIRECTORY_SEPARATOR;
 
 /**
  * Class Sys
@@ -281,4 +283,43 @@ public static function getMemUsage(string $program)
 
         return exec('ps aux | grep ' . $program . ' | grep -v grep | grep -v su | awk {"print $4"}');
     }
+
+    /**
+     * find executable file by input
+     *
+     * Usage:
+     *
+     * ```php
+     * $phpBin = Sys::findExecutable('php');
+     * echo $phpBin; // "/usr/bin/php"
+     * ```
+     *
+     * @param string $name
+     * @param array  $paths The dir paths for find bin file. if empty, will read from env $PATH
+     *
+     * @return string
+     */
+    public static function findExecutable(string $name, array $paths = []): string
+    {
+        $paths = $paths ?: self::getEnvPaths();
+
+        foreach ($paths as $path) {
+            $filename = $path . DIRECTORY_SEPARATOR . $name;
+            if (is_file($filename)) {
+                return $filename;
+            }
+        }
+        return "";
+    }
+
+    /**
+     * @param string $name
+     * @param array  $paths
+     *
+     * @return bool
+     */
+    public static function isExecutable(string $name, array $paths = []): bool
+    {
+        return self::findExecutable($name, $paths) !== "";
+    }
 }

src/Sys.php

@@ -11,6 +11,7 @@
 
 use Toolkit\Stdlib\OS;
 use function defined;
+use function explode;
 use function getenv;
 use function putenv;
 
@@ -71,4 +72,18 @@ public static function setEnv(string $key, $value): bool
     {
         return putenv($key . '=' . $value);
     }
+
+    /**
+     * @return array
+     */
+    public static function getEnvPaths(): array
+    {
+        $pathStr = $_SERVER['PATH'] ?? '';
+        if (!$pathStr) {
+            return [];
+        }
+
+        $sepChar = self::isWindows() ? ';' : ':';
+        return explode($sepChar, $pathStr);
+    }
 }

src/SysEnv.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types=1);
+
+namespace Toolkit\SysTest;
+
+use PHPUnit\Framework\TestCase;
+use Toolkit\Sys\Sys;
+use function vdump;
+
+/**
+ * Class SysTest
+ *
+ * @package Toolkit\SysTest
+ */
+class SysTest extends TestCase
+{
+    public function testGetEnvPaths(): void
+    {
+        self::assertNotEmpty($paths = Sys::getEnvPaths());
+
+        vdump($paths);
+    }
+
+    public function testFindExecutable(): void
+    {
+        self::assertTrue(Sys::isExecutable('php'));
+        self::assertNotEmpty($path = Sys::findExecutable('php'));
+        vdump($path);
+        self::assertEmpty(Sys::findExecutable('php', ['not-exist-dir']));
+        self::assertFalse(Sys::isExecutable('php', ['not-exist-dir']));
+    }
+}

test/SysTest.php

@@ -29,3 +29,9 @@
         include $file;
     }
 });
+
+if (is_file(dirname(__DIR__, 3) . '/autoload.php')) {
+    require dirname(__DIR__, 3) . '/autoload.php';
+} elseif (is_file(dirname(__DIR__) . '/vendor/autoload.php')) {
+    require dirname(__DIR__) . '/vendor/autoload.php';
+}