/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
package complex.filter.misc;
import com.sun.star.beans.PropertyValue;
import com.sun.star.container.NoSuchElementException;
import com.sun.star.container.XNameAccess;
import com.sun.star.container.XNameContainer;
import com.sun.star.container.XNameReplace;
import com.sun.star.lang.IllegalArgumentException;
import com.sun.star.lang.WrappedTargetException;
import com.sun.star.lang.WrappedTargetRuntimeException;
import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.uno.XInterface;
import com.sun.star.util.XFlushable;
import complexlib.ComplexTestCase;
import util.utils;
/**
* This complex test checks the functionality of the properties "Finalized" and "Mandatory" of
* the services <CODE>com.sun.star.document.FilterFactory</CODE> and
* <CODE>com.sun.star.document.TypeDetection</CODE>.
*
* Each of theses services represent a container of <CODE>PropertyValue[]</CODE>.
* The <CODE>PropertyValue[]</CODE> contains among others the properties called
* <CODE>Finalized</CODE> and <CODE>Mandatory</CODE>. If the property
* <CODE>Finalized</CODE> is set to <CODE>true</CODE>, a filter can be removed
* but will not be able to be changed.
* If the property <CODE>Mandatory</CODE> is set to <CODE>true</CODE>, the filter
* can not be removed.
*
* Every filter, which is registered to the office, will be tested. For every filter-test
* a new instance of the mentioned services will be created.
* During the test the property <CODE>UIName</CODE>
* will be changed and the service will be flushed. The test checks for expected exceptions:
* If the property <CODE>Finalized</CODE> equals
* <CODE>true</CODE> the tests check if an <CODE>Exception</CODE> must be thrown.
* The next step of the test is the removal of the filter was removed, than the service
* will be flushed. The test checks for expected exceptions: If the property
* <CODE>Madantory</CODE> equals <CODE>true</CODE>, an <CODE>Exception</CODE> must
* be thrown.
* This test results <CODE>false</CODE> state if there is no filter available with:
* <CODE>Finalized=true</CODE>
* <CODE>Finalized=false</CODE>
* <CODE>Mandatory=true</CODE>
* <CODE>Mandatory=false</CODE>
*/
public class FinalizedMandatoryTest extends ComplexTestCase {
static XMultiServiceFactory xMSF;
/**
* A function to tell the framework, which test functions are available.
* @return All test methods.
*/
public String[] getTestMethodNames() {
return new String[]{"checkReadonlySupportFilterFactory",
"checkReadonlySupportTypeDetection"};
}
/** Create the environment for following tests.
* Use either a component loader from desktop or
* from frame
* @throws Exception Exception
*/
public void before() throws Exception {
// create TypeDetection
xMSF = (XMultiServiceFactory)param.getMSF();
assure("Could not get XMultiServiceFactory", xMSF != null);
}
/**
* Creates an instance for the given <CODE>serviceName</CODE>
* @param serviceName the name of the service which should be created
* @throws Exception was thrown if creataion failes
* @return <CODE>XInterface</CODE> of service
*/
public XInterface getTestObject(String serviceName) throws Exception{
Object oInterface = xMSF.createInstance(serviceName);
if (oInterface == null) {
failed("Service wasn't created") ;
throw new Exception("could not create service '"+serviceName+"'");
}
return (XInterface) oInterface;
}
/**
* call the function <CODE>checkReadonlySupport</CODE> to test <CODE>com.sun.star.document.FilterFactory</CODE>
* @see com.sun.star.document.FilterFactory
*/
public void checkReadonlySupportFilterFactory(){
checkReadonlySupport("com.sun.star.document.FilterFactory");
}
/**
* call the function <CODE>checkReadonlySupport</CODE> to test <CODE>com.sun.star.document.TypeDetection</CODE>
* @see com.sun.star.document.TypeDetection
*/
public void checkReadonlySupportTypeDetection(){
checkReadonlySupport("com.sun.star.document.TypeDetection");
}
/**
* test the given service <CODE>serviceName</CODE>.
* For every filter a new instace was created and the tests started.
* @param serviceName the name of the service to test
*/
private void checkReadonlySupport(String serviceName){
log.println("+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++");
log.println("testing service '" + serviceName + "'");
XInterface oObj = null;
try{
oObj = getTestObject(serviceName);
log.println("ImplName: "+utils.getImplName(oObj));
} catch (java.lang.Exception e){
failed("could not get test object");
}
boolean mandantoryTrue = false;
boolean mandantoryFalse = false;
boolean finalizedTrue = false;
boolean finalizedFalse = false;
XNameAccess xNA = (XNameAccess) UnoRuntime.queryInterface
(XNameAccess.class, oObj);
String[] filterNames = xNA.getElementNames();
// XNameContainer; XNameReplace
String filterName = filterNames[0];
Object[] instance = null;;
for (int i = 0; i < filterNames.length; i++) {
log.println("------------------------------------------------");
try{
PropertyValue instanceProp = new PropertyValue();
filterName = filterNames[i];
log.println(filterName);
// testobject must new created for every test.
// We change in a loop the container and try to flush this changes.
// If we get an expected exception this container is corrupt. It's
// similar to a document which could not be saved beacuse of invalid
// contend. While you don't remove the invalid conted you will never
// be able to save the document. Same here.
try{
oObj = getTestObject(serviceName);
} catch (java.lang.Exception e){
failed("could not get test object", CONTINUE);
}
xNA = (XNameAccess) UnoRuntime.queryInterface(XNameAccess.class, oObj);
XNameContainer xNC = (XNameContainer) UnoRuntime.queryInterface(XNameContainer.class, oObj);
XNameReplace xNR = (XNameReplace) UnoRuntime.queryInterface(XNameReplace.class, oObj);
XFlushable xFlush = (XFlushable) UnoRuntime.queryInterface(XFlushable.class, oObj);
instance = (Object[]) xNA.getByName(filterName);
PropertyValue[] props = (PropertyValue[]) instance;
printPropertyValues(props);
boolean isMandatory = ((Boolean) getPropertyValueValue(props, "Mandatory")).booleanValue();
boolean isFinalized = ((Boolean) getPropertyValueValue(props, "Finalized")).booleanValue();
// memory if every state is available
mandantoryTrue |= isMandatory;
mandantoryFalse |= !isMandatory;
finalizedTrue |= isFinalized;
finalizedFalse |= !isFinalized;
//change the filter
setPropertyValueValue((PropertyValue[])instance, "UIName", "dummy");
// 1a.) try to change the filter in the container
try{
xNR.replaceByName(filterName, instance);
}catch (IllegalArgumentException e){
failed("could not replace filter properties ('" + filterName + "')", CONTINUE);
}
// 1b.) try to wirte the changed filter to the configuration.
// This must result in a exception if the filter is finalized.
boolean flushError = false;
try{
xFlush.flush();
} catch (WrappedTargetRuntimeException e){
flushError = true;
assure("Unexpected exception wihle flushing changed filter '"+ filterName + "'", isFinalized,CONTINUE);
}
assure("Expected exception was not thorwn while flushing changed filter '"+ filterName + "' Finalized:" + isFinalized,
!(flushError ^ isFinalized), CONTINUE);
// 2a.) try to remove the filter from the container
try{
xNC.removeByName(filterName);
}catch (NoSuchElementException e){
failed("could not remove filter from container ('" + filterName + "')", CONTINUE);
}
// 1b.) try to wirte the changed filter to the configuration.
// This must result in a exception if the filter is mandatory
flushError = false;
try{
xFlush.flush();
} catch (WrappedTargetRuntimeException e){
flushError = true;
assure("Unexpected exception wihle flushing removed filter '"+ filterName + "'", isMandatory,CONTINUE);
}
assure("Expected exception was not thorwn while flushing removed filter '"+ filterName + "' Mandatory:" + isMandatory,
!(flushError ^ isMandatory), CONTINUE);
} catch (NoSuchElementException e){
failed("Couldn't get elements from object", true);
} catch (WrappedTargetException e){
failed("Couldn't get elements from object", true);
}
}
String preMsg = "Could not find filter with state ";
String postMsg = " Please check if such filter is installed!";
assure(preMsg + "'Mandatory=true'" + postMsg ,mandantoryTrue, CONTINUE);
assure(preMsg + "'Mandatory=false'" + postMsg ,mandantoryFalse, CONTINUE);
assure(preMsg + "'Finalized=true'" + postMsg ,finalizedTrue, CONTINUE);
assure(preMsg + "'Finalized=false'" + postMsg ,finalizedFalse, CONTINUE);
}
/**
* print all propeties with its values to <CODE>logger</CODE>. For debug purposes.
* @see stats.SimpleLogWriter
* @see com.sun.star.beans.PropertyValue
* @param props Sequenze of PropertyValue
*/
protected void printPropertyValues(PropertyValue[] props) {
int i = 0;
while (i < props.length ) {
log.println(props[i].Name + ":" + props[i].Value.toString());
i++;
}
if (i < props.length) log.println(props[i].Name + ":" + props[i].Value.toString());
}
/**
* returns the value of the specified (<CODE>pName</CODE>) property from a sequenze of <CODE>PropertyValue</CODE>
* @param props a sequenze of <CODE>PropertyVlaue</CODE>
* @param pName the name of the property the value shoud be returned
* @return the value of the property
*/
protected Object getPropertyValueValue(PropertyValue[] props, String pName) {
int i = 0;
while (i < props.length && !props[i].Name.equals(pName)) {
i++;
}
return i < props.length ? props[i].Value : null;
}
/**
* set a value of the specified (<CODE>pName</CODE>) property inside a sequenze of <CODE>PropertyValue</CODE>
* @param props sequenze of <CODE>PropertyValue</CODE>
* @param pName name of the property which should be changed
* @param pValue the value the property should be assigned
*/
protected void setPropertyValueValue(PropertyValue[] props, String pName, Object pValue) {
int i = 0;
while (i < props.length && !props[i].Name.equals(pName)) {
i++;
}
props[i].Value = pValue;
}
}