/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.sshd.common.compression;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.EnumSet;
import java.util.List;
import java.util.Random;
import java.util.Set;
import org.apache.sshd.common.NamedFactory;
import org.apache.sshd.common.NamedResource;
import org.apache.sshd.common.compression.BuiltinCompressions.ParseResult;
import org.apache.sshd.common.util.GenericUtils;
import org.apache.sshd.util.test.BaseTestSupport;
import org.junit.FixMethodOrder;
import org.junit.Test;
import org.junit.runners.MethodSorters;
import org.mockito.Mockito;
/**
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
*/
@FixMethodOrder(MethodSorters.NAME_ASCENDING)
public class BuiltinCompressionsTest extends BaseTestSupport {
public BuiltinCompressionsTest() {
super();
}
@Test
public void testFromFactoryName() {
for (BuiltinCompressions expected : BuiltinCompressions.VALUES) {
String name = expected.getName();
for (int index = 0; index < name.length(); index++) {
BuiltinCompressions actual = BuiltinCompressions.fromFactoryName(name);
assertSame(name, expected, actual);
name = shuffleCase(name);
}
}
}
@Test
public void testAllConstantsCovered() throws Exception {
Set<BuiltinCompressions> avail = EnumSet.noneOf(BuiltinCompressions.class);
Field[] fields = BuiltinCompressions.Constants.class.getFields();
for (Field f : fields) {
String name = (String) f.get(null);
BuiltinCompressions value = BuiltinCompressions.fromFactoryName(name);
assertNotNull("No match found for " + name, value);
assertTrue(name + " re-specified", avail.add(value));
}
assertEquals("Incomplete coverage", BuiltinCompressions.VALUES, avail);
}
@Test
public void testParseCompressionsList() {
List<String> builtin = NamedResource.getNameList(BuiltinCompressions.VALUES);
List<String> unknown = Arrays.asList(getClass().getPackage().getName(), getClass().getSimpleName(), getCurrentTestName());
Random rnd = new Random();
for (int index = 0; index < (builtin.size() + unknown.size()); index++) {
Collections.shuffle(builtin, rnd);
Collections.shuffle(unknown, rnd);
List<String> weavedList = new ArrayList<>(builtin.size() + unknown.size());
for (int bIndex = 0, uIndex = 0; (bIndex < builtin.size()) || (uIndex < unknown.size());) {
boolean useBuiltin = false;
if (bIndex < builtin.size()) {
useBuiltin = uIndex >= unknown.size() || rnd.nextBoolean();
}
if (useBuiltin) {
weavedList.add(builtin.get(bIndex));
bIndex++;
} else if (uIndex < unknown.size()) {
weavedList.add(unknown.get(uIndex));
uIndex++;
}
}
String fullList = GenericUtils.join(weavedList, ',');
ParseResult result = BuiltinCompressions.parseCompressionsList(fullList);
List<String> parsed = NamedResource.getNameList(result.getParsedFactories());
List<String> missing = result.getUnsupportedFactories();
// makes sure not only that the contents are the same but also the order
assertListEquals(fullList + "[parsed]", builtin, parsed);
assertListEquals(fullList + "[unsupported]", unknown, missing);
}
}
@Test
public void testResolveFactoryOnBuiltinValues() {
for (NamedFactory<Compression> expected : BuiltinCompressions.VALUES) {
String name = expected.getName();
NamedFactory<Compression> actual = BuiltinCompressions.resolveFactory(name);
assertSame(name, expected, actual);
}
}
@Test
public void testNotAllowedToRegisterBuiltinFactories() {
for (CompressionFactory expected : BuiltinCompressions.VALUES) {
try {
BuiltinCompressions.registerExtension(expected);
fail("Unexpected sucess for " + expected.getName());
} catch (IllegalArgumentException e) {
// expected - ignored
}
}
}
@Test(expected = IllegalArgumentException.class)
public void testNotAllowedToOverrideRegisteredFactories() {
CompressionFactory expected = Mockito.mock(CompressionFactory.class);
Mockito.when(expected.getName()).thenReturn(getCurrentTestName());
String name = expected.getName();
try {
for (int index = 1; index <= Byte.SIZE; index++) {
BuiltinCompressions.registerExtension(expected);
assertEquals("Unexpected success at attempt #" + index, 1, index);
}
} finally {
BuiltinCompressions.unregisterExtension(name);
}
}
@Test
public void testResolveFactoryOnRegisteredExtension() {
CompressionFactory expected = Mockito.mock(CompressionFactory.class);
Mockito.when(expected.getName()).thenReturn(getCurrentTestName());
String name = expected.getName();
try {
assertNull("Extension already registered", BuiltinCompressions.resolveFactory(name));
BuiltinCompressions.registerExtension(expected);
NamedFactory<Compression> actual = BuiltinCompressions.resolveFactory(name);
assertSame("Mismatched resolved instance", expected, actual);
} finally {
NamedFactory<Compression> actual = BuiltinCompressions.unregisterExtension(name);
assertSame("Mismatched unregistered instance", expected, actual);
assertNull("Extension not un-registered", BuiltinCompressions.resolveFactory(name));
}
}
}