Skip to content

Commit 913cc14

Browse files
marceljkmarceljk
authored
feat(dns): add option to get dns_zone by dns_name (#856)
* feat: add option to get dns_zone by dns_name
1 parent d7b6530 commit 913cc14

File tree

5 files changed

+159
-43
lines changed

5 files changed

+159
-43
lines changed

‎docs/data-sources/dns_zone.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ data "stackit_dns_zone" "example" {
2525
### Required
2626

2727
- `project_id` (String) STACKIT project ID to which the dns zone is associated.
28+
29+
### Optional
30+
31+
- `dns_name` (String) The zone name. E.g. `example.com`
2832
- `zone_id` (String) The zone ID.
2933

3034
### Read-Only
@@ -34,7 +38,6 @@ data "stackit_dns_zone" "example" {
3438
- `contact_email` (String) A contact e-mail for the zone.
3539
- `default_ttl` (Number) Default time to live.
3640
- `description` (String) Description of the zone.
37-
- `dns_name` (String) The zone name. E.g. `example.com`
3841
- `expire_time` (Number) Expire time.
3942
- `id` (String) Terraform's internal data source. ID. It is structured as "`project_id`,`zone_id`".
4043
- `is_reverse_zone` (Boolean) Specifies, if the zone is a reverse zone or not.

‎stackit/internal/services/dns/dns_acc_test.go

Lines changed: 72 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,8 @@ func TestAccDnsMinResource(t *testing.T) {
131131
Config: resourceMinConfig,
132132
ConfigVariables: testConfigVarsMin,
133133
Check: resource.ComposeAggregateTestCheckFunc(
134-
// Zone data
135-
resource.TestCheckResourceAttr("stackit_dns_zone.zone", "project_id", testutil.ProjectId),
134+
// Zone data by zone_id
135+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone", "project_id", testutil.ProjectId),
136136
resource.TestCheckResourceAttrPair(
137137
"stackit_dns_zone.zone", "zone_id",
138138
"data.stackit_dns_zone.zone", "zone_id",
@@ -150,6 +150,21 @@ func TestAccDnsMinResource(t *testing.T) {
150150
"data.stackit_dns_record_set.record_set", "project_id",
151151
),
152152

153+
// Zone data by dns_name
154+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone_name", "project_id", testutil.ProjectId),
155+
resource.TestCheckResourceAttrPair(
156+
"stackit_dns_zone.zone", "zone_id",
157+
"data.stackit_dns_zone.zone_name", "zone_id",
158+
),
159+
resource.TestCheckResourceAttrPair(
160+
"data.stackit_dns_record_set.record_set", "zone_id",
161+
"data.stackit_dns_zone.zone_name", "zone_id",
162+
),
163+
resource.TestCheckResourceAttrPair(
164+
"data.stackit_dns_record_set.record_set", "project_id",
165+
"data.stackit_dns_zone.zone_name", "project_id",
166+
),
167+
153168
// Record set data
154169
resource.TestCheckResourceAttrSet("data.stackit_dns_record_set.record_set", "record_set_id"),
155170
resource.TestCheckResourceAttrSet("data.stackit_dns_record_set.record_set", "name"),
@@ -297,8 +312,8 @@ func TestAccDnsMaxResource(t *testing.T) {
297312
Config: resourceMaxConfig,
298313
ConfigVariables: testConfigVarsMax,
299314
Check: resource.ComposeAggregateTestCheckFunc(
300-
// Zone data
301-
resource.TestCheckResourceAttr("stackit_dns_zone.zone", "project_id", testutil.ProjectId),
315+
// Zone data by zone_id
316+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone", "project_id", testutil.ProjectId),
302317
resource.TestCheckResourceAttrPair(
303318
"stackit_dns_zone.zone", "zone_id",
304319
"data.stackit_dns_zone.zone", "zone_id",
@@ -316,24 +331,59 @@ func TestAccDnsMaxResource(t *testing.T) {
316331
"stackit_dns_record_set.record_set", "project_id",
317332
),
318333

319-
resource.TestCheckResourceAttr("stackit_dns_zone.zone", "acl", testutil.ConvertConfigVariable(testConfigVarsMax["acl"])),
320-
resource.TestCheckResourceAttr("stackit_dns_zone.zone", "active", testutil.ConvertConfigVariable(testConfigVarsMax["active"])),
321-
resource.TestCheckResourceAttr("stackit_dns_zone.zone", "contact_email", testutil.ConvertConfigVariable(testConfigVarsMax["contact_email"])),
322-
resource.TestCheckResourceAttr("stackit_dns_zone.zone", "default_ttl", testutil.ConvertConfigVariable(testConfigVarsMax["default_ttl"])),
323-
resource.TestCheckResourceAttr("stackit_dns_zone.zone", "description", testutil.ConvertConfigVariable(testConfigVarsMax["description"])),
324-
resource.TestCheckResourceAttr("stackit_dns_zone.zone", "expire_time", testutil.ConvertConfigVariable(testConfigVarsMax["expire_time"])),
325-
resource.TestCheckResourceAttr("stackit_dns_zone.zone", "is_reverse_zone", testutil.ConvertConfigVariable(testConfigVarsMax["is_reverse_zone"])),
326-
resource.TestCheckResourceAttr("stackit_dns_zone.zone", "primaries.#", "1"),
327-
resource.TestCheckResourceAttrSet("stackit_dns_zone.zone", "primaries.0"),
328-
resource.TestCheckResourceAttr("stackit_dns_zone.zone", "refresh_time", testutil.ConvertConfigVariable(testConfigVarsMax["refresh_time"])),
329-
resource.TestCheckResourceAttr("stackit_dns_zone.zone", "retry_time", testutil.ConvertConfigVariable(testConfigVarsMax["retry_time"])),
330-
resource.TestCheckResourceAttr("stackit_dns_zone.zone", "type", testutil.ConvertConfigVariable(testConfigVarsMax["type"])),
331-
resource.TestCheckResourceAttr("stackit_dns_zone.zone", "dns_name", testutil.ConvertConfigVariable(testConfigVarsMax["dns_name"])),
332-
resource.TestCheckResourceAttr("stackit_dns_zone.zone", "name", testutil.ConvertConfigVariable(testConfigVarsMax["name"])),
333-
// resource.TestCheckResourceAttrSet("stackit_dns_zone.zone", "negative_cache"),
334-
resource.TestCheckResourceAttrSet("stackit_dns_zone.zone", "serial_number"),
335-
resource.TestCheckResourceAttrSet("stackit_dns_zone.zone", "state"),
336-
resource.TestCheckResourceAttrSet("stackit_dns_zone.zone", "visibility"),
334+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone", "acl", testutil.ConvertConfigVariable(testConfigVarsMax["acl"])),
335+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone", "active", testutil.ConvertConfigVariable(testConfigVarsMax["active"])),
336+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone", "contact_email", testutil.ConvertConfigVariable(testConfigVarsMax["contact_email"])),
337+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone", "default_ttl", testutil.ConvertConfigVariable(testConfigVarsMax["default_ttl"])),
338+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone", "description", testutil.ConvertConfigVariable(testConfigVarsMax["description"])),
339+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone", "expire_time", testutil.ConvertConfigVariable(testConfigVarsMax["expire_time"])),
340+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone", "is_reverse_zone", testutil.ConvertConfigVariable(testConfigVarsMax["is_reverse_zone"])),
341+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone", "primaries.#", "1"),
342+
resource.TestCheckResourceAttrSet("data.stackit_dns_zone.zone", "primaries.0"),
343+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone", "refresh_time", testutil.ConvertConfigVariable(testConfigVarsMax["refresh_time"])),
344+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone", "retry_time", testutil.ConvertConfigVariable(testConfigVarsMax["retry_time"])),
345+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone", "type", testutil.ConvertConfigVariable(testConfigVarsMax["type"])),
346+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone", "dns_name", testutil.ConvertConfigVariable(testConfigVarsMax["dns_name"])),
347+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone", "name", testutil.ConvertConfigVariable(testConfigVarsMax["name"])),
348+
// resource.TestCheckResourceAttrSet("data.stackit_dns_zone.zone", "negative_cache"),
349+
resource.TestCheckResourceAttrSet("data.stackit_dns_zone.zone", "serial_number"),
350+
resource.TestCheckResourceAttrSet("data.stackit_dns_zone.zone", "state"),
351+
resource.TestCheckResourceAttrSet("data.stackit_dns_zone.zone", "visibility"),
352+
353+
// Zone data by dns_name
354+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone_name", "project_id", testutil.ProjectId),
355+
resource.TestCheckResourceAttrPair(
356+
"stackit_dns_zone.zone", "zone_id",
357+
"data.stackit_dns_zone.zone_name", "zone_id",
358+
),
359+
resource.TestCheckResourceAttrPair(
360+
"data.stackit_dns_record_set.record_set", "zone_id",
361+
"data.stackit_dns_zone.zone_name", "zone_id",
362+
),
363+
resource.TestCheckResourceAttrPair(
364+
"data.stackit_dns_record_set.record_set", "project_id",
365+
"data.stackit_dns_zone.zone_name", "project_id",
366+
),
367+
368+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone_name", "acl", testutil.ConvertConfigVariable(testConfigVarsMax["acl"])),
369+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone_name", "active", testutil.ConvertConfigVariable(testConfigVarsMax["active"])),
370+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone_name", "contact_email", testutil.ConvertConfigVariable(testConfigVarsMax["contact_email"])),
371+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone_name", "default_ttl", testutil.ConvertConfigVariable(testConfigVarsMax["default_ttl"])),
372+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone_name", "description", testutil.ConvertConfigVariable(testConfigVarsMax["description"])),
373+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone_name", "expire_time", testutil.ConvertConfigVariable(testConfigVarsMax["expire_time"])),
374+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone_name", "is_reverse_zone", testutil.ConvertConfigVariable(testConfigVarsMax["is_reverse_zone"])),
375+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone_name", "primaries.#", "1"),
376+
resource.TestCheckResourceAttrSet("data.stackit_dns_zone.zone_name", "primaries.0"),
377+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone_name", "refresh_time", testutil.ConvertConfigVariable(testConfigVarsMax["refresh_time"])),
378+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone_name", "retry_time", testutil.ConvertConfigVariable(testConfigVarsMax["retry_time"])),
379+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone_name", "type", testutil.ConvertConfigVariable(testConfigVarsMax["type"])),
380+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone_name", "dns_name", testutil.ConvertConfigVariable(testConfigVarsMax["dns_name"])),
381+
resource.TestCheckResourceAttr("data.stackit_dns_zone.zone_name", "name", testutil.ConvertConfigVariable(testConfigVarsMax["name"])),
382+
// resource.TestCheckResourceAttrSet("data.stackit_dns_zone.zone_name", "negative_cache"),
383+
resource.TestCheckResourceAttrSet("data.stackit_dns_zone.zone_name", "serial_number"),
384+
resource.TestCheckResourceAttrSet("data.stackit_dns_zone.zone_name", "state"),
385+
resource.TestCheckResourceAttrSet("data.stackit_dns_zone.zone_name", "visibility"),
386+
337387
// Record set data
338388
resource.TestCheckResourceAttrSet("data.stackit_dns_record_set.record_set", "record_set_id"),
339389
resource.TestCheckResourceAttrSet("data.stackit_dns_record_set.record_set", "name"),

‎stackit/internal/services/dns/testdata/resource-max.tf

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ resource "stackit_dns_zone" "zone" {
3636
expire_time = var.expire_time
3737
is_reverse_zone = var.is_reverse_zone
3838
# negative_cache = var.negative_cache
39-
primaries = var.primaries
40-
refresh_time = var.refresh_time
41-
retry_time = var.retry_time
42-
type = var.type
39+
primaries = var.primaries
40+
refresh_time = var.refresh_time
41+
retry_time = var.retry_time
42+
type = var.type
4343
}
4444

4545

@@ -62,6 +62,11 @@ data "stackit_dns_zone" "zone" {
6262
zone_id = stackit_dns_zone.zone.zone_id
6363
}
6464

65+
data "stackit_dns_zone" "zone_name" {
66+
project_id = var.project_id
67+
dns_name = stackit_dns_zone.zone.dns_name
68+
}
69+
6570
data "stackit_dns_record_set" "record_set" {
6671
project_id = var.project_id
6772
zone_id = stackit_dns_zone.zone.zone_id

‎stackit/internal/services/dns/testdata/resource-min.tf

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ data "stackit_dns_zone" "zone" {
2929
zone_id = stackit_dns_zone.zone.zone_id
3030
}
3131

32+
data "stackit_dns_zone" "zone_name" {
33+
project_id = var.project_id
34+
dns_name = stackit_dns_zone.zone.dns_name
35+
}
36+
3237
data "stackit_dns_record_set" "record_set" {
3338
project_id = var.project_id
3439
zone_id = stackit_dns_zone.zone.zone_id

‎stackit/internal/services/dns/zone/datasource.go

Lines changed: 69 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ import (
55
"fmt"
66
"net/http"
77

8+
"github.com/hashicorp/terraform-plugin-framework-validators/datasourcevalidator"
9+
"github.com/hashicorp/terraform-plugin-framework/path"
810
"github.com/stackitcloud/terraform-provider-stackit/stackit/internal/conversion"
911
dnsUtils "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/services/dns/utils"
1012

@@ -39,6 +41,16 @@ func (d *zoneDataSource) Metadata(_ context.Context, req datasource.MetadataRequ
3941
resp.TypeName = req.ProviderTypeName + "_dns_zone"
4042
}
4143

44+
// ConfigValidators validates the resource configuration
45+
func (d *zoneDataSource) ConfigValidators(_ context.Context) []datasource.ConfigValidator {
46+
return []datasource.ConfigValidator{
47+
datasourcevalidator.ExactlyOneOf(
48+
path.MatchRoot("zone_id"),
49+
path.MatchRoot("dns_name"),
50+
),
51+
}
52+
}
53+
4254
func (d *zoneDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
4355
providerData, ok := conversion.ParseProviderData(ctx, req.ProviderData, &resp.Diagnostics)
4456
if !ok {
@@ -72,7 +84,7 @@ func (d *zoneDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, r
7284
},
7385
"zone_id": schema.StringAttribute{
7486
Description: "The zone ID.",
75-
Required: true,
87+
Optional: true,
7688
Validators: []validator.String{
7789
validate.UUID(),
7890
validate.NoSeparator(),
@@ -84,7 +96,7 @@ func (d *zoneDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, r
8496
},
8597
"dns_name": schema.StringAttribute{
8698
Description: "The zone name. E.g. `example.com`",
87-
Computed: true,
99+
Optional: true,
88100
},
89101
"description": schema.StringAttribute{
90102
Description: "Description of the zone.",
@@ -169,24 +181,65 @@ func (d *zoneDataSource) Read(ctx context.Context, req datasource.ReadRequest, r
169181
}
170182
projectId := model.ProjectId.ValueString()
171183
zoneId := model.ZoneId.ValueString()
184+
dnsName := model.DnsName.ValueString()
172185
ctx = tflog.SetField(ctx, "project_id", projectId)
173186
ctx = tflog.SetField(ctx, "zone_id", zoneId)
187+
ctx = tflog.SetField(ctx, "dns_name", dnsName)
174188

175-
zoneResp, err := d.client.GetZone(ctx, projectId, zoneId).Execute()
176-
if err != nil {
177-
utils.LogError(
178-
ctx,
179-
&resp.Diagnostics,
180-
err,
181-
"Reading zone",
182-
fmt.Sprintf("Zone with ID %q does not exist in project %q.", zoneId, projectId),
183-
map[int]string{
184-
http.StatusForbidden: fmt.Sprintf("Project with ID %q not found or forbidden access", projectId),
185-
},
186-
)
187-
resp.State.RemoveResource(ctx)
188-
return
189+
var zoneResp *dns.ZoneResponse
190+
var err error
191+
192+
if zoneId != "" {
193+
zoneResp, err = d.client.GetZone(ctx, projectId, zoneId).Execute()
194+
if err != nil {
195+
utils.LogError(
196+
ctx,
197+
&resp.Diagnostics,
198+
err,
199+
"Reading zone",
200+
fmt.Sprintf("Zone with ID %q does not exist in project %q.", zoneId, projectId),
201+
map[int]string{
202+
http.StatusForbidden: fmt.Sprintf("Project with ID %q not found or forbidden access", projectId),
203+
},
204+
)
205+
resp.State.RemoveResource(ctx)
206+
return
207+
}
208+
} else {
209+
listZoneResp, err := d.client.ListZones(ctx, projectId).
210+
DnsNameEq(dnsName).
211+
ActiveEq(true).
212+
Execute()
213+
if err != nil {
214+
utils.LogError(
215+
ctx,
216+
&resp.Diagnostics,
217+
err,
218+
"Reading zone",
219+
fmt.Sprintf("Zone with DNS name %q does not exist in project %q.", dnsName, projectId),
220+
map[int]string{
221+
http.StatusForbidden: fmt.Sprintf("Project with ID %q not found or forbidden access", projectId),
222+
},
223+
)
224+
resp.State.RemoveResource(ctx)
225+
return
226+
}
227+
if *listZoneResp.TotalItems != 1 {
228+
utils.LogError(
229+
ctx,
230+
&resp.Diagnostics,
231+
fmt.Errorf("zone with DNS name %q does not exist in project %q", dnsName, projectId),
232+
"Reading zone",
233+
fmt.Sprintf("Zone with DNS name %q does not exist in project %q.", dnsName, projectId),
234+
nil,
235+
)
236+
resp.State.RemoveResource(ctx)
237+
return
238+
}
239+
zones := *listZoneResp.Zones
240+
zoneResp = dns.NewZoneResponse(zones[0])
189241
}
242+
190243
if zoneResp != nil && zoneResp.Zone.State != nil && *zoneResp.Zone.State == dns.ZONESTATE_DELETE_SUCCEEDED {
191244
resp.State.RemoveResource(ctx)
192245
core.LogAndAddError(ctx, &resp.Diagnostics, "Error reading zone", "Zone was deleted successfully")

0 commit comments

Comments
 (0)