Merge pull request #16 from shivammathur/develop

1.3.0

.github/FUNDING.yml

@@ -1,5 +1,7 @@
 # These are supported funding model platforms
 
-github: shivammathur
+open_collective: setup-php
+tidelift: "npm/setup-php"
+community_bridge: setup-php
 patreon: shivammathur
 custom: https://www.paypal.me/shivammathur

README.md

@@ -140,9 +140,10 @@ Contributions are welcome! See [Contributor's Guide](.github/CONTRIBUTING.md "sh
 
 If this action helped you.
 
-- Sponsor the project by subscribing on [Patreon](https://www.patreon.com/shivammathur "Shivam Mathur Patreon") or by contributing using [Paypal](https://www.paypal.me/shivammathur "Shivam Mathur PayPal").
-- Please star the project and share it with the community.
-- If you blog, write about your experience of using this action.
+- Please star the project and share it. If you blog, please share your experience of using this action.
+- Please consider supporting our work by sponsoring using [Open Collective](https://opencollective.com/setup-php), [Paypal](https://www.paypal.me/shivammathur "Shivam Mathur PayPal") or [Patreon](https://www.patreon.com/shivammathur "Shivam Mathur Patreon").
+- If you use this action at your company, please [reach out](mailto:contact@setup-php.com) to sponsor the project.
+
 
 ## :package: Dependencies
 

__tests__/utils.test.ts

@@ -7,15 +7,28 @@ jest.mock('@actions/core', () => ({
 }));
 
 describe('Utils tests', () => {
+  it('checking readEnv', async () => {
+    process.env['test'] = 'setup-php';
+    expect(await utils.readEnv('test')).toBe('setup-php');
+    expect(await utils.readEnv('undefined')).toBe('');
+  });
+
   it('checking getInput', async () => {
-    process.env['test'] = 'cache-extensions';
-    process.env['undefined'] = '';
-    expect(await utils.getInput('test', false)).toBe('cache-extensions');
-    expect(await utils.getInput('undefined', false)).toBe('');
+    process.env['test'] = 'setup-php';
+    expect(await utils.getInput('test', false)).toBe('setup-php');
     expect(await utils.getInput('cache-extensions', false)).toBe(
       'cache-extensions'
     );
     expect(await utils.getInput('DoesNotExist', false)).toBe('');
+    expect(async () => {
+      await utils.getInput('DoesNotExist', true);
+    }).rejects.toThrow('Input required and not supplied: DoesNotExist');
+  });
+
+  it('checking parseVersion', async () => {
+    expect(await utils.parseVersion('7')).toBe('7.0');
+    expect(await utils.parseVersion('7.4')).toBe('7.4');
+    expect(await utils.parseVersion('latest')).toBe('7.4');
   });
 
   it('checking filterExtensions', async () => {

dist/index.js

@@ -953,6 +953,32 @@ class ExecState extends events.EventEmitter {
 
 /***/ }),
 
+/***/ 82:
+/***/ (function(__unusedmodule, exports) {
+
+"use strict";
+
+// We use any as a valid input type
+/* eslint-disable @typescript-eslint/no-explicit-any */
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Sanitizes an input into a string so it can be passed into issueCommand safely
+ * @param input input to sanitize into a string
+ */
+function toCommandValue(input) {
+    if (input === null || input === undefined) {
+        return '';
+    }
+    else if (typeof input === 'string' || input instanceof String) {
+        return input;
+    }
+    return JSON.stringify(input);
+}
+exports.toCommandValue = toCommandValue;
+//# sourceMappingURL=utils.js.map
+
+/***/ }),
+
 /***/ 87:
 /***/ (function(module) {
 
@@ -960,6 +986,42 @@ module.exports = require("os");
 
 /***/ }),
 
+/***/ 102:
+/***/ (function(__unusedmodule, exports, __webpack_require__) {
+
+"use strict";
+
+// For internal use, subject to change.
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
+    result["default"] = mod;
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// We use any as a valid input type
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const fs = __importStar(__webpack_require__(747));
+const os = __importStar(__webpack_require__(87));
+const utils_1 = __webpack_require__(82);
+function issueCommand(command, message) {
+    const filePath = process.env[`GITHUB_${command}`];
+    if (!filePath) {
+        throw new Error(`Unable to find environment variable for file command ${command}`);
+    }
+    if (!fs.existsSync(filePath)) {
+        throw new Error(`Missing file at path: ${filePath}`);
+    }
+    fs.appendFileSync(filePath, `${utils_1.toCommandValue(message)}${os.EOL}`, {
+        encoding: 'utf8'
+    });
+}
+exports.issueCommand = issueCommand;
+//# sourceMappingURL=file-command.js.map
+
+/***/ }),
+
 /***/ 129:
 /***/ (function(module) {
 
@@ -987,13 +1049,28 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterExtensions = exports.getInput = void 0;
+exports.filterExtensions = exports.parseVersion = exports.getInput = exports.readEnv = void 0;
 const core = __importStar(__webpack_require__(470));
+/**
+ * Function to read environment variable and return a string value.
+ *
+ * @param property
+ */
+async function readEnv(property) {
+    const value = process.env[property];
+    switch (value) {
+        case undefined:
+            return '';
+        default:
+            return value;
+    }
+}
+exports.readEnv = readEnv;
 /**
  * Function to get inputs from both with and env annotations.
  *
@@ -1001,16 +1078,39 @@ const core = __importStar(__webpack_require__(470));
  * @param mandatory
  */
 async function getInput(name, mandatory) {
-    const input = process.env[name];
-    switch (input) {
-        case '':
-        case undefined:
-            return core.getInput(name, { required: mandatory });
-        default:
+    const input = core.getInput(name);
+    const env_input = await readEnv(name);
+    switch (true) {
+        case input != '':
             return input;
+        case input == '' && env_input != '':
+            return env_input;
+        case input == '' && env_input == '' && mandatory:
+            throw new Error(`Input required and not supplied: ${name}`);
+        default:
+            return '';
     }
 }
 exports.getInput = getInput;
+/**
+ * Function to parse PHP version.
+ *
+ * @param version
+ */
+async function parseVersion(version) {
+    switch (version) {
+        case 'latest':
+            return '7.4';
+        default:
+            switch (true) {
+                case version.length > 1:
+                    return version.slice(0, 3);
+                default:
+                    return version + '.0';
+            }
+    }
+}
+exports.parseVersion = parseVersion;
 /**
  * Function to filter extensions
  *
@@ -1050,6 +1150,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const os = __importStar(__webpack_require__(87));
+const utils_1 = __webpack_require__(82);
 /**
  * Commands
  *
@@ -1103,28 +1204,14 @@ class Command {
         return cmdStr;
     }
 }
-/**
- * Sanitizes an input into a string so it can be passed into issueCommand safely
- * @param input input to sanitize into a string
- */
-function toCommandValue(input) {
-    if (input === null || input === undefined) {
-        return '';
-    }
-    else if (typeof input === 'string' || input instanceof String) {
-        return input;
-    }
-    return JSON.stringify(input);
-}
-exports.toCommandValue = toCommandValue;
 function escapeData(s) {
-    return toCommandValue(s)
+    return utils_1.toCommandValue(s)
         .replace(/%/g, '%25')
         .replace(/\r/g, '%0D')
         .replace(/\n/g, '%0A');
 }
 function escapeProperty(s) {
-    return toCommandValue(s)
+    return utils_1.toCommandValue(s)
         .replace(/%/g, '%25')
         .replace(/\r/g, '%0D')
         .replace(/\n/g, '%0A')
@@ -1158,6 +1245,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const command_1 = __webpack_require__(431);
+const file_command_1 = __webpack_require__(102);
+const utils_1 = __webpack_require__(82);
 const os = __importStar(__webpack_require__(87));
 const path = __importStar(__webpack_require__(622));
 /**
@@ -1184,9 +1273,17 @@ var ExitCode;
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function exportVariable(name, val) {
-    const convertedVal = command_1.toCommandValue(val);
+    const convertedVal = utils_1.toCommandValue(val);
     process.env[name] = convertedVal;
-    command_1.issueCommand('set-env', { name }, convertedVal);
+    const filePath = process.env['GITHUB_ENV'] || '';
+    if (filePath) {
+        const delimiter = '_GitHubActionsFileCommandDelimeter_';
+        const commandValue = `${name}<<${delimiter}${os.EOL}${convertedVal}${os.EOL}${delimiter}`;
+        file_command_1.issueCommand('ENV', commandValue);
+    }
+    else {
+        command_1.issueCommand('set-env', { name }, convertedVal);
+    }
 }
 exports.exportVariable = exportVariable;
 /**
@@ -1202,7 +1299,13 @@ exports.setSecret = setSecret;
  * @param inputPath
  */
 function addPath(inputPath) {
-    command_1.issueCommand('add-path', {}, inputPath);
+    const filePath = process.env['GITHUB_PATH'] || '';
+    if (filePath) {
+        file_command_1.issueCommand('PATH', inputPath);
+    }
+    else {
+        command_1.issueCommand('add-path', {}, inputPath);
+    }
     process.env['PATH'] = `${inputPath}${path.delimiter}${process.env['PATH']}`;
 }
 exports.addPath = addPath;
@@ -1607,7 +1710,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };
@@ -1622,8 +1725,7 @@ const utils = __importStar(__webpack_require__(163));
  */
 async function run() {
     try {
-        let version = await utils.getInput('php-version', true);
-        version = version.length > 1 ? version.slice(0, 3) : version + '.0';
+        const version = await utils.parseVersion(await utils.getInput('php-version', true));
         const extensions = await utils.filterExtensions(await utils.getInput('extensions', true));
         const key = await utils.getInput('key', true);
         const script_path = path.join(__dirname, '../src/extensions.sh');

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cache-extensions",
-  "version": "1.1.3",
+  "version": "1.3.0",
   "private": false,
   "description": "Cache extensions in GitHub Actions",
   "main": "dist/index.js",
@@ -24,26 +24,26 @@
   "author": "shivammathur",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.2.4",
+    "@actions/core": "^1.2.6",
     "@actions/exec": "^1.0.4"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.9",
-    "@types/node": "^14.0.27",
-    "@typescript-eslint/eslint-plugin": "^3.8.0",
-    "@typescript-eslint/parser": "^3.8.0",
+    "@types/jest": "^26.0.14",
+    "@types/node": "^14.11.8",
+    "@typescript-eslint/eslint-plugin": "^4.4.1",
+    "@typescript-eslint/parser": "^4.4.1",
     "@zeit/ncc": "^0.22.3",
-    "eslint": "^7.6.0",
-    "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-import": "^2.22.0",
-    "eslint-plugin-jest": "^23.20.0",
+    "eslint": "^7.11.0",
+    "eslint-config-prettier": "^6.12.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jest": "^24.1.0",
     "eslint-plugin-prettier": "^3.1.4",
-    "husky": "^4.2.5",
-    "jest": "^26.2.2",
-    "jest-circus": "^26.2.2",
-    "prettier": "^2.0.5",
-    "ts-jest": "^26.1.4",
-    "typescript": "^3.9.7"
+    "husky": "^4.3.0",
+    "jest": "^26.5.3",
+    "jest-circus": "^26.5.3",
+    "prettier": "^2.1.2",
+    "ts-jest": "^26.4.1",
+    "typescript": "^4.0.3"
   },
   "husky": {
     "skipCI": true,

src/cache.ts

@@ -8,9 +8,10 @@ import * as utils from './utils';
  */
 export async function run(): Promise<void> {
   try {
-    let version: string = await utils.getInput('php-version', true);
-    version = version.length > 1 ? version.slice(0, 3) : version + '.0';
-    const extensions = await utils.filterExtensions(
+    const version: string = await utils.parseVersion(
+      await utils.getInput('php-version', true)
+    );
+    const extensions: string = await utils.filterExtensions(
       await utils.getInput('extensions', true)
     );
     const key: string = await utils.getInput('key', true);

src/extensions.sh

@@ -1,12 +1,11 @@
 linux_extension_dir() {
   apiv=$1
-  old_versions_linux="5.[4-5]"
   if [ "$version" = "5.3" ]; then
     echo "/home/runner/php/5.3.29/lib/php/extensions/no-debug-non-zts-$apiv"
-  elif [[ "$version" =~ $old_versions_linux ]]; then
+  elif [[ "$version" =~ $old_versions ]]; then
     echo "/usr/lib/php5/$apiv"
-  elif [ "$version" = "8.0" ]; then
-    echo "/usr/local/php/8.0/lib/php/extensions/no-debug-non-zts-$apiv"
+  elif [[ "$version" =~ $nightly_versions ]]; then
+    echo "/usr/local/php/$version/lib/php/extensions/no-debug-non-zts-$apiv"
   else
     echo "/usr/lib/php/$apiv"
   fi
@@ -33,6 +32,7 @@ get_apiv() {
     7.2) echo "20170718" ;;
     7.3) echo "20180731" ;;
     7.4) echo "20190902" ;;
+    8.0) echo "20200930" ;;
     *)
       php_h="https://raw.githubusercontent.com/php/php-src/master/main/php.h"
       curl -sSL --retry 5 "$php_h" | grep "PHP_API_VERSION" | cut -d' ' -f 3
@@ -73,6 +73,8 @@ extensions=$1
 key=$2
 version=$3
 os=$(uname -s)
+old_versions="5.[4-5]"
+nightly_versions="8.[0-1]"
 if [ "$os" = "Linux" ]; then
   release=$(lsb_release -s -c)
   os=$os-$release
@@ -87,9 +89,9 @@ elif [ "$os" = "Darwin" ]; then
 else
   os="Windows"
   dir='C:\\tools\\php\\ext'
-  if [ "$version" = "8.0" ] && [[ "$extensions" == *pcov* ]]; then
-    key="$key-pcov_20200410"
-  fi
+fi
+if [[ "$version" =~ $nightly_versions ]]; then
+  key="$key-20200930"
 fi
 key="$os"-ext-"$version"-$(echo -n "$extensions-$key" | openssl dgst -sha256 | cut -d ' ' -f 2)
 echo "::set-output name=dir::$dir"

src/lists/bionic-php8.0-extensions

@@ -6,8 +6,8 @@ Core
 ctype
 curl
 date
+dba
 dom
-enchant
 exif
 FFI
 fileinfo
@@ -21,10 +21,12 @@ iconv
 ioncube
 intl
 json
+ldap
 libxml
 mbstring
 mysqli
 mysqlnd
+odbc
 openssl
 pcntl
 pcov
@@ -32,11 +34,14 @@ pcre
 PDO
 oci8
 PDO_OCI
+pdo_dblib
 pdo_mysql
+PDO_ODBC
 pdo_pgsql
 pdo_sqlite
 pgsql
 Phar
+phpdbg_webhelper
 posix
 pspell
 readline
@@ -46,6 +51,7 @@ shmop
 SimpleXML
 soap
 sockets
+sodium
 SPL
 sqlite3
 standard
@@ -54,9 +60,9 @@ sysvsem
 sysvshm
 tidy
 tokenizer
+xdebug
 xml
 xmlreader
-xmlrpc
 xmlwriter
 xsl
 Zend OPcache
@@ -69,4 +75,3 @@ blackfire
 [Zend Modules]
 Zend OPcache
 Xdebug
-

src/lists/bionic-php8.1-extensions

@@ -0,0 +1,77 @@
+[PHP Modules]
+bcmath
+bz2
+calendar
+Core
+ctype
+curl
+date
+dba
+dom
+exif
+FFI
+fileinfo
+filter
+ftp
+gd
+gettext
+gmp
+hash
+iconv
+ioncube
+intl
+json
+ldap
+libxml
+mbstring
+mysqli
+mysqlnd
+odbc
+openssl
+pcntl
+pcov
+pcre
+PDO
+oci8
+PDO_OCI
+pdo_dblib
+pdo_mysql
+PDO_ODBC
+pdo_pgsql
+pdo_sqlite
+pgsql
+Phar
+phpdbg_webhelper
+posix
+pspell
+readline
+Reflection
+session
+shmop
+SimpleXML
+soap
+sockets
+sodium
+SPL
+sqlite3
+standard
+sysvmsg
+sysvsem
+sysvshm
+tidy
+tokenizer
+xdebug
+xml
+xmlreader
+xmlwriter
+xsl
+Zend OPcache
+zip
+zlib
+phalcon3
+phalcon4
+blackfire
+
+[Zend Modules]
+Zend OPcache
+Xdebug

src/lists/focal-php8.0-extensions

@@ -4,11 +4,10 @@ bz2
 calendar
 Core
 ctype
-cubrid
 curl
 date
+dba
 dom
-enchant
 exif
 FFI
 fileinfo
@@ -22,10 +21,12 @@ iconv
 ioncube
 intl
 json
+ldap
 libxml
 mbstring
 mysqli
 mysqlnd
+odbc
 openssl
 pcntl
 pcov
@@ -33,11 +34,14 @@ pcre
 PDO
 oci8
 PDO_OCI
+pdo_dblib
 pdo_mysql
+PDO_ODBC
 pdo_pgsql
 pdo_sqlite
 pgsql
 Phar
+phpdbg_webhelper
 posix
 pspell
 readline
@@ -47,6 +51,7 @@ shmop
 SimpleXML
 soap
 sockets
+sodium
 SPL
 sqlite3
 standard
@@ -55,9 +60,9 @@ sysvsem
 sysvshm
 tidy
 tokenizer
+xdebug
 xml
 xmlreader
-xmlrpc
 xmlwriter
 xsl
 Zend OPcache

src/lists/focal-php8.1-extensions

@@ -0,0 +1,77 @@
+[PHP Modules]
+bcmath
+bz2
+calendar
+Core
+ctype
+curl
+date
+dba
+dom
+exif
+FFI
+fileinfo
+filter
+ftp
+gd
+gettext
+gmp
+hash
+iconv
+ioncube
+intl
+json
+ldap
+libxml
+mbstring
+mysqli
+mysqlnd
+odbc
+openssl
+pcntl
+pcov
+pcre
+PDO
+oci8
+PDO_OCI
+pdo_dblib
+pdo_mysql
+PDO_ODBC
+pdo_pgsql
+pdo_sqlite
+pgsql
+Phar
+phpdbg_webhelper
+posix
+pspell
+readline
+Reflection
+session
+shmop
+SimpleXML
+soap
+sockets
+sodium
+SPL
+sqlite3
+standard
+sysvmsg
+sysvsem
+sysvshm
+tidy
+tokenizer
+xdebug
+xml
+xmlreader
+xmlwriter
+xsl
+Zend OPcache
+zip
+zlib
+phalcon3
+phalcon4
+blackfire
+
+[Zend Modules]
+Zend OPcache
+Xdebug

src/lists/xenial-php8.0-extensions

@@ -4,11 +4,10 @@ bz2
 calendar
 Core
 ctype
-cubrid
 curl
 date
+dba
 dom
-enchant
 exif
 FFI
 fileinfo
@@ -22,10 +21,12 @@ iconv
 ioncube
 intl
 json
+ldap
 libxml
 mbstring
 mysqli
 mysqlnd
+odbc
 openssl
 pcntl
 pcov
@@ -33,11 +34,14 @@ pcre
 PDO
 oci8
 PDO_OCI
+pdo_dblib
 pdo_mysql
+PDO_ODBC
 pdo_pgsql
 pdo_sqlite
 pgsql
 Phar
+phpdbg_webhelper
 posix
 pspell
 readline
@@ -47,6 +51,7 @@ shmop
 SimpleXML
 soap
 sockets
+sodium
 SPL
 sqlite3
 standard
@@ -55,9 +60,9 @@ sysvsem
 sysvshm
 tidy
 tokenizer
+xdebug
 xml
 xmlreader
-xmlrpc
 xmlwriter
 xsl
 Zend OPcache
@@ -70,4 +75,3 @@ blackfire
 [Zend Modules]
 Zend OPcache
 Xdebug
-

src/lists/xenial-php8.1-extensions

@@ -0,0 +1,77 @@
+[PHP Modules]
+bcmath
+bz2
+calendar
+Core
+ctype
+curl
+date
+dba
+dom
+exif
+FFI
+fileinfo
+filter
+ftp
+gd
+gettext
+gmp
+hash
+iconv
+ioncube
+intl
+json
+ldap
+libxml
+mbstring
+mysqli
+mysqlnd
+odbc
+openssl
+pcntl
+pcov
+pcre
+PDO
+oci8
+PDO_OCI
+pdo_dblib
+pdo_mysql
+PDO_ODBC
+pdo_pgsql
+pdo_sqlite
+pgsql
+Phar
+phpdbg_webhelper
+posix
+pspell
+readline
+Reflection
+session
+shmop
+SimpleXML
+soap
+sockets
+sodium
+SPL
+sqlite3
+standard
+sysvmsg
+sysvsem
+sysvshm
+tidy
+tokenizer
+xdebug
+xml
+xmlreader
+xmlwriter
+xsl
+Zend OPcache
+zip
+zlib
+phalcon3
+phalcon4
+blackfire
+
+[Zend Modules]
+Zend OPcache
+Xdebug

src/utils.ts

@@ -1,6 +1,21 @@
 import * as fs from 'fs';
 import * as core from '@actions/core';
 
+/**
+ * Function to read environment variable and return a string value.
+ *
+ * @param property
+ */
+export async function readEnv(property: string): Promise<string> {
+  const value = process.env[property];
+  switch (value) {
+    case undefined:
+      return '';
+    default:
+      return value;
+  }
+}
+
 /**
  * Function to get inputs from both with and env annotations.
  *
@@ -11,13 +26,36 @@ export async function getInput(
   name: string,
   mandatory: boolean
 ): Promise<string> {
-  const input = process.env[name];
-  switch (input) {
-    case '':
-    case undefined:
-      return core.getInput(name, {required: mandatory});
-    default:
+  const input = core.getInput(name);
+  const env_input = await readEnv(name);
+  switch (true) {
+    case input != '':
       return input;
+    case input == '' && env_input != '':
+      return env_input;
+    case input == '' && env_input == '' && mandatory:
+      throw new Error(`Input required and not supplied: ${name}`);
+    default:
+      return '';
+  }
+}
+
+/**
+ * Function to parse PHP version.
+ *
+ * @param version
+ */
+export async function parseVersion(version: string): Promise<string> {
+  switch (version) {
+    case 'latest':
+      return '7.4';
+    default:
+      switch (true) {
+        case version.length > 1:
+          return version.slice(0, 3);
+        default:
+          return version + '.0';
+      }
   }
 }