tests: add tests for error messages

impress-org · Oct 23, 2024 · 59ae796 · 59ae796
1 parent 7e459c6
commit 59ae796
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 0 deletions.
diff --git a/src/FormExtension/DonationForm/Rules/TurnstileFieldRule.php b/src/FormExtension/DonationForm/Rules/TurnstileFieldRule.php
@@ -56,6 +56,7 @@ public function __invoke($value, Closure $fail, string $key, array $values)
         if (!$response->isSuccess()) {
             Log::spam(__('Turnstile verification failed.', 'givewp-cloudflare-turnstile'), [
                 'response' => $response,
+                'errorMessages' => $response->getErrorMessages() ?? [],
                 'formId' => $values['formId'] ?? null,
             ]);
 

diff --git a/src/Turnstile/ValueObjects/TurnstileVerifyResponse.php b/src/Turnstile/ValueObjects/TurnstileVerifyResponse.php
@@ -94,4 +94,12 @@ public function getErrorMessage(string $code): ?string
                 return 'Invalid response';
         }
     }
+
+    /**
+     * @return array
+     */
+    public function getErrorMessages(): array
+    {
+        return array_map([$this, 'getErrorMessage'], $this->errorCodes);
+    }
 }
diff --git a/tests/Unit/Turnstile/ValueObjects/TestTurnstileVerifyResponse.php b/tests/Unit/Turnstile/ValueObjects/TestTurnstileVerifyResponse.php
@@ -29,4 +29,51 @@ public function testShouldReturnSelf(): void
         $this->assertTrue($turnstileVerifyResponse->success);
     }
 
+     /**
+     * @since 1.0.0
+      * @dataProvider errorMessagesProvider
+     */
+    public function testShouldGetErrorMessage(string $code, string $message): void
+    {
+        $turnstileVerifyResponse = new TurnstileVerifyResponse((object)[
+            'success' => false,
+            'error_codes' => [$code],
+        ]);
+
+        $this->assertEquals($message, $turnstileVerifyResponse->getErrorMessage($code));
+    }
+
+    /**
+     * @since 1.0.0
+     */
+    public function testShouldGetErrorMessages(): void
+    {
+        $turnstileVerifyResponse = new TurnstileVerifyResponse((object)[
+            'success' => false,
+            'error_codes' => ['missing-input-secret', 'invalid-input-secret'],
+        ]);
+
+        $this->assertEquals([
+            __("The secret parameter was not passed.", 'givewp-cloudflare-turnstile'),
+            __("The secret parameter was invalid or did not exist.", 'givewp-cloudflare-turnstile'),
+        ], $turnstileVerifyResponse->getErrorMessages());
+    }
+
+    /**
+     * @since 1.0.0
+     */
+    public function errorMessagesProvider(): array
+    {
+        return [
+            ['missing-input-secret', __("The secret parameter was not passed.", 'givewp-cloudflare-turnstile')],
+            ['invalid-input-secret', __("The secret parameter was invalid or did not exist.", 'givewp-cloudflare-turnstile')],
+            ['missing-input-response', __("The response parameter (token) was not passed.", 'givewp-cloudflare-turnstile')],
+            ['invalid-input-response', __("The response parameter (token) is invalid or has expired. Most of the time, this means a fake token has been used. If the error persists, contact customer support.", 'givewp-cloudflare-turnstile')],
+            ['bad-request', __("The request was rejected because it was malformed.", 'givewp-cloudflare-turnstile')],
+            ['timeout-or-duplicate', __("The response parameter (token) has already been validated before. This means that the token was issued five minutes ago and is no longer valid, or it was already redeemed.", 'givewp-cloudflare-turnstile')],
+            ['internal-error', __("An internal error happened while validating the response. The request can be retried.", 'givewp-cloudflare-turnstile')],
+            ['', __("Invalid response", 'givewp-cloudflare-turnstile')],
+        ];
+    }
+
 }