Improve code and examples

2025-07-22 23:03:28 +07:00 · 2019-10-08 18:12:54 +05:30
parent 7e81c058fb
commit 46a875ad7e
31 changed files with 1049 additions and 589 deletions
--- a/src/config.ts
+++ b/src/config.ts
@ -0,0 +1,58 @@
+import * as utils from './utils';
+
+/**
+ * Function to add custom ini values
+ *
+ * @param ini_values_csv
+ * @param os_version
+ */
+export async function addINIValues(ini_values_csv: string, os_version: string) {
+  switch (os_version) {
+    case 'win32':
+      return await addINIValuesWindows(ini_values_csv);
+    case 'darwin':
+    case 'linux':
+      return await addINIValuesUnix(ini_values_csv);
+    default:
+      return await utils.log(
+        'Platform ' + os_version + ' is not supported',
+        os_version,
+        'error',
+        'Add Config'
+      );
+  }
+}
+
+/**
+ * Add script to set custom ini values for unix
+ *
+ * @param ini_values_csv
+ */
+export async function addINIValuesUnix(
+  ini_values_csv: string
+): Promise<string> {
+  let script: string = '\n';
+  let ini_values: Array<string> = await utils.INIArray(ini_values_csv);
+  await utils.asyncForEach(ini_values, async function(ini_value: string) {
+    // add script to set ini value
+    script += 'echo "' + ini_value + '" >> $ini_file\n';
+  });
+  return script;
+}
+
+/**
+ * Add script to set custom ini values for windows
+ *
+ * @param ini_values_csv
+ */
+export async function addINIValuesWindows(
+  ini_values_csv: string
+): Promise<string> {
+  let script: string = '\n';
+  let ini_values: Array<string> = await utils.INIArray(ini_values_csv);
+  await utils.asyncForEach(ini_values, async function(ini_value: string) {
+    // add script to set ini value
+    script += 'Add-Content C:\\tools\\php\\php.ini "' + ini_value + '"\n';
+  });
+  return script;
+}
--- a/src/coverage.ts
+++ b/src/coverage.ts
@ -0,0 +1,129 @@
+import * as utils from './utils';
+import * as pecl from './pecl';
+import * as extensions from './extensions';
+import * as config from './config';
+
+export async function addCoverage(
+  coverage_driver: string,
+  version: string,
+  os_version: string
+): Promise<string> {
+  coverage_driver.toLowerCase();
+  switch (coverage_driver) {
+    case 'pcov':
+      return addCoveragePCOV(version, os_version);
+    case 'xdebug':
+      return addCoverageXdebug(version, os_version);
+    case 'none':
+      return disableCoverage(version, os_version);
+    default:
+      return '';
+  }
+}
+
+export async function addCoverageXdebug(version: string, os_version: string) {
+  let script: string = '\n';
+  script += await extensions.addExtension(
+    'xdebug',
+    version,
+    os_version,
+    'Set Coverage Driver'
+  );
+  script += await utils.log(
+    'Xdebug enabled as coverage driver',
+    os_version,
+    'success',
+    'Set Coverage Driver'
+  );
+
+  return script;
+}
+
+export async function addCoveragePCOV(version: string, os_version: string) {
+  let script: string = '\n';
+  switch (version) {
+    default:
+      script += await extensions.addExtension(
+        'pcov',
+        version,
+        os_version,
+        'Set Coverage Driver'
+      );
+      script += await config.addINIValues('pcov.enabled=1', os_version);
+
+      // add command to disable xdebug and enable pcov
+      switch (os_version) {
+        case 'linux':
+          script +=
+            'if [ -e /etc/php/' +
+            version +
+            '/mods-available/xdebug.ini ]; then sudo phpdismod xdebug; fi\n';
+          script += 'sudo sed -i "/xdebug/d" $ini_file\n';
+          break;
+        case 'darwin':
+          script += 'sudo sed -i \'\' "/xdebug/d" $ini_file\n';
+          break;
+        case 'win32':
+          script +=
+            'if(php -m | findstr -i xdebug) { Disable-PhpExtension xdebug C:\\tools\\php }\n';
+          break;
+      }
+
+      // success
+      script += await utils.log(
+        'PCOV enabled as coverage driver',
+        os_version,
+        'success',
+        'Set Coverage Driver'
+      );
+      // version is not supported
+      break;
+    case '5.6':
+    case '7.0':
+      script += await utils.log(
+        'PCOV requires PHP 7.1 or newer',
+        os_version,
+        'warning',
+        'Set Coverage Driver'
+      );
+      break;
+  }
+
+  return script;
+}
+
+export async function disableCoverage(version: string, os_version: string) {
+  let script: string = '\n';
+  switch (os_version) {
+    case 'linux':
+      script +=
+        'if [ -e /etc/php/' +
+        version +
+        '/mods-available/xdebug.ini ]; then sudo phpdismod xdebug; fi\n';
+      script +=
+        'if [ -e /etc/php/' +
+        version +
+        '/mods-available/pcov.ini ]; then sudo phpdismod pcov; fi\n';
+      script += 'sudo sed -i "/xdebug/d" $ini_file\n';
+      script += 'sudo sed -i "/pcov/d" $ini_file\n';
+      break;
+    case 'darwin':
+      script += 'sudo sed -i \'\' "/xdebug/d" $ini_file\n';
+      script += 'sudo sed -i \'\' "/pcov/d" $ini_file\n';
+      break;
+    case 'win32':
+      script +=
+        'if(php -m | findstr -i xdebug) { Disable-PhpExtension xdebug C:\\tools\\php }\n';
+      script +=
+        'if(php -m | findstr -i pcov) { Disable-PhpExtension pcov C:\\tools\\php }\n';
+      break;
+  }
+  script += await utils.log(
+    'Disabled Xdebug and PCOV',
+    os_version,
+    'success',
+    'Set Coverage Driver'
+  );
+
+  return script;
+}
--- a/src/extensions.ts
+++ b/src/extensions.ts
@ -24,23 +24,6 @@ export async function addExtension(
  }
 }

