From 0efae035a363218e3f6815b3507fba199c62cf0c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Barto=C5=A1?= Date: Wed, 8 Mar 2023 16:10:01 +0100 Subject: [PATCH] Initial commit --- .editorconfig | 14 + .gitattributes | 13 + .github/workflows/ci.yaml | 232 +++++++++++++ .github/workflows/dependency-review.yaml | 38 +++ .github/workflows/lock-closed-threads.yaml | 15 + .gitignore | 9 + CHANGELOG.md | 10 + LICENSE | 373 +++++++++++++++++++++ Makefile | 73 ++++ README.md | 40 +++ composer.json | 64 ++++ docs/README.md | 63 ++++ src/Job/CallbackJob.php | 26 ++ src/Job/Job.php | 10 + src/Scheduler.php | 25 ++ tests/Unit/Job/CallbackJobTest.php | 28 ++ tests/Unit/SchedulerTest.php | 31 ++ tools/.coveralls.yml | 4 + tools/infection.json | 19 ++ tools/phpcs.xml | 24 ++ tools/phpstan.baseline.neon | 11 + tools/phpstan.neon | 21 ++ tools/phpunit.xml | 21 ++ 23 files changed, 1164 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitattributes create mode 100644 .github/workflows/ci.yaml create mode 100644 .github/workflows/dependency-review.yaml create mode 100644 .github/workflows/lock-closed-threads.yaml create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.md create mode 100644 composer.json create mode 100644 docs/README.md create mode 100644 src/Job/CallbackJob.php create mode 100644 src/Job/Job.php create mode 100644 src/Scheduler.php create mode 100644 tests/Unit/Job/CallbackJobTest.php create mode 100644 tests/Unit/SchedulerTest.php create mode 100644 tools/.coveralls.yml create mode 100644 tools/infection.json create mode 100644 tools/phpcs.xml create mode 100644 tools/phpstan.baseline.neon create mode 100644 tools/phpstan.neon create mode 100644 tools/phpunit.xml diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..f81999f --- /dev/null +++ b/.editorconfig @@ -0,0 +1,14 @@ +# EditorConfig is awesome: https://EditorConfig.org + +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = tab + +[**.{yaml, yml}] +indent_style = space +indent_size=2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1d5c74d --- /dev/null +++ b/.gitattributes @@ -0,0 +1,13 @@ +# Not archived + +.github export-ignore +docs export-ignore +tests export-ignore +tools export-ignore + +.editorconfig export-ignore +.gitattributes export-ignore +.gitignore export-ignore +CHANGELOG-*.md export-ignore +Makefile export-ignore +README.md export-ignore diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..6620380 --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,232 @@ +name: "CI" + +on: + pull_request: + types: [ "opened", "synchronize", "edited", "reopened" ] + paths-ignore: + - "docs/**" + push: + branches: + - "**" + paths-ignore: + - "docs/**" + schedule: + - cron: "0 8 * * 1" # At 08:00 on Monday + workflow_dispatch: + inputs: {} + +concurrency: + group: "${{ github.workflow }}-${{ github.ref }}" + cancel-in-progress: true + +permissions: + contents: "read" + +jobs: + coding-standard: + name: "Coding standard" + runs-on: "${{ matrix.operating-system }}" + + if: | + github.event_name != 'pull_request' + || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name + + strategy: + matrix: + include: + - operating-system: "ubuntu-latest" + php-version: "8.1" + + steps: + - name: "Checkout" + uses: "actions/checkout@v3" + + - name: "PHP" + uses: "orisai/github-workflows/.github/actions/setup-php@v1" + with: + version: "${{ matrix.php-version }}" + token: "${{ secrets.GITHUB_TOKEN }}" + + - name: "Composer" + uses: "orisai/github-workflows/.github/actions/setup-composer@v1" + + - name: "PHP_CodeSniffer" + uses: "orisai/github-workflows/.github/actions/php-codesniffer@v1" + with: + command: "make cs ARGS='--report=checkstyle -q | vendor/bin/cs2pr'" + cache-path: "var/tools/PHP_CodeSniffer" + + static-analysis: + name: "Static analysis" + runs-on: "${{ matrix.operating-system }}" + + if: | + github.event_name != 'pull_request' + || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name + + strategy: + matrix: + include: + - operating-system: "ubuntu-latest" + php-version: "8.1" + + steps: + - name: "Checkout" + uses: "actions/checkout@v3" + + - name: "PHP" + uses: "orisai/github-workflows/.github/actions/setup-php@v1" + with: + version: "${{ matrix.php-version }}" + token: "${{ secrets.GITHUB_TOKEN }}" + + - name: "Composer" + uses: "orisai/github-workflows/.github/actions/setup-composer@v1" + + - name: "PHPStan" + uses: "orisai/github-workflows/.github/actions/phpstan@v1" + with: + command: "make phpstan" + cache-path: "var/tools/PHPStan" + + tests: + name: "Tests" + runs-on: "${{ matrix.operating-system }}" + continue-on-error: "${{ matrix.experimental }}" + + if: | + github.event_name != 'pull_request' + || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name + + strategy: + matrix: + operating-system: [ "ubuntu-latest", "macos-latest", "windows-latest" ] + php-version: [ "7.4", "8.0", "8.1" ] + composer-flags: [ "" ] + experimental: [ false ] + include: + - operating-system: "ubuntu-latest" + php-version: "7.4" + composer-flags: "--prefer-lowest --prefer-stable" + experimental: false + - operating-system: "ubuntu-latest" + php-version: "8.2" + composer-flags: "--ignore-platform-req=php+" + experimental: false + + steps: + - name: "Checkout" + uses: "actions/checkout@v3" + + - name: "PHP" + uses: "orisai/github-workflows/.github/actions/setup-php@v1" + with: + version: "${{ matrix.php-version }}" + coverage: "pcov" + token: "${{ secrets.GITHUB_TOKEN }}" + + - name: "Composer" + uses: "orisai/github-workflows/.github/actions/setup-composer@v1" + with: + command: "composer update --no-interaction --no-progress --prefer-dist ${{ matrix.composer-flags }}" + + - name: "PHPUnit" + uses: "orisai/github-workflows/.github/actions/phpunit@v1" + with: + command: "make coverage-clover" + cache-path: "var/tools/PHPUnit" + + - name: "Coveralls" + uses: "orisai/github-workflows/.github/actions/coveralls-php-upload@v1" + with: + config: "tools/.coveralls.yml" + token: "${{ secrets.GITHUB_TOKEN }}" + + - name: "Upload logs" + uses: "actions/upload-artifact@v3" + with: + name: "Logs - Tests (${{ matrix.operating-system }}, ${{ matrix.php-version }}, ${{ matrix.composer-flags }})" + path: "var/log" + if-no-files-found: "ignore" + + coverage-finish: + name: "Code coverage finish" + needs: "tests" + runs-on: "${{ matrix.operating-system }}" + + if: | + github.event_name != 'pull_request' + || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name + + strategy: + matrix: + include: + - operating-system: "ubuntu-latest" + php-version: "8.1" + + steps: + - name: "Coveralls" + uses: "orisai/github-workflows/.github/actions/coveralls-finish@v1" + with: + token: "${{ secrets.GITHUB_TOKEN }}" + + tests-mutations: + name: "Test for mutants" + runs-on: "${{ matrix.operating-system }}" + + if: | + github.event_name != 'pull_request' + || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name + + strategy: + matrix: + include: + - operating-system: "ubuntu-latest" + php-version: "8.1" + + steps: + - name: "Checkout" + uses: "actions/checkout@v3" + + - name: "PHP" + uses: "orisai/github-workflows/.github/actions/setup-php@v1" + with: + version: "${{ matrix.php-version }}" + coverage: "pcov" + token: "${{ secrets.GITHUB_TOKEN }}" + + - name: "Composer" + uses: "orisai/github-workflows/.github/actions/setup-composer@v1" + + - name: "PHPUnit" + uses: "orisai/github-workflows/.github/actions/phpunit@v1" + with: + command: "make mutations-tests" + cache-path: "var/tools/PHPUnit" + + - name: "Infection PHP" + uses: "orisai/github-workflows/.github/actions/infection-php@v1" + with: + command: "make mutations-infection ARGS='--logger-github'" + cache-path: "var/tools/Infection" + stryker-token: "${{ secrets.STRYKER_DASHBOARD_API_KEY }}" + + - name: "Upload logs" + uses: "actions/upload-artifact@v3" + with: + name: "Logs - Mutations" + path: "var/coverage/mutations/infection.log" + if-no-files-found: "ignore" + + status-check: + name: "Status check - ${{ github.workflow }}" + runs-on: "ubuntu-latest" + needs: [ "coding-standard", "static-analysis", "tests", "tests-mutations" ] + + if: "${{ always() }}" + + steps: + - name: "Check required jobs are successful" + uses: "orisai/github-workflows/.github/actions/status-check@v1" + with: + needs: "${{ toJSON(needs) }}" diff --git a/.github/workflows/dependency-review.yaml b/.github/workflows/dependency-review.yaml new file mode 100644 index 0000000..36e1193 --- /dev/null +++ b/.github/workflows/dependency-review.yaml @@ -0,0 +1,38 @@ +name: "Dependency Review" + +on: + pull_request: + types: [ "opened", "synchronize", "edited", "reopened" ] + paths-ignore: + - "docs/**" + push: + branches: + - "**" + paths-ignore: + - "docs/**" + +concurrency: + group: "${{ github.workflow }}-${{ github.ref }}" + cancel-in-progress: true + +permissions: + contents: "read" + +jobs: + dependency-review: + name: "Dependency Review" + runs-on: "ubuntu-latest" + + if: | + github.event_name != 'pull_request' + || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name + + steps: + - name: "Checkout" + uses: "actions/checkout@v3" + + - name: "Dependency Review" + uses: "actions/dependency-review-action@v3" + with: + base-ref: "${{ github.event.before }}" + head-ref: "${{ github.sha }}" diff --git a/.github/workflows/lock-closed-threads.yaml b/.github/workflows/lock-closed-threads.yaml new file mode 100644 index 0000000..8e8ad8b --- /dev/null +++ b/.github/workflows/lock-closed-threads.yaml @@ -0,0 +1,15 @@ +name: "Lock inactive closed issues and PRs" + +on: + schedule: + - cron: "0 12 * * 1" + workflow_dispatch: + inputs: {} + +permissions: + issues: "write" + pull-requests: "write" + +jobs: + lock: + uses: "orisai/github-workflows/.github/workflows/lock-closed-threads.yaml@v1" diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f762969 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +# IDE +/.idea + +# Composer +/vendor +/composer.lock + +# Generated +/var diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..29e30b9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,10 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) +and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). + +## [Unreleased](https://github.com/orisai/scheduler/compare/...HEAD) + +### Added diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a612ad9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..5792bae --- /dev/null +++ b/Makefile @@ -0,0 +1,73 @@ +_: list + +# Config + +PHPCS_CONFIG=tools/phpcs.xml +PHPSTAN_CONFIG=tools/phpstan.neon +PHPSTAN_BASELINE_CONFIG=tools/phpstan.baseline.neon +PHPUNIT_CONFIG=tools/phpunit.xml +INFECTION_CONFIG=tools/infection.json + +# QA + +qa: ## Check code quality - coding style and static analysis + make cs & make phpstan + +cs: ## Check PHP files coding style + mkdir -p var/tools/PHP_CodeSniffer + $(PRE_PHP) "vendor/bin/phpcs" src tests --standard=$(PHPCS_CONFIG) --parallel=$(LOGICAL_CORES) $(ARGS) + +csf: ## Fix PHP files coding style + mkdir -p var/tools/PHP_CodeSniffer + $(PRE_PHP) "vendor/bin/phpcbf" src tests --standard=$(PHPCS_CONFIG) --parallel=$(LOGICAL_CORES) $(ARGS) + +phpstan: ## Analyse code with PHPStan + mkdir -p var/tools + $(PRE_PHP) "vendor/bin/phpstan" analyse src tests -c $(PHPSTAN_CONFIG) $(ARGS) + +phpstan-baseline: ## Add PHPStan errors to baseline + make phpstan ARGS="-b $(PHPSTAN_BASELINE_CONFIG)" + +# Tests + +.PHONY: tests +tests: ## Run all tests + $(PRE_PHP) $(PHPUNIT_COMMAND) $(ARGS) + +coverage-clover: ## Generate code coverage in XML format + $(PRE_PHP) $(PHPUNIT_COVERAGE) --coverage-clover=var/coverage/clover.xml $(ARGS) + +coverage-html: ## Generate code coverage in HTML format + $(PRE_PHP) $(PHPUNIT_COVERAGE) --coverage-html=var/coverage/html $(ARGS) + +mutations: ## Check code for mutants + make mutations-tests + make mutations-infection + +mutations-tests: + mkdir -p var/coverage + $(PRE_PHP) $(PHPUNIT_COVERAGE) --coverage-xml=var/coverage/xml --log-junit=var/coverage/junit.xml + +mutations-infection: + $(PRE_PHP) vendor/bin/infection \ + --configuration=$(INFECTION_CONFIG) \ + --threads=$(LOGICAL_CORES) \ + --coverage=../var/coverage \ + --skip-initial-tests \ + $(ARGS) + +# Utilities + +.SILENT: $(shell grep -h -E '^[a-zA-Z_-]+:.*?$$' $(MAKEFILE_LIST) | sort -u | awk 'BEGIN {FS = ":.*?"}; {printf "%s ", $$1}') + +LIST_PAD=20 +list: + awk 'BEGIN {FS = ":.*##"; printf "Usage:\n make \033[36m\033[0m\n\nTargets:\n"}' + grep -h -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort -u | awk 'BEGIN {FS = ":.*?## "}; {printf " \033[36m%-$(LIST_PAD)s\033[0m %s\n", $$1, $$2}' + +PRE_PHP=XDEBUG_MODE=off + +PHPUNIT_COMMAND="vendor/bin/paratest" -c $(PHPUNIT_CONFIG) --runner=WrapperRunner -p$(LOGICAL_CORES) +PHPUNIT_COVERAGE=php -d pcov.enabled=1 -d pcov.directory=./src $(PHPUNIT_COMMAND) + +LOGICAL_CORES=$(shell nproc || sysctl -n hw.logicalcpu || wmic cpu get NumberOfLogicalProcessors || echo 4) diff --git a/README.md b/README.md new file mode 100644 index 0000000..8a197ef --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +

