Add small comments to methods/class

Fix apply new ACTIVE_PROXIES when fail create new proxy (port maybe already used
Fix stopping proxies when stopping application on ctrl+c

Author: AMEST

src/docker_cli_wrapper.py

@@ -1,7 +1,16 @@
 import subprocess, json
 
 class DockerCLIWrapper(object):
+    """
+        Docker cli wrapper for getting containers and node information
+        Alternative implementation of docker client and general implementation for windows
+        because default docker client when used ssh connection don't working in windows with ssh-agents
+    """
     def containers(self, all=False):
+        """
+            Getting containers info (id, ports, image, command and other)
+            By default, return only running containers. For get all, set all=True when execute
+        """
         ps_args = ['docker', 'ps', '--format', '"{{json .}}"', '--no-trunc']
         if all:
             ps_args.append('-a')
@@ -14,12 +23,18 @@ def containers(self, all=False):
         return containers
 
     def info(self):
+        """
+            Get information about docker host
+        """
         info_args = ['docker', 'info', '--format', '"{{json .}}"']
         info = subprocess.run(info_args, capture_output=True)
         return json.loads(info.stdout.decode()[1:-2])
 
 
 class DockerCliWrappedContainer(object):
+    """
+        Docker container information model
+    """
     id = None
     image = None
     command = None

src/main.py

@@ -16,11 +16,19 @@
 logging.getLogger("docker").setLevel(logging.INFO)
 
 def getDockerHostFromContext():
+    """
+        Get docker remote host uri from current docker context 
+    """
     current_context_cmd = subprocess.run(["docker", "context", "inspect"], capture_output=True)
     current_context_json = json.loads(current_context_cmd.stdout.decode())
     return current_context_json[0]["Endpoints"]["docker"]["Host"]
 
 def manageProxies(remote_docker_host_name, published_ports, listen_system_ports):
+    """
+        Manage proxy to publisher containers.
+        Getting new published ports, stopping proxies for stopped containers (published ports)
+        starting new proxies to new published ports
+    """
     global ACTIVE_PROXIES
     # Get only tcp services because only tcp proxy implemented
     published_ports = list(x["published"] for x in published_ports if x["internal"].endswith("tcp"))
@@ -34,17 +42,22 @@ def manageProxies(remote_docker_host_name, published_ports, listen_system_ports)
             published_ports.remove(proxy.proxy_port)
         else:
             proxy.stop()
-    # Add and start new proxies
-    for port in published_ports:
-        proxy = ProxyServer(remote_docker_host_name, port, ProxyType.TCP)
-        proxy.start()
-        new_active_proxies.append(proxy)
-    # Update proxy list
-    ACTIVE_PROXIES = new_active_proxies
+    try:
+        # Add and start new proxies
+        for port in published_ports:
+            proxy = ProxyServer(remote_docker_host_name, port, ProxyType.TCP)
+            proxy.start()
+            new_active_proxies.append(proxy)
+        # Update proxy list
+    finally:
+        ACTIVE_PROXIES = new_active_proxies
 
 
 
 def mainLoop(docker_host, listen_system_ports, use_docker_cli):
+    """
+        Main loop where getting published ports and launch managing proxies with 60s intervals
+    """
     global ACTIVE_PROXIES
     logging.info("Initialize docker remote proxy to `%s`" %docker_host)
     docker_service = DockerService(docker_host, use_docker_cli)
@@ -59,10 +72,12 @@ def mainLoop(docker_host, listen_system_ports, use_docker_cli):
                 logging.error(e)
             time.sleep(60)
     except KeyboardInterrupt:
+        return
+    finally:
         for proxy in ACTIVE_PROXIES:
             proxy.stop()
         logging.info('Docker remote proxy stopped!')
-        return
+
 
 if __name__ == "__main__":
     logging.info('Starting docker remote proxy!')

src/proxy.py

@@ -69,7 +69,7 @@ class ThreadedTCPServer(ThreadingMixIn, TCPServer):
     pass
 
 class ProxyServer():
-
+    
     def __init__(self, proxy_host, proxy_port, type=ProxyType.TCP):
         if(type != ProxyType.TCP):
             raise NotImplementedError("Only TCP Proxy implemented")