feat: better multipart tests

.github/workflows/tests.yml

@@ -100,3 +100,23 @@ jobs:
 
       - name: Lint
         run: composer lint
+
+  specs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup PHP with PECL extension
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions: curl
+
+      - name: Install
+        run: composer install
+
+      - name: Validate specs
+        run: composer test tests/SpecsTest.php
+

composer.json

@@ -31,7 +31,8 @@
         "ext-mbstring": "*",
         "ext-json": "*",
         "twig/twig": "3.14.*",
-        "matthiasmullie/minify": "1.3.*"
+        "matthiasmullie/minify": "1.3.*",
+        "utopia-php/fetch": "^0.2.1"
     },
     "require-dev": {
         "phpunit/phpunit": "11.*",

mock-server/app/http.php

@@ -387,7 +387,7 @@
     });
 
 App::get('/v1/mock/tests/general/multipart')
-    ->alias('/v1/mock/tests/general/multipartcomplied')
+    ->alias('/v1/mock/tests/general/multipart-compiled')
     ->desc('Multipart')
     ->groups(['mock'])
     ->label('scope', 'public')
@@ -410,6 +410,31 @@
         ]);
     });
 
+App::get('/v1/mock/tests/general/multipart-json')
+    ->desc('Multipart')
+    ->groups(['mock'])
+    ->label('scope', 'public')
+    ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
+    ->label('sdk.namespace', 'general')
+    ->label('sdk.method', 'multipartJson')
+    ->label('sdk.description', 'Mock a multipart request.')
+    ->label('sdk.response.code', Response::STATUS_CODE_OK)
+    ->label('sdk.response.type', Response::CONTENT_TYPE_MULTIPART)
+    ->label('sdk.response.model', Response::MODEL_MULTIPART)
+    ->label('sdk.mock', true)
+    ->inject('response')
+    ->action(function (Response $response) {
+
+        $response->multipart([
+            'x' => 'abc',
+            'y' => 123,
+            'responseBody' => [
+                'key' => 'value',
+                'key2' => 'value2',
+            ],
+        ]);
+    });
+
 App::get('/v1/mock/tests/general/redirect')
     ->desc('Redirect')
     ->groups(['mock'])

mock-server/docker-compose.yml

@@ -2,7 +2,7 @@ services:
   mockapi:
     container_name: mockapi
     ports:
-      - 8080:80
+      - 3175:80
     build:
       context: .
       args:

templates/php/src/Client.php.twig

@@ -283,7 +283,7 @@ class Client
             $data['duration'] = ((float) ($data['duration'] ?? ''));
         }
         if(isset($data['responseBody'])) {
-            $data['responseBody'] = Payload::fromString($data['responseBody'] ?? '');
+            $data['responseBody'] = Payload::fromBinary($data['responseBody'] ?? '');
         }
 
         return $data;

templates/python/package/payload.py.twig

@@ -32,8 +32,8 @@ class Payload:
 
         return self._data[offset:offset + length]
 
-    def to_string(self) -> str:
-        return str(self.to_binary())
+    def to_string(self, encoding='utf-8') -> str:
+        return self.to_binary().decode(encoding)
 
     def to_json(self) -> Dict[str, Any]:
         return json.loads(self.to_string())

tests/Base.php

