refactor(script): Migrate from deprecated constructorArgs to proper…

…ties This is a preparation for the migration to Kotlin 2.0.0 in order to work around [1]. [1]: https://youtrack.jetbrains.com/issue/KT-68336 Signed-off-by: Sebastian Schuberth <[email protected]>
oss-review-toolkit · May 22, 2024 · fb66d55 · fb66d55
1 parent b8026ba
commit fb66d55
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 19 deletions.
diff --git a/evaluator/src/main/kotlin/Evaluator.kt b/evaluator/src/main/kotlin/Evaluator.kt
@@ -22,7 +22,7 @@ package org.ossreviewtoolkit.evaluator
 import java.time.Instant
 
 import kotlin.script.experimental.api.ScriptEvaluationConfiguration
-import kotlin.script.experimental.api.constructorArgs
+import kotlin.script.experimental.api.providedProperties
 import kotlin.script.experimental.api.scriptsInstancesSharing
 import kotlin.script.experimental.jvmhost.createJvmCompilationConfigurationFromTemplate
 
@@ -45,7 +45,14 @@ class Evaluator(
     override val compConfig = createJvmCompilationConfigurationFromTemplate<RulesScriptTemplate>()
 
     override val evalConfig = ScriptEvaluationConfiguration {
-        constructorArgs(ortResult, licenseInfoResolver, resolutionProvider, licenseClassifications, time)
+        providedProperties(
+            "ortResult" to ortResult,
+            "licenseInfoResolver" to licenseInfoResolver,
+            "resolutionProvider" to resolutionProvider,
+            "licenseClassifications" to licenseClassifications,
+            "time" to time
+        )
+
         scriptsInstancesSharing(true)
     }
 

diff --git a/evaluator/src/main/kotlin/RulesScriptTemplate.kt b/evaluator/src/main/kotlin/RulesScriptTemplate.kt
@@ -24,6 +24,7 @@ import java.time.Instant
 import kotlin.script.experimental.annotations.KotlinScript
 import kotlin.script.experimental.api.ScriptCompilationConfiguration
 import kotlin.script.experimental.api.defaultImports
+import kotlin.script.experimental.api.providedProperties
 
 import org.ossreviewtoolkit.model.OrtResult
 import org.ossreviewtoolkit.model.RuleViolation
@@ -37,13 +38,7 @@ import org.ossreviewtoolkit.utils.scripting.OrtScriptCompilationConfiguration
     fileExtension = "rules.kts",
     compilationConfiguration = RulesScriptCompilationConfiguration::class
 )
-open class RulesScriptTemplate(
-    val ortResult: OrtResult,
-    val licenseInfoResolver: LicenseInfoResolver,
-    val resolutionProvider: ResolutionProvider,
-    val licenseClassifications: LicenseClassifications,
-    val time: Instant
-) {
+open class RulesScriptTemplate {
     val ruleViolations = mutableListOf<RuleViolation>()
 }
 
@@ -58,5 +53,13 @@ class RulesScriptCompilationConfiguration : ScriptCompilationConfiguration(
             "org.ossreviewtoolkit.model.utils.*",
             "org.ossreviewtoolkit.utils.spdx.*"
         )
+
+        providedProperties(
+            "ortResult" to OrtResult::class,
+            "licenseInfoResolver" to LicenseInfoResolver::class,
+            "resolutionProvider" to ResolutionProvider::class,
+            "licenseClassifications" to LicenseClassifications::class,
+            "time" to Instant::class
+        )
     }
 )
diff --git a/notifier/src/main/kotlin/NotificationsScriptTemplate.kt b/notifier/src/main/kotlin/NotificationsScriptTemplate.kt
@@ -22,6 +22,7 @@ package org.ossreviewtoolkit.notifier
 import kotlin.script.experimental.annotations.KotlinScript
 import kotlin.script.experimental.api.ScriptCompilationConfiguration
 import kotlin.script.experimental.api.defaultImports
+import kotlin.script.experimental.api.providedProperties
 
 import org.ossreviewtoolkit.model.OrtResult
 import org.ossreviewtoolkit.utils.scripting.OrtScriptCompilationConfiguration
@@ -31,9 +32,7 @@ import org.ossreviewtoolkit.utils.scripting.OrtScriptCompilationConfiguration
     fileExtension = "notifications.kts",
     compilationConfiguration = NotificationsScriptCompilationConfiguration::class
 )
