Ensure functional javascript tests can be run

[codebymikey]

The Problem/Issue/Bug

It's currently not possible to run functional tests as the default settings are invalid.

How this PR Solves The Problem

I've updated the default environment variables to more appropriate ones based off what Drupal uses in it's official pipelines.

Implementation notes

The MINK_DRIVER_ARGS_WEBDRIVER environment variable supports both goog:chromeOptions and chromeOptions (legacy) in order to automatically support testing on Drupal <10.3 - https://www.drupal.org/node/3422624

We can potentially simplify this to just goog:chromeOptions and add an init script which detects < D10.3, and replaces it with chromeOptions, but that seemed unnecessarily complicated.

Manual Testing Instructions

Set up a drupal project in gitpod.

ddev phpunit core/modules/action/tests/src/FunctionalJavascript/ActionFormAjaxTest.php

All the tests will be currently skipped due to the misconfigurations.

Related Issue Link(s)

N/A

Release/Deployment notes

N/A

Summary by CodeRabbit

• Chores
  • Updated testing configurations to improve consistency and reliability in the testing environment.

[codesandbox]

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

[coderabbitai]

Walkthrough

The recent updates focus on modifying the PHPUnit configuration and related testing environments within a web project. The primary change involves updating the SIMPLETEST_BASE_URL from "http://localhost" to "http://web", impacting both PHPUnit and Nightwatch configurations to ensure proper URL settings for testing.

Changes

Files	Change Summary
.ddev/commands/web/phpunit	Updated SIMPLETEST_BASE_URL from "http://localhost" to "http://web".
.ddev/docker-compose.testing.yaml	Adjusted settings for PHPUnit and Nightwatch, including updates to SIMPLETEST_BASE_URL, MINK_DRIVER_ARGS_WEBDRIVER, and DRUPAL_TEST_WEBDRIVER_CHROME_ARGS.

Poem

In the realm of code so bright,
URLs shift from day to night.
From localhost to web we steer,
Testing paths now crystal clear.
With PHPUnit and Nightwatch in sync,
Our web project dances on the brink.
🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8ddc8c9 and 1dc8e17.

Files selected for processing (2)

• .ddev/commands/web/phpunit (1 hunks)
• .ddev/docker-compose.testing.yaml (1 hunks)

Files skipped from review due to trivial changes (1)

• .ddev/commands/web/phpunit

Additional comments not posted (3)

.ddev/docker-compose.testing.yaml (3)

19-19: Ensure SIMPLETEST_BASE_URL is correctly set to match the new environment.

This change aligns with the PR's objective to update environment variables for functional testing. Make sure that all references to this URL in the test scripts are updated accordingly.

---

39-39: Updated Chrome arguments for WebDriver to enhance performance in headless tests.

The arguments provided are standard for optimizing Chrome performance in headless testing environments. This should help in reducing flakiness and improving test reliability.

---

22-31: Updated MINK_DRIVER_ARGS_WEBDRIVER to support both legacy and current Chrome options.

This update is crucial for backward compatibility with older versions of Drupal. Please ensure to test this configuration on multiple Drupal versions to confirm its effectiveness.

[vladdancer]

@codebymikey thank you for this PR! I confirm that this PR fixes running core/modules/action/tests/src/FunctionalJavascript/ActionFormAjaxTest.php but for some reason it didn't worked for running javascript tests for checking iframes. Also it didn't worked for media browser test: Drupal\Tests\media_library\FunctionalJavascript\WidgetOverflowTest::testWidgetOverflow

I recieved:

The test wasn't able to connect to your webdriver instance. For more information read core/tests/README.md.

The original message while starting Mink: Could not open connection: unknown error: Chrome failed to start: crashed.
  (unknown error: DevToolsActivePort file doesn't exist)

What worked for me is (in addition to your changes) to specify --no-sandbox in both variables:

      MINK_DRIVER_ARGS_WEBDRIVER: >-
        [
        "chrome",
        {
          "browserName":"chrome",
          "chromeOptions":{"args":["--disable-dev-shm-usage","--disable-gpu","--headless","--dns-prefetch-disable","--no-sandbox"]},
          "goog:chromeOptions":{"args":["--disable-dev-shm-usage","--disable-gpu","--headless","--dns-prefetch-disable","--no-sandbox"]}
        },
        "http://chromedriver:9515"
        ]
      DRUPAL_TEST_WEBDRIVER_CHROME_ARGS: "--disable-dev-shm-usage --disable-gpu --headless --dns-prefetch-disable --no-sandbox"

[rfay]

@codebymikey or @shaal Would you mind updating the title to "Ensure functional javascript tests can be run"? (ran -> run) thanks!

[rfay]

(BTW, I'm not sure why Drupalpod isn't using https://github.com/ddev/ddev-selenium-standalone-chrome for this if it's not? That would be the best maintained solution. )