Move the ShortcodeTest class to the Webfactory\ShortcodeBundle\Test namespace #18
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
Strictly speaking, we'd need to declare the PHPUnit version we're compatible with. However, since this test base class is only an add-on, I would not want to make it a regular On the other hand, a We might also simply ignore the problem, since we only inherit from |
Member
Author
|
Still an issue, since the test base class uses Symfony DomCrawler and BrowserKit, but we don't want to declare those as regular ( |
mpdude
added a commit
that referenced
this pull request
May 31, 2022
This PR addresses the shortcomings outlined in #12 and #13, and probably replaces #10 and #18 as well. 1. Deprecate the `\Webfactory\ShortcodeBundle\Tests\Functional\ShortcodeTest` class. * It was not available through the regular autoload mechanism (required extra trickery), * depended on undeclared dependencies (BrowserKit and DomCrawler), * came without tests, * suggested users to do/prefer full-scale Application Testing (using `WebTestCase`) and * worked only through the means of (ab-)using the Shortcode Guide. 2. Provide alternate means of testing shortcode processing * Encourage users to do plain/direct unit testing (or integration testing, when necessary) of their shortcode handlers and/or shortcode handling controllers through new sections in the README. This gives best (most direct) control of input parameters. * Add the public `\Webfactory\ShortcodeBundle\Test\ShortcodeDefinitionTestHelper` service that can be used in Kernel-based (functional) tests to verify a given shortcode name is known, the controller can be resolved etc. * Add a `\Webfactory\ShortcodeBundle\Test\EndToEndTestHelper` class that simplifies full end-to-end (from content to processed content) functional testing, including round-trips through Symfony's FragmentHandler for controller-based shortcodes. Fixes #12, fixes #13, closes #10, closes #18, closes #24. Co-authored-by: Malte Wunsch <mw@webfactory.de>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The class
Webfactory\ShortcodeBundle\Test\ShortcodeTestis intended to be used as a base class for users of this bundle.It should thus not only be available through
autoload-dev, but the regularautoloadconfiguration.My suggestion is to follow conventions as e. g. in symfony/symfony and use a
Testsub-namespace for testing-related classes that are intended to be used by clients, i. e. are part of the bundle's API.