TypeProcessorTest Class Reference

Inheritance diagram for TypeProcessorTest:

Public Member Functions
	testGetTypesData ()
	testSetTypesData ()
	testGetTypeDataInvalidArgumentException ()
	testGetTypeData ()
	testSetTypeDataArrayMerge ()
	testNormalizeType ()
	testIsTypeSimple ()
	testIsTypeAny ()
	testIsArrayType ()
	testIsValidTypeDeclaration ()
	getArrayItemType ()
	testTranslateTypeName ()
	testTranslateTypeNameInvalidArgumentException ()
	testTranslateArrayTypeName ()
	testProcessSimpleTypeIntToString ()
	testProcessSimpleTypeStringToInt ()
	testProcessSimpleTypeMixed ()
	testProcessSimpleTypeIntArrayToStringArray ()
	testProcessSimpleTypeStringArrayToIntArray ()
	testProcessSimpleTypeException ($value, $type)
	testProcessSimpleTypeInvalidType ()
	testGetParamTypeWithIncorrectAnnotation ()
	testGetArrayParamType (string $methodName, string $type)
	arrayParamTypeDataProvider ()
	testGetParameterDescription (string $methodName, array $descriptions)
	methodParamsDataProvider ()
	testGetOperationName ()
	testGetReturnTypeWithInheritDocBlock ()
	testGetReturnTypeWithoutReturnTag ()

Static Public Member Functions
static	processSimpleTypeExceptionProvider ()

Protected Member Functions
	setUp ()

Detailed Description

Definition at line 14 of file TypeProcessorTest.php.

Member Function Documentation

arrayParamTypeDataProvider()

arrayParamTypeDataProvider

(

)

Get list of methods with expected param types.

Returns

array

Definition at line 277 of file TypeProcessorTest.php.

    {
        return [
            ['method name' => 'addData', 'type' => 'array[]'],
            ['method name' => 'addObjectList', 'type' => 'TSampleInterface[]']
        ];
    }

getArrayItemType()

getArrayItemType

(

)

Definition at line 141 of file TypeProcessorTest.php.

    {
        $this->assertEquals('string', $this->typeProcessor->getArrayItemType('str[]'));
        $this->assertEquals('string', $this->typeProcessor->getArrayItemType('string[]'));
        $this->assertEquals('integer', $this->typeProcessor->getArrayItemType('int[]'));
        $this->assertEquals('boolean', $this->typeProcessor->getArrayItemType('bool[]'));
        $this->assertEquals('any', $this->typeProcessor->getArrayItemType('mixed[]'));
    }

methodParamsDataProvider()

methodParamsDataProvider

(

)

Gets list of method names with params and their descriptions.

Returns

array

Definition at line 311 of file TypeProcessorTest.php.

    {
        return [
            ['method name' => 'setName', 'descriptions' => ['Name of the attribute']],
            ['method name' => 'setData', 'descriptions' => ['Key is used as index', null]],
        ];
    }

processSimpleTypeExceptionProvider()

static processSimpleTypeExceptionProvider ( )

static

Returns

array

Definition at line 226 of file TypeProcessorTest.php.

    {
        return [
            "int type, string value" => ['test', 'int'],
            "float type, string value" => ['test', 'float'],
        ];
    }

setUp()

setUp ( )

protected

Set up helper.

Definition at line 24 of file TypeProcessorTest.php.

    {
        $this->typeProcessor = new TypeProcessor();
    }

testGetArrayParamType()

testGetArrayParamType	(	string	$methodName,
		string	$type
	)

Checks a case for different array param types.

Parameters

string	$methodName
string	$type	@dataProvider arrayParamTypeDataProvider

Definition at line 264 of file TypeProcessorTest.php.

    {
        $class = new ClassReflection(DataObject::class);
        $methodReflection = $class->getMethod($methodName);
        $params = $methodReflection->getParameters();
        $this->assertEquals($type, $this->typeProcessor->getParamType(array_pop($params)));
    }

testGetOperationName()

testGetOperationName

(

)

Definition at line 319 of file TypeProcessorTest.php.

    {
        $this->assertEquals(
            "resNameMethodName",
            $this->typeProcessor->getOperationName("resName", "methodName")
        );
    }

