st2 API and CLI command added for actions/workflows clone operation

st2api/st2api/controllers/v1/actions.py

@@ -28,6 +28,7 @@
 from st2api.controllers import resource
 from st2api.controllers.v1.action_views import ActionViewsController
 from st2common import log as logging
+from st2common.bootstrap.actionsregistrar import register_actions
 from st2common.constants.triggers import ACTION_FILE_WRITTEN_TRIGGER
 from st2common.exceptions.action import InvalidActionParameterException
 from st2common.exceptions.apivalidation import ValueValidationException
@@ -39,10 +40,12 @@
 from st2common.router import abort
 from st2common.router import Response
 from st2common.validators.api.misc import validate_not_part_of_system_pack
+from st2common.validators.api.misc import validate_not_part_of_system_pack_by_name
 from st2common.content.utils import get_pack_base_path
 from st2common.content.utils import get_pack_resource_file_abs_path
 from st2common.content.utils import get_relative_path_to_pack_file
 from st2common.services.packs import delete_action_files_from_pack
+from st2common.services.packs import clone_action
 from st2common.transport.reactor import TriggerDispatcher
 from st2common.util.system_info import get_host_info
 import st2common.validators.api.action as action_validator
@@ -271,6 +274,88 @@ def delete(self, ref_or_id, requester_user):
         LOG.audit("Action deleted. Action.id=%s" % (action_db.id), extra=extra)
         return Response(status=http_client.NO_CONTENT)
 
