diff options
Diffstat (limited to 'vcl/qa/complex/memCheck/CheckMemoryUsage.java')
-rw-r--r-- | vcl/qa/complex/memCheck/CheckMemoryUsage.java | 600 |
1 files changed, 434 insertions, 166 deletions
diff --git a/vcl/qa/complex/memCheck/CheckMemoryUsage.java b/vcl/qa/complex/memCheck/CheckMemoryUsage.java index 9f8272240403..a089a1c99f54 100644 --- a/vcl/qa/complex/memCheck/CheckMemoryUsage.java +++ b/vcl/qa/complex/memCheck/CheckMemoryUsage.java @@ -32,19 +32,27 @@ import com.sun.star.lang.XComponent; import com.sun.star.lang.XMultiServiceFactory; import com.sun.star.uno.UnoRuntime; import com.sun.star.util.XCloseable; -import complexlib.ComplexTestCase; +// import complexlib.ComplexTestCase; import helper.ProcessHandler; import java.io.File; -import java.io.FilePermission; +// import java.io.FilePermission; import java.io.FileWriter; import java.io.FilenameFilter; import java.io.PrintWriter; import java.util.Enumeration; import java.util.StringTokenizer; import java.util.Vector; +import lib.*; import util.DesktopTools; -import util.WriterTools; -import util.utils; +// import util.WriterTools; + +import org.junit.After; +import org.junit.AfterClass; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; +import org.openoffice.test.OfficeConnection; +import static org.junit.Assert.*; /** * Documents are opened and exported with StarOffice. The memory usage of @@ -66,95 +74,141 @@ import util.utils; * All parameters are used for iteration over the test document path. * </ul> */ -public class CheckMemoryUsage extends ComplexTestCase { +class TempDir +{ + + private String m_sTempDir; + + public TempDir(String _sTempDir) + { + m_sTempDir = _sTempDir; + } + + public String getOfficeTempDir() + { + return m_sTempDir; + } + + public String getTempDir() + { + final String sTempDir = FileHelper.getJavaCompatibleFilename(m_sTempDir); + return sTempDir; + } +} + +public class CheckMemoryUsage /* extends ComplexTestCase */ + +{ + private final String sWriterDoc = "sxw,writer_pdf_Export"; private final String sCalcDoc = "sxc,calc_pdf_Export"; private final String sImpressDoc = "sxi,impress_pdf_Export"; - private String sProcessId = "ps -ef | grep $USER | grep soffice | grep -v grep"; - private String sMemoryMonitor = "pmap <processID> | grep total"; - private String sChmod = "chmod 777 "; - private String sProcessIdCommand = null; - private String sOfficeMemoryCommand = null; - private String sTempDir = null; - private String sFS = null; - private String sMemoryMap1 = null; - private String sMemoryMap2 = null; - private String bash = "#!/bin/bash"; - private String sDocumentPath = ""; + // private String sProcessIdCommand = null; + TempDir m_aTempDir; + // private String sFS = null; + // private String sMemoryMap1 = null; + // private String sMemoryMap2 = null; + // private String sDocumentPath = ""; private String[][] sDocTypeExportFilter; private String[][] sDocuments; private int iAllowMemoryIncrease = 10; private int iExportDocCount = 25; + /** + * The test parameters + */ + private static TestParameters param = null; /** * Get all test methods * @return The test methods. - */ - public String[] getTestMethodNames() { - return new String[] {"loadAndSaveDocuments"}; - } - + // */ +// public String[] getTestMethodNames() { +// return new String[] {"loadAndSaveDocuments"}; +// } /** * Collect all documnets to load and all filters used for export. */ - public void before() { + @Before + public void before() + { + + final XMultiServiceFactory xMsf = getMSF(); + + // some Tests need the qadevOOo TestParameters, it is like a Hashmap for Properties. + param = new TestParameters(); + param.put("ServiceFactory", xMsf); // some qadevOOo functions need the ServiceFactory + // test does definitely not run on Windows. - if (param.get("OperatingSystem").equals("wntmsci")) { - log.println("Test can only reasonably be executed with a tool that " - + "displays the memory usage of StarOffice."); - failed("Test does not run on Windows, only on Solaris or Linux."); + if (param.get("OperatingSystem").equals("wntmsci")) + { + System.out.println("Test can only reasonably be executed with a tool that " + + "displays the memory usage of StarOffice."); + System.out.println("Test does not run on Windows, only on Solaris or Linux."); + // in an automatic environment it is better to say, there is no error here. + // it is a limitation, but no error. + System.exit(0); } + // how many times is every document exported. int count = param.getInt("ExportDocCount"); if (count != 0) + { iExportDocCount = count; + } // get the temp dir for creating the command scripts. - sTempDir = System.getProperty("java.io.tmpdir"); - sProcessIdCommand = sTempDir + "getPS"; - sOfficeMemoryCommand = sTempDir + "getPmap"; + // sTempDir = System.getProperty("java.io.tmpdir"); + m_aTempDir = new TempDir(util.utils.getOfficeTemp/*Dir*/(xMsf)); // get the file extension, export filter connection Enumeration keys = param.keys(); - Vector v = new Vector(); - while(keys.hasMoreElements()) { - String key = (String)keys.nextElement(); - if (key.startsWith("FileExportFilter")) { - v.add(param.get(key)); + Vector<String> v = new Vector<String>(); + while (keys.hasMoreElements()) + { + String key = (String) keys.nextElement(); + if (key.startsWith("FileExportFilter")) + { + v.add((String) param.get(key)); } } // if no param given, set defaults. - if (v.size() == 0){ + if (v.size() == 0) + { v.add(sWriterDoc); v.add(sCalcDoc); v.add(sImpressDoc); } // store a file extension sDocTypeExportFilter = new String[v.size()][2]; - for (int i=0; i<v.size(); i++) { + for (int i = 0; i < v.size(); i++) + { // 2do: error routine for wrong given params - StringTokenizer t = new StringTokenizer((String)v.get(i), ","); - sDocTypeExportFilter[i][0] = t.nextToken(); - sDocTypeExportFilter[i][1] = t.nextToken(); + final String sVContent = v.get(i); + StringTokenizer t = new StringTokenizer(sVContent, ","); + final String sExt = t.nextToken(); + final String sName = t.nextToken(); + sDocTypeExportFilter[i][0] = sExt; + sDocTypeExportFilter[i][1] = sName; } // get files to load and export - sDocumentPath = (String)param.get("TestDocumentPath"); - File f = new File(sDocumentPath); - sDocumentPath = f.getAbsolutePath(); - String sFS = System.getProperty("file.separator"); +// sDocumentPath = (String) param.get("TestDocumentPath"); + String sDocumentPath = TestDocument.getUrl(); + File f = new File(FileHelper.getJavaCompatibleFilename(sDocumentPath)); + // sDocumentPath = f.getAbsolutePath(); + // String sFS = System.getProperty("file.separator"); sDocuments = new String[sDocTypeExportFilter.length][]; - for (int j=0; j<sDocTypeExportFilter.length; j++) { + for (int j = 0; j < sDocTypeExportFilter.length; j++) + { FileFilter filter = new FileFilter(sDocTypeExportFilter[j][0]); String[] doc = f.list(filter); sDocuments[j] = new String[doc.length]; - for (int i=0; i<doc.length; i++) { - if (sDocumentPath.endsWith(sFS)) - sDocuments[j][i] = sDocumentPath + doc[i]; - else - sDocuments[j][i] = sDocumentPath + sFS + doc[i]; - sDocuments[j][i] = utils.getFullURL(sDocuments[j][i]); + for (int i = 0; i < doc.length; i++) + { + // final String sDocument = FileHelper.appendPath(sDocumentPath, doc[i]); + // sDocuments[j][i] = utils.getFullURL(sDocuments[j][i]); + sDocuments[j][i] = TestDocument.getUrl(doc[i]); } } } @@ -162,141 +216,323 @@ public class CheckMemoryUsage extends ComplexTestCase { /** * delete all created files on disk */ - public void after() { + @After + public void after() + { // delete the constructed files. - for (int i=0; i<iExportDocCount; i++) { - File f = new File(sTempDir + "DocExport" + i + ".pdf"); - f.delete(); - } - File f = new File(sProcessIdCommand); - f.delete(); - f = new File(sOfficeMemoryCommand); - f.delete(); +// we don't need to delete anything, all is stored in $USER_TREE +// for (int i = 0; i < iExportDocCount; i++) +// { +// final String sDocumentName = "DocExport" + i + ".pdf"; +// final String sFilename = FileHelper.appendPath(m_sTempDir, sDocumentName); +// File f = new File(FileHelper.getJavaCompatibleFilename(sFilename)); +// f.delete(); +// } + // File f = new File(sProcessIdCommand); + // f.delete(); + // f = new File(sOfficeMemoryCommand); + // f.delete(); } /** - * Thet etst function: load documents and save them using the given filters + * The test function: load documents and save them using the given filters * for each given document type. */ - public void loadAndSaveDocuments() { - int storageBefore = getOfficeMemoryUsage(); + @Test + public void loadAndSaveDocuments() + { + int nOk = 0; + int nRunThrough = 0; - XMultiServiceFactory xMSF = (XMultiServiceFactory)param.getMSF(); + // At first: + // we load the document, there will be some post work in office like late initialisations + // we store exact one time the document + // so the memory footprint should be right // iterate over all document types - for (int k=0; k<sDocTypeExportFilter.length; k++) { + for (int k = 0; k < sDocTypeExportFilter.length; k++) + { // iterate over all documents of this type - for (int i=0; i<sDocuments[k].length; i++) { - System.out.println("Document: "+ sDocuments[k][i]); - XComponent xComponent = DesktopTools.loadDoc(xMSF, sDocuments[k][i], null); - XStorable xStorable = (XStorable)UnoRuntime.queryInterface(XStorable.class, xComponent); - if (xStorable != null) { - // export each document iExportDocCount times - for (int j=0; j<iExportDocCount; j++) { - String url = utils.getFullURL(sTempDir + "DocExport" + j + ".pdf"); - try { - PropertyValue[] props = new PropertyValue[1]; - props[0] = new PropertyValue(); - props[0].Name = "FilterName"; - // use export filter for this doc type - props[0].Value = sDocTypeExportFilter[k][1]; - xStorable.storeToURL(url, props); - } - catch(com.sun.star.io.IOException e) { - failed("Could not store to '" + url + "'", true); - } - } - // close the doc - XCloseable xCloseable = (XCloseable)UnoRuntime.queryInterface(XCloseable.class, xStorable); - try { - xCloseable.close(true); - } - catch(com.sun.star.util.CloseVetoException e) { - e.printStackTrace((java.io.PrintWriter)log); - failed("Cannot close document: test is futile, Office will surely use more space."); - } - } - else { - log.println("Cannot query for XStorable interface on document '" + sDocuments[i] + "'"); - log.println(" -> Skipping storage."); - } + for (int i = 0; i < sDocuments[k].length; i++) + { + + final String sDocument = sDocuments[k][i]; + final String sExtension = sDocTypeExportFilter[k][1]; + +// OfficeMemchecker aChecker = new OfficeMemchecker(); +// aChecker.setDocumentName(FileHelper.getBasename(sDocument)); +// aChecker.setExtension(sExtension); +// aChecker.start(); + + loadAndSaveNTimesDocument(sDocument, 1, sExtension); + +// nOk += checkMemory(aChecker); +// nRunThrough ++; } + System.out.println(); + System.out.println(); } - // short wait for the office to 'calm down' and free some memory - shortWait(5000); - // wait util memory is not freed anymore. - int storageAfter = getOfficeMemoryUsage(); - int mem = 0; - int count = 0; - while (storageAfter != mem && count < 10) { - count++; - mem = storageAfter; - storageAfter = getOfficeMemoryUsage(); - shortWait(1000); - } - assure("The Office consumes now " + (storageAfter - storageBefore) - + "K more memory than at the start of the test; allowed were " - + iAllowMemoryIncrease * iExportDocCount + "K.", - storageAfter - storageBefore < iAllowMemoryIncrease * iExportDocCount); + shortWait(10000); + + // Now the real test, load document and store 25 times + + // iterate over all document types + for (int k = 0; k < sDocTypeExportFilter.length; k++) + { + // iterate over all documents of this type + for (int i = 0; i < sDocuments[k].length; i++) + { + + final String sDocument = sDocuments[k][i]; + final String sExtension = sDocTypeExportFilter[k][1]; + + OfficeMemchecker aChecker = new OfficeMemchecker(); + aChecker.setDocumentName(FileHelper.getBasename(sDocument)); + aChecker.setExtension(sExtension); + aChecker.start(); + + loadAndSaveNTimesDocument(sDocument, iExportDocCount, sExtension); + + aChecker.stop(); + final int nConsumMore = aChecker.getConsumMore(); + + nOk += checkMemory(nConsumMore); + nRunThrough++; + } + System.out.println(); + System.out.println(); + } + System.out.println("Find the output of used 'pmap' here: " + m_aTempDir.getTempDir() + " if test failed."); + assertTrue("Office consumes too many memory.", nOk == nRunThrough); } /** - * Get the process ID from the Office - * @return the Id as String + * Checks how much memory should consum + * @param storageBefore + * @return 1 if consum is ok, else 0 */ - private String getOfficeProcessID() { - writeExecutableFile(sProcessIdCommand, sProcessId); - ProcessHandler processID = new ProcessHandler(sProcessIdCommand); - processID.executeSynchronously(); - String text = processID.getOutputText(); - if (text == null || text.equals("") || text.indexOf(' ') == -1) - failed("Could not determine Office process ID. Check " + sProcessIdCommand); - StringTokenizer aToken = new StringTokenizer(text); - // this is not nice, but ps gives the same output on every machine - aToken.nextToken(); - String id = aToken.nextToken(); - return id; + private int checkMemory(int nConsumMore) + { + int nAllowed = iAllowMemoryIncrease * iExportDocCount; + System.out.println("The Office consumes now " + nConsumMore + + "K more memory than at the start of the test; allowed were " + + nAllowed + "K."); + if (nConsumMore > nAllowed) + { + System.out.println("ERROR: This is not allowed."); + return 0; + } + System.out.println("OK."); + return 1; } /** - * Get the memory usage of the Office in KByte. - * @return The memory used by the Office. + * load and save exact one document */ - private int getOfficeMemoryUsage() { - String command = sMemoryMonitor.replaceAll("<processID>", getOfficeProcessID()); - writeExecutableFile(sOfficeMemoryCommand, command); - ProcessHandler processID = new ProcessHandler(sOfficeMemoryCommand); - processID.executeSynchronously(); - String text = processID.getOutputText(); - if (text == null || text.equals("") || text.indexOf(' ') == -1) { - failed("Could not determine Office memory usage. Check " + sOfficeMemoryCommand); + private void loadAndSaveNTimesDocument(String _sDocument, int _nCount, String _sStoreExtension) + { + System.out.println("Document: " + _sDocument); + XComponent xComponent = DesktopTools.loadDoc(getMSF(), _sDocument, null); + XStorable xStorable = UnoRuntime.queryInterface(XStorable.class, xComponent); + if (xStorable != null) + { + // export each document iExportDocCount times + for (int j = 0; j < _nCount; j++) + { + final String sDocumentName = FileHelper.getBasename(_sDocument) + "_" + j + ".pdf"; + final String sFilename = FileHelper.appendPath(m_aTempDir.getOfficeTempDir(), sDocumentName); + // String url = utils.getFullURL(sFilename); + String url = sFilename; // graphical.FileHelper.getFileURLFromSystemPath(sFilename); + try + { + PropertyValue[] props = new PropertyValue[1]; + props[0] = new PropertyValue(); + props[0].Name = "FilterName"; + // use export filter for this doc type + props[0].Value = _sStoreExtension; + xStorable.storeToURL(url, props); + } + catch (com.sun.star.io.IOException e) + { + fail("Could not store to '" + url + "'"); + } + } + // close the doc + XCloseable xCloseable = UnoRuntime.queryInterface(XCloseable.class, xStorable); + try + { + xCloseable.close(true); + } + catch (com.sun.star.util.CloseVetoException e) + { + e.printStackTrace(); + fail("Cannot close document: test is futile, Office will surely use more space."); + } + } + else + { + System.out.println("Cannot query for XStorable interface on document '" + _sDocument + "'"); + System.out.println(" -> Skipping storage."); } - StringTokenizer aToken = new StringTokenizer(text); - // this works, because the output of pmap is quite standardized. - aToken.nextToken(); - String mem = aToken.nextToken(); - mem = mem.substring(0, mem.indexOf('K')); - Integer memory = new Integer(mem); - return memory.intValue(); + } - /** - * Write a script file and set its rights to rwxrwxrwx. - * @param fileName The name of the created file - * @param line The commandline that has to be written inside of the file. - */ - private void writeExecutableFile(String fileName, String line) { - try { - PrintWriter fWriter = new PrintWriter(new FileWriter(fileName)); - fWriter.println(bash); - fWriter.println(line); - fWriter.close(); - // change rights to rwxrwxrwx - ProcessHandler processID = new ProcessHandler(sChmod + fileName); +// ----------------------------------------------------------------------------- + private class OfficeMemchecker + { + + /** + * After called start() it contains the memory need at startup + */ + private int m_nMemoryStart; + /** + * After called stop() it contains the memory usage + */ + private int m_nMemoryUsage; + private String m_sDocumentName; + private String m_sExtension; + + public OfficeMemchecker() + { + m_nMemoryStart = 0; + } + + public void setDocumentName(String _sDocName) + { + m_sDocumentName = _sDocName; + } + + public void setExtension(String _sExt) + { + m_sExtension = _sExt; + } + + public void start() + { + m_nMemoryStart = getOfficeMemoryUsage(createModeName("start", 0)); + } + + private String createModeName(String _sSub, int _nCount) + { + StringBuffer aBuf = new StringBuffer(); + aBuf.append(_sSub); + aBuf.append('_').append(m_sDocumentName).append('_').append(m_sExtension); + aBuf.append('_').append(_nCount); + return aBuf.toString(); + } + + public void stop() + { + // short wait for the office to 'calm down' and free some memory + shortWait(20000); + // wait util memory is not freed anymore. + int storageAfter = getOfficeMemoryUsage(createModeName("stop", 0)); + int mem = 0; + int count = 0; + while (storageAfter != mem && count < 10) + { + count++; + mem = storageAfter; + storageAfter = getOfficeMemoryUsage(createModeName("stop", count)); + shortWait(1000); + } + m_nMemoryUsage = (storageAfter - m_nMemoryStart); + } + + public int getConsumMore() + { + return m_nMemoryUsage; + } + + /** + * Get the process ID from the Office + * @return the Id as String + */ + private String getOfficeProcessID() + { + String sProcessIdCommand = FileHelper.appendPath(m_aTempDir.getTempDir(), "getPS"); + final String sofficeArg = org.openoffice.test.Argument.get("soffice"); + final String sPSGrep = "ps -ef | grep $USER | grep <soffice>.bin | grep -v grep"; + final String sProcessId = sPSGrep.replaceAll("<soffice>", FileHelper.getJavaCompatibleFilename(sofficeArg)); + + createExecutableFile(sProcessIdCommand, sProcessId); + ProcessHandler processID = new ProcessHandler(sProcessIdCommand); + processID.noOutput(); + processID.executeSynchronously(); + String text = processID.getOutputText(); + if (text == null || text.equals("") || text.indexOf(' ') == -1) + { + fail("Could not determine Office process ID. Check " + sProcessIdCommand); + } + StringTokenizer aToken = new StringTokenizer(text); + // this is not nice, but ps gives the same output on every machine + aToken.nextToken(); + String id = aToken.nextToken(); + return id; + } + + /** + * Get the memory usage of the Office in KByte. + * @return The memory used by the Office. + */ + private int getOfficeMemoryUsage(String _sMode) + { + final String sMemoryMonitor = "pmap <processID> |tee <pmapoutputfile> | grep total"; + String sOfficeMemoryCommand = null; + sOfficeMemoryCommand = FileHelper.appendPath(m_aTempDir.getTempDir(), "getPmap"); + // sOfficeMemoryCommand = FileHelper.getJavaCompatibleFilename(sOfficeMemoryCommand); + String command = sMemoryMonitor.replaceAll("<processID>", getOfficeProcessID()); + String sPmapOutputFile = FileHelper.appendPath(m_aTempDir.getTempDir(), "pmap_" + _sMode + ".txt"); + command = command.replaceAll("<pmapoutputfile>", sPmapOutputFile); + createExecutableFile(sOfficeMemoryCommand, command); + + ProcessHandler processID = new ProcessHandler(sOfficeMemoryCommand); + processID.noOutput(); processID.executeSynchronously(); + int nError = processID.getExitCode(); + assertTrue("Execute of " + sOfficeMemoryCommand + " failed", nError == 0); + String text = processID.getOutputText(); + if (text == null || text.equals("") || text.indexOf(' ') == -1) + { + fail("Could not determine Office memory usage. Check " + sOfficeMemoryCommand); + } + StringTokenizer aToken = new StringTokenizer(text); + // this works, because the output of pmap is quite standardized. + aToken.nextToken(); + String mem = aToken.nextToken(); + mem = mem.substring(0, mem.indexOf('K')); + Integer memory = new Integer(mem); + return memory.intValue(); } - catch(java.io.IOException e) { + + /** + * Write a script file and set its rights to rwxrwxrwx. + * @param fileName The name of the created file + * @param line The commandline that has to be written inside of the file. + */ + private void createExecutableFile(String fileName, String line) + { + final String sChmod = "chmod a+x "; + final String bash = "#!/bin/bash"; + + try + { + String sFilename = FileHelper.getJavaCompatibleFilename(fileName); + PrintWriter fWriter = new PrintWriter(new FileWriter(sFilename)); + fWriter.println(bash); + fWriter.println(line); + fWriter.close(); + // change rights to rwxrwxrwx + ProcessHandler processID = new ProcessHandler(sChmod + sFilename); + processID.noOutput(); + processID.executeSynchronously(); + int nError = processID.getExitCode(); + assertTrue("chmod failed. ", nError == 0); + } + catch (java.io.IOException e) + { + } } } @@ -304,11 +540,15 @@ public class CheckMemoryUsage extends ComplexTestCase { * Let this thread sleep for some time * @param milliSeconds time to wait in milliseconds. */ - private void shortWait(int milliSeconds) { - try { + public static void shortWait(int milliSeconds) + { + System.out.println("Wait for: " + milliSeconds + "ms"); + try + { Thread.sleep(milliSeconds); } - catch(java.lang.InterruptedException e) { // ignore + catch (java.lang.InterruptedException e) + { // ignore } } @@ -316,15 +556,20 @@ public class CheckMemoryUsage extends ComplexTestCase { * Own file filter, will just return ok for all files that end with a given * suffix */ - private class FileFilter implements FilenameFilter { + private class FileFilter implements FilenameFilter + { + private String suffix = null; + /** * C'tor. * @param suffix The suffix each filename should end with. */ - public FileFilter(String suffix) { + public FileFilter(String suffix) + { this.suffix = suffix; } + /** * Returns true, if the name of the file has the suffix given to the * c'tor. @@ -332,9 +577,32 @@ public class CheckMemoryUsage extends ComplexTestCase { * @param file Not used. * @return True, if name ends with suffix. */ - public boolean accept(File file, String name) { + public boolean accept(File file, String name) + { return name.endsWith(suffix); } - }; + } + + private XMultiServiceFactory getMSF() + { + final XMultiServiceFactory xMSF1 = UnoRuntime.queryInterface(XMultiServiceFactory.class, connection.getComponentContext().getServiceManager()); + return xMSF1; + } + // setup and close connections + @BeforeClass + public static void setUpConnection() throws Exception + { + System.out.println("setUpConnection()"); + connection.setUp(); + } + + @AfterClass + public static void tearDownConnection() + throws InterruptedException, com.sun.star.uno.Exception + { + System.out.println("tearDownConnection()"); + connection.tearDown(); + } + private static final OfficeConnection connection = new OfficeConnection(); } |