The smoke we test here is "every factory compiles without throwing". + * Driving end-to-end completion (typing a partial line, asserting + * candidates) needs a real LineReader pumping the parser — this unit + * harness can't fake that reliably. Even so, this catches the most + * common breakage: a typo or missing import in a completer factory + * function that would NPE the first time a user hits TAB. + */ +class CompletionTest extends SystemTestSupport { + + @Test + void everyCommandsCompleterFactoryCompilesWithoutThrowing() { + // CommandRegistry.compileCompleters() invokes every per-command + // completer factory function. If any of them throws (typo in a + // class reference, missing JLine import, broken constructor + // chain), this test surfaces it. + def systemCompleter = groovy.compileCompleters() + assert systemCompleter != null + assert !systemCompleter.compiled + systemCompleter.compile() + assert systemCompleter.compiled + } +} diff --git a/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/ConsoleCommandTest.groovy b/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/ConsoleCommandTest.groovy new file mode 100644 index 00000000000..950834e4020 --- /dev/null +++ b/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/ConsoleCommandTest.groovy @@ -0,0 +1,49 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +package org.apache.groovy.groovysh.commands + +import org.junit.jupiter.api.Test + +/** + * Tests for the {@code /console} command. The command launches a Swing + * Groovy console window — we can't (and shouldn't) drive that in CI, but + * the registration and help paths are deterministic. + */ +class ConsoleCommandTest extends SystemTestSupport { + + @Test + void consoleIsRegisteredWhenObjectBrowserOnClasspath() { + // /console is conditionally registered: present iff + // groovy.console.ui.ObjectBrowser is on the classpath. The test + // module pulls groovy-console in transitively, so it should be + // there. If anyone removes that dep without intent, this fails. + assert '/console' in groovy.commandNames() + } + + @Test + void consoleHelpFlagDoesNotLaunchTheConsole() { + // maybePrintHelp short-circuits before `new Console(...)`, so + // `/console --help` is the only way to exercise the command in a + // headless test without opening a frame. Asserts on output growth + // — the help machinery captures via the printer. + int before = printer.output.size() + system.execute('/console --help') + assert printer.output.size() > before + } +} diff --git a/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/DocTest.groovy b/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/DocTest.groovy new file mode 100644 index 00000000000..142cdd84734 --- /dev/null +++ b/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/DocTest.groovy @@ -0,0 +1,53 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +package org.apache.groovy.groovysh.commands + +import org.junit.jupiter.api.Test + +import static groovy.test.GroovyAssert.shouldFail + +/** + * Tests for the {@code /doc} command. The command opens documentation in + * a browser via {@link java.awt.Desktop} when configured, but the early + * exit and error paths (no args, missing config, headless JVM) are + * deterministic and cheap to cover. + */ +class DocTest extends SystemTestSupport { + + @Test + void docWithNoArgsIsNoOp() { + // doc() returns early when xargs is empty; no exception, no output. + system.execute('/doc') + } + + @Test + void docForUnknownTargetSurfacesAClearError() { + // Without a CONSOLE_OPTIONS map, /doc throws IllegalStateException. + // The exact message varies by environment: + // - headless JVM: "Desktop is not supported!" + // - desktop dev box: "No documents configuration!" + // Don't pin to either; just lock in that the failure is targeted + // and not, e.g., an NPE walking through xargs. + def thrown = shouldFail(IllegalStateException) { + system.execute('/doc List') + } + assert thrown.message != null + assert !thrown.message.empty + } +} diff --git a/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/GrabTest.groovy b/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/GrabTest.groovy index 662b75a890c..49f62ee7a89 100644 --- a/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/GrabTest.groovy +++ b/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/GrabTest.groovy @@ -22,6 +22,8 @@ import groovy.junit6.plugin.ForkedJvm import org.junit.jupiter.api.Test import org.junit.jupiter.api.condition.EnabledIfSystemProperty +import static groovy.test.GroovyAssert.shouldFail + /** * Tests for the {@code /grab} command — Maven-coordinate dependency * resolution via Grape. The actual artifact-fetching test is forked and @@ -50,4 +52,37 @@ class GrabTest extends SystemTestSupport { assert cls != null assert cls.name == 'org.apache.commons.lang3.StringUtils' } + + @Test + void grabWithMalformedCoordsRaisesAClearError() { + // Coords must be group:module:version (3 colon-separated parts). + // An incomplete spec should fail fast with a targeted message + // rather than reaching the network and timing out. + def thrown = shouldFail(IllegalArgumentException) { + system.execute('/grab org.apache.commons:commons-lang3') + } + assert thrown.message.contains('Invalid command parameter') + assert thrown.message.contains('commons-lang3') + } + + @Test + void grabWithUnknownTwoArgFlagRaisesAClearError() { + // Two-arg form only accepts -v/--verbose. Anything else (here a + // bogus -x) is rejected before any network attempt. + def thrown = shouldFail(IllegalArgumentException) { + system.execute('/grab -x foo:bar:1.0') + } + assert thrown.message.contains('Unknown command parameters') + } + + @Test + void grabListEnumeratesCachedGrapes() { + // /grab --list calls Grape.instance.enumerateGrapes() which is + // local-only (no network); even with an empty cache it returns + // an empty map without throwing. Verifies the --list branch is + // reachable and produces output via the printer. + int before = printer.output.size() + system.execute('/grab --list') + assert printer.output.size() > before + } } diff --git a/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/ImgTest.groovy b/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/ImgTest.groovy new file mode 100644 index 00000000000..31bb6067ef9 --- /dev/null +++ b/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/ImgTest.groovy @@ -0,0 +1,163 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +package org.apache.groovy.groovysh.commands + +import org.junit.jupiter.api.Test +import org.junit.jupiter.api.io.TempDir + +import javax.imageio.ImageIO +import javax.swing.JLabel +import java.awt.image.BufferedImage +import java.nio.file.Path + +import static groovy.test.GroovyAssert.shouldFail + +/** + * Smoke tests for the {@code /img} command. Asserts on the fallback path + * (dumb terminal doesn't speak Sixel/Kitty/iTerm2) — the actual ANSI-image + * emission isn't testable through a captured byte stream without a real + * graphics-protocol terminal. + */ +class ImgTest extends SystemTestSupport { + + @TempDir + Path tmp + + private Path writePng(String name, int w, int h) { + Path file = tmp.resolve(name) + BufferedImage image = new BufferedImage(w, h, BufferedImage.TYPE_INT_RGB) + ImageIO.write(image, 'png', file.toFile()) + file + } + + @Test + void unsupportedTerminalProducesSummaryLine() { + Path file = writePng('chart.png', 12, 8) + system.execute("/img ${forwardSlashes(file)}") + // Dumb terminal — none of Sixel/Kitty/iTerm2 — falls through to the + // summary-line branch in img(). Assert on dimensions and the file + // identifier; don't pin to exact wording. + def out = printer.output.join() + assert out.contains('12x8') + assert out.contains('chart.png') + } + + @Test + void missingFileSurfacesAClearError() { + // /img saves exceptions via saveException(); JLine's + // AbstractCommandRegistry.invoke rethrows them, so the user sees a + // clear error rather than a silent no-op. + def thrown = shouldFail(IllegalArgumentException) { + system.execute('/img no-such-file.png') + } + assert thrown.message.contains('File not found') + assert thrown.message.contains('no-such-file.png') + } + + @Test + void imgFromBufferedImageVariable() { + // /img $var resolves the engine variable to its value via xargs. + BufferedImage src = new BufferedImage(20, 10, BufferedImage.TYPE_INT_RGB) + engine.put('imgVar', src) + system.execute('/img $imgVar') + def out = printer.output.join() + // Dumb terminal — falls through to the summary, which echoes the + // BufferedImage's actual dimensions. + assert out.contains('20x10') + } + + @Test + void imgFromObjectWithCreateBufferedImage() { + // Duck-typed dispatch: anything with createBufferedImage(int,int) — + // mirrors JFreeChart's signature without us depending on JFreeChart. + engine.put('chart', new ChartLikeForTest()) + system.execute('/img $chart --width=64 --height=32') + def out = printer.output.join() + assert out.contains('64x32') + } + + @Test + void imgFromObjectWithToBufferedImage() { + // Sibling duck-type: anything with toBufferedImage(int,int) — + // mirrors Smile Figure's signature without us depending on Smile. + engine.put('figure', new FigureLikeForTest()) + system.execute('/img $figure --width=72 --height=48') + def out = printer.output.join() + assert out.contains('72x48') + } + + @Test + void imgFromJComponent() { + // JComponent path — laid out and painted into a BufferedImage at the + // requested size. + engine.put('label', new JLabel('hello')) + system.execute('/img $label --width=80 --height=24') + def out = printer.output.join() + assert out.contains('80x24') + } + + @Test + void imgFromUnsupportedTypeErrors() { + engine.put('thing', 42) + def thrown = shouldFail(IllegalArgumentException) { + system.execute('/img $thing') + } + assert thrown.message.contains("don't know how to render") + assert thrown.message.contains('Integer') + } + + @Test + void undefinedVariableProducesClearError() { + // $panel is not defined — JLine resolves it to null and passes null into + // input.args(). Should surface as a friendly message, not a raw NPE on + // startsWith(). + def thrown = shouldFail(IllegalArgumentException) { + system.execute('/img $panel') + } + assert thrown.message.contains('null') + assert !thrown.message.contains('startsWith') + } + + @Test + void trailingWidthFlagWithoutValueProducesClearError() { + // `/img --width` (no value, no positional) used to walk past the end + // of args() and surface as an opaque ArrayIndexOutOfBoundsException + // via saveException. Should now be a targeted IllegalArgumentException + // naming the missing flag. + def thrown = shouldFail(IllegalArgumentException) { + system.execute('/img --width') + } + assert thrown.message.contains('--width') + assert thrown.message.contains('missing value') + } + + /** A test stand-in for JFreeChart-shaped objects. */ + static class ChartLikeForTest { + BufferedImage createBufferedImage(int w, int h) { + new BufferedImage(w, h, BufferedImage.TYPE_INT_RGB) + } + } + + /** A test stand-in for Smile-Figure-shaped objects. */ + static class FigureLikeForTest { + BufferedImage toBufferedImage(int w, int h) { + new BufferedImage(w, h, BufferedImage.TYPE_INT_RGB) + } + } +} diff --git a/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/RoundTripTest.groovy b/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/RoundTripTest.groovy new file mode 100644 index 00000000000..c30354935b1 --- /dev/null +++ b/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/commands/RoundTripTest.groovy @@ -0,0 +1,63 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +package org.apache.groovy.groovysh.commands + +import org.junit.jupiter.api.Test +import org.junit.jupiter.api.io.TempDir + +import java.nio.file.Path + +/** + * End-to-end test that drives several commands in sequence — the kind of + * cross-command regression no single per-command test can catch. + * + *
Distinct from {@link SaveLoadTest}, which exercises {@code /save} → + * {@code engine.reset()} → {@code /load} programmatically: this test + * routes the reset through the {@code /reset} command itself, so the + * full registry-dispatch path is exercised end-to-end. + */ +class RoundTripTest extends SystemTestSupport { + + @TempDir + Path tmp + + @Test + void buildSaveResetLoadRestoresState() { + system.execute('class Probe {}') + system.execute('def doubler(n) { n * 2 }') + system.execute('import java.time.LocalDate') + + Path file = tmp.resolve('session.groovy') + system.execute("/save ${forwardSlashes(file)}") + + // Reset via the registered /reset command (not engine.reset()). + // This is the bit SaveLoadTest doesn't cover. + system.execute('/reset') + assert engine.types.isEmpty() + assert engine.methodNames.isEmpty() + assert engine.imports.isEmpty() + + system.execute("/load ${forwardSlashes(file)}") + + assert engine.types.containsKey('Probe') + assert engine.methodNames.contains('doubler') + assert engine.imports.values().any { it.contains('java.time.LocalDate') } + assert engine.execute('doubler(21)') == 42 + } +} diff --git a/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/jline/GroovyEngineTest.groovy b/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/jline/GroovyEngineTest.groovy index da853d70ed7..53106994104 100644 --- a/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/jline/GroovyEngineTest.groovy +++ b/subprojects/groovy-groovysh/src/test/groovy/org/apache/groovy/groovysh/jline/GroovyEngineTest.groovy @@ -70,4 +70,60 @@ class GroovyEngineTest { engine.execute('import java.awt.Point') assert engine.imports.values().any { it.contains('java.awt.Point') } } + + @Test + void resetClearsTrackedDefinitionsButLeavesBindingVarsForFreshExecutes() { + // /reset wipes types/methods/imports/snippet-tracked variables; + // it does NOT delete shared/binding variables (those are managed + // by the underlying ScriptEngine and survive). This is contract + // users rely on. + engine.execute('class C {}') + engine.execute('def m(x) { x * 3 }') + engine.put('survivor', 'still here') + + engine.reset() + + assert engine.types.isEmpty() + assert engine.methodNames.isEmpty() + assert engine.imports.isEmpty() + assert engine.hasVariable('survivor') + assert engine.execute('survivor') == 'still here' + } + + @Test + void redefiningATypeReplacesTheTrackedSnippet() { + // The user redefines a class (common in interactive use). The + // engine should keep only one snippet under that name and run + // the latest body — not stack two definitions and produce + // ambiguous behaviour. + engine.execute('class T { String greet() { "first" } }') + engine.execute('class T { String greet() { "second" } }') + assert engine.types.containsKey('T') + assert engine.execute('new T().greet()') == 'second' + } + + @Test + void removeMethodDropsItFromTracking() { + engine.execute('def disposable() { 1 }') + assert engine.methodNames.contains('disposable') + engine.removeMethod('disposable') + assert !engine.methodNames.contains('disposable') + } + + @Test + void removeTypeDropsItFromTracking() { + engine.execute('class Disposable {}') + assert engine.types.containsKey('Disposable') + engine.removeType('Disposable') + assert !engine.types.containsKey('Disposable') + } + + @Test + void closureBindingVariableSurvivesAcrossExecutes() { + // A closure stored in the binding can be invoked by name on a + // later execute — useful for "save a callback, use it later" + // patterns that show up in REPL workflows. + engine.execute('greet = { name -> "hi, $name" }') + assert engine.execute("greet('paul')") == 'hi, paul' + } }