Skip to content

Conversation

@AlexSkrypnyk
Copy link
Member

@AlexSkrypnyk AlexSkrypnyk commented Feb 9, 2026

Closes #2172

Summary by CodeRabbit

  • Documentation
    • Added "Testing the template" section to Architecture documentation with overview of testing approaches.
    • Restructured testing documentation with improved testing strategy guidance, clearer instructions for running tests, and updated asset management procedures.
    • Added information about scripts transitioning from Bash to PHP in version 2.0.

@github-project-automation github-project-automation bot moved this to BACKLOG in Vortex Feb 9, 2026
@AlexSkrypnyk AlexSkrypnyk added this to the 1.36.0 milestone Feb 9, 2026
@AlexSkrypnyk AlexSkrypnyk moved this from BACKLOG to In progress in Vortex Feb 9, 2026
@coderabbitai
Copy link

coderabbitai bot commented Feb 9, 2026

Walkthrough

The changes add and restructure testing documentation within the Vortex project, introducing a new "Testing the template" section in the architecture guide and comprehensively reorganizing the tests documentation to describe unit tests, end-to-end tests, real-world validation via the DrevOps website, and the transition from Bats to PHPUnit.

Changes

Cohort / File(s) Summary
Architecture Documentation
architecture.mdx
Added new "Testing the template" section linking to unit tests (Bats), end-to-end tests (PHPUnit in Docker), and real-world validation (DrevOps website), with a reference to the Contributing > Maintenance > Tests documentation.
Testing Documentation
contributing/maintenance/tests.mdx
Substantially restructured and expanded testing documentation, introducing a multi-layer testing strategy covering unit tests with Bats, end-to-end testing with PHPUnit, example site validation, transition notes from Bash to PHP in version 2.0, and detailed collapsible sections for updating test assets and database dumps.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Poem

🐰 Scurrying through docs with delight,
Testing sections burn so bright,
From Bats to PHPUnit we hop,
E2E flows never stop,
DrevOps wisdom shines with light!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding documentation about testing Vortex, which aligns with the core purpose of this pull request.
Linked Issues check ✅ Passed All coding requirements from #2172 are met: unit testing (Bats), E2E testing (PHPUnit), example site reference, and supporting libraries are documented across the modified files.
Out of Scope Changes check ✅ Passed All changes are within scope: documentation additions to architecture.mdx and tests.mdx files align with the objective to document testing approaches and strategies.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/2172-docs-testing-vortex

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.vortex/docs/content/contributing/maintenance/tests.mdx (1)

292-297: ⚠️ Potential issue | 🟠 Major

Fix demo/test image naming mismatch in test container image steps.

This section is about the test database container image, but the tag/push commands still reference the demo image names. That will publish the wrong images.

🐛 Proposed fix to align with test image naming
- docker tag drevops/vortex-dev-mariadb-drupal-data-demo-11.x:latest drevops/vortex-dev-mariadb-drupal-data-demo-destination-11.x:vortex-dev-database-ii
- docker push drevops/vortex-dev-mariadb-drupal-data-demo-destination-11.x:vortex-dev-database-ii
-
- docker tag drevops/vortex-dev-mariadb-drupal-data-demo-11.x:latest drevops/vortex-dev-mariadb-drupal-data-demo-destination-11.x:vortex-dev-didi-database-fi
- docker push drevops/vortex-dev-mariadb-drupal-data-demo-destination-11.x:vortex-dev-didi-database-fi
+ docker tag drevops/vortex-dev-mariadb-drupal-data-test-11.x:latest drevops/vortex-dev-mariadb-drupal-data-test-destination-11.x:vortex-dev-database-ii
+ docker push drevops/vortex-dev-mariadb-drupal-data-test-destination-11.x:vortex-dev-database-ii
+
+ docker tag drevops/vortex-dev-mariadb-drupal-data-test-11.x:latest drevops/vortex-dev-mariadb-drupal-data-test-destination-11.x:vortex-dev-didi-database-fi
+ docker push drevops/vortex-dev-mariadb-drupal-data-test-destination-11.x:vortex-dev-didi-database-fi

@github-actions
Copy link

github-actions bot commented Feb 9, 2026

Code Coverage Report:
  2026-02-09 05:50:43

 Summary:
  Classes:  0.00% (0/1)
  Methods:  0.00% (0/2)
  Lines:   93.92% (170/181)

@AlexSkrypnyk
Copy link
Member Author

Code Coverage Report:
  2026-02-09 05:52:18

 Summary:
  Classes:  0.00% (0/1)
  Methods:  0.00% (0/2)
  Lines:   93.92% (170/181)

@AlexSkrypnyk
Copy link
Member Author

Code Coverage Report:
  2026-02-09 05:55:11

 Summary:
  Classes:  0.00% (0/1)
  Methods:  0.00% (0/2)
  Lines:   93.92% (170/181)

@AlexSkrypnyk AlexSkrypnyk enabled auto-merge (squash) February 9, 2026 06:06
@AlexSkrypnyk
Copy link
Member Author

Code Coverage Report:
  2026-02-09 06:12:57

 Summary:
  Classes:  0.00% (0/1)
  Methods:  0.00% (0/2)
  Lines:   93.92% (170/181)

@codecov
Copy link

codecov bot commented Feb 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.44%. Comparing base (f88b404) to head (beff1fc).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2262      +/-   ##
==========================================
- Coverage   77.05%   76.44%   -0.61%     
==========================================
  Files         114      107       -7     
  Lines        5988     5829     -159     
  Branches       44        0      -44     
==========================================
- Hits         4614     4456     -158     
+ Misses       1374     1373       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@AlexSkrypnyk AlexSkrypnyk merged commit 5f60d7c into main Feb 9, 2026
28 checks passed
@AlexSkrypnyk AlexSkrypnyk deleted the feature/2172-docs-testing-vortex branch February 9, 2026 06:13
@github-project-automation github-project-automation bot moved this from In progress to Release queue in Vortex Feb 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Release queue

Development

Successfully merging this pull request may close these issues.

[DOCS] Add section about how we test Vortex

1 participant