Skip to content

fix(annotations): Check for invalid sender requirements #781

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(annotations): Check for invalid sender requirements #781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions cloud-annotations/src/main/java/org/incendo/cloud/annotations/AnnotationParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -989,6 +989,16 @@ private <T> void parseParsers(final @NonNull T instance) {
}

if (commandDescriptor.requiredSender() != Object.class) {
if (!GenericTypeReflector.isSuperType(this.commandSenderType.getType(), commandDescriptor.requiredSender())) {
throw new IllegalArgumentException(String.format(
"Command method %s#%s(%s) has invalid sender type requirement: %s does not inherit from %s",
method.getDeclaringClass().getName(),
method.getName(),
Arrays.stream(method.getParameterTypes()).map(Class::getName).collect(Collectors.joining(", ")),
commandDescriptor.requiredSender().getName(),
this.commandSenderType.getType().getTypeName()
));
}
builder = builder.senderType((Class<? extends C>) commandDescriptor.requiredSender());
} else if (senderType != null) {
builder = builder.senderType(senderType);
Expand Down
21 changes: 18 additions & 3 deletions .../feature/RequiredSenderDeductionTest.java → ...notations/feature/RequiredSenderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,10 @@

import static org.junit.jupiter.api.Assertions.assertThrows;

class RequiredSenderDeductionTest {
class RequiredSenderTest {

private CommandManager<SuperSender<?>> commandManager;
private AnnotationParser<SuperSender<?>> annotationParser;

@BeforeEach
void setup() {
Expand All @@ -54,12 +55,12 @@ public boolean hasPermission(
return true;
}
};
AnnotationParser<SuperSender<?>> annotationParser = new AnnotationParser<>(
this.annotationParser = new AnnotationParser<>(
this.commandManager,
new TypeToken<SuperSender<?>>() {
}
);
annotationParser.parse(new TestClassA());
this.annotationParser.parse(new TestClassA());
}

@Test
Expand All @@ -83,6 +84,14 @@ void testIncorrectSender() {
);
}

@Test
void testInvalidRequirement() {
assertThrows(
IllegalArgumentException.class,
() -> this.annotationParser.parse(new InvalidSenderRequirementTest())
);
}


static class TestClassA {

Expand All @@ -102,4 +111,10 @@ public static class StringSender implements SuperSender<String> {

public static class IntegerSender implements SuperSender<Integer> {
}

static class InvalidSenderRequirementTest {
@Command(value = "invalid_command", requiredSender = String.class)
public void badSenderTypeNoParams() {
}
}
}
Loading