jpa/org.eclipse.persistence.jpa.jpql/src/test/java/org/eclipse/persistence/jpa/tests/jpql/tools/AbstractBasicRefactoringToolTest.java

/*
 * Copyright (c) 2012, 2021 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     Oracle - initial API and implementation
//
package org.eclipse.persistence.jpa.tests.jpql.tools;

import java.util.Arrays;
import org.eclipse.persistence.jpa.jpql.parser.JPQLGrammar;
import org.eclipse.persistence.jpa.jpql.tools.BasicRefactoringTool;
import org.eclipse.persistence.jpa.jpql.tools.RefactoringDelta;
import org.eclipse.persistence.jpa.jpql.tools.TextEdit;
import org.eclipse.persistence.jpa.tests.jpql.JPQLCoreTest;
import org.eclipse.persistence.jpa.tests.jpql.parser.JPQLGrammarTestHelper;
import static org.junit.Assert.*;

/**
 * The abstract definition of a unit-test that tests {@link BasicRefactoringTool BasicRefactoringTool}.
 *
 * @version 2.5
 * @since 2.4
 * @author Pascal Filion
 */
@SuppressWarnings("nls")
public abstract class AbstractBasicRefactoringToolTest extends JPQLCoreTest {

    @JPQLGrammarTestHelper
    private JPQLGrammar jpqlGrammar;

    protected JPQLGrammar getGrammar() {
        return jpqlGrammar;
    }

    protected final void testChange(BasicRefactoringTool refactoringTool,
                                    String jpqlQuery,
                                    String expectedJPQLQuery,
                                    int offset,
                                    String oldValue,
                                    String newValue) {

        RefactoringDelta delta = refactoringTool.getDelta();
        assertNotNull("The RefactoringDelta cannot be null", delta);
        assertEquals("One MultiTextEdit should have been created", 1, delta.size());

        Iterable<TextEdit> textEdits = delta.textEdits();
        assertNotNull("The list of Edit cannot be null", textEdits);

        TextEdit textEdit = textEdits.iterator().next();
        assertNotNull("The Edit cannot be null", textEdit);

        assertEquals(offset,            textEdit.getOffset());
        assertEquals(oldValue.length(), textEdit.getLength());
        assertEquals(oldValue,          textEdit.getOldValue());
        assertEquals(newValue,          textEdit.getNewValue());

        assertEquals(expectedJPQLQuery, delta.applyChanges());
        assertFalse(delta.hasTextEdits());
        assertFalse(delta.textEdits().iterator().hasNext());
    }

    protected final void testChanges(BasicRefactoringTool refactoringTool,
                                     String jpqlQuery,
                                     String expectedJPQLQuery,
                                     String oldValue,
                                     String newValue,
                                     int... offsets) {

        String[] oldValues = new String[offsets.length];
        String[] newValues = new String[offsets.length];

        Arrays.fill(oldValues, oldValue);
        Arrays.fill(newValues, newValue);

        testChanges(refactoringTool, jpqlQuery, expectedJPQLQuery, offsets, oldValues, newValues);
    }

    protected final void testChanges(BasicRefactoringTool refactoringTool,
                                     String jpqlQuery,
                                     String expectedJPQLQuery,
                                     int[] offsets,
                                     String[] oldValues,
                                     String[] newValues) {

        assertEquals(oldValues.length, newValues.length);
        assertEquals(oldValues.length, offsets.length);

        RefactoringDelta delta = refactoringTool.getDelta();
        assertNotNull("The RefactoringDelta cannot be null", delta);
        assertEquals("Incorrect number of TextEdit were created", offsets.length, delta.size());

        int index = 0;

        for (TextEdit textEdit : delta.textEdits()) {
            assertNotNull("The TextEdit cannot be null", textEdit);
            assertEquals(  offsets[index],          textEdit.getOffset());
            assertEquals(oldValues[index].length(), textEdit.getLength());
            assertEquals(oldValues[index],          textEdit.getOldValue());
            assertEquals(newValues[index],          textEdit.getNewValue());
            index++;
        }

        assertEquals(expectedJPQLQuery, delta.applyChanges());
        assertFalse(delta.hasTextEdits());
        assertFalse(delta.textEdits().iterator().hasNext());
    }

    protected final void testHasNoChanges(BasicRefactoringTool refactoringTool) {
        RefactoringDelta delta = refactoringTool.getDelta();
        assertNotNull("The RefactoringDelta cannot be null", delta);
        assertEquals("No MultiTextEdit should have been created", 0, delta.size());
    }
}