CODEWITHSUNDEEP
phpphpunit
John Smith
John Smith

Reputation: 6197

Phpunit, how to test if method does "nothing"?

class Testme()
{
    public function testMe ($a)
    {
        if ($a == 1)
        {
            throw new Exception ('YAY');
        }
    }
}

so its easy to test if it threw exception

/**
 * @expectedException Exception
 */
public function test()
{
    new Testme(1);
}

but what if it didn't do anything?

public function test()
{
    new Testme(2);
 ?? ? ? ? ?
}

Upvotes: 42

Views: 25629

Answers (8)

Tomas Votruba
Tomas Votruba

Reputation: 24280

2018+

Nowadays the best practice is annotation exactly for these cases:

/**
 * @doesNotPerformAssertions
 */
public function testSomething()
{
    $someService = new SomeObject();
    $someService->shallNotFail();
}

Upvotes: 11

Chyngyz Sagynov
Chyngyz Sagynov

Reputation: 161

public function testThrowingException()
{
    $this->expectException(Exception::class);
    $this->expectExceptionMessage('YAY');
    (new Testme())->testMe(1);
}

public function testNotThrowingException()
{
    $this->expectNotToPerformAssertions();
    (new Testme())->testMe(2);
}

Upvotes: 2

Nicholas Betsworth
Nicholas Betsworth

Reputation: 1793

In PHPUnit 7.2+ you can also use TestCase::expectNotToPerformAssertions()

public function test()
{
    // ...

    $this->expectNotToPerformAssertions();
}

This has the same behaviour as the @doesNotPerformAssertions annotation.

Upvotes: 21

Naveen
Naveen

Reputation: 852

This is an very interesting question, although lot of answers were written, none of them seems to properly answer the question, since you have asked using the class let me explain this way.

Please keep in mind that an instance method you have created in class should have only 2 intentions.

  1. It can alter the state of a class ( change the class properties like private variables )
  2. It returns the state of the class ( getters )

any thing other than this is meaningless unless it is a static method. for example if you have class like this

class Foo {

   private $prop = null;
   public function fooMethod() {
      $this->prop = "string";
   }
   public function getProp() {
     return $this->prop;
   }
}

the method fooMethod() does not return any thing, but it affects the state of $prop property in the class, you can test the method by 

$this->assertNotNull( $instance->getProp() );

because you knew if this method is run then the prop $prop should be affected and state of that variable is changed.

Miscellanous Scenario: My method doesn't alter the state and also won't return any state variables.

Then the method is static. It should not be an instance method, and the static methods usually have return type, because they cant affect the state of the class and also can't return state variables. This constraints the static methods from storing a result somewhere (unless you store them globals, don't do that ), so it should definitely return some output. If you don't want to return output, then you could consider returning a boolean from static method.

Upvotes: 1

Xavi Montero
Xavi Montero

Reputation: 10664

Scenarios

You have two possible scenarios for a function to do nothing:

Scenario 1: No return statement

Your function does nothing because you do not perform actions in it and you do not include the return keyword in it:

public function doNothing()
{
    // Do nothing.
}

Scenario 2: With return statement

Your function does nothing because you do not perform actions in it and you do include the return keyword in it without expressing any return value:

public function doNothing()
{
    // Do nothing.
    return;
}

Other scenarios

I will leave out of the cases to treat the following scenarios:

  1. Case in which you do not return anything but you perform significant actions that can be tested on other objects. In this case you must unit-test the resulting states of the modified objects.

  2. Case in which you do nothing but return something, then you should unit-test the return value.

Exploring the documentation in the PHP manual

For the first case, the PHP manual documents that the evaluated expression of the function will be null. It says here: http://php.net/manual/en/functions.returning-values.php in a note:

If the return is omitted the value NULL will be returned.

For the second case, the PHP manual documents that the evaluated expression of the funcion will also be null. It says here: http://php.net/manual/en/function.return.php in a note:

If no parameter is supplied, then the parentheses must be omitted and NULL will be returned. [...]

Conclusion

It is therefore clearly documented that a function that "does nothing" necessarily evaluates to null.

How to test a function that does nothing

Just assert your expectations:

$this->assertNull( $sut->doNothing() );

This way you "exercise" your function, you run over it making the code-coverage complete all the lines, and you "expect" that "nothing happened" by testing the null value of its evaluation as an expression, as documented.

