Changeset 213562 in webkit

Timestamp:

Mar 7, 2017 7:46:19 PM (7 years ago)

Author:

commit-queue@webkit.org

Message:

Perf and layout test results should report using correct scm revision.
​https://bugs.webkit.org/show_bug.cgi?id=169171

Patch by Kocsen Chung <Kocsen Chung> on 2017-03-07
Reviewed by Ryosuke Niwa.

For accurate record keeping, perf test and layout test results should
report using the native scm revision as an identifier.
To do so we introduce a new scm functions:

native_revision() and timestamp_of_native_revision().

The former is responsible for returning a git hash if scm.git or an
svn revision if scm.svn. The latter is responsible for retrieving the correct timestamp.
We also add the corresponding tests and a helper function _most_recent_log_for_revision.

• Scripts/webkitpy/common/checkout/scm/scm.py:

(SCM.run):
Drive-by indentation fix to adhere to WebKit style conventions.
(SCM.svn_revision):
Remove superfluous comment.
(SCM.native_revision):
Add new abstract function native_revision and make it a _subclass_must_implement()
as we want to closely mimic svn_revision() function due to their similar behavior.
(SCM.timestamp_of_native_revision):
Add new abstract function timestamp_of_native_revision to closely mimic timestamp_of_revision.

• Scripts/webkitpy/common/checkout/scm/git.py:

(Git._most_recent_log_for_revision):
New helper function similar to _most_recent_log_matching that is git hash friendly.
(Git.native_revision):
Implement new function native_revision(). Get the native_revision by running:

git log -1 --pretty=format:%H

and thus returning the latest git hash (in long format).
(Git.timestamp_of_native_revision):
Since perftestrunner and layout_test.controllers.manager use the new native_revision
function, we create a new native_revision timestamp retriever.
You will notice this uses a far more simplified way to retrieve UTC strict-ISO timestamp
than its non-native counterpart: timestamp_of_revision().

• Scripts/webkitpy/common/checkout/scm/svn.py:

(SVN.native_revision):
Implement native_revision for SVN: simply return self.svn_revision()
(SVN.timestamp_of_native_revision):
Implement timestamp_of_native_revision for SVN: simply return self.timestamp_of_revision()

• Scripts/webkitpy/common/checkout/scm/scm_unittest.py:

(test_native_revision):
[SVN] Confirm that svn_revision == native_revision. And that native_revision returns 5.
Use '.' as the path parameter instead of svn_checkout_path to avoid violating pylint/E1101
and since we are guaranteed by test setUp to be in the correct SVN dir.
(GitTest.test_native_revision):
[Git] Confirm that git rev-parse HEAD is equal to newly implemented native_revision().
(GitSVNTest.test_native_revision):
[Git] Confirm that git rev-parse HEAD is equal to newly implemented native_revision().
(test_timestamp_of_native_revision):
Test new function timestamp_of_native_revision. Very similar fashion to
test_timestamp_of_revision.

• Scripts/webkitpy/common/checkout/scm/scm_mock.py:

(MockSCM.native_revision):
Add MockSCM.native_revision to behave like svn.py (default).
(MockSCM.test_native_revision):
Add MockSCM.test_native_revision to behave like its non-native counterpart.

• Scripts/webkitpy/layout_tests/controllers/manager.py:

(Manager.upload_results):
When iterating through a list of projects, make sure we use the project's new native revision.

• Scripts/webkitpy/performance_tests/perftestsrunner.py:

(_generate_results_dict):
As per the FIXME in manager.py, we have duplicate code in perftestsrunner.py.
So make the same exact change here.

Location:

trunk/Tools

Files:

