Added support for Repository.get_workflow_runs parameters (PyGithub#1682)

* Added support for `Repository.get_workflow_runs` parameters

* Added anchor tag to docstring link

* Tests

Author: zacker150

github/Repository.py

@@ -3015,19 +3015,6 @@ def get_workflows(self):
             list_item="workflows",
         )
 
-    def get_workflow_runs(self):
-        """
-        :calls: `GET /repos/:owner/:repo/actions/runs <https://developer.github.com/v3/actions/workflow-runs>`_
-        :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.WorkflowRun.WorkflowRun`
-        """
-        return github.PaginatedList.PaginatedList(
-            github.WorkflowRun.WorkflowRun,
-            self._requester,
-            self.url + "/actions/runs",
-            None,
-            list_item="workflow_runs",
-        )
-
     def get_workflow(self, id_or_name):
         """
         :calls: `GET /repos/:owner/:repo/actions/workflows/:workflow_id <https://developer.github.com/v3/actions/workflows>`_
@@ -3041,6 +3028,59 @@ def get_workflow(self, id_or_name):
         )
         return github.Workflow.Workflow(self._requester, headers, data, completed=True)
 
+    def get_workflow_runs(
+        self,
+        actor=github.GithubObject.NotSet,
+        branch=github.GithubObject.NotSet,
+        event=github.GithubObject.NotSet,
+        status=github.GithubObject.NotSet,
+    ):
+        """
+        :calls: `GET /repos/:owner/:repo/actions/runs <https://developer.github.com/v3/actions/workflow-runs/#list-workflow-runs-for-a-repository>`_
+        :param actor: :class:`github.NamedUser.NamedUser` or string
+        :param branch: :class:`github.Branch.Branch` or string
+        :param event: string
+        :param status: string `queued`, `in_progress`, `completed`, `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`
+
+        :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.WorkflowRun.WorkflowRun`
+        """
+        assert (
+            actor is github.GithubObject.NotSet
+            or isinstance(actor, github.NamedUser.NamedUser)
+            or isinstance(actor, str)
+        ), actor
+        assert (
+            branch is github.GithubObject.NotSet
+            or isinstance(branch, github.Branch.Branch)
+            or isinstance(branch, str)
+        ), branch
+        assert event is github.GithubObject.NotSet or isinstance(event, str), event
+        assert status is github.GithubObject.NotSet or isinstance(status, str), status
+
+        url_parameters = dict()
+        if actor is not github.GithubObject.NotSet:
+            if isinstance(actor, github.NamedUser.NamedUser):
+                url_parameters["actor"] = actor._identity
+            else:
+                url_parameters["actor"] = actor
+        if branch is not github.GithubObject.NotSet:
+            if isinstance(branch, github.Branch.Branch):
+                url_parameters["branch"] = branch.name
+            else:
+                url_parameters["branch"] = branch
+        if event is not github.GithubObject.NotSet:
+            url_parameters["event"] = event
+        if status is not github.GithubObject.NotSet:
+            url_parameters["status"] = status
+
+        return github.PaginatedList.PaginatedList(
+            github.WorkflowRun.WorkflowRun,
+            self._requester,
+            self.url + "/actions/runs",
+            url_parameters,
+            list_item="workflow_runs",
+        )
+
     def get_workflow_run(self, id_):
         """
         :calls: `GET /repos/:owner/:repo/actions/runs/:run_id <https://developer.github.com/v3/actions/workflow-runs>`_

