Difference between revisions of "API testing module"

From PC2wiki
Jump to: navigation, search
m (add section)
m (rewrote description)
Line 1: Line 1:
The API testing module is a reference and testing module for the pc2 [[API]].
+
The API testing module is a GUI reference and testing program which exclusively uses the pc2 [[API]].
  
 
==Startup Steps==
 
==Startup Steps==

Revision as of 11:11, 19 January 2013

The API testing module is a GUI reference and testing program which exclusively uses the pc2 API.

Startup Steps

Use the pc2tapi script to start the API testing module

The API testing module allows a user to login and will print the output of API methods. Upon login a List box will appear where all output will be listed/printed.

Components

  • Login button - login
  • Logoff button - logoff
  • View All Run Source - DO NOT USE THIS view all run's source code
  • View Runs Grid - opens a window with a Run grid (Site, Team Login, Id, Time, Status/Judgement, Problem, Language)
  • Print ALL - print all reports in the API Methods listbox
  • Standings - print standings
  • API Methods list box - a list of reports to select from
  • Run button - print output for selected reports in the API Methods list box
  • Site - (when logged in) a list of sites in the contest, used with Get Run and GetClarification
  • Get Run - print info about the local run in the Run/Clar number textbox
  • GetClarification - print info about the local clar in the Run/Clar number textbox
  • Listener checkboxes (turn on and off listeners output)
    • View Run Listener - when listener invoked print data
    • View Clar Listener - when listener invoked print data
    • View Config Listener - when listener invoked print data
    • View Connection Listener - when listener invoked print data
  • Exit Button

Usage

Use

pc2tapi --help 

To print this usage

Usage: [--help]  

Purpose: a API test frame 

--help    this message

Version 9.3 20130117 (Thursday, January 17th 2013 06:10 UTC) Java ver 1.6.0_22 build 2591 Windows 7 6.1 (x86)

See Also