[CES]: v2 dashboards and one click alarms (#905)

Author: artem-lifshits

acceptance/openstack/ces/v2/dashboards_test.go

@@ -0,0 +1,69 @@
+package v2
+
+import (
+	"testing"
+
+	"github.com/opentelekomcloud/gophertelekomcloud/acceptance/clients"
+	"github.com/opentelekomcloud/gophertelekomcloud/openstack/ces/v2/dashboards"
+	th "github.com/opentelekomcloud/gophertelekomcloud/testhelper"
+)
+
+func TestDashboardsCRUD(t *testing.T) {
+	client, err := clients.NewCesV2Client()
+	th.AssertNoErr(t, err)
+
+	t.Log("Attempting to create dashboard")
+	dashboardId, err := dashboards.Create(client, dashboards.CreateOpts{
+		DashboardName: "test-dashboard-acc",
+	})
+	th.AssertNoErr(t, err)
+	t.Logf("Created dashboard: %s", dashboardId)
+
+	t.Log("Attempting to copy dashboard")
+	copyDashboardId, err := dashboards.Create(client, dashboards.CreateOpts{
+		DashboardName: "test-dashboard-copy-acc",
+		DashboardId:   dashboardId,
+	})
+	th.AssertNoErr(t, err)
+	t.Logf("Copied dashboard: %s", copyDashboardId)
+
+	t.Cleanup(func() {
+		t.Log("Attempting to batch delete dashboards")
+		results, err := dashboards.BatchDelete(client, dashboards.BatchDeleteOpts{
+			DashboardIds: []string{dashboardId, copyDashboardId},
+		})
+		th.AssertNoErr(t, err)
+		for _, result := range results {
+			t.Logf("Delete result: ID=%s, Status=%s", result.DashboardId, result.RetStatus)
+		}
+	})
+
+	t.Log("Attempting to list dashboards")
+	dashboardsList, err := dashboards.List(client, dashboards.ListOpts{})
+	th.AssertNoErr(t, err)
+	t.Logf("Found %d dashboards", len(dashboardsList))
+
+	found := 0
+	for _, d := range dashboardsList {
+		if d.DashboardId == dashboardId || d.DashboardId == copyDashboardId {
+			found++
+			t.Logf("Dashboard: ID=%s, Name=%s, Creator=%s",
+				d.DashboardId, d.DashboardName, d.CreatorName)
+		}
+	}
+	th.AssertEquals(t, found, 2)
+
+	t.Log("Attempting to modify dashboard")
+	err = dashboards.Update(client, dashboardId, dashboards.UpdateOpts{
+		DashboardName: "test-dashboard-updated-acc",
+	})
+	th.AssertNoErr(t, err)
+
+	t.Log("Attempting to verify dashboard update")
+	dashboardsList, err = dashboards.List(client, dashboards.ListOpts{
+		DashboardId: dashboardId,
+	})
+	th.AssertNoErr(t, err)
+	th.AssertEquals(t, len(dashboardsList), 1)
+	th.AssertEquals(t, dashboardsList[0].DashboardName, "test-dashboard-updated-acc")
+}

acceptance/openstack/ces/v2/oneclickalarms_test.go

@@ -0,0 +1,111 @@
+package v2
+
+import (
+	"testing"
+
+	"github.com/opentelekomcloud/gophertelekomcloud/acceptance/clients"
+	"github.com/opentelekomcloud/gophertelekomcloud/openstack/ces/v2/oneclickalarms"
+	th "github.com/opentelekomcloud/gophertelekomcloud/testhelper"
+)
+
+func TestOneClickAlarmsList(t *testing.T) {
+	client, err := clients.NewCesV2Client()
+	th.AssertNoErr(t, err)
+
+	t.Log("Attempting to list one-click alarms")
+	alarmsList, err := oneclickalarms.List(client)
+	th.AssertNoErr(t, err)
+	t.Logf("Found %d one-click alarms", len(alarmsList))
+}
+
+func TestOneClickAlarmsCRUD(t *testing.T) {
+	client, err := clients.NewCesV2Client()
+	th.AssertNoErr(t, err)
+
+	t.Log("Attempting to enable one-click monitoring for ECS")
+	createOpts := oneclickalarms.CreateOpts{
+		OneClickAlarmId: "ECSSystemOneClickAlarm",
+		DimensionNames: oneclickalarms.DimensionNames{
+			Metric: []string{"instance_id"},
+			Event:  []string{},
+		},
+		NotificationEnabled: false,
+	}
+
+	oneClickAlarmId, err := oneclickalarms.Create(client, createOpts)
+	th.AssertNoErr(t, err)
+	t.Logf("Enabled one-click monitoring: %s", oneClickAlarmId)
+
+	t.Cleanup(func() {
+		t.Log("Attempting to disable one-click monitoring")
+		_, err := oneclickalarms.BatchDelete(client, oneclickalarms.BatchDeleteOpts{
+			OneClickAlarmIds: []string{oneClickAlarmId},
+		})
+		th.AssertNoErr(t, err)
+	})
+
+	t.Log("Attempting to list one-click alarms to verify creation")
+	alarmsList, err := oneclickalarms.List(client)
+	th.AssertNoErr(t, err)
+
+	found := false
+	for _, alarm := range alarmsList {
+		if alarm.OneClickAlarmId == oneClickAlarmId && alarm.Enabled {
+			found = true
+			t.Logf("Found enabled one-click alarm: %s, Namespace: %s", alarm.OneClickAlarmId, alarm.Namespace)
+			break
+		}
+	}
+	th.AssertEquals(t, found, true)
+
+	t.Log("Attempting to get alarm rules for one-click monitoring")
+	alarmRules, err := oneclickalarms.ListAlarmRules(client, oneClickAlarmId)
+	th.AssertNoErr(t, err)
+	t.Logf("Found %d alarm rules", len(alarmRules))
+	th.AssertEquals(t, len(alarmRules) > 0, true)
+
+	alarmRule := alarmRules[0]
+	t.Logf("First alarm rule: ID=%s, Name=%s, Enabled=%v",
+		alarmRule.AlarmId, alarmRule.Name, alarmRule.Enabled)
+
+	t.Log("Attempting to disable alarm rule")
+	_, err = oneclickalarms.BatchEnableAlarmRules(client, oneClickAlarmId, oneclickalarms.BatchEnableAlarmRulesOpts{
+		AlarmIds:     []string{alarmRule.AlarmId},
+		AlarmEnabled: false,
+	})
+	th.AssertNoErr(t, err)
+
+	t.Log("Attempting to enable alarm rule")
+	_, err = oneclickalarms.BatchEnableAlarmRules(client, oneClickAlarmId, oneclickalarms.BatchEnableAlarmRulesOpts{
+		AlarmIds:     []string{alarmRule.AlarmId},
+		AlarmEnabled: true,
+	})
+	th.AssertNoErr(t, err)
+
+	th.AssertEquals(t, len(alarmRule.Policies) > 0, true)
+	policy := alarmRule.Policies[0]
+	t.Logf("First policy: ID=%s, MetricName=%s, Enabled=%v",
+		policy.AlarmPolicyId, policy.MetricName, policy.Enabled)
+
+	t.Log("Attempting to disable alarm policy")
+	_, err = oneclickalarms.BatchEnablePolicies(client, oneClickAlarmId, alarmRule.AlarmId, oneclickalarms.BatchEnablePoliciesOpts{
+		AlarmPolicyIds: []string{policy.AlarmPolicyId},
+		Enabled:        false,
+	})
+	th.AssertNoErr(t, err)
+
+	t.Log("Attempting to enable alarm policy")
+	_, err = oneclickalarms.BatchEnablePolicies(client, oneClickAlarmId, alarmRule.AlarmId, oneclickalarms.BatchEnablePoliciesOpts{
+		AlarmPolicyIds: []string{policy.AlarmPolicyId},
+		Enabled:        true,
+	})
+	th.AssertNoErr(t, err)
+
+	t.Log("Attempting to update notifications")
+	err = oneclickalarms.UpdateNotifications(client, oneClickAlarmId, oneclickalarms.UpdateNotificationsOpts{
+		NotificationEnabled:   false,
+		NotificationBeginTime: "00:00",
+		NotificationEndTime:   "23:59",
+	})
+	th.AssertNoErr(t, err)
+}

openstack/ces/v2/dashboards/BatchDelete.go

@@ -0,0 +1,47 @@
+package dashboards
+
+import (
+	golangsdk "github.com/opentelekomcloud/gophertelekomcloud"
+	"github.com/opentelekomcloud/gophertelekomcloud/internal/build"
+	"github.com/opentelekomcloud/gophertelekomcloud/internal/extract"
+)
+
+// BatchDeleteOpts contains the options for batch deleting dashboards.
+type BatchDeleteOpts struct {
+	// Specifies the list of dashboard IDs to delete.
+	// A maximum of 30 dashboard IDs are supported.
+	DashboardIds []string `json:"dashboard_ids,omitempty"`
+}
+
+// BatchDeleteResult represents the result of deleting a single dashboard.
+type BatchDeleteResult struct {
+	// Specifies the dashboard ID.
+	DashboardId string `json:"dashboard_id"`
+	// Specifies the deletion result.
+	// Possible values: successful, error
+	RetStatus string `json:"ret_status"`
+	// Specifies the error message if deletion failed.
+	ErrorMsg string `json:"error_msg,omitempty"`
+}
+
+// BatchDelete batch deletes dashboards.
+func BatchDelete(client *golangsdk.ServiceClient, opts BatchDeleteOpts) ([]BatchDeleteResult, error) {
+	b, err := build.RequestBody(opts, "")
+	if err != nil {
+		return nil, err
+	}
+
+	// POST /v2/{project_id}/dashboards/batch-delete
+	raw, err := client.Post(client.ServiceURL("dashboards", "batch-delete"), b, nil, &golangsdk.RequestOpts{
+		OkCodes: []int{200},
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	var res struct {
+		Dashboards []BatchDeleteResult `json:"dashboards"`
+	}
+	err = extract.Into(raw.Body, &res)
+	return res.Dashboards, err
+}

openstack/ces/v2/dashboards/Create.go

@@ -0,0 +1,48 @@
+package dashboards
+
+import (
+	golangsdk "github.com/opentelekomcloud/gophertelekomcloud"
+	"github.com/opentelekomcloud/gophertelekomcloud/internal/build"
+	"github.com/opentelekomcloud/gophertelekomcloud/internal/extract"
+)
+
+// CreateOpts contains the options for creating or copying a dashboard.
+type CreateOpts struct {
+	// Specifies the dashboard name.
+	// It can contain 1 to 128 characters.
+	// Only letters, digits, underscores (_), hyphens (-), and Chinese characters are allowed.
+	DashboardName string `json:"dashboard_name" required:"true"`
+	// Specifies the enterprise project ID.
+	// The value can be a UUID or "0".
+	EnterpriseId string `json:"enterprise_id,omitempty"`
+	// Specifies the dashboard ID to copy from.
+	// If this parameter is specified, the dashboard is copied.
+	// The value starts with "db" and is followed by 22 characters.
+	DashboardId string `json:"dashboard_id,omitempty"`
+	// Specifies how many graphs will be displayed in each row.
+	// Possible values: 0, 1, 2, 3. Default: 0
+	// 0 indicates auto layout.
+	RowWidgetNum *int `json:"row_widget_num,omitempty"`
+}
+
+// Create creates a new dashboard or copies an existing one.
+func Create(client *golangsdk.ServiceClient, opts CreateOpts) (string, error) {
+	b, err := build.RequestBody(opts, "")
+	if err != nil {
+		return "", err
+	}
+
+	// POST /v2/{project_id}/dashboards
+	raw, err := client.Post(client.ServiceURL("dashboards"), b, nil, &golangsdk.RequestOpts{
+		OkCodes: []int{201},
+	})
+	if err != nil {
+		return "", err
+	}
+
+	var res struct {
+		DashboardId string `json:"dashboard_id"`
+	}
+	err = extract.Into(raw.Body, &res)
+	return res.DashboardId, err
+}

openstack/ces/v2/dashboards/List.go

@@ -0,0 +1,66 @@
+package dashboards
+
+import (
+	golangsdk "github.com/opentelekomcloud/gophertelekomcloud"
+	"github.com/opentelekomcloud/gophertelekomcloud/internal/extract"
+)
+
+// ListOpts contains the options for querying dashboards.
+type ListOpts struct {
+	// Specifies whether to filter by favorite status.
+	// This parameter requires enterprise_id to be specified.
+	IsFavorite *bool `q:"is_favorite,omitempty"`
+	// Specifies the dashboard name for filtering.
+	// It can contain 1 to 128 characters.
+	DashboardName string `q:"dashboard_name,omitempty"`
+	// Specifies the dashboard ID for filtering.
+	// The value starts with "db" and is followed by 22 characters.
+	DashboardId string `q:"dashboard_id,omitempty"`
+	// Specifies the enterprise project ID.
+	EnterpriseId string `q:"enterprise_id,omitempty"`
+}
+
+// Dashboard represents a dashboard in the list response.
+type Dashboard struct {
+	// Specifies the dashboard ID.
+	DashboardId string `json:"dashboard_id"`
+	// Specifies the dashboard name.
+	DashboardName string `json:"dashboard_name"`
+	// Specifies the enterprise project ID.
+	EnterpriseId string `json:"enterprise_id"`
+	// Specifies the name of the user who created the dashboard.
+	CreatorName string `json:"creator_name"`
+	// Specifies the time when the dashboard was created.
+	// The value is a UNIX timestamp in milliseconds.
+	CreateTime int64 `json:"create_time"`
+	// Specifies how many graphs will be displayed in each row.
+	// Possible values: 0, 1, 2, 3. Default: 3
+	RowWidgetNum int `json:"row_widget_num"`
+	// Specifies whether the dashboard is a favorite.
+	IsFavorite bool `json:"is_favorite"`
+}
+
+// List queries dashboards.
+func List(client *golangsdk.ServiceClient, opts ListOpts) ([]Dashboard, error) {
+	url, err := golangsdk.NewURLBuilder().
+		WithEndpoints("dashboards").
+		WithQueryParams(&opts).
+		Build()
+	if err != nil {
+		return nil, err
+	}
+
+	// GET /v2/{project_id}/dashboards
+	raw, err := client.Get(client.ServiceURL(url.String()), nil, &golangsdk.RequestOpts{
+		MoreHeaders: map[string]string{"Content-Type": "application/json"},
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	var res struct {
+		Dashboards []Dashboard `json:"dashboards"`
+	}
+	err = extract.Into(raw.Body, &res)
+	return res.Dashboards, err
+}

openstack/ces/v2/dashboards/Update.go

@@ -0,0 +1,34 @@
+package dashboards
+
+import (
+	golangsdk "github.com/opentelekomcloud/gophertelekomcloud"
+	"github.com/opentelekomcloud/gophertelekomcloud/internal/build"
+)
+
+// UpdateOpts contains the options for modifying a dashboard.
+type UpdateOpts struct {
+	// Specifies the dashboard name.
+	// It can contain 1 to 128 characters.
+	// Only letters, digits, underscores (_), hyphens (-), and Chinese characters are allowed.
+	DashboardName string `json:"dashboard_name,omitempty"`
+	// Specifies whether the dashboard is a favorite.
+	IsFavorite *bool `json:"is_favorite,omitempty"`
+	// Specifies how many graphs will be displayed in each row.
+	// Possible values: 0, 1, 2, 3. Default: 3
+	// 0 indicates auto layout.
+	RowWidgetNum *int `json:"row_widget_num,omitempty"`
+}
+
+// Update modifies a dashboard.
+func Update(client *golangsdk.ServiceClient, dashboardId string, opts UpdateOpts) error {
+	b, err := build.RequestBody(opts, "")
+	if err != nil {
+		return err
+	}
+
+	// PUT /v2/{project_id}/dashboards/{dashboard_id}
+	_, err = client.Put(client.ServiceURL("dashboards", dashboardId), b, nil, &golangsdk.RequestOpts{
+		OkCodes: []int{204},
+	})
+	return err
+}