tests/PullRequest1682.py

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+
+############################ Copyrights and license ############################
+#                                                                              #
+# Copyright 2020 Victor Zeng <[email protected]>                           #
+#                                                                              #
+# This file is part of PyGithub.                                               #
+# http://pygithub.readthedocs.io/                                              #
+#                                                                              #
+# PyGithub is free software: you can redistribute it and/or modify it under    #
+# the terms of the GNU Lesser General Public License as published by the Free  #
+# Software Foundation, either version 3 of the License, or (at your option)    #
+# any later version.                                                           #
+#                                                                              #
+# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY  #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS    #
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
+# details.                                                                     #
+#                                                                              #
+# You should have received a copy of the GNU Lesser General Public License     #
+# along with PyGithub. If not, see <http://www.gnu.org/licenses/>.             #
+#                                                                              #
+################################################################################
+
+from . import Framework
+
+
+class PullRequest1682(Framework.TestCase):
+    def setUp(self):
+        super().setUp()
+        self.repo = self.g.get_repo("ReDASers/Phishing-Detection")
+
+    def test_no_parameters(self):
+        runs = self.repo.get_workflow_runs()
+        self.assertEqual(313400760, runs[0].id)
+
+    def test_object_parameters(self):
+        branch = self.repo.get_branch("adversary")
+        runs = self.repo.get_workflow_runs(branch=branch)
+        self.assertEqual(204764033, runs[0].id)
+        self.assertEqual(1, runs.totalCount)
+
+        user = self.g.get_user("shahryarabaki")
+        runs = self.repo.get_workflow_runs(actor=user)
+        self.assertEqual(28372848, runs[0].id)
+
+    def test_string_parameters(self):
+        runs = self.repo.get_workflow_runs(actor="xzhou29")
+        self.assertEqual(226142695, runs[0].id)
+
+        runs = self.repo.get_workflow_runs(branch="API_Flatten")
+        self.assertEqual(287515889, runs[0].id)
+
+        runs = self.repo.get_workflow_runs(event="pull_request")
+        self.assertEqual(298867254, runs[0].id)
+
+        runs = self.repo.get_workflow_runs(status="failure")
+        self.assertEqual(292080359, runs[0].id)

tests/ReplayData/PullRequest1682.setUp.txt

