Merge pull request #12 from cloud-hero/develop

v0.2

Author: one-hero

README.md

@@ -85,9 +85,9 @@ $./hero provider ls
 ### Environment
 An environment is a group of servers (nodes). You can give them any name, but we usualy call them production, staging, development.
 
-##### Create
+##### Add
 ```bash
-$./hero env create -p provider_id -l location -n name
+$./hero env add -p provider_id -l location -n name
 ```
 
 | Parameter   | Description

constants.py

@@ -1,12 +1,19 @@
 VERBOSE = False
-CLI_VERSION = '0.1'
-SSH_KEY_PATH = '~/.ssh/id_rsa_cloudhero'
+CLI_VERSION = '0.2'
 
+# API-related constants.
+# https://docs.cloudhero.io
 CLOUD_HERO_URI = 'http://d.cloudhero.io'
 CLOUD_HERO_TOKEN_ENV_VARIABLE = 'CLOUD_HERO_TOKEN'
+CLOUD_HERO_USER_AGENT = 'cloudhero-cli'
 
-CLOUD_HERO_DIR = '~/.herorc'
-CLOUD_HERO_TOKEN = CLOUD_HERO_DIR + '/token'
-CLOUD_HERO_CACHE_NODES = CLOUD_HERO_DIR + '/cache/nodes'
-CLOUD_HERO_CACHE_ENVIRONMENTS = CLOUD_HERO_DIR + '/cache/enviornments'
-CLOUD_HERO_CACHE_OPTIONS = CLOUD_HERO_DIR + '/cache/options'
+# Local directory-related constants.
+CLOUD_HERO_DIR = '~/.herorc/'
+CLOUD_HERO_SSH_KEY = CLOUD_HERO_DIR + '.ssh/id_rsa_cloudhero'
+CLOUD_HERO_TOKEN = CLOUD_HERO_DIR + 'token'
+CLOUD_HERO_CACHE_NODES = CLOUD_HERO_DIR + 'cache/nodes'
+CLOUD_HERO_CACHE_ENVIRONMENTS = CLOUD_HERO_DIR + 'cache/enviornments'
+CLOUD_HERO_CACHE_OPTIONS = CLOUD_HERO_DIR + 'cache/options'
+
+# Exceptions.
+class NotFound(Exception): pass

docs/WEB-EXAMPLE.md

@@ -27,7 +27,7 @@ Step 4.
 ###### Create a new environment where the nodes will be launched.
 In this step we will select which cloud provider we want to work with, which location to use and the name of our environment
 ```
-$ ./hero environment create -p 56fe7d5910d39669c06a5276 -l eu-west-1 -n bigsite-prod
+$ ./hero environment add -p 56fe7d5910d39669c06a5276 -l eu-west-1 -n bigsite-prod
 ```
 Step 5:
 -------

hero

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 import os
+import shutil
 import sys
 import paramiko
 import traceback
@@ -12,7 +13,7 @@ import requests
 from constants import *
 from interactive import interactive_shell
 from pyhero import Client
-from prompter import PROMPTER_KWARGS
+from prompter import *
 from utils import (write_to_file, set_keys_to_empty_values,
                    get_docker_ip_for_environment)
 
@@ -24,7 +25,7 @@ def persist_token(user_token):
     Set token environment variable.
     """
     os.environ['CLOUD_HERO_TOKEN'] = user_token
-    write(user_token)
+    write_token(user_token)
 
 
 def forget_token():
@@ -33,10 +34,9 @@ def forget_token():
     """
     env_token = os.environ.get(CLOUD_HERO_TOKEN_ENV_VARIABLE, None)
     del env_token
-    delete_token()
 
 
-def write(content):
+def write_token(content):
     """
     Write token to config file.
     """
@@ -57,17 +57,6 @@ def read_token():
         return token_from_file.strip().replace('\n', '').replace('\t', '')
 
 
-def delete_token():
-    """
-    Remove token.
-    """
-    config_file_path = os.path.expanduser(CLOUD_HERO_TOKEN)
-    try:
-        os.remove(config_file_path)
-    except OSError:
-        print('You are already logged out!')
-
-
 def exception_handler(api_exception):
     if isinstance(api_exception, requests.HTTPError):
         response = api_exception.response
@@ -96,7 +85,8 @@ if not token:
     token = read_token()
 cloud_hero = Client(base_url=CLOUD_HERO_URI, token=token,
                     exception_callback=exception_handler,
-                    clean_up_arguments=True)
+                    clean_up_arguments=True,
+                    user_agent=CLOUD_HERO_USER_AGENT)
 
 
 def verify_one_of(kwargs, *args):
@@ -112,7 +102,7 @@ def verify_one_of(kwargs, *args):
 
 def tags_for_pprint(tags):
     if not tags:
-        return '-'
+        return NOTHING_TO_SHOW
     return ', '.join(['{}:{}'.format(key, value)
                       for key, value in tags.items()])
 
