feat: Adds new mongodbatlas_control_plane_ip_addresses data source (#2331)

* initial scaffolding

* adds unit testing

* add changelog entry

* adding acceptance test

* add docs

* include acceptance test in CI

* add function to test cidr block

* refactor conversion function into common package

* include mention of new data source in migration guide

* adjust const to private

* fix links

* fix link

* change structure of test fixture to use a map

Author: AgustinBettati

.changelog/2331.txt

@@ -0,0 +1,3 @@
+```release-note:new-datasource
+mongodbatlas_control_plane_ip_addresses
+```

.github/workflows/acceptance-tests-runner.yml

@@ -187,6 +187,7 @@ jobs:
       search_index: ${{ steps.filter.outputs.search_index == 'true' || env.mustTrigger == 'true' }}
       serverless: ${{ steps.filter.outputs.serverless == 'true' || env.mustTrigger == 'true' }}
       stream: ${{ steps.filter.outputs.stream == 'true' || env.mustTrigger == 'true' }}
+      control_plane_ip_addresses: ${{ steps.filter.outputs.control_plane_ip_addresses == 'true' || env.mustTrigger == 'true' }}
     steps:
     - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29
     - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36
@@ -269,6 +270,8 @@ jobs:
           stream:
             - 'internal/service/streamconnection/*.go'
             - 'internal/service/streaminstance/*.go'
+          control_plane_ip_addresses:
+            - 'internal/service/controlplaneipaddresses/*.go'
 
   advanced_cluster:
     needs: [ change-detection, get-provider-version ]
@@ -815,3 +818,26 @@ jobs:
             ./internal/service/streamconnection
             ./internal/service/streaminstance
         run: make testacc
+    
+  control_plane_ip_addresses:
+    needs: [ change-detection, get-provider-version ]
+    if: ${{ needs.change-detection.outputs.control_plane_ip_addresses == 'true' || inputs.test_group == 'control_plane_ip_addresses' }}
+    runs-on: ubuntu-latest
+    permissions: {}
+    steps:
+      - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29
+        with:
+          ref: ${{ inputs.ref || github.ref }}
+      - uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7
+        with:
+          go-version-file: 'go.mod'
+      - uses: hashicorp/setup-terraform@651471c36a6092792c552e8b1bef71e592b462d8
+        with:
+          terraform_version: ${{ inputs.terraform_version }}
+          terraform_wrapper: false  
+      - name: Acceptance Tests
+        env:
+          MONGODB_ATLAS_LAST_VERSION: ${{ needs.get-provider-version.outputs.provider_version }}
+          ACCTEST_PACKAGES: |
+            ./internal/service/controlplaneipaddresses
+        run: make testacc

contributing/documentation.md

@@ -9,7 +9,7 @@ We autogenerate the documentation of our provider resources and data sources via
 ### How to generate the documentation for a resource
 - Make sure that the resource and data source schemas have defined the fields `MarkdownDescription` and `Description`.
   - We recommend to use [Scaffolding Schema and Model Definitions](#scaffolding-schema-and-model-definitions) to autogenerate the schema via the Open API specification.
-- Add the resource/data source templates to the [templates](templates) folder. See [README.md](templates/README.md) for more info.
+- Add the resource/data source templates to the [templates](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/templates) folder. See [README.md](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/templates/README.md) for more info.
 - Run the Makefile command `generate-doc`
 ```bash
 export resource_name=search_deployment && make generate-doc

examples/mongodbatlas_control_plane_ip_addresses/main.tf

@@ -0,0 +1,6 @@
+data "mongodbatlas_control_plane_ip_addresses" "test" {
+}
+
+output "outbound-aws-ip-addresses" {
+  value = data.mongodbatlas_control_plane_ip_addresses.test.outbound.aws
+}

examples/mongodbatlas_control_plane_ip_addresses/provider.tf

@@ -0,0 +1,4 @@
+provider "mongodbatlas" {
+  public_key  = var.public_key
+  private_key = var.private_key
+}

examples/mongodbatlas_control_plane_ip_addresses/variables.tf

@@ -0,0 +1,8 @@
+variable "public_key" {
+  description = "Public API key to authenticate to Atlas"
+  type        = string
+}
+variable "private_key" {
+  description = "Private API key to authenticate to Atlas"
+  type        = string
+}

examples/mongodbatlas_control_plane_ip_addresses/versions.tf

@@ -0,0 +1,9 @@
+terraform {
+  required_providers {
+    mongodbatlas = {
+      source  = "mongodb/mongodbatlas"
+      version = "~> 1.17"
+    }
+  }
+  required_version = ">= 1.0"
+}

internal/common/conversion/string_framework.go

@@ -3,7 +3,9 @@ package conversion
 import (
 	"context"
 
+	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
 )
 
 func TypesSetToString(ctx context.Context, set types.Set) []string {
@@ -18,6 +20,10 @@ func TypesListToString(ctx context.Context, list types.List) []string {
 	return results
 }
 
+func ToTFMapOfSlices(ctx context.Context, values map[string][]string) (basetypes.MapValue, diag.Diagnostics) {
+	return types.MapValueFrom(ctx, types.ListType{ElemType: types.StringType}, values)
+}
+
 // StringNullIfEmpty converts a string value to a Framework String value.
 // An empty string is converted to a null String. Useful for optional attributes.
 func StringNullIfEmpty(v string) types.String {

internal/provider/provider.go

@@ -28,6 +28,7 @@ import (
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/config"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/service/alertconfiguration"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/service/atlasuser"
+	"github.com/mongodb/terraform-provider-mongodbatlas/internal/service/controlplaneipaddresses"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/service/databaseuser"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/service/encryptionatrest"
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/service/project"
@@ -431,6 +432,7 @@ func (p *MongodbtlasProvider) DataSources(context.Context) []func() datasource.D
 		streaminstance.PluralDataSource,
 		streamconnection.DataSource,
 		streamconnection.PluralDataSource,
+		controlplaneipaddresses.DataSource,
 	}
 	previewDataSources := []func() datasource.DataSource{} // Data sources not yet in GA
 	if providerEnablePreview {

internal/service/controlplaneipaddresses/data_source.go

@@ -0,0 +1,44 @@
+package controlplaneipaddresses
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-framework/datasource"
+	"github.com/mongodb/terraform-provider-mongodbatlas/internal/config"
+)
+
+const controlPlaneIPAddressesName = "control_plane_ip_addresses"
+
+var _ datasource.DataSource = &controlPlaneIPAddressesDS{}
+var _ datasource.DataSourceWithConfigure = &controlPlaneIPAddressesDS{}
+
+func DataSource() datasource.DataSource {
+	return &controlPlaneIPAddressesDS{
+		DSCommon: config.DSCommon{
+			DataSourceName: controlPlaneIPAddressesName,
+		},
+	}
+}
+
+type controlPlaneIPAddressesDS struct {
+	config.DSCommon
+}
+
+func (d *controlPlaneIPAddressesDS) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
+	resp.Schema = DataSourceSchema(ctx)
+}
+
+func (d *controlPlaneIPAddressesDS) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
+	connV2 := d.Client.AtlasV2
+	apiResp, _, err := connV2.RootApi.ReturnAllControlPlaneIPAddresses(ctx).Execute()
+	if err != nil {
+		resp.Diagnostics.AddError("error fetching control plane ip addresses", err.Error())
+		return
+	}
+	newControlPlaneIPAddressesModel, diags := NewTFControlPlaneIPAddresses(ctx, apiResp)
+	if diags.HasError() {
+		resp.Diagnostics.Append(diags...)
+		return
+	}
+	resp.Diagnostics.Append(resp.State.Set(ctx, newControlPlaneIPAddressesModel)...)
+}