API Tests |
Introduction
This document provides a list of header files, by module, that need API tests. At this time we are working on the sal module. However, once a set of API tests for the sal module is completed, we will add other UDK modules (e.g. vos, cppu, etc.) to this URL.
If you want to help out, please put your name in the "Responsible Engineer" column in the table below before starting any work. If you do not have commit priviledges to the CVS tree, please post your updates to the dev@udk.openoffice.org mailing list so that we can update this URL for you.
Building and running the API test tool
The API test tool is a command line tool called testshl. Although the testshl command is not built as part of the OpenOffice.org build, you can build it manually by executing the following commands:
cd $SRC_ROOT ; cvs -d `cat sal/CVS/Root` co -D "05/22/2001" sal solenv/inc/unxsols3.mk cd $SRC_ROOT ; cvs -d `cat sal/CVS/Root` co -A sal/inc/rtl/tres.hxx cd $SRC_ROOT ; cvs -d `cat sal/CVS/Root` co -A sal/tests cd $SRC_ROOT ; cvs -d `cat sal/CVS/Root` co -A testshl cd $SRC_ROOT/sal ; dmake -u ; deliver cd $SRC_ROOT/testshl/util ; dmake -u cd $SRC_ROOT/testshl/src ; dmake -u ; deliver
The testshl command takes 2 arguments: a shared library containing your test functions and a text file that lists the names of those test functions (an *.sce file). The source files for your test functions, the *.sce file, and the makfile.mk file that builds your shared library is normally put in a "tests" subdirectory of each module. For example, in the sal module, there is a sal/tests subdirectory. If you are implementing tests for a new module, you should create a "tests" subdirectory for that module and use the makefile.mk and *.sce files in sal/tests as a template.
Once you have successfully built the testshl command, you can build and execute your test functions by executing the following commands:
cd $SRC_ROOT/(module-name)/tests ; dmake -u testshl $SRC_ROOT/(module-name)/$INPATH/lib/(test-library-name) $SRC_ROOT/(module-name)/tests/sce/(sce-name)
For example, to execute the test functions in sal/tests, you would execute the following commands:
cd $SRC_ROOT/sal/tests ; dmake -u testshl $SRC_ROOT/sal/$INPATH/lib/librtl_apitest.so $SRC_ROOT/sal/tests/sce/rtl_apitest.sce testshl $SRC_ROOT/sal/$INPATH/lib/libosl_apitest.so $SRC_ROOT/sal/tests/sce/osl_apitest.sce
Module: sal
| Header File | Responsible Engineer | API Test Source File | Status |
|---|---|---|---|
| sal/inc/osl/conditn.hxx | gene.anaya@sun.com | osl_apitest_conditn.cxx | Implemented 7/11/2001 |
| sal/inc/osl/conditn.h | gene.anaya@sun.com | osl_apitest_conditn.cxx | Implemented 7/11/2001 |
| sal/inc/osl/diagnose.h | gene.anaya@sun.com | osl_apitest_diagnose.cxx | Implemented 7/11/2001 |
| sal/inc/osl/endian.h | |||
| sal/inc/osl/file.h | gene.anaya@sun.com | osl_apitest_file.cxx | Implemented 7/27/2001 |
| sal/inc/osl/file.hxx | gene.anaya@sun.com | osl_apitest_file.cxx | Mostly Implemented 7/27/2001 |
| sal/inc/osl/interlck.h | gene.anaya@sun.com | osl_apitest_interlck.cxx | Implemented 7/11/2001 |
| sal/inc/osl/module.h | |||
| sal/inc/osl/module.hxx | |||
| sal/inc/osl/mutex.h | gene.anaya@sun.com | osl_apitest_mutex.cxx | Implemented 07/11/2001 |
| sal/inc/osl/mutex.hxx | gene.anaya@sun.com | osl_apitest_mutex.cxx | Mostly Implemented |
| sal/inc/osl/nlsupport.h | gene.anaya@sun.com | osl_apitest_nlsupport.cxx | Implemented 7/11/2001 |
| sal/inc/osl/pipe.hxx | gene.anaya@sun.com | osl_apitest_pipe.cxx | Mostly Implemented |
| sal/inc/osl/pipe.h | gene.anaya@sun.com | osl_apitest_pipe.cxx | Mostly Implemented |
| sal/inc/osl/pipe_decl.hxx | gene.anaya@sun.com | osl_apitest_pipe.cxx | see pipe.hxx |
| sal/inc/osl/process.h | |||
| sal/inc/osl/profile.h | gene.anaya@sun.com | osl_apitest_profile.cxx | Implemented 7/14/2001 |
| sal/inc/osl/profile.hxx | gene.anaya@sun.com | osl_apitest_profile.cxx | Implemented 7/14/2001 |
| sal/inc/osl/security.h | |||
| sal/inc/osl/security.hxx | |||
| sal/inc/osl/security_decl.hxx | |||
| sal/inc/osl/semaphor.h | |||
| sal/inc/osl/semaphor.hxx | |||
| sal/inc/osl/signal.h | |||
| sal/inc/osl/socket.h | |||
| sal/inc/osl/socket.hxx | |||
| sal/inc/osl/socket_decl.hxx | |||
| sal/inc/osl/thread.h | |||
| sal/inc/osl/thread.hxx | |||
| sal/inc/osl/time.h | gene.anaya@sun.com | osl_apitest_time.cxx | Implemented 7/11/2001 |
| sal/inc/osl/util.h | gene.anaya@sun.com | osl_apitest_util.cxx | Implemented 7/11/2001 |
| sal/inc/rtl/byteseq.hxx | |||
| sal/inc/rtl/alloc.h | |||
| sal/inc/rtl/byteseq.h | |||
| sal/inc/rtl/cipher.h | |||
| sal/inc/rtl/crc.h | |||
| sal/inc/rtl/digest.h | |||
| sal/inc/rtl/locale.h | |||
| sal/inc/rtl/locale.hxx | |||
| sal/inc/rtl/memory.h | |||
| sal/inc/rtl/process.h | |||
| sal/inc/rtl/random.h | |||
| sal/inc/rtl/ref.hxx | |||
| sal/inc/rtl/strbuf.h | babak.mahbod@sun.com | rtl_StringBuffer.cxx | In Development |
| sal/inc/rtl/strbuf.hxx | babak.mahbod@sun.com | rtl_OStringBuffer.cxx | In Development |
| sal/inc/rtl/string.h | babak.mahbod@sun.com | rtl_String.cxx | In Development |
| sal/inc/rtl/string.hxx | babak.mahbod@sun.com | rtl_OString.cxx | Last Update 07/27/01 |
| sal/inc/rtl/tencinfo.h | |||
| sal/inc/rtl/textcvt.h | |||
| sal/inc/rtl/textenc.h | |||
| sal/inc/rtl/tres.hxx | |||
| sal/inc/rtl/uri.h | |||
| sal/inc/rtl/uri.hxx | |||
| sal/inc/rtl/ustrbuf.h | babak.mahbod@sun.com | rtl_UStringBuffer.cxx | In Development |
| sal/inc/rtl/ustrbuf.hxx | babak.mahbod@sun.com | rtl_OUStringBuffer.cxx | In Development |
| sal/inc/rtl/uuid.h | |||
| sal/inc/rtl/ustring.h | babak.mahbod@sun.com | rtl_UString.cxx | In Development |
| sal/inc/rtl/ustring.hxx | babak.mahbod@sun.com | rtl_OUString.cxx | Last Update 07/27/01 |
| sal/inc/rtl/ustring.tmp | |||
| sal/inc/rtl/bootstrap.h | |||
| sal/inc/rtl/bootstrap.hxx | |||
| sal/inc/rtl/unload.h | |||
| sal/inc/sal/config.h | |||
| sal/inc/sal/macros.h | |||
| sal/inc/sal/main.h | |||
| sal/inc/sal/types.h |
