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

Test enhancement #1

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@
"autoload-dev": {
"psr-4": {
"Brick\\Reflection\\Tests\\": "tests/"
}
},
"files": [
"tests/reflectedFunc.php",
"tests/reflectedParameterFunc.php"
]
}
}
}
43 changes: 43 additions & 0 deletions tests/ImportResolverTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,47 @@ public function testAliasedImport()
$this->assertResolve(Tools::class . '\A', 'Tools\A');
$this->assertResolve(Tools::class . '\A\B', 'Tools\A\B');
}

/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage Cannot infer the file name from the given ReflectionObject
*/
public function testConstructorWithInvalidInferFileNameShouldThrowInvalidArgumentException()
{
$resolver = new ImportResolver(new \ReflectionObject(new \Exception));
}

public function testConstructorWithReflectionProperty()
{
$resolver = new ImportResolver(new \ReflectionProperty(ReflectionTarget::class, 'foo'));

$this->assertResolve(ReflectionTarget::class, 'ReflectionTarget');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're not testing against $resolver here, you need to use assertSame(..., $resolver->resolve(...

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right. The assertResolve will not be tested the correct test.
I use the assertSame instead of the assertResolve.

}

public function testConstructorWithReflectionMethod()
{
$resolver = new ImportResolver(new \ReflectionMethod(ReflectionTarget::class, 'publicStaticMethod'));

$this->assertResolve('Brick\Reflection\Tests\publicStaticMethod', 'publicStaticMethod');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, the first line is unused.

}

public function testConstructorWithReflectionParameter()
{
$resolver = new ImportResolver(new \ReflectionParameter([
ReflectionTarget::class, 'privateFunc',
], 'str'));

$this->assertResolve('Brick\Reflection\Tests\privateFunc', 'privateFunc');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

}

/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage Cannot infer the declaring class from the given ReflectionFunction
*/
public function testConstructorWithReflectedFunctionShouldThrowInvalidArgumentException()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very long name, please rename to testConstructorWithReflectionFunctionThrowsException

{
$resolver = new ImportResolver(new \ReflectionFunction('Brick\Reflection\Tests\reflectedFunc'));

$this->assertNull($resolver);
Copy link
Member

@BenMorel BenMorel Mar 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This statement will never be reached, you can remove it (and remove the assignment above).

}
}
47 changes: 47 additions & 0 deletions tests/ReflectionTarget.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?php

namespace Brick\Reflection\Tests;

/**
* The Reflection Target class.
*/
class ReflectionTarget
{
/**
* @param string $foo
Copy link
Member

@BenMorel BenMorel Mar 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be @var, and no variable name

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, just noticed that you're actually testing that it returns no types. Anyway, I don't think it's a good idea to put an invalid docblock in here. Maybe the best thing to do is to remove the docblock altogether?

Copy link
Author

@peter279k peter279k Mar 6, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's not the good way to remove the $foo docblock bcause it will output the following error message.

1) Brick\Reflection\Tests\ReflectionToolsTest::testGetPropertyTypesShouldReturnEmptyArray
TypeError: preg_match() expects parameter 2 to be string, boolean given

/home/lee/reflection/src/ReflectionTools.php:174
/home/lee/reflection/tests/ReflectionToolsTest.php:56

It will be failed when excuting the preg_match function.
I think we just keep the invalid docblock to test whether it returns the no types.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was a bug in ReflectionTools, I never realized that getDocComment() could return false! I just fixed it, and reported the documentation mistake on php.net.

You can now safely remove the docblock in the test!

*/
private $foo;

/**
* @var string $bar
Copy link
Member

@BenMorel BenMorel Mar 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be @var string, without variable name

*/
private $bar;

/**
* @var \\Exception $barWithType
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra \ here

*/
private $barWithType;

public function __construct()
{
$this->foo = 'foo';
$this->bar = 'bar';
}

/**
* @param string $str
* @return string $str
Copy link
Member

@BenMorel BenMorel Mar 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be @return string, no variable name

*/
private function privateFunc(string $str)
{
return $str;
}

/**
* @return void
*/
public static function publicStaticMethod()
{
return 'publicStaticMethod';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need to return anything here. You've declared it @return void, let's remove the body.

}
}
79 changes: 79 additions & 0 deletions tests/ReflectionToolsTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,85 @@ public function testGetMethodsDoesNotReturnStaticMethods()
$this->assertCount(0, $methods);
}

