Merge pull request #3 from bytebase/feat/api

feat: support instance resource

Author: d-bytebase

.gitignore

@@ -0,0 +1,3 @@
+vendor
+examples/.terraform*
+examples/terraform.*

api/auth.go

@@ -1,6 +1,12 @@
 package api
 
-// AuthResponse is the API message for user login.
+// Login is the API message for user login.
+type Login struct {
+	Email    string `json:"email"`
+	Password string `json:"password"`
+}
+
+// AuthResponse is the API message for user login response.
 type AuthResponse struct {
 	UserID   int    `json:"userId"`
 	Username string `json:"username"`

api/instance.go

@@ -38,13 +38,13 @@ type InstanceCreate struct {
 // InstancePatch is the API message for patching an instance.
 type InstancePatch struct {
 	// Domain specific fields
-	Name         string `json:"name,omitempty"`
-	ExternalLink string `json:"externalLink,omitempty"`
-	Host         string `json:"host,omitempty"`
-	Port         string `json:"port,omitempty"`
+	Name         *string `json:"name,omitempty"`
+	ExternalLink *string `json:"externalLink,omitempty"`
+	Host         *string `json:"host,omitempty"`
+	Port         *string `json:"port,omitempty"`
 }
 
 // HasChange returns if the patch struct has the value to update.
 func (p *InstancePatch) HasChange() bool {
-	return p.Name != "" || p.ExternalLink != "" || p.Host != "" || p.Port != ""
+	return p.Name != nil || p.ExternalLink != nil || p.Host != nil || p.Port != nil
 }

client/client.go

@@ -17,12 +17,7 @@ type client struct {
 	HostURL    string
 	HTTPClient *http.Client
 	Token      string
-	Auth       *authStruct
-}
-
-type authStruct struct {
-	Email    string `json:"email"`
-	Password string `json:"password"`
+	Auth       *api.Login
 }
 
 // NewClient returns the new Bytebase API client.
@@ -32,7 +27,7 @@ func NewClient(url, email, password string) (api.Client, error) {
 		HostURL:    url,
 	}
 
-	c.Auth = &authStruct{
+	c.Auth = &api.Login{
 		Email:    email,
 		Password: password,
 	}

examples/main.tf

@@ -1,22 +1,25 @@
-# This is an example for using bytebase terraform provider to manage your resource.
+# This is an example for using Bytebase Terraform provider to manage your resource.
 # To run this provider in your local machine,
-# 1. Run your bytebase service, then you can access the OpenAPI via http://localhost:8080/v1
-# 2. Replace the email and password with your account
+# 1. Run your Bytebase service, then you can access the OpenAPI via http://localhost:8080/v1
+# 2. Replace the email and password with your own Bytebase account
 # 3. Run `make install` under terraform-provider-bytebase folder
-# 4. Run `terraform init` under terraform-provider-bytebase/examples folder
-# 5. Run terraform plan or terraform apply
+# 4. Run `cd examples && terraform init`
+# 5. Run `terraform plan` to check the changes
+# 6. Run `terraform apply` to apply the changes
+# 7. Run `terraform output` to find the outputs
+# 8. Run `terraform destory` to delete the test resources
 terraform {
   required_providers {
     bytebase = {
       version = "0.0.1"
-      # The source is only used in this local example.
+      # The source is only used in the local example.
       source = "registry.terraform.io/bytebase/bytebase"
     }
   }
 }
 
 provider "bytebase" {
-  # You need to replace the email and password with your own bytebase account.
+  # You need to replace the email and password with your own Bytebase account.
   email        = "[email protected]"
   password     = "ed"
   bytebase_url = "http://localhost:8080/v1"
@@ -25,9 +28,31 @@ provider "bytebase" {
 # Create a new environment named "dev"
 resource "bytebase_environment" "dev" {
   name = "dev"
+  # You can specific the environment order
+  # order = 1
 }
 
 # Print the new environment
 output "staging_environment" {
   value = bytebase_environment.dev
 }
+
+# Create a new instance named "dev instance"
+resource "bytebase_instance" "dev_instance" {
+  name        = "dev instance"
+  engine      = "POSTGRES"
+  host        = "127.0.0.1"
+  environment = bytebase_environment.dev.name
+  # You can also provide the port, username, password
+  # port = 5432
+  # username = "username"
+  # password = "password"
+}
+
+# Print the new instance
+output "dev_instance" {
+  value = bytebase_instance.dev_instance
+  # The password in instance is sensitive, so you cannot directly get its value from the output.
+  # But we can still print the instance via `terraform output -json dev_instance`
+  sensitive = true
+}

provider/internal/mock_client.go

@@ -76,16 +76,15 @@ func (c *mockClient) UpdateEnvironment(environmentID int, patch *api.Environment
 	}
 
 	if v := patch.Name; v != nil {
+		if existed := c.findEnvironmentByName(*v); existed != nil {
+			return nil, errors.Errorf("Environment %s already exists", env.Name)
+		}
 		env.Name = *v
 	}
 	if v := patch.Order; v != nil {
 		env.Order = *v
 	}
 
-	if existed := c.findEnvironmentByName(env.Name); existed != nil {
-		return nil, errors.Errorf("Environment %s already exists", env.Name)
-	}
-
 	delete(c.environmentMap, env.ID)
 	c.environmentMap[env.ID] = env
 
@@ -113,21 +112,58 @@ func (*mockClient) ListInstance() ([]*api.Instance, error) {
 }
 
 // CreateInstance creates the instance.
-func (*mockClient) CreateInstance(_ *api.InstanceCreate) (*api.Instance, error) {
-	return nil, errors.Errorf("CreateInstance is not implemented yet")
+func (c *mockClient) CreateInstance(create *api.InstanceCreate) (*api.Instance, error) {
+	ins := &api.Instance{
+		ID:           len(c.instanceMap) + 1,
+		Environment:  create.Environment,
+		Name:         create.Name,
+		Engine:       create.Engine,
+		ExternalLink: create.ExternalLink,
+		Host:         create.Host,
+		Port:         create.Port,
+		Username:     create.Username,
+	}
+
+	c.instanceMap[ins.ID] = ins
+	return ins, nil
 }
 
 // GetInstance gets the instance by id.
-func (*mockClient) GetInstance(_ int) (*api.Instance, error) {
-	return nil, errors.Errorf("GetInstance is not implemented yet")
+func (c *mockClient) GetInstance(instanceID int) (*api.Instance, error) {
+	ins, ok := c.instanceMap[instanceID]
+	if !ok {
+		return nil, errors.Errorf("Cannot found instance with ID %d", instanceID)
+	}
+
+	return ins, nil
 }
 
 // UpdateInstance updates the instance.
-func (*mockClient) UpdateInstance(_ int, _ *api.InstancePatch) (*api.Instance, error) {
-	return nil, errors.Errorf("UpdateInstance is not implemented yet")
+func (c *mockClient) UpdateInstance(instanceID int, patch *api.InstancePatch) (*api.Instance, error) {
+	ins, err := c.GetInstance(instanceID)
+	if err != nil {
+		return nil, err
+	}
+
+	if v := patch.Name; v != nil {
+		ins.Name = *v
+	}
+	if v := patch.ExternalLink; v != nil {
+		ins.ExternalLink = *v
+	}
+	if v := patch.Host; v != nil {
+		ins.Host = *v
+	}
+	if v := patch.Port; v != nil {
+		ins.Port = *v
+	}
+
+	c.instanceMap[instanceID] = ins
+	return ins, nil
 }
 
 // DeleteInstance deletes the instance.
-func (*mockClient) DeleteInstance(_ int) error {
-	return errors.Errorf("DeleteInstance is not implemented yet")
+func (c *mockClient) DeleteInstance(instanceID int) error {
+	delete(c.instanceMap, instanceID)
+	return nil
 }

provider/provider.go

@@ -35,6 +35,7 @@ func NewProvider() *schema.Provider {
 		DataSourcesMap:       map[string]*schema.Resource{},
 		ResourcesMap: map[string]*schema.Resource{
 			"bytebase_environment": resourceEnvironment(),
+			"bytebase_instance":    resourceInstance(),
 		},
 	}
 }

provider/resource_environment.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 
 	"github.com/bytebase/terraform-provider-bytebase/api"
 )
@@ -21,14 +22,17 @@ func resourceEnvironment() *schema.Resource {
 		},
 		Schema: map[string]*schema.Schema{
 			"name": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:         schema.TypeString,
+				Required:     true,
+				Description:  "The environment unique name.",
+				ValidateFunc: validation.StringIsNotEmpty,
 			},
 			"order": {
-				Type:     schema.TypeInt,
-				Optional: true,
-				Computed: true,
-				Default:  nil,
+				Type:        schema.TypeInt,
+				Optional:    true,
+				Computed:    true,
+				Default:     nil,
+				Description: "The environment sorting order.",
 			},
 		},
 	}

provider/resource_environment_test.go

@@ -2,6 +2,7 @@ package provider
 
 import (
 	"fmt"
+	"regexp"
 	"strconv"
 	"testing"
 
@@ -13,7 +14,12 @@ import (
 )
 
 func TestAccEnvironment(t *testing.T) {
-	envName := "dev"
+	identifier := "new_environment"
+	resourceName := fmt.Sprintf("bytebase_environment.%s", identifier)
+
+	name := "dev"
+	order := 1
+	nameUpdated := fmt.Sprintf("%s-updated", name)
 
 	resource.Test(t, resource.TestCase{
 		PreCheck: func() {
@@ -22,16 +28,47 @@ func TestAccEnvironment(t *testing.T) {
 		Providers:    testAccProviders,
 		CheckDestroy: testAccCheckEnvironmentDestroy,
 		Steps: []resource.TestStep{
+			// resource create
+			{
+				Config: testAccCheckEnvironmentConfigBasic(identifier, name, order),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckEnvironmentExists(resourceName),
+					resource.TestCheckResourceAttr(resourceName, "name", name),
+					resource.TestCheckResourceAttr(resourceName, "order", fmt.Sprintf("%d", order)),
+				),
+			},
+			// resource update
 			{
-				Config: testAccCheckEnvironmentConfigBasic(envName),
+				Config: testAccCheckEnvironmentConfigBasic(identifier, nameUpdated, order+1),
 				Check: resource.ComposeTestCheckFunc(
-					testAccCheckEnvironmentExists("bytebase_environment.new"),
+					testAccCheckEnvironmentExists(resourceName),
+					resource.TestCheckResourceAttr(resourceName, "name", nameUpdated),
+					resource.TestCheckResourceAttr(resourceName, "order", fmt.Sprintf("%d", order+1)),
 				),
 			},
 		},
 	})
 }
 
+func TestAccEnvironment_InvalidInput(t *testing.T) {
+	identifier := "another_environment"
+
+	resource.Test(t, resource.TestCase{
+		PreCheck: func() {
+			testAccPreCheck(t)
+		},
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckEnvironmentDestroy,
+		Steps: []resource.TestStep{
+			// Invalid environment name
+			{
+				Config:      testAccCheckEnvironmentConfigBasic(identifier, "", 0),
+				ExpectError: regexp.MustCompile("not be an empty string"),
+			},
+		},
+	})
+}
+
 func testAccCheckEnvironmentDestroy(s *terraform.State) error {
 	c := testAccProvider.Meta().(api.Client)
 
@@ -53,12 +90,13 @@ func testAccCheckEnvironmentDestroy(s *terraform.State) error {
 	return nil
 }
 
-func testAccCheckEnvironmentConfigBasic(envName string) string {
+func testAccCheckEnvironmentConfigBasic(identifier, envName string, order int) string {
 	return fmt.Sprintf(`
-	resource "bytebase_environment" "new" {
+	resource "bytebase_environment" "%s" {
 		name = "%s"
+		order = %d
 	}
-	`, envName)
+	`, identifier, envName, order)
 }
 
 func testAccCheckEnvironmentExists(n string) resource.TestCheckFunc {