Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Special treatment of PanicSentinel in CatchPanicNode #11167

Merged
merged 7 commits into from
Sep 26, 2024
Merged

Special treatment of PanicSentinel in CatchPanicNode #11167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4b2afae
test: panic catch
4e6 Sep 19, 2024
63350f1
fix: typo
4e6 Sep 25, 2024
b89275b
Fix for the catch panic when instrumented RuntimeErrorsTest
JaroslavTulach Sep 25, 2024
a686387
Using metadata.assertInCode
JaroslavTulach Sep 25, 2024
3fb27c9
Testing behavior of CatchPanicNode
JaroslavTulach Sep 25, 2024
a85c561
PanicSentinel tests for CatchPanicNode
JaroslavTulach Sep 25, 2024
6e0a603
Merge branch 'develop' into wip/db/9402-catch-panic-instrumented
mergify[bot] Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
335 changes: 335 additions & 0 deletions .../src/test/java/org/enso/interpreter/node/expression/builtin/error/CatchPanicNodeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,335 @@
package org.enso.interpreter.node.expression.builtin.error;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;

import com.oracle.truffle.api.interop.InteropLibrary;
import org.enso.interpreter.node.expression.builtin.interop.syntax.HostValueToEnsoNode;
import org.enso.interpreter.runtime.EnsoContext;
import org.enso.interpreter.runtime.callable.argument.ArgumentDefinition;
import org.enso.interpreter.runtime.callable.function.Function;
import org.enso.interpreter.runtime.callable.function.FunctionSchema;
import org.enso.interpreter.runtime.data.text.Text;
import org.enso.interpreter.runtime.error.PanicException;
import org.enso.interpreter.runtime.error.PanicSentinel;
import org.enso.interpreter.runtime.library.dispatch.TypeOfNode;
import org.enso.test.utils.ContextUtils;
import org.enso.test.utils.TestRootNode;
import org.graalvm.polyglot.Context;
import org.hamcrest.Matchers;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;

