Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for using the update provider for A data source #478

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add support for using the update provider for A data source #478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/data-sources/a_record_set.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ output "google_addrs" {

- `host` (String) Host to look up.

### Optional

- `use_update_server` (Boolean) Whether to use the configured update DNS server

### Read-Only

- `addrs` (List of String) A list of IP addresses. IP addresses are always sorted to avoid constant changing plans.
Expand Down
75 changes: 64 additions & 11 deletions internal/provider/data_dns_a_record_set.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,21 @@ import (
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
"github.com/hashicorp/terraform-plugin-framework/diag"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/miekg/dns"
)

var (
_ datasource.DataSource = (*dnsARecordSetDataSource)(nil)
_ datasource.DataSource = (*dnsARecordSetDataSource)(nil)
_ datasource.DataSourceWithConfigure = (*dnsARecordSetDataSource)(nil)
)

func NewDnsARecordSetDataSource() datasource.DataSource {
return &dnsARecordSetDataSource{}
}

type dnsARecordSetDataSource struct{}
type dnsARecordSetDataSource struct {
client *DNSClient
}

func (d *dnsARecordSetDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_a_record_set"
Expand All @@ -36,6 +40,10 @@ func (d *dnsARecordSetDataSource) Schema(ctx context.Context, req datasource.Sch
Required: true,
Description: "Host to look up.",
},
"use_update_server": schema.BoolAttribute{
Optional: true,
Description: "Whether to use the configured update DNS server",
},
"addrs": schema.ListAttribute{
ElementType: types.StringType,
Computed: true,
Expand All @@ -49,6 +57,24 @@ func (d *dnsARecordSetDataSource) Schema(ctx context.Context, req datasource.Sch
}
}

func (d *dnsARecordSetDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
if req.ProviderData == nil {
return
}

client, ok := req.ProviderData.(*DNSClient)
if !ok {
resp.Diagnostics.AddError(
"Unexpected Resource Configure Type",
fmt.Sprintf("Expected *DNSClient, got: %T. Please report this issue to the provider developers.", req.ProviderData),
)

return
}

d.client = client
}

func (d *dnsARecordSetDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
var config aRecordSetConfig

Expand All @@ -57,16 +83,42 @@ func (d *dnsARecordSetDataSource) Read(ctx context.Context, req datasource.ReadR
return
}

host := config.Host.ValueString()
a, _, err := lookupIP(host)
if err != nil {
resp.Diagnostics.AddError(fmt.Sprintf("error looking up A records for %q: ", host), err.Error())
if config.UseUpdateServer.ValueBool() && d.client == nil {
resp.Diagnostics.AddError("use_update_server enabled, but no update server configured", "If you set use_update_server to true, an update server needs to be configured for the provider")
return
}
sort.Strings(a)

host := config.Host.ValueString()

answers := []string{}
if !config.UseUpdateServer.ValueBool() || d.client == nil {
var err error
answers, _, err = lookupIP(host)
if err != nil {
resp.Diagnostics.AddError(fmt.Sprintf("error looking up A records for %q: ", host), err.Error())
return
}
} else {
records, diags := resourceDnsRead_framework_flags(dnsConfig{Name: host}, d.client, dns.TypeA, dns.MsgHdr{RecursionDesired: true})
resp.Diagnostics.Append(diags...)
if diags.HasError() {
return
}

for _, record := range records {
addr, _, err := getAVal(record)
if err != nil {
resp.Diagnostics.AddError("Error querying DNS record:", err.Error())
return
}

answers = append(answers, addr)
}
}
sort.Strings(answers)

var convertDiags diag.Diagnostics
config.Addrs, convertDiags = types.ListValueFrom(ctx, config.Addrs.ElementType(ctx), a)
config.Addrs, convertDiags = types.ListValueFrom(ctx, config.Addrs.ElementType(ctx), answers)
resp.Diagnostics.Append(convertDiags...)
if resp.Diagnostics.HasError() {
return
Expand All @@ -77,7 +129,8 @@ func (d *dnsARecordSetDataSource) Read(ctx context.Context, req datasource.ReadR
}

type aRecordSetConfig struct {
ID types.String `tfsdk:"id"`
Host types.String `tfsdk:"host"`
Addrs types.List `tfsdk:"addrs"`
ID types.String `tfsdk:"id"`
Host types.String `tfsdk:"host"`
UseUpdateServer types.Bool `tfsdk:"use_update_server"`
Addrs types.List `tfsdk:"addrs"`
}
24 changes: 24 additions & 0 deletions internal/provider/data_dns_a_record_set_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,27 @@ data "dns_a_record_set" "test" {
},
})
}

func TestAccDataDnsARecordSet_BasicUpdateProvider(t *testing.T) {
recordName := "data.dns_a_record_set.test"

resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
ProtoV5ProviderFactories: testProtoV5ProviderFactories,
Steps: []resource.TestStep{
{
Config: `
data "dns_a_record_set" "test" {
host = "terraform-provider-dns-a.hashicorptest.com"
use_update_server = true
}
`,
Check: resource.ComposeAggregateTestCheckFunc(
resource.TestCheckResourceAttr(recordName, "addrs.#", "1"),
resource.TestCheckTypeSetElemAttr(recordName, "addrs.*", "127.0.0.1"),
resource.TestCheckResourceAttr(recordName, "id", "terraform-provider-dns-a.hashicorptest.com"),
),
},
},
})
}
68 changes: 60 additions & 8 deletions internal/provider/data_dns_aaaa_record_set.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,21 @@ import (
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
"github.com/hashicorp/terraform-plugin-framework/diag"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/miekg/dns"
)

