Merge pull request #12 from IvanOfThings/refactoring-code-improving-behavior-for-cluster-misuse

IvanOfThings · web-flow · commit 44fad614a565 · 2022-09-26T19:13:01.000+02:00
Refactoring code improving behavior for cluster misuse
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -116,7 +116,7 @@ jobs:
       timeout-minutes: 10
       env:
         TF_ACC: "1"
-        TF_CLICKHOUSE_URL: "127.0.0.1"
+        TF_CLICKHOUSE_HOST: "127.0.0.1"
         TF_CLICKHOUSE_USERNAME: "default"
         TF_CLICKHOUSE_PASSWORD: ""
         TF_CLICKHOUSE_PORT: "8123"
diff --git a/GNUmakefile b/GNUmakefile
@@ -1,17 +1,17 @@
 TEST?=$$(go list ./... | grep -v 'vendor')
 HOSTNAME=hashicorp.com
-NAMESPACE=edu
+NAMESPACE=ivanofthings
 NAME=clickhouse
 BINARY=terraform-provider-${NAME}
-VERSION=0.1.0
+VERSION=2.0.0
 OS_ARCH=linux_amd64
 
 default: testacc
 
 # Run acceptance tests
 .PHONY: testacc
 testacc:
-	TF_ACC=1 TF_CLICKHOUSE_URL="127.0.0.1" TF_CLICKHOUSE_USERNAME="default" TF_CLICKHOUSE_PASSWORD="" TF_CLICKHOUSE_PORT=8923 go test -tags testing ./... -v $(TESTARGS) -timeout 120m
+	TF_ACC=1 TF_CLICKHOUSE_HOST="127.0.0.1" TF_CLICKHOUSE_USERNAME="default" TF_CLICKHOUSE_PASSWORD="" TF_CLICKHOUSE_PORT=8923 go test -tags testing ./... -v $(TESTARGS) -timeout 120m
 
 build:
 	go build -o ${BINARY}
diff --git a/README.md b/README.md
@@ -45,7 +45,7 @@ Definining provider
 ```hcl
 provider "clickhouse" {
   port           = 8123
-  clickhouse_url = "127.0.0.1"
+  host           = "127.0.0.1"
   username       = "default"
   password       = ""
 }
@@ -56,13 +56,13 @@ In order to definte url, username and password in a safety way it is possible to
 ```config
 TF_CLICKHOUSE_USERNAME=default
 TF_CLICKHOUSE_PASSWORD=""
