/*
    * 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.myfaces.custom.transform;
  
  import java.io.File;
  import java.io.FileInputStream;
  import java.io.IOException;
  import java.io.InputStream;
  import java.io.StringWriter;
  import java.net.URI;
  import java.net.URL;
  
  import junit.framework.Test;
  import junit.framework.TestSuite;
  
  import org.apache.myfaces.test.base.AbstractJsfTestCase;
  import org.apache.myfaces.test.mock.MockHttpServletRequest;
  import org.apache.myfaces.test.mock.MockRenderKitFactory;
  import org.apache.myfaces.test.mock.MockResponseWriter;
  import org.apache.myfaces.test.mock.MockValueBinding;
  
  /**
   * Test case for XmlTransform
   *
   * @author Sean Schofield
   */
  public class XmlTransformTest extends AbstractJsfTestCase
  {
      private static final String PETS_STYLESHEET = "pets.xsl";
      private static final String PETS_CONTENT = "pets.xml";
      private static final String EXPECTED_TEXT = "Iguana";
  
      private XmlTransform xmlTransform;
      private ManagedFoo fooBean;
      private String stylesheet;
      private String stylesheetLocation = PETS_STYLESHEET;
      private InputStream styleStream;
      private String content;
      private String contentLocation = PETS_CONTENT;
      private InputStream contentStream;
  
      private StringWriter mockWriter = new StringWriter();
  
      /**
       * Constructor
       * @param name String
       */
      public XmlTransformTest(String name)
      {
          super(name);
      }
  
      /**
       * See abstract class
       */
      public void setUp() throws Exception
      {
          super.setUp();
  
          xmlTransform = new XmlTransform();
  
          // additional setup not provided automatically by the shale mock stuff
          facesContext.setResponseWriter(new MockResponseWriter(mockWriter, null, null));
  
          // TODO remove these two lines once shale-test goes alpha, see MYFACES-1155
          facesContext.getViewRoot().setRenderKitId(MockRenderKitFactory.HTML_BASIC_RENDER_KIT);
  
          fooBean = new ManagedFoo();
          fooBean.setContentLocation(PETS_CONTENT);
          fooBean.setStylesheetLocation(PETS_STYLESHEET);
  
          // put the foo bean in the request scope
          MockHttpServletRequest request = (MockHttpServletRequest)facesContext.getExternalContext().getRequest();
          request.setAttribute("foo", fooBean);
  
          // setup input stream to be used in some of the test cases
          ClassLoader loader = Thread.currentThread().getContextClassLoader();
          if (loader == null)
          {
              loader = XmlTransform.class.getClassLoader();
          }
  
         URL url = loader.getResource(PETS_CONTENT);
         try
         {
             contentStream = new FileInputStream(new File(URI.create(url.toString())));
 
             // now also populate the String variable for certain test cases
             FileInputStream cs = new FileInputStream(new File(URI.create(url.toString())));
             int x= cs.available();
             byte b[]= new byte[x];
             //noinspection ResultOfMethodCallIgnored
             cs.read(b);
             content = new String(b);
         }
         catch (IOException io)
         {}  // do nothing - test will fail eventually
 
         // setup stylesheet text to be used in some of the test cases
         url = loader.getResource(PETS_STYLESHEET);
         try
         {
             styleStream = new FileInputStream(new File(URI.create(url.toString())));
 
             // now also populate the String variable for certain test cases
             FileInputStream ss = new FileInputStream(new File(URI.create(url.toString())));
             int x= ss.available();
             byte b[]= new byte[x];
             //noinspection ResultOfMethodCallIgnored
             ss.read(b);
             stylesheet = new String(b);
         }
         catch (IOException io)
         {}  // do nothing - test will fail eventually
 
         fooBean.setContent(content);
         fooBean.setStylesheet(stylesheet);
         fooBean.setContentStream(contentStream);
         fooBean.setStyleStream(styleStream);
     }
 
     /**
      * Test the save and restore state methods.
      */
     public void testSaveAndRestoreState()
     {
         /**
          * NOTE: Normally you would not set all of these properties together in the component, but for the
          * purposes of testing, we want to make sure all fields are saved and restored properly.
          */
         xmlTransform.setContent(content);
         xmlTransform.setContentLocation(contentLocation);
         xmlTransform.setStylesheet(stylesheet);
         xmlTransform.setStylesheetLocation(stylesheetLocation);
         xmlTransform.setContentStream(contentStream);
         xmlTransform.setStyleStream(styleStream);
 
         Object state = xmlTransform.saveState(facesContext);
         xmlTransform = new XmlTransform();
         xmlTransform.restoreState(facesContext, state);
 
         assertEquals(content, xmlTransform.getContent());
         assertEquals(contentLocation, xmlTransform.getContentLocation());
         assertEquals(stylesheet, xmlTransform.getStylesheet());
         assertEquals(stylesheetLocation, xmlTransform.getStylesheetLocation());
         assertNull("contentStream should be null since it cannot be serialized", xmlTransform.getContentStream());
         assertNull("styleStream should be null since it cannot be serialized", xmlTransform.getStyleStream());
     }
 
     /**
      * Test the save and restore state methods with all values as value binding expressions.  This also tests
      * the value bindings themselves to make sure they are working.
      */
     public void testSaveAndRestoreStateValueBinding()
     {
         /**
          * NOTE: Normally you would not set all of these properties together in the component, but for the
          * purposes of testing, we want to make sure all fields are saved and restored properly.
          */
         xmlTransform.setValueBinding("content", new MockValueBinding(application, "#{foo.content}"));
         xmlTransform.setValueBinding("contentLocation", new MockValueBinding(application, "#{foo.contentLocation}"));
         xmlTransform.setValueBinding("stylesheet", new MockValueBinding(application, "#{foo.stylesheet}"));
         xmlTransform.setValueBinding("stylesheetLocation", new MockValueBinding(application, "#{foo.stylesheetLocation}"));
         xmlTransform.setValueBinding("contentStream", new MockValueBinding(application, "#{foo.contentStream}"));
         xmlTransform.setValueBinding("styleStream", new MockValueBinding(application, "#{foo.styleStream}"));
 
         Object state = xmlTransform.saveState(facesContext);
         xmlTransform = new XmlTransform();
         xmlTransform.restoreState(facesContext, state);
 
         assertEquals(content, xmlTransform.getContent());
         assertEquals(contentLocation, xmlTransform.getContentLocation());
         assertEquals(stylesheet, xmlTransform.getStylesheet());
         assertEquals(stylesheetLocation, xmlTransform.getStylesheetLocation());
         assertEquals(contentStream, xmlTransform.getContentStream());
     }
 
     public void testSetContent()
     {
         xmlTransform.setContent("foo");
         assertEquals("foo", xmlTransform.getContent());
 
         // reset property so we can test value binding
         xmlTransform.setContent(null);
         xmlTransform.setValueBinding("content", new MockValueBinding(application, "#{foo.content}"));
         assertEquals(fooBean.getContent(), xmlTransform.getContent());
     }
 
     public void testSetContentStream()
     {
         xmlTransform.setContentStream(fooBean.getContentStream());
         assertEquals(fooBean.getContentStream(), xmlTransform.getContentStream());
     }
 
     public void testSetContentStreamValueBinding()
     {
         xmlTransform.setValueBinding("contentStream", new MockValueBinding(application, "#{foo.contentStream}"));
         assertEquals(fooBean.getContentStream(), xmlTransform.getContentStream());
     }
 
     public void testSetStylesheet()
     {
         xmlTransform.setStylesheet("foo");
         assertEquals("foo", xmlTransform.getStylesheet());
 
         // reset property so we can test value binding
         xmlTransform.setStylesheet(null);
         xmlTransform.setValueBinding("stylesheet", new MockValueBinding(application, "#{foo.stylesheet}"));
         assertEquals(fooBean.getStylesheet(), xmlTransform.getStylesheet());
     }
 
     /**
      * Component should throw NPE if no stylesheet or Transform is provided
      */
     public void testNoTransformInfo() throws IOException
     {
         try
         {
             xmlTransform.encodeBegin(facesContext);
         }
         catch (NullPointerException e)
         {
             return;
         }
 
         fail("Expected exception when no Transform or stylesheet provided");
     }
 
     /**
      * Component should throw NPE if no content is provided
      */
     public void testStylesheetNoContent() throws IOException
     {
         // stylesheet is not sufficient, content must be provided
         xmlTransform.setStylesheet("blah");
 
         try
         {
             xmlTransform.encodeBegin(facesContext);
         }
         catch (NullPointerException e)
         {
             return;
         }
 
         fail("Expected exception when stylesheet but no content provided");
     }
 
     public void testStyleSheet() throws IOException
     {
         xmlTransform.setContentLocation(contentLocation);
         xmlTransform.setStylesheet(stylesheet);
         xmlTransform.encodeBegin(facesContext);
 
         String responseText = mockWriter.toString();
         assertEquals("Unexpected response text from content transformation", EXPECTED_TEXT, responseText);
     }
 
     public void testStyleSheetValueBinding() throws IOException
     {
         xmlTransform.setContent(content);
         xmlTransform.setValueBinding("stylesheet", new MockValueBinding(application, "#{foo.stylesheet}"));
         xmlTransform.encodeBegin(facesContext);
 
         String responseText = mockWriter.toString();
         assertEquals("Unexpected response text from content transformation", EXPECTED_TEXT, responseText);
     }
 
     public void testStylesheetLocation() throws IOException
     {
         xmlTransform.setContent(content);
         xmlTransform.setStylesheetLocation(stylesheetLocation);
         xmlTransform.encodeBegin(facesContext);
 
         String responseText = mockWriter.toString();
         assertEquals("Unexpected response text from content transformation", EXPECTED_TEXT, responseText);
     }
 
     public void testStylesheetLocationValueBinding() throws IOException
     {
         xmlTransform.setContent(content);
         xmlTransform.setValueBinding("stylesheetLocation", new MockValueBinding(application, "#{foo.stylesheetLocation}"));
         xmlTransform.encodeBegin(facesContext);
 
         String responseText = mockWriter.toString();
         assertEquals("Unexpected response text from content transformation", EXPECTED_TEXT, responseText);
     }
 
     public void testStylesheetStream() throws IOException
     {
         xmlTransform.setStyleStream(styleStream);
         xmlTransform.setContent(content);
         xmlTransform.encodeBegin(facesContext);
 
         String responseText = mockWriter.toString();
         assertEquals("Unexpected response text from content transformation", EXPECTED_TEXT, responseText);
     }
 
     public void testStylesheetStreamValueBinding() throws IOException
     {
         xmlTransform.setValueBinding("styleStream", new MockValueBinding(application, "#{foo.styleStream}"));
         xmlTransform.setContent(content);
         xmlTransform.encodeBegin(facesContext);
 
         String responseText = mockWriter.toString();
         assertEquals("Unexpected response text from content transformation", EXPECTED_TEXT, responseText);
     }
 
     public void testContent() throws IOException
     {
         xmlTransform.setContent(content);
         xmlTransform.setStylesheet(stylesheet);
         xmlTransform.encodeBegin(facesContext);
 
         String responseText = mockWriter.toString();
         assertEquals("Unexpected response text from content transformation", EXPECTED_TEXT, responseText);
     }
 
     public void testContentValueBinding() throws IOException
     {
         xmlTransform.setValueBinding("content", new MockValueBinding(application, "#{foo.content}"));
         xmlTransform.setStylesheet(stylesheet);
         xmlTransform.encodeBegin(facesContext);
 
         String responseText = mockWriter.toString();
         assertEquals("Unexpected response text from content transformation", EXPECTED_TEXT, responseText);
     }
 
     public void testContentLocation() throws IOException
     {
         xmlTransform.setContentLocation(contentLocation);
         xmlTransform.setStylesheet(stylesheet);
         xmlTransform.encodeBegin(facesContext);
 
         String responseText = mockWriter.toString();
         assertEquals("Unexpected response text from content transformation", EXPECTED_TEXT, responseText);
     }
 
     public void testContentLocationValueBinding() throws IOException
     {
         xmlTransform.setValueBinding("contentLocation", new MockValueBinding(application, "#{foo.contentLocation}"));
         xmlTransform.setStylesheet(stylesheet);
         xmlTransform.encodeBegin(facesContext);
 
         String responseText = mockWriter.toString();
         assertEquals("Unexpected response text from content transformation", EXPECTED_TEXT, responseText);
     }
 
     /**
      * Tests the actual transformation process using an InputStream as the source for content.
      * @throws IOException
      */
     public void testContentStream() throws IOException
     {
         xmlTransform.setContentStream(contentStream);
         xmlTransform.setStylesheet(stylesheet);
         xmlTransform.encodeBegin(facesContext);
 
         String responseText = mockWriter.toString();
         assertEquals("Unexpected response text from content transformation", EXPECTED_TEXT, responseText);
     }
 
     /**
      * Tests the actual transformation process using an InputStream as the source for content.  This test
      * sets the property to a value binding (as you would through use of XmlTransformTag) instead of setting
      * the value of the contentStream on the component directly.
      *
      * @throws IOException
      */
     public void testContentStreamValueBinding() throws IOException
     {
         xmlTransform.setValueBinding("contentStream", new MockValueBinding(application, "#{foo.contentStream}"));
         xmlTransform.setStylesheetLocation(stylesheetLocation);
         xmlTransform.encodeBegin(facesContext);
 
         String responseText = mockWriter.toString();
         assertEquals("Unexpected response text from content transformation", EXPECTED_TEXT, responseText);
     }
 
     public static Test suite()
     {
         return new TestSuite(XmlTransformTest.class);
     }
 
 }