• ChangeLog (modified) (1 diff)
• Scripts/webkitpy/common/checkout/scm/git.py (modified) (3 diffs)
• Scripts/webkitpy/common/checkout/scm/scm.py (modified) (2 diffs)
• Scripts/webkitpy/common/checkout/scm/scm_mock.py (modified) (1 diff)
• Scripts/webkitpy/common/checkout/scm/scm_unittest.py (modified) (4 diffs)
• Scripts/webkitpy/common/checkout/scm/svn.py (modified) (2 diffs)
• Scripts/webkitpy/layout_tests/controllers/manager.py (modified) (1 diff)
• Scripts/webkitpy/performance_tests/perftestsrunner.py (modified) (1 diff)

trunk/Tools/ChangeLog

@@ +1 @@
+2017-03-07  Kocsen Chung  <kocsen_chung@apple.com>
+
+        Perf and layout test results should report using correct scm revision.
+        https://bugs.webkit.org/show_bug.cgi?id=169171
+
+        Reviewed by Ryosuke Niwa.
+
+        For accurate record keeping, perf test and layout test results should
+        report using the native scm revision as an identifier.
+        To do so we introduce a new scm functions:
+            `native_revision()` and `timestamp_of_native_revision()`.
+        The former is responsible for returning a git hash if scm.git or an
+        svn revision if scm.svn. The latter is responsible for retrieving the correct timestamp.
+        We also add the corresponding tests and a helper function `_most_recent_log_for_revision`.
+
+        * Scripts/webkitpy/common/checkout/scm/scm.py:
+        (SCM.run):
+        Drive-by indentation fix to adhere to WebKit style conventions.
+        (SCM.svn_revision):
+        Remove superfluous comment.
+        (SCM.native_revision):
+        Add new abstract function `native_revision` and make it a `_subclass_must_implement()`
+        as we want to closely mimic `svn_revision()` function due to their similar behavior.
+        (SCM.timestamp_of_native_revision):
+        Add new abstract function `timestamp_of_native_revision` to closely mimic `timestamp_of_revision`.
+
+        * Scripts/webkitpy/common/checkout/scm/git.py:
+        (Git._most_recent_log_for_revision):
+        New helper function similar to `_most_recent_log_matching` that is git hash friendly.
+        (Git.native_revision):
+        Implement new function `native_revision()`. Get the native_revision by running:
+
+            `git log -1 --pretty=format:%H`
+
+        and thus returning the latest git hash (in long format).
+        (Git.timestamp_of_native_revision):
+        Since perftestrunner and layout_test.controllers.manager use the new native_revision
+        function, we create a new native_revision timestamp retriever.
+        You will notice this uses a far more simplified way to retrieve UTC strict-ISO timestamp
+        than its non-native counterpart: `timestamp_of_revision()`.
+        * Scripts/webkitpy/common/checkout/scm/svn.py:
+        (SVN.native_revision):
+        Implement native_revision for SVN: simply return self.svn_revision()
+        (SVN.timestamp_of_native_revision):
+        Implement timestamp_of_native_revision for SVN: simply return self.timestamp_of_revision()
+
+        * Scripts/webkitpy/common/checkout/scm/scm_unittest.py:
+        (test_native_revision):
+        [SVN] Confirm that svn_revision == native_revision. And that native_revision returns 5.
+        Use '.' as the path parameter instead of svn_checkout_path to avoid violating pylint/E1101
+        and since we are guaranteed by test setUp to be in the correct SVN dir.
+        (GitTest.test_native_revision):
+        [Git] Confirm that `git rev-parse HEAD` is equal to newly implemented native_revision().
+        (GitSVNTest.test_native_revision):
+        [Git] Confirm that `git rev-parse HEAD` is equal to newly implemented native_revision().
+        (test_timestamp_of_native_revision):
+        Test new function `timestamp_of_native_revision`. Very similar fashion to
+        `test_timestamp_of_revision`.
+
+        * Scripts/webkitpy/common/checkout/scm/scm_mock.py:
+        (MockSCM.native_revision):
+        Add MockSCM.native_revision to behave like svn.py (default).
+        (MockSCM.test_native_revision):
+        Add MockSCM.test_native_revision to behave like its non-native counterpart.
+
+        * Scripts/webkitpy/layout_tests/controllers/manager.py:
+        (Manager.upload_results):
+        When iterating through a list of projects, make sure we use the project's new native revision.
+        * Scripts/webkitpy/performance_tests/perftestsrunner.py:
+        (_generate_results_dict):
+        As per the FIXME in manager.py, we have duplicate code in perftestsrunner.py.
+        So make the same exact change here.
+
 2017-03-07  Tim Horton  <timothy_horton@apple.com>
 

