Merge pull request #114 from kdbinsidebrains/113-qspec-integration

113 qspec integration

Author: smklimenko

CHANGELOG.md

@@ -1,5 +1,16 @@
 # KdbInsideBrains Changelog
 
+## [5.15.0]
+
+### Added
+
+- QSpec Testing Framework added: https://www.kdbinsidebrains.dev/testing)
+- Run local KDB Instance redesigned
+
+### Fixed
+
+- InstancesTree freezes in 2025.x version
+
 ## [5.14.3]
 
 ### Fixed

src/main/java/icons/KdbIcons.java

@@ -14,10 +14,6 @@ public final class KdbIcons {
 
     private static @NotNull Icon row(@NotNull Icon icon1, @NotNull Icon icon2) {
         return IconManager.getInstance().createRowIcon(icon1, icon2);
-//        LayeredIcon icon = new LayeredIcon(2);
-//        icon.setIcon(icon1, 0, 0, 0);
-//        icon.setIcon(icon2, 1, icon1.getIconWidth(), 0);
-//        return icon;
     }
 
     private static @NotNull Icon layer(@NotNull Icon icon1, @NotNull Icon icon2) {
@@ -27,13 +23,16 @@ public final class KdbIcons {
     public static final class Main {
         public static final @NotNull Icon File = load("/org/kdb/inside/brains/icons/qFile.svg");
         public static final @NotNull Icon Module = load("/org/kdb/inside/brains/icons/q.svg");
-        public static final @NotNull Icon Library = load("/org/kdb/inside/brains/icons/q.svg");
-        public static final @NotNull Icon Application = load("/org/kdb/inside/brains/icons/q.svg");
-        public static final @NotNull Icon Notification = load("/org/kdb/inside/brains/icons/q.svg");
+        public static final @NotNull Icon Library = Module;
+        public static final @NotNull Icon Application = Module;
+        public static final @NotNull Icon Notification = Module;
 
         public static final @NotNull Icon ToolWindow = load("/org/kdb/inside/brains/icons/windows/instances.svg");
         public static final @NotNull Icon ConsoleWindow = load("/org/kdb/inside/brains/icons/windows/console.svg");
         public static final @NotNull Icon InspectorWindow = load("/org/kdb/inside/brains/icons/windows/inspector.svg");
+
+        public static final @NotNull Icon RunFile = Application;
+        public static final @NotNull Icon RunQSpec = layer(RunFile, AllIcons.RunConfigurations.TestMark);
     }
 
     public static final class Scope {

src/main/java/org/kdb/inside/brains/QFileType.java

@@ -13,6 +13,7 @@
 
 import javax.swing.*;
 import java.io.File;
+import java.nio.file.Path;
 
 public final class QFileType extends LanguageFileType {
     public static final QFileType INSTANCE = new QFileType();
@@ -41,6 +42,10 @@ public Icon getIcon() {
         return "q";
     }
 
+    public static boolean hasExtension(Path file) {
+        return hasExtension(file.getFileName().toString());
+    }
+
     public static boolean hasExtension(File file) {
         return hasExtension(file.getName());
     }
@@ -60,6 +65,10 @@ public static QFile createFactoryFile(Project project, String text) {
         return (QFile) PsiFileFactory.getInstance(project).createFileFromText("QElementFactory.q", QFileType.INSTANCE, text);
     }
 
+    public static boolean is(@Nullable Path file) {
+        return file != null && hasExtension(file.toFile());
+    }
+
     public static boolean is(@Nullable PsiFile file) {
         return (file instanceof QFile) || (file != null && is(file.getVirtualFile()));
     }

src/main/java/org/kdb/inside/brains/UIUtils.java

@@ -5,31 +5,37 @@
 import com.intellij.openapi.actionSystem.DataContext;
 import com.intellij.openapi.application.ApplicationManager;
 import com.intellij.openapi.application.Experiments;
+import com.intellij.openapi.fileChooser.FileChooserDescriptor;
 import com.intellij.openapi.project.DumbAwareAction;
 import com.intellij.openapi.project.Project;
-import com.intellij.openapi.ui.InputValidator;
-import com.intellij.openapi.ui.Messages;
+import com.intellij.openapi.ui.*;
 import com.intellij.openapi.ui.popup.ComponentPopupBuilder;
 import com.intellij.openapi.ui.popup.JBPopup;
 import com.intellij.openapi.ui.popup.JBPopupFactory;
 import com.intellij.openapi.util.TextRange;
 import com.intellij.ui.ContextHelpLabel;
 import com.intellij.ui.DocumentAdapter;
+import com.intellij.ui.TextFieldWithHistoryWithBrowseButton;
 import com.intellij.ui.components.JBTextField;
 import com.intellij.ui.content.Content;
 import com.intellij.ui.content.ContentFactory;
 import com.intellij.ui.tabs.TabInfo;
 import com.intellij.util.ui.ImageUtil;
 import org.apache.commons.lang.text.StrSubstitutor;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import javax.swing.*;
 import javax.swing.event.DocumentEvent;
 import java.awt.*;
 import java.awt.event.KeyEvent;
 import java.awt.image.BufferedImage;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.function.Consumer;
+import java.util.function.Function;
 import java.util.function.Predicate;
+import java.util.function.Supplier;
 
 public final class UIUtils {
     public static final String KEY_COLUMN_PREFIX = "\u00A1";
@@ -192,4 +198,47 @@ public void actionPerformed(@NotNull AnActionEvent e) {
         }.registerCustomShortcutSet(new CustomShortcutSet(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, 0)), textField);
         return popup;
     }
+
+    public static void initializerTextBrowseValidator(@NotNull TextFieldWithBrowseButton field, @NotNull Supplier<String> emptySupplier, @Nullable Supplier<String> nonExistSupplier) {
+        initializerTextBrowseValidator(field, emptySupplier, nonExistSupplier, (Function<String, String>[]) null);
+    }
+
+    @SafeVarargs
+    public static void initializerTextBrowseValidator(@NotNull TextFieldWithBrowseButton field, @NotNull Supplier<String> emptySupplier, @Nullable Supplier<String> nonExistSupplier, Function<String, String>... customValidator) {
+        final JTextField textField = field.getTextField();
+
+        final ComponentValidator componentValidator = new ComponentValidator(field);
+        componentValidator.withValidator(() -> {
+            final String text = textField.getText().trim();
+            if (text.isEmpty()) {
+                return new ValidationInfo(emptySupplier.get(), textField);
+            }
+            if (nonExistSupplier != null && !Files.exists(Path.of(text))) {
+                return new ValidationInfo(nonExistSupplier.get(), textField);
+            }
+            if (customValidator != null) {
+                for (Function<String, String> validator : customValidator) {
+                    final String apply = validator.apply(text);
+                    if (apply != null) {
+                        return new ValidationInfo(apply, textField);
+                    }
+                }
+            }
+            return null;
+        }).andRegisterOnDocumentListener(textField).installOn(textField);
+    }
+
+    public static void initializeFileChooser(@Nullable Project project, @NotNull ComponentWithBrowseButton<?> field, @NotNull FileChooserDescriptor descriptor) {
+        if (descriptor.getRoots().isEmpty() && project != null) {
+            descriptor.withRoots(project.getBaseDir());
+        }
+
+        if (field instanceof TextFieldWithBrowseButton button) {
+            button.addBrowseFolderListener(new TextBrowseFolderListener(descriptor, project));
+        } else if (field instanceof TextFieldWithHistoryWithBrowseButton button) {
+            button.addBrowseFolderListener(descriptor.getTitle(), descriptor.getDescription(), project, descriptor, TextComponentAccessors.TEXT_FIELD_WITH_HISTORY_WHOLE_TEXT);
+        } else {
+            throw new UnsupportedOperationException("Unsupported field type: " + field.getClass());
+        }
+    }
 }

src/main/java/org/kdb/inside/brains/core/KdbQuery.java

@@ -16,7 +16,7 @@ public KdbQuery(String expr, Object... args) {
         this.args = args;
     }
 
-    Object toQueryObject(boolean normalize) {
+    public Object toQueryObject(boolean normalize) {
         final char[] q = (normalize ? normalizeQuery(expr) : expr).toCharArray();
         if (args == null) {
             return q;

src/main/java/org/kdb/inside/brains/ide/qspec/QSpecLibrary.java

@@ -0,0 +1,43 @@
+package org.kdb.inside.brains.ide.qspec;
+
+import org.jdom.Element;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Objects;
+
+// https://github.com/nugend/qspec
+public record QSpecLibrary(String specFolder, String script) {
+    public static QSpecLibrary read(Element e) {
+        final Element child = e.getChild("qspec_library");
+        if (child == null) {
+            return null;
+        }
+        return new QSpecLibrary(child.getAttributeValue("path"), child.getText());
+    }
+
+    public static void validate(String path) throws IllegalStateException {
+        final boolean exists = Files.exists(Path.of(path).resolve("lib/init.q"));
+        if (!exists) {
+            throw new IllegalStateException("QSpec folder doesn't have lib/init.q inside");
+        }
+    }
+
+    public QSpecLibrary validate() throws IllegalStateException {
+        validate(specFolder);
+        return this;
+    }
+
+    public void write(Element element) {
+        final Element l = new Element("qspec_library");
+        l.setAttribute("path", specFolder);
+        l.setText(script);
+        element.addContent(l);
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof QSpecLibrary library)) return false;
+        return Objects.equals(specFolder, library.specFolder) && Objects.equals(script, library.script);
+    }
+}

src/main/java/org/kdb/inside/brains/ide/qspec/QSpecLibraryPanel.form

@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns="http://www.intellij.com/uidesigner/form/" version="1" bind-to-class="org.kdb.inside.brains.ide.qspec.QSpecLibraryPanel">
+  <grid id="27dc6" binding="myComponent" layout-manager="GridLayoutManager" row-count="4" column-count="3" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
+    <margin top="0" left="0" bottom="0" right="0"/>
+    <constraints>
+      <xy x="20" y="20" width="674" height="326"/>
+    </constraints>
+    <properties/>
+    <border type="none"/>
+    <children>
+      <component id="3587f" class="javax.swing.JLabel">
+        <constraints>
+          <grid row="1" column="0" row-span="1" col-span="3" vsize-policy="0" hsize-policy="0" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
+        </constraints>
+        <properties>
+          <text value="Custom Configuration Script:"/>
+        </properties>
+      </component>
+      <component id="c4568" class="javax.swing.JLabel">
+        <constraints>
+          <grid row="0" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="0" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
+        </constraints>
+        <properties>
+          <labelFor value=""/>
+          <text value="QSpec Path"/>
+        </properties>
+      </component>
+      <component id="bafdc" class="com.intellij.openapi.ui.TextFieldWithBrowseButton" binding="specFolderField">
+        <constraints>
+          <grid row="0" column="1" row-span="1" col-span="1" vsize-policy="3" hsize-policy="3" anchor="0" fill="1" indent="0" use-parent-layout="false">
+            <preferred-size width="298" height="34"/>
+          </grid>
+        </constraints>
+        <properties/>
+      </component>
+      <component id="dd52" class="javax.swing.JButton" binding="specDownloadButton">
+        <constraints>
+          <grid row="0" column="2" row-span="1" col-span="1" vsize-policy="0" hsize-policy="0" anchor="4" fill="0" indent="0" use-parent-layout="false"/>
+        </constraints>
+        <properties>
+          <text value="GitHub Download"/>
+        </properties>
+      </component>
+      <vspacer id="abf57">
+        <constraints>
+          <grid row="3" column="0" row-span="1" col-span="3" vsize-policy="6" hsize-policy="1" anchor="0" fill="2" indent="0" use-parent-layout="false"/>
+        </constraints>
+      </vspacer>
+      <scrollpane id="6184d" binding="scriptPanel">
+        <constraints>
+          <grid row="2" column="0" row-span="1" col-span="3" vsize-policy="7" hsize-policy="7" anchor="0" fill="3" indent="0" use-parent-layout="false">
+            <minimum-size width="-1" height="160"/>
+            <preferred-size width="-1" height="160"/>
+          </grid>
+        </constraints>
+        <properties/>
+        <border type="none"/>
+        <children/>
+      </scrollpane>
+    </children>
+  </grid>
+</form>

src/main/java/org/kdb/inside/brains/ide/qspec/QSpecLibraryPanel.java

@@ -0,0 +1,82 @@
+package org.kdb.inside.brains.ide.qspec;
+
+import com.intellij.openapi.fileChooser.FileChooserDescriptorFactory;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.ui.TextFieldWithBrowseButton;
+import com.intellij.openapi.vfs.VfsUtil;
+import com.intellij.ui.LanguageTextField;
+import org.jetbrains.annotations.Nullable;
+import org.kdb.inside.brains.QLanguage;
+import org.kdb.inside.brains.UIUtils;
+
+import javax.swing.*;
+
+public class QSpecLibraryPanel {
+    private static final String DEFAULT_TEXT = """
+            / Q below code that will be executed before running any QSpec tests.
+            / You can use it to initialize any required variables or load external files
+            / Please use only system commands, not slashed one. Use semicolons to split sentences.
+            """;
+    private JPanel myComponent;
+    private JScrollPane scriptPanel;
+    private LanguageTextField scriptTextArea;
+    private JButton specDownloadButton;
+    private TextFieldWithBrowseButton specFolderField;
+
+    public QSpecLibraryPanel() {
+    }
+
+    public JComponent init(@Nullable Project project, @Nullable QSpecLibrary library) {
+        scriptTextArea = new LanguageTextField(QLanguage.INSTANCE, project, DEFAULT_TEXT, false);
+
+        UIUtils.initializeFileChooser(project, specFolderField,
+                FileChooserDescriptorFactory.createSingleFolderDescriptor()
+                        .withRoots(VfsUtil.getUserHomeDir())
+                        .withTitle("Nugend QSpec Directory")
+                        .withDescription("Select directory where Nugend QSpec package is stored")
+        );
+
+        UIUtils.initializerTextBrowseValidator(specFolderField, () -> "Please select directory QSpec folder", () -> "QSpec directory doesn't exist", (s) -> {
+            try {
+                QSpecLibrary.validate(s);
+                return null;
+            } catch (Exception ex) {
+                return ex.getMessage();
+            }
+        });
+        specDownloadButton.addActionListener(e -> downloadQspec(project, specFolderField));
+
+        scriptPanel.setViewportView(scriptTextArea);
+
+        setLibrary(library);
+
+        return myComponent;
+    }
+
+    private void downloadQspec(@Nullable Project project, TextFieldWithBrowseButton field) {
+        final QSpecModuleDownloadDialog dialog = new QSpecModuleDownloadDialog(project);
+        if (dialog.showAndGet()) {
+            field.setText(dialog.getDownloadedPath().toAbsolutePath().toString());
+        }
+    }
+
+    public QSpecLibrary getLibrary() {
+        return new QSpecLibrary(specFolderField.getText(), scriptTextArea.getText());
+    }
+
+    public void setLibrary(QSpecLibrary library) {
+        if (library != null) {
+            scriptTextArea.setText(library.script());
+            specFolderField.setText(library.specFolder());
+        } else {
+            specFolderField.setText("");
+            scriptTextArea.setText(DEFAULT_TEXT);
+        }
+    }
+
+    public void setEnabled(boolean enabled) {
+        specFolderField.setEnabled(enabled);
+        specDownloadButton.setEnabled(enabled);
+        scriptTextArea.setEnabled(enabled);
+    }
+}