-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: render html from snyk-ls [IDE-214] (#496)
* feat: render html from snyk-ls * test: add tests * refactor: move code to the right panel * refactor: remove unused code * test: try to fix tests
- Loading branch information
1 parent
b04d888
commit 12fd4ef
Showing
10 changed files
with
215 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
133 changes: 133 additions & 0 deletions
133
src/test/kotlin/io/snyk/plugin/ui/toolwindow/SuggestionDescriptionPanelFromLSTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| @file:Suppress("FunctionName") | ||
| package io.snyk.plugin.ui.toolwindow | ||
|
|
||
| import com.intellij.openapi.application.WriteAction | ||
| import com.intellij.openapi.vfs.VirtualFile | ||
| import com.intellij.psi.PsiFile | ||
| import com.intellij.testFramework.fixtures.BasePlatformTestCase | ||
| import com.intellij.ui.jcef.JBCefBrowser | ||
| import io.mockk.every | ||
| import io.mockk.mockk | ||
| import io.mockk.mockkStatic | ||
| import io.mockk.unmockkAll | ||
| import io.snyk.plugin.Severity | ||
| import io.snyk.plugin.pluginSettings | ||
| import io.snyk.plugin.resetSettings | ||
| import io.snyk.plugin.snykcode.core.SnykCodeFile | ||
| import io.snyk.plugin.ui.getJBCefBrowserIfSupported | ||
| import io.snyk.plugin.ui.toolwindow.panels.SuggestionDescriptionPanelFromLS | ||
| import org.cef.browser.CefBrowserFactory | ||
| import org.cef.browser.CefRequestContext | ||
| import org.eclipse.lsp4j.Position | ||
| import org.eclipse.lsp4j.Range | ||
| import org.junit.Before | ||
| import org.junit.Test | ||
| import snyk.UIComponentFinder.getJBCEFBrowser | ||
| import snyk.UIComponentFinder.getJLabelByText | ||
| import snyk.code.annotator.SnykCodeAnnotator | ||
| import snyk.common.lsp.CommitChangeLine | ||
| import snyk.common.lsp.DataFlow | ||
| import snyk.common.lsp.ExampleCommitFix | ||
| import snyk.common.lsp.ScanIssue | ||
| import java.nio.file.Paths | ||
| import javax.swing.JPanel | ||
|
|
||
| class SuggestionDescriptionPanelFromLSTest : BasePlatformTestCase() { | ||
| private lateinit var cut: SuggestionDescriptionPanelFromLS | ||
| private val fileName = "app.js" | ||
| private lateinit var snykCodeFile: SnykCodeFile | ||
| private lateinit var issue: ScanIssue | ||
|
|
||
| private lateinit var file: VirtualFile | ||
| private lateinit var psiFile: PsiFile | ||
|
|
||
| override fun getTestDataPath(): String { | ||
| val resource = SnykCodeAnnotator::class.java.getResource("/test-fixtures/code/annotator") | ||
| requireNotNull(resource) { "Make sure that the resource $resource exists!" } | ||
| return Paths.get(resource.toURI()).toString() | ||
| } | ||
|
|
||
| @Before | ||
| override fun setUp() { | ||
| super.setUp() | ||
| unmockkAll() | ||
| resetSettings(project) | ||
|
|
||
| file = myFixture.copyFileToProject(fileName) | ||
| psiFile = WriteAction.computeAndWait<PsiFile, Throwable> { psiManager.findFile(file)!! } | ||
| snykCodeFile = SnykCodeFile(psiFile.project, psiFile.virtualFile) | ||
|
|
||
| issue = mockk<ScanIssue>() | ||
| every { issue.additionalData.message } returns "Test message" | ||
| every { issue.additionalData.isSecurityType } returns true | ||
| every { issue.additionalData.cwe } returns null | ||
| every { issue.additionalData.repoDatasetSize } returns 1 | ||
| every { issue.additionalData.exampleCommitFixes } returns listOf(ExampleCommitFix("https://commit-url", listOf( | ||
| CommitChangeLine("1", 1, "lineChange") | ||
| ))) | ||
| every { issue.additionalData.dataFlow } returns listOf(DataFlow(0, getTestDataPath(), Range(Position(1, 1), Position(1, 1)), "")) | ||
| every { issue.title } returns "Test title" | ||
| every { issue.getSeverityAsEnum() } returns Severity.CRITICAL | ||
| } | ||
|
|
||
| @Test | ||
| fun `test createUI should build panel with issue message as overview label if the feature flag is not enabled`() { | ||
| every { issue.additionalData.details } returns "<html>HTML message</html>" | ||
| every { issue.additionalData.details } returns null | ||
| cut = SuggestionDescriptionPanelFromLS(snykCodeFile, issue) | ||
|
|
||
| val actual = getJLabelByText(cut, "<html>Test message</html>") | ||
| assertNotNull(actual) | ||
|
|
||
| val actualBrowser = getJBCEFBrowser(cut) | ||
| assertNull(actualBrowser) | ||
| } | ||
|
|
||
| @Test | ||
| fun `test createUI should build panel with issue message as overview label if the details are empty even if feature flag is enabled`() { | ||
| pluginSettings().isGlobalIgnoresFeatureEnabled = true | ||
|
|
||
| every { issue.additionalData.details } returns null | ||
| cut = SuggestionDescriptionPanelFromLS(snykCodeFile, issue) | ||
|
|
||
| val actual = getJLabelByText(cut, "<html>Test message</html>") | ||
| assertNotNull(actual) | ||
|
|
||
| val actualBrowser = getJBCEFBrowser(cut) | ||
| assertNull(actualBrowser) | ||
| } | ||
|
|
||
| @Test | ||
| fun `test createUI should show nothing if feature flag is enabled but JCEF is not`() { | ||
| pluginSettings().isGlobalIgnoresFeatureEnabled = true | ||
|
|
||
| mockkStatic("io.snyk.plugin.ui.UIUtilsKt") | ||
| every { getJBCefBrowserIfSupported() } returns (null to "") | ||
|
|
||
| every { issue.additionalData.details } returns "<html>HTML message</html>" | ||
| cut = SuggestionDescriptionPanelFromLS(snykCodeFile, issue) | ||
|
|
||
| val actual = getJLabelByText(cut, "<html>Test message</html>") | ||
| assertNull(actual) | ||
|
|
||
| val actualBrowser = getJBCEFBrowser(cut) | ||
| assertNull(actualBrowser) | ||
| } | ||
|
|
||
| @Test | ||
| fun `test createUI should build panel with HTML from details if feature flag is enabled`() { | ||
| pluginSettings().isGlobalIgnoresFeatureEnabled = true | ||
|
|
||
| val mockJBCefBrowser = mockk<JBCefBrowser>() | ||
| every { mockJBCefBrowser.component } returns JPanel() | ||
| every { mockJBCefBrowser.loadHTML(eq("<html>HTML message</html>"), eq("http://foo/bar")) } returns | ||
| mockkStatic("io.snyk.plugin.ui.UIUtilsKt") | ||
| every { getJBCefBrowserIfSupported() } returns (mockJBCefBrowser to "http://foo/bar") | ||
|
|
||
| every { issue.additionalData.details } returns "<html>HTML message</html>" | ||
| cut = SuggestionDescriptionPanelFromLS(snykCodeFile, issue) | ||
|
|
||
| val actual = getJLabelByText(cut, "<html>Test message</html>") | ||
| assertNull(actual) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters