/*
    * 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.builder.combined;
  
  import static org.junit.jupiter.api.Assertions.assertEquals;
  import static org.junit.jupiter.api.Assertions.assertSame;
  import static org.junit.jupiter.api.Assertions.assertTrue;
  
  import java.io.File;
  import java.util.Collection;
  
  import org.apache.commons.configuration2.CombinedConfiguration;
  import org.apache.commons.configuration2.ConfigurationAssert;
  import org.apache.commons.configuration2.XMLConfiguration;
  import org.apache.commons.configuration2.builder.FileBasedBuilderParametersImpl;
  import org.apache.commons.configuration2.builder.FileBasedConfigurationBuilder;
  import org.apache.commons.configuration2.ex.ConfigurationException;
  import org.apache.commons.configuration2.reloading.CombinedReloadingController;
  import org.apache.commons.configuration2.reloading.ReloadingController;
  import org.apache.commons.configuration2.reloading.ReloadingControllerSupport;
  import org.junit.jupiter.api.BeforeEach;
  import org.junit.jupiter.api.Test;
  
  /**
   * Test class for {@code ReloadingCombinedConfigurationBuilder}.
   */
  public class TestReloadingCombinedConfigurationBuilder {
  
      /** The builder to be tested. */
      private ReloadingCombinedConfigurationBuilder builder;
  
      @BeforeEach
      public void setUp() throws Exception {
          builder = new ReloadingCombinedConfigurationBuilder();
      }
  
      /**
       * Tests whether the failOnInit flag is passed to the super constructor.
       */
      @Test
      void testInitWithFailOnInitFlag() {
          builder = new ReloadingCombinedConfigurationBuilder(null, true);
          assertTrue(builder.isAllowFailOnInit());
      }
  
      /**
       * Tests whether initialization parameters are correctly processed.
       */
      @Test
      void testInitWithParameters() throws ConfigurationException {
          final FileBasedBuilderParametersImpl params = new FileBasedBuilderParametersImpl();
          params.setFile(ConfigurationAssert.getTestFile("testDigesterConfiguration.xml"));
          builder = new ReloadingCombinedConfigurationBuilder(params.getParameters());
          final CombinedConfiguration cc = builder.getConfiguration();
          assertTrue(cc.getBoolean("test.boolean"));
      }
  
      /**
       * Tests whether a nested combined configuration definition can be loaded with reloading support.
       */
      @Test
      void testNestedReloadableSources() throws ConfigurationException {
          final File testFile = ConfigurationAssert.getTestFile("testCCReloadingNested.xml");
          builder.configure(new FileBasedBuilderParametersImpl().setFile(testFile));
          builder.getConfiguration();
          final CombinedReloadingController rc = (CombinedReloadingController) builder.getReloadingController();
          final Collection<ReloadingController> subControllers = rc.getSubControllers();
          assertEquals(2, subControllers.size());
          final ReloadingControllerSupport ccBuilder = (ReloadingControllerSupport) builder.getNamedBuilder("cc");
          assertTrue(subControllers.contains(ccBuilder.getReloadingController()));
          final CombinedReloadingController rc2 = (CombinedReloadingController) ccBuilder.getReloadingController();
          assertEquals(3, rc2.getSubControllers().size());
      }
  
      /**
       * Tests a definition configuration which does not contain sources with reloading support.
       */
      @Test
      void testNoReloadableSources() throws ConfigurationException {
          final File testFile = ConfigurationAssert.getTestFile("testDigesterConfiguration.xml");
          builder.configure(new CombinedBuilderParametersImpl().setDefinitionBuilder(new FileBasedConfigurationBuilder<>(XMLConfiguration.class))
              .setDefinitionBuilderParameters(new FileBasedBuilderParametersImpl().setFile(testFile)));
          builder.getConfiguration();
          final CombinedReloadingController rc = (CombinedReloadingController) builder.getReloadingController();
          assertTrue(rc.getSubControllers().isEmpty());
     }
 
     /**
      * Tests whether the definition builder created by default supports reloading.
      */
     @Test
     void testReloadableDefinitionBuilder() throws ConfigurationException {
         final File testFile = ConfigurationAssert.getTestFile("testDigesterConfiguration.xml");
         final ReloadingCombinedConfigurationBuilder confBuilder = builder.configure(new FileBasedBuilderParametersImpl().setFile(testFile));
         assertSame(builder, confBuilder);
         builder.getConfiguration();
         final CombinedReloadingController rc = (CombinedReloadingController) builder.getReloadingController();
         final Collection<ReloadingController> subControllers = rc.getSubControllers();
         assertEquals(1, subControllers.size());
         final ReloadingController subctrl = ((ReloadingControllerSupport) builder.getDefinitionBuilder()).getReloadingController();
         assertSame(subctrl, subControllers.iterator().next());
     }
 }