Experimental integration for external system run configurations

Fixes #38

Author: ashald

CHANGELOG.md

@@ -2,6 +2,12 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning].
 
+## Unreleased
+
+### Added
+
+- Experimental integration for external system run configurations (such as Gradle) ([#38])
+
 ## 3.1.2 - 2019-05-21
 
 ### Fixed
@@ -40,7 +46,7 @@ This project adheres to [Semantic Versioning].
 
 ### Fixed
 
-- Unicode sequence handling in `.env` files [(#38)]
+- Unicode sequence handling in `.env` files [(#32)]
 - Backslash being removed from values in `.env` files ([#52]) 
 - White text on white background when `Light` theme is used ([#61])
 
@@ -97,6 +103,7 @@ This project adheres to [Semantic Versioning].
 - Initial Release
 
 [#16]: https://github.com/Ashald/EnvFile/issues/16
+[#38]: https://github.com/Ashald/EnvFile/issues/32
 [#38]: https://github.com/Ashald/EnvFile/issues/38
 [#52]: https://github.com/Ashald/EnvFile/issues/52
 [#61]: https://github.com/Ashald/EnvFile/issues/61

README.md

@@ -60,6 +60,7 @@ version of the product.
         <li><em>Arquillian TestNG</em></li>
         <li><em>CloudBees Server</em></li>
         <li><em>Cucumber Java</em></li>
+        <li>Gradle (requires "Enable Experimental Integrations")</li>
         <li><em>GWT Configuration</em></li>
         <li>
             <em>Geronimo Server</em>
@@ -202,19 +203,31 @@ Restart IDE.
 1) Switch to <kbd>EnvFile</kbd> tab
 2) Select <kbd>Enable EnvFile</kbd> checkbox
 3) Select <kbd>Substitute Environment Variables</kbd> checkbox (if needed)
-4) Click on <kbd>+</kbd> to add a file
-5) Adjust order as needed
+4) Select <kbd>Process JetBrains path macro references</kbd> checkbox (if needed)
+5) Select <kbd>Ignore missing files</kbd> checkbox (if needed)
+6) Select <kbd>Enable experimental integrations</kbd> checkbox (if needed)
+7) Click on <kbd>+</kbd> to add a file
+8) Adjust order as needed
 6) Even variables defined within run configuration can be processed, ordered and substituted 
 
 ![Read from file](./docs/example.png)
 
 ### Caveats
 
+#### Hidden files 
 Hidden files (starting with a dot) are not displayed in Finder on `macOS` by default. To toggle
 hidden files in the Open dialog, press <kbd>COMMAND</kbd> + <kbd>SHIFT</kbd> + <kbd>.</kbd>.
 Alternatively, one can either tweak `macOS` to show hidden files or select any file using
 standard Finder dialog and then manually edit path by double-clicking on the entry in the table.
 
+#### Experimental Integrations
+Not all run configurations available in IDEA-based IDEs are implemented similarly. Some of them differ significantly.
+In certain cases (so far, only `Gradle` has been confirmed) the implementation exposes interfaces to integrate the EnvFile UI
+but doesn't provide interfaces for it to actually make its work. Luckily, it was possible to make few assumptions about
+IDEA's internal implementation and make it work. Such integration is very fragile and it's not immediately clear if it
+will affect any existing integrations and when it will break. For that reason there is a special option to
+`Enable Experimental Integrations` that can be enabled when desired and should prevent other integrations from breaking. 
+
 ### Examples
 
 #### .env

docs/example.png

@@ -0,0 +1,41 @@
+package net.ashald.envfile.utils;
+
+import java.util.*;
+
+public class ReadOnceMap<K, V> extends AbstractMap<K, V> implements Map<K, V> {
+
+    private Map<K, V> firstRead;
+    private Map<K, V> otherReads;
+
+    private boolean wasRead = false;
+
+    public ReadOnceMap(Map<K, V> first, Map<K, V> rest) {
+        firstRead = first;
+        otherReads = rest;
+    }
+
+    @Override
+    public int size() {
+        return getSource(false).size();
+    }
+
+    @Override
+    public Set<Entry<K, V>> entrySet() {
+        return getSource(true).entrySet();
+    }
+
+    private Map<K, V> getSource(boolean consume) {
+        Map<K ,V> source;
+        synchronized (this) {
+            if (wasRead) {
+                source = otherReads;
+            } else {
+                if (consume) {
+                    wasRead = true;
+                }
+                source = firstRead;
+            }
+        }
+        return source == null ? Collections.emptyMap() : source;
+    }
+}

modules/core/src/main/java/net/ashald/envfile/utils/ReadOnceMap.java

@@ -9,14 +9,23 @@ public class EnvFileSettings {
     private final boolean envVarsSubstitutionEnabled;
     private final boolean pathMacroSupported;
     private final boolean ignoreMissing;
+    private final boolean enableExperimentalIntegrations;
     private final List<EnvFileEntry> entries;
 
-    public EnvFileSettings(boolean isEnabled, boolean substituteVars, boolean pathMacroSupported, List<EnvFileEntry> envFileEntries, boolean ignoreMissing) {
+    public EnvFileSettings(
+            boolean isEnabled,
+            boolean substituteVars,
+            boolean pathMacroSupported,
+            List<EnvFileEntry> envFileEntries,
+            boolean ignoreMissing,
+            boolean experimentalInegrations
+    ) {
         pluginEnabled = isEnabled;
         envVarsSubstitutionEnabled = substituteVars;
         this.pathMacroSupported = pathMacroSupported;
         this.ignoreMissing = ignoreMissing;
         entries = envFileEntries;
+        enableExperimentalIntegrations = experimentalInegrations;
     }
 
     public boolean isEnabled() {
@@ -35,6 +44,10 @@ public boolean isIgnoreMissing() {
         return ignoreMissing;
     }
 
+    public boolean isEnableExperimentalIntegrations() {
+        return enableExperimentalIntegrations;
+    }
+
     public List<EnvFileEntry> getEntries() {
         return Collections.unmodifiableList(entries);
     }

modules/platform/src/main/java/net/ashald/envfile/platform/EnvFileSettings.java

@@ -35,6 +35,7 @@ public class EnvFileConfigurationEditor<T extends RunConfigurationBase> extends
     @NonNls private static final String FIELD_SUBSTITUTE_VARS = "IS_SUBST";
     @NonNls private static final String FIELD_PATH_MACRO_VARS = "IS_PATH_MACRO_SUPPORTED";
     @NonNls private static final String FIELD_IGNORE_MISSING = "IS_IGNORE_MISSING_FILES";
+    @NonNls private static final String FIELD_EXPERIMENTAL_INTEGRATIONS = "IS_ENABLE_EXPERIMENTAL_INTEGRATIONS";
     @NonNls private static final String FIELD_PATH = "PATH";
     @NonNls private static final String FIELD_PARSER = "PARSER";
 
@@ -80,6 +81,9 @@ public static void readExternal(@NotNull RunConfigurationBase configuration, @No
         String ignoreMissingStr = JDOMExternalizerUtil.readField(element, FIELD_IGNORE_MISSING, "false");
         boolean ignoreMissing = Boolean.parseBoolean(ignoreMissingStr);
 
+        String experimentalIntegrationsStr = JDOMExternalizerUtil.readField(element, FIELD_EXPERIMENTAL_INTEGRATIONS, "false");
+        boolean experimentalIntegrations = Boolean.parseBoolean(experimentalIntegrationsStr);
+
         List<EnvFileEntry> entries = new ArrayList<EnvFileEntry>();
 
         final Element entriesElement = element.getChild(ELEMENT_ENTRY_LIST);
@@ -110,7 +114,7 @@ public static void readExternal(@NotNull RunConfigurationBase configuration, @No
         }
         // For a while to migrate old users - end
 
-        EnvFileSettings state = new EnvFileSettings(isEnabled, envVarsSubstEnabled, pathMacroSupported, entries, ignoreMissing);
+        EnvFileSettings state = new EnvFileSettings(isEnabled, envVarsSubstEnabled, pathMacroSupported, entries, ignoreMissing, experimentalIntegrations);
         configuration.putUserData(USER_DATA_KEY, state);
     }
 
@@ -121,6 +125,7 @@ public static void writeExternal(@NotNull RunConfigurationBase configuration, @N
             JDOMExternalizerUtil.writeField(element, FIELD_SUBSTITUTE_VARS, Boolean.toString(state.isSubstituteEnvVarsEnabled()));
             JDOMExternalizerUtil.writeField(element, FIELD_PATH_MACRO_VARS, Boolean.toString(state.isPathMacroSupported()));
             JDOMExternalizerUtil.writeField(element, FIELD_IGNORE_MISSING, Boolean.toString(state.isIgnoreMissing()));
+            JDOMExternalizerUtil.writeField(element, FIELD_EXPERIMENTAL_INTEGRATIONS, Boolean.toString(state.isEnableExperimentalIntegrations()));
 
             final Element entriesElement = new Element(ELEMENT_ENTRY_LIST);
             for (EnvFileEntry entry : state.getEntries()) {
@@ -176,6 +181,11 @@ public static void validateConfiguration(@NotNull RunConfigurationBase configura
         }
     }
 
+    public static boolean isEnableExperimentalIntegrations(@NotNull RunConfigurationBase configuration) {
+        EnvFileSettings state = configuration.getUserData(USER_DATA_KEY);
+        return state != null && state.isEnableExperimentalIntegrations();
+    }
+
     @NotNull
     @Contract(pure = true)
     public static String getSerializationId() {

modules/platform/src/main/java/net/ashald/envfile/platform/ui/EnvFileConfigurationEditor.java

@@ -44,6 +44,7 @@ class EnvFileConfigurationPanel<T extends RunConfigurationBase> extends JPanel {
     private final JCheckBox substituteEnvVarsCheckBox;
     private final JCheckBox supportPathMacroCheckBox;
     private final JCheckBox ignoreMissingCheckBox;
+    private final JCheckBox experimentalIntegrationsCheckBox;
     private final ListTableModel<EnvFileEntry> envFilesModel;
     private final TableView<EnvFileEntry> envFilesTable;
 
@@ -86,6 +87,7 @@ public void actionPerformed(ActionEvent e) {
         substituteEnvVarsCheckBox.addActionListener(e -> envFilesModel.getItems().forEach(envFileEntry -> envFileEntry.setSubstitutionEnabled(substituteEnvVarsCheckBox.isSelected())));
         supportPathMacroCheckBox = new JCheckBox("Process JetBrains path macro references ($PROJECT_DIR$)");
         ignoreMissingCheckBox = new JCheckBox("Ignore missing files");
+        experimentalIntegrationsCheckBox = new JCheckBox("Enable experimental integrations (e.g. Gradle) - may break any time!");
 
         // TODO: come up with a generic approach for this
         envFilesModel.addRow(new EnvFileEntry(runConfig, "runconfig", null, true, substituteEnvVarsCheckBox.isSelected()));
@@ -131,6 +133,7 @@ public boolean isEnabled(AnActionEvent e) {
         optionsPanel.add(substituteEnvVarsCheckBox);
         optionsPanel.add(supportPathMacroCheckBox);
         optionsPanel.add(ignoreMissingCheckBox);
+        optionsPanel.add(experimentalIntegrationsCheckBox);
 
         // Compose UI
         JPanel checkboxPanel = new JPanel();
@@ -250,7 +253,8 @@ EnvFileSettings getState() {
                 substituteEnvVarsCheckBox.isSelected(),
                 supportPathMacroCheckBox.isSelected(),
                 envFilesModel.getItems(),
-                ignoreMissingCheckBox.isSelected()
+                ignoreMissingCheckBox.isSelected(),
+                experimentalIntegrationsCheckBox.isSelected()
         );
     }
 
@@ -259,11 +263,13 @@ void setState(EnvFileSettings state) {
         substituteEnvVarsCheckBox.setSelected(state.isSubstituteEnvVarsEnabled());
         supportPathMacroCheckBox.setSelected(state.isPathMacroSupported());
         ignoreMissingCheckBox.setSelected(state.isIgnoreMissing());
+        experimentalIntegrationsCheckBox.setSelected(state.isEnableExperimentalIntegrations());
 
         envFilesTable.setEnabled(state.isEnabled());
         substituteEnvVarsCheckBox.setEnabled(state.isEnabled());
         supportPathMacroCheckBox.setEnabled(state.isEnabled());
         ignoreMissingCheckBox.setEnabled(state.isEnabled());
+        experimentalIntegrationsCheckBox.setEnabled(state.isEnabled());
 
         envFilesModel.setItems(new ArrayList<>(state.getEntries()));
     }

modules/platform/src/main/java/net/ashald/envfile/platform/ui/EnvFileConfigurationPanel.java

@@ -6,11 +6,12 @@
 import com.intellij.execution.configurations.JavaParameters;
 import com.intellij.execution.configurations.RunConfigurationBase;
 import com.intellij.execution.configurations.RunnerSettings;
+import com.intellij.openapi.externalSystem.service.execution.ExternalSystemRunConfiguration;
 import com.intellij.openapi.options.SettingsEditor;
-import com.intellij.openapi.projectRoots.JdkUtil;
 import com.intellij.openapi.util.InvalidDataException;
 import com.intellij.openapi.util.WriteExternalException;
 import net.ashald.envfile.platform.ui.EnvFileConfigurationEditor;
+import net.ashald.envfile.utils.ReadOnceMap;
 import org.jdom.Element;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -72,6 +73,17 @@ public <T extends RunConfigurationBase> void updateJavaParameters(T configuratio
         // there is a chance that env is an immutable map,
         // that is why it is safer to replace it instead of updating it
         params.setEnv(newEnv);
+
+        // The code below works based on assumptions about internal implementation of
+        // ExternalSystemExecuteTaskTask and ExternalSystemExecutionSettings and therefore may break any time may it change
+        // It seems to be the only way to get things working for run configurations such as Gradle, at least for now
+        if (EnvFileConfigurationEditor.isEnableExperimentalIntegrations(configuration)) {
+            if (configuration instanceof ExternalSystemRunConfiguration) {
+                ExternalSystemRunConfiguration ext = (ExternalSystemRunConfiguration) configuration;
+
+                ext.getSettings().setEnv(new ReadOnceMap<>(newEnv, ext.getSettings().getEnv()));
+            }
+        }
     }
 
     //