Refactor persisting state in push and merge scripts.

tools/push-to-trunk/test_scripts.py

 #!/usr/bin/env python
 # Copyright 2013 the V8 project authors. All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are
 # met:
 #
 #     * Redistributions of source code must retain the above copyright
 #       notice, this list of conditions and the following disclaimer.
 #     * Redistributions in binary form must reproduce the above
 #       copyright notice, this list of conditions and the following
@@ skipping 280 matching lines @@
       f.write("#define MINOR_VERSION    22\n")
       f.write("#define BUILD_NUMBER     5\n")
       f.write("#define PATCH_LEVEL      0\n")
       f.write("  // Some line...\n")
       f.write("#define IS_CANDIDATE_VERSION 0\n")
     return name
 
   def MakeStep(self, step_class=Step, state=None, options=None):
     """Convenience wrapper."""
     options = options or CommonOptions(MakeOptions())
+    state = state if state is not None else self._state
     return MakeStep(step_class=step_class, number=0, state=state,
                     config=TEST_CONFIG, options=options,
                     side_effect_handler=self)
 
   def GitMock(self, cmd, args="", pipe=True):
     print "%s %s" % (cmd, args)
     return self._git_mock.Call(args)
 
   def LogMock(self, cmd, args=""):
     print "Log: %s %s" % (cmd, args)
@@ skipping 38 matching lines @@
 
   def ExpectReadURL(self, *args):
     """Convenience wrapper."""
     self._url_mock.Expect(*args)
 
   def setUp(self):
     self._git_mock = SimpleMock("git")
     self._rl_mock = SimpleMock("readline")
     self._url_mock = SimpleMock("readurl")
     self._tmp_files = []
+    self._state = {}
 
   def tearDown(self):
     Command("rm", "-rf %s*" % TEST_CONFIG[PERSISTFILE_BASENAME])
 
     # Clean up temps. Doesn't work automatically.
     for name in self._tmp_files:
       if os.path.exists(name):
         os.remove(name)
 
     self._git_mock.AssertFinished()
     self._rl_mock.AssertFinished()
     self._url_mock.AssertFinished()
 
-  def testPersistRestore(self):
-    self.MakeStep().Persist("test1", "")
-    self.assertEquals("", self.MakeStep().Restore("test1"))
-    self.MakeStep().Persist("test2", "AB123")
-    self.assertEquals("AB123", self.MakeStep().Restore("test2"))
-
   def testGitOrig(self):
     self.assertTrue(Command("git", "--version").startswith("git version"))
 
   def testGitMock(self):
     self.ExpectGit([["--version", "git version 1.2.3"], ["dummy", ""]])
     self.assertEquals("git version 1.2.3", self.MakeStep().Git("--version"))
     self.assertEquals("", self.MakeStep().Git("dummy"))
 
   def testCommonPrepareDefault(self):
     self.ExpectGit([
       ["status -s -uno", ""],
       ["status -s -b -uno", "## some_branch"],
       ["svn fetch", ""],
       ["branch", "  branch1\n* %s" % TEST_CONFIG[TEMP_BRANCH]],
       ["branch -D %s" % TEST_CONFIG[TEMP_BRANCH], ""],
       ["checkout -b %s" % TEST_CONFIG[TEMP_BRANCH], ""],
       ["branch", ""],
     ])
     self.ExpectReadline(["Y"])
     self.MakeStep().CommonPrepare()
     self.MakeStep().PrepareBranch()
-    self.assertEquals("some_branch", self.MakeStep().Restore("current_branch"))
+    self.assertEquals("some_branch", self._state["current_branch"])
 
   def testCommonPrepareNoConfirm(self):
     self.ExpectGit([
       ["status -s -uno", ""],
       ["status -s -b -uno", "## some_branch"],
       ["svn fetch", ""],
       ["branch", "  branch1\n* %s" % TEST_CONFIG[TEMP_BRANCH]],
     ])
     self.ExpectReadline(["n"])
     self.MakeStep().CommonPrepare()
     self.assertRaises(Exception, self.MakeStep().PrepareBranch)
