/*
    * 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;
  
  import static org.junit.jupiter.api.Assertions.assertEquals;
  import static org.junit.jupiter.api.Assertions.assertFalse;
  import static org.junit.jupiter.api.Assertions.assertNull;
  
  import java.util.List;
  
  import org.apache.commons.configuration2.BaseHierarchicalConfiguration;
  import org.apache.commons.configuration2.HierarchicalConfiguration;
  import org.apache.commons.configuration2.ex.ConfigurationException;
  import org.apache.commons.configuration2.tree.xpath.XPathExpressionEngine;
  import org.junit.jupiter.api.Test;
  
  /**
   * Test class for MergeCombiner.
   */
  public class TestMergeCombiner extends AbstractCombinerTest {
  
      /**
       * Helper method for checking the combined table structure.
       *
       * @param config the config
       * @return the node for the table element
       */
      private ImmutableNode checkTable(final HierarchicalConfiguration<ImmutableNode> config) {
          assertEquals(1, config.getMaxIndex("database.tables.table"));
          final HierarchicalConfiguration<ImmutableNode> c = config.configurationAt("database.tables.table(0)");
          assertEquals("documents", c.getString("name"));
          assertEquals(2, c.getMaxIndex("fields.field.name"));
          assertEquals("docname", c.getString("fields.field(1).name"));
  
          final NodeHandler<ImmutableNode> nodeHandler = config.getNodeModel().getNodeHandler();
          final List<QueryResult<ImmutableNode>> nds = config.getExpressionEngine().query(nodeHandler.getRootNode(), "database.tables.table", nodeHandler);
          assertFalse(nds.isEmpty());
          assertFalse(nds.get(0).isAttributeResult());
          return nds.get(0).getNode();
      }
  
      /**
       * Creates the combiner.
       *
       * @return the combiner
       */
      @Override
      protected NodeCombiner createCombiner() {
          return new MergeCombiner();
      }
  
      /**
       * Tests combination of attributes.
       */
      @Test
      void testAttributes() throws ConfigurationException {
          final BaseHierarchicalConfiguration config = createCombinedConfiguration();
          assertEquals(1, config.getInt("gui.level[@min]"));
          assertEquals(2, config.getInt("gui.level[@default]"));
          assertEquals(0, config.getMaxIndex("database.tables.table(0)[@id]"));
          assertEquals(1, config.getInt("database.tables.table(0)[@id]"));
      }
  
      /**
       * Tests the combination of the table structure. With the merge combiner both table 1 and table 2 should be present.
       */
      @Test
      void testCombinedTable() throws ConfigurationException {
          checkTable(createCombinedConfiguration());
      }
  
      /**
       * Tests if a list from the first node structure overrides a list in the second structure.
       */
      @Test
      void testListFromFirstStructure() throws ConfigurationException {
          final BaseHierarchicalConfiguration config = createCombinedConfiguration();
          assertEquals(0, config.getMaxIndex("net.service.url"));
          assertEquals("http://service1.org", config.getString("net.service.url"));
          assertFalse(config.containsKey("net.service.url[@type]"));
      }
  
      /**
       * Tests if a list from the second structure is added if it is not defined in the first structure.
       */
     @Test
     void testListFromSecondStructure() throws ConfigurationException {
         final BaseHierarchicalConfiguration config = createCombinedConfiguration();
         assertEquals(3, config.getMaxIndex("net.server.url"));
         assertEquals("http://testsvr.com", config.getString("net.server.url(2)"));
     }
 
     @Test
     void testMerge() throws ConfigurationException {
         // combiner.setDebugStream(System.out);
         final BaseHierarchicalConfiguration config = createCombinedConfiguration();
         config.setExpressionEngine(new XPathExpressionEngine());
         assertEquals(3, config.getMaxIndex("Channels/Channel"));
         assertEquals("My Channel", config.getString("Channels/Channel[@id='1']/Name"));
         assertEquals("half", config.getString("Channels/Channel[@id='1']/@type"));
         assertEquals("Channel 2", config.getString("Channels/Channel[@id='2']/Name"));
         assertEquals("full", config.getString("Channels/Channel[@id='2']/@type"));
         assertEquals("test 1 data", config.getString("Channels/Channel[@id='1']/ChannelData"));
         assertEquals("test 2 data", config.getString("Channels/Channel[@id='2']/ChannelData"));
         assertEquals("more test 2 data", config.getString("Channels/Channel[@id='2']/MoreChannelData"));
 
     }
 
     /**
      * Tests whether property values are correctly overridden.
      */
     @Test
     void testOverrideValues() throws ConfigurationException {
         final BaseHierarchicalConfiguration config = createCombinedConfiguration();
         assertEquals("Admin", config.getString("base.services.security.login.user"));
         assertEquals("default", config.getString("base.services.security.login.user[@type]"));
         assertNull(config.getString("base.services.security.login.passwd"));
         assertEquals("secret", config.getString("base.services.security.login.passwd[@type]"));
     }
 
     /**
      * Tests combination of simple elements.
      */
     @Test
     void testSimpleValues() throws ConfigurationException {
         final BaseHierarchicalConfiguration config = createCombinedConfiguration();
         assertEquals(0, config.getMaxIndex("gui.bgcolor"));
         assertEquals("green", config.getString("gui.bgcolor"));
         assertEquals("yellow", config.getString("gui.selcolor"));
         assertEquals("blue", config.getString("gui.fgcolor"));
         assertEquals(1, config.getInt("gui.level"));
     }
 }