Skip to content

feat: add Route53 DNS authority outputs #28

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

Merged
intel352 merged 1 commit into from
May 24, 2026
Merged

feat: add Route53 DNS authority outputs #28

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
98 changes: 91 additions & 7 deletions drivers/route53.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ type Route53Client interface {
CreateHostedZone(ctx context.Context, params *route53.CreateHostedZoneInput, optFns ...func(*route53.Options)) (*route53.CreateHostedZoneOutput, error)
ListHostedZonesByName(ctx context.Context, params *route53.ListHostedZonesByNameInput, optFns ...func(*route53.Options)) (*route53.ListHostedZonesByNameOutput, error)
GetHostedZone(ctx context.Context, params *route53.GetHostedZoneInput, optFns ...func(*route53.Options)) (*route53.GetHostedZoneOutput, error)
ListResourceRecordSets(ctx context.Context, params *route53.ListResourceRecordSetsInput, optFns ...func(*route53.Options)) (*route53.ListResourceRecordSetsOutput, error)
DeleteHostedZone(ctx context.Context, params *route53.DeleteHostedZoneInput, optFns ...func(*route53.Options)) (*route53.DeleteHostedZoneOutput, error)
ChangeResourceRecordSets(ctx context.Context, params *route53.ChangeResourceRecordSetsInput, optFns ...func(*route53.Options)) (*route53.ChangeResourceRecordSetsOutput, error)
}
Expand Down Expand Up @@ -59,7 +60,7 @@ func (d *Route53Driver) Create(ctx context.Context, spec interfaces.ResourceSpec
if err != nil {
return nil, fmt.Errorf("route53: create zone %q: %w", spec.Name, err)
}
return r53ZoneToOutput(spec.Name, out.HostedZone), nil
return r53ZoneToOutput(spec.Name, out.HostedZone, out.DelegationSet, nil), nil
}

