Merge pull request #309 from oracle/release_2020-11-24

Releasing version 2.24.1

Author: pelliu

CHANGELOG.rst

@@ -3,6 +3,19 @@ Change Log
 All notable changes to this project will be documented in this file.
 
 The format is based on `Keep a Changelog <http://keepachangelog.com/>`_.
+====================
+2.24.1 - 2020-11-24
+====================
+
+Added
+-----
+* Provide example for pagination that creates a *Details object for pagination
+* Provide example to turn response and model to JSON
+
+Security
+-----
+* cryptography pinning to cryptography=3.2.1 to address vulnerability `Github security alerts <https://github.com/oracle/oci-python-sdk/pull/299>`__
+
 ====================
 2.24.0 - 2020-11-17
 ====================

examples/json_response_example.py

@@ -0,0 +1,17 @@
+# coding: utf-8
+# Copyright (c) 2016, 2020, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# This script provides an example to demostrate converting a response payload to a json string.
+# For more information see: https://docs.python.org/3/library/json.html
+import oci
+import json
+
+# Load the default configuration
+config = oci.config.from_file()
+identity_client = oci.identity.IdentityClient(config)
+response = identity_client.list_regions().data
+
+# Convert the response to a json string
+json_response = json.dumps(str(response))
+print("My json string response: ", json_response)

examples/object_storage/object_storage_bulk_copy.py

@@ -21,6 +21,7 @@
 #   -dt        - Use Instance Principals with delegation token for cloud shell
 #   -sb source_bucket
 #   -sr source_region
+#   -sn source_namespace
 #   -sp source_prefix_include
 #   -se source_prefix_exclude
 #   -db destination_bucket
@@ -52,10 +53,12 @@
 parser.add_argument('-c', type=argparse.FileType('r'), dest='config_file', help="Config File (default=~/.oci/config)")
 parser.add_argument('-sb', default="", dest='source_bucket', help='Source Bucket Name')
 parser.add_argument('-sr', default="", dest='source_region', help='Source Region (Default current connection)')
+parser.add_argument('-sn', default="", dest='source_namespace', help='Source Namespace (Default current connection)')
 parser.add_argument('-sp', default="", dest='source_prefix_include', help='Source Prefix Include')
 parser.add_argument('-se', default="", dest='source_prefix_exclude', help='Source Prefix Exclude')
 parser.add_argument('-db', default="", dest='destination_bucket', help='Destination Bucket Name')
 parser.add_argument('-dr', default="", dest='destination_region', help='Destination Region')
+parser.add_argument('-dn', default="", dest='destination_namespace', help='Destination Namespace (Default current connection)')
 parser.add_argument('-ig', action='store_true', default=False, dest='ignore_exist', help='Ignore Check if files exist at Destination')
 cmd = parser.parse_args()
 
@@ -88,11 +91,11 @@
 # Global Variables
 object_storage_client = None
 object_storage_client_dest = None
-destination_namespace = ""
-source_namespace = ""
 
 source_bucket = cmd.source_bucket
 source_region = cmd.source_region
+source_namespace = cmd.source_namespace
+destination_namespace = cmd.destination_namespace
 source_prefix = cmd.source_prefix_include
 source_prefix_exclude = cmd.source_prefix_exclude
 destination_bucket = cmd.destination_bucket
@@ -446,7 +449,8 @@ def connect_to_object_storage():
             object_storage_client.base_client.session.proxies = {'https': cmd.proxy}
 
         # retrieve namespace from object storage
-        source_namespace = object_storage_client.get_namespace().data
+        if not source_namespace:
+            source_namespace = object_storage_client.get_namespace().data
         print("Succeed.")
 
     except Exception as e:
@@ -463,7 +467,8 @@ def connect_to_object_storage():
             object_storage_client_dest.base_client.session.proxies = {'https': cmd.proxy}
 
         # retrieve namespace from object storage
-        destination_namespace = object_storage_client_dest.get_namespace().data
+        if not destination_namespace:
+            destination_namespace = object_storage_client_dest.get_namespace().data
         print("Succeed.")
 
     except Exception as e:

examples/object_storage/object_storage_bulk_delete.py

@@ -47,6 +47,8 @@
 parser.add_argument('-c', type=argparse.FileType('r'), dest='config_file', help="Config File (default=~/.oci/config)")
 parser.add_argument('-sb', default="", dest='source_bucket', help='Source Bucket Name')
 parser.add_argument('-sp', default="", dest='source_prefix', help='Source Prefix Include')
+parser.add_argument('-se', default="", dest='source_prefix_exclude', help='Source Prefix Exclude')
+parser.add_argument('-exclude_dirs', action='store_true', default=False, dest='source_exclude_dirs', help='Exclude Directories')
 parser.add_argument('-sr', default="", dest='source_region', help='Source Region')
 cmd = parser.parse_args()
 