-open class NotificationsScriptTemplate(
-    val ortResult: OrtResult
-)
+open class NotificationsScriptTemplate
 
 class NotificationsScriptCompilationConfiguration : ScriptCompilationConfiguration(
     OrtScriptCompilationConfiguration(),
@@ -45,5 +44,7 @@ class NotificationsScriptCompilationConfiguration : ScriptCompilationConfigurati
             "org.ossreviewtoolkit.model.utils.*",
             "org.ossreviewtoolkit.notifier.modules.*"
         )
+
+        providedProperties("ortResult" to OrtResult::class)
     }
 )
diff --git a/notifier/src/main/kotlin/Notifier.kt b/notifier/src/main/kotlin/Notifier.kt
@@ -23,7 +23,6 @@ import java.time.Instant
 
 import kotlin.script.experimental.api.KotlinType
 import kotlin.script.experimental.api.ScriptEvaluationConfiguration
-import kotlin.script.experimental.api.constructorArgs
 import kotlin.script.experimental.api.providedProperties
 import kotlin.script.experimental.api.scriptsInstancesSharing
 import kotlin.script.experimental.jvmhost.createJvmCompilationConfigurationFromTemplate
@@ -54,7 +53,7 @@ class Notifier(
     }
 
     override val evalConfig = ScriptEvaluationConfiguration {
-        constructorArgs(ortResult)
+        providedProperties("ortResult" to ortResult)
         scriptsInstancesSharing(true)
 
         providedProperties(customProperties)

diff --git a/reporter/src/main/kotlin/HowToFixTextProvider.kt b/reporter/src/main/kotlin/HowToFixTextProvider.kt
@@ -21,7 +21,7 @@ package org.ossreviewtoolkit.reporter
 
 import kotlin.script.experimental.api.ResultValue
 import kotlin.script.experimental.api.ScriptEvaluationConfiguration
-import kotlin.script.experimental.api.constructorArgs
+import kotlin.script.experimental.api.providedProperties
 import kotlin.script.experimental.api.scriptsInstancesSharing
 import kotlin.script.experimental.jvmhost.createJvmCompilationConfigurationFromTemplate
 
@@ -57,7 +57,7 @@ private class HowToFixScriptRunner(ortResult: OrtResult) : ScriptRunner() {
     override val compConfig = createJvmCompilationConfigurationFromTemplate<HowToFixTextProviderScriptTemplate>()
 
     override val evalConfig = ScriptEvaluationConfiguration {
-        constructorArgs(ortResult)
+        providedProperties("ortResult" to ortResult)
         scriptsInstancesSharing(true)
     }
 

diff --git a/reporter/src/main/kotlin/HowToFixTextProviderScriptTemplate.kt b/reporter/src/main/kotlin/HowToFixTextProviderScriptTemplate.kt
@@ -22,6 +22,7 @@ package org.ossreviewtoolkit.reporter
 import kotlin.script.experimental.annotations.KotlinScript
 import kotlin.script.experimental.api.ScriptCompilationConfiguration
 import kotlin.script.experimental.api.defaultImports
+import kotlin.script.experimental.api.providedProperties
 
 import org.ossreviewtoolkit.model.OrtResult
 import org.ossreviewtoolkit.utils.scripting.OrtScriptCompilationConfiguration
@@ -31,9 +32,7 @@ import org.ossreviewtoolkit.utils.scripting.OrtScriptCompilationConfiguration
     fileExtension = "how-to-fix-text-provider.kts",
     compilationConfiguration = HowToFixTextProviderScriptCompilationConfiguration::class
 )
-open class HowToFixTextProviderScriptTemplate(
-    val ortResult: OrtResult
-)
+open class HowToFixTextProviderScriptTemplate
 
 class HowToFixTextProviderScriptCompilationConfiguration : ScriptCompilationConfiguration(
     OrtScriptCompilationConfiguration(),
@@ -45,5 +44,7 @@ class HowToFixTextProviderScriptCompilationConfiguration : ScriptCompilationConf
             "org.ossreviewtoolkit.model.utils.*",
             "org.ossreviewtoolkit.reporter.HowToFixTextProvider"
         )
+
+        providedProperties("ortResult" to OrtResult::class)
     }
 )