refactor(ort-utils): Split Extensions.kt and Utils.kt

Similar to 6d34ce5, split `ort-utils` by functionality instead of function
type.

Signed-off-by: Sebastian Schuberth <[email protected]>

Author: sschuberth

plugins/scanners/fossid/src/test/kotlin/FossIdUrlProviderTest.kt

@@ -137,7 +137,7 @@ private fun mockAuthenticator(
     port: Int = PORT,
     authentication: PasswordAuthentication? = AUTHENTICATION
 ) {
-    mockkStatic("org.ossreviewtoolkit.utils.ort.UtilsKt")
+    mockkStatic("org.ossreviewtoolkit.utils.ort.AuthenticationUtilsKt")
     every { requestPasswordAuthentication(any()) } answers {
         val uri = firstArg<URI>()
         authentication.takeIf { uri.host == host && uri.port == port && uri.scheme == "https" && uri.userInfo == null }

plugins/version-control-systems/git/src/test/kotlin/GitTest.kt

@@ -185,7 +185,7 @@ private val testUriAsUrl = URI.create(testUri.toString()).toURL()
  * Mocks the utility function to query password authentication for the test URI. Return the [result] provided.
  */
 private fun mockAuthentication(result: PasswordAuthentication?) {
-    mockkStatic("org.ossreviewtoolkit.utils.ort.UtilsKt")
+    mockkStatic("org.ossreviewtoolkit.utils.ort.AuthenticationUtilsKt")
 
     every {
         requestPasswordAuthentication(testUri.host, testUri.port, testUri.scheme, testUriAsUrl)

utils/ort/src/main/kotlin/AuthenticationUtils.kt

@@ -0,0 +1,52 @@
+/*
+ * Copyright (C) 2017 The ORT Project Authors (see <https://github.com/oss-review-toolkit/ort/blob/main/NOTICE>)
+ *
+ * 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
+ *
+ *     https://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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * License-Filename: LICENSE
+ */
+
+package org.ossreviewtoolkit.utils.ort
+
+import java.net.Authenticator
+import java.net.PasswordAuthentication
+import java.net.URI
+import java.net.URL
+
+/**
+ * Request a [PasswordAuthentication] object for the given [host], [port], [scheme], and optional [url]. Install the
+ * [OrtAuthenticator] and the [OrtProxySelector] beforehand to ensure they are active.
+ */
+fun requestPasswordAuthentication(host: String, port: Int, scheme: String, url: URL? = null): PasswordAuthentication? {
+    OrtAuthenticator.install()
+    OrtProxySelector.install()
+
+    return Authenticator.requestPasswordAuthentication(
+        /* host = */ host,
+        /* addr = */ null,
+        /* port = */ port,
+        /* protocol = */ scheme,
+        /* prompt = */ null,
+        /* scheme = */ null,
+        /* url = */ url,
+        /* reqType = */ Authenticator.RequestorType.SERVER
+    )
+}
+
+/**
+ * Request a [PasswordAuthentication] object for the given [uri]. Install the [OrtAuthenticator] and the
+ * [OrtProxySelector] beforehand to ensure they are active.
+ */
+fun requestPasswordAuthentication(uri: URI): PasswordAuthentication? =
+    requestPasswordAuthentication(uri.host, uri.port, uri.scheme, uri.toURL())

utils/ort/src/main/kotlin/OrtUtils.kt

@@ -0,0 +1,48 @@
+/*
+ * Copyright (C) 2017 The ORT Project Authors (see <https://github.com/oss-review-toolkit/ort/blob/main/NOTICE>)
+ *
+ * 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
+ *
+ *     https://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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * License-Filename: LICENSE
+ */
+
+package org.ossreviewtoolkit.utils.ort
+
+import kotlin.coroutines.CoroutineContext
+import kotlin.coroutines.EmptyCoroutineContext
+
+import kotlinx.coroutines.CoroutineScope
+
+import org.apache.logging.log4j.kotlin.CoroutineThreadContext
+
+/**
+ * Global variable that gets toggled by a command line parameter parsed in the main entry points of the modules.
+ */
+var printStackTrace = false
+
+/**
+ * Print the stack trace of the [Throwable] if [printStackTrace] is set to true.
+ */
+fun Throwable.showStackTrace(): Unit = run { if (printStackTrace) printStackTrace() }
+
+/**
+ * A wrapper for [kotlinx.coroutines.runBlocking] which always adds a [CoroutineThreadContext] to the newly created
+ * coroutine context. This ensures that Log4j's MDC context is not lost when `runBlocking` is used.
+ *
+ * This function should be used instead of [kotlinx.coroutines.runBlocking] in all code that can be used as a library to
+ * preserve any MDC context set by a consumer.
+ */
+fun <T> runBlocking(context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> T): T =
+    @Suppress("ForbiddenMethodCall")
+    kotlinx.coroutines.runBlocking(context + CoroutineThreadContext()) { block() }

utils/ort/src/main/kotlin/Extensions.kt renamed to utils/ort/src/main/kotlin/TempUtils.kt

@@ -48,8 +48,3 @@ fun createOrtTempFile(prefix: String? = null, suffix: String? = null): File =
  */
 fun Any.createOrtTempFile(prefix: String? = null, suffix: String? = null): File =
     kotlin.io.path.createTempFile(createOrtTempDir().toPath(), prefix, suffix).toFile()
-
-/**
- * Print the stack trace of the [Throwable] if [printStackTrace] is set to true.
- */
-fun Throwable.showStackTrace(): Unit = run { if (printStackTrace) printStackTrace() }