resolving merge conflict

Author: allmightyspiff

.github/workflows/test_pypi_release.yml

@@ -0,0 +1,37 @@
+# https://packaging.python.org/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+
+name: Publish 📦 to TestPyPI
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+    runs-on: ubuntu-18.04
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+    - name: Install pypa/build
+      run: >-
+        python -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python -m
+        build
+        --sdist
+        --wheel
+        --outdir dist/
+        .
+    - name: Publish 📦 to Test PyPI
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        password: ${{ secrets.CGALLO_TEST_PYPI }}
+        repository_url: https://test.pypi.org/legacy/

CONTRIBUTING.md

@@ -116,24 +116,24 @@ self.assertEqual(123, order_args['hostId'])
 
 ### Issues
 
-* ~~Title~~: Should contain quick highlight of the issue is about
-* ~~Body~~: All the technical information goes here
-* ~~Assignee~~: Should be the person who is actively working on an issue.
-* ~~Label~~: All issues should have at least 1 Label.
-* ~~Projects~~: Should be added to the quarerly Softlayer project when being worked on
-* ~~Milestones~~: Not really used, can be left blank
-* ~~Linked Pull Request~~: Should be linked to the relavent pull request when it is opened.
+* _Title_: Should contain quick highlight of the issue is about
+* _Body_: All the technical information goes here
+* _Assignee_: Should be the person who is actively working on an issue.
+* _Label_: All issues should have at least 1 Label.
+* _Projects_: Should be added to the quarerly Softlayer project when being worked on
+* _Milestones_: Not really used, can be left blank
+* _Linked Pull Request_: Should be linked to the relavent pull request when it is opened.
 
 ### Pull Requests
 
-* ~~Title~~: Should be similar to the title of the issue it is fixing, or otherwise descibe what is chaning in the pull request
-* ~~Body~~: Should have "Fixes #1234" at least, with some notes about the specific pull request if needed. Most technical information should still be in the github issue.
-* ~~Reviewers~~: 1 Reviewer is required
-* ~~Assignee~~: Should be the person who opened the pull request
-* ~~Labels~~: Should match the issue
-* ~~Projects~~: Should match the issue
-* ~~Milestones~~: Not really used, can be left blank
-* ~~Linked issues~~: If you put "Fixes #<Issue number>" in the body, this should be automatically filled in, otherwise link manually.
+* _Title_: Should be similar to the title of the issue it is fixing, or otherwise descibe what is chaning in the pull request
+* _Body_: Should have "Fixes #1234" at least, with some notes about the specific pull request if needed. Most technical information should still be in the github issue.
+* _Reviewers_: 1 Reviewer is required
+* _Assignee_: Should be the person who opened the pull request
+* _Labels_: Should match the issue
+* _Projects_: Should match the issue
+* _Milestones_: Not really used, can be left blank
+* _Linked issues_: If you put "Fixes #<Issue number>" in the body, this should be automatically filled in, otherwise link manually.
 
 ### Code Reviews
 All issues should be reviewed by at least 1 member of the SLDN team that is not the person opening the pull request. Time permitting, all members of the SLDN team should review the request.

README.rst

@@ -28,8 +28,7 @@ SoftLayer products and services.
 
 Documentation
 -------------
-Documentation for the Python client is available at
-http://softlayer.github.io/softlayer-python/.
+Documentation for the Python client is available at `Read the Docs <https://softlayer-python.readthedocs.io/en/latest/index.html>`_ .
 
 Additional API documentation can be found on the SoftLayer Development Network:
 
@@ -38,7 +37,7 @@ Additional API documentation can be found on the SoftLayer Development Network:
 * `Object mask information and examples
   <https://sldn.softlayer.com/article/object-masks>`_
 * `Code Examples
-  <https://softlayer.github.io/python/>`_
+  <https://sldn.softlayer.com/python/>`_
 
 Installation
 ------------
@@ -82,7 +81,7 @@ Issues with the Softlayer API itself should be addressed by opening a ticket.
 Examples
 --------
 
-A curated list of examples on how to use this library can be found at `softlayer.github.io <https://softlayer.github.io/python/>`_
+A curated list of examples on how to use this library can be found at `SLDN <https://softlayer.github.io/python/>`_
 
 Debugging
 ---------

RELEASE.md

@@ -1,18 +1,74 @@
-# Release steps
 
