feat: add interfaces and first functionality to retrieve html

bastiandoetsch · bastiandoetsch · commit 8535cff1aea2 · 2024-11-13T17:18:58.000+01:00
diff --git a/plugin/META-INF/MANIFEST.MF b/plugin/META-INF/MANIFEST.MF
@@ -24,7 +24,8 @@ Require-Bundle: org.eclipse.ui,
  org.eclipse.ui.editors,
  org.eclipse.ui.genericeditor,
  org.eclipse.swt,
- org.eclipse.jface
+ org.eclipse.jface,
+ com.google.gson;bundle-version="2.11.0"
 Automatic-Module-Name: io.snyk.eclipse.plugin.tests
 Bundle-ActivationPolicy: lazy
 Bundle-ClassPath: .,
diff --git a/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/ISnykToolView.java b/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/ISnykToolView.java
@@ -0,0 +1,14 @@
+package io.snyk.eclipse.plugin.views.snyktoolview;
+
+import org.eclipse.jface.resource.ImageDescriptor;
+import org.eclipse.jface.viewers.TreeNode;
+
+public interface ISnykToolView {
+	abstract void setNodeText(TreeNode node, String text);
+	abstract void setNodeIcon(ImageDescriptor icon);
+	abstract void addIssueNode(TreeNode parent, TreeNode toBeAdded);
+	abstract void addFileNode(TreeNode parent, TreeNode toBeAdded);
+	abstract void addInfoNode(TreeNode parent, TreeNode toBeAdded);
+	abstract TreeNode getProductNode(String product);
+	abstract TreeNode getRoot();
+}
diff --git a/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/RootObject.java b/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/RootObject.java
@@ -1,23 +1,31 @@
 package io.snyk.eclipse.plugin.views.snyktoolview;
 
-import java.util.ArrayList;
-import java.util.List;
-
 import org.eclipse.jface.viewers.TreeNode;
 
-public class RootObject {
-	private List<TreeNode> children;
+public class RootObject extends TreeNode {
+	public static final String CONFIGURATION = "Configuration";
+	public static final String CODE_SECURITY = "Code Security";
+	public static final String OPEN_SOURCE = "Open Source";
+	public static final String CODE_QUALITY = "Code Quality";
+	private TreeNode ossRootNode;
+	private TreeNode codeSecurityRootNode;
+	private TreeNode codeQualityRootNode;
+	private TreeNode iacRootNode;
 
 	public RootObject() {
-		children = new ArrayList<>();
-
-		// Initialize with some data
-		children.add(new TreeNode("Open Source"));
-		children.add(new TreeNode("Code Security"));
-		children.add(new TreeNode("Configuration"));
-	}
-
-	public List<TreeNode> getChildren() {
-		return children;
+		super("");
+		
+		ossRootNode = new TreeNode(OPEN_SOURCE);
+		codeSecurityRootNode = new TreeNode(CODE_SECURITY);
+		codeQualityRootNode = new TreeNode(CODE_QUALITY);
+		iacRootNode = new TreeNode(CONFIGURATION);
+		
+		TreeNode[] children = new TreeNode[] {
+			ossRootNode,
+			codeSecurityRootNode,
+			codeQualityRootNode,
+			iacRootNode,
+		};
+		setChildren(children);
 	}
 }
diff --git a/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/SnykToolView.java b/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/SnykToolView.java
@@ -7,6 +7,7 @@
 import org.eclipse.jface.action.Action;
 import org.eclipse.jface.action.MenuManager;
 import org.eclipse.jface.preference.PreferenceDialog;
+import org.eclipse.jface.resource.ImageDescriptor;
 import org.eclipse.jface.viewers.ISelectionChangedListener;
 import org.eclipse.jface.viewers.IStructuredSelection;
 import org.eclipse.jface.viewers.SelectionChangedEvent;
@@ -37,7 +38,7 @@
  * and packages to io.snyk.eclipse.plugin.views, when the original SnykView is
  * removed.
  */
-public class SnykToolView extends ViewPart {
+public class SnykToolView extends ViewPart implements ISnykToolView {
 
 	/**
 	 * The ID of the view as specified by the extension.
@@ -50,6 +51,7 @@ public class SnykToolView extends ViewPart {
 
 	private TreeViewer treeViewer;
 	private Browser browser;
+	private RootObject rootObject = new RootObject();
 
 	private final static Shell SHELL = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell();
 
@@ -71,7 +73,6 @@ public void createPartControl(Composite parent) {
 		treeViewer.setLabelProvider(new TreeLabelProvider());
 
 		// Create and set the root object
-		RootObject rootObject = new RootObject();
 		treeViewer.setInput(rootObject);
 
 		registerTreeContextMeny(parent);
@@ -165,4 +166,45 @@ private static Shell getShell() {
 	public void setFocus() {
 		treeViewer.getControl().setFocus();
 	}
+
+	@Override
+	public void setNodeText(TreeNode node, String text) {
+		// TODO Auto-generated method stub
+		
+	}
+
+	@Override
+	public void setNodeIcon(ImageDescriptor icon) {
+		// TODO Auto-generated method stub
+		
+	}
+
+	@Override
+	public void addIssueNode(TreeNode parent, TreeNode toBeAdded) {
+		// TODO Auto-generated method stub
+		
+	}
+
+	@Override
+	public void addFileNode(TreeNode parent, TreeNode toBeAdded) {
+		// TODO Auto-generated method stub
+		
+	}
+
+	@Override
+	public void addInfoNode(TreeNode parent, TreeNode toBeAdded) {
+		// TODO Auto-generated method stub
+		
+	}
+
+	@Override
+	public TreeNode getProductNode(String product) {
+		// TODO Auto-generated method stub
+		return null;
+	}
+
+	@Override
+	public TreeNode getRoot() {
+		return this.rootObject;
+	}
 }
diff --git a/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/providers/TreeContentProvider.java b/plugin/src/main/java/io/snyk/eclipse/plugin/views/snyktoolview/providers/TreeContentProvider.java
@@ -12,7 +12,7 @@ public Object[] getElements(Object inputElement) {
 		// Return the root elements of your tree
 		// This method is called to get the top-level items
 		if (inputElement instanceof RootObject) {
-			return ((RootObject) inputElement).getChildren().toArray();
+			return ((RootObject) inputElement).getChildren();
 		}
 		return new Object[0];
 	}
diff --git a/plugin/src/main/java/io/snyk/languageserver/protocolextension/SnykExtendedLanguageClient.java b/plugin/src/main/java/io/snyk/languageserver/protocolextension/SnykExtendedLanguageClient.java
@@ -19,6 +19,7 @@
 import org.eclipse.core.resources.IProject;
 import org.eclipse.jdt.internal.core.JavaProject;
 import org.eclipse.jface.viewers.IStructuredSelection;
+import org.eclipse.jface.viewers.TreeNode;
 import org.eclipse.jface.wizard.WizardDialog;
 import org.eclipse.lsp4e.LSPEclipseUtils;
 import org.eclipse.lsp4e.LanguageClientImpl;
@@ -32,6 +33,7 @@
 import org.eclipse.lsp4j.services.LanguageServer;
 import org.eclipse.ui.ISelectionService;
 import org.eclipse.ui.IWorkbenchWindow;
+import org.eclipse.ui.PartInitException;
 import org.eclipse.ui.PlatformUI;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
@@ -45,6 +47,8 @@
 import io.snyk.eclipse.plugin.properties.preferences.Preferences;
 import io.snyk.eclipse.plugin.utils.SnykLogger;
 import io.snyk.eclipse.plugin.views.SnykView;
+import io.snyk.eclipse.plugin.views.snyktoolview.ISnykToolView;
+import io.snyk.eclipse.plugin.views.snyktoolview.SnykToolView;
 import io.snyk.eclipse.plugin.wizards.SnykWizard;
 import io.snyk.languageserver.LsCommandID;
 import io.snyk.languageserver.LsNotificationID;
@@ -64,6 +68,7 @@ public class SnykExtendedLanguageClient extends LanguageClientImpl {
 	private final ProgressManager progressMgr = new ProgressManager();
 	private final ObjectMapper om = new ObjectMapper();
 	private AnalyticsSender analyticsSender;
+	private ISnykToolView toolView;
 	
 	private static SnykExtendedLanguageClient instance = null;
 
@@ -248,7 +253,16 @@ public void snykScan(SnykScanParam param) {
 		switch(param.getStatus()) {
 		case "inProgress":
 			scanState.setScanInProgress(inProgressKey, true);
-			// Show scanning view state
+			if (toolView == null) {
+				try {
+					toolView = (ISnykToolView) PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage().showView(SnykToolView.ID);
+				} catch (PartInitException e) {
+					SnykLogger.logError(e);
+					return;
+				}
+			}
+			TreeNode productNode = toolView.getProductNode(param.getProduct());
+			toolView.setNodeText(productNode, "Scanning...");
 			break;
 		case "success":
 			scanState.setScanInProgress(inProgressKey, false);
@@ -447,4 +461,8 @@ public static <T> T convertInstanceOfObject(Object o, Class<T> clazz) {
 			return null;
 		}
 	}
+
+	public void setToolWindow(ISnykToolView toolView) {
+		this.toolView = toolView;
+	}
 }
diff --git a/plugin/src/main/java/io/snyk/languageserver/protocolextension/messageObjects/scanResults/AdditionalData.java b/plugin/src/main/java/io/snyk/languageserver/protocolextension/messageObjects/scanResults/AdditionalData.java
@@ -1,6 +1,9 @@
 package io.snyk.languageserver.protocolextension.messageObjects.scanResults;
 
+import io.snyk.languageserver.protocolextension.SnykExtendedLanguageClient;
+
 public record AdditionalData(
+	String key,
 	// Code
     String message,
     String[] cwe,
@@ -9,7 +12,6 @@ public record AdditionalData(
     boolean hasAIFix,
     // OSS + Code    
     String ruleId,
-    String details,
     String license,
     String description,
     String language,
@@ -21,7 +23,9 @@ public record AdditionalData(
     String projectName,
     String displayTargetFile,
     // IaC    
-    String publicId,
-    String customUIContent
+    String publicId
 ) {
+	public String customUIContent() {
+		return SnykExtendedLanguageClient.getInstance().getIssueDescription(key);
+	}
 }
diff --git a/target-platform/target-platform.target b/target-platform/target-platform.target
@@ -70,6 +70,11 @@
             <version>3.4</version>
             <type>jar</type>
           </dependency>
+          <dependency>
+		    <groupId>org.instancio</groupId>
+		    <artifactId>instancio-core</artifactId>
+		    <version>5.0.2</version>
+		  </dependency>
         </dependencies>
       </location>
     </locations>
diff --git a/tests/META-INF/MANIFEST.MF b/tests/META-INF/MANIFEST.MF
@@ -17,4 +17,6 @@ Require-Bundle: wrapped.org.mockito.mockito-inline;bundle-version="4.5.1",
  org.mockito.mockito-core;bundle-version="4.5.1",
  net.bytebuddy.byte-buddy;bundle-version="1.12.7",
  net.bytebuddy.byte-buddy-agent;bundle-version="1.12.7",
- org.objenesis;bundle-version="3.1.0"
+ org.objenesis;bundle-version="3.1.0",
+ com.google.gson;bundle-version="2.11.0",
+ org.instancio.core;bundle-version="5.0.2"
diff --git a/tests/pom.xml b/tests/pom.xml
@@ -72,6 +72,11 @@
             <type>jar</type>
             <scope>test</scope>
         </dependency>
+        <dependency>
+    		<groupId>org.instancio</groupId>
+    		<artifactId>instancio-core</artifactId>
+    		<version>5.0.2</version>
+		</dependency>
     </dependencies>
 
     <build>
diff --git a/tests/src/test/java/io/snyk/eclipse/plugin/properties/preferences/PreferencesTest.java b/tests/src/test/java/io/snyk/eclipse/plugin/properties/preferences/PreferencesTest.java
@@ -1,19 +1,17 @@
 package io.snyk.eclipse.plugin.properties.preferences;
 
-import io.snyk.eclipse.plugin.EnvironmentConstants;
-import io.snyk.languageserver.LsRuntimeEnvironment;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import org.apache.commons.lang3.SystemUtils;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.mockito.MockedStatic;
 import org.mockito.Mockito;
 
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertTrue;
-import static org.junit.jupiter.api.Assertions.assertFalse;
-import static org.mockito.ArgumentMatchers.eq;
-import static org.mockito.Mockito.verify;
+import io.snyk.eclipse.plugin.EnvironmentConstants;
+import io.snyk.languageserver.LsRuntimeEnvironment;
 
 @SuppressWarnings("restriction")
 class PreferencesTest {
diff --git a/tests/src/test/java/io/snyk/languageserver/LsBaseTest.java b/tests/src/test/java/io/snyk/languageserver/LsBaseTest.java
@@ -43,7 +43,7 @@ protected void setUp() {
   }
 
   @AfterEach
-  void tearDown() {
+  protected void tearDown() {
     lsFile.delete();
     clearAllCaches();
   }
diff --git a/tests/src/test/java/io/snyk/languageserver/protocolextension/SnykExtendedLanguageClientTest.java b/tests/src/test/java/io/snyk/languageserver/protocolextension/SnykExtendedLanguageClientTest.java
@@ -2,14 +2,17 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.mockStatic;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.verifyNoMoreInteractions;
+import static org.mockito.Mockito.when;
 
 import java.net.URI;
 import java.util.List;
 import java.util.concurrent.TimeUnit;
 
+import org.eclipse.jface.viewers.TreeNode;
 import org.eclipse.lsp4e.LSPEclipseUtils;
 import org.eclipse.lsp4j.Diagnostic;
 import org.eclipse.lsp4j.PublishDiagnosticsParams;
@@ -26,6 +29,7 @@
 import io.snyk.eclipse.plugin.domain.ProductConstants;
 import io.snyk.eclipse.plugin.properties.preferences.InMemoryPreferenceStore;
 import io.snyk.eclipse.plugin.properties.preferences.Preferences;
+import io.snyk.eclipse.plugin.views.snyktoolview.ISnykToolView;
 import io.snyk.languageserver.LsBaseTest;
 import io.snyk.languageserver.ScanInProgressKey;
 import io.snyk.languageserver.ScanState;
@@ -184,6 +188,25 @@ void testPublishDiagnosticsShouldChangeCache() {
 		assertEquals(true, issueCache.getCodeIssuesForPath(filePath).isEmpty());
 	}
 	
+	@Test
+    void testSnykScanUpdatesRootNodeStatus() {
+		var param = new SnykScanParam();
+		param.setStatus("inProgress");
+		param.setProduct(ProductConstants.CODE);
+		param.setFolderPath("a/b/c");
+		ISnykToolView toolWindowMock = mock(ISnykToolView.class);
+		TreeNode productNode = new TreeNode("Code Issues");
+		when(toolWindowMock.getProductNode(param.getProduct())).thenReturn(productNode);
+		
+		cut = new SnykExtendedLanguageClient();
+		cut.setToolWindow(toolWindowMock);
+		cut.snykScan(param);
+		
+		// expect "scanning..."
+		verify(toolWindowMock).getProductNode(param.getProduct());
+		verify(toolWindowMock).setNodeText(productNode, "Scanning...");
+	}
+	
 	@Test
 	void testSnykScanAddsToScanStateHashMap() {
 		var scanState = ScanState.getInstance();
diff --git a/tests/src/test/java/io/snyk/languageserver/protocolextension/messageObjects/scanResults/AdditionalDataTest.java b/tests/src/test/java/io/snyk/languageserver/protocolextension/messageObjects/scanResults/AdditionalDataTest.java

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ public Object[] getElements(Object inputElement) {`
`12`	`12`	`// Return the root elements of your tree`
`13`	`13`	`// This method is called to get the top-level items`
`14`	`14`	`if (inputElement instanceof RootObject) {`
`15`		`- return ((RootObject) inputElement).getChildren().toArray();`
	`15`	`+ return ((RootObject) inputElement).getChildren();`
`16`	`16`	`}`
`17`	`17`	`return new Object[0];`
`18`	`18`	`}`