############################ Copyrights and license ############################ # # # Copyright 2012 Vincent Jacques # # Copyright 2012 Zearin # # Copyright 2013 AKFish # # Copyright 2013 Vincent Jacques # # Copyright 2014 Vincent Jacques # # Copyright 2016 Jannis Gebauer # # Copyright 2016 Peter Buckley # # Copyright 2017 Jannis Gebauer # # Copyright 2017 Simon # # Copyright 2018 sfdye # # Copyright 2019 Steve Kowalik # # Copyright 2019 Wan Liuyang # # Copyright 2020 Steve Kowalik # # Copyright 2021 Steve Kowalik # # Copyright 2023 Andrew Dawes <53574062+AndrewJDawes@users.noreply.github.com> # # Copyright 2023 Enrico Minack # # Copyright 2023 Trim21 # # Copyright 2023 alson # # Copyright 2024 Enrico Minack # # Copyright 2024 Jirka Borovec <6035284+Borda@users.noreply.github.com> # # Copyright 2025 Enrico Minack # # # # 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 . # # # ################################################################################ from __future__ import annotations import urllib.parse from datetime import datetime from typing import TYPE_CHECKING, Any import github.EnvironmentDeploymentBranchPolicy import github.EnvironmentProtectionRule import github.PublicKey import github.Secret import github.Variable from github.GithubObject import Attribute, CompletableGithubObject, NotSet from github.PaginatedList import PaginatedList if TYPE_CHECKING: from github.EnvironmentDeploymentBranchPolicy import EnvironmentDeploymentBranchPolicy from github.EnvironmentProtectionRule import EnvironmentProtectionRule from github.PublicKey import PublicKey from github.Secret import Secret from github.Variable import Variable class Environment(CompletableGithubObject): """ This class represents Environment. The reference can be found here https://docs.github.com/en/rest/reference/deployments#environments The OpenAPI schema can be found at - /components/schemas/environment """ def _initAttributes(self) -> None: self._created_at: Attribute[datetime] = NotSet self._deployment_branch_policy: Attribute[EnvironmentDeploymentBranchPolicy] = NotSet self._environments_url: Attribute[str] = NotSet self._html_url: Attribute[str] = NotSet self._id: Attribute[int] = NotSet self._name: Attribute[str] = NotSet self._node_id: Attribute[str] = NotSet self._protection_rules: Attribute[list[EnvironmentProtectionRule]] = NotSet self._updated_at: Attribute[datetime] = NotSet self._url: Attribute[str] = NotSet def __repr__(self) -> str: return self.get__repr__({"name": self._name.value}) @property def created_at(self) -> datetime: self._completeIfNotSet(self._created_at) return self._created_at.value @property def deployment_branch_policy( self, ) -> EnvironmentDeploymentBranchPolicy: self._completeIfNotSet(self._deployment_branch_policy) return self._deployment_branch_policy.value @property def environments_url(self) -> str: """ :type: string """ return self._environments_url.value @property def html_url(self) -> str: self._completeIfNotSet(self._html_url) return self._html_url.value @property def id(self) -> int: self._completeIfNotSet(self._id) return self._id.value @property def name(self) -> str: self._completeIfNotSet(self._name) return self._name.value @property def node_id(self) -> str: self._completeIfNotSet(self._node_id) return self._node_id.value @property def protection_rules( self, ) -> list[EnvironmentProtectionRule]: self._completeIfNotSet(self._protection_rules) return self._protection_rules.value @property def updated_at(self) -> datetime: self._completeIfNotSet(self._updated_at) return self._updated_at.value @property def url(self) -> str: """ :type: string """ # Construct url from environments_url and name, if self._url. is not set if self._url is NotSet: self._url = self._makeStringAttribute(self.environments_url + "/" + self.name) return self._url.value def get_public_key(self) -> PublicKey: """ :calls: `GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key `_ :rtype: :class:`PublicKey` """ # https://stackoverflow.com/a/76474814 # https://docs.github.com/en/rest/secrets?apiVersion=2022-11-28#get-an-environment-public-key headers, data = self._requester.requestJsonAndCheck("GET", f"{self.url}/secrets/public-key") return github.PublicKey.PublicKey(self._requester, headers, data, completed=True) def create_secret(self, secret_name: str, unencrypted_value: str) -> Secret: """ :calls: `PUT /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name} `_ """ assert isinstance(secret_name, str), secret_name assert isinstance(unencrypted_value, str), unencrypted_value public_key = self.get_public_key() payload = public_key.encrypt(unencrypted_value) put_parameters = { "key_id": public_key.key_id, "encrypted_value": payload, } quoted_secret_name = urllib.parse.quote(secret_name, safe="") url = f"{self.url}/secrets/{quoted_secret_name}" self._requester.requestJsonAndCheck("PUT", url, input=put_parameters) return github.Secret.Secret( self._requester, url=url, attributes={"name": secret_name}, completed=False, ) def get_secrets(self) -> PaginatedList[Secret]: """ Gets all repository secrets. :calls: `GET /repos/{owner}/{repo}/environments/{environment_name}/secrets `_ """ return PaginatedList( github.Secret.Secret, self._requester, f"{self.url}/secrets", None, attributesTransformer=PaginatedList.override_attributes({"secrets_url": f"{self.url}/secrets"}), list_item="secrets", ) def get_secret(self, secret_name: str) -> Secret: """ :calls: `GET /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name} `_ """ assert isinstance(secret_name, str), secret_name secret_name = urllib.parse.quote(secret_name, safe="") return github.Secret.Secret(self._requester, url=f"{self.url}/secrets/{secret_name}") def create_variable(self, variable_name: str, value: str) -> Variable: """ :calls: `POST /repos/{owner}/{repo}/environments/{environment_name}/variables/{name} `_ """ assert isinstance(variable_name, str), variable_name assert isinstance(value, str), value post_parameters = { "name": variable_name, "value": value, } self._requester.requestJsonAndCheck("POST", f"{self.url}/variables", input=post_parameters) quoted_variable_name = urllib.parse.quote(variable_name, safe="") url = f"{self.url}/variables/{quoted_variable_name}" return github.Variable.Variable( self._requester, url=url, attributes={ "name": variable_name, "value": value, }, completed=False, ) def get_variables(self) -> PaginatedList[Variable]: """ Gets all repository variables :rtype: :class:`PaginatedList` of :class:`Variable` """ return PaginatedList( github.Variable.Variable, self._requester, f"{self.url}/variables", None, attributesTransformer=PaginatedList.override_attributes({"variables_url": f"{self.url}/variables"}), list_item="variables", ) def get_variable(self, variable_name: str) -> Variable: """ :calls: `GET /repos/{owner}/{repo}/environments/{environment_name}/variables/{name} `_ :param variable_name: string :rtype: Variable """ assert isinstance(variable_name, str), variable_name variable_name = urllib.parse.quote(variable_name, safe="") url = f"{self.url}/variables/{variable_name}" return github.Variable.Variable(self._requester, url=url) def delete_secret(self, secret_name: str) -> bool: """ :calls: `DELETE /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name} `_ :param secret_name: string :rtype: bool """ assert isinstance(secret_name, str), secret_name status, headers, data = self._requester.requestJson("DELETE", f"{self.url}/secrets/{secret_name}") return status == 204 def delete_variable(self, variable_name: str) -> bool: """ :calls: `DELETE /repos/{owner}/{repo}/environments/{environment_name}/variables/{name} `_ :param variable_name: string :rtype: bool """ assert isinstance(variable_name, str), variable_name status, headers, data = self._requester.requestJson("DELETE", f"{self.url}/variables/{variable_name}") return status == 204 def _useAttributes(self, attributes: dict[str, Any]) -> None: if "created_at" in attributes: # pragma no branch self._created_at = self._makeDatetimeAttribute(attributes["created_at"]) if "deployment_branch_policy" in attributes: # pragma no branch self._deployment_branch_policy = self._makeClassAttribute( github.EnvironmentDeploymentBranchPolicy.EnvironmentDeploymentBranchPolicy, attributes["deployment_branch_policy"], ) if "environments_url" in attributes: self._environments_url = self._makeStringAttribute(attributes["environments_url"]) if "html_url" in attributes: # pragma no branch self._html_url = self._makeStringAttribute(attributes["html_url"]) if "id" in attributes: # pragma no branch self._id = self._makeIntAttribute(attributes["id"]) if "name" in attributes: # pragma no branch self._name = self._makeStringAttribute(attributes["name"]) elif "url" in attributes and attributes["url"]: quoted_name = attributes["url"].split("/")[-1] name = urllib.parse.unquote(quoted_name) self._name = self._makeStringAttribute(name) if "node_id" in attributes: # pragma no branch self._node_id = self._makeStringAttribute(attributes["node_id"]) if "protection_rules" in attributes: # pragma no branch self._protection_rules = self._makeListOfClassesAttribute( github.EnvironmentProtectionRule.EnvironmentProtectionRule, attributes["protection_rules"], ) if "updated_at" in attributes: # pragma no branch self._updated_at = self._makeDatetimeAttribute(attributes["updated_at"]) if "url" in attributes: # pragma no branch self._url = self._makeStringAttribute(attributes["url"])