add pest tests

calebporzio · Oct 10, 2023 · 01723fe · 01723fe
1 parent f24170c
commit 01723fe
Show file tree

Hide file tree

Showing 6 changed files with 301 additions and 1 deletion.
diff --git a/src/extension.js b/src/extension.js
@@ -1,5 +1,4 @@
 const vscode = require('vscode');
-const assert = require('assert');
 const PhpUnitCommand = require('./phpunit-command');
 const RemotePhpUnitCommand = require('./remote-phpunit-command.js');
 const DockerPhpUnitCommand = require('./docker-phpunit-command.js');

diff --git a/src/test/suite/extension.test.ts b/src/test/suite/extension.test.ts
@@ -23,6 +23,7 @@ suite("Better PHPUnit Test Suite", function () {
         // This allows us to test config options in tests and not harm other tests.
         await vscode.workspace.getConfiguration('better-phpunit').update('commandSuffix', null);
         await vscode.workspace.getConfiguration('better-phpunit').update('phpunitBinary', null);
+        await vscode.workspace.getConfiguration('better-phpunit').update('pestBinary', null);
         await vscode.workspace.getConfiguration("better-phpunit").update("ssh.enable", false);
         await vscode.workspace.getConfiguration("better-phpunit").update("xmlConfigFilepath", null);
         await vscode.workspace.getConfiguration("better-phpunit").update("suiteSuffix", null);
@@ -34,6 +35,7 @@ suite("Better PHPUnit Test Suite", function () {
         // This allows us to test config options in tests and not harm other tests.
         await vscode.workspace.getConfiguration('better-phpunit').update('commandSuffix', null);
         await vscode.workspace.getConfiguration('better-phpunit').update('phpunitBinary', null);
+        await vscode.workspace.getConfiguration('better-phpunit').update('pestBinary', null);
         await vscode.workspace.getConfiguration("better-phpunit").update("ssh.enable", false);
         await vscode.workspace.getConfiguration("better-phpunit").update("xmlConfigFilepath", null);
         await vscode.workspace.getConfiguration("better-phpunit").update("suiteSuffix", null);

diff --git a/src/test/suite/pest.test.ts b/src/test/suite/pest.test.ts
@@ -0,0 +1,272 @@
+import * as assert from 'assert';
+import { beforeEach, afterEach, before, after } from 'mocha';
+import * as path from 'path';
+import * as fs from 'fs';
+
+const vscode = require('vscode');
+const extension = require('../../../src/extension');
+
+const waitToAssertInSeconds = 5;
+
+// This is a little helper function to promisify setTimeout, so we can "await" setTimeout.
+function timeout(seconds: any, callback: any) {
+    return new Promise(resolve => {
+        setTimeout(() => {
+            callback();
+            resolve('');
+        }, seconds * waitToAssertInSeconds);
+    });
+}
+
+suite("Better PHPUnit Test Suite", function () {
+    before(async () => {
+        fs.renameSync(path.join(path.join(vscode.workspace.rootPath, 'composer.json')), path.join(path.join(vscode.workspace.rootPath, 'composer.json.phpunit')));
+        fs.renameSync(path.join(path.join(vscode.workspace.rootPath, 'sub-directory', 'composer.json')), path.join(path.join(vscode.workspace.rootPath, 'sub-directory', 'composer.json.phpunit')));
+
+        fs.renameSync(path.join(path.join(vscode.workspace.rootPath, 'composer.json.pest')), path.join(path.join(vscode.workspace.rootPath, 'composer.json')));
+        fs.renameSync(path.join(path.join(vscode.workspace.rootPath, 'sub-directory', 'composer.json.pest')), path.join(path.join(vscode.workspace.rootPath, 'sub-directory', 'composer.json')));
+    });
+
+    beforeEach(async () => {
+        // Reset the test/project-stub/.vscode/settings.json settings for each test.
+        // This allows us to test config options in tests and not harm other tests.
+        await vscode.workspace.getConfiguration('better-phpunit').update('commandSuffix', null);
+        await vscode.workspace.getConfiguration('better-phpunit').update('phpunitBinary', null);
+        await vscode.workspace.getConfiguration('better-phpunit').update('pestBinary', null);
+        await vscode.workspace.getConfiguration("better-phpunit").update("ssh.enable", false);
+        await vscode.workspace.getConfiguration("better-phpunit").update("xmlConfigFilepath", null);
+        await vscode.workspace.getConfiguration("better-phpunit").update("suiteSuffix", null);
+        await vscode.workspace.getConfiguration("better-phpunit").update("docker.enable", false);
+    });
+
+    after(async () => {
+        fs.renameSync(path.join(path.join(vscode.workspace.rootPath, 'composer.json')), path.join(path.join(vscode.workspace.rootPath, 'composer.json.pest')));
+        fs.renameSync(path.join(path.join(vscode.workspace.rootPath, 'sub-directory', 'composer.json')), path.join(path.join(vscode.workspace.rootPath, 'sub-directory', 'composer.json.pest')));
+
+        fs.renameSync(path.join(path.join(vscode.workspace.rootPath, 'composer.json.phpunit')), path.join(path.join(vscode.workspace.rootPath, 'composer.json')));
+        fs.renameSync(path.join(path.join(vscode.workspace.rootPath, 'sub-directory', 'composer.json.phpunit')), path.join(path.join(vscode.workspace.rootPath, 'sub-directory', 'composer.json')));
+    });
+
+    afterEach(async () => {
+        // Reset the test/project-stub/.vscode/settings.json settings for each test.
+        // This allows us to test config options in tests and not harm other tests.
+        await vscode.workspace.getConfiguration('better-phpunit').update('commandSuffix', null);
+        await vscode.workspace.getConfiguration('better-phpunit').update('phpunitBinary', null);
+        await vscode.workspace.getConfiguration('better-phpunit').update('pestBinary', null);
+        await vscode.workspace.getConfiguration("better-phpunit").update("ssh.enable", false);
+        await vscode.workspace.getConfiguration("better-phpunit").update("xmlConfigFilepath", null);
+        await vscode.workspace.getConfiguration("better-phpunit").update("suiteSuffix", null);
+        await vscode.workspace.getConfiguration("better-phpunit").update("docker.enable", false);
+    });
+
+    test("Run file outside of method", async () => {
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'tests', 'SampleTest.php'));
+        await vscode.window.showTextDocument(document, { selection: new vscode.Range(0, 0, 0, 0) });
+        await vscode.commands.executeCommand('better-phpunit.run');
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(extension.getGlobalCommandInstance().method, undefined);
+        });
+    });
+
+    test("Run file", async () => {
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'tests', 'SampleTest.php'));
+        await vscode.window.showTextDocument(document, { selection: new vscode.Range(7, 0, 7, 0) });
+        await vscode.commands.executeCommand('better-phpunit.run-file');
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(
+                extension.getGlobalCommandInstance().output,
+                path.join(vscode.workspace.rootPath, '/vendor/bin/pest') + ' ' + path.join(vscode.workspace.rootPath, '/tests/SampleTest.php')
+            );
+        });
+    });
+
+    test("Run from within first method", async () => {
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'tests', 'SampleTest.php'));
+        await vscode.window.showTextDocument(document, { selection: new vscode.Range(7, 0, 7, 0) });
+        await vscode.commands.executeCommand('better-phpunit.run');
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(
+                extension.getGlobalCommandInstance().method,
+                'test_first'
+            );
+        });
+    });
+
+    test("Run from within second method", async () => {
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'tests', 'SampleTest.php'));
+        await vscode.window.showTextDocument(document, { selection: new vscode.Range(12, 0, 12, 0) });
+        await vscode.commands.executeCommand('better-phpunit.run');
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(
+                extension.getGlobalCommandInstance().method,
+                'test_second'
+            );
+        });
+    });
+
+    test("Detect filename", async () => {
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'tests', 'SampleTest.php'));
+        await vscode.window.showTextDocument(document);
+        await vscode.commands.executeCommand('better-phpunit.run');
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(
+                extension.getGlobalCommandInstance().file,
+                path.join(vscode.workspace.rootPath, '/tests/SampleTest.php')
+            );
+        });
+    });
+
+    test("Detect filename with a space", async () => {
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'tests', 'File With Spaces Test.php'));
+        await vscode.window.showTextDocument(document);
+        await vscode.commands.executeCommand('better-phpunit.run');
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(
+                extension.getGlobalCommandInstance().file.replace(/\\/g, 'XX'),
+                path.join(vscode.workspace.rootPath, '/tests/FileXX WithXX SpacesXX Test.php')
+            );
+        });
+    });
+
+    test("Detect executable", async () => {
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'tests', 'SampleTest.php'));
+        await vscode.window.showTextDocument(document);
+        await vscode.commands.executeCommand('better-phpunit.run');
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(
+                extension.getGlobalCommandInstance().binary,
+                path.join(vscode.workspace.rootPath, '/vendor/bin/pest')
+            );
+        });
+    });
+
+    test("Detect executable in sub-directory", async () => {
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'sub-directory', 'tests', 'SampleTest.php'));
+        await vscode.window.showTextDocument(document);
+        await vscode.commands.executeCommand('better-phpunit.run');
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(
+                extension.getGlobalCommandInstance().binary,
+                path.join(vscode.workspace.rootPath, '/sub-directory/vendor/bin/pest')
+            );
+        });
+    });
+
+    test("Detect configuration in sub-directory", async () => {
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'sub-directory', 'tests', 'SampleTest.php'));
+        await vscode.window.showTextDocument(document);
+        await vscode.commands.executeCommand('better-phpunit.run');
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(
+                extension.getGlobalCommandInstance().configuration,
+                ` --configuration ${path.join(vscode.workspace.rootPath, '/sub-directory/phpunit.xml')}`
+            );
+        });
+    });
+
+    test("Uses configuration found in path supplied in settings", async () => {
+        await vscode.workspace.getConfiguration('better-phpunit').update('xmlConfigFilepath', '/var/log/phpunit.xml');
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'sub-directory', 'tests', 'SampleTest.php'));
+        await vscode.window.showTextDocument(document);
+        await vscode.commands.executeCommand('better-phpunit.run');
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(
+                extension.getGlobalCommandInstance().configuration,
+                ` --configuration /var/log/phpunit.xml`
+            );
+        });
+    });
+
+    test("Check full command", async () => {
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'tests', 'SampleTest.php'));
+        await vscode.window.showTextDocument(document, { selection: new vscode.Range(7, 0, 7, 0) });
+        await vscode.commands.executeCommand('better-phpunit.run');
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(
+                extension.getGlobalCommandInstance().output,
+                path.join(vscode.workspace.rootPath, '/vendor/bin/pest ') + path.join(vscode.workspace.rootPath, '/tests/SampleTest.php') + " --filter '^.*::test_first( .*)?$'"
+            );
+        });
+    });
+
+    test("Run previous", async () => {
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'tests', 'OtherTest.php'));
+        await vscode.window.showTextDocument(document, { selection: new vscode.Range(12, 0, 12, 0) });
+        await vscode.commands.executeCommand('better-phpunit.run-previous');
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(
+                extension.getGlobalCommandInstance().output,
+                path.join(vscode.workspace.rootPath, '/vendor/bin/pest ') + path.join(vscode.workspace.rootPath, '/tests/SampleTest.php') + " --filter '^.*::test_first( .*)?$'"
+            );
+        });
+    });
+
+    test("Run entire suite", async () => {
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'tests', 'SampleTest.php'));
+        await vscode.window.showTextDocument(document, { selection: new vscode.Range(7, 0, 7, 0) });
+        await vscode.commands.executeCommand('better-phpunit.run-suite')
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(
+                extension.getGlobalCommandInstance().output,
+                path.join(vscode.workspace.rootPath, '/vendor/bin/pest')
+            );
+        });
+    });
+
+    test("Run entire suite with specified options", async () => {
+        await vscode.workspace.getConfiguration('better-phpunit').update('suiteSuffix', '--testsuite unit --coverage');
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'tests', 'SampleTest.php'));
+        await vscode.window.showTextDocument(document, { selection: new vscode.Range(7, 0, 7, 0) });
+        await vscode.commands.executeCommand('better-phpunit.run-suite');
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(
+                extension.getGlobalCommandInstance().output,
+                path.join(vscode.workspace.rootPath, '/vendor/bin/pest') + ' --testsuite unit --coverage'
+            );
+        });
+    });
+
+    test("Run with commandSuffix config", async () => {
+        await vscode.workspace.getConfiguration('better-phpunit').update('commandSuffix', '--foo=bar');
+
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'tests', 'SampleTest.php'));
+        await vscode.window.showTextDocument(document, { selection: new vscode.Range(7, 0, 7, 0) });
+        await vscode.commands.executeCommand('better-phpunit.run-suite')
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(
+                extension.getGlobalCommandInstance().output,
+                path.join(vscode.workspace.rootPath, '/vendor/bin/pest') + ' --foo=bar'
+            );
+        });
+    });
+
+    test("Run with pestBinary config", async () => {
+        await vscode.workspace.getConfiguration('better-phpunit').update('pestBinary', 'vendor/foo/bar');
+
+        let document = await vscode.workspace.openTextDocument(path.join(vscode.workspace.rootPath, 'tests', 'SampleTest.php'));
+        await vscode.window.showTextDocument(document, { selection: new vscode.Range(7, 0, 7, 0) });
+        await vscode.commands.executeCommand('better-phpunit.run-suite')
+
+        await timeout(waitToAssertInSeconds, () => {
+            assert.equal(
+                extension.getGlobalCommandInstance().output,
+                "vendor/foo/bar"
+            );
+        });
+    });
+});
diff --git a/test/project-stub/.vscode/settings.json b/test/project-stub/.vscode/settings.json
@@ -2,6 +2,7 @@
     "better-phpunit.xmlConfigFilepath": null,
     "better-phpunit.commandSuffix": null,
     "better-phpunit.phpunitBinary": null,
+    "better-phpunit.pestBinary": null,
     "better-phpunit.ssh.enable": false,
     "better-phpunit.suiteSuffix": null,
     "better-phpunit.docker.enable": false,

diff --git a/test/project-stub/composer.json.pest b/test/project-stub/composer.json.pest
@@ -0,0 +1,13 @@
+{
+    "name": "calebporzio/project-stub",
+    "description": "Test environment for Better PHPUnit VS Code extension",
+    "authors": [
+        {
+            "name": "Caleb Porzio",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "pestphp/pest": "^2.0"
+    }
+}
diff --git a/test/project-stub/sub-directory/composer.json.pest b/test/project-stub/sub-directory/composer.json.pest
@@ -0,0 +1,13 @@
+{
+    "name": "calebporzio/project-stub",
+    "description": "Test environment for Better PHPUnit VS Code extension",
+    "authors": [
+        {
+            "name": "Caleb Porzio",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "pestphp/pest": "^2.0"
+    }
+}