qadevOOo/tests/java/complex/unoapi/CheckModuleAPI.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 /** complex tests to check the UNO-API
  20  **/
  21 package complex.unoapi;
  22
  23 import base.java_complex;
  24 import complexlib.ComplexTestCase;
  25 import helper.OfficeProvider;
  26 import helper.ParameterNotFoundException;
  27 import helper.ProcessHandler;
  28 import com.sun.star.lang.XMultiServiceFactory;
  29 import helper.BuildEnvTools;
  30 import helper.ComplexDescGetter;
  31 import helper.CwsDataExchangeImpl;
  32 import java.io.File;
  33 import java.util.ArrayList;
  34 import java.util.HashMap;
  35 import java.util.Iterator;
  36 import java.util.Set;
  37 import share.DescEntry;
  38 import util.PropertyName;
  39 import util.utils;
  40
  41 /**
  42  * This Complex Test will test the UNO-API by calling dmake in <B>$MODULE</B>/qa/unoapi<p>
  43  * This test depends on some requirments:
  44  * The <B>TestJob</B> is <b>-o complex.unoapi.CheckModuleAPI::module(<CODE>MODULE</CODE>)</b><p> where <CODE>MODULE</CODE>
  45  * could be the following:<p>
  46  * <ul>
  47  *  <li><b>all</b>  iterates over <CODE>SRC_ROOT</CODE> and call <CODE>dmake</CODE> in all qa/unoapi folder</li><p>
  48  *  <li><b>$module</b>  call dmake in $module/qa/unoapi folder</li><p>
  49  *  <li><b>$module1,$module2,...</b>    call dmake in $module1/qa/unoapi folder then in $module2/qa/unoapi folder and so on</li><p>
  50  * </ul><p>
  51  *
  52  * Also you have to fill the following parameter:
  53  * <ul>
  54  *  <li><b>SHELL</b>:      fill this parameter with a shell</li>
  55  * </ul>
  56  *
  57  */
  58 public class CheckModuleAPI extends ComplexTestCase
  59 {
  60
  61     private static String mSRC_ROOT = null;
  62     private static boolean mIsInitialized = false;
  63     private final static boolean mContinue = true;
  64     private static BuildEnvTools bet = null;
  65
  66     /**
  67      * Initialize the test environment.
  68      * This method checks for all neccesarry parameter and exit if not all parameter are set.
  69      *
  70      * Further this method starts an office instance and gets the office some more time to start. This is because
  71      * some freshly installed offices don not have such a user tree. The office will create it on its first start,
  72      * but this will take some time.
  73      * Note: This funktionality is only reasonable with parameter <CODE>-noOffice true</CODE>
  74      */
  75     public void before()
  76     {
  77
  78         if (!mIsInitialized)
  79         {
  80             mIsInitialized = true;
  81
  82             try
  83             {
  84
  85                 bet = new BuildEnvTools(param, log);
  86
  87             }
  88             catch (ParameterNotFoundException ex)
  89             {
  90                 this.failed(ex.toString(), false);
  91             }
  92
  93             mSRC_ROOT = bet.getSrcRoot();
  94         }
  95     }
  96
  97     /**
  98      * let API tests run.
  99      */
 100     public void checkModule(String module)
 101     {
 102         log.println(utils.getDateTime() + ": start testing module '" + module + "'");
 103
 104         log.println(utils.getDateTime() + "start new Office instance...");
 105
 106         // TODO: is Office started with this program?
 107         final OfficeProvider officeProvider = new OfficeProvider();
 108
 109         log.println(utils.getDateTime() + "Receiving the ServiceManager of the Office ");
 110         final XMultiServiceFactory msf = (XMultiServiceFactory) officeProvider.getManager(param);
 111         assure("couldnot get ServiceFarcotry", msf != null, mContinue);
 112         param.put("ServiceFactory", msf);
 113
 114         final String sep = System.getProperty("file.separator");
 115         final String sUnoapi = getModulePath(module);
 116         final File fUnoapi = new File(sUnoapi);
 117         final String sMakeFile = sUnoapi + sep + "makefile.mk";
 118         final File fMakeFile = new File(sMakeFile);
 119         assure("ERROR: could not find makefile: '" + sMakeFile + "'", fMakeFile.exists(), mContinue);
 120
 121         final String[] commands = getDmakeCommands(sUnoapi);
 122
 123         final ProcessHandler procHdl = bet.runCommandsInEnvironmentShell(commands, fUnoapi, 0);
 124         log.println("exit code of dmake: " + procHdl.getExitCode());
 125         String test = procHdl.getOutputText();
 126         test += procHdl.getErrorText();
 127         assure("module '" + module + "' failed", verifyOutput(test), mContinue);
 128         log.println(utils.getDateTime() + " module '" + module + "': kill existing office...");
 129
 130         // TODO: how to check if the office is not started with this process.
 131         boolean bNoOffice = param.getBool("NoOffice");
 132         if (!bNoOffice)
 133         {
 134             try
 135             {
 136                 officeProvider.closeExistingOffice(param, true);
 137             }
 138             catch (java.lang.UnsatisfiedLinkError exception)
 139             {
 140                 log.println("Office seems not to be running");
 141             }
 142         }
 143     }
 144     private String getQaUnoApiPath(String srcRoot, String _sModul)
 145     {
 146         File aFile = new File(srcRoot);
 147         if (!aFile.exists())
 148         {
 149             System.out.println("ERROR: srcRoot '" + srcRoot + "' does not exist.");
 150             return null;
 151         }
 152         String sModulePath = srcRoot;
 153         sModulePath += File.separator;
 154         sModulePath += _sModul;
 155
 156         File aModulePath = new File(sModulePath);
 157         if (! aModulePath.exists())
 158         {
 159             aModulePath = new File(sModulePath + ".lnk");
 160             if (! aModulePath.exists())
 161             {
 162                 aModulePath = new File(sModulePath + ".link");
 163                 if (! aModulePath.exists())
 164                 {
 165                     // module does not exist.
 166                     return null;
 167                 }
 168             }
 169         }
 170         sModulePath = aModulePath.getAbsolutePath();
 171         sModulePath += File.separator;
 172         sModulePath += "qa";
 173         sModulePath += File.separator;
 174         sModulePath += "unoapi";
 175         File aModulePathQaUnoApi = new File(sModulePath);
 176         if (aModulePathQaUnoApi.exists())
 177         {
 178             return aModulePathQaUnoApi.getAbsolutePath();
 179         }
 180         return null;
 181     }
 182     private boolean doesQaUnoApiFolderExist(String srcRoot, String _sModul)
 183     {
 184         if (getQaUnoApiPath(srcRoot, _sModul) != null)
 185         {
 186             return true;
 187         }
 188         return false;
 189     }
 190 /*
 191  private boolean doesQaUnoApiFolderExist(File srcRoot)
 192     {
 193         final FolderFilter qaFilter = new FolderFilter("qa");
 194         final File[] qaTree = srcRoot.listFiles(qaFilter);
 195         if (qaTree != null)
 196         {
 197             for (int j = 0; j < qaTree.length; j++)
 198             {
 199                 final File qaFolder = qaTree[j];
 200                 final FolderFilter apiFilter = new FolderFilter("unoapi");
 201                 final File[] apiTree = qaFolder.listFiles(apiFilter);
 202                 if (apiTree != null && apiTree.length > 0)
 203                 {
 204                     return true;
 205                 }
 206             }
 207         }
 208         return false;
 209     }
 210 */
 211
 212     private String[] getAllModuleCommand()
 213     {
 214         String[] checkModules;
 215
 216         final String[] names = getModulesFromSourceRoot();
 217         checkModules = getCheckModuleCommand(names);
 218
 219         return checkModules;
 220     }
 221
 222     private String[] getCheckModuleCommand(String[] names)
 223     {
 224         String[] checkModules;
 225         checkModules = new String[names.length];
 226
 227         for (int i = 0; i < names.length; i++)
 228         {
 229             // if a module is not added to a cws it contains a dot in its name (forms.lnk)
 230             if (names[i].indexOf(".") != -1)
 231             {
 232                 checkModules[i] = "checkModule(" + names[i].substring(0, names[i].indexOf(".")) + ")";
 233             }
 234             else
 235             {
 236                 checkModules[i] = "checkModule(" + names[i] + ")";
 237             }
 238         }
 239         return checkModules;
 240     }
 241
 242     private String[] getDmakeCommands(String sUnoapi)
 243     {
 244
 245         String[] cmdLines = null;
 246         final String platform = (String) param.get(PropertyName.OPERATING_SYSTEM);
 247         log.println("prepare command for platform " + platform);
 248
 249         if (platform.equals(PropertyName.WNTMSCI))
 250         {
 251             if (param.getBool(PropertyName.CYGWIN))
 252             {
 253                 // cygwin stuff
 254                 cmdLines = new String[]
 255                         {
 256                             "cd `cygpath '" + sUnoapi.replaceAll("\\\\", "\\\\\\\\") + "'`",
 257                             "dmake"
 258                         };
 259             }
 260             else
 261             {
 262                 // old 4NT
 263                 cmdLines = new String[]
 264                         {
 265                             "cdd " + sUnoapi,
 266                             "dmake"
 267                         };
 268             }
 269         }
 270         else
 271         {
 272             // unix
 273             cmdLines = new String[]
 274                     {
 275                         "cd " + sUnoapi,
 276                         "dmake"
 277                     };
 278         }
 279         return cmdLines;
 280     }
 281
 282     private String[] getCwsModuleCommand()
 283     {
 284         String[] checkModules;
 285         final String version = (String) param.get(PropertyName.VERSION);
 286         String[] names = null;
 287         if (version.startsWith("cws_"))
 288         {
 289             try
 290             {
 291                 final CwsDataExchangeImpl cde = new CwsDataExchangeImpl(param, log);
 292                 final ArrayList<String> addedModules = cde.getModules();
 293
 294                 final ArrayList<String> moduleNames = new ArrayList<String>();
 295                 Iterator<String> iterator = addedModules.iterator();
 296                 while (iterator.hasNext())
 297                 {
 298                     String sModuleName = iterator.next();
 299                     if (doesQaUnoApiFolderExist(mSRC_ROOT, sModuleName))
 300                     {
 301                         moduleNames.add(sModuleName);
 302                     }
 303                 }
 304                 names = moduleNames.toArray(new String[moduleNames.size()]);
 305             }
 306             catch (ParameterNotFoundException ex)
 307             {
 308                 this.failed(ex.toString(), false);
 309             }
 310
 311
 312         }
 313         else
 314         {
 315             // major version: all modules must be tested
 316             names = getModulesFromSourceRoot();
 317         }
 318         checkModules = getCheckModuleCommand(names);
 319
 320         return checkModules;
 321     }
 322
 323     private String[] getDefinedModuleCommand(String module)
 324     {
 325         String[] checkModules = null;
 326         // list of modules to test: (sw,sc,sd)
 327         if (module.indexOf(",") != -1)
 328         {
 329             final String[] names = module.split(",");
 330             checkModules = new String[names.length];
 331             for (int i = 0; i < names.length; i++)
 332             {
 333                 final String moduleName = names[i].trim();
 334
 335                 if (doesQaUnoApiFolderExist(mSRC_ROOT, moduleName))
 336                 {
 337                     checkModules[i] = "checkModule(" + moduleName + ")";
 338                 }
 339             }
 340         }
 341         else
 342         {
 343             if (doesQaUnoApiFolderExist(mSRC_ROOT, module))
 344             {
 345                 checkModules = new String[]
 346                         {
 347                             "checkModule(" + module + ")"
 348                         };
 349             }
 350         }
 351         return checkModules;
 352     }
 353
 354     private String getModulePath(String module)
 355     {
 356         String sUnoapi = getQaUnoApiPath(mSRC_ROOT, module);
 357         return sUnoapi;
 358     }
 359
 360     /**
 361     Some modules contains more the one project. This methods translates given project parameter to the
 362      *  correspind module name.
 363      *
 364      * fwk -> framework
 365      * fwl -> framework
 366      * sch -> chart2
 367      * lnn -> lingu
 368      * lng -> linguistic
 369      * sfx -> sfx2
 370      * sm -> starmath
 371      */
 372     private String getTranslatedNames(String module)
 373     {
 374
 375         final HashMap<String,String> aModuleHashMap = new HashMap<String,String>();
 376
 377         aModuleHashMap.put("fwk", "framework");
 378         aModuleHashMap.put("fwl", "framework");
 379         aModuleHashMap.put("sch", "chart2");
 380         aModuleHashMap.put("lnn", "lingu");
 381         aModuleHashMap.put("lng", "linguistic");
 382         aModuleHashMap.put("sfx", "sfx2");
 383         aModuleHashMap.put("sm", "starmath");
 384
 385         // it could the that the parameter looks like "fwk,fwl". This results in double "famework,framework".
 386         // The following loop correct this to only one "framework"
 387
 388         final Set<String> keys = aModuleHashMap.keySet();
 389         final Iterator<String> iterator = keys.iterator();
 390         while (iterator.hasNext())
 391         {
 392
 393             final String key = iterator.next();
 394             final String value = aModuleHashMap.get(key);
 395
 396             module = module.replaceAll(key, value);
 397
 398             final int count = module.split(value).length;
 399             if (count > 2)
 400             {
 401                 for (int i = 2; i < count; i++)
 402                 {
 403                     module.replaceFirst("," + value, "");
 404                 }
 405
 406             }
 407         }
 408         return module;
 409     }
 410
 411     private boolean verifyOutput(String output)
 412     {
 413
 414         log.println("verify output...");
 415         boolean ok = false;
 416         final String[] outs = output.split("\n");
 417
 418         for (int i = 0; i < outs.length; i++)
 419         {
 420             final String line = outs[i];
 421             if (line.matches("[0-9]+? of [0-9]+? tests failed"))
 422             {
 423                 log.println("mached line: " + line);
 424                 if (line.matches("0 of [0-9]+? tests failed"))
 425                 {
 426                     ok = true;
 427                     log.println("Module passed OK");
 428                 }
 429                 else
 430                 {
 431                     log.println("Module passed FAILED");
 432                 }
 433             }
 434         }
 435
 436         if (!ok)
 437         {
 438             log.println("ERROR: could not find '0 of [0-9]+? tests failed' in output");
 439         }
 440
 441         return ok;
 442     }
 443
 444     private String[] getModulesFromSourceRoot()
 445     {
 446         log.println("**** run module tests over all modules ****");
 447
 448         log.println("search for qa/unoapi foldres in all modules based in ");
 449         log.println("'" + mSRC_ROOT + "'");
 450
 451         final ArrayList<String> moduleNames = new ArrayList<String>();
 452         final File sourceRoot = new File(mSRC_ROOT);
 453         final File[] sourceTree = sourceRoot.listFiles();
 454
 455         for (int i = 0; i < sourceTree.length; i++)
 456         {
 457             final File moduleName = sourceTree[i];
 458             String sModuleName = moduleName.getName(); // (String)moduleNames.get(i);
 459             if (doesQaUnoApiFolderExist(mSRC_ROOT, sModuleName))
 460             {
 461                 moduleNames.add(sModuleName);
 462             }
 463         }
 464
 465         final String[] names = moduleNames.toArray(new String[moduleNames.size()]);
 466         return names;
 467     }
 468
 469     /**
 470      * This function generates a list of modules to test and call <CODE>checkModule</CODE> for every module.
 471      * <p>
 472      *
 473      * @param module names to test. This could be
 474      * <ul>
 475      * <li>a comma separated list of modules like 'sw,sc,sd'</li>
 476      * <li>'all' to test all modules </li>
 477      * <li>'auto' to check only modules which are added to the ChildWorkSpace</li>
 478      * </ul>
 479      */
 480     public void module(String module)
 481     {
 482
 483         String[] checkModules;
 484         final ComplexDescGetter desc = new ComplexDescGetter();
 485         DescEntry entry = null;
 486         module = module.trim();
 487
 488         /*
 489         all: check all modules which contains a qa/unoapi folder
 490         auto: check all modules which contains a qa/unoapi folder except the module is not added
 491          */
 492         if (module.equals("all"))
 493         {
 494             checkModules = getAllModuleCommand();
 495         }
 496         else if (module.equals("auto"))
 497         {
 498             checkModules = getCwsModuleCommand();
 499         }
 500         else
 501         {
 502             module = getTranslatedNames(module);
 503             checkModules = getDefinedModuleCommand(module);
 504         }
 505
 506         if (checkModules != null && checkModules.length > 0)
 507         {
 508
 509             entry = desc.createTestDesc("complex.unoapi.CheckModuleAPI", "complex.unoapi.CheckModuleAPI", checkModules,
 510                     log);
 511
 512             final java_complex complex = new java_complex();
 513
 514             log.println("********** start test *************");
 515             final boolean result = complex.executeTest(param, new DescEntry[] { entry });
 516             log.println("********** end test *************");
 517
 518             assure("CheckModuleAPI.module(" + module + ") PASSED.FAILED", result);
 519
 520         }
 521         else
 522         {
 523             log.println("No modules containing qa/unoapi folder found => OK");
 524             state = true;
 525         }
 526
 527         setUnoApiCwsStatus(state);
 528
 529     }
 530
 531     private void setUnoApiCwsStatus(boolean status)
 532     {
 533         final String version = (String) param.get(PropertyName.VERSION);
 534         if (version.startsWith("cws_"))
 535         {
 536             try
 537             {
 538
 539                 final CwsDataExchangeImpl cde = new CwsDataExchangeImpl(param, log);
 540                 cde.setUnoApiCwsStatus(status);
 541             }
 542             catch (ParameterNotFoundException ex)
 543             {
 544                 log.println("ERROR: could not wirte status to EIS database: " + ex.toString());
 545             }
 546         }
 547     }
 548
 549     @Override
 550     public String[] getTestMethodNames()
 551     {
 552         return new String[]
 553                 {
 554                     "module(all)"
 555                 };
 556     }
 557
 558 }