WabConverterTest.java

/*
 * 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 WARRANTIESOR 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.aries.web.converter.impl;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
import java.util.jar.Attributes;
import java.util.jar.JarInputStream;
import java.util.jar.JarOutputStream;
import java.util.jar.Manifest;
import java.util.zip.ZipEntry;

import org.apache.aries.web.converter.WarToWabConverter;
import org.apache.aries.web.converter.WarToWabConverter.InputStreamProvider;
import org.junit.Test;
import org.osgi.framework.Constants;

/**
 * These tests do not cover the complete functionality (as yet). Rather this gives a place for adding
 * smaller tests for individual units of work that don't need to be tested by converting a whole WAR file.
 */
public class WabConverterTest
{
  public static final String WAR_FILE_NAME_WO_SUFFIX = "test";
  public static final String WAR_FILE_NAME = WAR_FILE_NAME_WO_SUFFIX + ".war";
  
  private static final String SERVLET_IMPORTS = 
      "javax.servlet;version=2.5," +
      "javax.servlet.http;version=2.5";
  
  private static final String JSP_IMPORTS =
      "javax.servlet.jsp;version=2.1," +
      "javax.servlet.jsp.el;version=2.1," +
      "javax.servlet.jsp.tagext;version=2.1," +
      "javax.servlet.jsp.resources;version=2.1";
      
  private static final String DEFAULT_IMPORTS = 
      SERVLET_IMPORTS + "," + JSP_IMPORTS;
  
  /**
   * Test that we can handle a null manifest (in case a jar archive was created without manifest)
   */
  @Test
  public void testNullManifest() throws Exception
  {
    Properties properties = new Properties();
    properties.put(WarToWabConverter.WEB_CONTEXT_PATH, "/test");
    WarToWabConverterImpl sut = new WarToWabConverterImpl(makeTestFile(new byte[0]), WAR_FILE_NAME, properties);
    
    Manifest res = sut.updateManifest(null);
    Attributes attrs = res.getMainAttributes();
    
    assertTrue(attrs.getValue("Import-Package").contains("javax.servlet"));
  }
  
  @Test
  public void testImportPackageMerge() throws Exception
  {
    Properties properties = new Properties();
    properties.put(WarToWabConverter.WEB_CONTEXT_PATH, "/test");
    WarToWabConverterImpl sut = new WarToWabConverterImpl(makeTestFile(new byte[0]), WAR_FILE_NAME, properties);
    
    Manifest input = new Manifest();
    input.getMainAttributes().putValue(Constants.IMPORT_PACKAGE, "com.ibm.test,javax.servlet.http");
    
    Manifest res = sut.updateManifest(input);
    Attributes attrs = res.getMainAttributes();
    
    assertEquals(
        "com.ibm.test,"+
        "javax.servlet.http,"+
        "javax.servlet;version=2.5,"+
        JSP_IMPORTS,
        attrs.getValue(Constants.IMPORT_PACKAGE));
  }
    
  @Test
  public void testImportPackageWithAttributesMerge() throws Exception
  {
      Attributes attrs = convertWithProperties(
                WarToWabConverter.WEB_CONTEXT_PATH, "/test",
                Constants.IMPORT_PACKAGE, "javax.servlet.jsp; version=\"[2.0,2.1]\",javax.servlet.jsp.tagext; version=\"[2.0,2.1]\"");
      
      String actual = attrs.getValue(Constants.IMPORT_PACKAGE);
      System.out.println(actual);
      assertEquals(
           "javax.servlet.jsp; version=\"[2.0,2.1]\"," +
           "javax.servlet.jsp.tagext; version=\"[2.0,2.1]\"," +
           "javax.servlet;version=2.5," +
           "javax.servlet.http;version=2.5," +
           "javax.servlet.jsp.el;version=2.1," +
           "javax.servlet.jsp.resources;version=2.1",
          actual);
  }

