feat: support environment resource (#2)

Author: ecmadao

.github/workflows/tests.yml

@@ -42,6 +42,15 @@ jobs:
       - uses: actions/setup-go@v3
         with:
           go-version: 1.19
+      - uses: hashicorp/setup-terraform@v2
+        with:
+          terraform_version: '1.3.*'
+          terraform_wrapper: false
       - run: |
           go generate ./...
-          go test -v ./...
+          go test -v -cover ./...
+        env:
+          TF_ACC: '1'
+          BYTEBASE_USER_EMAIL: 'test_email'
+          BYTEBASE_USER_PASSWORD: 'test_pwd'
+          BYTEBASE_URL: 'test_url'

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "go.lintOnSave": "off",
+  "go.lintTool": "golangci-lint",
+  "go.buildTags": "mysql",
+  "gopls": {
+    "formatting.local": "github.com/bytebase/terraform-provider-bytebase"
+  }
+}

Makefile

@@ -0,0 +1,26 @@
+TEST?=$$(go list ./... | grep -v 'vendor')
+HOSTNAME=registry.terraform.io
+NAMESPACE=bytebase
+NAME=bytebase
+BINARY=terraform-provider-${NAMESPACE}
+VERSION=0.0.1
+OS_ARCH=darwin_amd64
+
+default: install
+
+build:
+	go build -o ${BINARY}
+
+release:
+	goreleaser release --rm-dist --snapshot --skip-publish  --skip-sign
+
+install: build
+	mkdir -p ~/.terraform.d/plugins/${HOSTNAME}/${NAMESPACE}/${NAME}/${VERSION}/${OS_ARCH}
+	mv ${BINARY} ~/.terraform.d/plugins/${HOSTNAME}/${NAMESPACE}/${NAME}/${VERSION}/${OS_ARCH}
+
+test:
+	go test -i $(TEST) || exit 1
+	echo $(TEST) | xargs -t -n4 go test $(TESTARGS) -timeout=30s -parallel=4
+
+testacc:
+	TF_ACC=1 go test $(TEST) -v $(TESTARGS) -timeout 120m

api/client.go

@@ -0,0 +1,32 @@
+package api
+
+// Client is the API message for Bytebase OpenAPI client.
+type Client interface {
+	// Auth
+	// Login will login the user and get the response.
+	Login() (*AuthResponse, error)
+
+	// Environment
+	// CreateEnvironment creates the environment.
+	CreateEnvironment(create *EnvironmentCreate) (*Environment, error)
+	// GetEnvironment gets the environment by id.
+	GetEnvironment(environmentID int) (*Environment, error)
+	// ListEnvironment finds all environments.
+	ListEnvironment() ([]*Environment, error)
+	// UpdateEnvironment updates the environment.
+	UpdateEnvironment(environmentID int, patch *EnvironmentPatch) (*Environment, error)
+	// DeleteEnvironment deletes the environment.
+	DeleteEnvironment(environmentID int) error
+
+	// Instance
+	// ListInstance will return all instances.
+	ListInstance() ([]*Instance, error)
+	// CreateInstance creates the instance.
+	CreateInstance(create *InstanceCreate) (*Instance, error)
+	// GetInstance gets the instance by id.
+	GetInstance(instanceID int) (*Instance, error)
+	// UpdateInstance updates the instance.
+	UpdateInstance(instanceID int, patch *InstancePatch) (*Instance, error)
+	// DeleteInstance deletes the instance.
+	DeleteInstance(instanceID int) error
+}

api/environment.go

