Add e2e help option tests

- Relates #885
This commit is contained in:
Janne Valkealahti
2023-12-10 13:34:25 +00:00
parent 4b7e4508d2
commit bfde7c7fe3
2 changed files with 109 additions and 0 deletions

View File

@@ -0,0 +1,70 @@
/*
* Copyright 2023 the original author or authors.
*
* 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
*
* https://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.springframework.shell.samples.e2e;
import org.springframework.context.annotation.Bean;
import org.springframework.shell.command.CommandRegistration;
import org.springframework.shell.command.annotation.Command;
import org.springframework.shell.command.annotation.Option;
import org.springframework.shell.standard.ShellComponent;
import org.springframework.shell.standard.ShellMethod;
import org.springframework.shell.standard.ShellOption;
import org.springframework.stereotype.Component;
@ShellComponent
public class HelpCommands extends BaseE2ECommands {
@ShellComponent
public static class LegacyAnnotation extends BaseE2ECommands {
@ShellMethod(key = LEGACY_ANNO + "help-desc-1", group = GROUP)
public void helpDesc1(
@ShellOption(help = "arg1 desc", defaultValue = "hi") String arg1
) {
}
}
@Command(command = BaseE2ECommands.ANNO, group = BaseE2ECommands.GROUP)
public static class Annotation extends BaseE2ECommands {
@Command(command = "help-desc-1")
public void helpDesc1(
@Option(longNames = "arg1", defaultValue = "hi", description = "arg1 desc") String arg1
) {
}
}
@Component
public static class Registration extends BaseE2ECommands {
@Bean
public CommandRegistration helpDesc1() {
return getBuilder()
.command(REG, "help-desc-1")
.group(GROUP)
.withOption()
.longNames("arg1")
.defaultValue("hi")
.description("arg1 desc")
.and()
.withTarget()
.consumer(ctx -> {})
.and()
.build();
}
}
}

View File

@@ -0,0 +1,39 @@
/*
* Copyright 2023 the original author or authors.
*
* 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
*
* https://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.springframework.shell.samples.e2e;
import org.junit.jupiter.params.ParameterizedTest;
import org.springframework.shell.command.annotation.EnableCommand;
import org.springframework.shell.samples.AbstractSampleTests;
import org.springframework.shell.samples.e2e.HelpCommands.LegacyAnnotation;
import org.springframework.shell.samples.e2e.HelpCommands.Registration;
import org.springframework.shell.samples.e2e.HelpCommands.Annotation;
import org.springframework.shell.test.ShellTestClient.BaseShellSession;
import org.springframework.test.context.ContextConfiguration;
@ContextConfiguration(classes = { LegacyAnnotation.class, Registration.class })
@EnableCommand(Annotation.class)
class HelpCommandsTests extends AbstractSampleTests {
@ParameterizedTest
@E2ESource(command = "help-desc-1 --help")
void testHelpDesc1(String command, boolean interactive) {
BaseShellSession<?> session = createSession(command, interactive);
assertScreenContainsText(session, "arg1 desc");
}
}