Test Plan for UIMA Version 2.1

This page documents the planned testing for the 2.1 release.

Test Schedule

Testing is planned starting Jan 22, 2007, for approx. 2-4 weeks.

Date(s)	Task
January 22	Code Freeze, bug fixes only
February 9	End of test, start release vote
February 12	Start vote on general@incubator.a.o
February 16	Target release date

Test Focus Areas

Suggest drive this using Jira analysis

Licensing, Notices review
Integration of Semantic Search
Install verification for bin on XP and Linux
Migration of existing UIMA components

Documentation Review

Parcel out documentation for review.
List Jira issues that have corresponding Doc review needs,
built a table of them here and check off as review completed.

Topic	Who	% complete	Comments
conceptual overview	Ferrucci
faqs	Schor	100%	Small updates, added hyperlinks
glossary	Lally	90%	Sent email about definitions of UIMA and Apache UIMA
eclipse setup	Baessler	100%

annotator & AE Guide	Lally	95%	"Other Examples" section misplaced?
Artifacts, Sofas	Lally	100%
application Guide	Lally	100%
Cas Multiplier	Lally	100%
CPE	Lally	100%
Flow Controller	Lally	100%
Multiple Views	Lally	100%
XMI Emf	Lally	100%

cde	Schor	100%
cpe Gui	Lally	100%
CVD	Goetz	100%	It's not good, but I'm not willing to spend more time on it right now.
doc analyzer	Lally	100%
jcasgen	Schor	100%	screen shot replaced
annotation viewer	Lally	100%
pear installer	Kozakov
pear merger	Kozakov
Pear packager	Kozakov	100%

cas	Goetz	100%
jcas	Schor	100%
pear	Kozakov	100%
xmi	Lally	100%
javadocs	Lally	100%
component Descriptor	Lally	100%
CPE Descriptor	Cwiklik	100%

Documentation updates to do keyed to JIRA issues:

% Complete	Who	key	Title
		UIMA-220	Failure in XCasToCasDataSaxHandlerTest on Sun Java 1.4.2
		UIMA-217	actions creating new instances which are subtypes of AnnotationBase should set the sofa ref
		UIMA-216	Add getSupportedXCasVersions to Vinci Services
		UIMA-212	Turn on socket keepAlive in jVinci
		UIMA-201	Document limitations of XML parser packaged with Sun Java 1.4
100%	Schor	UIMA-184	Add getAnnotationIndex() to JCas API, impl via forwarding to CAS	Fixed many examples in docs
100%	Schor	UIMA-179	Need method JFSIndexRepository.getAllIndexedFS(type)	updated tutorial, JCas and CAS Ref
100%	Schor	UIMA-177	JCasGen should notify user when "type merging" has occurred	Docs updated
100%	Schor	UIMA-173	Create Default Bag Indexes when addFsToIndexes is called but no index has been defined for that type	Docs updated
		UIMA-171	Make CVD look-and-feel configurable
100%	Schor	UIMA-166	Change JCasGen to not generate DocumentAnnotation if the merged version = the base
100%	Schor	UIMA-165	Need JCAS fixes for DocumentatAnnotation and type merging	Done - see UIMA-177
100%	Schor	UIMA-155	add cas editor (tae) project	Sandbox described, no mention of specific projects
		UIMA-151	Add project for uima whitespace tokenizer implementation
		UIMA-146	UimacppAnalysisComponent doesn't support ResultSpecification
		UIMA-135	Remove Entity View mode from DocumentAnalyzer
		UIMA-134	Extend CasCopier to support multiple views
100%	Schor	UIMA-132	Provide better support for filenames with spaces in resource URL	Added Doc on URI, changed sample code to use it
100%	Schor	UIMA-127	Add conference/workshop section to web site	Added section to doc about web site
100%	Schor	UIMA-126	add news section to the website	Added section to doc about web site
		UIMA-125	Apache UIMA client should be able to communicate with IBM UIMA (1.x or 2.0) service
100%	Schor	UIMA-122	Sofa mapping should be removed from Vinci services	Scanned the docs, look ok
		UIMA-120	Logical Structure view of CAS: show view name in unexpanded form of CAS
		UIMA-118	Link to the UIMA draft specification research report
100%	Schor	UIMA-115	The TCAS class should be dropped	scanned docs for TCAS
		UIMA-112	Assembly should unpack into a directory
		UIMA-108	Vinci Transport using Binary CAS Serialization is not documented
		UIMA-95	add sandbox infrastructure
		UIMA-91	Remove/hide CAS Initializer Panel in CPE GUI?
100%	Schor	UIMA-90	Create eclipse run configurations for startVNS and startVinciService	updated docs
100%	Schor	UIMA-78	CPE descriptor should support URLs to reference components	Doc updated
100%	Schor	UIMA-77	CasToInlineXml fails for new primitive types	not in main docs
		UIMA-76	add new pear installer API to install a pear file easily out of an application
		UIMA-73	multi-threading documentation (tutorial) needs review/improvement
60%	Schor	UIMA-71	New v2 features missing from tutorial chapters	Docs updated, no examples updated (yet)
		UIMA-55	Descriptor validation not reporting an error if both configurationParameters and configurationGroups are defined
		UIMA-51	Add version number to XCAS (or maybe to CAS built-in typesystem?)
100%	Lally	UIMA-49	Migration tools from IBM UIMA to Apache UIMA	Schor checked docs
		UIMA-38	Document Analyzer doesn't provide a way to view feature values that are very long
100%	Schor	UIMA-36	Change descriptor XML namespaces from uima.watson.ibm.com to uima.apache.org	checked with scan
100%	Schor	UIMA-34	Vinci service deployment descriptor timeoutPeriod parameter does not work.	removed param from documentation
		UIMA-33	Do not use same timeout on GetMetadata as is used for Process
		UIMA-32	CPE GUI doesn't parse CPM_HOME variable
		UIMA-31	Document Analyzer doesn't save character encoding in preferences
		UIMA-30	Binary CAS Serialization is not documented
100%	Schor	UIMA-29	Can't call process twice on CPE	Doc updated
		UIMA-17	Do missing documentation parts
		UIMA-15	Semantic Search repackaging
		UIMA-10	Split JCas into interface and implementation
100%	Schor	UIMA-9	Remove support for xi:include

Test Scenarios, Descriptions, platforms, status

Component	Description	Who	% complete	Comments (incl platforms
source distr	See if Source can be built	Adam	100%	uima-2.1.0-RC2 Builds successfully on Windows and Linux.
bin distr	See if bin can be used by new user
semantic search integration	Verify documentation and operation of semantic search, verify integration	Adam	100%	uimaj-2.1.0-RC2 works with the semantic search pre-release that I have.
migration tool	Try migration, following documentation and using tool, with existing components	all		See UIMA_uimaj_Install_002. Also Marshall and Adam have tested this.
Component	Test case	Description	Tester	Platform	Test level name	% complete	Comments
Installation	UIMA_uimaj_Install_001	Installation verification testInstall release package on a clean machine, check if the path adjustment works correctly	All Michael Adam	Windows Linux	uimaj-2.1.0-002 uimaj-2.1.0-RC2	100% 100%	Sample path adjustment works fine for e.g. SOAP. Install package work on Windows and Linux. On Linux the script files are executable automatically. Path adjustment worked fine for me.
Installation	UIMA_uimaj_Install_002	Try migration, following documentation and using tool, with existing components	Thilo	Windows	uimaj-2.1.0-001	100%	Tested with existing annotator. Worked out of the box. A bit disconcerting as there is no feedback at all. See Marshall's Jira issue on that point.
CPM	UIMA_uimaj_CPM_001	Running a CPE with TAE in Local Deployment Mode	Adam	Windows Linux	uimaj-2.1.0-RC2	100%
CPM	UIMA_uimaj_CPM_002	Running a CPE with TAE in Remote Deployment Mode	Adam	Windows Linux	uimaj-2.1.0-RC2	100%
CPM	UIMA_uimaj_CPM_003	Runing a CPE with mixed deployment modes	Adam	Windows Linux	uimaj-2.1.0-RC2	100%
CPM	UIMA_uimaj_CPM_004	Introduce a TAE that crashes. Test CPM error handling options	Adam	Windows Linux	uimaj-2.1.0-RC2	100%
Core	UIMA_uimaj_Core_001	UIMA remoting with SOAP Test UIMA remote analysis engines using the SOAP protocol	Michael	Windows Linux	uimaj-2.1.0-002	100%	Adam: also ran simple SOAP service test on Windows, no problems.
Core	UIMA_uimaj_Core_002	UIMA remoting with Vinci Test UIMA remote analysis engines using the Vinci protocol	Michael	Windows Linux	uimaj-2.1.0-001	100%	Tested provided SDK samples von Windows and Linux
Core	UIMA_uimaj_Core_003	Run SofA primitive and aggregate analysis engines, run using CPE with CollectionReader, CasInitializer, CasConsumer. Test sofa mapping. Test sofa creation, defaulting, multi-sofa Cas operation. Run as simple aggregate, as well as CPE.	Adam	Windows Linux	uimaj-2.1.0-RC2	100%
Core	UIMA_uimaj_Core_004	Test CAS multiplier component	Michael	Windows Linux	uimaj-2.1.0-004	100%	Tested provided samples with DocumentAnalyzer. Issue UIMA-264 verified. Retested also with CVD. Now a better error message is provided.
Core	UIMA_uimaj_Core_005	Test UIMA custom flow using the FlowController	Michael	Windows Linux	uimaj-2.1.0-002	100%	Tested eclipse plugin to create a FlowController. Tested example WhiteboardFlow aggregate.
Tooling	UIMA_uimaj_Tooling_001	Test Cas Visual Debugger	Thilo	Windows	uimaj-2.1.0-001	100%	Put the CVD through its paces on Windows. Everything worked except displaying manual. Should be tested on other platform.
Tooling	UIMA_uimaj_Tooling_002	Test Document Analyzer	Adam	Windows Linux	uimaj-2.1.0-RC2	100%
Tooling	UIMA_uimaj_Tooling_003	Test Pear Installer	Adam	Windows Linux	uimaj-2.1.0-RC2	100%	Opened trivial UI issues UIMA-270 and UIMA-271
Tooling	UIMA_uimaj_Tooling_004	Test Pear Merger	Michael	Windows Linux	uimaj-2.1.0-004	100%	Tested the merging of two pear files and run it afterwards. script files does not work correctly since it has windows end of line characters in it. All script files retested on linux.
Tooling	UIMA_uimaj_Tooling_005	Test Annotation Viewer	Michael	Windows Linux	uimaj-2.1.0-003	100%
Tooling	UIMA_uimaj_Tooling_006	Test CPE Configurator	Adam	Windows Linux	uimaj-2.1.0-RC2	100%
EclipsePlugins	UIMA_uimaj_EclipsePlugins_001	Test CDE (Component Descriptor Editor)	Schor	Eclipse versions? 3.2	various	50%	Extensive running on WinXP and MacOS X, used in tutorial
EclipsePlugins	UIMA_uimaj_EclipsePlugins_002	Test JCasGen generation	Schor	Eclispe versions? 3.2	various	50%	Extensive running on WinXP and MacOS X, used in tutorial
EclipsePlugins	UIMA_uimaj_EclipsePlugins_003	Test Pear packager	Michael	Windows Eclipse 3.2	uimaj-2.1.0-003	100%	Adam: Ran it once (Windows, Eclipse 3.2.0) Seemed to work fine.
Examples	UIMA_uimaj_Examples_001	Test provided UIMA examples	Adam	Windows Linux	uimaj-2.1.0-RC2	100%	Tested UimaMeetingDetector, NamesAndPersonTitles, NamesAndGovernmentOfficials as part of Document Analyzer testing. Tested SofaExampleAnnotator as part of Sofa testing. Tested Flow Controller and CAS Multiplier Examples (also earlier tested by Michael). Tested CPE Descriptors.