/*
    * 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.assertThrows;
  import static org.junit.jupiter.api.Assertions.assertTrue;
  
  import java.util.Locale;
  
  import org.apache.commons.configuration2.tree.ImmutableNode;
  import org.apache.commons.jxpath.ri.QName;
  import org.apache.commons.jxpath.ri.model.NodeIterator;
  import org.apache.commons.jxpath.ri.model.NodePointer;
  import org.junit.jupiter.api.BeforeEach;
  import org.junit.jupiter.api.Test;
  
  /**
   * Test class for {@code ConfigurationNodePointer}.
   */
  public class TestConfigurationNodePointer extends AbstractXPathTest {
  
      /** Stores the node pointer to be tested. */
      private ConfigurationNodePointer<ImmutableNode> pointer;
  
      /**
       * Recursive helper method for testing the returned iterators.
       *
       * @param p the node pointer to test
       */
      private void checkIterators(final NodePointer p) {
          final ImmutableNode node = (ImmutableNode) p.getNode();
          NodeIterator it = p.childIterator(null, false, null);
          assertEquals(node.getChildren().size(), iteratorSize(it));
  
          for (int index = 1; it.setPosition(index); index++) {
              final NodePointer pchild = it.getNodePointer();
              assertEquals(node.getChildren().get(index - 1), pchild.getNode());
              checkIterators(pchild);
          }
  
          it = p.attributeIterator(new QName(null, "*"));
          assertEquals(node.getAttributes().size(), iteratorSize(it));
          for (int index = 1; it.setPosition(index); index++) {
              final NodePointer pattr = it.getNodePointer();
              assertTrue(pattr.isAttribute());
              assertTrue(node.getAttributes().containsKey(pattr.getName().getName()));
          }
      }
  
      @Override
      @BeforeEach
      public void setUp() throws Exception {
          super.setUp();
          pointer = new ConfigurationNodePointer<>(root, Locale.getDefault(), handler);
      }
  
      /**
       * Tests whether a comparison of child node pointers handle the case that the child nodes are unknown. (This should not
       * happen in practice.)
       */
      @Test
      void testCompareChildNodePointersAttributes() {
          final ImmutableNode n1 = new ImmutableNode.Builder().name("n1").create();
          final ImmutableNode n2 = new ImmutableNode.Builder().name("n2").create();
          final NodePointer p1 = new ConfigurationNodePointer<>(pointer, n1, handler);
          final NodePointer p2 = new ConfigurationNodePointer<>(pointer, n2, handler);
          assertEquals(0, pointer.compareChildNodePointers(p1, p2));
          assertEquals(0, pointer.compareChildNodePointers(p2, p1));
      }
  
      /**
       * Tests comparing child node pointers for child nodes.
       */
      @Test
      void testCompareChildNodePointersChildren() {
          final NodePointer p1 = new ConfigurationNodePointer<>(pointer, root.getChildren().get(1), handler);
          final NodePointer p2 = new ConfigurationNodePointer<>(pointer, root.getChildren().get(3), handler);
          assertEquals(-1, pointer.compareChildNodePointers(p1, p2));
          assertEquals(1, pointer.compareChildNodePointers(p2, p1));
      }
  
      /**
       * Tests the attribute flag.
      */
     @Test
     void testIsAttribute() {
         assertFalse(pointer.isAttribute());
     }
 
     /**
      * Tests the leaf flag for a real leaf node.
      */
     @Test
     void testIsLeafTrue() {
         final ImmutableNode leafNode = new ImmutableNode.Builder().name("leafNode").create();
         pointer = new ConfigurationNodePointer<>(pointer, leafNode, handler);
         assertTrue(pointer.isLeaf());
     }
 
     /**
      * Tests if leaves in the tree are correctly detected.
      */
     @Test
     void testIsLeave() {
         assertFalse(pointer.isLeaf());
     }
 
     /**
      * Tests the iterators returned by the node pointer.
      */
     @Test
     void testIterators() {
         checkIterators(pointer);
     }
 
     /**
      * Tests that no new value can be set.
      */
     @Test
     void testSetValue() {
         assertThrows(UnsupportedOperationException.class, () -> pointer.setValue("newValue"));
     }
 }