How to test a constructor that does nothing

Nevertheless to test a constructor... well... common sense: What's the purpose of a constructor? Create an object (instance) of a certain type (class), right?

So... I prefer to start the 100% of my unit tests by checking that the $sut has been created. This is the VERY first test I write when I'm writing the code of a new class. This is the test I write even before the class exists. At the end, this is what the constructor is for. Red bar. Then I create the class. Green bar.

Let's say I have an Email class that takes a string and will be only created if a valid email is passed and throws exception otherwise. this is very similar to your question. A constructor that just "allows the creation" or "denies it by exploding the system".

I usually would do something like this:

//-------------------------------------------------//
// Tests                                           //
//-------------------------------------------------//

/** @dataProvider validEmailProvider **/
public function testCreationIsOfProperClass( string $email )
{
    $sut = $this->getSut( $validEmail );
    $this->assertInstanceOf( Email::class, $sut );
}

/** @dataProvider invalidEmailProvider **/
public function testCreationThrowsExceptionIfEmailIsInvalid( string $invalidEmail )
{
    $this->expectException( EmailException::class );
    $this->getSut( $invalidEmail );
}

//-------------------------------------------------//
// Data providers                                  //
//-------------------------------------------------//

public function validEmailProvider() : array
{
    return
    [
        [ '[email protected]' ],
        [ 'bob.with-several+symbols@subdomain.another.subdomain.example.verylongTLD' ],
    ]
}

public function invalidEmailProvider() : array
{
    return
    [
        [ 'missing_at_symbol' ],
        [ 'charlie@cannotBeOnlyTld' ],
    ]
}

//-------------------------------------------------//
// Sut creators                                    //
//-------------------------------------------------//

private function getSut( string $email ) : Email
{
    return new Email( $email );
}

As I use PHP 7.0 and I put types everywhere, both entering the parameters and also in the return types, if the created object was not an Email, the getSut() function would fail first.

But even if I wrote it omitting the return type, the test tests what it is expected to happen: new Email( '[email protected]' ); is itself an expression that shoud evaluate to "something" of class Email::class.

How to test a constructor that does something

Code smell. The constructor probably should not do work. If any, just store parameters. If the constructor "does work" other than storing parameters consider lazy-processing on getters, or delegating that work in a factory or so.

How to test a constructor that "does nothing but store parameters"

Just like before + then get the data.

  1. Test in your first test that the creation is an instance of something.
  2. Then in another different test, exercise something like a getter that gets you what entered in the constructor even if the constructor did not anything (other than storing it).

Hope that this helps.

Upvotes: 27

totas
totas

Reputation: 10760

I stumled upon the same problem. To ensure "nothing" has happened it's enough to just call you the method in your unit test. If it fails the test will fail anyway.

If you just call your method without the @expectedException annotation like this

public function test()
{
    new Testme(1);
}

you'll get an error

There was 1 error:

1) Testme::testMe
Exception: YAY

Upvotes: -1

Quasdunk
Quasdunk

Reputation: 15220

Note: The credits for this solution go to this related answer. The context may seem a little different, but the solution / workaround works the same way. Testing that an exception is not thrown is just the same as testing a method with no return value.

According to this issue thread, there is no built in solution for testing something like DoesNotThrowException in PHPUnit (yet).

So yes, one solution would be to return some dummy value from your method, like

public function testMe ($a)
{
    if ($a == 1) { throw new Exception ('YAY'); }

    return true;
}

and then assert it in your test. But if you don't want to change the code just for the test, you can work around it:

public function testExceptionIsNotThrown()
{
    try {
        new Testme(2);
    }
    catch(Exception $e) {
        /* An exception was thrown unexpectedly, so fail the test */
        $this->fail();
    }

    /* No exception was thrown, so just make a dummy assertion to pass the test */
    $this->assertTrue(true);
}

It may seem hacky and not very intuitive, but if it's stupid but it works, it's not stupid.

Upvotes: 3

Brejk
Brejk

Reputation: 454

It's not possible. Add return statement and assert the result. 

class Testme()
{
    public function testMe ($a)
    {
        if ($a == 1)
        {
            throw new Exception ('YAY');
        }

        return true;
    }
}

and then 

$object = new Testme();
$this->assertTrue($object->testMe(2));

Upvotes: 3

Related Questions