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

Jump to bottom

Add runApplication() Kotlin top level function #10511

Closed
wants to merge 3 commits into from
Closed

Add runApplication() Kotlin top level function #10511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7cf668
Add Kotlin main artifacts to dependency management
sdeleuze Oct 6, 2017
844e6ff
Add runApplication() Kotlin top level function
sdeleuze Oct 20, 2017
a92e7de
Specify kotlin-maven-plugin version for plugin management
sdeleuze Oct 25, 2017
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
26 changes: 26 additions & 0 deletions spring-boot-project/spring-boot-dependencies/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@
<junit.version>4.12</junit.version>
<junit-jupiter.version>5.0.1</junit-jupiter.version>
<junit-platform.version>1.0.1</junit-platform.version>
<kotlin.version>1.1.51</kotlin.version>
<lettuce.version>5.0.0.RELEASE</lettuce.version>
<liquibase.version>3.5.3</liquibase.version>
<log4j2.version>2.9.1</log4j2.version>
Expand Down Expand Up @@ -2264,6 +2265,26 @@
<artifactId>jooq-codegen</artifactId>
<version>${jooq.version}</version>
</dependency>
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-reflect</artifactId>
<version>${kotlin.version}</version>
</dependency>
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-stdlib</artifactId>
<version>${kotlin.version}</version>
</dependency>
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-stdlib-jre7</artifactId>
<version>${kotlin.version}</version>
</dependency>
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-stdlib-jre8</artifactId>
<version>${kotlin.version}</version>
</dependency>
<dependency>
<groupId>org.liquibase</groupId>
<artifactId>liquibase-core</artifactId>
Expand Down Expand Up @@ -3003,6 +3024,11 @@
<artifactId>flyway-maven-plugin</artifactId>
<version>${flyway.version}</version>
</plugin>
<plugin>
<groupId>kotlin-maven-plugin</groupId>
<artifactId>org.jetbrains.kotlin</artifactId>
<version>${kotlin.version}</version>
</plugin>
<plugin>
<groupId>pl.project13.maven</groupId>
<artifactId>git-commit-id-plugin</artifactId>
Expand Down
83 changes: 83 additions & 0 deletions spring-boot-project/spring-boot/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,79 @@
<properties>
<main.basedir>${basedir}/../..</main.basedir>
</properties>
<build>
<plugins>
<plugin>
<artifactId>kotlin-maven-plugin</artifactId>
<groupId>org.jetbrains.kotlin</groupId>
<version>${kotlin.version}</version>
<configuration>
<jvmTarget>${java.version}</jvmTarget>
</configuration>
<executions>
<execution>
<id>compile</id>
<phase>compile</phase>
<goals>
<goal>compile</goal>
</goals>
<configuration>
<sourceDirs>
<sourceDir>${project.basedir}/src/main/kotlin</sourceDir>
<sourceDir>${project.basedir}/src/main/java</sourceDir>
</sourceDirs>
</configuration>
</execution>
<execution>
<id>test-compile</id>
<phase>test-compile</phase>
<goals>
<goal>test-compile</goal>
</goals>
<configuration>
<sourceDirs>
<sourceDir>${project.basedir}/src/test/kotlin</sourceDir>
<sourceDir>${project.basedir}/src/test/java</sourceDir>
</sourceDirs>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>${java.version}</source>
<target>${java.version}</target>
<parameters>true</parameters>
</configuration>
<executions>
<execution>
<id>default-compile</id>
<phase>none</phase>
</execution>
<execution>
<id>default-testCompile</id>
<phase>none</phase>
</execution>
<execution>
<id>java-compile</id>
<phase>compile</phase>
<goals>
<goal>compile</goal>
</goals>
</execution>
<execution>
<id>java-test-compile</id>
<phase>test-compile</phase>
<goals>
<goal>testCompile</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
<dependencies>
<!-- Compile -->
<dependency>
Expand Down Expand Up @@ -264,6 +337,16 @@
<artifactId>snakeyaml</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-stdlib</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-reflect</artifactId>
<optional>true</optional>
</dependency>
<!-- Annotation processing -->
<dependency>
<groupId>org.springframework.boot</groupId>
Expand Down
53 changes: 53 additions & 0 deletions ...oject/spring-boot/src/main/kotlin/org/springframework/boot/SpringApplicationExtensions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/*
* Copyright 2012-2017 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
*
* http://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.boot

import org.springframework.context.ConfigurableApplicationContext
import kotlin.reflect.KClass


/**
* Top level function acting as a Kotlin shortcut allowing to write `runApplication<FooApplication>(arg1, arg2)`
* instead of `SpringApplication.run(FooApplication::class.java, arg1, arg2)`.
*
* @author Sebastien Deleuze
* @since 2.0.0
*/
inline fun <reified T : Any> runApplication(vararg args: String): ConfigurableApplicationContext =
SpringApplication.run(T::class.java, *args)

/**
* Top level function acting as a Kotlin shortcut allowing to write `runApplication<FooApplication>(arg1, arg2) { // SpringApplication customization ... }`
* instead of instantiating `SpringApplication` class, customize it and then invoking `run(arg1, arg2)`.
*
* @author Sebastien Deleuze
* @since 2.0.0
*/
inline fun <reified T : Any> runApplication(vararg args: String, init: SpringApplication.() -> Unit): ConfigurableApplicationContext =
SpringApplication(T::class.java).apply(init).run(*args)


/**
* Top level function acting as a Kotlin shortcut allowing to write
* `runApplication(arrayOf(FooApplication::class, FooConfiguration::class), arg1, arg2) { // Optional SpringApplication customization ... }`
* instead of instantiating `SpringApplication` class, customize it and then invoking `run(arrayOf(arg1, arg2))`.`
*
* @author Sebastien Deleuze
* @since 2.0.0
*/
fun runApplication(primarySources: Array<KClass<*>>, vararg args: String, init: SpringApplication.() -> Unit = {}): ConfigurableApplicationContext =
SpringApplication(*primarySources.map { it.java }.toTypedArray()).apply(init).run(*args)
118 changes: 118 additions & 0 deletions .../spring-boot/src/test/kotlin/org/springframework/boot/SpringApplicationExtensionsTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
/*
* Copyright 2002-2017 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
*
* http://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.boot

import org.junit.Assert.*
import org.junit.Test
import org.springframework.beans.factory.getBean
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import org.springframework.core.env.StandardEnvironment

/**
* Tests for `SpringApplicationExtensions`.
*
* @author Sebastien Deleuze
*/
class SpringApplicationExtensionsTests {

@Test
fun `Kotlin runApplication() top level function`() {
val context = runApplication<ExampleWebConfig>()
assertNotNull(context)
}

@Test
fun `Kotlin runApplication() top level function with a custom environment`() {
val environment = StandardEnvironment()
val context = runApplication<ExampleWebConfig> {
setEnvironment(environment)
}
assertNotNull(context)
assertEquals(environment, context.environment)
}

@Test
fun `Kotlin runApplication(arg1, arg2) top level function`() {
val context = runApplication<ExampleWebConfig>("--debug", "spring", "boot")
val args = context.getBean<ApplicationArguments>()
assertArrayEquals(arrayOf("spring", "boot"), args.nonOptionArgs.toTypedArray())
assertTrue(args.containsOption("debug"))
}

@Test
fun `Kotlin runApplication(arg1, arg2) top level function with a custom environment`() {
val environment = StandardEnvironment()
val context = runApplication<ExampleWebConfig>("--debug", "spring", "boot") {
setEnvironment(environment)
}
val args = context.getBean<ApplicationArguments>()
assertArrayEquals(arrayOf("spring", "boot"), args.nonOptionArgs.toTypedArray())
assertTrue(args.containsOption("debug"))
assertEquals(environment, context.environment)
}

@Test
fun `Kotlin runApplication(array of KClass) top level function`() {
val context = runApplication(arrayOf(ExampleConfig::class, ExampleWebConfig::class))
assertNotNull(context)
}

@Test
fun `Kotlin runApplication(array of KClass) top level function with a custom environment`() {
val environment = StandardEnvironment()
val context = runApplication(arrayOf(ExampleConfig::class, ExampleWebConfig::class)) {
setEnvironment(environment)
}
assertNotNull(context)
assertEquals(environment, context.environment)
}

@Test
fun `Kotlin runApplication(array of KClass, arg1, arg2) top level function`() {
val context = runApplication(arrayOf(ExampleConfig::class, ExampleWebConfig::class), "--debug", "spring", "boot")
val args = context.getBean<ApplicationArguments>()
assertArrayEquals(arrayOf("spring", "boot"), args.nonOptionArgs.toTypedArray())
assertTrue(args.containsOption("debug"))
}

@Test
fun `Kotlin runApplication(array of KClass, arg1, arg2) top level function with a custom environment`() {
val environment = StandardEnvironment()
val context = runApplication(arrayOf(ExampleConfig::class, ExampleWebConfig::class), "--debug", "spring", "boot") {
setEnvironment(environment)
}
val args = context.getBean<ApplicationArguments>()
assertArrayEquals(arrayOf("spring", "boot"), args.nonOptionArgs.toTypedArray())
assertTrue(args.containsOption("debug"))
assertEquals(environment, context.environment)
}


@Configuration
internal open class ExampleConfig

@Configuration
internal open class ExampleWebConfig {

@Bean
open fun webServer(): TomcatServletWebServerFactory {
return TomcatServletWebServerFactory(0)
}
}

}