@mytechtoday/augment-extensions 0.7.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (483) hide show
  1. package/AGENTS.md +265 -232
  2. package/README.md +956 -771
  3. package/augment-extensions/coding-standards/bash/README.md +196 -196
  4. package/augment-extensions/coding-standards/bash/module.json +163 -163
  5. package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -336
  6. package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -289
  7. package/augment-extensions/coding-standards/css/README.md +40 -40
  8. package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -550
  9. package/augment-extensions/coding-standards/css/module.json +44 -44
  10. package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -448
  11. package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -492
  12. package/augment-extensions/coding-standards/html/README.md +40 -40
  13. package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -267
  14. package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -505
  15. package/augment-extensions/coding-standards/html/module.json +44 -44
  16. package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -349
  17. package/augment-extensions/coding-standards/html-css-js/README.md +194 -194
  18. package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -487
  19. package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -550
  20. package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -667
  21. package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -267
  22. package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -612
  23. package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -505
  24. package/augment-extensions/coding-standards/html-css-js/module.json +48 -48
  25. package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -515
  26. package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -448
  27. package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -492
  28. package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -439
  29. package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -349
  30. package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -486
  31. package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -463
  32. package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -543
  33. package/augment-extensions/coding-standards/js/README.md +46 -46
  34. package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -487
  35. package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -667
  36. package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -612
  37. package/augment-extensions/coding-standards/js/module.json +49 -49
  38. package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -515
  39. package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -439
  40. package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -486
  41. package/augment-extensions/coding-standards/js/rules/performance.md +463 -463
  42. package/augment-extensions/coding-standards/js/rules/tooling.md +543 -543
  43. package/augment-extensions/coding-standards/php/README.md +248 -248
  44. package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -204
  45. package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -206
  46. package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -234
  47. package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -211
  48. package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -215
  49. package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -189
  50. package/augment-extensions/coding-standards/php/module.json +166 -166
  51. package/augment-extensions/coding-standards/php/rules/api-development.md +480 -480
  52. package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -332
  53. package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -472
  54. package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -561
  55. package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -402
  56. package/augment-extensions/coding-standards/php/rules/documentation.md +425 -425
  57. package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -627
  58. package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -336
  59. package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -677
  60. package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -279
  61. package/augment-extensions/coding-standards/php/rules/performance.md +392 -392
  62. package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -186
  63. package/augment-extensions/coding-standards/php/rules/security.md +358 -358
  64. package/augment-extensions/coding-standards/php/rules/testing.md +403 -403
  65. package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -331
  66. package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -426
  67. package/augment-extensions/coding-standards/powershell/README.md +154 -154
  68. package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -272
  69. package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -173
  70. package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -243
  71. package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -297
  72. package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -224
  73. package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -340
  74. package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -255
  75. package/augment-extensions/coding-standards/powershell/module.json +165 -165
  76. package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -439
  77. package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -240
  78. package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -384
  79. package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -383
  80. package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -482
  81. package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -296
  82. package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -314
  83. package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -466
  84. package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -244
  85. package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -266
  86. package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -209
  87. package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -314
  88. package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -268
  89. package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -197
  90. package/augment-extensions/coding-standards/python/README.md +48 -48
  91. package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -373
  92. package/augment-extensions/coding-standards/python/module.json +30 -30
  93. package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -884
  94. package/augment-extensions/coding-standards/python/rules/best-practices.md +232 -232
  95. package/augment-extensions/coding-standards/python/rules/code-organization.md +220 -220
  96. package/augment-extensions/coding-standards/python/rules/documentation.md +831 -831
  97. package/augment-extensions/coding-standards/python/rules/error-handling.md +1008 -1008
  98. package/augment-extensions/coding-standards/python/rules/naming-conventions.md +172 -172
  99. package/augment-extensions/coding-standards/python/rules/testing.md +409 -409
  100. package/augment-extensions/coding-standards/python/rules/tooling.md +446 -446
  101. package/augment-extensions/coding-standards/python/rules/type-hints.md +253 -253
  102. package/augment-extensions/coding-standards/react/README.md +45 -45
  103. package/augment-extensions/coding-standards/react/module.json +27 -27
  104. package/augment-extensions/coding-standards/react/rules/component-patterns.md +214 -214
  105. package/augment-extensions/coding-standards/react/rules/hooks-best-practices.md +235 -235
  106. package/augment-extensions/coding-standards/react/rules/performance.md +300 -300
  107. package/augment-extensions/coding-standards/react/rules/state-management.md +265 -265
  108. package/augment-extensions/coding-standards/react/rules/typescript-react.md +271 -271
  109. package/augment-extensions/coding-standards/typescript/README.md +45 -45
  110. package/augment-extensions/coding-standards/typescript/module.json +27 -27
  111. package/augment-extensions/coding-standards/typescript/rules/naming-conventions.md +225 -225
  112. package/augment-extensions/collections/html-css-js/README.md +82 -82
  113. package/augment-extensions/collections/html-css-js/collection.json +41 -41
  114. package/augment-extensions/domain-rules/api-design/README.md +41 -41
  115. package/augment-extensions/domain-rules/api-design/module.json +27 -27
  116. package/augment-extensions/domain-rules/api-design/rules/authentication.md +263 -263
  117. package/augment-extensions/domain-rules/api-design/rules/documentation.md +395 -395
  118. package/augment-extensions/domain-rules/api-design/rules/error-handling.md +290 -290
  119. package/augment-extensions/domain-rules/api-design/rules/graphql-api.md +313 -313
  120. package/augment-extensions/domain-rules/api-design/rules/rest-api.md +214 -214
  121. package/augment-extensions/domain-rules/api-design/rules/versioning.md +268 -268
  122. package/augment-extensions/domain-rules/database/README.md +161 -161
  123. package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -793
  124. package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -1132
  125. package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -868
  126. package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -805
  127. package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -621
  128. package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -965
  129. package/augment-extensions/domain-rules/database/module.json +28 -28
  130. package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -624
  131. package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -588
  132. package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -856
  133. package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -778
  134. package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -963
  135. package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -1076
  136. package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -697
  137. package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -671
  138. package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -607
  139. package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -907
  140. package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -783
  141. package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -980
  142. package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -485
  143. package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -521
  144. package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -858
  145. package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -934
  146. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/README.md +23 -23
  147. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/module.json +26 -26
  148. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/README.md +23 -23
  149. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/module.json +26 -26
  150. package/augment-extensions/domain-rules/design/color/themes/dracula/README.md +23 -23
  151. package/augment-extensions/domain-rules/design/color/themes/dracula/module.json +26 -26
  152. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/README.md +23 -23
  153. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/module.json +26 -26
  154. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/README.md +23 -23
  155. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/module.json +26 -26
  156. package/augment-extensions/domain-rules/design/color/themes/high-contrast/README.md +27 -27
  157. package/augment-extensions/domain-rules/design/color/themes/high-contrast/module.json +26 -26
  158. package/augment-extensions/domain-rules/design/color/themes/monokai/README.md +23 -23
  159. package/augment-extensions/domain-rules/design/color/themes/monokai/module.json +26 -26
  160. package/augment-extensions/domain-rules/design/color/themes/nord/README.md +23 -23
  161. package/augment-extensions/domain-rules/design/color/themes/nord/module.json +26 -26
  162. package/augment-extensions/domain-rules/design/color/themes/one-dark/README.md +23 -23
  163. package/augment-extensions/domain-rules/design/color/themes/one-dark/module.json +26 -26
  164. package/augment-extensions/domain-rules/design/color/themes/one-light/README.md +23 -23
  165. package/augment-extensions/domain-rules/design/color/themes/one-light/module.json +26 -26
  166. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/README.md +23 -23
  167. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/module.json +26 -26
  168. package/augment-extensions/domain-rules/design/color/themes/solarized-light/README.md +23 -23
  169. package/augment-extensions/domain-rules/design/color/themes/solarized-light/module.json +26 -26
  170. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/README.md +23 -23
  171. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/module.json +26 -26
  172. package/augment-extensions/domain-rules/mcp/README.md +150 -150
  173. package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -522
  174. package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -520
  175. package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -570
  176. package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -427
  177. package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -435
  178. package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -502
  179. package/augment-extensions/domain-rules/mcp/module.json +49 -49
  180. package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -595
  181. package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -345
  182. package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -687
  183. package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -636
  184. package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -484
  185. package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -360
  186. package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -393
  187. package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -194
  188. package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -625
  189. package/augment-extensions/domain-rules/security/README.md +41 -41
  190. package/augment-extensions/domain-rules/security/module.json +28 -28
  191. package/augment-extensions/domain-rules/security/rules/authentication-security.md +361 -361
  192. package/augment-extensions/domain-rules/security/rules/encryption.md +208 -208
  193. package/augment-extensions/domain-rules/security/rules/input-validation.md +294 -294
  194. package/augment-extensions/domain-rules/security/rules/owasp-top-10.md +339 -339
  195. package/augment-extensions/domain-rules/security/rules/secure-coding.md +293 -293
  196. package/augment-extensions/domain-rules/security/rules/web-security.md +268 -268
  197. package/augment-extensions/domain-rules/seo-sales-marketing/ANNOUNCEMENT.md +143 -0
  198. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/README.md +140 -136
  199. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/SCHEMA-VALIDATION-REPORT.md +216 -216
  200. package/augment-extensions/domain-rules/seo-sales-marketing/TEST-VALIDATION.md +129 -0
  201. package/augment-extensions/domain-rules/seo-sales-marketing/USAGE-GUIDES.md +254 -0
  202. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/brand-kit-example.yaml +292 -292
  203. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/campaign-brief-example.yaml +389 -389
  204. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/content-calendar-example.yaml +643 -643
  205. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/email-newsletter-example.md +376 -376
  206. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/landing-page-example.md +934 -934
  207. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/ppc-ad-copy-example.md +301 -301
  208. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/seo-blog-post-example.md +347 -347
  209. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/social-media-campaign-example.md +606 -606
  210. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/module.json +50 -50
  211. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/affiliate-influencer-marketing.md +593 -593
  212. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/asset-management.md +418 -418
  213. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/brand-consistency.md +210 -210
  214. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/content-marketing.md +337 -337
  215. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/conversion-optimization.md +455 -455
  216. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/direct-sales.md +499 -499
  217. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/email-marketing.md +439 -439
  218. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/legal-compliance.md +227 -227
  219. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/ppc-advertising.md +569 -569
  220. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/seo-optimization.md +470 -470
  221. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/social-media-marketing.md +414 -414
  222. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/universal-marketing.md +177 -177
  223. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/asset-inventory.schema.json +247 -247
  224. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/brand-kit.schema.json +326 -326
  225. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/campaign-brief.schema.json +342 -342
  226. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/color-palette.schema.json +223 -223
  227. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/content-template.schema.json +383 -383
  228. package/augment-extensions/domain-rules/wordpress/README.md +163 -163
  229. package/augment-extensions/domain-rules/wordpress/module.json +32 -32
  230. package/augment-extensions/domain-rules/wordpress/rules/coding-standards.md +617 -617
  231. package/augment-extensions/domain-rules/wordpress/rules/directory-structure.md +270 -270
  232. package/augment-extensions/domain-rules/wordpress/rules/file-patterns.md +423 -423
  233. package/augment-extensions/domain-rules/wordpress/rules/gutenberg-blocks.md +493 -493
  234. package/augment-extensions/domain-rules/wordpress/rules/performance.md +568 -568
  235. package/augment-extensions/domain-rules/wordpress/rules/plugin-development.md +510 -510
  236. package/augment-extensions/domain-rules/wordpress/rules/project-detection.md +251 -251
  237. package/augment-extensions/domain-rules/wordpress/rules/rest-api.md +501 -501
  238. package/augment-extensions/domain-rules/wordpress/rules/security.md +564 -564
  239. package/augment-extensions/domain-rules/wordpress/rules/theme-development.md +388 -388
  240. package/augment-extensions/domain-rules/wordpress/rules/woocommerce.md +441 -441
  241. package/augment-extensions/domain-rules/wordpress-plugin/README.md +139 -139
  242. package/augment-extensions/domain-rules/wordpress-plugin/examples/ajax-plugin.md +1599 -1599
  243. package/augment-extensions/domain-rules/wordpress-plugin/examples/custom-post-type-plugin.md +1727 -1727
  244. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block-plugin.md +428 -428
  245. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block.md +422 -422
  246. package/augment-extensions/domain-rules/wordpress-plugin/examples/mvc-plugin.md +1623 -1623
  247. package/augment-extensions/domain-rules/wordpress-plugin/examples/object-oriented-plugin.md +1343 -1343
  248. package/augment-extensions/domain-rules/wordpress-plugin/examples/rest-endpoint.md +734 -734
  249. package/augment-extensions/domain-rules/wordpress-plugin/examples/settings-page-plugin.md +1350 -1350
  250. package/augment-extensions/domain-rules/wordpress-plugin/examples/simple-procedural-plugin.md +503 -503
  251. package/augment-extensions/domain-rules/wordpress-plugin/examples/singleton-plugin.md +971 -971
  252. package/augment-extensions/domain-rules/wordpress-plugin/module.json +53 -53
  253. package/augment-extensions/domain-rules/wordpress-plugin/rules/activation-hooks.md +770 -770
  254. package/augment-extensions/domain-rules/wordpress-plugin/rules/admin-interface.md +874 -874
  255. package/augment-extensions/domain-rules/wordpress-plugin/rules/ajax-handlers.md +629 -629
  256. package/augment-extensions/domain-rules/wordpress-plugin/rules/asset-management.md +559 -559
  257. package/augment-extensions/domain-rules/wordpress-plugin/rules/context-providers.md +709 -709
  258. package/augment-extensions/domain-rules/wordpress-plugin/rules/cron-jobs.md +736 -736
  259. package/augment-extensions/domain-rules/wordpress-plugin/rules/database-management.md +1057 -1057
  260. package/augment-extensions/domain-rules/wordpress-plugin/rules/documentation-standards.md +463 -463
  261. package/augment-extensions/domain-rules/wordpress-plugin/rules/frontend-functionality.md +478 -478
  262. package/augment-extensions/domain-rules/wordpress-plugin/rules/gutenberg-blocks.md +818 -818
  263. package/augment-extensions/domain-rules/wordpress-plugin/rules/internationalization.md +416 -416
  264. package/augment-extensions/domain-rules/wordpress-plugin/rules/migration.md +667 -667
  265. package/augment-extensions/domain-rules/wordpress-plugin/rules/performance-optimization.md +878 -878
  266. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-architecture.md +693 -693
  267. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-structure.md +352 -352
  268. package/augment-extensions/domain-rules/wordpress-plugin/rules/rest-api.md +818 -818
  269. package/augment-extensions/domain-rules/wordpress-plugin/rules/scaffolding-workflow.md +624 -624
  270. package/augment-extensions/domain-rules/wordpress-plugin/rules/security-best-practices.md +866 -866
  271. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing-patterns.md +1165 -1165
  272. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing.md +414 -414
  273. package/augment-extensions/domain-rules/wordpress-plugin/rules/vscode-integration.md +751 -751
  274. package/augment-extensions/domain-rules/wordpress-plugin/rules/woocommerce-integration.md +949 -949
  275. package/augment-extensions/domain-rules/wordpress-plugin/rules/wordpress-org-submission.md +458 -458
  276. package/augment-extensions/examples/design-patterns/README.md +37 -37
  277. package/augment-extensions/examples/design-patterns/examples/behavioral-patterns.md +370 -370
  278. package/augment-extensions/examples/design-patterns/examples/creational-patterns.md +250 -250
  279. package/augment-extensions/examples/design-patterns/examples/structural-patterns.md +264 -264
  280. package/augment-extensions/examples/design-patterns/module.json +27 -27
  281. package/augment-extensions/examples/gutenberg-block-plugin/README.md +101 -101
  282. package/augment-extensions/examples/gutenberg-block-plugin/examples/testimonial-block.md +428 -428
  283. package/augment-extensions/examples/gutenberg-block-plugin/module.json +40 -40
  284. package/augment-extensions/examples/rest-api-plugin/README.md +98 -98
  285. package/augment-extensions/examples/rest-api-plugin/examples/task-manager-api.md +1299 -1299
  286. package/augment-extensions/examples/rest-api-plugin/module.json +40 -40
  287. package/augment-extensions/examples/woocommerce-extension/README.md +98 -98
  288. package/augment-extensions/examples/woocommerce-extension/examples/product-customizer.md +763 -763
  289. package/augment-extensions/examples/woocommerce-extension/module.json +40 -40
  290. package/augment-extensions/workflows/beads/README.md +135 -135
  291. package/augment-extensions/workflows/beads/examples/complete-workflow-example.md +278 -278
  292. package/augment-extensions/workflows/beads/module.json +55 -55
  293. package/augment-extensions/workflows/beads/rules/best-practices.md +398 -398
  294. package/augment-extensions/workflows/beads/rules/file-format.md +327 -327
  295. package/augment-extensions/workflows/beads/rules/manual-setup.md +315 -315
  296. package/augment-extensions/workflows/beads/rules/workflow.md +326 -326
  297. package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md +145 -145
  298. package/augment-extensions/workflows/beads-integration/README.md +143 -143
  299. package/augment-extensions/workflows/beads-integration/config/defaults.json +32 -32
  300. package/augment-extensions/workflows/beads-integration/config/schema.json +140 -140
  301. package/augment-extensions/workflows/beads-integration/examples/basic-task-generation.md +293 -293
  302. package/augment-extensions/workflows/beads-integration/module.json +75 -75
  303. package/augment-extensions/workflows/beads-integration/rules/core-rules.md +219 -219
  304. package/augment-extensions/workflows/beads-integration/rules/effectiveness-standards.md +256 -256
  305. package/augment-extensions/workflows/beads-integration/rules/task-generation.md +607 -607
  306. package/augment-extensions/workflows/database/README.md +195 -195
  307. package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -295
  308. package/augment-extensions/workflows/database/examples/migration-example.md +498 -498
  309. package/augment-extensions/workflows/database/examples/optimization-example.md +496 -496
  310. package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -444
  311. package/augment-extensions/workflows/database/module.json +42 -42
  312. package/augment-extensions/workflows/database/rules/data-migration.md +249 -249
  313. package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -339
  314. package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -352
  315. package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -435
  316. package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -535
  317. package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -305
  318. package/augment-extensions/workflows/database/rules/workflow.md +458 -458
  319. package/augment-extensions/workflows/wordpress-plugin/README.md +232 -232
  320. package/augment-extensions/workflows/wordpress-plugin/ai-prompts.md +839 -839
  321. package/augment-extensions/workflows/wordpress-plugin/bead-decomposition-patterns.md +854 -854
  322. package/augment-extensions/workflows/wordpress-plugin/examples/complete-plugin-example.md +540 -540
  323. package/augment-extensions/workflows/wordpress-plugin/examples/custom-post-type-example.md +1083 -1083
  324. package/augment-extensions/workflows/wordpress-plugin/examples/feature-addition-workflow.md +669 -669
  325. package/augment-extensions/workflows/wordpress-plugin/examples/plugin-creation-workflow.md +597 -597
  326. package/augment-extensions/workflows/wordpress-plugin/examples/secure-form-handler-example.md +925 -925
  327. package/augment-extensions/workflows/wordpress-plugin/examples/security-audit-workflow.md +752 -752
  328. package/augment-extensions/workflows/wordpress-plugin/examples/wordpress-org-submission-workflow.md +773 -773
  329. package/augment-extensions/workflows/wordpress-plugin/module.json +49 -49
  330. package/augment-extensions/workflows/wordpress-plugin/rules/best-practices.md +942 -942
  331. package/augment-extensions/workflows/wordpress-plugin/rules/development-workflow.md +702 -702
  332. package/augment-extensions/workflows/wordpress-plugin/rules/submission-workflow.md +728 -728
  333. package/augment-extensions/workflows/wordpress-plugin/rules/testing-workflow.md +775 -775
  334. package/augment-extensions/writing-standards/screenplay/README.md +339 -300
  335. package/augment-extensions/writing-standards/screenplay/_templates/README.md +121 -121
  336. package/augment-extensions/writing-standards/screenplay/_templates/genre-template.md +153 -153
  337. package/augment-extensions/writing-standards/screenplay/_templates/style-template.md +243 -243
  338. package/augment-extensions/writing-standards/screenplay/_templates/theme-template.md +213 -213
  339. package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -164
  340. package/augment-extensions/writing-standards/screenplay/examples/beat-sheet-example.yaml +95 -95
  341. package/augment-extensions/writing-standards/screenplay/examples/character-profile-example.yaml +116 -116
  342. package/augment-extensions/writing-standards/screenplay/examples/commercial-30sec.fountain +151 -151
  343. package/augment-extensions/writing-standards/screenplay/examples/independent-monologue.fountain +67 -67
  344. package/augment-extensions/writing-standards/screenplay/examples/news-segment.fountain +142 -142
  345. package/augment-extensions/writing-standards/screenplay/examples/plot-outline-example.yaml +184 -184
  346. package/augment-extensions/writing-standards/screenplay/examples/tv-episode-teaser.fountain +204 -204
  347. package/augment-extensions/writing-standards/screenplay/genres/README.md +181 -181
  348. package/augment-extensions/writing-standards/screenplay/genres/examples/.gitkeep +2 -2
  349. package/augment-extensions/writing-standards/screenplay/genres/module.json +70 -70
  350. package/augment-extensions/writing-standards/screenplay/genres/rules/.gitkeep +2 -2
  351. package/augment-extensions/writing-standards/screenplay/genres/rules/action.md +399 -399
  352. package/augment-extensions/writing-standards/screenplay/genres/rules/adventure.md +407 -407
  353. package/augment-extensions/writing-standards/screenplay/genres/rules/animation.md +293 -293
  354. package/augment-extensions/writing-standards/screenplay/genres/rules/biographical.md +293 -293
  355. package/augment-extensions/writing-standards/screenplay/genres/rules/comedy.md +401 -401
  356. package/augment-extensions/writing-standards/screenplay/genres/rules/documentary.md +293 -293
  357. package/augment-extensions/writing-standards/screenplay/genres/rules/drama.md +409 -409
  358. package/augment-extensions/writing-standards/screenplay/genres/rules/fantasy.md +293 -293
  359. package/augment-extensions/writing-standards/screenplay/genres/rules/historical.md +293 -293
  360. package/augment-extensions/writing-standards/screenplay/genres/rules/horror.md +268 -268
  361. package/augment-extensions/writing-standards/screenplay/genres/rules/musical.md +294 -294
  362. package/augment-extensions/writing-standards/screenplay/genres/rules/mystery.md +293 -293
  363. package/augment-extensions/writing-standards/screenplay/genres/rules/noir.md +294 -294
  364. package/augment-extensions/writing-standards/screenplay/genres/rules/romance.md +293 -293
  365. package/augment-extensions/writing-standards/screenplay/genres/rules/sci-fi.md +289 -289
  366. package/augment-extensions/writing-standards/screenplay/genres/rules/superhero.md +293 -293
  367. package/augment-extensions/writing-standards/screenplay/genres/rules/thriller.md +294 -294
  368. package/augment-extensions/writing-standards/screenplay/genres/rules/western.md +293 -293
  369. package/augment-extensions/writing-standards/screenplay/module.json +124 -124
  370. package/augment-extensions/writing-standards/screenplay/rules/aaa-hollywood-films.md +339 -339
  371. package/augment-extensions/writing-standards/screenplay/rules/ai-integration-testing.md +329 -329
  372. package/augment-extensions/writing-standards/screenplay/rules/character-development.md +169 -169
  373. package/augment-extensions/writing-standards/screenplay/rules/commercials.md +437 -437
  374. package/augment-extensions/writing-standards/screenplay/rules/dialogue-writing.md +263 -263
  375. package/augment-extensions/writing-standards/screenplay/rules/diversity-inclusion.md +261 -261
  376. package/augment-extensions/writing-standards/screenplay/rules/examples-guide.md +315 -315
  377. package/augment-extensions/writing-standards/screenplay/rules/file-organization.md +213 -0
  378. package/augment-extensions/writing-standards/screenplay/rules/formatting-validation.md +413 -413
  379. package/augment-extensions/writing-standards/screenplay/rules/fountain-format.md +372 -372
  380. package/augment-extensions/writing-standards/screenplay/rules/independent-films.md +374 -374
  381. package/augment-extensions/writing-standards/screenplay/rules/live-tv-productions.md +443 -443
  382. package/augment-extensions/writing-standards/screenplay/rules/narrative-structures.md +207 -207
  383. package/augment-extensions/writing-standards/screenplay/rules/news-broadcasts.md +444 -444
  384. package/augment-extensions/writing-standards/screenplay/rules/pacing-timing.md +331 -331
  385. package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md +334 -334
  386. package/augment-extensions/writing-standards/screenplay/rules/quick-reference.md +299 -299
  387. package/augment-extensions/writing-standards/screenplay/rules/screen-continuity.md +263 -263
  388. package/augment-extensions/writing-standards/screenplay/rules/streaming-content.md +412 -412
  389. package/augment-extensions/writing-standards/screenplay/rules/trope-management.md +370 -370
  390. package/augment-extensions/writing-standards/screenplay/rules/tv-series.md +374 -374
  391. package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -339
  392. package/augment-extensions/writing-standards/screenplay/rules/vscode-integration.md +277 -277
  393. package/augment-extensions/writing-standards/screenplay/rules/web-content.md +393 -393
  394. package/augment-extensions/writing-standards/screenplay/schemas/beat-sheet.json +332 -332
  395. package/augment-extensions/writing-standards/screenplay/schemas/character-profile.json +247 -247
  396. package/augment-extensions/writing-standards/screenplay/schemas/feature-selection.json +200 -200
  397. package/augment-extensions/writing-standards/screenplay/schemas/plot-outline.json +233 -233
  398. package/augment-extensions/writing-standards/screenplay/schemas/screenplay-config.json +245 -245
  399. package/augment-extensions/writing-standards/screenplay/schemas/trope-inventory.json +221 -221
  400. package/augment-extensions/writing-standards/screenplay/styles/README.md +159 -159
  401. package/augment-extensions/writing-standards/screenplay/styles/examples/.gitkeep +2 -2
  402. package/augment-extensions/writing-standards/screenplay/styles/examples/style-applications.md +1449 -1449
  403. package/augment-extensions/writing-standards/screenplay/styles/module.json +64 -64
  404. package/augment-extensions/writing-standards/screenplay/styles/rules/.gitkeep +2 -2
  405. package/augment-extensions/writing-standards/screenplay/styles/rules/dialogue-centric.md +520 -520
  406. package/augment-extensions/writing-standards/screenplay/styles/rules/ensemble.md +499 -499
  407. package/augment-extensions/writing-standards/screenplay/styles/rules/epic.md +497 -497
  408. package/augment-extensions/writing-standards/screenplay/styles/rules/experimental.md +492 -492
  409. package/augment-extensions/writing-standards/screenplay/styles/rules/flashback.md +509 -509
  410. package/augment-extensions/writing-standards/screenplay/styles/rules/linear.md +490 -490
  411. package/augment-extensions/writing-standards/screenplay/styles/rules/minimalist.md +499 -499
  412. package/augment-extensions/writing-standards/screenplay/styles/rules/non-linear.md +501 -501
  413. package/augment-extensions/writing-standards/screenplay/styles/rules/poetic.md +499 -499
  414. package/augment-extensions/writing-standards/screenplay/styles/rules/realistic.md +498 -498
  415. package/augment-extensions/writing-standards/screenplay/styles/rules/satirical.md +499 -499
  416. package/augment-extensions/writing-standards/screenplay/styles/rules/surreal.md +508 -508
  417. package/augment-extensions/writing-standards/screenplay/styles/rules/voice-over.md +500 -500
  418. package/augment-extensions/writing-standards/screenplay/themes/README.md +158 -158
  419. package/augment-extensions/writing-standards/screenplay/themes/examples/.gitkeep +2 -2
  420. package/augment-extensions/writing-standards/screenplay/themes/examples/common-mistakes-and-fixes.md +643 -643
  421. package/augment-extensions/writing-standards/screenplay/themes/examples/complete-scene-example.md +311 -311
  422. package/augment-extensions/writing-standards/screenplay/themes/examples/individual-theme-examples.md +562 -562
  423. package/augment-extensions/writing-standards/screenplay/themes/examples/multi-theme-weaving.md +538 -538
  424. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-application-guide.md +432 -432
  425. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-integration-across-acts.md +637 -637
  426. package/augment-extensions/writing-standards/screenplay/themes/module.json +66 -66
  427. package/augment-extensions/writing-standards/screenplay/themes/rules/.gitkeep +2 -2
  428. package/augment-extensions/writing-standards/screenplay/themes/rules/ambition.md +458 -458
  429. package/augment-extensions/writing-standards/screenplay/themes/rules/betrayal.md +490 -490
  430. package/augment-extensions/writing-standards/screenplay/themes/rules/environment.md +458 -458
  431. package/augment-extensions/writing-standards/screenplay/themes/rules/fate.md +459 -459
  432. package/augment-extensions/writing-standards/screenplay/themes/rules/friendship.md +491 -491
  433. package/augment-extensions/writing-standards/screenplay/themes/rules/growth.md +491 -491
  434. package/augment-extensions/writing-standards/screenplay/themes/rules/identity.md +490 -490
  435. package/augment-extensions/writing-standards/screenplay/themes/rules/isolation.md +464 -464
  436. package/augment-extensions/writing-standards/screenplay/themes/rules/justice.md +461 -461
  437. package/augment-extensions/writing-standards/screenplay/themes/rules/love.md +489 -489
  438. package/augment-extensions/writing-standards/screenplay/themes/rules/power.md +494 -494
  439. package/augment-extensions/writing-standards/screenplay/themes/rules/redemption.md +483 -483
  440. package/augment-extensions/writing-standards/screenplay/themes/rules/revenge.md +489 -489
  441. package/augment-extensions/writing-standards/screenplay/themes/rules/survival.md +496 -496
  442. package/augment-extensions/writing-standards/screenplay/themes/rules/technology.md +463 -463
  443. package/augment-extensions/writing-standards/screenplay/utils/__tests__/file-organization.test.ts +169 -0
  444. package/augment-extensions/writing-standards/screenplay/utils/file-organization.ts +165 -0
  445. package/cli/MODULES.md +302 -302
  446. package/cli/dist/cli.js +109 -22
  447. package/cli/dist/cli.js.map +1 -1
  448. package/cli/dist/commands/gui.d.ts.map +1 -1
  449. package/cli/dist/commands/gui.js +54 -6
  450. package/cli/dist/commands/gui.js.map +1 -1
  451. package/cli/dist/commands/init.d.ts.map +1 -1
  452. package/cli/dist/commands/init.js +76 -23
  453. package/cli/dist/commands/init.js.map +1 -1
  454. package/cli/dist/commands/self-remove.d.ts.map +1 -1
  455. package/cli/dist/commands/self-remove.js +48 -74
  456. package/cli/dist/commands/self-remove.js.map +1 -1
  457. package/cli/dist/commands/show.d.ts +11 -0
  458. package/cli/dist/commands/show.d.ts.map +1 -1
  459. package/cli/dist/commands/show.js +120 -0
  460. package/cli/dist/commands/show.js.map +1 -1
  461. package/cli/dist/commands/showCompleted.d.ts +21 -0
  462. package/cli/dist/commands/showCompleted.d.ts.map +1 -0
  463. package/cli/dist/commands/showCompleted.js +225 -0
  464. package/cli/dist/commands/showCompleted.js.map +1 -0
  465. package/cli/dist/commands/skill.js +88 -88
  466. package/cli/dist/commands/update.d.ts +2 -0
  467. package/cli/dist/commands/update.d.ts.map +1 -1
  468. package/cli/dist/commands/update.js +67 -1
  469. package/cli/dist/commands/update.js.map +1 -1
  470. package/cli/dist/utils/beadsCompletedChecker.d.ts +72 -0
  471. package/cli/dist/utils/beadsCompletedChecker.d.ts.map +1 -0
  472. package/cli/dist/utils/beadsCompletedChecker.js +198 -0
  473. package/cli/dist/utils/beadsCompletedChecker.js.map +1 -0
  474. package/cli/dist/utils/catalog-sync.js +13 -13
  475. package/cli/dist/utils/extractCommandHelp.d.ts +51 -0
  476. package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
  477. package/cli/dist/utils/extractCommandHelp.js +250 -0
  478. package/cli/dist/utils/extractCommandHelp.js.map +1 -0
  479. package/cli/dist/utils/install-rules.js +55 -55
  480. package/cli/dist/utils/mcp-integration.js +44 -44
  481. package/cli/dist/utils/rule-install-hooks.js +8 -8
  482. package/modules.md +667 -630
  483. package/package.json +85 -85
