vaadin-framework/server/src/test/java/com/vaadin/tests/design/ComponentFactoryTest.java

/*
 * Copyright 2000-2016 Vaadin Ltd.
 *
 * 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 com.vaadin.tests.design;

import java.io.ByteArrayInputStream;
import java.util.ArrayList;
import java.util.List;

import org.junit.After;
import org.junit.Assert;
import org.junit.Test;

import com.vaadin.ui.AbstractComponent;
import com.vaadin.ui.Label;
import com.vaadin.ui.declarative.Design;
import com.vaadin.ui.declarative.Design.ComponentFactory;
import com.vaadin.ui.declarative.DesignContext;
import com.vaadin.ui.declarative.DesignException;

public class ComponentFactoryTest {

    private static final ComponentFactory defaultFactory = Design
            .getComponentFactory();

    private static final ThreadLocal<ComponentFactory> currentComponentFactory = new ThreadLocal<>();

    // Set static component factory that delegate to a thread local factory
    static {
        Design.setComponentFactory(
                (String fullyQualifiedClassName, DesignContext context) -> {
                    ComponentFactory componentFactory = currentComponentFactory
                            .get();
                    if (componentFactory == null) {
                        componentFactory = defaultFactory;
                    }
                    return componentFactory
                            .createComponent(fullyQualifiedClassName, context);
                });
    }

    @Test(expected = IllegalArgumentException.class)
    public void testSetNullComponentFactory() {
        Design.setComponentFactory(null);
    }

    @Test
    public void testComponentFactoryLogging() {
        final List<String> messages = new ArrayList<>();
        currentComponentFactory
                .set((ComponentFactory) (String fullyQualifiedClassName,
                        DesignContext context) -> {
                    messages.add("Requested class " + fullyQualifiedClassName);
                    return defaultFactory
                            .createComponent(fullyQualifiedClassName, context);
                });

        Design.read(new ByteArrayInputStream("<vaadin-label />".getBytes()));

        Assert.assertEquals("There should be one message logged", 1,
                messages.size());
        Assert.assertEquals("Requested class " + Label.class.getCanonicalName(),
                messages.get(0));
    }

    @Test(expected = DesignException.class)
    public void testComponentFactoryReturningNull() {
        currentComponentFactory
                .set((ComponentFactory) (String fullyQualifiedClassName,
                        DesignContext context) -> null);

        Design.read(new ByteArrayInputStream("<vaadin-label />".getBytes()));
    }

    @Test(expected = DesignException.class)
    public void testComponentFactoryThrowingStuff() {
        currentComponentFactory.set((ComponentFactory) (
                String fullyQualifiedClassName,
                // Will throw because class is not found
                DesignContext context) -> defaultFactory.createComponent(
                        "foobar." + fullyQualifiedClassName, context));

        Design.read(new ByteArrayInputStream("<vaadin-label />".getBytes()));
    }

    @Test
    public void testGetDefaultInstanceUsesComponentFactory() {
        final List<String> classes = new ArrayList<>();
        currentComponentFactory
                .set((ComponentFactory) (String fullyQualifiedClassName,
                        DesignContext context) -> {
                    classes.add(fullyQualifiedClassName);
                    return defaultFactory
                            .createComponent(fullyQualifiedClassName, context);
                });

        DesignContext designContext = new DesignContext();
        designContext.getDefaultInstance(new DefaultInstanceTestComponent());

        Assert.assertEquals("There should be one class requests", 1,
                classes.size());
        Assert.assertEquals(
                "First class should be DefaultInstanceTestComponent",
                DefaultInstanceTestComponent.class.getName(), classes.get(0));
    }

    @After
    public void cleanup() {
        currentComponentFactory.remove();
    }

    public static class DefaultInstanceTestComponent extends AbstractComponent {
    }
}