Changeset 268433 in webkit

Timestamp:

Oct 13, 2020 4:53:34 PM (4 years ago)

Author:

Jonathan Bedard

Message:

[webkitscmpy] Add git-webkit find
​https://bugs.webkit.org/show_bug.cgi?id=217534
<rdar://problem/70152431>

Reviewed by Dewei Zhu.

• Scripts/git-webkit: Added.
• Scripts/libraries/webkitcorepy/webkitcorepy/init.py: Bump version.
• Scripts/libraries/webkitcorepy/webkitcorepy/arguments.py:

(NoAction.call):
(CountAction): Create an action to increment or decrement a variable by a value.
(CallbackAction): Create an action which will trigger a callback when set.
(LoggingGroup): Create a group which allows the user to change logging behavior.

• Scripts/libraries/webkitscmpy/git-webkit: Added.
• Scripts/libraries/webkitscmpy/setup.py: Add webkitscmpy.program and git-webkit.
• Scripts/libraries/webkitscmpy/webkitscmpy/init.py: Bump version.
• Scripts/libraries/webkitscmpy/webkitscmpy/commit.py:

(Commit): Make the 12 character hash based on a class variable.

• Scripts/libraries/webkitscmpy/webkitscmpy/local/git.py:

(Git.default_branch): Fallback to 'master' or 'main' if the remote isn't available.
(Git.find): Use git to match branches and tags to a hash instead of trying to do it ourselves.

• Scripts/libraries/webkitscmpy/webkitscmpy/local/scm.py:

(Scm.find): Add function to convert generic string arguments to a commit, and then find that commit in
the repository.

• Scripts/libraries/webkitscmpy/webkitscmpy/local/svn.py:

(Svn): Support a few different SVN binary paths.

• Scripts/libraries/webkitscmpy/webkitscmpy/mocks/local/git.py: Add rev-parse branch/tag/HEAD -> hash conversion.
• Scripts/libraries/webkitscmpy/webkitscmpy/program.py: Added.

(Command): Base class for all commands.
(Find):
(Find.parser): Configure parser for 'find' sub-program.
(Find.main): Given an identifier, revision, hash or branch name, find and print the matching commit from
(main): Entry point to git-<project> scripts.

• Scripts/libraries/webkitscmpy/webkitscmpy/test/find_unittest.py: Added.

(TestFind):
(TestFind.test_basic_git):
(TestFind.test_basic_git_svn):
(TestFind.test_basic_svn):
(TestFind.test_branch_tilde):
(TestFind.test_identifier_git):
(TestFind.test_identifier_git_svn):
(TestFind.test_identifier_svn):
(TestFind.test_hash):
(TestFind.test_revision_svn):
(TestFind.test_revision_git_svn):
(TestFind.test_standard):

Location:

trunk/Tools

Files:

• ChangeLog (modified) (1 diff)
• Scripts/git-webkit (copied) (copied from trunk/Tools/Scripts/libraries/webkitcorepy/webkitcorepy/arguments.py) (2 diffs, 1 prop)
• Scripts/libraries/webkitcorepy/webkitcorepy/arguments.py (modified) (2 diffs)
• Scripts/libraries/webkitscmpy/git-webkit (copied) (copied from trunk/Tools/Scripts/libraries/webkitcorepy/webkitcorepy/arguments.py) (2 diffs, 1 prop)
• Scripts/libraries/webkitscmpy/setup.py (modified) (1 diff)
• Scripts/libraries/webkitscmpy/webkitscmpy/__init__.py (modified) (1 diff)
• Scripts/libraries/webkitscmpy/webkitscmpy/commit.py (modified) (5 diffs)
• Scripts/libraries/webkitscmpy/webkitscmpy/local/git.py (modified) (3 diffs)
• Scripts/libraries/webkitscmpy/webkitscmpy/local/scm.py (modified) (3 diffs)
• Scripts/libraries/webkitscmpy/webkitscmpy/local/svn.py (modified) (1 diff)
• Scripts/libraries/webkitscmpy/webkitscmpy/mocks/local/git.py (modified) (1 diff)
• Scripts/libraries/webkitscmpy/webkitscmpy/program.py (added)
• Scripts/libraries/webkitscmpy/webkitscmpy/test/find_unittest.py (added)

trunk/Tools/ChangeLog

