mirror of
https://github.com/google/nomulus.git
synced 2025-05-02 04:57:51 +02:00
5098b03af4
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
129 lines
6.2 KiB
Java
129 lines
6.2 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.tools.server;
|
|
|
|
import static com.google.appengine.tools.cloudstorage.GcsServiceFactory.createGcsService;
|
|
import static com.google.common.truth.Truth.assertThat;
|
|
import static google.registry.testing.DatastoreHelper.createTld;
|
|
import static google.registry.testing.DatastoreHelper.newDomainResource;
|
|
import static google.registry.testing.DatastoreHelper.newHostResource;
|
|
import static google.registry.testing.DatastoreHelper.persistActiveContact;
|
|
import static google.registry.testing.DatastoreHelper.persistActiveDomain;
|
|
import static google.registry.testing.DatastoreHelper.persistActiveDomainApplication;
|
|
import static google.registry.testing.DatastoreHelper.persistActiveHost;
|
|
import static google.registry.testing.DatastoreHelper.persistResource;
|
|
import static google.registry.testing.GcsTestingUtils.readGcsFile;
|
|
import static google.registry.util.ResourceUtils.readResourceUtf8;
|
|
import static java.nio.charset.StandardCharsets.UTF_8;
|
|
import static org.joda.time.Duration.standardDays;
|
|
|
|
import com.google.appengine.tools.cloudstorage.GcsFilename;
|
|
import com.google.appengine.tools.cloudstorage.GcsService;
|
|
import com.google.common.base.Optional;
|
|
import com.google.common.base.Splitter;
|
|
import com.google.common.collect.ImmutableList;
|
|
import com.google.common.collect.ImmutableMap;
|
|
import com.google.common.collect.ImmutableSet;
|
|
import com.googlecode.objectify.Key;
|
|
import google.registry.mapreduce.MapreduceRunner;
|
|
import google.registry.model.domain.secdns.DelegationSignerData;
|
|
import google.registry.model.host.HostResource;
|
|
import google.registry.testing.FakeClock;
|
|
import google.registry.testing.mapreduce.MapreduceTestCase;
|
|
import java.net.InetAddress;
|
|
import java.util.Map;
|
|
import org.joda.time.DateTime;
|
|
import org.joda.time.DateTimeZone;
|
|
import org.junit.Test;
|
|
import org.junit.runner.RunWith;
|
|
import org.junit.runners.JUnit4;
|
|
|
|
/** Tests for {@link GenerateZoneFilesAction}.*/
|
|
@RunWith(JUnit4.class)
|
|
public class GenerateZoneFilesActionTest extends MapreduceTestCase<GenerateZoneFilesAction> {
|
|
|
|
private final GcsService gcsService = createGcsService();
|
|
|
|
@Test
|
|
public void testGenerate() throws Exception {
|
|
DateTime now = DateTime.now(DateTimeZone.UTC).withTimeAtStartOfDay();
|
|
|
|
createTld("tld");
|
|
createTld("com");
|
|
|
|
ImmutableSet<InetAddress> ips =
|
|
ImmutableSet.of(InetAddress.getByName("127.0.0.1"), InetAddress.getByName("::1"));
|
|
HostResource host1 =
|
|
persistResource(newHostResource("ns.foo.tld").asBuilder().addInetAddresses(ips).build());
|
|
HostResource host2 =
|
|
persistResource(newHostResource("ns.bar.tld").asBuilder().addInetAddresses(ips).build());
|
|
|
|
ImmutableSet<Key<HostResource>> nameservers =
|
|
ImmutableSet.of(Key.create(host1), Key.create(host2));
|
|
persistResource(newDomainResource("ns-and-ds.tld").asBuilder()
|
|
.addNameservers(nameservers)
|
|
.setDsData(ImmutableSet.of(DelegationSignerData.create(1, 2, 3, new byte[] {0, 1, 2})))
|
|
.build());
|
|
persistResource(newDomainResource("ns-only.tld").asBuilder()
|
|
.addNameservers(nameservers)
|
|
.build());
|
|
persistResource(newDomainResource("ds-only.tld").asBuilder()
|
|
.setDsData(ImmutableSet.of(DelegationSignerData.create(1, 2, 3, new byte[] {0, 1, 2})))
|
|
.build());
|
|
|
|
// These should be ignored; contact and applications aren't in DNS, hosts need to be from the
|
|
// same tld and have ip addresses, and domains need to be from the same tld and have hosts.
|
|
persistActiveContact("ignored_contact");
|
|
persistActiveDomainApplication("ignored_application.tld");
|
|
persistActiveHost("ignored.host.tld"); // No ips.
|
|
persistActiveDomain("ignored_domain.tld"); // No hosts or DS data.
|
|
persistResource(newHostResource("ignored.foo.com").asBuilder().addInetAddresses(ips).build());
|
|
persistResource(newDomainResource("ignored.com")
|
|
.asBuilder()
|
|
.addNameservers(nameservers)
|
|
.setDsData(ImmutableSet.of(DelegationSignerData.create(1, 2, 3, new byte[] {0, 1, 2})))
|
|
.build());
|
|
|
|
GenerateZoneFilesAction action = new GenerateZoneFilesAction();
|
|
action.mrRunner = new MapreduceRunner(Optional.<Integer>absent(), Optional.<Integer>absent());
|
|
action.bucket = "zonefiles-bucket";
|
|
action.gcsBufferSize = 123;
|
|
action.datastoreRetention = standardDays(29);
|
|
action.clock = new FakeClock(now.plusMinutes(2)); // Move past the actions' 2 minute check.
|
|
|
|
Map<String, Object> response = action.handleJsonRequest(ImmutableMap.<String, Object>of(
|
|
"tlds", ImmutableList.of("tld"),
|
|
"exportTime", now));
|
|
assertThat(response).containsEntry(
|
|
"filenames",
|
|
ImmutableList.of("gs://zonefiles-bucket/tld-" + now + ".zone"));
|
|
|
|
executeTasksUntilEmpty("mapreduce");
|
|
|
|
GcsFilename gcsFilename =
|
|
new GcsFilename("zonefiles-bucket", String.format("tld-%s.zone", now));
|
|
String generatedFile = new String(readGcsFile(gcsService, gcsFilename), UTF_8);
|
|
// The generated file contains spaces and tabs, but the golden file contains only spaces, as
|
|
// files with literal tabs irritate our build tools.
|
|
Splitter splitter = Splitter.on('\n').omitEmptyStrings();
|
|
Iterable<String> generatedFileLines = splitter.split(generatedFile.replaceAll("\t", " "));
|
|
Iterable<String> goldenFileLines =
|
|
splitter.split(readResourceUtf8(getClass(), "testdata/tld.zone"));
|
|
// The first line needs to be the same as the golden file.
|
|
assertThat(generatedFileLines.iterator().next()).isEqualTo(goldenFileLines.iterator().next());
|
|
// The remaining lines can be in any order.
|
|
assertThat(generatedFileLines).containsExactlyElementsIn(goldenFileLines);
|
|
}
|
|
}
|