qontract-reconcile 0.10.1rc837__py3-none-any.whl → 0.10.1rc839__py3-none-any.whl

reconcile/gql_definitions/jenkins_configs/jenkins_instances.py

@@ -0,0 +1,79 @@
+"""
+Generated by qenerate plugin=pydantic_v1. DO NOT MODIFY MANUALLY!
+"""
+from collections.abc import Callable  # noqa: F401 # pylint: disable=W0611
+from datetime import datetime  # noqa: F401 # pylint: disable=W0611
+from enum import Enum  # noqa: F401 # pylint: disable=W0611
+from typing import (  # noqa: F401 # pylint: disable=W0611
+    Any,
+    Optional,
+    Union,
+)
+
+from pydantic import (  # noqa: F401 # pylint: disable=W0611
+    BaseModel,
+    Extra,
+    Field,
+    Json,
+)
+
+from reconcile.gql_definitions.fragments.vault_secret import VaultSecret
+
+
+DEFINITION = """
+fragment VaultSecret on VaultSecret_v1 {
+    path
+    field
+    version
+    format
+}
+
+query JenkinsInstances {
+  instances: jenkins_instances_v1 {
+    name
+    description
+    serverUrl
+    token {
+      ... VaultSecret
+    }
+    deleteMethod
+  }
+}
+"""
+
+
+class ConfiguredBaseModel(BaseModel):
+    class Config:
+        smart_union=True
+        extra=Extra.forbid
+
+
+class JenkinsInstanceV1(ConfiguredBaseModel):
+    name: str = Field(..., alias="name")
+    description: str = Field(..., alias="description")
+    server_url: str = Field(..., alias="serverUrl")
+    token: VaultSecret = Field(..., alias="token")
+    delete_method: Optional[str] = Field(..., alias="deleteMethod")
+
+
+class JenkinsInstancesQueryData(ConfiguredBaseModel):
+    instances: Optional[list[JenkinsInstanceV1]] = Field(..., alias="instances")
+
+
+def query(query_func: Callable, **kwargs: Any) -> JenkinsInstancesQueryData:
+    """
+    This is a convenience function which queries and parses the data into
+    concrete types. It should be compatible with most GQL clients.
+    You do not have to use it to consume the generated data classes.
+    Alternatively, you can also mime and alternate the behavior
+    of this function in the caller.
+
+    Parameters:
+        query_func (Callable): Function which queries your GQL Server
+        kwargs: optional arguments that will be passed to the query function
+
+    Returns:
+        JenkinsInstancesQueryData: queried data parsed into generated classes
+    """
+    raw_data: dict[Any, Any] = query_func(DEFINITION, **kwargs)
+    return JenkinsInstancesQueryData(**raw_data)

reconcile/gql_definitions/jira/jira_servers.py

