diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..3656ac6 --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,91 @@ +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 + +defaults: + run: + shell: bash + +env: + # NIGHTLY_DDEV_PR_URL: "https://nightly.link/ddev/ddev/actions/runs/1720215802/ddev-linux-amd64.zip" + # Allow ddev get to use a github token to prevent rate limiting by tests + DDEV_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + # Allow `--HEAD` flag when running tests against HEAD + +jobs: + tests: + defaults: + run: + shell: bash + + strategy: + matrix: + ddev_version: [stable, HEAD] +# ddev_version: [stable, edge, HEAD, PR] + fail-fast: false + + runs-on: ubuntu-20.04 + + steps: + - uses: actions/checkout@v3 + - name: Set up Homebrew + id: set-up-homebrew + uses: Homebrew/actions/setup-homebrew@master + - name: Environment setup + run: | + brew install bats-core mkcert + mkcert -install + + - name: Use ddev stable + if: matrix.ddev_version == 'stable' + run: brew install ddev/ddev/ddev + + - name: Use ddev edge + if: matrix.ddev_version == 'edge' + run: brew install ddev/ddev-edge/ddev + + - name: Use ddev HEAD + if: matrix.ddev_version == 'HEAD' + run: brew install --HEAD ddev/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 + + - name: tmate debugging session + uses: mxschmitt/action-tmate@v3 + with: + limit-access-to-actor: true + github-token: ${{ secrets.GITHUB_TOKEN }} + if: github.event.inputs.debug_enabled == 'true' + + - name: tests + run: bats tests + + # keepalive-workflow adds a dummy commit if there's no other action here, keeps + # GitHub from turning off tests after 60 days + - uses: gautamkrishnar/keepalive-workflow@v1 + if: matrix.ddev_version == 'stable' 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/README.md b/README.md new file mode 100644 index 0000000..8780a79 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +[![tests](https://github.com/torhoehn/ddev-typesense/actions/workflows/tests.yml/badge.svg)](https://github.com/torhoehn/ddev-typesense/actions/workflows/tests.yml) ![project is maintained](https://img.shields.io/maintenance/yes/2024.svg) + +## Installation + +Uses [typesense official image](https://hub.docker.com/r/typesense/typesense/) + +`ddev get torhoehn/ddev-typesense` + +## Configuration + +From within the container, the typesense container is reached at hostname: "typesense", port: 8108. + +**Originally Contributed by [torhoehn](https://github.com/torhoehn)** diff --git a/docker-compose.typesense.yaml b/docker-compose.typesense.yaml new file mode 100644 index 0000000..4fbea96 --- /dev/null +++ b/docker-compose.typesense.yaml @@ -0,0 +1,19 @@ +#ddev-generated +services: + typesense: + container_name: ddev-${DDEV_SITENAME}-typesense + image: typesense/typesense:0.25.0 + networks: [default, ddev_default] + restart: on-failure + ports: + - "8108:8108" + labels: + com.ddev.site-name: ${DDEV_SITENAME} + com.ddev.approot: $DDEV_APPROOT + volumes: + - ".:/mnt/ddev_config" + - typesense:/data + command: '--data-dir /data --api-key=xyz --enable-cors' + +volumes: + typesense: diff --git a/install.yaml b/install.yaml new file mode 100644 index 0000000..3e94bbb --- /dev/null +++ b/install.yaml @@ -0,0 +1,87 @@ +# 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: your-addon + +# 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 + #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 <.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 +project_files: +- docker-compose.typesense.yaml +# - extra_files/ +# - somefile.sh + +# 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 +post_install_actions: +# - chmod +x ~/.ddev/commands/web/somecommand +# - touch somefile.${GOOS}.${DDEV_WEBSERVER} +# - perl -pi -e 's/oldstring/newstring/g' docker-compose.typesense.yaml + +# Shell actions that can be done during removal of the add-on +removal_actions: +# - rm ~/.ddev/commands/web/somecommand + +# 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 diff --git a/tests/test.bats b/tests/test.bats new file mode 100644 index 0000000..0d95ae3 --- /dev/null +++ b/tests/test.bats @@ -0,0 +1,41 @@ +setup() { + set -eu -o pipefail + export DIR="$( cd "$( dirname "$BATS_TEST_FILENAME" )" >/dev/null 2>&1 && pwd )/.." + export TESTDIR=~/tmp/test-typesense + mkdir -p $TESTDIR + export PROJNAME=test-typesense + 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 +} + +health_checks() { + ddev exec "curl -s typesense:8108/health" | grep "true" +} + +teardown() { + set -eu -o pipefail + cd ${TESTDIR} || ( printf "unable to cd to ${TESTDIR}\n" && exit 1 ) + ddev delete -Oy ${PROJNAME} >/dev/null 2>&1 + [ "${TESTDIR}" != "" ] && rm -rf ${TESTDIR} +} + +@test "install from directory" { + set -eu -o pipefail + cd ${TESTDIR} + echo "# ddev get ${DIR} with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3 + ddev get ${DIR} + ddev restart + health_checks +} + +@test "install from release" { + set -eu -o pipefail + cd ${TESTDIR} || ( printf "unable to cd to ${TESTDIR}\n" && exit 1 ) + echo "# ddev get torhoehn/ddev-typesense with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3 + ddev get torhoehn/ddev-typesense + ddev restart >/dev/null + health_checks +} diff --git a/tests/testdata/.gitmanaged b/tests/testdata/.gitmanaged new file mode 100644 index 0000000..e69de29