@@ +1 @@
+2020-10-13  Jonathan Bedard  <jbedard@apple.com>
+
+        [webkitscmpy] Add `git-webkit find`
+        https://bugs.webkit.org/show_bug.cgi?id=217534
+        <rdar://problem/70152431>
+
+        Reviewed by Dewei Zhu.
+
+        * Scripts/git-webkit: Added.
+        * Scripts/libraries/webkitcorepy/webkitcorepy/__init__.py: Bump version.
+        * Scripts/libraries/webkitcorepy/webkitcorepy/arguments.py:
+        (NoAction.__call__):
+        (CountAction): Create an action to increment or decrement a variable by a value.
+        (CallbackAction): Create an action which will trigger a callback when set.
+        (LoggingGroup): Create a group which allows the user to change logging behavior.
+        * Scripts/libraries/webkitscmpy/git-webkit: Added.
+        * Scripts/libraries/webkitscmpy/setup.py: Add webkitscmpy.program and git-webkit.
+        * Scripts/libraries/webkitscmpy/webkitscmpy/__init__.py: Bump version.
+        * Scripts/libraries/webkitscmpy/webkitscmpy/commit.py:
+        (Commit): Make the 12 character hash based on a class variable.
+        * Scripts/libraries/webkitscmpy/webkitscmpy/local/git.py:
+        (Git.default_branch): Fallback to 'master' or 'main' if the remote isn't available.
+        (Git.find): Use git to match branches and tags to a hash instead of trying to do it ourselves.
+        * Scripts/libraries/webkitscmpy/webkitscmpy/local/scm.py:
+        (Scm.find): Add function to convert generic string arguments to a commit, and then find that commit in
+        the repository.
+        * Scripts/libraries/webkitscmpy/webkitscmpy/local/svn.py:
+        (Svn): Support a few different SVN binary paths.
+        * Scripts/libraries/webkitscmpy/webkitscmpy/mocks/local/git.py: Add rev-parse branch/tag/HEAD -> hash conversion.
+        * Scripts/libraries/webkitscmpy/webkitscmpy/program.py: Added.
+        (Command): Base class for all commands.
+        (Find):
+        (Find.parser): Configure parser for 'find' sub-program.
+        (Find.main): Given an identifier, revision, hash or branch name, find and print the matching commit from
+        (main): Entry point to git-<project> scripts.
+        * Scripts/libraries/webkitscmpy/webkitscmpy/test/find_unittest.py: Added.
+        (TestFind):
+        (TestFind.test_basic_git):
+        (TestFind.test_basic_git_svn):
+        (TestFind.test_basic_svn):
+        (TestFind.test_branch_tilde):
+        (TestFind.test_identifier_git):
+        (TestFind.test_identifier_git_svn):
+        (TestFind.test_identifier_svn):
+        (TestFind.test_hash):
+        (TestFind.test_revision_svn):
+        (TestFind.test_revision_git_svn):
+        (TestFind.test_standard):
+
 2020-10-12  Ryosuke Niwa  <rniwa@webkit.org>
 

trunk/Tools/Scripts/git-webkit

@@ +1 @@
+#!/usr/bin/env python
+
 # Copyright (C) 2020 Apple Inc. All rights reserved.
 #
@@ -21 +23 @@
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-import argparse
+import os
+import webkitpy
+import sys
 
+from webkitscmpy import program
 
-class NoAction(argparse.Action):
-    def __init__(self, option_strings, dest, **kwargs):
-        super(NoAction, self).__init__(option_strings, dest, nargs=0, **kwargs)
+sys.exit(program.main(path=os.path.dirname(__file__)))
 
-    def __call__(self, parser, namespace, values, option_string=None):
-        setattr(namespace, self.dest, False if option_string.startswith('--no') else True)

trunk/Tools/Scripts/libraries/webkitcorepy/webkitcorepy/arguments.py

@@ -22 +22 @@
 
 import argparse
+import logging
+
+from webkitcorepy import log
 
 
@@ -30 +33 @@
     def __call__(self, parser, namespace, values, option_string=None):
         setattr(namespace, self.dest, False if option_string.startswith('--no') else True)
