/*
    * 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 de.smartics.properties.tutorial.property.constraints;
  
  import static org.junit.Assert.fail;
  
  import javax.validation.groups.Default;
  
  import org.junit.Before;
  import org.junit.Test;
  
  import de.smartics.projectdoc.annotations.DocCategory;
  import de.smartics.projectdoc.annotations.Document;
  import de.smartics.projectdoc.annotations.topic.DocSection;
  import de.smartics.properties.api.config.domain.ConfigurationValidationException;
  import de.smartics.properties.impl.config.classpath.ClasspathConfigurationProperties;
  import de.smartics.properties.impl.config.classpath.ClasspathConfigurationPropertiesFactory;
  import de.smartics.testdoc.categories.type.Integration;
  import de.smartics.validation.constraints.groups.Startup;
  
  /**
   * This tutorial introduces how to add constraints to the property declaration.
   * <p>
   * This feature takes the burden of validation from the developers shoulders. It
   * is based on <a href="http://jcp.org/en/jsr/detail?id=303">Beans Validation
   * (JSR-303)</a>, so any constraint defined with this technology can be used for
   * validating properties.
   * </p>
   */
  @Document(title = "Property Constraints With Groups", sortKey = "basics0060")
  @DocCategory({ "basics" })
  // @DocTopic(path="basics", step="60")
  public class PropertyConstraintsWithGroupsTutorial
  {
    private ClasspathConfigurationProperties config; // NOPMD
  
    private static final Class<GroupConstraintsProperties> TYPE =
        GroupConstraintsProperties.class;
  
    private GroupConstraintsProperties properties;
  
    @Before
    public void setUp()
    {
      config = createConfiguration();
      properties = config.getProperties(TYPE);
    }
  
    private static ClasspathConfigurationProperties createConfiguration()
    {
      final ClasspathConfigurationPropertiesFactory factory =
          new ClasspathConfigurationPropertiesFactory();
      final ClasspathConfigurationProperties config = factory.create();
      config.addClassPathProperties(TYPE);
      return config;
    }
  
    /**
     * <p>
     * Let's have a look at some examples that use groups to activate and
     * deactivate constraints for a particular validation.
     * </p>
     * <p>
     * In the following example the value <code>11</code> is correct in the
     * default group, but not in the startup group.
     * </p>
     */
    @Test(expected = ConfigurationValidationException.class)
    @DocSection
    public void invalidInStartupGroup()
    {
      config.setProperty(properties.startupGroupPropertyKey(), "11");
  
      try
      {
        config.validate();
      }
      catch (final ConfigurationValidationException e)
      {
        fail("Validation exception not expected since Startup group not activated.");
      }
  
      config.validate(Startup.class);
    }
  
    /**
    * <p>
    * Having no group or explicitly set the constraint in a default group has the
    * same effect.
    * </p>
    */
   @Test(expected = ConfigurationValidationException.class)
   @DocSection
   public void declaredDefaultGroup()
   {
     config.setProperty(properties.defaultGroupPropertyKey(), "11");
     config.validate();
   }
 
   /**
    * <p>
    * And it is also the same if you call the validation using the default group.
    * </p>
    */
   @Test(expected = ConfigurationValidationException.class)
   @DocSection
   public void declaredDefaultGroupExplictCallWithDefaultGroup()
   {
     config.setProperty(properties.defaultGroupPropertyKey(), "2");
     config.validate(Default.class);
   }
 
   /**
    * <p>
    * If there are no constraints in the given group, every value is valid.
    * </p>
    */
   @Test
   @DocSection
   public void calledWithUnknownGroup()
   {
     config.setProperty(properties.startupGroupPropertyKey(), "11");
     config.validate(Integration.class);
   }
 }