-
Notifications
You must be signed in to change notification settings - Fork 0
/
generator.go
145 lines (129 loc) · 4.54 KB
/
generator.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
package generate
import (
"bytes"
"fmt"
"io"
"log"
"os"
"path/filepath"
"strings"
"text/template"
"github.com/paloaltonetworks/pan-os-codegen/pkg/properties"
"github.com/paloaltonetworks/pan-os-codegen/pkg/translate"
)
type Creator struct {
GoOutputDir string
TemplatesDir string
Spec *properties.Normalization
}
// NewCreator initialize Creator instance.
func NewCreator(goOutputDir, templatesDir string, spec *properties.Normalization) *Creator {
return &Creator{
GoOutputDir: goOutputDir,
TemplatesDir: templatesDir,
Spec: spec,
}
}
// RenderTemplate loop through all templates, parse them and render content, which is saved to output file.
func (c *Creator) RenderTemplate() error {
log.Println("Start rendering templates")
templates, err := c.listOfTemplates()
if err != nil {
return fmt.Errorf("error listing templates: %w", err)
}
for _, templateName := range templates {
filePath := c.createFullFilePath(templateName)
log.Printf("Creating file: %s\n", filePath)
if err := c.makeAllDirs(filePath); err != nil {
return fmt.Errorf("error creating directories for %s: %w", filePath, err)
}
tmpl, err := c.parseTemplate(templateName)
if err != nil {
return fmt.Errorf("error parsing template %s: %w", templateName, err)
}
var data bytes.Buffer
if err := tmpl.Execute(&data, c.Spec); err != nil {
return fmt.Errorf("error executing template %s: %w", templateName, err)
}
// If from template no data was rendered (e.g. for DNS spec entry should not be created),
// then we don't need to create empty file (e.g. `entry.go`) with no content
if data.Len() > 0 {
outputFile, err := os.Create(filePath)
if err != nil {
return fmt.Errorf("error creating file %s: %w", filePath, err)
}
defer outputFile.Close()
_, err = io.Copy(outputFile, &data)
if err != nil {
return err
}
}
}
return nil
}
// createFullFilePath returns a full path for output file generated from template passed as argument to function.
func (c *Creator) createFullFilePath(templateName string) string {
fileBaseName := strings.TrimSuffix(templateName, filepath.Ext(templateName))
return filepath.Join(c.GoOutputDir, filepath.Join(c.Spec.GoSdkPath...), fmt.Sprintf("%s.go", fileBaseName))
}
// listOfTemplates return list of templates defined in TemplatesDir.
func (c *Creator) listOfTemplates() ([]string, error) {
var files []string
err := filepath.WalkDir(c.TemplatesDir, func(path string, entry os.DirEntry, err error) error {
if err != nil {
return err
}
if entry.IsDir() {
return nil
}
if strings.HasSuffix(entry.Name(), ".tmpl") {
files = append(files, entry.Name())
}
return nil
})
if err != nil {
return nil, err
}
return files, nil
}
// makeAllDirs creates all required directories, which are in the file path.
func (c *Creator) makeAllDirs(filePath string) error {
dirPath := filepath.Dir(filePath)
return os.MkdirAll(dirPath, os.ModePerm)
}
// createFile just create a file and return it.
func (c *Creator) createFile(filePath string) (*os.File, error) {
outputFile, err := os.Create(filePath)
if err != nil {
return nil, err
}
return outputFile, nil
}
// parseTemplate parse template passed as argument and with function map defined below.
func (c *Creator) parseTemplate(templateName string) (*template.Template, error) {
templatePath := filepath.Join(c.TemplatesDir, templateName)
funcMap := template.FuncMap{
"renderImports": translate.RenderImports,
"packageName": translate.PackageName,
"locationType": translate.LocationType,
"specParamType": translate.SpecParamType,
"xmlParamType": translate.XmlParamType,
"xmlName": translate.XmlName,
"xmlTag": translate.XmlTag,
"specifyEntryAssignment": translate.SpecifyEntryAssignment,
"normalizeAssignment": translate.NormalizeAssignment,
"specMatchesFunction": translate.SpecMatchesFunction,
"nestedSpecMatchesFunction": translate.NestedSpecMatchesFunction,
"omitEmpty": translate.OmitEmpty,
"contains": strings.Contains,
"subtract": func(a, b int) int {
return a - b
},
"generateEntryXpath": translate.GenerateEntryXpathForLocation,
"nestedSpecs": translate.NestedSpecs,
"createGoSuffixFromVersion": translate.CreateGoSuffixFromVersion,
"paramSupportedInVersion": translate.ParamSupportedInVersion,
"xmlPathSuffixes": translate.XmlPathSuffixes,
}
return template.New(templateName).Funcs(funcMap).ParseFiles(templatePath)
}