Consistently spell it like "metadata"

Signed-off-by: Sebastian Schuberth <[email protected]>
oss-review-toolkit · Sep 26, 2022 · 559c536 · 559c536
1 parent 077f525
commit 559c536
Show file tree

Hide file tree

Showing 34 changed files with 78 additions and 74 deletions.
diff --git a/analyzer/src/funTest/assets/projects/external/git-repo-expected-output.yml b/analyzer/src/funTest/assets/projects/external/git-repo-expected-output.yml
@@ -1673,7 +1673,7 @@ analyzer:
           url: "https://git-wip-us.apache.org/repos/asf/jena.git"
           revision: "jena-3.9.0-rc1"
           path: ""
-        is_meta_data_only: true
+        is_metadata_only: true
       curations: []
     - metadata:
         id: "Maven:org.apache.jena:jena-arq:3.9.0"
@@ -2402,7 +2402,7 @@ analyzer:
           url: "https://git-wip-us.apache.org/repos/asf/thrift.git"
           revision: ""
           path: ""
-        is_meta_data_only: true
+        is_metadata_only: true
       curations: []
     - metadata:
         id: "Maven:org.apache.xmlbeans:xmlbeans:2.6.0"

diff --git a/...Test/assets/projects/synthetic/gradle-all-dependencies-expected-result-with-curations.yml b/...Test/assets/projects/synthetic/gradle-all-dependencies-expected-result-with-curations.yml
@@ -458,7 +458,7 @@ analyzer:
           url: "https://gitbox.apache.org/repos/asf/struts.git"
           revision: "STRUTS_2_5_14_1"
           path: ""
-        is_meta_data_only: true
+        is_metadata_only: true
       curations: []
     - metadata:
         id: "Maven:org.hamcrest:hamcrest-core:1.3"

diff --git a/analyzer/src/funTest/assets/projects/synthetic/gradle-all-dependencies-expected-result.yml b/analyzer/src/funTest/assets/projects/synthetic/gradle-all-dependencies-expected-result.yml
@@ -458,7 +458,7 @@ analyzer:
           url: "https://gitbox.apache.org/repos/asf/struts.git"
           revision: "STRUTS_2_5_14_1"
           path: ""
-        is_meta_data_only: true
+        is_metadata_only: true
       curations: []
     - metadata:
         id: "Maven:org.hamcrest:hamcrest-core:1.3"

diff --git a/analyzer/src/funTest/assets/projects/synthetic/gradle-expected-output-app.yml b/analyzer/src/funTest/assets/projects/synthetic/gradle-expected-output-app.yml
@@ -214,4 +214,4 @@ packages:
     url: "https://gitbox.apache.org/repos/asf/struts.git"
     revision: "STRUTS_2_5_14_1"
     path: ""
-  is_meta_data_only: true
+  is_metadata_only: true
diff --git a/analyzer/src/funTest/assets/projects/synthetic/gradle-expected-output-lib.yml b/analyzer/src/funTest/assets/projects/synthetic/gradle-expected-output-lib.yml
@@ -242,7 +242,7 @@ packages:
     url: "https://gitbox.apache.org/repos/asf/struts.git"
     revision: "STRUTS_2_5_14_1"
     path: ""
-  is_meta_data_only: true
+  is_metadata_only: true
 - id: "Maven:org.hamcrest:hamcrest-core:1.3"
   purl: "pkg:maven/org.hamcrest/[email protected]"
   authors:

diff --git a/analyzer/src/funTest/assets/projects/synthetic/gradle-library-expected-output-app.yml b/analyzer/src/funTest/assets/projects/synthetic/gradle-library-expected-output-app.yml
@@ -212,4 +212,4 @@ packages:
     url: "https://gitbox.apache.org/repos/asf/struts.git"
     revision: "STRUTS_2_5_14_1"
     path: ""
-  is_meta_data_only: true
+  is_metadata_only: true
diff --git a/analyzer/src/funTest/assets/projects/synthetic/gradle-library-expected-output-lib.yml b/analyzer/src/funTest/assets/projects/synthetic/gradle-library-expected-output-lib.yml
@@ -242,7 +242,7 @@ packages:
     url: "https://gitbox.apache.org/repos/asf/struts.git"
     revision: "STRUTS_2_5_14_1"
     path: ""
-  is_meta_data_only: true
+  is_metadata_only: true
 - id: "Maven:org.hamcrest:hamcrest-core:1.3"
   purl: "pkg:maven/org.hamcrest/[email protected]"
   authors:

diff --git a/analyzer/src/funTest/assets/projects/synthetic/maven-expected-output-app.yml b/analyzer/src/funTest/assets/projects/synthetic/maven-expected-output-app.yml
@@ -69,7 +69,7 @@ packages:
     url: "https://gitbox.apache.org/repos/asf/beam.git"
     revision: "v2.3.0-RC3"
     path: ""
-  is_meta_data_only: true
+  is_metadata_only: true
 - id: "Maven:org.apache.commons:commons-lang3:3.5"
   purl: "pkg:maven/org.apache.commons/[email protected]"
   authors:

diff --git a/analyzer/src/funTest/assets/projects/synthetic/maven-expected-output-lib.yml b/analyzer/src/funTest/assets/projects/synthetic/maven-expected-output-lib.yml
@@ -102,7 +102,7 @@ packages:
     url: "https://gitbox.apache.org/repos/asf/beam.git"
     revision: "v2.3.0-RC3"
     path: ""
-  is_meta_data_only: true
+  is_metadata_only: true
 - id: "Maven:org.apache.commons:commons-lang3:3.5"
   purl: "pkg:maven/org.apache.commons/[email protected]"
   authors:

diff --git a/...Test/assets/projects/synthetic/pub-expected-output-with-flutter-android-and-cocoapods.yml b/...Test/assets/projects/synthetic/pub-expected-output-with-flutter-android-and-cocoapods.yml
@@ -2039,7 +2039,7 @@ packages:
       url: "https://github.com/Kotlin/kotlinx.coroutines.git"
       revision: ""
       path: ""
-    is_meta_data_only: true
+    is_metadata_only: true
   curations: []
 - metadata:
     id: "Maven:org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.5.2"

diff --git a/analyzer/src/main/kotlin/managers/Pip.kt b/analyzer/src/main/kotlin/managers/Pip.kt
@@ -384,7 +384,7 @@ class Pip(
         }.getOrThrow()
 
         // Get the locally available metadata for all installed packages as a fallback.
-        val installedPackages = getInstalledPackagesWithLocalMetaData(virtualEnvDir, workingDir).associateBy { it.id }
+        val installedPackages = getInstalledPackagesWithLocalMetadata(virtualEnvDir, workingDir).associateBy { it.id }
 
         val fullDependencyTree = jsonMapper.readTree(jsonFile)
         jsonFile.parentFile.safeDeleteRecursively(force = true)
@@ -649,7 +649,7 @@ class Pip(
         }.getOrDefault(Package.EMPTY.copy(id = id))
     }
 
