feat(goto): Navigate between test and implementation

CHANGELOG.md

@@ -4,7 +4,8 @@
 
 ## [Unreleased]
 ### Added
-- Add support for showing pest version
+- Added support for showing pest version
+- Added support for navigation between tests and test subject
 
 ### Changed
 

gradle.properties

@@ -3,7 +3,7 @@
 
 pluginGroup = com.pestphp
 pluginName = PEST PHP
-pluginVersion = 0.3.3
+pluginVersion = 0.4.0-alpha.1
 pluginSinceBuild = 201
 pluginUntilBuild = null
 

src/main/kotlin/com/pestphp/pest/goto/PestTestFinder.kt

@@ -0,0 +1,49 @@
+package com.pestphp.pest.goto
+
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiManager
+import com.intellij.psi.search.GlobalSearchScope
+import com.intellij.psi.util.PsiTreeUtil
+import com.intellij.testIntegration.TestFinder
+import com.intellij.util.indexing.FileBasedIndex
+import com.jetbrains.php.PhpIndex
+import com.jetbrains.php.lang.psi.elements.PhpClass
+import com.pestphp.pest.indexers.PestTestIndex
+import com.pestphp.pest.isPestTestFile
+import java.util.ArrayList
+
+class PestTestFinder : TestFinder {
+ override fun findClassesForTest(element: PsiElement): MutableCollection<PhpClass> {
+ return PhpIndex.getInstance(element.project)
+ .getClassesByNameInScope(
+ element.containingFile.name.removeSuffix("Test.php"),
+ GlobalSearchScope.projectScope(element.project)
+ )
+ }
+
+ override fun findSourceElement(from: PsiElement): PsiElement? {
+ return from.containingFile
+ }
+
+ override fun isTest(element: PsiElement): Boolean {
+ return element.containingFile.isPestTestFile()
+ }
+
+ override fun findTestsForClass(element: PsiElement): MutableCollection<PsiElement> {
+ val phpClass = PsiTreeUtil.getNonStrictParentOfType(element, PhpClass::class.java) ?: return arrayListOf()
+
+ return FileBasedIndex.getInstance().getAllKeys(
+ PestTestIndex.key,
+ element.project
+ ).filter { it.contains(phpClass.name) }
+ .flatMap {
+ FileBasedIndex.getInstance().getContainingFiles(
+ PestTestIndex.key,
+ it,
+ GlobalSearchScope.projectScope(element.project)
+ )
+ }
+ .map { PsiManager.getInstance(element.project).findFile(it)!! }
+ .toCollection(ArrayList())
+ }
+}

src/main/kotlin/com/pestphp/pest/indexers/PestTestIndex.kt

@@ -0,0 +1,52 @@
+package com.pestphp.pest.indexers
+
+import com.intellij.util.indexing.DataIndexer
+import com.intellij.util.indexing.FileBasedIndex
+import com.intellij.util.indexing.FileContent
+import com.intellij.util.indexing.ID
+import com.intellij.util.indexing.ScalarIndexExtension
+import com.intellij.util.io.EnumeratorStringDescriptor
+import com.intellij.util.io.KeyDescriptor
+import com.jetbrains.php.lang.psi.stubs.indexes.PhpConstantNameIndex
+import com.pestphp.pest.isPestTestFile
+import gnu.trove.THashMap
+
+class PestTestIndex : ScalarIndexExtension<String>() {
+ override fun getName(): ID<String, Void> {
+ return key
+ }
+
+ override fun getVersion(): Int {
+ return 0
+ }
+
+ override fun dependsOnFileContent(): Boolean {
+ return true
+ }
+
+ override fun getIndexer(): DataIndexer<String, Void, FileContent> {
+ return DataIndexer { inputData ->
+ val file = inputData.psiFile
+
+ if (!file.isPestTestFile()) {
+ return@DataIndexer mapOf()
+ }
+
+ val map = THashMap<String, Void>()
+ map[file.name] = null
+ return@DataIndexer map
+ }
+ }
+
+ override fun getInputFilter(): FileBasedIndex.InputFilter {
+ return PhpConstantNameIndex.PHP_INPUT_FILTER
+ }
+
+ override fun getKeyDescriptor(): KeyDescriptor<String> {
+ return EnumeratorStringDescriptor.INSTANCE
+ }
+
+ companion object {
+ val key = ID.create<String, Void>("php.pest")
+ }
+}

src/main/resources/META-INF/plugin.xml

@@ -21,6 +21,8 @@
  <iconProvider implementation="com.pestphp.pest.PestIconProvider"/>
 
  <projectService serviceImplementation="com.pestphp.pest.PestSettings"/>
