From 91077f084d321b9e475cb81c4f49089d8803147d Mon Sep 17 00:00:00 2001
From: Daira Hopwood <daira@jacaranda.org>
Date: Sun, 17 Aug 2014 15:32:17 +0100
Subject: [PATCH] test_runner: rename *_FILE variables to lowercase, because
 they are not constants.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
---
 src/allmydata/test/test_runner.py | 101 +++++++++++++++---------------
 1 file changed, 52 insertions(+), 49 deletions(-)

diff --git a/src/allmydata/test/test_runner.py b/src/allmydata/test/test_runner.py
index bfb59f7c..713d1b06 100644
--- a/src/allmydata/test/test_runner.py
+++ b/src/allmydata/test/test_runner.py
@@ -357,14 +357,15 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
 
     def test_introducer(self):
         self.skip_if_cannot_daemonize()
+
         basedir = self.workdir("test_introducer")
         c1 = os.path.join(basedir, "c1")
         exit_trigger_file = os.path.join(c1, Client.EXIT_TRIGGER_FILE)
-        TWISTD_PID_FILE = os.path.join(c1, "twistd.pid")
-        INTRODUCER_FURL_FILE = os.path.join(c1, "private", "introducer.furl")
-        PORTNUM_FILE = os.path.join(c1, "introducer.port")
-        NODE_URL_FILE = os.path.join(c1, "node.url")
-        CONFIG_FILE = os.path.join(c1, "tahoe.cfg")
+        twistd_pid_file = os.path.join(c1, "twistd.pid")
+        introducer_furl_file = os.path.join(c1, "private", "introducer.furl")
+        portnum_file = os.path.join(c1, "introducer.port")
+        node_url_file = os.path.join(c1, "node.url")
+        config_file = os.path.join(c1, "tahoe.cfg")
 
         d = self.run_bintahoe(["--quiet", "create-introducer", "--basedir", c1])
         def _cb(res):
@@ -373,9 +374,9 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
 
             # This makes sure that node.url is written, which allows us to
             # detect when the introducer restarts in _node_has_restarted below.
-            config = fileutil.read(CONFIG_FILE)
+            config = fileutil.read(config_file)
             self.failUnlessIn('\nweb.port = \n', config)
-            fileutil.write(CONFIG_FILE, config.replace('\nweb.port = \n', '\nweb.port = 0\n'))
+            fileutil.write(config_file, config.replace('\nweb.port = \n', '\nweb.port = 0\n'))
 
             # by writing this file, we get ten seconds before the node will
             # exit. This insures that even if the test fails (and the 'stop'
@@ -408,22 +409,22 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
         d.addCallback(_cb2)
 
         def _node_has_started():
-            return os.path.exists(INTRODUCER_FURL_FILE)
+            return os.path.exists(introducer_furl_file)
         d.addCallback(lambda res: self.poll(_node_has_started))
 
         def _started(res):
             # read the introducer.furl and introducer.port files so we can
             # check that their contents don't change on restart
-            self.furl = fileutil.read(INTRODUCER_FURL_FILE)
-            self.failUnless(os.path.exists(PORTNUM_FILE))
-            self.portnum = fileutil.read(PORTNUM_FILE)
+            self.furl = fileutil.read(introducer_furl_file)
+            self.failUnless(os.path.exists(portnum_file))
+            self.portnum = fileutil.read(portnum_file)
 
             fileutil.write(exit_trigger_file, "")
-            self.failUnless(os.path.exists(TWISTD_PID_FILE))
-            self.failUnless(os.path.exists(NODE_URL_FILE))
+            self.failUnless(os.path.exists(twistd_pid_file))
+            self.failUnless(os.path.exists(node_url_file))
 
             # rm this so we can detect when the second incarnation is ready
-            os.unlink(NODE_URL_FILE)
+            os.unlink(node_url_file)
             return self.run_bintahoe(["--quiet", "restart", c1])
         d.addCallback(_started)
 
@@ -436,25 +437,25 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
             # self.failUnlessEqual(err, "", errstr) # See test_client_no_noise -- for now we ignore noise.
         d.addCallback(_then)
 
-        # again, the second incarnation of the node might not be ready yet,
-        # so poll until it is. This time INTRODUCER_FURL_FILE already
-        # exists, so we check for the existence of NODE_URL_FILE instead.
+        # Again, the second incarnation of the node might not be ready yet,
+        # so poll until it is. This time introducer_furl_file already
+        # exists, so we check for the existence of node_url_file instead.
         def _node_has_restarted():
-            return os.path.exists(NODE_URL_FILE) and os.path.exists(PORTNUM_FILE)
+            return os.path.exists(node_url_file) and os.path.exists(portnum_file)
         d.addCallback(lambda res: self.poll(_node_has_restarted))
 
         def _check_same_furl_and_port(res):
-            self.failUnless(os.path.exists(INTRODUCER_FURL_FILE))
-            self.failUnlessEqual(self.furl, fileutil.read(INTRODUCER_FURL_FILE))
-            self.failUnlessEqual(self.portnum, fileutil.read(PORTNUM_FILE))
+            self.failUnless(os.path.exists(introducer_furl_file))
+            self.failUnlessEqual(self.furl, fileutil.read(introducer_furl_file))
+            self.failUnlessEqual(self.portnum, fileutil.read(portnum_file))
         d.addCallback(_check_same_furl_and_port)
 
-        # now we can kill it. TODO: On a slow machine, the node might kill
+        # Now we can kill it. TODO: On a slow machine, the node might kill
         # itself before we get a chance to, especially if spawning the
         # 'tahoe stop' command takes a while.
         def _stop(res):
             fileutil.write(exit_trigger_file, "")
-            self.failUnless(os.path.exists(TWISTD_PID_FILE))
+            self.failUnless(os.path.exists(twistd_pid_file))
 
             return self.run_bintahoe(["--quiet", "stop", c1])
         d.addCallback(_stop)
@@ -470,7 +471,7 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
             # the parent was supposed to poll and wait until it sees
             # twistd.pid go away before it exits, so twistd.pid should be
             # gone by now.
-            self.failIf(os.path.exists(TWISTD_PID_FILE))
+            self.failIf(os.path.exists(twistd_pid_file))
         d.addCallback(_after_stopping)
         d.addBoth(self._remove, exit_trigger_file)
         return d
@@ -484,8 +485,8 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
         basedir = self.workdir("test_client_no_noise")
         c1 = os.path.join(basedir, "c1")
         exit_trigger_file = os.path.join(c1, Client.EXIT_TRIGGER_FILE)
-        TWISTD_PID_FILE = os.path.join(c1, "twistd.pid")
-        PORTNUM_FILE = os.path.join(c1, "client.port")
+        twistd_pid_file = os.path.join(c1, "twistd.pid")
+        portnum_file = os.path.join(c1, "client.port")
 
         d = self.run_bintahoe(["--quiet", "create-client", "--basedir", c1, "--webport", "0"])
         def _cb(res):
@@ -528,14 +529,15 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
         d.addCallback(_cb2)
 
         def _node_has_started():
-            return os.path.exists(PORTNUM_FILE)
+            return os.path.exists(portnum_file)
         d.addCallback(lambda res: self.poll(_node_has_started))
 
         # now we can kill it. TODO: On a slow machine, the node might kill
         # itself before we get a chance to, especially if spawning the
         # 'tahoe stop' command takes a while.
         def _stop(res):
-            self.failUnless(os.path.exists(TWISTD_PID_FILE), (TWISTD_PID_FILE, os.listdir(os.path.dirname(TWISTD_PID_FILE))))
+            self.failUnless(os.path.exists(twistd_pid_file),
+                            (twistd_pid_file, os.listdir(os.path.dirname(twistd_pid_file))))
             return self.run_bintahoe(["--quiet", "stop", c1])
         d.addCallback(_stop)
         d.addBoth(self._remove, exit_trigger_file)
@@ -543,13 +545,14 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
 
     def test_client(self):
         self.skip_if_cannot_daemonize()
+
         basedir = self.workdir("test_client")
         c1 = os.path.join(basedir, "c1")
         exit_trigger_file = os.path.join(c1, Client.EXIT_TRIGGER_FILE)
-        TWISTD_PID_FILE = os.path.join(c1, "twistd.pid")
-        PORTNUM_FILE = os.path.join(c1, "client.port")
-        NODE_URL_FILE = os.path.join(c1, "node.url")
-        CONFIG_FILE = os.path.join(c1, "tahoe.cfg")
+        twistd_pid_file = os.path.join(c1, "twistd.pid")
+        portnum_file = os.path.join(c1, "client.port")
+        node_url_file = os.path.join(c1, "node.url")
+        config_file = os.path.join(c1, "tahoe.cfg")
 
         d = self.run_bintahoe(["--quiet", "create-node", "--basedir", c1, "--webport", "0"])
         def _cb(res):
@@ -557,7 +560,7 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
             self.failUnlessEqual(rc_or_sig, 0)
 
             # Check that the --webport option worked.
-            config = fileutil.read(CONFIG_FILE)
+            config = fileutil.read(config_file)
             self.failUnlessIn('\nweb.port = 0\n', config)
 
             # By writing this file, we get two minutes before the client will exit. This ensures
