Skip to content

Commit

Permalink
Consistently use ScanSummary.EMPTY.copy() in test code
Browse files Browse the repository at this point in the history 
Eliminate repeating default values by removing constructor calls in
favor of using `ScanSummary.EMPTY.copy()`.

Signed-off-by: Frank Viernau <frank_viernau@epam.com>
  • Loading branch information
@fviernau
fviernau committed Oct 12, 2022
1 parent 800483c commit 9b63690
Show file tree
Hide file tree
Showing 15 changed files with 40 additions and 129 deletions.
6 changes: 1 addition & 5 deletions evaluator/src/test/kotlin/ProjectSourceRuleTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import io.kotest.core.spec.style.WordSpec
import io.kotest.matchers.shouldBe

import java.io.File
import java.time.Instant

import org.ossreviewtoolkit.model.AccessStatistics
import org.ossreviewtoolkit.model.AnalyzerResult
Expand Down Expand Up @@ -227,11 +226,8 @@ private fun createOrtResult(
ScanResult(
provenance = RepositoryProvenance(vcsInfo, vcsInfo.revision),
scanner = ScannerDetails.EMPTY,
summary = ScanSummary(
summary = ScanSummary.EMPTY.copy(
licenseFindings = licenseFindings,
copyrightFindings = sortedSetOf(),
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
packageVerificationCode = "0000000000000000000000000000000000000000"
)
)
Expand Down
8 changes: 2 additions & 6 deletions evaluator/src/test/kotlin/TestData.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -265,15 +265,11 @@ val ortResult = OrtResult(
ScanResult(
provenance = UnknownProvenance,
scanner = ScannerDetails.EMPTY,
summary = ScanSummary(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
packageVerificationCode = "",
summary = ScanSummary.EMPTY.copy(
licenseFindings = sortedSetOf(
LicenseFinding("LicenseRef-a", TextLocation("LICENSE", 1)),
LicenseFinding("LicenseRef-b", TextLocation("LICENSE", 2))
),
copyrightFindings = sortedSetOf()
)
)
)
)
Expand Down
8 changes: 1 addition & 7 deletions model/src/test/kotlin/licenses/TestData.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@

package org.ossreviewtoolkit.model.licenses

import java.time.Instant

import org.ossreviewtoolkit.model.AccessStatistics
import org.ossreviewtoolkit.model.AnalyzerResult
import org.ossreviewtoolkit.model.AnalyzerRun
Expand Down Expand Up @@ -149,12 +147,8 @@ val scanResults = listOf(
ScanResult(
provenance = provenance,
scanner = ScannerDetails.EMPTY,
summary = ScanSummary(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
packageVerificationCode = "",
summary = ScanSummary.EMPTY.copy(
licenseFindings = licenseFindings,
copyrightFindings = sortedSetOf()
)
)
)
Expand Down
38 changes: 7 additions & 31 deletions reporter/src/funTest/kotlin/TestData.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -240,10 +240,7 @@ val ORT_RESULT = OrtResult(
ScanResult(
provenance = UnknownProvenance,
scanner = ScannerDetails(name = "scanner", version = "1.0", configuration = ""),
summary = ScanSummary(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
packageVerificationCode = "",
summary = ScanSummary.EMPTY.copy(
licenseFindings = sortedSetOf(
LicenseFinding(
license = "MIT",
Expand All @@ -263,23 +260,14 @@ val ORT_RESULT = OrtResult(
ScanResult(
provenance = UnknownProvenance,
scanner = ScannerDetails(name = "scanner", version = "1.0", configuration = ""),
summary = ScanSummary(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
packageVerificationCode = "",
licenseFindings = sortedSetOf(),
copyrightFindings = sortedSetOf()
)
summary = ScanSummary.EMPTY
)
),
Identifier("NPM:@ort:no-license-file:1.0") to listOf(
ScanResult(
provenance = UnknownProvenance,
scanner = ScannerDetails(name = "scanner", version = "1.0", configuration = ""),
summary = ScanSummary(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
packageVerificationCode = "",
summary = ScanSummary.EMPTY.copy(
licenseFindings = sortedSetOf(
LicenseFinding(
license = "MIT",
Expand All @@ -304,10 +292,7 @@ val ORT_RESULT = OrtResult(
)
),
scanner = ScannerDetails(name = "scanner", version = "1.0", configuration = ""),
summary = ScanSummary(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
packageVerificationCode = "",
summary = ScanSummary.EMPTY.copy(
licenseFindings = sortedSetOf(
LicenseFinding(
license = "MIT",
Expand Down Expand Up @@ -340,10 +325,7 @@ val ORT_RESULT = OrtResult(
)
),
scanner = ScannerDetails(name = "scanner", version = "1.0", configuration = ""),
summary = ScanSummary(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
packageVerificationCode = "",
summary = ScanSummary.EMPTY.copy(
licenseFindings = sortedSetOf(
LicenseFinding(
license = "MIT",
Expand Down Expand Up @@ -384,10 +366,7 @@ val ORT_RESULT = OrtResult(
)
),
scanner = ScannerDetails(name = "scanner", version = "1.0", configuration = ""),
summary = ScanSummary(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
packageVerificationCode = "",
summary = ScanSummary.EMPTY.copy(
licenseFindings = sortedSetOf(
LicenseFinding(
license = "MIT",
Expand Down Expand Up @@ -420,10 +399,7 @@ val ORT_RESULT = OrtResult(
)
),
scanner = ScannerDetails(name = "scanner", version = "1.0", configuration = ""),
summary = ScanSummary(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
packageVerificationCode = "",
summary = ScanSummary.EMPTY.copy(
licenseFindings = sortedSetOf(
LicenseFinding(
license = "BSD-3-Clause",
Expand Down
9 changes: 2 additions & 7 deletions reporter/src/funTest/kotlin/reporters/spdx/SpdxDocumentReporterFunTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ import io.kotest.matchers.should
import io.kotest.matchers.shouldBe

import java.io.File
import java.time.Instant

import org.ossreviewtoolkit.model.AccessStatistics
import org.ossreviewtoolkit.model.AnalyzerResult
Expand Down Expand Up @@ -298,9 +297,7 @@ private val ortResult = OrtResult(
)
),
scanner = ScannerDetails.EMPTY,
summary = ScanSummary(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
summary = ScanSummary.EMPTY.copy(
packageVerificationCode = "0000000000000000000000000000000000000000",
licenseFindings = sortedSetOf(
LicenseFinding(
Expand Down Expand Up @@ -331,9 +328,7 @@ private val ortResult = OrtResult(
resolvedRevision = "deadbeef"
),
scanner = ScannerDetails.EMPTY,
summary = ScanSummary(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
summary = ScanSummary.EMPTY.copy(
packageVerificationCode = "0000000000000000000000000000000000000000",
licenseFindings = sortedSetOf(
LicenseFinding(
Expand Down
6 changes: 2 additions & 4 deletions reporter/src/test/kotlin/reporters/OpossumReporterTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -482,9 +482,7 @@ private fun createOrtResult(): OrtResult {
version = "1.2.3",
configuration = "configuration"
),
summary = ScanSummary(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
summary = ScanSummary.EMPTY.copy(
packageVerificationCode = "0000000000000000000000000000000000000000",
licenseFindings = sortedSetOf(
LicenseFinding(
Expand Down Expand Up @@ -519,7 +517,7 @@ private fun createOrtResult(): OrtResult {
version = "1.2.3",
configuration = "otherConfiguration"
),
summary = ScanSummary(
summary = ScanSummary.EMPTY.copy(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
packageVerificationCode = "0000000000000000000000000000000000000000",
Expand Down
5 changes: 1 addition & 4 deletions reporter/src/test/kotlin/reporters/fossid/FossIdReporterTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ import io.mockk.mockkStatic
import io.mockk.spyk

import java.io.File
import java.time.Instant

import org.ossreviewtoolkit.clients.fossid.FossIdRestService
import org.ossreviewtoolkit.clients.fossid.FossIdServiceWithVersion
Expand Down Expand Up @@ -290,8 +289,6 @@ private fun createScanResult(scanCode: String): ScanResult =
ScanResult(
provenance = UnknownProvenance,
scanner = ScannerDetails.EMPTY,
summary = ScanSummary(
Instant.now(), Instant.now(), "", sortedSetOf(), sortedSetOf()
),
summary = ScanSummary.EMPTY,
additionalData = mapOf(FossIdReporter.SCAN_CODE_KEY to scanCode)
)
5 changes: 1 addition & 4 deletions reporter/src/test/kotlin/reporters/freemarker/FreeMarkerTemplateProcessorTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,7 @@ private fun scanResults(
ScanResult(
provenance = RepositoryProvenance(vcsInfo = vcsInfo, resolvedRevision = vcsInfo.revision),
scanner = ScannerDetails(name = "scanner", version = "1.0", configuration = ""),
summary = ScanSummary(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
packageVerificationCode = "",
summary = ScanSummary.EMPTY.copy(
licenseFindings = licenseFindings,
copyrightFindings = copyrightFindings,
)
Expand Down
10 changes: 2 additions & 8 deletions scanner/src/funTest/kotlin/scanners/ScannerIntegrationFunTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ import io.kotest.core.spec.style.StringSpec
import io.kotest.matchers.shouldBe

import java.io.File
import java.time.Instant

import org.ossreviewtoolkit.model.LicenseFinding
import org.ossreviewtoolkit.model.PackageType
Expand Down Expand Up @@ -104,13 +103,8 @@ class ScannerIntegrationFunTest : StringSpec() {
)
}

return ScanSummary(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
packageVerificationCode = "",
licenseFindings = licenseFindings,
copyrightFindings = sortedSetOf(),
issues = mutableListOf()
return ScanSummary.EMPTY.copy(
licenseFindings = licenseFindings
)
}
}
Expand Down
10 changes: 2 additions & 8 deletions scanner/src/funTest/kotlin/storages/AbstractProvenanceBasedStorageFunTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,6 @@ import io.kotest.matchers.collections.containExactly
import io.kotest.matchers.collections.containExactlyInAnyOrder
import io.kotest.matchers.should

import java.time.Instant

import org.ossreviewtoolkit.model.ArtifactProvenance
import org.ossreviewtoolkit.model.Hash
import org.ossreviewtoolkit.model.HashAlgorithm
Expand Down Expand Up @@ -226,13 +224,9 @@ private fun createScanResult(
ScanResult(
provenance,
scannerDetails,
ScanSummary(
startTime = Instant.EPOCH,
endTime = Instant.EPOCH,
packageVerificationCode = "",
ScanSummary.EMPTY.copy(
licenseFindings = sortedSetOf(
LicenseFinding(license, TextLocation("file.txt", 1, 2))
),
copyrightFindings = sortedSetOf()
)
)
)
3 changes: 1 addition & 2 deletions scanner/src/funTest/kotlin/storages/AbstractStorageFunTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,15 +99,14 @@ abstract class AbstractStorageFunTest(vararg listeners: TestListener) : WordSpec

private val scannerCriteriaForDetails1 = ScannerCriteria.forDetails(scannerDetails1, Semver.VersionDiff.PATCH)

private val scanSummaryWithFiles = ScanSummary(
private val scanSummaryWithFiles = ScanSummary.EMPTY.copy(
startTime = Instant.EPOCH + Duration.ofMinutes(1),
endTime = Instant.EPOCH + Duration.ofMinutes(2),
packageVerificationCode = "packageVerificationCode",
licenseFindings = sortedSetOf(
LicenseFinding("license-1.1", DUMMY_TEXT_LOCATION),
LicenseFinding("license-1.2", DUMMY_TEXT_LOCATION)
),
copyrightFindings = sortedSetOf(),
issues = mutableListOf(
OrtIssue(source = "source-1", message = "error-1"),
OrtIssue(source = "source-2", message = "error-2")
Expand Down
13 changes: 4 additions & 9 deletions scanner/src/funTest/kotlin/storages/ClearlyDefinedStorageFunTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ class ClearlyDefinedStorageFunTest : StringSpec({
"--package true --processes 2 --strip-root true --summary true --summary-key-files true " +
"--timeout 1000.0 --url true"
),
summary = ScanSummary(
summary = ScanSummary.EMPTY.copy(
startTime = Instant.parse("2020-02-14T00:36:14.000335513Z"),
endTime = Instant.parse("2020-02-14T00:36:37.000492119Z"),
packageVerificationCode = SpdxConstants.NONE,
Expand All @@ -84,9 +84,7 @@ class ClearlyDefinedStorageFunTest : StringSpec({
),
score = 60.87f
)
),
copyrightFindings = sortedSetOf(),
issues = emptyList()
)
)
)
}
Expand Down Expand Up @@ -115,13 +113,10 @@ class ClearlyDefinedStorageFunTest : StringSpec({
"--license-text-diagnostics true --package true --processes 2 --strip-root true " +
"--summary true --summary-key-files true --timeout 1000.0 --url true"
),
summary = ScanSummary(
summary = ScanSummary.EMPTY.copy(
startTime = Instant.parse("2022-05-02T07:34:28.000784295Z"),
endTime = Instant.parse("2022-05-02T07:34:59.000958218Z"),
packageVerificationCode = SpdxConstants.NONE,
licenseFindings = sortedSetOf(),
copyrightFindings = sortedSetOf(),
issues = emptyList()
packageVerificationCode = SpdxConstants.NONE
)
)
}
Expand Down
10 changes: 3 additions & 7 deletions scanner/src/test/kotlin/ScannerTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ import io.mockk.verify

import java.io.File
import java.io.IOException
import java.time.Instant
import java.util.SortedSet

import org.ossreviewtoolkit.model.ArtifactProvenance
Expand Down Expand Up @@ -824,7 +823,7 @@ private class FakePathScannerWrapper : PathScannerWrapper {
LicenseFinding("Apache-2.0", TextLocation(file.relativeTo(path).path, 1, 2))
}.toSortedSet()

return createScanSummary(licenseFindings = licenseFindings)
return ScanSummary.EMPTY.copy(licenseFindings = licenseFindings)
}
}

Expand Down Expand Up @@ -963,9 +962,6 @@ private fun VcsInfo.Companion.valid() =
revision = "f42e41a8fedc1e0acd78fab147e91fa047cb2853"
)

private fun createScanSummary(licenseFindings: Set<LicenseFinding> = emptySet()) =
ScanSummary(Instant.EPOCH, Instant.EPOCH, "", licenseFindings.toSortedSet(), sortedSetOf())

private fun createScanResult(
provenance: Provenance,
scannerDetails: ScannerDetails,
Expand All @@ -976,7 +972,7 @@ private fun createScanResult(
ScanResult(
provenance,
scannerDetails,
createScanSummary(licenseFindings)
ScanSummary.EMPTY.copy(licenseFindings = licenseFindings)
)

private fun createNestedScanResult(
Expand All @@ -995,7 +991,7 @@ private fun createStoredScanResult(provenance: Provenance, scannerDetails: Scann
ScanResult(
provenance,
scannerDetails,
createScanSummary(
ScanSummary.EMPTY.copy(
licenseFindings = sortedSetOf(
LicenseFinding("Apache-2.0", TextLocation("storage.txt", 1, 2))
)
Expand Down
Loading

0 comments on commit 9b63690

Please sign in to comment.