1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski package complex.tdoc; 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski import com.sun.star.beans.Property; 27*b1cdbd2cSJim Jagielski import com.sun.star.beans.XPropertySetInfo; 28*b1cdbd2cSJim Jagielski import lib.MultiMethodTest; 29*b1cdbd2cSJim Jagielski import lib.StatusException; 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski import com.sun.star.lang.XMultiServiceFactory; 32*b1cdbd2cSJim Jagielski import com.sun.star.ucb.Command; 33*b1cdbd2cSJim Jagielski import com.sun.star.ucb.CommandAbortedException; 34*b1cdbd2cSJim Jagielski import com.sun.star.ucb.CommandInfo; 35*b1cdbd2cSJim Jagielski import com.sun.star.ucb.GlobalTransferCommandArgument; 36*b1cdbd2cSJim Jagielski import com.sun.star.ucb.NameClash; 37*b1cdbd2cSJim Jagielski import com.sun.star.ucb.TransferCommandOperation; 38*b1cdbd2cSJim Jagielski import com.sun.star.ucb.UnsupportedCommandException; 39*b1cdbd2cSJim Jagielski import com.sun.star.ucb.XCommandInfo; 40*b1cdbd2cSJim Jagielski import com.sun.star.ucb.XCommandProcessor; 41*b1cdbd2cSJim Jagielski import com.sun.star.uno.Exception; 42*b1cdbd2cSJim Jagielski import com.sun.star.uno.UnoRuntime; 43*b1cdbd2cSJim Jagielski import share.LogWriter; 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski /** 46*b1cdbd2cSJim Jagielski * Tests <code>XCommandProcessor</code>. The TestCase can pass (but doesn't have 47*b1cdbd2cSJim Jagielski * to) "XCommandProcessor.AbortCommand" relation, to specify command to abort in 48*b1cdbd2cSJim Jagielski * <code>abort()</code> test. 49*b1cdbd2cSJim Jagielski * 50*b1cdbd2cSJim Jagielski * Testing <code>com.sun.star.ucb.XCommandProcessor</code> 51*b1cdbd2cSJim Jagielski * interface methods : 52*b1cdbd2cSJim Jagielski * <ul> 53*b1cdbd2cSJim Jagielski * <li><code> createCommandIdentifier()</code></li> 54*b1cdbd2cSJim Jagielski * <li><code> execute()</code></li> 55*b1cdbd2cSJim Jagielski * <li><code> abort()</code></li> 56*b1cdbd2cSJim Jagielski * </ul> <p> 57*b1cdbd2cSJim Jagielski * This test needs the following object relations : 58*b1cdbd2cSJim Jagielski * <ul> 59*b1cdbd2cSJim Jagielski * <li> <code>'XCommandProcessor.AbortCommand'</code> <b>optional</b> 60*b1cdbd2cSJim Jagielski * (of type <code>com.sun.star.ucb.Command</code>): 61*b1cdbd2cSJim Jagielski * specify command to abort in <code>abort()</code> test. 62*b1cdbd2cSJim Jagielski * If the relation is not specified the 'GlobalTransfer' 63*b1cdbd2cSJim Jagielski * command is used.</li> 64*b1cdbd2cSJim Jagielski * <ul> <p> 65*b1cdbd2cSJim Jagielski * The following predefined files needed to complete the test: 66*b1cdbd2cSJim Jagielski * <ul> 67*b1cdbd2cSJim Jagielski * <li> <code>poliball.gif</code> : this file is required in case 68*b1cdbd2cSJim Jagielski * if the relation <code>'XCommandProcessor.AbortCommand'</code> 69*b1cdbd2cSJim Jagielski * is not specified. This file is used by 'GlobalTransfer' 70*b1cdbd2cSJim Jagielski * command as a source file for copying.</li> 71*b1cdbd2cSJim Jagielski * <ul> <p> 72*b1cdbd2cSJim Jagielski * Test is <b> NOT </b> multithread compilant. <p> 73*b1cdbd2cSJim Jagielski * @see com.sun.star.ucb.XCommandProcessor 74*b1cdbd2cSJim Jagielski */ 75*b1cdbd2cSJim Jagielski public class _XCommandProcessor { 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski /** 78*b1cdbd2cSJim Jagielski * Conatins the tested object. 79*b1cdbd2cSJim Jagielski */ 80*b1cdbd2cSJim Jagielski public XCommandProcessor oObj; 81*b1cdbd2cSJim Jagielski public LogWriter log = null; 82*b1cdbd2cSJim Jagielski private XMultiServiceFactory xMSF = null; 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski /** 85*b1cdbd2cSJim Jagielski * Contains the command id returned by <code>createCommandIdentifier() 86*b1cdbd2cSJim Jagielski * </code>. It is used in <code>abort()</code> test. 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski int cmdId; 89*b1cdbd2cSJim Jagielski before(XMultiServiceFactory _xMSF)90*b1cdbd2cSJim Jagielski public void before(XMultiServiceFactory _xMSF) { 91*b1cdbd2cSJim Jagielski xMSF = _xMSF; 92*b1cdbd2cSJim Jagielski } 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski /** 95*b1cdbd2cSJim Jagielski * Tests <code>createCommandIdentifier()</code>. Calls it for two times 96*b1cdbd2cSJim Jagielski * and checks returned values. <p> 97*b1cdbd2cSJim Jagielski * Has <b>OK</b> status if values are unique correct idenifiers: not 0. 98*b1cdbd2cSJim Jagielski */ _createCommandIdentifier()99*b1cdbd2cSJim Jagielski public boolean _createCommandIdentifier() { 100*b1cdbd2cSJim Jagielski log.println("creating a command line identifier"); 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski int testCmdId = oObj.createCommandIdentifier(); 103*b1cdbd2cSJim Jagielski cmdId = oObj.createCommandIdentifier(); 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski if (cmdId == 0 || testCmdId == 0) { 106*b1cdbd2cSJim Jagielski log.println("createCommandLineIdentifier() returned 0 - FAILED"); 107*b1cdbd2cSJim Jagielski } 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski if (cmdId == testCmdId) { 110*b1cdbd2cSJim Jagielski log.println("the command identifier is not unique"); 111*b1cdbd2cSJim Jagielski } 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski return testCmdId != 0 && cmdId != 0 && cmdId != testCmdId; 114*b1cdbd2cSJim Jagielski } 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski /** 117*b1cdbd2cSJim Jagielski * First executes 'geCommandInfo' command and examines returned 118*b1cdbd2cSJim Jagielski * command info information. Second tries to execute inproper 119*b1cdbd2cSJim Jagielski * command. <p> 120*b1cdbd2cSJim Jagielski * Has <b> OK </b> status if in the first case returned information 121*b1cdbd2cSJim Jagielski * contains info about 'getCommandInfo' command and in the second 122*b1cdbd2cSJim Jagielski * case an exception is thrown. <p> 123*b1cdbd2cSJim Jagielski */ _execute()124*b1cdbd2cSJim Jagielski public boolean _execute() { 125*b1cdbd2cSJim Jagielski String[]commands = new String[] {"getCommandInfo", "getPropertySetInfo"}; 126*b1cdbd2cSJim Jagielski boolean returnVal = true; 127*b1cdbd2cSJim Jagielski for (int j=0; j<commands.length; j++) { 128*b1cdbd2cSJim Jagielski String commandName = commands[j]; 129*b1cdbd2cSJim Jagielski Command command = new Command(commandName, -1, null); 130*b1cdbd2cSJim Jagielski 131*b1cdbd2cSJim Jagielski Object result; 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski log.println("executing command " + commandName); 134*b1cdbd2cSJim Jagielski try { 135*b1cdbd2cSJim Jagielski result = oObj.execute(command, 0, null); 136*b1cdbd2cSJim Jagielski } catch (CommandAbortedException e) { 137*b1cdbd2cSJim Jagielski log.println("The command aborted " + e.getMessage()); 138*b1cdbd2cSJim Jagielski e.printStackTrace((java.io.PrintWriter)log); 139*b1cdbd2cSJim Jagielski throw new StatusException("Unexpected exception", e); 140*b1cdbd2cSJim Jagielski } catch (Exception e) { 141*b1cdbd2cSJim Jagielski log.println("Unexpected exception " + e.getMessage()); 142*b1cdbd2cSJim Jagielski e.printStackTrace((java.io.PrintWriter)log); 143*b1cdbd2cSJim Jagielski throw new StatusException("Unexpected exception", e); 144*b1cdbd2cSJim Jagielski } 145*b1cdbd2cSJim Jagielski 146*b1cdbd2cSJim Jagielski boolean found = false; 147*b1cdbd2cSJim Jagielski 148*b1cdbd2cSJim Jagielski XCommandInfo xCmdInfo = (XCommandInfo)UnoRuntime.queryInterface( 149*b1cdbd2cSJim Jagielski XCommandInfo.class, result); 150*b1cdbd2cSJim Jagielski if (xCmdInfo != null) { 151*b1cdbd2cSJim Jagielski CommandInfo[] cmdInfo = xCmdInfo.getCommands(); 152*b1cdbd2cSJim Jagielski for (int i = 0; i < cmdInfo.length; i++) { 153*b1cdbd2cSJim Jagielski log.println("\t##### " + cmdInfo[i].Name + " - " + cmdInfo[i].Handle + " - " + cmdInfo[i].ArgType.getTypeName()); 154*b1cdbd2cSJim Jagielski if (cmdInfo[i].Name.equals(commandName)) { 155*b1cdbd2cSJim Jagielski found = true; 156*b1cdbd2cSJim Jagielski // break; 157*b1cdbd2cSJim Jagielski } 158*b1cdbd2cSJim Jagielski } 159*b1cdbd2cSJim Jagielski } 160*b1cdbd2cSJim Jagielski 161*b1cdbd2cSJim Jagielski XPropertySetInfo xPropInfo = (XPropertySetInfo)UnoRuntime.queryInterface( 162*b1cdbd2cSJim Jagielski XPropertySetInfo.class, result); 163*b1cdbd2cSJim Jagielski if (xPropInfo != null) { 164*b1cdbd2cSJim Jagielski Property[] props = xPropInfo.getProperties(); 165*b1cdbd2cSJim Jagielski String[] defProps = new String[] {"ContentType", "IsDocument", "IsFolder", "Title"}; 166*b1cdbd2cSJim Jagielski int propCount = defProps.length; 167*b1cdbd2cSJim Jagielski for (int i = 0; i < props.length; i++) { 168*b1cdbd2cSJim Jagielski for (int k=0; k<defProps.length; k++) { 169*b1cdbd2cSJim Jagielski if (props[i].Name.equals(defProps[k])) { 170*b1cdbd2cSJim Jagielski propCount--; 171*b1cdbd2cSJim Jagielski log.println("Property '" + defProps[k] + "' has been found."); 172*b1cdbd2cSJim Jagielski } 173*b1cdbd2cSJim Jagielski } 174*b1cdbd2cSJim Jagielski } 175*b1cdbd2cSJim Jagielski found = propCount == 0; 176*b1cdbd2cSJim Jagielski } 177*b1cdbd2cSJim Jagielski 178*b1cdbd2cSJim Jagielski returnVal &= found; 179*b1cdbd2cSJim Jagielski 180*b1cdbd2cSJim Jagielski if (!found) { 181*b1cdbd2cSJim Jagielski log.println("Command '" + commandName + "' was not executed correctly."); 182*b1cdbd2cSJim Jagielski } 183*b1cdbd2cSJim Jagielski } 184*b1cdbd2cSJim Jagielski /* log.println("testing execute with wrong command"); 185*b1cdbd2cSJim Jagielski 186*b1cdbd2cSJim Jagielski Command badCommand = new Command("bad command", -1, null); 187*b1cdbd2cSJim Jagielski 188*b1cdbd2cSJim Jagielski try { 189*b1cdbd2cSJim Jagielski oObj.execute(badCommand, 0, null); 190*b1cdbd2cSJim Jagielski } catch (CommandAbortedException e) { 191*b1cdbd2cSJim Jagielski log.println("CommandAbortedException thrown - OK"); 192*b1cdbd2cSJim Jagielski } catch (UnsupportedCommandException e) { 193*b1cdbd2cSJim Jagielski log.println("UnsupportedCommandException thrown - OK"); 194*b1cdbd2cSJim Jagielski } catch (Exception e) { 195*b1cdbd2cSJim Jagielski log.println("Wrong exception thrown " + e.getMessage()); 196*b1cdbd2cSJim Jagielski e.printStackTrace((java.io.PrintWriter)log); 197*b1cdbd2cSJim Jagielski throw new StatusException("Unexpected exception", e); 198*b1cdbd2cSJim Jagielski } 199*b1cdbd2cSJim Jagielski */ 200*b1cdbd2cSJim Jagielski return returnVal; 201*b1cdbd2cSJim Jagielski } 202*b1cdbd2cSJim Jagielski 203*b1cdbd2cSJim Jagielski /** 204*b1cdbd2cSJim Jagielski * First a separate thread where <code>abort</code> method 205*b1cdbd2cSJim Jagielski * is called permanently. Then a "long" command (for example, 206*b1cdbd2cSJim Jagielski * "transfer") is started. I case if relation is not 207*b1cdbd2cSJim Jagielski * specified 'GlobalTransfer' command starts to 208*b1cdbd2cSJim Jagielski * copy a file to temporary directory (if the relation is present 209*b1cdbd2cSJim Jagielski * then the its command starts to work). <p> 210*b1cdbd2cSJim Jagielski * Has <b> OK </b> status if the command execution is aborted, i.e. 211*b1cdbd2cSJim Jagielski * <code>CommandAbortedException</code> is thrown. <p> 212*b1cdbd2cSJim Jagielski * The following method tests are to be completed successfully before : 213*b1cdbd2cSJim Jagielski * <ul> 214*b1cdbd2cSJim Jagielski * <li> <code> createCommandIdentifier() </code> : to have a unique 215*b1cdbd2cSJim Jagielski * identifier which is used to abourt started command. </li> 216*b1cdbd2cSJim Jagielski * </ul> 217*b1cdbd2cSJim Jagielski */ _abort()218*b1cdbd2cSJim Jagielski public boolean _abort() { 219*b1cdbd2cSJim Jagielski //executeMethod("createCommandIdentifier()"); 220*b1cdbd2cSJim Jagielski 221*b1cdbd2cSJim Jagielski // Command command = null;//(Command)tEnv.getObjRelation( 222*b1cdbd2cSJim Jagielski //"XCommandProcessor.AbortCommand"); 223*b1cdbd2cSJim Jagielski Command command = new Command("getCommandInfo", -1, null); 224*b1cdbd2cSJim Jagielski 225*b1cdbd2cSJim Jagielski if (command == null) { 226*b1cdbd2cSJim Jagielski String commandName = "globalTransfer"; 227*b1cdbd2cSJim Jagielski 228*b1cdbd2cSJim Jagielski String srcURL = util.utils.getFullTestURL("solibrary.jar") ; 229*b1cdbd2cSJim Jagielski String tmpURL = util.utils.getOfficeTemp(xMSF) ; 230*b1cdbd2cSJim Jagielski log.println("Copying '" + srcURL + "' to '" + tmpURL) ; 231*b1cdbd2cSJim Jagielski 232*b1cdbd2cSJim Jagielski GlobalTransferCommandArgument arg = new 233*b1cdbd2cSJim Jagielski GlobalTransferCommandArgument( 234*b1cdbd2cSJim Jagielski TransferCommandOperation.COPY, srcURL, 235*b1cdbd2cSJim Jagielski tmpURL, "", NameClash.OVERWRITE); 236*b1cdbd2cSJim Jagielski 237*b1cdbd2cSJim Jagielski command = new Command(commandName, -1, arg); 238*b1cdbd2cSJim Jagielski } 239*b1cdbd2cSJim Jagielski 240*b1cdbd2cSJim Jagielski Thread aborter = new Thread() { 241*b1cdbd2cSJim Jagielski public void run() { 242*b1cdbd2cSJim Jagielski for (int i = 0; i < 10; i++) { 243*b1cdbd2cSJim Jagielski log.println("try to abort command"); 244*b1cdbd2cSJim Jagielski oObj.abort(cmdId); 245*b1cdbd2cSJim Jagielski try { 246*b1cdbd2cSJim Jagielski Thread.sleep(10); 247*b1cdbd2cSJim Jagielski } catch (InterruptedException e) { 248*b1cdbd2cSJim Jagielski } 249*b1cdbd2cSJim Jagielski } 250*b1cdbd2cSJim Jagielski } 251*b1cdbd2cSJim Jagielski }; 252*b1cdbd2cSJim Jagielski 253*b1cdbd2cSJim Jagielski aborter.start(); 254*b1cdbd2cSJim Jagielski 255*b1cdbd2cSJim Jagielski try { 256*b1cdbd2cSJim Jagielski Thread.sleep(15); 257*b1cdbd2cSJim Jagielski } catch (InterruptedException e) { 258*b1cdbd2cSJim Jagielski } 259*b1cdbd2cSJim Jagielski 260*b1cdbd2cSJim Jagielski log.println("executing command"); 261*b1cdbd2cSJim Jagielski try { 262*b1cdbd2cSJim Jagielski oObj.execute(command, cmdId, null); 263*b1cdbd2cSJim Jagielski log.println("Command execution completed"); 264*b1cdbd2cSJim Jagielski log.println("CommandAbortedException is not thrown"); 265*b1cdbd2cSJim Jagielski log.println("This is OK since there is no command implemented "+ 266*b1cdbd2cSJim Jagielski "that can be aborted"); 267*b1cdbd2cSJim Jagielski } catch (CommandAbortedException e) { 268*b1cdbd2cSJim Jagielski return true; 269*b1cdbd2cSJim Jagielski } catch (Exception e) { 270*b1cdbd2cSJim Jagielski log.println("Unexpected exception " + e.getMessage()); 271*b1cdbd2cSJim Jagielski e.printStackTrace((java.io.PrintWriter)log); 272*b1cdbd2cSJim Jagielski return false; 273*b1cdbd2cSJim Jagielski } 274*b1cdbd2cSJim Jagielski 275*b1cdbd2cSJim Jagielski try { 276*b1cdbd2cSJim Jagielski aborter.join(5000); 277*b1cdbd2cSJim Jagielski aborter.interrupt(); 278*b1cdbd2cSJim Jagielski } catch(java.lang.InterruptedException e) { 279*b1cdbd2cSJim Jagielski } 280*b1cdbd2cSJim Jagielski return true; 281*b1cdbd2cSJim Jagielski } 282*b1cdbd2cSJim Jagielski } 283