README.md

PHPUnit Snippets

PHPUnit assertion and test snippets support for Visual Studio Code.

Screenshot

Snippet Trigger

Assertion

Start with assert: and follows support assertion.

For example: Type assert:Equals trigger with tab key, it produces $this->assertEquals($expected, $actual); snippet for you.

Trigger	Snippet
assert:ArrayHasKey	$this->assertArrayHasKey()
assert:ClassHasAttribute	$this->assertClassHasAttribute()
assert:ArraySubset (deprecated in PHPUnit 8)	$this->assertArraySubset()
assert:ClassHasStaticAttribute	$this->assertClassHasStaticAttribute()
assert:Contains	$this->assertContains()
assert:ContainsOnly	$this->assertContainsOnly()
assert:ContainsOnlyInstancesOf	$this->assertContainsOnlyInstancesOf()
assert:Count	$this->assertCount()
assert:DirectoryExists	$this->assertDirectoryExists()
assert:DirectoryIsReadable	$this->assertDirectoryIsReadable()
assert:DirectoryIsWritable	$this->assertDirectoryIsWritable()
assert:Empty	$this->assertEmpty()
assert:EqualXMLStructure	$this->assertEqualXMLStructure()
assert:Equals	$this->assertEquals()
assert:False	$this->assertFalse()
assert:FileEquals	$this->assertFileEquals()
assert:FileExists	$this->assertFileExists()
assert:FileIsReadable	$this->assertFileIsReadable()
assert:FileIsWritable	$this->assertFileIsWritable()
assert:GreaterThan	$this->assertGreaterThan()
assert:GreaterThanOrEqual	$this->assertGreaterThanOrEqual()
assert:Infinite	$this->assertInfinite()
assert:InstanceOf	$this->assertInstanceOf()
assert:InternalType (deprecated in PHPUnit 8)	$this->assertInternalType()
assert:IsArray	$this->assertIsArray()
assert:IsBool	$this->assertIsBool()
assert:IsCallable	$this->assertIsCallable()
assert:IsFloat	$this->assertIsFlat()
assert:IsInt	$this->assertIsInt()
assert:IsIterable	$this->assertIsIterable()
assert:IsNumeric	$this->assertIsNumeric()
assert:IsObject	$this->assertIsObject()
assert:IsResource	$this->assertIsResource()
assert:IsScalar	$this->assertIsScalar()
assert:IsString	$this->assertIsString()
assert:IsReadable	$this->assertIsReadable()
assert:IsWritable	$this->assertIsWritable()
assert:JsonFileEqualsJsonFile	$this->assertJsonFileEqualsJsonFile()
assert:JsonStringEqualsJsonFile	$this->assertJsonStringEqualsJsonFile()
assert:JsonStringEqualsJsonString	$this->assertJsonStringEqualsJsonString()
assert:LessThan	$this->assertLessThan()
assert:LessThanOrEqual	$this->assertLessThanOrEqual()
assert:Nan	$this->assertNan()
assert:Null	$this->assertNull()
assert:ObjectHasAttribute	$this->assertObjectHasAttribute()
assert:RegExp	$this->assertRegExp()
assert:StringMatchesFormat	$this->assertStringMatchesFormat()
assert:StringMatchesFormatFile	$this->assertStringMatchesFormatFile()
assert:Same	$this->assertSame()
assert:StringEndsWith	$this->assertStringEndsWith()
assert:StringEqualsFile	$this->assertStringEqualsFile()
assert:StringStartsWith	$this->assertStringStartsWith()
assert:That	$this->assertThat()
assert:True	$this->assertTrue()
assert:XmlFileEqualsXmlFile	$this->assertXmlFileEqualsXmlFile()
assert:XmlStringEqualsXmlFile	$this->assertXmlStringEqualsXmlFile()
assert:XmlStringEqualsXmlString	$this->assertXmlStringEqualsXmlString()

Incomplete and Skipped Test

Trigger	Snippet
mark:TestIncomplete	$this->markTestIncomplete()
mark:TestSkipped	$this->markTestSkipped()

Expect Exception

Trigger	Snippet
exp:Exception	$this->expectException()
exp:ExceptionCode	$this->expectExceptionCode()
exp:ExceptionMessage	$this->expectExceptionMessage()
exp:ExceptionMessageRegExp	$this->expectExceptionMessageRegExp()

Test and Fixture Snippets

Start with pu: and follows support code completion.

Trigger	Snippet
pu:testCase	Create basic test case class
pu:testFunction	Create base test function
pu:testDoxFunction	Create test function with @testdox annotation
pu:testException (deprecated in PHPUnit 8)	Create test function with @expectedException
pu:assertPreConditions	assertPreConditions(): void
pu:assertPostConditions	assertPostConditions(): void
pu:setUpBeforeClass	setUpBeforeClass(): void
pu:setUp	setUp(): void
pu:tearDown	tearDown(): void
pu:tearDownAfterClass	tearDownAfterClass(): void
pu:onNotSuccessfulTest	onNotSuccessfulTest(): void

Examples

Trigger: pu:testCase

use PHPUnit\Framework\TestCase;

/**
 * ClassNameTest
 * @group group
 */
class ClassNameTest extends TestCase
{
    /** @test */
    public function test_function()
    {
        // Test
    }
}

Trigger: pu:setUp

public function setUp(): void
{
    parent::setUp();
    
    // setup
}

Trigger: pu:tearDown

public function tearDown(): void
{
    // unset
}

Trigger: pu:testFunction

/** @test */
public function test_function()
{
    // Test    
}

Trigger: pu:testDoxFunction

/** 
 * @test
 * @testdox  description
 */
public function test_function()
{
    // Test    
}

Trigger: pu:testException

/** 
 * @test
 * @expectedException  exception
 */
public function test_function()
{
    // Test
}

Enjoy Unit Testing!!