Merge pull request #39 from agallou/results_treeview

Display test results as a treeView

Author: agallou

CHANGELOG.md

@@ -5,6 +5,7 @@
 * [#30](https://github.com/agallou/phpstorm-plugin/pull/30) Easily identify test files via a custom icon ([@agallou])
 * [#37](https://github.com/agallou/phpstorm-plugin/pull/37) Save test and tested file before run ([@agallou])
 * [#38](https://github.com/agallou/phpstorm-plugin/pull/38) Add default keyboard shortcuts ([@agallou])
+* [#39](https://github.com/agallou/phpstorm-plugin/pull/39) Display test results as a treeView ([@agallou])
 
 ## Documentation
 

META-INF/plugin.xml

@@ -46,7 +46,7 @@
       <keyboard-shortcut first-keystroke="alt shift K" keymap="$default"/>
     </action>
 
-    <action id="AtoumRunTests" class="pl.projectspace.idea.plugins.php.atoum.actions.AtoumRunTests"
+    <action id="AtoumRunTests" class="org.atoum.intellij.plugin.atoum.actions.Run"
             icon="/pl/projectspace/idea/plugins/php/atoum/icons/atoum_16_16.png"
             text="run tests">
       <add-to-group group-id="RunMenu" anchor="last"/>

README.md

@@ -13,6 +13,19 @@ Features :
 ## Detailed Features
 
 
+### Execute tests inside PhpStorm
+
+By an entry on the run menu and on the right click menu.
+
+![Demo](doc/run.png)
+
+You can run the tests from both the test file or the tested classe's file.
+
+Your test file and tested file will automatically be save before running the test.
+
+The default keyboard shortcut to execute the test is alt+shift+M.
+
+
 ### Go to the test class from the tested class
 
 From the tested class you can go to the test class by clicking on the icon on the left of the class,
@@ -47,21 +60,6 @@ or by an entry bin the right click menu.
 The default keyboard shortcut to switch file is alt+shift+K.
 
 
-### Execute tests inside PhpStorm
-
-By an entry on the run menu and on the right click menu.
-
-![Demo](doc/run.png)
-
-You can run the tests from both the test file or the tested classe's file :
-
-![Demo](doc/run_from_tested_class.png)
-
-Your test file and tested file will automatically be save before running the test.
-
-The default keyboard shortcut to execute the test is alt+shift+M.
-
-
 ### Easily identify test files by a custom icon
 
 Atoum's test files are displayed with a different icon, like that you will easily differentiate them from other PHP files.

doc/run.png

@@ -0,0 +1,70 @@
+package org.atoum.intellij.plugin.atoum;
+
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.vfs.VirtualFile;
+import com.intellij.psi.PsiDirectory;
+import com.jetbrains.php.lang.psi.PhpFile;
+import org.codehaus.jettison.json.JSONException;
+import org.codehaus.jettison.json.JSONObject;
+import org.jetbrains.annotations.Nullable;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+
+public class AtoumUtils {
+
+    public static VirtualFile findTestBaseDir(PhpFile phpFile, Project project)
+    {
+        Boolean continueSearch = true;
+        Integer maxDirs = 35;
+        Integer dirCount = 0;
+        PsiDirectory currentDir = phpFile.getContainingDirectory();
+        while (continueSearch) {
+            dirCount++;
+            if (currentDir.getVirtualFile().equals(project.getBaseDir())) {
+                continueSearch = false;
+            } else if (dirCount >= maxDirs) {
+                continueSearch = false;
+            } else {
+                if (new File(currentDir.getVirtualFile().getPath() + "/composer.json").exists()) {
+                    return currentDir.getVirtualFile();
+                }
+            }
+            currentDir = currentDir.getParentDirectory();
+            if (null == currentDir) {
+                return project.getBaseDir();
+            }
+        }
+
+        return project.getBaseDir();
+    }
+
+    public static String findAtoumBinPath(VirtualFile dir)
+    {
+        String defaultBinPath = dir.getPath() + "/vendor/bin/atoum";
+
+        String binDir = getComposerBinDir(dir.getPath() + "/composer.json");
+        String binPath = dir.getPath() + "/" + binDir + "/atoum";
+        if (null != binDir && new File(binPath).exists()) {
+            return binPath;
+        }
+
+        return defaultBinPath;
+    }
+
+    @Nullable
+    protected static String getComposerBinDir(String composerPath) {
+        try {
+            String composerJsonContent = new String(Files.readAllBytes(Paths.get(composerPath)));
+            JSONObject obj = new JSONObject(composerJsonContent);
+            return obj.getJSONObject("config").get("bin-dir").toString();
+        } catch (JSONException e) {
+            return null;
+        } catch (IOException e) {
+            return null;
+        }
+    }
+
+}

doc/run_from_tested_class.png

@@ -0,0 +1,82 @@
+package org.atoum.intellij.plugin.atoum.actions;
+
+import com.intellij.openapi.actionSystem.AnAction;
+import com.intellij.openapi.actionSystem.AnActionEvent;
+import com.intellij.openapi.actionSystem.PlatformDataKeys;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.editor.Document;
+import com.intellij.openapi.fileEditor.FileDocumentManager;
+import com.jetbrains.php.lang.psi.PhpFile;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import org.atoum.intellij.plugin.atoum.model.RunnerConfiguration;
+import org.atoum.intellij.plugin.atoum.run.Runner;
+import org.jetbrains.annotations.Nullable;
+import pl.projectspace.idea.plugins.php.atoum.actions.Utils;
+
+public class Run extends AnAction {
+
+    @Override
+    public void update(AnActionEvent event) {
+        event.getPresentation().setEnabled(false);
+        event.getPresentation().setVisible(true);
+        event.getPresentation().setText("atoum - run test");
+
+        PhpClass currentTestClass = getCurrentTestClass(event);
+        if (currentTestClass == null) {
+            return;
+        }
+
+        event.getPresentation().setText("atoum - run test : " + currentTestClass.getName());
+        event.getPresentation().setEnabled(true);
+    }
+
+    protected void saveFiles(PhpClass currentTestClass, Project project) {
+        Document documentTestClass = FileDocumentManager.getInstance().getDocument(currentTestClass.getContainingFile().getVirtualFile());
+        Document documentTestedClass = FileDocumentManager.getInstance().getDocument(Utils.locateTestedClass(project, currentTestClass).getContainingFile().getVirtualFile());
+        FileDocumentManager.getInstance().saveDocument(documentTestClass);
+        FileDocumentManager.getInstance().saveDocument(documentTestedClass);
+
+    }
+
+    public void actionPerformed(final AnActionEvent e) {
+        PhpClass currentTestClass = getCurrentTestClass(e);
+        if (currentTestClass == null) {
+            return;
+        }
+
+        Project project = e.getProject();
+
+        saveFiles(currentTestClass, project);
+
+        RunnerConfiguration runConfiguration = new RunnerConfiguration();
+        runConfiguration.setFile((PhpFile)currentTestClass.getContainingFile());
+
+        Runner runner = new Runner(project);
+        runner.run(runConfiguration);
+    }
+
+    @Nullable
+    protected PhpClass getCurrentTestClass(AnActionEvent e) {
+        Object psiFile = e.getData(PlatformDataKeys.PSI_FILE);
+
+        if (null == psiFile) {
+            return null;
+        }
+
+        if (!(psiFile instanceof PhpFile)) {
+            return null;
+        }
+        PhpFile phpFile = ((PhpFile) psiFile);
+
+        PhpClass currentClass = Utils.getFirstClassFromFile(phpFile);
+        if (null == currentClass) {
+            return null;
+        }
+
+        if (!Utils.isClassAtoumTest(currentClass)) {
+            return Utils.locateTestClass(e.getProject(), currentClass);
+        }
+
+        return currentClass;
+    }
+}

src/org/atoum/intellij/plugin/atoum/AtoumUtils.java

@@ -0,0 +1,62 @@
+package org.atoum.intellij.plugin.atoum.model;
+
+import java.util.ArrayList;
+
+public class ClassResult
+{
+
+    public static String STATE_PASSED = "passed";
+    public static String STATE_FAILED = "failed";
+    public static String STATE_SKIPPED = "skipped";
+
+    protected ArrayList<MethodResult> methodsResults;
+
+    protected String name;
+
+    public ClassResult() {
+        this.methodsResults = new ArrayList<MethodResult>();
+    }
+
+    public void addMethodResult(MethodResult methodResult)
+    {
+        this.methodsResults.add(methodResult);
+    }
+
+    public String getState()
+    {
+        if (hasMethodOfState(MethodResult.STATE_FAILED)) {
+            return STATE_FAILED;
+        }
+
+        if (hasMethodOfState(MethodResult.STATE_SKIPPED)) {
+            return STATE_SKIPPED;
+        }
+
+        if (hasMethodOfState(MethodResult.STATE_PASSED)) {
+            return STATE_PASSED;
+        }
+
+        return STATE_FAILED;
+    }
+
+    private boolean hasMethodOfState(String state) {
+        for (MethodResult methodsResult : this.methodsResults) {
+            if (methodsResult.getState().equals(state)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    public Iterable<MethodResult> getMethods() {
+        return this.methodsResults;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+}

src/org/atoum/intellij/plugin/atoum/actions/Run.java

@@ -0,0 +1,45 @@
+package org.atoum.intellij.plugin.atoum.model;
+
+public class MethodResult {
+
+    public static String STATE_PASSED = "passed";
+    public static String STATE_FAILED = "failed";
+    public static String STATE_SKIPPED = "skipped";
+
+    protected String state = STATE_FAILED;
+
+    protected String name;
+    protected String content;
+
+    public MethodResult(String name, String content) {
+        this.name = name;
+        this.content = content;
+    }
+
+    public void definedStatePassed() {
+        this.state = STATE_PASSED;
+    }
+
+    public void definedStateFailed() {
+        this.state = STATE_FAILED;
+    }
+
+    public void definedStateSkipped() {
+        this.state = STATE_SKIPPED;
+    }
+
+    public String getName()
+    {
+        return this.name;
+    }
+
+    public String getContent()
+    {
+        return this.content;
+    }
+
+    public String getState()
+    {
+        return this.state;
+    }
+}

src/org/atoum/intellij/plugin/atoum/model/ClassResult.java

@@ -0,0 +1,16 @@
+package org.atoum.intellij.plugin.atoum.model;
+
+import com.jetbrains.php.lang.psi.PhpFile;
+
+public class RunnerConfiguration {
+
+    protected PhpFile file;
+
+    public PhpFile getFile () {
+        return file;
+    }
+
+    public void setFile(PhpFile file) {
+        this.file = file;
+    }
+}