-    private fun getInstalledPackagesWithLocalMetaData(virtualEnvDir: File, workingDir: File): List<Package> {
+    private fun getInstalledPackagesWithLocalMetadata(virtualEnvDir: File, workingDir: File): List<Package> {
         val allPackages = listAllInstalledPackages(virtualEnvDir, workingDir)
 
         // Invoking 'pip show' once for each package separately is too slow, thus obtain the output for all packages

diff --git a/analyzer/src/main/kotlin/managers/utils/MavenSupport.kt b/analyzer/src/main/kotlin/managers/utils/MavenSupport.kt
@@ -709,7 +709,7 @@ class MavenSupport(private val workspaceReader: WorkspaceReader) {
             PackageManager.processProjectVcs(it, vcsFromPackage, *vcsFallbackUrls)
         } ?: PackageManager.processPackageVcs(vcsFromPackage, *vcsFallbackUrls)
 
-        val isSpringMetaDataProject = with(mavenProject) {
+        val isSpringMetadataProject = with(mavenProject) {
             listOf("boot", "cloud").any {
                 groupId == "org.springframework.$it" && (
                         artifactId.startsWith("spring-$it-starter") ||
@@ -734,7 +734,7 @@ class MavenSupport(private val workspaceReader: WorkspaceReader) {
             sourceArtifact = sourceRemoteArtifact,
             vcs = vcsFromPackage,
             vcsProcessed = vcsProcessed,
-            isMetaDataOnly = mavenProject.packaging == "pom" || isSpringMetaDataProject,
+            isMetadataOnly = mavenProject.packaging == "pom" || isSpringMetadataProject,
             isModified = isBinaryArtifactModified || isSourceArtifactModified
         )
     }

diff --git a/analyzer/src/main/kotlin/managers/utils/NuGetAllPackageData.kt b/analyzer/src/main/kotlin/managers/utils/NuGetAllPackageData.kt
@@ -85,11 +85,11 @@ internal class NuGetAllPackageData(
 
     // See https://docs.microsoft.com/en-us/nuget/reference/nuspec.
     data class PackageSpec(
-        val metadata: MetaData
+        val metadata: Metadata
     )
 
     @JsonIgnoreProperties(ignoreUnknown = true)
-    data class MetaData(
+    data class Metadata(
         // See https://docs.microsoft.com/en-us/nuget/reference/nuspec#required-metadata-elements
         val id: String,
         val version: String,

diff --git a/downloader/src/main/kotlin/Downloader.kt b/downloader/src/main/kotlin/Downloader.kt
@@ -69,7 +69,7 @@ class Downloader(private val config: DownloaderConfiguration) {
     fun download(pkg: Package, outputDirectory: File): Provenance {
         verifyOutputDirectory(outputDirectory)
 
-        if (pkg.isMetaDataOnly) return UnknownProvenance
+        if (pkg.isMetadataOnly) return UnknownProvenance
 
         val exception = DownloadException("Download failed for '${pkg.id.toCoordinates()}'.")
 

diff --git a/evaluator/src/main/kotlin/PackageRule.kt b/evaluator/src/main/kotlin/PackageRule.kt
@@ -129,11 +129,11 @@ open class PackageRule(
     /**
      * A [RuleMatcher] that checks whether the [package][pkg] is metadata only.
      */
-    fun isMetaDataOnly() =
+    fun isMetadataOnly() =
         object : RuleMatcher {
-            override val description = "isMetaDataOnly()"
+            override val description = "isMetadataOnly()"
 
-            override fun matches() = pkg.metadata.isMetaDataOnly
+            override fun matches() = pkg.metadata.isMetadataOnly
         }
 
     /**

diff --git a/evaluator/src/test/kotlin/PackageRuleTest.kt b/evaluator/src/test/kotlin/PackageRuleTest.kt
@@ -130,17 +130,17 @@ class PackageRuleTest : WordSpec() {
             }
         }
 
-        "isMetaDataOnly()" should {
+        "isMetadataOnly()" should {
             "return true for a package that has only metadata" {
-                val rule = createPackageRule(packageMetaDataOnly)
-                val matcher = rule.isMetaDataOnly()
+                val rule = createPackageRule(packageMetadataOnly)
+                val matcher = rule.isMetadataOnly()
 
                 matcher.matches() shouldBe true
             }
 
             "return false for a package that has not only metadata" {
                 val rule = createPackageRule(packageWithoutLicense)
-                val matcher = rule.isMetaDataOnly()
+                val matcher = rule.isMetadataOnly()
 
                 matcher.matches() shouldBe false
             }

diff --git a/evaluator/src/test/kotlin/TestData.kt b/evaluator/src/test/kotlin/TestData.kt
@@ -116,9 +116,9 @@ val packageWithVulnerabilities = Package.EMPTY.copy(
     id = Identifier("Maven:org.ossreviewtoolkit:package-with-vulnerabilities:1.0")
 )
 
-val packageMetaDataOnly = Package.EMPTY.copy(
+val packageMetadataOnly = Package.EMPTY.copy(
     id = Identifier("Maven:org.ossreviewtoolkit:package-metadata-only:1.0"),
-    isMetaDataOnly = true
+    isMetadataOnly = true
 )
 
 val packageDependency = Package.EMPTY.copy(
@@ -135,7 +135,7 @@ val allPackages = listOf(
     packageWithOnlyConcludedLicense,
     packageWithOnlyDeclaredLicense,
     packageWithConcludedAndDeclaredLicense,
-    packageMetaDataOnly,
+    packageMetadataOnly,
     packageDependency
 )
 
@@ -165,7 +165,7 @@ val scopeIncluded = Scope(
         packageWithConcludedAndDeclaredLicense.toReference(),
         packageRefDynamicallyLinked,
         packageRefStaticallyLinked,
-        packageMetaDataOnly.toReference()
+        packageMetadataOnly.toReference()
     )
 )
 

diff --git a/model/src/main/kotlin/Package.kt b/model/src/main/kotlin/Package.kt
@@ -19,6 +19,7 @@
 
 package org.ossreviewtoolkit.model
 
+import com.fasterxml.jackson.annotation.JsonAlias
 import com.fasterxml.jackson.annotation.JsonInclude
 
 import java.util.SortedSet
@@ -119,8 +120,9 @@ data class Package(
      * Indicates whether the package is just metadata, like e.g. Maven BOM artifacts which only define constraints
      * for dependency versions.
      */
+    @JsonAlias("is_meta_data_only")
     @JsonInclude(JsonInclude.Include.NON_DEFAULT)
-    val isMetaDataOnly: Boolean = false,
+    val isMetadataOnly: Boolean = false,
 
     /**
      * Indicates whether the source code of the package has been modified compared to the original source code,
@@ -172,7 +174,7 @@ data class Package(
             binaryArtifact = binaryArtifact.takeIf { it != other.binaryArtifact },
             sourceArtifact = sourceArtifact.takeIf { it != other.sourceArtifact },
             vcs = vcsProcessed.takeIf { it != other.vcsProcessed }?.toCuration(),
-            isMetaDataOnly = isMetaDataOnly.takeIf { it != other.isMetaDataOnly },
+            isMetadataOnly = isMetadataOnly.takeIf { it != other.isMetadataOnly },
             isModified = isModified.takeIf { it != other.isModified }
         )
     }

diff --git a/model/src/main/kotlin/PackageCurationData.kt b/model/src/main/kotlin/PackageCurationData.kt
@@ -19,6 +19,7 @@
 
 package org.ossreviewtoolkit.model
 
+import com.fasterxml.jackson.annotation.JsonAlias
 import com.fasterxml.jackson.annotation.JsonInclude
 
 import java.util.SortedSet
@@ -89,7 +90,8 @@ data class PackageCurationData(
     /**
      * Whether the package is metadata only.
      */
-    val isMetaDataOnly: Boolean? = null,
+    @JsonAlias("is_meta_data_only")
+    val isMetadataOnly: Boolean? = null,
 
     /**
      * Whether the package is modified compared to the original source
@@ -140,7 +142,7 @@ data class PackageCurationData(
             sourceArtifact = sourceArtifact ?: original.sourceArtifact,
             vcs = original.vcs,
             vcsProcessed = vcsProcessed,
-            isMetaDataOnly = isMetaDataOnly ?: original.isMetaDataOnly,
+            isMetadataOnly = isMetadataOnly ?: original.isMetadataOnly,
             isModified = isModified ?: original.isModified
         )
 
@@ -176,7 +178,7 @@ data class PackageCurationData(
             binaryArtifact = binaryArtifact ?: other.binaryArtifact,
             sourceArtifact = sourceArtifact ?: other.sourceArtifact,
             vcs = vcs?.merge(other.vcs ?: vcs) ?: other.vcs,
-            isMetaDataOnly = isMetaDataOnly ?: other.isMetaDataOnly,
+            isMetadataOnly = isMetadataOnly ?: other.isMetadataOnly,
             isModified = isModified ?: other.isModified,
             declaredLicenseMapping = declaredLicenseMapping.zip(other.declaredLicenseMapping) { value, otherValue ->
                 (value ?: otherValue)!!

diff --git a/model/src/test/kotlin/PackageCurationDataTest.kt b/model/src/test/kotlin/PackageCurationDataTest.kt
@@ -47,7 +47,7 @@ class PackageCurationDataTest : WordSpec({
             revision = "original",
             path = "original"
         ),
-        isMetaDataOnly = true,
+        isMetadataOnly = true,
         isModified = true,
         declaredLicenseMapping = mapOf("original" to "original".toSpdx())
     )
@@ -74,7 +74,7 @@ class PackageCurationDataTest : WordSpec({
             revision = "other",
             path = "other"
         ),
-        isMetaDataOnly = false,
+        isMetadataOnly = false,
         isModified = false,
         declaredLicenseMapping = mapOf("other" to "other".toSpdx())
     )
@@ -91,7 +91,7 @@ class PackageCurationDataTest : WordSpec({
                 concludedLicense = null,
                 binaryArtifact = null,
                 vcs = null,
-                isMetaDataOnly = null,
+                isMetadataOnly = null,
                 declaredLicenseMapping = emptyMap()
             )
 
@@ -101,7 +101,7 @@ class PackageCurationDataTest : WordSpec({
                 concludedLicense = other.concludedLicense,
                 binaryArtifact = other.binaryArtifact,
                 vcs = other.vcs,
-                isMetaDataOnly = other.isMetaDataOnly,
+                isMetadataOnly = other.isMetadataOnly,
                 declaredLicenseMapping = other.declaredLicenseMapping
             )
         }

diff --git a/model/src/test/kotlin/PackageCurationTest.kt b/model/src/test/kotlin/PackageCurationTest.kt
@@ -46,7 +46,7 @@ class PackageCurationTest : WordSpec({
                 binaryArtifact = RemoteArtifact.EMPTY,
                 sourceArtifact = RemoteArtifact.EMPTY,
                 vcs = VcsInfo.EMPTY,
-                isMetaDataOnly = false,
+                isMetadataOnly = false,
                 isModified = false
             )
 
@@ -74,7 +74,7 @@ class PackageCurationTest : WordSpec({
                         revision = "revision",
                         path = "path"
                     ),
-                    isMetaDataOnly = true,
+                    isMetadataOnly = true,
                     isModified = true
                 )
             )
@@ -96,7 +96,7 @@ class PackageCurationTest : WordSpec({
                 sourceArtifact shouldBe curation.data.sourceArtifact
                 vcs shouldBe pkg.vcs
                 vcsProcessed.toCuration() shouldBe curation.data.vcs
-                isMetaDataOnly shouldBe true
+                isMetadataOnly shouldBe true
                 isModified shouldBe true
             }
 
@@ -126,7 +126,7 @@ class PackageCurationTest : WordSpec({
                     revision = "revision",
                     path = "path"
                 ),
-                isMetaDataOnly = false,
+                isMetadataOnly = false,
                 isModified = false
             )
 
@@ -159,7 +159,7 @@ class PackageCurationTest : WordSpec({
                     revision = pkg.vcs.revision,
                     path = pkg.vcs.path
                 )
-                isMetaDataOnly shouldBe false
+                isMetadataOnly shouldBe false
                 isModified shouldBe false
             }
 
@@ -242,7 +242,7 @@ class PackageCurationTest : WordSpec({
             }
         }
 
-        "be able to clear isMetaDataOnly" {
+        "be able to clear isMetadataOnly" {
             val pkg = Package(
                 id = Identifier(
                     type = "Maven",
@@ -257,19 +257,19 @@ class PackageCurationTest : WordSpec({
                 binaryArtifact = RemoteArtifact.EMPTY,
                 sourceArtifact = RemoteArtifact.EMPTY,
                 vcs = VcsInfo.EMPTY,
-                isMetaDataOnly = true
+                isMetadataOnly = true
             )
 
             val curation = PackageCuration(
                 id = pkg.id,
                 data = PackageCurationData(
-                    isMetaDataOnly = false
+                    isMetadataOnly = false
                 )
             )
 
             val curatedPkg = curation.apply(pkg.toCuratedPackage())
 
-            curatedPkg.metadata.isMetaDataOnly shouldBe false
+            curatedPkg.metadata.isMetadataOnly shouldBe false
         }
 
         "be able to clear isModified" {