Merge pull request #1150 from allmightyspiff/issues1003

Bandwidth usage details for vs and server

Author: allmightyspiff

.travis.yml

@@ -1,18 +1,20 @@
+# https://docs.travis-ci.com/user/languages/python/#python-37-and-higher
+dist: xenial
 language: python
 sudo: false
 matrix:
   include:
-    - python: "2.7"
-      env: TOX_ENV=py27
     - python: "3.5"
       env: TOX_ENV=py35
     - python: "3.6"
       env: TOX_ENV=py36
-    - python: "pypy2.7-5.8.0"
+    - python: "3.7"
+      env: TOX_ENV=py37
+    - python: "pypy3.5"
       env: TOX_ENV=pypy
-    - python: "2.7"
+    - python: "3.6"
       env: TOX_ENV=analysis
-    - python: "2.7"
+    - python: "3.6"
       env: TOX_ENV=coverage
 install:
  - pip install tox

SoftLayer/CLI/hardware/bandwidth.py

@@ -0,0 +1,45 @@
+"""Get details for a hardware device."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import helpers
+from SoftLayer.CLI.virt.bandwidth import create_bandwidth_table
+
+
+@click.command()
+@click.argument('identifier')
+@click.option('--start_date', '-s', type=click.STRING, required=True,
+              help="Start Date YYYY-MM-DD, YYYY-MM-DDTHH:mm:ss,")
+@click.option('--end_date', '-e', type=click.STRING, required=True,
+              help="End Date YYYY-MM-DD, YYYY-MM-DDTHH:mm:ss")
+@click.option('--summary_period', '-p', type=click.INT, default=3600, show_default=True,
+              help="300, 600, 1800, 3600, 43200 or 86400 seconds")
+@click.option('--quite_summary', '-q', is_flag=True, default=False, show_default=True,
+              help="Only show the summary table")
+@environment.pass_env
+def cli(env, identifier, start_date, end_date, summary_period, quite_summary):
+    """Bandwidth data over date range. Bandwidth is listed in GB
+
+    Using just a date might get you times off by 1 hour, use T00:01 to get just the specific days data
+    Timezones can also be included with the YYYY-MM-DDTHH:mm:ss.00000-HH:mm format.
+
+    Due to some rounding and date alignment details, results here might be slightly different than
+    results in the control portal.
+
+    Example::
+
+        slcli hw bandwidth 1234 -s 2019-05-01T00:01 -e 2019-05-02T00:00:01.00000-12:00
+    """
+    hardware = SoftLayer.HardwareManager(env.client)
+    hardware_id = helpers.resolve_id(hardware.resolve_ids, identifier, 'hardware')
+    data = hardware.get_bandwidth_data(hardware_id, start_date, end_date, None, summary_period)
+
+    title = "Bandwidth Report: %s - %s" % (start_date, end_date)
+    table, sum_table = create_bandwidth_table(data, summary_period, title)
+
+    env.fout(sum_table)
+    if not quite_summary:
+        env.fout(table)

SoftLayer/CLI/hardware/detail.py

@@ -57,6 +57,10 @@ def cli(env, identifier, passwords, price):
 
     table.add_row(['vlans', vlan_table])
 
+    bandwidth = hardware.get_bandwidth_allocation(hardware_id)
+    bw_table = _bw_table(bandwidth)
+    table.add_row(['Bandwidth', bw_table])
+
     if result.get('notes'):
         table.add_row(['notes', result['notes']])
 
@@ -85,3 +89,17 @@ def cli(env, identifier, passwords, price):
     table.add_row(['tags', formatting.tags(result['tagReferences'])])
 
     env.fout(table)
+
+
+def _bw_table(bw_data):
+    """Generates a bandwidth useage table"""
+    table = formatting.Table(['Type', 'In GB', 'Out GB', 'Allotment'])
+    for bw_point in bw_data.get('useage'):
+        bw_type = 'Private'
+        allotment = 'N/A'
+        if bw_point['type']['alias'] == 'PUBLIC_SERVER_BW':
+            bw_type = 'Public'
+            allotment = bw_data['allotment'].get('amount', '-')
+
+        table.add_row([bw_type, bw_point['amountIn'], bw_point['amountOut'], allotment])
+    return table

SoftLayer/CLI/routes.py

@@ -19,6 +19,7 @@
     ('account:summary', 'SoftLayer.CLI.account.summary:cli'),
 
     ('virtual', 'SoftLayer.CLI.virt'),
+    ('virtual:bandwidth', 'SoftLayer.CLI.virt.bandwidth:cli'),
     ('virtual:cancel', 'SoftLayer.CLI.virt.cancel:cli'),
     ('virtual:capture', 'SoftLayer.CLI.virt.capture:cli'),
     ('virtual:create', 'SoftLayer.CLI.virt.create:cli'),
@@ -213,6 +214,7 @@
     ('rwhois:show', 'SoftLayer.CLI.rwhois.show:cli'),
 
     ('hardware', 'SoftLayer.CLI.hardware'),
+    ('hardware:bandwidth', 'SoftLayer.CLI.hardware.bandwidth:cli'),
     ('hardware:cancel', 'SoftLayer.CLI.hardware.cancel:cli'),
     ('hardware:cancel-reasons', 'SoftLayer.CLI.hardware.cancel_reasons:cli'),
     ('hardware:create', 'SoftLayer.CLI.hardware.create:cli'),

SoftLayer/CLI/virt/bandwidth.py

@@ -0,0 +1,103 @@
+"""Get details for a hardware device."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+from SoftLayer.CLI import helpers
+from SoftLayer import utils
+
+
+@click.command()
+@click.argument('identifier')
+@click.option('--start_date', '-s', type=click.STRING, required=True,
+              help="Start Date YYYY-MM-DD, YYYY-MM-DDTHH:mm:ss,")
+@click.option('--end_date', '-e', type=click.STRING, required=True,
+              help="End Date YYYY-MM-DD, YYYY-MM-DDTHH:mm:ss")
+@click.option('--summary_period', '-p', type=click.INT, default=3600, show_default=True,
+              help="300, 600, 1800, 3600, 43200 or 86400 seconds")
+@click.option('--quite_summary', '-q', is_flag=True, default=False, show_default=True,
+              help="Only show the summary table")
+@environment.pass_env
+def cli(env, identifier, start_date, end_date, summary_period, quite_summary):
+    """Bandwidth data over date range. Bandwidth is listed in GB
+
+    Using just a date might get you times off by 1 hour, use T00:01 to get just the specific days data
+    Timezones can also be included with the YYYY-MM-DDTHH:mm:ss.00000-HH:mm format.
+
+    Due to some rounding and date alignment details, results here might be slightly different than
+    results in the control portal.
+
+    Example::
+
+        slcli hw bandwidth 1234 -s 2019-05-01T00:01 -e 2019-05-02T00:00:01.00000-12:00
+    """
+    vsi = SoftLayer.VSManager(env.client)
+    vsi_id = helpers.resolve_id(vsi.resolve_ids, identifier, 'VS')
+    data = vsi.get_bandwidth_data(vsi_id, start_date, end_date, None, summary_period)
+
+    title = "Bandwidth Report: %s - %s" % (start_date, end_date)
+    table, sum_table = create_bandwidth_table(data, summary_period, title)
+
+    env.fout(sum_table)
+    if not quite_summary:
+        env.fout(table)
+
+
+def create_bandwidth_table(data, summary_period, title="Bandwidth Report"):
+    """Create 2 tables, bandwidth and sumamry. Used here and in hw bandwidth command"""
+
+    formatted_data = {}
+    for point in data:
+        key = utils.clean_time(point['dateTime'])
+        data_type = point['type']
+        # conversion from byte to megabyte
+        value = round(float(point['counter']) / 2 ** 20, 4)
+        if formatted_data.get(key) is None:
+            formatted_data[key] = {}
+        formatted_data[key][data_type] = float(value)
+
+    table = formatting.Table(['Date', 'Pub In', 'Pub Out', 'Pri In', 'Pri Out'], title=title)
+
+    sum_table = formatting.Table(['Type', 'Sum GB', 'Average MBps', 'Max GB', 'Max Date'], title="Summary")
+
+    # Required to specify keyName because getBandwidthTotals returns other counter types for some reason.
+    bw_totals = [
+        {'keyName': 'publicIn_net_octet', 'sum': 0.0, 'max': 0, 'name': 'Pub In'},
+        {'keyName': 'publicOut_net_octet', 'sum': 0.0, 'max': 0, 'name': 'Pub Out'},
+        {'keyName': 'privateIn_net_octet', 'sum': 0.0, 'max': 0, 'name': 'Pri In'},
+        {'keyName': 'privateOut_net_octet', 'sum': 0.0, 'max': 0, 'name': 'Pri Out'},
+    ]
+
+    for point in formatted_data:
+        new_row = [point]
+        for bw_type in bw_totals:
+            counter = formatted_data[point].get(bw_type['keyName'], 0)
+            new_row.append(mb_to_gb(counter))
+            bw_type['sum'] = bw_type['sum'] + counter
+            if counter > bw_type['max']:
+                bw_type['max'] = counter
+                bw_type['maxDate'] = point
+        table.add_row(new_row)
+
+    for bw_type in bw_totals:
+        total = bw_type.get('sum', 0.0)
+        average = 0
+        if total > 0:
+            average = round(total / len(formatted_data) / summary_period, 4)
+        sum_table.add_row([
+            bw_type.get('name'),
+            mb_to_gb(total),
+            average,
+            mb_to_gb(bw_type.get('max')),
+            bw_type.get('maxDate')
+        ])
+
+    return table, sum_table
+
+
+def mb_to_gb(mbytes):
+    """Converts a MegaByte int to GigaByte. mbytes/2^10"""
+    return round(mbytes / 2 ** 10, 4)

