source: josm/trunk/test/unit/org/openstreetmap/josm/command/CommandTest.java@ 12718

// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.command;

import static org.junit.Assert.assertSame;

import java.util.Arrays;
import java.util.Collection;

import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.openstreetmap.josm.data.coor.LatLon;
import org.openstreetmap.josm.data.osm.DataSet;
import org.openstreetmap.josm.data.osm.Node;
import org.openstreetmap.josm.data.osm.OsmPrimitive;
import org.openstreetmap.josm.data.osm.Relation;
import org.openstreetmap.josm.data.osm.RelationMember;
import org.openstreetmap.josm.data.osm.User;
import org.openstreetmap.josm.data.osm.Way;
import org.openstreetmap.josm.gui.MainApplication;
import org.openstreetmap.josm.gui.layer.OsmDataLayer;
import org.openstreetmap.josm.testutils.JOSMTestRules;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import nl.jqno.equalsverifier.EqualsVerifier;
import nl.jqno.equalsverifier.Warning;

/**
 * Unit tests of {@link Command} class.
 */
public class CommandTest {

    /**
     * We need prefs for nodes / data sets.
     */
    @Rule
    @SuppressFBWarnings(value = "URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD")
    public JOSMTestRules test = new JOSMTestRules().preferences().i18n();
    private CommandTestData testData;

    /**
     * Set up the test data.
     */
    @Before
    public void createTestData() {
        testData = new CommandTestData();
    }

    /**
     * Test {@link Command#getLayer()}
     * @deprecated to be removed end of 2017
     */
    @Test
    @Deprecated
    public void testGetLayer() {
        OsmDataLayer layer2 = new OsmDataLayer(new DataSet(), "test", null);
        Command command = new NopCommand();
        Command command2 = new NopCommand(layer2.data);
        assertSame(testData.layer, command.getLayer());
        assertSame(layer2, command2.getLayer());
    }

    /**
     * Unit test of methods {@link Command#equals} and {@link Command#hashCode}.
     */
    @Test
    public void testEqualsContract() {
        EqualsVerifier.forClass(Command.class).usingGetClass()
            .withPrefabValues(DataSet.class,
                new DataSet(), new DataSet())
            .withPrefabValues(User.class,
                    User.createOsmUser(1, "foo"), User.createOsmUser(2, "bar"))
            .withPrefabValues(OsmDataLayer.class,
                new OsmDataLayer(new DataSet(), "1", null), new OsmDataLayer(new DataSet(), "2", null))
            .suppress(Warning.NONFINAL_FIELDS)
            .verify();
    }

    private static final class NopCommand extends Command {
        NopCommand() {
            super();
        }

        NopCommand(DataSet dataset) {
            super(dataset);
        }

        @Override
        public String getDescriptionText() {
            return "";
        }

        @Override
        public void fillModifiedData(Collection<OsmPrimitive> modified, Collection<OsmPrimitive> deleted,
                Collection<OsmPrimitive> added) {
            // nop
        }
    }

    /**
     * A change test data consisting of two nodes and a way.
     * @author Michael Zangl
     */
    public static class CommandTestData {
        /**
         * A test layer
         */
        public final OsmDataLayer layer;
        /**
         * A test node
         */
        public final Node existingNode;
        /**
         * A second test node
         */
        public final Node existingNode2;
        /**
         * A test way
         */
        public final Way existingWay;

        /**
         * Creates the new test data and adds {@link #layer} to the layer manager.
         */
        public CommandTestData() {
            layer = new OsmDataLayer(new DataSet(), "layer", null);
            MainApplication.getLayerManager().addLayer(layer);

            existingNode = createNode(5);
            existingNode2 = createNode(6);

            existingWay = createWay(10, existingNode, existingNode2);
        }

        /**
         * Create and add a new test node.
         * @param id the id
         * @return The node.
         */
        public Node createNode(long id) {
            Node node = new Node();
            node.setOsmId(id, 1);
            node.setCoor(LatLon.ZERO);
            node.put("existing", "existing");
            layer.data.addPrimitive(node);
            return node;
        }

        /**
         * Create and add a new test way.
         * @param id the id
         * @param nodes The nodes
         * @return The way.
         */
        public Way createWay(int id, Node...nodes) {
            Way way = new Way();
            way.setOsmId(id, 1);
            way.setNodes(Arrays.asList(nodes));
            way.put("existing", "existing");
            layer.data.addPrimitive(way);
            return way;
        }

        /**
         * Create and add a new test relation.
         * @param id the id
         * @param members The members
         * @return The relation.
         */
        public Relation createRelation(int id, RelationMember...members) {
            Relation relation = new Relation(id, 1);
            for (RelationMember member : members) {
                relation.addMember(member);
            }
            relation.put("existing", "existing");
            layer.data.addPrimitive(relation);
            return relation;
        }
    }

    /**
     * A change test data consisting of two nodes, a way and a relation.
     * @author Michael Zangl
     */
    public static class CommandTestDataWithRelation extends CommandTestData {
        /**
         * A test relation
         */
        public final Relation existingRelation;

        /**
         * Creates the new test data and adds {@link #layer} to the layer manager.
         */
        public CommandTestDataWithRelation() {
            existingRelation = createRelation(20, new RelationMember("node", existingNode), new RelationMember("way", existingWay));
        }
    }
}