chore: migrate role api (#34)

* chore: migrate role api

* chore: improvement

* chore: update tests

* chore: update examples

* chore: update validation

* chore: update diags

* fix: lint

Author: ecmadao

api/client.go

@@ -36,13 +36,13 @@ type Client interface {
 
 	// Role
 	// CreateRole creates the role in the instance.
-	CreateRole(ctx context.Context, instanceID int, create *RoleUpsert) (*Role, error)
+	CreateRole(ctx context.Context, environmentID, instanceID string, create *RoleUpsert) (*Role, error)
 	// GetRole gets the role by instance id and role name.
-	GetRole(ctx context.Context, instanceID int, roleName string) (*Role, error)
+	GetRole(ctx context.Context, environmentID, instanceID, roleName string) (*Role, error)
 	// ListRole lists the role in instance.
-	ListRole(ctx context.Context, instanceID int) ([]*Role, error)
+	ListRole(ctx context.Context, environmentID, instanceID string) ([]*Role, error)
 	// UpdateRole updates the role in instance.
-	UpdateRole(ctx context.Context, instanceID int, roleName string, patch *RoleUpsert) (*Role, error)
+	UpdateRole(ctx context.Context, environmentID, instanceID, roleName string, patch *RoleUpsert) (*Role, error)
 	// DeleteRole deletes the role in the instance.
-	DeleteRole(ctx context.Context, instanceID int, roleName string) error
+	DeleteRole(ctx context.Context, environmentID, instanceID, roleName string) error
 }

api/database_role.go

@@ -14,15 +14,15 @@ type RoleAttribute struct {
 // Role is the API message for role.
 type Role struct {
 	Name            string         `json:"name"`
-	InstanceID      int            `json:"instanceId"`
+	Title           string         `json:"title"`
 	ConnectionLimit int            `json:"connectionLimit"`
 	ValidUntil      *string        `json:"validUntil"`
 	Attribute       *RoleAttribute `json:"attribute"`
 }
 
 // RoleUpsert is the API message for upserting a new role.
 type RoleUpsert struct {
-	Name            string         `json:"name"`
+	Title           string         `json:"title"`
 	Password        *string        `json:"password"`
 	ConnectionLimit *int           `json:"connectionLimit"`
 	ValidUntil      *string        `json:"validUntil"`

client/database_role.go

@@ -11,13 +11,13 @@ import (
 )
 
 // CreateRole creates the role in the instance.
-func (c *client) CreateRole(ctx context.Context, instanceID int, create *api.RoleUpsert) (*api.Role, error) {
+func (c *client) CreateRole(ctx context.Context, environmentID, instanceID string, create *api.RoleUpsert) (*api.Role, error) {
 	payload, err := json.Marshal(create)
 	if err != nil {
 		return nil, err
 	}
 
-	req, err := http.NewRequestWithContext(ctx, "POST", fmt.Sprintf("%s/instance/%d/role", c.HostURL, instanceID), strings.NewReader(string(payload)))
+	req, err := http.NewRequestWithContext(ctx, "POST", fmt.Sprintf("%s/environments/%s/instances/%s/roles", c.HostURL, environmentID, instanceID), strings.NewReader(string(payload)))
 	if err != nil {
 		return nil, err
 	}
@@ -37,8 +37,8 @@ func (c *client) CreateRole(ctx context.Context, instanceID int, create *api.Rol
 }
 
 // GetRole gets the role by instance id and role name.
-func (c *client) GetRole(ctx context.Context, instanceID int, roleName string) (*api.Role, error) {
-	req, err := http.NewRequestWithContext(ctx, "GET", fmt.Sprintf("%s/instance/%d/role/%s", c.HostURL, instanceID, roleName), nil)
+func (c *client) GetRole(ctx context.Context, environmentID, instanceID, roleName string) (*api.Role, error) {
+	req, err := http.NewRequestWithContext(ctx, "GET", fmt.Sprintf("%s/environments/%s/instances/%s/roles/%s", c.HostURL, environmentID, instanceID, roleName), nil)
 	if err != nil {
 		return nil, err
 	}
@@ -58,8 +58,8 @@ func (c *client) GetRole(ctx context.Context, instanceID int, roleName string) (
 }
 
 // ListRole lists the role in instance.
-func (c *client) ListRole(ctx context.Context, instanceID int) ([]*api.Role, error) {
-	req, err := http.NewRequestWithContext(ctx, "GET", fmt.Sprintf("%s/instance/%d/role", c.HostURL, instanceID), nil)
+func (c *client) ListRole(ctx context.Context, environmentID, instanceID string) ([]*api.Role, error) {
+	req, err := http.NewRequestWithContext(ctx, "GET", fmt.Sprintf("%s/environments/%s/instances/%s/roles", c.HostURL, environmentID, instanceID), nil)
 	if err != nil {
 		return nil, err
 	}
@@ -82,13 +82,30 @@ func (c *client) ListRole(ctx context.Context, instanceID int) ([]*api.Role, err
 }
 
 // UpdateRole updates the role in instance.
-func (c *client) UpdateRole(ctx context.Context, instanceID int, roleName string, patch *api.RoleUpsert) (*api.Role, error) {
+func (c *client) UpdateRole(ctx context.Context, environmentID, instanceID, roleName string, patch *api.RoleUpsert) (*api.Role, error) {
 	payload, err := json.Marshal(patch)
 	if err != nil {
 		return nil, err
 	}
 
-	req, err := http.NewRequestWithContext(ctx, "PATCH", fmt.Sprintf("%s/instance/%d/role/%s", c.HostURL, instanceID, roleName), strings.NewReader(string(payload)))
+	paths := []string{}
+	if patch.Title != roleName {
+		paths = append(paths, "role.title")
+	}
+	if patch.Password != nil {
+		paths = append(paths, "role.password")
+	}
+	if patch.ConnectionLimit != nil {
+		paths = append(paths, "role.connection_limit")
+	}
+	if patch.ValidUntil != nil {
+		paths = append(paths, "role.valid_until")
+	}
+	if patch.Attribute != nil {
+		paths = append(paths, "role.attribute")
+	}
+
+	req, err := http.NewRequestWithContext(ctx, "PATCH", fmt.Sprintf("%s/environments/%s/instances/%s/roles/%s?update_mask=%s", c.HostURL, environmentID, instanceID, roleName, strings.Join(paths, ",")), strings.NewReader(string(payload)))
 	if err != nil {
 		return nil, err
 	}
@@ -108,8 +125,8 @@ func (c *client) UpdateRole(ctx context.Context, instanceID int, roleName string
 }
 
 // DeleteRole deletes the role in the instance.
-func (c *client) DeleteRole(ctx context.Context, instanceID int, roleName string) error {
-	req, err := http.NewRequestWithContext(ctx, "DELETE", fmt.Sprintf("%s/instance/%d/role/%s", c.HostURL, instanceID, roleName), nil)
+func (c *client) DeleteRole(ctx context.Context, environmentID, instanceID, roleName string) error {
+	req, err := http.NewRequestWithContext(ctx, "DELETE", fmt.Sprintf("%s/environments/%s/instances/%s/roles/%s", c.HostURL, environmentID, instanceID, roleName), nil)
 	if err != nil {
 		return err
 	}

examples/instances/main.tf

@@ -29,7 +29,7 @@ locals {
 data "bytebase_instance_list" "all" {}
 
 output "all_instances" {
-  value = data.bytebase_instance_list.all.instances
+  value = data.bytebase_instance_list.all
 }
 
 # List all instances in dev environment
@@ -57,7 +57,6 @@ data "bytebase_instance" "prod" {
   environment = local.environment_id_prod
 }
 
-
 output "prod_instance" {
   value = data.bytebase_instance.prod
 }

examples/role/main.tf

@@ -18,19 +18,22 @@ provider "bytebase" {
 }
 
 locals {
-  role_name_dev     = "dev_role_test"
-  instance_name_dev = "dev_instance_test"
+  role_name_dev      = "dev_role_test"
+  instance_id_dev    = "dev-instance"
+  environment_id_dev = "dev"
 }
 
 # Find the instance
 data "bytebase_instance" "dev" {
-  name = local.instance_name_dev
+  resource_id = local.instance_id_dev
+  environment = local.environment_id_dev
 }
 
 # Find the role "dev_role_test" in the instance "dev_instance_test"
 data "bytebase_database_role" "dev" {
-  name     = local.role_name_dev
-  instance = data.bytebase_instance.dev.name
+  name        = local.role_name_dev
+  instance    = data.bytebase_instance.dev.resource_id
+  environment = data.bytebase_instance.dev.environment
 }
 
 output "dev_role" {
@@ -39,7 +42,8 @@ output "dev_role" {
 
 # List all roles in the instance "dev_instance_test"
 data "bytebase_database_role_list" "all" {
-  instance = data.bytebase_instance.dev.name
+  instance    = data.bytebase_instance.dev.resource_id
+  environment = data.bytebase_instance.dev.environment
 }
 
 output "list_role" {

examples/setup/main.tf

@@ -91,8 +91,10 @@ resource "bytebase_instance" "prod" {
 
 # Create a new role named "dev_role_test" in the instance "dev_instance_test"
 resource "bytebase_database_role" "dev" {
-  name             = local.role_name_dev
-  instance         = bytebase_instance.dev.name
+  name        = local.role_name_dev
+  instance    = bytebase_instance.dev.resource_id
+  environment = bytebase_instance.dev.environment
+
   password         = "123456"
   connection_limit = 10
   valid_until      = "2022-12-31T00:00:00+08:00"

provider/data_source_database_role.go

@@ -8,29 +8,31 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 
 	"github.com/bytebase/terraform-provider-bytebase/api"
+	"github.com/bytebase/terraform-provider-bytebase/provider/internal"
 )
 
 func dataSourceDatabaseRole() *schema.Resource {
 	return &schema.Resource{
 		Description: "The database role data source.",
 		ReadContext: dataSourceRoleRead,
 		Schema: map[string]*schema.Schema{
-			"id": {
-				Type:        schema.TypeString,
-				Computed:    true,
-				Description: "The database role id.",
-			},
 			"name": {
 				Type:         schema.TypeString,
 				Required:     true,
 				Description:  "The role unique name.",
 				ValidateFunc: validation.StringIsNotEmpty,
 			},
+			"environment": {
+				Type:         schema.TypeString,
+				Required:     true,
+				Description:  "The environment resource id.",
+				ValidateFunc: internal.ResourceIDValidation,
+			},
 			"instance": {
 				Type:         schema.TypeString,
 				Required:     true,
-				Description:  "The instance unique name.",
-				ValidateFunc: validation.StringIsNotEmpty,
+				Description:  "The instance resource id.",
+				ValidateFunc: internal.ResourceIDValidation,
 			},
 			"connection_limit": {
 				Type:        schema.TypeInt,
@@ -92,14 +94,12 @@ func dataSourceDatabaseRole() *schema.Resource {
 
 func dataSourceRoleRead(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
 	c := m.(api.Client)
-	roleName := d.Get("name").(string)
 
-	// TODO: migrate role api
-	role, err := c.GetRole(ctx, 0, roleName)
+	role, err := c.GetRole(ctx, d.Get("environment").(string), d.Get("instance").(string), d.Get("name").(string))
 	if err != nil {
 		return diag.FromErr(err)
 	}
 
-	d.SetId(getRoleIdentifier(role))
+	d.SetId(role.Name)
 	return setRole(d, role)
 }

provider/data_source_database_role_list.go

@@ -10,41 +10,37 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 
 	"github.com/bytebase/terraform-provider-bytebase/api"
+	"github.com/bytebase/terraform-provider-bytebase/provider/internal"
 )
 
 func dataSourceDatabaseRoleList() *schema.Resource {
 	return &schema.Resource{
 		Description: "The database role data source list.",
 		ReadContext: dataSourceRoleListRead,
 		Schema: map[string]*schema.Schema{
+			"environment": {
+				Type:         schema.TypeString,
+				Required:     true,
+				Description:  "The environment resource id.",
+				ValidateFunc: internal.ResourceIDValidation,
+			},
 			"instance": {
 				Type:         schema.TypeString,
 				Required:     true,
-				Description:  "The instance unique name.",
-				ValidateFunc: validation.StringIsNotEmpty,
+				Description:  "The instance resource id.",
+				ValidateFunc: internal.ResourceIDValidation,
 			},
 			"roles": {
 				Type:     schema.TypeList,
 				Computed: true,
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
-						"id": {
-							Type:        schema.TypeString,
-							Computed:    true,
-							Description: "The database role id.",
-						},
 						"name": {
 							Type:         schema.TypeString,
 							Required:     true,
 							Description:  "The role unique name.",
 							ValidateFunc: validation.StringIsNotEmpty,
 						},
-						"instance": {
-							Type:         schema.TypeString,
-							Required:     true,
-							Description:  "The instance unique name.",
-							ValidateFunc: validation.StringIsNotEmpty,
-						},
 						"connection_limit": {
 							Type:        schema.TypeInt,
 							Computed:    true,
@@ -109,20 +105,23 @@ func dataSourceDatabaseRoleList() *schema.Resource {
 func dataSourceRoleListRead(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
 	c := m.(api.Client)
 
-	instanceName := d.Get("instance").(string)
+	instanceID := d.Get("instance").(string)
+	environmentID := d.Get("environment").(string)
 
-	// TODO: migrate role api
-	roleList, err := c.ListRole(ctx, 0)
+	roleList, err := c.ListRole(ctx, environmentID, instanceID)
 	if err != nil {
 		return diag.FromErr(err)
 	}
 
 	roles := []map[string]interface{}{}
 	for _, raw := range roleList {
+		_, _, roleName, err := internal.GetEnvironmentInstanceRoleID(raw.Name)
+		if err != nil {
+			return diag.FromErr(err)
+		}
+
 		role := make(map[string]interface{})
-		role["id"] = getRoleIdentifier(raw)
-		role["name"] = raw.Name
-		role["instance"] = instanceName
+		role["name"] = roleName
 		role["connection_limit"] = raw.ConnectionLimit
 		role["valid_until"] = raw.ValidUntil
 

provider/data_source_database_role_list_test.go

@@ -0,0 +1,70 @@
+package provider
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+
+	"github.com/bytebase/terraform-provider-bytebase/provider/internal"
+)
+
+func TestAccDatabaseRoleListDataSource(t *testing.T) {
+	instanceName := "test-instance"
+	roleName := "test_role"
+	outputName := "role_list"
+	resourceName := fmt.Sprintf("data.bytebase_database_role_list.%s", outputName)
+
+	resource.Test(t, resource.TestCase{
+		PreCheck: func() {
+			testAccPreCheck(t)
+		},
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckRoleDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: fmt.Sprintf(`
+				%s
+
+				data "bytebase_database_role_list" "%s" {
+					instance    = bytebase_instance.%s.resource_id
+					environment = bytebase_instance.%s.environment
+				}
+				`, mockInstanceResource(instanceName), outputName, instanceName, instanceName),
+				Check: resource.ComposeTestCheckFunc(
+					internal.TestCheckResourceExists(resourceName),
+					resource.TestCheckResourceAttr(resourceName, "roles.#", "0"),
+				),
+			},
+			{
+				Config: fmt.Sprintf(`
+				%s
+
+				resource "bytebase_database_role" "%s" {
+					name        = "%s"
+					instance    = bytebase_instance.%s.resource_id
+					environment = bytebase_instance.%s.environment
+
+					attribute {}
+				}
+
+				data "bytebase_database_role_list" "%s" {
+					instance = bytebase_instance.%s.resource_id
+					environment = bytebase_instance.%s.environment
+
+					depends_on = [
+    					bytebase_database_role.%s
+  					]
+				}
+				`, mockInstanceResource(instanceName), roleName, roleName, instanceName, instanceName, outputName, instanceName, instanceName, roleName),
+				Check: resource.ComposeTestCheckFunc(
+					internal.TestCheckResourceExists(resourceName),
+					resource.TestCheckResourceAttr(resourceName, "roles.#", "1"),
+					resource.TestCheckResourceAttr(resourceName, "roles.0.name", roleName),
+					resource.TestCheckResourceAttr(resourceName, "roles.0.connection_limit", "-1"),
+					resource.TestCheckResourceAttr(resourceName, "roles.0.valid_until", ""),
+				),
+			},
+		},
+	})
+}