mirror of
https://github.com/google/nomulus
synced 2026-08-20 14:16:19 +00:00
This change replaces all Ref objects in the code with Key objects. These are
stored in datastore as the same object (raw datastore keys), so this is not
a model change.
Our best practices doc says to use Keys not Refs because:
* The .get() method obscures what's actually going on
- Much harder to visually audit the code for datastore loads
- Hard to distinguish Ref<T> get()'s from Optional get()'s and Supplier get()'s
* Implicit ofy().load() offers much less control
- Antipattern for ultimate goal of making Ofy injectable
- Can't control cache use or batch loading without making ofy() explicit anyway
* Serialization behavior is surprising and could be quite dangerous/incorrect
- Can lead to serialization errors. If it actually worked "as intended",
it would lead to a Ref<> on a serialized object being replaced upon
deserialization with a stale copy of the old value, which could potentially
break all kinds of transactional expectations
* Having both Ref<T> and Key<T> introduces extra boilerplate everywhere
- E.g. helper methods all need to have Ref and Key overloads, or you need to
call .key() to get the Key<T> for every Ref<T> you want to pass in
- Creating a Ref<T> is more cumbersome, since it doesn't have all the create()
overloads that Key<T> has, only create(Key<T>) and create(Entity) - no way to
create directly from kind+ID/name, raw Key, websafe key string, etc.
(Note that Refs are treated specially by Objectify's @Load method and Keys are not;
we don't use that feature, but it is the one advantage Refs have over Keys.)
The direct impetus for this change is that I am trying to audit our use of memcache,
and the implicit .get() calls to datastore were making that very hard.
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=131965491
135 lines
5.3 KiB
Java
135 lines
5.3 KiB
Java
// Copyright 2016 The Domain Registry 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.testing.DatastoreHelper.persistResource;
|
|
import static google.registry.testing.DatastoreHelper.persistSimpleResources;
|
|
import static google.registry.whois.WhoisHelper.loadWhoisTestFile;
|
|
|
|
import com.google.common.collect.ImmutableList;
|
|
import com.google.common.collect.ImmutableSet;
|
|
import google.registry.model.registrar.Registrar;
|
|
import google.registry.model.registrar.RegistrarAddress;
|
|
import google.registry.model.registrar.RegistrarContact;
|
|
import google.registry.testing.AppEngineRule;
|
|
import google.registry.testing.FakeClock;
|
|
import org.joda.time.DateTime;
|
|
import org.junit.Rule;
|
|
import org.junit.Test;
|
|
import org.junit.runner.RunWith;
|
|
import org.junit.runners.JUnit4;
|
|
|
|
/** Unit tests for {@link RegistrarWhoisResponse}. */
|
|
@RunWith(JUnit4.class)
|
|
public class RegistrarWhoisResponseTest {
|
|
|
|
@Rule
|
|
public final AppEngineRule gae = AppEngineRule.builder().withDatastore().build();
|
|
|
|
private final FakeClock clock = new FakeClock(DateTime.parse("2009-05-29T20:15:00Z"));
|
|
|
|
@Test
|
|
public void getTextOutputTest() {
|
|
Registrar registrar = new Registrar.Builder()
|
|
.setClientIdentifier("exregistrar")
|
|
.setRegistrarName("Example Registrar, Inc.")
|
|
.setType(Registrar.Type.REAL)
|
|
.setIanaIdentifier(8L)
|
|
.setState(Registrar.State.ACTIVE)
|
|
.setLocalizedAddress(new RegistrarAddress.Builder()
|
|
.setStreet(ImmutableList.of("1234 Admiralty Way"))
|
|
.setCity("Marina del Rey")
|
|
.setState("CA")
|
|
.setZip("90292")
|
|
.setCountryCode("US")
|
|
.build())
|
|
.setPhoneNumber("+1.3105551212")
|
|
.setFaxNumber("+1.3105551213")
|
|
.setEmailAddress("registrar@example.tld")
|
|
.setWhoisServer("whois.example-registrar.tld")
|
|
.setReferralUrl("http://www.example-registrar.tld")
|
|
.build();
|
|
// Use the registrar key for contacts' parent.
|
|
ImmutableList<RegistrarContact> contacts = ImmutableList.of(
|
|
new RegistrarContact.Builder()
|
|
.setParent(registrar)
|
|
.setName("Joe Registrar")
|
|
.setEmailAddress("joeregistrar@example-registrar.tld")
|
|
.setPhoneNumber("+1.3105551213")
|
|
.setFaxNumber("+1.3105551213")
|
|
.setTypes(ImmutableSet.of(RegistrarContact.Type.ADMIN))
|
|
.setVisibleInWhoisAsAdmin(true)
|
|
.setVisibleInWhoisAsTech(false)
|
|
.build(),
|
|
new RegistrarContact.Builder()
|
|
.setParent(registrar)
|
|
.setName("John Doe")
|
|
.setEmailAddress("johndoe@example-registrar.tld")
|
|
.setPhoneNumber("+1.1111111111")
|
|
.setFaxNumber("+1.1111111111")
|
|
.setTypes(ImmutableSet.of(RegistrarContact.Type.ADMIN))
|
|
.build(),
|
|
new RegistrarContact.Builder()
|
|
.setParent(registrar)
|
|
.setName("Jane Registrar")
|
|
.setEmailAddress("janeregistrar@example-registrar.tld")
|
|
.setPhoneNumber("+1.3105551214")
|
|
.setFaxNumber("+1.3105551213")
|
|
.setTypes(ImmutableSet.of(RegistrarContact.Type.ADMIN))
|
|
.setVisibleInWhoisAsAdmin(true)
|
|
.build(),
|
|
new RegistrarContact.Builder()
|
|
.setParent(registrar)
|
|
.setName("Jane Doe")
|
|
.setEmailAddress("janedoe@example-registrar.tld")
|
|
.setPhoneNumber("+1.1111111112")
|
|
.setFaxNumber("+1.1111111112")
|
|
.setTypes(ImmutableSet.of(RegistrarContact.Type.TECH))
|
|
.build(),
|
|
new RegistrarContact.Builder()
|
|
.setParent(registrar)
|
|
.setName("John Geek")
|
|
.setEmailAddress("johngeek@example-registrar.tld")
|
|
.setPhoneNumber("+1.3105551215")
|
|
.setFaxNumber("+1.3105551216")
|
|
.setTypes(ImmutableSet.of(RegistrarContact.Type.TECH))
|
|
.setVisibleInWhoisAsTech(true)
|
|
.build());
|
|
persistSimpleResources(contacts);
|
|
persistResource(registrar);
|
|
|
|
RegistrarWhoisResponse registrarWhoisResponse =
|
|
new RegistrarWhoisResponse(registrar, clock.nowUtc());
|
|
assertThat(registrarWhoisResponse.getPlainTextOutput(false, "Doodle Disclaimer"))
|
|
.isEqualTo(loadWhoisTestFile("whois_registrar.txt"));
|
|
}
|
|
|
|
@Test
|
|
public void testSetOfFields() {
|
|
Registrar registrar = new Registrar.Builder()
|
|
.setClientIdentifier("exregistrar")
|
|
.setType(Registrar.Type.REAL)
|
|
.setIanaIdentifier(8L)
|
|
.setState(Registrar.State.ACTIVE)
|
|
.build();
|
|
|
|
RegistrarWhoisResponse registrarWhoisResponse =
|
|
new RegistrarWhoisResponse(registrar, clock.nowUtc());
|
|
// Just make sure this doesn't NPE.
|
|
registrarWhoisResponse.getPlainTextOutput(false, "Doodle Disclaimer");
|
|
}
|
|
}
|