subversion-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pbu...@apache.org
Subject svn commit: r1294189 - /subversion/trunk/subversion/tests/README
Date Mon, 27 Feb 2012 15:45:12 GMT
Author: pburba
Date: Mon Feb 27 15:45:12 2012
New Revision: 1294189

URL: http://svn.apache.org/viewvc?rev=1294189&view=rev
Log:
Recommend that all XFailing tests have an associated issue in the tracker.

* subversion/tests/README: A long overdue recommendation.  Prior to the
  release of 1.7.0 we agreed that XFailing tests should be associated with
  an issue, http://svn.haxx.se/dev/archive-2011-02/0026.shtml, so let's
  make it official.

Modified:
    subversion/trunk/subversion/tests/README

Modified: subversion/trunk/subversion/tests/README
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/tests/README?rev=1294189&r1=1294188&r2=1294189&view=diff
==============================================================================
--- subversion/trunk/subversion/tests/README (original)
+++ subversion/trunk/subversion/tests/README Mon Feb 27 15:45:12 2012
@@ -130,6 +130,47 @@ This same rule applies to Subversion dev
 bug, write a test for it. **
 
 
+When to file a related issue
+----------------------------
+
+By definition, if you write a new test which is set to XFail, then it
+assumed that the test is for a known bug.  In these cases it is
+recommended that you associate an issue in the issue tracker with the
+XFailing test.  This ensures that the issue tracker is the authoritative
+list of known bugs -- see http://subversion.tigris.org/issue-tracker.html.
+You may need to create a new issue if one doesn't already exist.
+
+For C tests simply add a comment noting any associated issue:
+
+    /* This is for issue #3234. */
+    static svn_error_t *
+    test_copy_crash(const svn_test_opts_t *opts,
+                    apr_pool_t *pool)
+    {
+      apr_array_header_t *sources;
+      svn_opt_revision_t rev;
+      .
+      .
+
+For Python tests use the @Issue() decorator (a summary comment of the
+issue never hurts either):
+
+    #---------------------------------------------------------------------
+    # Test for issue #3657 'dav update report handler in skelta mode can
+    # cause spurious conflicts'.
+    @Issue(3657)
+    @XFail()
+    def dav_skelta_mode_causes_spurious_conflicts(sbox):
+      "dav skelta mode can cause spurious conflicts"
+      .
+      .
+
+Of course it isn't *always* necessary to create an associated issue.
+If a the fix for an new XFailing test is imminent, you are probably
+better off simply fixing the bug and moving on.  Use common sense, but
+when in doubt associate a new issue.
+
+
 What not to test
 ----------------
 



Mime
View raw message