Releasing version 3.27.1

Co-authored-by: Hamada Ibrahim <[email protected]>
Co-authored-by: Harsh Kumar <[email protected]>
Co-authored-by: Kanvi Pasricha <[email protected]>
Co-authored-by: Alex Le <[email protected]>
Co-authored-by: Nupur Gupta <[email protected]>
Co-authored-by: Karthik Kamath <[email protected]>
Co-authored-by: Mandy Tsai <[email protected]>
Co-authored-by: Pankaj Joshi <[email protected]>
Co-authored-by: Anup Singh <[email protected]>

Author: 9 people

CHANGELOG.rst

@@ -6,6 +6,16 @@ All notable changes to this project will be documented in this file.
 
 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__.
 
+3.27.1 - 2023-05-16
+--------------------
+Added
+~~~~~
+* Support for Self Service Integration in the Fusion Application service
+ 
+  * ``oci fusion-apps service-attachment create``
+  * ``oci fusion-apps service-attachment delete``
+  * ``oci fusion-apps service-attachment verify``
+
 3.27.0 - 2023-05-09
 --------------------
 Added

requirements.txt

@@ -14,7 +14,7 @@ Jinja2==3.0.3
 jmespath==0.10.0
 ndg-httpsclient==0.4.2
 mock==2.0.0
-oci==2.101.0
+oci==2.102.0
 packaging==20.2
 pluggy==0.13.0
 py==1.10.0

services/fusion_apps/src/oci_cli_fusion_applications/generated/fusionapplications_cli.py

