Tue Apr 3 04:04:51 BST 2012 Brian Warner <warner@lothar.com>

  * Rename web CheckResults to -Renderer, to avoid confusion. Closes #1705.

  This avoids the name collision between the actual results
  objects (defined in allmydata.check_results) and the code that renders
  these objects into HTML (defined in allmydata.web.check_results). Only
  the web-side objects were renamed.

diff --git a/src/allmydata/test/test_checker.py b/src/allmydata/test/test_checker.py
index dd2bfb0521822f4728d14af38ac885a4e7a6b024..af0a091248593e3da8a9d15ea846029e4c2ccc98 100644 (file)
--- a/src/allmydata/test/test_checker.py
+++ b/src/allmydata/test/test_checker.py
@@ -45,7 +45,7 @@ class WebResultsRendering(unittest.TestCase, WebRenderingMixin):
 
     def test_literal(self):
         c = self.create_fake_client()
-        lcr = web_check_results.LiteralCheckResults(c)
+        lcr = web_check_results.LiteralCheckResultsRenderer(c)
 
         d = self.render1(lcr)
         def _check(html):
@@ -90,7 +90,7 @@ class WebResultsRendering(unittest.TestCase, WebRenderingMixin):
                  }
         cr.set_data(data)
 
-        w = web_check_results.CheckResults(c, cr)
+        w = web_check_results.CheckResultsRenderer(c, cr)
         html = self.render2(w)
         s = self.remove_tags(html)
         self.failUnlessIn("File Check Results for SI=2k6avp", s) # abbreviated
@@ -213,7 +213,7 @@ class WebResultsRendering(unittest.TestCase, WebRenderingMixin):
         crr.post_repair_results = post_cr
         crr.repair_attempted = False
 
-        w = web_check_results.CheckAndRepairResults(c, crr)
+        w = web_check_results.CheckAndRepairResultsRenderer(c, crr)
         html = self.render2(w)
         s = self.remove_tags(html)
 
@@ -268,7 +268,7 @@ class WebResultsRendering(unittest.TestCase, WebRenderingMixin):
             self.failUnlessEqual(j["post-repair-results"]["summary"], "worse")
         d.addCallback(_got_json)
 
-        w2 = web_check_results.CheckAndRepairResults(c, None)
+        w2 = web_check_results.CheckAndRepairResultsRenderer(c, None)
         d.addCallback(lambda ignored: self.render_json(w2))
         def _got_lit_results(data):
             j = simplejson.loads(data)

diff --git a/src/allmydata/web/check_results.py b/src/allmydata/web/check_results.py
index 82c0a779cb2cfd755bac3880de59722fc90466d5..39524a965a3ed473639f4f9e010e383e8668ecf4 100644 (file)
--- a/src/allmydata/web/check_results.py
+++ b/src/allmydata/web/check_results.py
@@ -185,7 +185,7 @@ class ResultsBase:
             target = target + "?output=%s" % output
         return T.a(href=target)[si_s]
 
-class LiteralCheckResults(rend.Page, ResultsBase):
+class LiteralCheckResultsRenderer(rend.Page, ResultsBase):
     docFactory = getxmlfile("literal-check-results.xhtml")
 
     def __init__(self, client):
@@ -226,7 +226,7 @@ class CheckerBase:
             return T.div[T.a(href=return_to)["Return to file/directory."]]
         return ""
 
-class CheckResults(CheckerBase, rend.Page, ResultsBase):
+class CheckResultsRenderer(CheckerBase, rend.Page, ResultsBase):
     docFactory = getxmlfile("check-results.xhtml")
 
     def __init__(self, client, results):
@@ -269,7 +269,7 @@ class CheckResults(CheckerBase, rend.Page, ResultsBase):
         cr = self._render_results(ctx, data)
         return ctx.tag[cr]
 
-class CheckAndRepairResults(CheckerBase, rend.Page, ResultsBase):
+class CheckAndRepairResultsRenderer(CheckerBase, rend.Page, ResultsBase):
     docFactory = getxmlfile("check-and-repair-results.xhtml")
 
     def __init__(self, client, results):
@@ -316,7 +316,7 @@ class CheckAndRepairResults(CheckerBase, rend.Page, ResultsBase):
         return ""
 
 
-class DeepCheckResults(rend.Page, ResultsBase, ReloadMixin):
+class DeepCheckResultsRenderer(rend.Page, ResultsBase, ReloadMixin):
     docFactory = getxmlfile("deep-check-results.xhtml")
 
     def __init__(self, client, monitor):
@@ -331,8 +331,8 @@ class DeepCheckResults(rend.Page, ResultsBase, ReloadMixin):
         si = base32.a2b(name)
         r = self.monitor.get_status()
         try:
-            return CheckResults(self.client,
-                                r.get_results_for_storage_index(si))
+            return CheckResultsRenderer(self.client,
+                                        r.get_results_for_storage_index(si))
         except KeyError:
             raise WebError("No detailed results for SI %s" % html.escape(name),
                            http.NOT_FOUND)
@@ -470,7 +470,7 @@ class DeepCheckResults(rend.Page, ResultsBase, ReloadMixin):
         runtime = time.time() - req.processing_started_timestamp
         return ctx.tag["runtime: %s seconds" % runtime]
 
-class DeepCheckAndRepairResults(rend.Page, ResultsBase, ReloadMixin):
+class DeepCheckAndRepairResultsRenderer(rend.Page, ResultsBase, ReloadMixin):
     docFactory = getxmlfile("deep-check-and-repair-results.xhtml")
 
     def __init__(self, client, monitor):
@@ -483,10 +483,10 @@ class DeepCheckAndRepairResults(rend.Page, ResultsBase, ReloadMixin):
         # /operation/$OPHANDLE/$STORAGEINDEX provides detailed information
         # about a specific file or directory that was checked
         si = base32.a2b(name)
