/*
    * 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.reports;
  
  import static org.hamcrest.MatcherAssert.assertThat;
  import static org.hamcrest.Matchers.allOf;
  import static org.hamcrest.Matchers.containsString;
  import static org.hamcrest.Matchers.equalTo;
  import static org.hamcrest.Matchers.is;
  import static org.mockito.Mockito.mock;
  import static org.mockito.Mockito.when;
  
  import java.io.ByteArrayOutputStream;
  import java.io.UnsupportedEncodingException;
  
  import org.junit.Before;
  import org.junit.Test;
  import org.junit.experimental.categories.Category;
  
  import de.smartics.properties.api.core.domain.DocumentMetaData;
  import de.smartics.properties.api.core.domain.PropertyDescriptor;
  import de.smartics.properties.api.core.domain.PropertyExpression;
  import de.smartics.properties.api.core.domain.PropertyKey;
  import de.smartics.properties.report.data.PropertyReportItem;
  import de.smartics.properties.report.data.PropertyReportSet;
  import de.smartics.properties.reports.PropertiesPropertyReport;
  import de.smartics.properties.spi.core.metadata.projectdoc.ProjectdocMetaData;
  import de.smartics.testdoc.annotations.Uut;
  import de.smartics.testdoc.categories.Technical;
  import de.smartics.util.lang.NullArgumentException;
  
  /**
   * Tests {@link PropertiesPropertyReport}.
   */
  public class PropertiesPropertyReportTest
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    private static final String KEY_STRING_1 = "test.name.x";
  
    private static final String EXPRESSION_1 = null;
  
    private static final String KEY_STRING_2 = "test.name.y";
  
    private static final String EXPRESSION_2 = "42";
  
    // --- members --------------------------------------------------------------
  
    @Uut
    private PropertiesPropertyReport uut;
  
    private ByteArrayOutputStream out;
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- prepare --------------------------------------------------------------
  
    @Before
    public void setUp()
    {
      out = new ByteArrayOutputStream(2048);
      uut = new PropertiesPropertyReport(out);
    }
  
    // --- helper ---------------------------------------------------------------
  
    private static PropertyReportItem.Builder createBuilder(
        final String keyString, final String expression)
    {
      final PropertyDescriptor descriptor = mock(PropertyDescriptor.class);
      final PropertyKey key = new PropertyKey(keyString);
      when(descriptor.getKey()).thenReturn(key);
      if (expression != null)
      {
        final PropertyExpression ex = PropertyExpression.create(expression);
        when(descriptor.getDefaultExpression()).thenReturn(ex);
      }
      final DocumentMetaData metaData = new ProjectdocMetaData();
      when(descriptor.getDocumentMetaData()).thenReturn(metaData);
  
      final PropertyReportItem.Builder builder = new PropertyReportItem.Builder();
      builder.with(descriptor);
     return builder;
   }
 
   private void addItem(final String keyString, final String expression)
   {
     final PropertyReportItem.Builder builder =
         createBuilder(keyString, expression);
     final PropertyReportItem item = builder.build();
     uut.handle(item);
   }
 
   // --- tests ----------------------------------------------------------------
 
   @Test(expected = NullArgumentException.class)
   @Category(Technical.class)
   public void requiresANonNullStream()
   {
     new PropertiesPropertyReport(null);
   }
 
   @Test
   @Category(Technical.class)
   public void allowsFlushingAnEmptyPropertySet()
   {
     uut.flush();
     final int writtenBytes = out.toByteArray().length;
     assertThat(writtenBytes, is(equalTo(0)));
   }
 
   @Test
   @SuppressWarnings("unchecked")
   public void addsItemsWithoutPropertySet() throws UnsupportedEncodingException
   {
     addItem(KEY_STRING_1, EXPRESSION_1);
     addItem(KEY_STRING_2, EXPRESSION_2);
 
     uut.flush();
 
     final String written = out.toString("ISO8859_1");
     assertThat(
         written,
         allOf(containsString(KEY_STRING_1), containsString(KEY_STRING_2),
             containsString(EXPRESSION_2)));
   }
 
   @Test
   @SuppressWarnings("unchecked")
   public void addsItemsWithPropertySet() throws UnsupportedEncodingException
   {
     final PropertyReportSet.Builder builder = new PropertyReportSet.Builder();
     builder.withComment("comment").withType("type");
     final PropertyReportSet reportSet = builder.build();
     uut.handle(reportSet);
 
     addItem(KEY_STRING_1, EXPRESSION_1);
     addItem(KEY_STRING_2, EXPRESSION_2);
 
     uut.flush();
 
     final String written = out.toString("ISO8859_1");
     assertThat(
         written,
         allOf(containsString("type"), containsString("comment"),
             containsString(KEY_STRING_1), containsString(KEY_STRING_2),
             containsString(EXPRESSION_2)));
   }
 }