/*
 * Copyright (c) 2014 Cisco Systems, Inc. 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
 */
package org.opendaylight.controller.md.sal.dom.store.impl;

import org.junit.Test;

/**
 * Base template for a test suite for testing DataChangeListener functionality.
 */
public abstract class DefaultDataChangeListenerTestSuite extends AbstractDataChangeListenerTest {

    protected static final String FOO_SIBLING = "foo-sibling";

    /**
     * Callback invoked when the test suite can modify task parameters.
     *
     * @param task Update task configuration as needed
     */
    protected abstract void customizeTask(DatastoreTestTask task);

    @Test
    public final void putTopLevelOneNested() throws Exception {

        DatastoreTestTask task = newTestTask().test(writeOneTopMultipleNested(FOO, BAR));
        customizeTask(task);
        task.run();
        putTopLevelOneNested(task);
    }

    protected abstract void putTopLevelOneNested(DatastoreTestTask task) throws Exception;

    @Test
    public final void existingTopWriteSibling() throws Exception {
        DatastoreTestTask task = newTestTask().setup(writeOneTopMultipleNested(FOO)).test(
            tx -> tx.write(path(FOO_SIBLING), topLevelList(FOO_SIBLING).build()));
        customizeTask(task);
        task.run();
        existingTopWriteSibling(task);
    }

    protected abstract void existingTopWriteSibling(DatastoreTestTask task) throws Exception;

    @Test
    public final void existingTopWriteTwoNested() throws Exception {
        DatastoreTestTask task = newTestTask().setup(writeOneTopMultipleNested(FOO)).test(
            tx -> {
                tx.write(path(FOO,BAR), nestedList(BAR).build());
                tx.write(path(FOO,BAZ), nestedList(BAZ).build());
            });
        customizeTask(task);
        task.run();
        existingTopWriteTwoNested(task);
    }

    protected abstract void existingTopWriteTwoNested(DatastoreTestTask task) throws Exception;


    @Test
    public final void existingOneNestedWriteAdditionalNested() throws Exception {
        DatastoreTestTask task = newTestTask().setup(writeOneTopMultipleNested(FOO, BAR)).test(
            tx -> tx.write(path(FOO,BAZ), nestedList(BAZ).build()));
        customizeTask(task);
        task.run();
        existingOneNestedWriteAdditionalNested(task);
    }

    protected abstract void existingOneNestedWriteAdditionalNested(DatastoreTestTask task) throws Exception;

    @Test
    public final void replaceTopLevelNestedChanged() throws Exception {
        DatastoreTestTask task = newTestTask().setup(writeOneTopMultipleNested(FOO, BAR)).test(
                writeOneTopMultipleNested(FOO, BAZ));
        customizeTask(task);
        task.run();
        replaceTopLevelNestedChanged(task);
    }

    protected abstract void replaceTopLevelNestedChanged(DatastoreTestTask task) throws Exception;

    @Test
    public final void putTopLevelWithTwoNested() throws Exception {

        DatastoreTestTask task = newTestTask().test(writeOneTopMultipleNested(FOO, BAR, BAZ));
        customizeTask(task);
        task.run();
        putTopLevelWithTwoNested(task);
    }

    protected abstract void putTopLevelWithTwoNested(DatastoreTestTask task) throws Exception;

    @Test
    public final void twoNestedExistsOneIsDeleted() throws Exception {

        DatastoreTestTask task = newTestTask().setup(writeOneTopMultipleNested(FOO, BAR, BAZ)).test(
                deleteNested(FOO, BAZ));
        customizeTask(task);
        task.run();
        twoNestedExistsOneIsDeleted(task);
    }

    protected abstract void twoNestedExistsOneIsDeleted(DatastoreTestTask task) throws Exception;

    @Test
    public final void nestedListExistsRootDeleted() throws Exception {

        DatastoreTestTask task = newTestTask().cleanup(null).setup(writeOneTopMultipleNested(FOO, BAR, BAZ))
                .test(DatastoreTestTask.simpleDelete(TOP_LEVEL));
        customizeTask(task);
        task.run();
        nestedListExistsRootDeleted(task);
    }

    protected abstract void nestedListExistsRootDeleted(DatastoreTestTask task) throws Exception;
}