chore: database role to instance role and role title to role name (#37)

d-bytebase · web-flow · commit 77a118e092c0 · 2023-01-08T10:01:29.000+08:00
* chore: database role to instance role and role title to role name

* chore: update
diff --git a/api/database_role.go b/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"`
-	Title           string         `json:"title"`
+	RoleName        string         `json:"roleName"`
 	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 {
-	Title           string         `json:"title"`
+	RoleName        string         `json:"roleName"`
 	Password        *string        `json:"password"`
 	ConnectionLimit *int           `json:"connectionLimit"`
 	ValidUntil      *string        `json:"validUntil"`
diff --git a/client/database_role.go b/client/database_role.go
@@ -89,8 +89,8 @@ func (c *client) UpdateRole(ctx context.Context, environmentID, instanceID, role
 	}
 
 	paths := []string{}
-	if patch.Title != roleName {
-		paths = append(paths, "role.title")
+	if patch.RoleName != roleName {
+		paths = append(paths, "role.role_name")
 	}
 	if patch.Password != nil {
 		paths = append(paths, "role.password")
diff --git a/docs/data-sources/instance_role.md b/docs/data-sources/instance_role.md
@@ -1,21 +1,21 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "bytebase_database_role Data Source - terraform-provider-bytebase"
+page_title: "bytebase_instance_role Data Source - terraform-provider-bytebase"
 subcategory: ""
 description: |-
-  The database role data source.
+  The instance role data source.
 ---
 
-# bytebase_database_role (Data Source)
+# bytebase_instance_role (Data Source)
 
 > Requires the Bytebase version > 1.9.1 or use the release-ci.
 
-The database role data source. You can get a single role in a specific instance through the `bytebase_database_role` data source.
+The instance role data source. You can get a single role in a specific instance through the `bytebase_instance_role` data source.
 
 ## Example Usage
 
 ```terraform
-data "bytebase_database_role" "find_role" {
+data "bytebase_instance_role" "find_role" {
   name        = "<role name>"
   instance    = "<the instance resource id>"
   environment = "<the environment resource id>"
diff --git a/docs/data-sources/instance_role_list.md b/docs/data-sources/instance_role_list.md
@@ -1,21 +1,21 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "bytebase_database_role_list Data Source - terraform-provider-bytebase"
+page_title: "bytebase_instance_role_list Data Source - terraform-provider-bytebase"
 subcategory: ""
 description: |-
-  The database role list data source.
+  The instance role list data source.
 ---
 
-# bytebase_database_role_list (Data Source)
+# bytebase_instance_role_list (Data Source)
 
 > Requires the Bytebase version > 1.9.1 or use the release-ci.
 
-The database role list data source. You can list roles in a specific instance through the `bytebase_database_role_list` data source.
+The instance role list data source. You can list roles in a specific instance through the `bytebase_instance_role_list` data source.
 
 ## Example Usage
 
 ```terraform
-data "bytebase_database_role_list" "list_role" {
+data "bytebase_instance_role_list" "list_role" {
   instance    = "<the instance resource id>"
   environment = "<the environment resource id>"
 }
@@ -37,4 +37,4 @@ data "bytebase_database_role_list" "list_role" {
 
 ### Nested Schema for `roles`
 
-See [Role Schema](https://registry.terraform.io/providers/bytebase/bytebase/latest/docs/data-sources/database_role#schema).
+See [Role Schema](https://registry.terraform.io/providers/bytebase/bytebase/latest/docs/data-sources/instance_role#schema).
diff --git a/docs/resources/instance_role.md b/docs/resources/instance_role.md
@@ -1,21 +1,21 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "bytebase_database_role Resource - terraform-provider-bytebase"
+page_title: "bytebase_instance_role Resource - terraform-provider-bytebase"
 subcategory: ""
 description: |-
-  The database role resource.
+  The instance role resource.
 ---
 
-# bytebase_database_role (Resource)
+# bytebase_instance_role (Resource)
 
 > Requires the Bytebase version > 1.9.1 or use the release-ci.
 
-Database role resource. You can read, create, update or delete a single role in a specific instance through `bytebase_database_role` resource.
+Instance role resource. You can read, create, update or delete a single role in a specific instance through `bytebase_instance_role` resource.
 
 ## Example Usage
 
 ```terraform
-resource "bytebase_database_role" "admin" {
+resource "bytebase_instance_role" "admin" {
   name             = "admin"
   instance         = "<the instance resource id>"
   environment      = "<the environment resource id>"
diff --git a/examples/README.md b/examples/README.md
@@ -5,7 +5,7 @@ Examples of using the Terraform Bytebase Provider to manage your resource:
 - [setup](./setup): Initialize the data.
 - [environments](./environments): Use the Bytebase provider to query the environment.
 - [instances](./instances): Use the Bytebase provider to query the instance.
-- [role](./role): Use the  Bytebase provider to manage database role in your instance.
+- [role](./role): Use the  Bytebase provider to manage instance role in your instance.
 
 To run this provider on your local machine:
 
diff --git a/examples/roles/README.md b/examples/roles/README.md
@@ -1,6 +1,6 @@
-# Example of database role resource
+# Example of instance role resource
 
-This is an example of using the Terraform Bytebase Provider to query the database role in a specific instance.
+This is an example of using the Terraform Bytebase Provider to query the instance role in a specific instance.
 
 You should replace the provider initial variables with your own and exec the [setup](../setup/) before running this example.
 
@@ -9,15 +9,15 @@ You should replace the provider initial variables with your own and exec the [se
 ## List roles
 
 ```terraform
-data "bytebase_database_role_list" "all" {
+data "bytebase_instance_role_list" "all" {
   instance = "<the instance name>"
 }
 ```
 
 ## Find role by name
 
 ```terraform
-data "bytebase_database_role" "dev" {
+data "bytebase_instance_role" "dev" {
   name     = "<the role name>"
   instance = "<the instance name>"
 }
diff --git a/examples/roles/main.tf b/examples/roles/main.tf
@@ -30,22 +30,22 @@ data "bytebase_instance" "test" {
 }
 
 # Find the role "role_test_terraform" in the instance "test-instance"
-data "bytebase_database_role" "test" {
+data "bytebase_instance_role" "test" {
   name        = local.role_name
   instance    = data.bytebase_instance.test.resource_id
   environment = data.bytebase_instance.test.environment
 }
 
 output "role" {
-  value = data.bytebase_database_role.test
+  value = data.bytebase_instance_role.test
 }
 
 # List all roles in the instance "test-instance"
-data "bytebase_database_role_list" "all" {
+data "bytebase_instance_role_list" "all" {
   instance    = data.bytebase_instance.test.resource_id
   environment = data.bytebase_instance.test.environment
 }
 
 output "list_role" {
-  value = data.bytebase_database_role_list.all
+  value = data.bytebase_instance_role_list.all
 }
diff --git a/examples/setup/main.tf b/examples/setup/main.tf
@@ -89,7 +89,7 @@ resource "bytebase_instance" "prod" {
 }
 
 # Create a new role named "role_test_terraform" in the instance "test-instance"
-resource "bytebase_database_role" "test" {
+resource "bytebase_instance_role" "test" {
   name        = local.role_name
   instance    = bytebase_instance.test.resource_id
   environment = bytebase_instance.test.environment
diff --git a/provider/data_source_database_role.go b/provider/data_source_database_role.go
@@ -11,9 +11,9 @@ import (
 	"github.com/bytebase/terraform-provider-bytebase/provider/internal"
 )
 
-func dataSourceDatabaseRole() *schema.Resource {
+func dataSourceInstanceRole() *schema.Resource {
 	return &schema.Resource{
-		Description: "The database role data source.",
+		Description: "The instance role data source.",
 		ReadContext: dataSourceRoleRead,
 		Schema: map[string]*schema.Schema{
 			"name": {
diff --git a/provider/data_source_database_role_list.go b/provider/data_source_database_role_list.go
@@ -13,9 +13,9 @@ import (
 	"github.com/bytebase/terraform-provider-bytebase/provider/internal"
 )
 
-func dataSourceDatabaseRoleList() *schema.Resource {
+func dataSourceInstanceRoleList() *schema.Resource {
 	return &schema.Resource{
-		Description: "The database role data source list.",
+		Description: "The instance role data source list.",
 		ReadContext: dataSourceRoleListRead,
 		Schema: map[string]*schema.Schema{
 			"environment": {
diff --git a/provider/data_source_database_role_list_test.go b/provider/data_source_database_role_list_test.go
@@ -9,11 +9,11 @@ import (
 	"github.com/bytebase/terraform-provider-bytebase/provider/internal"
 )
 
-func TestAccDatabaseRoleListDataSource(t *testing.T) {
+func TestAccInstanceRoleListDataSource(t *testing.T) {
 	instanceName := "test-instance"
 	roleName := "test_role"
 	outputName := "role_list"
-	resourceName := fmt.Sprintf("data.bytebase_database_role_list.%s", outputName)
+	resourceName := fmt.Sprintf("data.bytebase_instance_role_list.%s", outputName)
 
 	resource.Test(t, resource.TestCase{
 		PreCheck: func() {
@@ -26,7 +26,7 @@ func TestAccDatabaseRoleListDataSource(t *testing.T) {
 				Config: fmt.Sprintf(`
 				%s
 
-				data "bytebase_database_role_list" "%s" {
+				data "bytebase_instance_role_list" "%s" {
 					instance    = bytebase_instance.%s.resource_id
 					environment = bytebase_instance.%s.environment
 				}
@@ -40,20 +40,20 @@ func TestAccDatabaseRoleListDataSource(t *testing.T) {
 				Config: fmt.Sprintf(`
 				%s
 
-				resource "bytebase_database_role" "%s" {
+				resource "bytebase_instance_role" "%s" {
 					name        = "%s"
 					instance    = bytebase_instance.%s.resource_id
 					environment = bytebase_instance.%s.environment
 
 					attribute {}
 				}
 
-				data "bytebase_database_role_list" "%s" {
+				data "bytebase_instance_role_list" "%s" {
 					instance = bytebase_instance.%s.resource_id
 					environment = bytebase_instance.%s.environment
 
 					depends_on = [
-    					bytebase_database_role.%s
+    					bytebase_instance_role.%s
   					]
 				}
 				`, mockInstanceResource(instanceName), roleName, roleName, instanceName, instanceName, outputName, instanceName, instanceName, roleName),
diff --git a/provider/data_source_database_role_test.go b/provider/data_source_database_role_test.go
@@ -10,10 +10,10 @@ import (
 	"github.com/bytebase/terraform-provider-bytebase/provider/internal"
 )
 
-func TestAccDatabaseRoleDataSource(t *testing.T) {
+func TestAccInstanceRoleDataSource(t *testing.T) {
 	roleName := "test_role"
 	instanceName := "test-instance"
-	resourceName := fmt.Sprintf("data.bytebase_database_role.%s", roleName)
+	resourceName := fmt.Sprintf("data.bytebase_instance_role.%s", roleName)
 
 	resource.Test(t, resource.TestCase{
 		PreCheck: func() {
@@ -26,16 +26,16 @@ func TestAccDatabaseRoleDataSource(t *testing.T) {
 				Config: fmt.Sprintf(`
 				%s
 
-				resource "bytebase_database_role" "%s" {
+				resource "bytebase_instance_role" "%s" {
 					name        = "%s"
 					instance    = bytebase_instance.%s.resource_id
 					environment = bytebase_instance.%s.environment
 
 					attribute {}
 				}
 
-				data "bytebase_database_role" "%s" {
-					name        = bytebase_database_role.%s.name
+				data "bytebase_instance_role" "%s" {
+					name        = bytebase_instance_role.%s.name
 					instance    = bytebase_instance.%s.resource_id
 					environment = bytebase_instance.%s.environment
 				}
@@ -52,7 +52,7 @@ func TestAccDatabaseRoleDataSource(t *testing.T) {
 	})
 }
 
-func TestAccDatabaseRoleDataSource_RoleNotFound(t *testing.T) {
+func TestAccInstanceRoleDataSource_RoleNotFound(t *testing.T) {
 	roleName := "test_role"
 	instanceName := "test-instance"
 
@@ -67,7 +67,7 @@ func TestAccDatabaseRoleDataSource_RoleNotFound(t *testing.T) {
 				Config: fmt.Sprintf(`
 				%s
 
-				data "bytebase_database_role" "%s" {
+				data "bytebase_instance_role" "%s" {
 					name        = "%s"
 					instance    = bytebase_instance.%s.resource_id
 					environment = bytebase_instance.%s.environment
@@ -79,7 +79,7 @@ func TestAccDatabaseRoleDataSource_RoleNotFound(t *testing.T) {
 	})
 }
 
-func TestAccDatabaseRoleDataSource_InstanceNotFound(t *testing.T) {
+func TestAccInstanceRoleDataSource_InstanceNotFound(t *testing.T) {
 	roleName := "test_role"
 	instanceID := "test-instance"
 	environmentID := "test-environment"
@@ -93,7 +93,7 @@ func TestAccDatabaseRoleDataSource_InstanceNotFound(t *testing.T) {
 		Steps: []resource.TestStep{
 			{
 				Config: fmt.Sprintf(`
-				data "bytebase_database_role" "%s" {
+				data "bytebase_instance_role" "%s" {
 					name        = "%s"
 					instance    = "%s"
 					environment = "%s"
diff --git a/provider/internal/mock_client.go b/provider/internal/mock_client.go
@@ -235,15 +235,15 @@ func (c *mockClient) UndeleteInstance(ctx context.Context, environmentID, instan
 
 // CreateRole creates the role in the instance.
 func (c *mockClient) CreateRole(_ context.Context, environmentID, instanceID string, create *api.RoleUpsert) (*api.Role, error) {
-	id := getRoleMapID(environmentID, instanceID, create.Title)
+	id := getRoleMapID(environmentID, instanceID, create.RoleName)
 
 	if _, ok := c.roleMap[id]; ok {
-		return nil, errors.Errorf("Role %s already exists", create.Title)
+		return nil, errors.Errorf("Role %s already exists", create.RoleName)
 	}
 
 	role := &api.Role{
 		Name:            id,
-		Title:           create.Title,
+		RoleName:        create.RoleName,
 		ConnectionLimit: -1,
 		Attribute:       &api.RoleAttribute{},
 	}
@@ -292,8 +292,8 @@ func (c *mockClient) UpdateRole(ctx context.Context, environmentID, instanceID,
 	}
 
 	newRole := &api.Role{
-		Name:            getRoleMapID(environmentID, instanceID, patch.Title),
-		Title:           patch.Title,
+		Name:            getRoleMapID(environmentID, instanceID, patch.RoleName),
+		RoleName:        patch.RoleName,
 		ConnectionLimit: role.ConnectionLimit,
 		ValidUntil:      role.ValidUntil,
 		Attribute:       role.Attribute,
diff --git a/provider/provider.go b/provider/provider.go
@@ -53,13 +53,13 @@ func NewProvider() *schema.Provider {
 			"bytebase_instance_list":      dataSourceInstanceList(),
 			"bytebase_environment":        dataSourceEnvironment(),
 			"bytebase_environment_list":   dataSourceEnvironmentList(),
-			"bytebase_database_role":      dataSourceDatabaseRole(),
-			"bytebase_database_role_list": dataSourceDatabaseRoleList(),
+			"bytebase_instance_role":      dataSourceInstanceRole(),
+			"bytebase_instance_role_list": dataSourceInstanceRoleList(),
 		},
 		ResourcesMap: map[string]*schema.Resource{
 			"bytebase_environment":   resourceEnvironment(),
 			"bytebase_instance":      resourceInstance(),
-			"bytebase_database_role": resourceDatabaseRole(),
+			"bytebase_instance_role": resourceInstanceRole(),
 		},
 	}
 }
diff --git a/provider/resource_database_role.go b/provider/resource_database_role.go
diff --git a/provider/resource_database_role_test.go b/provider/resource_database_role_test.go

Original file line number	Diff line number	Diff line change
`@@ -89,8 +89,8 @@ func (c *client) UpdateRole(ctx context.Context, environmentID, instanceID, role`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`paths := []string{}`
`92`		`- if patch.Title != roleName {`
`93`		`- paths = append(paths, "role.title")`
	`92`	`+ if patch.RoleName != roleName {`
	`93`	`+ paths = append(paths, "role.role_name")`
`94`	`94`	`}`
`95`	`95`	`if patch.Password != nil {`
`96`	`96`	`paths = append(paths, "role.password")`
Original file line number	Diff line number	Diff line change
`@@ -30,22 +30,22 @@ data "bytebase_instance" "test" {`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`# Find the role "role_test_terraform" in the instance "test-instance"`
`33`		`-data "bytebase_database_role" "test" {`
	`33`	`+data "bytebase_instance_role" "test" {`
`34`	`34`	`name = local.role_name`
`35`	`35`	`instance = data.bytebase_instance.test.resource_id`
`36`	`36`	`environment = data.bytebase_instance.test.environment`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`output "role" {`
`40`		`- value = data.bytebase_database_role.test`
	`40`	`+ value = data.bytebase_instance_role.test`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`# List all roles in the instance "test-instance"`
`44`		`-data "bytebase_database_role_list" "all" {`
	`44`	`+data "bytebase_instance_role_list" "all" {`
`45`	`45`	`instance = data.bytebase_instance.test.resource_id`
`46`	`46`	`environment = data.bytebase_instance.test.environment`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`output "list_role" {`
`50`		`- value = data.bytebase_database_role_list.all`
	`50`	`+ value = data.bytebase_instance_role_list.all`
`51`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ resource "bytebase_instance" "prod" {`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`# Create a new role named "role_test_terraform" in the instance "test-instance"`
`92`		`-resource "bytebase_database_role" "test" {`
	`92`	`+resource "bytebase_instance_role" "test" {`
`93`	`93`	`name = local.role_name`
`94`	`94`	`instance = bytebase_instance.test.resource_id`
`95`	`95`	`environment = bytebase_instance.test.environment`