testGetParameterDescription()

testGetParameterDescription	(	string	$methodName,
		array	$descriptions
	)

Checks a case when method param has additional description.

Parameters

string	$methodName
array	$descriptions	@dataProvider methodParamsDataProvider

Definition at line 292 of file TypeProcessorTest.php.

    {
        $class = new ClassReflection(DataObject::class);
        $methodReflection = $class->getMethod($methodName);
        $paramsReflection = $methodReflection->getParameters();
        foreach ($paramsReflection as $paramReflection) {
            $description = array_shift($descriptions);
            $this->assertEquals(
                $description,
                $this->typeProcessor->getParamDescription($paramReflection)
            );
        }
    }

testGetParamTypeWithIncorrectAnnotation()

testGetParamTypeWithIncorrectAnnotation

(

)

@expectedException \LogicException @expectedExceptionMessageRegExp /

Parameters

annotation

is incorrect for the parameter "name" \w+/

Definition at line 249 of file TypeProcessorTest.php.

    {
        $class = new ClassReflection(DataObject::class);
        $methodReflection = $class->getMethod('setName');
        $paramsReflection = $methodReflection->getParameters();
        $this->typeProcessor->getParamType($paramsReflection[0]);
    }

testGetReturnTypeWithInheritDocBlock()

testGetReturnTypeWithInheritDocBlock

(

)

Checks a case when method has only @inheritdoc annotation.

Definition at line 330 of file TypeProcessorTest.php.

    {
        $expected = [
            'type' => 'string',
            'isRequired' => true,
            'description' => null,
            'parameterCount' => 0
        ];

        $classReflection = new ClassReflection(TSample::class);
        $methodReflection = $classReflection->getMethod('getPropertyName');

        self::assertEquals($expected, $this->typeProcessor->getGetterReturnType($methodReflection));
    }

testGetReturnTypeWithoutReturnTag()

testGetReturnTypeWithoutReturnTag

(

)

Checks a case when method and parent interface don't have @return annotation.

@expectedException \InvalidArgumentException @expectedExceptionMessage Method's return type must be specified using

Returns

annotation. See Magento\Framework\Reflection\Test\Unit\Fixture\TSample::getName()

Definition at line 351 of file TypeProcessorTest.php.

    {
        $classReflection = new ClassReflection(TSample::class);
        $methodReflection = $classReflection->getMethod('getName');
        $this->typeProcessor->getGetterReturnType($methodReflection);
    }

testGetTypeData()

testGetTypeData

(

)

Test retrieval of data type details for the given type name.

Definition at line 66 of file TypeProcessorTest.php.

    {
        $this->typeProcessor->setTypeData('typeA', ['dataA']);
        $this->assertEquals(['dataA'], $this->typeProcessor->getTypeData('typeA'));
    }

testGetTypeDataInvalidArgumentException()

testGetTypeDataInvalidArgumentException

(

)

@expectedException \InvalidArgumentException @expectedExceptionMessage The "NonExistentType" data type isn't declared. Verify the type and try again.

Definition at line 58 of file TypeProcessorTest.php.

    {
        $this->typeProcessor->getTypeData('NonExistentType');
    }

testGetTypesData()

testGetTypesData

(

)

Test Retrieving of processed types data.

Definition at line 32 of file TypeProcessorTest.php.

    {
        $this->typeProcessor->setTypeData('typeA', ['dataA']);
        $this->typeProcessor->setTypeData('typeB', ['dataB']);
        $this->assertEquals(
            ['typeA' => ['dataA'], 'typeB' => ['dataB']],
            $this->typeProcessor->getTypesData()
        );
    }

testIsArrayType()

testIsArrayType

(

)

Definition at line 115 of file TypeProcessorTest.php.

    {
        $this->assertFalse($this->typeProcessor->isArrayType('string'));
        $this->assertTrue($this->typeProcessor->isArrayType('string[]'));
    }

testIsTypeAny()

testIsTypeAny

(

)