@@ -591,19 +594,19 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
 
         def _node_has_started():
             # this depends upon both files being created atomically
-            return os.path.exists(NODE_URL_FILE) and os.path.exists(PORTNUM_FILE)
+            return os.path.exists(node_url_file) and os.path.exists(portnum_file)
         d.addCallback(lambda res: self.poll(_node_has_started))
 
         def _started(res):
             # read the client.port file so we can check that its contents
             # don't change on restart
-            self.portnum = fileutil.read(PORTNUM_FILE)
+            self.portnum = fileutil.read(portnum_file)
 
             fileutil.write(exit_trigger_file, "")
-            self.failUnless(os.path.exists(TWISTD_PID_FILE))
+            self.failUnless(os.path.exists(twistd_pid_file))
 
             # rm this so we can detect when the second incarnation is ready
-            os.unlink(NODE_URL_FILE)
+            os.unlink(node_url_file)
             return self.run_bintahoe(["--quiet", "restart", c1])
         d.addCallback(_started)
 
@@ -622,7 +625,7 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
         d.addCallback(lambda res: self.poll(_node_has_started))
 
         def _check_same_port(res):
-            self.failUnlessEqual(self.portnum, fileutil.read(PORTNUM_FILE))
+            self.failUnlessEqual(self.portnum, fileutil.read(portnum_file))
         d.addCallback(_check_same_port)
 
         # now we can kill it. TODO: On a slow machine, the node might kill
@@ -630,9 +633,8 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
         # 'tahoe stop' command takes a while.
         def _stop(res):
             fileutil.write(exit_trigger_file, "")
-            self.failUnless(os.path.exists(TWISTD_PID_FILE),
-                            (TWISTD_PID_FILE,
-                             os.listdir(os.path.dirname(TWISTD_PID_FILE))))
+            self.failUnless(os.path.exists(twistd_pid_file),
+                            (twistd_pid_file, os.listdir(os.path.dirname(twistd_pid_file))))
             return self.run_bintahoe(["--quiet", "stop", c1])
         d.addCallback(_stop)
 
@@ -648,7 +650,7 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
             # the parent was supposed to poll and wait until it sees
             # twistd.pid go away before it exits, so twistd.pid should be
             # gone by now.
-            self.failIf(os.path.exists(TWISTD_PID_FILE))
+            self.failIf(os.path.exists(twistd_pid_file))
         d.addCallback(_cb4)
         d.addBoth(self._remove, exit_trigger_file)
         return d
@@ -693,10 +695,11 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
 
     def test_keygen(self):
         self.skip_if_cannot_daemonize()
+
         basedir = self.workdir("test_keygen")
         c1 = os.path.join(basedir, "c1")
-        TWISTD_PID_FILE = os.path.join(c1, "twistd.pid")
-        KEYGEN_FURL_FILE = os.path.join(c1, "key_generator.furl")
+        twistd_pid_file = os.path.join(c1, "twistd.pid")
+        keygen_furl_file = os.path.join(c1, "key_generator.furl")
 
         d = self.run_bintahoe(["--quiet", "create-key-generator", "--basedir", c1])
         def _cb(res):
@@ -726,13 +729,13 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
         d.addCallback(_cb2)
 
         def _node_has_started():
-            return os.path.exists(KEYGEN_FURL_FILE)
+            return os.path.exists(keygen_furl_file)
         d.addCallback(lambda res: self.poll(_node_has_started))
 
         def _started(res):
-            self.failUnless(os.path.exists(TWISTD_PID_FILE))
+            self.failUnless(os.path.exists(twistd_pid_file))
             # rm this so we can detect when the second incarnation is ready
-            os.unlink(KEYGEN_FURL_FILE)
+            os.unlink(keygen_furl_file)
             return self.run_bintahoe(["--quiet", "restart", c1])
         d.addCallback(_started)
 
@@ -752,7 +755,7 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
         # itself before we get a chance too, especially if spawning the
         # 'tahoe stop' command takes a while.
         def _stop(res):
-            self.failUnless(os.path.exists(TWISTD_PID_FILE))
+            self.failUnless(os.path.exists(twistd_pid_file))
             return self.run_bintahoe(["--quiet", "stop", c1])
         d.addCallback(_stop)
 
@@ -766,6 +769,6 @@ class RunNode(common_util.SignalMixin, unittest.TestCase, pollmixin.PollMixin,
             # the parent was supposed to poll and wait until it sees
             # twistd.pid go away before it exits, so twistd.pid should be
             # gone by now.
-            self.failIf(os.path.exists(TWISTD_PID_FILE))
+            self.failIf(os.path.exists(twistd_pid_file))
         d.addCallback(_cb4)
         return d
-- 
2.45.2