plugin-test

name

plugin-test

description

Writes or runs PHPUnit tests in tests/PluginTest.php for the myadmin-openvz-vps plugin. Use when user says 'add test', 'write test for', 'run tests', or 'test the plugin'. Covers static property assertions, hook registration, method signature checks, source-code analysis via ReflectionClass, and file/template existence. Do NOT use for integration tests against a live OpenVZ server or tests in other packages.

plugin-test

Critical

• All tests live in tests/PluginTest.php — one file, no subdirectories.
• Namespace is Detain\MyAdminOpenvz\Tests. Class is PluginTest extends TestCase.
• Run command: vendor/bin/phpunit tests/ -v
• PHPUnit config: phpunit.xml.dist (bootstrap=autoload.php generated by composer, failOnRisky=true, failOnWarning=true).
• Tests must not call myadmin_log, get_service_define, get_module_settings, or \TFSmarty directly — those globals are unavailable in unit test context. Use ReflectionClass source-analysis instead (read method body as string, assert substrings).
• Always check both 'OPENVZ' and 'SSD_OPENVZ' when asserting type-check behavior.
• declare(strict_types=1); is required at the top of the file.

Instructions

1. Open the test file at tests/PluginTest.php and read its current state before adding anything. Verify PluginTest already has protected function setUp(): void initializing $this->reflection = new ReflectionClass(Plugin::class);.

2. Choose the right assertion pattern based on what you are testing:

   What to test	Pattern to use
   Static property value	$this->assertSame('expected', Plugin::$prop);
   Static property existence & visibility	$this->reflection->hasProperty('prop') + isStatic() + isPublic()
   Method exists, public, static	$this->reflection->hasMethod('name') + isPublic() + isStatic()
   Method parameter type	$method->getParameters()[0]->getType()->getName()
   Code calls a function	Extract source via file() + array_slice() on start/end lines, then assertStringContainsString()
   File/dir on disk	assertFileExists(dirname(__DIR__) . '/path')
   Hook registration	assertSame([Plugin::class, 'methodName'], $hooks['vps.event'])

3. Source-analysis pattern (for verifying internal behavior without running side-effectful code):

   $method = $this->reflection->getMethod('getQueue');
   $startLine = $method->getStartLine();
   $endLine = $method->getEndLine();
   $filename = $method->getFileName();
   $this->assertNotFalse($filename);
   $lines = file($filename);
   $this->assertNotFalse($lines);
   $methodSource = implode('', array_slice($lines, $startLine - 1, $endLine - $startLine + 1));
   $this->assertStringContainsString('stopPropagation', $methodSource);
   

   Use this pattern whenever the method under test calls globals (myadmin_log, get_service_define, \TFSmarty, $GLOBALS['tf']).

4. Add @dataProvider when checking multiple similar values (e.g., template files, settings keys, method names). Provider methods return array<string, array{string}> with descriptive string keys:

   /** @dataProvider templateFileProvider */
   public function testTemplateFilesExist(string $template): void
   {
       $this->assertFileExists(dirname(__DIR__) . '/templates/' . $template);
   }
   
   public function templateFileProvider(): array
   {
       return [
           'create' => ['create.sh.tpl'],
           'start'  => ['start.sh.tpl'],
       ];
   }
   

5. New template test: when a new templates/foo.sh.tpl is added, add 'foo' => ['foo.sh.tpl'] to templateFileProvider() AND 'backup_foo' => ['backup/foo.sh.tpl'] if a backup variant exists.

6. Docblock format — every test method needs a docblock:

   /**
    * Test that [what it verifies].
    *
    * @return void
    */
   

   DataProvider tests also need @dataProvider providerMethodName and @param type $paramName.

7. Verify the new test passes before finishing:

   vendor/bin/phpunit tests/ -v
   

   All tests must be green. If failOnWarning triggers, check for undefined variables or wrong types.

Examples

User says: "add a test that getQueue references the templates directory"

Actions taken:

1. Read tests/PluginTest.php.
2. Add method using source-analysis pattern:

/**
 * Test that getQueue references template files by checking source contains templates path.
 *
 * @return void
 */
public function testGetQueueReferencesTemplatesDirectory(): void
{
    $method = $this->reflection->getMethod('getQueue');
    $startLine = $method->getStartLine();
    $endLine = $method->getEndLine();
    $filename = $method->getFileName();
    $this->assertNotFalse($filename);
    $lines = file($filename);
    $this->assertNotFalse($lines);
    $methodSource = implode('', array_slice($lines, $startLine - 1, $endLine - $startLine + 1));
    $this->assertStringContainsString('templates/', $methodSource);
    $this->assertStringContainsString('.sh.tpl', $methodSource);
}

3. Run vendor/bin/phpunit tests/ -v → green.

Result: Test added. Hook confirmed: getQueue source contains both 'templates/' and '.sh.tpl'.

---

User says: "write test for new operation resize_disk"

Actions taken:

1. Confirm templates/resize_disk.sh.tpl and templates/backup/resize_disk.sh.tpl exist.
2. Add entries to templateFileProvider():

   'resize_disk'        => ['resize_disk.sh.tpl'],
   'backup_resize_disk' => ['backup/resize_disk.sh.tpl'],
   

3. Run tests → green.

Common Issues

• Call to undefined function get_service_define() — you called the event handler method directly. Switch to source-analysis pattern (read method body as string via ReflectionClass, assert substrings).

• PHPUnit\Framework\RiskyTestError: This test did not perform any assertions — test method ran but no assert* call was reached. Add at least one assertion or use $this->addToAssertionCount(1) if checking something implicit.

• PHPUnit\Framework\Warning: failOnWarning — usually a @return void missing from docblock, or passing null where a typed value is expected. Check the method signature and docblocks.

• Test file not found — PHPUnit is run from the wrong directory. Run from the package root: vendor/bin/phpunit tests/ -v.

• assertFileExists fails for a new template — the .sh.tpl file was not created yet. Create both primary and backup template files before adding the test entry.

• assertCount(3, $hooks) fails after adding a new hook — testGetHooksReturnsExpectedCount hardcodes 3. Update it to the new count and also add the matching assertArrayHasKey and assertSame tests for the new hook.