+
+
+def CountAction(value=1):
+    class Action(argparse.Action):
+        def __init__(self, option_strings, dest, **kwargs):
+            super(Action, self).__init__(option_strings, dest, nargs=0, **kwargs)
+
+        def __call__(self, parser, namespace, values, option_string):
+            setattr(namespace, self.dest, getattr(namespace, self.dest) + value)
+
+    return Action
+
+
+def CallbackAction(action, callback=lambda namespace: None):
+    class Action(action):
+        def __call__(self, parser, namespace, values, option_strings):
+            super(Action, self).__call__(parser, namespace, values, option_strings)
+            callback(namespace)
+
+    return Action
+
+
+def LoggingGroup(parser, loggers=None, default=logging.WARNING, help='{} amount of logging'):
+    if not isinstance(parser, argparse.ArgumentParser):
+        raise ValueError('Provided parser is not a {}'.format(type(argparse.ArgumentParser)))
+
+    if not loggers:
+        loggers = [logging.getLogger(), log]
+    for logger in loggers:
+        logger.setLevel(default)
+
+    def verbose_callback(namespace):
+        verbosity = getattr(namespace, 'verbose')
+        log_level = default - verbosity * 10
+
+        setattr(namespace, 'log_level', log_level)
+
+        for logger in loggers:
+            logger.setLevel(log_level)
+
+    group = parser.add_argument_group('Logging')
+    group.add_argument(
+        '--verbose', '-v',
+        dest='verbose', default=0,
+        help=help.format('Increase'),
+        action=CallbackAction(CountAction(value=1), callback=verbose_callback),
+    )
+    group.add_argument(
+        '--quiet', '-q',
+        dest='verbose', default=0,
+        help=help.format('Decrease'),
+        action=CallbackAction(CountAction(value=-1), callback=verbose_callback),
+    )
+    return group

trunk/Tools/Scripts/libraries/webkitscmpy/git-webkit

@@ +1 @@
+#!/usr/bin/env python
+
 # Copyright (C) 2020 Apple Inc. All rights reserved.
 #
@@ -21 +23 @@
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-import argparse
+import sys
+
+from webkitscmpy import program
 
 
-class NoAction(argparse.Action):
-    def __init__(self, option_strings, dest, **kwargs):
-        super(NoAction, self).__init__(option_strings, dest, nargs=0, **kwargs)
-
-    def __call__(self, parser, namespace, values, option_string=None):
-        setattr(namespace, self.dest, False if option_string.startswith('--no') else True)
+sys.exit(program.main())

trunk/Tools/Scripts/libraries/webkitscmpy/setup.py

@@ -54 +54 @@
         'webkitscmpy.mocks',
         'webkitscmpy.mocks.local',
+        'webkitscmpy.program',
         'webkitscmpy.test',
     ],
+    scripts=['git-webkit'],
     install_requires=['python-dateutil', 'webkitcorepy'],
     include_package_data=True,

trunk/Tools/Scripts/libraries/webkitscmpy/webkitscmpy/__init__.py

@@ -47 +47 @@
     )
 
-version = Version(0, 1, 3)
+version = Version(0, 2, 0)
 
 AutoInstall.register(Package('dateutil', Version(2, 8, 1), pypi_name='python-dateutil'))

trunk/Tools/Scripts/libraries/webkitscmpy/webkitscmpy/commit.py

@@ -34 +34 @@
     IDENTIFIER_RE = re.compile(r'^((?P<branch_point>\d+)\.)?(?P<identifier>-?\d+)(@(?P<branch>\S+))?$')
     NUMBER_RE = re.compile(r'^-?\d*$')
+    HASH_LABEL_SIZE = 12
 
     class Encoder(json.JSONEncoder):
@@ -131 +132 @@
 
     @classmethod
-    def parse(cls, arg):
+    def parse(cls, arg, do_assert=True):
         if cls._parse_identifier(arg):
             return Commit(identifier=arg)
@@ -141 +142 @@
             return Commit(hash=arg)
 
-        raise ValueError("'{}' cannot be converted to a commit object".format(arg))
+        if do_assert:
+            raise ValueError("'{}' cannot be converted to a commit object".format(arg))
+        return None
 
     def __init__(
@@ -212 +215 @@
             result += '\n'
         if self.hash:
-            result += '    git hash: {}'.format(self.hash[:12])
+            result += '    git hash: {}'.format(self.hash[:self.HASH_LABEL_SIZE])
             if self.branch:
                 result += ' on {}'.format(self.branch)
@@ -243 +246 @@
             return 'r{}'.format(self.revision)
         if self.hash:
-            return self.hash[:12]
+            return self.hash[:self.HASH_LABEL_SIZE]
         if self.identifier is not None:
             return str(self.identifier)

trunk/Tools/Scripts/libraries/webkitscmpy/webkitscmpy/local/git.py

@@ -23 +23 @@
 
 import re
+import six
 
 from webkitcorepy import run, decorators, TimeoutExpired
@@ -88 +89 @@
         result = run([self.executable, 'rev-parse', '--abbrev-ref', 'origin/HEAD'], cwd=self.path, capture_output=True, encoding='utf-8')
         if result.returncode:
+            candidates = self.branches
+            if 'master' in candidates:
+                return 'master'
+            if 'main' in candidates:
+                return 'main'
             return None
         return '/'.join(result.stdout.rstrip().split('/')[1:])
@@ -251 +257 @@
             message='\n'.join(line[4:] for line in log.stdout.splitlines()[4:]),
         )
