Skip to content

feat(domain): add DiffSuppressFunc to scaleway_domain_record name attribute to accept FQDN and relative names #3413

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
merged 6 commits into from
Oct 21, 2025
Merged

feat(domain): add DiffSuppressFunc to scaleway_domain_record name attribute to accept FQDN and relative names #3413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
06a0eac
feat: add DiffSuppressFunc to scaleway_domain_record name attribute t…
jremy42 Oct 17, 2025
261e5be
feat: fix formatting in domain files
jremy42 Oct 20, 2025
4fde9b4
feat: add test for TEM domain integration with domain records (issue …
jremy42 Oct 20, 2025
8cd9faa
feat(domain): fix gofumpt formatting in TEM integration test
jremy42 Oct 20, 2025
6ab55db
feat(domain): remove hardcoded DKIM key from test
jremy42 Oct 21, 2025
e57b4de
Merge branch 'master' into feat/domain-record-name-diff-suppress
remyleone Oct 21, 2025
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
20 changes: 20 additions & 0 deletions internal/services/domain/helpers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -643,3 +643,23 @@ func BuildZoneName(subdomain, domain string) string {

return fmt.Sprintf("%s.%s", subdomain, domain)
}

func normalizeRecordName(name, dnsZone string) string {
if name == "" || name == "@" {
return ""
}

name = strings.TrimSuffix(name, ".")
dnsZone = strings.TrimSuffix(dnsZone, ".")

if name == dnsZone {
return ""
}

suffix := "." + dnsZone
if strings.HasSuffix(name, suffix) {
return strings.TrimSuffix(name, suffix)
}

return name
}
26 changes: 19 additions & 7 deletions internal/services/domain/record.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,20 @@ func ResourceRecord() *schema.Resource {
Optional: true,
StateFunc: func(val any) string {
value := val.(string)
if value == "@" {
if value == "@" || value == "" {
return ""
}

return value
},
DiffSuppressFunc: func(k, oldValue, newValue string, d *schema.ResourceData) bool {
dnsZone := d.Get("dns_zone").(string)

normalizedOld := normalizeRecordName(oldValue, dnsZone)
normalizedNew := normalizeRecordName(newValue, dnsZone)

return normalizedOld == normalizedNew
},
},
"type": {
Type: schema.TypeString,
Expand Down Expand Up @@ -249,9 +257,10 @@ func resourceRecordCreate(ctx context.Context, d *schema.ResourceData, m any) di
geoIP, okGeoIP := d.GetOk("geo_ip")
recordType := domain.RecordType(d.Get("type").(string))
recordData := d.Get("data").(string)
recordName := normalizeRecordName(d.Get("name").(string), dnsZone)
record := &domain.Record{
Data: recordData,
Name: d.Get("name").(string),
Name: recordName,
TTL: uint32(d.Get("ttl").(int)),
Type: recordType,
Priority: uint32(d.Get("priority").(int)),
Expand Down Expand Up @@ -289,7 +298,7 @@ func resourceRecordCreate(ctx context.Context, d *schema.ResourceData, m any) di

dnsZoneData, err := domainAPI.ListDNSZoneRecords(&domain.ListDNSZoneRecordsRequest{
DNSZone: dnsZone,
Name: d.Get("name").(string),
Name: recordName,
Type: recordType,
}, scw.WithAllPages(), scw.WithContext(ctx))
if err != nil {
Expand Down Expand Up @@ -361,10 +370,11 @@ func resourceDomainRecordRead(ctx context.Context, d *schema.ResourceData, m any
}

idRecord := locality.ExpandID(d.Id())
recordName := normalizeRecordName(d.Get("name").(string), dnsZone)

res, err := domainAPI.ListDNSZoneRecords(&domain.ListDNSZoneRecordsRequest{
DNSZone: dnsZone,
Name: d.Get("name").(string),
Name: recordName,
Type: recordType,
ID: &idRecord,
}, scw.WithAllPages(), scw.WithContext(ctx))
Expand Down Expand Up @@ -433,14 +443,16 @@ func resourceDomainRecordUpdate(ctx context.Context, d *schema.ResourceData, m a

domainAPI := NewDomainAPI(m)

dnsZone := d.Get("dns_zone").(string)
req := &domain.UpdateDNSZoneRecordsRequest{
DNSZone: d.Get("dns_zone").(string),
DNSZone: dnsZone,
ReturnAllRecords: scw.BoolPtr(false),
}

geoIP, okGeoIP := d.GetOk("geo_ip")
recordName := normalizeRecordName(d.Get("name").(string), dnsZone)
record := &domain.Record{
Name: d.Get("name").(string),
Name: recordName,
Data: d.Get("data").(string),
Priority: uint32(d.Get("priority").(int)),
TTL: uint32(d.Get("ttl").(int)),
Expand All @@ -465,7 +477,7 @@ func resourceDomainRecordUpdate(ctx context.Context, d *schema.ResourceData, m a
return diag.FromErr(err)
}

_, err = waitForDNSRecordExist(ctx, domainAPI, d.Get("dns_zone").(string), record.Name, record.Type, d.Timeout(schema.TimeoutUpdate))
_, err = waitForDNSRecordExist(ctx, domainAPI, dnsZone, record.Name, record.Type, d.Timeout(schema.TimeoutUpdate))
if err != nil {
return diag.FromErr(err)
}
Expand Down
135 changes: 135 additions & 0 deletions internal/services/domain/record_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -876,6 +876,141 @@ func TestAccDomainRecord_CNAME(t *testing.T) {
})
}

func TestAccDomainRecord_NameDiffSuppress(t *testing.T) {
tt := acctest.NewTestTools(t)
defer tt.Cleanup()

testDNSZone := "test-name-diff." + acctest.TestDomain
logging.L.Debugf("TestAccDomainRecord_NameDiffSuppress: test dns zone: %s", testDNSZone)

resource.ParallelTest(t, resource.TestCase{
PreCheck: func() { acctest.PreCheck(t) },
ProtoV6ProviderFactories: tt.ProviderFactories,
CheckDestroy: testAccCheckDomainRecordDestroy(tt),
Steps: []resource.TestStep{
{
Config: fmt.Sprintf(`
resource "scaleway_domain_record" "dmarc" {
dns_zone = "%s"
name = "_dmarc"
type = "TXT"
data = "v=DMARC1; p=none"
}
`, testDNSZone),
Check: resource.ComposeTestCheckFunc(
testAccCheckDomainRecordExists(tt, "scaleway_domain_record.dmarc"),
resource.TestCheckResourceAttr("scaleway_domain_record.dmarc", "name", "_dmarc"),
resource.TestCheckResourceAttr("scaleway_domain_record.dmarc", "type", "TXT"),
resource.TestCheckResourceAttr("scaleway_domain_record.dmarc", "data", "v=DMARC1; p=none"),
),
},
{
Config: fmt.Sprintf(`
resource "scaleway_domain_record" "dmarc" {
dns_zone = "%s"
name = "_dmarc.%s."
type = "TXT"
data = "v=DMARC1; p=none"
}
`, testDNSZone, testDNSZone),
Check: resource.ComposeTestCheckFunc(
testAccCheckDomainRecordExists(tt, "scaleway_domain_record.dmarc"),
resource.TestCheckResourceAttr("scaleway_domain_record.dmarc", "name", "_dmarc"),
resource.TestCheckResourceAttr("scaleway_domain_record.dmarc", "type", "TXT"),
),
},
},
})
}

func TestAccDomainRecord_TEMIntegration(t *testing.T) {
tt := acctest.NewTestTools(t)
defer tt.Cleanup()

testDNSZone := "test-tem-integration." + acctest.TestDomain
logging.L.Debugf("TestAccDomainRecord_TEMIntegration: test dns zone: %s", testDNSZone)

resource.ParallelTest(t, resource.TestCase{
PreCheck: func() { acctest.PreCheck(t) },
ProtoV6ProviderFactories: tt.ProviderFactories,
CheckDestroy: testAccCheckDomainRecordDestroy(tt),
Steps: []resource.TestStep{
{
Config: fmt.Sprintf(`
resource "scaleway_domain_record" "dmarc" {
dns_zone = "%s"
name = "_dmarc.%s."
type = "TXT"
data = "v=DMARC1; p=none"
}

resource "scaleway_domain_record" "dkim" {
dns_zone = "%s"
name = "scw1._domainkey.%s."
type = "TXT"
data = "test-dkim-record"
}
`, testDNSZone, testDNSZone, testDNSZone, testDNSZone),
Check: resource.ComposeTestCheckFunc(
testAccCheckDomainRecordExists(tt, "scaleway_domain_record.dmarc"),
testAccCheckDomainRecordExists(tt, "scaleway_domain_record.dkim"),
resource.TestCheckResourceAttr("scaleway_domain_record.dmarc", "name", "_dmarc"),
resource.TestCheckResourceAttr("scaleway_domain_record.dkim", "name", "scw1._domainkey"),
resource.TestCheckResourceAttr("scaleway_domain_record.dmarc", "type", "TXT"),
resource.TestCheckResourceAttr("scaleway_domain_record.dkim", "type", "TXT"),
),
},
{
Config: fmt.Sprintf(`
resource "scaleway_domain_record" "dmarc" {
dns_zone = "%s"
name = "_dmarc.%s."
type = "TXT"
data = "v=DMARC1; p=none"
}

resource "scaleway_domain_record" "dkim" {
dns_zone = "%s"
name = "scw1._domainkey.%s."
type = "TXT"
data = "test-dkim-record"
}
`, testDNSZone, testDNSZone, testDNSZone, testDNSZone),
Check: resource.ComposeTestCheckFunc(
testAccCheckDomainRecordExists(tt, "scaleway_domain_record.dmarc"),
testAccCheckDomainRecordExists(tt, "scaleway_domain_record.dkim"),
resource.TestCheckResourceAttr("scaleway_domain_record.dmarc", "name", "_dmarc"),
resource.TestCheckResourceAttr("scaleway_domain_record.dkim", "name", "scw1._domainkey"),
),
},
{
Config: fmt.Sprintf(`
resource "scaleway_domain_record" "dmarc" {
dns_zone = "%s"
name = "_dmarc"
type = "TXT"
data = "v=DMARC1; p=quarantine"
}

resource "scaleway_domain_record" "dkim" {
dns_zone = "%s"
name = "scw1._domainkey.%s."
type = "TXT"
data = "test-dkim-record"
}
`, testDNSZone, testDNSZone, testDNSZone),
Check: resource.ComposeTestCheckFunc(
testAccCheckDomainRecordExists(tt, "scaleway_domain_record.dmarc"),
testAccCheckDomainRecordExists(tt, "scaleway_domain_record.dkim"),
resource.TestCheckResourceAttr("scaleway_domain_record.dmarc", "name", "_dmarc"),
resource.TestCheckResourceAttr("scaleway_domain_record.dmarc", "data", "v=DMARC1; p=quarantine"),
resource.TestCheckResourceAttr("scaleway_domain_record.dkim", "name", "scw1._domainkey"),
),
},
},
})
}

func testAccCheckDomainRecordDestroy(tt *acctest.TestTools) resource.TestCheckFunc {
return func(state *terraform.State) error {
for _, rs := range state.RootModule().Resources {
Expand Down
Loading
Loading