@@ -76,7 +76,9 @@ abstract class Base extends TestCase
 
     protected const MULTIPART_RESPONSES = [
         'abc',
-        'd80e7e6999a3eb2ae0d631a96fe135a4' #
+        'd80e7e6999a3eb2ae0d631a96fe135a4',
+        '{"key": "value", "key2": "value2"}',
+        'value',
     ];
 
     protected const QUERY_HELPER_RESPONSES = [

tests/SpecsTest.php

@@ -0,0 +1,27 @@
+<?php
+
+use PHPUnit\Framework\TestCase;
+use Utopia\Fetch\Client;
+
+class SpecsTest extends TestCase
+{
+    public function testSpecs()
+    {
+            $specsPath = dirname(__FILE__) . '/resources/spec.json';
+            $specs = json_decode(file_get_contents($specsPath), true);
+
+            $client = new Client();
+            $client->addHeader('content-type', 'application/json');
+
+            $response = $client->fetch(
+                url: 'https://validator.swagger.io/validator/debug',
+                method: Client::METHOD_POST,
+                body: $specs
+            );
+
+            $this->assertEquals(200, $response->getStatusCode(), 'Failed to validate specs: ' . $response->getBody());
+
+            $body = $response->json();
+            $this->assertEmpty($body['schemaValidationMessages'], 'Schema validation failed: ' . json_encode($body['schemaValidationMessages'], JSON_PRETTY_PRINT));
+    }
+}

tests/languages/android/Tests.kt

@@ -170,7 +170,7 @@ class ServiceTest {
             general.empty()
 
             // Multipart tests
-            val mp = general.multipartComplied()
+            val mp = general.multipartCompiled()
 
             writeToFile((mp as Map<String, Any>)["x"] as String)
             writeToFile(md5(((mp as Map<String, Any>)["responseBody"] as Payload).toBinary()))

tests/languages/dart/tests.dart

@@ -120,6 +120,10 @@ void main() async {
   final hash = md5.convert(responseMultipart.responseBody.toBinary()).toString();
   print(hash);
 
+  responseMultipart = await general.multipartJson();
+  print(responseMultipart.responseBody.toString());
+  print(responseMultipart.responseBody.toJson()['key']);
+
   // Query helper tests
   print(Query.equal('released', [true]));
   print(Query.equal('title', ['Spiderman', 'Dr. Strange']));

tests/languages/deno/tests.ts

@@ -151,6 +151,10 @@ async function start() {
   const binary = await response['responseBody'].toBinary();
   console.log(createHash("md5").update(binary).toString('hex'));
 
+  response = await general.multipartJson();
+  console.log(response.responseBody.toString());
+  console.log(response.responseBody.toJson<{ key: string, key2: string}>()["key"]);
+
   // Query helper tests
   console.log(Query.equal("released", [true]));
   console.log(Query.equal("title", ["Spiderman", "Dr. Strange"]));

tests/languages/dotnet/Tests.cs

@@ -122,7 +122,7 @@ public async Task Test1()
             );
             TestContext.WriteLine(url);
             // Multipart tests
-            var response = await general.MultipartComplied();
+            var response = await general.MultipartCompiled();
             var res = (response as Dictionary<string, object>);
             TestContext.WriteLine(res["x"]);
             var pl = res["responseBody"] as Payload;

tests/languages/flutter/tests.dart

@@ -145,6 +145,10 @@ void main() async {
   final hash = md5.convert(responseMultipart.responseBody.toBinary()).toString();
   print(hash);
 
+  responseMultipart = await general.multipartJson();
+  print(responseMultipart.responseBody.toString());
+  print(responseMultipart.responseBody.toJson()['key']);
+
   // Query helper tests
   print(Query.equal('released', [true]));
   print(Query.equal('title', ['Spiderman', 'Dr. Strange']));

tests/languages/go/tests.go

@@ -189,7 +189,7 @@ func testLargeUpload(client client.Client, stringInArray []string) {
 
 func testMultipart(client client.Client){
     g := general.New(client)
-    mp, err := g.MultipartComplied()
+    mp, err := g.MultipartCompiled()
 
     if err != nil { return }
 

tests/languages/kotlin/Tests.kt

@@ -136,7 +136,7 @@ class ServiceTest {
             writeToFile(url)
 
             // Multipart tests
-            val mp = general.multipartComplied()
+            val mp = general.multipartCompiled()
 
             writeToFile((mp as Map<String, Any>)["x"] as String)
             writeToFile(md5(((mp as Map<String, Any>)["responseBody"] as Payload).toBinary()))

tests/languages/node/test.js

@@ -172,6 +172,10 @@ async function start() {
     const responseBodyBinary = response.responseBody.toBinary();
     const hash = crypto.createHash('md5').update(responseBodyBinary).digest('hex');
     console.log(hash); // should be d80e7e6999a3eb2ae0d631a96fe135a4
+
+    response = await general.multipartJson();
+    console.log(response.responseBody.toString());
+    console.log(response.responseBody.toJson()['key']);
 }
 
 start().catch((err) => {

tests/languages/php/test.php

@@ -123,6 +123,10 @@
 $hash = md5($response['responseBody']->toBinary());
 echo "{$hash}\n";
 
+$response = $general->multipartJson();
+echo "{$response['responseBody']->toString()}\n";
+echo "{$response['responseBody']->toJson()['key']}\n";
+
 // Query helper tests
 echo Query::equal('released', [true]) . "\n";
 echo Query::equal('title', ['Spiderman', 'Dr. Strange']) . "\n";

tests/languages/python/tests.py

@@ -108,6 +108,10 @@
 print(response['x']) # should be "abc"
 print(md5(response['responseBody'].to_binary()).hexdigest()) # should be d80e7e6999a3eb2ae0d631a96fe135a4
 
+response = general.multipart_json()
+print(response['responseBody'].to_string())
+print(response['responseBody'].to_json()['key'])
+
 # Query helper tests
 print(Query.equal("released", [True]))
 print(Query.equal("title", ["Spiderman", "Dr. Strange"]))

tests/languages/ruby/tests.rb

@@ -126,6 +126,15 @@
     puts e
 end
 
+begin
+    response = general.multipart_json()
+
+    puts response.response_body.to_string
+    puts response.response_body.to_json()['key']
+rescue => e
+    puts e
+end
+
 # Query helper tests
 puts Query.equal('released', [true])
 puts Query.equal('title', ['Spiderman', 'Dr. Strange'])