package org.dataone.integration.it.apiTests;

import java.util.Iterator;
import java.util.List;
import java.util.Vector;

import org.dataone.integration.ContextAwareTestCaseDataone;
import org.dataone.integration.it.testDefinitions.CNRegisterTestDefinitions;
import org.dataone.integration.it.testImplementations.CNRegisterTestImplementations;
import org.dataone.integration.webTest.WebTestImplementation;
import org.dataone.service.types.v1.Node;
import org.dataone.service.types.v1.NodeReference;
import org.dataone.service.types.v1.NodeState;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;

/**
 * Tests CNRegister functionality for v1 of the API 
 */
public class CNRegisterV1IT extends ContextAwareTestCaseDataone
        implements CNRegisterTestDefinitions {

    @WebTestImplementation
    private CNRegisterTestImplementations registerTestImpl;

    
    @Before
    public void setup() {
        registerTestImpl = new CNRegisterTestImplementations(this);
    }

    @Override
    protected String getTestDescription() {
        return "Test Case that runs through the CN version 1 of register API methods";
    }

    /**
     * Overrides {@link ContextAwareTestCaseDataone#getCoordinatingNodeIterator}.
     * This test has methods that lead to deserialization of {@link Node}s.
     * This deserialization fails if the Nodes don't conform to the schema, so
     * this method fills in the missing attributes.
     */
    @Override
    protected Iterator<Node> getCoordinatingNodeIterator() {
        
        Iterator<Node> originalIterator = super.getCoordinatingNodeIterator();
        List<Node> newList = new Vector<Node>();
        while(originalIterator.hasNext()) {
            Node node = originalIterator.next();
            if(node.getIdentifier() == null) {
                NodeReference nodeRef = new NodeReference();
                nodeRef.setValue("BogusNodeRef" + System.currentTimeMillis());
                node.setIdentifier(nodeRef);
            }
            node.setName("BogusName");
            node.setDescription("BogusDescription");
            node.setState(NodeState.UNKNOWN);
            
            newList.add(node);
        }
        return newList.iterator();
    }
    
    @Override
    @Test
    @Ignore("don't want to keep creating new phantom nodes")
    public void testRegister() {
        registerTestImpl.testRegister(getCoordinatingNodeIterator(), "v1");
    }

    @Override
    @Test
    public void testRegister_IdentifierNotUnique() {
        registerTestImpl.testRegister_IdentifierNotUnique(getCoordinatingNodeIterator(), "v1");
    }

    @Override
    @Test
    public void testUpdateNodeCapabilities() {
        registerTestImpl.testUpdateNodeCapabilities(getCoordinatingNodeIterator(), "v1");
    }

    @Override
    @Test
    public void testUpdateNodeCapabilities_NotFound() {
        registerTestImpl.testUpdateNodeCapabilities_NotFound(getCoordinatingNodeIterator(), "v1");
    }

    @Override
    @Test
    public void testUpdateNodeCapabilities_NotAuthorized() {
        registerTestImpl.testUpdateNodeCapabilities_NotAuthorized(getCoordinatingNodeIterator(), "v1");
    }

    @Override
    @Test
    public void testUpdateNodeCapabilities_updatingOtherField() {
        registerTestImpl.testUpdateNodeCapabilities_updatingOtherField(getCoordinatingNodeIterator(), "v1");
    }
}