forked from airbytehq/terraform-provider-airbyte
/
source_clickhouse_data_source.go
executable file
·339 lines (318 loc) · 12.8 KB
/
source_clickhouse_data_source.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
// Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
package provider
import (
"github.com/ryan-pip/terraform-provider-airbyte/internal/sdk"
"github.com/ryan-pip/terraform-provider-airbyte/internal/sdk/pkg/models/operations"
"context"
"fmt"
"github.com/ryan-pip/terraform-provider-airbyte/internal/validators"
"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
)
// Ensure provider defined types fully satisfy framework interfaces.
var _ datasource.DataSource = &SourceClickhouseDataSource{}
var _ datasource.DataSourceWithConfigure = &SourceClickhouseDataSource{}
func NewSourceClickhouseDataSource() datasource.DataSource {
return &SourceClickhouseDataSource{}
}
// SourceClickhouseDataSource is the data source implementation.
type SourceClickhouseDataSource struct {
client *sdk.SDK
}
// SourceClickhouseDataSourceModel describes the data model.
type SourceClickhouseDataSourceModel struct {
Configuration SourceClickhouse `tfsdk:"configuration"`
Name types.String `tfsdk:"name"`
SecretID types.String `tfsdk:"secret_id"`
SourceID types.String `tfsdk:"source_id"`
WorkspaceID types.String `tfsdk:"workspace_id"`
}
// Metadata returns the data source type name.
func (r *SourceClickhouseDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_source_clickhouse"
}
// Schema defines the schema for the data source.
func (r *SourceClickhouseDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
resp.Schema = schema.Schema{
MarkdownDescription: "SourceClickhouse DataSource",
Attributes: map[string]schema.Attribute{
"configuration": schema.SingleNestedAttribute{
Computed: true,
Attributes: map[string]schema.Attribute{
"database": schema.StringAttribute{
Computed: true,
Description: `The name of the database.`,
},
"host": schema.StringAttribute{
Computed: true,
Description: `The host endpoint of the Clickhouse cluster.`,
},
"password": schema.StringAttribute{
Computed: true,
Description: `The password associated with this username.`,
},
"port": schema.Int64Attribute{
Computed: true,
Description: `The port of the database.`,
},
"source_type": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
stringvalidator.OneOf(
"clickhouse",
),
},
Description: `must be one of ["clickhouse"]`,
},
"tunnel_method": schema.SingleNestedAttribute{
Computed: true,
Attributes: map[string]schema.Attribute{
"source_clickhouse_ssh_tunnel_method_no_tunnel": schema.SingleNestedAttribute{
Computed: true,
Attributes: map[string]schema.Attribute{
"tunnel_method": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
stringvalidator.OneOf(
"NO_TUNNEL",
),
},
MarkdownDescription: `must be one of ["NO_TUNNEL"]` + "\n" +
`No ssh tunnel needed to connect to database`,
},
},
Description: `Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.`,
},
"source_clickhouse_ssh_tunnel_method_password_authentication": schema.SingleNestedAttribute{
Computed: true,
Attributes: map[string]schema.Attribute{
"tunnel_host": schema.StringAttribute{
Computed: true,
Description: `Hostname of the jump server host that allows inbound ssh tunnel.`,
},
"tunnel_method": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
stringvalidator.OneOf(
"SSH_PASSWORD_AUTH",
),
},
MarkdownDescription: `must be one of ["SSH_PASSWORD_AUTH"]` + "\n" +
`Connect through a jump server tunnel host using username and password authentication`,
},
"tunnel_port": schema.Int64Attribute{
Computed: true,
Description: `Port on the proxy/jump server that accepts inbound ssh connections.`,
},
"tunnel_user": schema.StringAttribute{
Computed: true,
Description: `OS-level username for logging into the jump server host`,
},
"tunnel_user_password": schema.StringAttribute{
Computed: true,
Description: `OS-level password for logging into the jump server host`,
},
},
Description: `Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.`,
},
"source_clickhouse_ssh_tunnel_method_ssh_key_authentication": schema.SingleNestedAttribute{
Computed: true,
Attributes: map[string]schema.Attribute{
"ssh_key": schema.StringAttribute{
Computed: true,
Description: `OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )`,
},
"tunnel_host": schema.StringAttribute{
Computed: true,
Description: `Hostname of the jump server host that allows inbound ssh tunnel.`,
},
"tunnel_method": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
stringvalidator.OneOf(
"SSH_KEY_AUTH",
),
},
MarkdownDescription: `must be one of ["SSH_KEY_AUTH"]` + "\n" +
`Connect through a jump server tunnel host using username and ssh key`,
},
"tunnel_port": schema.Int64Attribute{
Computed: true,
Description: `Port on the proxy/jump server that accepts inbound ssh connections.`,
},
"tunnel_user": schema.StringAttribute{
Computed: true,
Description: `OS-level username for logging into the jump server host.`,
},
},
Description: `Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.`,
},
"source_clickhouse_update_ssh_tunnel_method_no_tunnel": schema.SingleNestedAttribute{
Computed: true,
Attributes: map[string]schema.Attribute{
"tunnel_method": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
stringvalidator.OneOf(
"NO_TUNNEL",
),
},
MarkdownDescription: `must be one of ["NO_TUNNEL"]` + "\n" +
`No ssh tunnel needed to connect to database`,
},
},
Description: `Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.`,
},
"source_clickhouse_update_ssh_tunnel_method_password_authentication": schema.SingleNestedAttribute{
Computed: true,
Attributes: map[string]schema.Attribute{
"tunnel_host": schema.StringAttribute{
Computed: true,
Description: `Hostname of the jump server host that allows inbound ssh tunnel.`,
},
"tunnel_method": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
stringvalidator.OneOf(
"SSH_PASSWORD_AUTH",
),
},
MarkdownDescription: `must be one of ["SSH_PASSWORD_AUTH"]` + "\n" +
`Connect through a jump server tunnel host using username and password authentication`,
},
"tunnel_port": schema.Int64Attribute{
Computed: true,
Description: `Port on the proxy/jump server that accepts inbound ssh connections.`,
},
"tunnel_user": schema.StringAttribute{
Computed: true,
Description: `OS-level username for logging into the jump server host`,
},
"tunnel_user_password": schema.StringAttribute{
Computed: true,
Description: `OS-level password for logging into the jump server host`,
},
},
Description: `Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.`,
},
"source_clickhouse_update_ssh_tunnel_method_ssh_key_authentication": schema.SingleNestedAttribute{
Computed: true,
Attributes: map[string]schema.Attribute{
"ssh_key": schema.StringAttribute{
Computed: true,
Description: `OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )`,
},
"tunnel_host": schema.StringAttribute{
Computed: true,
Description: `Hostname of the jump server host that allows inbound ssh tunnel.`,
},
"tunnel_method": schema.StringAttribute{
Computed: true,
Validators: []validator.String{
stringvalidator.OneOf(
"SSH_KEY_AUTH",
),
},
MarkdownDescription: `must be one of ["SSH_KEY_AUTH"]` + "\n" +
`Connect through a jump server tunnel host using username and ssh key`,
},
"tunnel_port": schema.Int64Attribute{
Computed: true,
Description: `Port on the proxy/jump server that accepts inbound ssh connections.`,
},
"tunnel_user": schema.StringAttribute{
Computed: true,
Description: `OS-level username for logging into the jump server host.`,
},
},
Description: `Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.`,
},
},
Validators: []validator.Object{
validators.ExactlyOneChild(),
},
Description: `Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.`,
},
"username": schema.StringAttribute{
Computed: true,
Description: `The username which is used to access the database.`,
},
},
},
"name": schema.StringAttribute{
Computed: true,
},
"secret_id": schema.StringAttribute{
Optional: true,
Description: `Optional secretID obtained through the public API OAuth redirect flow.`,
},
"source_id": schema.StringAttribute{
Required: true,
},
"workspace_id": schema.StringAttribute{
Computed: true,
},
},
}
}
func (r *SourceClickhouseDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
// Prevent panic if the provider has not been configured.
if req.ProviderData == nil {
return
}
client, ok := req.ProviderData.(*sdk.SDK)
if !ok {
resp.Diagnostics.AddError(
"Unexpected DataSource Configure Type",
fmt.Sprintf("Expected *sdk.SDK, got: %T. Please report this issue to the provider developers.", req.ProviderData),
)
return
}
r.client = client
}
func (r *SourceClickhouseDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
var data *SourceClickhouseDataSourceModel
var item types.Object
resp.Diagnostics.Append(req.Config.Get(ctx, &item)...)
if resp.Diagnostics.HasError() {
return
}
resp.Diagnostics.Append(item.As(ctx, &data, basetypes.ObjectAsOptions{
UnhandledNullAsEmpty: true,
UnhandledUnknownAsEmpty: true,
})...)
if resp.Diagnostics.HasError() {
return
}
sourceID := data.SourceID.ValueString()
request := operations.GetSourceClickhouseRequest{
SourceID: sourceID,
}
res, err := r.client.Sources.GetSourceClickhouse(ctx, request)
if err != nil {
resp.Diagnostics.AddError("failure to invoke API", err.Error())
if res != nil && res.RawResponse != nil {
resp.Diagnostics.AddError("unexpected http request/response", debugResponse(res.RawResponse))
}
return
}
if res == nil {
resp.Diagnostics.AddError("unexpected response from API", fmt.Sprintf("%v", res))
return
}
if res.StatusCode != 200 {
resp.Diagnostics.AddError(fmt.Sprintf("unexpected response from API. Got an unexpected response code %v", res.StatusCode), debugResponse(res.RawResponse))
return
}
if res.SourceResponse == nil {
resp.Diagnostics.AddError("unexpected response from API. No response body", debugResponse(res.RawResponse))
return
}
data.RefreshFromGetResponse(res.SourceResponse)
// Save updated data into Terraform state
resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
}