@@ -78,7 +80,9 @@
 source_namespace = ""
 source_bucket = cmd.source_bucket
 source_prefix = cmd.source_prefix
+source_prefix_exclude = cmd.source_prefix_exclude
 source_region = cmd.source_region
+source_exclude_dirs = cmd.source_exclude_dirs
 
 # Update Variables based on the parameters
 config_file = (cmd.config_file if cmd.config_file else oci.config.DEFAULT_LOCATION)
@@ -187,7 +191,10 @@ def print_command_info():
     print("Source Namespace      : " + source_namespace)
     print("Source Bucket         : " + source_bucket)
     print("Source Prefix Include : " + source_prefix)
+    print("Source Prefix Exclude : " + source_prefix_exclude)
     print("Source Region         : " + source_region)
+    if source_exclude_dirs:
+        print("Source Exclude Dirs   : True")
 
 
 ##############################################################################
@@ -237,6 +244,11 @@ def add_objects_to_queue(ns, source_bucket):
         next_starts_with = response.data.next_start_with
 
         for object_ in response.data.objects:
+            if source_prefix_exclude and object_.name.startswith(source_prefix_exclude):
+                continue
+            if source_exclude_dirs and "/" in object_.name:
+                continue
+
             q.put(object_.name)
             count += 1
 

examples/object_storage/object_storage_list_objects.py

@@ -22,7 +22,8 @@
 #   -co        - count only
 #   -f         - write to file
 #   -sb source_bucket
-#   -sp source_prefix
+#   -sp source_prefix_include
+#   -se source_prefix_exclude
 #   -sr source_region
 ##########################################################################
 import oci
@@ -44,7 +45,9 @@
 parser.add_argument('-c', type=argparse.FileType('r'), dest='config_file', help="Config File (default=~/.oci/config)")
 parser.add_argument('-sb', default="", dest='source_bucket', help='Source Bucket Name')
 parser.add_argument('-sp', default="", dest='source_prefix', help='Source Prefix Include')
+parser.add_argument('-se', default="", dest='source_prefix_exclude', help='Source Prefix Exclude')
 parser.add_argument('-sr', default="", dest='source_region', help='Source Region')
+parser.add_argument('-exclude_dirs', action='store_true', default=False, dest='source_exclude_dirs', help='Exclude Directories')
 parser.add_argument('-f', type=argparse.FileType('w'), dest='file', help="Output to file (as csv)")
 parser.add_argument('-co', action='store_true', default=False, dest='count_only', help='Count only files and size')
 cmd = parser.parse_args()
@@ -160,11 +163,14 @@ def print_header(name):
 def print_command_info(source_namespace):
     print_header("Running List/Count Objects")
     print("Written By Adi Zohar, June 2020")
-    print("Starts at       :" + get_time(full=True))
-    print("Command Line    : " + ' '.join(x for x in sys.argv[1:]))
-    print("Source Namespace: " + source_namespace)
-    print("Source Bucket   : " + cmd.source_bucket)
-    print("Source Prefix   : " + cmd.source_prefix)
+    print("Starts at           :" + get_time(full=True))
+    print("Command Line        : " + ' '.join(x for x in sys.argv[1:]))
+    print("Source Namespace    : " + source_namespace)
+    print("Source Bucket       : " + cmd.source_bucket)
+    print("Source Prefix       : " + cmd.source_prefix)
+    print("Source Pre-Exclude  : " + cmd.source_prefix_exclude)
+    if cmd.source_exclude_dirs:
+        print("Source Exclude Dirs : True")
 
 
 ##############################################################################
@@ -175,6 +181,8 @@ def main():
     source_namespace = None
     source_bucket = cmd.source_bucket
     source_prefix = cmd.source_prefix
+    source_prefix_exclude = cmd.source_prefix_exclude
+    source_exclude_dirs = cmd.source_exclude_dirs
 
     # get signer
     config, signer = create_signer(cmd.config_file, cmd.config_profile, cmd.is_instance_principals, cmd.is_delegation_token)
@@ -222,6 +230,11 @@ def main():
         next_starts_with = response.data.next_start_with
 
         for object_file in response.data.objects:
+            if source_prefix_exclude and object_file.name.startswith(source_prefix_exclude):
+                continue
+            if source_exclude_dirs and "/" in object_file.name:
+                continue
+
             count += 1
             size += object_file.size
 

examples/pagination_with_request_model.py

@@ -0,0 +1,19 @@
+# coding: utf-8
+# Copyright (c) 2016, 2020, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# This script gives an example on passing in a request model for an API to the pagination call.
+
+import oci
+
+config = oci.config.from_file()
+compartment_id = config["tenancy"]
+monitoring = oci.monitoring.MonitoringClient(config)
+
+paginated_response = oci.pagination.list_call_get_all_results(
+    monitoring.list_metrics,
+    compartment_id,
+    oci.monitoring.models.ListMetricsDetails()  # Request model passed in as specified from monitoring.ListMetricsDetail API
+).data
+
+print("paginated response: ", paginated_response)

