qadevOOo/tests/java/ifc/beans/_XFastPropertySet.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18
  19 package ifc.beans;
  20
  21 import java.util.ArrayList;
  22 import java.util.List;
  23 import java.util.Random;
  24 import java.util.Set;
  25
  26 import lib.MultiMethodTest;
  27 import lib.StatusException;
  28 import util.ValueChanger;
  29
  30 import com.sun.star.beans.Property;
  31 import com.sun.star.beans.PropertyAttribute;
  32 import com.sun.star.beans.XFastPropertySet;
  33 import com.sun.star.beans.XPropertySet;
  34 import com.sun.star.beans.XPropertySetInfo;
  35 import com.sun.star.uno.UnoRuntime;
  36
  37 /**
  38 * Testing <code>com.sun.star.beans.XFastPropertySet</code>
  39 * interface methods :
  40 * <ul>
  41 *  <li><code> setFastPropertyValue()</code></li>
  42 *  <li><code> getFastPropertyValue()</code></li>
  43 * </ul> <p>
  44 * Required relations :
  45 * <ul>
  46 *  <li> <code>'XFastPropertySet.ExcludeProps'</code>
  47 *    <b>(optional) </b> : java.util.Set.
  48 *    Has property names which must be skipped from testing in
  49 *    some reasons (for example property accepts restricted set
  50 *    of values).
  51 *  </li>
  52 * <ul> <p>
  53 * @see com.sun.star.beans.XFastPropertySet
  54 */
  55 public class _XFastPropertySet extends MultiMethodTest {
  56
  57     public XFastPropertySet oObj = null;
  58     private List<Integer> handles = new ArrayList<Integer>();
  59     private int handle = -1;
  60     private Set<String> exclude = null ;
  61
  62     /**
  63      * Retrieves relation.
  64      */
  65      protected void before() {
  66         exclude = (Set<String>) tEnv.getObjRelation("XFastPropertySet.ExcludeProps") ;
  67         if (exclude == null) {
  68             exclude = new java.util.HashSet<String>() ;
  69         }
  70      }
  71
  72     /**
  73     * Test selects random property which can not be VOID and
  74     * is writable, then change property value using <code>
  75     * get/set</code> methods, and checks if value properly changed.
  76     * Has <b> OK </b> status if value after change is not equal to value
  77     * before and no exceptions were thrown. <p>
  78     */
  79     public void _setFastPropertyValue() {
  80         XPropertySet PS = UnoRuntime.queryInterface
  81             (XPropertySet.class, oObj);
  82         XPropertySetInfo propertySetInfo = PS.getPropertySetInfo();
  83
  84         if (propertySetInfo == null) {
  85             log.println("getPropertySetInfo() method returned null");
  86             tRes.tested("setFastPropertyValue()", false) ;
  87         }
  88         getPropsToTest(propertySetInfo);
  89
  90         Object gValue = null;
  91         Object sValue = null;
  92
  93         if ( handle == -1) {
  94             log.println("*** No changeable properties found ***");
  95             tRes.tested("setFastPropertyValue()", false) ;
  96         } else {
  97             try {
  98                 gValue = oObj.getFastPropertyValue(handle);
  99                 sValue = ValueChanger.changePValue(gValue);
 100                 oObj.setFastPropertyValue(handle, sValue);
 101                 sValue = oObj.getFastPropertyValue(handle);
 102             } catch (com.sun.star.beans.UnknownPropertyException e) {
 103                 log.println("Exception occurred while trying to change property with handle = " + handle);
 104                 e.printStackTrace(log);
 105             } catch (com.sun.star.lang.WrappedTargetException e) {
 106                 log.println("Exception occurred while trying to change property with handle = " + handle);
 107                 e.printStackTrace(log);
 108             } catch (com.sun.star.beans.PropertyVetoException e) {
 109                 log.println("Exception occurred while trying to change property with handle = " + handle);
 110                 e.printStackTrace(log);
 111             }  catch (com.sun.star.lang.IllegalArgumentException e) {
 112                 log.println("Exception occurred while trying to change property with handle = " + handle);
 113                 e.printStackTrace(log);
 114             }
 115
 116             tRes.tested("setFastPropertyValue()",(!gValue.equals(sValue)));
 117         }
 118     }
 119
 120     /**
 121     * Test selects random property which can not be VOID and
 122     * is writable, then calls the method and  checks that
 123     * no exceptions were thrown. <p>
 124     * Has <b> OK </b> status if exceptions were thrown. <p>
 125     */
 126     public void _getFastPropertyValue() {
 127         XPropertySet PS = UnoRuntime.queryInterface
 128             (XPropertySet.class, oObj);
 129         XPropertySetInfo propertySetInfo = PS.getPropertySetInfo();
 130
 131         if (propertySetInfo == null) {
 132             log.println("getPropertySetInfo() method returned null");
 133             tRes.tested("getFastPropertyValue()", false) ;
 134         }
 135
 136         getPropsToTest(propertySetInfo);
 137
 138         try {
 139             oObj.getFastPropertyValue(handle);
 140             tRes.tested("getFastPropertyValue()",true);
 141         } catch (com.sun.star.beans.UnknownPropertyException e) {
 142             log.println("Exception occurred while trying to get property '"
 143                 + handle +"'");
 144             e.printStackTrace(log);
 145             tRes.tested("getFastPropertyValue()",false);
 146         } catch (com.sun.star.lang.WrappedTargetException e) {
 147             log.println("Exception occurred while trying to get property '"
 148                 + handle +"'");
 149             e.printStackTrace(log);
 150             tRes.tested("getFastPropertyValue()",false);
 151         }
 152         return;
 153     }
 154
 155
 156     //Get the properties being tested
 157     private void getPropsToTest(XPropertySetInfo xPSI) {
 158
 159         Property[] properties = xPSI.getProperties();
 160
 161         for (int i = 0; i < properties.length; i++) {
 162             if (exclude.contains(properties[i].Name)) continue ;
 163             Property property = properties[i];
 164             String name = property.Name;
 165             int handle = property.Handle;
 166             log.println("Checking '" + name + "' with handle = " + handle);
 167             boolean isWritable =
 168                 ((property.Attributes & PropertyAttribute.READONLY) == 0);
 169             boolean isNotNull =
 170                 ((property.Attributes & PropertyAttribute.MAYBEVOID) == 0);
 171             boolean canChange = false;
 172             if ( isWritable && isNotNull )
 173                 canChange = isChangeable(handle);
 174             if ( isWritable && isNotNull && canChange)
 175                 handles.add(new Integer(handle));
 176         } // endfor
 177
 178         Random rnd = new Random();
 179         int nr = rnd.nextInt(handles.size());
 180         handle = handles.get(nr).intValue();
 181     }
 182
 183     private boolean isChangeable(int handle) {
 184         boolean hasChanged = false;
 185         try {
 186             Object getProp = oObj.getFastPropertyValue(handle);
 187             Object setValue = null;
 188
 189             if (getProp != null)
 190                 setValue = ValueChanger.changePValue(getProp);
 191             else
 192                 log.println("Property with handle = " + handle
 193                     + " is null but 'MAYBEVOID' isn't set");
 194             if (setValue != null) {
 195                 oObj.setFastPropertyValue(handle, setValue);
 196                 hasChanged =
 197                     (!getProp.equals(oObj.getFastPropertyValue(handle)));
 198             }
 199             else
 200                 log.println("Couldn't change Property with handle " + handle);
 201         } catch(com.sun.star.lang.WrappedTargetException e) {
 202             log.println("Property with handle " + handle + " throws exception");
 203             e.printStackTrace(log);
 204             throw new StatusException("Property with handle " + handle
 205                 + " throws exception", e);
 206         } catch(com.sun.star.lang.IllegalArgumentException e) {
 207             log.println("Property with handle " + handle + " throws exception");
 208             e.printStackTrace(log);
 209             throw new StatusException("Property with handle " + handle
 210                 + " throws exception", e);
 211         } catch(com.sun.star.beans.PropertyVetoException e) {
 212             log.println("Property with handle " + handle + " throws exception");
 213             e.printStackTrace(log);
 214             throw new StatusException("Property with handle " + handle
 215                 + " throws exception", e);
 216         } catch(com.sun.star.beans.UnknownPropertyException e) {
 217             log.println("Property with handle " + handle + " throws exception");
 218             e.printStackTrace(log);
 219             throw new StatusException("Property with handle " + handle
 220                 + " throws exception", e);
 221         }
 222
 223         return hasChanged;
 224     }
 225 }
 226
 227