diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..3191904 --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,38 @@ +name: tests +on: + pull_request: + push: + branches: [ main ] + + schedule: + - cron: '25 08 * * *' + + workflow_dispatch: + inputs: + debug_enabled: + type: boolean + description: Debug with tmate + required: false + default: false + +# This is required for "gautamkrishnar/keepalive-workflow" +permissions: + contents: write + +jobs: + tests: + strategy: + matrix: + ddev_version: [stable, HEAD] + fail-fast: false + + runs-on: ubuntu-latest + + steps: + - uses: ddev/github-action-add-on-test@v1 + with: + ddev_version: ${{ matrix.ddev_version }} + token: ${{ secrets.GITHUB_TOKEN }} + debug_enabled: ${{ github.event.inputs.debug_enabled }} + addon_repository: ${{ env.GITHUB_REPOSITORY }} + addon_ref: ${{ env.GITHUB_REF }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a09c56d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/.idea diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/docker-compose.stirling-pdf.yaml b/docker-compose.stirling-pdf.yaml new file mode 100644 index 0000000..bb020a9 --- /dev/null +++ b/docker-compose.stirling-pdf.yaml @@ -0,0 +1,28 @@ +#ddev-generated +services: + stirling-pdf: + container_name: ddev-${DDEV_SITENAME}-stirling-pdf + hostname: ${DDEV_SITENAME}-stirling-pdf + image: frooodle/s-pdf:latest + labels: + com.ddev.site-name: ${DDEV_SITENAME} + com.ddev.approot: $DDEV_APPROOT + healthcheck: + test: [ "CMD-SHELL", "curl -f http://localhost:8080/api/v1/info/status | grep -q 'UP' && curl -fL http://localhost:8080/ | grep -q 'Please sign in'" ] + interval: 5s + timeout: 10s + retries: 20 + environment: + - VIRTUAL_HOST=$DDEV_HOSTNAME + - HTTP_EXPOSE=8060:8080 + - HTTPS_EXPOSE=8064:8080 + # For setup steps see https://github.com/Stirling-Tools/Stirling-PDF?tab=readme-ov-file#customisation + - DOCKER_ENABLE_SECURITY=true + - INSTALL_BOOK_AND_ADVANCED_HTML_OPS=true + - SECURITY_INITIALLOGIN_USERNAME=stirling + - SECURITY_INITIALLOGIN_PASSWORD=stirling + volumes: + - ".:/mnt/ddev_config" + - "./stirling-pdf/trainingData:/usr/share/tessdata" + - "./stirling-pdf/extraConfigs:/configs" + - "./stirling-pdf/customFiles:/customFiles" diff --git a/install.yaml b/install.yaml new file mode 100644 index 0000000..17ed6d9 --- /dev/null +++ b/install.yaml @@ -0,0 +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: stirling-pdf + +project_files: + - docker-compose.stirling-pdf.yaml + - stirling-pdf diff --git a/stirling-pdf/.gitignore b/stirling-pdf/.gitignore new file mode 100644 index 0000000..0ce26a4 --- /dev/null +++ b/stirling-pdf/.gitignore @@ -0,0 +1,4 @@ +#ddev-generated +./trainingData +./customFiles +./extraConfigs/ddev-stirling-pdf-DB.trace.db diff --git a/stirling-pdf/extraConfigs/settings.yml b/stirling-pdf/extraConfigs/settings.yml new file mode 100644 index 0000000..01b9b64 --- /dev/null +++ b/stirling-pdf/extraConfigs/settings.yml @@ -0,0 +1,24 @@ +#ddev-generated +security: + enableLogin: true # Enable or disable login + csrfDisabled: true + +system: + defaultLocale: 'en-US' # Set the default language (e.g. 'de-DE', 'fr-FR', etc) + googlevisibility: false # 'true' to allow Google visibility (via robots.txt), 'false' to disallow + customStaticFilePath: '/customFiles/' # Directory path for custom static files + +ui: + appName: DDEV-StirlingPdf # Application's visible name + homeDescription: DDEV Local Stirling PDF instance # Short description or tagline shown on homepage. + appNameNavbar: DDEV # Name displayed on the navigation bar + +endpoints: + toRemove: [] # List endpoints to disable (e.g. ['img-to-pdf', 'remove-pages']) + groupsToRemove: [] # List groups to disable (e.g. ['LibreOffice']) + +metrics: + enabled: true # 'true' to enable Info APIs endpoints (view http://localhost:8080/swagger-ui/index.html#/API to learn more), 'false' to disable + + +# wget https://repo1.maven.org/maven2/com/h2database/h2/2.2.224/h2-2.2.224.jar -o h2.jar diff --git a/tests/setup_suite.bash b/tests/setup_suite.bash new file mode 100644 index 0000000..a6bc8e4 --- /dev/null +++ b/tests/setup_suite.bash @@ -0,0 +1,28 @@ +#!/usr/bin/env bats + +setup_suite() { + export DIR="$( cd "$( dirname "$BATS_TEST_FILENAME" )" >/dev/null 2>&1 && pwd )" + set -eu -o pipefail + export TESTDIR=~/tmp/test-stirling-pdf-addon + mkdir -p $TESTDIR + export PROJNAME=test-addon-stirling-pdf + export DDEV_NON_INTERACTIVE=true + + ddev delete -Oy ${PROJNAME} >/dev/null 2>&1 || true + cd "${TESTDIR}" + ddev config --project-name=${PROJNAME} + ddev start -y >/dev/null + + echo "# ddev get ${DIR} with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3 + ddev get "${DIR}/.." + cp -rf "$DIR" "$TESTDIR/" + cp -rf "$DIR/testdata/stirling-pdf-DB.mv.db" "$TESTDIR/.ddev/stirling-pdf/extraConfigs/" + ddev restart -y >/dev/null +} + +teardown_suite() { + set -eu -o pipefail + cd ${TESTDIR} || ( printf "unable to cd to ${TESTDIR}\n" && exit 1 ) + ddev delete -Oy ${PROJNAME} >/dev/null 2>&1 + [ "${TESTDIR}" != "" ] && sudo rm -rf ${TESTDIR} +} diff --git a/tests/test.bats b/tests/test.bats new file mode 100644 index 0000000..ed10712 --- /dev/null +++ b/tests/test.bats @@ -0,0 +1,17 @@ +#!/bin/bash + +@test "Send request from 'web' to the Stirling PDF api" { + run ddev exec "curl -X 'GET' 'http://stirling-pdf:8080/api/v1/info/status' -H 'accept: */*'" + + [ "$status" -eq 0 ] + [[ "$output" == *"\"status\":\"UP\"}"* ]] +} + +@test "Send request to an endpoint that requires authentication" { + apiKey="16131b6c-c7b0-468f-b35c-9bfd5a613d9d" + run ddev exec "curl -X 'POST' 'http://stirling-pdf:8080/api/v1/security/get-info-on-pdf' -s -H 'X-API-KEY: ${apiKey}' -H 'accept: */*' -H 'Content-Type: multipart/form-data' -F 'fileInput=@tests/testdata/Test.pdf;type=application/pdf'" + + [ "$status" -eq 0 ] + [[ "$(echo "$output" | yq ".Metadata.Producer")" == *"Acrobat Distiller 4.0 for Windows"* ]] + [[ "$(echo "$output" | yq ".BasicInfo.FileSizeInBytes")" == *"80387"* ]] +} diff --git a/tests/testdata/Test.pdf b/tests/testdata/Test.pdf new file mode 100644 index 0000000..de7e4e7 Binary files /dev/null and b/tests/testdata/Test.pdf differ diff --git a/tests/testdata/stirling-pdf-DB.mv.db b/tests/testdata/stirling-pdf-DB.mv.db new file mode 100755 index 0000000..b1bb2f4 Binary files /dev/null and b/tests/testdata/stirling-pdf-DB.mv.db differ