public class CatchPanicNodeTest {

private static final InteropLibrary interop = InteropLibrary.getUncached();

private static Context context;
private static CatchPanicNode catchPanicNode;
private static HostValueToEnsoNode hostValueToEnsoNode;
private static TestRootNode testRootNode;

@BeforeClass
public static void initContextAndData() {
context = ContextUtils.createDefaultContext();
ContextUtils.executeInContext(
context,
() -> {
catchPanicNode = CatchPanicNode.build();
hostValueToEnsoNode = HostValueToEnsoNode.build();
testRootNode = new TestRootNode();
testRootNode.insertChildren(catchPanicNode, hostValueToEnsoNode);
return null;
});
}

@AfterClass
public static void disposeContext() {
context.close();
context = null;
}

@Test
public void passNothingThru() throws Exception {
ContextUtils.executeInContext(
context,
() -> {
var ctx = EnsoContext.get(catchPanicNode);
var any = ctx.getBuiltins().any();
var nothing = ctx.getBuiltins().nothing();
var result = catchPanicNode.execute(null, null, any, nothing, null);
assertEquals("Nothing gets returned", nothing, result);
return null;
});
}

@Test
public void passTextThru() throws Exception {
ContextUtils.executeInContext(
context,
() -> {
var ctx = EnsoContext.get(catchPanicNode);
var any = ctx.getBuiltins().any();
var text = Text.create("Hello");
var result = catchPanicNode.execute(null, null, any, text, null);
assertEquals("Hello gets returned", "Hello", result.toString());
return null;
});
}

@Test
public void passEvaluatedThunkThru() throws Exception {
ContextUtils.executeInContext(
context,
() -> {
var ctx = EnsoContext.get(catchPanicNode);
var any = ctx.getBuiltins().any();
var text = Text.create("Running");
var fn = new TestRootNode((frame) -> text);
var thunk = Function.thunk(fn.getCallTarget(), null);
var result = catchPanicNode.execute(null, null, any, thunk, null);
assertEquals("Thunk gets evaluated", "Running", result.toString());
return null;
});
}

@Test
public void catchAnyPanic() throws Exception {
ContextUtils.executeInContext(
context,
() -> {
var ctx = EnsoContext.get(catchPanicNode);
var any = ctx.getBuiltins().any();
var thrown = Text.create("Thrown");
var text = Text.create("Catched");
var handlerFn =
new TestRootNode(
(frame) -> {
var args =
Function.ArgumentsHelper.getPositionalArguments(frame.getArguments());
assertEquals("One argument expected", 1, args.length);
var argType = TypeOfNode.getUncached().execute(args[0]);
if (argType == ctx.getBuiltins().caughtPanic().getType()) {
assertThat(args[0].toString(), Matchers.containsString("Thrown"));
return text;
} else {
fail("Expecting Catched_Panic: " + args[0] + " type: " + argType);
return null;
}
});
var fn =
new TestRootNode(
(frame) -> {
throw new PanicException(thrown, null);
});
var thunk = Function.thunk(fn.getCallTarget(), null);
var handler = new Function(handlerFn.getCallTarget(), null, schema("err"));
var result = catchPanicNode.execute(null, null, any, thunk, handler);
assertEquals("Thunk gets evaluated", "Catched", result.toString());
return null;
});
}

@Test
public void catchAnyPanicSentinel() throws Exception {
ContextUtils.executeInContext(
context,
() -> {
var ctx = EnsoContext.get(catchPanicNode);
var any = ctx.getBuiltins().any();
var thrown = Text.create("Thrown");
var text = Text.create("Catched");
var handlerFn =
new TestRootNode(
(frame) -> {
var args =
Function.ArgumentsHelper.getPositionalArguments(frame.getArguments());
assertEquals("One argument expected", 1, args.length);
var argType = TypeOfNode.getUncached().execute(args[0]);
if (argType == ctx.getBuiltins().caughtPanic().getType()) {
assertThat(args[0].toString(), Matchers.containsString("Thrown"));
return text;
} else {
fail("Expecting Catched_Panic: " + args[0] + " type: " + argType);
return null;
}
});
var fn =
new TestRootNode(
(frame) -> {
return new PanicSentinel(new PanicException(thrown, null), null);
});
var thunk = Function.thunk(fn.getCallTarget(), null);
var handler = new Function(handlerFn.getCallTarget(), null, schema("err"));
var result = catchPanicNode.execute(null, null, any, thunk, handler);
assertEquals("Thunk gets evaluated", "Catched", result.toString());
return null;
});
}

@Test
public void catchSpecificPanic() throws Exception {
ContextUtils.executeInContext(
context,
() -> {
var ctx = EnsoContext.get(catchPanicNode);
var textType = ctx.getBuiltins().text();
var thrown = Text.create("Thrown");
var text = Text.create("Catched");
var handlerFn =
new TestRootNode(
(frame) -> {
var args =
Function.ArgumentsHelper.getPositionalArguments(frame.getArguments());
assertEquals("One argument expected", 1, args.length);
var argType = TypeOfNode.getUncached().execute(args[0]);
if (argType == ctx.getBuiltins().caughtPanic().getType()) {
assertThat(args[0].toString(), Matchers.containsString("Thrown"));
return text;
} else {
fail("Expecting Catched_Panic: " + args[0] + " type: " + argType);
return null;
}
});
var fn =
new TestRootNode(
(frame) -> {
throw new PanicException(thrown, null);
});
var thunk = Function.thunk(fn.getCallTarget(), null);
var handler = new Function(handlerFn.getCallTarget(), null, schema("err"));
var result = catchPanicNode.execute(null, null, textType, thunk, handler);
assertEquals("Thunk gets evaluated", "Catched", result.toString());
return null;
});
}

@Test
public void catchSpecificPanicSentinel() throws Exception {
ContextUtils.executeInContext(
context,
() -> {
var ctx = EnsoContext.get(catchPanicNode);
var textType = ctx.getBuiltins().text();
var thrown = Text.create("Thrown");
var text = Text.create("Catched");
var handlerFn =
new TestRootNode(
(frame) -> {
var args =
Function.ArgumentsHelper.getPositionalArguments(frame.getArguments());
assertEquals("One argument expected", 1, args.length);
var argType = TypeOfNode.getUncached().execute(args[0]);
if (argType == ctx.getBuiltins().caughtPanic().getType()) {
assertThat(args[0].toString(), Matchers.containsString("Thrown"));
return text;
} else {
fail("Expecting Catched_Panic: " + args[0] + " type: " + argType);
return null;
}
});
var fn =
new TestRootNode(
(frame) -> {
return new PanicSentinel(new PanicException(thrown, null), null);
});
var thunk = Function.thunk(fn.getCallTarget(), null);
var handler = new Function(handlerFn.getCallTarget(), null, schema("err"));
var result = catchPanicNode.execute(null, null, textType, thunk, handler);
assertEquals("Thunk gets evaluated", "Catched", result.toString());
return null;
});
}

@Test
public void dontCatchSpecificPanic() throws Exception {
ContextUtils.executeInContext(
context,
() -> {
var ctx = EnsoContext.get(catchPanicNode);
var numberType = ctx.getBuiltins().number().getNumber();
var thrown = Text.create("Thrown");
var text = Text.create("Catched");
var handlerFn =
new TestRootNode(
(frame) -> {
var args =
Function.ArgumentsHelper.getPositionalArguments(frame.getArguments());
assertEquals("One argument expected", 1, args.length);
var argType = TypeOfNode.getUncached().execute(args[0]);
if (argType == ctx.getBuiltins().caughtPanic().getType()) {
assertThat(args[0].toString(), Matchers.containsString("Thrown"));
return text;
} else {
fail("Expecting Catched_Panic: " + args[0] + " type: " + argType);
return null;
}
});
var fn =
new TestRootNode(
(frame) -> {
throw new PanicException(thrown, null);
});
var thunk = Function.thunk(fn.getCallTarget(), null);
var handler = new Function(handlerFn.getCallTarget(), null, schema("err"));
try {
var result = catchPanicNode.execute(null, null, numberType, thunk, handler);
fail("Not expecting any result back: " + result);
} catch (PanicException ex) {
// OK
assertEquals("Thrown", ex.getMessage());
}
return null;
});
}

@Test
public void dontCatchSpecificPanicSentinel() throws Exception {
ContextUtils.executeInContext(
context,
() -> {
var ctx = EnsoContext.get(catchPanicNode);
var numberType = ctx.getBuiltins().number().getNumber();
var thrown = Text.create("Thrown");
var text = Text.create("Catched");
var handlerFn =
new TestRootNode(
(frame) -> {
var args =
Function.ArgumentsHelper.getPositionalArguments(frame.getArguments());
assertEquals("One argument expected", 1, args.length);
var argType = TypeOfNode.getUncached().execute(args[0]);
if (argType == ctx.getBuiltins().caughtPanic().getType()) {
assertThat(args[0].toString(), Matchers.containsString("Thrown"));
return text;
} else {
fail("Expecting Catched_Panic: " + args[0] + " type: " + argType);
return null;
}
});
var fn =
new TestRootNode(
(frame) -> {
return new PanicSentinel(new PanicException(thrown, null), null);
});
var thunk = Function.thunk(fn.getCallTarget(), null);
var handler = new Function(handlerFn.getCallTarget(), null, schema("err"));
try {
var result = catchPanicNode.execute(null, null, numberType, thunk, handler);
fail("Not expecting any result back: " + result);
} catch (PanicException ex) {
// OK
assertEquals("Thrown", ex.getMessage());
}
return null;
});
}

private static FunctionSchema schema(String argName) {
var def =
new ArgumentDefinition(0, argName, null, null, ArgumentDefinition.ExecutionMode.EXECUTE);
return FunctionSchema.newBuilder().argumentDefinitions(def).build();
}
}
Loading
Loading