-* Update version constants (find them by running `git grep [VERSION_NUMBER]`)
-* Create changelog entry (edit CHANGELOG.md with a one-liner for each closed issue going in the release)
-* Commit and push changes to master with the message: "Version Bump to v[VERSION_NUMBER]"
-* Make sure your `upstream` repo is set
+
+# Versions
+
+This project follows the Major.Minor.Revision versioning system. Fixes, and minor additions would increment Revision. Large changes and additions would increment Minor, and anything that would be a "Breaking" change, or redesign would be an increment of Major.
+
+# Changelog
+
+When doing a release, the Changelog format should be as follows:
+
+```markdown
+
+## [Version] - YYYY-MM-DD
+https://github.com/softlayer/softlayer-python/compare/v5.9.0...v5.9.1 
+
+#### New Command
+- `slcli new command` #issueNumber
+
+#### Improvements
+- List out improvements #issueNumber
+- Something else that changed #issueNumber
+
+#### Deprecated
+- List something that got removed #issueNumber
+
+```
+
+# Normal Release steps
+
+A "release" of the softlayer-python project is the current state of the `master` branch. Any changes in the master branch should be considered releaseable.
+
+
+1. Create the changelog entry, us this to update `CHANGELOG.md` and as the text for the release on github.
+2. Update the version numbers in these files on the master branch.
+    - `SoftLayer/consts.py`
+    - `setup.py`
+3. Make sure the tests for the build all pass
+4. [Draft a new release](https://github.com/softlayer/softlayer-python/releases/new)
+    - Version should start with `v` followed by Major.Minor.Revision: `vM.m.r`
+    - Title should be `M.m.r`
+    - Description should be the release notes  
+    - Target should be the `master` branch
+5. The github automation should take care of publishing the release to [PyPi](https://pypi.org/project/SoftLayer/). This may take a few minutes to update.
+
+# Manual Release steps
+
+1. Create the changelog entry, us this to update `CHANGELOG.md` and as the text for the release on github.
+2. Update the version numbers in these files on the master branch.
+    - `SoftLayer/consts.py`
+    - `setup.py`
+3. Commit your changes to `master`, and make sure `softlayer/softlayer-python` repo is updated to reflect that
+4. Make sure your `upstream` repo is set
+
 ```
 git remote -v
 upstream  git@github.com:softlayer/softlayer-python.git (fetch)
 upstream  git@github.com:softlayer/softlayer-python.git (push)
 ```
-* Push tag and PyPi `python fabfile.py 5.7.2`. Before you do this, make sure you have the organization repository set up as upstream remote, also make sure that you have pip set up with your PyPi user credentials. The easiest way to do that is to create a file at `~/.pypirc` with the following contents:
+
+5. Create and publish the package
+    - Make sure you have `twine` installed, this is what uploads the pacakge to PyPi.
+    - Before you do this, make sure you have the organization repository set up as upstream remote, also make sure that you have pip set up with your PyPi user credentials. The easiest way to do that is to create a file at `~/.pypirc` with the following contents: 
 
  ```
 [server-login]
 username:YOUR_USERNAME
 password:YOUR_PASSWORD
  ```
+
+    - Run `python fabfile.py 5.7.2`. Where `5.7.2` is the `M.m.r` version number. Don't use the `v` here in the version number. 
+
+
+*NOTE* PyPi doesn't let you reupload a version, if you upload a bad package for some reason, you have to create a new version.
+

SoftLayer/CLI/environment.py

@@ -67,7 +67,23 @@ def input(self, prompt, default=None, show_default=True):
 
     def getpass(self, prompt, default=None):
         """Provide a password prompt."""
-        return click.prompt(prompt, hide_input=True, default=default)
+        password = click.prompt(prompt, hide_input=True, default=default)
+
+        # https://github.com/softlayer/softlayer-python/issues/1436
+        # click.prompt uses python's getpass() in the background
+        # https://github.com/python/cpython/blob/3.9/Lib/getpass.py#L97
+        # In windows, shift+insert actually inputs the below 2 characters
+        # If we detect those 2 characters, need to manually read from the clipbaord instead
+        # https://stackoverflow.com/questions/101128/how-do-i-read-text-from-the-clipboard
+        if password == 'àR':
+            # tkinter is a built in python gui, but it has clipboard reading functions.
+            # pylint: disable=import-outside-toplevel
+            from tkinter import Tk
+            tk_manager = Tk()
+            password = tk_manager.clipboard_get()
+            # keep the window from showing
+            tk_manager.withdraw()
+        return password
 
     # Command loading methods
     def list_commands(self, *path):

SoftLayer/CLI/hardware/upgrade.py

@@ -24,24 +24,40 @@
               default=None,
               type=click.Choice(['Non-RAID', 'RAID']))
 @click.option('--public-bandwidth', type=click.INT, help="Public Bandwidth in GB")
+@click.option('--add-disk', nargs=2, multiple=True, type=(int, int),
+              help="Add a Hard disk in GB to a specific channel, e.g 1000 GB in disk2, it will be "
+                   "--add-disk 1000 2")
+@click.option('--resize-disk', nargs=2, multiple=True, type=(int, int),
+              help="Upgrade a specific disk size in GB, e.g --resize-disk 2000 2")
 @click.option('--test', is_flag=True, default=False, help="Do not actually upgrade the hardware server")
 @environment.pass_env
-def cli(env, identifier, memory, network, drive_controller, public_bandwidth, test):
+def cli(env, identifier, memory, network, drive_controller, public_bandwidth, add_disk, resize_disk, test):
     """Upgrade a Hardware Server."""
 
     mgr = SoftLayer.HardwareManager(env.client)
 
-    if not any([memory, network, drive_controller, public_bandwidth]):
+    if not any([memory, network, drive_controller, public_bandwidth, add_disk, resize_disk]):
         raise exceptions.ArgumentError("Must provide "
-                                       " [--memory], [--network], [--drive-controller], or [--public-bandwidth]")
+                                       " [--memory], [--network], [--drive-controller], [--public-bandwidth],"
+                                       "[--add-disk] or [--resize-disk]")
 
     hw_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'Hardware')
     if not test:
         if not (env.skip_confirmations or formatting.confirm(
                 "This action will incur charges on your account. Continue?")):
             raise exceptions.CLIAbort('Aborted')
 