  @Test
  public void testAcceptNoManifest() throws Exception
  {
    final ByteArrayOutputStream bout = new ByteArrayOutputStream();
    JarOutputStream out = new JarOutputStream(bout);
    out.putNextEntry(new ZipEntry("random.html"));
    out.write("hello world".getBytes());
    out.close();
    
    InputStreamProvider input = makeTestFile(bout.toByteArray());
    
    Properties props = new Properties();
    props.put(WarToWabConverter.WEB_CONTEXT_PATH, "/test");
    props.put(Constants.BUNDLE_SYMBOLICNAME, "test.bundle");
    WarToWabConverterImpl sut = new WarToWabConverterImpl(input, WAR_FILE_NAME, props);
    
    @SuppressWarnings("resource")
    Manifest m = new JarInputStream(sut.getWAB()).getManifest();
    assertEquals("test.bundle", m.getMainAttributes().getValue(Constants.BUNDLE_SYMBOLICNAME));
  }
  
  @Test 
  public void testDefaultProperties() throws Exception {
    Attributes attrs = convertWithProperties(
            WarToWabConverter.WEB_CONTEXT_PATH, "/test");
    
    assertTrue(attrs.getValue(Constants.BUNDLE_SYMBOLICNAME).startsWith(WAR_FILE_NAME_WO_SUFFIX));
    assertEquals("1.0", attrs.getValue(Constants.BUNDLE_VERSION));
    assertEquals(DEFAULT_IMPORTS, attrs.getValue(Constants.IMPORT_PACKAGE));
    assertEquals("WEB-INF/classes",attrs.getValue(Constants.BUNDLE_CLASSPATH));
  }
  
  @Test
  public void testPropertySupport() throws Exception {
    Attributes attrs = convertWithProperties(
        WarToWabConverter.WEB_CONTEXT_PATH, "WebFiles",
        Constants.BUNDLE_VERSION, "2.0",
        Constants.IMPORT_PACKAGE, "org.apache.aries.test;version=2.5,org.apache.aries.test.eba;version=1.0");
    
    assertEquals("/WebFiles", attrs.getValue(WarToWabConverter.WEB_CONTEXT_PATH));
    assertEquals("2.0", attrs.getValue(Constants.BUNDLE_VERSION));
    assertEquals("org.apache.aries.test;version=2.5,org.apache.aries.test.eba;version=1.0," + DEFAULT_IMPORTS,
                 attrs.getValue(Constants.IMPORT_PACKAGE));
  }
  
  @Test
  public void testPropertyCaseInsensitiveSupport() throws Exception {
    Attributes attrs = convertWithProperties(
        "web-contextpath", "WebFiles",
        "bundle-VErsion", "1.0",
        "import-PACKAGE", "org.apache.aries.test;version=2.5,org.apache.aries.test.eba;version=1.0");
    
    assertEquals("/WebFiles", attrs.getValue(WarToWabConverter.WEB_CONTEXT_PATH));
    assertEquals("1.0", attrs.getValue(Constants.BUNDLE_VERSION));
    assertEquals("org.apache.aries.test;version=2.5,org.apache.aries.test.eba;version=1.0," + DEFAULT_IMPORTS,
                 attrs.getValue(Constants.IMPORT_PACKAGE));
  }
  
  @Test
  public void testBundleContextPathOverride() throws Exception {
    Manifest m = new Manifest();
    Attributes attrs = m.getMainAttributes();
    attrs.putValue(Constants.BUNDLE_SYMBOLICNAME, "org.apache.test");
    attrs.putValue(Constants.BUNDLE_VERSION, "1.0");
    attrs.putValue(Constants.IMPORT_PACKAGE, "org.apache.util,org.apache.test;version=1.0");
    attrs.putValue(Constants.BUNDLE_CLASSPATH, "jsp/classes");
    
    attrs = convertWithProperties(m, 
        WarToWabConverter.WEB_CONTEXT_PATH, "WebFiles");
       
    assertEquals("org.apache.test", attrs.getValue(Constants.BUNDLE_SYMBOLICNAME));
    assertEquals("1.0", attrs.getValue(Constants.BUNDLE_VERSION));
    assertTrue(attrs.getValue(Constants.IMPORT_PACKAGE).contains("org.apache.util"));
    assertTrue(attrs.getValue(Constants.IMPORT_PACKAGE).contains("org.apache.test;version=1.0"));    
    assertEquals("jsp/classes", attrs.getValue(Constants.BUNDLE_CLASSPATH));
    assertEquals("/WebFiles", attrs.getValue(WarToWabConverter.WEB_CONTEXT_PATH));
  }
  
  @Test
  public void testBundleContextPathManifestOverride() throws Exception {
    Manifest m = new Manifest();
    Attributes attrs = m.getMainAttributes();
    attrs.putValue(Constants.BUNDLE_SYMBOLICNAME, "org.apache.test");
    attrs.putValue(WarToWabConverter.WEB_CONTEXT_PATH, "test");
    attrs.putValue(Constants.BUNDLE_VERSION, "1.0");
    attrs.putValue(Constants.IMPORT_PACKAGE, "org.apache.util,org.apache.test;version=1.0");
    attrs.putValue(Constants.BUNDLE_CLASSPATH, "jsp/classes");
    
    attrs = convertWithProperties(m, 
        WarToWabConverter.WEB_CONTEXT_PATH, "WebFiles");
       
    assertEquals("org.apache.test", attrs.getValue(Constants.BUNDLE_SYMBOLICNAME));
    assertEquals("1.0", attrs.getValue(Constants.BUNDLE_VERSION));
    assertTrue(attrs.getValue(Constants.IMPORT_PACKAGE).contains("org.apache.util"));
    assertTrue(attrs.getValue(Constants.IMPORT_PACKAGE).contains("org.apache.test;version=1.0"));    
    assertEquals("jsp/classes", attrs.getValue(Constants.BUNDLE_CLASSPATH));
    assertEquals("/WebFiles", attrs.getValue(WarToWabConverter.WEB_CONTEXT_PATH));
  }
  
  @Test
  public void testBundleManifestOverride() throws Exception {
    Manifest m = new Manifest();
    Attributes attrs = m.getMainAttributes();
    attrs.putValue(Constants.BUNDLE_SYMBOLICNAME, "org.apache.test");
    attrs.putValue(WarToWabConverter.WEB_CONTEXT_PATH, "test");
    attrs.putValue(Constants.BUNDLE_VERSION, "1.0");
    attrs.putValue(Constants.IMPORT_PACKAGE, "org.apache.util,org.apache.test;version=1.0");
    attrs.putValue(Constants.BUNDLE_CLASSPATH, "jsp/classes");
    
    try {
        convertWithProperties(m, 
                WarToWabConverter.WEB_CONTEXT_PATH, "WebFiles",
                Constants.BUNDLE_SYMBOLICNAME, "foobar");
        fail("Conversion did not fail as expected");
    } catch (IOException e) {
        // that's expected
    }
  }
  
  private Attributes convertWithProperties(Manifest m, String ... props) throws Exception {
    Properties properties = new Properties();
    for (int i=0;i<props.length;i+=2) {
      properties.put(props[i], props[i+1]);
    }
    
    byte[] bytes = new byte[0];

    if (m != null) {      
      m.getMainAttributes().put(Attributes.Name.MANIFEST_VERSION, "1");
      final ByteArrayOutputStream bout = new ByteArrayOutputStream();
      JarOutputStream out = new JarOutputStream(bout,m);
      out.close();
      bytes = bout.toByteArray();
    }
    
    WarToWabConverterImpl sut = new WarToWabConverterImpl(makeTestFile(bytes), WAR_FILE_NAME, properties);
    return sut.getWABManifest().getMainAttributes();
  }
  
  private Attributes convertWithProperties(String ... props) throws Exception {
    return convertWithProperties(null, props);
  }
  
  
  private InputStreamProvider makeTestFile(final byte[] content) {
    return new InputStreamProvider() {      
      public InputStream getInputStream() throws IOException {
        return new ByteArrayInputStream(content);
      }
    };
  }  
}