add observatory scheduled test resource

.changelog/2807.txt

@@ -0,0 +1,3 @@
+```release-note:new-resource
+cloudflare_observatory_scheduled_test
+```

docs/resources/observatory_scheduled_test.md

@@ -0,0 +1,53 @@
+---
+page_title: "cloudflare_observatory_scheduled_test Resource - Cloudflare"
+subcategory: ""
+description: |-
+  Provides a Cloudflare Observatory Scheduled Test resource.
+---
+
+# cloudflare_observatory_scheduled_test (Resource)
+
+Provides a Cloudflare Observatory Scheduled Test resource.
+
+## Example Usage
+
+```terraform
+resource "cloudflare_observatory_scheduled_test" "example" {
+  zone_id = "0da42c8d2132a9ddaf714f9e7c920711"
+  url = "example.com"
+  region = "us-central1"
+  frequency = "WEEKLY"
+}
+```
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `frequency` (String) The frequency to run the test. Available values: `DAILY`, `WEEKLY`. **Modifying this attribute will force creation of a new resource.**
+- `region` (String) The region to run the test in. Available values: `us-central1`, `us-east1`, `us-east4`, `us-south1`, `us-west1`, `southamerica-east1`, `europe-north1`, `europe-southwest1`, `europe-west1`, `europe-west2`, `europe-west3`, `europe-west4`, `europe-west8`, `europe-west9`, `asia-east1`, `asia-southeast1`, `me-west1`, `australia-southeast1`. **Modifying this attribute will force creation of a new resource.**
+- `url` (String) The page to run the test on. **Modifying this attribute will force creation of a new resource.**
+- `zone_id` (String) The zone identifier to target for the resource. **Modifying this attribute will force creation of a new resource.**
+
+### Optional
+
+- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+
+<a id="nestedblock--timeouts"></a>
+### Nested Schema for `timeouts`
+
+Optional:
+
+- `create` (String)
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+$ terraform import cloudflare_observatory_scheduled_test.example <zone_id>:<url>:<region>
+```

examples/resources/cloudflare_observatory_scheduled_test/import.sh

@@ -0,0 +1 @@
+$ terraform import cloudflare_observatory_scheduled_test.example <zone_id>:<url>:<region>

examples/resources/cloudflare_observatory_scheduled_test/resource.tf

@@ -0,0 +1,7 @@
+resource "cloudflare_observatory_scheduled_test" "example" {
+  zone_id = "0da42c8d2132a9ddaf714f9e7c920711"
+  url = "example.com"
+  region = "us-central1"
+  frequency = "WEEKLY"
+}
+

internal/sdkv2provider/data_source_account_roles.go

@@ -5,10 +5,11 @@ import (
 	"fmt"
 
 	"github.com/cloudflare/cloudflare-go"
-	"github.com/cloudflare/terraform-provider-cloudflare/internal/consts"
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+
+	"github.com/cloudflare/terraform-provider-cloudflare/internal/consts"
 )
 
 func dataSourceCloudflareAccountRolesRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {

internal/sdkv2provider/provider.go

@@ -236,6 +236,7 @@ func New(version string) func() *schema.Provider {
 				"cloudflare_mtls_certificate":                       resourceCloudflareMTLSCertificate(),
 				"cloudflare_notification_policy_webhooks":           resourceCloudflareNotificationPolicyWebhook(),
 				"cloudflare_notification_policy":                    resourceCloudflareNotificationPolicy(),
+				"cloudflare_observatory_scheduled_test":             resourceCloudflareObservatoryScheduledTest(),
 				"cloudflare_origin_ca_certificate":                  resourceCloudflareOriginCACertificate(),
 				"cloudflare_page_rule":                              resourceCloudflarePageRule(),
 				"cloudflare_pages_domain":                           resourceCloudflarePagesDomain(),

internal/sdkv2provider/resource_cloudflare_account_member.go

@@ -8,10 +8,11 @@ import (
 
 	"github.com/MakeNowJust/heredoc/v2"
 	cloudflare "github.com/cloudflare/cloudflare-go"
-	"github.com/cloudflare/terraform-provider-cloudflare/internal/consts"
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+
+	"github.com/cloudflare/terraform-provider-cloudflare/internal/consts"
 )
 
 func resourceCloudflareAccountMember() *schema.Resource {

internal/sdkv2provider/resource_cloudflare_observatory_scheduled.go

@@ -0,0 +1,125 @@
+package sdkv2provider
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"strings"
+	"time"
+
+	cloudflare "github.com/cloudflare/cloudflare-go"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+
+	"github.com/cloudflare/terraform-provider-cloudflare/internal/consts"
+)
+
+func resourceCloudflareObservatoryScheduledTest() *schema.Resource {
+	return &schema.Resource{
+		Schema: resourceCloudflareObservatoryScheduledTestSchema(),
+
+		CreateContext: resourceCloudflareObservatoryScheduledTestCreate,
+		ReadContext:   resourceCloudflareObservatoryScheduledTestRead,
+		DeleteContext: resourceCloudflareObservatoryScheduledTestDelete,
+		Importer: &schema.ResourceImporter{
+			StateContext: resourceCloudflareObservatoryScheduledTestImport,
+		},
+
+		Timeouts: &schema.ResourceTimeout{
+			Create: schema.DefaultTimeout(30 * time.Second),
+		},
+		Description: "Provides a Cloudflare Observatory Scheduled Test resource.",
+	}
+}
+
+func resourceCloudflareObservatoryScheduledTestCreate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*cloudflare.API)
+	zoneID := d.Get(consts.ZoneIDSchemaKey).(string)
+
+	params := cloudflare.CreateObservatoryScheduledPageTestParams{
+		URL:       d.Get("url").(string),
+		Region:    d.Get("region").(string),
+		Frequency: d.Get("frequency").(string),
+	}
+	test, err := client.CreateObservatoryScheduledPageTest(ctx, cloudflare.ZoneIdentifier(zoneID), params)
+
+	if err != nil {
+		return diag.FromErr(fmt.Errorf("error creating observatory scheduled test %q: %w", d.Id(), err))
+	}
+
+	d.SetId(stringChecksum(fmt.Sprintf("%s:%s", test.Schedule.URL, test.Schedule.Region)))
+
+	return resourceCloudflareObservatoryScheduledTestRead(ctx, d, meta)
+}
+
+func resourceCloudflareObservatoryScheduledTestRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*cloudflare.API)
+	zoneID := d.Get(consts.ZoneIDSchemaKey).(string)
+
+	schedule, err := client.GetObservatoryScheduledPageTest(ctx, cloudflare.ZoneIdentifier(zoneID), cloudflare.GetObservatoryScheduledPageTestParams{
+		URL:    d.Get("url").(string),
+		Region: d.Get("region").(string),
+	})
+	if err != nil {
+		var notFoundError *cloudflare.NotFoundError
+		if errors.As(err, &notFoundError) {
+			tflog.Warn(ctx, fmt.Sprintf("Removing observatory scheduled test from state because it's not found in API"))
+			d.SetId("")
+			return nil
+		}
+		return diag.FromErr(fmt.Errorf("error getting observatory scheduled test %q: %w", d.Id(), err))
+	}
+	d.SetId(stringChecksum(fmt.Sprintf("%s:%s", schedule.URL, schedule.Region)))
+	d.Set("url", schedule.URL)
+	d.Set("region", schedule.Region)
+	d.Set("frequency", schedule.Frequency)
+	return nil
+}
+
+func resourceCloudflareObservatoryScheduledTestDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*cloudflare.API)
+	zoneID := d.Get(consts.ZoneIDSchemaKey).(string)
+
+	_, err := client.DeleteObservatoryScheduledPageTest(ctx, cloudflare.ZoneIdentifier(zoneID), cloudflare.DeleteObservatoryScheduledPageTestParams{
+		URL:    d.Get("url").(string),
+		Region: d.Get("region").(string),
+	})
+
+	if err != nil {
+		return diag.FromErr(fmt.Errorf("error deleting observatory scheduled test %q: %w", d.Id(), err))
+	}
+
+	return nil
+}
+
+func resourceCloudflareObservatoryScheduledTestImport(ctx context.Context, d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
+	client := meta.(*cloudflare.API)
+	idAttr := strings.SplitN(d.Id(), ":", 3)
+	var zoneID string
+	var url string
+	var region string
+	if len(idAttr) == 3 {
+		zoneID = idAttr[0]
+		url = idAttr[1]
+		region = idAttr[2]
+	} else {
+		return nil, fmt.Errorf("invalid id (\"%s\") specified, should be in format \"zoneID:url:region\" for import", d.Id())
+	}
+
+	schedule, err := client.GetObservatoryScheduledPageTest(ctx, cloudflare.ZoneIdentifier(zoneID), cloudflare.GetObservatoryScheduledPageTestParams{
+		URL:    url,
+		Region: region,
+	})
+	if err != nil {
+		return nil, fmt.Errorf("failed to fetch web analytics site: %s", url)
+	}
+
+	d.SetId(stringChecksum(fmt.Sprintf("%s:%s", schedule.URL, schedule.Region)))
+	d.Set(consts.ZoneIDSchemaKey, zoneID)
+	d.Set("url", schedule.URL)
+	d.Set("region", schedule.Region)
+	d.Set("frequency", schedule.Frequency)
+
+	return []*schema.ResourceData{d}, nil
+}

internal/sdkv2provider/resource_cloudflare_observatory_scheduled_test.go

@@ -0,0 +1,69 @@
+package sdkv2provider
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"testing"
+
+	cloudflare "github.com/cloudflare/cloudflare-go"
+	"github.com/cloudflare/terraform-provider-cloudflare/internal/consts"
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+	"github.com/hashicorp/terraform-plugin-testing/terraform"
+)
+
+func TestAccCloudflareObservatoryScheduledTest_Create(t *testing.T) {
+	t.Parallel()
+	zoneID := os.Getenv("CLOUDFLARE_ZONE_ID")
+	domain := os.Getenv("CLOUDFLARE_DOMAIN")
+	rnd := generateRandomResourceName()
+	name := fmt.Sprintf("cloudflare_observatory_scheduled_test.%s", rnd)
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: providerFactories,
+		CheckDestroy:      testAccCheckCloudflareWaitingRoomDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccCloudflareObservatoryScheduledTest(rnd, zoneID, domain),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr(name, consts.ZoneIDSchemaKey, zoneID),
+					resource.TestCheckResourceAttr(name, "url", domain+"/"),
+					resource.TestCheckResourceAttr(name, "region", "us-central1"),
+					resource.TestCheckResourceAttr(name, "frequency", "DAILY"),
+				),
+			},
+		},
+	})
+}
+
+func testAccCheckCloudflareObservatoryScheduledTestDestroy(s *terraform.State) error {
+	client := testAccProvider.Meta().(*cloudflare.API)
+
+	for _, rs := range s.RootModule().Resources {
+		if rs.Type != "cloudflare_observatory_scheduled_test" {
+			continue
+		}
+
+		_, err := client.GetObservatoryScheduledPageTest(context.Background(), cloudflare.ZoneIdentifier(rs.Primary.Attributes[consts.ZoneIDSchemaKey]), cloudflare.GetObservatoryScheduledPageTestParams{
+			URL:    rs.Primary.Attributes["url"],
+			Region: rs.Primary.Attributes["region"],
+		})
+		if err == nil {
+			return fmt.Errorf("observatory scheduled test still exists")
+		}
+	}
+
+	return nil
+}
+
+func testAccCloudflareObservatoryScheduledTest(resourceName, zoneID, domain string) string {
+	return fmt.Sprintf(`
+resource "cloudflare_observatory_scheduled_test" "%[1]s" {
+  zone_id   = "%[2]s"
+  url       = "%[3]s"
+  region    = "us-central1"
+  frequency = "DAILY"
+}
+`, resourceName, zoneID, domain)
+}

internal/sdkv2provider/schema_cloudflare_observatory_scheduled.go

@@ -0,0 +1,73 @@
+package sdkv2provider
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
+
+	"github.com/cloudflare/terraform-provider-cloudflare/internal/consts"
+)
+
+var observatoryTestScheduleFrequency = []string{
+	"DAILY",
+	"WEEKLY",
+}
+
+var observatoryTestRegions = []string{
+	"us-central1",
+	"us-east1",
+	"us-east4",
+	"us-south1",
+	"us-west1",
+	"southamerica-east1",
+	"europe-north1",
+	"europe-southwest1",
+	"europe-west1",
+	"europe-west2",
+	"europe-west3",
+	"europe-west4",
+	"europe-west8",
+	"europe-west9",
+	"asia-east1",
+	"asia-southeast1",
+	"me-west1",
+	"australia-southeast1",
+}
+
+func resourceCloudflareObservatoryScheduledTestSchema() map[string]*schema.Schema {
+	return map[string]*schema.Schema{
+		consts.ZoneIDSchemaKey: {
+			Description: consts.ZoneIDSchemaDescription,
+			Type:        schema.TypeString,
+			Required:    true,
+			ForceNew:    true,
+		},
+		"url": {
+			Description: "The page to run the test on.",
+			Type:        schema.TypeString,
+			Required:    true,
+			ForceNew:    true,
+			// ignore trailing "/" as observatory automatically adds it to tests
+			DiffSuppressFunc: func(k, oldValue, newValue string, d *schema.ResourceData) bool {
+				return strings.TrimSuffix(oldValue, "/") == newValue
+			},
+			DiffSuppressOnRefresh: true,
+		},
+		"region": {
+			Description:  fmt.Sprintf("The region to run the test in. %s", renderAvailableDocumentationValuesStringSlice(observatoryTestRegions)),
+			Type:         schema.TypeString,
+			Required:     true,
+			ValidateFunc: validation.StringInSlice(observatoryTestRegions, false),
+			ForceNew:     true,
+		},
+		"frequency": {
+			Description:  fmt.Sprintf("The frequency to run the test. %s", renderAvailableDocumentationValuesStringSlice(observatoryTestScheduleFrequency)),
+			Type:         schema.TypeString,
+			Required:     true,
+			ValidateFunc: validation.StringInSlice(observatoryTestScheduleFrequency, false),
+			ForceNew:     true,
+		},
+	}
+}