TS-38628 Resolve cucumber test issue and various refactorings

Author: Avanatiker

report-generator/src/main/java/com/teamscale/report/jacoco/OpenAnalyzer.java

@@ -54,6 +54,8 @@
  * {@link Analyzer} requires a {@link ExecutionDataStore} instance that holds
  * the execution data for the classes to analyze. The {@link Analyzer} offers
  * several methods to analyze classes from a variety of sources.
+ * <p>
+ * CAUTION: Do not convert to Kotlin. This class has to stay in Java for future maintenance reasons!
  */
 public class OpenAnalyzer {
 

report-generator/src/main/java/org/jacoco/core/internal/analysis/CachingInstructionsBuilder.java

@@ -29,6 +29,8 @@
  * <p>
  * When updating JaCoCo make a diff of the previous {@link org.jacoco.core.internal.analysis.InstructionsBuilder}
  * implementation and the new implementation and update this class accordingly.
+ * <p>
+ * CAUTION: Do not convert to Kotlin. This class has to stay in Java for future maintenance reasons!
  */
 public class CachingInstructionsBuilder extends InstructionsBuilder {
 

teamscale-client/src/main/kotlin/com/teamscale/client/AntPatternUtils.kt

@@ -149,14 +149,12 @@ object AntPatternUtils {
 	 * Returns whether the given position exists in the string and equals the given character, and the given character
 	 * is either at the end or right before a slash.
 	 */
-	private fun isCharAtBeforeSlashOrEnd(s: String, position: Int, character: Char): Boolean {
-		return isCharAt(s, position, character) && (position + 1 == s.length || isCharAt(s, position + 1, '/'))
-	}
+	private fun isCharAtBeforeSlashOrEnd(s: String, position: Int, character: Char) =
+		isCharAt(s, position, character) && (position + 1 == s.length || isCharAt(s, position + 1, '/'))
 
 	/**
 	 * Returns whether the given position exists in the string and equals the given character.
 	 */
-	private fun isCharAt(s: String, position: Int, character: Char): Boolean {
-		return position < s.length && s[position] == character
-	}
+	private fun isCharAt(s: String, position: Int, character: Char) =
+		position < s.length && s[position] == character
 }

teamscale-client/src/main/kotlin/com/teamscale/client/ClusteredTestDetails.kt

@@ -40,9 +40,7 @@ class ClusteredTestDetails @JsonCreator constructor(
 		fun createWithTestData(
 			uniformPath: String, sourcePath: String, testData: TestData,
 			clusterId: String, partition: String
-		): ClusteredTestDetails {
-			return ClusteredTestDetails(uniformPath, sourcePath, testData.hash, clusterId, partition)
-		}
+		) = ClusteredTestDetails(uniformPath, sourcePath, testData.hash, clusterId, partition)
 	}
 }
 

teamscale-client/src/main/kotlin/com/teamscale/client/CommitDescriptor.kt

@@ -4,8 +4,7 @@ import java.io.Serializable
 import java.util.*
 
 /** Holds the branch and timestamp of a commit.  */
