diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..95bc24b --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,15 @@ +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "daily" + labels: + - "type:dependencies" + + - package-ecosystem: "composer" + directory: "/" + schedule: + interval: "daily" + labels: + - "type:dependencies" diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 4f90873..c4e66d7 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -2,16 +2,24 @@ name-template: '$NEXT_MINOR_VERSION' tag-template: '$NEXT_MINOR_VERSION' categories: - title: 'šŸš€ New Features' - label: 'type:new feature' + labels: + - 'type:new feature' - title: 'šŸ”¬ Improvements' - label: 'type:improvement' + labels: + - 'type:improvement' - title: 'šŸž Bug Fixes' - label: 'type:bug' - - title: 'šŸ“¦ Dependency updates' - label: ' type:dependency' + labels: + - 'type:bug' + - title: 'ā¬†ļø Dependency Updates' + labels: + - 'type:dependencies' change-template: '* $TITLE (via #$NUMBER) - @$AUTHOR' +exclude-labels: + - 'type:internal' template: | $CHANGES + ## šŸ‘€ Links - [Commits since $PREVIOUS_TAG](https://github.com/allure-framework/allure-php-commons/compare/$PREVIOUS_TAG...master) \ No newline at end of file + + [Commits since $PREVIOUS_TAG](https://github.com/allure-framework/allure-php-api/compare/$PREVIOUS_TAG...master) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8311099..2a0c4cc 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -7,34 +7,16 @@ on: push: branches: - 'master' + - 'hotfix-*' + +permissions: + contents: read jobs: - build71: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - uses: shivammathur/setup-php@v2 - with: - php-version: '7.1.3' - - name: Install - run: composer update - - name: Test - run: composer test-legacy - build72: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - uses: shivammathur/setup-php@v2 - with: - php-version: '7.2' - - name: Install - run: composer update - - name: Test - run: composer test-legacy build73: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v6 - uses: shivammathur/setup-php@v2 with: php-version: '7.3' @@ -45,7 +27,7 @@ jobs: build74: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v6 - uses: shivammathur/setup-php@v2 with: php-version: '7.4' @@ -56,7 +38,7 @@ jobs: build80: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v6 - uses: shivammathur/setup-php@v2 with: php-version: '8.0' diff --git a/.github/workflows/draft-release.yml b/.github/workflows/draft-release.yml index 95a3f7a..98ca8f2 100644 --- a/.github/workflows/draft-release.yml +++ b/.github/workflows/draft-release.yml @@ -5,10 +5,16 @@ on: branches: - master +permissions: + contents: read + jobs: update_draft_release: + permissions: + contents: write + pull-requests: write runs-on: ubuntu-latest steps: - - uses: toolmantim/release-drafter@v5.2.0 + - uses: release-drafter/release-drafter@v7 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/labels-verify.yml b/.github/workflows/labels-verify.yml new file mode 100644 index 0000000..fa33942 --- /dev/null +++ b/.github/workflows/labels-verify.yml @@ -0,0 +1,16 @@ +name: "Verify type labels" + +on: + pull_request: + types: [opened, labeled, unlabeled, synchronize] + +permissions: + contents: read + +jobs: + triage: + runs-on: ubuntu-latest + steps: + - uses: zwaldowski/match-label-action@v6 + with: + allowed: 'type:bug,type:new feature,type:improvement,type:dependencies,type:internal,type:invalid' diff --git a/LICENSE b/LICENSE index d472d8c..fbd5b25 100644 --- a/LICENSE +++ b/LICENSE @@ -1,13 +1,201 @@ -Copyright 2014 Yandex LLC + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ -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 + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION -http://www.apache.org/licenses/LICENSE-2.0 + 1. Definitions. -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. \ No newline at end of file + "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 2021 Qameta Software OƜ + + 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 index def3c8d..88fc9b7 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,56 @@ -# Allure PHP API +# Allure PHP API (maintenance) + +This project is in Maintenance mode. The new version of PHP API is available at [`allure-framework/allure-php-commons`](https://github.com/allure-framework/allure-php-commons2). + +[![Build](https://github.com/allure-framework/allure-php-api/actions/workflows/build.yml/badge.svg)](https://github.com/allure-framework/allure-php-api/actions/workflows/build.yml) + This repository contains PHP API for Allure framework. The main idea is to reuse this API when creating adapters for different test frameworks. ## Getting started + In order to use this API you simply need to add the following to **composer.json**: + ```json { - "require": { - "php": ">=5.4.0", - "allure-framework/allure-php-api": "~1.0.0" - } + "require": { + "php": ">=7.3", + "allure-framework/allure-php-api": "~1.0.0" + } } ``` + Basic usage idiom is to fire an event like the following: + ```php Allure::lifecycle()->fire(new TestCaseFinishedEvent()); ``` ## Events + The following events are available right now: -* AddAttachmentEvent -* AddParameterEvent -* ClearStepStorageEvent -* ClearTestCaseStorageEvent -* RemoveAttachmentsEvent -* StepCanceledEvent -* StepEvent -* StepFailedEvent -* StepFinishedEvent -* StepStartedEvent -* TestCaseBrokenEvent -* TestCaseCanceledEvent -* TestCaseEvent -* TestCaseFailedEvent -* TestCaseFinishedEvent -* TestCasePendingEvent -* TestCaseStartedEvent -* TestCaseStatusChangedEvent -* TestSuiteEvent -* TestSuiteFinishedEvent -* TestSuiteStartedEvent + +- AddAttachmentEvent +- AddParameterEvent +- ClearStepStorageEvent +- ClearTestCaseStorageEvent +- RemoveAttachmentsEvent +- StepCanceledEvent +- StepEvent +- StepFailedEvent +- StepFinishedEvent +- StepStartedEvent +- TestCaseBrokenEvent +- TestCaseCanceledEvent +- TestCaseEvent +- TestCaseFailedEvent +- TestCaseFinishedEvent +- TestCasePendingEvent +- TestCaseStartedEvent +- TestCaseStatusChangedEvent +- TestSuiteEvent +- TestSuiteFinishedEvent +- TestSuiteStartedEvent ## Usage examples -See [allure-phpunit](https://github.com/allure-framework/allure-phpunit) project. \ No newline at end of file + +See [`allure-phpunit`](https://github.com/allure-framework/allure-phpunit) project. diff --git a/composer.json b/composer.json index 5ca0f82..5353eda 100644 --- a/composer.json +++ b/composer.json @@ -1,8 +1,8 @@ { "name": "allure-framework/allure-php-api", - "keywords":["php", "report", "allure", "api"], - "description": "PHP API for Allure adapter", - "homepage": "http://allure.qatools.ru/", + "keywords": ["PHP", "report", "allure", "api"], + "description": "Allure PHP commons", + "homepage": "https://allurereport.org/", "license": "Apache-2.0", "authors": [ { @@ -12,17 +12,18 @@ } ], "support": { - "email": "allure@yandex-team.ru", + "email": "allure@qameta.io", "source": "https://github.com/allure-framework/allure-php-api" }, "require": { - "php": ">=7.1.3", + "php": ">=7.3", "jms/serializer": "^1 | ^2 | ^3", "ramsey/uuid": "^3 | ^4", - "symfony/mime": "^4.3 | ^5" + "symfony/mime": "^4.3 | ^5 | ^6 | ^7", + "doctrine/annotations": "1.*" }, "require-dev": { - "phpunit/phpunit": "^7 | ^8 | ^9" + "phpunit/phpunit": "^9.6.34" }, "autoload": { "psr-0": { @@ -30,7 +31,6 @@ } }, "scripts": { - "test": "vendor/bin/phpunit", - "test-legacy": "vendor/bin/phpunit --configuration=phpunit.legacy.xml" + "test": "vendor/bin/phpunit" } } diff --git a/phpunit.legacy.xml b/phpunit.legacy.xml deleted file mode 100644 index ab55bad..0000000 --- a/phpunit.legacy.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - - - test/Yandex/Allure/Adapter/ - - - - - src/ - - - \ No newline at end of file diff --git a/src/Yandex/Allure/Adapter/Event/TestCaseStatusChangedEvent.php b/src/Yandex/Allure/Adapter/Event/TestCaseStatusChangedEvent.php index 1bf3718..e8c13ad 100644 --- a/src/Yandex/Allure/Adapter/Event/TestCaseStatusChangedEvent.php +++ b/src/Yandex/Allure/Adapter/Event/TestCaseStatusChangedEvent.php @@ -2,6 +2,7 @@ namespace Yandex\Allure\Adapter\Event; +use Throwable; use Yandex\Allure\Adapter\Model\Entity; use Yandex\Allure\Adapter\Model\Failure; use Yandex\Allure\Adapter\Model\TestCase; @@ -9,7 +10,7 @@ abstract class TestCaseStatusChangedEvent implements TestCaseEvent { /** - * @var \Exception + * @var Throwable */ private $exception; @@ -48,10 +49,10 @@ public function withMessage($message) } /** - * @param \Exception $exception + * @param Throwable $exception * @return $this */ - public function withException($exception) + public function withException(Throwable $exception) { $this->exception = $exception; diff --git a/src/Yandex/Allure/Adapter/Model/TestSuite.php b/src/Yandex/Allure/Adapter/Model/TestSuite.php index 82ddd30..7f7fbf5 100644 --- a/src/Yandex/Allure/Adapter/Model/TestSuite.php +++ b/src/Yandex/Allure/Adapter/Model/TestSuite.php @@ -210,7 +210,7 @@ public function setDescription(Description $description) */ public function addTestCase(TestCase $testCase) { - $this->testCases[$testCase->getName()] = $testCase; + $this->testCases[$testCase->getName() ?? ''] = $testCase; } /** @@ -220,7 +220,7 @@ public function addTestCase(TestCase $testCase) */ public function getTestCase($name) { - return $this->testCases[$name]; + return $this->testCases[$name ?? '']; } /** @@ -254,7 +254,24 @@ public function serialize() */ public function unserialize($serialized) { - return $this->getSerializer()->deserialize($serialized, 'Yandex\Allure\Adapter\Model\TestSuite', 'xml'); + return $this->getSerializer()->deserialize($serialized, \Yandex\Allure\Adapter\Model\TestSuite::class, 'xml'); + } + + /** + + * @return string + + */ + public function __serialize() + { + return $this->getSerializer()->serialize($this, 'xml'); + } + + /** + + * @param string $serialized + + * @return mixed + + */ + public function __unserialize($serialized) + { + return $this->getSerializer()->deserialize($serialized, \Yandex\Allure\Adapter\Model\TestSuite::class, 'xml'); } /**