Merge pull request #36 from woocommerce/24-08/add/validation-test-basics

Add initial shell of validation test documentation
woocommerce · Aug 29, 2024 · d1f50ec · d1f50ec
2 parents d6b27bf + d59545a
commit d1f50ec
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 8 deletions.
diff --git a/docs/managed-tests/08-validation.md b/docs/managed-tests/08-validation.md
@@ -0,0 +1,16 @@
+# Validation Tests
+
+Our validation test is designed to inform you of any issues with plugin and theme metadata. Right now it is purely informative, but in the future it may block submissions or updates.
+
+## Types of Issues Flagged
+The presence and value of certain headers will be checked:
+
+- `Requires PHP` - warning if not present in main plugin or theme file.
+- More coming soon!
+
+## What to do if it fails
+
+If your validation test is failing, please review the following steps:
+- Open the test report.
+- Identify the causes of the failure (typically a missing or misspelled header) and remedy it.
+- If you believe you've run across a bug in the test, please email us at [email protected] so we can review and make the necessary adjustments.
diff --git a/docs/support/test-options.md b/docs/support/test-options.md
@@ -6,14 +6,14 @@ sidebar_position: 1
 
 The table below shows what options are available for each test type. For example, for Activation tests you can supply a WordPress version but for the security tests it isn't supported.
 
-|                              | Activation | Woo E2E | Woo API | Security | PHPStan |
-| ---------------------------- | ---------- |---------|---------| -------- | ------- |
-| WordPress Versions           | ✅         | ✅       | ✅       | ❌       | ❌      |
-| WooCommerce Versions         | ✅         | ✅       | ✅       | ❌       | ❌      |
-| WooCommerce Features         | ✅         | ✅       | ✅       | ❌       | ❌      |
-| PHP Version                  | ✅         | ✅       | ✅       | ❌       | ❌      |
-| Additional Extensions        | ✅         | ✅       | ✅       | ❌       | ❌      |
-| Additional WordPress Plugins | ✅         | ✅       | ✅       | ❌       | ❌      |
+|                              | Activation | Woo E2E | Woo API | Security | PHPStan | Validation |
+| ---------------------------- | ---------- |---------|---------| -------- | ------- | ---------- |
+| WordPress Versions           | ✅         | ✅       | ✅       | ❌       | ❌      | ❌        |
+| WooCommerce Versions         | ✅         | ✅       | ✅       | ❌       | ❌      | ❌        |
+| WooCommerce Features         | ✅         | ✅       | ✅       | ❌       | ❌      | ❌        |
+| PHP Version                  | ✅         | ✅       | ✅       | ❌       | ❌      | ❌        |
+| Additional Extensions        | ✅         | ✅       | ✅       | ❌       | ❌      | ❌        |
+| Additional WordPress Plugins | ✅         | ✅       | ✅       | ❌       | ❌      | ❌        |
 
 ## WordPress and WooCommerce versions
 

diff --git a/src/components/TestTypes.js b/src/components/TestTypes.js
@@ -22,6 +22,8 @@ export default function TestTypes({ includeCode = false }) {
                         style={{ display: includeCode ? 'inline-block' : 'none' }}>run:phpcompatibility</code></li>
                     <li><a href="/docs/managed-tests/malware">Malware tests</a> <code
                         style={{ display: includeCode ? 'inline-block' : 'none' }}>run:malware</code></li>
+                    <li><a href="/docs/managed-tests/validation">Validation Tests</a> <code
+                        style={{ display: includeCode ? 'inline-block' : 'none' }}>run:validation</code></li>
                     <li>Performance tests <i>(Coming soon)</i></li>
                 </ul>
             </li>