-
Notifications
You must be signed in to change notification settings - Fork 42
/
datamodelview.go
400 lines (375 loc) · 12.8 KB
/
datamodelview.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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
package datamodeldiagram
import (
"fmt"
"sort"
"strings"
"github.com/anz-bank/sysl/pkg/syslutil"
"github.com/anz-bank/sysl/pkg/cmdutils"
"github.com/anz-bank/sysl/pkg/integrationdiagram"
"github.com/anz-bank/sysl/pkg/sysl"
)
const classString = `class`
const relationArrow = `}--`
const tupleArrow = `*--`
const entityLessThanArrow = `<< `
const entityGreaterThanArrow = ` >>`
type DataModelParam struct {
cmdutils.ClassLabeler
Mod *sysl.Module
App *sysl.Application
Project string
Title string
Epname bool // If %(epname) is specified
}
type DataModelView struct {
cmdutils.ClassLabeler
Mod *sysl.Module
StringBuilder *strings.Builder
Symbols map[string]*cmdutils.Var
Project string
Title string
}
type RelationshipParam struct {
Entity string
Relationship string
Count uint32
}
type EntityViewParam struct {
EntityColor string
EntityHeader string
EntityName string
EntityAlias string
IgnoredTypes map[string]struct{}
Types map[string]*sysl.Type
}
func MakeDataModelView(
p cmdutils.ClassLabeler, mod *sysl.Module, stringBuilder *strings.Builder,
title, project string,
) *DataModelView {
return &DataModelView{
ClassLabeler: p,
Mod: mod,
StringBuilder: stringBuilder,
Project: project,
Title: title,
Symbols: make(map[string]*cmdutils.Var),
}
}
func (v *DataModelView) UniqueVarForAppName(nameParts ...string) string {
// TODO: when DrawTuple actually separates Appname and TypeName fix this
withoutEmptyStrings := []string{}
for _, s := range nameParts {
if s != "" {
withoutEmptyStrings = append(withoutEmptyStrings, s)
}
}
appName := strings.Join(withoutEmptyStrings, ".")
if s, ok := v.Symbols[appName]; ok {
return s.Alias
}
i := len(v.Symbols)
alias := fmt.Sprintf("_%d", i)
label := v.LabelClass(appName)
s := &cmdutils.Var{
Agent: cmdutils.MakeAgent(map[string]*sysl.Attribute{}),
Order: i,
Label: label,
Alias: alias,
}
v.Symbols[appName] = s
return s.Alias
}
func (v *DataModelView) DrawRelationship(relationshipMap map[string]map[string]RelationshipParam, viewType string) {
relNames := []string{}
for relName := range relationshipMap {
relNames = append(relNames, relName)
}
sort.Strings(relNames)
for _, relName := range relNames {
childNames := []string{}
for childName := range relationshipMap[relName] {
childNames = append(childNames, childName)
}
sort.Strings(childNames)
for _, childName := range childNames {
for cnt := relationshipMap[relName][childName].Count; cnt > 0; cnt-- {
v.StringBuilder.WriteString(fmt.Sprintf("%s %s \"%s\" %s\n", relName, viewType,
relationshipMap[relName][childName].Relationship, relationshipMap[relName][childName].Entity))
}
}
}
}
func (v *DataModelView) DrawRelation(
viewParam EntityViewParam,
entity *sysl.Type_Relation,
relationshipMap map[string]map[string]RelationshipParam,
) {
entityTokens := strings.Split(viewParam.EntityName, ".")
encEntity := v.UniqueVarForAppName(entityTokens[len(entityTokens)-1])
v.StringBuilder.WriteString(fmt.Sprintf("%s \"%s\" as %s %s(%s,%s)%s {\n", classString, viewParam.EntityName,
encEntity, entityLessThanArrow, viewParam.EntityHeader, viewParam.EntityColor, entityGreaterThanArrow))
// sort and iterate over attributes
attrNames := []string{}
for attrName := range entity.AttrDefs {
attrNames = append(attrNames, attrName)
}
sort.Strings(attrNames)
for _, attrName := range attrNames {
attrType := entity.AttrDefs[attrName]
var s string
if typeRef := attrType.GetTypeRef(); typeRef != nil {
targetEntity := v.UniqueVarForAppName(typeRef.GetRef().Path[0])
s = fmt.Sprintf("+ %s : **%s.%s** <<FK>>\n",
attrName,
typeRef.GetRef().Path[0],
typeRef.GetRef().Path[1])
if _, exists := relationshipMap[encEntity]; !exists {
relationshipMap[encEntity] = map[string]RelationshipParam{}
}
if _, mulRelation := relationshipMap[encEntity][targetEntity]; mulRelation {
relationshipMap[encEntity][targetEntity] = RelationshipParam{
Entity: relationshipMap[encEntity][targetEntity].Entity,
Relationship: relationshipMap[encEntity][targetEntity].Relationship,
Count: relationshipMap[encEntity][targetEntity].Count + 1,
}
} else {
relationshipMap[encEntity][targetEntity] = RelationshipParam{
Entity: targetEntity,
Relationship: " ",
Count: 1,
}
}
} else {
s = fmt.Sprintf("+ %s : %s\n", attrName, strings.ToLower(attrType.GetPrimitive().String()))
}
v.StringBuilder.WriteString(s)
}
v.StringBuilder.WriteString("}\n")
}
func (v *DataModelView) DrawPrimitive(
viewParam EntityViewParam,
entity string,
relationshipMap map[string]map[string]RelationshipParam,
) {
entityTokens := strings.Split(viewParam.EntityName, ".")
encEntity := v.UniqueVarForAppName(entityTokens[len(entityTokens)-1])
v.StringBuilder.WriteString(fmt.Sprintf("%s \"%s\" as %s %s(%s,%s) %s%s {\n",
classString, viewParam.EntityName, encEntity,
entityLessThanArrow, viewParam.EntityHeader, viewParam.EntityColor, strings.ToLower(entity), entityGreaterThanArrow))
if _, exists := relationshipMap[encEntity]; !exists {
relationshipMap[encEntity] = map[string]RelationshipParam{}
}
v.StringBuilder.WriteString("}\n")
}
//nolint: funlen
func (v *DataModelView) DrawTuple(
viewParam EntityViewParam,
entity *sysl.Type_Tuple,
relationshipMap map[string]map[string]RelationshipParam,
) {
var alias, typeName string
if viewParam.EntityAlias == "" {
alias = viewParam.EntityName
} else {
alias = viewParam.EntityAlias
// add space for better formatting and allow empty space when alias == ""
typeName = " " + viewParam.EntityName
}
encEntity := v.UniqueVarForAppName(strings.Split(viewParam.EntityName, ".")...)
// this will create a class header, with alias it will look like the following:
// class "AliasName" as _0 << (D,orchid) TypeName >> {
// Without the alias:
// class "TypeName" as _0 << (D,orchid) >> {
v.StringBuilder.WriteString(
fmt.Sprintf(
"%s \"%s\" as %s %s(%s,%s)%s%s {\n",
classString, alias,
encEntity, entityLessThanArrow, viewParam.EntityHeader,
viewParam.EntityColor, typeName, entityGreaterThanArrow,
),
)
var appName string
var relation string
var collectionString string
var isPrimitiveList bool
// sort and iterate over attributes
attrNames := []string{}
for attrName := range entity.AttrDefs {
attrNames = append(attrNames, attrName)
}
sort.Strings(attrNames)
for _, attrName := range attrNames {
//If the first element before the dot isn't what we passed in, then it's referring to another app
if arr := strings.Split(attrName, "."); len(arr) <= 1 {
appName = strings.Split(viewParam.EntityName, ".")[0]
} else if arr[0] != appName {
appName = arr[0]
}
attrType := entity.AttrDefs[attrName]
if _, exists := relationshipMap[encEntity]; !exists {
relationshipMap[encEntity] = map[string]RelationshipParam{}
}
if attrType.GetPrimitive() == sysl.Type_NO_Primitive {
var path []string
var label string
switch {
case attrType.GetList() != nil:
appName, path, label, isPrimitiveList = getNames(attrType.GetList().GetType())
collectionString = fmt.Sprintf("+ %s : **List <%s>**\n", attrName, label)
relation = `0..*` //nolint:goconst
case attrType.GetSet() != nil:
appName, path, label, isPrimitiveList = getNames(attrType.GetSet())
collectionString = fmt.Sprintf("+ %s : **Set <%s>**\n", attrName, label)
relation = `0..*` //nolint:goconst
case attrType.GetSequence() != nil:
appName, path, label, isPrimitiveList = getNames(attrType.GetSequence())
collectionString = fmt.Sprintf("+ %s : **Sequence <%s>**\n", attrName, label)
fullName := syslutil.JoinTypePath(append([]string{appName}, path...))
if _, ok := viewParam.IgnoredTypes[fullName]; ok {
v.StringBuilder.WriteString(collectionString)
continue
}
relation = `0..*` //nolint:goconst
case attrType.GetTypeRef() != nil:
appName, path, label, isPrimitiveList = getNames(attrType)
collectionString = fmt.Sprintf("+ %s : **%s**\n", attrName, label)
fullName := syslutil.JoinTypePath(path)
if _, ok := viewParam.IgnoredTypes[fullName]; ok {
v.StringBuilder.WriteString(collectionString)
continue
}
relation = `1..1 `
default:
continue
}
if !isPrimitiveList {
typeName := path[0]
if len(path) > 1 {
appName = path[0]
typeName = path[1]
}
if viewParam.Types[appName+"."+typeName] == nil && viewParam.Types[typeName] == nil {
v.StringBuilder.WriteString(collectionString)
continue
}
v.StringBuilder.WriteString(collectionString)
if _, mulRelation := relationshipMap[encEntity][v.UniqueVarForAppName(appName, typeName)]; mulRelation {
relationshipMap[encEntity][v.UniqueVarForAppName(appName, typeName)] = RelationshipParam{
Entity: relationshipMap[encEntity][v.UniqueVarForAppName(appName, typeName)].Entity,
Relationship: relationshipMap[encEntity][v.UniqueVarForAppName(appName, typeName)].Relationship,
Count: relationshipMap[encEntity][v.UniqueVarForAppName(appName, typeName)].Count + 1,
}
} else {
relationshipMap[encEntity][v.UniqueVarForAppName(appName, typeName)] = RelationshipParam{
Entity: v.UniqueVarForAppName(appName, typeName),
Relationship: relation,
Count: 1,
}
}
} else {
v.StringBuilder.WriteString(collectionString)
}
} else {
v.StringBuilder.WriteString(fmt.Sprintf("+ %s : %s\n", attrName, strings.ToLower(attrType.GetPrimitive().String())))
}
}
v.StringBuilder.WriteString("}\n")
}
// getNames returns the names and details needed to represent a type in a diagram.
func getNames(t *sysl.Type) (appName string, path []string, label string, isPrimitiveList bool) {
if t.GetPrimitive() == sysl.Type_NO_Primitive {
contextAppName := syslutil.JoinAppName(t.GetTypeRef().GetContext().GetAppname())
ref := t.GetTypeRef().GetRef()
if ref.GetAppname().GetPart() != nil { //nolint:gocritic
appName = syslutil.JoinAppName(ref.GetAppname())
} else if len(path) > 1 {
appName = ref.Path[0]
} else {
appName = contextAppName
}
path = ref.GetPath()
pathLabel := syslutil.JoinTypePath(ref.Path)
switch appName {
case contextAppName, "":
label = pathLabel
default:
label = syslutil.JoinTypePath([]string{appName, pathLabel})
}
} else {
label = strings.ToLower(t.GetPrimitive().String())
path = []string{label}
isPrimitiveList = true
}
return
}
func (v *DataModelView) GenerateDataView(dataParam *DataModelParam) string {
var isRelation bool
appName := syslutil.JoinAppName(dataParam.App.Name)
relationshipMap := map[string]map[string]RelationshipParam{}
v.StringBuilder.WriteString("@startuml\n")
if dataParam.Title != "" {
fmt.Fprintf(v.StringBuilder, "title %s\n", dataParam.Title)
}
v.StringBuilder.WriteString(integrationdiagram.PumlHeader)
// sort and iterate over each entity type the selected application
// *Type_Tuple_ OR *Type_Relation_
typeMap := map[string]*sysl.Type{}
ignoredTypes := map[string]struct{}{}
//typeMap := dataParam.App.GetTypes()
// TODO: Actually put The app/project name and the app in a struct so strings.split and join dont need to be used
entityNames := []string{}
for _, app := range dataParam.Mod.Apps {
for entityName, entityValue := range app.GetTypes() {
entityName = syslutil.JoinAppName(app.GetName()) + "." + entityName
if entityValue.Type != nil {
typeMap[entityName] = entityValue
entityNames = append(entityNames, entityName)
} else {
ignoredTypes[entityName] = struct{}{}
}
}
}
sort.Strings(entityNames)
for _, entityName := range entityNames {
if dataParam.Epname && strings.Split(entityName, ".")[0] != appName {
continue
}
entityType := typeMap[entityName]
if relEntity := entityType.GetRelation(); relEntity != nil {
isRelation = true
viewParam := EntityViewParam{
EntityColor: `orchid`,
EntityHeader: `D`,
EntityName: entityName,
Types: typeMap,
}
v.DrawRelation(viewParam, relEntity, relationshipMap)
} else if tupEntity := entityType.GetTuple(); tupEntity != nil {
isRelation = false
viewParam := EntityViewParam{
EntityColor: `orchid`,
EntityHeader: `D`,
EntityName: entityName,
IgnoredTypes: ignoredTypes,
Types: typeMap,
}
v.DrawTuple(viewParam, tupEntity, relationshipMap)
} else if pe := entityType.GetPrimitive(); pe != sysl.Type_NO_Primitive && len(strings.TrimSpace(pe.String())) > 0 {
isRelation = false
viewParam := EntityViewParam{
EntityColor: `orchid`,
EntityHeader: `D`,
EntityName: entityName,
Types: typeMap,
}
v.DrawPrimitive(viewParam, pe.String(), relationshipMap)
}
}
if isRelation {
v.DrawRelationship(relationshipMap, relationArrow)
} else {
v.DrawRelationship(relationshipMap, tupleArrow)
}
v.StringBuilder.WriteString("@enduml\n")
return v.StringBuilder.String()
}