// IntellectualObjectSave saves the intellectual object to Pharos. If the
// object has an ID of zero, this performs a POST to create a new
// Intellectual Object. If the ID is non-zero, this updates the existing
// object with a PUT. The response object will contain a new copy of the
// IntellectualObject if it was successfully saved.
func (client *PharosClient) IntellectualObjectSave(obj *models.IntellectualObject) *PharosResponse {
// Set up the response object
resp := NewPharosResponse(PharosIntellectualObject)
resp.objects = make([]*models.IntellectualObject, 1)
// URL and method
// Note that POST URL takes an institution identifier, while
// the PUT URL takes an object identifier.
relativeUrl := fmt.Sprintf("/api/%s/objects/%s", client.apiVersion, obj.Institution)
httpMethod := "POST"
if obj.Id > 0 {
// PUT URL looks like /api/v2/objects/college.edu%2Fobject_name
relativeUrl = fmt.Sprintf("/api/%s/objects/%s", client.apiVersion, escapeSlashes(obj.Identifier))
httpMethod = "PUT"
}
absoluteUrl := client.BuildUrl(relativeUrl)
// Prepare the JSON data
postData, err := obj.SerializeForPharos()
if err != nil {
resp.Error = err
}
// Run the request
client.DoRequest(resp, httpMethod, absoluteUrl, bytes.NewBuffer(postData))
if resp.Error != nil {
return resp
}
// Parse the JSON from the response body
intelObj := &models.IntellectualObject{}
resp.Error = json.Unmarshal(resp.data, intelObj)
if resp.Error == nil {
resp.objects[0] = intelObj
}
return resp
}
func runAssertions(t *testing.T, obj *models.IntellectualObject, summary *models.WorkSummary, caller string) {
// WorkSummary
assert.False(t, summary.StartedAt.IsZero(), caller)
assert.False(t, summary.FinishedAt.IsZero(), caller)
assert.Empty(t, summary.Errors, caller)
// IntelObj properties
assert.Equal(t, 0, obj.Id, caller)
assert.Equal(t, "example.edu.tagsample_good", obj.Identifier, caller)
// TODO: Is BagName necessary? It should be the same as obj.Identifier
assert.Equal(t, "", obj.BagName, caller)
assert.Equal(t, "virginia.edu", obj.Institution, caller)
assert.Equal(t, 0, obj.InstitutionId, caller)
assert.Equal(t, "Thirteen Ways of Looking at a Blackbird", obj.Title, caller)
assert.Equal(t, "so much depends upon a red wheel barrow glazed with rain water beside the white chickens", obj.Description, caller)
assert.Equal(t, "Institution", obj.Access, caller)
assert.Equal(t, "uva-internal-id-0001", obj.AltIdentifier, caller)
assert.Empty(t, obj.IngestErrorMessage, caller)
if caller == "TestVirtualBagRead_FromTarFile" {
assert.NotEmpty(t, obj.IngestTarFilePath, caller)
} else if caller == "TestVirtualBagRead_FromDirectory" {
assert.NotEmpty(t, obj.IngestUntarredPath, caller)
}
assert.Equal(t, 2, len(obj.IngestManifests), caller)
assert.True(t, util.StringListContains(obj.IngestManifests, "manifest-md5.txt"), caller)
assert.True(t, util.StringListContains(obj.IngestManifests, "manifest-sha256.txt"), caller)
assert.Equal(t, 2, len(obj.IngestTagManifests), caller)
assert.True(t, util.StringListContains(obj.IngestTagManifests, "tagmanifest-md5.txt"), caller)
assert.True(t, util.StringListContains(obj.IngestTagManifests, "tagmanifest-sha256.txt"), caller)
assert.Empty(t, obj.IngestFilesIgnored, caller)
assert.NotNil(t, obj.IngestTopLevelDirNames, caller)
if obj.IngestTopLevelDirNames != nil {
assert.Equal(t, 1, len(obj.IngestTopLevelDirNames), caller)
assert.NotEmpty(t, obj.IngestTopLevelDirNames[0], caller)
}
// Tags
assert.Equal(t, 10, len(obj.IngestTags))
for _, tag := range obj.IngestTags {
assert.NotEmpty(t, tag.SourceFile, caller)
assert.NotEmpty(t, tag.Label, caller)
assert.NotEmpty(t, tag.Value, caller)
}
// Spot check one tag
tag := obj.IngestTags[4]
assert.Equal(t, "bag-info.txt", tag.SourceFile, caller)
assert.Equal(t, "Bag-Count", tag.Label, caller)
assert.Equal(t, "1 of 1", tag.Value, caller)
// Generic Files
tagFileCount := 0
payloadFileCount := 0
manifestCount := 0
tagManifestCount := 0
assert.Equal(t, 16, len(obj.GenericFiles), caller)
for _, gf := range obj.GenericFiles {
assert.NotEmpty(t, gf.Identifier, caller)
assert.NotEmpty(t, gf.IntellectualObjectIdentifier, caller)
assert.NotEmpty(t, gf.FileFormat, caller, gf.Identifier)
assert.NotEmpty(t, gf.IngestFileType, caller)
assert.NotEmpty(t, gf.IngestMd5, caller)
assert.NotEmpty(t, gf.IngestSha256, caller)
if caller == "TestVirtualBagRead_FromTarFile" {
assert.Empty(t, gf.IngestLocalPath, caller)
} else if caller == "TestVirtualBagRead_FromDirectory" {
assert.NotEmpty(t, gf.IngestLocalPath, caller)
}
assert.Empty(t, gf.IngestStorageURL, caller)
assert.Empty(t, gf.IngestReplicationURL, caller)
assert.True(t, gf.Size > 0, caller)
switch gf.IngestFileType {
case constants.PAYLOAD_FILE:
payloadFileCount++
case constants.PAYLOAD_MANIFEST:
manifestCount++
case constants.TAG_MANIFEST:
tagManifestCount++
case constants.TAG_FILE:
tagFileCount++
}
}
// Make sure file types were all tagged correctly
assert.Equal(t, 4, payloadFileCount, caller)
assert.Equal(t, 2, manifestCount, caller)
assert.Equal(t, 2, tagManifestCount, caller)
assert.Equal(t, 8, tagFileCount, caller)
// Spot check generic file aptrust-info.txt
gf := obj.FindGenericFile("aptrust-info.txt")
if gf == nil {
assert.Fail(t, "Could not find aptrust-info.txt", caller)
}
assert.Equal(t, "example.edu.tagsample_good/aptrust-info.txt", gf.Identifier, caller)
assert.Equal(t, 0, gf.IntellectualObjectId, caller)
assert.Equal(t, "example.edu.tagsample_good", gf.IntellectualObjectIdentifier, caller)
assert.Equal(t, "text/plain", gf.FileFormat, caller)
assert.Empty(t, gf.URI, caller)
assert.EqualValues(t, 67, gf.Size, caller)
assert.False(t, gf.FileModified.IsZero(), caller)
assert.Equal(t, constants.TAG_FILE, gf.IngestFileType, caller)
assert.Equal(t, "300e936e622605f9f7a846d261d53093", gf.IngestManifestMd5, caller)
assert.Equal(t, "300e936e622605f9f7a846d261d53093", gf.IngestMd5, caller)
assert.False(t, gf.IngestMd5GeneratedAt.IsZero(), caller)
assert.True(t, gf.IngestMd5VerifiedAt.IsZero(), caller)
assert.Equal(t, "a2b6c5a713af771c5e4edde8d5be25fbcad86e45ea338f43a5bb769347e7c8bb", gf.IngestManifestSha256, caller)
assert.Equal(t, "a2b6c5a713af771c5e4edde8d5be25fbcad86e45ea338f43a5bb769347e7c8bb", gf.IngestSha256, caller)
assert.False(t, gf.IngestSha256GeneratedAt.IsZero(), caller)
assert.True(t, gf.IngestSha256VerifiedAt.IsZero(), caller)
assert.NotEmpty(t, gf.IngestUUID, caller)
assert.False(t, gf.IngestUUIDGeneratedAt.IsZero(), caller)
assert.Empty(t, gf.IngestStorageURL, caller)
assert.True(t, gf.IngestStoredAt.IsZero(), caller)
assert.Empty(t, gf.IngestReplicationURL, caller)
assert.True(t, gf.IngestReplicatedAt.IsZero(), caller)
assert.False(t, gf.IngestPreviousVersionExists, caller)
assert.True(t, gf.IngestNeedsSave, caller)
assert.Empty(t, gf.IngestErrorMessage, caller)
}