SoftLayer/CLI/virt/detail.py

@@ -39,65 +39,42 @@ def cli(env, identifier, passwords=False, price=False):
     table.add_row(['domain', result['domain']])
     table.add_row(['fqdn', result['fullyQualifiedDomainName']])
     table.add_row(['status', formatting.FormattedItem(
-        result['status']['keyName'] or formatting.blank(),
-        result['status']['name'] or formatting.blank()
+        result['status']['keyName'],
+        result['status']['name']
     )])
     table.add_row(['state', formatting.FormattedItem(
         utils.lookup(result, 'powerState', 'keyName'),
         utils.lookup(result, 'powerState', 'name'),
     )])
     table.add_row(['active_transaction', formatting.active_txn(result)])
-    table.add_row(['datacenter',
-                   result['datacenter']['name'] or formatting.blank()])
+    table.add_row(['datacenter', result['datacenter']['name'] or formatting.blank()])
     _cli_helper_dedicated_host(env, result, table)
     operating_system = utils.lookup(result,
                                     'operatingSystem',
                                     'softwareLicense',
                                     'softwareDescription') or {}
-    table.add_row(['os', operating_system.get('name') or formatting.blank()])
-    table.add_row(['os_version',
-                   operating_system.get('version') or formatting.blank()])
+    table.add_row(['os', operating_system.get('name', '-')])
+    table.add_row(['os_version', operating_system.get('version', '-')])
     table.add_row(['cores', result['maxCpu']])
     table.add_row(['memory', formatting.mb_to_gb(result['maxMemory'])])