examples/showoci/CHANGELOG.rst

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 The format is based on `Keep a Changelog <http://keepachangelog.com/>`_.
 
+=====================
+20.11.24 - 20.11.24
+=====================
+* Added multiple VCN CIDR blocks
+
 =====================
 20.11.17 - 20.11.17
 =====================

examples/showoci/showoci.py

@@ -91,7 +91,7 @@
 import argparse
 import datetime
 
-version = "20.11.17"
+version = "20.11.24"
 
 ##########################################################################
 # check OCI version

examples/showoci/showoci_data.py

@@ -839,6 +839,9 @@ def __get_core_network_vcn(self, region_name, compartment):
                                  'name': vcn['name'],
                                  'display_name': vcn['display_name'],
                                  'cidr_block': vcn['cidr_block'],
+                                 'cidr_blocks': vcn['cidr_blocks'],
+                                 'ipv6_cidr_block': vcn['ipv6_cidr_block'],
+                                 'ipv6_public_cidr_block': vcn['ipv6_public_cidr_block'],
                                  'compartment_name': str(compartment['name']),
                                  'compartment_id': str(compartment['id']),
                                  'data': val})

examples/showoci/showoci_service.py

@@ -133,7 +133,7 @@ def is_load_basic_network(self):
 # class ShowOCIService
 ##########################################################################
 class ShowOCIService(object):
-    oci_compatible_version = "2.23.4"
+    oci_compatible_version = "2.23.5"
 
     ##########################################################################
     # Global Constants
@@ -1851,13 +1851,18 @@ def __load_core_network_vcn(self, virtual_network, compartments):
                 # loop on the array
                 # vcn = oci.core.models.Vcn()
                 for vcn in vcns:
-                    val = {'id': str(vcn.id), 'name': str(vcn.cidr_block) + " - " + str(vcn.display_name) + " - " + str(vcn.vcn_domain_name),
+                    val = {'id': str(vcn.id), 'name': str(', '.join(x for x in vcn.cidr_blocks)) + " - " + str(vcn.display_name) + " - " + str(vcn.vcn_domain_name),
                            'display_name': str(vcn.display_name),
                            'cidr_block': str(vcn.cidr_block),
-                           'time_created': str(vcn.time_created), 'compartment_name': str(compartment['name']),
+                           'cidr_blocks': vcn.cidr_blocks,
+                           'ipv6_cidr_block': str(vcn.ipv6_cidr_block),
+                           'ipv6_public_cidr_block': str(vcn.ipv6_public_cidr_block),
+                           'time_created': str(vcn.time_created),
+                           'compartment_name': str(compartment['name']),
                            'defined_tags': [] if vcn.defined_tags is None else vcn.defined_tags,
                            'freeform_tags': [] if vcn.freeform_tags is None else vcn.freeform_tags,
-                           'compartment_id': str(compartment['id']), 'region_name': str(self.config['region'])}
+                           'compartment_id': str(compartment['id']),
+                           'region_name': str(self.config['region'])}
                     data.append(val)
                     cnt += 1
 
@@ -2751,7 +2756,7 @@ def __load_core_network_subnet(self, virtual_network, compartments, vcns):
                     for vcn in vcns:
                         if str(subnet.vcn_id) == vcn['id']:
                             val['vcn_name'] = vcn['display_name']
-                            val['vcn_cidr'] = vcn['cidr_block']
+                            val['vcn_cidr'] = str(', '.join(x for x in vcn['cidr_blocks']))
 
                     data.append(val)
                     cnt += 1
@@ -4663,7 +4668,10 @@ def __load_load_balancers(self, load_balancer, compartments):
                             raise
 
                     # add the rest
-                    val = {'id': str(arr.id), 'shape_name': str(arr.shape_name), 'display_name': str(arr.display_name), 'is_private': str(arr.is_private),
+                    val = {'id': str(arr.id),
+                           'shape_name': str(arr.shape_name),
+                           'display_name': str(arr.display_name),
+                           'is_private': str(arr.is_private),
                            'status': str(status),
                            'ip_addresses': [(str(ip.ip_address) + " - " + ("Public" if ip.is_public else "Private")) for ip in arr.ip_addresses],
                            'compartment_name': str(compartment['name']),
@@ -4672,7 +4680,8 @@ def __load_load_balancers(self, load_balancer, compartments):
                            'nsg_names': "",
                            'defined_tags': [] if arr.defined_tags is None else arr.defined_tags,
                            'freeform_tags': [] if arr.freeform_tags is None else arr.freeform_tags,
-                           'region_name': str(self.config['region']), 'subnet_ids': []}
+                           'region_name': str(self.config['region']),
+                           'subnet_ids': []}
 
                     # subnets
                     if arr.subnet_ids: