sc/qa/complex/dataPilot/CheckDataPilot.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 complex.dataPilot;
  20
  21 import com.sun.star.beans.XPropertySet;
  22 import com.sun.star.container.XIndexAccess;
  23 import com.sun.star.container.XNamed;
  24 import com.sun.star.lang.XMultiServiceFactory;
  25 import com.sun.star.sheet.XDataPilotDescriptor;
  26 import com.sun.star.sheet.XDataPilotTable;
  27 import com.sun.star.sheet.XDataPilotTables;
  28 import com.sun.star.sheet.XDataPilotTablesSupplier;
  29 import com.sun.star.sheet.XSpreadsheet;
  30 import com.sun.star.sheet.XSpreadsheetDocument;
  31 import com.sun.star.sheet.XSpreadsheets;
  32 import com.sun.star.table.CellAddress;
  33 import com.sun.star.table.CellRangeAddress;
  34 import com.sun.star.uno.AnyConverter;
  35 import com.sun.star.uno.Type;
  36 import com.sun.star.uno.UnoRuntime;
  37 import com.sun.star.uno.XInterface;
  38 import com.sun.star.util.XCloseable;
  39 import lib.StatusException;
  40 import lib.TestParameters;
  41 import util.SOfficeFactory;
  42
  43 import org.junit.After;
  44 import org.junit.AfterClass;
  45 import org.junit.Before;
  46 import org.junit.BeforeClass;
  47 import org.junit.Test;
  48 import org.openoffice.test.OfficeConnection;
  49 import static org.junit.Assert.*;
  50
  51
  52 /**
  53  * check the DataPilot of Calc.
  54  */
  55 public class CheckDataPilot {
  56     /** The data pilot field object **/
  57     private XInterface mDataPilotFieldObject = null;
  58     /** The data pilot table object **/
  59     private XInterface mDataPilotTableObject = null;
  60
  61
  62     private XSpreadsheetDocument xSheetDoc = null;
  63
  64     /**
  65      * A field is filled some values. This integer determines the size of the
  66      * field in x and y direction.
  67      */
  68     private static final int mMaxFieldIndex = 6;
  69
  70     /**
  71      * The test parameters
  72      */
  73     private static TestParameters param = null;
  74
  75     /**
  76      * Get all test methods
  77      * @return The test methods
  78      */
  79     public String[] getTestMethodNames() {
  80         return new String[]{"testDataPilotTableObject",
  81                             "testDataPilotFieldObject"};
  82     }
  83
  84     /**
  85      * Test the data pilot field object:
  86      * simply execute the interface tests in a row
  87      */
  88     @Test public void testDataPilotFieldObject() {
  89         System.out.println("Starting 'testDataPilotFieldObject'");
  90         // _XNamed
  91         XNamed xNamed = UnoRuntime.queryInterface(
  92                                     XNamed.class, mDataPilotFieldObject);
  93
  94         _XNamed _xNamed = new _XNamed(xNamed/*, log*/, param);
  95         assertTrue("_getName failed.",_xNamed._getName());
  96         assertTrue("_setName failed.",_xNamed._setName());
  97
  98         // _XPropertySet
  99         XPropertySet xProp = UnoRuntime.queryInterface(
 100                                     XPropertySet.class, mDataPilotFieldObject);
 101         _XPropertySet _xProp = new _XPropertySet(xProp/*, log*/, param);
 102         assertTrue("_getPropertySetInfo failed.",_xProp._getPropertySetInfo());
 103         assertTrue("_addPropertyChangeListener failed.",_xProp._addPropertyChangeListener());
 104         assertTrue("_addVetoableChangeListener failed.",_xProp._addVetoableChangeListener());
 105         assertTrue("_setPropertyValue failed.",_xProp._setPropertyValue());
 106         assertTrue("_getPropertyValue failed.",_xProp._getPropertyValue());
 107         assertTrue("_removePropertyChangeListener failed.",_xProp._removePropertyChangeListener());
 108         assertTrue("_removeVetoableChangeListener failed.",_xProp._removeVetoableChangeListener());
 109
 110     }
 111
 112     /**
 113      * Test the data pilot table object:
 114      * simply execute the interface tests in a row
 115      */
 116     @Test public void testDataPilotTableObject() {
 117         System.out.println("Starting 'testDataPilotTableObject'");
 118         // _XNamed
 119         XNamed xNamed = UnoRuntime.queryInterface(
 120                                     XNamed.class, mDataPilotTableObject);
 121         _XNamed _xNamed = new _XNamed(xNamed/*, log*/, param);
 122         assertTrue("_getName failed.",_xNamed._getName());
 123         assertTrue("_setName failed.",_xNamed._setName());
 124
 125         // _XDataPilotTable
 126         XDataPilotTable xDataPilotTable =
 127                     UnoRuntime.queryInterface(XDataPilotTable.class,
 128                     mDataPilotTableObject);
 129         _XDataPilotTable _xDataPilotTable =
 130                     new _XDataPilotTable(xDataPilotTable/*, log*/, param);
 131         assertTrue("before failed.", _xDataPilotTable.before());
 132         assertTrue("_getOutputRange failed.", _xDataPilotTable._getOutputRange()) ;
 133
 134         // _XDataPilotDescriptor
 135         XDataPilotDescriptor xDataPilotDescriptor =
 136                     UnoRuntime.queryInterface(XDataPilotDescriptor.class,
 137                     mDataPilotTableObject);
 138         _XDataPilotDescriptor _xDataPilotDescriptor =
 139                     new _XDataPilotDescriptor(xDataPilotDescriptor/*, log*/, param);
 140         assertTrue("before failed.", _xDataPilotDescriptor.before());
 141         assertTrue("_setTag failed.", _xDataPilotDescriptor._setTag()) ;
 142         assertTrue("_getTag failed.", _xDataPilotDescriptor._getTag()) ;
 143         assertTrue("_getFilterDescriptor failed.", _xDataPilotDescriptor._getFilterDescriptor()) ;
 144         assertTrue("_getDataPilotFields failed.", _xDataPilotDescriptor._getDataPilotFields()) ;
 145         assertTrue("_getColumnFields failed.", _xDataPilotDescriptor._getColumnFields()) ;
 146         assertTrue("_getRowFields failed.", _xDataPilotDescriptor._getRowFields()) ;
 147         assertTrue("_getDataFields failed.", _xDataPilotDescriptor._getDataFields()) ;
 148         assertTrue("_getHiddenFields failed.", _xDataPilotDescriptor._getHiddenFields()) ;
 149         assertTrue("_getPageFields failed.", _xDataPilotDescriptor._getPageFields()) ;
 150         assertTrue("_setSourceRange failed.", _xDataPilotDescriptor._setSourceRange()) ;
 151         assertTrue("_getSourceRange failed.", _xDataPilotDescriptor._getSourceRange()) ;
 152     }
 153
 154     /**
 155      * create an environment for the test
 156      */
 157     @Before public void before() {
 158
 159         final XMultiServiceFactory xMsf = UnoRuntime.queryInterface(XMultiServiceFactory.class, connection.getComponentContext().getServiceManager());
 160         SOfficeFactory SOF = SOfficeFactory.getFactory(xMsf);
 161
 162         param = new TestParameters();
 163         param.put("ServiceFactory", xMsf);
 164
 165         // the cell range
 166         CellRangeAddress sCellRangeAdress = new CellRangeAddress();
 167         sCellRangeAdress.Sheet = 0;
 168         sCellRangeAdress.StartColumn = 1;
 169         sCellRangeAdress.StartRow = 0;
 170         sCellRangeAdress.EndColumn = mMaxFieldIndex-1;
 171         sCellRangeAdress.EndRow = mMaxFieldIndex - 1;
 172
 173         // position of the data pilot table
 174         CellAddress sCellAdress = new CellAddress();
 175         sCellAdress.Sheet = 0;
 176         sCellAdress.Column = 7;
 177         sCellAdress.Row = 8;
 178
 179         try {
 180             System.out.println( "Creating a Spreadsheet document" );
 181             xSheetDoc = SOF.createCalcDoc(null);
 182         } catch (com.sun.star.uno.Exception e) {
 183             // Some exception occurs.FAILED
 184             e.printStackTrace();
 185             throw new StatusException( "Couldn't create document", e );
 186         }
 187
 188         System.out.println("Getting a sheet");
 189         XSpreadsheets xSpreadsheets = xSheetDoc.getSheets();
 190         XSpreadsheet oSheet = null;
 191         XSpreadsheet oSheet2 = null;
 192         XIndexAccess oIndexAccess =
 193             UnoRuntime.queryInterface(XIndexAccess.class, xSpreadsheets);
 194
 195         // Per default there's now just one sheet, make sure we have at least two, then
 196         xSpreadsheets.insertNewByName("Some Sheet", (short)0);
 197
 198         try {
 199             oSheet = (XSpreadsheet) AnyConverter.toObject(
 200                     new Type(XSpreadsheet.class),oIndexAccess.getByIndex(0));
 201             oSheet2 = (XSpreadsheet) AnyConverter.toObject(
 202                     new Type(XSpreadsheet.class),oIndexAccess.getByIndex(1));
 203         } catch (com.sun.star.lang.WrappedTargetException e) {
 204             e.printStackTrace();
 205             throw new StatusException( "Couldn't get a spreadsheet", e);
 206         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 207             e.printStackTrace();
 208             throw new StatusException( "Couldn't get a spreadsheet", e);
 209         } catch (com.sun.star.lang.IllegalArgumentException e) {
 210             e.printStackTrace();
 211             throw new StatusException( "Couldn't get a spreadsheet", e);
 212         }
 213
 214         try {
 215             System.out.println("Filling a table");
 216             for (int i = 1; i < mMaxFieldIndex; i++) {
 217                 oSheet.getCellByPosition(i, 0).setFormula("Col" + i);
 218                 oSheet.getCellByPosition(0, i).setFormula("Row" + i);
 219                 oSheet2.getCellByPosition(i, 0).setFormula("Col" + i);
 220                 oSheet2.getCellByPosition(0, i).setFormula("Row" + i);
 221             }
 222
 223             for (int i = 1; i < mMaxFieldIndex; i++)
 224             {
 225                 for (int j = 1; j < mMaxFieldIndex; j++)
 226                 {
 227                     oSheet.getCellByPosition(i, j).setValue(i * (j + 1));
 228                     oSheet2.getCellByPosition(i, j).setValue(i * (j + 2));
 229                 }
 230             }
 231         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 232             e.printStackTrace();
 233             throw new StatusException("Couldn't fill some cells", e);
 234         }
 235
 236         // change a value of a cell and check the change in the data pilot
 237         // (for the XDataPilotTable.refresh() test)
 238         Object oChangeCell = null;
 239         Object oCheckCell = null;
 240         Integer aChangeValue = null;
 241         try {
 242             // cell of data
 243             oChangeCell = oSheet.getCellByPosition(1, 5);
 244             int x = sCellAdress.Column;
 245             int y = sCellAdress.Row + 3;
 246             // cell of the data pilot output
 247             oCheckCell = oSheet.getCellByPosition(x, y);
 248             aChangeValue = Integer.valueOf(27);
 249         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 250             e.printStackTrace();
 251             throw new StatusException( "Couldn't get cells for changing.", e);
 252         }
 253
 254
 255         // create the test objects
 256         System.out.println("Getting test objects") ;
 257         XDataPilotTablesSupplier DPTS =
 258             UnoRuntime.queryInterface(XDataPilotTablesSupplier.class, oSheet);
 259         XDataPilotTables DPT = DPTS.getDataPilotTables();
 260         XDataPilotDescriptor DPDsc = DPT.createDataPilotDescriptor();
 261         DPDsc.setSourceRange(sCellRangeAdress);
 262
 263         XPropertySet fieldPropSet = null;
 264         try {
 265             Object oDataPilotField = DPDsc.getDataPilotFields().getByIndex(0);
 266             fieldPropSet =
 267                 UnoRuntime.queryInterface(XPropertySet.class, oDataPilotField);
 268         } catch (com.sun.star.lang.WrappedTargetException e) {
 269             e.printStackTrace();
 270             throw new StatusException("Couldn't create a test environment", e);
 271         } catch(com.sun.star.lang.IndexOutOfBoundsException e) {
 272             e.printStackTrace();
 273             throw new StatusException("Couldn't create a test environment", e);
 274         }
 275
 276         try {
 277             fieldPropSet.setPropertyValue("Function",
 278                 com.sun.star.sheet.GeneralFunction.SUM);
 279             fieldPropSet.setPropertyValue("Orientation",
 280                 com.sun.star.sheet.DataPilotFieldOrientation.DATA);
 281         } catch(com.sun.star.lang.WrappedTargetException e) {
 282             e.printStackTrace();
 283             throw new StatusException("Couldn't create a test environment", e);
 284         } catch(com.sun.star.lang.IllegalArgumentException e) {
 285             e.printStackTrace();
 286             throw new StatusException("Couldn't create a test environment", e);
 287         } catch(com.sun.star.beans.PropertyVetoException e) {
 288             e.printStackTrace();
 289             throw new StatusException("Couldn't create a test environment", e);
 290         } catch(com.sun.star.beans.UnknownPropertyException e) {
 291             e.printStackTrace();
 292             throw new StatusException("Couldn't create a test environment", e);
 293         }
 294
 295         System.out.println("Insert the DataPilotTable");
 296         if (DPT.hasByName("DataPilotTable")) {
 297             DPT.removeByName("DataPilotTable");
 298         }
 299         DPT.insertNewByName("DataPilotTable", sCellAdress, DPDsc);
 300         try {
 301             mDataPilotTableObject = (XInterface) AnyConverter.toObject(
 302                 new Type(XInterface.class),DPT.getByName(DPT.getElementNames()[0]));
 303         } catch (com.sun.star.lang.WrappedTargetException e) {
 304             e.printStackTrace();
 305             throw new StatusException("Couldn't create a test environment", e);
 306         } catch (com.sun.star.container.NoSuchElementException e) {
 307             e.printStackTrace();
 308             throw new StatusException("Couldn't create a test environment", e);
 309         } catch (com.sun.star.lang.IllegalArgumentException e) {
 310             e.printStackTrace();
 311             throw new StatusException("Couldn't create a test environment", e);
 312         }
 313
 314         XIndexAccess IA = DPDsc.getDataPilotFields();
 315         try {
 316             mDataPilotFieldObject = (XInterface)AnyConverter.toObject(
 317                                 new Type(XInterface.class),IA.getByIndex(0));
 318         } catch (com.sun.star.lang.WrappedTargetException e) {
 319             e.printStackTrace();
 320             throw new StatusException("Couldn't get data pilot field", e);
 321         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 322             e.printStackTrace();
 323             throw new StatusException("Couldn't get data pilot field", e);
 324         } catch (com.sun.star.lang.IllegalArgumentException e) {
 325             e.printStackTrace();
 326             throw new StatusException("Couldn't get data pilot field", e);
 327         }
 328
 329         // Other parameters required for interface tests
 330         param.put("OUTPUTRANGE", sCellAdress);
 331         param.put("CELLFORCHANGE", oChangeCell);
 332         param.put("CELLFORCHECK", oCheckCell);
 333         param.put("CHANGEVALUE", aChangeValue);
 334         param.put("FIELDSAMOUNT", Integer.valueOf(5));
 335
 336     }
 337
 338         /*
 339      * this method closes a calc document and resets the corresponding class variable xSheetDoc
 340      */
 341     protected boolean closeSpreadsheetDocument() {
 342         boolean worked = true;
 343
 344         System.out.println("    disposing xSheetDoc ");
 345
 346         try {
 347             XCloseable oCloser =  UnoRuntime.queryInterface(
 348                                          XCloseable.class, xSheetDoc);
 349             oCloser.close(true);
 350         } catch (com.sun.star.util.CloseVetoException e) {
 351             worked = false;
 352             System.out.println("Couldn't close document");
 353         } catch (com.sun.star.lang.DisposedException e) {
 354             worked = false;
 355             System.out.println("Document already disposed");
 356         } catch (NullPointerException e) {
 357             worked = false;
 358             System.out.println("Couldn't get XCloseable");
 359         }
 360
 361         xSheetDoc = null;
 362
 363         return worked;
 364     }
 365
 366     @After public void after()
 367         {
 368             closeSpreadsheetDocument();
 369         }
 370
 371
 372     @BeforeClass public static void setUpConnection() throws Exception {
 373         System.out.println("setUpConnection()");
 374         connection.setUp();
 375     }
 376
 377     @AfterClass public static void tearDownConnection()
 378         throws InterruptedException, com.sun.star.uno.Exception
 379     {
 380         System.out.println("tearDownConnection()");
 381         connection.tearDown();
 382     }
 383
 384     private static final OfficeConnection connection = new OfficeConnection();
 385
 386
 387 }