sakharovmaksim/annotation-processor

Utility for parsing constants from the description of the test methods. Created by tutu.ru

1.0.3 2018-05-17 14:11 UTC

Requires

• php: ^7.1
• erusev/parsedown: ^1.0
• phpunit/phpunit: ^6.0 || ^7.0

MIT

• Sakharov Maksim

README

Install

1. Download project from the repository

Navigate to the directory where you want to store the directory with project. For instance, your home directory cd ~.

git clone [e-mail]:sakharovmaksim/annotation-processor.git

And when downloading is done, navigate to the project directory cd annotation-processor.

2. Install dependencies

composer install

Usage

1. In your TestCase class

In your TestCase class, in setUp() method, which extends from \PHPUnit\Framework\TestCase create and use function like:

public function setUp()
{
	$this->_processAnnotations();
}

private function _processAnnotations()
{
	$class = get_class($this);
	$methodName = $this->getName(false);
	$annotationProcessor = new AnnotationProcessor($class, $methodName);
	// @domains
	if ($domainsExcept = $annotationProcessor->process(new Annotation\ArrayAnnotation(AnnotationsNames::DOMAINS_EXCEPT)))
	{
		if (Env::isRC() && in_array(Env::RC, $domainsExcept))
		{
			$this->markTestSkipped("Skip the test that is not for RC: {$class}::{$methodName}");
		}
		elseif (Env::isProduction() && in_array(Env::PROD, $domainsExcept))
		{
			$this->markTestSkipped("Skip the test that is not for Production: {$class}::{$methodName}");
		}
		elseif (Env::isStand() && in_array(Env::STAND, $domainsExcept))
		{
			$this->markTestSkipped("Skip the test that is not for stands: {$class}::{$methodName}");
		}
	}
	// @bug
	if ($annotationProcessor->process(new Annotation\BoolAnnotation(AnnotationsNames::BUG)))
	{
		$this->markTestSkipped("Skip the test {$class}::{$methodName}, because it has deactivated due to a @bug!");
	}
	// @todocase
	if ($annotationProcessor->process(new Annotation\BoolAnnotation(AnnotationsNames::TODOCASE)))
	{
		$this->markTestSkipped("Skip the test {$class}::{$methodName}, because it has @todocase, write it!");
	}
}

This function, when starting each test, will analyze the constants from the description and apply the actions described in the function above.

2. Create AnnotationsNames file with annotation constants

Use constants in _processAnnotations()

class AnnotationsNames
{
	const DOMAINS_EXCEPT = '@domainsExcept';
	const BUG = '@bug';
	const TODOCASE = '@todocase';
}

3. Usage in tests annotations

/**
 * @labels Labels::RELEASE
 * @todocase Проверка поиска "Только туда"
 */
public function testSearchOW() {}

4. Run unit-tests for project

sh run_tests.sh

5. Deploy

Travis CI run unit-tests for all Pull Requests. Look '.travis.yml'-file with CI-config

Created by tutu.ru