Home Specs Ideas Testing About
You are here: CSS Working Group Wiki » Testing » Design Notes for a Test Review System

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
test:review-system [2008/11/03 20:24] – fantasaitest:review-system [2008/11/10 15:07] – fantasai
Line 1: Line 1:
-====== Requirements for a Test Review System ======+====== Design Notes for a Test Review System ======
  
 See also [[http://lists.w3.org/Archives/Public/public-css-testsuite/2008Apr/0025.html|outline of a CSS test suite review system]] and [[http://wiki.csswg.org/test/css2.1/review|Review Process Documentation]]. See also [[http://lists.w3.org/Archives/Public/public-css-testsuite/2008Apr/0025.html|outline of a CSS test suite review system]] and [[http://wiki.csswg.org/test/css2.1/review|Review Process Documentation]].
  
-  * Check off X tests and give them all the same comment +===== Expected Workflow =====
-  * Find test by ID, URL, title, etc. +
-  * Handle renaming of test +
-  * Track changes in same stream as comments (every subversion checkin adds a comment pointing to diff and new version) +
-  * Track status of test (needs review, needs work, etc) +
-  * Accept comments +
-  * Be test suite aware (which test belongs to which test suite); note that a test may belong to multiple test suites +
-  * Opt-in to hear comments on tests you reviewed (and accepted but second-level review found problems with?) +
-  * Easy to set up an account +
-  * Bulk submit preserving folder structure +
-  * Should work on all browsers+
  
-====== Workflow ====== +==== Workflow for Test Author ====
- +
-===== Workflow for Test Author =====+
  
   - Author identifies an assertion to test   - Author identifies an assertion to test
Line 31: Line 19:
   - Author receives acknowledgement that tests have been accepted and checked in   - Author receives acknowledgement that tests have been accepted and checked in
  
-===== Workflow for Reviewer =====+==== Workflow for Reviewer ====
  
   - If the Reviewer has 'Owner' or 'Peer' status (see [[/test/css2.1/review]]), the Reviewer searches the submittal data base for tests in the 'Accepted' state; if not, or if no 'Accepted' tests were found, Reviewer searches the submittal data base for tests in the 'Resubmitted' or 'Submitted' state and selects a test to review.  (He or she cannot review his or her own tests.)    - If the Reviewer has 'Owner' or 'Peer' status (see [[/test/css2.1/review]]), the Reviewer searches the submittal data base for tests in the 'Accepted' state; if not, or if no 'Accepted' tests were found, Reviewer searches the submittal data base for tests in the 'Resubmitted' or 'Submitted' state and selects a test to review.  (He or she cannot review his or her own tests.) 
Line 41: Line 29:
   - Otherwise, Reviewer enters comments explaining what changes need to be made and sets the status to 'NeedsWork'. (If the Reviewer has the Author's permission to make changes directly, the Reviewer may also change the test as necessary.  In this case, the status is set to 'Resubmitted' and someone else, possibly the Author, must review.)    - Otherwise, Reviewer enters comments explaining what changes need to be made and sets the status to 'NeedsWork'. (If the Reviewer has the Author's permission to make changes directly, the Reviewer may also change the test as necessary.  In this case, the status is set to 'Resubmitted' and someone else, possibly the Author, must review.) 
  
-===== Workflow for Approver =====+==== Workflow for Approver ====
  
   - Approver searches the submission database for tests in the 'Accepted' state.   - Approver searches the submission database for tests in the 'Accepted' state.
Line 47: Line 35:
   - Approver may suggest a new filename for checkin.   - Approver may suggest a new filename for checkin.
  
-===== Workflow for CVS Monkey =====+==== Workflow for CVS Monkey ====
  
   - If the test is now in the 'Approved' state, anyone with write access may now check it into the W3C CSS Test database, renaming the file as appropriate, and setting the status to 'CheckedIn'.   - If the test is now in the 'Approved' state, anyone with write access may now check it into the W3C CSS Test database, renaming the file as appropriate, and setting the status to 'CheckedIn'.
 +
 +===== Feature Requirements =====
 +
 +  * Check off X tests and give them all the same comment
 +  * Find test by ID, URL, title, etc.
 +  * Handle renaming of test
 +  * Track changes in same stream as comments (every subversion checkin adds a comment pointing to diff and new version)
 +  * Track status of test (needs review, needs work, etc)
 +  * Accept comments
 +  * Be test suite aware (which test belongs to which test suite); note that a test may belong to multiple test suites
 +  * Opt-in to hear comments on tests you reviewed (and accepted but second-level review found problems with?)
 +  * Easy to set up an account
 +  * Bulk submit preserving folder structure
 +  * Should work on all browsers
 +  * Unified login with wiki and Subversion
 +
 +===== Backend Design Notes =====
 +
 +A major design principle is to integrate with Subversion so that changes in SVN get automatically reported to the review system. Another is to take advantage of the tests' metadata so that as much information as possible will be automatically pulled from the test source.
 +
 +==== Database Tables ====
 +
 +
 +
 +  test suite
 +    suite short name
 +    suite full name
 +    url prefix
 +  
 +  tests
 +    id #
 +    testID (filename without extension) - should be unique (error if not)
 +    path in svn 
 +    metadata (from test file)
 +      author(s)        name + url
 +      help link(s)     url to spec
 +      title            string (unique)
 +      assertion        string (unique)
 +      flags            tokens
 +    status           - add "invalid (wrong)"
 +    checked-in       binary flag
 +    current revision?
 +    owner (username) initial value is from initial checkin
 +  
 +  comments
 +    id (of test)
 +    date
 +    comment
 +    commenter (username)
 +    validation script result (enum)
 +    revision at time of comment
 +    status change
 +    commenter name (if anon user)
 +  
 +  svn status (tracking what happened in svn)
 +    id
 +    committer svn username
 +    rev
 +    date
 +    comment
 +    commit type (update, copy, delete)
 +  
 +    - need to track svn renames
 +  
 +  
 +  user (drupal)
 +    username
 +    email
 +    realname
 +    role (svn access)
 +
 +==== UI Pages ====
 +
 +=== full report for one test ===
 +
 +  * meta data presented at top
 +  * merged list of comments / changes (link to diff) sorted by date
 +  * logged in user may change status and comment
 +  * anonymous user may make a comment, filling out either a name field or filling out username+pass to log in (like on LiveJournal)
 +
 +=== generic query interface ===
 +
 +  * list by status
 +  * search on assertion, title, testid, author, help link, who commented
 +
 +=== query results/review UI ===
 +
 +  * batch review, list tests, link to test, checkbox, review
 +  * list title, assertion, link to test, link to full report
 +  * only peers can approve
 +  * flag tests with revisions since last comment
 +
 +=== interface to rename/move test files ===
 +
 +  * Should allow substring matching to rename/move multiple files
 +
 +==== URL Scheme ====
 +
 +  * review/test/id
 +  * review/contributor/{username}/{named-query}
 +  * review/query[/{named-query}]
 +  * review/author/{name-substring}/{named-query}
 +  * (query based on test suite)
 +  * review/suite/{shortname}/{named-query}
 +
 +==== For Later ====
 +
 +  * generate email on comment or commit, submitter, reviewer (all commenters since last status change)
 +  * profile page to edit user data & email prefs
 +  * handling of tests in checked-in state: In this system,
 +      * Approved state requires checked-in.
 +      * Switching status to Approved automatically moves test to approved dir and marks as checked in
 +      * And so if you search Approved status, it searches approved directory
 +      * You can mark an Approved test as NeedsWork or Wrong: this svn copies it into the submitted directory and tracks it there. It keeps its checked-in status so we know this is high priority as it's live. Once re-approved, it gets svn copied back into the approved directory, overwriting the old.
 +      * Tests never lose their checked-in status unless they're deleted from the test suite
  
 
test/review-system.txt · Last modified: 2014/12/09 15:48 by 127.0.0.1
Recent changes RSS feed Valid XHTML 1.0 Valid CSS Driven by DokuWiki