Issue #3260879 by danielspeicher, jurgenhaas: Test trait ServiceTrait (751fa699) · Commits · project / eca

src/Service/ServiceTrait.php

+5 −7

Original line number	Diff line number	Diff line
		@@ -6,8 +6,6 @@ use Drupal\Component\Plugin\PluginInspectionInterface;
		use Drupal\Core\Form\FormState;
		use Drupal\Core\Plugin\PluginFormInterface;
		use Drupal\Core\StringTranslation\StringTranslationTrait;
		use Drupal\eca\Plugin\ECA\Condition\ConditionInterface;
		use Drupal\eca\Plugin\ECA\Event\EventInterface;
		use Drupal\eca\Plugin\OptionsInterface;

		/**
		@@ -43,7 +41,7 @@ trait ServiceTrait {
		* @param array $fields
		* The array to which the fields should be added.
		* @param array $config
		* The array received from defaultConfiguraiton of actions and conditions.
		* The array received from defaultConfiguration of actions and conditions.
		* @param \Drupal\Component\Plugin\PluginInspectionInterface $plugin
		* The plugin to which the field belong to.
		*/
		@@ -163,17 +161,17 @@ trait ServiceTrait {
		/**
		* Prepares a field as a checkbox.
		*
		* @param $name
		* @param string $name
		* The field name.
		* @param $label
		* @param string $label
		* The field label.
		* @param $value
		* @param string $value
		* The default value for the field.
		*
		* @return array
		* Prepared checkbox field.
		*/
		protected function checkbox($name, $label, $value): array {
		protected function checkbox(string $name, string $label, string $value): array {
		return [
		'name' => $name,
		'label' => $label,

tests/src/Unit/Service/ServiceTraitTest.php

0 → 100644

+336 −0

Original line number	Diff line number	Diff line
		<?php

		namespace Drupal\Tests\eca\Unit\Service;

		use Drupal\Component\Plugin\PluginInspectionInterface;
		use Drupal\eca\Plugin\Action\ConfigurableActionBase;
		use Drupal\eca\Plugin\ECA\Condition\StringComparisonBase;
		use Drupal\eca\Service\Conditions;
		use Drupal\eca\Service\ServiceTrait;
		use Drupal\Tests\UnitTestCase;
		use PHPUnit\Framework\MockObject\MockObject;

		/**
		* Tests the service trait.
		*
		* @group eca
		*/
		class ServiceTraitTest extends UnitTestCase {

		use ServiceTrait;

		/**
		* Gets the expected option fields.
		*
		* @param string $name
		* @param string $label
		*
		* @return array
		*/
		private static function getExpectedOptionFields(string $name, string $label): array {
		return [
		'name' => $name,
		'label' => $label,
		'type' => 'Dropdown',
		'value' => 'testValue',
		'extras' => [
		'choices' => [
		[
		'name' => 'name1',
		'value' => 'value1',
		],
		[
		'name' => 'name2',
		'value' => 'value2',
		],
		[
		'name' => 'name3',
		'value' => 'value3',
		],
		],
		],
		];
		}

		/**
		* Gets the expected checkbox.
		*
		* @param string $name
		* @param string $label
		* @param string $condition
		*
		* @return array
		*/
		private static function getExpectedCheckbox(string $name, string $label, string $condition): array {
		return [
		'name' => $name,
		'label' => $label,
		'type' => 'Dropdown',
		'value' => $condition,
		'extras' => [
		'choices' => [
		[
		'name' => 'no',
		'value' => Conditions::OPTION_NO,
		],
		[
		'name' => 'yes',
		'value' => Conditions::OPTION_YES,
		],
		],
		],
		];
		}

		/**
		* Tests the sort of plugins.
		*
		* @return void
		*/
		public function testSortPlugins(): void {
		$plugins = [];
		foreach ([
		'testPluginB',
		'testPluginC',
		'testPluginA',
		'testPluginC',
		] as $label) {
		$plugins[] = $this->getPluginMock($label);
		}
		$this->sortPlugins($plugins);
		foreach ([
		'testPluginA',
		'testPluginB',
		'testPluginC',
		'testPluginC',
		] as $key => $label) {
		$this->assertEquals($label, $plugins[$key]->getPluginDefinition()['label']);
		}
		}

		/**
		* Gets plugin mocks by the given label.
		*
		* @param string $label
		*
		* @return MockObject
		*/
		private function getPluginMock(string $label): MockObject {
		$mockObject = $this->createMock(PluginInspectionInterface::class);
		$mockObject->method('getPluginDefinition')->willReturn([
		'label' => $label,
		]);
		return $mockObject;
		}

		/**
		* Tests the method prepare config fields with boolean.
		*
		* @return void
		*/
		public function testPrepareConfigFieldsWithBoolean(): void {
		$fields = [];
		$pluginInspection = $this->createMock(PluginInspectionInterface::class);
		$config = [
		'testKey' => TRUE,
		];
		$this->prepareConfigFields($fields, $config, $pluginInspection);
		$this->assertEquals($this->getExpectedCheckbox('testKey', 'TestKey', Conditions::OPTION_YES),
		$fields[0]);
		}

		/**
		* Tests the method prepare config fields with array.
		*
		* @return void
		*/
		public function testPrepareConfigFieldsWithArray(): void {
		$fields = [];
		$pluginInspection = $this->createMock(PluginInspectionInterface::class);
		$config = [
		'testKey' => [
		'a',
		'b',
		'c',
		],
		];
		$this->prepareConfigFields($fields, $config, $pluginInspection);
		$expectedFields = [
		'name' => 'testKey',
		'label' => 'TestKey',
		'type' => 'String',
		'value' => 'a,b,c',
		];
		$this->assertEquals($expectedFields, $fields[0]);
		}

		/**
		* Tests the method prepare config fields with options.
		*
		* @return void
		*/
		public function testPrepareConfigFieldsWithOptions(): void {
		$fields = [];
		$pluginInspection = $this->createMock(StringComparisonBase::class);
		$pluginInspection->expects($this->once())->method('getOptions')
		->with('testKey')->willReturn([
		'value1' => 'name1',
		'value2' => 'name2',
		'value3' => 'name3',
		]);
		$config = [
		'testKey' => 'testValue',
		];
		$this->prepareConfigFields($fields, $config, $pluginInspection);
		$this->assertEquals($this->getExpectedOptionFields('testKey', 'TestKey'),
		$fields[0]);
		}

		/**
		* Tests the method prepare config fields with form textarea.
		*
		* @return void
		*/
		public function testPrepareConfigFieldsWithFormTextarea(): void {
		$fields = [];
		$pluginInspection = $this->getActionBaseMockByType('textarea');
		$config = [
		'testKey' => 'testValue',
		];
		$this->prepareConfigFields($fields, $config, $pluginInspection);
		$expectedFields = [];
		$expectedFields[] = [
		'name' => 'testKey',
		'label' => 'title',
		'type' => 'Text',
		'value' => 'testValue',
		];
		$this->assertEquals($expectedFields, $fields);
		}

		/**
		* Tests the method prepare config fields with form select.
		*
		* @return void
		*/
		public function testPrepareConfigFieldsWithFormSelect(): void {
		$fields = [];
		$pluginInspection = $this->getActionBaseMockByType('select');
		$config = [
		'testKey' => 'testValue',
		];
		$this->prepareConfigFields($fields, $config, $pluginInspection);
		$expectedFields = [];
		$expectedFields[] = [
		'name' => 'testKey',
		'label' => 'title',
		'type' => 'Dropdown',
		'value' => 'testValue',
		'extras' => [
		'choices' => [
		[
		'name' => 'name1',
		'value' => 'value1',
		],
		[
		'name' => 'name2',
		'value' => 'value2',
		],
		],
		],
		];
		$this->assertEquals($expectedFields, $fields);
		}

		/**
		* Gets the mock by the given type.
		*
		* @param string $type
		*
		* @return PluginInspectionInterface
		*/
		private function getActionBaseMockByType(string $type): PluginInspectionInterface {
		$pluginInspection = $this->createMock(ConfigurableActionBase::class);
		$form = [];
		$form['testKey'] = [
		'#title' => 'title',
		'#type' => $type,
		];
		if ($type === 'select') {
		$form['testKey']['#options'] = [
		'value1' => 'name1',
		'value2' => 'name2',
		];
		}
		$pluginInspection->expects($this->once())->method('buildConfigurationForm')
		->willReturn($form);
		return $pluginInspection;
		}

		/**
		* Tests the method fieldLabel with NULL value.
		*
		* @return void
		*/
		public function testFieldLabelWithNull(): void {
		$this->assertEquals('A test key',
		$this->fieldLabel(NULL, 'a_test_key'));
		}

		/**
		* Tests the method fieldLabel.
		*
		* @return void
		*/
		public function testFieldLabelWithLabel(): void {
		$this->assertEquals('Test Label',
		$this->fieldLabel('Test Label', 'a_test_key'));
		}

		/**
		* Tests the optionsField method.
		*
		* @return void
		*/
		public function testOptionsField(): void {
		$expected = self::getExpectedOptionFields('test', 'This is a test');

		$this->assertEquals($expected, $this->optionsField('test', 'This is a test',NULL, [
		'value1' => 'name1',
		'value2' => 'name2',
		'value3' => 'name3',
		], 'testValue'));
		}

		/**
		* Tests the optionsField with description.
		*
		* @return void
		*/
		public function testOptionsFieldWithDescription(): void {
		$expected = self::getExpectedOptionFields('test', 'This is a test');
		$expected['description'] = 'Test description';

		$this->assertEquals($expected, $this->optionsField('test', 'This is a test','Test description',
		[
		'value1' => 'name1',
		'value2' => 'name2',
		'value3' => 'name3',
		], 'testValue'));
		}

		/**
		* Tests the checkbox method.
		*
		* @return void
		*/
		public function testCheckBox(): void {
		$expected = $this->getExpectedCheckbox('test', 'testLabel', Conditions::OPTION_YES);
		$this->assertEquals($expected,
		$this->checkbox('test', 'testLabel', 'testValue'));
		$expected['value'] = 'no';
		$this->assertEquals($expected,
		$this->checkbox('test', 'testLabel', ''));
		}

		}
		No newline at end of file