trunk/Tools/Scripts/webkitpy/common/checkout/scm/git.py

@@ -271 +271 @@
         return self._run_git(['log', '-1', '--grep=' + grep_str, '--date=iso', self.find_checkout_root(path)])
 
+    def _most_recent_log_for_revision(self, revision, path):
+        return self._run_git(['log', '-1', revision, '--date=iso', self.find_checkout_root(path)])
+
     def svn_revision(self, path):
         git_log = self._most_recent_log_matching('git-svn-id:', path)
@@ -277 +280 @@
             return ""
         return str(match.group('svn_revision'))
+
+    def native_revision(self, path):
+        return self._run_git(['log', '-1', '--pretty=format:%H', self.find_checkout_root(path)])
 
     def svn_url(self):
@@ -300 +306 @@
         time_without_timezone = time_with_timezone - datetime.timedelta(hours=sign * int(match.group(8)), minutes=int(match.group(9)))
         return time_without_timezone.strftime('%Y-%m-%dT%H:%M:%SZ')
+
+    def timestamp_of_native_revision(self, path, sha):
+        unix_timestamp = self._run_git(['log', '-1', sha, '--pretty="format:%ct"', self.find_checkout_root(path)]).rstrip()
+        commit_timestamp = datetime.datetime.utcfromtimestamp(float(unix_timestamp))
+        return commit_timestamp.strftime('%Y-%m-%dT%H:%M:%SZ')
 
     def prepend_svn_revision(self, diff):

trunk/Tools/Scripts/webkitpy/common/checkout/scm/scm.py

@@ -70 +70 @@
         # FIXME: We should set cwd appropriately.
         return self._executive.run_command(args,
-                           cwd=cwd,
-                           input=input,
-                           error_handler=error_handler,
-                           return_exit_code=return_exit_code,
-                           return_stderr=return_stderr,
-                           decode_output=decode_output)
+            cwd=cwd,
+            input=input,
+            error_handler=error_handler,
+            return_exit_code=return_exit_code,
+            return_stderr=return_stderr,
+            decode_output=decode_output)
 
     # SCM always returns repository relative path, but sometimes we need
@@ -159 +159 @@
 
     def svn_revision(self, path):
-        """Returns the latest svn revision found in the checkout."""
+        self._subclass_must_implement()
+
+    def native_revision(self, path):
         self._subclass_must_implement()
 
     def timestamp_of_revision(self, path, revision):
+        self._subclass_must_implement()
+
+    def timestamp_of_native_revision(self, path, revision):
         self._subclass_must_implement()
 

trunk/Tools/Scripts/webkitpy/common/checkout/scm/scm_mock.py

@@ -85 +85 @@
         return '5678'
 
+    def native_revision(self, path):
+        return self.svn_revision(path)
+
     def timestamp_of_revision(self, path, revision):
+        return '2013-02-01 08:48:05 +0000'
+
+    def timestamp_of_native_revision(self, path, revision):
         return '2013-02-01 08:48:05 +0000'
 

trunk/Tools/Scripts/webkitpy/common/checkout/scm/scm_unittest.py

@@ -903 +903 @@
         self._shared_test_head_svn_revision()
 
+    def test_native_revision(self):
+        self.assertEqual(self.scm.head_svn_revision(), self.scm.native_revision('.'))
+        self.assertEqual(self.scm.native_revision('.'), '5')
+
     def test_propset_propget(self):
         filepath = os.path.join(self.svn_checkout_path, "test_file")
@@ -1081 +1085 @@
         self.assertEqual(scm.head_svn_revision(), '')
 
