GPLUNIT ; CCDCCR/GPL - Unit Testing Library; 5/07/08
        ;;0.1;CCDCCR;nopatch;noreleasedate
        W "This is a unit testing library",!
        W !
        Q
        ;
ZT(ZARY,BAT,TST) ; private routine to add a test case to the ZARY array
        ; ZARY IS PASSED BY REFERENCE
        ; BAT is a string identifying the test battery
        ; TST is a test which will evaluate to true or false
        ; I '$G(ZARY) D
        ; . S ZARY(0)=0 ; initially there are no elements
        ; W "GOT HERE LOADING "_TST,!
        N CNT ; count of array elements
        S CNT=ZARY(0) ; contains array count
        S CNT=CNT+1 ; increment count
        S ZARY(CNT)=TST ; put the test in the array
        I $D(ZARY(BAT))  D  ; NOT THE FIRST TEST IN BATTERY
        . N II ; TEMP FOR ENDING TEST IN BATTERY
        . S II=$P(ZARY(BAT),"^",2)
        . S $P(ZARY(BAT),"^",2)=II+1
        I '$D(ZARY(BAT))  D  ; FIRST TEST IN THIS BATTERY
        . S ZARY(BAT)=CNT_"^"_CNT ; FIRST AND LAST TESTS IN BATTERY
        . S ZARY("TESTS",BAT)="" ; PUT THE BATTERY IN THE TESTS INDEX
        S ZARY(0)=CNT ; update the array counter
        Q
        ;
ZLOAD(ZARY,ROUTINE)  ; load tests into ZARY which is passed by reference
       ; ZARY IS PASSED BY NAME
       ; ZARY = name of the root, closed array format (e.g., "^TMP($J)")
       ; ROUTINE = NAME OF THE ROUTINE - PASSED BY VALUE
       K @ZARY
       S @ZARY@(0)=0 ; initialize array count
       N LINE,LABEL,BODY
       N INTEST S INTEST=0 ; switch for in the test case section
       N SECTION S SECTION="[anonymous]" ; test case section
       ;
       N NUM F NUM=1:1 S LINE=$T(+NUM^@ROUTINE) Q:LINE=""  D
       . I LINE?." "1";;><TEST>".E S INTEST=1 ; entering test section
       . I LINE?." "1";;><TEMPLATE>".E S INTEST=1 ; entering TEMPLATE section
       . I LINE?." "1";;></TEST>".E S INTEST=0 ; leaving test section
       . I LINE?." "1";;></TEMPLATE>".E S INTEST=0 ; leaving TEMPLATE section
       . I INTEST  D  ; within the testing section
       . . I LINE?." "1";;><".E  D  ; section name found
       . . . S SECTION=$P($P(LINE,";;><",2),">",1) ; pull out name
       . . I LINE?." "1";;>>".E  D  ; test case found
       . . . D ZT(.@ZARY,SECTION,$P(LINE,";;>>",2)) ; put the test in the array
       S @ZARY@("ALL")="1"_"^"_@ZARY@(0) ; MAKE A BATTERY FOR ALL
       Q
       ;
ZTEST(ZARY,WHICH)   ; try out the tests using a passed array ZTEST
       N I,ZX,ZR,ZP
       S DEBUG=0
       I '$D(ZARY(WHICH))  D  ; TEST SECTION DOESN'T EXIST
       . W "ERROR -- TEST SECTION DOESN'T EXIST -> ",WHICH,!
       . Q ; EXIT
       N FIRST,LAST
       S FIRST=$P(ZARY(WHICH),"^",1)
       S LAST=$P(ZARY(WHICH),"^",2)
       F I=FIRST:1:LAST  D
       . I ZARY(I)?1">"1.E  D  ; NOT A TEST, JUST RUN THE STATEMENT
       . . S ZP=$E(ZARY(I),2,$L(ZARY(I)))
       . . ;  W ZP,!
       . . S ZX=ZP
       . . W "RUNNING: "_ZP
       . . X ZX
       . . W "..SUCCESS: ",WHICH,!
       . I ZARY(I)?1"?"1.E  D  ; THIS IS A TEST
       . . S ZP=$E(ZARY(I),2,$L(ZARY(I)))
       . . S ZX="S ZR="_ZP
       . . W "TRYING: "_ZP
       . . X ZX
       . . W $S(ZR=1:"..PASSED ",1:"..FAILED "),!
       . . I '$D(TPASSED) D  ; NOT INITIALIZED YET
       . . . S TPASSED=0 S TFAILED=0
       . . I ZR S TPASSED=TPASSED+1
       . . I 'ZR S TFAILED=TFAILED+1
       Q
       ;
TEST   ; RUN ALL THE TEST CASES
      N ZTMP
      D ZLOAD(.ZTMP)
      D ZTEST(.ZTMP,"ALL")
      W "PASSED: ",TPASSED,!
      W "FAILED: ",TFAILED,!
      W !
      W "THE TESTS!",!
      ZWR ZTMP
      Q
      ;
TLIST(ZARY) ; LIST ALL THE TESTS
     ; THEY ARE MARKED AS ;;><TESTNAME> IN THE TEST CASES
     ; ZARY IS PASSED BY REFERENCE
     N I,J,K S I="" S I=$O(ZARY("TESTS",I))
     S K=1
     F J=0:0  Q:I=""  D
     . ; W "I IS NOW=",I,!
     . W I," "
     . S I=$O(ZARY("TESTS",I))
     . S K=K+1 I K=6  D
     . . W !
     . . S K=1
     Q
     ;