-
Notifications
You must be signed in to change notification settings - Fork 1
/
factory.go
290 lines (264 loc) · 8.7 KB
/
factory.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
package pgmodels
import (
"fmt"
"math/rand"
"strings"
"time"
"github.com/APTrust/registry/constants"
"github.com/brianvoe/gofakeit/v6"
"github.com/google/uuid"
)
// --------------------------------------------------------------------
// TODO:
//
// ✓ Explain the magic number 4 & set as constant.
// x Rename these methods so it's clear they are factory methods
// to be used for testing only. (Maybe move them to a different
// package.)
// --------------------------------------------------------------------
var testInstitutionID = int64(4)
var testInstAdminID = int64(8)
var testInstUserID = int64(9)
// GetTestObject returns an IntellectualObject with valid settings
// that can be altered per-test.
func GetTestObject() *IntellectualObject {
return &IntellectualObject{
Title: "TestObject999",
Description: "Obj Created by Test",
Identifier: "test.edu/obj1",
AltIdentifier: "Yadda-Yadda-Yo",
Access: constants.AccessInstitution,
State: constants.StateActive,
BagName: "TestObject999.tar",
ETag: "12345678-9",
InstitutionID: 4,
StorageOption: constants.StorageOptionStandard,
BagItProfileIdentifier: "https://example.com/profile.json",
SourceOrganization: "Willy Wonka's Chocolate Factory",
BagGroupIdentifier: "group-999",
InternalSenderIdentifier: "yadda-999",
InternalSenderDescription: "Created by intel obj test",
}
}
func RandomObject() *IntellectualObject {
return &IntellectualObject{
Title: Title(),
Description: gofakeit.HackerPhrase(),
Identifier: ObjIdentifier(),
AltIdentifier: gofakeit.FarmAnimal(),
Access: constants.AccessInstitution,
State: constants.StateActive,
BagName: BagName(),
ETag: ETag(),
InstitutionID: 4,
StorageOption: constants.StorageOptionStandard,
BagItProfileIdentifier: "https://example.com/profile.json",
SourceOrganization: "Test University",
BagGroupIdentifier: gofakeit.Noun(),
InternalSenderIdentifier: gofakeit.PetName(),
InternalSenderDescription: gofakeit.HipsterSentence(12),
GenericFiles: make([]*GenericFile, 0),
PremisEvents: make([]*PremisEvent, 0),
}
}
func CreateObjectWithRelations() (*IntellectualObject, error) {
obj := RandomObject()
err := obj.Save()
if err != nil {
goto ERR
}
for i := 0; i < 5; i++ {
gf := RandomGenericFile(obj.ID, obj.Identifier)
err = gf.Save()
if err != nil {
goto ERR
}
gf.PremisEvents = append(gf.PremisEvents, RandomPremisEvent(constants.EventIngestion))
gf.PremisEvents = append(gf.PremisEvents, RandomPremisEvent(constants.EventIdentifierAssignment))
for _, event := range gf.PremisEvents {
event.IntellectualObjectID = gf.IntellectualObjectID
event.GenericFileID = gf.ID
err = event.Save()
if err != nil {
goto ERR
}
}
gf.Checksums = append(gf.Checksums, RandomChecksum(constants.AlgMd5))
gf.Checksums = append(gf.Checksums, RandomChecksum(constants.AlgSha256))
for _, checksum := range gf.Checksums {
checksum.GenericFileID = gf.ID
err = checksum.Save()
if err != nil {
goto ERR
}
}
gf.StorageRecords = append(gf.StorageRecords, RandomStorageRecord())
gf.StorageRecords = append(gf.StorageRecords, RandomStorageRecord())
for _, sr := range gf.StorageRecords {
sr.GenericFileID = gf.ID
err = sr.Save()
if err != nil {
goto ERR
}
}
obj.GenericFiles = append(obj.GenericFiles, gf)
}
obj.PremisEvents = append(obj.PremisEvents, RandomPremisEvent(constants.EventIngestion))
obj.PremisEvents = append(obj.PremisEvents, RandomPremisEvent(constants.EventIdentifierAssignment))
for _, event := range obj.PremisEvents {
event.IntellectualObjectID = obj.ID
err = event.Save()
if err != nil {
goto ERR
}
}
return obj, nil
ERR:
return nil, err
}
func RandomWorkItem(name, action string, objID, gfID int64) *WorkItem {
now := time.Now().UTC()
return &WorkItem{
TimestampModel: TimestampModel{
CreatedAt: now,
UpdatedAt: now,
},
Name: name,
ETag: ETag(),
InstitutionID: 4,
IntellectualObjectID: objID,
GenericFileID: gfID,
Bucket: "blah.receiving.blah",
User: "someone@example.com",
Note: "This item was created by the factory",
Action: action,
Stage: constants.StageRequested,
Status: constants.StatusPending,
Outcome: "Outcome? WTF?",
BagDate: now.AddDate(0, -4, 0),
DateProcessed: now,
Retry: true,
QueuedAt: now,
Size: rand.Int63(),
}
}
// RandomGenericFile returns a random generic file with the specified
// obj identifier prefix. State will be active.
func RandomGenericFile(objID int64, objIdentifier string) *GenericFile {
now := time.Now().UTC()
return &GenericFile{
TimestampModel: TimestampModel{
CreatedAt: now,
UpdatedAt: now,
},
FileFormat: gofakeit.AnimalType(),
Size: rand.Int63(),
Identifier: FileIdentifier(objIdentifier),
InstitutionID: 4,
IntellectualObjectID: objID,
State: constants.StateActive,
LastFixityCheck: now.AddDate(0, -4, 0),
StorageOption: constants.StorageOptionStandard,
UUID: uuid.NewString(),
PremisEvents: make([]*PremisEvent, 0),
Checksums: make([]*Checksum, 0),
StorageRecords: make([]*StorageRecord, 0),
}
}
// RandomPremisEvent returns a random premis event of the specified
// type. Caller should set GenericFileID and IntellectualObjectID.
func RandomPremisEvent(eventType string) *PremisEvent {
now := time.Now().UTC()
return &PremisEvent{
Agent: gofakeit.FarmAnimal(),
DateTime: now,
Detail: gofakeit.Sentence(4),
EventType: eventType,
Identifier: uuid.NewString(),
InstitutionID: 4,
Object: gofakeit.Sentence(4),
Outcome: gofakeit.Sentence(5),
OutcomeDetail: gofakeit.BeerName(),
OutcomeInformation: gofakeit.AppAuthor(),
TimestampModel: TimestampModel{
CreatedAt: now,
UpdatedAt: now,
},
}
}
// RandomChecksum returns a random checksum with the specified
// algorithm. Caller should set GenericFileID.
func RandomChecksum(alg string) *Checksum {
now := time.Now().UTC()
return &Checksum{
TimestampModel: TimestampModel{
CreatedAt: now,
UpdatedAt: now,
},
Algorithm: alg,
DateTime: now,
Digest: ETag(),
}
}
// RandomStorageRecord() returns a random storage record.
// Caller should set GenericFileID.
func RandomStorageRecord() *StorageRecord {
return &StorageRecord{
URL: gofakeit.URL(),
}
}
// RandFileBatch returns a slice of 20 GenericFiles, each with
// 4 events, checksums, and storage records. Note that this also
// creates the parent object in the database. You may want to
// reset the DB after calling this.
func RandomFileBatch() (*IntellectualObject, []*GenericFile, error) {
obj := RandomObject()
err := obj.Save()
if err != nil {
return nil, nil, err
}
files := make([]*GenericFile, 20)
for i := 0; i < 20; i++ {
gf := RandomGenericFile(obj.ID, obj.Identifier)
for j := 0; j < 4; j++ {
event := RandomPremisEvent(constants.EventIngestion)
event.Outcome = constants.OutcomeSuccess
gf.PremisEvents = append(gf.PremisEvents, event)
checksum := RandomChecksum(constants.AlgSha1)
gf.Checksums = append(gf.Checksums, checksum)
sr := RandomStorageRecord()
gf.StorageRecords = append(gf.StorageRecords, sr)
}
files[i] = gf
}
return obj, files, nil
}
func CreateDeletionRequest(objects []*IntellectualObject, files []*GenericFile) (*DeletionRequest, error) {
now := time.Now().UTC()
req, err := NewDeletionRequest()
if err != nil {
return nil, err
}
req.InstitutionID = 4
req.RequestedAt = now.Add(-1 * time.Hour)
req.RequestedByID = testInstUserID
req.GenericFiles = files
req.IntellectualObjects = objects
err = req.Save()
return req, err
}
func Title() string {
return fmt.Sprintf("%s %s %s", gofakeit.HackerAdjective(), gofakeit.BuzzWord(), gofakeit.BS())
}
func BagName() string {
return fmt.Sprintf("%s.tar", gofakeit.HackerAdjective())
}
func ObjIdentifier() string {
return fmt.Sprintf("test.edu/%s", gofakeit.AppName())
}
func FileIdentifier(objIdentifier string) string {
return fmt.Sprintf("%s/data/%s.%s", objIdentifier, gofakeit.Gamertag(), gofakeit.FileExtension())
}
func ETag() string {
return strings.Replace(uuid.NewString(), "-", "", -1)
}