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
100 changes: 100 additions & 0 deletions core/src/main/java/google/registry/tools/RdapQueryCommand.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
// Copyright 2025 The Nomulus Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package google.registry.tools;

import static com.google.common.base.Preconditions.checkState;

import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters;
import com.google.common.collect.ImmutableMap;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonElement;
import com.google.gson.JsonParser;
import google.registry.config.RegistryConfig.Config;
import google.registry.request.Action.Service;
import jakarta.inject.Inject;
import java.io.IOException;
import java.util.Optional;
import javax.annotation.Nullable;

/** Command to manually perform an authenticated RDAP query. */
@Parameters(separators = " =", commandDescription = "Manually perform an authenticated RDAP query")
public final class RdapQueryCommand implements CommandWithConnection {

private static final Gson GSON = new GsonBuilder().setPrettyPrinting().create();

enum RdapQueryType {
DOMAIN("/rdap/domain/%s"),
DOMAIN_SEARCH("/rdap/domains", "name"),
NAMESERVER("/rdap/nameserver/%s"),
NAMESERVER_SEARCH("/rdap/nameservers", "name"),
ENTITY("/rdap/entity/%s"),
ENTITY_SEARCH("/rdap/entities", "fn");

private final String pathFormat;
private final Optional<String> searchParamKey;

RdapQueryType(String pathFormat) {
this(pathFormat, null);
}

RdapQueryType(String pathFormat, @Nullable String searchParamKey) {
this.pathFormat = pathFormat;
this.searchParamKey = Optional.ofNullable(searchParamKey);
}

String getQueryPath(String queryTerm) {
return searchParamKey.isPresent() ? pathFormat : String.format(pathFormat, queryTerm);
}

ImmutableMap<String, String> getQueryParameters(String queryTerm) {
return searchParamKey.map(key -> ImmutableMap.of(key, queryTerm)).orElse(ImmutableMap.of());
}
}

@Parameter(names = "--type", description = "The type of RDAP query to perform.", required = true)
private RdapQueryType type;

@Parameter(
description = "The main query term (e.g., a domain name or search pattern).",
required = true)
private String queryTerm;

@Inject ServiceConnection defaultConnection;

@Inject
@Config("useCanary")
boolean useCanary;

@Override
public void setConnection(ServiceConnection connection) {
this.defaultConnection = connection;
}

@Override
public void run() throws IOException {
checkState(defaultConnection != null, "ServiceConnection was not set by RegistryCli.");

String path = type.getQueryPath(queryTerm);
ImmutableMap<String, String> queryParams = type.getQueryParameters(queryTerm);

ServiceConnection pubapiConnection = defaultConnection.withService(Service.PUBAPI, useCanary);
String rdapResponse = pubapiConnection.sendGetRequest(path, queryParams);

JsonElement rdapJson = JsonParser.parseString(rdapResponse);
System.out.println(GSON.toJson(rdapJson));
}
}
1 change: 1 addition & 0 deletions core/src/main/java/google/registry/tools/RegistryTool.java
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ public final class RegistryTool {
.put("login", LoginCommand.class)
.put("logout", LogoutCommand.class)
.put("pending_escrow", PendingEscrowCommand.class)
.put("rdap_query", RdapQueryCommand.class)
.put("recreate_billing_recurrences", RecreateBillingRecurrencesCommand.class)
.put("registrar_poc", RegistrarPocCommand.class)
.put("renew_domain", RenewDomainCommand.class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,8 @@ interface RegistryToolComponent {

void inject(PendingEscrowCommand command);

void inject(RdapQueryCommand command);

void inject(RenewDomainCommand command);

void inject(SaveSqlCredentialCommand command);
Expand Down
145 changes: 145 additions & 0 deletions core/src/test/java/google/registry/tools/RdapQueryCommandTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
// Copyright 2025 The Nomulus Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package google.registry.tools;

import static com.google.common.truth.Truth.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import com.beust.jcommander.ParameterException;
import com.google.common.collect.ImmutableMap;
import google.registry.request.Action.Service;
import java.io.IOException;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.mockito.junit.jupiter.MockitoSettings;
import org.mockito.quality.Strictness;

/** Unit tests for {@link RdapQueryCommand}. */
@ExtendWith(MockitoExtension.class)
@MockitoSettings(strictness = Strictness.LENIENT)
class RdapQueryCommandTest extends CommandTestCase<RdapQueryCommand> {

@Mock private ServiceConnection mockDefaultConnection;
@Mock private ServiceConnection mockPubapiConnection;

@BeforeEach
void beforeEach() {
command.setConnection(mockDefaultConnection);
command.useCanary = false;

when(mockDefaultConnection.withService(Service.PUBAPI, false)).thenReturn(mockPubapiConnection);
}

private void mockGetResponse(
String path, ImmutableMap<String, ?> queryParams, String responseBody) throws IOException {
when(mockPubapiConnection.sendGetRequest(path, queryParams)).thenReturn(responseBody);
}

@Test
void testSuccess_domainLookup() throws Exception {
String path = "/rdap/domain/example.dev";
String responseJson = "{\"ldhName\":\"example.dev\"}";
mockGetResponse(path, ImmutableMap.of(), responseJson);

runCommand("--type=DOMAIN", "example.dev");
verify(mockPubapiConnection).sendGetRequest(path, ImmutableMap.of());

assertInStdout("{\n \"ldhName\": \"example.dev\"\n}");
}

@Test
void testSuccess_domainSearch() throws Exception {
String path = "/rdap/domains";
ImmutableMap<String, String> query = ImmutableMap.of("name", "exam*.dev");
String responseJson = "{\"domainSearchResults\":[{\"ldhName\":\"example.dev\"}]}";
mockGetResponse(path, query, responseJson);

runCommand("--type=DOMAIN_SEARCH", "exam*.dev");
verify(mockPubapiConnection).sendGetRequest(path, query);

assertInStdout(
"{\n"
+ " \"domainSearchResults\": [\n"
+ " {\n"
+ " \"ldhName\": \"example.dev\"\n"
+ " }\n"
+ " ]\n"
+ "}");
}

@Test
void testSuccess_nameserverLookup() throws Exception {
String path = "/rdap/nameserver/ns1.example.com";
mockGetResponse(path, ImmutableMap.of(), "{}");
runCommand("--type=NAMESERVER", "ns1.example.com");
verify(mockPubapiConnection).sendGetRequest(path, ImmutableMap.of());
assertInStdout("{}\n");
}

@Test
void testSuccess_nameserverSearch() throws Exception {
String path = "/rdap/nameservers";
ImmutableMap<String, String> query = ImmutableMap.of("name", "ns*.example.com");
mockGetResponse(path, query, "{}");
runCommand("--type=NAMESERVER_SEARCH", "ns*.example.com");
verify(mockPubapiConnection).sendGetRequest(path, query);
assertInStdout("{}\n");
}

@Test
void testSuccess_entityLookup() throws Exception {
String path = "/rdap/entity/123-FOO";
mockGetResponse(path, ImmutableMap.of(), "{}");
runCommand("--type=ENTITY", "123-FOO");
verify(mockPubapiConnection).sendGetRequest(path, ImmutableMap.of());
assertInStdout("{}\n");
}

@Test
void testSuccess_entitySearch() throws Exception {
String path = "/rdap/entities";
ImmutableMap<String, String> query = ImmutableMap.of("fn", "John*");
mockGetResponse(path, query, "{}");
runCommand("--type=ENTITY_SEARCH", "John*");
verify(mockPubapiConnection).sendGetRequest(path, query);
assertInStdout("{}\n");
}

@Test
void testFailure_missingType() {
assertThrows(ParameterException.class, () -> runCommand("some-term"));
}

@Test
void testFailure_missingQueryTerm() {
assertThrows(ParameterException.class, () -> runCommand("--type=DOMAIN"));
}

@Test
void testFailure_propagatesIoException() throws IOException {
String path = "/rdap/domain/fail.dev";
when(mockPubapiConnection.sendGetRequest(path, ImmutableMap.of()))
.thenThrow(new IOException("HTTP 500: Server on fire"));

IOException thrown =
assertThrows(IOException.class, () -> runCommand("--type=DOMAIN", "fail.dev"));
assertThat(thrown).hasMessageThat().contains("HTTP 500: Server on fire");
}
}
Loading