Marcel S. Henselin
a5a388f238
## Description
<!-- **Please link some issue here describing what you are trying to achieve.**
In case there is no issue present for your PR, please consider creating one.
At least please give us some description what you are trying to achieve and why your change is needed. -->
relates to #1234
## Checklist
- [ ] Issue was linked above
- [ ] Code format was applied: `make fmt`
- [ ] Examples were added / adjusted (see `examples/` directory)
- [x] Docs are up-to-date: `make generate-docs` (will be checked by CI)
- [ ] Unit tests got implemented or updated
- [ ] Acceptance tests got implemented or updated (see e.g. [here](f5f99d1709/stackit/internal/services/dns/dns_acc_test.go))
- [x] Unit tests are passing: `make test` (will be checked by CI)
- [x] No linter issues: `make lint` (will be checked by CI)
Reviewed-on: #26
Co-authored-by: Marcel S. Henselin <marcel.henselin@stackit.cloud>
Co-committed-by: Marcel S. Henselin <marcel.henselin@stackit.cloud>
78 lines
3.2 KiB
Go
78 lines
3.2 KiB
Go
// Copyright (c) STACKIT
|
|
|
|
package features
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"slices"
|
|
"strings"
|
|
|
|
"github.com/hashicorp/terraform-plugin-framework/diag"
|
|
"github.com/hashicorp/terraform-plugin-log/tflog"
|
|
"tf-provider.git.onstackit.cloud/stackit-dev-tools/terraform-provider-stackitprivatepreview/stackit/internal/core"
|
|
)
|
|
|
|
const (
|
|
RoutingTablesExperiment = "routing-tables"
|
|
NetworkExperiment = "network"
|
|
IamExperiment = "iam"
|
|
)
|
|
|
|
var AvailableExperiments = []string{IamExperiment, RoutingTablesExperiment, NetworkExperiment}
|
|
|
|
// Check if an experiment is valid.
|
|
func ValidExperiment(experiment string, diags *diag.Diagnostics) bool {
|
|
validExperiment := slices.ContainsFunc(AvailableExperiments, func(e string) bool {
|
|
return strings.EqualFold(e, experiment)
|
|
})
|
|
if !validExperiment {
|
|
diags.AddError("Invalid Experiment", fmt.Sprintf("The Experiment %s is invalid. This is most likely a bug in the STACKIT Provider. Please open an issue. Available Experiments: %v", experiment, AvailableExperiments))
|
|
}
|
|
|
|
return validExperiment
|
|
}
|
|
|
|
// Check if an experiment is enabled.
|
|
func CheckExperimentEnabled(ctx context.Context, data *core.ProviderData, experiment, resourceName string, resourceType core.ResourceType, diags *diag.Diagnostics) {
|
|
if CheckExperimentEnabledWithoutError(ctx, data, experiment, resourceName, resourceType, diags) {
|
|
return
|
|
}
|
|
errTitle := fmt.Sprintf("%s is part of the %s experiment, which is currently disabled by default", resourceName, experiment)
|
|
errContent := fmt.Sprintf(`Enable the %s experiment by adding it into your provider block.`, experiment)
|
|
tflog.Error(ctx, fmt.Sprintf("%s | %s", errTitle, errContent))
|
|
diags.AddError(errTitle, errContent)
|
|
}
|
|
|
|
func CheckExperimentEnabledWithoutError(ctx context.Context, data *core.ProviderData, experiment, resourceName string, resourceType core.ResourceType, diags *diag.Diagnostics) bool {
|
|
if !ValidExperiment(experiment, diags) {
|
|
errTitle := fmt.Sprintf("The experiment %s does not exist.", experiment)
|
|
errContent := "This is a bug in the STACKIT Terraform Provider. Please open an issue here: https://github.com/stackitcloud/terraform-provider-stackit/issues"
|
|
diags.AddError(errTitle, errContent)
|
|
return false
|
|
}
|
|
experimentActive := slices.ContainsFunc(data.Experiments, func(e string) bool {
|
|
return strings.EqualFold(e, experiment)
|
|
})
|
|
|
|
if experimentActive {
|
|
warnTitle := fmt.Sprintf("%s is part of the %s experiment.", resourceName, experiment)
|
|
warnContent := fmt.Sprintf("This %s is part of the %s experiment and is likely going to undergo significant changes or be removed in the future. Use it at your own discretion.", resourceType, experiment)
|
|
tflog.Warn(ctx, fmt.Sprintf("%s | %s", warnTitle, warnContent))
|
|
diags.AddWarning(warnTitle, warnContent)
|
|
return true
|
|
}
|
|
return false
|
|
}
|
|
|
|
func AddExperimentDescription(description, experiment string, resourceType core.ResourceType) string {
|
|
// Callout block: https://developer.hashicorp.com/terraform/registry/providers/docs#callouts
|
|
return fmt.Sprintf("%s\n\n~> %s%s%s%s%s",
|
|
description,
|
|
"This ",
|
|
resourceType,
|
|
" is part of the ",
|
|
experiment,
|
|
" experiment and is likely going to undergo significant changes or be removed in the future. Use it at your own discretion.",
|
|
)
|
|
}
|