Content deletion - initial merge to master

cli/src/katello/client/api/changeset.py

@@ -36,11 +36,12 @@ def changeset_by_name(self, orgName, envId, csName):
         else:
             return None
 
-    def create(self, orgName, envId, name, description=None):
+    def create(self, orgName, envId, name, type, description=None):
         data = {
             "changeset": {
                 "name": name,
-                "description": description
+                "description": description,
+                "type": type
             }
         }
         path = "/api/organizations/%s/environments/%s/changesets/" % (orgName, envId)
@@ -63,8 +64,8 @@ def dependencies(self, csId):
         deps = self.server.GET(path)[1]
         return deps
 
-    def promote(self, csId):
-        path = "/api/changesets/%s/promote" % (csId)
+    def apply(self, csId):
+        path = "/api/changesets/%s/apply" % (csId)
         return self.server.POST(path)[1]
 
     def update_content(self, csId, patch):

cli/src/katello/client/core/changeset.py

@@ -56,6 +56,7 @@ def run(self):
 
         self.printer.add_column('id')
         self.printer.add_column('name')
+        self.printer.add_column('type')
         self.printer.add_column('updated_at', formatter=format_date)
         self.printer.add_column('state')
         self.printer.add_column('environment_id')
@@ -109,6 +110,7 @@ def run(self):
 
         self.printer.add_column('id')
         self.printer.add_column('name')
+        self.printer.add_column('action_type')
         self.printer.add_column('description', multiline=True, show_with=printer.VerboseStrategy)
         self.printer.add_column('updated_at', formatter=format_date)
         self.printer.add_column('state')
@@ -142,6 +144,12 @@ def setup_parser(self, parser):
                                help=_("changeset name (required)"))
         parser.add_option('--description', dest='description',
                                help=_("changeset description"))
+        parser.add_option('--promotion', dest='type_promotion', action="store_true", default=False,
+                               help=_("changeset type promotion: pushes changes to the next environment [DEFAULT]"))
+        parser.add_option('--deletion', dest='type_deletion', action="store_true", default=False,
+                               help=_("changeset type deletion: deletes items in changeset from current environment"))
+
+
 
     def check_options(self, validator):
         validator.require(('org', 'name', 'env'))
@@ -151,9 +159,18 @@ def run(self):
         envName = self.get_option('env')
         csName = self.get_option('name')
         csDescription = self.get_option('description')
+        csType = 'PROMOTION'
+
+        # Check for duplicate type flags
+        if self.get_option('type_promotion') and self.get_option('type_deletion'):
+            raise OptionValueError(_("specify either --promotion or --deletion but not both"))
+        if self.get_option('type_promotion'):
+            csType = 'PROMOTION'
+        elif self.get_option('type_deletion'):
+            csType = 'DELETION'
 
         env = get_environment(orgName, envName)
