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