+    def clone(
+        self,
+        source_pack,
+        source_action,
+        dest_pack,
+        dest_action,
+        requester_user,
+        overwrite=False,
+    ):
+        """
+        Clone an action.
+        Handles requests:
+            POST /actions/{sorce_pack}/{source_action}/{dest_pack}/{dest_action}
+        """
+
+        source_ref = "%s.%s" % (source_pack, source_action)
+        source_action_db = self._get_by_ref(resource_ref=source_ref)
+        msg = "The requested source for cloning operation doesn't exists"
+        if not source_action_db:
+            abort(http_client.BAD_REQUEST, six.text_type(msg))
+
+        permission_type = PermissionType.ACTION_CREATE
+        rbac_utils = get_rbac_backend().get_utils_class()
+        rbac_utils.assert_user_has_resource_db_permission(
+            user_db=requester_user,
+            resource_db=source_action_db,
+            permission_type=permission_type,
+        )
+
+        LOG.debug(
+            "POST /actions/ lookup with ref=%s found object: %s",
+            source_ref,
+            source_action_db,
+        )
+
+        source_pack = source_action_db["pack"]
+        source_entry_point = source_action_db["entry_point"]
+        source_metadata_file = source_action_db["metadata_file"]
+        source_pack_base_path = get_pack_base_path(pack_name=source_pack)
+        dest_pack_base_path = get_pack_base_path(pack_name=dest_pack)
+        if not os.path.isdir(dest_pack_base_path):
+            raise ValueError('Destination pack "%s" doesn\'t exist' % (dest_pack))
+
+        dest_ref = "%s.%s" % (dest_pack, dest_action)
+        dest_action_db = self._get_by_ref(resource_ref=dest_ref)
+
+        try:
+            validate_not_part_of_system_pack_by_name(dest_pack)
+        except ValueValidationException as e:
+            abort(http_client.BAD_REQUEST, six.text_type(e))
+
+        if dest_action_db:
+            if overwrite:
+                pass
+            else:
+                msg = "The requested destination action already exists"
+                abort(http_client.BAD_REQUEST, six.text_type(msg))
+        try:
+            clone_action(
+                source_pack_base_path=source_pack_base_path,
+                source_metadata_file=source_metadata_file,
+                source_entry_point=source_entry_point,
+                dest_pack_base_path=dest_pack_base_path,
+                dest_pack=dest_pack,
+                dest_action=dest_action,
+            )
+            register_actions(pack_dir=dest_pack_base_path)
+        except Exception as e:
+            LOG.error(
+                "Exception encountered during cloning resource." "Exception was %s",
+                e,
+            )
+            abort(http_client.INTERNAL_SERVER_ERROR, six.text_type(e))
+            return
+
+        dest_action_db = self._get_by_ref(resource_ref=dest_ref)
+        extra = {"cloned_acion_db": dest_action_db}
+        LOG.audit("Action cloned. Action.id=%s" % (dest_action_db.id), extra=extra)
+        cloned_action_api = ActionAPI.from_model(dest_action_db)
+
+        return Response(json=cloned_action_api, status=http_client.CREATED)
+
     def _handle_data_files(self, pack_ref, data_files):
         """
         Method for handling action data files.

st2client/st2client/commands/resource.py

@@ -102,6 +102,7 @@ def __init__(
             "delete": ResourceDeleteCommand,
             "enable": ResourceEnableCommand,
             "disable": ResourceDisableCommand,
+            "clone": ResourceCloneCommand,
         }
         for cmd, cmd_class in cmd_map.items():
             if cmd not in commands:
@@ -116,6 +117,7 @@ def __init__(
             self.commands["create"] = commands["create"](*args)
             self.commands["update"] = commands["update"](*args)
             self.commands["delete"] = commands["delete"](*args)
+            self.commands["clone"] = commands["clone"](*args)
 
         if has_disable:
             self.commands["enable"] = commands["enable"](*args)
@@ -758,6 +760,99 @@ class ContentPackResourceDeleteCommand(ResourceDeleteCommand):
     pk_argument_name = "ref_or_id"
 
 
+class ResourceCloneCommand(ResourceCommand):
+    pk_source_pack = "source_pack"
+    pk_source_action = "source_action"
+    pk_dest_pack = "destination_pack"
+    pk_dest_action = "destination_action"
+
+    def __init__(self, resource, *args, **kwargs):
+        super(ResourceCloneCommand, self).__init__(
+            resource,
+            "clone",
+            "Clone a new %s." % resource.get_display_name().lower(),
+            *args,
+            **kwargs,
+        )
+
+        pk_list = [
+            self.pk_source_pack,
+            self.pk_source_action,
+            self.pk_dest_pack,
+            self.pk_dest_action,
+        ]
+
+        for var in pk_list:
+            metavar = self._get_metavar_for_argument(argument=var)
+            helparg = self._get_help_for_argument(resource=resource, argument=var)
+            self.parser.add_argument(var, metavar=metavar, help=helparg)
+
+        self.parser.add_argument(
+            "-f",
+            "--force",
+            action="store_true",
+            dest="force",
+            help="Auto yes flag to overwrite action files on disk if destination exists.",
+        )
+
+    @add_auth_token_to_kwargs_from_cli
+    def run(self, args, **kwargs):
+        source_pack = getattr(args, self.pk_source_pack, None)
+        source_action = getattr(args, self.pk_source_action, None)
+        dest_pack = getattr(args, self.pk_dest_pack, None)
+        dest_action = getattr(args, self.pk_dest_action, None)
+        source_ref = "%s.%s" % (source_pack, source_action)
+        instance = self.get_resource(source_ref, **kwargs)
+        msg = 'Action with name "%s" has been successfully cloned in "%s" pack.' % (
+            dest_action,
+            dest_pack,
+        )
+
+        dest_ref = "%s.%s" % (dest_pack, dest_action)
+        try:
+            dest_instance = self.get_resource(dest_ref, **kwargs)
+        except ResourceNotFoundError:
+            dest_instance = None
+
+        if dest_instance:
+            user_input = ""
+            if not args.force:
+                user_input = input(
+                    "The destination action already exists. Do you want to overwrite? (y/n): "
+                )
+            if args.force or user_input.lower() == "y" or user_input.lower() == "yes":
+                self.manager.clone(
+                    instance,
+                    source_pack,
+                    source_action,
+                    dest_pack,
+                    dest_action,
+                    overwrite=True,
+                    **kwargs,
+                )
+                print(msg)
+            else:
+                print("Action is not cloned.")
+        else:
+            self.manager.clone(
+                instance,
+                source_pack,
+                source_action,
+                dest_pack,
+                dest_action,
+                overwrite=False,
+                **kwargs,
+            )
+            print(msg)
+
+    def run_and_print(self, args, **kwargs):
+        resource_id = getattr(args, self.pk_source_pack)
+        try:
+            self.run(args, **kwargs)
+        except ResourceNotFoundError:
+            self.print_not_found(resource_id)
+
+
 def load_meta_file(file_path):
     if not os.path.isfile(file_path):
         raise Exception('File "%s" does not exist.' % file_path)

st2client/st2client/models/core.py

@@ -376,6 +376,31 @@ def delete(self, instance, **kwargs):
 
         return True
 
+    @add_auth_token_to_kwargs_from_env
+    def clone(
+        self,
+        instance,
+        source_pack,
+        source_action,
+        dest_pack,
+        dest_action,
+        overwrite,
+        **kwargs,
+    ):
+        url = "/%s/%s/%s/%s/%s?overwrite=%s" % (
+            self.resource.get_url_path_name(),
+            source_pack,
+            source_action,
+            dest_pack,
+            dest_action,
+            overwrite,
+        )
+        response = self.client.post(url, instance.serialize(), **kwargs)
+        if response.status_code != http_client.OK:
+            self.handle_error(response)
+        instance = self.resource.deserialize(parse_api_response(response))
+        return instance
+
     @add_auth_token_to_kwargs_from_env
     def delete_by_id(self, instance_id, **kwargs):
         url = "/%s/%s" % (self.resource.get_url_path_name(), instance_id)

st2common/st2common/openapi.yaml

@@ -425,6 +425,55 @@ paths:
           description: Unexpected error
           schema:
             $ref: '#/definitions/Error'
+  /api/v1/actions/{source_pack}/{source_action}/{dest_pack}/{dest_action}:    
+    post:
+      operationId: st2api.controllers.v1.actions:actions_controller.clone
+      description: |
+        Clone one action.
+      parameters:
+        - name: source_pack
+          in: path
+          description: Source pack name
+          type: string
+          required: true
+        - name: source_action
+          in: path
+          description: Source action name
+          type: string
+          required: true
+        - name: dest_pack
+          in: path
+          description: Destination pack name
+          type: string
+          required: true
+        - name: dest_action
+          in: path
+          description: Destination action name
+          type: string
+          required: true
+        - name: overwrite
+          in: query
+          description: Force clone action if destination already exists
+          type: boolean
+          default: false
+      x-parameters:
+        - name: user
+          in: context
+          x-as: requester_user
+          description: User performing the operation.
+      responses:
+        '201':
+          description: Single action being cloned
+          schema:
+            $ref: '#/definitions/Action'
+          examples:
+            application/json:
+              ref: 'core.local'
+              # and stuff
+        default:
+          description: Unexpected error
+          schema:
+            $ref: '#/definitions/Error'  
   /api/v1/actions/views/parameters/{action_id}:
     get:
       operationId: st2api.controllers.v1.action_views:parameters_view_controller.get_one

st2common/st2common/openapi.yaml.j2

@@ -421,6 +421,55 @@ paths:
           description: Unexpected error
           schema:
             $ref: '#/definitions/Error'
+  /api/v1/actions/{source_pack}/{source_action}/{dest_pack}/{dest_action}:    
+    post:
+      operationId: st2api.controllers.v1.actions:actions_controller.clone
+      description: |
+        Clone one action.
+      parameters:
+        - name: source_pack
+          in: path
+          description: Source pack name
+          type: string
+          required: true
+        - name: source_action
+          in: path
+          description: Source action name
+          type: string
+          required: true
+        - name: dest_pack
+          in: path
+          description: Destination pack name
+          type: string
+          required: true
+        - name: dest_action
+          in: path
+          description: Destination action name
+          type: string
+          required: true
+        - name: overwrite
+          in: query
+          description: Force clone action if destination already exists
+          type: boolean
+          default: false
+      x-parameters:
+        - name: user
+          in: context
+          x-as: requester_user
+          description: User performing the operation.
+      responses:
+        '201':
+          description: Single action being cloned
+          schema:
+            $ref: '#/definitions/Action'
+          examples:
+            application/json:
+              ref: 'core.local'
+              # and stuff
+        default:
+          description: Unexpected error
+          schema:
+            $ref: '#/definitions/Error'  
   /api/v1/actions/views/parameters/{action_id}:
     get:
       operationId: st2api.controllers.v1.action_views:parameters_view_controller.get_one