feat: set rhda_token, rhda_source, MATCH_MANIFEST_VERSIONS and EXHORT_PYTHON_VIRTUAL_ENV for exhort api calls (#135)

xieshenzh · web-flow · commit 323bbd4f85e0 · 2023-11-08T12:13:12.000+02:00
* feat: set rhda_token and rhda_source for exhort api calls

* feat: add golang and python package resolving options
diff --git a/src/main/java/org/jboss/tools/intellij/exhort/ApiService.java b/src/main/java/org/jboss/tools/intellij/exhort/ApiService.java
@@ -11,8 +11,12 @@
 
 package org.jboss.tools.intellij.exhort;
 
+import com.intellij.ide.plugins.PluginManagerCore;
+import com.intellij.openapi.application.ApplicationInfo;
 import com.intellij.openapi.components.Service;
 import com.intellij.openapi.diagnostic.Logger;
+import com.intellij.openapi.extensions.PluginDescriptor;
+import com.intellij.openapi.extensions.PluginId;
 import com.redhat.exhort.Api;
 import com.redhat.exhort.api.AnalysisReport;
 import com.redhat.exhort.impl.ExhortApi;
@@ -32,7 +36,7 @@ public final class ApiService {
     private static final Logger LOG = Logger.getInstance(ApiService.class);
 
     enum TelemetryKeys {
-        MANIFEST, ECOSYSTEM, PLATFORM;
+        MANIFEST, ECOSYSTEM, PLATFORM, RHDA_TOKEN;
 
         @Override
         public String toString() {
@@ -55,14 +59,14 @@ public Path getStackAnalysis(final String packageManager, final String manifestN
         telemetryMsg.property(TelemetryKeys.ECOSYSTEM.toString(), packageManager);
         telemetryMsg.property(TelemetryKeys.PLATFORM.toString(), System.getProperty("os.name"));
         telemetryMsg.property(TelemetryKeys.MANIFEST.toString(), manifestName);
+        telemetryMsg.property(TelemetryKeys.RHDA_TOKEN.toString(), ApiSettingsState.getInstance().rhdaToken);
 
         try {
-            ApiSettingsState.getInstance().setApiOptions();
-            LOG.info("Perform stack analysis");
+            setRequestProperties(manifestName);
             var htmlContent = exhortApi.stackAnalysisHtml(manifestPath);
             var tmpFile = Files.createTempFile("exhort_", ".html");
             Files.write(tmpFile, htmlContent.get());
-            LOG.info("Finish stack analysis");
+
             telemetryMsg.send();
             return tmpFile;
 
@@ -78,19 +82,18 @@ public AnalysisReport getComponentAnalysis(final String packageManager, final St
         telemetryMsg.property(TelemetryKeys.ECOSYSTEM.toString(), packageManager);
         telemetryMsg.property(TelemetryKeys.PLATFORM.toString(), System.getProperty("os.name"));
         telemetryMsg.property(TelemetryKeys.MANIFEST.toString(), manifestName);
+        telemetryMsg.property(TelemetryKeys.RHDA_TOKEN.toString(), ApiSettingsState.getInstance().rhdaToken);
 
         try {
-            ApiSettingsState.getInstance().setApiOptions();
+            setRequestProperties(manifestName);
             CompletableFuture<AnalysisReport> componentReport;
-            LOG.info("Perform component analysis");
             if ("go.mod".equals(manifestName) || "requirements.txt".equals(manifestName)) {
                 var manifestContent = Files.readAllBytes(Paths.get(manifestPath));
                 componentReport = exhortApi.componentAnalysis(manifestName, manifestContent);
             } else {
                 componentReport = exhortApi.componentAnalysis(manifestPath);
             }
             AnalysisReport report = componentReport.get();
-            LOG.info("Finish component analysis");
             telemetryMsg.send();
             return report;
         } catch (IOException | InterruptedException | ExecutionException ex) {
@@ -108,4 +111,104 @@ public AnalysisReport getComponentAnalysis(final String packageManager, final St
         }
         return null;
     }
+
+    private void setRequestProperties(final String manifestName) {
+        String ideName = ApplicationInfo.getInstance().getFullApplicationName();
+        PluginDescriptor pluginDescriptor = PluginManagerCore.getPlugin(PluginId.getId("org.jboss.tools.intellij.analytics"));
+        if (pluginDescriptor != null) {
+            String pluginName = pluginDescriptor.getName() + " " + pluginDescriptor.getVersion();
+            System.setProperty("RHDA_SOURCE", ideName + " / " + pluginName);
+        } else {
+            System.setProperty("RHDA_SOURCE", ideName);
+        }
+
+        ApiSettingsState settings = ApiSettingsState.getInstance();
+        System.setProperty("RHDA_TOKEN", settings.rhdaToken);
+
+        if (settings.mvnPath != null && !settings.mvnPath.isBlank()) {
+            System.setProperty("EXHORT_MVN_PATH", settings.mvnPath);
+        } else {
+            System.clearProperty("EXHORT_MVN_PATH");
+        }
+        if (settings.javaPath != null && !settings.javaPath.isBlank()) {
+            System.setProperty("JAVA_HOME", settings.javaPath);
+        } else {
+            System.clearProperty("JAVA_HOME");
+        }
+        if (settings.npmPath != null && !settings.npmPath.isBlank()) {
+            System.setProperty("EXHORT_NPM_PATH", settings.npmPath);
+        } else {
+            System.clearProperty("EXHORT_NPM_PATH");
+        }
+        if (settings.nodePath != null && !settings.nodePath.isBlank()) {
+            System.setProperty("NODE_HOME", settings.nodePath);
+        } else {
+            System.clearProperty("NODE_HOME");
+        }
+        if (settings.goPath != null && !settings.goPath.isBlank()) {
+            System.setProperty("EXHORT_GO_PATH", settings.goPath);
+        } else {
+            System.clearProperty("EXHORT_GO_PATH");
+        }
+        if ("go.mod".equals(manifestName)) {
+            if (settings.goMatchManifestVersions) {
+                System.setProperty("MATCH_MANIFEST_VERSIONS", "true");
+            } else {
+                System.clearProperty("MATCH_MANIFEST_VERSIONS");
+            }
+        }
+        if (settings.usePython2) {
+            if (settings.pythonPath != null && !settings.pythonPath.isBlank()) {
+                System.setProperty("EXHORT_PYTHON_PATH", settings.pythonPath);
+            } else {
+                System.clearProperty("EXHORT_PYTHON_PATH");
+            }
+            if (settings.pipPath != null && !settings.pipPath.isBlank()) {
+                System.setProperty("EXHORT_PIP_PATH", settings.pipPath);
+            } else {
+                System.clearProperty("EXHORT_PIP_PATH");
+            }
+            System.clearProperty("EXHORT_PYTHON3_PATH");
+            System.clearProperty("EXHORT_PIP3_PATH");
+        } else {
+            if (settings.pythonPath != null && !settings.pythonPath.isBlank()) {
+                System.setProperty("EXHORT_PYTHON3_PATH", settings.pythonPath);
+            } else {
+                System.clearProperty("EXHORT_PYTHON3_PATH");
+            }
+            if (settings.pipPath != null && !settings.pipPath.isBlank()) {
+                System.setProperty("EXHORT_PIP3_PATH", settings.pipPath);
+            } else {
+                System.clearProperty("EXHORT_PIP3_PATH");
+            }
+            System.clearProperty("EXHORT_PYTHON_PATH");
+            System.clearProperty("EXHORT_PIP_PATH");
+        }
+        if (settings.usePythonVirtualEnv) {
+            System.setProperty("EXHORT_PYTHON_VIRTUAL_ENV", "true");
+            if (settings.pythonInstallBestEfforts) {
+                System.setProperty("EXHORT_PYTHON_INSTALL_BEST_EFFORTS", "true");
+            } else {
+                System.clearProperty("EXHORT_PYTHON_INSTALL_BEST_EFFORTS");
+            }
+        } else {
+            System.clearProperty("EXHORT_PYTHON_VIRTUAL_ENV");
+            System.clearProperty("EXHORT_PYTHON_INSTALL_BEST_EFFORTS");
+        }
+        if ("requirements.txt".equals(manifestName)) {
+            if (settings.pythonMatchManifestVersions) {
+                System.setProperty("MATCH_MANIFEST_VERSIONS", "true");
+            } else {
+                System.clearProperty("MATCH_MANIFEST_VERSIONS");
+            }
+        }
+        if (!"go.mod".equals(manifestName) && !"requirements.txt".equals(manifestName)) {
+            System.clearProperty("MATCH_MANIFEST_VERSIONS");
+        }
+        if (settings.snykToken != null && !settings.snykToken.isBlank()) {
+            System.setProperty("EXHORT_SNYK_TOKEN", settings.snykToken);
+        } else {
+            System.clearProperty("EXHORT_SNYK_TOKEN");
+        }
+    }
 }
diff --git a/src/main/java/org/jboss/tools/intellij/settings/ApiSettingsComponent.java b/src/main/java/org/jboss/tools/intellij/settings/ApiSettingsComponent.java
@@ -33,12 +33,20 @@ public class ApiSettingsComponent {
             + "<br>Specifies absolute path of the <i>directory</i> containing <b>node</b> executable.</html>";
     private final static String goPathLabel = "<html>Go > Executable: <b>Path</b>"
             + "<br>Specifies absolute path of <b>go</b> executable.</html>";
+    private final static String goMatchManifestVersionsLabel = "<html>Go > Match package version" +
+            "<br>Specifies if comparing the resolved package versions with the versions defined in the manifest.</html>";
     private final static String pythonPathLabel = "<html>Python > Executable: <b>Path</b>"
             + "<br>Specifies absolute path of <b>python</b> executable.</html>";
     private final static String pipPathLabel = "<html>Pip > Executable: <b>Path</b>"
             + "<br>Specifies absolute path of <b>pip</b> executable.</html>";
-    private final static String usePython2Label = "<html>Python > Executable: <b>Version</b></html>";
-    private final static String usePythonVirtualEnvLabel = "<html>Python > Virtual Envrionment</html>";
+    private final static String usePython2Label = "<html>Python > Executable: <b>Version</b>"
+            + "<br>Specifies if using python 2.x.</html>";
+    private final static String usePythonVirtualEnvLabel = "<html>Python > Virtual Environment"
+            + "<br>Specifies if using virtual environment.</html>";
+    private final static String pythonInstallBestEffortsLabel = "<html>Python > Virtual Environment: alternate package version"
+            + "<br>Specifies if allowing to use alternate package versions in virtual environment.</html>";
+    private final static String pythonMatchManifestVersionsLabel = "<html>Python > Match package version"
+            + "<br>Specifies if comparing the resolved package versions with the versions defined in the manifest.</html>";
     private final static String snykTokenLabel = "<html>Red Hat Dependency Analytics: <b>Exhort Snyk Token</b>"
             + "<br>Red Hat Dependency Analytics sever authentication token for Snyk.</html>";
 
@@ -49,10 +57,13 @@ public class ApiSettingsComponent {
     private final TextFieldWithBrowseButton npmPathText;
     private final TextFieldWithBrowseButton nodePathText;
     private final TextFieldWithBrowseButton goPathText;
+    private final JCheckBox goMatchManifestVersionsCheck;
     private final TextFieldWithBrowseButton pythonPathText;
     private final TextFieldWithBrowseButton pipPathText;
     private final JCheckBox usePython2Check;
     private final JCheckBox usePythonVirtualEnvCheck;
+    private final JCheckBox pythonInstallBestEffortsCheck;
+    private final JCheckBox pythonMatchManifestVersionsCheck;
     private final JBTextField snykTokenText;
 
     public ApiSettingsComponent() {
@@ -101,6 +112,8 @@ public ApiSettingsComponent() {
                 TextComponentAccessor.TEXT_FIELD_WHOLE_TEXT
         );
 
+        goMatchManifestVersionsCheck = new JCheckBox("Strictly match package version");
+
         pythonPathText = new TextFieldWithBrowseButton();
         pythonPathText.addBrowseFolderListener(
                 null,
@@ -123,6 +136,10 @@ public ApiSettingsComponent() {
 
         usePythonVirtualEnvCheck = new JCheckBox("Use python virtual environment");
 
+        pythonInstallBestEffortsCheck = new JCheckBox("Allow alternate package version");
+
+        pythonMatchManifestVersionsCheck = new JCheckBox("Strictly match package version");
+
         snykTokenText = new JBTextField();
 
         mainPanel = FormBuilder.createFormBuilder()
@@ -137,6 +154,8 @@ public ApiSettingsComponent() {
                 .addSeparator(10)
                 .addVerticalGap(10)
                 .addLabeledComponent(new JBLabel(goPathLabel), goPathText, 1, true)
+                .addVerticalGap(10)
+                .addLabeledComponent(new JBLabel(goMatchManifestVersionsLabel), goMatchManifestVersionsCheck, 1, true)
                 .addSeparator(10)
                 .addVerticalGap(10)
                 .addLabeledComponent(new JBLabel(pythonPathLabel), pythonPathText, 1, true)
@@ -146,6 +165,10 @@ public ApiSettingsComponent() {
                 .addLabeledComponent(new JBLabel(usePython2Label), usePython2Check, 1, true)
                 .addVerticalGap(10)
                 .addLabeledComponent(new JBLabel(usePythonVirtualEnvLabel), usePythonVirtualEnvCheck, 1, true)
+                .addVerticalGap(10)
+                .addLabeledComponent(new JBLabel(pythonInstallBestEffortsLabel), pythonInstallBestEffortsCheck, 1, true)
+                .addVerticalGap(10)
+                .addLabeledComponent(new JBLabel(pythonMatchManifestVersionsLabel), pythonMatchManifestVersionsCheck, 1, true)
                 .addSeparator(10)
                 .addVerticalGap(10)
                 .addLabeledComponent(new JBLabel(snykTokenLabel), snykTokenText, 1, true)
@@ -206,6 +229,14 @@ public void setGoPathText(@NotNull String text) {
         goPathText.setText(text);
     }
 
+    public boolean getGoMatchManifestVersionsCheck() {
+        return goMatchManifestVersionsCheck.isSelected();
+    }
+
+    public void setGoMatchManifestVersionsCheck(boolean selected) {
+        goMatchManifestVersionsCheck.setSelected(selected);
+    }
+
     @NotNull
     public String getPythonPathText() {
         return pythonPathText.getText();
@@ -240,6 +271,22 @@ public void setUsePythonVirtualEnvCheck(boolean selected) {
         usePythonVirtualEnvCheck.setSelected(selected);
     }
 
+    public boolean getPythonInstallBestEffortsCheck() {
+        return pythonInstallBestEffortsCheck.isSelected();
+    }
+
+    public void setPythonInstallBestEffortsCheck(boolean selected) {
+        pythonInstallBestEffortsCheck.setSelected(selected);
+    }
+
+    public boolean getPythonMatchManifestVersionsCheck() {
+        return pythonMatchManifestVersionsCheck.isSelected();
+    }
+
+    public void setPythonMatchManifestVersionsCheck(boolean selected) {
+        pythonMatchManifestVersionsCheck.setSelected(selected);
+    }
+
     @NotNull
     public String getSnykTokenText() {
         return snykTokenText.getText();
diff --git a/src/main/java/org/jboss/tools/intellij/settings/ApiSettingsConfigurable.java b/src/main/java/org/jboss/tools/intellij/settings/ApiSettingsConfigurable.java
@@ -44,10 +44,13 @@ public boolean isModified() {
         modified |= !settingsComponent.getNpmPathText().equals(settings.npmPath);
         modified |= !settingsComponent.getNodePathText().equals(settings.nodePath);
         modified |= !settingsComponent.getGoPathText().equals(settings.goPath);
+        modified |= settingsComponent.getGoMatchManifestVersionsCheck() != settings.goMatchManifestVersions;
         modified |= !settingsComponent.getPythonPathText().equals(settings.pythonPath);
         modified |= !settingsComponent.getPipPathText().equals(settings.pipPath);
         modified |= settingsComponent.getUsePython2Check() != settings.usePython2;
         modified |= settingsComponent.getUsePythonVirtualEnvCheck() != settings.usePythonVirtualEnv;
+        modified |= settingsComponent.getPythonInstallBestEffortsCheck() != settings.pythonInstallBestEfforts;
+        modified |= settingsComponent.getPythonMatchManifestVersionsCheck() != settings.pythonMatchManifestVersions;
         modified |= !settingsComponent.getSnykTokenText().equals(settings.snykToken);
         return modified;
     }
@@ -60,10 +63,13 @@ public void apply() {
         settings.npmPath = settingsComponent.getNpmPathText();
         settings.nodePath = settingsComponent.getNodePathText();
         settings.goPath = settingsComponent.getGoPathText();
+        settings.goMatchManifestVersions = settingsComponent.getGoMatchManifestVersionsCheck();
         settings.pythonPath = settingsComponent.getPythonPathText();
         settings.pipPath = settingsComponent.getPipPathText();
         settings.usePython2 = settingsComponent.getUsePython2Check();
         settings.usePythonVirtualEnv = settingsComponent.getUsePythonVirtualEnvCheck();
+        settings.pythonInstallBestEfforts = settingsComponent.getPythonInstallBestEffortsCheck();
+        settings.pythonMatchManifestVersions = settingsComponent.getPythonMatchManifestVersionsCheck();
         settings.snykToken = settingsComponent.getSnykTokenText();
     }
 
@@ -75,10 +81,13 @@ public void reset() {
         settingsComponent.setNpmPathText(settings.npmPath != null ? settings.npmPath : "");
         settingsComponent.setNodePathText(settings.nodePath != null ? settings.nodePath : "");
         settingsComponent.setGoPathText(settings.goPath != null ? settings.goPath : "");
+        settingsComponent.setGoMatchManifestVersionsCheck(settings.goMatchManifestVersions);
         settingsComponent.setPythonPathText(settings.pythonPath != null ? settings.pythonPath : "");
         settingsComponent.setPipPathText(settings.pipPath != null ? settings.pipPath : "");
         settingsComponent.setUsePython2Check(settings.usePython2);
         settingsComponent.setUsePythonVirtualEnvCheck(settings.usePythonVirtualEnv);
+        settingsComponent.setPythonInstallBestEffortsCheck(settings.pythonInstallBestEfforts);
+        settingsComponent.setPythonMatchManifestVersionsCheck(settings.pythonMatchManifestVersions);
         settingsComponent.setSnykTokenText(settings.snykToken != null ? settings.snykToken : "");
     }
 
diff --git a/src/main/java/org/jboss/tools/intellij/settings/ApiSettingsState.java b/src/main/java/org/jboss/tools/intellij/settings/ApiSettingsState.java
