cloudconsolelink 1.0.24__tar.gz → 2.0.0__tar.gz

{cloudconsolelink-1.0.24 → cloudconsolelink-2.0.0}/PKG-INFO

@@ -1,18 +1,34 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: cloudconsolelink
-Version: 1.0.24
+Version: 2.0.0
 Summary: Generate console links for cloud resources
 Home-page: https://github.com/Cloudanix/cloud-console-links
 Maintainer: Cloudanix
-Maintainer-email: ganesh@cloudanix.com
-License: apache2
+Maintainer-email: support@cloudanix.com
+License: Apache-2.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pre-commit~=4.2; extra == "dev"
+Requires-Dist: pytest~=8.3; extra == "dev"
+Requires-Dist: pytest-cov==2.11; extra == "dev"
+Requires-Dist: pytest-mock~=3.14; extra == "dev"
+Requires-Dist: types-PyYAML~=6.0; extra == "dev"
+Requires-Dist: types-requests~=2.32; extra == "dev"
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: provides-extra
+Dynamic: summary
 
 # What is cloudconsolelink?
 This project for generate console links for AWS, GCP and Azure cloud resources
@@ -20,6 +36,22 @@ This project for generate console links for AWS, GCP and Azure cloud resources
 # Install
 Run ```pip install cloudconsolelink``` to install our code
 
+For local development, install the package with dev extras:
+
+```bash
+pip install -e '.[dev]'
+```
+
+Verification shortcuts:
+
+```bash
+make test
+make coverage
+make test-arn
+make test-aws-links
+make check
+```
+
 # Usage
 
 ### Import Package

{cloudconsolelink-1.0.24 → cloudconsolelink-2.0.0}/README.md

@@ -4,6 +4,22 @@ This project for generate console links for AWS, GCP and Azure cloud resources
 # Install
 Run ```pip install cloudconsolelink``` to install our code
 
+For local development, install the package with dev extras:
+
+```bash
+pip install -e '.[dev]'
+```
+
+Verification shortcuts:
+
+```bash
+make test
+make coverage
+make test-arn
+make test-aws-links
+make check
+```
+
 # Usage
 
 ### Import Package

{cloudconsolelink-1.0.24 → cloudconsolelink-2.0.0}/cloudconsolelink/__init__.py

@@ -1,2 +1,2 @@
 # version of the module
-__version__ = '1.0.24'
+__version__ = "2.0.0"

cloudconsolelink-2.0.0/cloudconsolelink/clouds/aws/__init__.py

@@ -0,0 +1,137 @@
+import logging
+import urllib.parse
+from typing import Dict
+
+from .links import get_links
+
+logger = logging.getLogger(__name__)
+
+
+def get_console(partition: str) -> str:
+    consoles = {
+        "aws": "console.aws.amazon.com",
+        "aws-us-gov": "console.amazonaws-us-gov.com",
+        "aws-cn": "console.amazonaws.cn",
+    }
+    return consoles.get(partition, "")
+
+
+def get_arn_string(data: Dict) -> str:
+    if not data.get("resourceType", ""):
+        return (
+            f"{data.get('prefix', '')}:{data.get('partition', '')}:{data.get('service', '')}:"
+            f"{data.get('region', '')}:{data.get('account', '')}:{data.get('resource', '')}"
+        )
+
+    elif data.get("hasPath", ""):
+        return (
+            f"{data.get('prefix', '')}:{data.get('partition', '')}:{data.get('service', '')}:"
+            f"{data.get('region', '')}:{data.get('account', '')}:{data.get('resourceType', '')}"
+            f"/{data.get('resource', '')}"
+        )
+
+    else:
+        return (
+            f"{data.get('prefix', '')}:{data.get('partition', '')}:{data.get('service', '')}:"
+            f"{data.get('region', '')}:{data.get('account', '')}:{data.get('resourceType', '')}:"
+            f"{data.get('resource', '')}"
+        )
+
+
+def get_qualifiers(resource: str) -> list[str]:
+    return resource.split(":")
+
+
+def get_resource_path(resource: str) -> str:
+    return resource.split("/")[-1]
+
+
+class AWSLinker:
+    def get_console_link(self, arn: str) -> str:
+        logger.debug(f"Start Process for AWS ARN: {arn}")
+        arn = arn.strip()
+        firstTokens = arn.split(":")
+        tokens = firstTokens[:7]
+
+        try:
+            data: dict[str, str | bool] = {
+                "prefix": tokens[0],
+                "partition": tokens[1],
+                "service": tokens[2],
+                "region": tokens[3],
+                "account": tokens[4],
+                "resourceType": "",
+                "resource": "",
+                "hasPath": False,
+            }
+
+        except IndexError:
+            logger.error(f"AWS ARN {arn} is too short")
+            raise ValueError(f"AWS ARN {arn} is too short")
+
+        if len(tokens) > 6:
+            data["resourceType"] = tokens[5]
+            data["resource"] = tokens[6]
+            data["hasPath"] = False
+
+        elif len(tokens) > 5 and tokens[5].count("/") > 0:
+            data["resourceType"] = tokens[5][: tokens[5].index("/")]
+            data["resource"] = tokens[5][tokens[5].index("/") + 1 :]
+            data["hasPath"] = True
+
+        elif len(tokens) > 5 and tokens[5].count("/") == 0:
+            data["resourceType"] = ""
+            data["resource"] = tokens[5]
+            data["hasPath"] = False
+
+        else:
+            logger.error(f"Invalid AWS ARN {arn}")
+            raise ValueError(f"Invalid AWS ARN {arn}")
+
+        console = get_console(str(data.get("partition", "")))
+        if not console:
+            logger.error(
+                f"AWS ARN {arn} has invalid partition (Valid Partitions: aws, aws-us-gov, aws-cn)",
+            )
+            raise ValueError(
+                f"AWS ARN {arn} has invalid partition (Valid Partitions: aws, aws-us-gov, aws-cn)",
+            )
+        data["console"] = console
+
+        links = get_links()
+
+        if data["prefix"] != "arn":
+            logger.error(f"Invalid AWS ARN {arn}")
+            raise ValueError(f"Invalid AWS ARN {arn}")
+
+        elif not links.get(data["service"], None):
+            logger.error(f"AWS service {data['service']} unknown")
+            raise ValueError(f"AWS service {data['service']} unknown")
+
+        elif not links.get(data["service"], {}).get(data["resourceType"], None):
+            logger.error(
+                f"AWS service {data['service']} resource type {data['resourceType']} not supported",
+            )
+
+            # If resource type does not exist, take the user to service home page
+            return f"https://console.aws.amazon.com/{data['service']}"
+
+            # raise ValueError(f"AWS service {data['service']} resource type {data['resourceType']} not supported")
+
+        else:
+            template_context = {
+                "arn": arn,
+                "data": data,
+                "get_arn_string": get_arn_string,
+                "get_qualifiers": get_qualifiers,
+                "get_resource_path": get_resource_path,
+            }
+            data["resource"] = urllib.parse.quote(str(data["resource"]))
+            return eval(
+                f"f'{links[data['service']][data['resourceType']]}'",
+                {"__builtins__": {}},
+                template_context,
+            ).replace(
+                " ",
+                "",
+            )