chore: support approval flow (#78)

* refactor: use protocol api

* fix: go mod

* chore: update

* chore: update

* chore: go version

* fix: test

* chore: golang lint

* chore: support approval setting

* chore: support approval flow

* chore: update

* fix: go mod tidy

* fix: lint

* chore: update

* chore: update

* chore: update

* fix: lint

Author: ecmadao

.golangci.yaml

@@ -77,6 +77,8 @@ linters-settings:
         disabled: true
       - name: unchecked-type-assertion
         disabled: true
+      - name: redundant-import-alias
+        disabled: true
   gocritic:
     disabled-checks:
       - ifElseChain

VERSION

@@ -1 +1 @@
-1.0.2
+1.0.3

api/client.go

@@ -3,7 +3,8 @@ package api
 import (
 	"context"
 
-	v1pb "buf.build/gen/go/bytebase/bytebase/protocolbuffers/go/v1"
+	v1pb "github.com/bytebase/bytebase/proto/generated-go/v1"
+	v1alpha1 "google.golang.org/genproto/googleapis/api/expr/v1alpha1"
 )
 
 // Client is the API message for Bytebase OpenAPI client.
@@ -73,4 +74,16 @@ type Client interface {
 	DeleteProject(ctx context.Context, projectName string) error
 	// UndeleteProject undeletes the project.
 	UndeleteProject(ctx context.Context, projectName string) (*v1pb.Project, error)
+
+	// Setting
+	// ListSettings lists all settings.
+	ListSettings(ctx context.Context) (*v1pb.ListSettingsResponse, error)
+	// GetSetting gets the setting by the name.
+	GetSetting(ctx context.Context, settingName string) (*v1pb.Setting, error)
+	// UpsertSetting updates or creates the setting.
+	UpsertSetting(ctx context.Context, upsert *v1pb.Setting, updateMasks []string) (*v1pb.Setting, error)
+
+	// Cel
+	// ParseExpression parse the expression string.
+	ParseExpression(ctx context.Context, expression string) (*v1alpha1.Expr, error)
 }

api/setting.go

@@ -0,0 +1,51 @@
+package api
+
+// SettingName is the Bytebase setting name without settings/ prefix.
+type SettingName string
+
+const (
+	// SettingWorkspaceApproval is the setting name for workspace approval config.
+	SettingWorkspaceApproval SettingName = "bb.workspace.approval"
+	// SettingWorkspaceExternalApproval is the setting name for workspace external approval config.
+	SettingWorkspaceExternalApproval SettingName = "bb.workspace.approval.external"
+)
+
+// RiskLevel is the approval risk level.
+type RiskLevel string
+
+const (
+	// RiskLevelDefault is the default risk level, the level number should be 0.
+	RiskLevelDefault RiskLevel = "DEFAULT"
+	// RiskLevelLow is the low risk level, the level number should be 100.
+	RiskLevelLow RiskLevel = "LOW"
+	// RiskLevelModerate is the moderate risk level, the level number should be 200.
+	RiskLevelModerate RiskLevel = "MODERATE"
+	// RiskLevelHigh is the high risk level, the level number should be 300.
+	RiskLevelHigh RiskLevel = "HIGH"
+)
+
+// Int returns the int value for risk.
+func (r RiskLevel) Int() int {
+	switch r {
+	case RiskLevelLow:
+		return 100
+	case RiskLevelModerate:
+		return 200
+	case RiskLevelHigh:
+		return 300
+	default:
+		return 0
+	}
+}
+
+// ApprovalNodeType is the type for approval node.
+type ApprovalNodeType string
+
+const (
+	// ApprovalNodeTypeGroup means the approval node is a group.
+	ApprovalNodeTypeGroup ApprovalNodeType = "GROUP"
+	// ApprovalNodeTypeRole means the approval node is a role, the value should be role fullname.
+	ApprovalNodeTypeRole ApprovalNodeType = "ROLE"
+	// ApprovalNodeTypeExternalNodeID means the approval node is a external node, the value should be the node id.
+	ApprovalNodeTypeExternalNodeID ApprovalNodeType = "EXTERNAL_NODE"
+)

client/auth.go

@@ -8,7 +8,7 @@ import (
 	"github.com/pkg/errors"
 	"google.golang.org/protobuf/encoding/protojson"
 
-	v1pb "buf.build/gen/go/bytebase/bytebase/protocolbuffers/go/v1"
+	v1pb "github.com/bytebase/bytebase/proto/generated-go/v1"
 )
 
 // Login will login the user and get the response.

client/cel.go

@@ -0,0 +1,48 @@
+package client
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"strings"
+
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+
+	v1pb "github.com/bytebase/bytebase/proto/generated-go/v1"
+	"github.com/pkg/errors"
+	v1alpha1 "google.golang.org/genproto/googleapis/api/expr/v1alpha1"
+	"google.golang.org/protobuf/encoding/protojson"
+)
+
+// ParseExpression parse the expression string.
+func (c *client) ParseExpression(ctx context.Context, expression string) (*v1alpha1.Expr, error) {
+	payload, err := protojson.Marshal(&v1pb.BatchParseRequest{
+		Expressions: []string{expression},
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	req, err := http.NewRequestWithContext(ctx, "POST", fmt.Sprintf("%s/%s/cel/batchParse", c.url, c.version), strings.NewReader(string(payload)))
+	if err != nil {
+		return nil, err
+	}
+
+	body, err := c.doRequest(req)
+	if err != nil {
+		return nil, err
+	}
+
+	tflog.Debug(ctx, fmt.Sprintf("parse cel response:\n%v", string(body)))
+
+	var res v1pb.BatchParseResponse
+	if err := ProtojsonUnmarshaler.Unmarshal(body, &res); err != nil {
+		return nil, err
+	}
+
+	if len(res.Expressions) != 1 {
+		return nil, errors.Errorf("failed to parse the cel: %v", expression)
+	}
+
+	return res.GetExpressions()[0], nil
+}

client/client.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/pkg/errors"
 
-	v1pb "buf.build/gen/go/bytebase/bytebase/protocolbuffers/go/v1"
+	v1pb "github.com/bytebase/bytebase/proto/generated-go/v1"
 
 	"github.com/bytebase/terraform-provider-bytebase/api"
 )

client/database.go

@@ -7,7 +7,7 @@ import (
 	"net/url"
 	"strings"
 
-	v1pb "buf.build/gen/go/bytebase/bytebase/protocolbuffers/go/v1"
+	v1pb "github.com/bytebase/bytebase/proto/generated-go/v1"
 	"google.golang.org/protobuf/encoding/protojson"
 )
 
@@ -24,8 +24,7 @@ func (c *client) GetDatabase(ctx context.Context, databaseName string) (*v1pb.Da
 	}
 
 	var res v1pb.Database
-	err = ProtojsonUnmarshaler.Unmarshal(body, &res)
-	if err != nil {
+	if err := ProtojsonUnmarshaler.Unmarshal(body, &res); err != nil {
 		return nil, err
 	}
 
@@ -50,8 +49,7 @@ func (c *client) ListDatabase(ctx context.Context, instanceID, filter string) (*
 	}
 
 	var res v1pb.ListDatabasesResponse
-	err = ProtojsonUnmarshaler.Unmarshal(body, &res)
-	if err != nil {
+	if err := ProtojsonUnmarshaler.Unmarshal(body, &res); err != nil {
 		return nil, err
 	}
 
@@ -65,14 +63,6 @@ func (c *client) UpdateDatabase(ctx context.Context, patch *v1pb.Database, updat
 		return nil, err
 	}
 
-	// updateMask := []string{}
-	// if patch.Project != nil {
-	// 	updateMask = append(updateMask, "project")
-	// }
-	// if patch.Labels != nil {
-	// 	updateMask = append(updateMask, "labels")
-	// }
-
 	req, err := http.NewRequestWithContext(ctx, "PATCH", fmt.Sprintf("%s/%s/%s?update_mask=%s", c.url, c.version, patch.Name, strings.Join(updateMasks, ",")), strings.NewReader(string(payload)))
 	if err != nil {
 		return nil, err
@@ -84,8 +74,7 @@ func (c *client) UpdateDatabase(ctx context.Context, patch *v1pb.Database, updat
 	}
 
 	var res v1pb.Database
-	err = ProtojsonUnmarshaler.Unmarshal(body, &res)
-	if err != nil {
+	if err := ProtojsonUnmarshaler.Unmarshal(body, &res); err != nil {
 		return nil, err
 	}
 

client/environment.go

@@ -6,7 +6,7 @@ import (
 	"net/http"
 	"strings"
 
-	v1pb "buf.build/gen/go/bytebase/bytebase/protocolbuffers/go/v1"
+	v1pb "github.com/bytebase/bytebase/proto/generated-go/v1"
 	"google.golang.org/protobuf/encoding/protojson"
 )
 
@@ -28,8 +28,7 @@ func (c *client) CreateEnvironment(ctx context.Context, environmentID string, cr
 	}
 
 	var env v1pb.Environment
-	err = ProtojsonUnmarshaler.Unmarshal(body, &env)
-	if err != nil {
+	if err := ProtojsonUnmarshaler.Unmarshal(body, &env); err != nil {
 		return nil, err
 	}
 
@@ -49,8 +48,7 @@ func (c *client) GetEnvironment(ctx context.Context, environmentName string) (*v
 	}
 
 	var env v1pb.Environment
-	err = ProtojsonUnmarshaler.Unmarshal(body, &env)
-	if err != nil {
+	if err := ProtojsonUnmarshaler.Unmarshal(body, &env); err != nil {
 		return nil, err
 	}
 
@@ -70,8 +68,7 @@ func (c *client) ListEnvironment(ctx context.Context, showDeleted bool) (*v1pb.L
 	}
 
 	var res v1pb.ListEnvironmentsResponse
-	err = ProtojsonUnmarshaler.Unmarshal(body, &res)
-	if err != nil {
+	if err := ProtojsonUnmarshaler.Unmarshal(body, &res); err != nil {
 		return nil, err
 	}
 
@@ -96,8 +93,7 @@ func (c *client) UpdateEnvironment(ctx context.Context, patch *v1pb.Environment,
 	}
 
 	var env v1pb.Environment
-	err = ProtojsonUnmarshaler.Unmarshal(body, &env)
-	if err != nil {
+	if err := ProtojsonUnmarshaler.Unmarshal(body, &env); err != nil {
 		return nil, err
 	}
 
@@ -130,8 +126,7 @@ func (c *client) UndeleteEnvironment(ctx context.Context, environmentName string
 	}
 
 	var res v1pb.Environment
-	err = ProtojsonUnmarshaler.Unmarshal(body, &res)
-	if err != nil {
+	if err := ProtojsonUnmarshaler.Unmarshal(body, &res); err != nil {
 		return nil, err
 	}
 

client/instance.go

@@ -6,7 +6,7 @@ import (
 	"net/http"
 	"strings"
 
-	v1pb "buf.build/gen/go/bytebase/bytebase/protocolbuffers/go/v1"
+	v1pb "github.com/bytebase/bytebase/proto/generated-go/v1"
 	"google.golang.org/protobuf/encoding/protojson"
 )
 
@@ -23,8 +23,7 @@ func (c *client) ListInstance(ctx context.Context, showDeleted bool) (*v1pb.List
 	}
 
 	var res v1pb.ListInstancesResponse
-	err = ProtojsonUnmarshaler.Unmarshal(body, &res)
-	if err != nil {
+	if err := ProtojsonUnmarshaler.Unmarshal(body, &res); err != nil {
 		return nil, err
 	}
 
@@ -44,8 +43,7 @@ func (c *client) GetInstance(ctx context.Context, instanceName string) (*v1pb.In
 	}
 
 	var res v1pb.Instance
-	err = ProtojsonUnmarshaler.Unmarshal(body, &res)
-	if err != nil {
+	if err := ProtojsonUnmarshaler.Unmarshal(body, &res); err != nil {
 		return nil, err
 	}
 
@@ -71,8 +69,7 @@ func (c *client) CreateInstance(ctx context.Context, instanceID string, instance
 	}
 
 	var res v1pb.Instance
-	err = ProtojsonUnmarshaler.Unmarshal(body, &res)
-	if err != nil {
+	if err := ProtojsonUnmarshaler.Unmarshal(body, &res); err != nil {
 		return nil, err
 	}
 
@@ -98,8 +95,7 @@ func (c *client) UpdateInstance(ctx context.Context, patch *v1pb.Instance, updat
 	}
 
 	var res v1pb.Instance
-	err = ProtojsonUnmarshaler.Unmarshal(body, &res)
-	if err != nil {
+	if err := ProtojsonUnmarshaler.Unmarshal(body, &res); err != nil {
 		return nil, err
 	}
 
@@ -132,8 +128,7 @@ func (c *client) UndeleteInstance(ctx context.Context, instanceName string) (*v1
 	}
 
 	var res v1pb.Instance
-	err = ProtojsonUnmarshaler.Unmarshal(body, &res)
-	if err != nil {
+	if err := ProtojsonUnmarshaler.Unmarshal(body, &res); err != nil {
 		return nil, err
 	}