Introduce TestRestTemplate Kotlin extensions

This commit introduces Kotlin extensions similar to the RestOperations ones in order to be able to take advantage of Kotlin reified type parameters for example. See gh-11039
2017-11-15 18:45:32 +01:00
parent 7f8ca64df1
commit cd98da5ee9
4 changed files with 560 additions and 0 deletions
--- a/spring-boot-project/spring-boot-test/src/main/kotlin/org/springframework/boot/test/web/client/TestRestTemplateExtensions.kt
+++ b/spring-boot-project/spring-boot-test/src/main/kotlin/org/springframework/boot/test/web/client/TestRestTemplateExtensions.kt
@@ -0,0 +1,234 @@
+/*
+ * 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.test.web.client
+
+import org.springframework.core.ParameterizedTypeReference
+import org.springframework.http.HttpEntity
+import org.springframework.http.HttpMethod
+import org.springframework.http.RequestEntity
+import org.springframework.http.ResponseEntity
+import org.springframework.web.client.RestClientException
+import java.net.URI
+
+/**
+ * Extension for [TestRestTemplate.getForObject] avoiding specifying the type
+ * parameter thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.getForObject(url: String, vararg uriVariables: Any): T? =
+		getForObject(url, T::class.java, *uriVariables)
+
+/**
+ * Extension for [TestRestTemplate.getForObject] avoiding specifying the type
+ * parameter thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.getForObject(url: String, uriVariables: Map<String, Any?>): T? =
+		getForObject(url, T::class.java, uriVariables)
+
+/**
+ * Extension for [TestRestTemplate.getForObject] avoiding specifying the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.getForObject(url: URI): T? =
+		getForObject(url, T::class.java)
+
+/**
+ * Extension for [TestRestTemplate.getForEntity] avoiding requiring the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.getForEntity(url: URI): ResponseEntity<T> =
+		getForEntity(url, T::class.java)
+
+/**
+ * Extension for [TestRestTemplate.getForEntity] avoiding requiring the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.getForEntity(url: String, vararg uriVariables: Any): ResponseEntity<T> =
+		getForEntity(url, T::class.java, *uriVariables)
+
+/**
+ * Extension for [TestRestTemplate.getForEntity] avoiding requiring the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.getForEntity(url: String, uriVariables: Map<String, *>): ResponseEntity<T> =
+		getForEntity(url, T::class.java, uriVariables)
+
+/**
+ * Extension for [TestRestTemplate.patchForObject] avoiding specifying the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.patchForObject(url: String, request: Any, vararg uriVariables: Any): T? =
+		patchForObject(url, request, T::class.java, *uriVariables)
+
+/**
+ * Extension for [TestRestTemplate.patchForObject] avoiding specifying the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.patchForObject(url: String, request: Any, uriVariables: Map<String, *>): T? =
+		patchForObject(url, request, T::class.java, uriVariables)
+
+/**
+ * Extension for [TestRestTemplate.patchForObject] avoiding specifying the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.patchForObject(url: URI, request: Any): T? =
+		patchForObject(url, request, T::class.java)
+
+/**
+ * Extension for [TestRestTemplate.postForObject] avoiding specifying the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.postForObject(url: String, request: Any, vararg uriVariables: Any): T? =
+		postForObject(url, request, T::class.java, *uriVariables)
+
+/**
+ * Extension for [TestRestTemplate.postForObject] avoiding specifying the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.postForObject(url: String, request: Any, uriVariables: Map<String, *>): T? =
+		postForObject(url, request, T::class.java, uriVariables)
+
+/**
+ * Extension for [TestRestTemplate.postForObject] avoiding specifying the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.postForObject(url: URI, request: Any): T? =
+		postForObject(url, request, T::class.java)
+
+/**
+ * Extension for [TestRestTemplate.postForEntity] avoiding specifying the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.postForEntity(url: String, request: Any, vararg uriVariables: Any): ResponseEntity<T> =
+		postForEntity(url, request, T::class.java, *uriVariables)
+
+/**
+ * Extension for [TestRestTemplate.postForEntity] avoiding specifying the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.postForEntity(url: String, request: Any, uriVariables: Map<String, *>): ResponseEntity<T> =
+		postForEntity(url, request, T::class.java, uriVariables)
+
+/**
+ * Extension for [TestRestTemplate.postForEntity] avoiding specifying the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.postForEntity(url: URI, request: Any): ResponseEntity<T> =
+		postForEntity(url, request, T::class.java)
+
+/**
+ * Extension for [TestRestTemplate.exchange] avoiding specifying the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.exchange(url: String, method: HttpMethod, requestEntity: HttpEntity<*>, vararg uriVariables: Any): ResponseEntity<T> =
+		exchange(url, method, requestEntity, object : ParameterizedTypeReference<T>() {}, *uriVariables)
+
+/**
+ * Extension for [TestRestTemplate.exchange] avoiding specifying the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.exchange(url: String, method: HttpMethod, requestEntity: HttpEntity<*>, uriVariables: Map<String, *>): ResponseEntity<T> =
+		exchange(url, method, requestEntity, object : ParameterizedTypeReference<T>() {}, uriVariables)
+
+/**
+ * Extension for [TestRestTemplate.exchange] avoiding specifying the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.exchange(url: URI, method: HttpMethod, requestEntity: HttpEntity<*>): ResponseEntity<T> =
+		exchange(url, method, requestEntity, object : ParameterizedTypeReference<T>() {})
+
+/**
+ * Extension for [TestRestTemplate.exchange] avoiding specifying the type parameter
+ * thanks to Kotlin reified type parameters.
+ *
+ * @author Sebastien Deleuze
+ * @since 2.0.0
+ */
+@Throws(RestClientException::class)
+inline fun <reified T: Any> TestRestTemplate.exchange(requestEntity: RequestEntity<*>): ResponseEntity<T> =
+		exchange(requestEntity, object : ParameterizedTypeReference<T>() {})