Add tools support

2025-07-23 23:29:07 +07:00 · 2019-12-27 06:56:49 +05:30
parent 273096b82f
commit de32d8b95f
13 changed files with 556 additions and 112 deletions
--- a/src/config.ts
+++ b/src/config.ts
@ -8,7 +8,7 @@ import * as utils from './utils';
 export async function addINIValuesUnix(
  ini_values_csv: string
 ): Promise<string> {
-  const ini_values: Array<string> = await utils.INIArray(ini_values_csv);
+  const ini_values: Array<string> = await utils.CSVArray(ini_values_csv);
  let script = '\n';
  await utils.asyncForEach(ini_values, async function(line: string) {
    script +=
@ -25,7 +25,7 @@ export async function addINIValuesUnix(
 export async function addINIValuesWindows(
  ini_values_csv: string
 ): Promise<string> {
-  const ini_values: Array<string> = await utils.INIArray(ini_values_csv);
+  const ini_values: Array<string> = await utils.CSVArray(ini_values_csv);
  let script = '\n';
  await utils.asyncForEach(ini_values, async function(line: string) {
    script +=
--- a/src/install.ts
+++ b/src/install.ts
@ -3,6 +3,7 @@ import * as core from '@actions/core';
 import * as config from './config';
 import * as coverage from './coverage';
 import * as extensions from './extensions';
+import * as tools from './tools';
 import * as utils from './utils';
 import * as matchers from './matchers';

@ -26,7 +27,11 @@ export async function build(
    (await utils.getInput('ini-values', false)) ||
    (await utils.getInput('ini-values-csv', false));
  const coverage_driver: string = await utils.getInput('coverage', false);
-  const setup_matchers: string = await utils.getInput('matchers', false);
+  const pecl: string = await utils.getInput('pecl', false);
+  let tools_csv: string = await utils.getInput('tools', false);
+  if (pecl == 'true') {
+    tools_csv = 'pecl, ' + tools_csv;
+  }

  let script: string = await utils.readScript(filename, version, os_version);
  if (extension_csv) {
@ -38,6 +43,7 @@ export async function build(
  if (coverage_driver) {
    script += await coverage.addCoverage(coverage_driver, version, os_version);
  }
+  script += await tools.addTools(tools_csv, os_version);

  return await utils.writeScript(filename, script);
 }
@ -54,15 +60,10 @@ export async function run(): Promise<void> {
    let script_path = '';
    switch (os_version) {
      case 'darwin':
+      case 'linux':
        script_path = await build(os_version + '.sh', version, os_version);
        await exec('sh ' + script_path + ' ' + version + ' ' + __dirname);
        break;
-      case 'linux': {
-        const pecl: string = await utils.getInput('pecl', false);
-        script_path = await build(os_version + '.sh', version, os_version);
-        await exec('sh ' + script_path + ' ' + version + ' ' + pecl);
-        break;
-      }
      case 'win32':
        script_path = await build('win32.ps1', version, os_version);
        await exec('pwsh ' + script_path + ' ' + version + ' ' + __dirname);
--- a/src/scripts/darwin.sh
+++ b/src/scripts/darwin.sh
@ -47,11 +47,27 @@ remove_extension() {
  sudo rm -rf "$ext_dir"/"$1".so >/dev/null 2>&1
 }

+# Function to setup a remote tool
+add_tool() {
+  url=$1
+  tool=$2
+  if [ ! -e /usr/local/bin/"$tool" ]; then
+    rm -rf /usr/local/bin/"${tool:?}"
+  fi
+  sudo curl -o /usr/local/bin/"$tool" -L "$url" >/dev/null 2>&1
+  sudo chmod a+x /usr/local/bin/"$tool"
+  add_log "$tick" "$tool" "Added"
+}
+
+add_pecl() {
+  add_log "$tick" "PECL" "Added"
+}
+
 # Function to setup PHP and composer
 setup_php_and_composer() {
  export HOMEBREW_NO_INSTALL_CLEANUP=TRUE
  brew tap shivammathur/homebrew-php >/dev/null 2>&1
-  brew install shivammathur/php/php@"$version" composer >/dev/null 2>&1
+  brew install shivammathur/php/php@"$version" >/dev/null 2>&1
  brew link --force --overwrite php@"$version" >/dev/null 2>&1
 }

@ -61,7 +77,7 @@ cross="✗"
 version=$1

 # Setup PHP and composer
-step_log "Setup PHP and Composer"
+step_log "Setup PHP"
 setup_php_and_composer
 ini_file=$(php -d "date.timezone=UTC" --ini | grep "Loaded Configuration" | sed -e "s|.*:s*||" | sed "s/ //g")
 echo "date.timezone=UTC" >> "$ini_file"
@ -70,4 +86,3 @@ sudo chmod 777 "$ini_file"
 mkdir -p "$(pecl config-get ext_dir)"
 semver=$(php -v | head -n 1 | cut -f 2 -d ' ')
 add_log "$tick" "PHP" "Installed PHP $semver"
-add_log "$tick" "Composer" "Installed"
--- a/src/scripts/linux.sh
+++ b/src/scripts/linux.sh
@ -43,11 +43,23 @@ add_extension() {
 # Function to remove extensions
 remove_extension() {
  extension=$1
-  if [ -e /etc/php/"$version"/mods-available/$1.ini ]; then
-    sudo phpdismod -v "$version" $1
+  if [ -e /etc/php/"$version"/mods-available/"$extension".ini ]; then
+    sudo phpdismod -v "$version" "$extension"
  fi
-  sudo sed -i "/$1/d" "$ini_file"
-  sudo DEBIAN_FRONTEND=noninteractive apt-get remove php-$1 -y >/dev/null 2>&1
+  sudo sed -i "/$extension/d" "$ini_file"
+  sudo DEBIAN_FRONTEND=noninteractive apt-get remove php-"$extension" -y >/dev/null 2>&1
+}
+
+# Function to setup a remote tool
+add_tool() {
+  url=$1
+  tool=$2
+  if [ ! -e /usr/local/bin/"$tool" ]; then
+    rm -rf /usr/local/bin/"${tool:?}"
+  fi
+  sudo curl -o /usr/local/bin/"$tool" -L "$url" >/dev/null 2>&1
+  sudo chmod a+x /usr/local/bin/"$tool"
+  add_log "$tick" "$tool" "Added"
 }

 # Function to setup the nightly build from master branch
@ -64,30 +76,18 @@ setup_master() {
 }

 # Function to setup PECL
-setup_pecl() {
+add_pecl() {
+  update_ppa
  $apt_install php"$version"-dev php"$version"-xml >/dev/null 2>&1
  sudo update-alternatives --set php-config /usr/bin/php-config"$version" >/dev/null 2>&1
  sudo update-alternatives --set phpize /usr/bin/phpize"$version" >/dev/null 2>&1
  wget https://github.com/pear/pearweb_phars/raw/master/install-pear-nozlib.phar >/dev/null 2>&1
  sudo php install-pear-nozlib.phar >/dev/null 2>&1
+  sudo rm -rf install-pear-nozlib.phar >/dev/null 2>&1
  sudo pear config-set php_ini "$ini_file" >/dev/null 2>&1
  sudo pear config-set auto_discover 1 >/dev/null 2>&1
  sudo pear channel-update pear.php.net >/dev/null 2>&1
-}
-
-# Function to setup composer
-setup_composer() {
-  if [ ! -e "/usr/bin/composer" ]; then
-    curl -s -L https://getcomposer.org/installer >composer-setup.php
-    if [ "$(curl -s https://composer.github.io/installer.sig)" != "$(php -r "echo hash_file('sha384', 'composer-setup.php');")" ]; then
-      echo >&2 'ERROR: Invalid installer signature'
-    else
-      export COMPOSER_ALLOW_SUPERUSER=1
-      sudo php composer-setup.php --install-dir=/usr/local/bin --filename=composer
-    fi
-    rm composer-setup.php
-  fi
-  add_log "$tick" "Composer" "Installed"
+  add_log "$tick" "PECL" "Added"
 }

 # Function to switch versions of PHP binaries
@ -104,13 +104,12 @@ tick="✓"
 cross="✗"
 ppa_updated="false"
 version=$1
-pecl=$2
 apt_install="sudo DEBIAN_FRONTEND=noninteractive apt-fast install -y"
 existing_version=$(php-config --version | cut -c 1-3)
 semver=$(php -v | head -n 1 | cut -f 2 -d ' ' | cut -f 1 -d '-')

 # Setup PHP
-step_log "Setup PHP and Composer"
+step_log "Setup PHP"
 sudo mkdir -p /var/run
 sudo mkdir -p /run/php

@ -150,13 +149,3 @@ ini_file=$(php --ini | grep "Loaded Configuration" | sed -e "s|.*:s*||" | sed "s
 ext_dir=$(php -i | grep "extension_dir => /usr" | sed -e "s|.*=> s*||")
 sudo chmod 777 "$ini_file"
 add_log "$tick" "PHP" "$status"
-
-# Setup PECL
-if [ "$pecl" = "true" ]; then
-  update_ppa
-  setup_pecl
-  add_log "$tick" "PECL" "Installed"
-fi
-
-# Setup composer
-setup_composer
--- a/src/scripts/win32.ps1
+++ b/src/scripts/win32.ps1
@ -75,6 +75,38 @@ Function Remove-Extension() {
  }
 }

+# Function to setup a remote tool
+Function Add-Tool() {
+  Param (
+    [Parameter(Position = 0, Mandatory = $true)]
+    [ValidateNotNull()]
+    [ValidateLength(1, [int]::MaxValue)]
+    [string]
+    $url,
+    [Parameter(Position = 1, Mandatory = $true)]
+    [ValidateNotNull()]
+    [ValidateLength(1, [int]::MaxValue)]
+    [string]
+    $tool
+  )
+  if (Test-Path $php_dir\$tool) {
+    Remove-Item $php_dir\$tool
+  }
+  Invoke-WebRequest -UseBasicParsing -Uri $url -OutFile $php_dir\$tool > $null 2>&1
+  $bat_content = @()
+  $bat_content += "@ECHO off"
+  $bat_content += "setlocal DISABLEDELAYEDEXPANSION"
+  $bat_content += "SET BIN_TARGET=%~dp0/" + $tool
+  $bat_content += "php %BIN_TARGET% %*"
+  Set-Content -Path $php_dir\$tool.bat -Value $bat_content
+  Add-Content -Path $PsHome\profile.ps1 -Value "New-Alias $tool $php_dir\$tool.bat"
+  Add-Log $tick $tool "Added"
+}
+
+Function Add-PECL() {
+  Add-Log $tick "PECL" "Use extensions input or Install-PhpExtension to setup PECL extensions on windows"
+}
+
 # Variables
 $tick = ([char]8730)
 $cross = ([char]10007)
@ -96,7 +128,7 @@ if (Test-Path -LiteralPath $php_dir -PathType Container) {
  catch {
  }
 }
-Step-Log "Setup PHP and Composer"
+Step-Log "Setup PHP"
 if ($null -eq $installed -or -not("$($installed.Version).".StartsWith(($version -replace '^(\d+(\.\d+)*).*', '$1.')))) {
  if ($version -lt '7.0') {
    Install-Module -Name VcRedist -Force
@ -123,6 +155,3 @@ if ($version -eq 'master') {
  Set-PhpIniKey -Key 'opcache.jit' -Value '1235' -Path $php_dir
 }
 Add-Log $tick "PHP" $status
-
-Install-Composer -Scope System -Path $php_dir -PhpPath $php_dir
-Add-Log $tick "Composer" "Installed"
--- a/src/tools.ts
+++ b/src/tools.ts
@ -0,0 +1,141 @@
+import * as utils from './utils';
+
+export async function getToolCommand(os_version: string): Promise<string> {
+  switch (os_version) {
+    case 'linux':
+    case 'darwin':
+      return 'add_tool ';
+    case 'win32':
+      return 'Add-Tool ';
+    default:
+      return await utils.log(
+        'Platform ' + os_version + ' is not supported',
+        os_version,
+        'error'
+      );
+  }
+}
+
+export async function getPECLCommand(os_version: string): Promise<string> {
+  switch (os_version) {
+    case 'linux':
+    case 'darwin':
+      return 'add_pecl ';
+    case 'win32':
+      return 'Add-PECL ';
+    default:
+      return await utils.log(
+        'Platform ' + os_version + ' is not supported',
+        os_version,
+        'error'
+      );
+  }
+}
+
+/**
+ * Setup tools
+ *
+ * @param tool_csv
+ * @param os_version
+ */
+export async function addTools(
+  tools_csv: string,
+  os_version: string
+): Promise<string> {
+  let script = await utils.stepLog('Setup Tools', os_version);
+  let tools: Array<string> = await utils.CSVArray(tools_csv);
+  tools = tools.filter(tool => tool !== 'composer');
+  tools.unshift('composer');
+  await utils.asyncForEach(tools, async function(tool: string) {
+    script += '\n';
+    switch (tool) {
+      case 'php-cs-fixer':
+        script +=
+          (await getToolCommand(os_version)) +
+          'https://github.com/FriendsOfPHP/PHP-CS-Fixer/releases/latest/download/php-cs-fixer.phar' +
+          ' ' +
+          'php-cs-fixer';
+        break;
+      case 'phpcs':
+        script +=
+          (await getToolCommand(os_version)) +
+          'https://github.com/squizlabs/PHP_CodeSniffer/releases/latest/download/phpcs.phar' +
+          ' ' +
+          'phpcs';
+        break;
+      case 'phpcbf':
+        script +=
+          (await getToolCommand(os_version)) +
+          'https://github.com/squizlabs/PHP_CodeSniffer/releases/latest/download/phpcbf.phar' +
+          ' ' +
+          'phpcbf';
+        break;
+      case 'phpcpd':
+        script +=
+          (await getToolCommand(os_version)) +
+          'https://github.com/sebastianbergmann/phpcpd/releases/latest/download/phpcpd.phar' +
+          ' ' +
+          'phpcpd';
+        break;
+      case 'phpstan':
+        script +=
+          (await getToolCommand(os_version)) +
+          'https://github.com/phpstan/phpstan/releases/latest/download/phpstan.phar' +
+          ' ' +
+          'phpstan';
+        break;
+      case 'phpmd':
+        script +=
+          (await getToolCommand(os_version)) +
+          'https://github.com/phpmd/phpmd/releases/latest/download/phpmd.phar' +
+          ' ' +
+          'phpmd';
+        break;
+      case 'composer':
+        script +=
+          (await getToolCommand(os_version)) +
+          'https://getcomposer.org/composer.phar' +
+          ' ' +
+          'composer';
+        break;
+      case 'codeception':
+        script +=
+          (await getToolCommand(os_version)) +
+          'https://codeception.com/codecept.phar' +
+          ' ' +
+          'codeception';
+        break;
+      case 'phpunit':
+        script +=
+          (await getToolCommand(os_version)) +
+          'https://phar.phpunit.de/phpunit.phar' +
+          ' ' +
+          'phpunit';
+        break;
+      case 'deployer':
+        script +=
+          (await getToolCommand(os_version)) +
+          'https://deployer.org/deployer.phar' +
+          ' ' +
+          'deployer';
+        break;
+      case 'prestissimo':
+        script +=
+          'composer global require hirak/prestissimo' +
+          (await utils.suppressOutput(os_version));
+        break;
+      case 'pecl':
+        script += await getPECLCommand(os_version);
+        break;
+      default:
+        script += await utils.log(
+          'Tool ' + tool + ' is not supported',
+          os_version,
+          'error'
+        );
+        break;
+    }
+  });
+
+  return script;
+}
--- a/src/utils.ts
+++ b/src/utils.ts
@ -191,30 +191,36 @@ export async function extensionArray(
    case ' ':
      return [];
    default:
-      return extension_csv.split(',').map(function(extension: string) {
-        return extension
-          .trim()
-          .replace('php-', '')
-          .replace('php_', '');
-      });
+      return extension_csv
+        .split(',')
+        .map(function(extension: string) {
+          return extension
+            .trim()
+            .replace('php-', '')
+            .replace('php_', '');
+        })
+        .filter(Boolean);
  }
 }

 /**
- * Function to break ini values csv into an array
+ * Function to break csv into an array
 *
- * @param ini_values_csv
+ * @param values_csv
 * @constructor
 */
-export async function INIArray(ini_values_csv: string): Promise<Array<string>> {
-  switch (ini_values_csv) {
+export async function CSVArray(values_csv: string): Promise<Array<string>> {
+  switch (values_csv) {
    case '':
    case ' ':
      return [];
    default:
-      return ini_values_csv.split(',').map(function(ini_value: string) {
-        return ini_value.trim();
-      });
+      return values_csv
+        .split(',')
+        .map(function(value: string) {
+          return value.trim();
+        })
+        .filter(Boolean);
  }
 }