-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathprovider.go
More file actions
599 lines (544 loc) · 18.8 KB
/
Copy pathprovider.go
File metadata and controls
599 lines (544 loc) · 18.8 KB
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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
// Package provider implements the Uptime Kuma Terraform provider.
package provider
import (
"context"
"fmt"
"os"
"strconv"
"strings"
"time"
"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/provider"
"github.com/hashicorp/terraform-plugin-framework/provider/schema"
"github.com/hashicorp/terraform-plugin-framework/resource"
"github.com/hashicorp/terraform-plugin-framework/types"
kuma "github.com/breml/go-uptime-kuma-client"
"github.com/breml/terraform-provider-uptimekuma/internal/client"
)
// Ensure UptimeKumaProvider satisfies various provider interfaces.
var (
_ provider.Provider = &UptimeKumaProvider{}
)
// UptimeKumaProvider defines the provider implementation.
type UptimeKumaProvider struct {
// version is set to the provider version on release, "dev" when the
// provider is built and ran locally, and "test" when running acceptance
// testing.
version string
}
// UptimeKumaProviderModel describes the provider data model.
type UptimeKumaProviderModel struct {
Endpoint types.String `tfsdk:"endpoint"`
Username types.String `tfsdk:"username"`
Password types.String `tfsdk:"password"`
Timeout types.String `tfsdk:"timeout"`
PerAttemptTimeout types.String `tfsdk:"per_attempt_timeout"`
MaxRetries types.Int64 `tfsdk:"max_retries"`
}
// Metadata returns the metadata for the provider.
func (p *UptimeKumaProvider) Metadata(
_ context.Context,
_ provider.MetadataRequest,
resp *provider.MetadataResponse,
) {
resp.TypeName = "uptimekuma"
resp.Version = p.version
}
// Schema returns the schema for the provider.
func (*UptimeKumaProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp *provider.SchemaResponse) {
resp.Schema = schema.Schema{
Attributes: map[string]schema.Attribute{
"endpoint": schema.StringAttribute{
MarkdownDescription: "Uptime Kuma endpoint. Can be set via `UPTIMEKUMA_ENDPOINT` environment variable.",
Optional: true,
},
"username": schema.StringAttribute{
MarkdownDescription: "Uptime Kuma username. Can be set via `UPTIMEKUMA_USERNAME` environment variable.",
Optional: true,
},
"password": schema.StringAttribute{
MarkdownDescription: "Uptime Kuma password. Can be set via `UPTIMEKUMA_PASSWORD` environment variable.",
Optional: true,
Sensitive: true,
},
"timeout": schema.StringAttribute{
MarkdownDescription: "Overall connection timeout as a Go duration string (e.g. `30s`, `2m`). " +
"Bounds the total time spent attempting to connect to Uptime Kuma, including all retry " +
"attempts and backoff. Defaults to `30s` if not specified. " +
"Can be set via `UPTIMEKUMA_TIMEOUT` environment variable.",
Optional: true,
},
"per_attempt_timeout": schema.StringAttribute{
MarkdownDescription: "Optional per-attempt connection timeout as a Go duration string " +
"(e.g. `5s`, `10s`). Caps the time spent on each individual connection attempt. The " +
"effective per-attempt timeout is the smaller of this value and the remaining `timeout` " +
"budget. When unset, each attempt may use the full remaining `timeout` budget. " +
"Can be set via `UPTIMEKUMA_PER_ATTEMPT_TIMEOUT` environment variable.",
Optional: true,
},
"max_retries": schema.Int64Attribute{
MarkdownDescription: fmt.Sprintf(
"Maximum number of connection retry attempts (default: `%d`). "+
"All retry attempts must complete within the overall `timeout` budget. "+
"Can be set via `UPTIMEKUMA_MAX_RETRIES` environment variable.",
defaultMaxRetries,
),
Optional: true,
},
},
}
}
// Configure configures the provider with the API client.
func (*UptimeKumaProvider) Configure(
ctx context.Context,
req provider.ConfigureRequest,
resp *provider.ConfigureResponse,
) {
var data UptimeKumaProviderModel
resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
if resp.Diagnostics.HasError() {
return
}
// Apply environment variable defaults where Terraform config is not provided.
// Precedence: Terraform config > environment variables > nothing
applyEnvironmentDefaults(&data, resp)
// Validate configuration
// Endpoint is always required to connect to Uptime Kuma
// Username and password are optional (client will skip login if both are empty)
// However, if either username or password is provided, both must be present
hasUsername := !data.Username.IsNull()
hasPassword := !data.Password.IsNull()
if data.Endpoint.IsNull() {
resp.Diagnostics.AddError("endpoint required", "endpoint is required")
}
// If credentials are partially provided, require both
if hasUsername && !hasPassword {
resp.Diagnostics.AddError("password required", "password is required when username is provided")
}
if hasPassword && !hasUsername {
resp.Diagnostics.AddError("username required", "username is required when password is provided")
}
if resp.Diagnostics.HasError() {
return
}
opts := parseClientOptions(&data, resp)
if resp.Diagnostics.HasError() {
return
}
kumaClient, err := client.New(context.Background(), &client.Config{
Endpoint: data.Endpoint.ValueString(),
Username: data.Username.ValueString(),
Password: data.Password.ValueString(),
EnableConnectionPool: true,
LogLevel: kuma.LogLevel(os.Getenv("SOCKETIO_LOG_LEVEL")),
ConnectTimeout: opts.connectTimeout,
PerAttemptTimeout: opts.perAttemptTimeout,
MaxRetries: opts.maxRetries,
})
if err != nil {
resp.Diagnostics.AddError("failed to create client", err.Error())
return
}
// Context is cancelled on shutdown - you can use defer or goroutine
go func() {
<-ctx.Done()
client.GetGlobalPool().Release()
}()
pd := &providerData{
client: kumaClient,
password: data.Password.ValueString(),
}
resp.DataSourceData = pd
resp.ResourceData = pd
}
// clientOptions holds parsed and validated provider connection options.
type clientOptions struct {
connectTimeout time.Duration
perAttemptTimeout time.Duration
maxRetries int
}
// parseClientOptions extracts and validates timeout, per_attempt_timeout and
// max_retries from the provider model.
func parseClientOptions(
data *UptimeKumaProviderModel,
resp *provider.ConfigureResponse,
) clientOptions {
var opts clientOptions
opts.connectTimeout = parseDurationAttribute(data.Timeout, "timeout", resp)
if resp.Diagnostics.HasError() {
return opts
}
opts.perAttemptTimeout = parseDurationAttribute(data.PerAttemptTimeout, "per_attempt_timeout", resp)
if resp.Diagnostics.HasError() {
return opts
}
if opts.perAttemptTimeout > 0 && opts.connectTimeout > 0 && opts.perAttemptTimeout >= opts.connectTimeout {
resp.Diagnostics.AddWarning(
"per_attempt_timeout has no effect",
fmt.Sprintf(
"per_attempt_timeout (%s) is greater than or equal to timeout (%s); "+
"each attempt is already bounded by the remaining overall budget, "+
"so per_attempt_timeout will never be applied",
opts.perAttemptTimeout, opts.connectTimeout,
),
)
}
opts.maxRetries = defaultMaxRetries
if !data.MaxRetries.IsNull() {
opts.maxRetries = int(data.MaxRetries.ValueInt64())
}
if opts.maxRetries < 0 {
resp.Diagnostics.AddError(
"invalid max_retries",
fmt.Sprintf("max_retries must be non-negative, got %d", opts.maxRetries),
)
return clientOptions{}
}
return opts
}
// defaultMaxRetries mirrors the client package default. It is used both as
// the fallback in parseClientOptions when the user does not provide an
// explicit value, and to render the value in the `max_retries` schema
// description so the documented default cannot drift from the runtime one.
const defaultMaxRetries = 3
// parseDurationAttribute parses a Go duration string from a Terraform string
// attribute. Empty/null values yield a zero duration (meaning "use the default").
// Negative values produce a diagnostic error.
func parseDurationAttribute(
attr types.String,
name string,
resp *provider.ConfigureResponse,
) time.Duration {
value := strings.TrimSpace(attr.ValueString())
if attr.IsNull() || value == "" {
return 0
}
parsed, err := time.ParseDuration(value)
if err != nil {
resp.Diagnostics.AddError(
fmt.Sprintf("invalid %s", name),
fmt.Sprintf("failed to parse %s %q: %s", name, attr.ValueString(), err.Error()),
)
return 0
}
if parsed < 0 {
resp.Diagnostics.AddError(
fmt.Sprintf("invalid %s", name),
fmt.Sprintf("%s must be non-negative, got %s", name, parsed),
)
return 0
}
return parsed
}
// applyEnvironmentDefaults applies environment variable defaults to the provider model.
// Terraform config values take precedence over environment variables.
func applyEnvironmentDefaults(data *UptimeKumaProviderModel, resp *provider.ConfigureResponse) {
envEndpoint := os.Getenv("UPTIMEKUMA_ENDPOINT")
if data.Endpoint.IsNull() && envEndpoint != "" {
data.Endpoint = types.StringValue(envEndpoint)
}
envUsername := os.Getenv("UPTIMEKUMA_USERNAME")
if data.Username.IsNull() && envUsername != "" {
data.Username = types.StringValue(envUsername)
}
envPassword := os.Getenv("UPTIMEKUMA_PASSWORD")
if data.Password.IsNull() && envPassword != "" {
data.Password = types.StringValue(envPassword)
}
envTimeout := os.Getenv("UPTIMEKUMA_TIMEOUT")
if data.Timeout.IsNull() && envTimeout != "" {
data.Timeout = types.StringValue(envTimeout)
}
envPerAttemptTimeout := os.Getenv("UPTIMEKUMA_PER_ATTEMPT_TIMEOUT")
if data.PerAttemptTimeout.IsNull() && envPerAttemptTimeout != "" {
data.PerAttemptTimeout = types.StringValue(envPerAttemptTimeout)
}
envMaxRetries := os.Getenv("UPTIMEKUMA_MAX_RETRIES")
if data.MaxRetries.IsNull() && envMaxRetries != "" {
val, err := strconv.ParseInt(envMaxRetries, 10, 64)
if err == nil {
data.MaxRetries = types.Int64Value(val)
} else {
resp.Diagnostics.AddWarning(
"invalid UPTIMEKUMA_MAX_RETRIES",
fmt.Sprintf("invalid UPTIMEKUMA_MAX_RETRIES value %q; ignore value from environment variable", envMaxRetries),
)
}
}
}
// Resources returns the list of resources for the provider.
func (*UptimeKumaProvider) Resources(_ context.Context) []func() resource.Resource {
resources := notificationResources()
resources = append(
resources,
NewMonitorHTTPResource,
NewMonitorHTTPKeywordResource,
NewMonitorGrpcKeywordResource,
NewMonitorHTTPJSONQueryResource,
NewMonitorGroupResource,
NewMonitorPingResource,
NewMonitorDNSResource,
NewMonitorSNMPResource,
NewMonitorRadiusResource,
NewMonitorKafkaProducerResource,
NewMonitorPushResource,
NewMonitorRealBrowserResource,
NewMonitorPostgresResource,
NewMonitorMySQLResource,
NewMonitorOracleDBResource,
NewMonitorMongoDBResource,
NewMonitorRabbitMQResource,
NewMonitorRedisResource,
NewMonitorSQLServerResource,
NewMonitorGameDigResource,
NewMonitorGlobalpingResource,
NewMonitorSteamResource,
NewMonitorTailscalePingResource,
NewMonitorTCPPortResource,
NewMonitorSIPOptionsResource,
NewMonitorDockerResource,
NewMonitorMQTTResource,
NewMonitorSMTPResource,
NewProxyResource,
NewTagResource,
NewDockerHostResource,
NewMaintenanceResource,
NewMaintenanceMonitorsResource,
NewMaintenanceStatusPagesResource,
NewSettingsResource,
NewStatusPageResource,
NewStatusPageIncidentResource,
)
return resources
}
func notificationResources() []func() resource.Resource {
return []func() resource.Resource{
NewNotificationResource,
NewNotification46ElksResource,
NewNotificationAlertaResource,
NewNotificationAlertNowResource,
NewNotificationAliyunsmsResource,
NewNotificationAppriseResource,
NewNotificationBaleResource,
NewNotificationBarkResource,
NewNotificationBitrix24Resource,
NewNotificationBrevoResource,
NewNotificationCallMeBotResource,
NewNotificationCellsyntResource,
NewNotificationClicksendSmsResource,
NewNotificationDingDingResource,
NewNotificationDiscordResource,
NewNotificationEvolutionResource,
NewNotificationFeishuResource,
NewNotificationFlashDutyResource,
NewNotificationFluxerResource,
NewNotificationFreemobileResource,
NewNotificationGoAlertResource,
NewNotificationGoogleChatResource,
NewNotificationGoogleSheetsResource,
NewNotificationGotifyResource,
NewNotificationGorushResource,
NewNotificationGrafanaOncallResource,
NewNotificationGTXMessagingResource,
NewNotificationHaloPSAResource,
NewNotificationHeiiOnCallResource,
NewNotificationHomeAssistantResource,
NewNotificationKeepResource,
NewNotificationKookResource,
NewNotificationLineResource,
NewNotificationLunaseaResource,
NewNotificationMatrixResource,
NewNotificationMattermostResource,
NewNotificationNextcloudTalkResource,
NewNotificationNotiferyResource,
NewNotificationNostrResource,
NewNotificationNtfyResource,
NewNotificationOneBotResource,
NewNotificationOneChatResource,
NewNotificationOctopushResource,
NewNotificationOnesenderResource,
NewNotificationOpsgenieResource,
NewNotificationPagerDutyResource,
NewNotificationPagerTreeResource,
NewNotificationPumbleResource,
NewNotificationPushbulletResource,
NewNotificationPromoSMSResource,
NewNotificationPushDeerResource,
NewNotificationPushoverResource,
NewNotificationPushPlusResource,
NewNotificationPushyResource,
NewNotificationRocketChatResource,
NewNotificationSendgridResource,
NewNotificationServerChanResource,
NewNotificationSerwersmsResource,
NewNotificationSevenioResource,
NewNotificationSIGNL4Resource,
NewNotificationSignalResource,
NewNotificationSlackResource,
NewNotificationSquadcastResource,
NewNotificationSMSCResource,
NewNotificationSMSEagleResource,
NewNotificationSMSManagerResource,
NewNotificationSMSPartnerResource,
NewNotificationSMSPlanetResource,
NewNotificationStackfieldResource,
NewNotificationTechulusPushResource,
NewNotificationThreemaResource,
NewNotificationSplunkResource,
NewNotificationSpugPushResource,
NewNotificationSMTPResource,
NewNotificationTeamsResource,
NewNotificationTelegramResource,
NewNotificationTwilioResource,
NewNotificationVKResource,
NewNotificationWAHAResource,
NewNotificationWhapiResource,
NewNotificationWPushResource,
NewNotificationWebhookResource,
NewNotificationWeComResource,
NewNotificationYZJResource,
NewNotificationZohoCliqResource,
}
}
// DataSources returns the list of data sources for the provider.
func (*UptimeKumaProvider) DataSources(_ context.Context) []func() datasource.DataSource {
dataSources := notificationDataSources()
dataSources = append(
dataSources,
NewMonitorHTTPDataSource,
NewMonitorHTTPKeywordDataSource,
NewMonitorGrpcKeywordDataSource,
NewMonitorHTTPJSONQueryDataSource,
NewMonitorGroupDataSource,
NewMonitorPingDataSource,
NewMonitorDNSDataSource,
NewMonitorSNMPDataSource,
NewMonitorRadiusDataSource,
NewMonitorKafkaProducerDataSource,
NewMonitorPushDataSource,
NewMonitorRealBrowserDataSource,
NewMonitorPostgresDataSource,
NewMonitorMySQLDataSource,
NewMonitorOracleDBDataSource,
NewMonitorMongoDBDataSource,
NewMonitorRabbitMQDataSource,
NewMonitorRedisDataSource,
NewMonitorSQLServerDataSource,
NewMonitorGameDigDataSource,
NewMonitorGlobalpingDataSource,
NewMonitorSteamDataSource,
NewMonitorTailscalePingDataSource,
NewMonitorTCPPortDataSource,
NewMonitorSIPOptionsDataSource,
NewMonitorDockerDataSource,
NewMonitorMQTTDataSource,
NewMonitorSMTPDataSource,
NewProxyDataSource,
NewDockerHostDataSource,
NewMaintenanceDataSource,
NewMaintenanceMonitorsDataSource,
NewMaintenanceStatusPagesDataSource,
NewSettingsDataSource,
NewStatusPageDataSource,
)
return dataSources
}
func notificationDataSources() []func() datasource.DataSource {
return []func() datasource.DataSource{
NewMaintenancesDataSource,
NewTagDataSource,
NewNotificationDataSource,
NewNotification46ElksDataSource,
NewNotificationAlertaDataSource,
NewNotificationAlertNowDataSource,
NewNotificationAliyunsmsDataSource,
NewNotificationAppriseDataSource,
NewNotificationBaleDataSource,
NewNotificationBarkDataSource,
NewNotificationBitrix24DataSource,
NewNotificationBrevoDataSource,
NewNotificationCallMeBotDataSource,
NewNotificationCellsyntDataSource,
NewNotificationClicksendSmsDataSource,
NewNotificationDingDingDataSource,
NewNotificationDiscordDataSource,
NewNotificationEvolutionDataSource,
NewNotificationFeishuDataSource,
NewNotificationFlashDutyDataSource,
NewNotificationFluxerDataSource,
NewNotificationFreemobileDataSource,
NewNotificationGoAlertDataSource,
NewNotificationGoogleChatDataSource,
NewNotificationGoogleSheetsDataSource,
NewNotificationGotifyDataSource,
NewNotificationGorushDataSource,
NewNotificationGrafanaOncallDataSource,
NewNotificationGTXMessagingDataSource,
NewNotificationHaloPSADataSource,
NewNotificationHeiiOnCallDataSource,
NewNotificationHomeAssistantDataSource,
NewNotificationKeepDataSource,
NewNotificationKookDataSource,
NewNotificationLineDataSource,
NewNotificationLunaseaDataSource,
NewNotificationMatrixDataSource,
NewNotificationMattermostDataSource,
NewNotificationNextcloudTalkDataSource,
NewNotificationNotiferyDataSource,
NewNotificationNostrDataSource,
NewNotificationNtfyDataSource,
NewNotificationOneBotDataSource,
NewNotificationOneChatDataSource,
NewNotificationOctopushDataSource,
NewNotificationOnesenderDataSource,
NewNotificationOpsgenieDataSource,
NewNotificationPagerDutyDataSource,
NewNotificationPagerTreeDataSource,
NewNotificationPumbleDataSource,
NewNotificationPushbulletDataSource,
NewNotificationPromoSMSDataSource,
NewNotificationPushDeerDataSource,
NewNotificationPushoverDataSource,
NewNotificationPushPlusDataSource,
NewNotificationPushyDataSource,
NewNotificationRocketChatDataSource,
NewNotificationSendgridDataSource,
NewNotificationServerChanDataSource,
NewNotificationSerwersmsDataSource,
NewNotificationSevenioDataSource,
NewNotificationSIGNL4DataSource,
NewNotificationSignalDataSource,
NewNotificationSlackDataSource,
NewNotificationSquadcastDataSource,
NewNotificationSMSCDataSource,
NewNotificationSMSEagleDataSource,
NewNotificationSMSManagerDataSource,
NewNotificationSMSPartnerDataSource,
NewNotificationSMSPlanetDataSource,
NewNotificationStackfieldDataSource,
NewNotificationTechulusPushDataSource,
NewNotificationThreemaDataSource,
NewNotificationSplunkDataSource,
NewNotificationSpugPushDataSource,
NewNotificationSMTPDataSource,
NewNotificationTeamsDataSource,
NewNotificationTelegramDataSource,
NewNotificationTwilioDataSource,
NewNotificationVKDataSource,
NewNotificationWAHADataSource,
NewNotificationWhapiDataSource,
NewNotificationWPushDataSource,
NewNotificationWebhookDataSource,
NewNotificationWeComDataSource,
NewNotificationYZJDataSource,
NewNotificationZohoCliqDataSource,
}
}
// New returns a new instance of the provider.
func New(version string) func() provider.Provider {
return func() provider.Provider {
return &UptimeKumaProvider{
version: version,
}
}
}