Definition at line 107 of file TypeProcessorTest.php.

    {
        $this->assertTrue($this->typeProcessor->isTypeAny('mixed'));
        $this->assertTrue($this->typeProcessor->isTypeAny('mixed[]'));
        $this->assertFalse($this->typeProcessor->isTypeAny('int'));
        $this->assertFalse($this->typeProcessor->isTypeAny('int[]'));
    }

testIsTypeSimple()

testIsTypeSimple

(

)

Definition at line 96 of file TypeProcessorTest.php.

    {
        $this->assertTrue($this->typeProcessor->isTypeSimple('string'));
        $this->assertTrue($this->typeProcessor->isTypeSimple('string[]'));
        $this->assertTrue($this->typeProcessor->isTypeSimple('int'));
        $this->assertTrue($this->typeProcessor->isTypeSimple('float'));
        $this->assertTrue($this->typeProcessor->isTypeSimple('double'));
        $this->assertTrue($this->typeProcessor->isTypeSimple('boolean'));
        $this->assertFalse($this->typeProcessor->isTypeSimple('blah'));
    }

testIsValidTypeDeclaration()

testIsValidTypeDeclaration

(

)

Definition at line 121 of file TypeProcessorTest.php.

    {
        $this->assertTrue($this->typeProcessor->isValidTypeDeclaration('Traversable')); // Interface
        $this->assertTrue($this->typeProcessor->isValidTypeDeclaration('stdObj')); // Class
        $this->assertTrue($this->typeProcessor->isValidTypeDeclaration('array'));
        $this->assertTrue($this->typeProcessor->isValidTypeDeclaration('callable'));
        $this->assertTrue($this->typeProcessor->isValidTypeDeclaration('self'));
        $this->assertTrue($this->typeProcessor->isValidTypeDeclaration('self'));
        $this->assertFalse($this->typeProcessor->isValidTypeDeclaration('string'));
        $this->assertFalse($this->typeProcessor->isValidTypeDeclaration('string[]'));
        $this->assertFalse($this->typeProcessor->isValidTypeDeclaration('int'));
        $this->assertFalse($this->typeProcessor->isValidTypeDeclaration('float'));
        $this->assertFalse($this->typeProcessor->isValidTypeDeclaration('double'));
        $this->assertFalse($this->typeProcessor->isValidTypeDeclaration('boolean'));
        $this->assertFalse($this->typeProcessor->isValidTypeDeclaration('[]'));
        $this->assertFalse($this->typeProcessor->isValidTypeDeclaration('mixed[]'));
        $this->assertFalse($this->typeProcessor->isValidTypeDeclaration('stdObj[]'));
        $this->assertFalse($this->typeProcessor->isValidTypeDeclaration('Traversable[]'));
    }

testNormalizeType()

testNormalizeType

(

)

Definition at line 87 of file TypeProcessorTest.php.

    {
        $this->assertEquals('blah', $this->typeProcessor->normalizeType('blah'));
        $this->assertEquals('string', $this->typeProcessor->normalizeType('str'));
        $this->assertEquals('int', $this->typeProcessor->normalizeType('integer'));
        $this->assertEquals('boolean', $this->typeProcessor->normalizeType('bool'));
        $this->assertEquals('anyType', $this->typeProcessor->normalizeType('mixed'));
    }

testProcessSimpleTypeException()

testProcessSimpleTypeException	(		$value,
			$type
	)

@dataProvider processSimpleTypeExceptionProvider

Definition at line 214 of file TypeProcessorTest.php.

    {
        $this->expectException(
            SerializationException::class,
            'Invalid type for value: "' . $value . '". Expected Type: "' . $type . '"'
        );
        $this->typeProcessor->processSimpleAndAnyType($value, $type);
    }

testProcessSimpleTypeIntArrayToStringArray()

testProcessSimpleTypeIntArrayToStringArray

(

)

Definition at line 197 of file TypeProcessorTest.php.

    {
        $value = [1, 2, 3, 4, 5];
        $type = 'string[]';
        $this->assertSame(['1', '2', '3', '4', '5'], $this->typeProcessor->processSimpleAndAnyType($value, $type));
    }

testProcessSimpleTypeIntToString()

testProcessSimpleTypeIntToString

(

)