var (
_ datasource.DataSource = (*dnsAAAARecordSetDataSource)(nil)
_ datasource.DataSource = (*dnsAAAARecordSetDataSource)(nil)
_ datasource.DataSourceWithConfigure = (*dnsAAAARecordSetDataSource)(nil)
)

func NewDnsAAAARecordSetDataSource() datasource.DataSource {
return &dnsAAAARecordSetDataSource{}
}

type dnsAAAARecordSetDataSource struct{}
type dnsAAAARecordSetDataSource struct {
client *DNSClient
}

func (d *dnsAAAARecordSetDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_aaaa_record_set"
Expand All @@ -36,6 +40,10 @@ func (d *dnsAAAARecordSetDataSource) Schema(ctx context.Context, req datasource.
Required: true,
Description: "Host to look up.",
},
"use_update_server": schema.BoolAttribute{
Optional: true,
Description: "Whether to use the configured update DNS server",
},
"addrs": schema.ListAttribute{
ElementType: types.StringType,
Computed: true,
Expand All @@ -49,6 +57,24 @@ func (d *dnsAAAARecordSetDataSource) Schema(ctx context.Context, req datasource.
}
}

func (d *dnsAAAARecordSetDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
if req.ProviderData == nil {
return
}

client, ok := req.ProviderData.(*DNSClient)
if !ok {
resp.Diagnostics.AddError(
"Unexpected Resource Configure Type",
fmt.Sprintf("Expected *DNSClient, got: %T. Please report this issue to the provider developers.", req.ProviderData),
)

return
}

d.client = client
}

func (d *dnsAAAARecordSetDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
var config aRecordSetConfig

Expand All @@ -57,16 +83,42 @@ func (d *dnsAAAARecordSetDataSource) Read(ctx context.Context, req datasource.Re
return
}

host := config.Host.ValueString()
_, aaaa, err := lookupIP(host)
if err != nil {
resp.Diagnostics.AddError(fmt.Sprintf("error looking up AAAA records for %q: ", host), err.Error())
if config.UseUpdateServer.ValueBool() && d.client == nil {
resp.Diagnostics.AddError("use_update_server enabled, but no update server configured", "If you set use_update_server to true, an update server needs to be configured for the provider")
return
}
sort.Strings(aaaa)

host := config.Host.ValueString()

answers := []string{}
if !config.UseUpdateServer.ValueBool() || d.client == nil {
var err error
_, answers, err = lookupIP(host)
if err != nil {
resp.Diagnostics.AddError(fmt.Sprintf("error looking up AAAA records for %q: ", host), err.Error())
return
}
} else {
records, diags := resourceDnsRead_framework_flags(dnsConfig{Name: host}, d.client, dns.TypeAAAA, dns.MsgHdr{RecursionDesired: true})
resp.Diagnostics.Append(diags...)
if diags.HasError() {
return
}

for _, record := range records {
addr, _, err := getAAAAVal(record)
if err != nil {
resp.Diagnostics.AddError("Error querying DNS record:", err.Error())
return
}

answers = append(answers, addr)
}
}
sort.Strings(answers)

var convertDiags diag.Diagnostics
config.Addrs, convertDiags = types.ListValueFrom(ctx, config.Addrs.ElementType(ctx), aaaa)
config.Addrs, convertDiags = types.ListValueFrom(ctx, config.Addrs.ElementType(ctx), answers)
resp.Diagnostics.Append(convertDiags...)
if resp.Diagnostics.HasError() {
return
Expand Down
24 changes: 24 additions & 0 deletions internal/provider/data_dns_aaaa_record_set_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,27 @@ data "dns_aaaa_record_set" "test" {
},
})
}

func TestAccDataDnsAAAARecordSet_BasicUpdateServer(t *testing.T) {
recordName := "data.dns_aaaa_record_set.test"

resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
ProtoV5ProviderFactories: testProtoV5ProviderFactories,
Steps: []resource.TestStep{
{
Config: `
data "dns_aaaa_record_set" "test" {
host = "terraform-provider-dns-aaaa.hashicorptest.com"
use_update_server = true
}
`,
Check: resource.ComposeAggregateTestCheckFunc(
resource.TestCheckResourceAttr(recordName, "addrs.#", "1"),
resource.TestCheckTypeSetElemAttr(recordName, "addrs.*", "::1"),
resource.TestCheckResourceAttr(recordName, "id", "terraform-provider-dns-aaaa.hashicorptest.com"),
),
},
},
})
}
2 changes: 0 additions & 2 deletions internal/provider/provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,8 +489,6 @@ func exchange(msg *dns.Msg, tsig bool, client *DNSClient) (*dns.Msg, error) {
keyname = k
}

