jakarta-watchdog-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From a...@locus.apache.org
Subject cvs commit: jakarta-watchdog/doc design
Date Mon, 06 Mar 2000 23:36:17 GMT
arun        00/03/06 15:36:16

  Modified:    .        README
  Added:       doc      design
  Log:
  Added more documents.
  
  Revision  Changes    Path
  1.11      +6 -0      jakarta-watchdog/README
  
  Index: README
  ===================================================================
  RCS file: /home/cvs/jakarta-watchdog/README,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- README	2000/03/01 04:40:23	1.10
  +++ README	2000/03/06 23:36:14	1.11
  @@ -142,3 +142,9 @@
   You must, MUST do a `build clean;build` to make sure a clean
   workspace builds. Also, you must, MUST run the tests. All tests must
   pass before checking in the code. 
  +
  +Related Documents
  +-----------------
  +
  +Please read doc/design for further information on the Watchdog design overview.
  +For details on Ant, refer to http://jakarta.apache.org/ant/index.html
  
  
  
  1.1                  jakarta-watchdog/doc/design
  
  Index: design
  ===================================================================
  
  jakarta-watchdog 
  ================
    
  Watchdog overview
  -----------------
  
  Watchdog consists of various JSP and Servlet tests intended to validate
  JSP1.1 and Servlet2.2 API / specification. 
  
  There are two forms of test frameworks:
      - Generic clients: these follow jsp.xml format and are driven by GTest harness 
        This format is applicable to the tests which do not need complex result processing
        on the client side.
      - Specialized clients: these tests follow servlet.xml format and are driven by Moo harness

        This format should be used where complex processing of the results is required on
the 
        client side.
  
  
  Watchdog itself utilizes various other components:
      Ant (ant.jar)
      Moo (moo.jar)
      GTest (testdriver.jar)
  
  
  1. user invokes watchdog.bat or watchdog.sh
  
  2. watchdog.bat or watchdog.sh invoke ant with an xml file and a target in the xml as parameters
  
  3. ant parses the xml file and executes the specified target
  
  3. results are validated by the target either in the form of return codes or golden-files
or 
     combinations of both.
  
  
  Directory structure
  -------------------
  
                [jakarta-watchdog]
                        |
                       / \
                     /  |   \
                   /    |     \
                 /      |       \
               /        |         \
             /          |           \ 
           /            |             \
       build.xml      [doc]          [src]         
       build.bat                       |
       build.sh                       /|\           
                                    /  |  \          
                                  /    |    \
                                /      |      \
                              /        |        \
                            /|         |         |\
                          /  |         |         |  \
                        /    |         |         |    \
                      /      |         |         |      \
                   [conf]         [client]     [etc]    [server] 
                  jsp.xml              |      web.xml      | 
                  servlet.xml        [org]                 |
                                       |                 /   \
                                     [apacge]          /       \
                                       |             /           \
                                     [jckeck]     [jsp]        [WEB-INF]
                                       |         jsp-tests          |
                                     [jsp]                        / |  \
                                       |                        /   |    \
                                    [client]                  /     |      \
                                      / \               [classes] web.xml  [lib]
                                    /     \            ..servlets..        moo.jar
                              ...golden-files...
  
  How to Add new tests
  --------------------
  
  JSP Test
  --------
      - Server side of the test
        % cd jakarta-watchdog/src/server/jsp
        % mkdir your-test-dir
        % cd your-test-dir
        % cp ~ your-test-jsp.jsp  .
  
      - Client side of the test
        % cd jakarta-watchdog/src/conf
        % add your-test entry to either jsp.xml or servlet.xml
  
  Servlet Test
  --------
      - Server side of the test
        % cd jakarta-watchdog/src/server/WEB-INF/classes
        % mkdir your-test-dir
        % cd your-test-dir
        % cp ~ your-test-servlet.java  .
  
      - Client side of the test
        % cd jakarta-watchdog/src/conf
        % add your-test entry to either jsp.xml or servlet.xml
  
      - Edit web.xml for configuring servlet mappings
  
  
  
  
  

Mime
View raw message