Merge branch 'master' into issue_1241

Author: allmightyspiff

.github/workflows/documentation.yml

@@ -0,0 +1,27 @@
+name: softlayer
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r tools/test-requirements.txt
+    - name: Documentation Checks
+      run: |
+        python docCheck.py

CHANGELOG.md

@@ -1,7 +1,21 @@
 # Change Log
 
-
-## [5.8.5] - 2012-01-29
+## [5.8.7] - 2020-03-26
+https://github.com/softlayer/softlayer-python/compare/v5.8.5...v5.8.7
+
+- #1222 Get load balancer (LBaaS) by name
+- #1221 Added version checker
+- #1227 Updated unit test suite for TravisCI to run properly
+- #1225 Add note about using multiple colon symbols not working when setting tags.
+- #1228 Support ordering [Dependent Duplicate Volumes](https://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-dependentduplicate)
+- #1233 Refactored File/Block managers to reduce duplicated code.
+- #1231 Added Refresh functions for Dependent Duplicate Volumes
+- #801 Added support for JSON styled parameters and object filters
+- #1234 Added ability to change which datacenters an image template was stored in
+
+## [5.8.6] - Skipped
+
+## [5.8.5] - 2020-01-29
 https://github.com/softlayer/softlayer-python/compare/v5.8.4...v5.8.5
 
 -  #1195 Fixed an issue with `slcli vs dns-sync --ptr`. Added `slcli hw dns-sync`

SoftLayer/CLI/account/billing_items.py

@@ -0,0 +1,60 @@
+"""Lists all active billing items on this account. See https://cloud.ibm.com/billing/billing-items"""
+# :license: MIT, see LICENSE for more details.
+import click
+
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+from SoftLayer.managers.account import AccountManager as AccountManager
+from SoftLayer import utils
+
+
+@click.command()
+@environment.pass_env
+def cli(env):
+    """Lists billing items with some other useful information.
+
+    Similiar to https://cloud.ibm.com/billing/billing-items
+    """
+
+    manager = AccountManager(env.client)
+    items = manager.get_account_billing_items()
+    table = item_table(items)
+
+    env.fout(table)
+
+
+def item_table(items):
+    """Formats a table for billing items"""
+    table = formatting.Table([
+        "Id",
+        "Create Date",
+        "Cost",
+        "Category Code",
+        "Ordered By",
+        "Description",
+        "Notes"
+    ], title="Billing Items")
+    table.align['Description'] = 'l'
+    table.align['Category Code'] = 'l'
+    for item in items:
+        description = item.get('description')
+        fqdn = "{}.{}".format(item.get('hostName', ''), item.get('domainName', ''))
+        if fqdn != ".":
+            description = fqdn
+        user = utils.lookup(item, 'orderItem', 'order', 'userRecord')
+        ordered_by = "IBM"
+        create_date = utils.clean_time(item.get('createDate'), in_format='%Y-%m-%d', out_format='%Y-%m-%d')
+        if user:
+            # ordered_by = "{} ({})".format(user.get('displayName'), utils.lookup(user, 'userStatus', 'name'))
+            ordered_by = user.get('displayName')
+
+        table.add_row([
+            item.get('id'),
+            create_date,
+            item.get('nextInvoiceTotalRecurringAmount'),
+            item.get('categoryCode'),
+            ordered_by,
+            utils.trim_to(description, 50),
+            utils.trim_to(item.get('notes', 'None'), 40),
+        ])
+    return table

SoftLayer/CLI/account/cancel_item.py

@@ -0,0 +1,18 @@
+"""Cancels a billing item."""
+# :license: MIT, see LICENSE for more details.
+import click
+
+from SoftLayer.CLI import environment
+from SoftLayer.managers.account import AccountManager as AccountManager
+
+
+@click.command()
+@click.argument('identifier')
+@environment.pass_env
+def cli(env, identifier):
+    """Cancels a billing item."""
+
+    manager = AccountManager(env.client)
+    item = manager.cancel_item(identifier)
+
+    env.fout(item)

SoftLayer/CLI/account/item_detail.py