+ Orisai +
+ Scheduler +

+ +

+ Cron job scheduler - with locks, parallelism and more +

+ +

+ 📄 Check out our documentation. +

+ +

+ 💸 If you like Orisai, please make a donation. Thank you! +

+ +

+ + + + + + + + + + + + + + + + + + +

+ +## diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..c204f00 --- /dev/null +++ b/composer.json @@ -0,0 +1,64 @@ +{ + "name": "orisai/scheduler", + "description": "Cron job scheduler - with locks, parallelism and more", + "keywords": [ + "cron", + "cronjob", + "crontab", + "frequency", + "interval", + "job-scheduler", + "queue", + "recurring", + "runner", + "schedule", + "scheduling", + "scheduler", + "task" + ], + "type": "library", + "license": "MPL-2.0", + "homepage": "https://github.com/orisai/scheduler", + "authors": [ + { + "name": "Marek Bartoš", + "homepage": "https://github.com/mabar" + } + ], + "require": { + "php": ">=7.4.0 <8.3.0", + "orisai/exceptions": "^1.0.0" + }, + "require-dev": { + "brianium/paratest": "^6.3.0", + "infection/infection": "^0.26.0", + "orisai/coding-standard": "^3.0.0", + "phpstan/extension-installer": "^1.0.0", + "phpstan/phpstan": "^1.0.0", + "phpstan/phpstan-deprecation-rules": "^1.0.0", + "phpstan/phpstan-phpunit": "^1.0.0", + "phpstan/phpstan-strict-rules": "^1.0.0", + "phpunit/phpunit": "^9.5.0", + "staabm/annotate-pull-request-from-checkstyle": "^1.7.0" + }, + "autoload": { + "psr-4": { + "Orisai\\Scheduler\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "Tests\\Orisai\\Scheduler\\": "tests" + } + }, + "minimum-stability": "dev", + "prefer-stable": true, + "config": { + "sort-packages": true, + "allow-plugins": { + "dealerdirect/phpcodesniffer-composer-installer": true, + "infection/extension-installer": true, + "phpstan/extension-installer": true + } + } +} diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..e6a1900 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,63 @@ +# Scheduler + +Cron job scheduler - with locks, parallelism and more + +## Content + +- [Why do you need it?](#why-do-you-need-it) +- [Quick start](#quick-start) + +## Why do you need it? + +Let's say you already use cron jobs configured via crontab (or custom solution given by hosting). Each cron has to be +registered in crontab in every single environment (e.g. local, stage, production) and application itself is generally +not aware of these cron jobs. + +With this library you can manage all cron jobs in application and setup them in crontab with single line. + +> Why not any alternative library? There is ton of them. + +Well, you are right. But do they manage everything needed? By not using crontab directly you loose several features that +library has to replicate: + +- locking - each job should run only once at a time +- parallelism - jobs should run in parallel and start in time even if one or more run for a long time +- failure protection - if one job fails, the failure should be logged and the other jobs should still be executed +- cron expressions - library has to parse and properly evaluate cron expression to determine whether job should be run + +Orisai Scheduler solves all of these problems. + +On top of that you get: + +- overview of all jobs, including estimated times of previous and next runs and whether job is currently running +- heatmap for load-balancing your jobs +- before/after job events for customizations + +## Quick start + +Install with [Composer](https://getcomposer.org) + +```sh +composer require orisai/scheduler +``` + +Create script with scheduler setup (e.g. `bin/scheduler.php`) + +```php +use Orisai\Scheduler\Scheduler; + +$scheduler = new Scheduler(); + +// Add jobs +$scheduler->addJob(new CallbackJob(fn() => exampleTask())); + +$scheduler->run(); +``` + +Configure crontab to run your script each minute + +```txt +* * * * * path/to/bin/scheduler.php >> /dev/null 2>&1 +``` + +Got to go! diff --git a/src/Job/CallbackJob.php b/src/Job/CallbackJob.php new file mode 100644 index 0000000..ff86369 --- /dev/null +++ b/src/Job/CallbackJob.php @@ -0,0 +1,26 @@ +callback = $callback; + } + + public function run(): void + { + ($this->callback)(); + } + +} diff --git a/src/Job/Job.php b/src/Job/Job.php new file mode 100644 index 0000000..0183485 --- /dev/null +++ b/src/Job/Job.php @@ -0,0 +1,10 @@ + */ + private array $jobs = []; + + public function addJob(Job $job): void + { + $this->jobs[] = $job; + } + + public function run(): void + { + foreach ($this->jobs as $job) { + $job->run(); + } + } + +} diff --git a/tests/Unit/Job/CallbackJobTest.php b/tests/Unit/Job/CallbackJobTest.php new file mode 100644 index 0000000..4da354b --- /dev/null +++ b/tests/Unit/Job/CallbackJobTest.php @@ -0,0 +1,28 @@ +run(); + self::assertSame(1, $i); + + $job->run(); + self::assertSame(2, $i); + } + +} diff --git a/tests/Unit/SchedulerTest.php b/tests/Unit/SchedulerTest.php new file mode 100644 index 0000000..a6e45a7 --- /dev/null +++ b/tests/Unit/SchedulerTest.php @@ -0,0 +1,31 @@ +addJob($job); + + $scheduler->run(); + self::assertSame(1, $i); + + $scheduler->run(); + self::assertSame(2, $i); + } + +} diff --git a/tools/.coveralls.yml b/tools/.coveralls.yml new file mode 100644 index 0000000..0344358 --- /dev/null +++ b/tools/.coveralls.yml @@ -0,0 +1,4 @@ +# for php-coveralls +service_name: github-actions +coverage_clover: var/coverage/clover.xml +json_path: var/coverage/coveralls-upload.json diff --git a/tools/infection.json b/tools/infection.json new file mode 100644 index 0000000..574ea34 --- /dev/null +++ b/tools/infection.json @@ -0,0 +1,19 @@ +{ + "$schema": "../vendor/infection/infection/resources/schema.json", + "source": { + "directories": [ + "src" + ] + }, + "logs": { + "html": "var/coverage/mutations/infection.html", + "text": "var/coverage/mutations/infection.log", + "stryker": { + "report": "/^v[0-9]+.[0-9x]+$/" + } + }, + "tmpDir": "../var/tools/Infection", + "mutators": { + "@default": true + } +} diff --git a/tools/phpcs.xml b/tools/phpcs.xml new file mode 100644 index 0000000..d184ed7 --- /dev/null +++ b/tools/phpcs.xml @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + diff --git a/tools/phpstan.baseline.neon b/tools/phpstan.baseline.neon new file mode 100644 index 0000000..db64dfc --- /dev/null +++ b/tools/phpstan.baseline.neon @@ -0,0 +1,11 @@ +parameters: + ignoreErrors: + - + message: "#^Call to static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertSame\\(\\) with 2 and 1 will always evaluate to false\\.$#" + count: 1 + path: ../tests/Unit/Job/CallbackJobTest.php + + - + message: "#^Call to static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertSame\\(\\) with 2 and 1 will always evaluate to false\\.$#" + count: 1 + path: ../tests/Unit/SchedulerTest.php diff --git a/tools/phpstan.neon b/tools/phpstan.neon new file mode 100644 index 0000000..8437767 --- /dev/null +++ b/tools/phpstan.neon @@ -0,0 +1,21 @@ +includes: + - ../vendor/phpstan/phpstan/conf/bleedingEdge.neon + - phpstan.baseline.neon + +parameters: + phpVersion: 70400 + level: 8 + tmpDir: ../var/tools/PHPStan + resultCachePath: %currentWorkingDirectory%/var/tools/PHPStan/resultCache.php + + checkBenevolentUnionTypes: true + checkMissingCallableSignature: true + checkInternalClassCaseSensitivity: true + checkTooWideReturnTypesInProtectedAndPublicMethods: true + + exceptions: + check: + missingCheckedExceptionInThrows: true + tooWideThrowType: true + checkedExceptionClasses: + - Orisai\Exceptions\Check\CheckedException diff --git a/tools/phpunit.xml b/tools/phpunit.xml new file mode 100644 index 0000000..5eeea9a --- /dev/null +++ b/tools/phpunit.xml @@ -0,0 +1,21 @@ + + + ../tests + + + + + ../src + + +