Changeset 287978 in webkit

Timestamp:

Jan 13, 2022, 7:22:22 AM (5 years ago)

Author:

Jonathan Bedard

Message:

[EWS] Load contributors from stand-alone class
​https://bugs.webkit.org/show_bug.cgi?id=235161
<rdar://problem/87491516>

Reviewed by Aakash Jain.

• Tools/CISupport/ews-build/steps.py:

(Contributors): Moved from ValidateCommiterAndReviewer.
(ValidateCommiterAndReviewer.load_contributors_from_disk): Moved to Contributors.
(ValidateCommiterAndReviewer.load_contributors_from_github): Ditto.
(ValidateCommiterAndReviewer.load_contributors): Ditto.

• Tools/CISupport/ews-build/steps_unittest.py:

Canonical link: ​https://commits.webkit.org/246007@main

Location:

trunk/Tools

Files:

• CISupport/ews-build/steps.py (modified) (4 diffs)
• CISupport/ews-build/steps_unittest.py (modified) (4 diffs)
• ChangeLog (modified) (1 diff)

trunk/Tools/CISupport/ews-build/steps.py

@@ -90 +90 @@
 
 
+class Contributors(object):
+    url = 'https://raw.githubusercontent.com/WebKit/WebKit/main/metadata/contributors.json'
+    contributors = {}
+
+    @classmethod
+    def load_from_disk(cls):
+        cwd = os.path.abspath(os.path.dirname(__file__))
+        repo_root = os.path.dirname(os.path.dirname(os.path.dirname(cwd)))
+        contributors_path = os.path.join(repo_root, 'metadata/contributors.json')
+        try:
+            with open(contributors_path, 'rb') as contributors_json:
+                return json.load(contributors_json), None
+        except Exception as e:
+            return {}, 'Failed to load {}\n'.format(contributors_path)
+
+    @classmethod
+    def load_from_github(cls):
+        try:
+            response = requests.get(cls.url, timeout=60)
+            if response.status_code != 200:
+                return {}, 'Failed to access {} with status code: {}\n'.format(cls.url, response.status_code)
+            return response.json(), None
+        except Exception as e:
+            return {}, 'Failed to access {url}\n'.format(url=cls.url)
+
+    @classmethod
+    def load(cls):
+        errors = []
+        contributors_json, error = cls.load_from_github()
+        if error:
+            errors.append(error)
+
+        if not contributors_json:
+            contributors_json, error = cls.load_from_disk()
+            if error:
+                errors.append(error)
+
+        contributors = {}
+        for value in contributors_json:
+            name = value.get('name')
+            emails = value.get('emails')
+            github_username = value.get('github')
+            if name and emails:
+                bugzilla_email = emails[0].lower()  # We're requiring that the first email is the primary bugzilla email
+                contributors[bugzilla_email] = {'name': name, 'status': value.get('status')}
+            if github_username and name and emails:
+                contributors[github_username] = dict(
+                    name=name,
+                    status=value.get('status'),
+                    email=emails[0],
+                )
+        return contributors, errors
+
+
 class ConfigureBuild(buildstep.BuildStep):
     name = 'configure-build'
@@ -959 +1013 @@
     name = 'validate-commiter-and-reviewer'
     descriptionDone = ['Validated commiter and reviewer']
-    url = 'https://raw.githubusercontent.com/WebKit/WebKit/main/metadata/contributors.json'
-    contributors = {}
-
-    def load_contributors_from_disk(self):
-        cwd = os.path.abspath(os.path.dirname(__file__))
-        repo_root = os.path.dirname(os.path.dirname(os.path.dirname(cwd)))
-        contributors_path = os.path.join(repo_root, 'metadata/contributors.json')
-        try:
-            with open(contributors_path, 'rb') as contributors_json:
-                return json.load(contributors_json)
-        except Exception as e:
-            self._addToLog('stdio', 'Failed to load {}\n'.format(contributors_path))
-            return {}
-
-    def load_contributors_from_github(self):
-        try:
-            response = requests.get(self.url, timeout=60)
-            if response.status_code != 200:
-                self._addToLog('stdio', 'Failed to access {} with status code: {}\n'.format(self.url, response.status_code))
-                return {}
-            return response.json()
-        except Exception as e:
-            self._addToLog('stdio', 'Failed to access {url}\n'.format(url=self.url))
-            return {}
-
-    def load_contributors(self):
-        contributors_json = self.load_contributors_from_github()
-        if not contributors_json:
-            contributors_json = self.load_contributors_from_disk()
-
-        contributors = {}
-        for value in contributors_json:
-            name = value.get('name')
-            emails = value.get('emails')
-            if name and emails:
-                bugzilla_email = emails[0].lower()  # We're requiring that the first email is the primary bugzilla email
-                contributors[bugzilla_email] = {'name': name, 'status': value.get('status')}
-        return contributors
+
+    def __init__(self, *args, **kwargs):
+        super(ValidateCommiterAndReviewer, self).__init__(*args, **kwargs)
+        self.contributors = {}
 
     @defer.inlineCallbacks
