core/org.eclipse.smila.tika.test/code/src/org/eclipse/smila/tika/test/TestMimeTypeIdentifyPipeline.java

/*******************************************************************************
 * Copyright (c) 2008, 2013 Empolis Information Management GmbH and brox IT Solutions GmbH. All rights reserved. This
 * program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: Andreas Weber (Empolis Information Management GmbH) - initial API and implementation
 *******************************************************************************/
package org.eclipse.smila.tika.test;

import org.eclipse.smila.blackboard.Blackboard;
import org.eclipse.smila.blackboard.Blackboard.Get;
import org.eclipse.smila.blackboard.BlackboardAccessException;
import org.eclipse.smila.blackboard.BlackboardFactory;
import org.eclipse.smila.datamodel.Any.ValueType;
import org.eclipse.smila.datamodel.Value;
import org.eclipse.smila.processing.WorkflowProcessor;
import org.eclipse.smila.test.DeclarativeServiceTestCase;

/**
 * Tesr for MimeTypeIdentifyPipelet by executing a pipeline.
 */
public class TestMimeTypeIdentifyPipeline extends DeclarativeServiceTestCase {

  /**
   * name of pipeline to test.
   */
  protected static final String PIPELINE_NAME = "MimeTypeIdentifyPipeline";

  /**
   * WorkflowProcessor instance to test.
   */
  protected WorkflowProcessor _processor;

  /**
   * The _blackboard.
   */
  protected Blackboard _blackboard;

  /**
   * {@inheritDoc}
   */
  @Override
  protected void setUp() throws Exception {
    super.setUp();
    _processor = getService(WorkflowProcessor.class);
    assertNotNull("no WorkflowProcessor service found.", _processor);
    final BlackboardFactory factory = getService(BlackboardFactory.class);
    assertNotNull("no BlackboardFactory service found.", factory);
    _blackboard = factory.createPersistingBlackboard();
    assertNotNull("no Blackboard created", _blackboard);
  }

  /**
   * {@inheritDoc}
   * 
   * @see junit.framework.TestCase#tearDown()
   */
  @Override
  protected void tearDown() throws Exception {
    _processor = null;
    _blackboard = null;
    super.tearDown();
  }

  /**
   * {@inheritDoc}
   */
  protected String extract(final String extension) throws Exception {
    final String request = createBlackboardRecord("source", "key:" + extension, extension);
    final String[] result = process(request);
    assertEquals(1, result.length);
    assertEquals(request, result[0]);
    final Value mimeType = _blackboard.getMetadata(request).getValue("MimeType");
    assertNotNull("literal mime type must not be null", mimeType);
    assertEquals("literal mime type must be a string", ValueType.STRING, mimeType.getValueType());
    return mimeType.asString();
  }

  /**
   * create a new record on the blackboard.
   * 
   * @param source
   *          source value of ID
   * @param key
   *          key value of ID
   * @param extension
   *          the file extension
   * 
   * @return id of created record.
   * 
   * @throws BlackboardAccessException
   *           the blackboard access exception
   */
  protected String createBlackboardRecord(final String source, final String key, final String extension)
    throws BlackboardAccessException {
    final String id = source + ":" + key;
    _blackboard.unloadRecord(id);
    _blackboard.getRecord(id, Get.NEW);
    _blackboard.getMetadata(id).put("FileExtension", extension);
    return id;
  }

  /**
   * Process.
   * 
   * @param id
   *          the id
   * 
   * @return the id[]
   * 
   * @throws Exception
   *           the exception
   */
  protected String[] process(final String id) throws Exception {
    return _processor.process(PIPELINE_NAME, _blackboard, new String[] { id });
  }

  /**
   * Test txt.
   * 
   * @throws Exception
   *           the exception
   */
  public void testTXT() throws Exception {
    executeTest("txt", "text/plain");
  }

  /**
   * Test utf-8 txt.
   * 
   * @throws Exception
   *           the exception
   */
  public void testUTF8TXT() throws Exception {
    executeTest("txt", "text/plain");
  }

  /**
   * Test html.
   * 
   * @throws Exception
   *           the exception
   */
  public void testHTML() throws Exception {
    executeTest("html", "text/html");
  }

  /**
   * Test pdf.
   * 
   * @throws Exception
   *           the exception
   */
  public void testPDF() throws Exception {
    executeTest("pdf", "application/pdf");
  }

  /**
   * Test rtf.
   * 
   * @throws Exception
   *           the exception
   */
  public void testRTF() throws Exception {
    executeTest("rtf", "application/rtf");
  }

  /**
   * Test xml.
   * 
   * @throws Exception
   *           the exception
   */
  public void testXML() throws Exception {
    executeTest("xml", "application/xml");
  }

  /**
   * Test msoffic e2003 doc.
   * 
   * @throws Exception
   *           the exception
   */
  public void testMSOFFICE2003DOC() throws Exception {
    executeTest("doc", "application/msword");
  }

  /**
   * Test msoffic e2003 ppt.
   * 
   * @throws Exception
   *           the exception
   */
  public void testMSOFFICE2003PPT() throws Exception {
    executeTest("ppt", "application/vnd.ms-powerpoint");
  }

  /**
   * Test msoffic e2003 xls.
   * 
   * @throws Exception
   *           the exception
   */
  public void testMSOFFICE2003XLS() throws Exception {
    executeTest("xls", "application/vnd.ms-excel");
  }

  /**
   * Test msoffic e2007 docx.
   * 
   * @throws Exception
   *           the exception
   */
  public void testMSOFFICE2007DOCX() throws Exception {
    executeTest("docx", "application/vnd.openxmlformats-officedocument.wordprocessingml.document");
  }

  /**
   * Test openoffic e24 odp.
   * 
   * @throws Exception
   *           the exception
   */
  public void testOPENOFFICE24ODP() throws Exception {
    executeTest("odp", "application/vnd.oasis.opendocument.presentation");
  }

  /**
   * Test openoffic e22 ods.
   * 
   * @throws Exception
   *           the exception
   */
  public void testOPENOFFICE22ODS() throws Exception {
    executeTest("ods", "application/vnd.oasis.opendocument.spreadsheet");
  }

  /**
   * Test openoffic e22 odt.
   * 
   * @throws Exception
   *           the exception
   */
  public void testOPENOFFICE22ODT() throws Exception {
    executeTest("odt", "application/vnd.oasis.opendocument.text");
  }

  /**
   * Execute test.
   * 
   * @param extension
   *          File extension.
   * @param expectedMimeType
   *          Expected MIME type.
   * 
   * @throws Exception
   *           the exception
   */
  protected void executeTest(final String extension, final String expectedMimeType) throws Exception {
    try {
      final String result = extract(extension);
      assertNotNull(result);
      assertEquals("resolved mime type [" + result + "] must be equal [" + expectedMimeType + "]",
        expectedMimeType, result);
    } catch (final Exception e) {
      e.printStackTrace();
      throw e;
    }
  }

}