Replace Codeception tests with Pest tests

putyourlightson · Feb 19, 2024 · 8ea0c51 · 8ea0c51
1 parent 6453330
commit 8ea0c51
Show file tree

Hide file tree

Showing 32 changed files with 218 additions and 345 deletions.
diff --git a/src/templates/_settings.twig b/src/templates/_settings.twig
@@ -139,7 +139,7 @@
     id: 'excludeControllerActions',
     cols: [
         {
-            type: 'text',
+            type: 'singleline',
             heading: 'Controller Action'|t('snaptcha'),
             code: true,
         },
@@ -160,7 +160,7 @@
     id: 'allowList',
     cols: [
         {
-            type: 'text',
+            type: 'singleline',
             heading: 'IP Address'|t('snaptcha'),
             code: true,
         },
@@ -181,7 +181,7 @@
     id: 'denyList',
     cols: [
         {
-            type: 'text',
+            type: 'singleline',
             heading: 'IP Address'|t('snaptcha'),
             code: true,
         },

diff --git a/tests/.env b/tests/.env
diff --git a/tests/README.md b/tests/README.md
@@ -1,23 +1,41 @@
-# Static Analysis
+# Testing
+
+## Static Analysis
 
-To run static analysis on the plugin, install PHPStan and run the following command from the root of your project.
+To run static analysis on the plugin,
+install [PHPStan for Craft CMS](https://github.com/craftcms/phpstan) and run the
+following command from the root of your project.
 
 ```shell
-./vendor/bin/phpstan analyse -c vendor/putyourlightson/craft-snaptcha/phpstan.neon
+./vendor/bin/phpstan analyse -c vendor/putyourlightson/craft-snaptcha/phpstan.neon  --memory-limit 1G
 ```
 
-# Testing
+## Easy Coding Standard
 
-To test the plugin, install Codeception, update `.env` and run the following command from the root of your project.
+To run the Easy Coding Standard on the plugin,
+install [ECS for Craft CMS](https://github.com/craftcms/ecs) and run the
+following command from the root of your project.
 
 ```shell
-./vendor/bin/codecept run -c ./vendor/putyourlightson/craft-snaptcha unit
+./vendor/bin/ecs check -c vendor/putyourlightson/craft-snaptcha/ecs.php
 ```
 
-Or to run a specific test.
+## Pest Tests
+
+To run Pest tests, first install [Craft Pest](https://craft-pest.com/) core as a dev dependency.
 
 ```shell
-./vendor/bin/codecept run -c ./vendor/putyourlightson/craft-snaptcha unit variables/SnaptchaVariableTest:getField
+composer require markhuot/craft-pest-core:^2.0.0-rc2 --dev
 ```
 
-> Ensure that the database you specify in `.env` is not one that actually contains any data as it will be cleared when the tests are run. 
+Then run the following command from the root of your project.
+
+```shell
+php php vendor/bin/pest --test-directory=vendor/putyourlightson/craft-snaptcha/tests/pest
+```
+
+Or to run a specific test.
+
+```shell
+php php vendor/bin/pest --test-directory=vendor/putyourlightson/craft-snaptcha/tests/pest --filter=CacheRequestTest
+```
diff --git a/tests/TESTS.md b/tests/TESTS.md
@@ -0,0 +1,34 @@
+# Test Specification
+
+This document outlines the test specification for the Snaptcha plugin.
+
+---
+
+## Architecture Tests
+
+### [Architecture](pest/Architecture/ArchitectureTest.php)
+
+_Tests the architecture of the plugin._
+
+![Pass](https://raw.githubusercontent.com/putyourlightson/craft-generate-test-spec/main/icons/pass.svg) Source code does not contain any “dump or die” statements.  
+
+## Feature Tests
+
+### [Allowed](pest/Feature/AllowedTest.php)
+
+_Tests whether performing actions is allowed._
+
+![Pass](https://raw.githubusercontent.com/putyourlightson/craft-generate-test-spec/main/icons/pass.svg) User is not allowed when validation is enabled.  
+![Pass](https://raw.githubusercontent.com/putyourlightson/craft-generate-test-spec/main/icons/pass.svg) User is allowed when validation is disabled.  
+![Pass](https://raw.githubusercontent.com/putyourlightson/craft-generate-test-spec/main/icons/pass.svg) User IP is allowed when in the allow list.  
+![Pass](https://raw.githubusercontent.com/putyourlightson/craft-generate-test-spec/main/icons/pass.svg) User IP is allowed when in a nested array in the allow list.  
+![Pass](https://raw.githubusercontent.com/putyourlightson/craft-generate-test-spec/main/icons/pass.svg) User IP is not allowed when not in the allow list.  
+![Pass](https://raw.githubusercontent.com/putyourlightson/craft-generate-test-spec/main/icons/pass.svg) User IP is denied when in the deny list.  
+![Pass](https://raw.githubusercontent.com/putyourlightson/craft-generate-test-spec/main/icons/pass.svg) User IP is denied when in a nested array in the deny list.  
+![Pass](https://raw.githubusercontent.com/putyourlightson/craft-generate-test-spec/main/icons/pass.svg) User IP is not denied when not in the deny list.  
+
+### [SnaptchaVariable](pest/Feature/SnaptchaVariableTest.php)
+
+_Tests the markup generated by the Snaptcha variable._
+
+![Pass](https://raw.githubusercontent.com/putyourlightson/craft-generate-test-spec/main/icons/pass.svg) Field is named after field name setting.  
diff --git a/tests/_bootstrap.php b/tests/_bootstrap.php
diff --git a/tests/_craft/config/db.php b/tests/_craft/config/db.php
diff --git a/tests/_craft/config/general.php b/tests/_craft/config/general.php
diff --git a/tests/_craft/config/test.php b/tests/_craft/config/test.php
diff --git a/tests/_craft/storage/.gitignore b/tests/_craft/storage/.gitignore
diff --git a/tests/_data/.gitkeep b/tests/_data/.gitkeep
diff --git a/tests/_output/.gitignore b/tests/_output/.gitignore
diff --git a/tests/_support/AcceptanceTester.php b/tests/_support/AcceptanceTester.php
diff --git a/tests/_support/FunctionalTester.php b/tests/_support/FunctionalTester.php
diff --git a/tests/_support/Helper/Acceptance.php b/tests/_support/Helper/Acceptance.php
diff --git a/tests/_support/Helper/Functional.php b/tests/_support/Helper/Functional.php
diff --git a/tests/_support/Helper/Unit.php b/tests/_support/Helper/Unit.php
diff --git a/tests/_support/UnitTester.php b/tests/_support/UnitTester.php
diff --git a/tests/_support/_generated/.gitignore b/tests/_support/_generated/.gitignore
diff --git a/tests/acceptance.suite.yml b/tests/acceptance.suite.yml
diff --git a/tests/acceptance/_bootstrap.php b/tests/acceptance/_bootstrap.php
diff --git a/tests/functional.suite.yml b/tests/functional.suite.yml
diff --git a/tests/functional/_bootstrap.php b/tests/functional/_bootstrap.php
diff --git a/tests/pest/.gitignore b/tests/pest/.gitignore
@@ -0,0 +1 @@
+/test-results.xml
diff --git a/tests/pest/Architecture/ArchitectureTest.php b/tests/pest/Architecture/ArchitectureTest.php
@@ -0,0 +1,9 @@
+<?php
+
+/**
+ * Tests the architecture of the plugin.
+ */
+
+test('Source code does not contain any “dump or die” statements')
+    ->expect(['var_dump', 'die'])
+    ->not->toBeUsed();