Merge pull request #121 from eclipxe13/version-2.28.2

Fix openssl run not throwing an OpenSSLException (version 2.28.2)

Author: eclipxe13

.github/workflows/build.yml

@@ -2,11 +2,9 @@ name: build
 on:
   workflow_dispatch:
   pull_request:
-    branches:
-      - master
+    branches: [ "master" ]
   push:
-    branches:
-      - master
+    branches: [ "master" ]
   schedule:
     - cron: '0 16 * * 0' # sunday 16:00
 
@@ -107,11 +105,11 @@ jobs:
         run: phpstan analyse --no-progress --verbose
 
   tests-linux:
-    name: Test PHP ${{ matrix.php-versions }} on Linux
+    name: Test PHP ${{ matrix.php-version }} on Linux
     runs-on: "ubuntu-latest"
     strategy:
       matrix:
-        php-versions: [ '7.3', '7.4', '8.0', '8.1', '8.2', '8.3' ]
+        php-version: [ '7.3', '7.4', '8.0', '8.1', '8.2', '8.3' ]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -127,7 +125,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: ${{ matrix.php-versions }}
+          php-version: ${{ matrix.php-version }}
           extensions: soap, intl, xsl, fileinfo, bcmath
           coverage: xdebug
           tools: composer:v2
@@ -149,7 +147,7 @@ jobs:
           mv resources-sat-xml-cloned/resources build/resources
           rm -r -f resources-sat-xml-cloned
       - name: Remove genkgo/xsl on PHP 8.3
-        if: matrix.php-versions == '8.3'
+        if: matrix.php-version == '8.3'
         run: |
           composer remove genkgo/xsl --dev --no-interaction --no-progress --no-update
       - name: Install project dependencies
@@ -165,11 +163,11 @@ jobs:
           php build/scrutinizer/vendor/bin/ocular code-coverage:upload -vvv --no-interaction --format=php-clover build/coverage-clover.xml
 
   tests-windows:
-    name: Tests PHP ${{ matrix.php-versions }} on Windows
+    name: Tests PHP ${{ matrix.php-version }} on Windows
     runs-on: "windows-latest"
     strategy:
       matrix:
-        php-versions: [ '7.3', '7.4', '8.0', '8.1', '8.2', '8.3' ]
+        php-version: [ '7.3', '7.4', '8.0', '8.1', '8.2', '8.3' ]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -178,7 +176,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: ${{ matrix.php-versions }}
+          php-version: ${{ matrix.php-version }}
           extensions: soap, intl, xsl, fileinfo, bcmath
           coverage: none
           tools: composer:v2
@@ -201,7 +199,7 @@ jobs:
           mv resources-sat-xml-cloned/resources build/resources
           rm -r -f resources-sat-xml-cloned
       - name: Remove genkgo/xsl on PHP 8.3
-        if: matrix.php-versions == '8.3'
+        if: matrix.php-version == '8.3'
         run: |
           composer remove genkgo/xsl --dev --no-interaction --no-progress --no-update
       - name: Install project dependencies

.readthedocs.yaml

@@ -8,12 +8,7 @@ version: 2
 build:
     os: ubuntu-22.04
     tools:
-        python: "3.7"
+        python: "3"
 
 mkdocs:
   configuration: mkdocs.yml
-
-# Optionally set the version of Python and requirements required to build your docs
-python:
-   install:
-     - requirements: docs/rtd-requirements.txt

composer.json

@@ -44,6 +44,7 @@
     },
     "require-dev": {
         "ext-bcmath": "*",
+        "ext-curl": "*",
         "ext-soap": "*",
         "genkgo/xsl": "^1.0.8",
         "phpunit/phpunit": "^9.5",

docs/CHANGELOG.md

@@ -33,6 +33,15 @@
 - Remove deprecated constant `CfdiUtils\Retenciones\Retenciones::RET_NAMESPACE`.
 - Remove deprecated class `CfdiUtils\Utils\Crp20277Fixer`.
 
+## Version 2.28.2 2024-02-20
+
+- Wrap OpenSSL command run on a *try/catch* block to throw OpenSSLException.
+- Refactor certificate downloader test helper. Now it uses curl instead of native PHP. It was failing on PHP 7.3.
+- Remove old dependencies for *ReadTheDocs*: `mkdocs:1.2.3` and `jinja2<3.1.0`. Thanks to `@dependabot`.
+- On build workflow:
+    - Simplify "on" section.
+    - Use `php-version` matrix value as singular.
+
 ## Version 2.28.1 2024-02-20
 
 - Allow dependency on `symfony/process` branch `7.x`.

docs/rtd-requirements.txt

@@ -1,5 +1,5 @@
 {
     "devDependencies": {
-        "markdownlint-cli": "^0.34.0"
+        "markdownlint-cli": "^0.41.0"
     }
 }

package.json

@@ -5,7 +5,7 @@
 /**
  * Build a command array from a template
  *
- * NOTE: Changes will not be considering a bracking compatibility change since this utility is for internal usage only
+ * NOTE: Changes will not be considering a breaking compatibility change since this utility is for internal usage only
  * @internal
  */
 class CommandTemplate

src/CfdiUtils/Internals/CommandTemplate.php

@@ -37,7 +37,11 @@ public function call(string $template, array $arguments, array $environment = []
         }
 
         // execute process
-        $execution = $process->run();
+        try {
+            $execution = $process->run();
+        } catch (Throwable $exception) {
+            throw new OpenSSLException('Unable to run command', 0, $exception);
+        }
 
         // build response
         $callResponse = new CallResponse(

src/CfdiUtils/OpenSSL/Caller.php

@@ -4,47 +4,61 @@
 
 use Exception;
 use XmlResourceRetriever\Downloader\DownloaderInterface;
-use XmlResourceRetriever\Downloader\PhpDownloader;
 
 /**
  * This class is a wrapper around PhpDownloader to retry the download if it fails (for any reason).
  *
  * The reason behind this is that the web server at https://rdc.sat.gob.mx/
- * has issues and sometimes it does not respond with the certificate file.
+ * has issues, and sometimes it does not respond with the certificate file.
  *
  * @see https://www.phpcfdi.com/sat/problemas-conocidos/descarga-certificados/
  */
 final class CertificateDownloaderHelper implements DownloaderInterface
 {
-    /** @var PhpDownloader */
-    private $realDownloader;
-
-    private $maxAttempts;
-
-    public function __construct()
-    {
-        $this->realDownloader = new PhpDownloader();
-        $this->maxAttempts = 8;
-    }
+    public const MAX_DOWNLOAD_ATTEMPTS = 8;
 
     public function downloadTo(string $source, string $destination)
     {
         $attempt = 1;
         while (true) {
             try {
-                $this->realDownloader->downloadTo($source, $destination);
+                $this->realDownloadTo($source, $destination);
                 break;
             } catch (Exception $exception) {
-                // TODO: change to scpecific download exception when it exists
-                if ($exception->getMessage() !== "Unable to download $source to $destination") {
-                    throw $exception;
-                }
-                if ($attempt === $this->maxAttempts) {
-                    throw $exception;
+                if (self::MAX_DOWNLOAD_ATTEMPTS === $attempt) {
+                    throw new Exception("Unable to download $source to $destination", 0, $exception);
                 }
                 $attempt = $attempt + 1;
                 continue;
             }
         }
     }
+
+    private function realDownloadTo(string $source, string $destination)
+    {
+        $ch = curl_init();
+        curl_setopt($ch, CURLOPT_URL, $source);
+        curl_setopt($ch, CURLOPT_VERBOSE, 0); // set to 1 to debug
+        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
+        curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
+        curl_setopt($ch, CURLOPT_HEADER, 0);
+        $result = (string) curl_exec($ch);
+        $status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
+        curl_close($ch);
+
+        if ('' === $result) {
+            throw new Exception('Response is empty');
+        }
+        if (! is_scalar($status)) {
+            throw new Exception('Invalid status code');
+        }
+        $status = (int) $status;
+        if (200 !== $status) {
+            throw new Exception('Status code is not 200');
+        }
+
+        if (false === @file_put_contents($destination, $result)) {
+            throw new Exception('Cannot save certificate on destination');
+        }
+    }
 }