feat(php): PHP tests #378

damcou · 2022-04-14T13:24:48Z

🧭 What and Why

🎟 JIRA Ticket: APIC-328

Changes included:

Added PHP Test template for the CTS
Generated classes

🧪 Test

yarn docker cts generate php
yarn docker cts run php

netlify · 2022-04-14T13:24:53Z

✅ Deploy Preview for api-clients-automation ready!

Name	Link
🔨 Latest commit	`47c8f95`
🔍 Latest deploy log	https://app.netlify.com/sites/api-clients-automation/deploys/62690e2e2db500000955b5b7
😎 Deploy Preview	https://deploy-preview-378--api-clients-automation.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

# Conflicts: # scripts/cts/client/generate.ts # scripts/cts/utils.ts

algolia-bot · 2022-04-14T13:56:04Z

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.

shortcuts

Looks really nice already! Will do an other pass once the CI is green

generators/src/main/java/com/algolia/codegen/cts/AlgoliaCtsGenerator.java

generators/src/main/java/com/algolia/codegen/cts/ParametersWithDataType.java

shortcuts · 2022-04-21T07:46:59Z

generators/src/main/java/com/algolia/codegen/cts/ParametersWithDataType.java


    Map<String, Object> testOutput = createDefaultOutput();
    testOutput.put("key", finalParamName);
    testOutput.put("parentSuffix", suffix - 1);
+    testOutput.put("isFirstLevel", isFirstLevel);
+    testOutput.put("hasGeneratedKey", finalParamName.matches("(.*)_[0-9]$"));


What is the hasGeneratedKey referring to please?

From what I understood, @millotp needs to generate keys to structure the data when there's no defined key in the test (for example here: https://github.com/algolia/api-clients-automation/blob/main/tests/CTS/methods/requests/recommend/getRecommendations.json#L34 where a requests_0 is generated by the custom generator. This is a problem for the PHP tests because the expected array structure is not the good one for the tests. That's why I added a boolean which checks if the key has been generated or not (if it's the case, I don't use it)

package.json

shortcuts · 2022-04-21T07:48:32Z

tests/output/php/src/methods/requests/InsightsTest.php

+                'body' => json_decode(
+                    "{\"events\":[{\"eventType\":\"click\",\"eventName\":\"Product Clicked\",\"index\":\"products\",\"userToken\":\"user-123456\",\"timestamp\":1641290601962,\"objectIDs\":[\"9780545139700\",\"9780439784542\"],\"queryID\":\"43b15df305339e827f0ac0bdc5ebcaa7\",\"positions\":[7,6]},{\"eventType\":\"view\",\"eventName\":\"Product Detail Page Viewed\",\"index\":\"products\",\"userToken\":\"user-123456\",\"timestamp\":1641290601962,\"objectIDs\":[\"9780545139700\",\"9780439784542\"]},{\"eventType\":\"conversion\",\"eventName\":\"Product Purchased\",\"index\":\"products\",\"userToken\":\"user-123456\",\"timestamp\":1641290601962,\"objectIDs\":[\"9780545139700\",\"9780439784542\"],\"queryID\":\"43b15df305339e827f0ac0bdc5ebcaa7\"}]}"
+                ),


I assume there's no prettier way to do it? :(

At the beginning, I used simple quotes to embed the json, but for some paths, we use simple quotes as well, so as we already have the lambda.escapequotes function available for the templates, I thought it was the easiest and more secured way to do it .

millotp

Very cool ! just a few comments but it's working very well !

clients/algoliasearch-client-php/lib/Configuration/Configuration.php

generators/src/main/java/com/algolia/codegen/cts/AlgoliaCtsGenerator.java

millotp · 2022-04-21T09:26:27Z

scripts/cts/runCts.ts

@@ -24,7 +23,7 @@ async function runCtsOne(language: string, verbose: boolean): Promise<void> {
        { verbose }
      );
      break;
-    }*/
+    }


I cannot comment on line 22 but small question, do we need to run a command before to make sure that the phpunit binary is there ?

phpunit is included in the composer.json file so I don't know why the binary wouldn't be there. Do you have any specific potential issue in mind ?

