inst/unitTests/test_createS4ObjectFromList.R

In Sage-Bionetworks/rSynapseClient: Synapse R Client from Sage Bionetworks

# 
# Author: brucehoff
###############################################################################


unitTestCreateS4ObjectFromList<-function() {
  # simple case: list argument has just primitives
  listRep<-list(name="name", description="description")
  e<-synapseClient:::createS4ObjectFromList(listRep, "Evaluation")
  checkEquals("name", e@name)
  checkEquals("description", e@description)
  
  up<-synapseClient:::createS4ObjectFromList( 
    list(ownerId="101", 
      emails=c("foo@bar.com", "bar@bas.com")
    ), "UserProfile")
  checkEquals("101", up@ownerId)
  checkEquals(c("foo@bar.com", "bar@bas.com"), up@emails)
  
  # list argument has content of embedded S4 object
  up<-synapseClient:::createS4ObjectFromList( 
    list(ownerId="101", 
      emails=c("foo@bar.com", "bar@bas.com"),
      notificationSettings=list(sendEmailNotifications=T, markEmailedMessagesAsRead=F)
    ), "UserProfile")
  checkEquals("101", up@ownerId)
  checkEquals(c("foo@bar.com", "bar@bas.com"), up@emails)
  checkEquals(synapseClient:::Settings(sendEmailNotifications=T, markEmailedMessagesAsRead=F), up@notificationSettings)
  
  # list has array of embedded S4 objects
  
  up<-synapseClient:::createS4ObjectFromList( 
    list(ownerId="101", 
      emails=c("foo@bar.com", "bar@bas.com"),
      notificationSettings=list(sendEmailNotifications=T, markEmailedMessagesAsRead=F),
      preferences=list(
        list(concreteType="org.sagebionetworks.repo.model.UserPreferenceBoolean", name="foo", value=T),
        list(concreteType="org.sagebionetworks.repo.model.UserPreferenceBoolean", name="bar", value=F)
      )
    ), "UserProfile")
  checkEquals("101", up@ownerId)
  checkEquals(c("foo@bar.com", "bar@bas.com"), up@emails)
  checkEquals(synapseClient:::Settings(sendEmailNotifications=T, markEmailedMessagesAsRead=F), up@notificationSettings)
  prefs<-up@preferences
  checkTrue(!is.null(prefs))
  checkEquals(2, length(prefs))
  checkEquals(synapseClient:::UserPreferenceBoolean(name="foo", value=T, concreteType="org.sagebionetworks.repo.model.UserPreferenceBoolean"), prefs[[1]])
  checkEquals(synapseClient:::UserPreferenceBoolean(name="bar", value=F, concreteType="org.sagebionetworks.repo.model.UserPreferenceBoolean"), prefs[[2]])
}


unitTestS4RoundTrip<-function() {
  e<-Evaluation(name="name", description="description")
  listRep<-synapseClient:::createListFromS4Object(e)
  checkEquals(e, synapseClient:::createS4ObjectFromList(listRep, "Evaluation"))
  emails<-c("foo@bar.com", "bar@bas.com")
  preferences<-new("UserPreferenceList")
  preferences@content<-list(
    synapseClient:::UserPreferenceBoolean(name="foo", value=T, concreteType="org.sagebionetworks.repo.model.UserPreferenceBoolean"),
    synapseClient:::UserPreferenceBoolean(name="bar", value=F, concreteType="org.sagebionetworks.repo.model.UserPreferenceBoolean")
  )
  notificationSettings<-synapseClient:::Settings(sendEmailNotifications=T, markEmailedMessagesAsRead=F)
  up<-synapseClient:::UserProfile(
    ownerId="101", 
    emails=emails,
    preferences=preferences,
    notificationSettings=notificationSettings
  )
  
  listRep<-synapseClient:::createListFromS4Object(up)
  checkEquals(up, synapseClient:::createS4ObjectFromList(listRep, "UserProfile"))
  
}

unitTestMissingS4Field<-function() {
  # note:  there's no 'notificationSettings' field
  emails<-c("foo@bar.com", "bar@bas.com")
  preferences<-new("UserPreferenceList")
  preferences@content<-list(
    synapseClient:::UserPreferenceBoolean(name="foo", value=T, concreteType="org.sagebionetworks.repo.model.UserPreferenceBoolean"),
    synapseClient:::UserPreferenceBoolean(name="bar", value=F, concreteType="org.sagebionetworks.repo.model.UserPreferenceBoolean")
  )
  up<-synapseClient:::UserProfile(
    ownerId="101", 
    emails=emails,
    preferences=preferences
  )
  
  listRep<-synapseClient:::createListFromS4Object(up)
  
  # There should not be a list entry for 'notificationSettings'
  checkTrue(is.null(listRep$notificationSettings))
  
  # Also double check that it generates the original UserProfile
  checkEquals(up, synapseClient:::createS4ObjectFromList(listRep, "UserProfile"))
}

unitTestRoundTripWithEnumField<-function() {
  # Note:  'status' is defined as an enum field
  s<-synapseClient:::SubmissionStatus(id="12345", status="SCORED", entityId="syn101")
  li<-synapseClient:::createListFromS4Object(s)
  s2<-synapseClient:::createS4ObjectFromList(li, "SubmissionStatus")
  checkEquals(s,s2)
}

unitTestVector<-function() {
  x<-c(concreteType="org.sagebionetworks.repo.model.table.UploadToTableRequest", tableId="syn12345", uploadFileHandleId="1111")
  obj<-synapseClient:::createS4ObjectFromList(x, "AsynchronousRequestBody")
  checkEquals("UploadToTableRequest", as.character(class(obj)))
}

unitTestIntegerAssignment<-function() {
  # constructor converts numeric to integer
  TableColumn(maximumSize=10)
  # an edge case...
  TableColumn(maximumSize=numeric(0))
}

unitTestFileHandle<-function() {
  fileHandle<-synapseClient:::S3FileHandle(id="999", fileName="foo.txt")
  fileHandleAsList<-synapseClient:::createListFromS4Object(fileHandle)
}

unitTestExtraField<-function() {
  listRep<-list(name="name", description="description", foo="bar")
  # should hang on to the unexpected field "foo"
  e<-synapseClient:::createS4ObjectFromList(listRep, "Evaluation")
  checkEquals("name", e@name)
  checkEquals("description", e@description)
  checkEquals(e@autoGeneratedExtra$foo, "bar")
  checkEquals(synapseClient:::createListFromS4Object(e), listRep)
}

unitTestEmptyExceptConcreteType<-function() {
  fileHandle<-c(concreteType="org.sagebionetworks.repo.model.file.S3FileHandle")
  s4FileHandle<-synapseClient:::createS4ObjectFromList(fileHandle, "FileHandle")
  checkEquals(s4FileHandle, synapseClient:::S3FileHandle())
}