@@ -0,0 +1,52 @@
+"""Gets some details about a specific billing item."""
+# :license: MIT, see LICENSE for more details.
+import click
+
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+from SoftLayer.managers.account import AccountManager as AccountManager
+from SoftLayer import utils
+
+
+@click.command()
+@click.argument('identifier')
+@environment.pass_env
+def cli(env, identifier):
+    """Gets detailed information about a billing item."""
+    manager = AccountManager(env.client)
+    item = manager.get_billing_item(identifier)
+    env.fout(item_table(item))
+
+
+def item_table(item):
+    """Formats a table for billing items"""
+
+    date_format = '%Y-%m-%d'
+    table = formatting.KeyValueTable(["Key", "Value"], title="{}".format(item.get('description', 'Billing Item')))
+    table.add_row(['createDate', utils.clean_time(item.get('createDate'), date_format, date_format)])
+    table.add_row(['cycleStartDate', utils.clean_time(item.get('cycleStartDate'), date_format, date_format)])
+    table.add_row(['cancellationDate', utils.clean_time(item.get('cancellationDate'), date_format, date_format)])
+    table.add_row(['description', item.get('description')])
+    fqdn = "{}.{}".format(item.get('hostName'), item.get('domain'))
+    if fqdn != ".":
+        table.add_row(['FQDN', fqdn])
+
+    if item.get('hourlyFlag', False):
+        table.add_row(['hourlyRecurringFee', item.get('hourlyRecurringFee')])
+        table.add_row(['hoursUsed', item.get('hoursUsed')])
+        table.add_row(['currentHourlyCharge', item.get('currentHourlyCharge')])
+    else:
+        table.add_row(['recurringFee', item.get('recurringFee')])
+
+    ordered_by = "IBM"
+    user = utils.lookup(item, 'orderItem', 'order', 'userRecord')
+    if user:
+        ordered_by = "{} ({})".format(user.get('displayName'), utils.lookup(user, 'userStatus', 'name'))
+    table.add_row(['Ordered By', ordered_by])
+    table.add_row(['Notes', item.get('notes')])
+    table.add_row(['Location', utils.lookup(item, 'location', 'name')])
+    if item.get('children'):
+        for child in item.get('children'):
+            table.add_row([child.get('categoryCode'), child.get('description')])
+
+    return table

SoftLayer/CLI/hardware/billing.py