-export async function addINIValues(ini_values_csv: string, os_version: string) {
-  switch (os_version) {
-    case 'win32':
-      return await addINIValuesWindows(ini_values_csv);
-    case 'darwin':
-    case 'linux':
-      return await addINIValuesUnix(ini_values_csv);
-    default:
-      return await utils.log(
-        'Platform ' + os_version + ' is not supported',
-        os_version,
-        'error',
-        'Add Config'
-      );
-  }
-}
-
 /**
 * Enable extensions which are installed but not enabled on windows
 *
@ -324,149 +307,3 @@ export async function addExtensionLinux(
  });
  return script;
 }
-
-/**
- * Add script to set custom ini values for unix
- *
- * @param ini_values_csv
- */
-export async function addINIValuesUnix(
-  ini_values_csv: string
-): Promise<string> {
-  let script: string = '\n';
-  let ini_values: Array<string> = await utils.INIArray(ini_values_csv);
-  await utils.asyncForEach(ini_values, async function(ini_value: string) {
-    // add script to set ini value
-    script += 'echo "' + ini_value + '" >> $ini_file\n';
-  });
-  return script;
-}
-
-/**
- * Add script to set custom ini values for windows
- *
- * @param ini_values_csv
- */
-export async function addINIValuesWindows(
-  ini_values_csv: string
-): Promise<string> {
-  let script: string = '\n';
-  let ini_values: Array<string> = await utils.INIArray(ini_values_csv);
-  await utils.asyncForEach(ini_values, async function(ini_value: string) {
-    // add script to set ini value
-    script += 'Add-Content C:\\tools\\php\\php.ini "' + ini_value + '"\n';
-  });
-  return script;
-}
-
-export async function addCoverage(
-  coverage: string,
-  version: string,
-  os_version: string
-): Promise<string> {
-  let script: string = '\n';
-  coverage = coverage.toLowerCase();
-  // pcov
-  switch (coverage) {
-    case 'pcov':
-      // if version is 7.1 or newer
-      switch (version) {
-        default:
-          script += await addExtension(
-            'pcov',
-            version,
-            os_version,
-            'Set Coverage Driver'
-          );
-          script += await addINIValues('pcov.enabled=1', os_version);
-
-          // add command to disable xdebug and enable pcov
-          switch (os_version) {
-            case 'linux':
-              script +=
-                'if [ -e /etc/php/' +
-                version +
-                '/mods-available/xdebug.ini ]; then sudo phpdismod xdebug; fi\n';
-              script += 'sudo sed -i "/xdebug/d" $ini_file\n';
-              break;
-            case 'darwin':
-              script += 'sudo sed -i \'\' "/xdebug/d" $ini_file\n';
-              break;
-            case 'win32':
-              script +=
-                'if(php -m | findstr -i xdebug) { Disable-PhpExtension xdebug C:\\tools\\php }\n';
-              break;
-          }
-
-          // success
-          script += await utils.log(
-            'PCOV enabled as coverage driver',
-            os_version,
-            'success',
-            'Set Coverage Driver'
-          );
-          // version is not supported
-          break;
-        case '5.6':
-        case '7.0':
-          script += await utils.log(
-            'PCOV requires PHP 7.1 or newer',
-            os_version,
-            'warning',
-            'Set Coverage Driver'
-          );
-          break;
-      }
-      break;
-    //xdebug
-    case 'xdebug':
-      script += await addExtension(
-        'xdebug',
-        version,
-        os_version,
-        'Set Coverage Driver'
-      );
-      script += await utils.log(
-        'Xdebug enabled as coverage driver',
-        os_version,
-        'success',
-        'Set Coverage Driver'
-      );
-      break;
-    case 'none':
-      switch (os_version) {
-        case 'linux':
-          script +=
-            'if [ -e /etc/php/' +
-            version +
-            '/mods-available/xdebug.ini ]; then sudo phpdismod xdebug; fi\n';
-          script +=
-            'if [ -e /etc/php/' +
-            version +
-            '/mods-available/pcov.ini ]; then sudo phpdismod pcov; fi\n';
-          script += 'sudo sed -i "/xdebug/d" $ini_file\n';
-          script += 'sudo sed -i "/pcov/d" $ini_file\n';
-          break;
-        case 'darwin':
-          script += 'sudo sed -i \'\' "/xdebug/d" $ini_file\n';
-          script += 'sudo sed -i \'\' "/pcov/d" $ini_file\n';
-          break;
-        case 'win32':
-          script +=
-            'if(php -m | findstr -i xdebug) { Disable-PhpExtension xdebug C:\\tools\\php }\n';
-          script +=
-            'if(php -m | findstr -i pcov) { Disable-PhpExtension pcov C:\\tools\\php }\n';
-          break;
-      }
-      script += await utils.log(
-        'Disabled Xdebug and PCOV',
-        os_version,
-        'success',
-        'Set Coverage Driver'
-      );
-      break;
-    default:
-      script = '';
-  }
-  return script;
-}
--- a/src/install.ts
+++ b/src/install.ts
@ -1,7 +1,9 @@
 import {exec} from '@actions/exec/lib/exec';
 import * as core from '@actions/core';
 import * as utils from './utils';
