Add managed certificate support (#116)

LKaemmerling · web-flow · commit b28e68314e07 · 2021-04-06T10:59:55.000+02:00
Signed-off-by: Lukas Kämmerling &lt;lukas.kaemmerling@hetzner-cloud.de&gt;
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,6 +2,10 @@
 History
 =======
 
+v1.12.0 (2021-04-06)
+---------------------
+* Feature: Add support for managed Certificates
+
 v1.11.0 (2021-03-11)
 ---------------------
 * Feature: Add support for Firewalls
diff --git a/hcloud/__version__.py b/hcloud/__version__.py
@@ -1 +1 @@
-VERSION = '1.11.0'
+VERSION = '1.12.0'
diff --git a/hcloud/certificates/client.py b/hcloud/certificates/client.py
@@ -1,12 +1,55 @@
 # -*- coding: utf-8 -*-
+from hcloud.actions.client import BoundAction
 from hcloud.core.client import ClientEntityBase, BoundModelBase, GetEntityByNameMixin
 
-from hcloud.certificates.domain import Certificate
+from hcloud.certificates.domain import Certificate, CreateManagedCertificateResponse, ManagedCertificateStatus, ManagedCertificateError
+from hcloud.core.domain import add_meta_to_result
 
 
 class BoundCertificate(BoundModelBase):
     model = Certificate
 
+    def __init__(self, client, data, complete=True):
+        status = data.get('status')
+        if status is not None:
+            error_data = status.get('error')
+            error = None
+            if error_data:
+                error = ManagedCertificateError(code=error_data['code'], message=error_data['message'])
+            data['status'] = ManagedCertificateStatus(
+                issuance=status['issuance'],
+                renewal=status['renewal'],
+                error=error)
+        super(BoundCertificate, self).__init__(client, data, complete)
+
+    def get_actions_list(self, status=None, sort=None, page=None, per_page=None):
+        # type: (Optional[List[str]], Optional[List[str]], Optional[int], Optional[int]) -> PageResults[List[BoundAction, Meta]]
+        """Returns all action objects for a Certificate.
+
+        :param status: List[str] (optional)
+               Response will have only actions with specified statuses. Choices: `running` `success` `error`
+        :param sort: List[str] (optional)
+               Specify how the results are sorted. Choices: `id` `id:asc` `id:desc` `command` `command:asc` `command:desc` `status` `status:asc` `status:desc` `progress` `progress:asc` `progress:desc` `started` `started:asc` `started:desc` `finished` `finished:asc` `finished:desc`
+        :param page: int (optional)
+               Specifies the page to fetch
+        :param per_page: int (optional)
+               Specifies how many results are returned by page
+        :return: (List[:class:`BoundAction <hcloud.actions.client.BoundAction>`], :class:`Meta <hcloud.core.domain.Meta>`)
+        """
+        return self._client.get_actions_list(self, status, sort, page, per_page)
+
+    def get_actions(self, status=None, sort=None):
+        # type: (Optional[List[str]], Optional[List[str]]) -> List[BoundAction]
+        """Returns all action objects for a Certificate.
+
+        :param status: List[str] (optional)
+               Response will have only actions with specified statuses. Choices: `running` `success` `error`
+        :param sort: List[str] (optional)
+               Specify how the results are sorted. Choices: `id` `id:asc` `id:desc` `command` `command:asc` `command:desc` `status` `status:asc` `status:desc` `progress` `progress:asc` `progress:desc` `started` `started:asc` `started:desc` `finished` `finished:asc` `finished:desc`
+        :return: List[:class:`BoundAction <hcloud.actions.client.BoundAction>`]
+        """
+        return self._client.get_actions(self, status, sort)
+
     def update(self, name=None, labels=None):
         # type: (Optional[str], Optional[Dict[str, str]]) -> BoundCertificate
         """Updates an certificate. You can update an certificate name and the certificate labels.
@@ -26,6 +69,13 @@ def delete(self):
         """
         return self._client.delete(self)
 
+    def retry_issuance(self):
+        # type: () -> BoundAction
+        """Retry a failed Certificate issuance or renewal.
+           :return: BoundAction
+        """
+        return self._client.retry_issuance(self)
+
 
 class CertificatesClient(ClientEntityBase, GetEntityByNameMixin):
     results_list_attribute_name = 'certificates'
@@ -102,7 +152,8 @@ def get_by_name(self, name):
 
     def create(self, name, certificate, private_key, labels=None):
         # type: (str, str, Optional[Dict[str, str]]) -> BoundCertificate
-        """Creates a new Certificate with the given name, certificate and private_key.
+        """Creates a new Certificate with the given name, certificate and private_key. This methods allows only creating
+           custom uploaded certificates. If you want to create a managed certificate use :func:`~hcloud.certificates.client.CertificatesClient.create_managed`
 
         :param name: str
         :param certificate: str
@@ -116,13 +167,37 @@ def create(self, name, certificate, private_key, labels=None):
         data = {
             'name': name,
             'certificate': certificate,
-            'private_key': private_key
+            'private_key': private_key,
+            'type': Certificate.TYPE_UPLOADED
         }
         if labels is not None:
             data['labels'] = labels
         response = self._client.request(url="/certificates", method="POST", json=data)
         return BoundCertificate(self, response['certificate'])
 
+    def create_managed(self, name, domain_names, labels=None):
+        # type: (str, List[str], Optional[Dict[str, str]]) -> CreateManagedCertificateResponse
+        """Creates a new managed Certificate with the given name and domain names. This methods allows only creating
+           managed certificates for domains that are using the Hetzner DNS service. If you want to create a custom uploaded certificate use :func:`~hcloud.certificates.client.CertificatesClient.create`
+
+        :param name: str
+        :param domain_names: List[str]
+               Domains and subdomains that should be contained in the Certificate
+        :param labels: Dict[str, str] (optional)
+               User-defined labels (key-value pairs)
+        :return: :class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>`
+        """
+        data = {
+            'name': name,
+            'type': Certificate.TYPE_MANAGED,
+            'domain_names': domain_names
+        }
+        if labels is not None:
+            data['labels'] = labels
+        response = self._client.request(url="/certificates", method="POST", json=data)
+        return CreateManagedCertificateResponse(certificate=BoundCertificate(self, response['certificate']),
+                                                action=BoundAction(self._client.actions, response['action']))
+
     def update(self, certificate, name=None, labels=None):
         # type: (Certificate,  Optional[str],  Optional[Dict[str, str]]) -> BoundCertificate
         """Updates a Certificate. You can update a certificate name and labels.
@@ -155,3 +230,67 @@ def delete(self, certificate):
         """
         # Return always true, because the API does not return an action for it. When an error occurs a HcloudAPIException will be raised
         return True
+
+    def get_actions_list(
+            self, certificate, status=None, sort=None, page=None, per_page=None
+    ):
+        # type: (Certificate, Optional[List[str]], Optional[List[str]], Optional[int], Optional[int]) -> PageResults[List[BoundAction], Meta]
+        """Returns all action objects for a Certificate.
+
+        :param certificate: :class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>` or :class:`Certificate <hcloud.certificates.domain.Certificate>`
+        :param status: List[str] (optional)
+               Response will have only actions with specified statuses. Choices: `running` `success` `error`
+        :param sort: List[str] (optional)
+               Specify how the results are sorted. Choices: `id` `id:asc` `id:desc` `command` `command:asc` `command:desc` `status` `status:asc` `status:desc` `progress` `progress:asc` `progress:desc` `started` `started:asc` `started:desc` `finished` `finished:asc` `finished:desc`
+        :param page: int (optional)
+               Specifies the page to fetch
+        :param per_page: int (optional)
+               Specifies how many results are returned by page
+        :return: (List[:class:`BoundAction <hcloud.actions.client.BoundAction>`], :class:`Meta <hcloud.core.domain.Meta>`)
+        """
+        params = {}
+        if status is not None:
+            params["status"] = status
+        if sort is not None:
+            params["sort"] = sort
+        if page is not None:
+            params["page"] = page
+        if per_page is not None:
+            params["per_page"] = per_page
+
+        response = self._client.request(
+            url="/certificates/{certificate_id}/actions".format(certificate_id=certificate.id),
+            method="GET",
+            params=params,
+        )
+        actions = [
+            BoundAction(self._client.actions, action_data)
+            for action_data in response["actions"]
+        ]
+        return add_meta_to_result(actions, response, "actions")
+
+    def get_actions(self, certificate, status=None, sort=None):
+        # type: (Certificate, Optional[List[str]], Optional[List[str]]) -> List[BoundAction]
+        """Returns all action objects for a Certificate.
+
+        :param certificate: :class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>` or :class:`Certificate <hcloud.certificates.domain.Certificate>`
+        :param status: List[str] (optional)
+               Response will have only actions with specified statuses. Choices: `running` `success` `error`
+        :param sort: List[str] (optional)
+               Specify how the results are sorted. Choices: `id` `id:asc` `id:desc` `command` `command:asc` `command:desc` `status` `status:asc` `status:desc` `progress` `progress:asc` `progress:desc` `started` `started:asc` `started:desc` `finished` `finished:asc` `finished:desc`
+        :return: List[:class:`BoundAction <hcloud.actions.client.BoundAction>`]
+        """
+        return super(CertificatesClient, self).get_actions(
+            certificate, status=status, sort=sort
+        )
+
+    def retry_issuance(self, certificate):
+        # type: (Certificate) -> BoundAction
+        """Returns all action objects for a Certificate.
+
+        :param certificate: :class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>` or :class:`Certificate <hcloud.certificates.domain.Certificate>`
+        :return: :class:`BoundAction <hcloud.actions.client.BoundAction>`
+        """
+        response = self._client.request(url="/certificates/{certificate_id}/actions/retry".format(certificate_id=certificate.id),
+                                        method="POST")
+        return BoundAction(self._client.actions, response['action'])
diff --git a/hcloud/certificates/domain.py b/hcloud/certificates/domain.py
@@ -20,6 +20,8 @@ class Certificate(BaseDomain, DomainIdentityMixin):
            User-defined labels (key-value pairs)
     :param created: datetime
            Point in time when the certificate was created
+    :param type: str Type of Certificate
+    :param status: ManagedCertificateStatus Current status of a type managed Certificate, always none for type uploaded Certificates
     """
     __slots__ = (
         "id",
@@ -31,7 +33,11 @@ class Certificate(BaseDomain, DomainIdentityMixin):
         "fingerprint",
         "created",
         "labels",
+        "type",
+        "status"
     )
+    TYPE_UPLOADED = "uploaded"
+    TYPE_MANAGED = "managed"
 
     def __init__(
             self,
@@ -44,13 +50,69 @@ def __init__(
             fingerprint=None,
             created=None,
             labels=None,
+            type=None,
+            status=None,
     ):
         self.id = id
         self.name = name
+        self.type = type
         self.certificate = certificate
         self.domain_names = domain_names
         self.fingerprint = fingerprint
         self.not_valid_before = isoparse(not_valid_before) if not_valid_before else None
         self.not_valid_after = isoparse(not_valid_after) if not_valid_after else None
         self.created = isoparse(created) if created else None
         self.labels = labels
+        self.status = status
+
+
+class ManagedCertificateStatus(BaseDomain):
+    """ManagedCertificateStatus Domain
+
+    :param issuance: str
+           Status of the issuance process of the Certificate
+    :param renewal: str
+           Status of the renewal process of the Certificate
+    :param error: ManagedCertificateError
+          If issuance or renewal reports failure, this property contains information about what happened
+        """
+
+    def __init__(self, issuance=None, renewal=None, error=None):
+        self.issuance = issuance
+        self.renewal = renewal
+        self.error = error
+
+
+class ManagedCertificateError(BaseDomain):
+    """ManagedCertificateError Domain
+
+    :param code: str
+        Error code identifying the error
+    :param message:
+        Message detailing the error
+    """
+    def __init__(self, code=None, message=None):
+        self.code = code
+        self.message = message
+
+
+class CreateManagedCertificateResponse(BaseDomain):
+    """Create Managed Certificate Response Domain
+
+    :param certificate: :class:`BoundCertificate <hcloud.certificate.client.BoundCertificate>`
+           The created server
+    :param action: :class:`BoundAction <hcloud.actions.client.BoundAction>`
+           Shows the progress of the certificate creation
+    """
+    __slots__ = (
+        "certificate",
+        "action",
+    )
+
+    def __init__(
+            self,
+            certificate,  # type: BoundCertificate
+            action,  # type: BoundAction
+    ):
+        self.certificate = certificate
+        self.action = action
diff --git a/tests/unit/certificates/conftest.py b/tests/unit/certificates/conftest.py
diff --git a/tests/unit/certificates/test_client.py b/tests/unit/certificates/test_client.py

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-VERSION = '1.11.0'`
	`1`	`+VERSION = '1.12.0'`