INTEGRATION: CWS filtercfg (1.1.2); FILE ADDED

2004/01/19 12:27:47 cn 1.1.2.3: #102620# documentation anhanced
2004/01/06 16:17:29 cn 1.1.2.2: #102620# enhancements for various file types
2003/12/18 15:16:50 cn 1.1.2.1: #102620# initial version of typeDetection test

1 files changed, 529 insertions, 0 deletions

diff --git a/filter/qa/complex/filter/detection/typeDetection/TypeDetection.java b/filter/qa/complex/filter/detection/typeDetection/TypeDetection.java
new file mode 100644
index 000000000000..c7f7585112bb
--- /dev/null
+++ b/filter/qa/complex/filter/detection/typeDetection/TypeDetection.java
@@ -0,0 +1,529 @@
+/*************************************************************************
+ *
+ *  $RCSfile: TypeDetection.java,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Date: 2004-01-28 14:59:10 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+package complex.filter.detection.typeDetection;
+
+import com.sun.star.beans.PropertyValue;
+import com.sun.star.document.XTypeDetection;
+import com.sun.star.io.NotConnectedException;
+import com.sun.star.io.XInputStream;
+import com.sun.star.lang.XMultiServiceFactory;
+import com.sun.star.uno.UnoRuntime;
+import com.sun.star.uno.XInterface;
+import complexlib.ComplexTestCase;
+
+import java.util.Enumeration;
+import java.util.Hashtable;
+import java.util.Vector;
+import util.utils;
+
+
+
+/** Check "TypeDetection"
+ * <p>
+ * This test will check the file type detection. This will be done by filling
+ * properties of a <code>MediaDescriptor</code>.
+ *
+ * In the test method <code>checkByURLonly</code> the
+ * <code>MediaDescriptor</code> was filled at once with the URL of a test
+ * file. At second it was filled with a <code>XInputStream</code> from test
+ * file. In both subtests the returned file type must match with an expected
+ * type.
+ *
+ * In the test method <code>checkPreselectedType</code> the
+ * <code>MediaDescriptor</code> was filled with the URL of the test file and
+ * with the name of a type which should be used. The returned type of the
+ * <code>TypeDetection<code> must match with an expected type.
+ *
+ * In the test method <code>checkPreselectedFilter</code> the
+ * <code>MediaDescriptor</code> was filled with the URL of the test file and
+ * with the name of a filter which should be used. The returned type of the
+ * <code>TypeDetection<code> must match with an expected type.
+ *
+ * In the test method <code>checkPreselectedDocService</code> the
+ * <code>MediaDescriptor</code> was filled with the URL of the test file and
+ * with the name of a document service which should be used. The returned type
+ * of the <code>TypeDetection<code> must match with an expected type.
+ *
+ *
+ * To get information which test file should support which type, filter and
+ * document service, this information was collect from configuration files:
+ * <UL>
+ * <LI><a href="#TypeDetection.props">TypeDetection.props</a></LI>
+ * <LI><a href="#files.csv">files.csv</a></LI>
+ * <LI><a href="#preselectedFilter.csv">preselectedFilter.csv</a></LI>
+ * <LI><a href="#preselectedType.csv">preselectedType.csv</a></LI>
+ * <LI><a href="#serviceName.csv">serviceName.csv</a></LI>
+ * </UL>
+ * <p>
+ * <h3><A name="TypeDetection.props"></A>
+ * <code>typeDetection.props</code></h3>
+ * At fist there will be the <code>typeDetection.props</code>. Here the following
+ * properties should be set (with example values):
+ *
+ * TestDocumentPath=file:///path/to/my/testdocuments
+ * placeHolder=%
+ * %SO6productname=StarOffice
+ * %SO6formatversion=6.0
+ *
+ * <code>TestDocumentPath</code>: this is the path to your test documents. If
+ * you have grouped your documents ie. by writer, calc, ... then it should be
+ * the root path. To specify the particular sub folders you have to use
+ * <code>csv.files</code>
+ * <p>
+ * <code>files.csv</code>: In this file all test documents are listed.
+ * Syntax: fileAlias;fileURL;defaultURLFileType;StreamFileTypes
+ * Example:
+ *
+ * Writer6_1;Writer/Writer6.sxw;writer_StarOffice_XML_Writer;writer_StarOffice_XML_Writer
+ * text1;Writer/Text.txt;writer_Text_encoded:writer_Text;writer_Text_encoded:writer_Text
+ *
+ * The first example shows you the following:
+ * <code>Writer6_1</code> is a free chosen name
+ * <code>Writer/Writer6.sxw</code> is the document path. This will be assembled
+ * by <code>TestDocumentPath</code> from <code>typeDetection.props</code>.
+ * <code>writer_StarOffice_XML_Writer</code>: this is the default file type of
+ * this file
+ *
+ * The second example displays two document types for <code>XInputStream</CODE>
+ * (<code>writer_Text_encoded</CODE> and <code>writer_Text</CODE>. This two
+ * document types are listed by a colon ':' as separator. This is needed because
+ * XInputStream can detect a text file as writer_Text_encoded as well as
+ * writer_Text.
+ * <p>
+ *
+ * <H3><A name="preselectedFilter.csv"</a>
+ * <code>preselectedFilter.csv</code></H3>
+ * In this file you can choose a special
+ * filter to detect the document. This make sense ie. for csv-files: You can
+ * open csv files as Writer or as Calc. To check this case you have to specify
+ * in <code>csv.files</code> a fileAlias like ?csv_writer? and ?csv_calc? with
+ * the same fileURL and it's specific defaultFileType.
+ * The returned file type by <code>TypeDetection</code> must equal to
+ * correspond <code>defaultFileType</code> from <code>csv.files</code>
+ *
+ * Syntax: fileAlias;FilterName;FilterOptions;FilterData
+ * Example: Writer6_1;%SO6productname %SO6formatversion Textdokument;;
+ *
+ * The example shows the following:
+ * <code>Writer6_1</code> is the same as in <code>csv.files</code>
+ * <code>%SO6productname %SO6formatversion Textdokument</code> is the filter
+ * name which should be used. Here we have a special: <code>%SO6productname
+ * %SO6formatversion</code> will be replaced by the equals of
+ * <code>typeDetection.props</code>. The filter names depends on the Office
+ * name and version. So a future Office could called ?StarSuite 8?.
+ * <code>FilterOptions</code> is not relevant for this filter. But ie. for csv
+ * filter this entry could be used to specify the separator of the csv file.
+ * <code>FilterData<code> if filter needs some FilterData arguments you can
+ * specify it here
+ *
+ * <p>
+ * <H3><a name="preselectedType.csv"></A>
+ * <code>preselectedType.csv</code></H3>
+ * In this file you can preselect the type
+ * <code>TypeDetection</code> should use.
+ * The returned file type by <code>TypeDetection</code> must equal to the
+ * preselected file type.
+ * Note: If you try to use invalid types you will get a failed test because
+ * <code>TypeDetection</code> tries to find out the type itself.
+ *
+ * Syntax: fileAlias;fileType
+ * Example: Writer6_1;writer_StarOffice_XML_Writer
+ *
+ * This example shows the following:
+ * <code>Writer6_1</code> is the same as in <code>csv.files</code>
+ * <code>writer_StarOffice_XML_Writer</code> is the file type which was used as
+ * parameter in <code>MediaDescriptor</code>. This type must be returned from
+ * <code>TypeDetection</code>
+ *
+ * <p>
+ * <H3><a name="serviceName.csv"></A>
+ * <code>serviceName.csv</code></H3> In this file you can preselect a service name
+ * to detect the file type. The returned file type by
+ * <code>TypeDetection</code> must equal to correspond
+ * <code>defaultFileType</code> from <code>csv.files</code>
+ *
+ * Syntax: fileAlias;serviceName
+ * Example: Writer6_1;com.sun.star.text.FormatDetector
+ *
+ * This example shows the following:
+ * <code>Writer6_1</code> is the same as in <code>csv.files</code>
+ * <code>com.sun.star.text.FormatDetector</code> is the service name which was
+ * used as parameter in <code>MediaDescriptor</code>.
+ *
+ *
+ * <p>
+ * All these files will be copied by make file beside of
+ * <code>typeDetection.class</code>.
+ * @see com.sun.star.document.XTypeDetection
+ * @see com.sun.star.document.MediaDescriptor
+ */
+public class TypeDetection extends ComplexTestCase {
+
+    /**
+     * @member m_xDetection     the object to test
+     * @member helper           instacne of helper class
+     */
+
+    static XTypeDetection   m_xDetection;
+    static Helper helper = null;
+
+    /**
+     * A function to tell the framework, which test functions are available.
+     * @return All test methods.
+     */
+    public String[] getTestMethodNames() {
+        return new String[]{"checkByURLonly",
+                            "checkPreselectedType",
+                            "checkPreselectedFilter",
+                            "checkPreselectedDocService"};
+    }
+
+    /** Create the environment for following tests.
+     * Use either a component loader from desktop or
+     * from frame
+     * @throws Exception Exception
+     */
+    public void before() throws Exception {
+
+        // create TypeDetection
+        XMultiServiceFactory xMSF = (XMultiServiceFactory)param.getMSF();
+        assure("Could not get XMultiServiceFactory", xMSF != null);
+
+        Object oInterface = xMSF.createInstance(
+                                        "com.sun.star.document.TypeDetection");
+
+        if (oInterface == null) {
+            failed("Service wasn't created") ;
+        }
+
+        XInterface oObj = (XInterface) oInterface ;
+        log.println("ImplName: "+utils.getImplName(oObj));
+
+        m_xDetection = (XTypeDetection)
+                UnoRuntime.queryInterface(XTypeDetection.class, oInterface);
+
+        // create instrace of helper class
+        helper = new Helper(param, log);
+
+    }
+
+    /**
+     * close the environment
+     */
+    public void after() {
+    }
+
+    /**
+     * The <code>MediaDescriptor</code> was filled with the URL of a file. The
+     * <code>type</code> of the file is kown and must be returned by
+     * <code>MediaDescriptor</code>
+     *
+     * Syntax of files.csv:
+     * fileAlias;fileURL;fileType
+     *
+     */
+    public void checkByURLonly() {
+        try{
+            log.println("### checkByURLonly() ###");
+            Vector CSVData =  helper.getToDoList(
+                                    (String)param.get("csv.files"));
+            Enumeration allToDos = CSVData.elements();
+
+            while (allToDos.hasMoreElements()){
+                Vector toDo = (Vector) allToDos.nextElement();
+
+                String fileAlias = (String) toDo.get(0);
+                String fileURL  = (String) toDo.get(1);
+                String URLfileType = (String) toDo.get(2);
+                String StreamfileType = (String) toDo.get(3);
+
+                fileURL =  utils.getFullURL(helper.ensureEndingFileSep(
+                              (String)param.get("TestDocumentPath")) + fileURL);
+
+                log.println("actual '"+ fileAlias +
+                                        "' ['" + URLfileType + "']: '" + fileURL);
+
+                checkMediaDescriptorURL(fileAlias, fileURL, URLfileType);
+                checkMediaDescriptorXInputStream(fileAlias, fileURL, StreamfileType);
+            }
+
+        } catch (ClassCastException e){
+            failed(e.toString(), true);
+        }
+    }
+
+    /** To check the <CODE>TypeDedection</CODE> by URL the <CODE>MediaDescriptor</CODE>
+     * was filled at fist with the URL only, at second with <CODE>XInputStream</CODE>
+     * only. The <CODE>TypeDetection</CODE> must return the expected value
+     * @param fileAlias the alias name of the test file
+     * @param fileURL the URL of the test file
+     * @param fileType the expected type of the test file
+     * @see com.sun.star.document.MediaDescriptor
+     */
+    private void checkMediaDescriptorURL(
+                            String fileAlias, String fileURL, String fileType){
+
+        PropertyValue[] MediaDescriptor = helper.createMediaDescriptor(
+            new String[] {"URL"},
+            new Object[] {fileURL});
+            log.println("check only by URL...");
+
+            String type = m_xDetection.queryTypeByDescriptor(
+                               helper.createInOutPropertyValue(MediaDescriptor), true);
+
+            boolean fileTypeOK = helper.checkFileType(type, fileType);
+
+            assure("\nURL-test         : " + fileAlias + ":\n\treturned type: '" + type +
+                   "'\n\texpected type: '" + fileType + "'",fileTypeOK ,true);
+    }
+
+    /** Filles a MediaDescriptor with a <code>XInputStream</code> of the test
+     * file given by URL.
+     * Then the MediaDescriptor was used as parameter for TypeDetection.
+     * The TypeDetection must return expected type
+     * @param fileAlias the alias name of the test file
+     * @param fileURL the URL of the test file
+     * @param fileType the expected type of the test file
+     * @see com.sun.star.document.MediaDescriptor
+     * @see com.sun.star.io.XInputStream
+     */
+    private void checkMediaDescriptorXInputStream(
+                             String fileAlias, String fileURL, String fileType){
+
+        XInputStream xStream = null;
+
+        try{
+            xStream = helper.getFileStream( fileURL );
+        } catch (NotConnectedException e) {
+            failed("Could not get XInputStream from file :'" + fileURL + "'",true);
+            return;
+        }
+
+        PropertyValue[] MediaDescriptor = helper.createMediaDescriptor(
+            new String[] {"InputStream"},
+            new Object[] {xStream});
+            log.println("check only by XInputStream...");
+
+            String type = m_xDetection.queryTypeByDescriptor(
+                               helper.createInOutPropertyValue(MediaDescriptor), true);
+
+            boolean fileTypeOK = helper.checkFileType(type, fileType);
+
+            assure("\nXInputStream-test: " + fileAlias + ":\n\treturned type: '" + type +
+                   "'\n\texpected type: '" + fileType + "'", fileTypeOK, true);
+
+    }
+
+    /**
+     * The <code>MediaDescriptor</code> was filled with the URL of a file. The
+     * <code>type</code> of the file is kown and must be returned by
+     * <code>MediaDescriptor</code>
+     *
+     * Syntax of files.csv:
+     * fileAlias;fileURL;fileType
+     *
+     */
+    public void checkPreselectedType() {
+        try{
+            log.println("### checkPreselectedType() ###");
+
+            Vector CSVData =  helper.getToDoList(
+                                    (String)param.get("csv.preselectedType"));
+            Enumeration allToDos = CSVData.elements();
+
+            while (allToDos.hasMoreElements()){
+                try{
+                    Vector toDo = (Vector) allToDos.nextElement();
+
+                    String fileAlias = (String) toDo.get(0);
+                    String fileURL  = helper.getURLforfileAlias(fileAlias);
+                    String preselectFileType = (String) toDo.get(1);
+                    String expectedFileType = (String) toDo.get(2);
+
+                    PropertyValue[] MediaDescriptor = helper.createMediaDescriptor(
+                        new String[] {"URL", "MediaType"},
+                        new Object[] {fileURL, preselectFileType});
+                    log.println("check '" + fileAlias + "' with MediaType: '" +
+                                preselectFileType + "'");
+
+                    String type = m_xDetection.queryTypeByDescriptor(
+                                   helper.createInOutPropertyValue(MediaDescriptor), true);
+
+                    boolean fileTypeOK = helper.checkFileType(type, expectedFileType);
+
+                    assure("\n" + fileAlias + ":\n\treturned type: '" + type +
+                                    "'\n\texpected type: '" + expectedFileType + "'",
+                                    fileTypeOK, true);
+
+                    } catch (FileAliasNotFoundException e){
+                        failed(e.toString(),true);
+                    }
+
+            }
+
+        } catch (ClassCastException e){
+            failed(e.toString(), true);
+        }
+    }
+
+
+    /**
+     * Check loading from a stream. The source for the stream is the
+     * first fileAlias that matches "*.txt" in the file list
+     * of the given directory.
+     */
+    public void checkPreselectedFilter() {
+        try{
+            log.println("### checkPreselectedFilter() ###");
+
+            Vector CSVData =  helper.getToDoList(
+                                    (String)param.get("csv.preselectedFilter"));
+
+            Enumeration allToDos = CSVData.elements();
+
+            while (allToDos.hasMoreElements()){
+                try{
+                    Vector toDo = (Vector) allToDos.nextElement();
+
+                    String fileAlias = (String) toDo.get(0);
+                    String fileURL  = helper.getURLforfileAlias(fileAlias);
+                    String filterName = (String) toDo.get(1);
+                    String filterOptions = (String) toDo.get(2);
+                    String filterData = (String) toDo.get(3);
+                    String expectedType = (String) toDo.get(4);
+
+                    PropertyValue[] MediaDescriptor = helper.createMediaDescriptor(
+                        new String[] {"URL","FilterName",
+                                                  "FilterOptions","FilterData"},
+                        new Object[] {fileURL, filterName,
+                                                   filterOptions, filterData});
+
+                    log.println("check '" + fileAlias + "' with filter: '" +
+                                filterName + "'");
+
+                    String type = m_xDetection.queryTypeByDescriptor(
+                               helper.createInOutPropertyValue(MediaDescriptor), true);
+
+                    boolean fileTypeOK = helper.checkFileType(type, expectedType);
+
+                    assure("\n" + fileAlias + ":\n\treturned type: '" + type +
+                                    "'\n\texpected type: '" + expectedType + "'",
+                                    fileTypeOK,true);
+
+                } catch (FileAliasNotFoundException e){
+                    failed(e.toString(),true);
+                }
+
+            }
+
+        } catch (ClassCastException e){
+            failed(e.toString(), true);
+        }
+    }
+
+    /**
+     * Check URL encoding. The first fileAlias that matches "*.sxw"
+     * is used as source for several encodings.
+     */
+     public void checkPreselectedDocService() {
+        try{
+            log.println("### checkPreselectedDocService() ###");
+
+            Vector CSVData =  helper.getToDoList((String)param.get("csv.serviceName"));
+            Enumeration allToDos = CSVData.elements();
+
+            while (allToDos.hasMoreElements()){
+                try{
+                    Vector toDo = (Vector) allToDos.nextElement();
+
+                    String fileAlias = (String) toDo.get(0);
+                    String fileURL  = helper.getURLforfileAlias(fileAlias);
+                    String serviceName = (String) toDo.get(1);
+                    String fileType = helper.getTypeforfileAlias(fileAlias);
+
+                    PropertyValue[] MediaDescriptor = helper.createMediaDescriptor(
+                        new String[] {"URL", "DocumentSerivce"},
+                        new Object[] {fileURL, serviceName});
+                    log.println("check " + fileAlias);
+
+                    String type = m_xDetection.queryTypeByDescriptor(
+                                   helper.createInOutPropertyValue(MediaDescriptor), true);
+
+                    boolean fileTypeOK = helper.checkFileType(type, fileType);
+
+                    assure("\n" + fileAlias + ":\n\treturned type: '" + type +
+                                    "'\t\nexpected type: '" + fileType + "'",
+                                    fileTypeOK, true);
+
+                } catch (FileAliasNotFoundException e){
+                    failed(e.toString(),true);
+                }
+
+            }
+
+        } catch (ClassCastException e){
+            failed(e.toString(), true);
+        }
+     }
+
+
+}
\ No newline at end of file