docs: require dev-url for schema data sources (#126)

* docs: require dev-url for schema data sources * docs: fix ci * docs: remove dev_db_url
ariga · Mar 21, 2024 · 547b653 · 547b653
1 parent 95cbb7b
commit 547b653
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -46,7 +46,7 @@ provider "atlas" {
 
 2\. Then, inspect the schema of the database:
 ```shell
-atlas schema inspect -d "mysql://root:pass@localhost:3306/example" > schema.hcl
+atlas schema inspect -u "mysql://root:pass@localhost:3306/example" > schema.hcl
 ```
 
 3\. Finally, configure the terraform resource to apply the state to your database:

diff --git a/docs/data-sources/schema.md b/docs/data-sources/schema.md
@@ -39,12 +39,11 @@ resource "atlas_schema" "hello" {
 
 ### Required
 
+- `dev_url` (String, Sensitive) The url of the dev-db see https://atlasgo.io/cli/url
 - `src` (String) The schema definition of the database. This attribute can be HCL schema or an URL to HCL/SQL file.
 
 ### Optional
 
-- `dev_db_url` (String, Sensitive, Deprecated) Use `dev_url` instead.
-- `dev_url` (String, Sensitive) The url of the dev-db see https://atlasgo.io/cli/url
 - `variables` (Map of String) The map of variables used in the HCL.
 
 ### Read-Only

diff --git a/docs/resources/schema.md b/docs/resources/schema.md
@@ -34,7 +34,6 @@ resource "atlas_schema" "market" {
 
 ### Optional
 
-- `dev_db_url` (String, Sensitive, Deprecated) Use `dev_url` instead.
 - `dev_url` (String, Sensitive) The url of the dev-db see https://atlasgo.io/cli/url
 - `diff` (Block, Optional) (see [below for nested schema](#nestedblock--diff))
 - `exclude` (List of String) Filter out resources matching the given glob pattern. See https://atlasgo.io/declarative/inspect#exclude-schemas

diff --git a/internal/provider/atlas_schema_data_source.go b/internal/provider/atlas_schema_data_source.go
@@ -27,8 +27,6 @@ type (
 		HCL       types.String `tfsdk:"hcl"`
 		ID        types.String `tfsdk:"id"`
 		Variables types.Map    `tfsdk:"variables"`
-
-		DeprecatedDevURL types.String `tfsdk:"dev_db_url"`
 	}
 )
 
@@ -58,7 +56,7 @@ func (d *AtlasSchemaDataSource) Schema(_ context.Context, _ datasource.SchemaReq
 		Attributes: map[string]schema.Attribute{
 			"dev_url": schema.StringAttribute{
 				Description: "The url of the dev-db see https://atlasgo.io/cli/url",
-				Optional:    true,
+				Required:    true,
 				Sensitive:   true,
 			},
 			"src": schema.StringAttribute{
@@ -79,14 +77,6 @@ func (d *AtlasSchemaDataSource) Schema(_ context.Context, _ datasource.SchemaReq
 				Optional:    true,
 				ElementType: types.StringType,
 			},
-
-			"dev_db_url": schema.StringAttribute{
-				Description: "Use `dev_url` instead.",
-				Optional:    true,
-				Sensitive:   true,
-				DeprecationMessage: "This attribute is deprecated and will be removed in the next major version. " +
-					"Please use the `dev_url` attribute instead.",
-			},
 		},
 	}
 }
@@ -146,7 +136,7 @@ func (d *AtlasSchemaDataSource) Read(ctx context.Context, req datasource.ReadReq
 		}
 	}
 	normalHCL, err := d.client.SchemaInspect(ctx, &atlas.SchemaInspectParams{
-		DevURL: d.getDevURL(data.DevURL, data.DeprecatedDevURL),
+		DevURL: d.getDevURL(data.DevURL),
 		Format: "hcl",
 		URL:    src,
 		Vars:   vars,

diff --git a/internal/provider/atlas_schema_data_source_test.go b/internal/provider/atlas_schema_data_source_test.go
@@ -54,7 +54,7 @@ func TestAccSchemaDataSource(t *testing.T) {
 			// Read testing
 			{
 				Config: fmt.Sprintf(`data "atlas_schema" "market" {
-					dev_db_url = "mysql://root:pass@localhost:3307/test"
+					dev_url = "mysql://root:pass@localhost:3307/test"
 					variables = {
 						tenant = "test",
 					}
@@ -76,7 +76,7 @@ func TestAccSchemaDataSource(t *testing.T) {
 			// Read testing
 			{
 				Config: `data "atlas_schema" "market" {
-					dev_db_url = "mysql://root:pass@localhost:3307/test"
+					dev_url = "mysql://root:pass@localhost:3307/test"
 					src = ""
 				}`,
 				Check: resource.ComposeAggregateTestCheckFunc(
@@ -117,6 +117,7 @@ func TestAccSchemaDataSource(t *testing.T) {
 				}
 				data "atlas_schema" "hello" {
 					src = "file://./sql-files/schema.sql"
+					dev_url = "mysql://root:pass@localhost:3307/test"
 				}`,
 				Check: resource.ComposeAggregateTestCheckFunc(
 					resource.TestCheckResourceAttr("data.atlas_schema.hello", "hcl", normalHCL),

diff --git a/internal/provider/atlas_schema_resource.go b/internal/provider/atlas_schema_resource.go
@@ -35,8 +35,6 @@ type (
 		TxMode  types.String `tfsdk:"tx_mode"`
 		// Policies
 		Diff *Diff `tfsdk:"diff"`
-
-		DeprecatedDevURL types.String `tfsdk:"dev_db_url"`
 	}
 	// Diff defines the diff policies to apply when planning schema changes.
 	Diff struct {
@@ -174,13 +172,6 @@ func (r *AtlasSchemaResource) Schema(ctx context.Context, _ resource.SchemaReque
 					stringplanmodifier.UseStateForUnknown(),
 				},
 			},
-			"dev_db_url": schema.StringAttribute{
-				Description: "Use `dev_url` instead.",
-				Optional:    true,
-				Sensitive:   true,
-				DeprecationMessage: "This attribute is deprecated and will be removed in the next major version. " +
-					"Please use the `dev_url` attribute instead.",
-			},
 		},
 	}
 }
@@ -306,7 +297,7 @@ func (r *AtlasSchemaResource) ModifyPlan(ctx context.Context, req resource.Modif
 			return
 		}
 	}
-	resp.Diagnostics.Append(PrintPlanSQL(ctx, r.client, r.getDevURL(plan.DevURL, plan.DeprecatedDevURL), plan)...)
+	resp.Diagnostics.Append(PrintPlanSQL(ctx, r.client, r.getDevURL(plan.DevURL), plan)...)
 }
 
 func PrintPlanSQL(ctx context.Context, c *atlas.Client, devURL string, data *AtlasSchemaResourceModel) (diags diag.Diagnostics) {
@@ -385,7 +376,7 @@ func (r *AtlasSchemaResource) applySchema(ctx context.Context, data *AtlasSchema
 	}
 	d := &schemaData{
 		URL:    u,
-		DevURL: r.getDevURL(data.DevURL, data.DeprecatedDevURL),
+		DevURL: r.getDevURL(data.DevURL),
 		Source: "schema.hcl",
 		Diff:   data.Diff,
 	}

diff --git a/internal/provider/atlas_schema_resource_test.go b/internal/provider/atlas_schema_resource_test.go
@@ -33,7 +33,7 @@ resource "foo_mirror" "url" {
 	value = "%s"
 }
 data "atlas_schema" "market" {
-  dev_db_url = "%s"
+  dev_url = "%s"
   src = <<-EOT
 	schema "test" {
 		charset = "utf8mb4"
@@ -55,13 +55,13 @@ data "atlas_schema" "market" {
 resource "atlas_schema" "testdb" {
   hcl = data.atlas_schema.market.hcl
   url = foo_mirror.url.result
-  dev_db_url = "%s"
+  dev_url = "%s"
 }
 `, mysqlURL, mysqlDevURL, mysqlDevURL)
 
 	var testAccActionConfigUpdate = fmt.Sprintf(`
 data "atlas_schema" "market" {
-  dev_db_url = "%s"
+  dev_url = "%s"
   src = <<-EOT
 	schema "test" {
 		charset = "utf8mb4"
@@ -355,7 +355,7 @@ schema "test" {
 		}
 		testAccSanityT = `
 data "atlas_schema" "sanity" {
-  dev_db_url = "%s"
+  dev_url = "%s"
   src = <<-EOT
 	%s
 	EOT