chore(ddev): add init of addon and pre-install setup

README.md

@@ -1,44 +1,30 @@
-[![tests](https://github.com/drud/ddev-addon-template/actions/workflows/tests.yml/badge.svg)](https://github.com/drud/ddev-addon-template/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2024.svg)
+[![tests](https://github.com/a11ywatch/ddev-a11ywatch/actions/workflows/tests.yml/badge.svg)](https://github.com/a11ywatch/ddev-a11ywatch/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2024.svg)
 
-## What is ddev-addon-template?
+## What is this?
 
-This repository is a template for providing [DDEV](https://ddev.readthedocs.io) addons and services.
+This repository allows you to quickly install the warp speed accessibility and vast coverage tool [A11yWatch Lite](https://github.com/a11ywatch/a11ywatch) into a [Ddev](https://ddev.readthedocs.io) project using just `ddev get a11ywatch/ddev-a11ywatch`.
 
-In ddev v1.19+ addons can be installed from the command line using the `ddev get` command, for example, `ddev get drud/ddev-addon-template` or `ddev get drud/ddev-drupal9-solr`.
+## Installation
 
-A repository like this one is the 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.
+1. `ddev get a11ywatch/ddev-a11ywatch && ddev restart`
+2. `ddev restart`
 
-![template button](images/template-button.png)
+## Explanation
 
-## Components of the repository
+This A11yWatch recipe for [ddev](https://ddev.readthedocs.io) installs a [`.ddev/docker-compose.a11ywatch-standalone.yaml`](docker-compose.a11ywatch-standalone.yaml) using the [`A11yWatch`](https://hub.docker.com/r/a11ywatch/a11ywatch/tags) stand-alone docker image.
 
-* 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.
+## Interacting with A11yWatch
 
-## Getting started
+* The A11ywatch instance will listen on TCP port 3280 (the A11yWatch default) and port 50050 for gRPC.
+* Configure your application to access A11ywatch on the host:port `a11ywatch:3280`.
 
-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 remove `docker-composeaddon-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/stable/users/extend/custom-commands/#environment-variables-provided).
-6. Update `tests/test.bats` to provide a reasonable test for the repository. You can run it manually with `bats tests` and it will be run on push and nightly as well. 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`. You can install it with `brew install bats-core` or [see other techniques](https://bats-core.readthedocs.io/en/stable/installation.html). See [bats tutorial](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 on GitHub.
-9. Test manually with `ddev get <owner/repo>`.
-10. 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 [drud/ddev-drupal9-solr](https://github.com/drud/ddev-drupal9-solr), [drud/ddev-memcached](https://github.com/drud/ddev-memcached), and [drud/ddev-beanstalkd](https://github.com/drud/ddev-beanstalkd).
-11. Add a good short description to your repo, and add the label "ddev-get". It will immediately be added to the list provided by `ddev get --list --all`.
-12. 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/drud/ddev/issues) for that.
+## Additional Resources
 
-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).
+* To get detailed infromation on how to interact or commincate with the [A11yWatch API Info](https://a11ywatch.com/api-info) A11yWatch.
+* The [A11yWatch CLI](https://github.com/a11ywatch/a11ywatch) is helpful to perform automated task using the gRPC client.
 
-**Contributed and maintained by [@CONTRIBUTOR](https://github.com/CONTRIBUTOR) based on the original [ddev-contrib recipe](https://github.com/drud/ddev-contrib/tree/master/docker-compose-services/RECIPE) by [@CONTRIBUTOR](https://github.com/CONTRIBUTOR)**
-
-**Originally Contributed by [somebody](https://github.com/somebody) in https://github.com/drud/ddev-contrib/...)
+## Todo
 
+1. Add web panel option start using the `a11ywatch/web` image.
 
+**Contributed by [j-mendez](https://github.com/j-mendez)**

docker-compose.a11ywatch-standalone.yaml

@@ -0,0 +1,26 @@
+#ddev-generated
+# Simple template to demonstrate ddev-a11ywatch-standalone
+services:
+  ddev-a11ywatch-standalone:
+    container_name: ddev-${DDEV_SITENAME}-a11ywatch
+    hostname: ${DDEV_SITENAME}-a11ywatch
+    image: a11ywatch/a11ywatch:${A11YWATCH_IMAGE:-latest}
+    networks: [default, ddev_default]
+    expose:
+      - "3280"
+      - "50050"
+    environment:
+      - COMPUTER_VISION_ENDPOINT=${COMPUTER_VISION_ENDPOINT:-""}
+      - COMPUTER_VISION_SUBSCRIPTION_KEY=${COMPUTER_VISION_SUBSCRIPTION_KEY:-""}
+      - PAGESPEED_API_KEY=${PAGESPEED_API_KEY:-""}
+      - AI_DISABLED=${AI_DISABLED:-false}
+      - SUPER_MODE=${SUPER_MODE:-true}
+    labels:
+      com.ddev.site-name: ${DDEV_SITENAME}
+      com.ddev.approot: $DDEV_APPROOT
+    volumes:
+      - a11ywatch:/usr/share/a11ywatch/data
+      - ".:/mnt/ddev_config"
+
+volumes:
+  a11ywatch:

install.yaml

@@ -1,18 +1,10 @@
-name: addon-template
+name: ddev-a11ywatch-standalone
 
 # pre_install_actions - list of actions to run before installing the addon.
 # Examples would be removing an extraneous docker volume,
 # or doing a sanity check for requirements.
 # DDEV environment variables can be interpolated into these actions
 pre_install_actions:
-  # Actions with #ddev-nodisplay will not show the execution of the action, but may show their output
-# - |
-  # #ddev-nodisplay
-  # if [ "$(arch)" = "arm64" -o "$(arch)" = "aarch64" ]; then
-    # echo "This package does not work on arm64 machines";
-    # exit 1;
-  #fi
-
 # - "docker volume rm ddev-${DDEV_PROJECT}_solr 2>/dev/null || true"
 #- |
 #  # Using #ddev-nodisplay tells ddev to be quiet about this action and not show it or its output.
@@ -50,7 +42,7 @@ pre_install_actions:
 # if it hasn't been modified by the user.
 # DDEV environment variables can be interpolated into these filenames
 project_files:
-- docker-compose.addon-template.yaml
+- docker-compose.a11ywatch-standalone.yaml
 # - extra_files/
 # - somefile.sh
 
@@ -62,9 +54,15 @@ global_files:
 
 # DDEV environment variables can be interpolated into these actions
 post_install_actions:
-# - chmod +x ~/.ddev/commands/web/somecommand
-# - touch somefile.${GOOS}.${DDEV_WEBSERVER}
-# - perl -pi -e 's/oldstring/newstring/g' docker-compose.addon-template.yaml
+  # Actions with #ddev-nodisplay will not show the execution of the action, but may show their output
+- |
+  #ddev-nodisplay
+  if [[ "$OSTYPE" == "darwin"* ]]; then
+      if [ "$(arch)" = "arm64" -o "$(arch)" = "aarch64" ]; then
+          # set target platform default required for chip specific image
+          sed -i '' 's/A11YWATCH_IMAGE:-latest/A11YWATCH_IMAGE:-darwin/g' docker-compose.a11ywatch-standalone.yaml
+      fi
+  fi
 
 # Advanced usage - yaml files can be read in and then used as go template actions
 # in pre_install_actions and post_install_actions

tests/test.bats

@@ -1,9 +1,9 @@
 setup() {
   set -eu -o pipefail
   export DIR="$( cd "$( dirname "$BATS_TEST_FILENAME" )" >/dev/null 2>&1 && pwd )/.."
-  export TESTDIR=~/tmp/test-addon-template
+  export TESTDIR=~/tmp/test-ddev-a11ywatch-standalone
   mkdir -p $TESTDIR
-  export PROJNAME=test-addon-template
+  export PROJNAME=test-ddev-a11ywatch-standalone
   export DDEV_NON_INTERACTIVE=true
   ddev delete -Oy ${PROJNAME} >/dev/null 2>&1 || true
   cd "${TESTDIR}"
@@ -24,17 +24,18 @@ teardown() {
   echo "# ddev get ${DIR} with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
   ddev get ${DIR}
   ddev restart
-  # Do something here to verify functioning extra service
-  # For extra credit, use a real CMS with actual config.
-  # ddev exec "curl -s elasticsearch:9200" | grep "${PROJNAME}-elasticsearch"
+  # verify add-on scan
+  ddev exec "curl --location --request POST 'https://test-ddev-a11ywatch-standalone.ddev.site:3280/api/scan' --header 'Content-Type: application/json' --data-raw '{ \"url\": \"https://a11ywatch.com\" }'"
+  # verify add-on crawl
+  ddev exec "curl --location --request POST 'https://test-ddev-a11ywatch-standalone.ddev.site:3280/api/crawl' --header 'Content-Type: application/json' --data-raw '{ \"url\": \"https://a11ywatch.com\" }'"
 }
 
 @test "install from release" {
   set -eu -o pipefail
   cd ${TESTDIR} || ( printf "unable to cd to ${TESTDIR}\n" && exit 1 )
-  echo "# ddev get drud/ddev-addon-template with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
-  ddev get drud/ddev-addon-template
+  echo "# ddev get a11ywatch/ddev-a11ywatch with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
+  ddev get a11ywatch/ddev-a11ywatch
   ddev restart >/dev/null
-  # Do something useful here that verifies the add-on
-  # ddev exec "curl -s elasticsearch:9200" | grep "${PROJNAME}-elasticsearch"
+  # verify add-on scan
+  ddev exec "curl --location --request POST 'https://test-ddev-a11ywatch-standalone.ddev.site:3280/api/scan' --header 'Content-Type: application/json' --data-raw '{ 'url': 'https://a11ywatch.com' }'"
 }