google-nomulus/javatests/google/registry/model/EntityClassesTest.java

// Copyright 2017 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.model;

import static com.google.common.collect.ImmutableSet.toImmutableSet;
import static com.google.common.truth.Truth.assertThat;
import static google.registry.model.EntityClasses.ALL_CLASSES;
import static google.registry.model.EntityClasses.CLASS_TO_KIND_FUNCTION;
import static google.registry.util.TypeUtils.hasAnnotation;
import static java.util.stream.Collectors.toSet;

import com.google.common.collect.Ordering;
import com.googlecode.objectify.annotation.Entity;
import com.googlecode.objectify.annotation.EntitySubclass;
import java.util.Set;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** Unit tests for {@link EntityClasses}. */
@RunWith(JUnit4.class)
public class EntityClassesTest {

  // This implements the manual ordering we've been using for the EntityClasses class lists.
  private static final Ordering<Class<?>> QUALIFIED_CLASS_NAME_ORDERING =
      Ordering.natural()
          .onResultOf(
              clazz -> clazz.getCanonicalName().substring(clazz.getPackage().getName().length()));

  @Test
  public void testEntityClasses_inAlphabeticalOrder() throws Exception {
    assertThat(ALL_CLASSES).isStrictlyOrdered(QUALIFIED_CLASS_NAME_ORDERING);
  }

  @Test
  public void testEntityClasses_baseEntitiesHaveUniqueKinds() throws Exception {
    assertThat(
            ALL_CLASSES
                .stream()
                .filter(hasAnnotation(Entity.class))
                .map(CLASS_TO_KIND_FUNCTION)
                .collect(toImmutableSet()))
        .named("base entity kinds")
        .containsNoDuplicates();
  }

  @Test
  public void testEntityClasses_entitySubclassesHaveKindsMatchingBaseEntities() throws Exception {
    Set<String> baseEntityKinds =
        ALL_CLASSES
            .stream()
            .filter(hasAnnotation(Entity.class))
            .map(CLASS_TO_KIND_FUNCTION)
            .collect(toSet());
    Set<String> entitySubclassKinds =
        ALL_CLASSES
            .stream()
            .filter(hasAnnotation(EntitySubclass.class))
            .map(CLASS_TO_KIND_FUNCTION)
            .collect(toSet());
    assertThat(baseEntityKinds).named("base entity kinds").containsAllIn(entitySubclassKinds);
  }

  @Test
  public void testEntityClasses_eitherBaseEntityOrEntitySubclass() throws Exception {
    for (Class<?> clazz : ALL_CLASSES) {
      boolean isEntityXorEntitySubclass =
          clazz.isAnnotationPresent(Entity.class) ^ clazz.isAnnotationPresent(EntitySubclass.class);
      assertThat(isEntityXorEntitySubclass)
          .named("class " + clazz.getSimpleName() + " is @Entity or @EntitySubclass")
          .isTrue();
    }
  }
}