├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.yml │ └── feature_request.yml ├── PULL_REQUEST_TEMPLATE.md └── workflows │ └── tests.yml ├── .gitignore ├── LICENSE ├── README.md ├── install.yaml ├── tests ├── test.bats └── testdata │ └── .gitmanaged └── web-build ├── Dockerfile.ddev-cron ├── cron.conf └── time.cron.example /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | name: 🐞 Bug report or Support Request 2 | description: Create a report to help us improve. 3 | labels: [bug] 4 | body: 5 | - type: checkboxes 6 | attributes: 7 | label: Preliminary checklist 8 | description: Please complete the following checks before submitting an issue. 9 | options: 10 | - label: I am using the latest stable version of DDEV 11 | required: true 12 | - label: I am using the latest stable version of this add-on 13 | required: true 14 | - type: textarea 15 | attributes: 16 | label: Expected Behavior 17 | description: What did you expect to happen? 18 | validations: 19 | required: true 20 | - type: textarea 21 | attributes: 22 | label: Actual Behavior 23 | description: What actually happened instead? 24 | validations: 25 | required: true 26 | - type: textarea 27 | attributes: 28 | label: Steps To Reproduce 29 | description: Specific steps to reproduce the behavior. 30 | placeholder: | 31 | 1. In this environment... 32 | 2. With this config... 33 | 3. Run `...` 34 | 4. See error... 35 | validations: 36 | required: false 37 | - type: textarea 38 | attributes: 39 | label: Anything else? 40 | description: | 41 | Links? References? Screenshots? Anything that will give us more context about your issue! 42 | 43 | 💡 Attach images or log files by clicking this area to highlight it and dragging files in. 44 | validations: 45 | required: false 46 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.yml: -------------------------------------------------------------------------------- 1 | name: 🚀 Feature request 2 | description: Suggest an idea for this project. 3 | labels: [enhancement] 4 | body: 5 | - type: checkboxes 6 | attributes: 7 | label: Is there an existing issue for this? 8 | description: Please search existing issues to see if one already exists for your request. 9 | options: 10 | - label: I have searched the existing issues 11 | required: true 12 | - type: textarea 13 | attributes: 14 | label: Is your feature request related to a problem? 15 | description: Clearly and concisely describe the problem. (Ex. I'm always frustrated when...) 16 | validations: 17 | required: true 18 | - type: textarea 19 | attributes: 20 | label: Describe your solution 21 | description: Clearly and concisely describe what you want to happen. 22 | validations: 23 | required: true 24 | - type: textarea 25 | attributes: 26 | label: Describe alternatives 27 | description: Clearly and concisely describe any alternative solutions or features you've considered. 28 | validations: 29 | required: false 30 | - type: textarea 31 | attributes: 32 | label: Additional context 33 | description: Add any other context or screenshots about the feature request. 34 | validations: 35 | required: false 36 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## The Issue 2 | 3 | - # 4 | 5 | 6 | 7 | ## How This PR Solves The Issue 8 | 9 | ## Manual Testing Instructions 10 | 11 | ```bash 12 | ddev add-on get https://github.com///tarball/ 13 | ddev restart 14 | ``` 15 | 16 | ## Automated Testing Overview 17 | 18 | 19 | 20 | ## Release/Deployment Notes 21 | 22 | 23 | -------------------------------------------------------------------------------- /.github/workflows/tests.yml: -------------------------------------------------------------------------------- 1 | name: tests 2 | on: 3 | pull_request: 4 | push: 5 | branches: [ main ] 6 | 7 | schedule: 8 | - cron: '25 08 * * *' 9 | 10 | workflow_dispatch: 11 | inputs: 12 | debug_enabled: 13 | type: boolean 14 | description: Debug with tmate 15 | required: false 16 | default: false 17 | 18 | concurrency: 19 | group: ${{ github.workflow }}-${{ github.ref }} 20 | cancel-in-progress: true 21 | 22 | # This is required for "gautamkrishnar/keepalive-workflow", see "ddev/github-action-add-on-test" 23 | permissions: 24 | actions: write 25 | 26 | jobs: 27 | tests: 28 | strategy: 29 | matrix: 30 | ddev_version: [stable, HEAD] 31 | fail-fast: false 32 | 33 | runs-on: ubuntu-latest 34 | 35 | steps: 36 | - uses: ddev/github-action-add-on-test@v2 37 | with: 38 | ddev_version: ${{ matrix.ddev_version }} 39 | token: ${{ secrets.GITHUB_TOKEN }} 40 | debug_enabled: ${{ github.event.inputs.debug_enabled }} 41 | addon_repository: ${{ env.GITHUB_REPOSITORY }} 42 | addon_ref: ${{ env.GITHUB_REF }} 43 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.idea 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![add-on registry](https://img.shields.io/badge/DDEV-Add--on_Registry-blue)](https://addons.ddev.com) 2 | [![tests](https://github.com/ddev/ddev-cron/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/ddev/ddev-cron/actions/workflows/tests.yml?query=branch%3Amain) 3 | [![last commit](https://img.shields.io/github/last-commit/ddev/ddev-cron)](https://github.com/ddev/ddev-cron/commits) 4 | [![release](https://img.shields.io/github/v/release/ddev/ddev-cron)](https://github.com/ddev/ddev-cron/releases/latest) 5 | 6 | # DDEV Cron 7 | 8 | - [Overview](#overview) 9 | - [Installation](#installation) 10 | - [Usage](#usage) 11 | - [\*.cron](#cron) 12 | - [Useful sites and debugging](#useful-sites-and-debugging) 13 | - [Examples](#examples) 14 | - [Logging current time](#logging-current-time) 15 | - [Drupal cron](#drupal-cron) 16 | - [Laravel cron](#laravel-cron) 17 | - [OpenMage cron](#openmage-cron) 18 | - [TYPO3 scheduler](#typo3-scheduler) 19 | - [WordPress cron](#wordpress-cron) 20 | - [Credits](#credits) 21 | 22 | ## Overview 23 | 24 | The [cron command-line utility](https://en.wikipedia.org/wiki/Cron) is a job scheduler on Unix-like operating systems. 25 | 26 | This add-on: 27 | 28 | - Helps to execute a command in the web container based on a cron schedule. 29 | - Installs and runs the cron service inside the web container. 30 | - Adds an example job that writes out the current time. 31 | 32 | *This extension is designed to be a generic implementation. See [Running TYPO3 Cron inside the web container](https://github.com/ddev/ddev-contrib/tree/master/recipes/cronjob) for a specific example of a manual setup.* 33 | 34 | ## Installation 35 | 36 | To install this add-on, run: 37 | 38 | ```bash 39 | ddev add-on get ddev/ddev-cron 40 | # modify/rename/adjust the time.cron file for your needs 41 | cp .ddev/web-build/time.cron.example .ddev/web-build/time.cron 42 | ddev restart 43 | ``` 44 | 45 | After installation, make sure to commit the `.ddev` directory to version control. 46 | 47 | ## Usage 48 | 49 | This extension does the following: 50 | 51 | - Adds required cron service to the web container. 52 | - Configures the cron service using `.ddev/web-build/cron.conf`. 53 | - Adds all `.ddev/web-build/*.cron` files to crontab scheduler. 54 | 55 | ### *.cron 56 | 57 | This addon uses `*.cron` files to populate crontab. This allows projects to track and manage cron jobs via git. 58 | 59 | On `ddev start`, all `.ddev/web-build/*.cron` files are: 60 | 61 | - Copied into the `/etc/cron.d`. 62 | - Have their permissions updated. 63 | - Added to crontab. 64 | 65 | See `.ddev/web-build/time.cron.example` and [Examples](#examples) section below for specific example. 66 | 67 | ## Useful sites and debugging 68 | 69 | - [crontab guru](https://crontab.guru/) is a helpful for generating cron schedule expressions. 70 | - For `crontab` usage, see [crontab man page](https://manpages.debian.org/buster/cron/crontab.1.en.html). 71 | - Check crontab by running `ddev exec crontab -l`. 72 | - If you want the cron to run on your local time instead of UTC, make sure to set `timezone` in your `.ddev/config.yaml`. 73 | - To help debug, connect to the web container session (`ddev ssh`) and manually run the commands to confirm expected results. 74 | - If you are running a CMS command that requires access to the database, set the environment variable `IS_DDEV_PROJECT=true` 75 | 76 | ## Examples 77 | 78 | The following examples are provide as guides. 79 | PRs are welcome for changes and updates for current best practices for specific frameworks. 80 | 81 | ### Logging current time 82 | 83 | This addon provides an example that can check if the cron service is running. 84 | Every minute, it writes the current time (UTC timezone) to `./time.log`. 85 | 86 | - Rename `.ddev/web-build/time.cron.example` to `.ddev/web-build/time.cron` 87 | - Restart the DDEV project to start the time example. 88 | - After at least a minute, you should see `./time.log` containing the web container's current time. 89 | 90 | ### Drupal cron 91 | 92 | - Create a `./.ddev/web-build/drupal.cron` file 93 | - Add the following code to run the drupal scheduler every 10 minutes and write to a log file. 94 | - `DDEV_PHP_VERSION` value must match your project's PHP version. 95 | 96 | ```cron 97 | */10 * * * * IS_DDEV_PROJECT=true DDEV_PHP_VERSION=8.1 /var/www/html/vendor/bin/drush cron | tee -a /var/www/html/cron-log.txt 98 | ``` 99 | 100 | ### Laravel cron 101 | 102 | - Create a `./.ddev/web-build/laravel.cron` file 103 | - Add the following code to run the laravel scheduler every minute. 104 | 105 | ```cron 106 | * * * * * cd /var/www/html && IS_DDEV_PROJECT=true php artisan schedule:run >> /dev/null 2>&1 107 | ``` 108 | 109 | ### OpenMage cron 110 | 111 | - Create a `./.ddev/web-build/openmage.cron` file 112 | - Add the following code to run the OpenMage scheduler every minute. 113 | 114 | ```cron 115 | * * * * * /var/www/html/cron.sh 116 | ``` 117 | 118 | ### TYPO3 scheduler 119 | 120 | - Create a `./.ddev/web-build/typo3.cron` file 121 | - Add the following code to run the typo3 scheduler every minute and write to a log file. 122 | 123 | ```cron 124 | * * * * * cd /var/www/html && IS_DDEV_PROJECT=true vendor/bin/typo3 scheduler:run -vv | tee -a /var/www/html/scheduler-log.txt 125 | ``` 126 | 127 | ### WordPress cron 128 | 129 | - Create a `./.ddev/web-build/wordpress.cron` file 130 | - Add the following code to trigger the WordPress scheduler. 131 | 132 | ```cron 133 | */15 * * * * IS_DDEV_PROJECT=true DDEV_PHP_VERSION=8.1 cd /var/www/html && /usr/local/bin/wp cron event run --due-now 2>&1 | tee -a /var/www/html/cron.log 134 | ``` 135 | 136 | - This configuration will run the WordPress scheduler every 15 minutes and will create a `cron.log` file in the root of your project 137 | 138 | ## Credits 139 | 140 | **Contributed and maintained by [@tyler36](https://github.com/tyler36) based on the original [Running TYPO3 Cron inside the web container](https://github.com/ddev/ddev-contrib/tree/master/recipes/cronjob) by [@thomaskieslich](https://github.com/thomaskieslich)** 141 | 142 | **Originally contributed by [@thomaskieslich](https://github.com/thomaskieslich) in )** 143 | -------------------------------------------------------------------------------- /install.yaml: -------------------------------------------------------------------------------- 1 | name: ddev-cron 2 | 3 | project_files: 4 | - web-build/Dockerfile.ddev-cron 5 | - web-build/cron.conf 6 | - web-build/time.cron.example 7 | 8 | ddev_version_constraint: '>= v1.24.3' 9 | -------------------------------------------------------------------------------- /tests/test.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | # Bats is a testing framework for Bash 4 | # Documentation https://bats-core.readthedocs.io/en/stable/ 5 | # Bats libraries documentation https://github.com/ztombol/bats-docs 6 | 7 | # For local tests, install bats-core, bats-assert, bats-file, bats-support 8 | # And run this in the add-on root directory: 9 | # bats ./tests/test.bats 10 | # To exclude release tests: 11 | # bats ./tests/test.bats --filter-tags '!release' 12 | # For debugging: 13 | # bats ./tests/test.bats --show-output-of-passing-tests --verbose-run --print-output-on-failure 14 | 15 | setup() { 16 | set -eu -o pipefail 17 | 18 | # Override this variable for your add-on: 19 | export GITHUB_REPO=ddev/ddev-cron 20 | 21 | TEST_BREW_PREFIX="$(brew --prefix 2>/dev/null || true)" 22 | export BATS_LIB_PATH="${BATS_LIB_PATH}:${TEST_BREW_PREFIX}/lib:/usr/lib/bats" 23 | bats_load_library bats-assert 24 | bats_load_library bats-file 25 | bats_load_library bats-support 26 | 27 | export DIR="$(cd "$(dirname "${BATS_TEST_FILENAME}")/.." >/dev/null 2>&1 && pwd)" 28 | export PROJNAME="test-$(basename "${GITHUB_REPO}")" 29 | mkdir -p ~/tmp 30 | export TESTDIR=$(mktemp -d ~/tmp/${PROJNAME}.XXXXXX) 31 | export DDEV_NONINTERACTIVE=true 32 | export DDEV_NO_INSTRUMENTATION=true 33 | ddev delete -Oy "${PROJNAME}" >/dev/null 2>&1 || true 34 | cd "${TESTDIR}" 35 | run ddev config --project-name="${PROJNAME}" --project-tld=ddev.site 36 | assert_success 37 | run ddev start -y 38 | assert_success 39 | echo "# ddev started at $(date)" >&3 40 | } 41 | 42 | health_checks() { 43 | # Make sure cron process is running. 44 | # We use `time_cron_checks` to check the example cron job is actually correctly implemented. 45 | # This is due to the need to test the health-check when there are no jobs added. 46 | run ddev exec 'sudo killall -0 cron' 47 | assert_success 48 | } 49 | 50 | time_cron_checks() { 51 | # ASSERT time.log was written to 52 | grep UTC time.log 53 | 54 | # ASSERT job displays under current user's crontab 55 | ddev exec crontab -l | grep '* * * * * date | tee -a /var/www/html/time.log' 56 | } 57 | 58 | teardown() { 59 | set -eu -o pipefail 60 | ddev delete -Oy ${PROJNAME} >/dev/null 2>&1 61 | [ "${TESTDIR}" != "" ] && rm -rf ${TESTDIR} 62 | } 63 | 64 | @test "install from directory" { 65 | set -eu -o pipefail 66 | echo "# ddev add-on get ${DIR} with project ${PROJNAME} in $(pwd)" >&3 67 | run ddev add-on get "${DIR}" 68 | 69 | # Set the example cron job as an actual cron job. 70 | mv ./.ddev/web-build/time.cron.example ./.ddev/web-build/time.cron 71 | 72 | run ddev restart -y 73 | assert_success 74 | 75 | # The example runs every minute so we should wait at least the length. 76 | sleep 61 77 | 78 | # Check service works 79 | health_checks 80 | 81 | # Check example cron job works 82 | time_cron_checks 83 | } 84 | 85 | # bats test_tags=release 86 | @test "install from release" { 87 | set -eu -o pipefail 88 | echo "# ddev add-on get ${GITHUB_REPO} with project ${PROJNAME} in $(pwd)" >&3 89 | run ddev add-on get "${GITHUB_REPO}" 90 | 91 | # Set the example cron job as an actual cron job. 92 | mv ./.ddev/web-build/time.cron.example ./.ddev/web-build/time.cron 93 | 94 | run ddev restart -y 95 | assert_success 96 | 97 | # The example runs every minute so we should wait at least the length. 98 | sleep 61 99 | 100 | # Check service works 101 | health_checks 102 | 103 | # Check example cron job works 104 | time_cron_checks 105 | } 106 | 107 | @test "services work when no valid jobs are present" { 108 | set -eu -o pipefail 109 | echo "# ddev add-on get ${DIR} with project ${PROJNAME} in $(pwd)" >&3 110 | run ddev add-on get "${DIR}" 111 | assert_success 112 | run ddev restart -y 113 | assert_success 114 | 115 | # We should wait at least one cycle. 116 | sleep 61 117 | 118 | # Check service works 119 | health_checks 120 | } 121 | -------------------------------------------------------------------------------- /tests/testdata/.gitmanaged: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ddev/ddev-cron/e711e747c8eacc4d7f100480804bf4c8ccf5fa4a/tests/testdata/.gitmanaged -------------------------------------------------------------------------------- /web-build/Dockerfile.ddev-cron: -------------------------------------------------------------------------------- 1 | #ddev-generated 2 | # Install cron package; this can be done in webimage_extra_packages, but put it here for now. 3 | RUN (apt-get update || true) && DEBIAN_FRONTEND=noninteractive apt-get install -y -o Dpkg::Options::="--force-confold" --no-install-recommends --no-install-suggests cron 4 | 5 | # Copy our custom config 6 | COPY ./cron.conf /etc/supervisor/conf.d/cron.conf 7 | 8 | # Make it so you can add to cron.d without root privileges 9 | RUN chmod 777 /etc/cron.d /var/run 10 | 11 | # Copy over our custom jobs 12 | COPY ./*.cron /etc/cron.d/ 13 | 14 | # Give execution rights on the cron jobs 15 | RUN chmod -f 0644 /etc/cron.d/*.cron || true 16 | 17 | # Concatenate files 18 | RUN { cat /etc/cron.d/*.cron; } | crontab -u ${username} - 19 | -------------------------------------------------------------------------------- /web-build/cron.conf: -------------------------------------------------------------------------------- 1 | #ddev-generated 2 | [program:cron] 3 | command=sudo /usr/sbin/cron -f -L7 4 | autorestart=true 5 | startretries=10 6 | stdout_logfile=/proc/self/fd/2 7 | stdout_logfile_maxbytes=0 8 | redirect_stderr=true 9 | -------------------------------------------------------------------------------- /web-build/time.cron.example: -------------------------------------------------------------------------------- 1 | #ddev-generated 2 | * * * * * date | tee -a /var/www/html/time.log 3 | --------------------------------------------------------------------------------