-        r = self.monitor.get_status()
+        s = self.monitor.get_status()
         try:
-            return CheckAndRepairResults(self.client,
-                                         r.get_results_for_storage_index(si))
+            results = s.get_results_for_storage_index(si)
+            return CheckAndRepairResultsRenderer(self.client, results)
         except KeyError:
             raise WebError("No detailed results for SI %s" % html.escape(name),
                            http.NOT_FOUND)

diff --git a/src/allmydata/web/directory.py b/src/allmydata/web/directory.py
index f99e1d8d251e0f50a0290625951b491f5f258a64..ce424eac95bb7f9b4c61ed856274dd8fd1674641 100644 (file)
--- a/src/allmydata/web/directory.py
+++ b/src/allmydata/web/directory.py
@@ -28,9 +28,9 @@ from allmydata.web.common import text_plain, WebError, \
      get_format, get_mutable_type
 from allmydata.web.filenode import ReplaceMeMixin, \
      FileNodeHandler, PlaceHolderNodeHandler
-from allmydata.web.check_results import CheckResults, \
-     CheckAndRepairResults, DeepCheckResults, DeepCheckAndRepairResults, \
-     LiteralCheckResults
+from allmydata.web.check_results import CheckResultsRenderer, \
+     CheckAndRepairResultsRenderer, DeepCheckResultsRenderer, \
+     DeepCheckAndRepairResultsRenderer, LiteralCheckResultsRenderer
 from allmydata.web.info import MoreInfo
 from allmydata.web.operations import ReloadMixin
 from allmydata.web.check_results import json_check_results, \
@@ -392,7 +392,7 @@ class DirectoryNodeHandler(RenderMixin, rend.Page, ReplaceMeMixin):
     def _maybe_literal(self, res, Results_Class):
         if res:
             return Results_Class(self.client, res)
-        return LiteralCheckResults(self.client)
+        return LiteralCheckResultsRenderer(self.client)
 
     def _POST_check(self, req):
         # check this directory
@@ -401,10 +401,10 @@ class DirectoryNodeHandler(RenderMixin, rend.Page, ReplaceMeMixin):
         add_lease = boolean_of_arg(get_arg(req, "add-lease", "false"))
         if repair:
             d = self.node.check_and_repair(Monitor(), verify, add_lease)
-            d.addCallback(self._maybe_literal, CheckAndRepairResults)
+            d.addCallback(self._maybe_literal, CheckAndRepairResultsRenderer)
         else:
             d = self.node.check(Monitor(), verify, add_lease)
-            d.addCallback(self._maybe_literal, CheckResults)
+            d.addCallback(self._maybe_literal, CheckResultsRenderer)
         return d
 
     def _start_operation(self, monitor, renderer, ctx):
@@ -421,10 +421,10 @@ class DirectoryNodeHandler(RenderMixin, rend.Page, ReplaceMeMixin):
         add_lease = boolean_of_arg(get_arg(ctx, "add-lease", "false"))
         if repair:
             monitor = self.node.start_deep_check_and_repair(verify, add_lease)
-            renderer = DeepCheckAndRepairResults(self.client, monitor)
+            renderer = DeepCheckAndRepairResultsRenderer(self.client, monitor)
         else:
             monitor = self.node.start_deep_check(verify, add_lease)
-            renderer = DeepCheckResults(self.client, monitor)
+            renderer = DeepCheckResultsRenderer(self.client, monitor)
         return self._start_operation(monitor, renderer, ctx)
 
     def _POST_stream_deep_check(self, ctx):

diff --git a/src/allmydata/web/filenode.py b/src/allmydata/web/filenode.py
index 18ffe2df22a11b05c862e7e40082d75578ab3d94..fd7e7eb865dbc8183c6be9bbd7550a5459d58e92 100644 (file)
--- a/src/allmydata/web/filenode.py
+++ b/src/allmydata/web/filenode.py
@@ -19,8 +19,8 @@ from allmydata.web.common import text_plain, WebError, RenderMixin, \
      boolean_of_arg, get_arg, should_create_intermediate_directories, \
      MyExceptionHandler, parse_replace_arg, parse_offset_arg, \
      get_format, get_mutable_type
-from allmydata.web.check_results import CheckResults, \
-     CheckAndRepairResults, LiteralCheckResults
+from allmydata.web.check_results import CheckResultsRenderer, \
+     CheckAndRepairResultsRenderer, LiteralCheckResultsRenderer
 from allmydata.web.info import MoreInfo
 
 class ReplaceMeMixin:
@@ -285,7 +285,7 @@ class FileNodeHandler(RenderMixin, rend.Page, ReplaceMeMixin):
     def _maybe_literal(self, res, Results_Class):
         if res:
             return Results_Class(self.client, res)
-        return LiteralCheckResults(self.client)
+        return LiteralCheckResultsRenderer(self.client)
 
     def _POST_check(self, req):
         verify = boolean_of_arg(get_arg(req, "verify", "false"))
@@ -293,10 +293,10 @@ class FileNodeHandler(RenderMixin, rend.Page, ReplaceMeMixin):
         add_lease = boolean_of_arg(get_arg(req, "add-lease", "false"))
         if repair:
             d = self.node.check_and_repair(Monitor(), verify, add_lease)
-            d.addCallback(self._maybe_literal, CheckAndRepairResults)
+            d.addCallback(self._maybe_literal, CheckAndRepairResultsRenderer)
         else:
             d = self.node.check(Monitor(), verify, add_lease)
-            d.addCallback(self._maybe_literal, CheckResults)
+            d.addCallback(self._maybe_literal, CheckResultsRenderer)
         return d
 
     def render_DELETE(self, ctx):