chore: support single environment resource (#107)

ecmadao · web-flow · commit f64b0944efa3 · 2025-04-30T12:42:44.000+08:00
* chore: support single environment resource

* chore: update version
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.0.24
+3.6.0
diff --git a/examples/database/main.tf b/examples/database/main.tf
@@ -2,7 +2,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.24"
+      version = "3.6.0"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/environments/main.tf b/examples/environments/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.24"
+      version = "3.6.0"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
@@ -25,3 +25,11 @@ data "bytebase_setting" "environments" {
 output "all_environments" {
   value = data.bytebase_setting.environments
 }
+
+data "bytebase_environment" "prod" {
+  resource_id = "prod"
+}
+
+output "prod_environment" {
+  value = data.bytebase_environment.prod
+}
diff --git a/examples/groups/main.tf b/examples/groups/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.24"
+      version = "3.6.0"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/iamPolicy/main.tf b/examples/iamPolicy/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.24"
+      version = "3.6.0"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/instances/main.tf b/examples/instances/main.tf
@@ -2,7 +2,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.24"
+      version = "3.6.0"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/policies/main.tf b/examples/policies/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.24"
+      version = "3.6.0"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/projects/main.tf b/examples/projects/main.tf
@@ -2,7 +2,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.24"
+      version = "3.6.0"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/roles/main.tf b/examples/roles/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.24"
+      version = "3.6.0"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/settings/main.tf b/examples/settings/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.24"
+      version = "3.6.0"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/setup/environment.tf b/examples/setup/environment.tf
@@ -1,16 +1,38 @@
 resource "bytebase_setting" "environments" {
   name = "bb.workspace.environment"
   environment_setting {
-    environment {
-      id        = local.environment_id_test
-      title     = "Test"
-      protected = false
-    }
-
     environment {
       id        = local.environment_id_prod
       title     = "Prod"
       protected = true
     }
+
+    environment {
+      id        = local.environment_id_test
+      title     = "Test"
+      protected = false
+    }
   }
 }
+
+# Upsert test environment.
+resource "bytebase_environment" "test" {
+  depends_on = [
+    bytebase_setting.environments
+  ]
+  resource_id = local.environment_id_test
+  title       = "Staging" // rename to "Staging"
+  order       = 0         // change order to 0
+  protected   = false
+}
+
+# Upsert prod environment.
+resource "bytebase_environment" "prod" {
+  depends_on = [
+    bytebase_environment.test
+  ]
+  resource_id = local.environment_id_prod
+  title       = "Prod"
+  order       = 1 // change order to 1
+  protected   = true
+}
diff --git a/examples/setup/main.tf b/examples/setup/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.23"
+      version = "3.6.0"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/sql_review/main.tf b/examples/sql_review/main.tf
@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.24"
+      version = "3.6.0"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/examples/users/main.tf b/examples/users/main.tf
@@ -2,7 +2,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "1.0.24"
+      version = "3.6.0"
       # For local development, please use "terraform.local/bytebase/bytebase" instead
       source = "registry.terraform.io/bytebase/bytebase"
     }
diff --git a/provider/data_source_environment.go b/provider/data_source_environment.go
@@ -0,0 +1,66 @@
+package provider
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+
+	"github.com/bytebase/terraform-provider-bytebase/api"
+	"github.com/bytebase/terraform-provider-bytebase/provider/internal"
+)
+
+func dataSourceEnvironment() *schema.Resource {
+	return &schema.Resource{
+		Description: "The environment data source.",
+		ReadContext: dataSourceEnvironmentRead,
+		Schema: map[string]*schema.Schema{
+			"resource_id": {
+				Type:         schema.TypeString,
+				Required:     true,
+				ValidateFunc: internal.ResourceIDValidation,
+				Description:  "The environment unique resource id.",
+			},
+			"name": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The environment full name in environments/{resource id} format.",
+			},
+			"title": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The environment unique name.",
+			},
+			"order": {
+				Type:        schema.TypeInt,
+				Computed:    true,
+				Description: "The environment sorting order.",
+			},
+			"color": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "The environment color.",
+			},
+			"protected": {
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Description: "The environment is protected or not.",
+			},
+		},
+	}
+}
+
+func dataSourceEnvironmentRead(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
+	c := m.(api.Client)
+	environmentName := fmt.Sprintf("%s%s", internal.EnvironmentNamePrefix, d.Get("resource_id").(string))
+
+	env, order, _, err := findEnvironment(ctx, c, environmentName)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	d.SetId(env.Name)
+
+	return setEnvironment(d, env, order)
+}
diff --git a/provider/data_source_setting.go b/provider/data_source_setting.go
@@ -353,9 +353,10 @@ func getEnvironmentSetting(computed bool) *schema.Schema {
 								Description: "The environment readonly name in environments/{id} format.",
 							},
 							"title": {
-								Type:        schema.TypeString,
-								Required:    true,
-								Description: "The environment display name.",
+								Type:         schema.TypeString,
+								Required:     true,
+								ValidateFunc: validation.StringIsNotEmpty,
+								Description:  "The environment display name.",
 							},
 							"color": {
 								Type:        schema.TypeString,
diff --git a/provider/provider.go b/provider/provider.go
@@ -67,6 +67,7 @@ func NewProvider() *schema.Provider {
 			"bytebase_review_config":      dataSourceReviewConfig(),
 			"bytebase_review_config_list": dataSourceReviewConfigList(),
 			"bytebase_iam_policy":         dataSourceIAMPolicy(),
+			"bytebase_environment":        dataSourceEnvironment(),
 		},
 		ResourcesMap: map[string]*schema.Resource{
 			"bytebase_instance":      resourceInstance(),
@@ -79,6 +80,7 @@ func NewProvider() *schema.Provider {
 			"bytebase_database":      resourceDatabase(),
 			"bytebase_review_config": resourceReviewConfig(),
 			"bytebase_iam_policy":    resourceIAMPolicy(),
+			"bytebase_environment":   resourceEnvironment(),
 		},
 	}
 }
diff --git a/provider/resource_environment.go b/provider/resource_environment.go

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`terraform {`
`3`	`3`	`required_providers {`
`4`	`4`	`bytebase = {`
`5`		`- version = "1.0.24"`
	`5`	`+ version = "3.6.0"`
`6`	`6`	`# For local development, please use "terraform.local/bytebase/bytebase" instead`
`7`	`7`	`source = "registry.terraform.io/bytebase/bytebase"`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`terraform {`
`2`	`2`	`required_providers {`
`3`	`3`	`bytebase = {`
`4`		`- version = "1.0.24"`
	`4`	`+ version = "3.6.0"`
`5`	`5`	`# For local development, please use "terraform.local/bytebase/bytebase" instead`
`6`	`6`	`source = "registry.terraform.io/bytebase/bytebase"`
`7`	`7`	`}`