Menu
▾
▴
[tslogparser-CVS] tslogparser USAGE,NONE,1.1 HISTORY,1.13,1.14 INSTALL,1.3,1.4
|
From: Sebastien D. <sde...@us...> - 2005-01-12 14:00:15
|
Update of /cvsroot/tslogparser/tslogparser In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27717 Modified Files: HISTORY INSTALL Added Files: USAGE Log Message: Documentation update --- NEW FILE: USAGE --- This file contains the usage directives for the tslogparser tool (light User's manual / collection of HOWTO's) It contains the following sections: 1: Enter a testsuite in the database. 2: Enter new results in the database. 3: Explore existing logs 4: Browse and filter a logfile 5: Compare logs 6: For more... --------------------- 1 - Enter a test suite in the database ----------------------- You need at this point a working installation of the tslogparser tool. See INSTALL file if you don't have it yet. We'll suppose in the rest of this file that your installation is accessible from http://localhost/tslogparser/ You may change this to fit your own setup. -> In case you're not using tslogparser on localhost, you need to upload the testsuite files on the server filesystem. We'll suppose that the server can access your testsuite files from /home/test/posixtestsuite-1.5.0 WARNING: archived testsuite is not supported yet; you need a plain testsuite package. -> Point your browser to the admin interface: http://localhost/tslogparser/admin/ You should see a table with the list of supported testsuites formats (Module) and the releases already present in the database. You can click the "About" button to get more information about each module. NOTE: In case there is no module for the testsuite you want to parse, you may check the tslogparser.sourceforge.net website for user contributed modules and write your own module (use the tslogparser mailing list for more information / support). -> Click the "Add new testsuite version" button corresponding to the correct module for the testsuite you're wanting to enter. -> A new array will appear with the current module as a reminder, and then several fields. New release name : Enter a short text describing your release (eg. "Release 1.5.0") New release description: You can give detailed information on the testsuite, such as the date, the origin, patchs, etc... Path to new release : Enter the path on the filesystem to the testsuite files (eg. "/home/test/posixtestsuite-1.5.0") -> Click "Send" when you're ready. The tool will parse the testsuite and tell you the errors/warnings/informations on the next page. Once it is finished, you can see your new release appeared on the administration page. --------------------- 2 - Enter new results in the database ----------------------- Here we are assuming that you've run a testsuite which release is already in the database. If it is not the case, please see previous section to let tslogparser learn the testsuite release. Your run has generated a log file ('logfile' in OPTS). -> Go to the administration interface http://localhost/tslogparser/admin/ -> Look for the testsuite release corresponding to your run, and then push the "Add New Logfile" button of this release. -> You get a new table showing a reminder of the current module and TS release, then you are asked to enter the following informations: New Run Name : Enter a short text describing your run (eg. "Fresh Fedora Core 3") New Release Description: Enter all the information related to this run, as for example the command line options, kernel patchs, ... Log file : Browse to your log file and select it. The compression is not supported yet, so be sure to provide clear plain-text file. -> Press "Send" when you are done. This will upload your logfile to the server, then the file is parsed, information is displayed on the next page and if successful the result is inserted in the database. The uploaded file is destroyed each time so in case of error you'll have to upload again. You should see the new run appear in the administration interface and be able to browse inside it (see next section). --------------------- 3 - Explore existing logs ----------------------- To be able to browse results, you'll have to enter them in the database. Refer to previous sections for more informations. -> Open your browser to the tslogparser root. http://localhost/tslogparser/ This should redirect you automatically to the run-browse.php page. You can of course have a different index.php with a link to the run-browse.php file. -> (optionnal) If your database contains runs froms several modules (for example opts, ltp, nfs, ...) you'll have to choose which results you want to browse. There is no point in comparing different testsuites releases. -> Now you can see a list of testsuite releases and runs. -> Click "browse" to enter the detail of a particular run. -> Check the boxes of several runs and then click "Compare selected" at the bottom to compare several runs. In the current version, only runs from the same TS release can be compared -- this may change in future releases. --------------------- 4 - Browse and filter a logfile ----------------------- When you click "browse" from the run-browse.pgp page, you enter the log browser interface. See previous section(s) if you cannot see a "browse" button. The browser interface contains several parts: (*) The commands toolbar at the top: Reload: Push this to reload the page, in case something went wrong at load time. (your browser 'Reload' facility may bother with POST data re-posting) Show logs / Hide logs: This will include each test log in the current page display. When the logs are hidden, the "(log)" indicator is happened to the test case status to signal when a log message is available. When the logs are shown, an additionnal column in the table contains the log text when available. Show assertions / Hide assertions: This will display the assertion text which is tested by the corresponding testcase on the page. When hidden, you can always access this information by entering the test details. (*) The Statistics and filter table. This table shows the list of status which are present in the logfile. For each status, it gives the number of testcases which returned this status (for example 4 tests PASSED, 2 tests FAILED, ...). Show / Hide : push this putton will show or hide the corresponding tests from the table. This can be used for example to hide PASSED tests, or to filter only the compilation failures, or whatever... When you open the page, the default is to hide all PASSED and SKIP tests and show everything else. (*) The results. The table below shows the tests status list, testcase names, status, optionaly logs and assertions. You can click on a testcase status to get a full summary of this testcase result. --------------------- 5 - Compare logs ----------------------- From the browser page (http://localhost/tslogparser/) in case you have several runs in a given TS release (or module in future versions) you are able to check some runs and push the "Compare selected" button. There is no limitation on the number of selectable runs, but the machine memory. I would suggest not to compare more than 3 runs but you just try and see your limitation. Once you push "Compare Selected", you enter in the log comparator module. This module is very similar to the log browser, with small changes: (*)Command toolbar: Reload: reloads the page. Show / Hide common results: Choose whether testcases with identical results should be shown on the page. Show / Hide assertions: Tested assertion text is displayed or not on the page. (*) Statistics: For each test status, the number of testcases returning this status for each run is shown. In the current version no filtering command is available here. (*) The table. As in log browser mode, the table then shows for each testcase and each runs the status and a link to detailed test information. -------------------------------- 6 - For more... ------------------------------------ This usefull script is in beta version yet, your help and comments are precious! The right place to discuss this product is the mailing list: tsl...@li... (subscribe at http://lists.sourceforge.net/lists/listinfo/tslogparser-discuss) You can also directly contact the author: seb...@ex... Index: INSTALL =================================================================== RCS file: /cvsroot/tslogparser/tslogparser/INSTALL,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- INSTALL 10 Jan 2005 18:09:51 -0000 1.3 +++ INSTALL 12 Jan 2005 14:00:00 -0000 1.4 @@ -1,16 +1,64 @@ -Steps to set up: +This file describes the process for installing the tslogparser tool. -@@ STEP 1: Installation of the scripts. +It contains the following sections: +1. Copy the files +2. Set up the database server +3. Configure tslogparser +4. Initial database creation --> Copy all the files with the directory structure to - a directory accessible from your web server (with PHP - execution rights). --> Edit the db_inc.php file, enter the following information: +---------------------- STEP 1: Copy the files. ------------------------------- + +-> Put the tslogparser files in a suitable directory for your setup. + For example: + cd /opt + mkdir tslogparser + + cd + tar zxvf tslogparser*.tar.gz + cd tslogparser* + + cp -R * /opt/tslogparser + +-> Then make this directory accessible from your web server. + cd /var/www/html + ln -s /opt/tslogparser + +-> Check your web server can access the files. + Open http://localhost/tslogparser/INSTALL in a web browser. + You may need extra set-up to allow for PHP files execution. + Check your webserver configuration file. + + + +------------------- STEP 2: Set up the database server. ------------------------- + +You need a working MySQL installation here. +You can execute the following commands from the command line client or +from a GUI such as PhpMyAdmin. + +In case you're not root on the database server, you can just use your +login and database names for the tslogparser tool. + +-> Create a new user 'tslogparser' + GRANT USAGE ON *.* TO tslogparser@localhost IDENTIFIED BY 'secret'; + +-> Create a new database 'tslogparser' + CREATE DATABASE `tslogparser` ; + +-> Give rights on the database to the user + GRANT SELECT , INSERT , UPDATE , DELETE , CREATE , DROP , INDEX , ALTER ON tslogparser.* TO tslogparser@localhost; + + + + +------------------ STEP 3: Configure tslogparser -------------------------------- + +-> Edit the file db_inc.php with your database configuration information: (*) server name or IP. (*) user name (*) user password - (*) database name -- this database must already exist. + (*) database name. Example of such a file: $ cat > db_inc.php <<EOF @@ -18,99 +66,31 @@ // Database server name or IP: $db_server="localhost"; // Database name: -$db="site"; +$db="tslogparser"; // Database user login: -$db_user="apache"; +$db_user="tslogparser"; // Database password: -$db_pw="apache"; +$db_pw="secret"; ?> EOF NOTE: You may put this file anywhere for security reasons; just - let the file database.inc.php know where it is. - --> Point your browser to http://<your.server>/<your/path>/admin/upgrade.php - then follow the instruction to create the tables. - --> The initial database is empty. You may go to - http://<your.server>/<your/path>/admin/ - to start entering your test suite releases and runs (see below). - - -@@ STEP 2: Putting your results in the database. - -As a prerequisite, we'll suppose you have run the Open POSIX TestSuite -several times and collected the 'logfile' results in separate files -("logfile1", "logfile2", ...) - -All the described operations are done from the admin/index.php page. - --> Make the system know about your testsuite. - The first step is to provide the system with the description of your - testsuite. - Check that there is an installed module corresponding to your testsuite. - We'll take the Open POSIX Test Suite as an example (module 'opts'). - To see information about a module, you can click the "about" button. - - Next to your desired module, there is an "Add New Testsuite Version" - button. Push it. - - The page asks for several descriptive information -- enter anything - you like, but I'd suggest to put explicit naming convention and description. - exemple: - Name: Release1.5.0 - Desc: This is the official release from ... - - The latest field asks for the directory name where your posixtestsuite is. - Please note this is the path on you WEB SERVER FILESYSTEM. - The script does not support uploading of files; so you'll have to upload - you files on the webserver, and then provide the path to it, e.g.: - /var/uploaded/posixtestsuite - Please note that you must provide path to an uncompressed archive. - - Once you validate; you should see a log message telling what has been - processed and what has been ignored. Some testcases are excluded as they've - no matching assertion -- this is a bug in OPTS, it may be fixed later. - Below, you can see the array with your new release added. - - --> Next step is to let the system know about your runs (logfiles). - Next to your new release, you can see an "Add New Logfile" button. - Push it. - - From this screen, you get a reminder of the module and testsuite, - then you can enter a name and a description for your run. - As previously, i'd suggest to give as detailed information as possible, e.g.: - Name: BOS-ia32-latest(20041119) - Desc: Run in BullOpenSource, on dual-i686 box, with kernel 2.6.9 - and NPTL 2004/11/19, gcc 3.4.2. See details at http://... - - You then have to choose your logfile. The compression is not supported yet, - so be sure to provide clear plain-text file. The file will be uploaded, - then parsed and destroyed. There is no backup of the data but in the database. + let the file database.inc.php know where it is located, and + make sure that your web server process can access it (user apache). - By pushing Send, you should see some processing and then a log result - telling how many tests were added to the database. It is normal to see - some tests ignored (those which have no corresponding assertion). -@@ STEP 3: Use your results. - - -> Just open your browser to the script root. You'll be redirected to - the run-browse.php file. From this page you can explore your results, - get statistics, and compare several runs. - +------------------- STEP 4: Initial database creation ------------------------ +-> Open the admin/upgrade.php file from your web client. + for example: + http://localhost/tslogparser/admin/upgrade.php + Follow the instructions to create the database tables. -@@ STEP 4: Provide feedback and improvements. -This usefull script is in beta version yet, -your help and comments are precious! -The right place to discuss this product is the mailing list: -ts...@li... -(subscribe at http://lists.sourceforge.net/lists/listinfo/tslogparser-discuss) - -You can also directly contact the author: seb...@ex... +------------------- STEP 5: You're ready :) ----------------------------------- -@@ STEP 5: Enjoy :) +The tslogparser is now installed. You may start adding new testsuites and logs +from the admin interface (http://localhost/tslogparser/admin/). See USAGE file +for more information. Index: HISTORY =================================================================== RCS file: /cvsroot/tslogparser/tslogparser/HISTORY,v retrieving revision 1.13 retrieving revision 1.14 diff -u -d -r1.13 -r1.14 --- HISTORY 11 Jan 2005 11:08:33 -0000 1.13 +++ HISTORY 12 Jan 2005 14:00:00 -0000 1.14 @@ -1,3 +1,7 @@ +2005-01-12: +- Update INSTALL file according to Bryce's recommandations. +- New file: USAGE. + 2005-01-11: tag v03 - Update run browser to support modules and new administration interface. |
