Skip to content

Commit

Permalink
add more tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@seakayone
seakayone committed Nov 21, 2024
1 parent 1e824e3 commit 2eb997e
Show file tree
Hide file tree
Showing 2 changed files with 79 additions and 28 deletions.
95 changes: 71 additions & 24 deletions integration/src/test/scala/org/knora/webapi/it/v2/CopyrightAndLicensesSpec.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,50 +38,67 @@ import org.knora.webapi.slice.resourceinfo.domain.IriConverter

object CopyrightAndLicensesSpec extends E2EZSpec {

private val copyrightAttribution = CopyrightAttribution.unsafeFrom("2020, Example")
private val license = License.unsafeFrom("CC BY-SA 4.0")
private val aCopyrightAttribution = CopyrightAttribution.unsafeFrom("2020, On FileValue")
private val aLicense = License.unsafeFrom("CC BY-SA 4.0")

private val projectCopyrightAttribution = CopyrightAttribution.unsafeFrom("2024, On Project")
private val projectLicense = License.unsafeFrom("Apache-2.0")

val e2eSpec: Spec[Scope & env, Any] = suite("Copyright Attribution and Licenses")(
test(
"given the project does neither have a default license nor a default copyright attribution " +
"when creating a resource without copyright attribution and license " +
"the creation response should not contain the license and copyright attribution",
) {
for {
createResourceResponseModel <- createStillImageResource()
actualCreatedCopyright <- copyrightValueOption(createResourceResponseModel)
actualCreatedLicense <- licenseValueOption(createResourceResponseModel)
} yield assertTrue(
actualCreatedCopyright.isEmpty,
actualCreatedLicense.isEmpty,
)
},
test(
"when creating a resource with copyright attribution and license " +
"the creation response should contain the license and copyright attribution",
) {
for {
createResourceResponseModel <- createStillImageResource(Some(copyrightAttribution), Some(license))
createResourceResponseModel <- createStillImageResource(Some(aCopyrightAttribution), Some(aLicense))
actualCreatedCopyright <- copyrightValue(createResourceResponseModel)
actualCreatedLicense <- licenseValue(createResourceResponseModel)
} yield assertTrue(
actualCreatedCopyright == copyrightAttribution.value,
actualCreatedLicense == license.value,
actualCreatedCopyright == aCopyrightAttribution.value,
actualCreatedLicense == aLicense.value,
)
},
test(
"when creating a resource with copyright attribution and license " +
"the response when getting the created resource should contain the license and copyright attribution",
) {
for {
createResourceResponseModel <- createStillImageResource(Some(copyrightAttribution), Some(license))
createResourceResponseModel <- createStillImageResource(Some(aCopyrightAttribution), Some(aLicense))
resourceId <- resourceId(createResourceResponseModel)
getResponseModel <- getResourceFromApi(resourceId)
actualCopyright <- copyrightValue(getResponseModel)
actualLicense <- licenseValue(getResponseModel)
} yield assertTrue(
actualCopyright == copyrightAttribution.value,
actualLicense == license.value,
actualCopyright == aCopyrightAttribution.value,
actualLicense == aLicense.value,
)
},
test(
"when creating a resource with copyright attribution and license " +
"the response when getting the created value should contain the license and copyright attribution",
) {
for {
createResourceResponseModel <- createStillImageResource(Some(copyrightAttribution), Some(license))
createResourceResponseModel <- createStillImageResource(Some(aCopyrightAttribution), Some(aLicense))
valueResponseModel <- getValueFromApi(createResourceResponseModel)
actualCopyright <- copyrightValue(valueResponseModel)
actualLicense <- licenseValue(valueResponseModel)
} yield assertTrue(
actualCopyright == copyrightAttribution.value,
actualLicense == license.value,
actualCopyright == aCopyrightAttribution.value,
actualLicense == aLicense.value,
)
},
test(
Expand All @@ -90,24 +107,42 @@ object CopyrightAndLicensesSpec extends E2EZSpec {
"then the response when getting the created value should contain the default license and default copyright attribution",
) {
for {
projectService <- ZIO.service[KnoraProjectService]
prj <-
projectService.findByShortcode(Shortcode.unsafeFrom("0001")).someOrFail(new Exception("Project not found"))
_ <- projectService.updateProject(
prj,
ProjectUpdateRequest(copyrightAttribution = Some(copyrightAttribution), license = Some(license)),
)
_ <- addCopyrightAttributionAndLicenseToProject(projectCopyrightAttribution, projectLicense)
createResourceResponseModel <- createStillImageResource()
valueResponseModel <- getValueFromApi(createResourceResponseModel)
actualCopyright <- copyrightValue(valueResponseModel)
actualLicense <- licenseValue(valueResponseModel)
} yield assertTrue(
actualCopyright == copyrightAttribution.value,
actualLicense == license.value,
actualCopyright == projectCopyrightAttribution.value,
actualLicense == projectLicense.value,
)
},
test(
"when creating a resource with copyright attribution and without license " +
"given the project has a default license and default copyright attribution " +
"then the response when getting the created value should contain the license and copyright attribution from resource",
) {
for {
_ <- addCopyrightAttributionAndLicenseToProject(projectCopyrightAttribution, projectLicense)
createResourceResponseModel <- createStillImageResource(Some(aCopyrightAttribution), Some(aLicense))
valueResponseModel <- getValueFromApi(createResourceResponseModel)
actualCopyright <- copyrightValue(valueResponseModel)
actualLicense <- licenseValue(valueResponseModel)
} yield assertTrue(
actualCopyright == aCopyrightAttribution.value,
actualLicense == aLicense.value,
)
},
)

private def addCopyrightAttributionAndLicenseToProject(copyrightAttribution: CopyrightAttribution, license: License) =
for {
projectService <- ZIO.service[KnoraProjectService]
prj <- projectService.findByShortcode(Shortcode.unsafeFrom("0001")).someOrFail(new Exception("Project not found"))
change = ProjectUpdateRequest(copyrightAttribution = Some(copyrightAttribution), license = Some(license))
updated <- projectService.updateProject(prj, change)
} yield updated

private def createStillImageResource(
copyrightAttribution: Option[CopyrightAttribution] = None,
license: Option[License] = None,
Expand Down Expand Up @@ -176,8 +211,20 @@ object CopyrightAndLicensesSpec extends E2EZSpec {
case _ => ZIO.fail(Exception("Multiple values found"))
}

private def copyrightValue(model: Model) = singleStringValue(model, HasCopyrightAttribution)
private def licenseValue(model: Model) = singleStringValue(model, HasLicense)
private def singleStringValue(model: Model, property: Property) =
ZIO.fromEither(model.singleSubjectWithProperty(property).flatMap(_.objectString(property))).mapError(Exception(_))
private def copyrightValue(model: Model) =
singleStringValueOption(model, HasCopyrightAttribution).someOrFail(new Exception("No copyright found"))
private def copyrightValueOption(model: Model) =
singleStringValueOption(model, HasCopyrightAttribution)
private def licenseValue(model: Model) =
singleStringValueOption(model, HasLicense).someOrFail(new Exception("No license found"))
private def licenseValueOption(model: Model) =
singleStringValueOption(model, HasLicense)
private def singleStringValueOption(model: Model, property: Property): Task[Option[String]] =
ZIO
.fromEither(
model
.singleSubjectWithPropertyOption(property)
.flatMap(_.map(_.objectStringOption(property)).fold(Right(None))(identity)),
)
.mapError(Exception(_))
}
12 changes: 8 additions & 4 deletions webapi/src/main/scala/org/knora/webapi/slice/common/jena/ModelOps.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,18 @@ object ModelOps { self =>
case iris => Left(s"Multiple root resources found in model: ${iris.mkString(", ")}")
}

def singleSubjectWithProperty(property: Property): Either[String, Resource] =
def singleSubjectWithPropertyOption(property: Property): Either[String, Option[Resource]] =
val subjects = model.listSubjectsWithProperty(property).asScala.toList
subjects match {
case s :: Nil => Right(s)
case Nil => Left(s"No resource found with property ${property.getURI}")
case _ => Left(s"Multiple resources found with property ${property.getURI}")
case s :: Nil => Right(Some(s))
case Nil => Right(None)
case _ => Left(s"Multiple subjects found with property ${property.getURI}")
}

def singleSubjectWithProperty(property: Property): Either[String, Resource] =
singleSubjectWithPropertyOption(property).flatMap(
_.toRight(s"No resource found with property ${property.getURI}"),
)
}

def fromJsonLd(str: String): ZIO[Scope, String, Model] = from(str, Lang.JSONLD)
Expand Down

0 comments on commit 2eb997e

Please sign in to comment.