Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds Run icon in gutter next to ExUnit tests #1807

Merged
merged 2 commits into from
Aug 4, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,8 @@
### Enhancements
* [#1792](https://github.com/KronicDeth/intellij-elixir/pull/1792) - [@marcindawidziuk](https://github.com/marcindawidziuk)
* Quick documentation (F1/Ctrl+Q)
* [#1807](https://github.com/KronicDeth/intellij-elixir/pull/1807) - [@niknetniko](https://github.com/niknetniko)
* Run Icons in gutter next to ExUnit tests. The icon changes to the state of the test: green for passing and red for failing.

### Bug Fixes
* [#1788](https://github.com/KronicDeth/intellij-elixir/pull/1788) - [@KronicDeth](https://github.com/KronicDeth)
Expand Down
4 changes: 4 additions & 0 deletions resources/META-INF/changelog.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ <h1>v11.8.0</h1>
<p>Enhancements</p>
<ul>
<li>Quick documentation (F1/Ctrl+Q)</li>
<li>
Run Icons in gutter next to ExUnit tests. The icon changes to the state of the test: green for passing and
red for failing.
</li>
</ul>
</li>
<li>
Expand Down
3 changes: 3 additions & 0 deletions resources/META-INF/plugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,9 @@
<lang.formatter language="EEx" implementationClass="com.intellij.psi.templateLanguages.SimpleTemplateLanguageFormattingModelBuilder"/>
<langCodeStyleSettingsProvider implementation="org.elixir_lang.formatter.settings.LanguageCodeStyleSettingsProvider"/>

<!-- test -->
<runLineMarkerContributor language="Elixir" implementationClass="org.elixir_lang.exunit.ExUnitLineMarkerProvider"/>

<lang.parserDefinition language="Elixir" implementationClass="org.elixir_lang.ElixirParserDefinition"/>
<lang.psiStructureViewFactory language="Elixir" implementationClass="org.elixir_lang.structure_view.Factory"/>
<lang.quoteHandler language="Elixir" implementationClass="org.elixir_lang.QuoteHandler"/>
Expand Down
75 changes: 75 additions & 0 deletions src/org/elixir_lang/exunit/TestLineMarkerProvider.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
package org.elixir_lang.exunit

import com.intellij.execution.TestStateStorage
import com.intellij.execution.lineMarker.RunLineMarkerContributor
import com.intellij.openapi.roots.ProjectRootManager
import com.intellij.psi.PsiElement
import com.intellij.psi.impl.source.tree.LeafPsiElement
import org.codehaus.plexus.interpolation.os.Os
import org.elixir_lang.exunit.configuration.SUFFIX
import org.elixir_lang.exunit.configuration.lineNumber
import org.elixir_lang.mix.TestFinder
import org.elixir_lang.psi.ElixirFile
import org.elixir_lang.psi.ElixirUnmatchedQualifiedParenthesesCall
import org.elixir_lang.psi.call.Call
import org.elixir_lang.psi.operation.Match

/**
* Provides the gutter "run" icons for tests.
*/
class ExUnitLineMarkerProvider: RunLineMarkerContributor() {

override fun getInfo(element: PsiElement): Info? {

// Speed things up by only looking at files inside the test directory.
if (!isUnderTestSources(element)) {
return null
}

if (!TestFinder.isTestElement(element) || element !is LeafPsiElement) {
return null
}

val parent = element.parent?.parent

if (parent !is Call) {
return null
}

// Assignment
if (parent.parent is Match) {
return null
}

val functionElement = parent.firstChild

if (functionElement != element.parent) {
return null
}

val isClass = when (parent.functionName()) {
"test" -> false
"describe" -> true
"defmodule" -> true
"doctest" -> false
else -> null
} ?: return null

val number = lineNumber(element)
var url = "file://${element.containingFile.virtualFile.path}:${number}"
if (Os.isFamily(Os.FAMILY_WINDOWS)) {
// In Elixir, the drive letter is lowercase for some reason.
val location = "file://".length
url = url.replaceRange(location, location + 1, url[location].toLowerCase().toString())
}
val state = TestStateStorage.getInstance(element.project)?.getState(url)
return withExecutorActions(getTestStateIcon(state, isClass))
}
}

fun isUnderTestSources(clazz: PsiElement): Boolean {
val psiFile = clazz.containingFile
val vFile = psiFile.virtualFile ?: return false
val isTest = psiFile is ElixirFile && psiFile.virtualFile.path.endsWith(SUFFIX)
return ProjectRootManager.getInstance(clazz.project).fileIndex.isInTestSourceContent(vFile) and isTest
}
4 changes: 2 additions & 2 deletions src/org/elixir_lang/exunit/configuration/Producer.kt
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class MixExUnitRunConfigurationProducer :
} == true
}

private const val SUFFIX = "_test.exs"
const val SUFFIX = "_test.exs"
private const val UNKNOWN_LINE = -1

private fun configurationName(file: PsiFileSystemItem,
Expand Down Expand Up @@ -71,7 +71,7 @@ private fun isConfigurationFromContextImpl(configuration: Configuration, psiElem
contextConfiguration.workingDirectory == configuration.workingDirectory
}

private fun lineNumber(psiElement: PsiElement): Int {
fun lineNumber(psiElement: PsiElement): Int {
val containingFile = psiElement.containingFile
val documentLineNumber = PsiDocumentManager
.getInstance(containingFile.project)
Expand Down
59 changes: 25 additions & 34 deletions src/org/elixir_lang/mix/TestFinder.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,12 @@ private static Collection<PsiElement> corresponding(@NotNull PsiElement element,
@NotNull Function<String, String> correspondingName,
@NotNull Condition<Call> correspondingCallCondition) {
Call sourceElement = sourceElement(element);
Collection<PsiElement> correspondingCollection = new ArrayList<PsiElement>();
Collection<PsiElement> correspondingCollection = new ArrayList<>();

if (sourceElement != null && sourceElement instanceof StubBased) {
if (sourceElement instanceof StubBased) {
@SuppressWarnings("rawtypes")
StubBased sourceStubBased = (StubBased) sourceElement;
@SuppressWarnings("unchecked") Set<String> canonicalNameSet = sourceStubBased.canonicalNameSet();
Set<String> canonicalNameSet = sourceStubBased.canonicalNameSet();

if (!canonicalNameSet.isEmpty()) {
Project project = element.getProject();
Expand Down Expand Up @@ -122,18 +123,8 @@ public Call findSourceElement(@NotNull PsiElement from) {
public Collection<PsiElement> findTestsForClass(@NotNull PsiElement element) {
return corresponding(
element,
new Function<String, String>() {
@Override
public String fun(@NotNull String canonicalName) {
return canonicalName + TEST_SUFFIX;
}
},
new Condition<Call>() {
@Override
public boolean value(Call call) {
return Module.Companion.is(call);
}
}
canonicalName -> canonicalName + TEST_SUFFIX,
Module.Companion::is
);
}

Expand All @@ -142,36 +133,36 @@ public boolean value(Call call) {
public Collection<PsiElement> findClassesForTest(@NotNull PsiElement element) {
return corresponding(
element,
new Function<String, String>() {
@Override
public String fun(String canonicalName) {
String correspondingCanonicalName = null;

if (canonicalName.endsWith(TEST_SUFFIX)) {
correspondingCanonicalName =
canonicalName.substring(0, canonicalName.length() - TEST_SUFFIX.length());
}
canonicalName -> {
String correspondingCanonicalName = null;

return correspondingCanonicalName;
if (canonicalName.endsWith(TEST_SUFFIX)) {
correspondingCanonicalName =
canonicalName.substring(0, canonicalName.length() - TEST_SUFFIX.length());
}

return correspondingCanonicalName;
},
new Condition<Call>() {
@Override
public boolean value(Call call) {
return isModular(call);
}
}
TestFinder::isModular
);
}

@Override
public boolean isTest(@NotNull PsiElement element) {
Call sourceElement = findSourceElement(element);
return isTestElement(element);
}

/**
* Check if the given element is a test or not.
*/
public static boolean isTestElement(@NotNull PsiElement element) {
Call sourceElement = sourceElement(element);
boolean isTest = false;

if (sourceElement != null && sourceElement instanceof StubBased) {
if (sourceElement instanceof StubBased) {
@SuppressWarnings("rawtypes")
StubBased sourceStubBased = (StubBased) sourceElement;
@SuppressWarnings("unchecked") Set<String> canonicalNameSet = sourceStubBased.canonicalNameSet();
Set<String> canonicalNameSet = sourceStubBased.canonicalNameSet();

if (!canonicalNameSet.isEmpty()) {
for (String canonicalName : canonicalNameSet) {
Expand Down