-        cset = self.api.create(orgName, env["id"], csName, csDescription)
+        cset = self.api.create(orgName, env["id"], csName, csType, csDescription)
         test_record(cset,
             _("Successfully created changeset [ %s ] for environment [ %s ]") % (csName, env["name"]),
             _("Could not create changeset [ %s ] for environment [ %s ]") % (csName, env["name"])
@@ -177,11 +194,15 @@ def build_patch(action, itemBuilder, items):
             return patch
 
     class PatchItemBuilder(object):
-        def __init__(self, org_name, env_name):
+        def __init__(self, org_name, env_name, type):
             self.org_name = org_name
             self.env_name = env_name
-            self.prior_env_name = get_environment(org_name, env_name)['prior']
-
+            self.type = type
+            # Use current env if we are doing a deletion otherwise use the prior
+            if self.type == 'deletion':
+                self.env_name = get_environment(org_name, env_name)['name']
+            else:
+                self.env_name = get_environment(org_name, env_name)['prior']
 
         def product_id(self, options):
             if 'product' in options:
@@ -193,11 +214,11 @@ def product_id(self, options):
             return prod['id']
 
         def repo_id(self, options):
-            repo = get_repo(self.org_name, options['product'], options['name'], self.prior_env_name)
+            repo = get_repo(self.org_name, options['product'], options['name'], self.env_name)
             return repo['id']
 
         def template_id(self, options):
-            tpl = get_template(self.org_name, self.prior_env_name, options['name'])
+            tpl = get_template(self.org_name, self.env_name, options['name'])
             return tpl['id']
 
 
@@ -353,10 +374,11 @@ def run(self):
         csDescription = self.get_option('description')
 
         cset = get_changeset(orgName, envName, csName)
+        csType = cset['action_type']
 
         self.update(cset["id"], csNewName, csDescription)
-        addPatch = self.PatchBuilder.build_patch('add', self.AddPatchItemBuilder(orgName, envName), items)
-        removePatch = self.PatchBuilder.build_patch('remove', self.RemovePatchItemBuilder(orgName, envName), items)
+        addPatch = self.PatchBuilder.build_patch('add', self.AddPatchItemBuilder(orgName, envName, csType), items)
+        removePatch = self.PatchBuilder.build_patch('remove', self.RemovePatchItemBuilder(orgName, envName, csType), items)
         self.update_content(cset["id"], addPatch, self.api.add_content)
         self.update_content(cset["id"], removePatch, self.api.remove_content)
 
@@ -402,8 +424,8 @@ def run(self):
 
 
 # ==============================================================================
-class Promote(ChangesetAction):
-    description = _('promotes a changeset to the next environment')
+class Apply(ChangesetAction):
+    description = _('applies a changeset based on the type (promotion, deletion)')
 
     def setup_parser(self, parser):
         parser.add_option('--name', dest='name',
@@ -423,18 +445,36 @@ def run(self):
 
         cset = get_changeset(orgName, envName, csName)
 
-        task = self.api.promote(cset["id"])
+        task = self.api.apply(cset["id"])
         task = AsyncTask(task)
 
-        run_spinner_in_bg(wait_for_async_task, [task], message=_("Promoting the changeset, please wait... "))
+        run_spinner_in_bg(wait_for_async_task, [task], message=_("Applying the changeset, please wait... "))
 
         if task.succeeded():
-            print _("Changeset [ %s ] promoted" % csName)
+            print _("Changeset [ %s ] applied" % csName)
             return os.EX_OK
         else:
             print _("Changeset [ %s ] promotion failed: %s" % (csName, format_task_errors(task.errors())))
             return os.EX_DATAERR
 
+# ==============================================================================
+class Promote(Apply):
+    description = _('promotes a changeset to the next environment - DEPRECATED')
+
+    def run(self):
+        csName = self.get_option('name')
+        orgName = self.get_option('org')
+        envName = self.get_option('env')
+
+        # Block attempts to call this on deletion changesets, otherwise continue
+        cset = get_changeset(orgName, envName, csName)
+        if cset['type'] == 'DELETION':
+            print _("This is a deletion changeset and does not support promotion")
+            return os.EX_DATAERR
+
+        super(Promote, self).run()
+
+
 
 # changeset command ============================================================
 class Changeset(Command):

cli/src/katello/client/main.py

@@ -242,6 +242,7 @@ def setup_admin(katello_cmd):
     cset_cmd.add_command('info', changeset.Info())
     cset_cmd.add_command('update', changeset.UpdateContent())
     cset_cmd.add_command('delete', changeset.Delete())
+    cset_cmd.add_command('apply', changeset.Apply())
     cset_cmd.add_command('promote', changeset.Promote())
     katello_cmd.add_command('changeset', cset_cmd)
 

cli/test/katello/tests/core/changeset/changeset_create_test.py

@@ -0,0 +1,55 @@
+import unittest
+from mock import Mock
+import os
+
+from katello.tests.core.action_test_utils import CLIOptionTestCase, CLIActionTestCase
+from katello.tests.core.organization.organization_data import ORGS, ENVS
+
+import katello.client.core.changeset
+from katello.client.core.changeset import Create
+
+class RequiredCLIOptionsTests(CLIOptionTestCase):
+
+    action = Create()
+
+    disallowed_options = [
+        ('--name=changeset1', ),
+        ('--org=ACME', )
+    ]
+
+    allowed_options = [
+        ('--org=ACME', '--name=changeset1', '--env=DEV', '--promotion', '--deletion')
+    ]
+
+
+class ChangesetAddTest(CLIActionTestCase):
+    ORG = 'org'
+    NAME = 'changeset1'
+    DESCRIPTION = 'description'
+    TYPE = 'promotion'
+
+    OPTIONS = {
+        'org':ORG,
+        'name':NAME,
+        'description':DESCRIPTION,
+        'type':TYPE
+    }
+
+    def setUp(self):
+        self.set_action(Create())
+        self.set_module(katello.client.core.changeset)
+        self.mock_printer()
+        self.mock_options(self.OPTIONS)
+
+        self.mock(self.action.api, 'create', [])
+        self.mock(self.module, 'get_environment', ENVS[0])
+
+    def tearDown(self):
+        self.restore_mocks()
+
+
+    def test_it_uses_filter_create_api(self):
+        self.run_action()
+        self.action.api.create.assert_called_once_with(self.ORG, ENVS[0]['id'], self.NAME, self.DESCRIPTION, self.TYPE)
+
+

src/app/controllers/api/changesets_controller.rb

@@ -12,7 +12,7 @@
 
 class Api::ChangesetsController < Api::ApiController
 
-  before_filter :find_changeset, :only => [:show, :update, :destroy, :promote, :dependencies]
+  before_filter :find_changeset, :only => [:show, :update, :destroy, :promote, :apply, :dependencies]
   before_filter :find_environment
   before_filter :authorize
 
@@ -26,6 +26,7 @@ def rules
       :create       => manage_perm,
       :update       => manage_perm,
       :promote      => promote_perm,
+      :apply        => promote_perm,
       :destroy      => manage_perm,
     }
   end
@@ -35,8 +36,9 @@ def rules
   api :GET, "/organizations/:organization_id/environments/:environment_id/changesets", "List changesets in an environment"
   param :name, String, :desc => "An optional changeset name to filter upon"
   def index
-    render :json => Changeset.select("changesets.*, environments.name AS environment_name").
+    changesets = Changeset.select("changesets.*, environments.name AS environment_name").
         joins(:environment).where(params.slice(:name, :environment_id))
+    render :json => changesets.to_json
   end
 
   api :GET, "/changesets/:id", "Show a changeset"
@@ -68,18 +70,34 @@ def dependencies
     param :name, String, :desc => "The name of the changeset"
   end
   def create
-    @changeset             = Changeset.new(params[:changeset])
+    csType = params[:changeset][:type]
+    if params[:changeset][:type] == 'PROMOTION'
+      @changeset = PromotionChangeset.new(params[:changeset])
+    elsif params[:changeset][:type] == 'DELETION'
+      @changeset = DeletionChangeset.new(params[:changeset])
+    else
+      raise HttpErrors::ApiError, _("Unknown changeset type, must be PROMOTION or DELETION: #{csType}")
+    end
+
     @changeset.environment = @environment
     @changeset.save!
 
     render :json => @changeset
   end
 
-  api :POST, "/changesets/:id/promote", "Promote a changeset into a new envrionment"
+  # DEPRICATED - TODO: Note this in the new API doc format
+  api :POST, "/changesets/:id/promote", "Promote a changeset into a new envrionment."
   def promote
     @changeset.state = Changeset::REVIEW
     @changeset.save!
-    async_job = @changeset.promote :async => true
+    async_job = @changeset.apply :async => true
+    render :json => async_job, :status => 202
+  end
+
+  def apply
+    @changeset.state = Changeset::REVIEW
+    @changeset.save!
+    async_job = @changeset.apply :async => true
     render :json => async_job, :status => 202
   end