diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..54604ea --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,42 @@ +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 + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +# This is required for "gautamkrishnar/keepalive-workflow", see "ddev/github-action-add-on-test" +permissions: + actions: write + +jobs: + tests: + strategy: + matrix: + ddev_version: [stable, HEAD] + fail-fast: false + + runs-on: ubuntu-latest + + steps: + - uses: ddev/github-action-add-on-test@v2 + 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/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..2880389 --- /dev/null +++ b/README.md @@ -0,0 +1,93 @@ +[![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) + +# ddev-addon-template + +* [What is ddev-addon-template?](#what-is-ddev-addon-template) +* [Components of the repository](#components-of-the-repository) +* [Getting started](#getting-started) +* [How to debug in Github Actions](#how-to-debug-tests-github-actions) + +## What is ddev-addon-template? + +This repository is a template for providing [DDEV](https://ddev.readthedocs.io) add-ons and services. + +In DDEV addons can be installed from the command line using the `ddev get` command, for example, `ddev get ddev/ddev-redis` or `ddev get ddev/ddev-solr`. + +This repository is a quick 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. + +![template button](images/template-button.png) + +## Components of the repository + +* 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--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 replace `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/latest/users/extend/custom-commands/#environment-variables-provided). + +6. Update `tests/test.bats` to provide a reasonable test for your repository. Tests are triggered either by manually executing `bats ./tests/test.bats`, automatically on every push to the repository, or periodically each night. 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. To run a Bats test locally, you have to [install bats-core](https://bats-core.readthedocs.io/en/stable/installation.html) first. Then you download your add-on, and finally run `bats ./tests/test.bats` within the root of the uncompressed directory. To learn more about Bats see the [documentation](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](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) on GitHub. +9. Test manually with `ddev get `. +10. You can test PRs with `ddev get https://github.com///tarball/` +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-solr](https://github.com/ddev/ddev-solr), [ddev/ddev-memcached](https://github.com/ddev/ddev-memcached), and (advanced) [ddev-platformsh](https://github.com/ddev/ddev-platformsh). +12. Update the `README.md` header in Title Case format, for example, use `# DDEV Redis`, not `# ddev-redis`. +13. Add a good short description to your repo, and add the [topic](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics) "ddev-get". It will immediately be added to the list provided by `ddev get --list --all`. +14. 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. + +Add-ons were covered in [DDEV Add-ons: Creating, maintaining, testing](https://www.dropbox.com/scl/fi/bnvlv7zswxwm8ix1s5u4t/2023-11-07_DDEV_Add-ons.mp4?rlkey=5cma8s11pscxq0skawsoqrscp&dl=0) (part of the [DDEV Contributor Live Training](https://ddev.com/blog/contributor-training)). + +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). + +## How to debug tests (Github Actions) + +1. You need an SSH-key registered with GitHub. You either pick the key you have already used with `github.com` or you create a dedicated new one with `ssh-keygen -t ed25519 -a 64 -f tmate_ed25519 -C "$(date +'%d-%m-%Y')"` and add it at `https://github.com/settings/keys`. + +2. Add the following snippet to `~/.ssh/config`: + +``` +Host *.tmate.io + User git + AddKeysToAgent yes + UseKeychain yes + PreferredAuthentications publickey + IdentitiesOnly yes + IdentityFile ~/.ssh/tmate_ed25519 +``` +3. Go to `https://github.com///actions/workflows/tests.yml`. + +4. Click the `Run workflow` button and you will have the option to select the branch to run the workflow from and activate `tmate` by checking the `Debug with tmate` checkbox for this run. + +![tmate](images/gh-tmate.jpg) + +5. After the `workflow_dispatch` event was triggered, click the `All workflows` link in the sidebar and then click the `tests` action in progress workflow. + +7. Pick one of the jobs in progress in the sidebar. + +8. Wait until the current task list reaches the `tmate debugging session` section and the output shows something like: + +``` +106 SSH: ssh PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io +107 or: ssh -i PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io +108 SSH: ssh PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io +109 or: ssh -i PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io +``` + +9. Copy and execute the first option `ssh PRbaS7SLVxbXImhjUqydQBgDL@nyc1.tmate.io` in the terminal and continue by pressing either q or Ctrl + c. + +10. Start the Bats test with `bats ./tests/test.bats`. + +For a more detailed documentation about `tmate` see [Debug your GitHub Actions by using tmate](https://mxschmitt.github.io/action-tmate/). + +**Contributed and maintained by [@CONTRIBUTOR](https://github.com/CONTRIBUTOR)** diff --git a/docker-compose.addon-template.yaml b/docker-compose.addon-template.yaml new file mode 100644 index 0000000..7c9844e --- /dev/null +++ b/docker-compose.addon-template.yaml @@ -0,0 +1,17 @@ +#ddev-generated +# Simple template to demonstrate addon-template +services: + addon-template: + container_name: ddev-${DDEV_SITENAME}-addon-template + image: busybox:stable + command: tail -f /dev/null + networks: [default, ddev_default] + restart: "no" + # 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" + - "ddev-global-cache:/mnt/ddev-global-cache" diff --git a/images/gh-tmate.jpg b/images/gh-tmate.jpg new file mode 100644 index 0000000..71b11e8 Binary files /dev/null and b/images/gh-tmate.jpg differ diff --git a/images/template-button.png b/images/template-button.png new file mode 100644 index 0000000..7bc5113 Binary files /dev/null and b/images/template-button.png differ diff --git a/install.yaml b/install.yaml new file mode 100644 index 0000000..3544202 --- /dev/null +++ b/install.yaml @@ -0,0 +1,95 @@ +# 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: addon-template + +# 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 [ "$(uname -m)" = "arm64" -o "$(uname -m)" = "aarch64" ]; then + # echo "This package does not work on arm64 (Apple Silicon) 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 +# If you use directories, they must be directories that are managed +# by this add-on, or removal could remove things that are not owned by it +project_files: +- docker-compose.addon-template.yaml +# - some-directory/file1.txt +# - some-directory/file2.txt +# - extra_files_dir_created_by_this_template/ +# - 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/web/add-on-command +# - homeadditions/some-file.txt + +# List of add-on names that this add-on depends on +dependencies: +# - redis + +# 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 + +# 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..b41afac --- /dev/null +++ b/tests/test.bats @@ -0,0 +1,44 @@ +setup() { + set -eu -o pipefail + export DIR="$( cd "$( dirname "$BATS_TEST_FILENAME" )" >/dev/null 2>&1 && pwd )/.." + export TESTDIR=~/tmp/test-addon-template + mkdir -p $TESTDIR + export PROJNAME=test-addon-template + 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() { + # 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 ) + 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 ddev/ddev-addon-template with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3 + ddev get ddev/ddev-addon-template + ddev restart >/dev/null + health_checks +} + diff --git a/tests/testdata/.gitmanaged b/tests/testdata/.gitmanaged new file mode 100644 index 0000000..e69de29