+    disk_list = list()
+    if add_disk:
+        for guest_disk in add_disk:
+            disks = {'description': 'add_disk', 'capacity': guest_disk[0], 'number': guest_disk[1]}
+            disk_list.append(disks)
+    if resize_disk:
+        for guest_disk in resize_disk:
+            disks = {'description': 'resize_disk', 'capacity': guest_disk[0], 'number': guest_disk[1]}
+            disk_list.append(disks)
+
     if not mgr.upgrade(hw_id, memory=memory, nic_speed=network, drive_controller=drive_controller,
-                       public_bandwidth=public_bandwidth, test=test):
+                       public_bandwidth=public_bandwidth, disk=disk_list, test=test):
         raise exceptions.CLIAbort('Hardware Server Upgrade Failed')
     env.fout('Successfully Upgraded.')

SoftLayer/CLI/virt/detail.py

@@ -69,6 +69,11 @@ def cli(env, identifier, passwords=False, price=False):
     table.add_row(['transient', result.get('transientGuestFlag', False)])
     table.add_row(['created', result['createDate']])
     table.add_row(['modified', result['modifyDate']])
+    last_transaction = "{} ({})".format(utils.lookup(result, 'lastTransaction', 'transactionGroup', 'name'),
+                                        utils.clean_time(utils.lookup(result, 'lastTransaction', 'modifyDate')))
+
+    table.add_row(['last_transaction', last_transaction])
+    table.add_row(['billing', 'Hourly' if result['hourlyBillingFlag'] else'Monthly'])
     table.add_row(['preset', utils.lookup(result, 'billingItem',
                                           'orderItem',
                                           'preset',

SoftLayer/fixtures/SoftLayer_Hardware_Server.py

@@ -13,6 +13,10 @@
         'children': [
             {'description': 'test', 'nextInvoiceTotalRecurringAmount': 1},
         ],
+        'nextInvoiceChildren': [
+            {'description': 'test', 'nextInvoiceTotalRecurringAmount': 1, 'categoryCode': 'disk1'},
+            {'description': 'test2', 'nextInvoiceTotalRecurringAmount': 2, 'categoryCode': 'disk3'}
+        ],
         'orderItem': {
             'order': {
                 'userRecord': {
@@ -336,5 +340,40 @@
             "id": 6177,
             "keyName": "BANDWIDTH_500_GB"
         }
+    },
+    {
+        "hourlyRecurringFee": ".023",
+        "id": 49759,
+        "recurringFee": "15",
+        "categories": [
+            {
+                "categoryCode": "disk2",
+                "id": 6,
+                "name": "Third Hard Drive"
+            }
+        ],
+        "item": {
+            "capacity": "1000",
+            "description": "1.00 TB SATA",
+            "id": 6159,
+            "keyName": "HARD_DRIVE_1_00_TB_SATA_2",
+        }
+    },
+    {
+        "id": 49759,
+        "recurringFee": "0",
+        "categories": [
+            {
+                "categoryCode": "disk1",
+                "id": 5,
+                "name": "Second Hard Drive"
+            }
+        ],
+        "item": {
+            "capacity": "1000",
+            "description": "1.00 TB SATA",
+            "id": 6159,
+            "keyName": "HARD_DRIVE_1_00_TB_SATA_2"
+        }
     }
 ]