-    table.add_row(['public_ip',
-                   result['primaryIpAddress'] or formatting.blank()])
-    table.add_row(['private_ip',
-                   result['primaryBackendIpAddress'] or formatting.blank()])
+    table.add_row(['public_ip', result.get('primaryIpAddress', '-')])
+    table.add_row(['private_ip', result.get('primaryBackendIpAddress', '-')])
     table.add_row(['private_only', result['privateNetworkOnlyFlag']])
     table.add_row(['private_cpu', result['dedicatedAccountHostOnlyFlag']])
     table.add_row(['created', result['createDate']])
     table.add_row(['modified', result['modifyDate']])
-    if utils.lookup(result, 'billingItem') != []:
-        table.add_row(['owner', formatting.FormattedItem(
-            utils.lookup(result, 'billingItem', 'orderItem',
-                         'order', 'userRecord',
-                         'username') or formatting.blank(),
-        )])
-    else:
-        table.add_row(['owner', formatting.blank()])
 
-    vlan_table = formatting.Table(['type', 'number', 'id'])
-    for vlan in result['networkVlans']:
-        vlan_table.add_row([
-            vlan['networkSpace'], vlan['vlanNumber'], vlan['id']])
-    table.add_row(['vlans', vlan_table])
+    table.add_row(_get_owner_row(result))
+    table.add_row(_get_vlan_table(result))
 
