mirror of
https://github.com/ansible-collections/hetzner.hcloud.git
synced 2026-02-04 08:01:49 +00:00
feat: vendor hcloud python dependency (#244)
* chore: ignore venv directories * chore: ignore integration test generated inventory * feat: vendor hcloud package * import https://github.com/hetznercloud/hcloud-python * use vendored hcloud in modules * update integration test requirements * make vendor script self contained * chore: add check-hcloud-vendor pre-commit hook * pin hcloud version to v.1.24.0 * move vendored __version__.py file to _version.py * update comment about galaxy-importer filename lint
This commit is contained in:
Jonas L
GitHub
parent
5190535323
commit
8a6157e8b2
84 changed files with 8433 additions and 79 deletions
316
plugins/module_utils/vendor/hcloud/certificates/client.py
vendored
Normal file
316
plugins/module_utils/vendor/hcloud/certificates/client.py
vendored
Normal file
|
|
@ -0,0 +1,316 @@
|
|||
from ..actions.client import BoundAction
|
||||
from ..core.client import BoundModelBase, ClientEntityBase, GetEntityByNameMixin
|
||||
from ..core.domain import add_meta_to_result
|
||||
from .domain import (
|
||||
Certificate,
|
||||
CreateManagedCertificateResponse,
|
||||
ManagedCertificateError,
|
||||
ManagedCertificateStatus,
|
||||
)
|
||||
|
||||
|
||||
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().__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.
|
||||
|
||||
:param name: str (optional)
|
||||
New name to set
|
||||
:param labels: Dict[str, str] (optional)
|
||||
User-defined labels (key-value pairs)
|
||||
:return: :class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>
|
||||
"""
|
||||
return self._client.update(self, name, labels)
|
||||
|
||||
def delete(self):
|
||||
# type: () -> bool
|
||||
"""Deletes a certificate.
|
||||
:return: boolean
|
||||
"""
|
||||
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"
|
||||
|
||||
def get_by_id(self, id):
|
||||
# type: (int) -> BoundCertificate
|
||||
"""Get a specific certificate by its ID.
|
||||
|
||||
:param id: int
|
||||
:return: :class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>`
|
||||
"""
|
||||
response = self._client.request(url=f"/certificates/{id}", method="GET")
|
||||
return BoundCertificate(self, response["certificate"])
|
||||
|
||||
def get_list(
|
||||
self,
|
||||
name=None, # type: Optional[str]
|
||||
label_selector=None, # type: Optional[str]
|
||||
page=None, # type: Optional[int]
|
||||
per_page=None, # type: Optional[int]
|
||||
):
|
||||
# type: (...) -> PageResults[List[BoundCertificate], Meta]
|
||||
"""Get a list of certificates
|
||||
|
||||
:param name: str (optional)
|
||||
Can be used to filter certificates by their name.
|
||||
:param label_selector: str (optional)
|
||||
Can be used to filter certificates by labels. The response will only contain certificates matching the label selector.
|
||||
: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:`BoundCertificate <hcloud.certificates.client.BoundCertificate>`], :class:`Meta <hcloud.core.domain.Meta>`)
|
||||
"""
|
||||
params = {}
|
||||
if name is not None:
|
||||
params["name"] = name
|
||||
|
||||
if label_selector is not None:
|
||||
params["label_selector"] = label_selector
|
||||
|
||||
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", method="GET", params=params
|
||||
)
|
||||
|
||||
certificates = [
|
||||
BoundCertificate(self, certificate_data)
|
||||
for certificate_data in response["certificates"]
|
||||
]
|
||||
|
||||
return self._add_meta_to_result(certificates, response)
|
||||
|
||||
def get_all(self, name=None, label_selector=None):
|
||||
# type: (Optional[str], Optional[str]) -> List[BoundCertificate]
|
||||
"""Get all certificates
|
||||
|
||||
:param name: str (optional)
|
||||
Can be used to filter certificates by their name.
|
||||
:param label_selector: str (optional)
|
||||
Can be used to filter certificates by labels. The response will only contain certificates matching the label selector.
|
||||
:return: List[:class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>`]
|
||||
"""
|
||||
return super().get_all(name=name, label_selector=label_selector)
|
||||
|
||||
def get_by_name(self, name):
|
||||
# type: (str) -> BoundCertificate
|
||||
"""Get certificate by name
|
||||
|
||||
:param name: str
|
||||
Used to get certificate by name.
|
||||
:return: :class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>`
|
||||
"""
|
||||
return super().get_by_name(name)
|
||||
|
||||
def create(self, name, certificate, private_key, labels=None):
|
||||
# type: (str, str, str, Optional[Dict[str, str]]) -> BoundCertificate
|
||||
"""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
|
||||
Certificate and chain in PEM format, in order so that each record directly certifies the one preceding
|
||||
:param private_key: str
|
||||
Certificate key in PEM format
|
||||
:param labels: Dict[str, str] (optional)
|
||||
User-defined labels (key-value pairs)
|
||||
:return: :class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>`
|
||||
"""
|
||||
data = {
|
||||
"name": name,
|
||||
"certificate": certificate,
|
||||
"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.
|
||||
|
||||
:param certificate: :class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>` or :class:`Certificate <hcloud.certificates.domain.Certificate>`
|
||||
:param name: str (optional)
|
||||
New name to set
|
||||
:param labels: Dict[str, str] (optional)
|
||||
User-defined labels (key-value pairs)
|
||||
:return: :class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>`
|
||||
"""
|
||||
data = {}
|
||||
if name is not None:
|
||||
data["name"] = name
|
||||
if labels is not None:
|
||||
data["labels"] = labels
|
||||
response = self._client.request(
|
||||
url=f"/certificates/{certificate.id}",
|
||||
method="PUT",
|
||||
json=data,
|
||||
)
|
||||
return BoundCertificate(self, response["certificate"])
|
||||
|
||||
def delete(self, certificate):
|
||||
# type: (Certificate) -> bool
|
||||
self._client.request(
|
||||
url=f"/certificates/{certificate.id}",
|
||||
method="DELETE",
|
||||
)
|
||||
"""Deletes a certificate.
|
||||
|
||||
:param certificate: :class:`BoundCertificate <hcloud.certificates.client.BoundCertificate>` or :class:`Certificate <hcloud.certificates.domain.Certificate>`
|
||||
:return: True
|
||||
"""
|
||||
# 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().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"])
|
||||
Loading…
Add table
Add a link
Reference in a new issue