@@ -13,12 +13,12 @@ type Environment struct {
 type EnvironmentCreate struct {
 	// Domain specific fields
 	Name  string `json:"name"`
-	Order *int   `json:"order"`
+	Order *int   `json:"order,omitempty"`
 }
 
 // EnvironmentPatch is the API message for patching an environment.
 type EnvironmentPatch struct {
 	// Domain specific fields
-	Name  string `json:"name,omitempty"`
-	Order int    `json:"order"`
+	Name  *string `json:"name,omitempty"`
+	Order *int    `json:"order,omitempty"`
 }

client/auth.go

@@ -12,7 +12,7 @@ import (
 )
 
 // Login will login the user and get the response.
-func (c *Client) Login() (*api.AuthResponse, error) {
+func (c *client) Login() (*api.AuthResponse, error) {
 	if c.Auth.Email == "" || c.Auth.Password == "" {
 		return nil, errors.Errorf("define username and password")
 	}

client/client.go

@@ -8,10 +8,12 @@ import (
 	"time"
 
 	"github.com/pkg/errors"
+
+	"github.com/bytebase/terraform-provider-bytebase/api"
 )
 
-// Client is the API message for Bytebase API client.
-type Client struct {
+// client is the API message for Bytebase API client.
+type client struct {
 	HostURL    string
 	HTTPClient *http.Client
 	Token      string
@@ -24,8 +26,8 @@ type authStruct struct {
 }
 
 // NewClient returns the new Bytebase API client.
-func NewClient(url, email, password string) (*Client, error) {
-	c := Client{
+func NewClient(url, email, password string) (api.Client, error) {
+	c := client{
 		HTTPClient: &http.Client{Timeout: 10 * time.Second},
 		HostURL:    url,
 	}
@@ -45,7 +47,7 @@ func NewClient(url, email, password string) (*Client, error) {
 	return &c, nil
 }
 
-func (c *Client) doRequest(req *http.Request) ([]byte, error) {
+func (c *client) doRequest(req *http.Request) ([]byte, error) {
 	req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", c.Token))
 
 	res, err := c.HTTPClient.Do(req)

client/environment.go

@@ -10,7 +10,7 @@ import (
 )
 
 // CreateEnvironment creates the environment.
-func (c *Client) CreateEnvironment(create *api.EnvironmentCreate) (*api.Environment, error) {
+func (c *client) CreateEnvironment(create *api.EnvironmentCreate) (*api.Environment, error) {
 	payload, err := json.Marshal(create)
 	if err != nil {
 		return nil, err
@@ -36,7 +36,7 @@ func (c *Client) CreateEnvironment(create *api.EnvironmentCreate) (*api.Environm
 }
 
 // GetEnvironment gets the environment by id.
-func (c *Client) GetEnvironment(environmentID int) (*api.Environment, error) {
+func (c *client) GetEnvironment(environmentID int) (*api.Environment, error) {
 	req, err := http.NewRequest("GET", fmt.Sprintf("%s/environment/%d", c.HostURL, environmentID), nil)
 	if err != nil {
 		return nil, err
@@ -57,7 +57,7 @@ func (c *Client) GetEnvironment(environmentID int) (*api.Environment, error) {
 }
 
 // ListEnvironment finds all environments.
-func (c *Client) ListEnvironment() ([]*api.Environment, error) {
+func (c *client) ListEnvironment() ([]*api.Environment, error) {
 	req, err := http.NewRequest("GET", fmt.Sprintf("%s/environment", c.HostURL), nil)
 	if err != nil {
 		return nil, err
@@ -78,7 +78,7 @@ func (c *Client) ListEnvironment() ([]*api.Environment, error) {
 }
 
 // UpdateEnvironment updates the environment.
-func (c *Client) UpdateEnvironment(environmentID int, patch *api.EnvironmentPatch) (*api.Environment, error) {
+func (c *client) UpdateEnvironment(environmentID int, patch *api.EnvironmentPatch) (*api.Environment, error) {
 	payload, err := json.Marshal(patch)
 	if err != nil {
 		return nil, err
@@ -104,7 +104,7 @@ func (c *Client) UpdateEnvironment(environmentID int, patch *api.EnvironmentPatc
 }
 
 // DeleteEnvironment deletes the environment.
-func (c *Client) DeleteEnvironment(environmentID int) error {
+func (c *client) DeleteEnvironment(environmentID int) error {
 	req, err := http.NewRequest("DELETE", fmt.Sprintf("%s/environment/%d", c.HostURL, environmentID), nil)
 	if err != nil {
 		return err

client/instance.go

@@ -10,7 +10,7 @@ import (
 )
 
 // ListInstance will return all instances.
-func (c *Client) ListInstance() ([]*api.Instance, error) {
+func (c *client) ListInstance() ([]*api.Instance, error) {
 	req, err := http.NewRequest("GET", fmt.Sprintf("%s/instance", c.HostURL), nil)
 	if err != nil {
 		return nil, err
@@ -31,7 +31,7 @@ func (c *Client) ListInstance() ([]*api.Instance, error) {
 }
 
 // CreateInstance creates the instance.
-func (c *Client) CreateInstance(create *api.InstanceCreate) (*api.Instance, error) {
+func (c *client) CreateInstance(create *api.InstanceCreate) (*api.Instance, error) {
 	payload, err := json.Marshal(create)
 	if err != nil {
 		return nil, err
@@ -57,7 +57,7 @@ func (c *Client) CreateInstance(create *api.InstanceCreate) (*api.Instance, erro
 }
 
 // GetInstance gets the instance by id.
-func (c *Client) GetInstance(instanceID int) (*api.Instance, error) {
+func (c *client) GetInstance(instanceID int) (*api.Instance, error) {
 	req, err := http.NewRequest("GET", fmt.Sprintf("%s/instance/%d", c.HostURL, instanceID), nil)
 	if err != nil {
 		return nil, err
@@ -78,7 +78,7 @@ func (c *Client) GetInstance(instanceID int) (*api.Instance, error) {
 }
 
 // UpdateInstance updates the instance.
-func (c *Client) UpdateInstance(instanceID int, patch *api.InstancePatch) (*api.Instance, error) {
+func (c *client) UpdateInstance(instanceID int, patch *api.InstancePatch) (*api.Instance, error) {
 	payload, err := json.Marshal(patch)
 	if err != nil {
 		return nil, err
@@ -104,7 +104,7 @@ func (c *Client) UpdateInstance(instanceID int, patch *api.InstancePatch) (*api.
 }
 
 // DeleteInstance deletes the instance.
-func (c *Client) DeleteInstance(instanceID int) error {
+func (c *client) DeleteInstance(instanceID int) error {
 	req, err := http.NewRequest("DELETE", fmt.Sprintf("%s/instance/%d", c.HostURL, instanceID), nil)
 	if err != nil {
 		return err

examples/main.tf

@@ -0,0 +1,33 @@
+# 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
+# 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
+terraform {
+  required_providers {
+    bytebase = {
+      version = "0.0.1"
+      # The source is only used in this local example.
+      source = "registry.terraform.io/bytebase/bytebase"
+    }
+  }
+}
+
+provider "bytebase" {
+  # You need to replace the email and password with your own bytebase account.
+  email        = "[email protected]"
+  password     = "ed"
+  bytebase_url = "http://localhost:8080/v1"
+}
+
+# Create a new environment named "dev"
+resource "bytebase_environment" "dev" {
+  name = "dev"
+}
+
+# Print the new environment
+output "staging_environment" {
+  value = bytebase_environment.dev
+}