/*
    * 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
    *
   *   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 org.apache.maven.archetype.ui.generation;
  
  import java.util.Arrays;
  import java.util.List;
  
  import org.apache.maven.archetype.ui.ArchetypeConfiguration;
  import org.junit.Before;
  import org.junit.Test;
  
  import static org.junit.Assert.assertEquals;
  
  public class RequiredPropertyComparatorTest {
      private DefaultArchetypeGenerationConfigurator.RequiredPropertyComparator requiredPropertyComparator;
  
      private ArchetypeConfiguration archetypeConfiguration;
  
      @Before
      public void setUp() throws Exception {
          archetypeConfiguration = new ArchetypeConfiguration();
          requiredPropertyComparator =
                  new DefaultArchetypeGenerationConfigurator.RequiredPropertyComparator(archetypeConfiguration);
      }
  
      @Test
      public void testShouldOrderPropertiesWhenReferringEachOther() {
          archetypeConfiguration.addRequiredProperty("prop1");
          archetypeConfiguration.setDefaultProperty("prop1", "${prop2}");
          archetypeConfiguration.addRequiredProperty("prop2");
          archetypeConfiguration.setDefaultProperty("prop2", "prop2 default value");
  
          List<String> requiredProperties = archetypeConfiguration.getRequiredProperties();
          assertEquals(Arrays.asList("prop1", "prop2"), requiredProperties);
          requiredProperties.sort(requiredPropertyComparator);
          assertEquals(Arrays.asList("prop2", "prop1"), requiredProperties);
      }
  
      @Test
      public void testShouldOrderPropertiesWhenReferringEachOther2() {
          archetypeConfiguration.addRequiredProperty("prop1");
          archetypeConfiguration.setDefaultProperty("prop1", "${prop2}");
          archetypeConfiguration.addRequiredProperty("prop2");
  
          List<String> requiredProperties = archetypeConfiguration.getRequiredProperties();
          assertEquals(Arrays.asList("prop1", "prop2"), requiredProperties);
          requiredProperties.sort(requiredPropertyComparator);
          assertEquals(Arrays.asList("prop2", "prop1"), requiredProperties);
      }
  
      @Test
      public void testTransitivePropertyReferences() {
          archetypeConfiguration.addRequiredProperty("foo");
          archetypeConfiguration.setDefaultProperty("foo", "${bar}");
          archetypeConfiguration.addRequiredProperty("bar");
          archetypeConfiguration.setDefaultProperty("bar", "${baz}");
          archetypeConfiguration.addRequiredProperty("baz");
  
          List<String> requiredProperties = archetypeConfiguration.getRequiredProperties();
          assertEquals(Arrays.asList("foo", "bar", "baz"), requiredProperties);
          requiredProperties.sort(requiredPropertyComparator);
          assertEquals(Arrays.asList("baz", "bar", "foo"), requiredProperties);
      }
  
      @Test
      public void testPropertiesWithHyphen() {
          archetypeConfiguration.addRequiredProperty("description");
          archetypeConfiguration.setDefaultProperty("description", "${acronym-app} project-arch: ${component-name}");
          archetypeConfiguration.addRequiredProperty("component-name");
          archetypeConfiguration.addRequiredProperty("acronym-app");
  
          List<String> requiredProperties = archetypeConfiguration.getRequiredProperties();
          assertEquals(Arrays.asList("description", "component-name", "acronym-app"), requiredProperties);
          requiredProperties.sort(requiredPropertyComparator);
          assertEquals(Arrays.asList("component-name", "acronym-app", "description"), requiredProperties);
      }
  }