2011-10-24T19:14:15Z

Bot: /* Documentation */

==Documentation==
The latest documentation exists in wiki format here: [[Doc:latest.]] Please help us improve our docs by editing these pages!
 
It also exists in static form here: [http://www.openclovis.org/doc]

==FAQ==

* [[Installation FAQ | Installation]]
* [[Building a model FAQ | Building a model]]
* [[Running ASP FAQ | Running ASP]]
* [[CLI commands (asp_console) FAQ | ASP CLI commands (asp_console)]]
* [[Command Line and environment variables FAQ | Command Line and environment variables]]
* [[TIPC Configuration]]
===ASP Components===
* [[Platform Management (PM), Platform Support Package (PSP), and Chassis Manager (CM)]]
* [[High Availability (AMF) Questions]]
* [[Logging Questions]]

===Runtime Troubleshooting===
* [[Process death]]

2011-10-24T19:07:19Z

Bot: 1 revision

=='''Preface'''==

''OpenClovis Test Automation Environment (TAE) User Guide'' provides information about the usage of OpenClovis TAE. TAE provides an infrastructure to allow comprehensive system and unit tests to be written and executed easily. It also contains a web-based test report server for permanent storage and retrieval of test reports. This guide helps you to utilize the OpenClovis TAE in your own environment.

OpenClovis TAE is designed to simplify and accelerate the testing of Telecom application software over OpenClovis platform. It also provides a simple and powerful mechanism to coordinate the activities of multiple blades of a chassis or multiple systems in a network.

===Audience===

OpenClovis TAE User Guide is designed for system integrators, developers, and testers. To use this OpenClovis product, you must be aware of the fundamentals of operation, management, and configuration of telecommunication and networking domains. You must also be familiar with Python programming, the OpenClovis SAFplus Platform product, and have a basic knowledge of Linux.

===Documentation Conventions===

This guide uses different fonts and symbols to differentiate between document elements and types of information. These conventions are summarized in the following table:

{| border="0" cellpadding="3"
|- style="color:#ffffff; background:#549cc6"
!style="color:#66b154; background:#09477c"| Notation
!style="color:#66b154; background:#09477c"| Description
|- style="color:#ffffff; background:#549cc6"
| style="color:black" | <code><pre>Code</pre></code>
| This font denotes the source code provided in various examples.
|- style="color:#ffffff; background:#549cc6"
|
Cross reference
|
This font denotes a hyper link. You can click on the hyper link text to access the reference location, which can be either a section within the User Guide or a URL link.
A cross reference refers to a section name accesses the first page of that section.
|- style="color:#ffffff; background:#549cc6"
|
'''Bold Text'''
|
Menu items and button names.
|- style="color:#ffffff; background:#549cc6"
|
''Italic Text''
|
Variables for which you enter values.
|}

 [[File:OpenClovis_Note.png]]This indicates the presence of notes or annotations, related to the context of the document.
 [[File:OpenClovis_Caution.png]]This indicates that certain precautionary measures must be taken before performing a particular task.
 [[File:OpenClovis_Info.png]]This indicates that additional information is provided to you.

===Related Documentation===

For additional information about OpenClovis products, refer to the following guides:
* '''OpenClovis Release Notes''' provides information about the software and the hardware required to install OpenClovis Application Service Platform (SAFplus Platform) and Integrated Development Environment (IDE). It contains the additional features and enhancements of the product since the previous release. It also summarizes the issues and limitations of the product and provides workarounds wherever applicable.
* '''OpenClovis SA Forum Compliance''' describes the level of compliance of OpenClovis SAFplus Platform and its Application Programming Interface (API) with the relevant Service Availability Forum Specifications.
* '''OpenClovis Installation Guide''' provides the system requirements, installation procedure for OpenClovis SAFplus Platform, IDE, and the Evaluation System.
* '''OpenClovis Sample Application Tutorial''' provides the steps to create and build a sample model using OpenClovis IDE and OpenClovis SAFplus Platform. It also provides troubleshooting information for this process. This provides the logical first step in understanding the OpenClovis offering.
* '''OpenClovis Evaluation System User Guide''' provides all the required information to configure and run the sample models packaged within the Evaluation System. This document also provides good understanding of OpenClovis SAFplus Platform's functionality. This is the natural follow on to the ''OpenClovis Sample Application Tutorial'' as it builds on the example created in that document.
* '''OpenClovis SDK User Guide''' provides information about OpenClovis Application Service Platform (SAFplus Platform) architecture, various OpenClovis SAFplus Platform components, and their interactions. This guide helps you to configure the OpenClovis SAFplus Platform components, compile, and execute the OpenClovis SAFplus Platform code to build your custom application.
* '''OpenClovis Log Tool User Guide''' provides information about the usage of OpenClovis Log Tool. OpenClovis Log Tool is an interactive utility that allows you to view binary log files in a readable format and hence monitor system errors, warnings, and other log information. Log Tool allows you to format the <code>.log</code> files and filter them to view the required entries.
* '''OpenClovis API Reference Guide''' is provided for each component. It describes the Application Programming Interface (API), Service Model, and Management Information Model of the various OpenClovis Application Service Platform (SAFplus Platform) services. It helps the developer to understand the capabilities of the SAFplus Platform services and the APIs provided by these services.
* '''OpenClovis SAFplus Platform Console Reference Guide''' provides details about managing applications built on OpenClovis SAFplus Platform using the SAFplus Platform runtime debug console commands. SAFplus Platform Console commands can be used to manage, monitor, and test your application.

For additional information about TurboGears, the web application mega-framework used by the OpenClovis SAFplus Platform Web Director please refer to:
* Turbogears web site at http://www.turbogears.org.

===OpenClovis Online Technical Support===

OpenClovis customers and partners can register on our Web site and receive personalized services and information. If you need any support or assistance while working on OpenClovis products, you can access the following: URL: http://www.openclovis.com. Send your queries to: support@openclovis.com. Open source community support is available at: http://www.openclovis.org/forum.

===Documentation Feedback===

We are interested in hearing from our customers on the documentation provided with the product. Let us know your comments and suggestions on improving the documentation at OpenClovis Inc. Send your comments to: support@openclovis.com. Post your feedback on documentation at: http://www.openclovis.org/forum.

Doc:Sdk 4.1/taeguide/overview

2011-10-24T19:07:18Z

Bot: 1 revision

== Organization ==

The TAE is organized following the [http://en.wikipedia.org/wiki/Matryoshka_doll Matryoshka principle] in that each facility requires all "smaller" facilities, yet any particular facility and all "smaller" facilities comprises a working automation environment (albeit missing the features provided by the "larger" facilities) and is useful in certain circumstances.

The purpose of this organization is most importantly to create an incremental development schedule that will yield a usable test framework rapidly and a fully-featured one when those features are required.

Another extremely important purpose is to allow the automation environment to be run in a variety of different situations and by a variety of different users. For example, it could be run by an automated nightly verification system (layer 3), or by a developer fixing a bug (layer 1,2). It could be run by an OpenClovis engineer (layer 1,2 or 3), or by a customer who is verifying compatibility with his hardware (layer 3).

Lastly, it is designed to allow programs written for a variety of purposes -- test, demo, eval, and real systems -- to be run. Traditionally automated test frameworks are so encompassing that the only software that can be run are test suites designed from the bottom-up to fit within the automated test framework. This framework allows software that was not written for the express purpose of testing to be annotated with compile-time optional tests (similar to assert()) that can be used to verify the correct execution of that software.

Each layer is summarized in this document and contains a link to a detailed design.

=== Layer 1: C program API (Clovis Test API) ===

The smallest layer is the API used in a program to run tests. This layer consists of a set of C macros that group and run tests. When not testing, these macros can be compiled out. This is very similar to unit testing packages found for many languages.

If this layer is run alone, it will simply print test successes and failures to the screen.

When run within the layer 3 framework, test successes and failures will be posted to the TAE report server.

=== Layer 2: Python based testing (using APIs provided by TAE)===

This is another layer to write test programs in python and run tests. Here the test program uses the rich set of APIs (written in python) present in the TAE infrastructure. This layer provides multiple utilities to run tests in a distributed environment.

If this layer is run alone, it will simply print test successes and failures to the screen.

When run within the layer 3 framework, test successes and failures will be posted to the TAE report server.
=== Layer 3: Test Execution Management and Event Simulation ===

The Test Execution Management and Event Simulation (TEMES) layer consists of a separate machine (test driver) that controls the test "fixture" (the set of machines that constitute a test environment). It is capable of taking software from either a local directory, a ftp site, an http site or from subversion repository, unpacking it (if needed), installing it on the fixture, compiling it, and running a series of tests.

These tests primarily constitute executable programs that use the Layer 1 and 2 APIs, and conform to a loose modeling format.

Additionally, a test-specific scripts may be run on the TEMES that can "drive" the progress of the test and cause events such as process, network, and machine failures.

If this layer is run alone, it will run through a complete test suite and report successes and failures.

=== Layer 4: Automated Run and Longitudinal Reports ===

The Automated Run and Longitudinal Reporting (ARLR) layer consists of a single globally accessible server (ARLR server) and a source repository (subversion etc). The ARLR server contains a web site that allows users to see which source code branches are failing which tests on what hardware and it keeps a history of this information. It also will communicate with unused (or layer 3 dedicated) test drivers to schedule runs of a set of test suites against a set of branches and receive results from these drivers.