+ <testFinder implementation="com.pestphp.pest.goto.PestTestFinder"/>
+ <fileBasedIndex implementation="com.pestphp.pest.indexers.PestTestIndex"/>
  </extensions>
 
  <extensions defaultExtensionNs="com.jetbrains.php">

src/test/kotlin/com/pestphp/pest/goto/PestTestFinderTest.kt

@@ -0,0 +1,43 @@
+package com.pestphp.pest.goto
+
+import com.jetbrains.php.lang.psi.PhpFile
+import com.jetbrains.php.lang.psi.PhpPsiUtil
+import com.pestphp.pest.tests.PestLightCodeFixture
+import junit.framework.TestCase
+
+class PestTestFinderTest : PestLightCodeFixture() {
+ override fun getTestDataPath(): String? {
+ return "src/test/resources/com/pestphp/pest/goto/PestTestFinder"
+ }
+
+ fun testPestTestIsTest() {
+ val file = myFixture.configureByFile("test/App/UserTest.php")
+
+ val testElement = file.firstChild.lastChild.firstChild
+
+ assertTrue(PestTestFinder().isTest(testElement))
+ }
+
+ fun testFileIsTest() {
+ val file = myFixture.configureByFile("test/App/UserTest.php")
+
+ assertTrue(PestTestFinder().isTest(file))
+ }
+
+ fun testRandomElementIsTest() {
+ val file = myFixture.configureByFile("test/App/UserTest.php")
+
+ assertTrue(PestTestFinder().isTest(file.firstChild.children.random()))
+ }
+
+ fun testCanFindSourceElement() {
+ val file = myFixture.configureByFile("App/User.php")
+
+ TestCase.assertSame(
+ file,
+ PestTestFinder().findSourceElement(
+ PhpPsiUtil.findAllClasses(file as PhpFile).first().methods.first()
+ )
+ )
+ }
+}

src/test/kotlin/com/pestphp/pest/indexers/PestTestIndexTest.kt

@@ -0,0 +1,41 @@
+package com.pestphp.pest.indexers
+
+import com.intellij.psi.search.GlobalSearchScope
+import com.intellij.util.indexing.FileBasedIndex
+import com.pestphp.pest.tests.PestLightCodeFixture
+import junit.framework.TestCase
+
+class PestTestIndexTest : PestLightCodeFixture() {
+ override fun getTestDataPath(): String? {
+ return "src/test/resources/com/pestphp/pest/indexers/PestTestIndexTest"
+ }
+
+ fun testPestTestFileIsIndexed() {
+ val file = myFixture.configureByFile("FileWithPestTest.php")
+
+ val indexes = FileBasedIndex.getInstance().getAllKeys(PestTestIndex.key, project)
+
+ val files = FileBasedIndex.getInstance().getContainingFiles(
+ PestTestIndex.key,
+ indexes.first(),
+ GlobalSearchScope.projectScope(project)
+ )
+
+ assertNotNull(file.virtualFile)
+ assertContainsElements(files, file.virtualFile)
+ }
+
+ fun testPhpFileIsNotIndexed() {
+ val file = myFixture.configureByFile("FileWithoutPestTest.php")
+
+ val indexes = FileBasedIndex.getInstance().getAllKeys(PestTestIndex.key, project)
+
+ val files = FileBasedIndex.getInstance().getContainingFiles(
+ PestTestIndex.key,
+ indexes.first(),
+ GlobalSearchScope.projectScope(project)
+ )
+
+ assertDoesntContain(files, file.virtualFile)
+ }
+}

src/test/resources/com/pestphp/pest/goto/PestTestFinder/App/User.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App;
+
+class User {
+ public function getName(): String
+ {
+ return "Oliver Nybroe";
+ }
+}

src/test/resources/com/pestphp/pest/goto/PestTestFinder/test/App/UserTest.php

@@ -0,0 +1,7 @@
+<?php
+
+test("Can get user's name", function () {
+ $user = new \App\User();
+
+ $this->asserEquals("Oliver Nybroe", $user->getName());
+});

src/test/resources/com/pestphp/pest/indexers/PestTestIndexTest/FileWithPestTest.php

@@ -0,0 +1,5 @@
+<?php
+
+test('basic', function () {
+ $this->assertTrue(true);
+});

src/test/resources/com/pestphp/pest/indexers/PestTestIndexTest/FileWithoutPestTest.php

@@ -0,0 +1,3 @@
+<?php
+
+echo "works";