Add missing preview features of Deployment and Deployment Statuses API (PyGithub#1674)

* Add missing preview features of Deployment and Deployment Statuses API
  - Enable support for deployment status states in_progress and queued
  - Add arguments production_environment and transient_environment to Repository.create_deployment()
  - Add attributes production_environment and transient_environment to Deployment
  - Use correct type in assertion for Deployment.payload
  - Fix incorrect assertion for description in Deployment.create_status()
  - Add arguments environment, environment_url, auto_inactive to Deployment.create_status()
  - Add attribute environment_url to DeploymentStatus

Author: pascal-hofmann

github/Consts.py

@@ -11,6 +11,7 @@
 # Copyright 2018 Wan Liuyang <[email protected]>                                #
 # Copyright 2018 sfdye <[email protected]>                                      #
 # Copyright 2019 Nick Campbell <[email protected]>                 #
+# Copyright 2020 Pascal Hofmann <[email protected]>                        #
 #                                                                              #
 # This file is part of PyGithub.                                               #
 # http://pygithub.readthedocs.io/                                              #
@@ -123,3 +124,6 @@
 
 # https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements/
 deploymentEnhancementsPreview = "application/vnd.github.ant-man-preview+json"
+
+# https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/
+deploymentStatusEnhancementsPreview = "application/vnd.github.flash-preview+json"

github/Deployment.py

@@ -4,6 +4,7 @@
 #                                                                              #
 # Copyright 2020 Steve Kowalik <[email protected]>                        #
 # Copyright 2020 Colby Gallup <[email protected]>                          #
+# Copyright 2020 Pascal Hofmann <[email protected]>                        #
 #                                                                              #
 # This file is part of PyGithub.                                               #
 # http://pygithub.readthedocs.io/                                              #
@@ -92,6 +93,22 @@ def environment(self):
         self._completeIfNotSet(self._environment)
         return self._environment.value
 
+    @property
+    def production_environment(self):
+        """
+        :type: bool
+        """
+        self._completeIfNotSet(self._production_environment)
+        return self._production_environment.value
+
+    @property
+    def transient_environment(self):
+        """
+        :type: bool
+        """
+        self._completeIfNotSet(self._transient_environment)
+        return self._transient_environment.value
+
     @property
     def description(self):
         """
@@ -150,6 +167,7 @@ def get_statuses(self):
             self._requester,
             self.url + "/statuses",
             None,
+            headers={"Accept": self._get_accept_header()},
         )
 
     def get_status(self, id_):
@@ -162,7 +180,7 @@ def get_status(self, id_):
         headers, data = self._requester.requestJsonAndCheck(
             "GET",
             self.url + "/statuses/" + str(id_),
-            headers={"Accept": github.Consts.deploymentEnhancementsPreview},
+            headers={"Accept": self._get_accept_header()},
         )
         return github.DeploymentStatus.DeploymentStatus(
             self._requester, headers, data, completed=True
@@ -173,12 +191,18 @@ def create_status(
         state,
         target_url=github.GithubObject.NotSet,
         description=github.GithubObject.NotSet,
+        environment=github.GithubObject.NotSet,
+        environment_url=github.GithubObject.NotSet,
+        auto_inactive=github.GithubObject.NotSet,
     ):
         """
         :calls: `POST /repos/:owner/:repo/deployments/:deployment_id/statuses <https://developer.github.com/v3/repos/deployments/#create-a-deployment-status>`_
         :param: state: string
         :param: target_url: string
         :param: description: string
+        :param: environment: string
+        :param: environment_url: string
+        :param: auto_inactive: bool
         :rtype: :class:`github.DeploymentStatus.DeploymentStatus`
         """
         assert isinstance(state, str), state
@@ -187,23 +211,52 @@ def create_status(
         ), target_url
         assert description is github.GithubObject.NotSet or isinstance(
             description, str
-        ), target_url
+        ), description
+        assert environment is github.GithubObject.NotSet or isinstance(
+            environment, str
+        ), environment
+        assert environment_url is github.GithubObject.NotSet or isinstance(
+            environment_url, str
+        ), environment_url
+        assert auto_inactive is github.GithubObject.NotSet or isinstance(
+            auto_inactive, bool
+        ), auto_inactive
+
         post_parameters = {"state": state}
         if target_url is not github.GithubObject.NotSet:
             post_parameters["target_url"] = target_url
         if description is not github.GithubObject.NotSet:
             post_parameters["description"] = description
+        if environment is not github.GithubObject.NotSet:
+            post_parameters["environment"] = environment
+        if environment_url is not github.GithubObject.NotSet:
+            post_parameters["environment_url"] = environment_url
+        if auto_inactive is not github.GithubObject.NotSet:
+            post_parameters["auto_inactive"] = auto_inactive
+
         headers, data = self._requester.requestJsonAndCheck(
             "POST",
             self.url + "/statuses",
             input=post_parameters,
+            headers={"Accept": self._get_accept_header()},
         )
         return github.DeploymentStatus.DeploymentStatus(
             self._requester, headers, data, completed=True
         )
 
+    @staticmethod
+    def _get_accept_header():
+        return ", ".join(
+            [
+                github.Consts.deploymentEnhancementsPreview,
+                github.Consts.deploymentStatusEnhancementsPreview,
+            ]
+        )
+
     def _initAttributes(self):
         self._id = github.GithubObject.NotSet
+        self._production_environment = github.GithubObject.NotSet
+        self._transient_environment = github.GithubObject.NotSet
         self._url = github.GithubObject.NotSet
         self._sha = github.GithubObject.NotSet
         self._task = github.GithubObject.NotSet
@@ -220,6 +273,14 @@ def _initAttributes(self):
     def _useAttributes(self, attributes):
         if "id" in attributes:  # pragma no branch
             self._id = self._makeIntAttribute(attributes["id"])
+        if "production_environment" in attributes:  # pragma no branch
+            self._production_environment = self._makeBoolAttribute(
+                attributes["production_environment"]
+            )
+        if "transient_environment" in attributes:  # pragma no branch
+            self._transient_environment = self._makeBoolAttribute(
+                attributes["transient_environment"]
+            )
         if "url" in attributes:  # pragma no branch
             self._url = self._makeStringAttribute(attributes["url"])
         if "sha" in attributes:  # pragma no branch

github/Deployment.pyi

@@ -8,6 +8,8 @@ from github.PaginatedList import PaginatedList
 
 class Deployment(CompletableGithubObject):
     def __repr__(self) -> str: ...
+    @staticmethod
+    def _get_accept_header() -> str: ...
     def _initAttributes(self) -> None: ...
     def _useAttributes(self, attributes: Dict[str, Any]) -> None: ...
     def get_statuses(self) -> PaginatedList[DeploymentStatus]: ...
@@ -17,6 +19,9 @@ class Deployment(CompletableGithubObject):
         state: str,
         target_url: Union[str, _NotSetType] = ...,
         description: Union[str, _NotSetType] = ...,
+        environment: Union[str, _NotSetType] = ...,
+        environment_url: Union[str, _NotSetType] = ...,
+        auto_inactive: Union[bool, _NotSetType] = ...,
     ) -> DeploymentStatus: ...
     @property
     def id(self) -> int: ...
@@ -33,6 +38,10 @@ class Deployment(CompletableGithubObject):
     @property
     def environment(self) -> str: ...
     @property
+    def production_environment(self) -> bool: ...
+    @property
+    def transient_environment(self) -> bool: ...
+    @property
     def description(self) -> str: ...
     @property
     def creator(self) -> NamedUser: ...

github/DeploymentStatus.py

@@ -3,6 +3,7 @@
 ############################ Copyrights and license ############################
 #                                                                              #
 # Copyright 2020 Colby Gallup <[email protected]>                          #
+# Copyright 2020 Pascal Hofmann <[email protected]>                        #
 #                                                                              #
 # This file is part of PyGithub.                                               #
 # http://pygithub.readthedocs.io/                                              #
@@ -73,6 +74,14 @@ def environment(self):
         self._completeIfNotSet(self._environment)
         return self._environment.value
 
+    @property
+    def environment_url(self):
+        """
+        :type: string
+        """
+        self._completeIfNotSet(self._environment_url)
+        return self._environment_url.value
+
     @property
     def repository_url(self):
         """
@@ -135,6 +144,7 @@ def _initAttributes(self):
         self._deployment_url = github.GithubObject.NotSet
         self._description = github.GithubObject.NotSet
         self._environment = github.GithubObject.NotSet
+        self._environment_url = github.GithubObject.NotSet
         self._repository_url = github.GithubObject.NotSet
         self._state = github.GithubObject.NotSet
         self._target_url = github.GithubObject.NotSet
@@ -144,6 +154,10 @@ def _initAttributes(self):
         self._node_id = github.GithubObject.NotSet
 
     def _useAttributes(self, attributes):
+        if "environment_url" in attributes:  # pragma no branch
+            self._environment_url = self._makeStringAttribute(
+                attributes["environment_url"]
+            )
         if "url" in attributes:  # pragma no branch
             self._url = self._makeStringAttribute(attributes["url"])
         if "id" in attributes:  # pragma no branch

github/DeploymentStatus.pyi

@@ -20,6 +20,8 @@ class DeploymentStatus(CompletableGithubObject):
     @property
     def environment(self) -> str: ...
     @property
+    def environment_url(self) -> str: ...
+    @property
     def repository_url(self) -> str: ...
     @property
     def state(self) -> str: ...

github/Repository.py

@@ -66,6 +66,7 @@
 # Copyright 2018 Zilei Gu <[email protected]>                              #
 # Copyright 2018 Yves Zumbach <[email protected]>                        #
 # Copyright 2018 Leying Chen <[email protected]>                          #
+# Copyright 2020 Pascal Hofmann <[email protected]>                        #
 #                                                                              #
 # This file is part of PyGithub.                                               #
 # http://pygithub.readthedocs.io/                                              #
@@ -1812,6 +1813,7 @@ def get_deployments(
             self._requester,
             self.url + "/deployments",
             parameters,
+            headers={"Accept": Consts.deploymentEnhancementsPreview},
         )
 
     def get_deployment(self, id_):
@@ -1822,7 +1824,9 @@ def get_deployment(self, id_):
         """
         assert isinstance(id_, int), id_
         headers, data = self._requester.requestJsonAndCheck(
-            "GET", self.url + "/deployments/" + str(id_)
+            "GET",
+            self.url + "/deployments/" + str(id_),
+            headers={"Accept": Consts.deploymentEnhancementsPreview},
         )
         return github.Deployment.Deployment(
             self._requester, headers, data, completed=True
@@ -1837,15 +1841,20 @@ def create_deployment(
         payload=github.GithubObject.NotSet,
         environment=github.GithubObject.NotSet,
         description=github.GithubObject.NotSet,
+        transient_environment=github.GithubObject.NotSet,
+        production_environment=github.GithubObject.NotSet,
     ):
         """
         :calls: `POST /repos/:owner/:repo/deployments <https://developer.github.com/v3/repos/deployments/>`_
         :param: ref: string
+        :param: task: string
         :param: auto_merge: bool
-        :param: required_contexts: list of statuses
-        :param: payload: json
+        :param: required_contexts: list of status contexts
+        :param: payload: dict
         :param: environment: string
         :param: description: string
+        :param: transient_environment: bool
+        :param: production_environment: bool
         :rtype: :class:`github.Deployment.Deployment`
         """
         assert isinstance(ref, str), ref
@@ -1857,14 +1866,21 @@ def create_deployment(
             required_contexts, list
         ), required_contexts  # need to do better checking here
         assert payload is github.GithubObject.NotSet or isinstance(
-            payload, str
-        ), payload  # How to assert it's JSON?
+            payload, dict
+        ), payload
         assert environment is github.GithubObject.NotSet or isinstance(
             environment, str
         ), environment
         assert description is github.GithubObject.NotSet or isinstance(
             description, str
         ), description
+        assert transient_environment is github.GithubObject.NotSet or isinstance(
+            transient_environment, bool
+        ), transient_environment
+        assert production_environment is github.GithubObject.NotSet or isinstance(
+            production_environment, bool
+        ), production_environment
+
         post_parameters = {"ref": ref}
         if task is not github.GithubObject.NotSet:
             post_parameters["task"] = task
@@ -1878,11 +1894,18 @@ def create_deployment(
             post_parameters["environment"] = environment
         if description is not github.GithubObject.NotSet:
             post_parameters["description"] = description
+        if transient_environment is not github.GithubObject.NotSet:
+            post_parameters["transient_environment"] = transient_environment
+        if production_environment is not github.GithubObject.NotSet:
+            post_parameters["production_environment"] = production_environment
+
         headers, data = self._requester.requestJsonAndCheck(
             "POST",
             self.url + "/deployments",
             input=post_parameters,
+            headers={"Accept": Consts.deploymentEnhancementsPreview},
         )
+
         return github.Deployment.Deployment(
             self._requester, headers, data, completed=True
         )

github/Repository.pyi

@@ -9,6 +9,7 @@ from github.Commit import Commit
 from github.CommitComment import CommitComment
 from github.Comparison import Comparison
 from github.ContentFile import ContentFile
+from github.Deployment import Deployment
 from github.Download import Download
 from github.Event import Event
 from github.GitBlob import GitBlob
@@ -112,6 +113,18 @@ class Repository(CompletableGithubObject):
         output: Union[_NotSetType, Dict[str, Union[str, List[Dict[str, Union[str, int]]]]]] = ...,
         actions: Union[_NotSetType, List[Dict[str, str]]] = ...,
     ) -> CheckRun: ...
+    def create_deployment(
+        self,
+        ref: str,
+        task: Union[str, _NotSetType] = ...,
+        auto_merge: Union[bool, _NotSetType] = ...,
+        required_contexts: Union[List[str], _NotSetType] = ...,
+        payload: Union[Dict[str, Any], _NotSetType] = ...,
+        environment: Union[str, _NotSetType] = ...,
+        description: Union[str, _NotSetType] = ...,
+        transient_environment: Union[bool, _NotSetType] = ...,
+        production_environment: Union[bool, _NotSetType] = ...,
+    ) -> Deployment: ...
     def create_file(
         self,
         path: str,
@@ -295,6 +308,14 @@ class Repository(CompletableGithubObject):
     def get_contributors(
         self, anon: Union[str, _NotSetType] = ...
     ) -> PaginatedList[NamedUser]: ...
+    def get_deployment(self, id_: int) -> Any: ...
+    def get_deployments(
+        self,
+        sha: Union[str, _NotSetType] = ...,
+        ref: Union[str, _NotSetType] = ...,
+        task: Union[str, _NotSetType] = ...,
+        environment: Union[str, _NotSetType] = ...,
+    ) -> PaginatedList[Deployment]: ...
     def get_dir_contents(
         self, path: str, ref: Union[str, _NotSetType] = ...
     ) -> List[ContentFile]: ...