/*
    * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
    *
    * Licensed 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
    *
    *     http://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 test.de.smartics.properties.spi.core.metadata;
  
  import static org.hamcrest.MatcherAssert.assertThat;
  import static org.hamcrest.Matchers.equalTo;
  import static org.hamcrest.Matchers.is;
  
  import java.lang.reflect.Method;
  import java.util.List;
  
  import org.junit.Test;
  
  import de.smartics.properties.api.core.annotations.AccessType;
  import de.smartics.properties.api.core.annotations.PropertyDefinitionTime;
  import de.smartics.properties.api.core.annotations.PropertyLifecycle;
  import de.smartics.properties.api.core.annotations.PropertySet;
  import de.smartics.properties.api.core.domain.PropertyDescriptor;
  import de.smartics.properties.spi.core.metadata.PropertyMetaDataParser;
  import de.smartics.testdoc.annotations.Uut;
  
  /**
   * Tests {@link de.smartics.properties.spi.core.metadata.PropertyMetaDataParser}
   * with {@link PropertyLifecycle} annotations.
   */
  @Uut(type = PropertyMetaDataParser.class)
  public class PropertyMetaDataParserMetaDataTest extends
      AbstractPropertyMetaDataParserTestBase
  { // NOPMD
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    private static final long SOME_MILLIS = 128L;
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Inner Classes *****************************
  
    @PropertySet
    public interface TestProperties
    {
      String noAnnotation();
  
      @PropertyLifecycle
      String defaultMetaData();
  
      @PropertyLifecycle(definitionTime = PropertyDefinitionTime.RUN,
          access = AccessType.READ_WRITE, updateInterval = SOME_MILLIS)
      String allSpecifed();
  
      String allSpecifiedPropertyKey();
    }
  
    // ********************************* Methods ********************************
  
    // --- prepare --------------------------------------------------------------
  
    // --- helper ---------------------------------------------------------------
  
    private PropertyDescriptor runTest(final String methodNameAndPropertyName)
    {
      final Method method =
          fetchMethod(TestProperties.class, methodNameAndPropertyName);
      final PropertyDescriptor descriptor = uut.readDescriptor(method);
      return descriptor;
    }
  
    // --- tests ----------------------------------------------------------------
  
    @Test
    public void propertyMetaDataAnnotationIsNotRequired()
    {
      final PropertyDescriptor descriptor = runTest("noAnnotation");
  
      assertThat(descriptor.getConfigurationTime(),
          is(equalTo(PropertyDefinitionTime.STARTUP)));
      assertThat(descriptor.getUpdateIntervalInMs(), is(equalTo(-1L)));
      assertThat(descriptor.isRuntimeMutable(), is(equalTo(false)));
    }
  
    @Test
    public void propertyMetaDataAnnotationProvidesDefaults()
    {
      final PropertyDescriptor descriptor = runTest("defaultMetaData");
  
     assertThat(descriptor.getConfigurationTime(),
         is(equalTo(PropertyDefinitionTime.STARTUP)));
     assertThat(descriptor.getUpdateIntervalInMs(), is(equalTo(-1L)));
     assertThat(descriptor.isRuntimeMutable(), is(equalTo(false)));
   }
 
   @Test
   public void propertyMetaDataAnnotationFromType()
   {
     final List<PropertyDescriptor> descriptors =
         uut.readDescriptors(TestProperties.class);
 
     assertThat(descriptors.size(), is(equalTo(3)));
   }
 
   @Test
   public void propertyMetaDataAnnotationAllowsToProvideConfigurationTimeAndUpdateInterval()
   {
     final PropertyDescriptor descriptor = runTest("allSpecifed");
 
     assertThat(descriptor.getConfigurationTime(),
         is(equalTo(PropertyDefinitionTime.RUN)));
     assertThat(descriptor.getUpdateIntervalInMs(), is(equalTo(SOME_MILLIS)));
     assertThat(descriptor.isRuntimeMutable(), is(equalTo(true)));
   }
 }