msg.RecursionDesired = false

if tsig && keyname != "" {
msg.SetTsig(keyname, keyalgo, 300, time.Now().Unix())
}
Expand Down
10 changes: 9 additions & 1 deletion internal/provider/provider_framework.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,10 +325,13 @@ func (p *dnsProvider) Configure(ctx context.Context, req provider.ConfigureReque
keytab: keytab,
}

resp.ResourceData, configErr = config.Client(ctx)
client, configErr := config.Client(ctx)
if configErr != nil {
resp.Diagnostics.AddError("Error initializing DNS Client:", configErr.Error())
}

resp.ResourceData = client
resp.DataSourceData = client
}

func (p *dnsProvider) Resources(ctx context.Context) []func() resource.Resource {
Expand Down Expand Up @@ -496,11 +499,16 @@ func resourceFQDN_framework(config dnsConfig) string {
}

func resourceDnsRead_framework(config dnsConfig, client *DNSClient, rrType uint16) ([]dns.RR, diag.Diagnostics) {
return resourceDnsRead_framework_flags(config, client, rrType, dns.MsgHdr{RecursionDesired: false})
}

func resourceDnsRead_framework_flags(config dnsConfig, client *DNSClient, rrType uint16, flags dns.MsgHdr) ([]dns.RR, diag.Diagnostics) {
var diags diag.Diagnostics
fqdn := resourceFQDN_framework(config)

msg := new(dns.Msg)
msg.SetQuestion(fqdn, rrType)
msg.RecursionDesired = flags.RecursionDesired

r, err := exchange(msg, true, client)
if err != nil {
Expand Down
Loading