-import * as features from './features';
+import * as extensions from './extensions';
+import * as config from './config';
+import * as coverage from './coverage';

 /**
 * Run the script
@ -12,7 +14,7 @@ async function run() {
    let version: string = await utils.getInput('php-version', true);
    let extension_csv: string = await utils.getInput('extension-csv', false);
    let ini_values_csv: string = await utils.getInput('ini-values-csv', false);
-    let coverage: string = await utils.getInput('coverage', false);
+    let coverage_driver: string = await utils.getInput('coverage', false);

    let os_version: string = process.platform;
    // check the os version and run the respective script
@ -23,9 +25,17 @@ async function run() {
        os_version
      );

-      darwin += await features.addExtension(extension_csv, version, os_version);
-      darwin += await features.addINIValues(ini_values_csv, os_version);
-      darwin += await features.addCoverage(coverage, version, os_version);
+      darwin += await extensions.addExtension(
+        extension_csv,
+        version,
+        os_version
+      );
+      darwin += await config.addINIValues(ini_values_csv, os_version);
+      darwin += await coverage.addCoverage(
+        coverage_driver,
+        version,
+        os_version
+      );
      await utils.writeScript('darwin.sh', version, darwin);
      await exec('sh ./' + version + 'darwin.sh ' + version);
    } else if (os_version == 'win32') {
@ -34,13 +44,17 @@ async function run() {
        version,
        os_version
      );
-      windows += await features.addExtension(
+      windows += await extensions.addExtension(
        extension_csv,
        version,
        os_version
      );
-      windows += await features.addINIValues(ini_values_csv, os_version);
-      windows += await features.addCoverage(coverage, version, os_version);
+      windows += await config.addINIValues(ini_values_csv, os_version);
+      windows += await coverage.addCoverage(
+        coverage_driver,
+        version,
+        os_version
+      );
      await utils.writeScript('win32.ps1', version, windows);
      await exec('powershell .\\' + version + 'win32.ps1 -version ' + version);
    } else if (os_version == 'linux') {
@ -49,9 +63,13 @@ async function run() {
        version,
        os_version
      );
-      linux += await features.addExtension(extension_csv, version, os_version);
-      linux += await features.addINIValues(ini_values_csv, os_version);
-      linux += await features.addCoverage(coverage, version, os_version);
+      linux += await extensions.addExtension(
+        extension_csv,
+        version,
+        os_version
+      );
+      linux += await config.addINIValues(ini_values_csv, os_version);
+      linux += await coverage.addCoverage(coverage_driver, version, os_version);
      await utils.writeScript('linux.sh', version, linux);
      await exec('./' + version + 'linux.sh ' + version);
    }
--- a/src/pecl.ts
+++ b/src/pecl.ts
@ -11,7 +11,7 @@ export async function checkPECLExtension(extension: string): Promise<boolean> {
    maxRetries: 2
  });
  const response: hc.HttpClientResponse = await http.get(
-    'https://pecl.php.net/package/' + extension
+    'https://pecl.php.net/json.php?package=' + extension
  );
  return response.message.statusCode === 200;
 }
--- a/src/scripts/win32.ps1
+++ b/src/scripts/win32.ps1
@ -6,26 +6,26 @@ if($version -eq '7.4') {
 	$version = '7.4RC'
 }

-echo "Installing PhpManager"
+Write-Host "Installing PhpManager" -ForegroundColor Blue
 Install-Module -Name PhpManager -Force -Scope CurrentUser

 $installed = $($(php -v)[0] -join '')[4..6] -join ''
 if($installed -ne $version) {
  if($version -lt '7.0') {
-    echo "Installing VcRedist"
+      Write-Host "Installing VcRedist"
    Install-Module -Name VcRedist -Force
  }
-  echo "Installing PHP"
+  Write-Host "Installing PHP" -ForegroundColor Blue
  Uninstall-Php C:\tools\php
  Install-Php -Version $version -Architecture x86 -ThreadSafe $true -InstallVC -Path C:\tools\php$version -TimeZone UTC -InitialPhpIni Production -Force
-  echo "Switch PHP"
+  Write-Host "Switch PHP" -ForegroundColor Blue
  (Get-PhpSwitcher).targets
  Initialize-PhpSwitcher -Alias C:\tools\php -Scope CurrentUser -Force
  Add-PhpToSwitcher -Name $version -Path C:\tools\php$version -Force
  Switch-Php $version -Force
 }

-echo "Housekeeping in PHP.ini, enabling openssl"
+Write-Host "Housekeeping in PHP.ini, enabling openssl" -ForegroundColor Blue
 $ext_dir = "C:\tools\php\ext"
 Add-Content C:\tools\php\php.ini "date.timezone = 'UTC'"
 Set-PhpIniKey extension_dir $ext_dir
@ -37,7 +37,7 @@ if($version -lt '7.4') {
  Copy-Item "php_pcov.dll" -Destination $ext_dir"\php_pcov.dll"
 }

-echo "Installing Composer"
+Write-Host "Installing Composer" -ForegroundColor Blue
 Install-Composer -Scope System -Path C:\tools\php
 php -v
 composer -V