feat: Add num_partitions field in mongodbatlas_search_index #3982
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| ```release-note:enhancement | ||
| resource/mongodbatlas_search_index: Adds `num_partitions` attribute | ||
| ``` | ||
|
|
||
| ```release-note:enhancement | ||
| data-source/mongodbatlas_search_index: Adds `num_partitions` attribute | ||
| ``` | ||
|
|
||
| ```release-note:enhancement | ||
| data-source/mongodbatlas_search_indexes: Adds `num_partitions` attribute | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -52,5 +52,6 @@ data "mongodbatlas_search_indexes" "test" { | |
| * `type_sets` - Set of type set definitions (when present). Each item includes: | ||
| * `name` - Type set name. | ||
| * `types` - JSON array string describing the types for the set. | ||
| * `num_partitions` - Number of index partitions, returns 0 if not set in the resource | ||
|
There was a problem hiding this comment. The documentation states 'returns 0 if not set in the resource', but this phrasing is unclear as this is a data source, not a resource. Consider rephrasing to 'returns 0 if not configured' or 'returns 0 when not set' for clarity.
Collaborator
There was a problem hiding this comment. if default value is 1(it says so in the API docs), why we return 0? seems like an inconsistency in the API?
Collaborator
Author
There was a problem hiding this comment. @oarbusi We receive an integer pointer as nil. Since SDKv2 does not natively handle nil values, and our num_partitions field is of type integer, the field will default to an undefined integer value, equal to 0.
Collaborator
There was a problem hiding this comment. it makes sense considering the API bahavior. What I find confusing is the fact that we have a "default is 1" statement but then it "returns 0 when not set", which contradicts the default is 1 statement
Collaborator
Author
There was a problem hiding this comment. In Atlas, if this value is not explicitly set, it defaults to 1. However, this default value is not included in the response For example:
Collaborator
There was a problem hiding this comment. I still think it can be confusing, but good to resolve on my side
Collaborator
Author
There was a problem hiding this comment. I agree with you! Do you have any suggestions for rephrasing it? Or do you think we should remove the
Collaborator
There was a problem hiding this comment. it's a hard one, and I am not sure whether there's an easy solution/or clearer way of explaining this |
||
|
|
||
| For more information see: [MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/atlas-search/) - [and MongoDB Atlas API - Search](https://docs.atlas.mongodb.com/reference/api/atlas-search/) Documentation for more information. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -4,6 +4,7 @@ import ( | |||||
| "context" | ||||||
| "fmt" | ||||||
| "regexp" | ||||||
| "strconv" | ||||||
| "testing" | ||||||
|
|
||||||
| "github.com/hashicorp/terraform-plugin-testing/helper/resource" | ||||||
|
|
@@ -192,6 +193,57 @@ func TestAccSearchIndex_withVector(t *testing.T) { | |||||
| resource.ParallelTest(t, *basicVectorTestCase(t)) | ||||||
| } | ||||||
|
|
||||||
| func TestAccSearchIndex_withNumPartitions(t *testing.T) { | ||||||
| var ( | ||||||
| projectID, clusterName = acc.ClusterNameExecution(t, true) | ||||||
| indexName = acc.RandomName() | ||||||
| ) | ||||||
| resource.Test(t, resource.TestCase{ | ||||||
| PreCheck: func() { acc.PreCheckBasic(t) }, | ||||||
| ProtoV6ProviderFactories: acc.TestAccProviderV6Factories, | ||||||
| CheckDestroy: acc.CheckDestroySearchIndex, | ||||||
| Steps: []resource.TestStep{ | ||||||
| { | ||||||
| Config: configSearchWithNumPartitions(projectID, indexName, clusterName, nil), | ||||||
| Check: checkSearchWithNumPartitions(projectID, indexName, clusterName, nil), | ||||||
| }, | ||||||
| { | ||||||
| Config: configSearchWithNumPartitions(projectID, indexName, clusterName, conversion.IntPtr(2)), | ||||||
| Check: checkSearchWithNumPartitions(projectID, indexName, clusterName, conversion.IntPtr(2)), | ||||||
| }, | ||||||
| { | ||||||
| Config: configSearchWithNumPartitions(projectID, indexName, clusterName, nil), | ||||||
| Check: checkSearchWithNumPartitions(projectID, indexName, clusterName, nil), | ||||||
| }, | ||||||
| }, | ||||||
| }) | ||||||
| } | ||||||
|
|
||||||
| func TestAccVectorSearchIndex_withNumPartitions(t *testing.T) { | ||||||
| var ( | ||||||
| projectID, clusterName = acc.ClusterNameExecution(t, true) | ||||||
| indexName = acc.RandomName() | ||||||
| ) | ||||||
| resource.Test(t, resource.TestCase{ | ||||||
| PreCheck: func() { acc.PreCheckBasic(t) }, | ||||||
| ProtoV6ProviderFactories: acc.TestAccProviderV6Factories, | ||||||
| CheckDestroy: acc.CheckDestroySearchIndex, | ||||||
| Steps: []resource.TestStep{ | ||||||
| { | ||||||
| Config: configVectorSearchWithNumPartitions(projectID, indexName, clusterName, nil), | ||||||
| Check: checkVectorSearchWithNumPartitions(projectID, indexName, clusterName, nil), | ||||||
| }, | ||||||
| { | ||||||
| Config: configVectorSearchWithNumPartitions(projectID, indexName, clusterName, conversion.IntPtr(2)), | ||||||
| Check: checkVectorSearchWithNumPartitions(projectID, indexName, clusterName, conversion.IntPtr(2)), | ||||||
| }, | ||||||
| { | ||||||
| Config: configVectorSearchWithNumPartitions(projectID, indexName, clusterName, nil), | ||||||
| Check: checkVectorSearchWithNumPartitions(projectID, indexName, clusterName, nil), | ||||||
| }, | ||||||
| }, | ||||||
| }) | ||||||
| } | ||||||
| func basicTestCase(tb testing.TB) *resource.TestCase { | ||||||
| tb.Helper() | ||||||
| var ( | ||||||
|
|
@@ -372,7 +424,7 @@ func configBasic(projectID, clusterName, indexName, indexType, storedSource stri | |||||
| data "mongodbatlas_search_index" "data_index" { | ||||||
| cluster_name = mongodbatlas_search_index.test.cluster_name | ||||||
| project_id = mongodbatlas_search_index.test.project_id | ||||||
| index_id = mongodbatlas_search_index.test.index_id | ||||||
| } | ||||||
| `, clusterName, projectID, indexName, database, collection, searchAnalyzer, extra) | ||||||
| } | ||||||
|
|
@@ -409,7 +461,7 @@ func configWithMapping(projectID, indexName, clusterName string) string { | |||||
| data "mongodbatlas_search_index" "data_index" { | ||||||
| cluster_name = mongodbatlas_search_index.test.cluster_name | ||||||
| project_id = mongodbatlas_search_index.test.project_id | ||||||
| index_id = mongodbatlas_search_index.test.index_id | ||||||
| } | ||||||
| `, clusterName, projectID, indexName, database, collection, searchAnalyzer, analyzersTF, mappingsFieldsTF) | ||||||
| } | ||||||
|
|
@@ -451,7 +503,7 @@ func configWithSynonyms(projectID, indexName, clusterName string, has bool) stri | |||||
| data "mongodbatlas_search_index" "data_index" { | ||||||
| cluster_name = mongodbatlas_search_index.test.cluster_name | ||||||
| project_id = mongodbatlas_search_index.test.project_id | ||||||
| index_id = mongodbatlas_search_index.test.index_id | ||||||
| } | ||||||
| `, clusterName, projectID, indexName, database, collection, searchAnalyzer, synonymsStr) | ||||||
| } | ||||||
|
|
@@ -489,7 +541,7 @@ func configAdditional(projectID, indexName, clusterName, additional string) stri | |||||
| data "mongodbatlas_search_index" "data_index" { | ||||||
| cluster_name = mongodbatlas_search_index.test.cluster_name | ||||||
| project_id = mongodbatlas_search_index.test.project_id | ||||||
| index_id = mongodbatlas_search_index.test.index_id | ||||||
| } | ||||||
| `, clusterName, projectID, indexName, database, collection, searchAnalyzer, additional) | ||||||
| } | ||||||
|
|
@@ -533,11 +585,117 @@ func configVector(projectID, indexName, clusterName string) string { | |||||
| data "mongodbatlas_search_index" "data_index" { | ||||||
| cluster_name = mongodbatlas_search_index.test.cluster_name | ||||||
| project_id = mongodbatlas_search_index.test.project_id | ||||||
| index_id = mongodbatlas_search_index.test.index_id | ||||||
| } | ||||||
| `, clusterName, projectID, indexName, database, collection, fieldsJSON) | ||||||
| } | ||||||
|
|
||||||
| func configVectorSearchWithNumPartitions(projectID, indexName, clusterName string, numPartitions *int) string { | ||||||
| var numPartitionsLine string | ||||||
| hasNumPartitions := numPartitions != nil | ||||||
| if hasNumPartitions { | ||||||
| numPartitionsLine = fmt.Sprintf("num_partitions = %d", *numPartitions) | ||||||
| } | ||||||
| return fmt.Sprintf(` | ||||||
|
|
||||||
| resource "mongodbatlas_search_deployment" "test" { | ||||||
| cluster_name = %[1]q | ||||||
| project_id = %[2]q | ||||||
| specs = [ | ||||||
| { | ||||||
| instance_size = "S20_HIGHCPU_NVME" | ||||||
| node_count = 2 | ||||||
| } | ||||||
| ] | ||||||
| } | ||||||
|
|
||||||
| resource "mongodbatlas_search_index" "test" { | ||||||
| cluster_name = %[1]q | ||||||
| project_id = %[2]q | ||||||
| name = %[3]q | ||||||
| database = %[4]q | ||||||
| collection_name = %[5]q | ||||||
|
|
||||||
| type = "vectorSearch" | ||||||
| %[6]s | ||||||
| fields = <<-EOF | ||||||
| %[7]s | ||||||
| EOF | ||||||
|
|
||||||
| depends_on = [mongodbatlas_search_deployment.test] | ||||||
| } | ||||||
|
|
||||||
| data "mongodbatlas_search_index" "data_index" { | ||||||
| cluster_name = mongodbatlas_search_index.test.cluster_name | ||||||
| project_id = mongodbatlas_search_index.test.project_id | ||||||
| index_id = mongodbatlas_search_index.test.index_id | ||||||
| } | ||||||
| `, clusterName, projectID, indexName, database, collection, numPartitionsLine, fieldsJSON) | ||||||
| } | ||||||
| func configSearchWithNumPartitions(projectID, indexName, clusterName string, numPartitions *int) string { | ||||||
| var numPartitionsLine string | ||||||
| hasNumPartitions := numPartitions != nil | ||||||
| if hasNumPartitions { | ||||||
| numPartitionsLine = fmt.Sprintf("num_partitions = %d", *numPartitions) | ||||||
| } | ||||||
| return fmt.Sprintf(` | ||||||
|
|
||||||
| resource "mongodbatlas_search_deployment" "test" { | ||||||
| cluster_name = %[1]q | ||||||
| project_id = %[2]q | ||||||
| specs = [ | ||||||
| { | ||||||
| instance_size = "S20_HIGHCPU_NVME" | ||||||
| node_count = 2 | ||||||
| } | ||||||
| ] | ||||||
| } | ||||||
|
|
||||||
| resource "mongodbatlas_search_index" "test" { | ||||||
| cluster_name = %[1]q | ||||||
| project_id = %[2]q | ||||||
| name = %[3]q | ||||||
| database = %[4]q | ||||||
| collection_name = %[5]q | ||||||
| analyzer = "lucene.standard" | ||||||
| search_analyzer = "lucene.standard" | ||||||
| mappings_dynamic = true | ||||||
| type = "search" | ||||||
| %[6]s | ||||||
|
|
||||||
| depends_on = [mongodbatlas_search_deployment.test] | ||||||
|
There was a problem hiding this comment. Inconsistent indentation in the
Suggested change
|
||||||
| } | ||||||
|
|
||||||
| data "mongodbatlas_search_index" "data_index" { | ||||||
| cluster_name = mongodbatlas_search_index.test.cluster_name | ||||||
| project_id = mongodbatlas_search_index.test.project_id | ||||||
| index_id = mongodbatlas_search_index.test.index_id | ||||||
| } | ||||||
| `, clusterName, projectID, indexName, database, collection, numPartitionsLine) | ||||||
| } | ||||||
| func checkVectorSearchWithNumPartitions(projectID, indexName, clusterName string, numPartitions *int) resource.TestCheckFunc { | ||||||
| indexType := "vectorSearch" | ||||||
| mappingsDynamic := "true" | ||||||
| checks := []resource.TestCheckFunc{ | ||||||
| resource.TestCheckResourceAttrWith(resourceName, "fields", acc.JSONEquals(fieldsJSON)), | ||||||
| resource.TestCheckResourceAttrWith(datasourceName, "fields", acc.JSONEquals(fieldsJSON)), | ||||||
| } | ||||||
|
|
||||||
| if numPartitions != nil { | ||||||
| checks = append(checks, | ||||||
| resource.TestCheckResourceAttr(resourceName, "num_partitions", strconv.Itoa(*numPartitions)), | ||||||
| resource.TestCheckResourceAttr(datasourceName, "num_partitions", strconv.Itoa(*numPartitions)), | ||||||
| ) | ||||||
| } else { | ||||||
| checks = append(checks, | ||||||
| resource.TestCheckResourceAttr(resourceName, "num_partitions", "0"), | ||||||
| resource.TestCheckResourceAttr(datasourceName, "num_partitions", "0"), | ||||||
| ) | ||||||
| } | ||||||
|
|
||||||
| return checkAggr(projectID, clusterName, indexName, indexType, mappingsDynamic, checks...) | ||||||
| } | ||||||
|
|
||||||
| func checkVector(projectID, indexName, clusterName string) resource.TestCheckFunc { | ||||||
| indexType := "vectorSearch" | ||||||
| mappingsDynamic := "true" | ||||||
|
|
@@ -546,6 +704,30 @@ func checkVector(projectID, indexName, clusterName string) resource.TestCheckFun | |||||
| resource.TestCheckResourceAttrWith(datasourceName, "fields", acc.JSONEquals(fieldsJSON))) | ||||||
| } | ||||||
|
|
||||||
| func checkSearchWithNumPartitions(projectID, indexName, clusterName string, numPartitions *int) resource.TestCheckFunc { | ||||||
| indexType := "search" | ||||||
| mappingsDynamic := "true" | ||||||
| checks := []resource.TestCheckFunc{ | ||||||
| resource.TestCheckResourceAttr(resourceName, "analyzer", "lucene.standard"), | ||||||
| resource.TestCheckResourceAttr(resourceName, "search_analyzer", "lucene.standard"), | ||||||
| resource.TestCheckResourceAttr(datasourceName, "analyzer", "lucene.standard"), | ||||||
| resource.TestCheckResourceAttr(datasourceName, "search_analyzer", "lucene.standard"), | ||||||
| } | ||||||
|
|
||||||
| if numPartitions != nil { | ||||||
| checks = append(checks, | ||||||
| resource.TestCheckResourceAttr(resourceName, "num_partitions", strconv.Itoa(*numPartitions)), | ||||||
| resource.TestCheckResourceAttr(datasourceName, "num_partitions", strconv.Itoa(*numPartitions)), | ||||||
| ) | ||||||
| } else { | ||||||
| checks = append(checks, | ||||||
| resource.TestCheckResourceAttr(resourceName, "num_partitions", "0"), | ||||||
| resource.TestCheckResourceAttr(datasourceName, "num_partitions", "0"), | ||||||
| ) | ||||||
| } | ||||||
| return checkAggr(projectID, clusterName, indexName, indexType, mappingsDynamic, checks...) | ||||||
| } | ||||||
|
|
||||||
| func importStateIDFunc(resourceName string) resource.ImportStateIdFunc { | ||||||
| return func(s *terraform.State) (string, error) { | ||||||
| rs, ok := s.RootModule().Resources[resourceName] | ||||||
|
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation states 'returns 0 if not set in the resource', but this phrasing is unclear as this is a data source, not a resource. Consider rephrasing to 'returns 0 if not configured' or 'returns 0 when not set' for clarity.