mirror of
https://github.com/google/nomulus.git
synced 2025-04-30 12:07:51 +02:00
51f5c8bcfe
This improves the tests by:
1) Adding tests for alphabetical ordering of the command maps, to keep them
organized, and fixing existing mis-orderings. Note that this is a no-op
test for RegistryTool since it uses ImmutableSortedMap (to resort the
commands after inserting GtechTool.COMMAND_MAP), but it'll be relevant
in the upcoming CL when they get merged. I changed GtechTool.COMMAND_MAP
to use regular ImmutableMap.
2) Checking that RegistryTool.COMMAND_MAP (the full map, after the existing
GtechTool.COMMAND_MAP has been merged in) contains the exact same set of
commands as all the concrete classes implementing Command that we can find.
This is a stronger test than what we had before, which just checked that
every Command class appeared in RegistryTool (i.e. that RegistryTool's
commands are a superset of all Commands found). You'd think that it'd be
impossible for RegistryTool to contain commands that aren't in the set of
Commands we found, but it is if we're not searching for commands properly,
which we weren't (we were only checking within the .tools package and not
within any subpackages (e.g. tools.javascrap). This has now been fixed.
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=134451859
103 lines
4.1 KiB
Java
103 lines
4.1 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;
|
|
|
|
import static com.google.common.base.CaseFormat.LOWER_UNDERSCORE;
|
|
import static com.google.common.base.CaseFormat.UPPER_CAMEL;
|
|
import static com.google.common.reflect.Reflection.getPackageName;
|
|
import static com.google.common.truth.Truth.assertThat;
|
|
|
|
import com.google.common.collect.ImmutableSet;
|
|
import com.google.common.collect.Sets;
|
|
import com.google.common.reflect.ClassPath;
|
|
import com.google.common.reflect.ClassPath.ClassInfo;
|
|
import com.google.common.truth.Expect;
|
|
import java.io.IOException;
|
|
import java.lang.reflect.Modifier;
|
|
import java.util.Map;
|
|
import org.junit.Before;
|
|
import org.junit.Rule;
|
|
import org.junit.Test;
|
|
import org.junit.runner.RunWith;
|
|
import org.junit.runners.JUnit4;
|
|
|
|
/** Unit tests for {@link RegistryTool}. */
|
|
@RunWith(JUnit4.class)
|
|
public class RegistryToolTest {
|
|
|
|
@Rule
|
|
public final Expect expect = Expect.create();
|
|
|
|
@Before
|
|
public void init() {
|
|
RegistryToolEnvironment.UNITTEST.setup();
|
|
}
|
|
|
|
@Test
|
|
public void test_commandMap_namesAreInAlphabeticalOrder() throws Exception {
|
|
assertThat(RegistryTool.COMMAND_MAP.keySet()).isStrictlyOrdered();
|
|
}
|
|
|
|
@Test
|
|
public void test_commandMap_includesAllCommands() throws Exception {
|
|
ImmutableSet<?> commandMapClasses = ImmutableSet.copyOf(RegistryTool.COMMAND_MAP.values());
|
|
ImmutableSet<?> classLoaderClasses = getAllCommandClasses();
|
|
// Not using plain old containsExactlyElementsIn() since it produces a huge unreadable blob.
|
|
assertThat(
|
|
Sets.difference(commandMapClasses, classLoaderClasses))
|
|
.named("command classes in RegistryTool.COMMAND_MAP but not found by class loader")
|
|
.isEmpty();
|
|
assertThat(
|
|
Sets.difference(classLoaderClasses, commandMapClasses))
|
|
.named("command classes found by class loader but not in RegistryTool.COMMAND_MAP")
|
|
.isEmpty();
|
|
}
|
|
|
|
@Test
|
|
public void test_commandMap_namesAreDerivedFromClassNames() throws Exception {
|
|
for (Map.Entry<String, ? extends Class<? extends Command>> commandEntry :
|
|
RegistryTool.COMMAND_MAP.entrySet()) {
|
|
String className = commandEntry.getValue().getSimpleName();
|
|
expect.that(commandEntry.getKey())
|
|
// JCommander names should match the class name, up to "Command" and case formatting.
|
|
.isEqualTo(UPPER_CAMEL.to(LOWER_UNDERSCORE, className.replaceFirst("Command$", "")));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets the set of all non-abstract classes implementing the {@link Command} interface (abstract
|
|
* class and interface subtypes of Command aren't expected to have cli commands). Note that this
|
|
* also filters out HelpCommand, which has special handling in {@link RegistryCli} and isn't in
|
|
* the command map.
|
|
*
|
|
* @throws IOException if reading the classpath resources fails.
|
|
*/
|
|
@SuppressWarnings("unchecked")
|
|
private ImmutableSet<Class<? extends Command>> getAllCommandClasses() throws IOException {
|
|
ImmutableSet.Builder<Class<? extends Command>> builder = new ImmutableSet.Builder<>();
|
|
for (ClassInfo classInfo : ClassPath
|
|
.from(getClass().getClassLoader())
|
|
.getTopLevelClassesRecursive(getPackageName(getClass()))) {
|
|
Class<?> clazz = classInfo.load();
|
|
if (Command.class.isAssignableFrom(clazz)
|
|
&& !Modifier.isAbstract(clazz.getModifiers())
|
|
&& !Modifier.isInterface(clazz.getModifiers())
|
|
&& !clazz.equals(HelpCommand.class)) {
|
|
builder.add((Class<? extends Command>) clazz);
|
|
}
|
|
}
|
|
return builder.build();
|
|
}
|
|
}
|