-class CommitDescriptor
-/** Constructor.  */(
+data class CommitDescriptor(
 	/** Branch name of the commit.  */
 	@JvmField val branchName: String,
 	/**
@@ -18,25 +17,7 @@ class CommitDescriptor
 	constructor(branchName: String, timestamp: Long) : this(branchName, timestamp.toString())
 
 	/** Returns a string representation of the commit in a Teamscale REST API compatible format.  */
-	override fun toString(): String {
-		return "$branchName:$timestamp"
-	}
-
-	override fun equals(o: Any?): Boolean {
-		if (this === o) {
-			return true
-		}
-		if (o == null || javaClass != o.javaClass) {
-			return false
-		}
-		val that = o as CommitDescriptor
-		return branchName == that.branchName &&
-				timestamp == that.timestamp
-	}
-
-	override fun hashCode(): Int {
-		return Objects.hash(branchName, timestamp)
-	}
+	override fun toString() = "$branchName:$timestamp"
 
 	companion object {
 		/** Parses the given commit descriptor string.  */

teamscale-client/src/main/kotlin/com/teamscale/client/EReportFormat.kt

@@ -158,7 +158,7 @@ enum class EReportFormat(
 	/**
 	 * Coverage report generated with the Lauterbach Trace32 tool. See section for
 	 * [Supported
- * Upload Formats and Samples](https://docs.teamscale.com/reference/upload-formats-and-samples/) in the user guide for more information about
+ 	 * Upload Formats and Samples](https://docs.teamscale.com/reference/upload-formats-and-samples/) in the user guide for more information about
 	 * the Lauterbach Trace32 tool. See the `trace32_example_reports.zip` for
 	 * additional report examples.
 	 */

teamscale-client/src/main/kotlin/com/teamscale/client/FileLoggingInterceptor.kt

@@ -4,6 +4,7 @@ import okhttp3.Interceptor
 import okhttp3.Request
 import okhttp3.Response
 import okhttp3.ResponseBody
+import okhttp3.ResponseBody.Companion.toResponseBody
 import okio.Buffer
 import java.io.File
 import java.io.FileWriter
@@ -13,44 +14,35 @@ import java.io.PrintWriter
 /**
  * OkHttpInterceptor which prints out the full request and server response of requests to a file.
  */
-class FileLoggingInterceptor
-/** Constructor.  */(private val logfile: File) : Interceptor {
+class FileLoggingInterceptor(
+	private val logfile: File
+) : Interceptor {
 	@Throws(IOException::class)
 	override fun intercept(chain: Interceptor.Chain): Response {
-		val request: Request = chain.request()
+		val request = chain.request()
 
 		val requestStartTime = System.nanoTime()
 		PrintWriter(FileWriter(logfile)).use { fileWriter ->
 			fileWriter.write(
-				String.format(
-					"--> Sending request %s on %s %s%n%s%n", request.method, request.url,
-					chain.connection(),
-					request.headers
-				)
+				"--> Sending request ${request.method} on ${request.url} ${chain.connection()}\n${request.headers}\n"
 			)
 			val requestBuffer = Buffer()
-			if (request.body != null) {
-				request.body?.writeTo(requestBuffer)
-			}
+			request.body?.writeTo(requestBuffer)
 			fileWriter.write(requestBuffer.readUtf8())
 
 			val response = getResponse(chain, request, fileWriter)
-
 			val requestEndTime = System.nanoTime()
 			fileWriter.write(
-				String.format(
-					"<-- Received response for %s %s in %.1fms%n%s%n%n", response.code,
-					response.request.url, (requestEndTime - requestStartTime) / 1e6, response.headers
-				)
+				"<-- Received response for ${response.code} ${response.request.url} in ${(requestEndTime - requestStartTime) / 1e6}ms\n${response.headers}\n\n"
 			)
 
 			var wrappedBody: ResponseBody? = null
-			if (response.body != null) {
-				val contentType = response.body!!.contentType()
-				val content = response.body!!.string()
+			response.body?.let {
+				val contentType = it.contentType()
+				val content = it.string()
 				fileWriter.write(content)
 
-				wrappedBody = ResponseBody.create(contentType, content)
+				wrappedBody = content.toResponseBody(contentType)
 			}
 			return response.newBuilder().body(wrappedBody).build()
 		}

teamscale-client/src/main/kotlin/com/teamscale/client/FileSystemUtils.kt

@@ -7,24 +7,9 @@ import java.nio.charset.StandardCharsets
  * File system utilities.
  */
 object FileSystemUtils {
-	/** Encoding for UTF-8.  */
-	val UTF8_ENCODING: String = StandardCharsets.UTF_8.name()
-
 	/** Unix file path separator  */
 	private const val UNIX_SEPARATOR = '/'
 
-	/**
-	 * Checks if a directory exists. If not it creates the directory and all necessary parent directories.
-	 *
-	 * @throws IOException if directories couldn't be created.
-	 */
-	@Throws(IOException::class)
-	fun ensureDirectoryExists(directory: File) {
-		if (!directory.exists() && !directory.mkdirs()) {
-			throw IOException("Couldn't create directory: $directory")
-		}
-	}
-
 	/**
 	 * Returns a list of all files and directories contained in the given directory and all subdirectories matching the
 	 * filter provided. The given directory itself is not included in the result.
@@ -130,19 +115,4 @@ object FileSystemUtils {
 		}
 		return size
 	}
-
-	/**
-	 * Returns the name of the given file without extension. Example:
-	 * '/home/joe/data.dat' returns 'data'.
-	 */
-	fun getFilenameWithoutExtension(file: File): String {
-		return getFilenameWithoutExtension(file.name)
-	}
-
-	/**
-	 * Returns the name of the given file without extension. Example: 'data.dat' returns 'data'.
-	 */
-	fun getFilenameWithoutExtension(fileName: String): String {
-		return StringUtils.removeLastPart(fileName, '.')
-	}
 }

teamscale-client/src/main/kotlin/com/teamscale/client/HttpUtils.kt

@@ -4,9 +4,6 @@ import okhttp3.Authenticator
 import okhttp3.Credentials.basic
 import okhttp3.Interceptor
 import okhttp3.OkHttpClient.Builder
-import okhttp3.Response
-import okhttp3.Route
-import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 import retrofit2.Retrofit
 import java.io.IOException
@@ -24,24 +21,24 @@ import javax.net.ssl.*
  * Utility functions to set up [Retrofit] and [OkHttpClient].
  */
 object HttpUtils {
-	private val LOGGER: Logger = LoggerFactory.getLogger(HttpUtils::class.java)
+	private val LOGGER = LoggerFactory.getLogger(HttpUtils::class.java)
 
 	/**
 	 * Default read timeout in seconds.
 	 */
 	@JvmField
-	val DEFAULT_READ_TIMEOUT: Duration = Duration.ofSeconds(60)
+	val DEFAULT_READ_TIMEOUT = Duration.ofSeconds(60)
 
 	/**
 	 * Default write timeout in seconds.
 	 */
 	@JvmField
-	val DEFAULT_WRITE_TIMEOUT: Duration = Duration.ofSeconds(60)
+	val DEFAULT_WRITE_TIMEOUT = Duration.ofSeconds(60)
 
 	/**
 	 * HTTP header used for authenticating against a proxy server
 	 */
-	const val PROXY_AUTHORIZATION_HTTP_HEADER: String = "Proxy-Authorization"
+	const val PROXY_AUTHORIZATION_HTTP_HEADER = "Proxy-Authorization"
 
 	/** Controls whether [OkHttpClient]s built with this class will validate SSL certificates.  */
 	private var shouldValidateSsl = true
@@ -68,10 +65,11 @@ object HttpUtils {
 		okHttpBuilderAction: Consumer<Builder>, readTimeout: Duration = DEFAULT_READ_TIMEOUT,
 		writeTimeout: Duration = DEFAULT_WRITE_TIMEOUT
 	): Retrofit {
-		val httpClientBuilder = Builder()
-		setTimeouts(httpClientBuilder, readTimeout, writeTimeout)
-		setUpSslValidation(httpClientBuilder)
-		setUpProxyServer(httpClientBuilder)
+		val httpClientBuilder = Builder().apply {
+			setTimeouts(readTimeout, writeTimeout)
+			setUpSslValidation()
+			setUpProxyServer()
+		}
 		okHttpBuilderAction.accept(httpClientBuilder)
 
 		val builder = Retrofit.Builder().client(httpClientBuilder.build())
@@ -88,41 +86,39 @@ object HttpUtils {
 	 * &
 	 * [https://stackoverflow.com/a/35567936](https://stackoverflow.com/a/35567936)
 	 */
-	private fun setUpProxyServer(httpClientBuilder: Builder) {
+	private fun Builder.setUpProxyServer() {
 		val setHttpsProxyWasSuccessful = setUpProxyServerForProtocol(
 			ProxySystemProperties.Protocol.HTTPS,
-			httpClientBuilder
+			this
 		)
 		if (!setHttpsProxyWasSuccessful) {
-			setUpProxyServerForProtocol(ProxySystemProperties.Protocol.HTTP, httpClientBuilder)
+			setUpProxyServerForProtocol(ProxySystemProperties.Protocol.HTTP, this)
 		}
 	}
 
 	private fun setUpProxyServerForProtocol(
 		protocol: ProxySystemProperties.Protocol,
 		httpClientBuilder: Builder
 	): Boolean {
-		val teamscaleProxySystemProperties = TeamscaleProxySystemProperties(protocol)
+		val proxySystemProperties = TeamscaleProxySystemProperties(protocol)
 		try {
-			if (!teamscaleProxySystemProperties.isProxyServerSet()) {
+			if (!proxySystemProperties.isProxyServerSet()) {
 				return false
 			}
 
 			useProxyServer(
-				httpClientBuilder, teamscaleProxySystemProperties.proxyHost!!,
-				teamscaleProxySystemProperties.proxyPort
+				httpClientBuilder, proxySystemProperties.proxyHost!!,
+				proxySystemProperties.proxyPort
 			)
 		} catch (e: ProxySystemProperties.IncorrectPortFormatException) {
 			LOGGER.warn(e.message)
 			return false
 		}
 
-		if (teamscaleProxySystemProperties.isProxyAuthSet()) {
-			useProxyAuthenticator(
-				httpClientBuilder,
-				teamscaleProxySystemProperties.proxyUser!!,
-				teamscaleProxySystemProperties.proxyPassword!!
-			)
+		if (proxySystemProperties.isProxyAuthSet()) {
+			val user = proxySystemProperties.proxyUser ?: return false
+			val password = proxySystemProperties.proxyPassword ?: return false
+			useProxyAuthenticator(httpClientBuilder, user, password)
 		}
 
 		return true
@@ -133,7 +129,7 @@ object HttpUtils {
 	}
 
 	private fun useProxyAuthenticator(httpClientBuilder: Builder, user: String, password: String) {
-		val proxyAuthenticator = Authenticator { route: Route?, response: Response ->
+		val proxyAuthenticator = Authenticator { _, response ->
 			val credential = basic(user, password)
 			response.request.newBuilder()
 				.header(PROXY_AUTHORIZATION_HTTP_HEADER, credential)
@@ -146,16 +142,16 @@ object HttpUtils {
 	/**
 	 * Sets sensible defaults for the [OkHttpClient].
 	 */
-	private fun setTimeouts(builder: Builder, readTimeout: Duration, writeTimeout: Duration) {
-		builder.connectTimeout(Duration.ofSeconds(60))
-		builder.readTimeout(readTimeout)
-		builder.writeTimeout(writeTimeout)
+	private fun Builder.setTimeouts(readTimeout: Duration, writeTimeout: Duration) {
+		connectTimeout(Duration.ofSeconds(60))
+		readTimeout(readTimeout)
+		writeTimeout(writeTimeout)
 	}
 
 	/**
 	 * Enables or disables SSL certificate validation for the [Retrofit] instance
 	 */
-	private fun setUpSslValidation(builder: Builder) {
+	private fun Builder.setUpSslValidation() {
 		if (shouldValidateSsl) {
 			// this is the default behaviour of OkHttp, so we don't need to do anything
 			return
@@ -164,17 +160,17 @@ object HttpUtils {
 		val sslSocketFactory: SSLSocketFactory
 		try {
 			val sslContext = SSLContext.getInstance("TLS")
-			sslContext.init(null, arrayOf<TrustManager>(TrustAllCertificatesManager.INSTANCE), SecureRandom())
+			sslContext.init(null, arrayOf<TrustManager>(TrustAllCertificatesManager), SecureRandom())
 			sslSocketFactory = sslContext.socketFactory
 		} catch (e: GeneralSecurityException) {
 			LOGGER.error("Could not disable SSL certificate validation. Leaving it enabled", e)
 			return
 		}
 
 		// this causes OkHttp to accept all certificates
-		builder.sslSocketFactory(sslSocketFactory, TrustAllCertificatesManager.INSTANCE)
+		sslSocketFactory(sslSocketFactory, TrustAllCertificatesManager)
 		// this causes it to ignore invalid host names in the certificates
-		builder.hostnameVerifier(HostnameVerifier { hostName: String?, session: SSLSession? -> true })
+		hostnameVerifier { _, _ -> true }
 	}
 
 	/**
@@ -204,11 +200,9 @@ object HttpUtils {
 	/**
 	 * A simple implementation of [X509TrustManager] that simple trusts every certificate.
 	 */
-	class TrustAllCertificatesManager : X509TrustManager {
+	object TrustAllCertificatesManager : X509TrustManager {
 		/** Returns `null`.  */
-		override fun getAcceptedIssuers(): Array<X509Certificate> {
-			return arrayOf()
-		}
+		override fun getAcceptedIssuers() = arrayOf<X509Certificate>()
 
 		/** Does nothing.  */
 		override fun checkServerTrusted(certs: Array<X509Certificate>, authType: String) {
@@ -219,10 +213,5 @@ object HttpUtils {
 		override fun checkClientTrusted(certs: Array<X509Certificate>, authType: String) {
 			// Nothing to do
 		}
-
-		companion object {
-			/** Singleton instance.  */ /*package*/
-			val INSTANCE: TrustAllCertificatesManager = TrustAllCertificatesManager()
-		}
 	}
 }