/*
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements.  See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to You under the Apache License, Version 2.0
    * (the "License"); you may not use this file except in compliance with
    * the License.  You may obtain a copy of the License at
    *
    *     https://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.apache.commons.configuration2.tree.xpath;
  
  import static org.junit.jupiter.api.Assertions.assertEquals;
  import static org.junit.jupiter.api.Assertions.assertFalse;
  import static org.junit.jupiter.api.Assertions.assertNotNull;
  import static org.junit.jupiter.api.Assertions.assertSame;
  import static org.junit.jupiter.api.Assertions.assertThrows;
  import static org.junit.jupiter.api.Assertions.assertTrue;
  import static org.mockito.Mockito.mock;
  import static org.mockito.Mockito.when;
  
  import java.util.Arrays;
  import java.util.List;
  
  import org.apache.commons.configuration2.tree.ImmutableNode;
  import org.apache.commons.configuration2.tree.InMemoryNodeModel;
  import org.apache.commons.configuration2.tree.NodeAddData;
  import org.apache.commons.configuration2.tree.NodeHandler;
  import org.apache.commons.configuration2.tree.QueryResult;
  import org.apache.commons.jxpath.JXPathContext;
  import org.apache.commons.jxpath.ri.JXPathContextReferenceImpl;
  import org.apache.commons.jxpath.ri.model.NodePointerFactory;
  import org.junit.jupiter.api.BeforeAll;
  import org.junit.jupiter.api.Test;
  
  /**
   * Test class for XPathExpressionEngine.
   */
  public class TestXPathExpressionEngine {
  
      /** Constant for the valid test key. */
      private static final String TEST_KEY = "TESTKEY";
  
      /** Constant for the name of the root node. */
      private static final String ROOT_NAME = "testRoot";
  
      /** The test root node. */
      private static ImmutableNode root;
  
      /** A test node handler. */
      private static NodeHandler<ImmutableNode> handler;
  
      /**
       * Helper method for testing the path nodes in the given add data object.
       *
       * @param data the data object to check
       * @param attr a flag if the new node is an attribute
       * @param expected an array with the expected path elements
       */
      private static void checkAddPath(final NodeAddData<ImmutableNode> data, final boolean attr, final String... expected) {
          assertSame(root, data.getParent());
          final List<String> path = data.getPathNodes();
          assertEquals(Arrays.asList(expected).subList(0, expected.length - 1), path);
          assertEquals(expected[expected.length - 1], data.getNewNodeName());
          assertEquals(attr, data.isAttribute());
      }
  
      @BeforeAll
      public static void setUpBeforeClass() throws Exception {
          root = new ImmutableNode.Builder().name(ROOT_NAME).create();
          handler = new InMemoryNodeModel(root).getNodeHandler();
      }
  
      /**
       * Helper method for testing queries with undefined keys.
       *
       * @param key the key
       */
      private void checkEmptyKey(final String key) {
          final XPathContextFactory factory = mock(XPathContextFactory.class);
          final XPathExpressionEngine engine = new XPathExpressionEngine(factory);
          final List<QueryResult<ImmutableNode>> results = engine.query(root, key, handler);
          assertEquals(1, results.size());
          assertSame(root, results.get(0).getNode());
      }
  
      /**
       * Helper method for checking whether an exception is thrown for an invalid path passed to prepareAdd().
       *
       * @param path the path to be tested
       * @throws IllegalArgumentException if the test is successful
       */
      private void checkInvalidAddPath(final String path) {
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         final QueryResult<ImmutableNode> res = QueryResult.createNodeResult(root);
         assertThrows(IllegalArgumentException.class, () -> engine.createNodeAddData(path, res));
     }
 
     /**
      * Creates a mock for a context and prepares it to expect a select invocation yielding the provided results.
      *
      * @param results the results
      * @return the mock context
      */
     private JXPathContext expectSelect(final Object... results) {
         final JXPathContext ctx = mock(JXPathContext.class);
 
         when(ctx.selectNodes(TEST_KEY)).thenReturn(Arrays.asList(results));
 
         return ctx;
     }
 
     /**
      * Creates a test engine instance configured with a context factory which returns the given test context.
      *
      * @param ctx the context mock
      * @return the test engine instance
      */
     private XPathExpressionEngine setUpEngine(final JXPathContext ctx) {
         final XPathContextFactory factory = mock(XPathContextFactory.class);
 
         when(factory.createContext(root, handler)).thenReturn(ctx);
 
         return new XPathExpressionEngine(factory);
     }
 
     /**
      * Tests the key of an attribute which belongs to the root node.
      */
     @Test
     void testAttributeKeyOfRootNode() {
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         assertEquals("@child", engine.attributeKey(null, "child"));
     }
 
     /**
      * Tests whether a canonical key can be queried if all child nodes have different names.
      */
     @Test
     void testCanonicalKeyNoDuplicates() {
         final ImmutableNode.Builder parentBuilder = new ImmutableNode.Builder(2);
         final ImmutableNode c1 = new ImmutableNode.Builder().name("child").create();
         final ImmutableNode c2 = new ImmutableNode.Builder().name("child_other").create();
         parentBuilder.addChildren(Arrays.asList(c2, c1));
         final ImmutableNode parent = parentBuilder.create();
         final NodeHandler<ImmutableNode> testHandler = new InMemoryNodeModel(parent).getNodeHandler();
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         assertEquals("parent/child[1]", engine.canonicalKey(c1, "parent", testHandler));
     }
 
     /**
      * Tests whether the parent key can be undefined when querying a canonical key.
      */
     @Test
     void testCanonicalKeyNoParentKey() {
         final ImmutableNode.Builder parentBuilder = new ImmutableNode.Builder(1);
         final ImmutableNode c1 = new ImmutableNode.Builder().name("child").create();
         final ImmutableNode parent = parentBuilder.addChild(c1).create();
         final NodeHandler<ImmutableNode> testHandler = new InMemoryNodeModel(parent).getNodeHandler();
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         assertEquals("child[1]", engine.canonicalKey(c1, null, testHandler));
     }
 
     /**
      * Tests whether a canonical key for the parent node can be queried if no parent key was passed in.
      */
     @Test
     void testCanonicalKeyRootNoParentKey() {
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         assertEquals("", engine.canonicalKey(root, null, handler));
     }
 
     /**
      * Tests whether a parent key is evaluated when determining the canonical key of the root node.
      */
     @Test
     void testCanonicalKeyRootWithParentKey() {
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         assertEquals("parent", engine.canonicalKey(root, "parent", handler));
     }
 
     /**
      * Tests whether duplicates are correctly resolved when querying for canonical keys.
      */
     @Test
     void testCanonicalKeyWithDuplicates() {
         final ImmutableNode.Builder parentBuilder = new ImmutableNode.Builder(3);
         final ImmutableNode c1 = new ImmutableNode.Builder().name("child").create();
         final ImmutableNode c2 = new ImmutableNode.Builder().name("child").create();
         final ImmutableNode c3 = new ImmutableNode.Builder().name("child_other").create();
         parentBuilder.addChildren(Arrays.asList(c1, c2, c3));
         final ImmutableNode parent = parentBuilder.create();
         final NodeHandler<ImmutableNode> testHandler = new InMemoryNodeModel(parent).getNodeHandler();
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         assertEquals("parent/child[1]", engine.canonicalKey(c1, "parent", testHandler));
         assertEquals("parent/child[2]", engine.canonicalKey(c2, "parent", testHandler));
     }
 
     /**
      * Tests whether a correct default context factory is created.
      */
     @Test
     void testDefaultContextFactory() {
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         assertNotNull(engine.getContextFactory());
     }
 
     /**
      * Tests whether the key of an attribute can be generated.
      */
     @Test
     void testNodeKeyAttribute() {
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         assertEquals("node/@attr", engine.attributeKey("node", "attr"));
     }
 
     /**
      * Tests node key() for direct children of the root node.
      */
     @Test
     void testNodeKeyForRootChild() {
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         assertEquals(ROOT_NAME, engine.nodeKey(root, "", handler));
     }
 
     /**
      * Tests nodeKey() for the root node.
      */
     @Test
     void testNodeKeyForRootNode() {
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         assertEquals("", engine.nodeKey(root, null, handler));
     }
 
     /**
      * Tests a node key if the node does not have a name.
      */
     @Test
     void testNodeKeyNoNodeName() {
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         assertEquals("test", engine.nodeKey(new ImmutableNode.Builder().create(), "test", handler));
     }
 
     /**
      * Tests a normal call of nodeKey().
      */
     @Test
     void testNodeKeyNormal() {
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         assertEquals("parent/" + ROOT_NAME, engine.nodeKey(root, "parent", handler));
     }
 
     /**
      * Tests if the JXPathContext is correctly initialized with the node pointer factory.
      */
     @Test
     void testNodePointerFactory() {
         JXPathContext.newContext(this);
         final NodePointerFactory[] factories = JXPathContextReferenceImpl.getNodePointerFactories();
         boolean found = false;
         for (final NodePointerFactory factory : factories) {
             if (factory instanceof ConfigurationNodePointerFactory) {
                 found = true;
                 break;
             }
         }
         assertTrue(found);
     }
 
     /**
      * Tests adding a new attribute node.
      */
     @Test
     void testPrepareAddAttribute() {
         final JXPathContext ctx = expectSelect(root);
         final XPathExpressionEngine engine = setUpEngine(ctx);
         final NodeAddData<ImmutableNode> data = engine.prepareAdd(root, TEST_KEY + "\t@newAttr", handler);
         checkAddPath(data, true, "newAttr");
     }
 
     /**
      * Tests adding a complete path whose final node is an attribute.
      */
     @Test
     void testPrepareAddAttributePath() {
         final JXPathContext ctx = expectSelect(root);
         final XPathExpressionEngine engine = setUpEngine(ctx);
         final NodeAddData<ImmutableNode> data = engine.prepareAdd(root, TEST_KEY + " a/full/path@attr", handler);
         checkAddPath(data, true, "a", "full", "path", "attr");
     }
 
     /**
      * Tests an add operation where the key is empty.
      */
     @Test
     void testPrepareAddEmptyKey() {
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         assertThrows(IllegalArgumentException.class, () -> engine.prepareAdd(root, "", handler));
     }
 
     /**
      * Tests an add operation with an empty path for the new node.
      */
     @Test
     void testPrepareAddEmptyPath() {
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         assertThrows(IllegalArgumentException.class, () -> engine.prepareAdd(root, TEST_KEY + " ", handler));
     }
 
     /**
      * Tests an add operation with an invalid path: the path contains an attribute in the middle part.
      */
     @Test
     void testPrepareAddInvalidAttributePath() {
         checkInvalidAddPath("a/path/with@an/attribute");
     }
 
     /**
      * Tests an add operation with an invalid path: the path contains an attribute after a slash.
      */
     @Test
     void testPrepareAddInvalidAttributePath2() {
         checkInvalidAddPath("a/path/with/@attribute");
     }
 
     /**
      * Tests an add operation with a query that does not return a single node.
      */
     @Test
     void testPrepareAddInvalidParent() {
         final JXPathContext ctx = expectSelect();
         final XPathExpressionEngine engine = setUpEngine(ctx);
         assertThrows(IllegalArgumentException.class, () -> engine.prepareAdd(root, TEST_KEY + " test", handler));
     }
 
     /**
      * Tests an add operation with an invalid path.
      */
     @Test
     void testPrepareAddInvalidPath() {
         checkInvalidAddPath("an/invalid//path");
     }
 
     /**
      * Tests an add operation with an invalid path that contains multiple attribute components.
      */
     @Test
     void testPrepareAddInvalidPathMultipleAttributes() {
         checkInvalidAddPath("an@attribute@path");
     }
 
     /**
      * Tests an add operation with an invalid path that starts with a slash.
      */
     @Test
     void testPrepareAddInvalidPathWithSlash() {
         checkInvalidAddPath("/a/path/node");
     }
 
     /**
      * Tests adding a single child node.
      */
     @Test
     void testPrepareAddNode() {
         final JXPathContext ctx = expectSelect(root);
         final XPathExpressionEngine engine = setUpEngine(ctx);
         final NodeAddData<ImmutableNode> data = engine.prepareAdd(root, TEST_KEY + "  newNode", handler);
         checkAddPath(data, false, "newNode");
     }
 
     /**
      * Tests an add operation where the key is null.
      */
     @Test
     void testPrepareAddNullKey() {
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         assertThrows(IllegalArgumentException.class, () -> engine.prepareAdd(root, null, handler));
     }
 
     /**
      * Tests adding a complete path.
      */
     @Test
     void testPrepareAddPath() {
         final JXPathContext ctx = expectSelect(root);
         final XPathExpressionEngine engine = setUpEngine(ctx);
         final NodeAddData<ImmutableNode> data = engine.prepareAdd(root, TEST_KEY + " \t a/full/path/node", handler);
         checkAddPath(data, false, "a", "full", "path", "node");
     }
 
     /**
      * Tests adding a new attribute to the root.
      */
     @Test
     void testPrepareAddRootAttribute() {
         final JXPathContext ctx = expectSelect(root);
         final XPathExpressionEngine engine = setUpEngine(ctx);
         final NodeAddData<ImmutableNode> data = engine.prepareAdd(root, " @attr", handler);
         checkAddPath(data, true, "attr");
     }
 
     /**
      * Tests adding a new node to the root.
      */
     @Test
     void testPrepareAddRootChild() {
         final JXPathContext ctx = expectSelect(root);
         final XPathExpressionEngine engine = setUpEngine(ctx);
         final NodeAddData<ImmutableNode> data = engine.prepareAdd(root, " newNode", handler);
         checkAddPath(data, false, "newNode");
     }
 
     /**
      * Tests that it is not possible to add nodes to an attribute.
      */
     @Test
     void testPrepareAddToAttributeResult() {
         final XPathExpressionEngine engine = new XPathExpressionEngine();
         final QueryResult<ImmutableNode> result = QueryResult.createAttributeResult(root, TEST_KEY);
         assertThrows(IllegalArgumentException.class, () -> engine.createNodeAddData("path", result));
     }
 
     /**
      * Tests a query which yields an attribute result.
      */
     @Test
     void testQueryAttributeExpression() {
         final QueryResult<ImmutableNode> attrResult = QueryResult.createAttributeResult(root, "attr");
         final JXPathContext ctx = expectSelect(attrResult);
         final XPathExpressionEngine engine = setUpEngine(ctx);
         final List<QueryResult<ImmutableNode>> result = engine.query(root, TEST_KEY, handler);
         assertEquals(1, result.size());
         assertSame(attrResult, result.get(0));
     }
 
     /**
      * Tests the query() method with an expression yielding a node.
      */
     @Test
     void testQueryNodeExpression() {
         final JXPathContext ctx = expectSelect(root);
         final XPathExpressionEngine engine = setUpEngine(ctx);
         final List<QueryResult<ImmutableNode>> result = engine.query(root, TEST_KEY, handler);
         assertEquals(1, result.size());
         assertSame(root, result.get(0).getNode());
         assertFalse(result.get(0).isAttributeResult());
     }
 
     /**
      * Tests a query with an empty key. This should directly return the root node without invoking the JXPathContext.
      */
     @Test
     void testQueryWithEmptyKey() {
         checkEmptyKey("");
     }
 
     /**
      * Tests a query with a null key. Same as an empty key.
      */
     @Test
     void testQueryWithNullKey() {
         checkEmptyKey(null);
     }
 
     /**
      * Tests a query that has no results. This should return an empty list.
      */
     @Test
     void testQueryWithoutResult() {
         final JXPathContext ctx = expectSelect();
         final XPathExpressionEngine engine = setUpEngine(ctx);
         assertTrue(engine.query(root, TEST_KEY, handler).isEmpty());
     }
 }