+
+    def find(self, argument):
+        if not isinstance(argument, six.string_types):
+            raise ValueError("Expected 'argument' to be a string, not '{}'".format(type(argument)))
+
+        parsed_commit = Commit.parse(argument, do_assert=False)
+        if parsed_commit:
+            return self.commit(
+                hash=parsed_commit.hash,
+                revision=parsed_commit.revision,
+                identifier=parsed_commit.identifier,
+                branch=parsed_commit.branch,
+            )
+
+        output = run(
+            [self.executable, 'rev-parse', argument],
+            cwd=self.root_path, capture_output=True, encoding='utf-8',
+        )
+        if output.returncode:
+            raise ValueError("'{}' is not an arguement recognized by git".format(argument))
+        return self.commit(hash=output.stdout.rstrip())

trunk/Tools/Scripts/libraries/webkitscmpy/webkitscmpy/local/scm.py

@@ -24 +24 @@
 import logging
 import re
+import six
 import sys
 
 from logging import NullHandler
-from webkitscmpy import log
+from webkitscmpy import log, Commit
 
 
@@ -49 +50 @@
         if local.Svn.is_checkout(path):
             return local.Svn(path)
-        raise OSError('{} is not a known SCM type')
+        raise OSError("'{}' is not a known SCM type".format(path))
 
     def __init__(self, path, dev_branches=None, prod_branches=None):
@@ -90 +91 @@
         raise NotImplementedError()
 
+    def find(self, argument):
+        if not isinstance(argument, six.string_types):
+            raise ValueError("Expected 'argument' to be a string, not '{}'".format(type(argument)))
+
+        offset = 0
+        if '~' in argument:
+            for s in argument.split('~')[1:]:
+                if s and not s.isdigit():
+                    raise ValueError("'{}' is not a valid argument to Scm.find()".format(argument))
+                offset += int(s) if s else 1
+            argument = argument.split('~')[0]
+
+        if argument == 'HEAD':
+            result = self.commit()
+
+        elif argument in self.branches:
+            result = self.commit(branch=argument)
+
+        else:
+            if offset:
+                raise ValueError("'~' offsets are not supported for revisions and identifiers")
+
+            parsed_commit = Commit.parse(argument)
+            return self.commit(
+                hash=parsed_commit.hash,
+                revision=parsed_commit.revision,
+                identifier=parsed_commit.identifier,
+                branch=parsed_commit.branch,
+            )
+
+        if not offset:
+            return result
+
+        return self.commit(
+            identifier=result.identifier - offset,
+            branch=result.branch,
+        )
+
     def commit(self, hash=None, revision=None, identifier=None, branch=None):
         raise NotImplementedError()

trunk/Tools/Scripts/libraries/webkitscmpy/webkitscmpy/local/svn.py

@@ -38 +38 @@
 
 class Svn(Scm):
-    executable = '/usr/local/bin/svn'
+    executable = '/usr/bin/svn' if os.path.exists('/usr/bin/svn') else '/usr/local/bin/svn'
     LOG_RE = re.compile(r'r(?P<revision>\d+) \| (?P<email>.*) \| (?P<date>.*)')
     CACHE_VERSION = Version(1)

trunk/Tools/Scripts/libraries/webkitscmpy/webkitscmpy/mocks/local/git.py

@@ -222 +222 @@
                 ),
             ), mocks.Subprocess.Route(
+                local.Git.executable, 'rev-parse', '.*',
+                cwd=self.path,
+                generator=lambda *args, **kwargs: mocks.ProcessCompletion(
+                    returncode=0,
+                    stdout='{}\n'.format(self.find(args[2]).hash),
+                ) if self.find(args[2]) else mocks.ProcessCompletion(returncode=128)
+            ), mocks.Subprocess.Route(
                 local.Git.executable, 'log', re.compile(r'.+'), '-1',
                 cwd=self.path,