Merge pull request #477 from luksrn/spring_boot_starter_fix_and_improving

Spring Boot autoconfiguration improvements.

telegrambots-spring-boot-starter/README.md

@@ -25,7 +25,7 @@ Usage
 **Gradle**
 
 ```gradle
-    compile "org.telegram:telegrambots-spring-boot-starter:3.6"
+    compile "org.telegram:telegrambots-spring-boot-starter:3.6.1"
 ```
 
 Motivation
@@ -39,8 +39,6 @@ Your main spring boot class should look like this:
 
 ```java
 @SpringBootApplication
-//Add this annotation to enable automatic bots initializing
-@EnableTelegramBots
 public class YourApplicationMainClass {
 
 	public static void main(String[] args) {

telegrambots-spring-boot-starter/pom.xml

@@ -60,7 +60,7 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
         <bots.version>3.6.1</bots.version>
-        <spring-boot.version>1.5.10.RELEASE</spring-boot.version>
+        <spring-boot.version>2.0.2.RELEASE</spring-boot.version>
     </properties>
 
     <dependencies>
@@ -75,24 +75,41 @@
             <artifactId>spring-boot</artifactId>
             <version>${spring-boot.version}</version>
         </dependency>
+        
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-autoconfigure</artifactId>
             <version>${spring-boot.version}</version>
         </dependency>
         
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-test</artifactId>
+			<version>${spring-boot.version}</version>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>org.assertj</groupId>
+			<artifactId>assertj-core</artifactId>
+			<scope>test</scope>
+			<version>3.9.1</version>
+		</dependency>
+		
         <dependency>
             <groupId>org.mockito</groupId>
             <artifactId>mockito-all</artifactId>
             <version>2.0.2-beta</version>
             <scope>test</scope>
         </dependency>
+        
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
             <version>4.11</version>
             <scope>test</scope>
         </dependency>
+         
     </dependencies>
 
     <build>

telegrambots-spring-boot-starter/src/main/java/org/telegram/telegrambots/starter/EnableTelegramBots.java

@@ -1,10 +0,0 @@
-package org.telegram.telegrambots.starter;
-
-import org.springframework.context.annotation.Import;
-
-/**
- * Imports configuration #TelegramBotStarterConfiguration in spring context.
- */
-@Import(TelegramBotStarterConfiguration.class)
-public @interface EnableTelegramBots {
-}

telegrambots-spring-boot-starter/src/main/java/org/telegram/telegrambots/starter/TelegramBotInitializer.java

@@ -0,0 +1,45 @@
+package org.telegram.telegrambots.starter;
+
+import java.util.List;
+import java.util.Objects;
+
+import org.springframework.beans.factory.InitializingBean;
+import org.telegram.telegrambots.TelegramBotsApi;
+import org.telegram.telegrambots.exceptions.TelegramApiException;
+import org.telegram.telegrambots.generics.LongPollingBot;
+import org.telegram.telegrambots.generics.WebhookBot;
+
+/**
+ * Receives all beand which are #LongPollingBot and #WebhookBot and register them in #TelegramBotsApi.
+ */
+public class TelegramBotInitializer implements InitializingBean {
+
+	private final TelegramBotsApi telegramBotsApi;
+    private final List<LongPollingBot> longPollingBots;
+    private final List<WebhookBot> webHookBots;
+
+    public TelegramBotInitializer(TelegramBotsApi telegramBotsApi,
+    								List<LongPollingBot> longPollingBots,
+                                    List<WebhookBot> webHookBots) {
+    	Objects.requireNonNull(telegramBotsApi);
+    	Objects.requireNonNull(longPollingBots);
+    	Objects.requireNonNull(webHookBots);
+    	this.telegramBotsApi = telegramBotsApi;
+        this.longPollingBots = longPollingBots;
+        this.webHookBots = webHookBots;
+    }
+
+	@Override
+	public void afterPropertiesSet() throws Exception {
+		try {
+            for (LongPollingBot bot : longPollingBots) {
+                telegramBotsApi.registerBot(bot);
+            }
+            for (WebhookBot bot : webHookBots) {
+                telegramBotsApi.registerBot(bot);
+            }
+        } catch (TelegramApiException e) {
+            throw new RuntimeException(e);
+        }		
+	}
+}

telegrambots-spring-boot-starter/src/main/java/org/telegram/telegrambots/starter/TelegramBotStarterConfiguration.java

@@ -1,70 +1,37 @@
 package org.telegram.telegrambots.starter;
 
-import org.springframework.beans.factory.annotation.Autowired;
+import java.util.Collections;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Configuration;
-import org.telegram.telegrambots.TelegramBotsApi;
-import org.telegram.telegrambots.exceptions.TelegramApiRequestException;
-import org.telegram.telegrambots.generics.LongPollingBot;
-import org.telegram.telegrambots.generics.WebhookBot;
-
-import javax.annotation.PostConstruct;
 import java.util.List;
 import java.util.Optional;
 
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.telegram.telegrambots.TelegramBotsApi;
+import org.telegram.telegrambots.generics.LongPollingBot;
+import org.telegram.telegrambots.generics.WebhookBot;
+
 /**
- * Receives all beand which are #LongPollingBot and #WebhookBot and register them in #TelegramBotsApi.
  * #TelegramBotsApi added to spring context as well
  */
 @Configuration
+@ConditionalOnProperty(prefix="telegrambots",name = "enabled", havingValue = "true", matchIfMissing = true)
 public class TelegramBotStarterConfiguration {
 	
-
-    private final List<LongPollingBot> longPollingBots;
-    private final List<WebhookBot> webHookBots;
-
-    private TelegramBotsApi telegramBotsApi;
-
-    @Autowired
-    public void setTelegramBotsApi(TelegramBotsApi telegramBotsApi) {
-        this.telegramBotsApi = telegramBotsApi;
-    }
-
-    public TelegramBotStarterConfiguration(@Autowired(required = false) List<LongPollingBot> longPollingBots,
-                                           @Autowired(required = false) List<WebhookBot> webHookBots) {
-
-        this.longPollingBots = longPollingBots;
-        this.webHookBots = webHookBots;
-    }
-
-    @PostConstruct
-    public void registerBots() {
-        Optional.ofNullable(longPollingBots).ifPresent(bots -> {
-            bots.forEach(bot -> {
-                try {
-                    telegramBotsApi.registerBot(bot);
-                } catch (TelegramApiRequestException e) {
-                    throw new RuntimeException(e);
-                }
-            });
-        });
-
-        Optional.ofNullable(webHookBots).ifPresent(bots -> {
-            bots.forEach(bot -> {
-                try {
-                    telegramBotsApi.registerBot(bot);
-                } catch (TelegramApiRequestException e) {
-                    throw new RuntimeException(e);
-                }
-            });
-        });
-    }
-
-
     @Bean
     @ConditionalOnMissingBean(TelegramBotsApi.class)
     public TelegramBotsApi telegramBotsApi() {    	
         return new TelegramBotsApi();
     }
+    
+    @Bean
+	@ConditionalOnMissingBean
+	public TelegramBotInitializer telegramBotInitializer(TelegramBotsApi telegramBotsApi,
+										Optional<List<LongPollingBot>> longPollingBots,
+							            Optional<List<WebhookBot>> webHookBots) {
+		return new TelegramBotInitializer(telegramBotsApi, 
+						longPollingBots.orElseGet(Collections::emptyList), 
+						webHookBots.orElseGet(Collections::emptyList));
+    }
 }

telegrambots-spring-boot-starter/src/main/resources/META-INF/spring.factories

@@ -0,0 +1 @@
+org.springframework.boot.autoconfigure.EnableAutoConfiguration=org.telegram.telegrambots.starter.TelegramBotStarterConfiguration

telegrambots-spring-boot-starter/src/test/java/org/telegram/telegrambots/starter/TestTelegramBotStarterConfiguration.java

@@ -1,66 +1,99 @@
 package org.telegram.telegrambots.starter;
 
-import com.google.common.collect.Lists;
+
-import org.junit.Rule;
+import static org.assertj.core.api.Assertions.assertThat;
+
 import org.junit.Test;
-import org.mockito.Answers;
+import static org.mockito.Mockito.*;
-import org.mockito.Mock;
+import org.springframework.boot.autoconfigure.AutoConfigurations;
-import org.mockito.junit.MockitoJUnit;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
-import org.mockito.junit.MockitoRule;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
 import org.telegram.telegrambots.TelegramBotsApi;
-import org.telegram.telegrambots.exceptions.TelegramApiRequestException;
 import org.telegram.telegrambots.generics.LongPollingBot;
 import org.telegram.telegrambots.generics.WebhookBot;
 
-import static org.mockito.Matchers.any;
-import static org.mockito.Mockito.*;
-
 public class TestTelegramBotStarterConfiguration {
 
-    @Mock
+	private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
-    private TelegramBotsApi telegramBotsApi;
+			.withConfiguration(AutoConfigurations.of(MockTelegramBotsApi.class, TelegramBotStarterConfiguration.class));
-
-    @Rule
-    public MockitoRule mockitoRule = MockitoJUnit.rule();
 
 	@Test
-    public void TestRegisterBotsWithLongPollingBots() throws TelegramApiRequestException {
+	public void createMockTelegramBotsApiWithDefaultSettings() {
-        when(telegramBotsApi.registerBot(any(LongPollingBot.class))).then(Answers.RETURNS_MOCKS.get());
+		this.contextRunner.run((context) -> {
-        LongPollingBot longPollingBot = mock(LongPollingBot.class);
+			assertThat(context).hasSingleBean(TelegramBotsApi.class);
-        TelegramBotStarterConfiguration configuration = new TelegramBotStarterConfiguration(Lists.newArrayList(longPollingBot), null);
+			assertThat(context).hasSingleBean(TelegramBotInitializer.class);
-        configuration.setTelegramBotsApi(telegramBotsApi);
+			assertThat(context).doesNotHaveBean(LongPollingBot.class);
-
+			assertThat(context).doesNotHaveBean(WebhookBot.class);
-        configuration.registerBots();
+			verifyNoMoreInteractions(context.getBean(TelegramBotsApi.class));
-
+		});
-        verify(telegramBotsApi, times(1)).registerBot(longPollingBot);
-        verifyNoMoreInteractions(telegramBotsApi);
 	}
 	
 	@Test
-    public void TestRegisterBotsWithWebhookBots() throws TelegramApiRequestException {
+	public void createOnlyLongPollingBot() {
-        doNothing().when(telegramBotsApi).registerBot(any(WebhookBot.class));
+		this.contextRunner.withUserConfiguration(LongPollingBotConfig.class)
-        WebhookBot webhookBot = mock(WebhookBot.class);
+				.run((context) -> {
-        TelegramBotStarterConfiguration configuration = new TelegramBotStarterConfiguration(null, Lists.newArrayList(webhookBot));
+					assertThat(context).hasSingleBean(LongPollingBot.class);
-        configuration.setTelegramBotsApi(telegramBotsApi);
+					assertThat(context).doesNotHaveBean(WebhookBot.class);
 					
-        configuration.registerBots();
+					TelegramBotsApi telegramBotsApi = context.getBean(TelegramBotsApi.class);
 			        
-        verify(telegramBotsApi, times(1)).registerBot(webhookBot);
+					verify(telegramBotsApi, times(1)).registerBot( context.getBean(LongPollingBot.class) );
 			        verifyNoMoreInteractions(telegramBotsApi);
+		});
 	}
 	
 	@Test
-    public void TestRegisterBotsWithLongPollingBotsAndWebhookBots() throws TelegramApiRequestException {
+	public void createOnlyWebhookBot() {
-        doNothing().when(telegramBotsApi).registerBot(any(WebhookBot.class));
+		this.contextRunner.withUserConfiguration(WebhookBotConfig.class)
-        LongPollingBot longPollingBot = mock(LongPollingBot.class);
+				.run((context) -> {
-        WebhookBot webhookBot = mock(WebhookBot.class);
+					assertThat(context).hasSingleBean(WebhookBot.class);
-        TelegramBotStarterConfiguration configuration = new TelegramBotStarterConfiguration(Lists.newArrayList(longPollingBot), Lists.newArrayList(webhookBot));
+					assertThat(context).doesNotHaveBean(LongPollingBot.class);
-        configuration.setTelegramBotsApi(telegramBotsApi);
 					
-        configuration.registerBots();
+					TelegramBotsApi telegramBotsApi = context.getBean(TelegramBotsApi.class);
 					
-        verify(telegramBotsApi, times(1)).registerBot(longPollingBot);
+			        verify(telegramBotsApi, times(1)).registerBot( context.getBean(WebhookBot.class) );
-        verify(telegramBotsApi, times(1)).registerBot(webhookBot);
 			        verifyNoMoreInteractions(telegramBotsApi);
+		});
+	}
+	
+	@Test
+	public void createLongPoolingBotAndWebhookBot() {
+		this.contextRunner.withUserConfiguration(LongPollingBotConfig.class, WebhookBotConfig.class)
+				.run((context) -> {
+					assertThat(context).hasSingleBean(LongPollingBot.class);
+					assertThat(context).hasSingleBean(WebhookBot.class);
+
+					TelegramBotsApi telegramBotsApi = context.getBean(TelegramBotsApi.class);
+					
+			        verify(telegramBotsApi, times(1)).registerBot( context.getBean(LongPollingBot.class) );
+			        verify(telegramBotsApi, times(1)).registerBot( context.getBean(WebhookBot.class) );
+			        //verifyNoMoreInteractions(telegramBotsApi);
+		});
+	}
+
+	@Configuration
+	static class MockTelegramBotsApi{
+
+		@Bean
+		public TelegramBotsApi telegramBotsApi() {
+			return mock(TelegramBotsApi.class);
+		}
+	}
+	
+	@Configuration
+	static class LongPollingBotConfig{
+		@Bean
+		public LongPollingBot longPollingBot() {
+			return mock(LongPollingBot.class);
+		}
+	}
+	
+	@Configuration
+	static class WebhookBotConfig{
+		@Bean
+		public WebhookBot webhookBot() {
+			return mock(WebhookBot.class);
+		}
 	}
 }