-
Notifications
You must be signed in to change notification settings - Fork 7
/
diagram-creation.go
391 lines (361 loc) · 12.8 KB
/
diagram-creation.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
// diagram-creation.go: all the methods attached to the generator object to be used in templating
package catalog
import (
"bytes"
"fmt"
"os"
"path"
"regexp"
"strings"
"text/template"
"github.com/anz-bank/sysl/pkg/syslutil"
"github.com/anz-bank/sysl/pkg/diagrams"
"github.com/russross/blackfriday"
"github.com/anz-bank/protoc-gen-sysl/syslpopulate"
"github.com/anz-bank/sysl-catalog/pkg/catalogdiagrams"
"github.com/anz-bank/sysl/pkg/cmdutils"
"github.com/sirupsen/logrus"
"github.com/anz-bank/sysl/pkg/integrationdiagram"
"github.com/anz-bank/sysl/pkg/sysl"
)
var (
ofTypeSymbol = regexp.MustCompile(`(?m)(?:<:)(?:.*)`)
)
const (
plantuml = iota
mermaidjs
)
// CreateMarkdown is a wrapper function that also converts output markdown to html if in server mode
func (p *Generator) CreateMarkdown(t *template.Template, outputFileName string, i interface{}) error {
var buf bytes.Buffer
if err := t.Execute(&buf, i); err != nil {
return err
}
if err := p.Fs.MkdirAll(path.Dir(outputFileName), os.ModePerm); err != nil {
return err
}
f2, err := p.Fs.Create(outputFileName)
if err != nil {
return err
}
out := buf.Bytes()
if p.Format == "html" && !p.DisableCss {
raw := string(blackfriday.Run(out))
raw = strings.ReplaceAll(raw, "README.md", p.OutputFileName)
out = []byte(header + raw + style + endTags)
}
if _, err = f2.Write(out); err != nil {
return err
}
return nil
}
func (p *Generator) CreateIntegrationDiagram(m *sysl.Module, title string, EPA bool) string {
if p.Mermaid {
return p.CreateIntegrationDiagramMermaid(m, title, EPA)
}
return p.CreateIntegrationDiagramPlantuml(m, title, EPA)
}
//TODO @ashwinsajiv: fill out this function to generate mermaid integration diagrams
func (p *Generator) CreateIntegrationDiagramMermaid(m *sysl.Module, title string, EPA bool) string {
return "" //p.CreateFile("plantumlString", mermaidjs, "title", "integration.Output+p.Ext")
}
// CreateIntegrationDiagram creates an integration diagram and returns the filename
func (p *Generator) CreateIntegrationDiagramPlantuml(m *sysl.Module, title string, EPA bool) string {
type intsCmd struct {
diagrams.Plantumlmixin
cmdutils.CmdContextParamIntgen
}
integration := intsCmd{}
projectApp := createProjectApp(m.Apps)
project := "__TEMP__"
defer delete(p.Module.GetApps(), project)
p.Module.GetApps()[project] = projectApp
integration.Project = project
integration.Output = "integration" + TernaryOperator(EPA, "EPA", "").(string)
integration.Title = title
integration.EPA = EPA
integration.Clustered = true
result, err := integrationdiagram.GenerateIntegrations(&integration.CmdContextParamIntgen, p.Module, logrus.New())
if err != nil {
p.Log.Error(err)
return ""
}
plantumlString := result[integration.Output]
return p.CreateFile(plantumlString, plantuml, integration.Output+p.Ext)
}
// CreateSequenceDiagram creates an sequence diagram and returns the filename
func (p *Generator) CreateSequenceDiagram(appName string, endpoint *sysl.Endpoint) string {
m := p.Module
call := fmt.Sprintf("%s <- %s", appName, endpoint.GetName())
plantumlString, err := CreateSequenceDiagram(m, call)
if err != nil {
p.Log.Error(err)
return ""
}
return p.CreateFile(plantumlString, plantuml, appName, endpoint.GetName()+p.Ext)
}
// CreateParamDataModel creates a parameter data model and returns a filename
func (p *Generator) CreateParamDataModel(app *sysl.Application, param *sysl.Param) string {
var appName, typeName string
appName, typeName = GetAppTypeName(param)
if appName == "" {
appName = path.Join(app.Name.GetPart()...)
}
relatedTypes := catalogdiagrams.RecurseivelyGetTypes(appName, map[string]*sysl.Type{typeName: NewTypeRef(appName, typeName)}, p.Module)
plantumlString := catalogdiagrams.GenerateDataModel(appName, relatedTypes)
return p.CreateFile(plantumlString, plantuml, appName+p.Ext)
}
// GetReturnType converts an application and a param into a type, useful for getting attributes.
func (p *Generator) GetParamType(app *sysl.Application, param *sysl.Param) *sysl.Type {
var appName, typeName string
appName, typeName = GetAppTypeName(param)
if appName == "" {
appName = path.Join(app.GetName().GetPart()...)
}
return p.Module.Apps[appName].GetTypes()[typeName]
}
// GetReturnType converts an endpoint and a statement into a type, useful for getting attributes.
func (p *Generator) GetReturnType(endpoint *sysl.Endpoint, stmnt *sysl.Statement) *sysl.Type {
var appName, typeName string
ret := stmnt.GetRet()
if ret == nil {
return nil
}
t := strings.ReplaceAll(ofTypeSymbol.FindString(ret.GetPayload()), "<: ", "")
if strings.Contains(t, "sequence of") {
t = strings.ReplaceAll(t, "sequence of ", "")
}
if split := strings.Split(t, "."); len(split) > 1 {
appName = split[0]
typeName = split[1]
} else {
typeName = split[0]
}
if appName == "" {
appName = strings.Join(endpoint.GetSource().GetPart(), "")
}
return p.Module.GetApps()[appName].GetTypes()[typeName]
}
// CreateReturnDataModel creates a return data model and returns a filename, or empty string if it wasn't a return statement.
func (p *Generator) CreateReturnDataModel(stmnt *sysl.Statement, endpoint *sysl.Endpoint) string {
var sequence bool
var typeref *sysl.Type
var appName, typeName string
ret := stmnt.GetRet()
if ret == nil {
return ""
}
t := strings.ReplaceAll(ofTypeSymbol.FindString(ret.Payload), "<: ", "")
if strings.Contains(t, "sequence of") {
t = strings.ReplaceAll(t, "sequence of ", "")
sequence = true
}
if split := strings.Split(t, "."); len(split) > 1 {
appName = split[0]
typeName = split[1]
} else {
typeName = split[0]
}
if sequence {
newSequenceName := endpoint.GetName() + "ReturnVal"
newAppName := strings.Join(endpoint.GetSource().GetPart(), "")
defer delete(p.Module.GetApps()[newAppName].GetTypes(), newSequenceName)
p.Module.GetApps()[newAppName].GetTypes()[newSequenceName] = &sysl.Type{
Type: &sysl.Type_Tuple_{
Tuple: &sysl.Type_Tuple{
AttrDefs: map[string]*sysl.Type{"sequence": {Type: &sysl.Type_Sequence{
Sequence: syslpopulate.NewType(typeName, appName)},
},
},
},
},
}
typeref = NewTypeRef(appName, newSequenceName)
} else {
typeref = NewTypeRef(appName, typeName)
}
if _, ok := p.Module.Apps[appName]; !ok {
return ""
}
return p.CreateTypeDiagram(p.Module.GetApps()[appName], typeName, typeref, true)
}
// CreateTypeDiagram creates a data model diagram and returns the filename
func (p *Generator) CreateTypeDiagram(app *sysl.Application, typeName string, t *sysl.Type, recursive bool) string {
m := p.Module
appName := strings.Join(app.Name.Part, "")
typeref := NewTypeRef(appName, typeName)
var plantumlString string
if recursive {
relatedTypes := catalogdiagrams.RecurseivelyGetTypes(appName, map[string]*sysl.Type{typeName: typeref}, m)
plantumlString = catalogdiagrams.GenerateDataModel(appName, relatedTypes)
} else {
plantumlString = catalogdiagrams.GenerateDataModel(appName, map[string]*sysl.Type{typeName: t})
}
if _, ok := p.Module.GetApps()[appName]; !ok {
return ""
}
return p.CreateFile(plantumlString, plantuml, appName, typeName+TernaryOperator(recursive, "", "simple").(string)+p.Ext)
}
// CreateFileName returns the absolute and relative filepaths
func CreateFileName(dir string, elems ...string) (string, string) {
absolutefileName := path.Join(append([]string{dir}, Map(elems, SanitiseOutputName)...)...)
relativefileName := strings.Replace(absolutefileName, dir+"/", "", 1)
return absolutefileName, relativefileName
}
// CreateFile registers a file that needs to be created in p, or returns the embedded img tag if in server mode
func (p *Generator) CreateFile(contents string, diagramType int, elems ...string) string {
fileName, relativeFilepath := CreateFileName(p.CurrentDir, elems...)
var fileContents string
var targetMap map[string]string
var err error
switch diagramType {
case plantuml:
fileContents, err = PlantUMLURL(p.PlantumlService, contents)
targetMap = p.FilesToCreate
case mermaidjs:
fileContents = contents
targetMap = p.MermaidFilesToCreate
default:
panic("Wrong diagram type specified")
}
if err != nil {
p.Log.Error(err)
return ""
}
// if p.ImageTags: return image tag from plantUML service
if p.ImageTags && diagramType == plantuml {
return fileContents
}
targetMap[fileName] = fileContents
return relativeFilepath
}
// GenerateDataModel generates a data model for all of the types in app
func (p *Generator) GenerateDataModel(app *sysl.Application) string {
appName := strings.Join(app.GetName().GetPart(), "")
plantumlString := catalogdiagrams.GenerateDataModel(appName, app.GetTypes())
if _, ok := p.Module.GetApps()[appName]; !ok {
return ""
}
return p.CreateFile(plantumlString, plantuml, appName, "types"+p.Ext)
}
// CreateQueryParamDataModel returns a Query Parameter data model filename.
func (p *Generator) CreateQueryParamDataModel(CurrentAppName string, param *sysl.Endpoint_RestParams_QueryParam) string {
var typeName, appName string
var parsedType *sysl.Type
switch param.GetType().GetType().(type) {
case *sysl.Type_Primitive_:
parsedType = param.GetType()
typeName = param.GetName()
case *sysl.Type_TypeRef:
appName, typeName = GetAppTypeName(param)
if appName == "" {
appName = CurrentAppName
}
parsedType = NewTypeRef(appName, typeName)
}
if _, ok := p.Module.GetApps()[appName]; !ok {
return ""
}
return p.CreateTypeDiagram(p.Module.GetApps()[appName], typeName, parsedType, true)
}
// CreateQueryParamDataModel returns a Path Parameter data model filename.
func (p *Generator) CreatePathParamDataModel(CurrentAppName string, param *sysl.Endpoint_RestParams_QueryParam) string {
var typeName, appName string
var parsedType *sysl.Type
switch param.Type.Type.(type) {
case *sysl.Type_Primitive_:
parsedType = param.GetType()
typeName = param.GetName()
case *sysl.Type_TypeRef:
appName, typeName = GetAppTypeName(param)
if appName == "" {
appName = CurrentAppName
}
parsedType = NewTypeRef(appName, typeName)
}
if _, ok := p.Module.GetApps()[appName]; !ok {
return ""
}
return p.CreateTypeDiagram(p.Module.GetApps()[appName], typeName, parsedType, true)
}
func (p *Generator) getProjectApp(m *sysl.Module) (*sysl.Application, map[string]string) {
includedProjects := Filter(
SortedKeys(m.Apps),
func(i string) bool {
return syslutil.HasPattern(m.GetApps()[i].GetAttrs(), "project") &&
m.GetApps()[i].SourceContext.File == p.SourceFileName
},
)
if len(includedProjects) > 0 {
set := make(map[string]string)
app := m.GetApps()[includedProjects[0]]
for _, e := range app.GetEndpoints() {
if syslutil.HasPattern(e.GetAttrs(), "ignore") {
continue
}
for _, e2 := range e.GetStmt() {
set[e2.GetAction().GetAction()] = e.Name
}
}
return m.GetApps()[includedProjects[0]], set
}
return nil, nil
}
// ModuleAsMacroPackage returns "macro packages" that map to the endpoints on the "project" application
/*
project[~project]: <-- first map
FirstDivision: <-- first key
package1 <--- second map["package1"]*sysl.Module
package2 <--- second map["package2"]*sysl.Module
SecondDivision:
package3
*/
func (p *Generator) ModuleAsMacroPackage(m *sysl.Module) map[string]map[string]*sysl.Module {
packages := make(map[string]map[string]*sysl.Module)
_, includedProjects := p.getProjectApp(m)
for _, key := range SortedKeys(m.GetApps()) {
app := m.GetApps()[key]
packageName := Attribute(app, "package")
if packageName == "" {
packageName = key
}
// what endpoint on the "project app" are we on?
projectEndpoint, ok := includedProjects[packageName]
if len(includedProjects) > 0 && !ok || (projectEndpoint == "") {
continue
}
if syslutil.HasPattern(app.GetAttrs(), "ignore") || syslutil.HasPattern(app.GetAttrs(), "project") {
continue
}
if _, ok := packages[projectEndpoint]; !ok {
packages[projectEndpoint] = make(map[string]*sysl.Module)
}
if _, ok := packages[projectEndpoint][packageName]; !ok {
packages[projectEndpoint][packageName] = &sysl.Module{Apps: map[string]*sysl.Application{}}
}
packages[projectEndpoint][packageName].GetApps()[strings.Join(app.GetName().GetPart(), "")] = app
}
return packages
}
func (p *Generator) ModuleAsPackages(m *sysl.Module) map[string]*sysl.Module {
packages := make(map[string]*sysl.Module)
_, includedProjects := p.getProjectApp(m)
for _, key := range SortedKeys(m.GetApps()) {
app := m.GetApps()[key]
packageName := Attribute(app, "package")
if packageName == "" {
packageName = key
}
if _, ok := includedProjects[packageName]; len(includedProjects) > 0 && !ok {
continue
}
if syslutil.HasPattern(app.GetAttrs(), "ignore") || syslutil.HasPattern(app.GetAttrs(), "project") {
continue
}
if _, ok := packages[packageName]; !ok {
packages[packageName] = &sysl.Module{Apps: map[string]*sysl.Application{}}
}
packages[packageName].GetApps()[strings.Join(app.GetName().GetPart(), "")] = app
}
return packages
}