Create DDEV Additional Service for Gotenberg

README.md

@@ -1,51 +1,26 @@
-[![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)
+[![tests](https://github.com/echavaillaz/ddev-gotenberg/actions/workflows/tests.yml/badge.svg)](https://github.com/echavaillaz/ddev-gotenberg/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2024.svg)
 
-# ddev-addon-template <!-- omit in toc -->
+## What is ddev-gotenberg?
 
-* [What is ddev-addon-template?](#what-is-ddev-addon-template)
-* [Components of the repository](#components-of-the-repository)
-* [Getting started](#getting-started)
+This repository allows you to quickly install [Gotenberg](https://gotenberg.dev) into a [DDEV](https://ddev.readthedocs.io) project using just `ddev get echavaillaz/ddev-gotenberg`.
 
-## What is ddev-addon-template?
+## Installation
 
-This repository is a template for providing [DDEV](https://ddev.readthedocs.io) add-ons and services.
+1. `ddev get echavaillaz/ddev-gotenberg`
+2. `ddev restart`
 
-In DDEV addons can be installed from the command line using the `ddev get` command, for example, `ddev get ddev/ddev-addon-template` or `ddev get ddev/ddev-drupal9-solr`.
+## Explanation
 
-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.
+This Gotenberg recipe for [DDEV](https://ddev.readthedocs.io) installs a [`.ddev/docker-compose.gotenberg.yaml`](docker-compose.gotenberg.yaml) using the [`gotenberg/gotenberg`](https://hub.docker.com/r/gotenberg/gotenberg) Docker image.
 
-![template button](images/template-button.png)
+## Interacting with Gotenberg
 
-## Components of the repository
+* The Gotenberg instance will listen on TCP port 300 (the Gotenberg default).
+* Configure your application to access Gotenberg on the host:port `gotenberg:3000`.
 
-* 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
+## Resources
 
-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-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/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. 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-drupal9-solr](https://github.com/ddev/ddev-drupal9-solr), [ddev/ddev-memcached](github.com/ddev/ddev-memcached), and [ddev/ddev-beanstalkd](https://github.com/ddev/ddev-beanstalkd).
-12. 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`.
-13. 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.
-
-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).
-
-**Contributed and maintained by [@CONTRIBUTOR](https://github.com/CONTRIBUTOR) based on the original [ddev-contrib recipe](https://github.com/ddev/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/ddev/ddev-contrib/>
+1. [Official documentation](https://gotenberg.dev)
+2. [Official repository](https://github.com/gotenberg/gotenberg)
+3. [Awesome Gotenberg](https://github.com/gotenberg/awesome-gotenberg)

docker-compose.gotenberg.yaml

@@ -0,0 +1,28 @@
+---
+#ddev-generated
+services:
+  gotenberg:
+    command: bash -c 'gotenberg --chromium-ignore-certificate-errors'
+    container_name: ddev-${DDEV_SITENAME}-gotenberg
+    environment:
+      - VIRTUAL_HOST=$DDEV_HOSTNAME
+    expose:
+      - 3000
+    external_links:
+      - ddev-router:${DDEV_SITENAME}.${DDEV_TLD}
+    healthcheck:
+      interval: 60s
+      test: [ CMD, curl, -f, http://gotenberg:3000/health ]
+      timeout: 10s
+    image: gotenberg/gotenberg:latest
+    labels:
+      com.ddev.approot: $DDEV_APPROOT
+      com.ddev.site-name: ${DDEV_SITENAME}
+    restart: 'no'
+    volumes:
+      - ddev_config:/mnt/ddev_config
+  web:
+    links:
+      - gotenberg
+volumes:
+  ddev_config:

install.yaml

@@ -1,81 +1,17 @@
-name: addon-template
+name: gotenberg
 
-# 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
+# List of actions to run before installing the addon.
 pre_install_actions:
-  # Actions with #ddev-nodisplay will not show the execution of the action, but may show their output
-# - |
-  # #ddev-nodisplay
-  #ddev-description:Check architecture type for incompatible arm64 type
-  # 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.
-#  #ddev-nodisplay
-#  #ddev-description:Remove solr volume
-#  if ! ( ddev debug capabilities 2>/dev/null | grep multiple-dockerfiles >/dev/null 2>&1 ) ; then
-#    echo "This add-on requires DDEV v1.19.4 or higher, please upgrade." && exit 2
-#  fi
-#- 'echo "what is your platform.sh token" && read x'
-
-# This item shows templating using DDEV environment variables.
-# -
-#   #ddev-description:Touch a file to create it
-#   touch somefile.${DDEV_PROJECT_TYPE}.${DDEV_DOCROOT}.txt
-#
-
-# This item shows complex go templating possibilities based on yaml_read_files
-#- |
-#- #ddev-description:Create a config.platformsh.yaml
-#  cat <<EOF >.ddev/config.platformsh.yaml
-#  php_version: {{ trimPrefix "php:" .platformapp.type }}
-#  database:
-#    type: {{ regexReplaceAll ":.*$" .services.db.type "" }}
-#    version: {{ regexReplaceAll "^.*:" .services.db.type "" }}
-#
-#  docroot: {{ dig "web" "locations" "/" "root" "notfound" .platformapp }}
-#  {{ if eq .platformapp.build.flavor "composer" }}
-#  hooks:
-#    post-start:
-#      - composer: install
-#  {{ if .platformapp.hooks.deploy }}
-#      - exec: "{{ trimAll "\n" .platformapp.hooks.deploy | splitList "\n" | join ` && ` }}"
-#  {{ end }}
-#  {{ end }}
-#
-#  EOF
-
-# list of files and directories listed that are copied into project .ddev directory
-# Each file should contain #ddev-generated so it can be replaced by a later `ddev get`
-# if it hasn't been modified by the user.
-# DDEV environment variables can be interpolated into these filenames
+# List of files and directories listed that are copied into project .ddev directory
 project_files:
-- docker-compose.addon-template.yaml
-# - extra_files/
-# - somefile.sh
+- docker-compose.gotenberg.yaml
 
 # List of files and directories that are copied into the global .ddev directory
-# DDEV environment variables can be interpolated into these filenames
 global_files:
-# - commands
-# - homeadditions
 
-# DDEV environment variables can be interpolated into these actions
+# List of actions to run after installing the addon.
 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
 
 # Advanced usage - yaml files can be read in and then used as go template actions
-# in pre_install_actions and post_install_actions
-# See example in
-# https://github.com/rfay/ddev/blob/20220606_yaml_read_experiment/cmd/ddev/cmd/testdata/TestCmdGetComplex/recipe/install.yaml
 yaml_read_files:
-# someyaml: someyaml.yaml
-# otheryaml: someotheryaml.yaml

tests/test.bats

@@ -1,22 +1,18 @@
 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-gotenberg
   mkdir -p $TESTDIR
-  export PROJNAME=test-addon-template
+  export PROJNAME=test-gotenberg
   export DDEV_NON_INTERACTIVE=true
   ddev delete -Oy ${PROJNAME} >/dev/null 2>&1 || true
   cd "${TESTDIR}"
+  echo "# Setting up project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
+  cp -R ${DIR}/tests/testdata/* .
   ddev config --project-name=${PROJNAME}
   ddev start -y >/dev/null
 }
 
-health_checks() {
-  # Do something useful here that verifies the add-on
-  # ddev exec "curl -s elasticsearch:9200" | grep "${PROJNAME}-elasticsearch"
-  ddev exec "curl -s https://localhost:443/"
-}
-
 teardown() {
   set -eu -o pipefail
   cd ${TESTDIR} || ( printf "unable to cd to ${TESTDIR}\n" && exit 1 )
@@ -30,15 +26,24 @@ teardown() {
   echo "# ddev get ${DIR} with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
   ddev get ${DIR}
   ddev restart
-  health_checks
+  ddev exec curl --request POST http://gotenberg:3000/forms/chromium/convert/url --form url=https://render.com --output chromium.pdf
+  ddev exec test -s chromium.pdf || ( printf "PDF is empty or cannot be checked" && exit 1 )
+  ddev exec curl --request POST http://gotenberg:3000/forms/libreoffice/convert --form files=@resources/test-libreoffice.docx --output libreoffice.pdf
+  ddev exec test -s libreoffice.pdf || ( printf "PDF is empty or cannot be checked" && exit 1 )
+  ddev exec curl --request POST http://gotenberg:3000/forms/pdfengines/merge --form files=@resources/test-pdfengines-1.pdf --form files=@resources/test-pdfengines-2.pdf --output pdfengines.pdf
+  ddev exec test -s pdfengines.pdf || ( printf "PDF is empty or cannot be checked" && exit 1 )
 }
 
 @test "install from release" {
   set -eu -o pipefail
   cd ${TESTDIR} || ( printf "unable to cd to ${TESTDIR}\n" && exit 1 )
-  echo "# ddev get ddev/ddev-addon-template with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
-  ddev get ddev/ddev-addon-template
+  echo "# ddev get echavaillaz/ddev-gotenberg with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
+  ddev get echavaillaz/ddev-gotenberg
   ddev restart >/dev/null
-  health_checks
+  ddev exec curl --request POST http://gotenberg:3000/forms/chromium/convert/url --form url=https://render.com --output chromium.pdf
+  ddev exec test -s chromium.pdf || ( printf "PDF is empty or cannot be checked" && exit 1 )
+  ddev exec curl --request POST http://gotenberg:3000/forms/libreoffice/convert --form files=@resources/test-libreoffice.docx --output libreoffice.pdf
+  ddev exec test -s libreoffice.pdf || ( printf "PDF is empty or cannot be checked" && exit 1 )
+  ddev exec curl --request POST http://gotenberg:3000/forms/pdfengines/merge --form files=@resources/test-pdfengines-1.pdf --form files=@resources/test-pdfengines-2.pdf --output pdfengines.pdf
+  ddev exec test -s pdfengines.pdf || ( printf "PDF is empty or cannot be checked" && exit 1 )
 }
-