org.openvpms.macro.impl.MacroFunctionsTestCase.java Source code

Introduction

Here is the source code for org.openvpms.macro.impl.MacroFunctionsTestCase.java

Source

/*
 * Version: 1.0
 *
 * The contents of this file are subject to the OpenVPMS License Version
 * 1.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.openvpms.org/license/
 *
 * Software distributed under the License is distributed on an 'AS IS' basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Copyright 2015 (C) OpenVPMS Ltd. All Rights Reserved.
 */

package org.openvpms.macro.impl;

import org.apache.commons.jxpath.FunctionLibrary;
import org.apache.commons.jxpath.JXPathContext;
import org.junit.Before;
import org.junit.Test;
import org.openvpms.archetype.function.factory.ArchetypeFunctionsFactory;
import org.openvpms.archetype.function.factory.DefaultArchetypeFunctionsFactory;
import org.openvpms.archetype.rules.doc.DocumentHandlers;
import org.openvpms.archetype.test.ArchetypeServiceTest;
import org.openvpms.archetype.test.TestHelper;
import org.openvpms.component.business.domain.im.party.Party;
import org.openvpms.component.business.service.archetype.IArchetypeService;
import org.openvpms.component.system.common.jxpath.JXPathHelper;
import org.openvpms.macro.Macros;
import org.openvpms.report.ReportFactory;

import static org.junit.Assert.assertEquals;

/**
 * Tests the {@link MacroFunctions} class.
 *
 * @author Tim Anderson
 */
public class MacroFunctionsTestCase extends ArchetypeServiceTest {

    /**
     * The macros.
     */
    private Macros macros;

    /**
     * The JXPath extension functions factory.
     */
    private ArchetypeFunctionsFactory functions;

    /**
     * Sets up the test case.
     */
    @Before
    public void setUp() {
        MacroTestHelper.createMacro("displayName", "openvpms:get(., 'displayName')");
        MacroTestHelper.createMacro("numbertest", "concat('input number: ', $number)");

        final IArchetypeService service = getArchetypeService();
        functions = new DefaultArchetypeFunctionsFactory(service, getLookupService(), null, null) {
            @Override
            public FunctionLibrary create(IArchetypeService service) {
                FunctionLibrary library = super.create(service);
                library.addFunctions(create("macro", new MacroFunctions(macros)));
                return library;
            }
        };

        ReportFactory factory = new ReportFactory(service, getLookupService(), new DocumentHandlers(), functions);
        macros = new LookupMacros(getLookupService(), service, factory);
    }

    /**
     * Tests the single argument version:
     * <pre>
     *   macro:eval('macroname')
     * </pre>
     * This evaluates the macro against the context object.
     */
    @Test
    public void testSingleArgEval() {
        Party customer = TestHelper.createCustomer(false);
        JXPathContext ctx = createContext(customer);
        assertEquals("Customer", ctx.getValue("macro:eval('displayName')"));
    }

    /**
     * Tests the two argument version:
     * <pre>
     *   macro:eval('macroname', somecontext)
     * </pre>
     * This evaluates the macro against the specified context object.
     */
    @Test
    public void testTwoArgEval() {
        Party customer = TestHelper.createCustomer(false);

        JXPathContext ctx = createContext(customer);
        assertEquals("Customer", ctx.getValue("macro:eval('displayName', .)"));

        ctx = createContext(new Object());
        ctx.getVariables().declareVariable("customer", customer);
        assertEquals("Customer", ctx.getValue("macro:eval('displayName', $customer)"));
    }

    /**
     * Tests that numeric prefixes are expanded as the $number variable.
     */
    @Test
    public void testNumericPrefix() {
        Object dummy = new Object();
        JXPathContext ctx = createContext(dummy);

        // verify that when no prefix is specified, the number doesn't evaluate
        // to anything
        Object text1 = ctx.getValue("macro:eval('numbertest')");
        assertEquals("input number: ", text1);

        Object text2 = ctx.getValue("macro:eval('99numbertest')");
        assertEquals("input number: 99", text2);
    }

    private JXPathContext createContext(Object object) {
        return JXPathHelper.newContext(object, functions.create());
    }

}