public function testGetReflectionFunction()
{
$reflectionFunc = function()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't have to provide a body, just = function() {}; will be shorter.

{
return 'reflectedFunction';
};
$functions = (new ReflectionTools)->getReflectionFunction($reflectionFunc);

$this->assertCount(0, $functions->getParameters());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would actually be better to check that $function (without s, please) is an instance of ReflectionFunction and that getName() returns the proper value!

}

public function testGetFunctionParameterTypesShouldReturnEmptyArray()
{
$functions = (new ReflectionTools)->getFunctionParameterTypes(new \ReflectionFunction('Brick\Reflection\Tests\reflectedFunc'));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would call it $types here!


$this->assertCount(0, $functions);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Redundant with the test below it, you can remove this line.

$this->assertSame([], $functions);
}

public function testGetFunctionParameterTypesShouldReturnTypesArray()
{
$functions = (new ReflectionTools)->getFunctionParameterTypes(new \ReflectionFunction('Brick\Reflection\Tests\reflectedParameterFunc'));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be called $types as well.


$this->assertCount(1, $functions);
$this->assertSame('string', $functions['arg'][0]);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you test the actual array returned with assertSame() instead of these 2 lines?

}

public function testGetParameterTypesShouldReturnTypeArray()
{
$parameters = (new ReflectionTools)->getParameterTypes(new \ReflectionParameter([
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be called $types as well.

ReflectionTarget::class, 'privateFunc',
], 'str'));

$this->assertCount(1, $parameters);
$this->assertSame('string', $parameters[0]);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, please replace with assertSame([...], ...

}

public function testGetPropertyTypesShouldReturnEmptyArray()
{
$properties = (new ReflectionTools)->getPropertyTypes(new \ReflectionProperty(ReflectionTarget::class, 'foo'));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be called $types


$this->assertCount(0, $properties);
}

public function testGetPropertyTypesShouldReturnTypeArray()
{
$properties = (new ReflectionTools)->getPropertyTypes(new \ReflectionProperty(ReflectionTarget::class, 'bar'));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be called $types


$this->assertCount(1, $properties);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should use assertSame()

}

public function testGetPropertyClassShouldReturnNull()
{
$propertyClass = (new ReflectionTools)->getPropertyClass(new \ReflectionProperty(ReflectionTarget::class, 'foo'));

$this->assertNull($propertyClass);
}

public function testGetPropertyClassShouldReturnTypeString()
{
$propertyClass = (new ReflectionTools)->getPropertyClass(new \ReflectionProperty(ReflectionTarget::class, 'barWithType'));

$this->assertSame('\Exception', $propertyClass);
}

public function testGetFunctionNameShouldReturnClassMethodName()
{
$functionName = (new ReflectionTools)->getFunctionName(new \ReflectionMethod(ReflectionTarget::class, 'publicStaticMethod'));

$this->assertSame('Brick\Reflection\Tests\ReflectionTarget::publicStaticMethod', $functionName);
}

public function testGetFunctionNameShouldReturnCurrentFunctionName()
{
$functionName = (new ReflectionTools)->getFunctionName(new \ReflectionFunction('Brick\Reflection\Tests\reflectedFunc'));

$this->assertSame('Brick\Reflection\Tests\reflectedFunc', $functionName);
}

/**
* @return void
*/
Expand Down
11 changes: 11 additions & 0 deletions tests/reflectedFunc.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

namespace Brick\Reflection\Tests;

/**
* The Target Reflection function without parameter.
*/
function reflectedFunc()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you merge these 2 functions into one file, functions.php?

{
return 'test';
}
12 changes: 12 additions & 0 deletions tests/reflectedParameterFunc.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?php

namespace Brick\Reflection\Tests;

/**
* The Target Reflection function with string parameter.
* @param string $arg
*/
function reflectedParameterFunc(string $arg)
{
return isset($arg) ? $arg : 'test';
}