Create DDEV Additional Service for PdfReactor

.github/workflows/tests.yml

@@ -41,37 +41,30 @@ jobs:
       run: |
         brew install bats-core mkcert
         mkcert -install
-
     - name: Use ddev stable
       if: matrix.ddev_version == 'stable'
       run: brew install drud/ddev/ddev
-
     - name: Use ddev edge
       if: matrix.ddev_version == 'edge'
       run: brew install drud/ddev-edge/ddev
-
     - name: Use ddev HEAD
       if: matrix.ddev_version == 'HEAD'
       run: brew install --HEAD drud/ddev/ddev
-
     - name: Use ddev PR
       if: matrix.ddev_version == 'PR'
       run: |
         curl -sSL -o ddev_linux.zip ${NIGHTLY_DDEV_PR_URL}
         unzip ddev_linux.zip
         mv ddev /usr/local/bin/ddev && chmod +x /usr/local/bin/ddev
-
     - name: Download docker images
       run: | 
         mkdir junk && pushd junk && ddev config --auto && ddev debug download-images >/dev/null
-        docker pull memcached:1.6 >/dev/null
+        docker pull realobjects/pdfreactor >/dev/null
     - name: tmate debugging session
       uses: mxschmitt/action-tmate@v3
       with:
         limit-access-to-actor: true
         github-token: ${{ secrets.GITHUB_TOKEN }}
       if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled }}
-
     - name: tests
-      run: bats tests
-
+      run: bats --verbose-run tests

README.md

@@ -1,42 +1,21 @@
-[![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/2022.svg)
+[![tests](https://github.com/blankse/ddev-pdfreactor/actions/workflows/tests.yml/badge.svg)](https://github.com/blankse/ddev-pdfreactor/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2022.svg)
 
-## What is ddev-addon-template?
+## What is ddev-pdfreactor?
 
-This repository is a template for providing [DDEV](https://ddev.readthedocs.io) addons and services.
+This repository allows you to quickly install [PDFreactor](https://www.pdfreactor.com/) into a [Ddev](https://ddev.readthedocs.io) project using just `ddev get blankse/ddev-pdfreactor`.
 
-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 blankse/ddev-pdfreactor`
+2. `ddev restart`
 
-![template button](images/template-button.png)
+## Explanation
 
-## Components of the repository
+This pdfreactor recipe for [ddev](https://ddev.readthedocs.io) installs a [`.ddev/docker-compose.pdfreactor.yaml`](docker-compose.pdfreactor.yaml) using the [`realobjects/pdfreactor`](https://hub.docker.com/r/realobjects/pdfreactor/) 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.
-
-## 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 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](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.
-
-**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/...)
+## Interacting with PDFreactor
 
+* The PDFreactor instance will listen on TCP port 9423 (the PDFreactor default).
+* Configure your application to access PDFreactor on the host:port `pdfreactor:9423`.
 
+**Contributed and maintained by [@blankse](https://github.com/blankse)**

docker-compose.pdfreactor.yaml

@@ -0,0 +1,12 @@
+version: '3.6'
+services:
+  pdfreactor:
+    container_name: ddev-${DDEV_SITENAME}-pdfreactor
+    image: realobjects/pdfreactor
+    # These labels ensure this service is discoverable by ddev.
+    labels:
+      com.ddev.site-name: ${DDEV_SITENAME}
+      com.ddev.approot: $DDEV_APPROOT
+    volumes:
+    - ".:/mnt/ddev_config"
+    - "./pdfreactor:/ro/config"

install.yaml

@@ -1,23 +1,16 @@
-name: addon-template
+name: pdfreactor
 
 # 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.
 pre_install_actions:
-# - '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"
 
 # 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.pdfreactor.yaml
+- pdfreactor/
 
 # List of files and directories that are copied into the global .ddev directory
 global_files:
-# - commands
-# - homeadditions
 
 post_install_actions:
-# - chmod +x ~/.ddev/commands/web/somecommand
-# - perl -pi -e 's/oldstring/newstring/g' docker-compose.addon-template.yaml

tests/test.bats

@@ -1,14 +1,18 @@
 setup() {
   set -eu -o pipefail
   export DIR="$( cd "$( dirname "$BATS_TEST_FILENAME" )" >/dev/null 2>&1 && pwd )/.."
-  export TESTDIR=~/tmp/testelasticsearch
+  export TESTDIR=~/tmp/testpdfreactor
   mkdir -p $TESTDIR
-  export PROJNAME=test-addon-template
+  export PROJNAME=test-pdfreactor
   export DDEV_NON_INTERACTIVE=true
   ddev delete -Oy ${PROJNAME} || true
   cd "${TESTDIR}"
-  ddev config --project-name=${PROJNAME}
-  ddev start
+  ddev config --project-name=${PROJNAME} --project-type=php --docroot=public --webserver-type=apache-fpm --create-docroot --php-version=8.0 --database=mariadb:10.5
+  echo "# Setting up Pimcore project via composer ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
+  ddev composer create -y -n pimcore/demo
+  ddev exec php vendor/pimcore/pimcore/bin/pimcore-install --admin-username admin --admin-password demo --mysql-host-socket db --mysql-username db --mysql-password db --mysql-database db --no-interaction
+  cp ${DIR}/tests/testdata/web2print.php var/config/web2print.php
+  cp ${DIR}/tests/testdata/PdfReactorCommand.php src/Command/PdfReactorCommand.php
 }
 
 teardown() {
@@ -24,16 +28,14 @@ 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"
+  ddev php bin/console app:pdf-reactor
 }
 
 @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
+  ddev get blankse/pdfreactor
   ddev restart
-  # ddev exec "curl -s elasticsearch:9200" | grep "${PROJNAME}-elasticsearch"
+  ddev php bin/console app:pdf-reactor
 }

tests/testdata/PdfReactorCommand.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace App\Command;
+
+use Pimcore\Console\AbstractCommand;
+use Pimcore\Web2Print\Processor;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ExportPdfReactorCommand extends AbstractCommand
+{
+    protected function configure(): void
+    {
+        $this->setName('app:pdf-reactor');
+    }
+
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     *
+     * @return int
+     *
+     * @throws \Exception
+     */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $pdf = Processor::getInstance()->startPdfGeneration(75);
+
+        if ($pdf) {
+            return 0;
+        }
+
+        return 1;
+    }
+}

tests/testdata/web2print.php

@@ -0,0 +1,16 @@
+<?php
+
+return [
+    "enableInDefaultView" => TRUE,
+    "generalTool" => "pdfreactor",
+    "generalDocumentSaveMode" => "default",
+    "pdfreactorVersion" => "10.0",
+    "pdfreactorProtocol" => "http",
+    "pdfreactorServer" => "pdfreactor",
+    "pdfreactorServerPort" => "9423",
+    "pdfreactorBaseUrl" => "",
+    "pdfreactorApiKey" => "",
+    "pdfreactorLicence" => "",
+    "pdfreactorEnableLenientHttpsMode" => FALSE,
+    "pdfreactorEnableDebugMode" => FALSE,
+];