mirror of
https://github.com/google/nomulus.git
synced 2025-07-07 03:33:28 +02:00
Disable whois caching in nomulus tool (#980)
* Disable whois caching in nomulus tool The whois commands previously served output generated from cached EppResource objects in most cases. While this is entirely appropriate from server-side, it is less useful when these commands are run from nomulus tool and, in fact, when run from the "shell" command this results in changes that have been applied from the shell not being visible from a subsequent "whois". The command may instead serve information on an earlier, cached version of the resource instead of the latest version. This implementation uses dagger for parameterization of cached/non-cached modes. I did consider the possibility of simply parameterizing the query commands in all cases as discussed, however, having gone down the daggerization path and having gotten it to work, I have to say I find this approach preferrable. There's really no case for identifying cached/non-cached on a per-command basis and doing so would require propagating the flag throughout all levels of the API and all callsites. Tested: In addition to the new unit test which explicitly verifies the caching/noncaching behavior of the new commands, tested the actual failing sequence from "nomulus -e sandbox shell" and verified that the correct results are served after a mutation. * Fixed copyright year * More copyright date fixes * Added WhoisCommandFactoryTest to fragile tests I suspect that this test has some contention with other tests, it's not clear why.
This commit is contained in:
Michael Muller
GitHub
parent
b75eb0ad95
commit
e07139665e
14 changed files with 428 additions and 79 deletions
|
|
@ -96,7 +96,7 @@ public class WhoisActionTest {
|
|||
whoisAction.input = new StringReader(input);
|
||||
whoisAction.response = response;
|
||||
whoisAction.whoisReader =
|
||||
new WhoisReader(new WhoisCommandFactory(), "Please contact registrar");
|
||||
new WhoisReader(WhoisCommandFactory.createCached(), "Please contact registrar");
|
||||
whoisAction.whoisMetrics = new WhoisMetrics();
|
||||
whoisAction.metricBuilder = WhoisMetric.builderForRequest(clock);
|
||||
whoisAction.disclaimer =
|
||||
|
|
|
|||
|
|
@ -0,0 +1,240 @@
|
|||
// Copyright 2021 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.whois;
|
||||
|
||||
import static com.google.common.truth.Truth.assertThat;
|
||||
import static google.registry.persistence.transaction.TransactionManagerFactory.tm;
|
||||
import static google.registry.testing.DatabaseHelper.newDomainBase;
|
||||
import static google.registry.testing.DatabaseHelper.newHostResource;
|
||||
import static google.registry.testing.DatabaseHelper.newRegistry;
|
||||
import static google.registry.testing.DatabaseHelper.persistNewRegistrar;
|
||||
import static google.registry.testing.DatabaseHelper.persistResource;
|
||||
|
||||
import com.google.common.collect.ImmutableSet;
|
||||
import com.google.common.net.InternetDomainName;
|
||||
import google.registry.config.RegistryConfig;
|
||||
import google.registry.model.domain.DomainBase;
|
||||
import google.registry.model.host.HostResource;
|
||||
import google.registry.model.registrar.Registrar;
|
||||
import google.registry.testing.AppEngineExtension;
|
||||
import google.registry.testing.FakeClock;
|
||||
import google.registry.testing.TestCacheExtension;
|
||||
import java.net.InetAddress;
|
||||
import org.joda.time.Duration;
|
||||
import org.junit.jupiter.api.AfterEach;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.extension.RegisterExtension;
|
||||
|
||||
class WhoisCommandFactoryTest {
|
||||
|
||||
FakeClock clock = new FakeClock();
|
||||
|
||||
@RegisterExtension
|
||||
final AppEngineExtension appEngine =
|
||||
AppEngineExtension.builder().withDatastoreAndCloudSql().withClock(clock).build();
|
||||
|
||||
@RegisterExtension
|
||||
final TestCacheExtension testCacheExtension =
|
||||
new TestCacheExtension.Builder().withEppResourceCache(Duration.millis(1000000000)).build();
|
||||
|
||||
WhoisCommandFactory noncachedFactory = WhoisCommandFactory.createNonCached();
|
||||
WhoisCommandFactory cachedFactory = WhoisCommandFactory.createCached();
|
||||
DomainBase domain;
|
||||
HostResource host;
|
||||
Registrar otherRegistrar;
|
||||
|
||||
int origSingletonCacheRefreshSeconds;
|
||||
|
||||
@BeforeEach
|
||||
void setUp() throws Exception {
|
||||
persistResource(newRegistry("tld", "TLD"));
|
||||
host =
|
||||
newHostResource("ns.example.tld")
|
||||
.asBuilder()
|
||||
.setInetAddresses(ImmutableSet.of(InetAddress.getByName("1.2.3.4")))
|
||||
.build();
|
||||
persistResource(host);
|
||||
domain = newDomainBase("example.tld", host);
|
||||
persistResource(domain);
|
||||
otherRegistrar = persistNewRegistrar("OtherRegistrar");
|
||||
otherRegistrar =
|
||||
persistResource(
|
||||
otherRegistrar
|
||||
.asBuilder()
|
||||
.setState(Registrar.State.ACTIVE)
|
||||
.setPhoneNumber("+1.2223334444")
|
||||
.build());
|
||||
|
||||
// In addition to the TestCacheExtension, we have to set a long singleton cache timeout.
|
||||
RegistryConfig.CONFIG_SETTINGS.get().caching.singletonCacheRefreshSeconds = 1000000;
|
||||
}
|
||||
|
||||
@AfterEach
|
||||
void tearDown() {
|
||||
// Restore the singleton cache timeout. For some reason, this doesn't work if we store the
|
||||
// original value in an instance variable (I suspect there may be some overlap in test
|
||||
// execution) so just restore to zero.
|
||||
RegistryConfig.CONFIG_SETTINGS.get().caching.singletonCacheRefreshSeconds = 0;
|
||||
}
|
||||
|
||||
@Test
|
||||
void testNonCached_NameserverLookupByHostCommand() throws Exception {
|
||||
WhoisResponse response =
|
||||
noncachedFactory
|
||||
.nameserverLookupByHost(InternetDomainName.from("ns.example.tld"))
|
||||
.executeQuery(clock.nowUtc());
|
||||
assertThat(response.getResponse(false, "").plainTextOutput())
|
||||
.contains("Registrar: The Registrar");
|
||||
|
||||
// Note that we can't use persistResource() for these as that clears the cache.
|
||||
tm().transact(
|
||||
() ->
|
||||
tm().put(
|
||||
host.asBuilder()
|
||||
.setPersistedCurrentSponsorClientId("OtherRegistrar")
|
||||
.build()));
|
||||
response =
|
||||
noncachedFactory
|
||||
.nameserverLookupByHost(InternetDomainName.from("ns.example.tld"))
|
||||
.executeQuery(clock.nowUtc());
|
||||
assertThat(response.getResponse(false, "").plainTextOutput())
|
||||
.contains("Registrar: OtherRegistrar name");
|
||||
}
|
||||
|
||||
@Test
|
||||
void testCached_NameserverLookupByHostCommand() throws Exception {
|
||||
WhoisResponse response =
|
||||
cachedFactory
|
||||
.nameserverLookupByHost(InternetDomainName.from("ns.example.tld"))
|
||||
.executeQuery(clock.nowUtc());
|
||||
assertThat(response.getResponse(false, "").plainTextOutput())
|
||||
.contains("Registrar: The Registrar");
|
||||
|
||||
tm().transact(
|
||||
() ->
|
||||
tm().put(
|
||||
host.asBuilder()
|
||||
.setPersistedCurrentSponsorClientId("OtherRegistrar")
|
||||
.build()));
|
||||
response =
|
||||
cachedFactory
|
||||
.nameserverLookupByHost(InternetDomainName.from("ns.example.tld"))
|
||||
.executeQuery(clock.nowUtc());
|
||||
assertThat(response.getResponse(false, "").plainTextOutput())
|
||||
.contains("Registrar: The Registrar");
|
||||
}
|
||||
|
||||
@Test
|
||||
void testNonCached_DomainLookupCommand() throws Exception {
|
||||
WhoisResponse response =
|
||||
noncachedFactory
|
||||
.domainLookup(InternetDomainName.from("example.tld"), true, "REDACTED")
|
||||
.executeQuery(clock.nowUtc());
|
||||
assertThat(response.getResponse(false, "").plainTextOutput())
|
||||
.contains("Registrar: The Registrar");
|
||||
|
||||
tm().transact(
|
||||
() ->
|
||||
tm().put(
|
||||
domain
|
||||
.asBuilder()
|
||||
.setPersistedCurrentSponsorClientId("OtherRegistrar")
|
||||
.build()));
|
||||
response =
|
||||
noncachedFactory
|
||||
.domainLookup(InternetDomainName.from("example.tld"), true, "REDACTED")
|
||||
.executeQuery(clock.nowUtc());
|
||||
assertThat(response.getResponse(false, "").plainTextOutput())
|
||||
.contains("Registrar: OtherRegistrar name");
|
||||
}
|
||||
|
||||
@Test
|
||||
void testCached_DomainLookupCommand() throws Exception {
|
||||
WhoisResponse response =
|
||||
cachedFactory
|
||||
.domainLookup(InternetDomainName.from("example.tld"), true, "REDACTED")
|
||||
.executeQuery(clock.nowUtc());
|
||||
assertThat(response.getResponse(false, "").plainTextOutput())
|
||||
.contains("Registrar: The Registrar");
|
||||
|
||||
tm().transact(
|
||||
() ->
|
||||
tm().put(
|
||||
domain
|
||||
.asBuilder()
|
||||
.setPersistedCurrentSponsorClientId("OtherRegistrar")
|
||||
.build()));
|
||||
response =
|
||||
cachedFactory
|
||||
.domainLookup(InternetDomainName.from("example.tld"), true, "REDACTED")
|
||||
.executeQuery(clock.nowUtc());
|
||||
assertThat(response.getResponse(false, "").plainTextOutput())
|
||||
.contains("Registrar: The Registrar");
|
||||
}
|
||||
|
||||
@Test
|
||||
void testNonCached_RegistrarLookupCommand() throws Exception {
|
||||
WhoisResponse response =
|
||||
noncachedFactory.registrarLookup("OtherRegistrar").executeQuery(clock.nowUtc());
|
||||
assertThat(response.getResponse(false, "").plainTextOutput())
|
||||
.contains("Phone Number: +1.2223334444");
|
||||
|
||||
tm().transact(
|
||||
() -> tm().put(otherRegistrar.asBuilder().setPhoneNumber("+1.2345677890").build()));
|
||||
response = noncachedFactory.registrarLookup("OtherRegistrar").executeQuery(clock.nowUtc());
|
||||
assertThat(response.getResponse(false, "").plainTextOutput())
|
||||
.contains("Phone Number: +1.2345677890");
|
||||
}
|
||||
|
||||
@Test
|
||||
void testCached_RegistrarLookupCommand() throws Exception {
|
||||
WhoisResponse response =
|
||||
cachedFactory.registrarLookup("OtherRegistrar").executeQuery(clock.nowUtc());
|
||||
assertThat(response.getResponse(false, "").plainTextOutput())
|
||||
.contains("Phone Number: +1.2223334444");
|
||||
|
||||
tm().transact(
|
||||
() -> tm().put(otherRegistrar.asBuilder().setPhoneNumber("+1.2345677890").build()));
|
||||
response = cachedFactory.registrarLookup("OtherRegistrar").executeQuery(clock.nowUtc());
|
||||
assertThat(response.getResponse(false, "").plainTextOutput())
|
||||
.contains("Phone Number: +1.2223334444");
|
||||
}
|
||||
|
||||
@Test
|
||||
void testNonCached_NameserverLookupByIpCommand() throws Exception {
|
||||
// Note that this lookup currently doesn't cache the hosts, so there's no point in testing the
|
||||
// "cached" case. This test is here so that it will fail if anyone adds caching.
|
||||
WhoisResponse response =
|
||||
noncachedFactory
|
||||
.nameserverLookupByIp(InetAddress.getByName("1.2.3.4"))
|
||||
.executeQuery(clock.nowUtc());
|
||||
assertThat(response.getResponse(false, "").plainTextOutput())
|
||||
.contains("Registrar: The Registrar");
|
||||
|
||||
tm().transact(
|
||||
() ->
|
||||
tm().put(
|
||||
host.asBuilder()
|
||||
.setPersistedCurrentSponsorClientId("OtherRegistrar")
|
||||
.build()));
|
||||
response =
|
||||
noncachedFactory
|
||||
.nameserverLookupByIp(InetAddress.getByName("1.2.3.4"))
|
||||
.executeQuery(clock.nowUtc());
|
||||
assertThat(response.getResponse(false, "").plainTextOutput())
|
||||
.contains("Registrar: OtherRegistrar");
|
||||
}
|
||||
}
|
||||
|
|
@ -78,7 +78,7 @@ class WhoisHttpActionTest {
|
|||
whoisAction.requestPath = WhoisHttpAction.PATH + pathInfo;
|
||||
whoisAction.response = response;
|
||||
whoisAction.whoisReader =
|
||||
new WhoisReader(new WhoisCommandFactory(), "Please contact registrar");
|
||||
new WhoisReader(WhoisCommandFactory.createCached(), "Please contact registrar");
|
||||
whoisAction.whoisMetrics = new WhoisMetrics();
|
||||
whoisAction.metricBuilder = WhoisMetric.builderForRequest(clock);
|
||||
whoisAction.disclaimer =
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ class WhoisReaderTest {
|
|||
@SuppressWarnings({"TypeParameterUnusedInFormals", "unchecked"})
|
||||
<T> T readCommand(String commandStr) throws Exception {
|
||||
return (T)
|
||||
new WhoisReader(new WhoisCommandFactory(), "Please contact registrar")
|
||||
new WhoisReader(WhoisCommandFactory.createCached(), "Please contact registrar")
|
||||
.readCommand(new StringReader(commandStr), false, clock.nowUtc());
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue