execution server ping to resource script

Author: katzy687

resource-scripts/es_ping/__main__.py

@@ -0,0 +1,2 @@
+from es_ping import run_es_ping
+run_es_ping()

resource-scripts/es_ping/debug.py

@@ -0,0 +1,14 @@
+from cloudshell.helpers.scripts.cloudshell_dev_helpers import attach_to_cloudshell_as
+from es_ping import run_es_ping
+
+LIVE_SANDBOX_ID = "87df6742-0fd6-43e4-b068-48764b97d7e5"
+TARGET_RESOURCE_NAME = "DUT mock 1"
+
+attach_to_cloudshell_as(user="admin",
+                        password="admin",
+                        domain="Global",
+                        reservation_id=LIVE_SANDBOX_ID,
+                        server_address="localhost",
+                        resource_name=TARGET_RESOURCE_NAME)
+
+run_es_ping()

resource-scripts/es_ping/es_ping.py

@@ -0,0 +1,31 @@
+import json
+
+from cloudshell.helpers.scripts.cloudshell_scripts_helpers import get_reservation_context_details, get_api_session, \
+    get_resource_context_details
+from cloudshell.logging.qs_logger import get_qs_logger
+from cloudshell.helpers.sandbox_reporter.reporter import SandboxReporter
+from ping_parser_helper import ping_target_ip, get_local_ip, PingFailedException
+
+
+def run_es_ping():
+    api = get_api_session()
+    sb_details = get_reservation_context_details()
+    sb_id = sb_details.id
+
+    resource_details = get_resource_context_details()
+    resource_name = resource_details.name
+    logger = get_qs_logger(log_group=sb_id, log_category=resource_details.model, log_file_prefix=resource_name)
+    reporter = SandboxReporter(api, sb_id, logger)
+    ip = resource_details.address
+    es_ip = get_local_ip()
+
+    reporter.info(f"Pinging '{resource_name}' at IP '{ip}' from Execution Server...")
+
+    try:
+        stats = ping_target_ip(ip)
+    except PingFailedException as e:
+        msg = f"Failed ping to '{resource_name}' at IP '{ip}' from ES at IP '{es_ip}'.\n{str(e)}"
+        reporter.error(msg)
+        raise
+    reporter.success(f"Successful ping from ES to '{resource_name}' at IP '{ip}'")
+    print(json.dumps(stats.as_dict(), indent=4))

resource-scripts/es_ping/ping_parser_helper.py

@@ -0,0 +1,46 @@
+import socket
+import json
+import pingparsing
+
+
+class PingFailedException(Exception):
+    pass
+
+
+def get_local_ip():
+    """
+    Use socket to get the local IP, default to loopback 127.0.0.1
+    https://stackoverflow.com/a/28950776
+    :return:
+    """
+    s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+    s.settimeout(0)
+    try:
+        # doesn't even have to be reachable
+        s.connect(('10.255.255.255', 1))
+        IP = s.getsockname()[0]
+    except Exception:
+        IP = '127.0.0.1'
+    finally:
+        s.close()
+    return IP
+
+
+def ping_target_ip(target_ip: str) -> pingparsing.PingStats:
+    ping_parser = pingparsing.PingParsing()
+    transmitter = pingparsing.PingTransmitter()
+    transmitter.destination = target_ip
+    transmitter.count = 4
+    result = transmitter.ping()
+    if result.returncode != 0:
+        raise PingFailedException(f"Failed ping output:\n{result.stdout}")
+    stats = ping_parser.parse(result)
+    if stats.packet_loss_rate > 0:
+        stats_json = json.dumps(stats.as_dict(include_icmp_replies=True), indent=4)
+        raise PingFailedException(f"Ping loss rate greater than 0.\n{stats_json}")
+    return stats
+
+
+if __name__ == "__main__":
+    res = ping_target_ip("google.com").as_dict()
+    print(json.dumps(res, indent=4))

resource-scripts/es_ping/readme.MD

@@ -0,0 +1,4 @@
+# Get Port from Connector
+This is a resource script that will find port of specified connector alias
+
+## Usage

resource-scripts/es_ping/requirements.txt

@@ -0,0 +1,4 @@
+cloudshell-automation-api
+cloudshell-logging
+pingparsing
+cloudshell-sandbox-reporter