AuthenticationRule.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.test.ui;

import org.junit.rules.MethodRule;
import org.junit.runners.model.FrameworkMethod;
import org.junit.runners.model.Statement;

import static org.xwiki.test.ui.AbstractTest.getUtil;

/**
 * Authenticates a user in the wiki before the test starts.
 *
 * @version $Id: 7c852682d03bc94c96ab7363266cd841f99a498b $
 * @since 5.1M1
 */
public class AuthenticationRule implements MethodRule
{
    private String userName;

    private String userPassword;

    private TestUtils util;

    private boolean isAdvanced;

    public AuthenticationRule(String userName, String userPassword, TestUtils util)
    {
        this.userName = userName;
        this.userPassword = userPassword;
        this.util = util;
    }

    /**
     * @since 9.3-rc-1
     */
    public AuthenticationRule(String userName, String userPassword, boolean isAdvanced, TestUtils util)
    {
        this(userName, userPassword, util);
        this.isAdvanced = isAdvanced;
    }

    @Override
    public Statement apply(final Statement base, final FrameworkMethod method, final Object target)
    {
        return new Statement()
        {
            @Override
            public void evaluate() throws Throwable
            {
                authenticate();
                if (isAdvanced) {
                    getUtil().updateObject("XWiki", "Admin", "XWiki.XWikiUsers", 0, "usertype", "Advanced");
                }

                base.evaluate();
            }
        };
    }

    public void authenticate()
    {
        this.util.login(this.userName, this.userPassword);
    }
}