DrupalPod + Drupal Forge

These instructions can be used to install and test the DrupalPod + Drupal Forge browser extension for working on Drupal.org issues.

1. Install the Drupal Forge browser extension from either the Firefox add-on page, Chrome web store page or Safari app store page.
   1. Important: Open the extension options (or preferences) page and paste https://git.drupalcode.org/project/drupalpod/-/tree/main as the DrupalPod Repository URL and press the Save button.
2. Create a free account on https://drupalforge.org
3. Login to drupal.org
4. Ensure that you have setup git access for your drupal.org user account.
5. Visit the issue that you want to work on.
6. Press the “Get Push Access” button on the issue page.
7. Open the Drupal Forge helper extension in your browser’s toolbar, and select:
   1. Branch: choose the corresponding branch from the merge request.
   2. Drupal core version: 11.x
   3. Install profile: Standard
8. Click the button to “Open Dev Environment”, agree to the Terms & Conditions, click the “Launch” button and be a little patient. Accept the waivers, if necessary.
9. You can click the “Access to DevPanel to work more Powerful” link to see a progress bar as the environment is built.
10. Once the environment is finished setting up your Drupal web site, the Application Summary page will be displayed.
    1. If you want to view the Drupal web site, proceed to the “Working with Drupal in the browser” section below.
    2. If you want to make a code contribution, proceed to the “Working with VS Code in the browser” section below.
11. Please leave any feedback/bugs/comments on the DrupalPod project - including if you went through this process and everything worked for you!

Working with Drupal in the browser 

1. From the Application Summary page, follow the link that ends in “drupalforge.app”.
2. You can log in to your working Drupal web site using admin as the username and admin as the password.
3. Complete the task that you need to work on in the issue such as “Add screenshots to an issue”.

Working with Visual Studio Code in the browser

1. From the Application Summary page underneath the “Start VSCode in Browser” section, copy the VS Code password.
2. Follow the “Open Application” link to open Visual Studio Code in your browser.
3. Paste the password from step 1 in the password field on the “Welcome to code-server” page, and then press the “SUBMIT” button.
   1. Note it is possible to share the Open Application link and password to act as a shared work space.
4. In the Visual Studio Code interface, you can find the module or drupal directory inside the repos directory by navigating from the left sidebar or using the terminal. For example, if you are working on a Drupal core issue, the repository is cloned into repos/drupal so you would run cd repos/drupal to access that directory in the terminal.
5. When you make changes to files, you can test them in the browser by following the “Working with Drupal in the browser” section above.

Pushing your changes back to the drupal.org issue fork

1. Configure your git user name and email by running the following commands in the terminal.
   1. git config --global user.email "you@example.com"
   2. git config --global user.name "Your Name"
2. Create a GitLab Personal Access Token allowing the “write_repository” permission. Read the “Authenticating with Personal access token over HTTPS” documentation for instructions. It is advised to save the token after you create in a password manager as you will not be able to view the token again after creating it.
3. Change directory to the project directory inside the repos directory e.g. cd repos/drupal.
4. Ensure the git branch is correct, commit your changes, and when you run git push <issue fork remote> <issue fork branch>, use the personal access token generated above as the password when prompted.

Using Drush

1. Run ./vendor/bin/drush in the terminal.

Running PHPUnit tests

1. Copy the web/core/phpunit.xml.dist file to phpunit.xml.
2. Open the phpunit.xml file.
3. Browse to web/core/sites/default and open settings.php. It may be helpful to use the “Open to the side” functionality to view both files side-by-side in the editor. Scroll down to the bottom of settings.php.
4. In the phpunit.xml file,
   1. Change the phpunit bootstrap value attribute to web/core/tests/bootstrap.php.
   2. Change the SIMPLETEST_BASE_URL env value attribute to http://localhost.
   3. Change the SIMPLETEST_DB env value to the database connection string based on the database connection array in settings.php:
      1. Start by pasting mysql://username:password@localhost:port/database_name into the value attribute.
      2. Replace username with the username value.
      3. Replace password with the password value.
      4. Replace localhost with the host value.
      5. Replace port with the port value.
      6. Replace database_name with the database value.
5. In the terminal, ensure that the current working directory is /var/www/html, and then run vendor/bin/phpunit -c phpunit.xml <web/path/to/test> such as web/core/modules/node/tests/src/Kernel/ConfigActionTest.php.