-
Notifications
You must be signed in to change notification settings - Fork 255
/
query_provider_impl.go
186 lines (156 loc) · 5.13 KB
/
query_provider_impl.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
package modconfig
import (
"fmt"
"github.com/hashicorp/hcl/v2"
"github.com/turbot/go-kit/helpers"
typehelpers "github.com/turbot/go-kit/types"
"github.com/zclconf/go-cty/cty"
)
type QueryProviderImpl struct {
RuntimeDependencyProviderImpl
QueryProviderRemain hcl.Body `hcl:",remain" json:"-"`
SQL *string `cty:"sql" hcl:"sql" column:"sql,text" json:"-"`
Query *Query `cty:"query" hcl:"query" json:"-"`
Args *QueryArgs `cty:"args" column:"args,jsonb" json:"-"`
Params []*ParamDef `cty:"params" column:"params,jsonb" json:"-"`
QueryName *string `column:"query,text" json:"-"`
withs []*DashboardWith
disableCtySerialise bool
// flags to indicate if params and args were inherited from base resource
argsInheritedFromBase bool
paramsInheritedFromBase bool
}
// GetParams implements QueryProvider
func (q *QueryProviderImpl) GetParams() []*ParamDef {
return q.Params
}
// GetArgs implements QueryProvider
func (q *QueryProviderImpl) GetArgs() *QueryArgs {
return q.Args
}
// GetSQL implements QueryProvider
func (q *QueryProviderImpl) GetSQL() *string {
return q.SQL
}
// GetQuery implements QueryProvider
func (q *QueryProviderImpl) GetQuery() *Query {
return q.Query
}
// SetArgs implements QueryProvider
func (q *QueryProviderImpl) SetArgs(args *QueryArgs) {
q.Args = args
}
// SetParams implements QueryProvider
func (q *QueryProviderImpl) SetParams(params []*ParamDef) {
q.Params = params
}
// ValidateQuery implements QueryProvider
// returns an error if neither sql or query are set
// it is overidden by resource types for which sql is optional
func (q *QueryProviderImpl) ValidateQuery() hcl.Diagnostics {
var diags hcl.Diagnostics
// Top level resources (with the exceptions of controls and queries) are never executed directly,
// only used as base for a nested resource.
// Therefore only nested resources, controls and queries MUST have sql or a query defined
queryRequired := !q.IsTopLevel() ||
helpers.StringSliceContains([]string{BlockTypeQuery, BlockTypeControl}, q.BlockType())
if !queryRequired {
return nil
}
if queryRequired && q.Query == nil && q.SQL == nil {
diags = append(diags, &hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: fmt.Sprintf("%s does not define a query or SQL", q.Name()),
Subject: q.GetDeclRange(),
})
}
return diags
}
// RequiresExecution implements QueryProvider
func (q *QueryProviderImpl) RequiresExecution(queryProvider QueryProvider) bool {
return queryProvider.GetQuery() != nil || queryProvider.GetSQL() != nil
}
// GetResolvedQuery return the SQL and args to run the query
func (q *QueryProviderImpl) GetResolvedQuery(runtimeArgs *QueryArgs) (*ResolvedQuery, error) {
argsArray, err := ResolveArgs(q, runtimeArgs)
if err != nil {
return nil, fmt.Errorf("failed to resolve args for %s: %s", q.Name(), err.Error())
}
sql := typehelpers.SafeString(q.GetSQL())
// we expect there to be sql on the query provider, NOT a Query
if sql == "" {
return nil, fmt.Errorf("getResolvedQuery faiuled - no sql set for '%s'", q.Name())
}
return &ResolvedQuery{
ExecuteSQL: sql,
RawSQL: sql,
Args: argsArray,
}, nil
}
// MergeParentArgs merges our args with our parent args (ours take precedence)
func (q *QueryProviderImpl) MergeParentArgs(queryProvider QueryProvider, parent QueryProvider) (diags hcl.Diagnostics) {
parentArgs := parent.GetArgs()
if parentArgs == nil {
return nil
}
args, err := parentArgs.Merge(queryProvider.GetArgs(), parent)
if err != nil {
return hcl.Diagnostics{&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: err.Error(),
Subject: parent.(HclResource).GetDeclRange(),
}}
}
queryProvider.SetArgs(args)
return nil
}
// GetQueryProviderImpl implements QueryProvider
func (q *QueryProviderImpl) GetQueryProviderImpl() *QueryProviderImpl {
return q
}
// ParamsInheritedFromBase implements QueryProvider
// determine whether our params were inherited from base resource
func (q *QueryProviderImpl) ParamsInheritedFromBase() bool {
return q.paramsInheritedFromBase
}
// ArgsInheritedFromBase implements QueryProvider
// determine whether our args were inherited from base resource
func (q *QueryProviderImpl) ArgsInheritedFromBase() bool {
return q.argsInheritedFromBase
}
// CtyValue implements CtyValueProvider
func (q *QueryProviderImpl) CtyValue() (cty.Value, error) {
if q.disableCtySerialise {
return cty.Zero, nil
}
return GetCtyValue(q)
}
func (q *QueryProviderImpl) setBaseProperties() {
q.RuntimeDependencyProviderImpl.setBaseProperties()
if q.SQL == nil {
q.SQL = q.getBaseImpl().SQL
}
if q.Query == nil {
q.Query = q.getBaseImpl().Query
}
if q.Args == nil {
q.Args = q.getBaseImpl().Args
q.argsInheritedFromBase = true
}
if q.Params == nil {
q.Params = q.getBaseImpl().Params
q.paramsInheritedFromBase = true
}
}
func (q *QueryProviderImpl) getBaseImpl() *QueryProviderImpl {
return q.base.(QueryProvider).GetQueryProviderImpl()
}
func (q *QueryProviderImpl) OnDecoded(block *hcl.Block, _ ResourceMapsProvider) hcl.Diagnostics {
q.populateQueryName()
return nil
}
func (q *QueryProviderImpl) populateQueryName() {
if q.Query != nil {
q.QueryName = &q.Query.FullName
}
}