-    self.assertEquals("some_branch", self.MakeStep().Restore("current_branch"))
+    self.assertEquals("some_branch", self._state["current_branch"])
 
   def testCommonPrepareDeleteBranchFailure(self):
     self.ExpectGit([
       ["status -s -uno", ""],
       ["status -s -b -uno", "## some_branch"],
       ["svn fetch", ""],
       ["branch", "  branch1\n* %s" % TEST_CONFIG[TEMP_BRANCH]],
       ["branch -D %s" % TEST_CONFIG[TEMP_BRANCH], None],
     ])
     self.ExpectReadline(["Y"])
     self.MakeStep().CommonPrepare()
     self.assertRaises(Exception, self.MakeStep().PrepareBranch)
-    self.assertEquals("some_branch", self.MakeStep().Restore("current_branch"))
+    self.assertEquals("some_branch", self._state["current_branch"])
 
   def testInitialEnvironmentChecks(self):
     TEST_CONFIG[DOT_GIT_LOCATION] = self.MakeEmptyTempFile()
     os.environ["EDITOR"] = "vi"
     self.MakeStep().InitialEnvironmentChecks()
 
   def testReadAndPersistVersion(self):
     TEST_CONFIG[VERSION_FILE] = self.MakeTempVersionFile()
     step = self.MakeStep()
     step.ReadAndPersistVersion()
-    self.assertEquals("3", self.MakeStep().Restore("major"))
-    self.assertEquals("22", self.MakeStep().Restore("minor"))
-    self.assertEquals("5", self.MakeStep().Restore("build"))
-    self.assertEquals("0", self.MakeStep().Restore("patch"))
-    self.assertEquals("3", step._state["major"])
-    self.assertEquals("22", step._state["minor"])
-    self.assertEquals("5", step._state["build"])
-    self.assertEquals("0", step._state["patch"])
+    self.assertEquals("3", step["major"])
+    self.assertEquals("22", step["minor"])
+    self.assertEquals("5", step["build"])
+    self.assertEquals("0", step["patch"])
 
   def testRegex(self):
     self.assertEqual("(issue 321)",
                      re.sub(r"BUG=v8:(.*)$", r"(issue \1)", "BUG=v8:321"))
     self.assertEqual("(Chromium issue 321)",
                      re.sub(r"BUG=(.*)$", r"(Chromium issue \1)", "BUG=321"))
 
     cl = "  too little\n\ttab\ttab\n         too much\n        trailing  "
     cl = MSub(r"\t", r"        ", cl)
     cl = MSub(r"^ {1,7}([^ ])", r"        \1", cl)
@@ skipping 30 matching lines @@
         "Review URL: https://codereview.chromium.org/9876543210\n")],
       ["log -1 rev4 --format=\"%an\"", "author4@chromium.org"],
     ])
 
     # The cl for rev4 on rietveld has an updated LOG flag.
     self.ExpectReadURL([
       ["https://codereview.chromium.org/9876543210/description",
        "Title\n\nBUG=456\nLOG=N\n\n"],
     ])
 
-    self.MakeStep().Persist("last_push", "1234")
+    self._state["last_push"] = "1234"
     self.MakeStep(PrepareChangeLog).Run()
 
     actual_cl = FileToText(TEST_CONFIG[CHANGELOG_ENTRY_FILE])
 
     expected_cl = """1999-07-31: Version 3.22.5
 
         Title text 1.
 
         Title text 3 (Chromium issue 321).
 
@@ skipping 11 matching lines @@
 #
 #       Title text 3 (Chromium issue 321).
 #       (author3@chromium.org)
 #
 #       Title text 4 (Chromium issue 456).
 #       (author4@chromium.org)
 #
 #"""
 
     self.assertEquals(expected_cl, actual_cl)