@@ -21,6 +21,8 @@ from pydantic import (  # noqa: F401 # pylint: disable=W0611
 DEFINITION = """
 query JiraServers {
   jira_servers: jira_servers_v1 {
+    name
+    description
     serverUrl
     username
     token {
@@ -48,6 +50,8 @@ class VaultSecretV1(ConfiguredBaseModel):
 
 
 class JiraServerV1(ConfiguredBaseModel):
+    name: str = Field(..., alias="name")
+    description: str = Field(..., alias="description")
     server_url: str = Field(..., alias="serverUrl")
     username: str = Field(..., alias="username")
     token: VaultSecretV1 = Field(..., alias="token")

reconcile/gql_definitions/ocm_labels/clusters.py

@@ -23,6 +23,7 @@ from reconcile.gql_definitions.fragments.ocm_environment import OCMEnvironment
 DEFINITION = """
 fragment OCMEnvironment on OpenShiftClusterManagerEnvironment_v1 {
     name
+    description
     labels
     url
     accessTokenClientId

reconcile/gql_definitions/openshift_cluster_bots/clusters.py

@@ -24,6 +24,7 @@ from reconcile.gql_definitions.fragments.vault_secret import VaultSecret
 DEFINITION = """
 fragment OCMEnvironment on OpenShiftClusterManagerEnvironment_v1 {
     name
+    description
     labels
     url
     accessTokenClientId

reconcile/gql_definitions/rhidp/organizations.py

@@ -28,6 +28,7 @@ fragment DisableAutomations on DisableClusterAutomations_v1 {
 
 fragment OCMEnvironment on OpenShiftClusterManagerEnvironment_v1 {
     name
+    description
     labels
     url
     accessTokenClientId

reconcile/gql_definitions/statuspage/statuspages.py

@@ -31,7 +31,9 @@ fragment VaultSecret on VaultSecret_v1 {
 query StatusPages {
   status_pages: status_page_v1 {
     name
+    description
     pageId
+    url
     apiUrl
     credentials {
       ...VaultSecret
@@ -145,7 +147,9 @@ class MaintenanceV1(ConfiguredBaseModel):
 
 class StatusPageV1(ConfiguredBaseModel):
     name: str = Field(..., alias="name")
+    description: str = Field(..., alias="description")
     page_id: str = Field(..., alias="pageId")
+    url: Optional[str] = Field(..., alias="url")
     api_url: str = Field(..., alias="apiUrl")
     credentials: VaultSecret = Field(..., alias="credentials")
     components: Optional[list[StatusPageComponentV1]] = Field(..., alias="components")

reconcile/gql_definitions/terraform_cloudflare_resources/terraform_cloudflare_accounts.py

@@ -31,6 +31,7 @@ fragment VaultSecret on VaultSecret_v1 {
 query TerraformCloudflareAccounts {
   accounts: cloudflare_accounts_v1 {
     name
+    description
     providerVersion
     apiCredentials {
       ... VaultSecret
@@ -94,6 +95,7 @@ class DeletionApprovalV1(ConfiguredBaseModel):
 
 class CloudflareAccountV1(ConfiguredBaseModel):
     name: str = Field(..., alias="name")
+    description: Optional[str] = Field(..., alias="description")
     provider_version: str = Field(..., alias="providerVersion")
     api_credentials: VaultSecret = Field(..., alias="apiCredentials")
     terraform_state_account: AWSAccountV1 = Field(..., alias="terraformStateAccount")

reconcile/gql_definitions/terraform_tgw_attachments/aws_accounts.py

@@ -25,6 +25,7 @@ DEFINITION = """
 fragment AWSAccountCommon on AWSAccount_v1 {
   path
   name
+  description
   uid
   terraformUsername
   consoleUrl

reconcile/gql_definitions/unleash_feature_toggles/feature_toggles.py

@@ -31,6 +31,7 @@ fragment VaultSecret on VaultSecret_v1 {
 query UnleashFeatureToggles {
   instances: unleash_instances_v1 {
     name
+    description
     url
     adminToken {
       ...VaultSecret
@@ -82,6 +83,7 @@ class UnleashProjectV1(ConfiguredBaseModel):
 
 class UnleashInstanceV1(ConfiguredBaseModel):
     name: str = Field(..., alias="name")
+    description: str = Field(..., alias="description")
     url: str = Field(..., alias="url")
     admin_token: Optional[VaultSecret] = Field(..., alias="adminToken")
     allow_unmanaged_feature_toggles: Optional[bool] = Field(..., alias="allowUnmanagedFeatureToggles")

reconcile/gql_definitions/vault_instances/vault_instances.py

@@ -31,6 +31,7 @@ fragment VaultSecret on VaultSecret_v1 {
 query VaultInstances {
   vault_instances: vault_instances_v1 {
     name
+    description
     address
     auth {
       provider
@@ -215,6 +216,7 @@ class VaultReplicationConfigV1(ConfiguredBaseModel):
 
 class VaultInstanceV1(ConfiguredBaseModel):
     name: str = Field(..., alias="name")
+    description: str = Field(..., alias="description")
     address: str = Field(..., alias="address")
     auth: Union[VaultInstanceAuthApproleV1, VaultInstanceAuthV1] = Field(..., alias="auth")
     replication: Optional[list[VaultReplicationConfigV1]] = Field(..., alias="replication")

reconcile/statuspage/page.py

@@ -145,13 +145,16 @@ class StatusMaintenance(BaseModel):
             for c in page_components
             if c.app.name in affected_services
         ]
-        statuspage_announcements = [
-            StatusMaintenanceAnnouncement.init_from_announcement(
-                cast(MaintenanceStatuspageAnnouncementV1, m)
-            )
-            for m in maintenance.announcements or []
-            if m.provider == PROVIDER_NAME
-        ]
+        if affected_components:
+            statuspage_announcements = [
+                StatusMaintenanceAnnouncement.init_from_announcement(
+                    cast(MaintenanceStatuspageAnnouncementV1, m)
+                )
+                for m in maintenance.announcements or []
+                if m.provider == PROVIDER_NAME
+            ]
+        else:
+            statuspage_announcements = [StatusMaintenanceAnnouncement()]
         if len(statuspage_announcements) != 1:
             raise ValueError(
                 f"Maintenanace announcements must include exactly one item of provider {PROVIDER_NAME}"

reconcile/test/test_gitlab_members.py

@@ -27,6 +27,8 @@ from reconcile.utils.pagerduty_api import PagerDutyMap
 @pytest.fixture()
 def instance(vault_secret: VaultSecret) -> GitlabInstanceV1:
     return GitlabInstanceV1(
+        name="gitlab",
+        description="gitlab",
         url="http://foobar.com",
         token=vault_secret,
         sslVerify=False,

reconcile/test/test_terraform_cloudflare_resources.py

@@ -213,6 +213,7 @@ def mock_cloudflare_accounts(mocker):
             accounts=[
                 CFAccountV1(
                     name="cfaccount",
+                    description="cfaccount",
                     providerVersion="0.33.x",
                     apiCredentials=VaultSecret(
                         path="cf-account-path",

reconcile/typed_queries/cloudflare.py

@@ -0,0 +1,10 @@
+from reconcile.gql_definitions.terraform_cloudflare_resources.terraform_cloudflare_accounts import (
+    CloudflareAccountV1,
+    query,
+)
+from reconcile.utils import gql
+
+
+def get_cloudflare_accounts() -> list[CloudflareAccountV1]:
+    data = query(gql.get_api().query)
+    return list(data.accounts or [])

reconcile/typed_queries/dynatrace.py

@@ -0,0 +1,10 @@
+from reconcile.gql_definitions.dynatrace_token_provider.dynatrace_bootstrap_tokens import (
+    DynatraceEnvironmentV1,
+    query,
+)
+from reconcile.utils import gql
+
+
+def get_dynatrace_environments() -> list[DynatraceEnvironmentV1]:
+    data = query(gql.get_api().query)
+    return list(data.environments or [])

reconcile/typed_queries/glitchtip.py

@@ -0,0 +1,10 @@
+from reconcile.gql_definitions.glitchtip.glitchtip_instance import (
+    GlitchtipInstanceV1,
+    query,
+)
+from reconcile.utils import gql
+
+
+def get_glitchtip_instances() -> list[GlitchtipInstanceV1]:
+    data = query(gql.get_api().query)
+    return list(data.instances or [])

reconcile/typed_queries/jenkins.py

@@ -0,0 +1,11 @@
+from reconcile.gql_definitions.jenkins_configs.jenkins_instances import (
+    JenkinsInstanceV1,
+    query,
+)
+from reconcile.utils import gql
+
+
+def get_jenkins_instances() -> list[JenkinsInstanceV1]:
+    gqlapi = gql.get_api()
+    data = query(gqlapi.query)
+    return list(data.instances or [])

reconcile/typed_queries/jira.py

@@ -0,0 +1,7 @@
+from reconcile.gql_definitions.jira.jira_servers import JiraServerV1, query
+from reconcile.utils import gql
+
+
+def get_jira_servers() -> list[JiraServerV1]:
+    data = query(gql.get_api().query)
+    return list(data.jira_servers or [])

reconcile/typed_queries/ocm.py

@@ -0,0 +1,8 @@
+from reconcile.gql_definitions.common.ocm_environments import query
+from reconcile.gql_definitions.fragments.ocm_environment import OCMEnvironment
+from reconcile.utils import gql
+
+
+def get_ocm_environments() -> list[OCMEnvironment]:
+    data = query(gql.get_api().query)
+    return list(data.environments or [])

reconcile/typed_queries/quay.py

@@ -0,0 +1,7 @@
+from reconcile.gql_definitions.common.quay_instances import QuayInstanceV1, query
+from reconcile.utils import gql
+
+
+def get_quay_instances() -> list[QuayInstanceV1]:
+    data = query(gql.get_api().query)
+    return list(data.instances or [])

reconcile/typed_queries/slack.py

@@ -0,0 +1,7 @@
+from reconcile.gql_definitions.common.slack_workspaces import SlackWorkspaceV1, query
+from reconcile.utils import gql
+
+
+def get_slack_workspaces() -> list[SlackWorkspaceV1]:
+    data = query(gql.get_api().query)
+    return list(data.workspaces or [])

reconcile/typed_queries/unleash.py

@@ -0,0 +1,10 @@
+from reconcile.gql_definitions.unleash_feature_toggles.feature_toggles import (
+    UnleashInstanceV1,
+    query,
+)
+from reconcile.utils import gql
+
+
+def get_unleash_instances() -> list[UnleashInstanceV1]:
+    data = query(gql.get_api().query)
+    return list(data.instances or [])

reconcile/typed_queries/vault.py

@@ -0,0 +1,10 @@
+from reconcile.gql_definitions.vault_instances.vault_instances import (
+    VaultInstanceV1,
+    query,
+)
+from reconcile.utils import gql
+
+
+def get_vault_instances() -> list[VaultInstanceV1]:
+    data = query(gql.get_api().query)
+    return list(data.vault_instances or [])

tools/cli_commands/systems_and_tools.py

@@ -0,0 +1,319 @@
+#!/usr/bin/env python3
+# ruff: noqa: PLC0415 - `import` should be at the top-level of a file
+
+from typing import (
+    Any,
+    Self,
+)
+
+from pydantic import BaseModel
+
+from reconcile.gql_definitions.common.clusters import ClusterV1
+from reconcile.gql_definitions.common.pagerduty_instances import (
+    PagerDutyInstanceV1,
+)
+from reconcile.gql_definitions.common.quay_instances import QuayInstanceV1
+from reconcile.gql_definitions.common.slack_workspaces import SlackWorkspaceV1
+from reconcile.gql_definitions.dynatrace_token_provider.dynatrace_bootstrap_tokens import (
+    DynatraceEnvironmentV1,
+)
+from reconcile.gql_definitions.fragments.ocm_environment import OCMEnvironment
+from reconcile.gql_definitions.gitlab_members.gitlab_instances import GitlabInstanceV1
+from reconcile.gql_definitions.glitchtip.glitchtip_instance import GlitchtipInstanceV1
+from reconcile.gql_definitions.jenkins_configs.jenkins_instances import (
+    JenkinsInstanceV1,
+)
+from reconcile.gql_definitions.jira.jira_servers import JiraServerV1
+from reconcile.gql_definitions.statuspage.statuspages import StatusPageV1
+from reconcile.gql_definitions.terraform_cloudflare_resources.terraform_cloudflare_accounts import (
+    CloudflareAccountV1,
+)
+from reconcile.gql_definitions.terraform_tgw_attachments.aws_accounts import (
+    AWSAccountV1,
+)
+from reconcile.gql_definitions.unleash_feature_toggles.feature_toggles import (
+    UnleashInstanceV1,
+)
+from reconcile.gql_definitions.vault_instances.vault_instances import VaultInstanceV1
+from reconcile.statuspage.integration import get_status_pages
+from reconcile.typed_queries.cloudflare import get_cloudflare_accounts
+from reconcile.typed_queries.clusters import get_clusters
+from reconcile.typed_queries.dynatrace import get_dynatrace_environments
+from reconcile.typed_queries.gitlab_instances import get_gitlab_instances
+from reconcile.typed_queries.glitchtip import get_glitchtip_instances
+from reconcile.typed_queries.jenkins import get_jenkins_instances
+from reconcile.typed_queries.jira import get_jira_servers
+from reconcile.typed_queries.ocm import get_ocm_environments
+from reconcile.typed_queries.pagerduty_instances import get_pagerduty_instances
+from reconcile.typed_queries.quay import get_quay_instances
+from reconcile.typed_queries.slack import get_slack_workspaces
+from reconcile.typed_queries.terraform_tgw_attachments.aws_accounts import (
+    get_aws_accounts,
+)
+from reconcile.typed_queries.unleash import get_unleash_instances
+from reconcile.typed_queries.vault import get_vault_instances
+from reconcile.utils import (
+    gql,
+)
+
+
+class SystemTool(BaseModel):
+    system_type: str
+    system_id: str
+    name: str
+    url: str
+    description: str
+
+    @classmethod
+    def init_from_model(cls, model: Any) -> Self:
+        match model:
+            case GitlabInstanceV1():
+                return cls.init_from_gitlab(model)
+            case JenkinsInstanceV1():
+                return cls.init_from_jenkins(model)
+            case ClusterV1():
+                return cls.init_from_cluster(model)
+            case AWSAccountV1():
+                return cls.init_from_aws_account(model)
+            case DynatraceEnvironmentV1():
+                return cls.init_from_dynatrace_environment(model)
+            case GlitchtipInstanceV1():
+                return cls.init_from_glitchtip_instance(model)
+            case JiraServerV1():
+                return cls.init_from_jira_server(model)
+            case OCMEnvironment():
+                return cls.init_from_ocm_environment(model)
+            case PagerDutyInstanceV1():
+                return cls.init_from_pagerduty_instance(model)
+            case QuayInstanceV1():
+                return cls.init_from_quay_instance(model)
+            case SlackWorkspaceV1():
+                return cls.init_from_slack_workspace(model)
+            case StatusPageV1():
+                return cls.init_from_status_page(model)
+            case UnleashInstanceV1():
+                return cls.init_from_unleash_instance(model)
+            case VaultInstanceV1():
+                return cls.init_from_vault_instance(model)
+            case CloudflareAccountV1():
+                return cls.init_from_cloudflare_account(model)
+            case _:
+                raise NotImplementedError(f"unsupported: {model}")
+
+    @classmethod
+    def init_from_gitlab(cls, g: GitlabInstanceV1) -> Self:
+        return cls(
+            system_type="gitlab",
+            system_id=g.name,
+            name=g.name,
+            url=g.url,
+            description=g.description,
+        )
+
+    @classmethod
+    def init_from_jenkins(cls, j: JenkinsInstanceV1) -> Self:
+        return cls(
+            system_type="jenkins",
+            system_id=j.name,
+            name=j.name,
+            url=j.server_url,
+            description=j.description,
+        )
+
+    @classmethod
+    def init_from_cluster(cls, c: ClusterV1) -> Self:
+        return cls(
+            system_type="openshift",
+            system_id=c.spec.q_id if c.spec else "",
+            name=c.name,
+            url=c.server_url,
+            description=c.description,
+        )
+
+    @classmethod
+    def init_from_aws_account(cls, a: AWSAccountV1) -> Self:
+        return cls(
+            system_type="aws",
+            system_id=a.uid,
+            name=a.name,
+            url=a.console_url,
+            description=a.description,
+        )
+
+    @classmethod
+    def init_from_dynatrace_environment(cls, dt: DynatraceEnvironmentV1) -> Self:
+        return cls(
+            system_type="dynatrace",
+            system_id=dt.environment_id,
+            name=dt.name,
+            url=dt.environment_url,
+            description=dt.description,
+        )
+
+    @classmethod
+    def init_from_glitchtip_instance(cls, g: GlitchtipInstanceV1) -> Self:
+        return cls(
+            system_type="glitchtip",
+            system_id=g.name,
+            name=g.name,
+            url=g.console_url,
+            description=g.description,
+        )
+
+    @classmethod
+    def init_from_jira_server(cls, j: JiraServerV1) -> Self:
+        return cls(
+            system_type="jira",
+            system_id=j.name,
+            name=j.name,
+            url=j.server_url,
+            description=j.description,
+        )
+
+    @classmethod
+    def init_from_ocm_environment(cls, o: OCMEnvironment) -> Self:
+        return cls(
+            system_type="ocm",
+            system_id=o.name,
+            name=o.name,
+            url=o.url,
+            description=o.description,
+        )
+
+    @classmethod
+    def init_from_pagerduty_instance(cls, p: PagerDutyInstanceV1) -> Self:
+        return cls(
+            system_type="pagerduty",
+            system_id=p.name,
+            name=p.name,
+            url=p.description,  # no url
+            description=p.description,
+        )
+
+    @classmethod
+    def init_from_quay_instance(cls, q: QuayInstanceV1) -> Self:
+        return cls(
+            system_type="quay",
+            system_id=q.name,
+            name=q.name,
+            url=f"https://{q.name}.pagerduty.com",
+            description=q.description,
+        )
+
+    @classmethod
+    def init_from_slack_workspace(cls, s: SlackWorkspaceV1) -> Self:
+        return cls(
+            system_type="slack",
+            system_id=s.name,
+            name=s.name,
+            url=f"https://{s.name}.slack.com",
+            description=s.description,
+        )
+
+    @classmethod
+    def init_from_status_page(cls, s: StatusPageV1) -> Self:
+        return cls(
+            system_type="statuspage",
+            system_id=s.name,
+            name=s.name,
+            url=s.url,
+            description=s.description,
+        )
+
+    @classmethod
+    def init_from_unleash_instance(cls, u: UnleashInstanceV1) -> Self:
+        return cls(
+            system_type="unleash",
+            system_id=u.name,
+            name=u.name,
+            url=u.url,
+            description=u.description,
+        )
+
+    @classmethod
+    def init_from_vault_instance(cls, v: VaultInstanceV1) -> Self:
+        return cls(
+            system_type="vault",
+            system_id=v.name,
+            name=v.name,
+            url=v.address,
+            description=v.description,
+        )
+
+    @classmethod
+    def init_from_cloudflare_account(cls, a: CloudflareAccountV1) -> Self:
+        return cls(
+            system_type="cloudflare",
+            system_id=a.name,
+            name=a.name,
+            url="https://dash.cloudflare.com/",
+            description=a.description,
+        )
+
+
+class SystemToolInventory:
+    def __init__(self) -> None:
+        self.systems_and_tools: list[SystemTool] = []
+
+    def append(self, model: Any) -> None:
+        self.systems_and_tools.append(SystemTool.init_from_model(model))
+
+    def update(self, models: list[Any]) -> None:
+        for m in models:
+            self.append(m)
+
+    @property
+    def data(self) -> list[dict[str, Any]]:
+        return [
+            {
+                "type": st.system_type,
+                "id": st.system_id,
+                "name": st.name,
+                "url": st.url,
+                "description": st.description.replace("\n", "\\n"),
+            }
+            for st in self.systems_and_tools
+        ]
+
+    @property
+    def columns(self) -> list[str]:
+        return [
+            "type",
+            "id",
+            "name",
+            "url",
+            "description",
+        ]
+
+
+def get_systems_and_tools_inventory() -> SystemToolInventory:
+    gql_api = gql.get_api()
+    inventory = SystemToolInventory()
+
+    inventory.update(get_gitlab_instances())
+    inventory.update(get_jenkins_instances())
+    inventory.update(get_clusters())
+    inventory.update(get_aws_accounts(gql_api))
+    inventory.update(get_dynatrace_environments())
+    inventory.update(get_glitchtip_instances())
+    inventory.update(get_jira_servers())
+    inventory.update(get_ocm_environments())
+    inventory.update(get_pagerduty_instances(gql_api.query))
+    inventory.update(get_quay_instances())
+    inventory.update(get_slack_workspaces())
+    inventory.update(get_status_pages())
+    inventory.update(get_unleash_instances())
+    inventory.update(get_vault_instances())
+    inventory.update(get_cloudflare_accounts())
+
+    inventory.systems_and_tools.append(
+        SystemTool(
+            system_type="github",
+            system_id="github",
+            name="github",
+            url="https://github.com",
+            description="github",
+        )
+    )
+
+    return inventory