Merge pull request #1250 from appwrite/fix-php-build-failing

fix: php build failing

Author: abnegate

.github/workflows/sdk-build-validation.yml

@@ -173,6 +173,7 @@ jobs:
               ;;
             php)
               composer install
+              find . -name "*.php" ! -path "./vendor/*" -exec php -l {} +
               ;;
             python)
               pip install -e .

src/SDK/Language/PHP.php

@@ -172,6 +172,11 @@ public function getFiles(): array
                 'destination'   => 'composer.json',
                 'template'      => 'php/composer.json.twig',
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'phpunit.xml',
+                'template'      => 'php/phpunit.xml.twig',
+            ],
             [
                 'scope'         => 'service',
                 'destination'   => 'docs/{{service.name | caseLower}}.md',

templates/php/composer.json.twig

@@ -7,6 +7,9 @@
         "url": "{{ spec.contactURL }}",
         "email": "{{ spec.contactEmail }}"
     },
+    "scripts": {
+        "test": "vendor/bin/phpunit"
+    },
     "autoload": {
         "psr-4": {
             "{{spec.title | caseUcfirst}}\\": "src/{{spec.title | caseUcfirst}}"
@@ -19,7 +22,7 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^10",
-        "mockery/mockery": "^1.6.6"
+        "mockery/mockery": "^1.6.12"
     },
     "minimum-stability": "dev"
 }

templates/php/phpunit.xml.twig

@@ -0,0 +1,32 @@
+<?xml version="1.0"?>
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
+    bootstrap="vendor/autoload.php"
+    cacheDirectory=".phpunit.cache"
+    colors="true"
+    displayDetailsOnIncompleteTests="true"
+    displayDetailsOnSkippedTests="true"
+    displayDetailsOnTestsThatTriggerDeprecations="true"
+    displayDetailsOnTestsThatTriggerErrors="true"
+    displayDetailsOnTestsThatTriggerNotices="true"
+    displayDetailsOnTestsThatTriggerWarnings="true"
+    failOnDeprecation="true"
+    failOnEmptyTestSuite="true"
+    failOnIncomplete="true"
+    failOnRisky="true"
+    failOnSkipped="true"
+    failOnWarning="true"
+>
+    <testsuites>
+        <testsuite name="{{ spec.title | caseUcfirst }} SDK Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <source>
+        <include>
+            <directory suffix=".php">./src/{{ spec.title | caseUcfirst }}</directory>
+        </include>
+    </source>
+</phpunit>

templates/php/src/Services/Service.php.twig

@@ -30,7 +30,17 @@ class {{ service.name | caseUcfirst }} extends Service
          parent::__construct($client);
      }
 
+{% set nonDeprecatedMethodNames = [] %}
 {% for method in service.methods %}
+{% if not method.deprecated %}
+{% set nonDeprecatedMethodNames = nonDeprecatedMethodNames|merge([method.name | caseCamel | lower]) %}
+{% endif %}
+{% endfor %}
+{% for method in service.methods %}
+{% set methodNameLower = method.name | caseCamel | lower %}
+{% if method.deprecated and methodNameLower in nonDeprecatedMethodNames %}
+{# Skip deprecated methods that have namespace collisions with non-deprecated methods #}
+{% else %}
 {% set deprecated_message = '' %}
     /**
 {% if method.description %}
@@ -72,6 +82,7 @@ class {{ service.name | caseUcfirst }} extends Service
     }
         {%~ if not loop.last %}
 
+        {%~ endif %}
         {%~ endif %}
         {%~ endfor %}
 }

templates/php/tests/Services/ServiceTest.php.twig

@@ -16,7 +16,17 @@ final class {{service.name | caseUcfirst}}Test extends TestCase {
         $this->{{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}($this->client);
     }
 
+{% set nonDeprecatedMethodNames = [] %}
 {% for method in service.methods %}
+{% if not method.deprecated %}
+{% set nonDeprecatedMethodNames = nonDeprecatedMethodNames|merge([method.name | caseCamel | lower]) %}
+{% endif %}
+{% endfor %}
+{% for method in service.methods %}
+{% set methodNameLower = method.name | caseCamel | lower %}
+{% if method.deprecated and methodNameLower in nonDeprecatedMethodNames %}
+{# Skip deprecated methods that have namespace collisions with non-deprecated methods #}
+{% else %}
     public function testMethod{{method.name | caseUcfirst}}(): void {
         {%~ if method.responseModel and method.responseModel != 'any' ~%}
         $data = array(
@@ -40,5 +50,6 @@ final class {{service.name | caseUcfirst}}Test extends TestCase {
         $this->assertSame($data, $response);
     }
 
+{% endif %}
 {% endfor %}
 }