/*
    * 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.ApplicationId.ANY_APP;
  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 org.junit.Before;
  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.testdoc.annotations.Uut;
  import de.smartics.util.lang.NullArgumentException;
  
  /**
   * Tests {@link DefinitionKeyHelper}.
   */
  public class DefinitionKeyHelperTest
  { // NOPMD
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // ... environments .........................................................
  
    private static final EnvironmentId ENV_PRODUCTION = new EnvironmentId(
        "production");
  
    private static final EnvironmentId ENV_PRODUCTION_A = new EnvironmentId(
        "production", "a");
  
    // ... applications .........................................................
  
    private static final String DEFAULT_GROUP = "de.smartics.test.one";
  
    private static final String TLD_COM_GROUP = "com.smartics.test.one";
  
    private static final String DEFAULT_ARTIFACT = "app-1";
  
    private static final ApplicationId APP_ANY_IN_GROUP_ONE = new ApplicationId(
        DEFAULT_GROUP, null, null);
  
    private static final ApplicationId APP_ANY_VERSION_OF_APP_1 =
        new ApplicationId(DEFAULT_GROUP, DEFAULT_ARTIFACT, null);
  
    private static final ApplicationId APP_APP_1_V1 = new ApplicationId(
        DEFAULT_GROUP, DEFAULT_ARTIFACT, "1.0");
  
    private static final ApplicationId APP_ANY_IN_GROUP_COM = new ApplicationId(
        TLD_COM_GROUP, null, null);
  
    // --- members --------------------------------------------------------------
  
    @Uut
    private DefinitionKeyHelper uut;
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- prepare --------------------------------------------------------------
  
    @Before
    public void setUp()
    {
      uut = new DefinitionKeyHelper();
    }
  
    // --- helper ---------------------------------------------------------------
  
    private void runTest(final EnvironmentId envId, final ApplicationId appId)
      throws IllegalArgumentException, NullArgumentException
    {
      final String path =
          envId.toString() + (envId != ANY_ENV ? "/" : "") + appId.toPath();
      runTest(path, envId, appId);
    }
  
    private void runTest(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 identifiesAnEnvironmentOnly()
   {
     runTest(ENV_PRODUCTION, ANY_APP);
   }
 
   @Test
   public void identifiesAnEnvironmentWithoutNode()
   {
     runTest(ENV_PRODUCTION, APP_ANY_IN_GROUP_ONE);
   }
 
   @Test
   public void identifiesAnEnvironmentWithNodeButNotApplication()
   {
     runTest(ENV_PRODUCTION_A, ANY_APP);
   }
 
   @Test
   public void identifiesAnEnvironmentWithNodeAndApplicationGroup()
   {
     runTest(ENV_PRODUCTION_A, APP_ANY_IN_GROUP_ONE);
   }
 
   @Test
   public void identifiesAnEnvironmentWithNodeAndApplicationGroupAndArtifact()
   {
     runTest(ENV_PRODUCTION_A, APP_ANY_VERSION_OF_APP_1);
   }
 
   @Test
   public void identifiesAnEnvironmentWithNodeAndApplicationGroupAndArtifactAndVersion()
   {
     runTest(ENV_PRODUCTION_A, APP_APP_1_V1);
   }
 
   @Test
   public void identifiesApplicationGroupAndArtifactAndVersion()
   {
     runTest(ANY_ENV, APP_APP_1_V1);
   }
 
   @Test
   public void startingSlashAllowedWithEnvironment()
   {
     final String path = '/' + ENV_PRODUCTION.toString();
     runTest(path, ENV_PRODUCTION, ANY_APP);
   }
 
   @Test
   public void startingSlashAllowedWithApplicationOnly()
   {
     final String path = '/' + APP_APP_1_V1.toPath();
     runTest(path, ANY_ENV, APP_APP_1_V1);
   }
 
   @Test
   public void trailingSlashAllowedWithEnvironment()
   {
     final String path = ENV_PRODUCTION.toString() + '/';
     runTest(path, ENV_PRODUCTION, ANY_APP);
   }
 
   @Test
   public void trailingSlashAllowedWithApplicationOnly()
   {
     final String path = APP_APP_1_V1.toPath() + '/';
     runTest(path, ANY_ENV, APP_APP_1_V1);
   }
 
   @Test
   public void identifiesAnEnvironmentWithNodeAndApplicationGroupCom()
   {
     runTest(ENV_PRODUCTION_A, APP_ANY_IN_GROUP_COM);
   }
 
   @Test
   public void returnsAnyEnvAnyAppKeyIfNoPathIsGiven()
   {
     final ConfigurationKey key = uut.parse("");
     final ConfigurationKey expectedKey =
         new ConfigurationKey(EnvironmentId.ANY_ENV, ApplicationId.ANY_APP);
     assertThat(key, is(equalTo(expectedKey)));
   }
 
   @Test
   public void skipsPropertiesFile()
   {
     final String path = ENV_PRODUCTION.toString() + "/my-module.properties";
     runTest(path, ENV_PRODUCTION, ANY_APP);
   }
 }