/*
    * Copyright 2010-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.xml.encoding;
  
  import static org.junit.Assert.assertEquals;
  import static org.junit.Assert.assertNull;
  
  import java.io.ByteArrayInputStream;
  import java.io.InputStream;
  import java.io.UnsupportedEncodingException;
  
  import org.junit.Before;
  import org.junit.Test;
  import org.junit.experimental.categories.Category;
  import org.xml.sax.InputSource;
  
  import de.smartics.testdoc.annotations.Uut;
  import de.smartics.testdoc.categories.Technical;
  
  /**
   * Tests {@link XmlDescriptorDetector}.
   */
  public class XmlDescriptorDetectorTest
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    private static final String ENCODING = "UTF-16";
  
    private static final String VERSION = "1.0";
  
    private static final String TNS = "http://example.com/test/1";
  
    private static final String PUBLIC_ID = "http://example.com/test";
  
    private static final String SYSTEM_ID = "file:///tmp/test.xml";
  
    // --- members --------------------------------------------------------------
  
    @Uut
    private XmlDescriptorDetector uut;
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- prepare --------------------------------------------------------------
  
    @Before
    public void setUp()
    {
      uut = new XmlDescriptorDetector();
    }
  
    // --- helper ---------------------------------------------------------------
  
    private String createTestXmlDocument(final boolean encoding,
        final boolean nameSpace)
    {
      // NOTE that the target namespace is *not* evaluated!
      return "<?xml version='" + VERSION + "'"
             + (encoding ? " encoding='" + ENCODING + "'" : "") + "?>\n<root"
             + (nameSpace ? " targetNamespace='" + TNS + "'" : "") + "/>\n";
    }
  
    private InputStream createTestXmlDocumentInputStream(final boolean encoding,
        final boolean nameSpace) throws UnsupportedEncodingException
    {
      final String xmlDocument = createTestXmlDocument(encoding, nameSpace);
      final InputStream xmlInput =
          new ByteArrayInputStream(xmlDocument.getBytes(ENCODING));
      return xmlInput;
    }
  
    // --- tests ----------------------------------------------------------------
  
    @Test
    public void supportsReadingFromInputStreamButWithoutIdDetection()
      throws Exception
    {
      final InputStream input = createTestXmlDocumentInputStream(true, true);
      final XmlDescriptor descriptor = uut.readDescriptor(input);
  
      assertEquals(VERSION, descriptor.getVersion());
      assertEquals(ENCODING, descriptor.getEncoding());
     assertNull(descriptor.getPublicId());
     assertNull(descriptor.getSystemId());
   }
 
   @Test
   @Category(Technical.class)
   public void theEncodingInformationIsNotRequired() throws Exception
   {
     final InputStream stream = createTestXmlDocumentInputStream(false, true);
     final XmlDescriptor descriptor = uut.readDescriptor(stream);
 
     assertEquals(VERSION, descriptor.getVersion());
     assertEquals(ENCODING, descriptor.getEncoding());
   }
 
   @Test
   public void supportsReadingFromInputSource() throws Exception
   {
     final InputStream stream = createTestXmlDocumentInputStream(true, true);
 
     final InputSource source = new InputSource(stream);
     source.setSystemId(SYSTEM_ID);
     source.setPublicId(PUBLIC_ID);
 
     final XmlDescriptor descriptor = uut.readDescriptor(source);
 
     assertEquals(VERSION, descriptor.getVersion());
     assertEquals(ENCODING, descriptor.getEncoding());
     assertEquals(PUBLIC_ID, descriptor.getPublicId());
     assertEquals(SYSTEM_ID, descriptor.getSystemId());
   }
 }