@@ -0,0 +1,11 @@
+https
+GET
+api.github.com
+None
+/repos/ReDASers/Phishing-Detection
+{'Authorization': 'Basic login_and_password_removed', 'User-Agent': 'PyGithub/Python'}
+None
+200
+[('Server', 'GitHub.com'), ('Date', 'Tue, 27 Oct 2020 20:01:34 GMT'), ('Content-Type', 'application/json; charset=utf-8'), ('Transfer-Encoding', 'chunked'), ('Status', '200 OK'), ('Cache-Control', 'private, max-age=60, s-maxage=60'), ('Vary', 'Accept, Authorization, Cookie, X-GitHub-OTP, Accept-Encoding, Accept, X-Requested-With'), ('ETag', 'W/"3f57c3bc8bc24a574b14be5562a6807a14b95ece2301de951d8234cacea234ed"'), ('Last-Modified', 'Sat, 10 Oct 2020 08:06:04 GMT'), ('X-GitHub-Media-Type', 'github.v3; format=json'), ('X-RateLimit-Limit', '5000'), ('X-RateLimit-Remaining', '4909'), ('X-RateLimit-Reset', '1603831065'), ('X-RateLimit-Used', '91'), ('Access-Control-Expose-Headers', 'ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset'), ('Access-Control-Allow-Origin', '*'), ('Strict-Transport-Security', 'max-age=31536000; includeSubdomains; preload'), ('X-Frame-Options', 'deny'), ('X-Content-Type-Options', 'nosniff'), ('X-XSS-Protection', '1; mode=block'), ('Referrer-Policy', 'origin-when-cross-origin, strict-origin-when-cross-origin'), ('Content-Security-Policy', "default-src 'none'"), ('Content-Encoding', 'gzip'), ('X-GitHub-Request-Id', 'F14D:4B2E:23C90:6072E:5F987C9E')]
+{"id":146139403,"node_id":"MDEwOlJlcG9zaXRvcnkxNDYxMzk0MDM=","name":"Phishing-Detection","full_name":"ReDASers/Phishing-Detection","private":true,"owner":{"login":"ReDASers","id":67067070,"node_id":"MDEyOk9yZ2FuaXphdGlvbjY3MDY3MDcw","avatar_url":"https://avatars0.githubusercontent.com/u/67067070?v=4","gravatar_id":"","url":"https://api.github.com/users/ReDASers","html_url":"https://github.com/ReDASers","followers_url":"https://api.github.com/users/ReDASers/followers","following_url":"https://api.github.com/users/ReDASers/following{/other_user}","gists_url":"https://api.github.com/users/ReDASers/gists{/gist_id}","starred_url":"https://api.github.com/users/ReDASers/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ReDASers/subscriptions","organizations_url":"https://api.github.com/users/ReDASers/orgs","repos_url":"https://api.github.com/users/ReDASers/repos","events_url":"https://api.github.com/users/ReDASers/events{/privacy}","received_events_url":"https://api.github.com/users/ReDASers/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/ReDASers/Phishing-Detection","description":"A customizable benchmarking framework for phishing research. ","fork":false,"url":"https://api.github.com/repos/ReDASers/Phishing-Detection","forks_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/forks","keys_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/teams","hooks_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/hooks","issue_events_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/issues/events{/number}","events_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/events","assignees_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/assignees{/user}","branches_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/branches{/branch}","tags_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/tags","blobs_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/git/refs{/sha}","trees_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/statuses/{sha}","languages_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/languages","stargazers_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/stargazers","contributors_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/contributors","subscribers_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/subscribers","subscription_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/subscription","commits_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/commits{/sha}","git_commits_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/git/commits{/sha}","comments_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/comments{/number}","issue_comment_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/issues/comments{/number}","contents_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/contents/{+path}","compare_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/merges","archive_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/downloads","issues_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/issues{/number}","pulls_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/pulls{/number}","milestones_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/milestones{/number}","notifications_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/labels{/name}","releases_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/releases{/id}","deployments_url":"https://api.github.com/repos/ReDASers/Phishing-Detection/deployments","created_at":"2018-08-26T00:30:13Z","updated_at":"2020-10-10T08:06:04Z","pushed_at":"2020-10-18T06:42:23Z","git_url":"git://github.com/ReDASers/Phishing-Detection.git","ssh_url":"[email protected]:ReDASers/Phishing-Detection.git","clone_url":"https://github.com/ReDASers/Phishing-Detection.git","svn_url":"https://github.com/ReDASers/Phishing-Detection","homepage":"","size":30731,"stargazers_count":1,"watchers_count":1,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"archived":false,"disabled":false,"open_issues_count":11,"license":null,"forks":1,"open_issues":11,"watchers":1,"default_branch":"master","permissions":{"admin":true,"push":true,"pull":true},"temp_clone_token":"ABZLTTAMCWRKWXDZRJKUCUC7TB64U","allow_squash_merge":true,"allow_merge_commit":false,"allow_rebase_merge":true,"delete_branch_on_merge":false,"organization":{"login":"ReDASers","id":67067070,"node_id":"MDEyOk9yZ2FuaXphdGlvbjY3MDY3MDcw","avatar_url":"https://avatars0.githubusercontent.com/u/67067070?v=4","gravatar_id":"","url":"https://api.github.com/users/ReDASers","html_url":"https://github.com/ReDASers","followers_url":"https://api.github.com/users/ReDASers/followers","following_url":"https://api.github.com/users/ReDASers/following{/other_user}","gists_url":"https://api.github.com/users/ReDASers/gists{/gist_id}","starred_url":"https://api.github.com/users/ReDASers/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ReDASers/subscriptions","organizations_url":"https://api.github.com/users/ReDASers/orgs","repos_url":"https://api.github.com/users/ReDASers/repos","events_url":"https://api.github.com/users/ReDASers/events{/privacy}","received_events_url":"https://api.github.com/users/ReDASers/received_events","type":"Organization","site_admin":false},"network_count":1,"subscribers_count":1}
+