Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@testdox annotation not working for test descriptions #6697

Open
dingo-d opened this issue Oct 3, 2023 · 0 comments
Open

@testdox annotation not working for test descriptions #6697

dingo-d opened this issue Oct 3, 2023 · 0 comments

Comments

@dingo-d
Copy link

dingo-d commented Oct 3, 2023

What are you trying to achieve?

I'd like to change the test descriptions so that they are a bit more... well, descriptive 😅

@testdoc annotation

What do you get instead?

My test looks like this:

<?php

namespace Tests\Unit;

use Tests\Support\UnitTester;

class Test extends \Codeception\Test\Unit
{

	protected UnitTester $tester;

	protected function _before()
	{
	}

	/**
	 * @testdox This is some feature test!
	 */
	public function testSomeFeature()
	{
		$this->assertTrue(true);
	}
}

When I run this test I get

✔ Test: Some feature(0.00s)

And I'd like to get

✔ Test: This is some feature test!(0.00s)

Details

  • Codeception version: 5.0.11
  • PHP Version: 8.1
  • Operating System: MacOS Ventura 13.6 (22G120)
  • Installation type: Composer
  • List of installed packages (composer show)
composer packages
antecedent/patchwork                           2.1.26                                 Method redefinition (monkey-patching) functionality for PHP.
behat/gherkin                                  v4.9.0                                 Gherkin DSL parser for PHP
brain/monkey                                   2.6.1                                  Mocking utility for PHP functions and WordPress plugin API
codeception/codeception                        5.0.11                                 BDD-style testing framework
codeception/lib-asserts                        2.1.0                                  Assertion methods used by Codeception core and Asserts module
codeception/lib-innerbrowser                   3.1.3                                  Parent library for all Codeception framework modules and PhpBrowser
codeception/lib-web                            1.0.2                                  Library containing files used by module-webdriver and lib-innerbrowser or module-phpbrowser
codeception/module-asserts                     3.0.0                                  Codeception module containing various assertions
codeception/module-cli                         2.0.1                                  Codeception module for testing basic shell commands and shell output
codeception/module-db                          3.1.0                                  DB module for Codeception
codeception/module-filesystem                  3.0.0                                  Codeception module for testing local filesystem
codeception/module-phpbrowser                  3.0.0                                  Codeception module for testing web application over HTTP
codeception/module-webdriver                   3.2.1                                  WebDriver module for Codeception
codeception/stub                               4.1.1                                  Flexible Stub wrapper for PHPUnit's Mock Builder
dealerdirect/phpcodesniffer-composer-installer v1.0.0                                 PHP_CodeSniffer Standards Composer Installer Plugin
doctrine/instantiator                          2.0.0                                  A small, lightweight utility to instantiate objects in PHP without invoking their constructors
graham-campbell/result-type                    v1.1.1                                 An Implementation Of The Result Type
guzzlehttp/guzzle                              7.8.0                                  Guzzle is a PHP HTTP client library
guzzlehttp/promises                            2.0.1                                  Guzzle promises library
guzzlehttp/psr7                                2.6.1                                  PSR-7 message implementation that also provides common utility methods
hamcrest/hamcrest-php                          v2.0.1                                 This is the PHP port of Hamcrest Matchers
ifsnop/mysqldump-php                           v2.12                                  PHP version of mysqldump cli that comes with MySQL
infinum/eightshift-coding-standards            2.0.0-beta                             Eightshift WordPress Coding Standards
infinum/eightshift-libs                        dev-feature/update-wpcs 4ede7ac        WordPress libs developed by Eightshift team to use in modern WordPress.
laravel/serializable-closure                   v1.3.1                                 Laravel Serializable Closure provides an easy and secure way to serialize closures in PHP.
lucatume/wp-browser                            4.0.3                                  A set of Codeception modules to test WordPress projects.
masterminds/html5                              2.8.1                                  An HTML5 parser and serializer.
mockery/mockery                                1.6.6                                  Mockery is a simple yet flexible PHP mock object framework
myclabs/deep-copy                              1.11.1                                 Create deep copies (clones) of your objects
nikic/php-parser                               v4.17.1                                A PHP parser written in PHP
phar-io/manifest                               2.0.3                                  Component for reading phar.io manifest information from a PHP Archive (PHAR)
phar-io/version                                3.2.1                                  Library for handling version information and constraints
php-di/invoker                                 2.3.4                                  Generic and extensible callable invoker
php-di/php-di                                  7.0.5                                  The dependency injection container for humans
php-parallel-lint/php-parallel-lint            v1.3.2                                 This tool check syntax of PHP files about 20x faster than serial check.
php-stubs/woocommerce-stubs                    v8.1.0                                 WooCommerce function and class declaration stubs for static analysis.
php-stubs/wordpress-globals                    v0.2.0                                 Global variables and global constants from WordPress core.
php-stubs/wordpress-stubs                      v6.3.0                                 WordPress function and class declaration stubs for static analysis.
php-webdriver/webdriver                        1.15.0                                 A PHP client for Selenium WebDriver. Previously facebook/webdriver.
phpcompatibility/php-compatibility             9.3.5                                  A set of sniffs for PHP_CodeSniffer that checks for PHP cross-version compatibility.
phpcompatibility/phpcompatibility-paragonie    1.3.2                                  A set of rulesets for PHP_CodeSniffer to check for PHP cross-version compatibility issues in...
phpcompatibility/phpcompatibility-wp           2.1.4                                  A ruleset for PHP_CodeSniffer to check for PHP cross-version compatibility issues in project...
phpcsstandards/phpcsextra                      1.1.2                                  A collection of sniffs and standards for use with PHP_CodeSniffer.
phpcsstandards/phpcsutils                      1.0.8                                  A suite of utility functions for use with PHP_CodeSniffer
phpoption/phpoption                            1.9.1                                  Option Type for PHP
phpstan/phpdoc-parser                          1.24.2                                 PHPDoc parser with support for nullable, intersection and generic types
phpstan/phpstan                                1.10.35                                PHPStan - PHP Static Analysis Tool
phpunit/php-code-coverage                      9.2.29                                 Library that provides collection, processing, and rendering functionality for PHP code cover...
phpunit/php-file-iterator                      3.0.6                                  FilterIterator implementation that filters files based on a list of suffixes.
phpunit/php-invoker                            3.1.1                                  Invoke callables with a timeout
phpunit/php-text-template                      2.0.4                                  Simple template engine.
phpunit/php-timer                              5.0.3                                  Utility class for timing
phpunit/phpunit                                9.6.13                                 The PHP Unit Testing framework.
psr/container                                  2.0.2                                  Common Container Interface (PHP FIG PSR-11)
psr/event-dispatcher                           1.0.0                                  Standard interfaces for event handling.
psr/http-client                                1.0.3                                  Common interface for HTTP clients
psr/http-factory                               1.0.2                                  Common interfaces for PSR-7 HTTP message factories
psr/http-message                               2.0                                    Common interface for HTTP messages
psy/psysh                                      v0.11.21                               An interactive shell for modern PHP.
ralouphie/getallheaders                        3.0.3                                  A polyfill for getallheaders.
sebastian/cli-parser                           1.0.1                                  Library for parsing CLI options
sebastian/code-unit                            1.0.8                                  Collection of value objects that represent the PHP code units
sebastian/code-unit-reverse-lookup             2.0.3                                  Looks up which function or method a line of code belongs to
sebastian/comparator                           4.0.8                                  Provides the functionality to compare PHP values for equality
sebastian/complexity                           2.0.2                                  Library for calculating the complexity of PHP code units
sebastian/diff                                 4.0.5                                  Diff implementation
sebastian/environment                          5.1.5                                  Provides functionality to handle HHVM/PHP environments
sebastian/exporter                             4.0.5                                  Provides the functionality to export PHP variables for visualization
sebastian/global-state                         5.0.6                                  Snapshotting of global state
sebastian/lines-of-code                        1.0.3                                  Library for counting the lines of code in PHP source code
sebastian/object-enumerator                    4.0.4                                  Traverses array structures and object graphs to enumerate all referenced objects
sebastian/object-reflector                     2.0.4                                  Allows reflection of object attributes, including inherited and non-public ones
sebastian/recursion-context                    4.0.5                                  Provides functionality to recursively process PHP variables
sebastian/resource-operations                  3.0.3                                  Provides a list of PHP built-in functions that operate on resources
sebastian/type                                 3.2.1                                  Collection of value objects that represent the types of the PHP type system
sebastian/version                              3.0.2                                  Library that helps with managing the version number of Git-hosted PHP projects
slevomat/coding-standard                       8.13.4                                 Slevomat Coding Standard for PHP_CodeSniffer complements Consistence Coding Standard by prov...
squizlabs/php_codesniffer                      3.7.2                                  PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined ...
symfony/browser-kit                            v6.3.2                                 Simulates the behavior of a web browser, allowing you to make requests, click on links and s...
symfony/console                                v6.3.4                                 Eases the creation of beautiful and testable command line interfaces
symfony/css-selector                           v6.3.2                                 Converts CSS selectors to XPath expressions
symfony/deprecation-contracts                  v3.3.0                                 A generic function and convention to trigger deprecation notices
symfony/dom-crawler                            v6.3.4                                 Eases DOM navigation for HTML and XML documents
symfony/event-dispatcher                       v6.3.2                                 Provides tools that allow your application components to communicate with each other by disp...
symfony/event-dispatcher-contracts             v3.3.0                                 Generic abstractions related to dispatching event
symfony/filesystem                             v6.3.1                                 Provides basic utilities for the filesystem
symfony/finder                                 v6.3.3                                 Finds files and directories via an intuitive fluent interface
symfony/polyfill-ctype                         v1.28.0                                Symfony polyfill for ctype functions
symfony/polyfill-intl-grapheme                 v1.28.0                                Symfony polyfill for intl's grapheme_* functions
symfony/polyfill-intl-normalizer               v1.28.0                                Symfony polyfill for intl's Normalizer class and related functions
symfony/polyfill-mbstring                      v1.28.0                                Symfony polyfill for the Mbstring extension
symfony/polyfill-php73                         v1.28.0                                Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions
symfony/polyfill-php80                         v1.28.0                                Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions
symfony/process                                v6.3.4                                 Executes commands in sub-processes
symfony/service-contracts                      v3.3.0                                 Generic abstractions related to writing services
symfony/string                                 v6.3.2                                 Provides an object-oriented API to strings and deals with bytes, UTF-8 code points and graph...
symfony/var-dumper                             v6.3.4                                 Provides mechanisms for walking through any arbitrary PHP variable
symfony/yaml                                   v6.3.3                                 Loads and dumps YAML files
szepeviktor/phpstan-wordpress                  v1.3.0                                 WordPress extensions for PHPStan
theseer/tokenizer                              1.2.1                                  A small library for converting tokenized PHP source code into XML and potentially other formats
typisttech/imposter                            0.6.1                                  Wrapping all composer vendor packages inside your own namespace. Intended for WordPress plug...
typisttech/imposter-plugin                     0.6.2                                  Composer plugin that wraps all composer vendor packages inside your own namespace. Intended ...
vlucas/phpdotenv                               v5.5.0                                 Loads environment variables from `.env` to `getenv()`, `$_ENV` and `$_SERVER` automagically.
wp-coding-standards/wpcs                       dev-hotifx/escape-output-sniff 4a48492 PHP_CodeSniffer rules (sniffs) to enforce WordPress coding conventions
yoast/phpunit-polyfills                        1.1.0                                  Set of polyfills for changed PHPUnit functionality to allow for creating PHPUnit cross-versi...
yoast/wp-test-utils                            1.2.0                                  PHPUnit cross-version compatibility layer for testing plugins and themes build for WordPress
  • Suite configuration:
# Unit test suite configuration
#
# Run unit and "WordPress unit" tests.

actor: UnitTester
bootstrap: _bootstrap.php
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant