Releasing version 3.29.3

Releasing version 3.29.3

Author: mandyht

CHANGELOG.rst

@@ -6,6 +6,63 @@ All notable changes to this project will be documented in this file.
 
 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__.
 
+3.29.3 - 2023-07-11
+--------------------
+Added
+~~~~~
+
+* Support for optional parameters in the Application Performance Monitoring Synthetic service
+
+  * ``oci apm-synthetics monitor create-browser-monitor --is-default-snapshot-enabled --verify-response-codes``
+  * ``oci apm-synthetics monitor create-rest-monitor --client-certificate-details``
+  * ``oci apm-synthetics monitor create-scripted-browser-monitor --is-default-snapshot-enabled``
+  * ``oci apm-synthetics monitor create-scripted-rest-monitor --req-authentication-scheme --verify-response-codes``
+  * ``oci apm-synthetics monitor update-browser-monitor --is-default-snapshot-enabled --verify-response-codes``
+  * ``oci apm-synthetics monitor update-rest-monitor ---client-certificate-details``
+  * ``oci apm-synthetics monitor update-scripted-browser-monitor ---is-default-snapshot-enabled``
+  * ``oci apm-synthetics monitor update-scripted-rest-monitor --req-authentication-scheme --verify-response-codes``
+
+* Support for new commands in the OSP Gateway service
+
+  * ``oci osp-gateway address-rule-service address-rule get``
+  * ``oci osp-gateway address-service address``
+
+* AI Document Service
+
+  * Support for new commands
+
+    * ``oci ai-document analyze-document-result``
+    * ``oci ai-document model patch``
+
+  * Support for new optional parameters
+
+    * ``oci ai-document model create --alias-name --component-models``
+
+* Support for workload mapping processing in the Container Engine service
+
+  * ``oci ce workload-mapping``
+  * ``oci ce workload-mapping-summary``
+
+* Support for new commands in the Data Integration service
+
+  * ``oci data-integration composite-state get``
+  * ``oci data-integration export-request``
+  * ``oci data-integration export-request-summary-collection list-export-requests``
+  * ``oci data-integration import-request``
+  * ``oci data-integration import-request-summary-collection list-import-requests``
+  * ``oci data-integration data-entity create-entity-shape-create-entity-shape-from-object``
+  * ``oci data-integration workspace delete-export-request``
+  * ``oci data-integration workspace delete-import-request``
+  * ``oci data-integration workspace update-export-request``
+  * ``oci data-integration workspace update-import-request``
+
+* Support for new optional parameter --kms-key-id in updating and creating backup and volume backup's envelope key in Core services
+
+  * ``oci bv backup create --kms-key-id``
+  * ``oci bv backup update --kms-key-id``
+  * ``oci bv boot-volume-backup create --kms-key-id``
+  * ``oci bv boot-volume-backup update --kms-key-id``
+
 3.29.2 - 2023-06-27
 --------------------
 Added

README.rst

@@ -26,6 +26,10 @@ Try the interactive features anytime with the ``-i`` option:
 
     oci -i
 
+.. image:: images/animation.png
+  :width: 1000
+  :alt: Alternative text
+
 Read more on `OCI Documentation`__.
 
 __ https://docs.oracle.com/iaas/Content/API/SDKDocs/cliusing_topic-Using_Interactive_Mode.htm

requirements.txt

@@ -8,13 +8,13 @@ certifi
 cffi>=1.9.1
 click==8.0.4
 coverage==4.5.2
-cryptography>=3.2.1,<40.0.0
+cryptography>=3.2.1,<42.0.0
 httpsig-cffi==15.0.0
 Jinja2==3.0.3
 jmespath==0.10.0
 ndg-httpsclient==0.4.2
 mock==2.0.0
-oci==2.105.0
+oci==2.106.0
 packaging==20.2
 pluggy==0.13.0
 py==1.10.0
@@ -27,7 +27,8 @@ pytest==7.1.2; python_version >= '3.10'
 pytest-cov==2.5.1
 python-dateutil>=2.5.3,<3.0.0
 pytz>=2016.10
-requests==2.21.0
+requests==2.21.0; python_version == '3.6'
+requests==2.31.0; python_version > '3.6'
 six>=1.15.0
 sphinx==3.3.0
 sphinx-rtd-theme==0.4.3
@@ -42,4 +43,6 @@ PyYAML>=5.4,<=6
 docutils==0.15.2
 prompt-toolkit==3.0.29
 setuptools>65.5.1; python_version > '3.6'