-    if result.get('networkComponents'):
-        secgroup_table = formatting.Table(['interface', 'id', 'name'])
-        has_secgroups = False
-        for comp in result.get('networkComponents'):
-            interface = 'PRIVATE' if comp['port'] == 0 else 'PUBLIC'
-            for binding in comp['securityGroupBindings']:
-                has_secgroups = True
-                secgroup = binding['securityGroup']
-                secgroup_table.add_row([
-                    interface, secgroup['id'],
-                    secgroup.get('name') or formatting.blank()])
-        if has_secgroups:
-            table.add_row(['security_groups', secgroup_table])
+    bandwidth = vsi.get_bandwidth_allocation(vs_id)
+    table.add_row(['Bandwidth', _bw_table(bandwidth)])
+
+    security_table = _get_security_table(result)
+    if security_table is not None:
+        table.add_row(['security_groups', security_table])
 
-    if result.get('notes'):
-        table.add_row(['notes', result['notes']])
+    table.add_row(['notes', result.get('notes', '-')])
 
     if price:
         total_price = utils.lookup(result,
@@ -145,6 +122,20 @@ def cli(env, identifier, passwords=False, price=False):
     env.fout(table)
 
 
+def _bw_table(bw_data):
+    """Generates a bandwidth useage table"""
+    table = formatting.Table(['Type', 'In GB', 'Out GB', 'Allotment'])
+    for bw_point in bw_data.get('useage'):
+        bw_type = 'Private'
+        allotment = 'N/A'
+        if bw_point['type']['alias'] == 'PUBLIC_SERVER_BW':
+            bw_type = 'Public'
+            allotment = bw_data['allotment'].get('amount', '-')
+
+        table.add_row([bw_type, bw_point['amountIn'], bw_point['amountOut'], allotment])
+    return table
+
+
 def _cli_helper_dedicated_host(env, result, table):
     """Get details on dedicated host for a virtual server."""
 
@@ -160,3 +151,40 @@ def _cli_helper_dedicated_host(env, result, table):
             dedicated_host = {}
         table.add_row(['dedicated_host',
                        dedicated_host.get('name') or formatting.blank()])
+
+
+def _get_owner_row(result):
+    """Formats and resturns the Owner row"""
+
+    if utils.lookup(result, 'billingItem') != []:
+        owner = utils.lookup(result, 'billingItem', 'orderItem', 'order', 'userRecord', 'username')
+    else:
+        owner = formatting.blank()
+    return(['owner', owner])
+
+
+def _get_vlan_table(result):
+    """Formats and resturns a vlan table"""
+
+    vlan_table = formatting.Table(['type', 'number', 'id'])
+    for vlan in result['networkVlans']:
+        vlan_table.add_row([
+            vlan['networkSpace'], vlan['vlanNumber'], vlan['id']])
+    return ['vlans', vlan_table]
+
+
+def _get_security_table(result):
+    secgroup_table = formatting.Table(['interface', 'id', 'name'])
+    has_secgroups = False
+
+    if result.get('networkComponents'):
+        for comp in result.get('networkComponents'):
+            interface = 'PRIVATE' if comp['port'] == 0 else 'PUBLIC'
+            for binding in comp['securityGroupBindings']:
+                has_secgroups = True
+                secgroup = binding['securityGroup']
+                secgroup_table.add_row([interface, secgroup['id'], secgroup.get('name', '-')])
+    if has_secgroups:
+        return secgroup_table
+    else:
+        return None

SoftLayer/CLI/virt/usage.py

@@ -17,7 +17,7 @@
 @click.option('--end_date', '-e', type=click.STRING, required=True, help="End Date e.g. 2019-4-2 (yyyy-MM-dd)")
 @click.option('--valid_type', '-t', type=click.STRING, required=True,
               help="Metric_Data_Type keyName e.g. CPU0, CPU1, MEMORY_USAGE, etc.")
-@click.option('--summary_period', '-p', type=click.INT, default=1800,
+@click.option('--summary_period', '-p', type=click.INT, default=3600,
               help="300, 600, 1800, 3600, 43200 or 86400 seconds")
 @environment.pass_env
 def cli(env, identifier, start_date, end_date, valid_type, summary_period):

SoftLayer/decoration.py

@@ -15,7 +15,6 @@
     exceptions.ServerError,
     exceptions.ApplicationError,
     exceptions.RemoteSystemError,
-    exceptions.TransportError
 )