@@ -146,7 +136,7 @@ def log_response(response):
 # ------------------------------------------------------------------------
 class OrderedHeroCommands(click.Group):
 
-    COMMANDS_ORDER = ['login', 'register', 'provider',
+    COMMANDS_ORDER = ['login', 'register', 'provider', 'integration',
                       'environment', 'node', 'docker', 'ssh']
 
     COMMANDS_ALIASES = {
@@ -238,9 +228,9 @@ def scale_node(**kwargs):
 @node.command('ls', short_help='List all your nodes',
                help='List all your nodes')
 def list_nodes():
-    node_format = ('{node[name]:<25}{environment[name]:<20}'
-                   '{node[public_ip]:<17}{node[private_ip]:<17}'
-                   '{node[status]:<10}{node[provider]:<10}{node[id]:<25}'
+    node_format = ('{node[name]:<20}{environment[name]:<20}'
+                   '{node[public_ip]:<15}{node[private_ip]:<15}'
+                   '{node[status]:<10}{node[provider]:<15}{node[id]:<25}'
                    '{environment[id]:<25}{node[tags]:<15}{node[packages]:<15}')
     print node_format.format(**PROMPTER_KWARGS)
 
@@ -251,17 +241,17 @@ def list_nodes():
                 'node': {
                     'id': node['id'],
                     'name': node['name'],
-                    'status': 'TBD',
+                    'status': node.get('status', NOT_AVAILABLE),
                     'provider': environment['provider']['name'],
-                    'public_ip': node.get('public_ip', '-'),
-                    'private_ip': node.get('private_ip', '-'),
+                    'public_ip': node.get('public_ip', NOT_AVAILABLE),
+                    'private_ip': node.get('private_ip', NOT_AVAILABLE),
                     'packages': ','.join(node['packages']),
                     'tags': tags_for_pprint(node['tags'])
                 },
                 'environment': {
                     'id': environment['id'],
                     'name': environment['name'],
-                }
+                },
             }
             print(node_format.format(**node_data))
 
@@ -284,19 +274,18 @@ def environment():
     pass
 
 
-@environment.command('create', short_help='Create environment',
-                      help='Create environment')
+@environment.command('add', short_help='Add environment', help='Add environment')
 @click.option('-p', '--provider_id', prompt=True, help='Select the provider ID')
 @click.option('-l', '--location', prompt=True,
               help='Cloud provider location/region for environment')
 @click.option('-n', '--name', prompt=True, help='Environment name')
-def create_environment(**kwargs):
+def add_environment(**kwargs):
     data = {
         'region': kwargs['location'],
         'environment': kwargs['name'],
         'provider_id': kwargs['provider_id']
     }
-    log_response(cloud_hero.create_environment(data))
+    log_response(cloud_hero.add_environment(data))
 
 
 @environment.command('rm', short_help='Remove an existing environment',
@@ -315,7 +304,8 @@ def remove_environment(**kwargs):
 def list_environments():
     format_string = ('{node[name]:<25}{environment[location]:<15}'
                      '{nodes_count:<15}{environment[name]:<20}'
-                     '{environment[id]:<30}')
+                     '{environment[id]:<30}'
+                     '{provider[name]:<30}{provider[id]:<30}')
     print format_string.format(**PROMPTER_KWARGS)
 
     environments_list = cloud_hero.list_environments()
@@ -326,9 +316,14 @@ def list_environments():
                 'name': environment['name'],
                 'location': environment['os_region'],
             },
-            'nodes_count': len(environment['nodes'])
+            'nodes_count': len(environment['nodes']),
+            'provider': {
+                'id': environment['provider']['id'],
+                'name': environment['provider']['name']
+            }
         }
-        for index, node in enumerate(environment['nodes'] or [{'name': '-'}]):
+        nodes_list = environment['nodes'] or [{'name': NOTHING_TO_SHOW}]
+        for index, node in enumerate(nodes_list):
             if index == 0:
                 print format_string.format(node=node, **environment_data)
                 continue
@@ -446,7 +441,14 @@ def remove_provider(**kwargs):
 def export_docker_environment(**kwargs):
     environment = kwargs['environment']
     node_details = cloud_hero.get_all_details()
-    docker_ip = get_docker_ip_for_environment(node_details, environment)
+    try:
+        docker_ip = get_docker_ip_for_environment(node_details, environment)
+    except NotFound as exception:
+        sys.exit(exception.message)
+    if docker_ip is None:
+        sys.exit('Node is still being created, could not find the IP to '
+                 'connect to')
+
     print('export DOCKER_HOST=tcp://{}:4000'.format(docker_ip))
     print('# Run this command to configure your shell:\n'
           '# eval "$(hero docker {})"'.format(environment))
@@ -520,7 +522,7 @@ def ssh_to_vm(**kwargs):
     remote_user = node['provider']['username']
 
     # Get key and write it to the local path
