org.eclipse.mylyn.trac.tests.ui.TracRepositorySettingsPageTest.java Source code

Java tutorial

Introduction

Here is the source code for org.eclipse.mylyn.trac.tests.ui.TracRepositorySettingsPageTest.java

Source

/*******************************************************************************
 * Copyright (c) 2006, 2010 Steffen Pingel and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Steffen Pingel - initial API and implementation
 *******************************************************************************/

package org.eclipse.mylyn.trac.tests.ui;

import junit.framework.TestCase;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Status;
import org.eclipse.jface.dialogs.IMessageProvider;
import org.eclipse.jface.wizard.Wizard;
import org.eclipse.jface.wizard.WizardDialog;
import org.eclipse.mylyn.commons.net.AuthenticationCredentials;
import org.eclipse.mylyn.commons.net.AuthenticationType;
import org.eclipse.mylyn.internal.tasks.ui.TasksUiPlugin;
import org.eclipse.mylyn.internal.tasks.ui.wizards.EditRepositoryWizard;
import org.eclipse.mylyn.internal.trac.core.TracRepositoryConnector;
import org.eclipse.mylyn.internal.trac.core.client.ITracClient;
import org.eclipse.mylyn.internal.trac.core.client.ITracClient.Version;
import org.eclipse.mylyn.internal.trac.ui.wizard.TracRepositorySettingsPage;
import org.eclipse.mylyn.internal.trac.ui.wizard.TracRepositorySettingsPage.TracValidator;
import org.eclipse.mylyn.tasks.core.TaskRepository;
import org.eclipse.mylyn.tests.util.TasksUiTestUtil;
import org.eclipse.mylyn.trac.tests.support.TracFixture;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.PlatformUI;

/**
 * @author Steffen Pingel
 */
public class TracRepositorySettingsPageTest extends TestCase {

    // make protected methods visible
    private static class MyTracRepositorySettingsPage extends TracRepositorySettingsPage {

        public MyTracRepositorySettingsPage(TaskRepository taskRepository) {
            super(taskRepository);
        }

        @Override
        protected void applyValidatorResult(Validator validator) {
            // see AbstractRespositorySettingsPage.validate()
            if (validator.getStatus() == null) {
                validator.setStatus(Status.OK_STATUS);
            }
            super.applyValidatorResult(validator);
        }

        @Override
        protected boolean isValidUrl(String name) {
            return super.isValidUrl(name);
        }

    }

    private MyTracRepositorySettingsPage page;

    private TracValidator validator;

    private WizardDialog dialog;

    private TracFixture fixture;

    public TracRepositorySettingsPageTest() {
    }

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

        page = new MyTracRepositorySettingsPage(null);

        // stub wizard and dialog
        Wizard wizard = new Wizard() {
            @Override
            public boolean performFinish() {
                return true;
            }
        };
        wizard.addPage(page);
        dialog = new WizardDialog(null, wizard);
        dialog.create();
        //      page.createControl(dialog.getShell());
        //      page.setVisible(true);

        fixture = TracFixture.current();
    }

    @Override
    protected void tearDown() throws Exception {
        if (dialog != null) {
            dialog.close();
        }
    }

    protected void initialize(TracFixture fixture) throws Exception {
        // initialize page from test fixture
        TaskRepository repository = fixture.repository();
        page.setAnonymous(false);
        page.setUrl(repository.getRepositoryUrl());
        AuthenticationCredentials credentials = repository.getCredentials(AuthenticationType.REPOSITORY);
        page.setUserId(credentials == null ? null : credentials.getUserName());
        page.setPassword(credentials == null ? null : credentials.getPassword());
        page.setTracVersion(fixture.getAccessMode());

        validator = page.new TracValidator(page.createTaskRepository(), fixture.getAccessMode());
    }

    public void testValidate() throws Exception {
        initialize(fixture);

        validator.run(new NullProgressMonitor());
        assertNull(validator.getResult());
        assertNull(validator.getStatus());

        page.applyValidatorResult(validator);
        assertEquals(fixture.getAccessMode(), page.getTracVersion());
        assertEquals("Authentication credentials are valid.", page.getMessage());
    }

    public void testValidateAutomaticUser() throws Exception {
        initialize(fixture);

        page.setTracVersion(null);
        validator = page.new TracValidator(page.createTaskRepository(), null);

        validator.run(new NullProgressMonitor());
        assertEquals(Version.XML_RPC, validator.getResult());
        assertNull(validator.getStatus());

        page.applyValidatorResult(validator);
        assertEquals(Version.XML_RPC, page.getTracVersion());
        assertEquals("Authentication credentials are valid.", page.getMessage());
    }

    public void testValidateAutomaticAnonymous() throws Exception {
        initialize(fixture);

        page.setUserId("");
        page.setPassword("");
        page.setTracVersion(null);
        validator = page.new TracValidator(page.createTaskRepository(), null);

        validator.run(new NullProgressMonitor());
        assertEquals(Version.TRAC_0_9, validator.getResult());
        assertNotNull(validator.getStatus());

        page.applyValidatorResult(validator);
        assertEquals(Version.TRAC_0_9, page.getTracVersion());
        assertEquals(
                "Authentication credentials are valid. Note: Insufficient permissions for XML-RPC access, falling back to web access.",
                page.getMessage());
    }

    public void testValidateInvalid() throws Exception {
        initialize(fixture);

        page.setUrl("http://mylyn.org/doesnotexist");
        page.setTracVersion(null);
        validator = page.new TracValidator(page.createTaskRepository(), null);

        try {
            validator.run(new NullProgressMonitor());
            fail("Expected CoreException");
        } catch (CoreException e) {
            validator.setStatus(e.getStatus());
        }

        page.applyValidatorResult(validator);
        assertNull(page.getTracVersion());
        assertEquals(IMessageProvider.ERROR, page.getMessageType());
    }

    public void testValidUrl() throws Exception {
        assertFalse(page.isValidUrl(""));
        assertFalse(page.isValidUrl("http:/google.com"));
        assertFalse(page.isValidUrl("http:/google.com/"));
        assertFalse(page.isValidUrl("http://google.com/"));
        assertFalse(page.isValidUrl("http://google.com/foo /space"));

        assertTrue(page.isValidUrl("http://google.com"));
        assertTrue(page.isValidUrl("https://google.com"));
        assertTrue(page.isValidUrl("http://mylyn.org/trac30"));
        assertTrue(page.isValidUrl("http://www.mylyn.org/trac30"));
    }

    public void testClientManagerChangeTaskRepositorySettings() throws Exception {
        TracRepositoryConnector connector = fixture.connector();
        TaskRepository repository = fixture.singleRepository();
        repository.setVersion(Version.TRAC_0_9.name());
        ITracClient client = connector.getClientManager().getTracClient(repository);
        assertEquals(Version.TRAC_0_9, client.getAccessMode());

        TasksUiTestUtil.ensureTasksUiInitialization();

        EditRepositoryWizard wizard = new EditRepositoryWizard(repository,
                TasksUiPlugin.getConnectorUi(repository.getConnectorKind()));
        Shell shell = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell();
        WizardDialog dialog = new WizardDialog(shell, wizard);
        try {
            dialog.create();

            ((TracRepositorySettingsPage) wizard.getSettingsPage()).setTracVersion(Version.XML_RPC);
            assertTrue(wizard.performFinish());

            client = connector.getClientManager().getTracClient(repository);
            assertEquals(Version.XML_RPC, client.getAccessMode());
        } finally {
            dialog.close();
        }
    }

}