org.eclipse.gmf.tests.runtime.emf.type.core/src/org/eclipse/gmf/tests/runtime/emf/type/core/AbstractEditHelperTest.java

/******************************************************************************
 * Copyright (c) 2005, 2006 IBM Corporation 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:
 *    IBM Corporation - initial API and implementation 
 ****************************************************************************/

package org.eclipse.gmf.tests.runtime.emf.type.core;

import junit.framework.Test;
import junit.framework.TestSuite;
import junit.textui.TestRunner;

import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.gmf.runtime.common.core.command.ICommand;
import org.eclipse.gmf.runtime.emf.type.core.requests.CreateElementRequest;
import org.eclipse.gmf.runtime.emf.type.core.requests.CreateRelationshipRequest;
import org.eclipse.gmf.runtime.emf.type.core.requests.IEditCommandRequest;
import org.eclipse.gmf.runtime.emf.type.core.requests.SetRequest;
import org.eclipse.gmf.tests.runtime.emf.type.core.employee.Department;
import org.eclipse.gmf.tests.runtime.emf.type.core.internal.EmployeeType;

public class AbstractEditHelperTest
    extends AbstractEMFTypeTest {

    private Department department;

    public AbstractEditHelperTest(String name) {
        super(name);
    }

    public static void main(String[] args) {
        TestRunner.run(suite());
    }

    public static Test suite() {
        return new TestSuite(AbstractEditHelperTest.class);
    }

    protected void doModelSetup(Resource resource) {

        department = (Department) getEmployeeFactory().create(
            getEmployeePackage().getDepartment());
        department.setName("Department"); //$NON-NLS-1$

        resource.getContents().add(department);

    }

    public void test_defaultContainmentFeature() {
        // Verifies that if a containment feature is specified in the element
        // type XML, it is used as the default

        CreateElementRequest request = new CreateElementRequest(
            getEditingDomain(), department, EmployeeType.MANAGER);
        EmployeeType.DEPARTMENT.getEditCommand(request);
        assertSame(getEmployeePackage().getDepartment_Manager(), request
            .getContainmentFeature());
    }

    public void test_replaceDefaultEditCommand() {

        CreateElementRequest request = new CreateElementRequest(
            getEditingDomain(), department, EmployeeType.MANAGER);

        // Get the default command
        ICommand command = EmployeeType.DEPARTMENT.getEditCommand(request);
        assertNotNull(command);

        // Replace the default command
        request.setParameter(IEditCommandRequest.REPLACE_DEFAULT_COMMAND,
            Boolean.TRUE);
        command = EmployeeType.DEPARTMENT.getEditCommand(request);
        assertNull(command);
    }
    
    /**
     * Tests that the command returned by an edit helper to create a new
     * relationship is executable if the source or target has not yet been
     * specified.
     */
    public void test_incompleteCreateRelationshipRequest_117922() {

        // no target
        CreateRelationshipRequest request = new CreateRelationshipRequest(
            getEditingDomain(), department, department, null,
            EmployeeType.MANAGER);

        ICommand command = EmployeeType.DEPARTMENT.getEditCommand(request);
        assertNotNull(command);
        assertTrue(command.canExecute());
        
        // no source AND no target
        request = new CreateRelationshipRequest(
            getEditingDomain(), department, null, null,
            EmployeeType.MANAGER);

        command = EmployeeType.DEPARTMENT.getEditCommand(request);
        assertTrue(command == null || !command.canExecute());
    }
    
    /**
     * Tests the canEdit() method on an edit helper.
     */
    public void test_canEdit_122771() {
        
        // allowed to create a manager in a department
        CreateElementRequest request = new CreateElementRequest(
            getEditingDomain(), department, EmployeeType.MANAGER);

        boolean canEdit = EmployeeType.DEPARTMENT.getEditHelper().canEdit(request);
        assertTrue(canEdit);
        
        canEdit = EmployeeType.DEPARTMENT.canEdit(request);
        assertTrue(canEdit);

        // not allowed to create an office in a department
        request = new CreateElementRequest(
            getEditingDomain(), department, EmployeeType.OFFICE);

        canEdit = EmployeeType.DEPARTMENT.getEditHelper().canEdit(request);
        assertFalse(canEdit);
        
        canEdit = EmployeeType.DEPARTMENT.canEdit(request);
        assertFalse(canEdit);
    }
    
    /**
     * Tests that the edit helper is consulted to approve edit requests.
     */
    public void test_approveRequest_133160() {
        
        // Request is approved by the DepartmentEditHelper
        SetRequest setRequest = new SetRequest(department,
            getEmployeePackage().getDepartment_Number(), new Integer(123456));
        
        boolean canEdit = EmployeeType.DEPARTMENT.getEditHelper().canEdit(setRequest);
        assertTrue(canEdit);
        Object parameter = setRequest.getParameter("approved"); //$NON-NLS-1$
        assertSame(Boolean.TRUE, parameter);
        
        // reset the parameter
        setRequest.setParameter("approved", null); //$NON-NLS-1$
        
        ICommand command = EmployeeType.DEPARTMENT.getEditHelper().getEditCommand(setRequest);
        assertNotNull(command);
        assertTrue(command.canExecute());
        parameter = setRequest.getParameter("approved"); //$NON-NLS-1$
        assertSame(Boolean.TRUE, parameter);
        
        // Request is not approved by the DepartmentEditHelper
        setRequest = new SetRequest(department,
            getEmployeePackage().getDepartment_Number(), new Integer(0));
        
        canEdit = EmployeeType.DEPARTMENT.getEditHelper().canEdit(setRequest);
        assertFalse(canEdit);
        parameter = setRequest.getParameter("approved"); //$NON-NLS-1$
        assertSame(Boolean.FALSE, parameter);
        
        // reset the parameter
        setRequest.setParameter("approved", null); //$NON-NLS-1$
        
        command = EmployeeType.DEPARTMENT.getEditHelper().getEditCommand(setRequest);
        assertNull(command);
        parameter = setRequest.getParameter("approved"); //$NON-NLS-1$
        assertSame(Boolean.FALSE, parameter);
    }
}