func (d *Route53Driver) Read(ctx context.Context, ref interfaces.ResourceRef) (*interfaces.ResourceOutput, error) {
Expand All @@ -68,7 +69,11 @@ func (d *Route53Driver) Read(ctx context.Context, ref interfaces.ResourceRef) (*
if err != nil {
return nil, fmt.Errorf("route53: get zone %q: %w", ref.ProviderID, err)
}
return r53ZoneToOutput(ref.Name, out.HostedZone), nil
records, err := d.listRecordSets(ctx, ref.ProviderID)
if err != nil {
return nil, err
}
return r53ZoneToOutput(ref.Name, out.HostedZone, out.DelegationSet, records), nil
}

domainName := ref.Name
Expand All @@ -81,7 +86,35 @@ func (d *Route53Driver) Read(ctx context.Context, ref interfaces.ResourceRef) (*
if len(out.HostedZones) == 0 {
return nil, fmt.Errorf("route53: zone %q not found", domainName)
}
return r53ZoneToOutput(ref.Name, &out.HostedZones[0]), nil
zoneID := awssdk.ToString(out.HostedZones[0].Id)
hostedZone := &out.HostedZones[0]
zone, err := d.client.GetHostedZone(ctx, &route53.GetHostedZoneInput{Id: awssdk.String(zoneID)})
if err != nil {
return nil, fmt.Errorf("route53: get zone %q: %w", zoneID, err)
}
var delegation *r53types.DelegationSet
if zone != nil {
if zone.HostedZone != nil {
hostedZone = zone.HostedZone
}
delegation = zone.DelegationSet
}
records, err := d.listRecordSets(ctx, zoneID)
if err != nil {
return nil, err
}
return r53ZoneToOutput(ref.Name, hostedZone, delegation, records), nil
}

func (d *Route53Driver) listRecordSets(ctx context.Context, zoneID string) ([]r53types.ResourceRecordSet, error) {
out, err := d.client.ListResourceRecordSets(ctx, &route53.ListResourceRecordSetsInput{HostedZoneId: awssdk.String(zoneID)})
if err != nil {
return nil, fmt.Errorf("route53: list records %q: %w", zoneID, err)
}
if out == nil {
return nil, nil
}
return out.ResourceRecordSets, nil
}

func (d *Route53Driver) Update(ctx context.Context, ref interfaces.ResourceRef, spec interfaces.ResourceSpec) (*interfaces.ResourceOutput, error) {
Expand Down Expand Up @@ -114,9 +147,9 @@ func (d *Route53Driver) Update(ctx context.Context, ref interfaces.ResourceRef,
changes = append(changes, r53types.Change{
Action: r53types.ChangeActionUpsert,
ResourceRecordSet: &r53types.ResourceRecordSet{
Name: awssdk.String(name),
Type: r53types.RRType(rtype),
TTL: awssdk.Int64(ttl),
Name: awssdk.String(name),
Type: r53types.RRType(rtype),
TTL: awssdk.Int64(ttl),
ResourceRecords: rrs,
},
})
Expand Down Expand Up @@ -170,7 +203,7 @@ func (d *Route53Driver) Scale(_ context.Context, _ interfaces.ResourceRef, _ int
return nil, fmt.Errorf("route53: DNS zones are not scalable")
}

func r53ZoneToOutput(name string, zone *r53types.HostedZone) *interfaces.ResourceOutput {
func r53ZoneToOutput(name string, zone *r53types.HostedZone, delegation *r53types.DelegationSet, records []r53types.ResourceRecordSet) *interfaces.ResourceOutput {
if zone == nil {
return nil
}
Expand All @@ -180,10 +213,25 @@ func r53ZoneToOutput(name string, zone *r53types.HostedZone) *interfaces.Resourc
}
if zone.Name != nil {
outputs["domain_name"] = *zone.Name
outputs["domain"] = *zone.Name
}
if zone.Config != nil {
outputs["private"] = zone.Config.PrivateZone
}
if delegation != nil {
outputs["name_servers"] = append([]string(nil), delegation.NameServers...)
}
if records != nil {
outputs["records"] = r53RecordOutputs(records)
outputs["record_count"] = len(records)
} else if zone.ResourceRecordSetCount != nil {
outputs["record_count"] = int(*zone.ResourceRecordSetCount)
}
outputs["authority"] = map[string]any{
"role": "target_authoritative_dns",
"dns_host": "Route53",
"name_servers": append([]string(nil), delegationNameServers(delegation)...),
}

return &interfaces.ResourceOutput{
Name: name,
Expand All @@ -194,6 +242,42 @@ func r53ZoneToOutput(name string, zone *r53types.HostedZone) *interfaces.Resourc
}
}

func delegationNameServers(delegation *r53types.DelegationSet) []string {
if delegation == nil {
return nil
}
return delegation.NameServers
}

func r53RecordOutputs(records []r53types.ResourceRecordSet) []map[string]any {
outputs := make([]map[string]any, 0, len(records))
for _, record := range records {
out := map[string]any{
"name": awssdk.ToString(record.Name),
"type": string(record.Type),
}
if record.TTL != nil {
out["ttl"] = *record.TTL
}
if len(record.ResourceRecords) > 0 {
values := make([]string, 0, len(record.ResourceRecords))
for _, value := range record.ResourceRecords {
values = append(values, awssdk.ToString(value.Value))
}
out["values"] = values
}
if record.AliasTarget != nil {
out["alias_target"] = map[string]any{
"dns_name": awssdk.ToString(record.AliasTarget.DNSName),
"hosted_zone_id": awssdk.ToString(record.AliasTarget.HostedZoneId),
"evaluate_target_health": record.AliasTarget.EvaluateTargetHealth,
}
}
outputs = append(outputs, out)
}
return outputs
}

// SensitiveKeys returns output keys whose values should be masked in logs and plan output.
func (d *Route53Driver) SensitiveKeys() []string { return nil }

Expand Down
73 changes: 65 additions & 8 deletions drivers/route53_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,16 @@ import (
)

type mockRoute53Client struct {
createOut *route53.CreateHostedZoneOutput
createErr error
listOut *route53.ListHostedZonesByNameOutput
listErr error
getOut *route53.GetHostedZoneOutput
getErr error
deleteErr error
changeErr error
createOut *route53.CreateHostedZoneOutput
createErr error
listOut *route53.ListHostedZonesByNameOutput
listErr error
getOut *route53.GetHostedZoneOutput
getErr error
recordsOut *route53.ListResourceRecordSetsOutput
recordsErr error
deleteErr error
changeErr error
}

func (m *mockRoute53Client) CreateHostedZone(_ context.Context, _ *route53.CreateHostedZoneInput, _ ...func(*route53.Options)) (*route53.CreateHostedZoneOutput, error) {
Expand All @@ -33,6 +35,9 @@ func (m *mockRoute53Client) ListHostedZonesByName(_ context.Context, _ *route53.
func (m *mockRoute53Client) GetHostedZone(_ context.Context, _ *route53.GetHostedZoneInput, _ ...func(*route53.Options)) (*route53.GetHostedZoneOutput, error) {
return m.getOut, m.getErr
}
func (m *mockRoute53Client) ListResourceRecordSets(_ context.Context, _ *route53.ListResourceRecordSetsInput, _ ...func(*route53.Options)) (*route53.ListResourceRecordSetsOutput, error) {
return m.recordsOut, m.recordsErr
}
func (m *mockRoute53Client) DeleteHostedZone(_ context.Context, _ *route53.DeleteHostedZoneInput, _ ...func(*route53.Options)) (*route53.DeleteHostedZoneOutput, error) {
return &route53.DeleteHostedZoneOutput{}, m.deleteErr
}
Expand Down Expand Up @@ -86,6 +91,58 @@ func TestRoute53Driver_Read_ByName(t *testing.T) {
}
}

func TestRoute53Driver_ReadIncludesAuthorityAndRecords(t *testing.T) {
mock := &mockRoute53Client{
getOut: &route53.GetHostedZoneOutput{
HostedZone: &r53types.HostedZone{
Id: awssdk.String("/hostedzone/Z123456"),
Name: awssdk.String("example.com."),
},
DelegationSet: &r53types.DelegationSet{
NameServers: []string{"ns-1.awsdns-01.com", "ns-2.awsdns-02.net"},
},
},
recordsOut: &route53.ListResourceRecordSetsOutput{
ResourceRecordSets: []r53types.ResourceRecordSet{
{
Name: awssdk.String("example.com."),
Type: r53types.RRTypeMx,
TTL: awssdk.Int64(300),
ResourceRecords: []r53types.ResourceRecord{
{Value: awssdk.String("10 mail.example.com.")},
},
},
},
},
}
d := drivers.NewRoute53DriverWithClient(mock)
out, err := d.Read(context.Background(), interfaces.ResourceRef{Name: "example.com", ProviderID: "/hostedzone/Z123456"})
if err != nil {
t.Fatalf("Read failed: %v", err)
}
authority, ok := out.Outputs["authority"].(map[string]any)
if !ok {
t.Fatalf("authority = %T, want map[string]any", out.Outputs["authority"])
}
if got := authority["dns_host"]; got != "Route53" {
t.Fatalf("authority.dns_host = %v, want Route53", got)
}
nameServers, ok := authority["name_servers"].([]string)
if !ok || len(nameServers) != 2 || nameServers[0] != "ns-1.awsdns-01.com" {
t.Fatalf("authority.name_servers = %#v, want Route53 nameservers", authority["name_servers"])
}
if got := out.Outputs["record_count"]; got != 1 {
t.Fatalf("record_count = %v, want 1", got)
}
records, ok := out.Outputs["records"].([]map[string]any)
if !ok || len(records) != 1 {
t.Fatalf("records = %#v, want one normalized record", out.Outputs["records"])
}
if records[0]["type"] != "MX" || records[0]["name"] != "example.com." {
t.Fatalf("record = %#v, want MX example.com.", records[0])
}
}

func TestRoute53Driver_Delete(t *testing.T) {
mock := &mockRoute53Client{
listOut: &route53.ListHostedZonesByNameOutput{
Expand Down
Loading