/*
    * 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;
  
  import static org.junit.jupiter.api.Assertions.assertEquals;
  import static org.junit.jupiter.api.Assertions.assertFalse;
  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.verify;
  import static org.mockito.Mockito.verifyNoMoreInteractions;
  import static org.mockito.Mockito.when;
  
  import java.util.Collections;
  
  import org.apache.commons.configuration2.SynchronizerTestImpl.Methods;
  import org.apache.commons.configuration2.io.FileHandler;
  import org.apache.commons.configuration2.sync.LockMode;
  import org.apache.commons.configuration2.sync.NoOpSynchronizer;
  import org.junit.jupiter.api.BeforeEach;
  import org.junit.jupiter.api.Test;
  import org.mockito.ArgumentMatchers;
  
  /**
   * A test class for the synchronization capabilities of {@code AbstractConfiguration}. This class mainly checks the collaboration between a configuration object
   * and its {@code Synchronizer}.
   */
  public class TestAbstractConfigurationSynchronization {
  
      /** Constant for the test property accessed by all tests. */
      private static final String PROP = "configuration.loaded";
  
      /**
       * Prepares a mock configuration for a copy operation.
       *
       * @return the mock configuration
       */
      private static Configuration prepareConfigurationMockForCopy() {
          final Configuration config2 = mock(Configuration.class);
          when(config2.getKeys()).thenReturn(Collections.<String>emptySet().iterator());
          return config2;
      }
  
      /**
       * Verifies a mock configuration after a copy operation.
       *
       * @param mock the mock configuration
       */
      private static void verifyConfigurationMockAfterCopy(final Configuration mock) {
          verify(mock).lock(LockMode.READ);
          verify(mock).forEach(ArgumentMatchers.any());
          verify(mock).unlock(LockMode.READ);
      }
  
      /** The synchronizer used for testing. */
      private SynchronizerTestImpl sync;
      /** A test configuration. */
      private AbstractConfiguration config;
  
      @BeforeEach
      public void setUp() throws Exception {
          // any concrete class will do
          final PropertiesConfiguration c = new PropertiesConfiguration();
          new FileHandler(c).load(ConfigurationAssert.getTestFile("test.properties"));
          sync = new SynchronizerTestImpl();
          c.setSynchronizer(sync);
          config = c;
      }
  
      /**
       * Tests the correct synchronization of addProperty().
       */
      @Test
      void testAddPropertySynchronized() {
          config.addProperty(PROP, "of course");
          sync.verify(Methods.BEGIN_WRITE, Methods.END_WRITE);
      }
  
      /**
       * Tests whether the append() method uses synchronization.
       */
      @Test
      void testAppendSynchronized() {
         final Configuration config2 = prepareConfigurationMockForCopy();
         config.append(config2);
         verifyConfigurationMockAfterCopy(config2);
         verifyNoMoreInteractions(config2);
     }
 
     /**
      * Tests the correct synchronization of clearProperty().
      */
     @Test
     void testClearPropertySynchronized() {
         config.clearProperty(PROP);
         sync.verify(Methods.BEGIN_WRITE, Methods.END_WRITE);
     }
 
     /**
      * Tests the correct synchronization of clear().
      */
     @Test
     void testClearSynchronized() {
         config.clear();
         sync.verifyStart(Methods.BEGIN_WRITE);
         sync.verifyEnd(Methods.END_WRITE);
     }
 
     /**
      * Tests whether containsKey() is correctly synchronized.
      */
     @Test
     void testContainsKeySychronized() {
         assertTrue(config.containsKey(PROP));
         sync.verify(Methods.BEGIN_READ, Methods.END_READ);
     }
 
     /**
      * Tests whether the copy() method uses synchronization.
      */
     @Test
     void testCopySynchronized() {
         final Configuration config2 = prepareConfigurationMockForCopy();
         config.copy(config2);
         verifyConfigurationMockAfterCopy(config2);
         verifyNoMoreInteractions(config2);
     }
 
     /**
      * Tests the Synchronizer used by default.
      */
     @Test
     void testDefaultSynchronizer() {
         assertSame(NoOpSynchronizer.INSTANCE, new PropertiesConfiguration().getSynchronizer());
     }
 
     /**
      * Tests whether getKeys(String prefix) is correctly synchronized.
      */
     @Test
     void testGetKeysPrefixSynchronized() {
         config.getKeys("test");
         sync.verify(Methods.BEGIN_READ, Methods.END_READ);
     }
 
     /**
      * Tests whether getKeys() is correctly synchronized.
      */
     @Test
     void testGetKeysSynchronized() {
         assertTrue(config.getKeys().hasNext());
         sync.verify(Methods.BEGIN_READ, Methods.END_READ);
     }
 
     /**
      * Tests whether read access to properties is synchronized.
      */
     @Test
     void testGetPropertySynchronized() {
         assertEquals("true", config.getProperty(PROP));
         assertTrue(config.getBoolean(PROP));
         sync.verify(Methods.BEGIN_READ, Methods.END_READ, Methods.BEGIN_READ, Methods.END_READ);
     }
 
     /**
      * Tests whether isEmpty() is correctly synchronized.
      */
     @Test
     void testIsEmptySynchronized() {
         assertFalse(config.isEmpty());
         sync.verify(Methods.BEGIN_READ, Methods.END_READ);
     }
 
     /**
      * Tests lock() with a null argument.
      */
     @Test
     void testLockNull() {
         assertThrows(NullPointerException.class, () -> config.lock(null));
     }
 
     /**
      * Tests whether a read lock can be obtained.
      */
     @Test
     void testLockRead() {
         config.lock(LockMode.READ);
         sync.verify(Methods.BEGIN_READ);
     }
 
     /**
      * Tests whether a write lock can be obtained.
      */
     @Test
     void testLockWrite() {
         config.lock(LockMode.WRITE);
         sync.verify(Methods.BEGIN_WRITE);
     }
 
     /**
      * Tests the correct synchronization of setProperty().
      */
     @Test
     void testSetPropertySynchronized() {
         config.setProperty(PROP, "yes");
         sync.verifyStart(Methods.BEGIN_WRITE);
         sync.verifyEnd(Methods.END_WRITE);
     }
 
     /**
      * Tests whether size() is correctly synchronized.
      */
     @Test
     void testSizeSynchronized() {
         assertFalse(config.isEmpty());
         sync.verify(Methods.BEGIN_READ, Methods.END_READ);
     }
 
     /**
      * Tests synchronization of subset().
      */
     @Test
     void testSubsetSynchronized() {
         final AbstractConfiguration subset = (AbstractConfiguration) config.subset("configuration");
         sync.verify();
         assertEquals(NoOpSynchronizer.INSTANCE, subset.getSynchronizer());
     }
 
     /**
      * Tests whether a read lock can be released.
      */
     @Test
     void testUnlockRead() {
         config.unlock(LockMode.READ);
         sync.verify(Methods.END_READ);
     }
 
     /**
      * Tests whether a write lock can be released.
      */
     @Test
     void testUnlockWrite() {
         config.unlock(LockMode.WRITE);
         sync.verify(Methods.END_WRITE);
     }
 }