rescale · yhuanghamu · Aug 8, 2019 · Nov 28, 2018 · Nov 28, 2018 · Nov 29, 2018
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,24 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: htmldir
+  configuration: docs/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - requirements: docs/requirements.txt
diff --git a/.travis.yml b/.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

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,124 @@
 # Change Log
 
+
+## [5.7.2] - 2019-05-03
+- https://github.com/softlayer/softlayer-python/compare/v5.7.1...v5.7.2
+
++ #1107 Added exception to handle json parsing error when ordering 
++ #1068 Support for -1 when changing port speed 
++ #1109 Fixed docs about placement groups
++ #1112 File storage endurance iops upgrade 
++ #1101 Handle the new user creation exceptions 
++ #1116 Fix order place quantity option
++ #1002 Invoice commands
+    * account invoices
+    * account invoice-detail
+    * account summary
++ #1004 Event Notification Management commands
+    * account events
+    * account event-detail
++ #1117 Two PCIe items can be added at order time 
++ #1121 Fix object storage apiType for S3 and Swift.
++ #1100 Event Log performance improvements. 
++ #872 column 'name' was renamed to 'hostname'
++ #1127 Fix object storage credentials.
++ #1129 Fixed unexpected errors in slcli subnet create
++ #1134 Change encrypt parameters for importing of images. Adds root-key-crn
++ #208 Quote ordering commands
+    * order quote
+    * order quote-detail
+    * order quote-list
++ #1113 VS usage information command
+    * virtual usage 
++ #1131 made sure config_tests dont actually make api calls.
+
+
+## [5.7.1] - 2019-02-26
+- https://github.com/softlayer/softlayer-python/compare/v5.7.0...v5.7.1
+
++ #1089 removed legacy SL message queue commands
++ Support for Hardware reflash firmware CLI/Manager method
+
+## [5.7.0] - 2019-02-15
+- Changes: https://github.com/softlayer/softlayer-python/compare/v5.6.4...v5.7.0
+
++ #1099 Support for security group Ids
++ event-log cli command
++ #1069 Virtual Placement Group Support
+   ```
+      slcli vs placementgroup --help
+    Commands:
+      create          Create a placement group.
+      create-options  List options for creating a placement group.
+      delete          Delete a placement group.
+      detail          View details of a placement group.
+      list            List placement groups.
+   ```
++ #962 Rest Transport improvements. Properly handle HTTP exceptions instead of crashing.
++ #1090 removed power_state column option from "slcli server list"
++ #676 - ipv6 support for creating virtual guests
+  * Refactored virtual guest creation to use Product_Order::placeOrder instead of Virtual_Guest::createObject, because createObject doesn't allow adding IPv6
++ #882 Added table which shows the status of each url in object storage
++ #1085 Update provisionedIops reading to handle float-y values
++ #1074 fixed issue with config setup
++ #1081 Fix file volume-cancel
++ #1059 Support for SoftLayer_Hardware_Server::toggleManagementInterface
+  * `slcli hw toggle-ipmi`
+
+
+## [5.6.4] - 2018-11-16
+
+- Changes: https://github.com/softlayer/softlayer-python/compare/v5.6.3...v5.6.4
+
++ #1041 Dedicated host cancel, cancel-guests, list-guests
++ #1071 added createDate and modifyDate parameters to sg rule-list
++ #1060 Fixed slcli subnet list
++ #1056 Fixed documentation link in image manager
++ #1062 Added description to slcli order 
+
+## [5.6.3] - 2018-11-07
+
+- Changes: https://github.com/softlayer/softlayer-python/compare/v5.6.0...v5.6.3
+
++ #1065 Updated urllib3 and requests libraries due to CVE-2018-18074
++ #1070 Fixed an ordering bug
++ Updated release process and fab-file
+
+## [5.6.0] - 2018-10-16
+- Changes: https://github.com/softlayer/softlayer-python/compare/v5.5.3...v5.6.0
+
++ #1026 Support for [Reserved Capacity](https://console.bluemix.net/docs/vsi/vsi_about_reserved.html#about-reserved-virtual-servers)
+  * `slcli vs capacity create`
+  * `slcli vs capacity create-guest`
+  * `slcli vs capacity create-options`
+  * `slcli vs capacity detail`
+  * `slcli vs capacity list`
++ #1050 Fix `post_uri` parameter name on docstring
++ #1039 Fixed suspend cloud server order.
++ #1055 Update to use click 7
++ #1053 Add export/import capabilities to/from IBM Cloud Object Storage to the image manager as well as the slcli. 
+
+
+## [5.5.3] - 2018-08-31
+- Changes: https://github.com/softlayer/softlayer-python/compare/v5.5.2...v5.5.3
+
++ Added `slcli user delete`
++ #1023 Added `slcli order quote` to let users create a quote from the slcli.
++ #1032 Fixed vs upgrades when using flavors.
++ #1034 Added pagination to ticket list commands
++ #1037 Fixed DNS manager to be more flexible and support more zone types.
++ #1044 Pinned Click library version at >=5 < 7
+
+## [5.5.2] - 2018-08-31
+- Changes: https://github.com/softlayer/softlayer-python/compare/v5.5.1...v5.5.2
+
++ #1018 Fixed hardware credentials.
++ #1019 support for ticket priorities
++ #1025 create dedicated host with gpu fixed.
+
+
 ## [5.5.1] - 2018-08-06