@@ -0,0 +1,38 @@
+"""Get billing 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')
+@environment.pass_env
+def cli(env, identifier):
+    """Get billing for a hardware device."""
+    hardware = SoftLayer.HardwareManager(env.client)
+
+    hardware_id = helpers.resolve_id(hardware.resolve_ids, identifier, 'hardware')
+    result = hardware.get_hardware(hardware_id)
+    table = formatting.KeyValueTable(['name', 'value'])
+    table.align['name'] = 'r'
+    table.align['value'] = 'l'
+
+    table.add_row(['Id', identifier])
+
+    table.add_row(['Billing Item Id', utils.lookup(result, 'billingItem', 'id')])
+    table.add_row(['Recurring Fee', utils.lookup(result, 'billingItem', 'recurringFee')])
+    table.add_row(['Total', utils.lookup(result, 'billingItem', 'nextInvoiceTotalRecurringAmount')])
+    table.add_row(['Provision Date', utils.lookup(result, 'billingItem', 'provisionDate')])
+
+    price_table = formatting.Table(['Item', 'Recurring Price'])
+    for item in utils.lookup(result, 'billingItem', 'children') or []:
+        price_table.add_row([item['description'], item['nextInvoiceTotalRecurringAmount']])
+
+    table.add_row(['prices', price_table])
+    env.fout(table)

SoftLayer/CLI/routes.py

@@ -17,9 +17,13 @@
     ('account:events', 'SoftLayer.CLI.account.events:cli'),
     ('account:event-detail', 'SoftLayer.CLI.account.event_detail:cli'),
     ('account:summary', 'SoftLayer.CLI.account.summary:cli'),
+    ('account:billing-items', 'SoftLayer.CLI.account.billing_items:cli'),
+    ('account:item-detail', 'SoftLayer.CLI.account.item_detail:cli'),
+    ('account:cancel-item', 'SoftLayer.CLI.account.cancel_item:cli'),
 
     ('virtual', 'SoftLayer.CLI.virt'),
     ('virtual:bandwidth', 'SoftLayer.CLI.virt.bandwidth:cli'),
+    ('virtual:billing', 'SoftLayer.CLI.virt.billing:cli'),
     ('virtual:cancel', 'SoftLayer.CLI.virt.cancel:cli'),
     ('virtual:capture', 'SoftLayer.CLI.virt.capture:cli'),
     ('virtual:create', 'SoftLayer.CLI.virt.create:cli'),
@@ -192,11 +196,9 @@
     ('loadbal:order-options', 'SoftLayer.CLI.loadbal.order:order_options'),
     ('loadbal:cancel', 'SoftLayer.CLI.loadbal.order:cancel'),
 
-
     ('loadbal:ns-detail', 'SoftLayer.CLI.loadbal.ns_detail:cli'),
     ('loadbal:ns-list', 'SoftLayer.CLI.loadbal.ns_list:cli'),
 
-
     ('metadata', 'SoftLayer.CLI.metadata:cli'),
 
     ('nas', 'SoftLayer.CLI.nas'),
@@ -232,6 +234,7 @@
     ('hardware:create', 'SoftLayer.CLI.hardware.create:cli'),
     ('hardware:create-options', 'SoftLayer.CLI.hardware.create_options:cli'),
     ('hardware:detail', 'SoftLayer.CLI.hardware.detail:cli'),
+    ('hardware:billing', 'SoftLayer.CLI.hardware.billing:cli'),
     ('hardware:edit', 'SoftLayer.CLI.hardware.edit:cli'),
     ('hardware:list', 'SoftLayer.CLI.hardware.list:cli'),
     ('hardware:power-cycle', 'SoftLayer.CLI.hardware.power:power_cycle'),
@@ -306,6 +309,8 @@
     ('user:edit-details', 'SoftLayer.CLI.user.edit_details:cli'),
     ('user:create', 'SoftLayer.CLI.user.create:cli'),
     ('user:delete', 'SoftLayer.CLI.user.delete:cli'),
+    ('user:vpn-manual', 'SoftLayer.CLI.user.vpn_manual:cli'),
+    ('user:vpn-subnet', 'SoftLayer.CLI.user.vpn_subnet:cli'),
 
     ('vlan', 'SoftLayer.CLI.vlan'),
     ('vlan:detail', 'SoftLayer.CLI.vlan.detail:cli'),

SoftLayer/CLI/user/vpn_manual.py

@@ -0,0 +1,28 @@
+"""Enable or Disable vpn subnets manual config for a user."""
+# :license: MIT, see LICENSE for more details.
+
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import helpers
+
+
+@click.command()
+@click.argument('user')
+@click.option('--enable/--disable', default=True,
+              help="Enable or disable vpn subnets manual config.")
+@environment.pass_env
+def cli(env, user, enable):
+    """Enable or disable user vpn subnets manual config"""
+    mgr = SoftLayer.UserManager(env.client)
+    user_id = helpers.resolve_id(mgr.resolve_ids, user, 'username')
+
+    result = mgr.vpn_manual(user_id, enable)
+    message = "{} vpn manual config {}".format(user, 'enable' if enable else 'disable')
+
+    if result:
+        click.secho(message, fg='green')
+    else:
+        click.secho("Failed to update {}".format(user), fg='red')

SoftLayer/CLI/user/vpn_subnet.py

@@ -0,0 +1,30 @@
+"""Add or remove specific subnets access for a user."""
+# :license: MIT, see LICENSE for more details.
+
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import helpers
+
+
+@click.command()
+@click.option('--add/--remove', default=True,
+              help="Add or remove access to subnets.")
+@click.argument('user', nargs=1, required=True)
+@click.argument('subnet', nargs=-1, required=True)
+@environment.pass_env
+def cli(env, user, add, subnet):
+    """Add or remove subnets access for a user."""
+    mgr = SoftLayer.UserManager(env.client)
+    user_id = helpers.resolve_id(mgr.resolve_ids, user, 'username')
+    if add:
+        result = mgr.vpn_subnet_add(user_id, subnet)
+    else:
+        result = mgr.vpn_subnet_remove(user_id, subnet)
+
+    if result:
+        click.secho("%s updated successfully" % (user), fg='green')
+    else:
+        click.secho("Failed to update %s" % (user), fg='red')

SoftLayer/CLI/virt/billing.py

@@ -0,0 +1,38 @@
+"""Get billing for a virtual 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')
+@environment.pass_env
+def cli(env, identifier):
+    """Get billing for a virtual device."""
+    virtual = SoftLayer.VSManager(env.client)
+
+    virtual_id = helpers.resolve_id(virtual.resolve_ids, identifier, 'virtual')
+    result = virtual.get_instance(virtual_id)
+    table = formatting.KeyValueTable(['name', 'value'])
+    table.align['name'] = 'r'
+    table.align['value'] = 'l'
+
+    table.add_row(['Id', identifier])
+
+    table.add_row(['Billing Item Id', utils.lookup(result, 'billingItem', 'id')])
+    table.add_row(['Recurring Fee', utils.lookup(result, 'billingItem', 'recurringFee')])
+    table.add_row(['Total', utils.lookup(result, 'billingItem', 'nextInvoiceTotalRecurringAmount')])
+    table.add_row(['Provision Date', utils.lookup(result, 'billingItem', 'provisionDate')])
+
+    price_table = formatting.Table(['Recurring Price'])
+    for item in utils.lookup(result, 'billingItem', 'children') or []:
+        price_table.add_row([item['nextInvoiceTotalRecurringAmount']])
+
+    table.add_row(['prices', price_table])
+    env.fout(table)