build(Gradle): Move advisors to individual plugin projects

Signed-off-by: Sebastian Schuberth <[email protected]>
oss-review-toolkit · Nov 3, 2023 · df5ede2 · df5ede2
1 parent ae37645
commit df5ede2
Show file tree

Hide file tree

Showing 39 changed files with 235 additions and 37 deletions.
diff --git a/advisor/build.gradle.kts b/advisor/build.gradle.kts
@@ -24,18 +24,11 @@ plugins {
 
 dependencies {
     api(project(":model"))
+    api(project(":utils:common-utils"))
 
-    implementation(project(":clients:github-graphql-client"))
-    implementation(project(":clients:nexus-iq-client"))
-    implementation(project(":clients:oss-index-client"))
-    implementation(project(":clients:osv-client"))
-    implementation(project(":clients:vulnerable-code-client"))
+    implementation(project(":utils:ort-utils"))
 
-    implementation(libs.cvssCalculator)
-    implementation(libs.bundles.kotlinxSerialization)
     implementation(libs.kotlinxCoroutines)
-    implementation(libs.ktorClientOkHttp)
 
     testImplementation(libs.mockk)
-    testImplementation(libs.wiremock)
 }
diff --git a/...r/src/main/resources/META-INF/services/org.ossreviewtoolkit.advisor.AdviceProviderFactory b/...r/src/main/resources/META-INF/services/org.ossreviewtoolkit.advisor.AdviceProviderFactory
diff --git a/plugins/advisors/build.gradle.kts b/plugins/advisors/build.gradle.kts
@@ -0,0 +1,23 @@
+/*
+ * Copyright (C) 2023 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
+ */
+
+plugins {
+    // Apply precompiled plugins.
+    id("ort-plugins-conventions")
+}
diff --git a/plugins/advisors/github/build.gradle.kts b/plugins/advisors/github/build.gradle.kts
@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2020 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
+ */
+
+plugins {
+    // Apply precompiled plugins.
+    id("ort-library-conventions")
+}
+
+dependencies {
+    api(project(":advisor"))
+    api(project(":model"))
+
+    implementation(project(":clients:github-graphql-client"))
+    implementation(project(":utils:common-utils"))
+    implementation(project(":utils:ort-utils"))
+
+    implementation(libs.kotlinxCoroutines)
+    implementation(libs.ktorClientOkHttp)
+
+    testImplementation(libs.mockk)
+}
diff --git a/...src/main/kotlin/advisors/GitHubDefects.kt → ...s/github/src/main/kotlin/GitHubDefects.kt b/...src/main/kotlin/advisors/GitHubDefects.kt → ...s/github/src/main/kotlin/GitHubDefects.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.advisor.advisors
+package org.ossreviewtoolkit.plugins.advisors.github
 
 import io.ktor.client.HttpClient
 import io.ktor.client.engine.okhttp.OkHttp

diff --git a/...in/advisors/GitHubDefectsConfiguration.kt → ...main/kotlin/GitHubDefectsConfiguration.kt b/...in/advisors/GitHubDefectsConfiguration.kt → ...main/kotlin/GitHubDefectsConfiguration.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.advisor.advisors
+package org.ossreviewtoolkit.plugins.advisors.github
 
 /**
  * The configuration for the GitHub Defects advisor.

diff --git a/...b/src/main/resources/META-INF/services/org.ossreviewtoolkit.advisor.AdviceProviderFactory b/...b/src/main/resources/META-INF/services/org.ossreviewtoolkit.advisor.AdviceProviderFactory
@@ -0,0 +1 @@
+org.ossreviewtoolkit.plugins.advisors.github.GitHubDefects$Factory
diff --git a/...test/kotlin/advisors/GitHubDefectsTest.kt → ...thub/src/test/kotlin/GitHubDefectsTest.kt b/...test/kotlin/advisors/GitHubDefectsTest.kt → ...thub/src/test/kotlin/GitHubDefectsTest.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.advisor.advisors
+package org.ossreviewtoolkit.plugins.advisors.github
 
 import io.kotest.core.spec.style.WordSpec
 import io.kotest.matchers.collections.beEmpty

diff --git a/plugins/advisors/nexus-iq/build.gradle.kts b/plugins/advisors/nexus-iq/build.gradle.kts
@@ -0,0 +1,32 @@
+/*
+ * Copyright (C) 2020 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
+ */
+
+plugins {
+    // Apply precompiled plugins.
+    id("ort-library-conventions")
+}
+
+dependencies {
+    api(project(":advisor"))
+    api(project(":model"))
+
+    implementation(project(":clients:nexus-iq-client"))
+    implementation(project(":utils:common-utils"))
+    implementation(project(":utils:ort-utils"))
+}
diff --git a/advisor/src/main/kotlin/advisors/NexusIq.kt → ...isors/nexus-iq/src/main/kotlin/NexusIq.kt b/advisor/src/main/kotlin/advisors/NexusIq.kt → ...isors/nexus-iq/src/main/kotlin/NexusIq.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.advisor.advisors
+package org.ossreviewtoolkit.plugins.advisors.nexusiq
 
 import java.net.URI
 import java.time.Duration

diff --git a/...n/kotlin/advisors/NexusIqConfiguration.kt → ...q/src/main/kotlin/NexusIqConfiguration.kt b/...n/kotlin/advisors/NexusIqConfiguration.kt → ...q/src/main/kotlin/NexusIqConfiguration.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.advisor.advisors
+package org.ossreviewtoolkit.plugins.advisors.nexusiq
 
 /**
  * The configuration for Nexus IQ as a security vulnerability provider.

diff --git a/...q/src/main/resources/META-INF/services/org.ossreviewtoolkit.advisor.AdviceProviderFactory b/...q/src/main/resources/META-INF/services/org.ossreviewtoolkit.advisor.AdviceProviderFactory
@@ -0,0 +1 @@
+org.ossreviewtoolkit.plugins.advisors.nexusiq.NexusIq$Factory
diff --git a/plugins/advisors/oss-index/build.gradle.kts b/plugins/advisors/oss-index/build.gradle.kts
@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) 2020 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
+ */
+
+plugins {
+    // Apply precompiled plugins.
+    id("ort-library-conventions")
+}
+
+dependencies {
+    api(project(":advisor"))
+    api(project(":model"))
+
+    implementation(project(":clients:oss-index-client"))
+    implementation(project(":utils:common-utils"))
+    implementation(project(":utils:ort-utils"))
+
+    testImplementation(libs.wiremock)
+}
diff --git a/advisor/src/main/kotlin/advisors/OssIndex.kt → ...ors/oss-index/src/main/kotlin/OssIndex.kt b/advisor/src/main/kotlin/advisors/OssIndex.kt → ...ors/oss-index/src/main/kotlin/OssIndex.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.advisor.advisors
+package org.ossreviewtoolkit.plugins.advisors.ossindex
 
 import java.net.URI
 import java.time.Instant

diff --git a/.../kotlin/advisors/OssIndexConfiguration.kt → .../src/main/kotlin/OssIndexConfiguration.kt b/.../kotlin/advisors/OssIndexConfiguration.kt → .../src/main/kotlin/OssIndexConfiguration.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.advisor.advisors
+package org.ossreviewtoolkit.plugins.advisors.ossindex
 
 /**
  * The configuration for the OSS Index provider.

diff --git a/...x/src/main/resources/META-INF/services/org.ossreviewtoolkit.advisor.AdviceProviderFactory b/...x/src/main/resources/META-INF/services/org.ossreviewtoolkit.advisor.AdviceProviderFactory
@@ -0,0 +1 @@
+org.ossreviewtoolkit.plugins.advisors.ossindex.OssIndex$Factory
diff --git a/advisor/src/test/assets/__files/README.md → ...s-index/src/test/assets/__files/README.md b/advisor/src/test/assets/__files/README.md → ...s-index/src/test/assets/__files/README.md
diff --git a/..._files/oss-index/response_components.json → ...t/assets/__files/response_components.json b/..._files/oss-index/response_components.json → ...t/assets/__files/response_components.json
diff --git a/.../src/test/kotlin/advisors/OssIndexTest.kt → ...oss-index/src/test/kotlin/OssIndexTest.kt b/.../src/test/kotlin/advisors/OssIndexTest.kt → ...oss-index/src/test/kotlin/OssIndexTest.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.advisor.advisors
+package org.ossreviewtoolkit.plugins.advisors.ossindex
 
 import com.github.tomakehurst.wiremock.WireMockServer
 import com.github.tomakehurst.wiremock.client.WireMock.aResponse
@@ -140,7 +140,6 @@ class OssIndexTest : WordSpec({
 private const val ADVISOR_NAME = "OssIndexTest"
 
 private const val TEST_FILES_ROOT = "src/test/assets"
-private const val TEST_FILES_DIRECTORY = "oss-index"
 
 private val ID_HAMCREST = Identifier("Maven:org.hamcrest:hamcrest-core:1.3")
 private val ID_JUNIT = Identifier("Maven:junit:junit:4.12")
@@ -158,7 +157,7 @@ private fun WireMockServer.stubComponentsRequest(responseFile: String) {
             .withHeader("Content-Type", equalTo("application/json; charset=UTF-8"))
             .willReturn(
                 aResponse().withStatus(200)
-                    .withBodyFile("$TEST_FILES_DIRECTORY/$responseFile")
+                    .withBodyFile(responseFile)
             )
     )
 }
diff --git a/plugins/advisors/osv/build.gradle.kts b/plugins/advisors/osv/build.gradle.kts
@@ -0,0 +1,47 @@
+/*
+ * Copyright (C) 2020 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
+ */
+
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+plugins {
+    // Apply precompiled plugins.
+    id("ort-library-conventions")
+}
+
+dependencies {
+    api(project(":advisor"))
+    api(project(":model"))
+
+    implementation(project(":clients:osv-client"))
+    implementation(project(":utils:common-utils"))
+    implementation(project(":utils:ort-utils"))
+
+    implementation(libs.cvssCalculator)
+    implementation(libs.bundles.kotlinxSerialization)
+}
+
+tasks.withType<KotlinCompile>().configureEach {
+    val customCompilerArgs = listOf(
+        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
+    )
+
+    compilerOptions {
+        freeCompilerArgs.addAll(customCompilerArgs)
+    }
+}
diff --git a/...eve-package-findings-expected-result.json → ...eve-package-findings-expected-result.json b/...eve-package-findings-expected-result.json → ...eve-package-findings-expected-result.json
diff --git a/advisor/src/funTest/kotlin/OsvFunTest.kt → ...sors/osv/src/funTest/kotlin/OsvFunTest.kt b/advisor/src/funTest/kotlin/OsvFunTest.kt → ...sors/osv/src/funTest/kotlin/OsvFunTest.kt
@@ -17,16 +17,14 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.advisor
+package org.ossreviewtoolkit.plugins.advisors.osv
 
 import io.kotest.core.spec.style.StringSpec
 import io.kotest.matchers.collections.shouldContainExactlyInAnyOrder
 import io.kotest.matchers.shouldBe
 
 import java.time.Instant
 
-import org.ossreviewtoolkit.advisor.advisors.Osv
-import org.ossreviewtoolkit.advisor.advisors.OsvConfiguration
 import org.ossreviewtoolkit.model.AdvisorResult
 import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.Package

diff --git a/advisor/src/main/kotlin/advisors/Osv.kt → plugins/advisors/osv/src/main/kotlin/Osv.kt b/advisor/src/main/kotlin/advisors/Osv.kt → plugins/advisors/osv/src/main/kotlin/Osv.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.advisor.advisors
+package org.ossreviewtoolkit.plugins.advisors.osv
 
 import java.time.Instant
 

diff --git a/.../main/kotlin/advisors/OsvConfiguration.kt → ...s/osv/src/main/kotlin/OsvConfiguration.kt b/.../main/kotlin/advisors/OsvConfiguration.kt → ...s/osv/src/main/kotlin/OsvConfiguration.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.advisor.advisors
+package org.ossreviewtoolkit.plugins.advisors.osv
 
 /**
  * The configuration for the Google OSV vulnerability provider.

diff --git a/...v/src/main/resources/META-INF/services/org.ossreviewtoolkit.advisor.AdviceProviderFactory b/...v/src/main/resources/META-INF/services/org.ossreviewtoolkit.advisor.AdviceProviderFactory
@@ -0,0 +1 @@
+org.ossreviewtoolkit.plugins.advisors.osv.Osv$Factory
diff --git a/plugins/advisors/vulnerable-code/build.gradle.kts b/plugins/advisors/vulnerable-code/build.gradle.kts
@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) 2020 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
+ */
+
+plugins {
+    // Apply precompiled plugins.
+    id("ort-library-conventions")
+}
+
+dependencies {
+    api(project(":advisor"))
+    api(project(":model"))
+
+    implementation(project(":clients:vulnerable-code-client"))
+    implementation(project(":utils:common-utils"))
+    implementation(project(":utils:ort-utils"))
+
+    testImplementation(libs.wiremock)
+}
diff --git a/...c/funTest/kotlin/VulnerableCodeFunTest.kt → ...c/funTest/kotlin/VulnerableCodeFunTest.kt b/...c/funTest/kotlin/VulnerableCodeFunTest.kt → ...c/funTest/kotlin/VulnerableCodeFunTest.kt
@@ -17,14 +17,12 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.advisor
+package org.ossreviewtoolkit.plugins.advisors.vulnerablecode
 
 import io.kotest.core.spec.style.StringSpec
 import io.kotest.matchers.collections.shouldContainAll
 import io.kotest.matchers.shouldBe
 
-import org.ossreviewtoolkit.advisor.advisors.VulnerableCode
-import org.ossreviewtoolkit.advisor.advisors.VulnerableCodeConfiguration
 import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.Package
 import org.ossreviewtoolkit.model.utils.toPurl

diff --git a/...rc/main/kotlin/advisors/VulnerableCode.kt → ...le-code/src/main/kotlin/VulnerableCode.kt b/...rc/main/kotlin/advisors/VulnerableCode.kt → ...le-code/src/main/kotlin/VulnerableCode.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.advisor.advisors
+package org.ossreviewtoolkit.plugins.advisors.vulnerablecode
 
 import java.net.URI
 import java.time.Instant
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		org.ossreviewtoolkit.plugins.advisors.github.GitHubDefects$Factory
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		org.ossreviewtoolkit.plugins.advisors.nexusiq.NexusIq$Factory
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		org.ossreviewtoolkit.plugins.advisors.ossindex.OssIndex$Factory