-setuptools==59.6.0; python_version == '3.6'
+setuptools==59.6.0; python_version == '3.6'
+# this is required because of python 3.6 requests dependency version bound
+urllib3<=1.26.15

scripts/examples/project_o/README.md

@@ -1,4 +1,6 @@
 # o - a smart oci-cli wrapper
+<!-- Project o - helper smart wrapper oci cli user experience -->
+
 **`o`** helps you use the Oracle Cloud Infrastructure's `oci` command line interface.  With **`o`** you can
  - quickly find a command and get usage info
  - simply run commands using *resource names*, not OCIDs
@@ -7,7 +9,7 @@
 **`o`** uses shortcuts for *everything*.  All commands, parameters, and resource names have intuitive, *automatic* shortcuts.
 You can run most commands with no scripting. Say goodbye to saving OCIDs to variables.
 
-**``O``** instantly transforms this:
+**``o``** instantly transforms this:
 ```
 $ o list subn -c sales -v west -a
 ```
@@ -41,10 +43,12 @@ To install, get **``o``** from github, place it in your PATH (perhaps in the sam
 o_src=https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/examples/project_o/o
 where=$(which oci) && to=${where%ci} && curl -so $to $o_src && chmod +x $to
 ```
-**`O`** version 1.6 runs in **Windows** PowerShell or Command shell, but installation not automated.  Get **`o`**
+#### Windows
+**`o`** version 1.6 and later runs in Windows PowerShell or Command shell, but installation not automated.  To try it, use this curl command to get **`o`**.  Then copy it to somewhere in your PATH.
 ```
 curl -o o.py https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/examples/project_o/o
 ```
+Update your PATHEXT to make it execute as `o` instead of `o.py`.
 
 #### Setup
 
@@ -86,8 +90,8 @@ This will get a fresh list of all compartments in the tenancy, which is a great
    - identical names can be resolved by using a substring from the OCID
      - for example, ``-c ujfa`` would specify the *sales* compartment. The last four to six characters will uniquely identify most resources.
      - handy when your resource names contain spaces or special characters
- - support [complex type] parameters where a list of OCIDs is expected
-   - comma-separated resource names are converted to a JSON list
+ - support ``--*-ids`` parameters where a list of OCIDs is expected, e.g. ``--security-list-ids``
+   - comma-separated list of resource names is converted to a JSON list of OCIDs
  - simplify [datetime] parameters
    - ``--start-time today`` beginning (midnight) of current day (UTC)
    - ``--start-time today-36h`` - the day before yesterday at Noon
@@ -160,6 +164,13 @@ This will get a fresh list of all compartments in the tenancy, which is a great
  - Added “reg" column to identify region key in default table output
    - This is not shown nor available in csv or text formats.
    - Region isn't in the resource data for most data types. **o** is extracting it from the ocid
+ - **o** runs on *Windows* PowerShell and Command shell. Not fully tested, but the basics appear to work.
+
+#### New in version 1.9 (2023-07-05)
+- "Best match" command selection adjusted to accept shorter input for commands in common, core services.  This was needed because oci-cli supports more services and more commands than before, making it more difficult to find unambiguous shortcuts.
+- More shortcuts for `o structured-search --query-text` where clauses:
+   - Use `c` or `l` for "compartment" or "lifeCycleState", followed by `=` or `!=` and the name of a compartment or lifeCycleState.  Don't worry about quotation marks around terms. E.g.
+      - `query all resources where (c = sales || c = kevco) && l != terminated`
 
 ## How **``o``** works  
  - **``o``** compares your input with thousands of ``oci`` commands, and uses an fuzzy matching to find the command you want.

scripts/examples/project_o/o

@@ -21,8 +21,8 @@ if (sys.platform != "win32"):
     import fcntl
 import errno
 import datetime
-VERSION = "1.8"
-UPDATED = "2023-06-12"
+VERSION = "1.9"
+UPDATED = "2023-07-05"
 
 # ==============================================================================
 # Global variables
@@ -283,6 +283,7 @@ and I'll do this for you:
   o iam compartment list -c <tenancy-ocid> -ciis true -all .
   o iam ad list -c <tenancy-ocid> .
   o iam region-subscription list .
+  o iam compartment get -c <tenancy-id> .
         """)
 
         # To be extra helpful, get likely tenancy ocid from oci config file
@@ -302,15 +303,18 @@ and I'll do this for you:
             print("Tenancy name:", sys.argv[2])
         print(bold('Setting up your ' + ocids_file_name + ' file:'))
         print(bold('\nGetting compartment names and ocids...'), end='')
-        if run_command(sys.argv[0] + ' -o name iam compartment list -c ' + sys.argv[1] + ' -ciis true -all .'):
+        ocmd = sys.argv[0]
+        if ' ' in sys.argv[0]:
+            ocmd = '"' + sys.argv[0] + '"'
+        if run_command(ocmd + ' -o name iam compartment list -c ' + sys.argv[1] + ' -ciis true -all .'):
             print('\nThat didn\'t work.  Your account may need additional privileges.')
             exit(0)
         print(bold('\nGetting availability domains...'), end='')
-        run_command(sys.argv[0] + ' -o name iam ad list -c ' + sys.argv[1] + ' .')
+        run_command(ocmd + ' -o name iam ad list -c ' + sys.argv[1] + ' .')
         print(bold('\nGetting regions...'), end='')
-        run_command(sys.argv[0] + ' -o name iam region-subscription list .')
+        run_command(ocmd + ' -o name iam region-subscription list .')
         print(bold('\nGetting tenancy name from root compartment...'), end='')
-        if run_command(sys.argv[0] + ' -o name iam compartment get -c ' + sys.argv[1] + ' .'):
+        if run_command(ocmd + ' -o name iam compartment get -c ' + sys.argv[1] + ' .'):
             # compartment get on tenancy failed; try saving a stub for tenancy
             print("\nCould not get root compartment.")
             tenancy_name = input(bold("Enter tenancy name: "))
@@ -440,12 +444,16 @@ def get_new_ocids_from_returned_items(items):
     """
 
     # special case for region list - save the whole list in one entry
-    if 'oci iam region list' in oci_command_line:
+    if 'oci iam region' in oci_command_line and ' list' in oci_command_line:
+        if 'region-key' in items[0]:
+            region_list = [{'key': i['region-key'], 'name': i['region-name']} for i in items]
+        else:
+            region_list = items
         return {'regionlist': {
                 'type': 'regionlist',
                 'alias': 'regionlist',
                 'id': 'regionlist',
-                'data': items}}
+                'data': region_list}}
 
     if oci_command_line.startswith('oci search'):
         for i in items:
@@ -557,7 +565,7 @@ def show_command(c, full=False, prefix='oci '):
         print('    optional\t' + re.sub(r' -', r'\n\t\t-', c['optional']))
         if show_help:
             print('    global\t' + re.sub(r'\n', r'\n                ',
-                  textwrap.fill(global_options, width=60, break_on_hyphens=False)))
+                  textwrap.fill(global_options, width=60, break_on_hyphens=False)) + '\n')
 
 # ==============================================================================
 
@@ -597,7 +605,7 @@ def args_match_command(c, params):
         # look for word starting with arg
         if ' ' + a in action or '-' + a in action:
             # Scratch out this match
-            action = re.sub(' ' + r'(\S+-)*' + a + r'(\S+)', ' ', action, count=1)
+            action = re.sub(' ' + r'(\S)*?' + a + r'(\S)*?' + ' ', ' ', action, count=1)
             continue
 
         # look for rlc -> really-long-command
@@ -899,6 +907,8 @@ def get_matching_ocid(option, value):
             opt_type = 'organizationsentity'
         elif opt_type == 'routedistribution':
             opt_type = 'drgroutedistribution'
+        elif opt_type == 'session':
+            opt_type = 'bastionsession'
         # Add new idtypes to the above when the --whatever-id does not match ocid1.whatevs...
 
     matches = [item for k, item in ocid.items() if
@@ -973,7 +983,7 @@ def value_parameter(option, value):
             if not v:
                 continue
             o = get_matching_ocid(option, v)
-            idlist.append(v)
+            idlist.append(o)
         return repr(json.dumps(idlist))
 
     # Assist with datetime parameters
@@ -995,16 +1005,23 @@ def value_parameter(option, value):
 
     # Special help with structured-search --search-query "where compartmentId = ocid"
     if option == '--query-text':
-        match = re.findall(r"(\bc\w*) *= *('*\w+'*)", value, flags=re.IGNORECASE)
+        match = re.findall(r"(\b[cl]\w*) *!*= *('*\"*[-_/\w]+'*\"*)", value, flags=re.IGNORECASE)
         for (m, spec) in match:
             if m.lower() == 'compartmentid'[:len(m)]:
                 if m.lower() != 'compartmentid':
-                    value = re.sub(r'\b' + m + r'\b', 'compartmentId', value)
-            if spec.startswith("'"):
-                spec = spec[1:-1]
-            o = get_matching_ocid('compartment', spec)
-            if o != spec:
-                value = re.sub(spec, "'" + o + "'", value)
+                    value = re.sub(r'\b' + m + r'\b', 'compartmentId', value, count=1)
+                if spec.startswith("'") or spec.startswith('"'):
+                    spec = spec[1:-1]
+                o = get_matching_ocid('compartment', spec)
+                if o == spec:
+                    value = re.sub(spec, "'" + spec + "'", value, count=1)
+                else:
+                    value = re.sub(spec, "'" + o + "'", value, count=1)
+            elif m.lower() == 'lifecyclestate'[:len(m)]:
+                if m.lower() != 'lifecyclestate':
+                    value = re.sub(r'\b' + m + r'\b', 'lifecycleState', value, count=1)
+                if not (spec.startswith("'") or spec.startswith('"')):
+                    value = re.sub(spec, "'" + spec + "'", value)
 
     return value
 
@@ -1141,14 +1158,14 @@ def set_column_widths(fields, out_sep, item_list):
 # ==============================================================================
 
 
-def show_column_headers(out_fields, sep):
+def show_column_headers(out_fields, sep, reg=False):
     if quiet > 1:
         return
     if sep == '|':
         for k in out_fields:
             # print(bold(column[k]['format'].format(k)), end=' ', file=sys.stderr)
             try:
-                if k == 'id' and user_out_spec == default_out_spec:
+                if reg and k == 'id' and user_out_spec == default_out_spec:
                     print(bold(' reg'), end=' ', file=sys.stderr)
                 print(bold(column[k]['format'].format(k.split(".")[-1])),
                       end=' ', file=sys.stderr)
@@ -1206,7 +1223,7 @@ def get_field_from_item(field, item):
 # ==============================================================================
 
 
-def show_item(item, fields, sep):
+def show_item(item, fields, sep, reg=False):
     """Report result in user specified -o format."""
 
     out = []
@@ -1225,8 +1242,8 @@ def show_item(item, fields, sep):
             else:
                 out.append(value)
         else:
-            if field == 'id' and sep == '|' and user_out_spec == default_out_spec and 'ocid' in value:
-                out.append(' ' + value.split('.')[3])
+            if reg and field == 'id' and sep == '|' and user_out_spec == default_out_spec and 'ocid' in value:
+                out.append(' ' + (value.split('.')[3]))
             out.append(column[field]['format'].format(re.sub(r'[{}\'[\]\n]', '', value)[
                        column[field]['offset']:]))
 
@@ -1341,6 +1358,11 @@ def output(jsonOut):
     # Below we format and display the data.
     # ==========================================================================
 
+    reg_in_ocid = False
+    try:
+        reg_in_ocid = len(results[0]['id'].split('.')[3]) > 0
+    except (KeyError, IndexError):
+        pass
     if not user_out_spec:
         print(json.dumps(jsonOut, indent=4))
         return results
@@ -1358,9 +1380,9 @@ def output(jsonOut):
         set_column_widths(out_fields, out_sep, results)
         if debug > 1: print("COLUMN:", column)             # noqa: E701
         # Then output header and requested fields from item_list
-        show_column_headers(out_fields, out_sep)
+        show_column_headers(out_fields, out_sep, reg=reg_in_ocid)
         for item in results:
-            show_item(item, out_fields, out_sep)
+            show_item(item, out_fields, out_sep, reg=reg_in_ocid)
 
     # Any extra non-'data' key-values?  Send to stdout
     if type(jsonOut) is dict and jsonOut.keys() != ['data']:
@@ -1977,14 +1999,12 @@ ncw = command_words[0] if command_words else len(CLI_params)
 options_in_args = len(command_words) > 0
 
 # Prioritize core services above others.
-priority_services = ('compute ', 'bv ', 'os ', 'network ', 'iam ', 'db ')
+priority_services = ('compute ', 'bv ', 'os ', 'network ', 'iam ', 'db ', 'resource-manager')
 
 # Find matching commands.  Sort by priority, then by command length.
 matches = sorted([c for c in command if args_match_command(c, CLI_params[:ncw])],
-                 key=lambda c: (len(c['action']) if len(c['action']) < 25 else int(round(len(c['action']) / 10.) * 10.))
-                 if c['action'].startswith(priority_services)
-                 else (1.5 * len(c['action']) if len(c['action']) < 25 else 1.5 * int(round(len(c['action']) / 10.) * 10.)),
-                 reverse=True)
+                 key=lambda c: (not c['action'].startswith(priority_services),
+                 len(c['action'])), reverse=True)
 
 # ==============================================================================
 # Take action - either show help or 'go' run the command