Implement addon (#1)

* First commit

* Add playwright commands

* Add generated

* Add base-url to playwright config

* Add comment

* Try

* More commands

* Add annotations

* New commands

* Refactor

* New line

---------

Co-authored-by: Christian Fritsch <[email protected]>

README.md

@@ -1,93 +1,18 @@
-[![tests](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml/badge.svg)](https://github.com/ddev/ddev-addon-template/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2024.svg)
+# DDEV - DPP Add-on
 
-# ddev-addon-template <!-- omit in toc -->
+This is a DDEV Add-on to provide a seamless integration with the [Drupal Project Platform](https://www.drupal-project-platform.com/).
 
-* [What is ddev-addon-template?](#what-is-ddev-addon-template)
-* [Components of the repository](#components-of-the-repository)
-* [Getting started](#getting-started)
-* [How to debug in Github Actions](#how-to-debug-tests-github-actions)
+## Installation
 
-## What is ddev-addon-template?
-
-This repository is a template for providing [DDEV](https://ddev.readthedocs.io) add-ons and services.
-
-In DDEV addons can be installed from the command line using the `ddev get` command, for example, `ddev get ddev/ddev-redis` or `ddev get ddev/ddev-solr`.
-
-This repository is a quick way to get started. You can create a new repo from this one by clicking the template button in the top right corner of the page.
-
-![template button](images/template-button.png)
-
-## Components of the repository
-
-* The fundamental contents of the add-on service or other component. For example, in this template there is a [docker-compose.addon-template.yaml](docker-compose.addon-template.yaml) file.
-* An [install.yaml](install.yaml) file that describes how to install the service or other component.
-* A test suite in [test.bats](tests/test.bats) that makes sure the service continues to work as expected.
-* [Github actions setup](.github/workflows/tests.yml) so that the tests run automatically when you push to the repository.
-
-## Getting started
-
-1. Choose a good descriptive name for your add-on. It should probably start with "ddev-" and include the basic service or functionality. If it's particular to a specific CMS, perhaps `ddev-<CMS>-servicename`.
-2. Create the new template repository by using the template button.
-3. Globally replace "addon-template" with the name of your add-on.
-4. Add the files that need to be added to a DDEV project to the repository. For example, you might replace `docker-compose.addon-template.yaml` with the `docker-compose.*.yaml` for your recipe.
-5. Update the `install.yaml` to give the necessary instructions for installing the add-on:
-
-   * The fundamental line is the `project_files` directive, a list of files to be copied from this repo into the project `.ddev` directory.
-   * You can optionally add files to the `global_files` directive as well, which will cause files to be placed in the global `.ddev` directory, `~/.ddev`.
-   * Finally, `pre_install_commands` and `post_install_commands` are supported. These can use the host-side environment variables documented [in DDEV docs](https://ddev.readthedocs.io/en/latest/users/extend/custom-commands/#environment-variables-provided).
-
-6. Update `tests/test.bats` to provide a reasonable test for your repository. Tests are triggered either by manually executing `bats ./tests/test.bats`, automatically on every push to the repository, or periodically each night. Please make sure to attend to test failures when they happen. Others will be depending on you. Bats is a simple testing framework that just uses Bash. To run a Bats test locally, you have to [install bats-core](https://bats-core.readthedocs.io/en/stable/installation.html) first. Then you download your add-on, and finally run `bats ./tests/test.bats` within the root of the uncompressed directory. To learn more about Bats see the [documentation](https://bats-core.readthedocs.io/en/stable/).
-7. When everything is working, including the tests, you can push the repository to GitHub.
-8. Create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) on GitHub.
-9. Test manually with `ddev get <owner/repo>`.
-10. You can test PRs with `ddev get https://github.com/<user>/<repo>/tarball/<branch>`
-11. Update the `README.md` to describe the add-on, how to use it, and how to contribute. If there are any manual actions that have to be taken, please explain them. If it requires special configuration of the using project, please explain how to do those. Examples in [ddev/ddev-solr](https://github.com/ddev/ddev-solr), [ddev/ddev-memcached](https://github.com/ddev/ddev-memcached), and (advanced) [ddev-platformsh](https://github.com/ddev/ddev-platformsh).
-12. Update the `README.md` header in Title Case format, for example, use `# DDEV Redis`, not `# ddev-redis`.
-13. Add a good short description to your repo, and add the [topic](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics) "ddev-get". It will immediately be added to the list provided by `ddev get --list --all`.
-14. When it has matured you will hopefully want to have it become an "official" maintained add-on. Open an issue in the [DDEV queue](https://github.com/ddev/ddev/issues) for that.
-
-Add-ons were covered in [DDEV Add-ons: Creating, maintaining, testing](https://www.dropbox.com/scl/fi/bnvlv7zswxwm8ix1s5u4t/2023-11-07_DDEV_Add-ons.mp4?rlkey=5cma8s11pscxq0skawsoqrscp&dl=0) (part of the [DDEV Contributor Live Training](https://ddev.com/blog/contributor-training)).
-
-Note that more advanced techniques are discussed in [DDEV docs](https://ddev.readthedocs.io/en/latest/users/extend/additional-services/#additional-service-configurations-and-add-ons-for-ddev).
-
-## How to debug tests (Github Actions)
-
-1. You need an SSH-key registered with GitHub. You either pick the key you have already used with `github.com` or you create a dedicated new one with `ssh-keygen -t ed25519 -a 64 -f tmate_ed25519 -C "$(date +'%d-%m-%Y')"` and add it at `https://github.com/settings/keys`.
-
-2. Add the following snippet to `~/.ssh/config`:
-
-```
-Host *.tmate.io
-    User git
-    AddKeysToAgent yes
-    UseKeychain yes
-    PreferredAuthentications publickey
-    IdentitiesOnly yes
-    IdentityFile ~/.ssh/tmate_ed25519
-```
-3. Go to `https://github.com/<user>/<repo>/actions/workflows/tests.yml`.
-
-4. Click the `Run workflow` button and you will have the option to select the branch to run the workflow from and activate `tmate` by checking the `Debug with tmate` checkbox for this run.
-
-![tmate](images/gh-tmate.jpg)
-
-5. After the `workflow_dispatch` event was triggered, click the `All workflows` link in the sidebar and then click the `tests` action in progress workflow.
-
-7. Pick one of the jobs in progress in the sidebar.
-
-8. Wait until the current task list reaches the `tmate debugging session` section and the output shows something like:
-
-```
-106 SSH: ssh [email protected]
-107 or: ssh -i <path-to-private-SSH-key> [email protected]
-108 SSH: ssh [email protected]
-109 or: ssh -i <path-to-private-SSH-key> [email protected]
+```bash
+ddev get thunder/ddev-dpp
 ```
 
-9. Copy and execute the first option `ssh [email protected]` in the terminal and continue by pressing either <kbd>q</kbd> or <kbd>Ctrl</kbd> + <kbd>c</kbd>.
+## Usage
 
-10. Start the Bats test with `bats ./tests/test.bats`.
+The add-on provides the following commands:
 
-For a more detailed documentation about `tmate` see [Debug your GitHub Actions by using tmate](https://mxschmitt.github.io/action-tmate/).
+- `ddev install-playwright` - Setup and install Playwright for testing
+- `ddev playwright` - A wrapper for the Playwright CLI
+- `ddev dump-test-database` - Dump the database for testing purposes
 
-**Contributed and maintained by [@CONTRIBUTOR](https://github.com/CONTRIBUTOR)**

commands/host/install-playwright

@@ -0,0 +1,18 @@
+#!/bin/sh
+#ddev-generated
+
+## Description: Install Playwright in the project
+## Usage: install-playwright
+## Example: "ddev install-playwright"
+
+# Skip if Playwright is already installed
+if [ -d "${DDEV_APPROOT}/tests/Playwright" ]; then
+  echo "Playwright is already installed in the project."
+  exit 0
+fi
+
+mkdir -p "${DDEV_APPROOT}/tests/Playwright"
+cd "${DDEV_APPROOT}/tests/Playwright" || exit
+npm init playwright@latest
+
+node "${DDEV_APPROOT}"/.ddev/dpp/add-base-url.js ${DDEV_APPROOT}/tests/Playwright/playwright.config.js

commands/host/playwright

@@ -0,0 +1,14 @@
+#!/bin/sh
+#ddev-generated
+
+## Description: Run Playwright commands
+## Usage: playwright
+## Example: "ddev playwright"
+
+cd "${DDEV_APPROOT}/tests/Playwright" || exit 1
+export PLAYWRIGHT_BASE_URL=$DDEV_PRIMARY_URL
+if [ -f yarn.lock ]; then
+  yarn && yarn playwright "$@"
+else
+  npx playwright "$@"
+fi

commands/web/dump-test-database

@@ -0,0 +1,17 @@
+#!/bin/sh
+#ddev-generated
+
+## Description: Dump the database as PHP file into the docroot.
+## Usage: dump-test-database
+## Example: ddev dump-test-database
+
+cd "${DDEV_COMPOSER_ROOT}"/"${DDEV_DOCROOT}" || exit
+
+# Ask user for SITE_NAME, take "default" as default value
+read -rp "Enter the site name (default): " SITE_NAME
+export SITE_NAME=${SITE_NAME:-default}
+
+echo "Dumping the database for ${SITE_NAME}..."
+
+# shellcheck disable=SC2154
+php core/scripts/db-tools.php dump-database-d8-mysql > "${thunderDumpFile}"

config.dpp.yml

@@ -0,0 +1,9 @@
+#ddev-generated
+web_environment:
+  - DRUSH_OPTIONS_URI=${DDEV_PRIMARY_URL}
+  - thunderDumpFile=${DDEV_COMPOSER_ROOT}/${DDEV_DOCROOT}/test-database-dump.php
+
+hooks:
+  post-start:
+    - composer: global config --no-plugins allow-plugins.dpp/composer-plugin true
+    - composer: global require -n dpp/composer-plugin:^1@beta

dpp/add-base-url.js

@@ -0,0 +1,54 @@
+//#ddev-generated
+const fs = require('fs');
+
+// Path to your Playwright config file
+const configFilePath = process.argv[2];
+
+// Read the configuration file
+fs.readFile(configFilePath, 'utf8', (err, data) => {
+  if (err) {
+    console.error(`Error reading file: ${err}`);
+    return;
+  }
+
+  // Parse the file content
+  const fileLines = data.split('\n');
+
+  // Find the line where the "use" object starts
+  const useStartIndex = fileLines.findIndex(line => line.trim().startsWith('use: {'));
+
+  if (useStartIndex === -1) {
+    console.error('Could not find the "use" object in the configuration file.');
+    return;
+  }
+
+  // Define the new value to add
+  const newValue = 'baseURL: process.env.PLAYWRIGHT_BASE_URL,';
+
+  // Find the end of the "use" object
+  let useEndIndex = useStartIndex;
+  let braceCount = 0;
+  for (let i = useStartIndex; i < fileLines.length; i++) {
+    if (fileLines[i].includes('{')) braceCount++;
+    if (fileLines[i].includes('}')) braceCount--;
+    if (braceCount === 0) {
+      useEndIndex = i;
+      break;
+    }
+  }
+
+  // Insert the new value before the closing brace of the "use" object
+  fileLines.splice(useEndIndex, 0, `    ${newValue}`);
+
+  // Join the lines back together
+  const updatedData = fileLines.join('\n');
+
+  // Write the updated configuration back to the file
+  fs.writeFile(configFilePath, updatedData, 'utf8', (err) => {
+    if (err) {
+      console.error(`Error writing file: ${err}`);
+      return;
+    }
+    console.log('Configuration file updated successfully.');
+  });
+});

install.yaml

@@ -1,6 +1,6 @@
 # Details about the install.yaml file are at https://ddev.readthedocs.io/en/latest/users/extend/additional-services/#sections-and-features-of-ddev-get-add-on-installyaml
 
-name: addon-template
+name: dpp
 
 # pre_install_actions - list of actions to run before installing the addon.
 # Examples would be removing an extraneous docker volume,
@@ -60,7 +60,12 @@ pre_install_actions:
 # If you use directories, they must be directories that are managed
 # by this add-on, or removal could remove things that are not owned by it
 project_files:
-- docker-compose.addon-template.yaml
+  - config.dpp.yml
+  - commands/host/install-playwright
+  - commands/host/playwright
+  - commands/web/dump-test-database
+  - dpp/add-base-url.js
+# - docker-compose.addon-template.yaml
 # - some-directory/file1.txt
 # - some-directory/file2.txt
 # - extra_files_dir_created_by_this_template/
@@ -74,7 +79,7 @@ global_files:
 
 # List of add-on names that this add-on depends on
 dependencies:
-# - redis
+# - ddev/ddev-selenium-standalone-chrome
 
 # DDEV environment variables can be interpolated into these actions
 post_install_actions: