test: add integration test for ClientTerminalAddon

Author: javier-godoy

pom.xml

@@ -101,6 +101,12 @@
             <groupId>com.vaadin</groupId>
             <artifactId>vaadin-testbench</artifactId>
             <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.flowingcode.vaadin.test</groupId>
+            <artifactId>testbench-rpc</artifactId>
+            <version>1.4.0</version>
+            <scope>test</scope>
         </dependency>
 		<dependency>
 		    <groupId>org.hamcrest</groupId>

src/test/java/com/flowingcode/vaadin/addons/xterm/integration/IntegrationView.java

@@ -0,0 +1,68 @@
+/*-
+ * #%L
+ * XTerm Console Addon
+ * %%
+ * Copyright (C) 2020 - 2026 Flowing Code
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.flowingcode.vaadin.addons.xterm.integration;
+
+import com.flowingcode.vaadin.addons.xterm.ITerminalOptions.CursorStyle;
+import com.flowingcode.vaadin.addons.xterm.XTerm;
+import com.vaadin.flow.component.ClientCallable;
+import com.vaadin.flow.component.orderedlayout.VerticalLayout;
+import com.vaadin.flow.router.Route;
+
+@SuppressWarnings("serial")
+@Route(value = IntegrationView.ROUTE)
+public class IntegrationView extends VerticalLayout implements IntegrationViewCallables {
+
+  public static final String ROUTE = "xterm/it";
+
+  private XTerm xterm;
+
+  private SampleClientTerminalAddon sampleClientTerminalAddon;
+
+  public IntegrationView() {
+    setSizeFull();
+    setPadding(false);
+    getElement().getStyle().set("background", "black");
+
+    xterm = new XTerm();
+    xterm.setPrompt("[user@xterm ~]$ ");
+
+    xterm.writeln("xterm add-on by Flowing Code S.A.\n\n");
+    xterm.writePrompt();
+
+    xterm.setCursorBlink(true);
+    xterm.setCursorStyle(CursorStyle.UNDERLINE);
+
+    xterm.setSizeFull();
+    sampleClientTerminalAddon = new SampleClientTerminalAddon(xterm);
+
+    xterm.addLineListener(ev -> xterm.writePrompt());
+
+    xterm.focus();
+    xterm.fit();
+    add(xterm);
+  }
+
+  @Override
+  @ClientCallable
+  public void setSampleClientTerminalAddonValue(String value) {
+    sampleClientTerminalAddon.setValue(value);
+  }
+
+}

src/test/java/com/flowingcode/vaadin/addons/xterm/integration/IntegrationViewCallables.java

@@ -0,0 +1,26 @@
+/*-
+ * #%L
+ * XTerm Console Addon
+ * %%
+ * Copyright (C) 2020 - 2026 Flowing Code
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.flowingcode.vaadin.addons.xterm.integration;
+
+public interface IntegrationViewCallables {
+
+  void setSampleClientTerminalAddonValue(String value);
+
+}

src/test/java/com/flowingcode/vaadin/addons/xterm/integration/SampleClientTerminalAddon.java

@@ -0,0 +1,56 @@
+/*-
+ * #%L
+ * XTerm Console Addon
+ * %%
+ * Copyright (C) 2020 - 2026 Flowing Code
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.flowingcode.vaadin.addons.xterm.integration;
+
+import com.flowingcode.vaadin.addons.xterm.ClientTerminalAddon;
+import com.flowingcode.vaadin.addons.xterm.XTermBase;
+
+@SuppressWarnings("serial")
+public class SampleClientTerminalAddon extends ClientTerminalAddon {
+
+  public final static String NAME = "sample-terminal-addon";
+
+  public SampleClientTerminalAddon(XTermBase xterm) {
+    super(xterm);
+
+    // see https://github.com/FlowingCode/XTermConsoleAddon/issues/98
+    xterm.getElement().executeJs("""
+        window.Vaadin.Flow.fcXtermConnector = window.Vaadin.Flow.fcXtermConnector || {};
+        window.Vaadin.Flow.fcXtermConnector.load_sample = (name, node) => {
+          const addon = {
+            activate: () => {},
+            dispose: () => {}
+          };
+          node.terminal.loadAddon(addon);
+          node.addons[name]=addon;
+        };
+        Vaadin.Flow.fcXtermConnector.load_sample($0, this);""", NAME);
+  }
+
+  public void setValue(String value) {
+    executeJs("this.value=$0;", value);
+  }
+
+  @Override
+  public String getName() {
+    return NAME;
+  }
+
+}

src/test/java/com/flowingcode/vaadin/addons/xterm/integration/SampleClientTerminalAddonIT.java

@@ -0,0 +1,47 @@
+/*-
+ * #%L
+ * XTerm Console Addon
+ * %%
+ * Copyright (C) 2020 - 2026 Flowing Code
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+package com.flowingcode.vaadin.addons.xterm.integration;
+
+import static org.junit.Assert.assertEquals;
+import com.flowingcode.vaadin.testbench.rpc.HasRpcSupport;
+import org.junit.Test;
+
+public class SampleClientTerminalAddonIT extends AbstractViewTest implements HasRpcSupport {
+
+  private static final String BAR = "BAR";
+  IntegrationViewCallables $server = createCallableProxy(IntegrationViewCallables.class);
+
+  public SampleClientTerminalAddonIT() {
+    super(IntegrationView.ROUTE);
+  }
+
+  @Test
+  public void testSelectionFeature1() throws InterruptedException {
+    XTermElement term = $(XTermElement.class).first();
+    $server.setSampleClientTerminalAddonValue(BAR);
+    assertEquals(BAR, getSampleClientTerminalValue(term));
+  }
+
+  private static String getSampleClientTerminalValue(XTermElement term) {
+    return (String) term.executeScript("return this.addons[arguments[0]].value;",
+        SampleClientTerminalAddon.NAME);
+  }
+
+}