src/test/java/org/codehaus/plexus/evaluator/sources/DefaultExpressionEvaluatorTest.java

package org.codehaus.plexus.evaluator.sources;

/*
 * 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.
 */

import junit.framework.TestCase;
import org.codehaus.plexus.evaluator.DefaultExpressionEvaluator;
import org.codehaus.plexus.evaluator.EvaluatorException;
import org.codehaus.plexus.evaluator.ExpressionEvaluator;

import java.util.Properties;

/**
 * DefaultExpressionEvaluatorTest
 *
 * @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a>
 * @version $Id$
 */
public class DefaultExpressionEvaluatorTest
    extends TestCase
{
    private ExpressionEvaluator evaluator;

    protected void setUp()
        throws Exception
    {
        super.setUp();

        evaluator = new DefaultExpressionEvaluator();
    }

    public void testSimple()
        throws EvaluatorException
    {
        Properties props = new Properties();
        props.setProperty( "fruit", "apple" );

        PropertiesExpressionSource propsSource = new PropertiesExpressionSource();
        propsSource.setProperties( props );
        evaluator.addExpressionSource( propsSource );

        String expression = "${fruit}";
        String expected = "apple";

        String actual = evaluator.expand( expression );
        assertEquals( expected, actual );
    }

    public void testSimpleStartOfLine()
        throws EvaluatorException
    {
        Properties props = new Properties();
        props.setProperty( "fruit", "apple" );

        PropertiesExpressionSource propsSource = new PropertiesExpressionSource();
        propsSource.setProperties( props );
        evaluator.addExpressionSource( propsSource );

        String expression = "${fruit} is good for you.";
        String expected = "apple is good for you.";

        String actual = evaluator.expand( expression );
        assertEquals( expected, actual );
    }

    public void testSimpleEndOfLine()
        throws EvaluatorException
    {
        Properties props = new Properties();
        props.setProperty( "fruit", "apple" );

        PropertiesExpressionSource propsSource = new PropertiesExpressionSource();
        propsSource.setProperties( props );
        evaluator.addExpressionSource( propsSource );

        String expression = "watch out for the worm in the ${fruit}";
        String expected = "watch out for the worm in the apple";

        String actual = evaluator.expand( expression );
        assertEquals( expected, actual );
    }

    public void testSimpleSystemProperty()
        throws EvaluatorException
    {
        evaluator.addExpressionSource( new SystemPropertyExpressionSource() );

        String userHome = System.getProperty( "user.home" );
        String expression = "My HOME directory is ${user.home}";
        String expected = "My HOME directory is " + userHome;

        String actual = evaluator.expand( expression );
        assertEquals( expected, actual );
    }

    public void testMultiExpression()
        throws EvaluatorException
    {
        evaluator.addExpressionSource( new SystemPropertyExpressionSource() );

        String userName = System.getProperty( "user.name" );
        String userHome = System.getProperty( "user.home" );
        String expression = "${user.name}'s home directory is ${user.home}";
        String expected = userName + "'s home directory is " + userHome;

        String actual = evaluator.expand( expression );
        assertEquals( expected, actual );
    }

    /**
     * This use case was discovered by a user of archiva.
     * The last expression doesn't get evaluated properly.
     * <p/>
     * The result (with the bug) was "2.0.4${prj.ver.suf}"
     */
    public void testMultiExpressionVersionBug()
        throws EvaluatorException
    {
        Properties props = new Properties();
        props.setProperty( "prj.ver.maj", "2" );
        props.setProperty( "prj.ver.min", "0" );
        props.setProperty( "prj.ver.inc", "4" );
        props.setProperty( "prj.ver.suf", "-SNAPSHOT" );

        PropertiesExpressionSource propsSource = new PropertiesExpressionSource();
        propsSource.setProperties( props );
        evaluator.addExpressionSource( propsSource );

        String expression = "${prj.ver.maj}.${prj.ver.min}.${prj.ver.inc}${prj.ver.suf}";
        String expected = "2.0.4-SNAPSHOT";

        String actual = evaluator.expand( expression );
        assertEquals( expected, actual );
    }

    public void testEscaping()
        throws EvaluatorException
    {
        evaluator.addExpressionSource( new SystemPropertyExpressionSource() );

        String userName = System.getProperty( "user.name" );
        String userHome = System.getProperty( "user.home" );
        String expression = "${user.name}'s home directory is ${user.home} (fetched via $${user.home} expression)";
        String expected = userName + "'s home directory is " + userHome + " (fetched via ${user.home} expression)";

        String actual = evaluator.expand( expression );
        assertEquals( expected, actual );
    }

    public void testRecursiveSimple()
        throws EvaluatorException
    {
        PropertiesExpressionSource propsource = new PropertiesExpressionSource();
        Properties props = new Properties();

        // Create intentional recursive lookup.
        props.setProperty( "main.dir", "${target.dir}/classes" );
        props.setProperty( "target.dir", "./target" );

        propsource.setProperties( props );

        evaluator.addExpressionSource( propsource );
        evaluator.addExpressionSource( new SystemPropertyExpressionSource() );

        String expression = "My classes directory is ${main.dir}";
        String expected = "My classes directory is ./target/classes";

        String actual = evaluator.expand( expression );
        assertEquals( expected, actual );
    }

    public void testRecursiveCycle()
    {
        PropertiesExpressionSource propsource = new PropertiesExpressionSource();
        Properties props = new Properties();

        // Create intentional recursive lookup.
        props.setProperty( "main.dir", "${test.dir}/target/classes" );
        props.setProperty( "test.dir", "${main.dir}/target/test-classes" );

        propsource.setProperties( props );

        evaluator.addExpressionSource( propsource );
        evaluator.addExpressionSource( new SystemPropertyExpressionSource() );

        try
        {
            evaluator.expand( "My main dir is ${main.dir}" );
            fail( "Should have thrown an EvaluatorException due to recursive cycle." );
        }
        catch ( EvaluatorException e )
        {
            // Expected path.
        }
    }
}