/*
    * 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.assertFalse;
  import static org.junit.jupiter.api.Assertions.assertNull;
  import static org.junit.jupiter.api.Assertions.assertThrows;
  import static org.junit.jupiter.api.Assertions.assertTrue;
  
  import org.apache.commons.configuration2.BaseHierarchicalConfiguration;
  import org.apache.commons.configuration2.HierarchicalConfiguration;
  import org.apache.commons.configuration2.ex.ConfigurationRuntimeException;
  import org.junit.jupiter.api.Test;
  
  /**
   * Test class for {@code ConfigurationDeclaration}.
   */
  public class TestConfigurationDeclaration {
  
      /**
       * Creates a default test instance.
       *
       * @param conf the configuration to be used (may be <strong>null</strong> for a default one)
       * @return the test object
       */
      private static ConfigurationDeclaration createDeclaration(final HierarchicalConfiguration<?> conf) {
          final HierarchicalConfiguration<?> config = conf != null ? conf : new BaseHierarchicalConfiguration();
          return new ConfigurationDeclaration(null, config);
      }
  
      /**
       * Tests if special reserved attributes are recognized by the isReservedNode() method. For compatibility reasons the
       * attributes "at" and "optional" are also treated as reserved attributes, but only if there are no corresponding
       * attributes with the "config-" prefix.
       *
       * @param name the attribute name
       */
      private void checkOldReservedAttribute(final String name) {
          final String prefixName = "config-" + name;
          final BaseHierarchicalConfiguration config = new BaseHierarchicalConfiguration();
          config.addProperty(String.format("[@%s]", prefixName), Boolean.TRUE);
          final ConfigurationDeclaration decl = createDeclaration(config);
          assertTrue(decl.isReservedAttributeName(prefixName), prefixName + " attribute not recognized");
          config.addProperty(String.format("[@%s]", name), Boolean.TRUE);
          assertFalse(decl.isReservedAttributeName(name), name + " is reserved though config- exists");
          assertTrue(decl.isReservedAttributeName(prefixName), "config- attribute not recognized when " + name + " exists");
      }
  
      /**
       * Tests access to certain reserved attributes of a ConfigurationDeclaration.
       */
      @Test
      void testConfigurationDeclarationGetAttributes() {
          final HierarchicalConfiguration<?> config = new BaseHierarchicalConfiguration();
          config.addProperty("xml.fileName", "test.xml");
          ConfigurationDeclaration decl = createDeclaration(config.configurationAt("xml"));
          assertNull(decl.getAt());
          assertFalse(decl.isOptional());
          config.addProperty("xml[@config-at]", "test1");
          decl = createDeclaration(config.configurationAt("xml"));
          assertEquals("test1", decl.getAt());
          config.addProperty("xml[@at]", "test2");
          decl = createDeclaration(config.configurationAt("xml"));
          assertEquals("test1", decl.getAt());
          config.clearProperty("xml[@config-at]");
          decl = createDeclaration(config.configurationAt("xml"));
          assertEquals("test2", decl.getAt());
          config.addProperty("xml[@config-optional]", "true");
          decl = createDeclaration(config.configurationAt("xml"));
          assertTrue(decl.isOptional());
          config.addProperty("xml[@optional]", "false");
          decl = createDeclaration(config.configurationAt("xml"));
          assertTrue(decl.isOptional());
          config.clearProperty("xml[@config-optional]");
          config.setProperty("xml[@optional]", Boolean.TRUE);
          decl = createDeclaration(config.configurationAt("xml"));
          assertTrue(decl.isOptional());
      }
  
      /**
       * Tests the isReservedNode() method of ConfigurationDeclaration.
       */
      @Test
      void testConfigurationDeclarationIsReserved() {
         final ConfigurationDeclaration decl = createDeclaration(null);
         assertTrue(decl.isReservedAttributeName("at"));
         assertTrue(decl.isReservedAttributeName("optional"));
         assertTrue(decl.isReservedAttributeName("config-class"));
         assertFalse(decl.isReservedAttributeName("different"));
     }
 
     /**
      * Tests if the at attribute is correctly detected as reserved attribute.
      */
     @Test
     void testConfigurationDeclarationIsReservedAt() {
         checkOldReservedAttribute("at");
     }
 
     /**
      * Tests if the optional attribute is correctly detected as reserved attribute.
      */
     @Test
     void testConfigurationDeclarationIsReservedOptional() {
         checkOldReservedAttribute("optional");
     }
 
     /**
      * Tests whether an invalid value of an optional attribute is detected.
      */
     @Test
     void testConfigurationDeclarationOptionalAttributeInvalid() {
         final HierarchicalConfiguration<?> factory = new BaseHierarchicalConfiguration();
         factory.addProperty("xml.fileName", "test.xml");
         factory.setProperty("xml[@optional]", "invalid value");
         final ConfigurationDeclaration decl = createDeclaration(factory.configurationAt("xml"));
         assertThrows(ConfigurationRuntimeException.class, decl::isOptional);
     }
 }