@@ -1,1165 +1,1165 @@
1
- # Testing Patterns for WordPress Plugins
2
-
3
- ## Overview
4
-
5
- This document provides comprehensive testing patterns and best practices for WordPress plugin development, including PHPUnit setup, unit tests, integration tests, and WordPress-specific testing strategies.
6
-
7
- ## Testing Environment Setup
8
-
9
- ### Install WordPress Test Suite
10
-
11
- ```bash
12
- #!/bin/bash
13
- # bin/install-wp-tests.sh
14
-
15
- DB_NAME=${1-wordpress_test}
16
- DB_USER=${2-root}
17
- DB_PASS=${3-}
18
- DB_HOST=${4-localhost}
19
- WP_VERSION=${5-latest}
20
-
21
- # Download WordPress test suite
22
- svn co --quiet https://develop.svn.wordpress.org/tags/$WP_VERSION/tests/phpunit/includes/ /tmp/wordpress-tests-lib/includes/
23
- svn co --quiet https://develop.svn.wordpress.org/tags/$WP_VERSION/tests/phpunit/data/ /tmp/wordpress-tests-lib/data/
24
-
25
- # Create test database
26
- mysql --user="$DB_USER" --password="$DB_PASS" --execute="CREATE DATABASE IF NOT EXISTS $DB_NAME;"
27
- ```
28
-
29
- ### PHPUnit Configuration
30
-
31
- **phpunit.xml:**
32
- ```xml
33
- <?xml version="1.0"?>
34
- <phpunit
35
- bootstrap="tests/bootstrap.php"
36
- backupGlobals="false"
37
- colors="true"
38
- convertErrorsToExceptions="true"
39
- convertNoticesToExceptions="true"
40
- convertWarningsToExceptions="true"
41
- >
42
- <testsuites>
43
- <testsuite name="unit">
44
- <directory prefix="test-" suffix=".php">./tests/unit/</directory>
45
- </testsuite>
46
- <testsuite name="integration">
47
- <directory prefix="test-" suffix=".php">./tests/integration/</directory>
48
- </testsuite>
49
- </testsuites>
50
- <filter>
51
- <whitelist processUncoveredFilesFromWhitelist="true">
52
- <directory suffix=".php">./includes/</directory>
53
- <directory suffix=".php">./admin/</directory>
54
- <directory suffix=".php">./public/</directory>
55
- </whitelist>
56
- </filter>
57
- </phpunit>
58
- ```
59
-
60
- ### Bootstrap File
61
-
62
- **tests/bootstrap.php:**
63
- ```php
64
- <?php
65
- /**
66
- * PHPUnit bootstrap file
67
- */
68
-
69
- // Composer autoloader
70
- require_once dirname( dirname( __FILE__ ) ) . '/vendor/autoload.php';
71
-
72
- // WordPress tests directory
73
- $_tests_dir = getenv( 'WP_TESTS_DIR' );
74
-
75
- if ( ! $_tests_dir ) {
76
- $_tests_dir = rtrim( sys_get_temp_dir(), '/\\' ) . '/wordpress-tests-lib';
77
- }
78
-
79
- if ( ! file_exists( $_tests_dir . '/includes/functions.php' ) ) {
80
- echo "Could not find $_tests_dir/includes/functions.php\n";
81
- exit( 1 );
82
- }
83
-
84
- // Give access to tests_add_filter() function
85
- require_once $_tests_dir . '/includes/functions.php';
86
-
87
- /**
88
- * Manually load the plugin being tested
89
- */
90
- function _manually_load_plugin() {
91
- require dirname( dirname( __FILE__ ) ) . '/my-plugin.php';
92
- }
93
- tests_add_filter( 'muplugins_loaded', '_manually_load_plugin' );
94
-
95
- // Start up the WP testing environment
96
- require $_tests_dir . '/includes/bootstrap.php';
97
- ```
98
-
99
- ---
100
-
101
- ## Unit Testing Patterns
102
-
103
- ### Test Class Structure
104
-
105
- ```php
106
- <?php
107
- /**
108
- * Unit test for custom class
109
- */
110
- class Test_My_Plugin_Class extends WP_UnitTestCase {
111
-
112
- /**
113
- * Set up before each test
114
- */
115
- public function setUp(): void {
116
- parent::setUp();
117
-
118
- // Set up test data
119
- $this->instance = new My_Plugin_Class();
120
- }
121
-
122
- /**
123
- * Tear down after each test
124
- */
125
- public function tearDown(): void {
126
- parent::tearDown();
127
-
128
- // Clean up test data
129
- unset( $this->instance );
130
- }
131
-
132
- /**
133
- * Test method
134
- */
135
- public function test_method_name() {
136
- $result = $this->instance->method_name( 'test' );
137
-
138
- $this->assertEquals( 'expected', $result );
139
- }
140
- }
141
- ```
142
-
143
- ### Testing WordPress Functions
144
-
145
- ```php
146
- <?php
147
- /**
148
- * Test WordPress function integration
149
- */
150
- class Test_Plugin_Functions extends WP_UnitTestCase {
151
-
152
- /**
153
- * Test option storage
154
- */
155
- public function test_save_plugin_option() {
156
- $option_name = 'my_plugin_option';
157
- $option_value = 'test value';
158
-
159
- update_option( $option_name, $option_value );
160
-
161
- $saved_value = get_option( $option_name );
162
-
163
- $this->assertEquals( $option_value, $saved_value );
164
- }
165
-
166
- /**
167
- * Test post meta
168
- */
169
- public function test_save_post_meta() {
170
- $post_id = $this->factory->post->create();
171
- $meta_key = '_custom_meta';
172
- $meta_value = 'test value';
173
-
174
- update_post_meta( $post_id, $meta_key, $meta_value );
175
-
176
- $saved_value = get_post_meta( $post_id, $meta_key, true );
177
-
178
- $this->assertEquals( $meta_value, $saved_value );
179
- }
180
- }
181
- ```
182
-
183
- ### Testing Custom Post Types
184
-
185
- ```php
186
- <?php
187
- /**
188
- * Test custom post type registration
189
- */
190
- class Test_Custom_Post_Type extends WP_UnitTestCase {
191
-
192
- /**
193
- * Test CPT is registered
194
- */
195
- public function test_cpt_registered() {
196
- $this->assertTrue( post_type_exists( 'my_custom_post_type' ) );
197
- }
198
-
199
- /**
200
- * Test CPT creation
201
- */
202
- public function test_create_cpt() {
203
- $post_id = $this->factory->post->create( array(
204
- 'post_type' => 'my_custom_post_type',
205
- 'post_title' => 'Test Post',
206
- 'post_status' => 'publish',
207
- ) );
208
-
209
- $this->assertGreaterThan( 0, $post_id );
210
-
211
- $post = get_post( $post_id );
212
- $this->assertEquals( 'my_custom_post_type', $post->post_type );
213
- $this->assertEquals( 'Test Post', $post->post_title );
214
- }
215
-
216
- /**
217
- * Test CPT labels
218
- */
219
- public function test_cpt_labels() {
220
- $post_type_object = get_post_type_object( 'my_custom_post_type' );
221
-
222
- $this->assertEquals( 'My Custom Posts', $post_type_object->labels->name );
223
- $this->assertEquals( 'My Custom Post', $post_type_object->labels->singular_name );
224
- }
225
- }
226
- ```
227
-
228
- ### Testing Taxonomies
229
-
230
- ```php
231
- <?php
232
- /**
233
- * Test custom taxonomy
234
- */
235
- class Test_Custom_Taxonomy extends WP_UnitTestCase {
236
-
237
- /**
238
- * Test taxonomy is registered
239
- */
240
- public function test_taxonomy_registered() {
241
- $this->assertTrue( taxonomy_exists( 'my_custom_taxonomy' ) );
242
- }
243
-
244
- /**
245
- * Test term creation
246
- */
247
- public function test_create_term() {
248
- $term = wp_insert_term( 'Test Term', 'my_custom_taxonomy' );
249
-
250
- $this->assertIsArray( $term );
251
- $this->assertArrayHasKey( 'term_id', $term );
252
-
253
- $term_object = get_term( $term['term_id'], 'my_custom_taxonomy' );
254
- $this->assertEquals( 'Test Term', $term_object->name );
255
- }
256
-
257
- /**
258
- * Test term assignment
259
- */
260
- public function test_assign_term_to_post() {
261
- $post_id = $this->factory->post->create( array(
262
- 'post_type' => 'my_custom_post_type',
263
- ) );
264
-
265
- $term = wp_insert_term( 'Test Term', 'my_custom_taxonomy' );
266
-
267
- wp_set_object_terms( $post_id, $term['term_id'], 'my_custom_taxonomy' );
268
-
269
- $terms = wp_get_object_terms( $post_id, 'my_custom_taxonomy' );
270
-
271
- $this->assertCount( 1, $terms );
272
- $this->assertEquals( 'Test Term', $terms[0]->name );
273
- }
274
- }
275
- ```
276
-
277
- ---
278
-
279
- ## Integration Testing Patterns
280
-
281
- ### Testing Hooks and Filters
282
-
283
- ```php
284
- <?php
285
- /**
286
- * Test hooks and filters
287
- */
288
- class Test_Plugin_Hooks extends WP_UnitTestCase {
289
-
290
- /**
291
- * Test action hook is registered
292
- */
293
- public function test_action_hook_registered() {
294
- $this->assertGreaterThan(
295
- 0,
296
- has_action( 'init', 'my_plugin_init_function' )
297
- );
298
- }
299
-
300
- /**
301
- * Test filter hook is registered
302
- */
303
- public function test_filter_hook_registered() {
304
- $this->assertGreaterThan(
305
- 0,
306
- has_filter( 'the_content', 'my_plugin_filter_content' )
307
- );
308
- }
309
-
310
- /**
311
- * Test filter modifies content
312
- */
313
- public function test_filter_modifies_content() {
314
- $original_content = 'Original content';
315
- $filtered_content = apply_filters( 'the_content', $original_content );
316
-
317
- $this->assertStringContainsString( 'Original content', $filtered_content );
318
- }
319
-
320
- /**
321
- * Test action executes
322
- */
323
- public function test_action_executes() {
324
- // Set up a flag to check if action executed
325
- $executed = false;
326
-
327
- add_action( 'my_plugin_custom_action', function() use ( &$executed ) {
328
- $executed = true;
329
- } );
330
-
331
- do_action( 'my_plugin_custom_action' );
332
-
333
- $this->assertTrue( $executed );
334
- }
335
- }
336
- ```
337
-
338
- ### Testing AJAX Handlers
339
-
340
- ```php
341
- <?php
342
- /**
343
- * Test AJAX handlers
344
- */
345
- class Test_Plugin_AJAX extends WP_Ajax_UnitTestCase {
346
-
347
- /**
348
- * Test AJAX handler for logged-in users
349
- */
350
- public function test_ajax_handler_logged_in() {
351
- // Create and log in user
352
- $user_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
353
- wp_set_current_user( $user_id );
354
-
355
- // Set up POST data
356
- $_POST['nonce'] = wp_create_nonce( 'my_plugin_ajax_nonce' );
357
- $_POST['data'] = 'test data';
358
-
359
- // Make AJAX request
360
- try {
361
- $this->_handleAjax( 'my_plugin_ajax_action' );
362
- } catch ( WPAjaxDieContinueException $e ) {
363
- // Expected exception
364
- }
365
-
366
- // Check response
367
- $response = json_decode( $this->_last_response );
368
- $this->assertTrue( $response->success );
369
- }
370
-
371
- /**
372
- * Test AJAX handler for non-logged-in users
373
- */
374
- public function test_ajax_handler_not_logged_in() {
375
- // Set up POST data
376
- $_POST['data'] = 'test data';
377
-
378
- // Make AJAX request
379
- try {
380
- $this->_handleAjax( 'my_plugin_ajax_action' );
381
- } catch ( WPAjaxDieStopException $e ) {
382
- // Expected exception for unauthorized access
383
- }
384
-
385
- // Check response indicates failure
386
- $response = json_decode( $this->_last_response );
387
- $this->assertFalse( $response->success );
388
- }
389
- }
390
- ```
391
-
392
- ### Testing REST API Endpoints
393
-
394
- ```php
395
- <?php
396
- /**
397
- * Test REST API endpoints
398
- */
399
- class Test_Plugin_REST_API extends WP_Test_REST_TestCase {
400
-
401
- /**
402
- * Set up before tests
403
- */
404
- public function setUp(): void {
405
- parent::setUp();
406
-
407
- // Create test user
408
- $this->user_id = $this->factory->user->create( array(
409
- 'role' => 'administrator',
410
- ) );
411
- }
412
-
413
- /**
414
- * Test GET endpoint
415
- */
416
- public function test_get_endpoint() {
417
- wp_set_current_user( $this->user_id );
418
-
419
- $request = new WP_REST_Request( 'GET', '/my-plugin/v1/items' );
420
- $response = rest_do_request( $request );
421
-
422
- $this->assertEquals( 200, $response->get_status() );
423
-
424
- $data = $response->get_data();
425
- $this->assertIsArray( $data );
426
- }
427
-
428
- /**
429
- * Test POST endpoint
430
- */
431
- public function test_post_endpoint() {
432
- wp_set_current_user( $this->user_id );
433
-
434
- $request = new WP_REST_Request( 'POST', '/my-plugin/v1/items' );
435
- $request->set_body_params( array(
436
- 'title' => 'Test Item',
437
- 'content' => 'Test content',
438
- ) );
439
-
440
- $response = rest_do_request( $request );
441
-
442
- $this->assertEquals( 201, $response->get_status() );
443
-
444
- $data = $response->get_data();
445
- $this->assertEquals( 'Test Item', $data['title'] );
446
- }
447
-
448
- /**
449
- * Test endpoint permissions
450
- */
451
- public function test_endpoint_permissions() {
452
- // Not logged in
453
- $request = new WP_REST_Request( 'POST', '/my-plugin/v1/items' );
454
- $response = rest_do_request( $request );
455
-
456
- $this->assertEquals( 401, $response->get_status() );
457
- }
458
- }
459
- ```
460
-
461
- ---
462
-
463
- ## Database Testing Patterns
464
-
465
- ### Testing Custom Tables
466
-
467
- ```php
468
- <?php
469
- /**
470
- * Test custom database table
471
- */
472
- class Test_Custom_Table extends WP_UnitTestCase {
473
-
474
- /**
475
- * Table name
476
- */
477
- private $table_name;
478
-
479
- /**
480
- * Set up before tests
481
- */
482
- public function setUp(): void {
483
- parent::setUp();
484
-
485
- global $wpdb;
486
- $this->table_name = $wpdb->prefix . 'my_plugin_table';
487
- }
488
-
489
- /**
490
- * Test table exists
491
- */
492
- public function test_table_exists() {
493
- global $wpdb;
494
-
495
- $table_exists = $wpdb->get_var(
496
- $wpdb->prepare(
497
- "SHOW TABLES LIKE %s",
498
- $this->table_name
499
- )
500
- );
501
-
502
- $this->assertEquals( $this->table_name, $table_exists );
503
- }
504
-
505
- /**
506
- * Test insert data
507
- */
508
- public function test_insert_data() {
509
- global $wpdb;
510
-
511
- $data = array(
512
- 'name' => 'Test Name',
513
- 'value' => 'Test Value',
514
- );
515
-
516
- $result = $wpdb->insert( $this->table_name, $data );
517
-
518
- $this->assertEquals( 1, $result );
519
- $this->assertGreaterThan( 0, $wpdb->insert_id );
520
- }
521
-
522
- /**
523
- * Test query data
524
- */
525
- public function test_query_data() {
526
- global $wpdb;
527
-
528
- // Insert test data
529
- $wpdb->insert( $this->table_name, array(
530
- 'name' => 'Test Name',
531
- 'value' => 'Test Value',
532
- ) );
533
-
534
- // Query data
535
- $result = $wpdb->get_row(
536
- $wpdb->prepare(
537
- "SELECT * FROM {$this->table_name} WHERE name = %s",
538
- 'Test Name'
539
- )
540
- );
541
-
542
- $this->assertEquals( 'Test Name', $result->name );
543
- $this->assertEquals( 'Test Value', $result->value );
544
- }
545
- }
546
- ```
547
-
548
- ### Testing Transients
549
-
550
- ```php
551
- <?php
552
- /**
553
- * Test transient caching
554
- */
555
- class Test_Plugin_Transients extends WP_UnitTestCase {
556
-
557
- /**
558
- * Test set and get transient
559
- */
560
- public function test_set_get_transient() {
561
- $transient_name = 'my_plugin_transient';
562
- $transient_value = array( 'key' => 'value' );
563
-
564
- set_transient( $transient_name, $transient_value, HOUR_IN_SECONDS );
565
-
566
- $retrieved_value = get_transient( $transient_name );
567
-
568
- $this->assertEquals( $transient_value, $retrieved_value );
569
- }
570
-
571
- /**
572
- * Test transient expiration
573
- */
574
- public function test_transient_expiration() {
575
- $transient_name = 'my_plugin_transient_expire';
576
- $transient_value = 'test value';
577
-
578
- set_transient( $transient_name, $transient_value, 1 );
579
-
580
- sleep( 2 );
581
-
582
- $retrieved_value = get_transient( $transient_name );
583
-
584
- $this->assertFalse( $retrieved_value );
585
- }
586
-
587
- /**
588
- * Test delete transient
589
- */
590
- public function test_delete_transient() {
591
- $transient_name = 'my_plugin_transient_delete';
592
- $transient_value = 'test value';
593
-
594
- set_transient( $transient_name, $transient_value, HOUR_IN_SECONDS );
595
-
596
- delete_transient( $transient_name );
597
-
598
- $retrieved_value = get_transient( $transient_name );
599
-
600
- $this->assertFalse( $retrieved_value );
601
- }
602
- }
603
- ```
604
-
605
- ---
606
-
607
- ## WooCommerce Testing Patterns
608
-
609
- ### Testing WooCommerce Products
610
-
611
- ```php
612
- <?php
613
- /**
614
- * Test WooCommerce product functionality
615
- */
616
- class Test_WooCommerce_Product extends WP_UnitTestCase {
617
-
618
- /**
619
- * Test create simple product
620
- */
621
- public function test_create_simple_product() {
622
- $product = new WC_Product_Simple();
623
- $product->set_name( 'Test Product' );
624
- $product->set_regular_price( '10.00' );
625
- $product->set_status( 'publish' );
626
- $product->save();
627
-
628
- $this->assertGreaterThan( 0, $product->get_id() );
629
- $this->assertEquals( 'Test Product', $product->get_name() );
630
- $this->assertEquals( '10.00', $product->get_regular_price() );
631
- }
632
-
633
- /**
634
- * Test product meta
635
- */
636
- public function test_product_meta() {
637
- $product = new WC_Product_Simple();
638
- $product->set_name( 'Test Product' );
639
- $product->save();
640
-
641
- $product->update_meta_data( '_custom_field', 'custom value' );
642
- $product->save();
643
-
644
- $custom_field = $product->get_meta( '_custom_field' );
645
-
646
- $this->assertEquals( 'custom value', $custom_field );
647
- }
648
- }
649
- ```
650
-
651
- ### Testing WooCommerce Orders
652
-
653
- ```php
654
- <?php
655
- /**
656
- * Test WooCommerce order functionality
657
- */
658
- class Test_WooCommerce_Order extends WP_UnitTestCase {
659
-
660
- /**
661
- * Test create order
662
- */
663
- public function test_create_order() {
664
- $order = wc_create_order();
665
-
666
- $this->assertInstanceOf( 'WC_Order', $order );
667
- $this->assertGreaterThan( 0, $order->get_id() );
668
- }
669
-
670
- /**
671
- * Test add product to order
672
- */
673
- public function test_add_product_to_order() {
674
- $product = new WC_Product_Simple();
675
- $product->set_name( 'Test Product' );
676
- $product->set_regular_price( '10.00' );
677
- $product->save();
678
-
679
- $order = wc_create_order();
680
- $order->add_product( $product, 2 );
681
- $order->calculate_totals();
682
-
683
- $this->assertEquals( '20.00', $order->get_total() );
684
- }
685
-
686
- /**
687
- * Test order status change
688
- */
689
- public function test_order_status_change() {
690
- $order = wc_create_order();
691
- $order->set_status( 'processing' );
692
- $order->save();
693
-
694
- $this->assertEquals( 'processing', $order->get_status() );
695
- }
696
- }
697
- ```
698
-
699
- ---
700
-
701
- ## Mock and Stub Patterns
702
-
703
- ### Mocking External APIs
704
-
705
- ```php
706
- <?php
707
- /**
708
- * Test external API integration
709
- */
710
- class Test_External_API extends WP_UnitTestCase {
711
-
712
- /**
713
- * Test API call with mock
714
- */
715
- public function test_api_call() {
716
- // Mock HTTP response
717
- add_filter( 'pre_http_request', function( $preempt, $args, $url ) {
718
- if ( strpos( $url, 'api.example.com' ) !== false ) {
719
- return array(
720
- 'response' => array( 'code' => 200 ),
721
- 'body' => json_encode( array( 'success' => true ) ),
722
- );
723
- }
724
- return $preempt;
725
- }, 10, 3 );
726
-
727
- $response = wp_remote_get( 'https://api.example.com/endpoint' );
728
- $body = json_decode( wp_remote_retrieve_body( $response ), true );
729
-
730
- $this->assertTrue( $body['success'] );
731
- }
732
- }
733
- ```
734
-
735
- ### Stubbing WordPress Functions
736
-
737
- ```php
738
- <?php
739
- /**
740
- * Test with stubbed functions
741
- */
742
- class Test_Stubbed_Functions extends WP_UnitTestCase {
743
-
744
- /**
745
- * Test with stubbed current_time
746
- */
747
- public function test_with_stubbed_time() {
748
- // Stub current_time to return fixed timestamp
749
- add_filter( 'current_time', function( $time, $type ) {
750
- return '2024-01-01 12:00:00';
751
- }, 10, 2 );
752
-
753
- $time = current_time( 'mysql' );
754
-
755
- $this->assertEquals( '2024-01-01 12:00:00', $time );
756
- }
757
- }
758
- ```
759
-
760
- ---
761
-
762
- ## Test Data Factories
763
-
764
- ### Using WordPress Factories
765
-
766
- ```php
767
- <?php
768
- /**
769
- * Test using factories
770
- */
771
- class Test_With_Factories extends WP_UnitTestCase {
772
-
773
- /**
774
- * Test create multiple posts
775
- */
776
- public function test_create_posts() {
777
- $post_ids = $this->factory->post->create_many( 5 );
778
-
779
- $this->assertCount( 5, $post_ids );
780
- }
781
-
782
- /**
783
- * Test create user with meta
784
- */
785
- public function test_create_user_with_meta() {
786
- $user_id = $this->factory->user->create( array(
787
- 'role' => 'editor',
788
- 'user_email' => 'test@example.com',
789
- ) );
790
-
791
- update_user_meta( $user_id, 'custom_field', 'custom value' );
792
-
793
- $user = get_user_by( 'id', $user_id );
794
- $custom_field = get_user_meta( $user_id, 'custom_field', true );
795
-
796
- $this->assertEquals( 'editor', $user->roles[0] );
797
- $this->assertEquals( 'custom value', $custom_field );
798
- }
799
-
800
- /**
801
- * Test create comment
802
- */
803
- public function test_create_comment() {
804
- $post_id = $this->factory->post->create();
805
- $comment_id = $this->factory->comment->create( array(
806
- 'comment_post_ID' => $post_id,
807
- ) );
808
-
809
- $comment = get_comment( $comment_id );
810
-
811
- $this->assertEquals( $post_id, $comment->comment_post_ID );
812
- }
813
- }
814
- ```
815
-
816
- ---
817
-
818
- ## Assertion Patterns
819
-
820
- ### Common Assertions
821
-
822
- ```php
823
- <?php
824
- /**
825
- * Common assertion examples
826
- */
827
- class Test_Assertions extends WP_UnitTestCase {
828
-
829
- /**
830
- * Test equality assertions
831
- */
832
- public function test_equality() {
833
- $this->assertEquals( 'expected', 'expected' );
834
- $this->assertNotEquals( 'expected', 'actual' );
835
- $this->assertSame( 1, 1 ); // Strict comparison
836
- $this->assertNotSame( 1, '1' );
837
- }
838
-
839
- /**
840
- * Test boolean assertions
841
- */
842
- public function test_boolean() {
843
- $this->assertTrue( true );
844
- $this->assertFalse( false );
845
- $this->assertNull( null );
846
- $this->assertNotNull( 'value' );
847
- }
848
-
849
- /**
850
- * Test array assertions
851
- */
852
- public function test_array() {
853
- $array = array( 'key' => 'value' );
854
-
855
- $this->assertIsArray( $array );
856
- $this->assertArrayHasKey( 'key', $array );
857
- $this->assertContains( 'value', $array );
858
- $this->assertCount( 1, $array );
859
- }
860
-
861
- /**
862
- * Test string assertions
863
- */
864
- public function test_string() {
865
- $string = 'Hello World';
866
-
867
- $this->assertIsString( $string );
868
- $this->assertStringContainsString( 'World', $string );
869
- $this->assertStringStartsWith( 'Hello', $string );
870
- $this->assertStringEndsWith( 'World', $string );
871
- }
872
-
873
- /**
874
- * Test numeric assertions
875
- */
876
- public function test_numeric() {
877
- $this->assertGreaterThan( 5, 10 );
878
- $this->assertLessThan( 10, 5 );
879
- $this->assertGreaterThanOrEqual( 5, 5 );
880
- $this->assertLessThanOrEqual( 5, 5 );
881
- }
882
-
883
- /**
884
- * Test instance assertions
885
- */
886
- public function test_instance() {
887
- $post = get_post( $this->factory->post->create() );
888
-
889
- $this->assertInstanceOf( 'WP_Post', $post );
890
- }
891
- }
892
- ```
893
-
894
- ---
895
-
896
- ## Code Coverage
897
-
898
- ### Generate Coverage Report
899
-
900
- **composer.json:**
901
- ```json
902
- {
903
- "scripts": {
904
- "test": "phpunit",
905
- "test:coverage": "phpunit --coverage-html coverage"
906
- }
907
- }
908
- ```
909
-
910
- **Run coverage:**
911
- ```bash
912
- composer test:coverage
913
- ```
914
-
915
- ### Coverage Annotations
916
-
917
- ```php
918
- <?php
919
- /**
920
- * Test with coverage annotations
921
- */
922
- class Test_Coverage extends WP_UnitTestCase {
923
-
924
- /**
925
- * @covers My_Plugin_Class::method_name
926
- */
927
- public function test_method() {
928
- $instance = new My_Plugin_Class();
929
- $result = $instance->method_name();
930
-
931
- $this->assertTrue( $result );
932
- }
933
- }
934
- ```
935
-
936
- ---
937
-
938
- ## Continuous Integration
939
-
940
- ### GitHub Actions Workflow
941
-
942
- **.github/workflows/tests.yml:**
943
- ```yaml
944
- name: Tests
945
-
946
- on:
947
- push:
948
- branches: [ main, develop ]
949
- pull_request:
950
- branches: [ main, develop ]
951
-
952
- jobs:
953
- test:
954
- runs-on: ubuntu-latest
955
-
956
- strategy:
957
- matrix:
958
- php: [ '7.4', '8.0', '8.1', '8.2' ]
959
- wordpress: [ 'latest', '6.0' ]
960
-
961
- steps:
962
- - uses: actions/checkout@v3
963
-
964
- - name: Setup PHP
965
- uses: shivammathur/setup-php@v2
966
- with:
967
- php-version: ${{ matrix.php }}
968
- extensions: mysqli
969
- coverage: xdebug
970
-
971
- - name: Install dependencies
972
- run: composer install --prefer-dist --no-progress
973
-
974
- - name: Install WordPress test suite
975
- run: |
976
- bash bin/install-wp-tests.sh wordpress_test root root localhost ${{ matrix.wordpress }}
977
-
978
- - name: Run tests
979
- run: composer test
980
-
981
- - name: Upload coverage
982
- if: matrix.php == '8.1' && matrix.wordpress == 'latest'
983
- uses: codecov/codecov-action@v3
984
- ```
985
-
986
- ---
987
-
988
- ## Best Practices
989
-
990
- ### DO
991
-
992
- ✅ **Write tests first** (TDD approach when possible)
993
- ✅ **Test one thing per test** method
994
- ✅ **Use descriptive test names** (`test_user_can_save_settings`)
995
- ✅ **Clean up after tests** (use `tearDown()`)
996
- ✅ **Use factories** for test data creation
997
- ✅ **Mock external dependencies** (APIs, services)
998
- ✅ **Test edge cases** and error conditions
999
- ✅ **Aim for high code coverage** (80%+ is good)
1000
- ✅ **Run tests before commits**
1001
- ✅ **Use CI/CD** for automated testing
1002
- ✅ **Test with multiple PHP versions**
1003
- ✅ **Test with multiple WordPress versions**
1004
-
1005
- ### DON'T
1006
-
1007
- ❌ **Don't test WordPress core** functionality
1008
- ❌ **Don't write tests that depend on each other**
1009
- ❌ **Don't use real external APIs** in tests
1010
- ❌ **Don't skip cleanup** in `tearDown()`
1011
- ❌ **Don't test implementation details** - test behavior
1012
- ❌ **Don't ignore failing tests**
1013
- ❌ **Don't commit without running tests**
1014
- ❌ **Don't test private methods** directly
1015
- ❌ **Don't use production database** for tests
1016
- ❌ **Don't hardcode test data** - use factories
1017
-
1018
- ---
1019
-
1020
- ## Test Organization
1021
-
1022
- ### Directory Structure
1023
-
1024
- ```
1025
- tests/
1026
- ├── bootstrap.php # Test bootstrap
1027
- ├── unit/ # Unit tests
1028
- │ ├── test-class-plugin.php
1029
- │ ├── test-functions.php
1030
- │ └── test-helpers.php
1031
- ├── integration/ # Integration tests
1032
- │ ├── test-cpt.php
1033
- │ ├── test-ajax.php
1034
- │ └── test-rest-api.php
1035
- ├── fixtures/ # Test fixtures
1036
- │ ├── sample-data.json
1037
- │ └── sample-image.jpg
1038
- └── mocks/ # Mock classes
1039
- └── class-mock-api.php
1040
- ```
1041
-
1042
- ### Naming Conventions
1043
-
1044
- **Test files:**
1045
- - Prefix with `test-`
1046
- - Match source file name: `class-plugin.php` → `test-class-plugin.php`
1047
-
1048
- **Test classes:**
1049
- - Prefix with `Test_`
1050
- - Use underscores: `Test_My_Plugin_Class`
1051
-
1052
- **Test methods:**
1053
- - Prefix with `test_`
1054
- - Descriptive names: `test_user_can_save_settings()`
1055
-
1056
- ---
1057
-
1058
- ## Running Tests
1059
-
1060
- ### Command Line
1061
-
1062
- ```bash
1063
- # Run all tests
1064
- phpunit
1065
-
1066
- # Run specific test suite
1067
- phpunit --testsuite unit
1068
- phpunit --testsuite integration
1069
-
1070
- # Run specific test file
1071
- phpunit tests/unit/test-class-plugin.php
1072
-
1073
- # Run specific test method
1074
- phpunit --filter test_method_name
1075
-
1076
- # Run with coverage
1077
- phpunit --coverage-html coverage
1078
-
1079
- # Run with verbose output
1080
- phpunit --verbose
1081
- ```
1082
-
1083
- ### Composer Scripts
1084
-
1085
- **composer.json:**
1086
- ```json
1087
- {
1088
- "scripts": {
1089
- "test": "phpunit",
1090
- "test:unit": "phpunit --testsuite unit",
1091
- "test:integration": "phpunit --testsuite integration",
1092
- "test:coverage": "phpunit --coverage-html coverage",
1093
- "test:watch": "phpunit-watcher watch"
1094
- }
1095
- }
1096
- ```
1097
-
1098
- **Run:**
1099
- ```bash
1100
- composer test
1101
- composer test:unit
1102
- composer test:coverage
1103
- ```
1104
-
1105
- ---
1106
-
1107
- ## Debugging Tests
1108
-
1109
- ### Enable Debug Output
1110
-
1111
- ```php
1112
- <?php
1113
- /**
1114
- * Test with debug output
1115
- */
1116
- class Test_Debug extends WP_UnitTestCase {
1117
-
1118
- public function test_with_debug() {
1119
- $value = 'test';
1120
-
1121
- // Output debug information
1122
- fwrite( STDERR, print_r( $value, true ) );
1123
-
1124
- $this->assertEquals( 'test', $value );
1125
- }
1126
- }
1127
- ```
1128
-
1129
- ### Use PHPUnit Annotations
1130
-
1131
- ```php
1132
- <?php
1133
- /**
1134
- * @group slow
1135
- * @group external-api
1136
- */
1137
- class Test_External_API extends WP_UnitTestCase {
1138
-
1139
- /**
1140
- * @group integration
1141
- */
1142
- public function test_api_call() {
1143
- // Test code
1144
- }
1145
- }
1146
- ```
1147
-
1148
- **Run specific groups:**
1149
- ```bash
1150
- phpunit --group integration
1151
- phpunit --exclude-group slow
1152
- ```
1153
-
1154
- ---
1155
-
1156
- ## Resources
1157
-
1158
- - [WordPress PHPUnit Documentation](https://make.wordpress.org/core/handbook/testing/automated-testing/phpunit/)
1159
- - [PHPUnit Documentation](https://phpunit.de/documentation.html)
1160
- - [WP_UnitTestCase Reference](https://developer.wordpress.org/reference/classes/wp_unittestcase/)
1161
- - [WordPress Test Suite](https://develop.svn.wordpress.org/trunk/tests/phpunit/)
1162
- - [WooCommerce Testing](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce/tests)
1163
- ```
1164
-
1165
-
1
+ # Testing Patterns for WordPress Plugins
2
+
3
+ ## Overview
4
+
5
+ This document provides comprehensive testing patterns and best practices for WordPress plugin development, including PHPUnit setup, unit tests, integration tests, and WordPress-specific testing strategies.
6
+
7
+ ## Testing Environment Setup
8
+
9
+ ### Install WordPress Test Suite
10
+
11
+ ```bash
12
+ #!/bin/bash
13
+ # bin/install-wp-tests.sh
14
+
15
+ DB_NAME=${1-wordpress_test}
16
+ DB_USER=${2-root}
17
+ DB_PASS=${3-}
18
+ DB_HOST=${4-localhost}
19
+ WP_VERSION=${5-latest}
20
+
21
+ # Download WordPress test suite
22
+ svn co --quiet https://develop.svn.wordpress.org/tags/$WP_VERSION/tests/phpunit/includes/ /tmp/wordpress-tests-lib/includes/
23
+ svn co --quiet https://develop.svn.wordpress.org/tags/$WP_VERSION/tests/phpunit/data/ /tmp/wordpress-tests-lib/data/
24
+
25
+ # Create test database
26
+ mysql --user="$DB_USER" --password="$DB_PASS" --execute="CREATE DATABASE IF NOT EXISTS $DB_NAME;"
27
+ ```
28
+
29
+ ### PHPUnit Configuration
30
+
31
+ **phpunit.xml:**
32
+ ```xml
33
+ <?xml version="1.0"?>
34
+ <phpunit
35
+ bootstrap="tests/bootstrap.php"
36
+ backupGlobals="false"
37
+ colors="true"
38
+ convertErrorsToExceptions="true"
39
+ convertNoticesToExceptions="true"
40
+ convertWarningsToExceptions="true"
41
+ >
42
+ <testsuites>
43
+ <testsuite name="unit">
44
+ <directory prefix="test-" suffix=".php">./tests/unit/</directory>
45
+ </testsuite>
46
+ <testsuite name="integration">
47
+ <directory prefix="test-" suffix=".php">./tests/integration/</directory>
48
+ </testsuite>
49
+ </testsuites>
50
+ <filter>
51
+ <whitelist processUncoveredFilesFromWhitelist="true">
52
+ <directory suffix=".php">./includes/</directory>
53
+ <directory suffix=".php">./admin/</directory>
54
+ <directory suffix=".php">./public/</directory>
55
+ </whitelist>
56
+ </filter>
57
+ </phpunit>
58
+ ```
59
+
60
+ ### Bootstrap File
61
+
62
+ **tests/bootstrap.php:**
63
+ ```php
64
+ <?php
65
+ /**
66
+ * PHPUnit bootstrap file
67
+ */
68
+
69
+ // Composer autoloader
70
+ require_once dirname( dirname( __FILE__ ) ) . '/vendor/autoload.php';
71
+
72
+ // WordPress tests directory
73
+ $_tests_dir = getenv( 'WP_TESTS_DIR' );
74
+
75
+ if ( ! $_tests_dir ) {
76
+ $_tests_dir = rtrim( sys_get_temp_dir(), '/\\' ) . '/wordpress-tests-lib';
77
+ }
78
+
79
+ if ( ! file_exists( $_tests_dir . '/includes/functions.php' ) ) {
80
+ echo "Could not find $_tests_dir/includes/functions.php\n";
81
+ exit( 1 );
82
+ }
83
+
84
+ // Give access to tests_add_filter() function
85
+ require_once $_tests_dir . '/includes/functions.php';
86
+
87
+ /**
88
+ * Manually load the plugin being tested
89
+ */
90
+ function _manually_load_plugin() {
91
+ require dirname( dirname( __FILE__ ) ) . '/my-plugin.php';
92
+ }
93
+ tests_add_filter( 'muplugins_loaded', '_manually_load_plugin' );
94
+
95
+ // Start up the WP testing environment
96
+ require $_tests_dir . '/includes/bootstrap.php';
97
+ ```
98
+
99
+ ---
100
+
101
+ ## Unit Testing Patterns
102
+
103
+ ### Test Class Structure
104
+
105
+ ```php
106
+ <?php
107
+ /**
108
+ * Unit test for custom class
109
+ */
110
+ class Test_My_Plugin_Class extends WP_UnitTestCase {
111
+
112
+ /**
113
+ * Set up before each test
114
+ */
115
+ public function setUp(): void {
116
+ parent::setUp();
117
+
118
+ // Set up test data
119
+ $this->instance = new My_Plugin_Class();
120
+ }
121
+
122
+ /**
123
+ * Tear down after each test
124
+ */
125
+ public function tearDown(): void {
126
+ parent::tearDown();
127
+
128
+ // Clean up test data
129
+ unset( $this->instance );
130
+ }
131
+
132
+ /**
133
+ * Test method
134
+ */
135
+ public function test_method_name() {
136
+ $result = $this->instance->method_name( 'test' );
137
+
138
+ $this->assertEquals( 'expected', $result );
139
+ }
140
+ }
141
+ ```
142
+
143
+ ### Testing WordPress Functions
144
+
145
+ ```php
146
+ <?php
147
+ /**
148
+ * Test WordPress function integration
149
+ */
150
+ class Test_Plugin_Functions extends WP_UnitTestCase {
151
+
152
+ /**
153
+ * Test option storage
154
+ */
155
+ public function test_save_plugin_option() {
156
+ $option_name = 'my_plugin_option';
157
+ $option_value = 'test value';
158
+
159
+ update_option( $option_name, $option_value );
160
+
161
+ $saved_value = get_option( $option_name );
162
+
163
+ $this->assertEquals( $option_value, $saved_value );
164
+ }
165
+
166
+ /**
167
+ * Test post meta
168
+ */
169
+ public function test_save_post_meta() {
170
+ $post_id = $this->factory->post->create();
171
+ $meta_key = '_custom_meta';
172
+ $meta_value = 'test value';
173
+
174
+ update_post_meta( $post_id, $meta_key, $meta_value );
175
+
176
+ $saved_value = get_post_meta( $post_id, $meta_key, true );
177
+
178
+ $this->assertEquals( $meta_value, $saved_value );
179
+ }
180
+ }
181
+ ```
182
+
183
+ ### Testing Custom Post Types
184
+
185
+ ```php
186
+ <?php
187
+ /**
188
+ * Test custom post type registration
189
+ */
190
+ class Test_Custom_Post_Type extends WP_UnitTestCase {
191
+
192
+ /**
193
+ * Test CPT is registered
194
+ */
195
+ public function test_cpt_registered() {
196
+ $this->assertTrue( post_type_exists( 'my_custom_post_type' ) );
197
+ }
198
+
199
+ /**
200
+ * Test CPT creation
201
+ */
202
+ public function test_create_cpt() {
203
+ $post_id = $this->factory->post->create( array(
204
+ 'post_type' => 'my_custom_post_type',
205
+ 'post_title' => 'Test Post',
206
+ 'post_status' => 'publish',
207
+ ) );
208
+
209
+ $this->assertGreaterThan( 0, $post_id );
210
+
211
+ $post = get_post( $post_id );
212
+ $this->assertEquals( 'my_custom_post_type', $post->post_type );
213
+ $this->assertEquals( 'Test Post', $post->post_title );
214
+ }
215
+
216
+ /**
217
+ * Test CPT labels
218
+ */
219
+ public function test_cpt_labels() {
220
+ $post_type_object = get_post_type_object( 'my_custom_post_type' );
221
+
222
+ $this->assertEquals( 'My Custom Posts', $post_type_object->labels->name );
223
+ $this->assertEquals( 'My Custom Post', $post_type_object->labels->singular_name );
224
+ }
225
+ }
226
+ ```
227
+
228
+ ### Testing Taxonomies
229
+
230
+ ```php
231
+ <?php
232
+ /**
233
+ * Test custom taxonomy
234
+ */
235
+ class Test_Custom_Taxonomy extends WP_UnitTestCase {
236
+
237
+ /**
238
+ * Test taxonomy is registered
239
+ */
240
+ public function test_taxonomy_registered() {
241
+ $this->assertTrue( taxonomy_exists( 'my_custom_taxonomy' ) );
242
+ }
243
+
244
+ /**
245
+ * Test term creation
246
+ */
247
+ public function test_create_term() {
248
+ $term = wp_insert_term( 'Test Term', 'my_custom_taxonomy' );
249
+
250
+ $this->assertIsArray( $term );
251
+ $this->assertArrayHasKey( 'term_id', $term );
252
+
253
+ $term_object = get_term( $term['term_id'], 'my_custom_taxonomy' );
254
+ $this->assertEquals( 'Test Term', $term_object->name );
255
+ }
256
+
257
+ /**
258
+ * Test term assignment
259
+ */
260
+ public function test_assign_term_to_post() {
261
+ $post_id = $this->factory->post->create( array(
262
+ 'post_type' => 'my_custom_post_type',
263
+ ) );
264
+
265
+ $term = wp_insert_term( 'Test Term', 'my_custom_taxonomy' );
266
+
267
+ wp_set_object_terms( $post_id, $term['term_id'], 'my_custom_taxonomy' );
268
+
269
+ $terms = wp_get_object_terms( $post_id, 'my_custom_taxonomy' );
270
+
271
+ $this->assertCount( 1, $terms );
272
+ $this->assertEquals( 'Test Term', $terms[0]->name );
273
+ }
274
+ }
275
+ ```
276
+
277
+ ---
278
+
279
+ ## Integration Testing Patterns
280
+
281
+ ### Testing Hooks and Filters
282
+
283
+ ```php
284
+ <?php
285
+ /**
286
+ * Test hooks and filters
287
+ */
288
+ class Test_Plugin_Hooks extends WP_UnitTestCase {
289
+
290
+ /**
291
+ * Test action hook is registered
292
+ */
293
+ public function test_action_hook_registered() {
294
+ $this->assertGreaterThan(
295
+ 0,
296
+ has_action( 'init', 'my_plugin_init_function' )
297
+ );
298
+ }
299
+
300
+ /**
301
+ * Test filter hook is registered
302
+ */
303
+ public function test_filter_hook_registered() {
304
+ $this->assertGreaterThan(
305
+ 0,
306
+ has_filter( 'the_content', 'my_plugin_filter_content' )
307
+ );
308
+ }
309
+
310
+ /**
311
+ * Test filter modifies content
312
+ */
313
+ public function test_filter_modifies_content() {
314
+ $original_content = 'Original content';
315
+ $filtered_content = apply_filters( 'the_content', $original_content );
316
+
317
+ $this->assertStringContainsString( 'Original content', $filtered_content );
318
+ }
319
+
320
+ /**
321
+ * Test action executes
322
+ */
323
+ public function test_action_executes() {
324
+ // Set up a flag to check if action executed
325
+ $executed = false;
326
+
327
+ add_action( 'my_plugin_custom_action', function() use ( &$executed ) {
328
+ $executed = true;
329
+ } );
330
+
331
+ do_action( 'my_plugin_custom_action' );
332
+
333
+ $this->assertTrue( $executed );
334
+ }
335
+ }
336
+ ```
337
+
338
+ ### Testing AJAX Handlers
339
+
340
+ ```php
341
+ <?php
342
+ /**
343
+ * Test AJAX handlers
344
+ */
345
+ class Test_Plugin_AJAX extends WP_Ajax_UnitTestCase {
346
+
347
+ /**
348
+ * Test AJAX handler for logged-in users
349
+ */
350
+ public function test_ajax_handler_logged_in() {
351
+ // Create and log in user
352
+ $user_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
353
+ wp_set_current_user( $user_id );
354
+
355
+ // Set up POST data
356
+ $_POST['nonce'] = wp_create_nonce( 'my_plugin_ajax_nonce' );
357
+ $_POST['data'] = 'test data';
358
+
359
+ // Make AJAX request
360
+ try {
361
+ $this->_handleAjax( 'my_plugin_ajax_action' );
362
+ } catch ( WPAjaxDieContinueException $e ) {
363
+ // Expected exception
364
+ }
365
+
366
+ // Check response
367
+ $response = json_decode( $this->_last_response );
368
+ $this->assertTrue( $response->success );
369
+ }
370
+
371
+ /**
372
+ * Test AJAX handler for non-logged-in users
373
+ */
374
+ public function test_ajax_handler_not_logged_in() {
375
+ // Set up POST data
376
+ $_POST['data'] = 'test data';
377
+
378
+ // Make AJAX request
379
+ try {
380
+ $this->_handleAjax( 'my_plugin_ajax_action' );
381
+ } catch ( WPAjaxDieStopException $e ) {
382
+ // Expected exception for unauthorized access
383
+ }
384
+
385
+ // Check response indicates failure
386
+ $response = json_decode( $this->_last_response );
387
+ $this->assertFalse( $response->success );
388
+ }
389
+ }
390
+ ```
391
+
392
+ ### Testing REST API Endpoints
393
+
394
+ ```php
395
+ <?php
396
+ /**
397
+ * Test REST API endpoints
398
+ */
399
+ class Test_Plugin_REST_API extends WP_Test_REST_TestCase {
400
+
401
+ /**
402
+ * Set up before tests
403
+ */
404
+ public function setUp(): void {
405
+ parent::setUp();
406
+
407
+ // Create test user
408
+ $this->user_id = $this->factory->user->create( array(
409
+ 'role' => 'administrator',
410
+ ) );
411
+ }
412
+
413
+ /**
414
+ * Test GET endpoint
415
+ */
416
+ public function test_get_endpoint() {
417
+ wp_set_current_user( $this->user_id );
418
+
419
+ $request = new WP_REST_Request( 'GET', '/my-plugin/v1/items' );
420
+ $response = rest_do_request( $request );
421
+
422
+ $this->assertEquals( 200, $response->get_status() );
423
+
424
+ $data = $response->get_data();
425
+ $this->assertIsArray( $data );
426
+ }
427
+
428
+ /**
429
+ * Test POST endpoint
430
+ */
431
+ public function test_post_endpoint() {
432
+ wp_set_current_user( $this->user_id );
433
+
434
+ $request = new WP_REST_Request( 'POST', '/my-plugin/v1/items' );
435
+ $request->set_body_params( array(
436
+ 'title' => 'Test Item',
437
+ 'content' => 'Test content',
438
+ ) );
439
+
440
+ $response = rest_do_request( $request );
441
+
442
+ $this->assertEquals( 201, $response->get_status() );
443
+
444
+ $data = $response->get_data();
445
+ $this->assertEquals( 'Test Item', $data['title'] );
446
+ }
447
+
448
+ /**
449
+ * Test endpoint permissions
450
+ */
451
+ public function test_endpoint_permissions() {
452
+ // Not logged in
453
+ $request = new WP_REST_Request( 'POST', '/my-plugin/v1/items' );
454
+ $response = rest_do_request( $request );
455
+
456
+ $this->assertEquals( 401, $response->get_status() );
457
+ }
458
+ }
459
+ ```
460
+
461
+ ---
462
+
463
+ ## Database Testing Patterns
464
+
465
+ ### Testing Custom Tables
466
+
467
+ ```php
468
+ <?php
469
+ /**
470
+ * Test custom database table
471
+ */
472
+ class Test_Custom_Table extends WP_UnitTestCase {
473
+
474
+ /**
475
+ * Table name
476
+ */
477
+ private $table_name;
478
+
479
+ /**
480
+ * Set up before tests
481
+ */
482
+ public function setUp(): void {
483
+ parent::setUp();
484
+
485
+ global $wpdb;
486
+ $this->table_name = $wpdb->prefix . 'my_plugin_table';
487
+ }
488
+
489
+ /**
490
+ * Test table exists
491
+ */
492
+ public function test_table_exists() {
493
+ global $wpdb;
494
+
495
+ $table_exists = $wpdb->get_var(
496
+ $wpdb->prepare(
497
+ "SHOW TABLES LIKE %s",
498
+ $this->table_name
499
+ )
500
+ );
501
+
502
+ $this->assertEquals( $this->table_name, $table_exists );
503
+ }
504
+
505
+ /**
506
+ * Test insert data
507
+ */
508
+ public function test_insert_data() {
509
+ global $wpdb;
510
+
511
+ $data = array(
512
+ 'name' => 'Test Name',
513
+ 'value' => 'Test Value',
514
+ );
515
+
516
+ $result = $wpdb->insert( $this->table_name, $data );
517
+
518
+ $this->assertEquals( 1, $result );
519
+ $this->assertGreaterThan( 0, $wpdb->insert_id );
520
+ }
521
+
522
+ /**
523
+ * Test query data
524
+ */
525
+ public function test_query_data() {
526
+ global $wpdb;
527
+
528
+ // Insert test data
529
+ $wpdb->insert( $this->table_name, array(
530
+ 'name' => 'Test Name',
531
+ 'value' => 'Test Value',
532
+ ) );
533
+
534
+ // Query data
535
+ $result = $wpdb->get_row(
536
+ $wpdb->prepare(
537
+ "SELECT * FROM {$this->table_name} WHERE name = %s",
538
+ 'Test Name'
539
+ )
540
+ );
541
+
542
+ $this->assertEquals( 'Test Name', $result->name );
543
+ $this->assertEquals( 'Test Value', $result->value );
544
+ }
545
+ }
546
+ ```
547
+
548
+ ### Testing Transients
549
+
550
+ ```php
551
+ <?php
552
+ /**
553
+ * Test transient caching
554
+ */
555
+ class Test_Plugin_Transients extends WP_UnitTestCase {
556
+
557
+ /**
558
+ * Test set and get transient
559
+ */
560
+ public function test_set_get_transient() {
561
+ $transient_name = 'my_plugin_transient';
562
+ $transient_value = array( 'key' => 'value' );
563
+
564
+ set_transient( $transient_name, $transient_value, HOUR_IN_SECONDS );
565
+
566
+ $retrieved_value = get_transient( $transient_name );
567
+
568
+ $this->assertEquals( $transient_value, $retrieved_value );
569
+ }
570
+
571
+ /**
572
+ * Test transient expiration
573
+ */
574
+ public function test_transient_expiration() {
575
+ $transient_name = 'my_plugin_transient_expire';
576
+ $transient_value = 'test value';
577
+
578
+ set_transient( $transient_name, $transient_value, 1 );
579
+
580
+ sleep( 2 );
581
+
582
+ $retrieved_value = get_transient( $transient_name );
583
+
584
+ $this->assertFalse( $retrieved_value );
585
+ }
586
+
587
+ /**
588
+ * Test delete transient
589
+ */
590
+ public function test_delete_transient() {
591
+ $transient_name = 'my_plugin_transient_delete';
592
+ $transient_value = 'test value';
593
+
594
+ set_transient( $transient_name, $transient_value, HOUR_IN_SECONDS );
595
+
596
+ delete_transient( $transient_name );
597
+
598
+ $retrieved_value = get_transient( $transient_name );
599
+
600
+ $this->assertFalse( $retrieved_value );
601
+ }
602
+ }
603
+ ```
604
+
605
+ ---
606
+
607
+ ## WooCommerce Testing Patterns
608
+
609
+ ### Testing WooCommerce Products
610
+
611
+ ```php
612
+ <?php
613
+ /**
614
+ * Test WooCommerce product functionality
615
+ */
616
+ class Test_WooCommerce_Product extends WP_UnitTestCase {
617
+
618
+ /**
619
+ * Test create simple product
620
+ */
621
+ public function test_create_simple_product() {
622
+ $product = new WC_Product_Simple();
623
+ $product->set_name( 'Test Product' );
624
+ $product->set_regular_price( '10.00' );
625
+ $product->set_status( 'publish' );
626
+ $product->save();
627
+
628
+ $this->assertGreaterThan( 0, $product->get_id() );
629
+ $this->assertEquals( 'Test Product', $product->get_name() );
630
+ $this->assertEquals( '10.00', $product->get_regular_price() );
631
+ }
632
+
633
+ /**
634
+ * Test product meta
635
+ */
636
+ public function test_product_meta() {
637
+ $product = new WC_Product_Simple();
638
+ $product->set_name( 'Test Product' );
639
+ $product->save();
640
+
641
+ $product->update_meta_data( '_custom_field', 'custom value' );
642
+ $product->save();
643
+
644
+ $custom_field = $product->get_meta( '_custom_field' );
645
+
646
+ $this->assertEquals( 'custom value', $custom_field );
647
+ }
648
+ }
649
+ ```
650
+
651
+ ### Testing WooCommerce Orders
652
+
653
+ ```php
654
+ <?php
655
+ /**
656
+ * Test WooCommerce order functionality
657
+ */
658
+ class Test_WooCommerce_Order extends WP_UnitTestCase {
659
+
660
+ /**
661
+ * Test create order
662
+ */
663
+ public function test_create_order() {
664
+ $order = wc_create_order();
665
+
666
+ $this->assertInstanceOf( 'WC_Order', $order );
667
+ $this->assertGreaterThan( 0, $order->get_id() );
668
+ }
669
+
670
+ /**
671
+ * Test add product to order
672
+ */
673
+ public function test_add_product_to_order() {
674
+ $product = new WC_Product_Simple();
675
+ $product->set_name( 'Test Product' );
676
+ $product->set_regular_price( '10.00' );
677
+ $product->save();
678
+
679
+ $order = wc_create_order();
680
+ $order->add_product( $product, 2 );
681
+ $order->calculate_totals();
682
+
683
+ $this->assertEquals( '20.00', $order->get_total() );
684
+ }
685
+
686
+ /**
687
+ * Test order status change
688
+ */
689
+ public function test_order_status_change() {
690
+ $order = wc_create_order();
691
+ $order->set_status( 'processing' );
692
+ $order->save();
693
+
694
+ $this->assertEquals( 'processing', $order->get_status() );
695
+ }
696
+ }
697
+ ```
698
+
699
+ ---
700
+
701
+ ## Mock and Stub Patterns
702
+
703
+ ### Mocking External APIs
704
+
705
+ ```php
706
+ <?php
707
+ /**
708
+ * Test external API integration
709
+ */
710
+ class Test_External_API extends WP_UnitTestCase {
711
+
712
+ /**
713
+ * Test API call with mock
714
+ */
715
+ public function test_api_call() {
716
+ // Mock HTTP response
717
+ add_filter( 'pre_http_request', function( $preempt, $args, $url ) {
718
+ if ( strpos( $url, 'api.example.com' ) !== false ) {
719
+ return array(
720
+ 'response' => array( 'code' => 200 ),
721
+ 'body' => json_encode( array( 'success' => true ) ),
722
+ );
723
+ }
724
+ return $preempt;
725
+ }, 10, 3 );
726
+
727
+ $response = wp_remote_get( 'https://api.example.com/endpoint' );
728
+ $body = json_decode( wp_remote_retrieve_body( $response ), true );
729
+
730
+ $this->assertTrue( $body['success'] );
731
+ }
732
+ }
733
+ ```
734
+
735
+ ### Stubbing WordPress Functions
736
+
737
+ ```php
738
+ <?php
739
+ /**
740
+ * Test with stubbed functions
741
+ */
742
+ class Test_Stubbed_Functions extends WP_UnitTestCase {
743
+
744
+ /**
745
+ * Test with stubbed current_time
746
+ */
747
+ public function test_with_stubbed_time() {
748
+ // Stub current_time to return fixed timestamp
749
+ add_filter( 'current_time', function( $time, $type ) {
750
+ return '2024-01-01 12:00:00';
751
+ }, 10, 2 );
752
+
753
+ $time = current_time( 'mysql' );
754
+
755
+ $this->assertEquals( '2024-01-01 12:00:00', $time );
756
+ }
757
+ }
758
+ ```
759
+
760
+ ---
761
+
762
+ ## Test Data Factories
763
+
764
+ ### Using WordPress Factories
765
+
766
+ ```php
767
+ <?php
768
+ /**
769
+ * Test using factories
770
+ */
771
+ class Test_With_Factories extends WP_UnitTestCase {
772
+
773
+ /**
774
+ * Test create multiple posts
775
+ */
776
+ public function test_create_posts() {
777
+ $post_ids = $this->factory->post->create_many( 5 );
778
+
779
+ $this->assertCount( 5, $post_ids );
780
+ }
781
+
782
+ /**
783
+ * Test create user with meta
784
+ */
785
+ public function test_create_user_with_meta() {
786
+ $user_id = $this->factory->user->create( array(
787
+ 'role' => 'editor',
788
+ 'user_email' => 'test@example.com',
789
+ ) );
790
+
791
+ update_user_meta( $user_id, 'custom_field', 'custom value' );
792
+
793
+ $user = get_user_by( 'id', $user_id );
794
+ $custom_field = get_user_meta( $user_id, 'custom_field', true );
795
+
796
+ $this->assertEquals( 'editor', $user->roles[0] );
797
+ $this->assertEquals( 'custom value', $custom_field );
798
+ }
799
+
800
+ /**
801
+ * Test create comment
802
+ */
803
+ public function test_create_comment() {
804
+ $post_id = $this->factory->post->create();
805
+ $comment_id = $this->factory->comment->create( array(
806
+ 'comment_post_ID' => $post_id,
807
+ ) );
808
+
809
+ $comment = get_comment( $comment_id );
810
+
811
+ $this->assertEquals( $post_id, $comment->comment_post_ID );
812
+ }
813
+ }
814
+ ```
815
+
816
+ ---
817
+
818
+ ## Assertion Patterns
819
+
820
+ ### Common Assertions
821
+
822
+ ```php
823
+ <?php
824
+ /**
825
+ * Common assertion examples
826
+ */
827
+ class Test_Assertions extends WP_UnitTestCase {
828
+
829
+ /**
830
+ * Test equality assertions
831
+ */
832
+ public function test_equality() {
833
+ $this->assertEquals( 'expected', 'expected' );
834
+ $this->assertNotEquals( 'expected', 'actual' );
835
+ $this->assertSame( 1, 1 ); // Strict comparison
836
+ $this->assertNotSame( 1, '1' );
837
+ }
838
+
839
+ /**
840
+ * Test boolean assertions
841
+ */
842
+ public function test_boolean() {
843
+ $this->assertTrue( true );
844
+ $this->assertFalse( false );
845
+ $this->assertNull( null );
846
+ $this->assertNotNull( 'value' );
847
+ }
848
+
849
+ /**
850
+ * Test array assertions
851
+ */
852
+ public function test_array() {
853
+ $array = array( 'key' => 'value' );
854
+
855
+ $this->assertIsArray( $array );
856
+ $this->assertArrayHasKey( 'key', $array );
857
+ $this->assertContains( 'value', $array );
858
+ $this->assertCount( 1, $array );
859
+ }
860
+
861
+ /**
862
+ * Test string assertions
863
+ */
864
+ public function test_string() {
865
+ $string = 'Hello World';
866
+
867
+ $this->assertIsString( $string );
868
+ $this->assertStringContainsString( 'World', $string );
869
+ $this->assertStringStartsWith( 'Hello', $string );
870
+ $this->assertStringEndsWith( 'World', $string );
871
+ }
872
+
873
+ /**
874
+ * Test numeric assertions
875
+ */
876
+ public function test_numeric() {
877
+ $this->assertGreaterThan( 5, 10 );
878
+ $this->assertLessThan( 10, 5 );
879
+ $this->assertGreaterThanOrEqual( 5, 5 );
880
+ $this->assertLessThanOrEqual( 5, 5 );
881
+ }
882
+
883
+ /**
884
+ * Test instance assertions
885
+ */
886
+ public function test_instance() {
887
+ $post = get_post( $this->factory->post->create() );
888
+
889
+ $this->assertInstanceOf( 'WP_Post', $post );
890
+ }
891
+ }
892
+ ```
893
+
894
+ ---
895
+
896
+ ## Code Coverage
897
+
898
+ ### Generate Coverage Report
899
+
900
+ **composer.json:**
901
+ ```json
902
+ {
903
+ "scripts": {
904
+ "test": "phpunit",
905
+ "test:coverage": "phpunit --coverage-html coverage"
906
+ }
907
+ }
908
+ ```
909
+
910
+ **Run coverage:**
911
+ ```bash
912
+ composer test:coverage
913
+ ```
914
+
915
+ ### Coverage Annotations
916
+
917
+ ```php
918
+ <?php
919
+ /**
920
+ * Test with coverage annotations
921
+ */
922
+ class Test_Coverage extends WP_UnitTestCase {
923
+
924
+ /**
925
+ * @covers My_Plugin_Class::method_name
926
+ */
927
+ public function test_method() {
928
+ $instance = new My_Plugin_Class();
929
+ $result = $instance->method_name();
930
+
931
+ $this->assertTrue( $result );
932
+ }
933
+ }
934
+ ```
935
+
936
+ ---
937
+
938
+ ## Continuous Integration
939
+
940
+ ### GitHub Actions Workflow
941
+
942
+ **.github/workflows/tests.yml:**
943
+ ```yaml
944
+ name: Tests
945
+
946
+ on:
947
+ push:
948
+ branches: [ main, develop ]
949
+ pull_request:
950
+ branches: [ main, develop ]
951
+
952
+ jobs:
953
+ test:
954
+ runs-on: ubuntu-latest
955
+
956
+ strategy:
957
+ matrix:
958
+ php: [ '7.4', '8.0', '8.1', '8.2' ]
959
+ wordpress: [ 'latest', '6.0' ]
960
+
961
+ steps:
962
+ - uses: actions/checkout@v3
963
+
964
+ - name: Setup PHP
965
+ uses: shivammathur/setup-php@v2
966
+ with:
967
+ php-version: ${{ matrix.php }}
968
+ extensions: mysqli
969
+ coverage: xdebug
970
+
971
+ - name: Install dependencies
972
+ run: composer install --prefer-dist --no-progress
973
+
974
+ - name: Install WordPress test suite
975
+ run: |
976
+ bash bin/install-wp-tests.sh wordpress_test root root localhost ${{ matrix.wordpress }}
977
+
978
+ - name: Run tests
979
+ run: composer test
980
+
981
+ - name: Upload coverage
982
+ if: matrix.php == '8.1' && matrix.wordpress == 'latest'
983
+ uses: codecov/codecov-action@v3
984
+ ```
985
+
986
+ ---
987
+
988
+ ## Best Practices
989
+
990
+ ### DO
991
+
992
+ ✅ **Write tests first** (TDD approach when possible)
993
+ ✅ **Test one thing per test** method
994
+ ✅ **Use descriptive test names** (`test_user_can_save_settings`)
995
+ ✅ **Clean up after tests** (use `tearDown()`)
996
+ ✅ **Use factories** for test data creation
997
+ ✅ **Mock external dependencies** (APIs, services)
998
+ ✅ **Test edge cases** and error conditions
999
+ ✅ **Aim for high code coverage** (80%+ is good)
1000
+ ✅ **Run tests before commits**
1001
+ ✅ **Use CI/CD** for automated testing
1002
+ ✅ **Test with multiple PHP versions**
1003
+ ✅ **Test with multiple WordPress versions**
1004
+
1005
+ ### DON'T
1006
+
1007
+ ❌ **Don't test WordPress core** functionality
1008
+ ❌ **Don't write tests that depend on each other**
1009
+ ❌ **Don't use real external APIs** in tests
1010
+ ❌ **Don't skip cleanup** in `tearDown()`
1011
+ ❌ **Don't test implementation details** - test behavior
1012
+ ❌ **Don't ignore failing tests**
1013
+ ❌ **Don't commit without running tests**
1014
+ ❌ **Don't test private methods** directly
1015
+ ❌ **Don't use production database** for tests
1016
+ ❌ **Don't hardcode test data** - use factories
1017
+
1018
+ ---
1019
+
1020
+ ## Test Organization
1021
+
1022
+ ### Directory Structure
1023
+
1024
+ ```
1025
+ tests/
1026
+ ├── bootstrap.php # Test bootstrap
1027
+ ├── unit/ # Unit tests
1028
+ │ ├── test-class-plugin.php
1029
+ │ ├── test-functions.php
1030
+ │ └── test-helpers.php
1031
+ ├── integration/ # Integration tests
1032
+ │ ├── test-cpt.php
1033
+ │ ├── test-ajax.php
1034
+ │ └── test-rest-api.php
1035
+ ├── fixtures/ # Test fixtures
1036
+ │ ├── sample-data.json
1037
+ │ └── sample-image.jpg
1038
+ └── mocks/ # Mock classes
1039
+ └── class-mock-api.php
1040
+ ```
1041
+
1042
+ ### Naming Conventions
1043
+
1044
+ **Test files:**
1045
+ - Prefix with `test-`
1046
+ - Match source file name: `class-plugin.php` → `test-class-plugin.php`
1047
+
1048
+ **Test classes:**
1049
+ - Prefix with `Test_`
1050
+ - Use underscores: `Test_My_Plugin_Class`
1051
+
1052
+ **Test methods:**
1053
+ - Prefix with `test_`
1054
+ - Descriptive names: `test_user_can_save_settings()`
1055
+
1056
+ ---
1057
+
1058
+ ## Running Tests
1059
+
1060
+ ### Command Line
1061
+
1062
+ ```bash
1063
+ # Run all tests
1064
+ phpunit
1065
+
1066
+ # Run specific test suite
1067
+ phpunit --testsuite unit
1068
+ phpunit --testsuite integration
1069
+
1070
+ # Run specific test file
1071
+ phpunit tests/unit/test-class-plugin.php
1072
+
1073
+ # Run specific test method
1074
+ phpunit --filter test_method_name
1075
+
1076
+ # Run with coverage
1077
+ phpunit --coverage-html coverage
1078
+
1079
+ # Run with verbose output
1080
+ phpunit --verbose
1081
+ ```
1082
+
1083
+ ### Composer Scripts
1084
+
1085
+ **composer.json:**
1086
+ ```json
1087
+ {
1088
+ "scripts": {
1089
+ "test": "phpunit",
1090
+ "test:unit": "phpunit --testsuite unit",
1091
+ "test:integration": "phpunit --testsuite integration",
1092
+ "test:coverage": "phpunit --coverage-html coverage",
1093
+ "test:watch": "phpunit-watcher watch"
1094
+ }
1095
+ }
1096
+ ```
1097
+
1098
+ **Run:**
1099
+ ```bash
1100
+ composer test
1101
+ composer test:unit
1102
+ composer test:coverage
1103
+ ```
1104
+
1105
+ ---
1106
+
1107
+ ## Debugging Tests
1108
+
1109
+ ### Enable Debug Output
1110
+
1111
+ ```php
1112
+ <?php
1113
+ /**
1114
+ * Test with debug output
1115
+ */
1116
+ class Test_Debug extends WP_UnitTestCase {
1117
+
1118
+ public function test_with_debug() {
1119
+ $value = 'test';
1120
+
1121
+ // Output debug information
1122
+ fwrite( STDERR, print_r( $value, true ) );
1123
+
1124
+ $this->assertEquals( 'test', $value );
1125
+ }
1126
+ }
1127
+ ```
1128
+
1129
+ ### Use PHPUnit Annotations
1130
+
1131
+ ```php
1132
+ <?php
1133
+ /**
1134
+ * @group slow
1135
+ * @group external-api
1136
+ */
1137
+ class Test_External_API extends WP_UnitTestCase {
1138
+
1139
+ /**
1140
+ * @group integration
1141
+ */
1142
+ public function test_api_call() {
1143
+ // Test code
1144
+ }
1145
+ }
1146
+ ```
1147
+
1148
+ **Run specific groups:**
1149
+ ```bash
1150
+ phpunit --group integration
1151
+ phpunit --exclude-group slow
1152
+ ```
1153
+
1154
+ ---
1155
+
1156
+ ## Resources
1157
+
1158
+ - [WordPress PHPUnit Documentation](https://make.wordpress.org/core/handbook/testing/automated-testing/phpunit/)
1159
+ - [PHPUnit Documentation](https://phpunit.de/documentation.html)
1160
+ - [WP_UnitTestCase Reference](https://developer.wordpress.org/reference/classes/wp_unittestcase/)
1161
+ - [WordPress Test Suite](https://develop.svn.wordpress.org/trunk/tests/phpunit/)
1162
+ - [WooCommerce Testing](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce/tests)
1163
+ ```
1164
+
1165
+