Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 14 additions & 14 deletions rust/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion rust/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ async-trait = "0.1"
bytes = "1"
chrono = { version = "0.4", default-features = false, features = ["clock", "serde"] }
clap = { version = "4.5", features = ["std", "string", "derive", "env"] }
cli-engine = { version = "0.10.4", features = ["pkce-auth"] }
cli-engine = { version = "0.10.6", features = ["pkce-auth"] }
dirs = "6"
domains-client = { path = "domains-client" }
email-client = { path = "email-client" }
Expand Down
139 changes: 131 additions & 8 deletions rust/src/dns/delete.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ use crate::scopes::DOMAINS_DNS_UPDATE;
use domains_client::types;

use super::records::{
ZONE_AND_NAME, fetch_records, parse_write_type_arg, record_value, verified_result,
ZONE_AND_NAME, detail_columns, detail_values, fetch_records, merged_tlsa_data,
parse_write_type_arg, record_value, verified_result,
};

output_schema!(DnsDeleteResult {
Expand Down Expand Up @@ -66,6 +67,19 @@ fn summarize_delete_outcomes(
}))
}

/// How a record is named in a delete's preview and in its per-record results: its
/// value, except for TLSA, whose value alone is just the certificate — two records
/// that differ only in usage, selector or matching type would otherwise look
/// identical, and a delete by name removes every one of them. TLSA is shown the
/// way `dns list` shows it (`usage selector matching-type certificate`).
fn record_label_value(rec: &types::DnsRecord) -> Option<String> {
if rec.type_.as_str() == "TLSA" {
Some(merged_tlsa_data(rec)).filter(|text| !text.is_empty())
} else {
record_value(rec).map(str::to_owned)
}
}

/// Builds the `dns delete --dry-run` preview from the same matched records the
/// real execution would delete, so the preview can never drift from what
/// `delete` would actually do.
Expand All @@ -88,7 +102,13 @@ fn dry_run_delete_preview(
} else {
"would fail (missing recordId)"
};
json!({"recordId": rec.record_id, "data": record_value(rec), "status": status})
// The type-specific fields say which of several records under one
// name (an SRV's services, say) would go.
let mut row = detail_values(rec);
row.insert("recordId".to_owned(), json!(rec.record_id));
row.insert("data".to_owned(), json!(record_label_value(rec)));
row.insert("status".to_owned(), json!(status));
Value::Object(row)
})
.collect();

Expand Down Expand Up @@ -144,11 +164,17 @@ fn view_columns() -> Vec<TableColumn> {
TableColumn::new("deleted", "Deleted").align(Alignment::Right),
TableColumn::new("failed", "Failed").align(Alignment::Right),
TableColumn::new("action", "Action"),
TableColumn::new("records", "Records").nested(vec![
TableColumn::new("recordId", "Record ID"),
TableColumn::new("data", "Data").essential(true),
TableColumn::new("status", "Status").essential(true),
]),
TableColumn::new("records", "Records")
.hide_when_empty(true)
.nested({
let mut columns = vec![
TableColumn::new("data", "Data").essential(true),
TableColumn::new("status", "Status").essential(true),
];
columns.extend(detail_columns());
columns.push(TableColumn::new("recordId", "Record ID"));
columns
}),
]
}

Expand Down Expand Up @@ -220,7 +246,10 @@ pub(super) fn command() -> RuntimeCommandSpec {
}
},
};
outcomes.push((record_value(rec).unwrap_or("(no data)").to_string(), err));
outcomes.push((
record_label_value(rec).unwrap_or_else(|| "(no data)".to_owned()),
err,
));
}

summarize_delete_outcomes(&domain, &record_type, &name, &outcomes)
Expand Down Expand Up @@ -323,12 +352,48 @@ mod tests {
#[test]
fn dry_run_delete_preview_shows_tlsa_certificate_data_as_the_value() {
let cert = "d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971";
// No numeric fields: it falls back to the certificate alone, not null.
let existing = vec![test_tlsa_record("r1", cert)];
let preview = dry_run_delete_preview("example.com", "TLSA", "www", &existing);
let records = preview["records"].as_array().expect("records array");
assert_eq!(records[0]["data"], cert);
}

/// Two TLSA records with the same certificate, port and protocol that differ
/// only in usage are different records, and `delete --type TLSA --name www`
/// removes both: the preview has to show which is which.
#[test]
fn dry_run_delete_preview_tells_tlsa_records_apart_by_usage_selector_and_matching_type() {
let cert = "d2abde240d7cd3ee6b4b28c54df034b97983a1d16e8a410e4561cb106618e971";
let tlsa = |id: &str, usage: u8, selector: u8, matching: u8| types::DnsRecord {
usage: Some(types::TlsaUsage(usage)),
selector: Some(types::TlsaSelector(selector)),
matching_type: Some(types::TlsaMatchingType(matching)),
port: Some(443),
protocol: Some("_tcp".to_owned()),
..test_tlsa_record(id, cert)
};
let existing = vec![tlsa("r1", 3, 1, 1), tlsa("r2", 1, 0, 2)];

let preview = dry_run_delete_preview("example.com", "TLSA", "www", &existing);

let records = preview["records"].as_array().expect("records array");
assert_eq!(records[0]["data"], format!("3 1 1 {cert}"));
assert_eq!(records[1]["data"], format!("1 0 2 {cert}"));
assert_ne!(records[0]["data"], records[1]["data"]);
}

#[test]
fn a_record_that_is_not_tlsa_is_labelled_by_its_plain_value() {
let a = test_record("r1", "1.2.3.4");
assert_eq!(record_label_value(&a).as_deref(), Some("1.2.3.4"));
let none = types::DnsRecord {
data: None,
..test_record("r2", "")
};
assert_eq!(record_label_value(&none), None);
}

/// A record without a recordId can't actually be deleted (the real
/// handler reports it as a failure) — the preview must not claim it as
/// a delete either.
Expand Down Expand Up @@ -381,6 +446,64 @@ mod tests {
}
}

fn test_srv_record(record_id: &str, service: &str, port: u16) -> types::DnsRecord {
types::DnsRecord {
data: Some("chat-server.example.com.".to_owned()),
name: "chat".to_owned(),
port: Some(port),
priority: Some(10),
weight: Some(5),
protocol: Some("_tcp".to_owned()),
service: Some(service.to_owned()),
type_: types::DnsRecordType("SRV".to_owned()),
..test_record(record_id, "")
}
}

/// Deleting `--type SRV --name chat` removes every service under it, so the
/// preview has to say which services those are: otherwise the rows are
/// identical and the customer cannot see what is about to go.
#[test]
fn dry_run_delete_preview_tells_srv_records_apart() {
let existing = vec![
test_srv_record("r1", "_sip", 5060),
test_srv_record("r2", "_xmpp", 5222),
];
let preview = dry_run_delete_preview("example.com", "SRV", "chat", &existing);

let records = preview["records"].as_array().expect("records array");
assert_eq!(records[0]["service"], "_sip");
assert_eq!(records[1]["port"], 5222);

let rendered = cli_engine::preview_human_view(preview, &view_columns());
assert!(
rendered.contains("SERVICE") && rendered.contains("PORT"),
"{rendered}"
);
assert!(
rendered.contains("_sip") && rendered.contains("_xmpp"),
"{rendered}"
);
}

#[test]
fn dry_run_delete_preview_adds_no_columns_for_plain_records() {
let existing = vec![test_record("r1", "1.2.3.4"), test_record("r2", "5.6.7.8")];
let preview = dry_run_delete_preview("example.com", "A", "www", &existing);

let rendered = cli_engine::preview_human_view(preview, &view_columns());

for sparse in [
"SERVICE", "PORT", "PRIORITY", "PROTOCOL", "WEIGHT", "TAG", "FLAG",
] {
assert!(!rendered.contains(sparse), "{sparse} shown: {rendered}");
}
assert!(
rendered.contains("1.2.3.4") && rendered.contains("would delete"),
"{rendered}"
);
}

/// Proves `view_columns()`'s field names actually match what
/// `dry_run_delete_preview` emits — a mismatch here would silently drop
/// the record breakdown from human output the same way the `api
Expand Down
2 changes: 1 addition & 1 deletion rust/src/dns/guides/dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Some record types need extra flags:
| `TLSA` | `--usage`, `--selector`, `--matching-type`, `--port`, `--protocol` | |
| `CAA` | `--tag` (`issue`, `issuewild` or `iodef`); `--data` carries the CA domain or value | `--flag` (defaults to `0`) |

`--service` and `--protocol` take the plain name, e.g. `--service sip --protocol tcp`. GoDaddy stores them with a leading underscore (`_sip._tcp`), which `gddy` adds for you; `--service _sip` works too. Any name made of letters, digits, `-` and `_` (up to 62 characters before the underscore) is accepted, so custom services work. Where they are shown (`--fields service,protocol`, or JSON), they appear in the underscore form, since that is the DNS name.
`--service` and `--protocol` take the plain name, e.g. `--service sip --protocol tcp`. GoDaddy stores them with a leading underscore (`_sip._tcp`), which `gddy` adds for you; `--service _sip` works too. Any name made of letters, digits, `-` and `_` (up to 62 characters before the underscore) is accepted, so custom services work. Listings show the underscore form, since that is the DNS name.

Example SRV record:

Expand Down
Loading
Loading