@@ -564,6 +564,62 @@ def create_refresh_activity(ctx, from_json, wait_for_state, max_wait_seconds, wa
     cli_util.render_response(result, ctx)
 
 
+@service_attachment_group.command(name=cli_util.override('fusion_apps.create_service_attachment.command_name', 'create'), help=u"""Attaches a service instance to the fusion pod. \n[Command Reference](createServiceAttachment)""")
+@cli_util.option('--service-instance-type', required=True, help=u"""Type of the ServiceInstance being attached.""")
+@cli_util.option('--service-instance-id', required=True, help=u"""The service instance OCID of the instance being attached""")
+@cli_util.option('--fusion-environment-id', required=True, help=u"""unique FusionEnvironment identifier""")
+@cli_util.option('--wait-for-state', type=custom_types.CliCaseInsensitiveChoice(["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"]), multiple=True, help="""This operation asynchronously creates, modifies or deletes a resource and uses a work request to track the progress of the operation. Specify this option to perform the action and then wait until the work request reaches a certain state. Multiple states can be specified, returning on the first state. For example, --wait-for-state SUCCEEDED --wait-for-state FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.""")
+@cli_util.option('--max-wait-seconds', type=click.INT, help="""The maximum time to wait for the work request to reach the state defined by --wait-for-state. Defaults to 1200 seconds.""")
+@cli_util.option('--wait-interval-seconds', type=click.INT, help="""Check every --wait-interval-seconds to see whether the work request has reached the state defined by --wait-for-state. Defaults to 30 seconds.""")
+@json_skeleton_utils.get_cli_json_input_option({})
+@cli_util.help_option
+@click.pass_context
+@json_skeleton_utils.json_skeleton_generation_handler(input_params_to_complex_types={})
+@cli_util.wrap_exceptions
+def create_service_attachment(ctx, from_json, wait_for_state, max_wait_seconds, wait_interval_seconds, service_instance_type, service_instance_id, fusion_environment_id):
+
+    if isinstance(fusion_environment_id, six.string_types) and len(fusion_environment_id.strip()) == 0:
+        raise click.UsageError('Parameter --fusion-environment-id cannot be whitespace or empty string')
+
+    kwargs = {}
+    kwargs['opc_request_id'] = cli_util.use_or_generate_request_id(ctx.obj['request_id'])
+
+    _details = {}
+    _details['serviceInstanceType'] = service_instance_type
+    _details['serviceInstanceId'] = service_instance_id
+
+    client = cli_util.build_client('fusion_apps', 'fusion_applications', ctx)
+    result = client.create_service_attachment(
+        fusion_environment_id=fusion_environment_id,
+        create_service_attachment_details=_details,
+        **kwargs
+    )
+    if wait_for_state:
+
+        if hasattr(client, 'get_work_request') and callable(getattr(client, 'get_work_request')):
+            try:
+                wait_period_kwargs = {}
+                if max_wait_seconds is not None:
+                    wait_period_kwargs['max_wait_seconds'] = max_wait_seconds
+                if wait_interval_seconds is not None:
+                    wait_period_kwargs['max_interval_seconds'] = wait_interval_seconds
+
+                click.echo('Action completed. Waiting until the work request has entered state: {}'.format(wait_for_state), file=sys.stderr)
+                result = oci.wait_until(client, client.get_work_request(result.headers['opc-work-request-id']), 'status', wait_for_state, **wait_period_kwargs)
+            except oci.exceptions.MaximumWaitTimeExceeded as e:
+                # If we fail, we should show an error, but we should still provide the information to the customer
+                click.echo('Failed to wait until the work request entered the specified state. Outputting last known resource state', file=sys.stderr)
+                cli_util.render_response(result, ctx)
+                sys.exit(2)
+            except Exception:
+                click.echo('Encountered error while waiting for work request to enter the specified state. Outputting last known resource state', file=sys.stderr)
+                cli_util.render_response(result, ctx)
+                raise
+        else:
+            click.echo('Unable to wait for the work request to enter the specified state', file=sys.stderr)
+    cli_util.render_response(result, ctx)
+
+
 @fusion_environment_group.command(name=cli_util.override('fusion_apps.delete_fusion_environment.command_name', 'delete'), help=u"""Deletes the Fusion environment identified by it's OCID. \n[Command Reference](deleteFusionEnvironment)""")
 @cli_util.option('--fusion-environment-id', required=True, help=u"""unique FusionEnvironment identifier""")
 @cli_util.option('--if-match', help=u"""For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.""")
@@ -782,6 +838,63 @@ def delete_refresh_activity(ctx, from_json, wait_for_state, max_wait_seconds, wa
     cli_util.render_response(result, ctx)
 
 
+@service_attachment_group.command(name=cli_util.override('fusion_apps.delete_service_attachment.command_name', 'delete'), help=u"""Delete a service attachment by identifier \n[Command Reference](deleteServiceAttachment)""")
+@cli_util.option('--fusion-environment-id', required=True, help=u"""unique FusionEnvironment identifier""")
+@cli_util.option('--service-attachment-id', required=True, help=u"""OCID of the Service Attachment""")
+@cli_util.option('--if-match', help=u"""For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.""")
+@cli_util.confirm_delete_option
+@cli_util.option('--wait-for-state', type=custom_types.CliCaseInsensitiveChoice(["ACCEPTED", "IN_PROGRESS", "FAILED", "SUCCEEDED", "CANCELING", "CANCELED"]), multiple=True, help="""This operation asynchronously creates, modifies or deletes a resource and uses a work request to track the progress of the operation. Specify this option to perform the action and then wait until the work request reaches a certain state. Multiple states can be specified, returning on the first state. For example, --wait-for-state SUCCEEDED --wait-for-state FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.""")
+@cli_util.option('--max-wait-seconds', type=click.INT, help="""The maximum time to wait for the work request to reach the state defined by --wait-for-state. Defaults to 1200 seconds.""")
+@cli_util.option('--wait-interval-seconds', type=click.INT, help="""Check every --wait-interval-seconds to see whether the work request has reached the state defined by --wait-for-state. Defaults to 30 seconds.""")
+@json_skeleton_utils.get_cli_json_input_option({})
+@cli_util.help_option
+@click.pass_context
+@json_skeleton_utils.json_skeleton_generation_handler(input_params_to_complex_types={})
+@cli_util.wrap_exceptions
+def delete_service_attachment(ctx, from_json, wait_for_state, max_wait_seconds, wait_interval_seconds, fusion_environment_id, service_attachment_id, if_match):
+
+    if isinstance(fusion_environment_id, six.string_types) and len(fusion_environment_id.strip()) == 0:
+        raise click.UsageError('Parameter --fusion-environment-id cannot be whitespace or empty string')
+
+    if isinstance(service_attachment_id, six.string_types) and len(service_attachment_id.strip()) == 0:
+        raise click.UsageError('Parameter --service-attachment-id cannot be whitespace or empty string')
+
+    kwargs = {}
+    if if_match is not None:
+        kwargs['if_match'] = if_match
+    kwargs['opc_request_id'] = cli_util.use_or_generate_request_id(ctx.obj['request_id'])
+    client = cli_util.build_client('fusion_apps', 'fusion_applications', ctx)
+    result = client.delete_service_attachment(
+        fusion_environment_id=fusion_environment_id,
+        service_attachment_id=service_attachment_id,
+        **kwargs
+    )
+    if wait_for_state:
+
+        if hasattr(client, 'get_work_request') and callable(getattr(client, 'get_work_request')):
+            try:
+                wait_period_kwargs = {}
+                if max_wait_seconds is not None:
+                    wait_period_kwargs['max_wait_seconds'] = max_wait_seconds
+                if wait_interval_seconds is not None:
+                    wait_period_kwargs['max_interval_seconds'] = wait_interval_seconds
+
+                click.echo('Action completed. Waiting until the work request has entered state: {}'.format(wait_for_state), file=sys.stderr)
+                result = oci.wait_until(client, client.get_work_request(result.headers['opc-work-request-id']), 'status', wait_for_state, **wait_period_kwargs)
+            except oci.exceptions.MaximumWaitTimeExceeded as e:
+                # If we fail, we should show an error, but we should still provide the information to the customer
+                click.echo('Failed to wait until the work request entered the specified state. Please retrieve the work request to find its current state', file=sys.stderr)
+                cli_util.render_response(result, ctx)
+                sys.exit(2)
+            except Exception:
+                click.echo('Encountered error while waiting for work request to enter the specified state. Outputting last known resource state', file=sys.stderr)
+                cli_util.render_response(result, ctx)
+                raise
+        else:
+            click.echo('Unable to wait for the work request to enter the specified state', file=sys.stderr)
+    cli_util.render_response(result, ctx)
+
+
 @data_masking_activity_group.command(name=cli_util.override('fusion_apps.get_data_masking_activity.command_name', 'get'), help=u"""Gets a DataMaskingActivity by identifier \n[Command Reference](getDataMaskingActivity)""")
 @cli_util.option('--fusion-environment-id', required=True, help=u"""unique FusionEnvironment identifier""")
 @cli_util.option('--data-masking-activity-id', required=True, help=u"""Unique DataMasking run identifier.""")
@@ -1963,3 +2076,33 @@ def update_refresh_activity(ctx, from_json, wait_for_state, max_wait_seconds, wa
         else:
             click.echo('Unable to wait for the resource to enter the specified state', file=sys.stderr)
     cli_util.render_response(result, ctx)
+
+
+@service_attachment_group.command(name=cli_util.override('fusion_apps.verify_service_attachment.command_name', 'verify'), help=u"""Verify whether a service instance can be attached to the fusion pod \n[Command Reference](verifyServiceAttachment)""")
+@cli_util.option('--service-instance-type', required=True, help=u"""Type of the ServiceInstance being attached.""")
+@cli_util.option('--service-instance-id', required=True, help=u"""The service instance OCID of the instance being attached""")
+@cli_util.option('--fusion-environment-id', required=True, help=u"""unique FusionEnvironment identifier""")
+@json_skeleton_utils.get_cli_json_input_option({})
+@cli_util.help_option
+@click.pass_context
+@json_skeleton_utils.json_skeleton_generation_handler(input_params_to_complex_types={})
+@cli_util.wrap_exceptions
+def verify_service_attachment(ctx, from_json, service_instance_type, service_instance_id, fusion_environment_id):
+
+    if isinstance(fusion_environment_id, six.string_types) and len(fusion_environment_id.strip()) == 0:
+        raise click.UsageError('Parameter --fusion-environment-id cannot be whitespace or empty string')
+
+    kwargs = {}
+    kwargs['opc_request_id'] = cli_util.use_or_generate_request_id(ctx.obj['request_id'])
+
+    _details = {}
+    _details['serviceInstanceType'] = service_instance_type
+    _details['serviceInstanceId'] = service_instance_id
+
+    client = cli_util.build_client('fusion_apps', 'fusion_applications', ctx)
+    result = client.verify_service_attachment(
+        fusion_environment_id=fusion_environment_id,
+        verify_service_attachment_details=_details,
+        **kwargs
+    )
+    cli_util.render_response(result, ctx)

setup.py

@@ -29,7 +29,7 @@ def open_relative(*path):
     readme = f.read()
 
 requires = [
-    'oci==2.101.0',
+    'oci==2.102.0',
     'arrow>=1.0.0',
     'certifi',
     'click==8.0.4',
@@ -40,7 +40,7 @@ def open_relative(*path):
     'six>=1.15.0',
     'terminaltables==3.1.0',
     'pyOpenSSL>=17.5.0,<24.0.0',
-    'PyYAML>=5.4,<6',
+    'PyYAML>=5.4,<=6',
     'prompt-toolkit==3.0.29'
 ]
 

src/oci_cli/cli_constants.py

@@ -75,3 +75,6 @@
 SERVICE_ERROR_DOCUMENTATION = 'https://docs.oracle.com/iaas/Content/API/References/apierrors.htm'
 
 GITHUB_CHANGELOG = 'https://github.com/oracle/oci-cli/blob/master/CHANGELOG.rst'
+
+INTERACTIVE_CLI_SUGGESTION_MESSAGE = 'For OCI CLI commands and parameters suggestion, auto completion and ' \
+                                     'other useful features, try the Interactive mode by typing `oci -i`.'

src/oci_cli/cli_root.py

@@ -420,6 +420,7 @@ def find_latest_release_version(ctx, param, value):
 @click.pass_context
 def cli(ctx, config_file, profile, cli_rc_file, request_id, region, endpoint, realm_specific_endpoint, cert_bundle, output, query, raw_output, auth, auth_purpose, no_retry, max_retries, generate_full_command_json_input, generate_param_json_input, debug, cli_auto_prompt, connection_timeout, read_timeout, help):
 
+    click.exceptions.UsageError.show = cli_util.update_click_help_message
     if max_retries and no_retry:
         raise click.UsageError('The option --max-retries is not applicable when using the --no-retry flag.')
 

src/oci_cli/cli_util.py

@@ -2605,6 +2605,13 @@ def get_request_endpoint_from_exception_string(exception_string: str):
         return None
 
 
+def update_click_help_message(self):
+    if self.ctx is not None:
+        print(self.ctx.get_usage() + '\n')
+    print('Error: %s\n' % self.format_message())
+    print(cli_constants.INTERACTIVE_CLI_SUGGESTION_MESSAGE)
+
+
 class CommandExample:
 
     def __init__(self, description, usage, output):

src/oci_cli/version.py

@@ -2,4 +2,4 @@
 # Copyright (c) 2016, 2021, 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.
 
-__version__ = '3.27.0'
+__version__ = '3.27.1'