-    expanded_file_path = os.path.expanduser(SSH_KEY_PATH)
+    expanded_file_path = os.path.expanduser(CLOUD_HERO_SSH_KEY)
     if not os.path.exists(expanded_file_path):
         ssh_key_content = cloud_hero.list_key()['content']
         write_to_file(ssh_key_content, expanded_file_path)
@@ -558,6 +560,15 @@ def ssh_to_vm(**kwargs):
 def logout():
     forget_token()
 
+    # Remove everything from the CLOUD_HERO_PATH.
+    cloud_hero_path = os.path.expanduser(CLOUD_HERO_DIR)
+    try:
+        shutil.rmtree(cloud_hero_path)
+    except OSError as os_exception:
+        print(os_exception.strerror)
+
+    print('Logout successful!')
+
 
 @hero.command(short_help='Login user', help='Login user')
 @click.option('-e', '--email', prompt=True, help='Email')

prompter.py

@@ -1,5 +1,5 @@
 PROMPTER_KWARGS = {
-    'node':{
+    'node': {
         'id': 'NODE-ID',
         'name': 'NODE-NAME',
         'public_ip': 'PUBLIC-IP',
@@ -14,10 +14,18 @@
         'name': 'ENVIRONMENT-NAME',
         'location': 'LOCATION'
     },
+    'provider': {
+        'id': 'PROVIDER-ID',
+        'name': 'PROVIDER-NAME',
+        'type': 'PROVIDER-TYPE',
+    },
     'application': {
         'id': 'APPLICATION-ID',
         'name': 'APPLICATION-NAME'
     },
     'index': 'OPTION',
     'nodes_count': 'NODES-COUNT'
 }
+
+NOT_AVAILABLE = 'N/A'
+NOTHING_TO_SHOW = '-'

pyhero.py

@@ -8,12 +8,9 @@
 
 DEFAULT_CLIENT_VERSION = '1.0'
 DEFAULT_TIMEOUT_SECONDS = 60
-CLIENT_CACHE_TTL = 60 * 5
+CLIENT_CACHE_TTL = 60
 CLIENT_CACHE_OPTIONS_TTL = 60 * 60
 
-class NotFound(Exception): pass
-class APIError(Exception): pass
-
 
 ENDPOINTS = {
     'register': '/accounts/register',
@@ -35,10 +32,12 @@ class Client(object):
     def __init__(self, base_url=None, token=None,
                  timeout=DEFAULT_TIMEOUT_SECONDS,
                  exception_callback=None,
-                 clean_up_arguments=False):
+                 clean_up_arguments=False,
+                 user_agent=None):
         self.timeout = timeout
         self.token = token
         self.base_url = base_url
+        self.user_agent = user_agent
         self.exception_callback = exception_callback
         self.clean_up_arguments = clean_up_arguments
         if self.base_url is None:
@@ -96,7 +95,7 @@ def delete_integration(self, item_id):
                                              item_id))
 
     @invalidate_cache(CLOUD_HERO_CACHE_ENVIRONMENTS, CLOUD_HERO_CACHE_NODES)
-    def create_environment(self, data):
+    def add_environment(self, data):
         return self._result(self.post_json(ENDPOINTS['environments'],
                                            data=data))
 
@@ -127,8 +126,8 @@ def get_all_details(self):
                         'node': {
                             'id': node['id'],
                             'name': node['name'],
-                            'private_ip': node['private_ip'],
-                            'public_ip': node['public_ip'],
+                            'private_ip': node.get('private_ip'),
+                            'public_ip': node.get('public_ip'),
                             'packages': node['packages'],
                             'size': node['size'],
                             'tags': node['tags']
@@ -232,6 +231,9 @@ def _update_request(self, kwargs):
         if self.token:
             kwargs['headers']['Authentication-Token'] = self.token
 
+        if self.user_agent:
+            kwargs['headers']['User-Agent'] = self.user_agent
+
         return kwargs
 
     def _result(self, response, json=True):

utils.py

@@ -4,7 +4,7 @@
 import os
 import time
 
-from constants import CLOUD_HERO_CACHE_OPTIONS
+from constants import CLOUD_HERO_CACHE_OPTIONS, NotFound
 
 
 def write_to_file(content, file_path, is_json=False):
@@ -114,8 +114,13 @@ def set_keys_to_empty_values(obj):
 
 
 def get_docker_ip_for_environment(node_details, environment_id):
+    environment_found = False
     for node, nodes_data in node_details.items():
         for node_data in nodes_data:
-            if (node_data['environment']['id'] == environment_id and
-                    node_data['node']['public_ip']):
-                return node_data['node']['public_ip']
+            if node_data['environment']['id'] == environment_id:
+                environment_found = True
+                if node_data['node'].get('public_ip'):
+                    return node_data['node']['public_ip']
+
+    if environment_found is False:
+        raise NotFound('Environment {} not found!'.format(environment_id))