-    self.assertEquals("3", self.MakeStep().Restore("major"))
-    self.assertEquals("22", self.MakeStep().Restore("minor"))
-    self.assertEquals("5", self.MakeStep().Restore("build"))
-    self.assertEquals("0", self.MakeStep().Restore("patch"))
+    self.assertEquals("3", self._state["major"])
+    self.assertEquals("22", self._state["minor"])
+    self.assertEquals("5", self._state["build"])
+    self.assertEquals("0", self._state["patch"])
 
   def testEditChangeLog(self):
     TEST_CONFIG[CHANGELOG_ENTRY_FILE] = self.MakeEmptyTempFile()
     TEST_CONFIG[CHANGELOG_FILE] = self.MakeEmptyTempFile()
     TextToFile("        Original CL", TEST_CONFIG[CHANGELOG_FILE])
     TextToFile("  New  \n\tLines  \n", TEST_CONFIG[CHANGELOG_ENTRY_FILE])
     os.environ["EDITOR"] = "vi"
 
     self.ExpectReadline([
       "",  # Open editor.
     ])
 
     self.MakeStep(EditChangeLog).Run()
 
     self.assertEquals("New\n        Lines\n\n\n        Original CL",
                       FileToText(TEST_CONFIG[CHANGELOG_FILE]))
 
   def testIncrementVersion(self):
     TEST_CONFIG[VERSION_FILE] = self.MakeTempVersionFile()
-    self.MakeStep().Persist("build", "5")
+    self._state["build"] = "5"
 
     self.ExpectReadline([
       "Y",  # Increment build number.
     ])
 
     self.MakeStep(IncrementVersion).Run()
 
-    self.assertEquals("3", self.MakeStep().Restore("new_major"))
-    self.assertEquals("22", self.MakeStep().Restore("new_minor"))
-    self.assertEquals("6", self.MakeStep().Restore("new_build"))
-    self.assertEquals("0", self.MakeStep().Restore("new_patch"))
+    self.assertEquals("3", self._state["new_major"])
+    self.assertEquals("22", self._state["new_minor"])
+    self.assertEquals("6", self._state["new_build"])
+    self.assertEquals("0", self._state["new_patch"])
 
   def testLastChangeLogEntries(self):
     TEST_CONFIG[CHANGELOG_FILE] = self.MakeEmptyTempFile()
     l = """
         Fixed something.
         (issue 1234)\n"""
     for _ in xrange(10): l = l + l
 
     cl_chunk = """2013-11-12: Version 3.23.2\n%s
         Performance and stability improvements on all platforms.\n\n\n""" % l
 
     cl_chunk_full = cl_chunk + cl_chunk + cl_chunk
     TextToFile(cl_chunk_full, TEST_CONFIG[CHANGELOG_FILE])
 
     cl = GetLastChangeLogEntries(TEST_CONFIG[CHANGELOG_FILE])
     self.assertEquals(cl_chunk, cl)
 
   def _TestSquashCommits(self, change_log, expected_msg):
     TEST_CONFIG[CHANGELOG_ENTRY_FILE] = self.MakeEmptyTempFile()
     with open(TEST_CONFIG[CHANGELOG_ENTRY_FILE], "w") as f:
       f.write(change_log)
 
     self.ExpectGit([
       ["diff svn/trunk hash1", "patch content"],
       ["svn find-rev hash1", "123455\n"],
     ])
 