-TF_CLICKHOUSE_URL="127.0.0.1"
+TF_CLICKHOUSE_HOST="127.0.0.1"
 TF_CLICKHOUSE_PORT=8123
 ```
 
 ```hcl
 resource "clickhouse_db" "test_db_clusterd" {
-  db_name = "database_test_clustered"
+  name = "database_test_clustered"
   comment = "This is a test database"
 }
 ```
@@ -74,7 +74,7 @@ Configuring provider
 ```hcl
 provider "clickhouse" {
   port           = 8923
-  clickhouse_url = "127.0.0.1"
+  host           = "127.0.0.1"
   username       = "default"
   password       = ""
   default_cluster ="cluster"
@@ -85,7 +85,7 @@ Creating a Database
 
 ```hcl
 resource "clickhouse_db" "test_db_clusterd" {
-  db_name = "database_test_clustered"
+  name = "database_test_clustered"
   comment = "This is a test database"
   cluster = "cluster"
 }
@@ -98,7 +98,7 @@ I is possible to use macros defined for cluster, databases, installation names i
 ```hcl
 provider "clickhouse" {
   port           = 8123
-  clickhouse_url = "127.0.0.1"
+  host           = "127.0.0.1"
   username       = "default"
   password       = ""
   default_cluster ="'{cluster}'"
@@ -107,7 +107,7 @@ provider "clickhouse" {
 
 ```hcl
 resource "clickhouse_db" "test_db_clusterd" {
-  db_name = "database_test_clustered"
+  name = "database_test_clustered"
   comment = "This is a test database"
   cluster = "'{cluster}'"
 }
@@ -117,8 +117,8 @@ Creating tables
 
 ```hcl
 resource "clickhouse_table" "replicated_table" {
-  database      = clickhouse_db.test_db_clustered.db_name
-  table_name    = "replicated_table"
+  database      = clickhouse_db.test_db_clustered.name
+  name    = "replicated_table"
   cluster       = clickhouse_db.test_db_clustered.cluster
   engine        = "ReplicatedMergeTree"
   engine_params = ["'/clickhouse/{installation}/clickhouse_db.test_db_clustered.cluster/tables/{shard}/{database}/{table}'", "'{replica}'"]
@@ -150,11 +150,11 @@ resource "clickhouse_table" "replicated_table" {
 
 
 resource "clickhouse_table" "distributed_table" {
-  database      = clickhouse_db.test_db_clustered.db_name
-  table_name    = "distributed_table"
+  database      = clickhouse_db.test_db_clustered.name
+  name    = "distributed_table"
   cluster       = clickhouse_db.test_db_clustered.cluster
   engine        = "Distributed"
-  engine_params = [clickhouse_db.test_db_clustered.cluster, clickhouse_db.test_db_clustered.db_name, clickhouse_table.replicated_table.table_name, "rand()"]
+  engine_params = [clickhouse_db.test_db_clustered.cluster, clickhouse_db.test_db_clustered.name, clickhouse_table.replicated_table.name, "rand()"]
 }
 ```
 
diff --git a/docs/data-sources/dbs.md b/docs/data-sources/dbs.md
@@ -27,9 +27,9 @@ Read-Only:
 
 - `comment` (String)
 - `data_path` (String)
-- `db_name` (String)
 - `engine` (String)
 - `metadata_path` (String)
+- `name` (String)
 - `uuid` (String)
 
 
diff --git a/docs/index.md b/docs/index.md
@@ -16,8 +16,8 @@ description: |-
 terraform {
   required_providers {
     clickhouse = {
-      version = "0.1.0"
-      source  = "hashicorp.com/edu/clickhouse"
+      version = "2.0.0"
+      source  = "hashicorp.com/ivanofthings/clickhouse"
     }
   }
 }
@@ -36,8 +36,8 @@ provider "clickhouse" {
 
 ### Optional
 
-- `clickhouse_url` (String, Sensitive) Clickhouse server url
 - `default_cluster` (String) Default cluster, if provided will be used when no cluster is provided
+- `host` (String, Sensitive) Clickhouse server url
 - `password` (String, Sensitive) Clickhouse user password with admin privileges
 - `port` (Number) Clickhouse server port
 - `username` (String) Clickhouse username with admin privileges
diff --git a/docs/resources/db.md b/docs/resources/db.md
@@ -17,7 +17,7 @@ Resource to handle clickhouse databases.
 
 ### Required
 
-- `db_name` (String) Database name
+- `name` (String) Database name
 
 ### Optional
 
diff --git a/docs/resources/table.md b/docs/resources/table.md
@@ -20,7 +20,7 @@ Resource to manage tables
 - `database` (String) DB Name where the table will bellow
 - `engine` (String) Table engine type (Supported types so far: Distributed, ReplicatedReplacingMergeTree, ReplacingMergeTree)
 - `engine_params` (List of String) Engine params in case the engine type requires them
-- `table_name` (String) Table Name
+- `name` (String) Table Name
 
 ### Optional
 
diff --git a/examples/data-sources/clickhouse_dbs/main.tf b/examples/data-sources/clickhouse_dbs/main.tf
@@ -1,8 +1,8 @@
 terraform {
   required_providers {
     clickhouse = {
-      version = "0.1.0"
-      source  = "hashicorp.com/edu/clickhouse"
+      version = "2.0.0"
+      source  = "hashicorp.com/ivanofthings/clickhouse"
     }
   }
 }
diff --git a/examples/main.tf b/examples/main.tf
@@ -1,17 +1,17 @@
 terraform {
   required_providers {
     clickhouse = {
-      version = "0.1.0"
-      source  = "hashicorp.com/edu/clickhouse"
+      version = "2.0.0"
+      source  = "hashicorp.com/ivanofthings/clickhouse"
     }
   }
 }
 
 provider "clickhouse" {
-  port           = 8923
-  clickhouse_url = "127.0.0.1"
-  username       = "default"
-  password       = ""
+  port     = 8123
+  host     = "127.0.0.1"
+  username = "default"
+  password = ""
 }
 
 module "databases" {
diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -1,8 +1,8 @@
 terraform {
   required_providers {
     clickhouse = {
-      version = "0.1.0"
-      source  = "hashicorp.com/edu/clickhouse"
+      version = "2.0.0"
+      source  = "hashicorp.com/ivanofthings/clickhouse"
     }
   }
 }
diff --git a/examples/resources/clickhouse_db/main.tf b/examples/resources/clickhouse_db/main.tf
@@ -1,8 +1,8 @@
 terraform {
   required_providers {
     clickhouse = {
-      version = "0.1.0"
-      source  = "hashicorp.com/edu/clickhouse"
+      version = "2.0.0"
+      source  = "hashicorp.com/ivanofthings/clickhouse"
     }
   }
 }
@@ -11,19 +11,19 @@ provider "clickhouse" {
   port = 8123
 }
 
-/*
+
 resource "clickhouse_db" "test_db" {
-  db_name = "database_test_3"
+  name    = "database_test"
   comment = "This is a test database"
 }
-*/
+
 
 // '{cluster}' is tha way to refer cluster name using macros provided by altinity clickhouse ok8s operator for clickhouse
 // Should provide cluster name in case of using this into a clickhouse cluster
 // see: https://github.com/Altinity/clickhouse-operator/blob/master/docs/replication_setup.md
 resource "clickhouse_db" "test_db_clusterd" {
-  db_name = "database_test_clustered_2"
-  comment = "This is a test database"
+  name    = "clustered_test_database"
+  comment = "This is a culstered test database"
   cluster = "'{cluster}'"
 }
 
diff --git a/examples/resources/clickhouse_table/main.tf b/examples/resources/clickhouse_table/main.tf
@@ -1,8 +1,8 @@
 terraform {
   required_providers {
     clickhouse = {
-      version = "0.1.0"
-      source  = "hashicorp.com/edu/clickhouse"
+      version = "2.0.0"
+      source  = "hashicorp.com/ivanofthings/clickhouse"
     }
   }
 }
@@ -12,15 +12,15 @@ provider "clickhouse" {
 }
 
 resource "clickhouse_db" "test_db_clustered" {
-  db_name = "database_test_10"
-  comment = "This is a test database"
+  name    = "awesome_database"
+  comment = "This is an awesome database"
   cluster = "'{cluster}'"
 }
 
 
 resource "clickhouse_table" "replicated_table" {
-  database      = clickhouse_db.test_db_clustered.db_name
-  table_name    = "replicated_table"
+  database      = clickhouse_db.test_db_clustered.name
+  name          = "replicated_table"
   cluster       = "'{cluster}'"
   engine        = "ReplicatedMergeTree"
   engine_params = ["'/clickhouse/{installation}/{cluster}/tables/{shard}/{database}/{table}'", "'{replica}'"]
@@ -52,11 +52,15 @@ resource "clickhouse_table" "replicated_table" {
 
 
 resource "clickhouse_table" "distributed_table" {
-  database      = clickhouse_db.test_db_clustered.db_name
-  table_name    = "t1_dist_6"
-  cluster       = "'{cluster}'"
-  engine        = "Distributed"
-  engine_params = ["'{cluster}'", clickhouse_db.test_db_clustered.db_name, clickhouse_table.replicated_table.table_name, "rand()"]
+  database = clickhouse_db.test_db_clustered.name
+  name     = "distributed_table"
+  cluster  = "'{cluster}'"
+  engine   = "Distributed"
+  engine_params = [
+    "'{cluster}'",
+    clickhouse_db.test_db_clustered.name,
+    clickhouse_table.replicated_table.name,
+  "rand()"]
 }
 
 
diff --git a/main.go b/main.go
@@ -36,7 +36,7 @@ func main() {
 		Debug: debugMode,
 
 		// TODO: update this string with the full name of your provider as used in your configs
-		ProviderAddr: "registry.terraform.io/hashicorp/clickhouse",
+		ProviderAddr: "registry.terraform.io/ivanofthings/clickhouse",
 
 		ProviderFunc: provider.New(version),
 	}
diff --git a/pkg/common/db_sql_helpers.go b/pkg/common/db_sql_helpers.go
@@ -7,7 +7,7 @@ import (
 )
 
 type DataSourceDbsItem struct {
-	DbName       string `json:"db_name"`
+	DbName       string `json:"name"`
 	Engine       string `json:"engine"`
 	DataPath     string `json:"data_path"`
 	MetadataPath string `json:"metadata_path"`
diff --git a/pkg/common/sql_helpers.go b/pkg/common/sql_helpers.go
@@ -123,7 +123,7 @@ func GetResourceNamesOnDataBases(conn *ch.Conn, databaseName string) (resources
 func GetTables(conn *ch.Conn, data *CHDataBase, errors *[]error) []clickhouseTable {
 	var query string
 	if data != nil {
-		query = fmt.Sprintf("SELECT `database`, `name`, `engine_full`, `engine`, `comment` FROM system.tables where database = '%v' AND name = '%v'", data.Database, data.Table_name)
+		query = fmt.Sprintf("SELECT `database`, `name`, `engine_full`, `engine`, `comment` FROM system.tables where database = '%v' AND name = '%v'", data.Database, data.Name)
 	} else {
 		query = fmt.Sprintf("SELECT `database`, `name`, `engine_full`, `engine`, `comment` FROM system.tables")
 
@@ -140,14 +140,14 @@ func GetTables(conn *ch.Conn, data *CHDataBase, errors *[]error) []clickhouseTab
 		result := iter.Result
 
 		database := *toString(result, "database", errors)
-		name := *toString(result, "name", errors)
+		table_name := *toString(result, "name", errors)
 
 		var columns []clickhouseTablesColumn
-		columns = getColumns(conn, database, name, errors)
+		columns = getColumns(conn, database, table_name, errors)
 
 		table := clickhouseTable{
 			database:    database,
-			table_name:  name,
+			name:        table_name,
 			engine_full: *toString(result, "engine_full", errors),
 			engine:      *toString(result, "engine", errors),
 			comment:     *toString(result, "comment", errors),
diff --git a/pkg/common/table_mappers.go b/pkg/common/table_mappers.go
@@ -84,7 +84,7 @@ func MapTableToDatasource(table clickhouseTable) (*DataSourceCHTable, error) {
 
 	return &DataSourceCHTable{
 		Database:      table.database,
-		Table_name:    table.table_name,
+		Name:          table.name,
 		Engine_full:   table.engine_full,
 		Engine:        table.engine,
 		Cluster:       &cluster,
diff --git a/pkg/common/types.go b/pkg/common/types.go
@@ -37,16 +37,16 @@ type clickhouseTablesColumn struct {
 
 type clickhouseTable struct {
 	database    string
-	table_name  string
+	name        string
 	engine      string
 	engine_full string
 	comment     string
 	columns     []clickhouseTablesColumn
 }
 
 type CHDataBase struct {
-	Database   string
-	Table_name string
+	Database string
+	Name     string
 }
 
 type dataSourceClickhouseColumn struct {
@@ -56,7 +56,7 @@ type dataSourceClickhouseColumn struct {
 
 type DataSourceCHTable struct {
 	Database      string
-	Table_name    string
+	Name          string
 	Engine_full   string
 	Engine        string
 	Cluster       *string
diff --git a/pkg/datasources/data_source_dbs.go b/pkg/datasources/data_source_dbs.go
@@ -21,7 +21,7 @@ func DataSourceDbs() *schema.Resource {
 				Computed: true,
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
-						"db_name": &schema.Schema{
+						"name": &schema.Schema{
 							Description: "DB Name",
 							Type:        schema.TypeString,
 							Computed:    true,
diff --git a/pkg/datasources/data_source_dbs_acceptance_test.go b/pkg/datasources/data_source_dbs_acceptance_test.go
diff --git a/pkg/provider/provider.go b/pkg/provider/provider.go
diff --git a/pkg/resources/resource_db.go b/pkg/resources/resource_db.go
diff --git a/pkg/resources/resource_db_acceptance_test.go b/pkg/resources/resource_db_acceptance_test.go
diff --git a/pkg/resources/resource_table.go b/pkg/resources/resource_table.go
diff --git a/pkg/resources/resource_table_acceptance_test.go b/pkg/resources/resource_table_acceptance_test.go

Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,8 @@ description: \|-`
`16`	`16`	`terraform {`
`17`	`17`	`required_providers {`
`18`	`18`	`clickhouse = {`
`19`		`- version = "0.1.0"`
`20`		`- source = "hashicorp.com/edu/clickhouse"`
	`19`	`+ version = "2.0.0"`
	`20`	`+ source = "hashicorp.com/ivanofthings/clickhouse"`
`21`	`21`	`}`
`22`	`22`	`}`
`23`	`23`	`}`
`@@ -36,8 +36,8 @@ provider "clickhouse" {`
`36`	`36`
`37`	`37`	`### Optional`
`38`	`38`
`39`		-- `clickhouse_url` (String, Sensitive) Clickhouse server url
`40`	`39`	- `default_cluster` (String) Default cluster, if provided will be used when no cluster is provided
	`40`	+- `host` (String, Sensitive) Clickhouse server url
`41`	`41`	- `password` (String, Sensitive) Clickhouse user password with admin privileges
`42`	`42`	- `port` (Number) Clickhouse server port
`43`	`43`	- `username` (String) Clickhouse username with admin privileges
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`terraform {`
`2`	`2`	`required_providers {`
`3`	`3`	`clickhouse = {`
`4`		`- version = "0.1.0"`
`5`		`- source = "hashicorp.com/edu/clickhouse"`
	`4`	`+ version = "2.0.0"`
	`5`	`+ source = "hashicorp.com/ivanofthings/clickhouse"`
`6`	`6`	`}`
`7`	`7`	`}`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,17 +1,17 @@`
`1`	`1`	`terraform {`
`2`	`2`	`required_providers {`
`3`	`3`	`clickhouse = {`
`4`		`- version = "0.1.0"`
`5`		`- source = "hashicorp.com/edu/clickhouse"`
	`4`	`+ version = "2.0.0"`
	`5`	`+ source = "hashicorp.com/ivanofthings/clickhouse"`
`6`	`6`	`}`
`7`	`7`	`}`
`8`	`8`	`}`
`9`	`9`
`10`	`10`	`provider "clickhouse" {`
`11`		`- port = 8923`
`12`		`- clickhouse_url = "127.0.0.1"`
`13`		`- username = "default"`
`14`		`- password = ""`
	`11`	`+ port = 8123`
	`12`	`+ host = "127.0.0.1"`
	`13`	`+ username = "default"`
	`14`	`+ password = ""`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`module "databases" {`