+    def test_native_revision(self):
+        scm = self.tracking_scm
+        command = ['git', '-C', scm.checkout_root, 'rev-parse', 'HEAD']
+        self.assertEqual(scm.native_revision(scm.checkout_root), run_command(command).strip())
+
     def test_rename_files(self):
         scm = self.tracking_scm
@@ -1592 +1601 @@
         self._shared_test_head_svn_revision()
 
+    def test_native_revision(self):
+        command = ['git', '-C', self.git_checkout_path, 'rev-parse', 'HEAD']
+        self.assertEqual(self.scm.native_revision(self.git_checkout_path), run_command(command).strip())
+
     def test_to_object_name(self):
         relpath = 'test_file_commit1'
@@ -1673 +1686 @@
         scm._run_git = lambda args: 'Date: 2013-02-08 01:55:21 -0800'
         self.assertEqual(scm.timestamp_of_revision('some-path', '12345'), '2013-02-08T09:55:21Z')
+
+    def test_timestamp_of_native_revision(self):
+        scm = self.make_scm()
+        scm.find_checkout_root = lambda path: ''
+        scm._run_git = lambda args: '1360310749'
+        self.assertEqual(scm.timestamp_of_native_revision('some-path', '1a1c3b08814bc2a8c15b0f6db63cdce68f2aaa7a'), '2013-02-08T08:05:49Z')
+
+        scm._run_git = lambda args: '1360279923'
+        self.assertEqual(scm.timestamp_of_native_revision('some-path', '1a1c3b08814bc2a8c15b0f6db63cdce68f2aaa7a'), '2013-02-07T23:32:03Z')
+
+        scm._run_git = lambda args: '1360317321'
+        self.assertEqual(scm.timestamp_of_native_revision('some-path', '1a1c3b08814bc2a8c15b0f6db63cdce68f2aaa7a'), '2013-02-08T09:55:21Z')

trunk/Tools/Scripts/webkitpy/common/checkout/scm/svn.py

@@ -269 +269 @@
         return self.value_from_svn_info(path, 'Revision')
 
+    def native_revision(self, path):
+        return self.svn_revision(path)
+
     def timestamp_of_revision(self, path, revision):
         # We use --xml to get timestamps like 2013-02-08T08:18:04.964409Z
@@ -275 +278 @@
         match = re.search(r"^<date>(?P<value>.+)</date>\r?$", info_output, re.MULTILINE)
         return match.group('value')
+
+    def timestamp_of_native_revision(self, path, revision):
+        return self.timestamp_of_revision(path, revision)
 
     # FIXME: This method should be on Checkout.

trunk/Tools/Scripts/webkitpy/layout_tests/controllers/manager.py

@@ -472 +472 @@
         for (name, path) in self._port.repository_paths():
             scm = SCMDetector(self._port.host.filesystem, self._port.host.executive).detect_scm_system(path) or self._port.host.scm()
-            revision = scm.svn_revision(path)
-            revisions[name] = {'revision': revision, 'timestamp': scm.timestamp_of_revision(path, revision)}
+            revision = scm.native_revision(path)
+            revisions[name] = {'revision': revision, 'timestamp': scm.timestamp_of_native_revision(path, revision)}
 
         _log.info("Uploading JSON files for master: %s builder: %s build: %s slave: %s to %s", master_name, builder_name, build_number, build_slave, hostname)

trunk/Tools/Scripts/webkitpy/performance_tests/perftestsrunner.py

@@ -271 +271 @@
         for (name, path) in self._port.repository_paths():
             scm = SCMDetector(self._host.filesystem, self._host.executive).detect_scm_system(path) or self._host.scm()
-            revision = scm.svn_revision(path)
-            revisions[name] = {'revision': revision, 'timestamp': scm.timestamp_of_revision(path, revision)}
+            revision = scm.native_revision(path)
+            revisions[name] = {'revision': revision, 'timestamp': scm.timestamp_of_native_revision(path, revision)}
 
         meta_info = {