@@ -1013 +1033 @@
     def fail_build(self, email, status):
         reason = '{} does not have {} permissions'.format(email, status)
-        comment = '{} does not have {} permissions according to {}.'.format(email, status, self.url)
+        comment = '{} does not have {} permissions according to {}.'.format(email, status, Contributors.url)
         comment += '\n\nRejecting attachment {} from commit queue.'.format(self.getProperty('patch_id', ''))
         self.setProperty('bugzilla_comment_text', comment)
@@ -1038 +1058 @@
 
     def start(self):
-        self.contributors = self.load_contributors()
+        self.contributors, errors = Contributors.load()
+        for error in errors:
+            print(error)
+            self._addToLog('stdio', error)
+
         if not self.contributors:
             self.finished(FAILURE)

trunk/Tools/CISupport/ews-build/steps_unittest.py

@@ -45 +45 @@
                    CheckOutSource, CheckOutSpecificRevision, CheckPatchRelevance, CheckPatchStatusOnEWSQueues, CheckStyle,
                    CleanBuild, CleanUpGitIndexLock, CleanGitRepo, CleanWorkingDirectory, CompileJSC, CompileJSCWithoutPatch,
-                   CompileWebKit, CompileWebKitWithoutPatch, ConfigureBuild, CreateLocalGITCommit,
+                   CompileWebKit, CompileWebKitWithoutPatch, ConfigureBuild, ConfigureBuild, Contributors, CreateLocalGITCommit,
                    DownloadBuiltProduct, DownloadBuiltProductFromMaster, EWS_BUILD_HOSTNAME, ExtractBuiltProduct, ExtractTestResults,
                    FetchBranches, FindModifiedChangeLogs, FindModifiedLayoutTests, GitResetHard,
@@ -4586 +4586 @@
         self.longMessage = True
 
-        def mock_load_contributors(cls, *args, **kwargs):
+        def mock_load_contributors(*args, **kwargs):
             return {'aakash_jain@apple.com': {'name': 'Aakash Jain', 'status': 'reviewer'},
-                    'committer@webkit.org': {'name': 'WebKit Committer', 'status': 'committer'}}
-        ValidateCommiterAndReviewer.load_contributors = mock_load_contributors
+                    'committer@webkit.org': {'name': 'WebKit Committer', 'status': 'committer'}}, []
+        Contributors.load = mock_load_contributors
         return self.setUpBuildStep()
 
@@ -4617 +4617 @@
         self.setProperty('patch_id', '1234')
         self.setProperty('patch_committer', 'abc@webkit.org')
-        ValidateCommiterAndReviewer.load_contributors = lambda x: {}
+        Contributors.load = lambda: ({}, [])
         self.expectHidden(False)
         self.expectOutcome(result=FAILURE, state_string='Failed to get contributors information')
@@ -4640 +4640 @@
 
     def test_load_contributors_from_disk(self):
-        ValidateCommiterAndReviewer._addToLog = lambda cls, logtype, log: sys.stdout.write(log)
-        contributors = filter(lambda element: element.get('name') == 'Aakash Jain', ValidateCommiterAndReviewer().load_contributors_from_disk())
+        contributors = filter(lambda element: element.get('name') == 'Aakash Jain', Contributors().load_from_disk()[0])
         self.assertEqual(list(contributors)[0]['emails'][0], 'aakash_jain@apple.com')
 

trunk/Tools/ChangeLog

@@ +1 @@
+2022-01-12  Jonathan Bedard  <jbedard@apple.com>
+
+        [EWS] Load contributors from stand-alone class
+        https://bugs.webkit.org/show_bug.cgi?id=235161
+        <rdar://problem/87491516>
+
+        Reviewed by Aakash Jain.
+
+        * CISupport/ews-build/steps.py:
+        (Contributors): Moved from ValidateCommiterAndReviewer.
+        (ValidateCommiterAndReviewer.load_contributors_from_disk): Moved to Contributors.
+        (ValidateCommiterAndReviewer.load_contributors_from_github): Ditto.
+        (ValidateCommiterAndReviewer.load_contributors): Ditto.
+        * CISupport/ews-build/steps_unittest.py:
+
 2022-01-12  Ryan Haddad  <ryanhaddad@apple.com>