/*
    * 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.config.definition;
  
  import static de.smartics.properties.api.config.domain.key.EnvironmentId.ANY_ENV;
  import static org.hamcrest.MatcherAssert.assertThat;
  import static org.hamcrest.Matchers.equalTo;
  import static org.hamcrest.Matchers.is;
  
  import java.util.HashSet;
  import java.util.Set;
  
  import org.junit.Test;
  
  import de.smartics.properties.api.config.domain.key.ApplicationId;
  import de.smartics.properties.api.config.domain.key.ConfigurationKey;
  import de.smartics.properties.api.config.domain.key.EnvironmentId;
  import de.smartics.properties.spi.config.definition.DefinitionKeyHelper;
  import de.smartics.properties.spi.config.definition.PropertiesDefinitionContext;
  import de.smartics.testdoc.annotations.Uut;
  import de.smartics.util.lang.NullArgumentException;
  
  /**
   * Tests {@link DefinitionKeyHelper} with registered groups, nodes and
   * environments.
   */
  @Uut(type = DefinitionKeyHelper.class)
  public class DefinitionKeyHelperRegisteredTest
  { // NOPMD
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    private static final String COM_GROUP = "com.smartics.test.one";
  
    private static final String DEFAULT_GROUP = "de.smartics.test.one";
  
    private static final String NON_STANDARD_GROUP = "nonstandard";
  
    private static final String NON_STANDARD_TLD = "xxx";
  
    private static final String NON_STANDARD_GROUP_TLD = NON_STANDARD_TLD
                                                         + ".example.test";
  
    // ... environments .........................................................
  
    private static final EnvironmentId ENV_PRODUCTION = new EnvironmentId(
        "production");
  
    private static final EnvironmentId ENV_PRODUCTION_A = new EnvironmentId(
        "production", DEFAULT_GROUP);
  
    private static final EnvironmentId ENV_PRODUCTION_XX = new EnvironmentId(
        DEFAULT_GROUP);
  
    // ... applications .........................................................
  
    private static final ApplicationId APP_ANY_IN_GROUP_ONE = new ApplicationId(
        COM_GROUP, null, null);
  
    private static final ApplicationId APP_WITH_NON_STANDARD_GROUP =
        new ApplicationId(NON_STANDARD_GROUP, null, null);
  
    private static final ApplicationId APP_WITH_NON_STANDARD_TLD =
        new ApplicationId(NON_STANDARD_GROUP_TLD, null, null);
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- prepare --------------------------------------------------------------
  
    // --- helper ---------------------------------------------------------------
  
    private void runTest(final DefinitionKeyHelper uut,
        final EnvironmentId envId, final ApplicationId appId)
      throws IllegalArgumentException, NullArgumentException
    {
      final String path =
          envId.toString() + (envId != ANY_ENV ? "/" : "") + appId.toPath();
      runTest(uut, path, envId, appId);
    }
  
    private void runTest(final DefinitionKeyHelper uut, final String path,
       final EnvironmentId envId, final ApplicationId appId)
     throws IllegalArgumentException, NullArgumentException
   {
     final ConfigurationKey key = uut.parse(path);
 
     final ConfigurationKey expectedKey = new ConfigurationKey(envId, appId);
     assertThat(key, is(equalTo(expectedKey)));
   }
 
   // --- tests ----------------------------------------------------------------
 
   @Test
   public void identifiesRegisteredEnvironments()
   {
     final Set<String> envs = new HashSet<String>();
     envs.add(DEFAULT_GROUP);
 
     final PropertiesDefinitionContext context =
         new PropertiesDefinitionContext(envs, null, null);
 
     final DefinitionKeyHelper uut = new DefinitionKeyHelper(context);
     runTest(uut, ENV_PRODUCTION_XX, APP_ANY_IN_GROUP_ONE);
   }
 
   @Test
   public void identifiesRegisteredNodes()
   {
     final Set<String> nodes = new HashSet<String>();
     nodes.add(DEFAULT_GROUP);
 
     final PropertiesDefinitionContext context =
         new PropertiesDefinitionContext(null, nodes, null);
 
     final DefinitionKeyHelper uut = new DefinitionKeyHelper(context);
     runTest(uut, ENV_PRODUCTION_A, APP_ANY_IN_GROUP_ONE);
   }
 
   @Test
   public void identifiesRegisteredGroups()
   {
     final Set<String> groups = new HashSet<String>();
     groups.add(NON_STANDARD_GROUP);
 
     final PropertiesDefinitionContext context =
         new PropertiesDefinitionContext(null, null, groups);
 
     final DefinitionKeyHelper uut = new DefinitionKeyHelper(context);
     runTest(uut, ENV_PRODUCTION, APP_WITH_NON_STANDARD_GROUP);
   }
 
   @Test
   public void identifiesGroupByRegisteredTlds()
   {
     final Set<String> tlds = new HashSet<String>();
     tlds.add(NON_STANDARD_TLD);
 
     final PropertiesDefinitionContext context =
         new PropertiesDefinitionContext(tlds, null, null, null, null);
 
     final DefinitionKeyHelper uut = new DefinitionKeyHelper(context);
     runTest(uut, ENV_PRODUCTION, APP_WITH_NON_STANDARD_TLD);
   }
 }