Command not registered if @Profile(..) is used and activated

[tkrah]

Hi,

I got some command which have:

@Component
@Profile("solr")
public class IndexCommand {
...
}

In v3 this works like expected, if the profile solr is enabled, it gets registered.

In v4 the command is not available at all if you use @Profile(..) although the profile is activated - looks like a bug to me, anyone?

[fmbenhassine]

This is a valid issue. Thank you for reporting it! I will plan the fix for the upcoming release.

[czpilar]

Hello,

I've just tried to reproduce the issue to help fix the problem, but I'm not sure if my configuration is correct because I'm not able to replicate the issue with the following steps.

If I am not mistaken, the issue is about class level Profile configuration.

So considering the following configuration:

package org.springframework.shell.samples.helloworld.boot;

import org.springframework.context.annotation.Profile;
import org.springframework.shell.core.command.annotation.Command;
import org.springframework.shell.core.command.annotation.Option;
import org.springframework.stereotype.Component;

@Component
@Profile("greetings")
public class GreetingCommands {

	@Command(name = "hello", description = "Say hello to a given name", group = "Greetings",
			help = "A command that greets the user with 'Hello ${name}!'. Usage: hello [-n | --name]=<name>")
	public void sayHello(@Option(shortName = 'n', longName = "name", description = "the name of the person to greet",
			defaultValue = "World") String name) {
		System.out.println("Hello " + name + "!");
	}

}

package org.springframework.shell.samples.helloworld.boot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SpringShellApplication {

	public static void main(String[] args) {
		SpringApplication.run(SpringShellApplication.class, args);
	}

}

Running the application with an enabled profile and command is registered and works as expected:

mvnw -pl org.springframework.shell:spring-shell-sample-spring-boot spring-boot:run -Dspring-boot.run.profiles=greetings

or equivalently:

mvnw -pl org.springframework.shell:spring-shell-sample-spring-boot spring-boot:run -Dspring-boot.run.jvmArguments="-Dspring.profiles.active=greetings"

Running the application without an enabled profile and command is not registered:

mvnw -pl org.springframework.shell:spring-shell-sample-spring-boot spring-boot:run

[fmbenhassine]

@czpilar Thank you for trying to help on this!

I believe I validated this bug by mistake, and here is why: when I tested this back then, I used the non-boot version of the hello world sample (since the OP did not mention Boot). And here is the quick sample I used:

package org.springframework.shell.samples.helloworld;

import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Profile;
import org.springframework.shell.core.ShellRunner;
import org.springframework.shell.core.command.annotation.Command;
import org.springframework.shell.core.command.annotation.EnableCommand;
import org.springframework.shell.core.command.annotation.Option;
import org.springframework.stereotype.Component;

@EnableCommand(SpringShellApplication.class)
public class SpringShellApplication {

	public static void main(String[] args) throws Exception {
		ApplicationContext context = new AnnotationConfigApplicationContext(SpringShellApplication.class);
		ShellRunner runner = context.getBean(ShellRunner.class);
		runner.run(args);
	}

	@Component
	@Profile("greeting")
	static class GreetingCommands {

		@Command(name = "hello", description = "Say hello to a given name", group = "Greetings",
				help = "A command that greets the user with 'Hello ${name}!'. Usage: hello [-n | --name]=<name>")
		public void sayHello(@Option(shortName = 'n', longName = "name",
				description = "the name of the person to greet", defaultValue = "World") String name) {
			System.out.println("Hello " + name + "!");
		}

		@Command(name = "goodbye", description = "Say goodbye to a given name", group = "Greetings",
				help = "A command that says goodbye to the user with 'Goodbye ${name}!'. Usage: goodbye [-n | --name]=<name>")
		public void sayGoodbye(@Option(shortName = 'n', longName = "name",
				description = "the name of the person to say goodbye to", defaultValue = "World") String name) {
			System.out.println("Goodbye " + name + "!");
		}

	}

}

Running this sample with the greeting profile active does not show the commands, so I thought the bug report is valid.. but my sample was actually incorrect, it should have been like:

--@EnableCommand(SpringShellApplication.class)
++@EnableCommand(SpringShellApplication.GreetingCommands.class)
public class SpringShellApplication {
...
}

which works as expected with profiles. I just re-tested with nested and non-nested classes and profile honouring seems to work with boot and non-boot samples.

@tkrah Can you please provide a minimal complete sample that we can use to reproduce the issue? Are you sure your IndexCommand is not excluded from classpath scanning and correctly defined as a bean?