-- Changes: https://github.com/softlayer/softlayer-python/compare/v5.5.0...master
+- Changes: https://github.com/softlayer/softlayer-python/compare/v5.5.0...v5.5.1
 
 - #1006, added paginations to several slcli methods, making them work better with large result sets. 
 - #995, Fixed an issue displaying VLANs.

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -25,5 +25,80 @@ Code is tested and style checked with tox, you can run the tox tests individuall
 * create pull request
 
 
+## Documentation
 
+CLI command should have a more human readable style of documentation.
+Manager methods should have a decent docblock describing any parameters and what the method does.
 
+Docs are generated with [Sphinx](https://docs.readthedocs.io/en/latest/intro/getting-started-with-sphinx.html) and once Sphinx is setup, you can simply do
+
+`make html` in the softlayer-python/docs directory, which should generate the HTML in softlayer-python/docs/_build/html for testing. 
+
+
+## Unit Tests
+
+All new features should be 100% code covered, and your pull request should at the very least increase total code overage. 
+
+### Mocks
+To tests results from the API, we keep mock results in SoftLayer/fixtures/<SoftLayer_Service>/ with the method name matching the variable name.
+
+Any call to a service that doesn't have a fixture will result in a TransportError
+
+### Overriding Fixtures
+
+Adding your expected output in the fixtures file with a unique name is a good way to define a fixture that gets used frequently in a test.
+
+```python
+from SoftLayer.fixtures import SoftLayer_Product_Package
+
+    def test_test(self):
+        amock = self.set_mock('SoftLayer_Product_Package', 'getAllObjects')
+        amock.return_value = fixtures.SoftLayer_Product_Package.RESERVED_CAPACITY
+```
+
+Otherwise defining it on the spot works too.
+```python
+    def test_test(self):
+        mock = self.set_mock('SoftLayer_Network_Storage', 'getObject')
+        mock.return_value = {
+            'billingItem': {'hourlyFlag': True, 'id': 449},
+        }
+```
+
+
+### Call testing
+Testing your code to make sure it makes the correct API call is also very important.
+
+The testing.TestCase class has a method call `assert_called_with` which is pretty handy here.
+
+```python
+self.assert_called_with(
+    'SoftLayer_Billing_Item', # Service
+    'cancelItem',             # Method
+    args=(True, True, ''),    # Args
+    identifier=449,           # Id
+    mask=mock.ANY,            # object Mask,
+    filter=mock.ANY,          # object Filter
+    limit=0,                  # result Limit
+    offset=0                  # result Offset 
+)
+```
+
+Making sure a API was NOT called
+
+```python
+self.assertEqual([], self.calls('SoftLayer_Account', 'getObject'))
+```
+
+Making sure an API call has a specific arg, but you don't want to list out the entire API call (like with a place order test)
+
+```python
+# Get the API Call signature
+order_call = self.calls('SoftLayer_Product_Order', 'placeOrder')
+
+# Get the args property of that API call, which is a tuple, with the first entry being our data.
+order_args = getattr(order_call[0], 'args')[0]
+
+# Test our specific argument value
+self.assertEqual(123, order_args['hostId'])
+```