Okay but when do you run composer ?

For example on the CI we run the CTS directly, we won't run composer before

millotp · 2022-04-21T09:27:43Z

scripts/formatter.ts

@@ -27,6 +27,7 @@ export async function formatter(
    case 'php':
      cmd = `composer update --working-dir=clients/algoliasearch-client-php \


I'm getting some errors from this formatter: [error] No supported files were found in the directory: "tests/output/php/src".. Do we need to add something to the docker image ? Or it as to do with the file naming (it generates them with lowercase) ?

millotp · 2022-04-21T09:30:09Z

generators/src/main/java/com/algolia/codegen/cts/ParametersWithDataType.java


    Map<String, Object> testOutput = createDefaultOutput();
    testOutput.put("key", finalParamName);
    testOutput.put("parentSuffix", suffix - 1);
+    testOutput.put("isFirstLevel", isFirstLevel);


Maybe you can use {{^parent}} instead of {{isFirstLevel}}, because it should be null for root element

If I use this, I get weird values like "indexName" => "[B@3e850122" , that's why I added this boolean.

tests/CTS/methods/requests/templates/php/generateParams.mustache

millotp · 2022-04-21T12:25:39Z

Can you remove the file SearchClientTest.php outside of src ? I think it was just a test

clients/algoliasearch-client-php/lib/Configuration/Configuration.php

millotp · 2022-04-26T15:03:06Z

tests/output/php/src/methods/requests/AbtestingTest.php

+        }
+    }
+
+    public function sendRequest(


I don't know much about phpunit, when is sendRequest called ?

I'm not a PHPUnit expert (nor PHP tests either) but the sendRequest() method seems to be called each time a method is called from the client object (it has been implemented this way in the current PHP client). And instead of performing the true request, it stores it in an array of requests and return automatically a 200 response (the requests are tested afterwards in the assertRequests() method).

does that mean it doesn't go through the client code ?

It goes through the code and stores the targeted api endpoint and the computed data sent (if any), the HTTP call is just not done.

shortcuts

looks really nice from my noob eye, I mostly have template comments

shortcuts · 2022-04-26T15:31:06Z

tests/CTS/methods/requests/templates/php/requests.mustache

+    {
+        $client = $this->getClient();
+
+        {{#hasParameters}}
+
+        $client->{{{method}}}(
+        {{#parametersWithDataType}}{{> generateParams}}{{/parametersWithDataType}}
+        );
+        {{/hasParameters}}
+        {{^hasParameters}}
+            $client->{{{method}}}();
+        {{/hasParameters}}
+
+        $this->assertRequests([
+            [
+                "path" => "{{{request.path}}}",
+                "method" => "{{{request.method}}}",
+                {{#request.data}}
+                "body" => json_decode("{{#lambda.escapequotes}}{{{request.data}}}{{/lambda.escapequotes}}"),
+                {{/request.data}}
+                {{#request.searchParams}}
+                "searchParams" => json_decode("{{#lambda.escapequotes}}{{{request.searchParams}}}{{/lambda.escapequotes}}"),
+                {{/request.searchParams}}
+            ],
+        ]);
+    }


We should remove some spaces here and inline mustache conditions, otherwise it puts newlines between every lines

e.g.

Suggested change

{

$client = $this->getClient();

{{#hasParameters}}

$client->{{{method}}}(

{{#parametersWithDataType}}{{> generateParams}}{{/parametersWithDataType}}

);

{{/hasParameters}}

{{^hasParameters}}

$client->{{{method}}}();

{{/hasParameters}}

$this->assertRequests([

[

"path" => "{{{request.path}}}",

"method" => "{{{request.method}}}",

{{#request.data}}

"body" => json_decode("{{#lambda.escapequotes}}{{{request.data}}}{{/lambda.escapequotes}}"),

{{/request.data}}

{{#request.searchParams}}

"searchParams" => json_decode("{{#lambda.escapequotes}}{{{request.searchParams}}}{{/lambda.escapequotes}}"),

{{/request.searchParams}}

],

]);

}

{

$client = $this->getClient();

$client->{{^hasParameters}}{{{method}}}();{{/hasParameters}}{{#hasParameters}}{{{method}}}(

{{#parametersWithDataType}}{{> generateParams}}{{/parametersWithDataType}}

);{{/hasParameters}}

$this->assertRequests([

[

"path" => "{{{request.path}}}",

"method" => "{{{request.method}}}",

{{#request.data}}"body" => json_decode("{{#lambda.escapequotes}}{{{request.data}}}{{/lambda.escapequotes}}"),{{/request.data}}

{{#request.searchParams}}"searchParams" => json_decode("{{#lambda.escapequotes}}{{{request.searchParams}}}{{/lambda.escapequotes}}"),{{/request.searchParams}}

],

]);

}

The linter should do the rest

shortcuts · 2022-04-26T15:35:31Z

tests/CTS/methods/requests/templates/php/generateParams.mustache

+{{#isFirstLevel}}{{#isString}}"{{{value}}}"{{/isString}}
+{{#isInteger}}{{{value}}}{{/isInteger}}
+{{#isDouble}}{{{value}}}{{/isDouble}}
+{{#isLong}}{{{value}}}{{/isLong}}
+{{#isBoolean}}{{{value}}}{{/isBoolean}}
+{{#isEnum}}"{{{value}}}"{{/isEnum}}
+{{#isArray}}[{{#value}}{{> generateParams}}{{/value}}]{{/isArray}}
+{{#isObject}}[{{#value}}{{> generateParams}}{{/value}}]{{/isObject}}
+{{#isFreeFormObject}}[{{#value}}{{> generateParams}}{{/value}}]{{/isFreeFormObject}}
+{{^-last}},{{/-last}}
+{{/isFirstLevel}}
+{{^isFirstLevel}}
+{{^hasGeneratedKey}}"{{{key}}}" => {{/hasGeneratedKey}}
+{{#isString}}"{{{value}}}",{{/isString}}
+{{#isInteger}}{{{value}}},{{/isInteger}}
+{{#isDouble}}{{{value}}},{{/isDouble}}
+{{#isLong}}{{{value}}},{{/isLong}}
+{{#isBoolean}}{{{value}}},{{/isBoolean}}
+{{#isEnum}}"{{{value}}}",{{/isEnum}}
+{{#isArray}}[{{#value}}{{> generateParams}}{{/value}}],{{/isArray}}
+{{#isObject}}[{{#value}}{{> generateParams}}{{/value}}],{{/isObject}}
+{{#isFreeFormObject}}[{{#value}}{{> generateParams}}{{/value}}],{{/isFreeFormObject}}
+{{/isFirstLevel}}


Same case here

Suggested change

{{#isFirstLevel}}{{#isString}}"{{{value}}}"{{/isString}}

{{#isInteger}}{{{value}}}{{/isInteger}}

{{#isDouble}}{{{value}}}{{/isDouble}}

{{#isLong}}{{{value}}}{{/isLong}}

{{#isBoolean}}{{{value}}}{{/isBoolean}}

{{#isEnum}}"{{{value}}}"{{/isEnum}}

{{#isArray}}[{{#value}}{{> generateParams}}{{/value}}]{{/isArray}}

{{#isObject}}[{{#value}}{{> generateParams}}{{/value}}]{{/isObject}}

{{#isFreeFormObject}}[{{#value}}{{> generateParams}}{{/value}}]{{/isFreeFormObject}}

{{^-last}},{{/-last}}

{{/isFirstLevel}}

{{^isFirstLevel}}

{{^hasGeneratedKey}}"{{{key}}}" => {{/hasGeneratedKey}}

{{#isString}}"{{{value}}}",{{/isString}}

{{#isInteger}}{{{value}}},{{/isInteger}}

{{#isDouble}}{{{value}}},{{/isDouble}}

{{#isLong}}{{{value}}},{{/isLong}}

{{#isBoolean}}{{{value}}},{{/isBoolean}}

{{#isEnum}}"{{{value}}}",{{/isEnum}}

{{#isArray}}[{{#value}}{{> generateParams}}{{/value}}],{{/isArray}}

{{#isObject}}[{{#value}}{{> generateParams}}{{/value}}],{{/isObject}}

{{#isFreeFormObject}}[{{#value}}{{> generateParams}}{{/value}}],{{/isFreeFormObject}}

{{/isFirstLevel}}

{{#isFirstLevel}}{{#isString}}"{{{value}}}"{{/isString}}

{{#isInteger}}{{{value}}}{{/isInteger}}

{{#isDouble}}{{{value}}}{{/isDouble}}

{{#isLong}}{{{value}}}{{/isLong}}

{{#isBoolean}}{{{value}}}{{/isBoolean}}

{{#isEnum}}"{{{value}}}"{{/isEnum}}

{{#isArray}}[{{#value}}{{> generateParams}}{{/value}}]{{/isArray}}

{{#isObject}}[{{#value}}{{> generateParams}}{{/value}}]{{/isObject}}

{{#isFreeFormObject}}[{{#value}}{{> generateParams}}{{/value}}]{{/isFreeFormObject}}

{{^-last}},{{/-last}}{{/isFirstLevel}}{{^isFirstLevel}}

{{^hasGeneratedKey}}"{{{key}}}" => {{/hasGeneratedKey}}

{{#isString}}"{{{value}}}",{{/isString}}

{{#isInteger}}{{{value}}},{{/isInteger}}

{{#isDouble}}{{{value}}},{{/isDouble}}

{{#isLong}}{{{value}}},{{/isLong}}

{{#isBoolean}}{{{value}}},{{/isBoolean}}

{{#isEnum}}"{{{value}}}",{{/isEnum}}

{{#isArray}}[{{#value}}{{> generateParams}}{{/value}}],{{/isArray}}

{{#isObject}}[{{#value}}{{> generateParams}}{{/value}}],{{/isObject}}

{{#isFreeFormObject}}[{{#value}}{{> generateParams}}{{/value}}],{{/isFreeFormObject}}{{/isFirstLevel}}

Also, some conditions could be factorized (all they all used in PHP?)

I actually tried those updates and for some reason, not only that it doesn't remove blank lines but it adds some :( . The linter doesn't remove the additional blank lines in PHP, TBH I don't know how to remove them, but I don't think it should be a blocker since it's only test classes.

millotp

The code looks good, I'm surprised there is nothing to change in the client for it to pass, good job !

algolia/api-clients-automation#378 Co-authored-by: Damien Couchez <damien.couchez@gmail.com>

feat(php): initiate the test template for php tests

48e9370

Merge branch 'main' into feat/APIC-328/php-tests

f724899

# Conflicts: # scripts/cts/client/generate.ts # scripts/cts/utils.ts

damcou added 14 commits April 14, 2022 15:59

feat(php): updated Cts generator

55b8c8f

Merge branch 'main' into feat/APIC-328/php-tests

0ce4ece

feat(php): add prettier and update template

6519a20

feat(php): handle generated keys

a54134d

feat(php): Finally got the recommend test class working

41e3d4d

feat(php): add tests

fbd120c

feat(php): add tests

c6ded66

feat(php): update tests

2c3a31d

feat(php): add SearchTest

dfe2746

Merge branch 'main' into feat/APIC-328/php-tests

751898a

Merge branch 'main' into feat/APIC-328/php-tests

6cfcf29

feat(php): update client name in test

9b06bd6

feat(php): regenerate tests with new client

20e61e1

feat(php): fix json

6010713

damcou marked this pull request as ready for review April 20, 2022 16:17

damcou requested review from millotp and shortcuts and removed request for millotp April 20, 2022 16:17

shortcuts reviewed Apr 21, 2022

View reviewed changes

damcou and others added 3 commits April 21, 2022 10:09

Merge branch 'main' into feat/APIC-328/php-tests

35d57b8

fix java cts

706a19f

Merge branch 'main' into feat/APIC-328/php-tests

56db047

millotp reviewed Apr 21, 2022

View reviewed changes

damcou added 2 commits April 21, 2022 12:07

Merge branch 'main' into feat/APIC-328/php-tests

026c4d3

feat(php): updated clients

41b61bb

damcou added 5 commits April 21, 2022 14:47

feat(php): regenerate classes

c211027

feat(php): changes after review

7405340

Merge branch 'main' into feat/APIC-328/php-tests

bf5546e

feat(php): lint custom generator

7eca884

feat(php): removed use of env vars for initializing php clients

83f427d

millotp reviewed Apr 22, 2022

View reviewed changes

clients/algoliasearch-client-php/lib/Configuration/Configuration.php Outdated Show resolved Hide resolved

millotp and others added 2 commits April 26, 2022 11:24

add fat jar (#272)

384af93

Merge branch 'main' into feat/APIC-328/php-tests

6b5b169

shortcuts force-pushed the main branch from 384af93 to 554bc2b Compare April 26, 2022 09:30

damcou added 5 commits April 26, 2022 11:32

feat(php): pierre's review

40b9301

Merge branch 'main' into feat/APIC-328/php-tests

d12d52c

Merge branch 'main' into feat/APIC-328/php-tests

c658aa3

feat(php): update yarn.lock

e9c0943

feat(php): update tests

183145a

millotp reviewed Apr 26, 2022

View reviewed changes

shortcuts reviewed Apr 26, 2022

View reviewed changes

Merge branch 'main' into feat/APIC-328/php-tests

47c8f95

millotp approved these changes Apr 27, 2022

View reviewed changes

damcou merged commit 5862227 into main Apr 27, 2022

damcou deleted the feat/APIC-328/php-tests branch April 27, 2022 10:03

algolia-bot added a commit to algolia/algoliasearch-client-php that referenced this pull request Apr 27, 2022

feat(php): PHP tests

3384797

algolia/api-clients-automation#378 Co-authored-by: Damien Couchez <damien.couchez@gmail.com>

This was referenced Apr 28, 2022

chore: release 2022-04-28 #445

Closed

chore: release 2022-04-28 #446

Closed

chore: release 2022-04-29 #456

Closed

chore: release 2022-04-29 #461

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(php): PHP tests #378

feat(php): PHP tests #378

damcou commented Apr 14, 2022 •

edited

Loading

netlify bot commented Apr 14, 2022 •

edited

Loading

algolia-bot commented Apr 14, 2022 •

edited

Loading

shortcuts left a comment

shortcuts Apr 21, 2022

damcou Apr 21, 2022

shortcuts Apr 21, 2022

damcou Apr 21, 2022

millotp left a comment

millotp Apr 21, 2022

damcou Apr 21, 2022 •

edited

Loading

millotp Apr 21, 2022

millotp Apr 21, 2022

millotp Apr 21, 2022

millotp Apr 21, 2022

damcou Apr 21, 2022

millotp commented Apr 21, 2022

millotp Apr 26, 2022

damcou Apr 26, 2022

millotp Apr 27, 2022

damcou Apr 27, 2022

shortcuts left a comment

shortcuts Apr 26, 2022

shortcuts Apr 26, 2022

damcou Apr 27, 2022

millotp left a comment

		@@ -27,6 +27,7 @@ export async function formatter(
		case 'php':
		cmd = `composer update --working-dir=clients/algoliasearch-client-php \

feat(php): PHP tests #378

feat(php): PHP tests #378

Conversation

damcou commented Apr 14, 2022 • edited Loading

🧭 What and Why

Changes included:

🧪 Test

netlify bot commented Apr 14, 2022 • edited Loading

✅ Deploy Preview for api-clients-automation ready!

algolia-bot commented Apr 14, 2022 • edited Loading

✗ The generated branch has been deleted.

shortcuts left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

millotp left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

damcou Apr 21, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

millotp commented Apr 21, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shortcuts left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

millotp left a comment

Choose a reason for hiding this comment

damcou commented Apr 14, 2022 •

edited

Loading

netlify bot commented Apr 14, 2022 •

edited

Loading

algolia-bot commented Apr 14, 2022 •

edited

Loading

damcou Apr 21, 2022 •

edited

Loading