-    self.MakeStep().Persist("prepare_commit_hash", "hash1")
-    self.MakeStep().Persist("date", "1999-11-11")
+    self._state["prepare_commit_hash"] = "hash1"
+    self._state["date"] = "1999-11-11"
 
     self.MakeStep(SquashCommits).Run()
     self.assertEquals(FileToText(TEST_CONFIG[COMMITMSG_FILE]), expected_msg)
 
     patch = FileToText(TEST_CONFIG[ PATCH_FILE])
     self.assertTrue(re.search(r"patch content", patch))
 
   def testSquashCommitsUnformatted(self):
     change_log = """1999-11-11: Version 3.22.5
 
@@ skipping 204 matching lines @@
       ["status -s -uno", ""],
       ["status -s -b -uno", "## some_branch\n"],
       ["svn fetch", ""],
       ["svn log -1 --oneline", "r100 | Text"],
       ["svn log -1 --oneline ChangeLog", "r65 | Prepare push to trunk..."],
     ])
 
     auto_roll.RunAutoRoll(TEST_CONFIG, AutoRollOptions(
         MakeOptions(status_password=status_password)), self)
 
-    self.assertEquals("100", self.MakeStep().Restore("lkgr"))
-    self.assertEquals("100", self.MakeStep().Restore("latest"))
+    state = json.loads(FileToText("%s-state.json"
+                                  % TEST_CONFIG[PERSISTFILE_BASENAME]))
+
+    self.assertEquals("100", state["lkgr"])
+    self.assertEquals("100", state["latest"])
 
   def testAutoRollStoppedBySettings(self):
     TEST_CONFIG[DOT_GIT_LOCATION] = self.MakeEmptyTempFile()
     TEST_CONFIG[SETTINGS_LOCATION] = self.MakeEmptyTempFile()
     TextToFile("{\"enable_auto_roll\": false}", TEST_CONFIG[SETTINGS_LOCATION])
 
     self.ExpectReadURL([])
 
     self.ExpectGit([
       ["status -s -uno", ""],
@@ skipping 74 matching lines @@
       ["log -1 --format=%s hash1", "Title1"],
       ["svn find-rev hash2 svn/bleeding_edge", "23456"],
       ["log -1 --format=%s hash2", "Title2"],
       ["log svn/bleeding_edge --reverse --format=%H --grep=\"Port r23456\"",
        ""],
       ["log svn/bleeding_edge --reverse --format=%H --grep=\"Port r34567\"",
        "hash3"],
       ["svn find-rev hash3 svn/bleeding_edge", "56789"],
       ["log -1 --format=%s hash3", "Title3"],
       ["svn find-rev \"r12345\" svn/bleeding_edge", "hash4"],
+      # Simulate svn being down which stops the script.
+      ["svn find-rev \"r23456\" svn/bleeding_edge", None],
+      # Restart script in the failing step.
+      ["svn find-rev \"r12345\" svn/bleeding_edge", "hash4"],
       ["svn find-rev \"r23456\" svn/bleeding_edge", "hash2"],
       ["svn find-rev \"r34567\" svn/bleeding_edge", "hash3"],
       ["svn find-rev \"r45678\" svn/bleeding_edge", "hash1"],
       ["svn find-rev \"r56789\" svn/bleeding_edge", "hash5"],
       ["log -1 --format=%s hash4", "Title4"],
       ["log -1 --format=%s hash2", "Title2"],
       ["log -1 --format=%s hash3", "Title3"],
       ["log -1 --format=%s hash1", "Title1"],
       ["log -1 --format=%s hash5", "Title5"],
       ["log -1 hash4", "Title4\nBUG=123\nBUG=234"],
@@ skipping 38 matching lines @@
       "Y",  # Automatically increment patch level?
       "reviewer@chromium.org",  # V8 reviewer.
       "LGTM",  # Enter LGTM for V8 CL.
     ])
 
     options = MakeOptions(p=extra_patch, f=True)
     # r12345 and r34567 are patches. r23456 (included) and r45678 are the MIPS
     # ports of r12345. r56789 is the MIPS port of r34567.
     args = ["trunk", "12345", "23456", "34567"]
     self.assertTrue(merge_to_branch.ProcessOptions(options, args))
+
+    # The first run of the script stops because of the svn being down.
+    self.assertRaises(Exception,
+        lambda: RunMergeToBranch(TEST_CONFIG,
+                                 MergeToBranchOptions(options, args),
+                                 self))
+
+    # Test that state recovery after restarting the script works.
+    options.s = 3
     RunMergeToBranch(TEST_CONFIG, MergeToBranchOptions(options, args), self)
 
 
 class SystemTest(unittest.TestCase):
   def testReload(self):
     step = MakeStep(step_class=PrepareChangeLog, number=0, state={}, config={},
                     options=CommonOptions(MakeOptions()),
                     side_effect_handler=DEFAULT_SIDE_EFFECT_HANDLER)
     body = step.Reload(
 """------------------------------------------------------------------------
 r17997 | machenbach@chromium.org | 2013-11-22 11:04:04 +0100 (...) | 6 lines
 
 Prepare push to trunk.  Now working on version 3.23.11.
 
 R=danno@chromium.org
 
 Review URL: https://codereview.chromium.org/83173002
 
 ------------------------------------------------------------------------""")
     self.assertEquals(
 """Prepare push to trunk.  Now working on version 3.23.11.
 
 R=danno@chromium.org
 
 Committed: https://code.google.com/p/v8/source/detail?r=17997""", body)