Definition at line 176 of file TypeProcessorTest.php.

    {
        $value = 1;
        $type = 'string';
        $this->assertSame('1', $this->typeProcessor->processSimpleAndAnyType($value, $type));
    }

testProcessSimpleTypeInvalidType()

testProcessSimpleTypeInvalidType

(

)

@expectedException \Magento\Framework\Exception\SerializationException @expectedExceptionMessage The "integer" value's type is invalid. The "int[]" type was expected. Verify and try again.

Definition at line 238 of file TypeProcessorTest.php.

    {
        $value = 1;
        $type = 'int[]';
        $this->typeProcessor->processSimpleAndAnyType($value, $type);
    }

testProcessSimpleTypeMixed()

testProcessSimpleTypeMixed

(

)

Definition at line 190 of file TypeProcessorTest.php.

    {
        $value = 1;
        $type = 'mixed';
        $this->assertSame(1, $this->typeProcessor->processSimpleAndAnyType($value, $type));
    }

testProcessSimpleTypeStringArrayToIntArray()

testProcessSimpleTypeStringArrayToIntArray

(

)

Definition at line 204 of file TypeProcessorTest.php.

    {
        $value = ['1', '2', '3', '4', '5'];
        $type = 'int[]';
        $this->assertSame([1, 2, 3, 4, 5], $this->typeProcessor->processSimpleAndAnyType($value, $type));
    }

testProcessSimpleTypeStringToInt()

testProcessSimpleTypeStringToInt

(

)

Definition at line 183 of file TypeProcessorTest.php.

    {
        $value = '1';
        $type = 'int';
        $this->assertSame(1, $this->typeProcessor->processSimpleAndAnyType($value, $type));
    }

testSetTypeDataArrayMerge()

testSetTypeDataArrayMerge

(

)

Test data type details for the same type name set multiple times.

Definition at line 75 of file TypeProcessorTest.php.

    {
        $this->typeProcessor->setTypeData('typeA', ['dataA1']);
        $this->typeProcessor->setTypeData('typeA', ['dataA2']);
        $this->typeProcessor->setTypeData('typeA', ['dataA3']);
        $this->typeProcessor->setTypeData('typeA', [null]);
        $this->assertEquals(
            ['dataA1', 'dataA2', 'dataA3', null],
            $this->typeProcessor->getTypeData('typeA')
        );
    }

testSetTypesData()

testSetTypesData

(

)

Test set of processed types data.

Definition at line 45 of file TypeProcessorTest.php.

    {
        $this->typeProcessor->setTypeData('typeC', ['dataC']);
        $this->assertEquals(['typeC' => ['dataC']], $this->typeProcessor->getTypesData());
        $typeData = ['typeA' => ['dataA'], 'typeB' => ['dataB']];
        $this->typeProcessor->setTypesData($typeData);
        $this->assertEquals($typeData, $this->typeProcessor->getTypesData());
    }

testTranslateArrayTypeName()

testTranslateArrayTypeName

(

)

Definition at line 171 of file TypeProcessorTest.php.

    {
        $this->assertEquals('ArrayOfComplexType', $this->typeProcessor->translateArrayTypeName('complexType'));
    }

testTranslateTypeName()

testTranslateTypeName

(

)

Definition at line 150 of file TypeProcessorTest.php.

    {
        $this->assertEquals(
            'TestModule1V1EntityItem',
            $this->typeProcessor->translateTypeName(\Magento\TestModule1\Service\V1\Entity\Item::class)
        );
        $this->assertEquals(
            'TestModule3V1EntityParameter[]',
            $this->typeProcessor->translateTypeName('\Magento\TestModule3\Service\V1\Entity\Parameter[]')
        );
    }

testTranslateTypeNameInvalidArgumentException()

testTranslateTypeNameInvalidArgumentException

(

)

@expectedException \InvalidArgumentException @expectedExceptionMessage The "\Magento\TestModule3\V1\Parameter[]" parameter type is invalid. Verify the parameter and try again.

Definition at line 166 of file TypeProcessorTest.php.

    {
        $this->typeProcessor->translateTypeName('\Magento\TestModule3\V1\Parameter[]');
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Reflection/Test/Unit/TypeProcessorTest.php