astakos: Split quota commands

Introduce quota-list and quota-verify.

docs/admin-guide.rst

@@ -915,7 +915,8 @@ component-show                Show component details
 project-control               Manage projects and applications
 project-list                  List projects
 project-show                  Show project details
-quota                         List and check the integrity of user quota
+quota-list                    List user quota
+quota-verify                  Check the integrity of user quota
 reconcile-resources-astakos   Reconcile resource usage of Quotaholder with Astakos DB
 resource-list                 List resources
 resource-modify               Modify a resource's default base quota and boolean flags

snf-astakos-app/astakos/im/management/commands/_common.py

@@ -68,6 +68,28 @@ def get_user(email_or_id, **kwargs):
         return None
 
 
+def get_accepted_user(user_ident):
+    if is_uuid(user_ident):
+        try:
+            user = AstakosUser.objects.get(uuid=user_ident)
+        except AstakosUser.DoesNotExist:
+            raise CommandError('There is no user with uuid: %s' %
+                               user_ident)
+    elif is_email(user_ident):
+        try:
+            user = AstakosUser.objects.get(username=user_ident)
+        except AstakosUser.DoesNotExist:
+            raise CommandError('There is no user with email: %s' %
+                               user_ident)
+    else:
+        raise CommandError('Please specify user by uuid or email')
+
+    if not user.is_accepted():
+        raise CommandError('%s is not an accepted user.' % user.uuid)
+
+    return user
+
+
 def get_astakosuser_content_type():
     try:
         return ContentType.objects.get(app_label='im',

snf-astakos-app/astakos/im/management/commands/quota-list.py

+# Copyright 2012, 2013 GRNET S.A. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or
+# without modification, are permitted provided that the following
+# conditions are met:
+#
+#   1. Redistributions of source code must retain the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer.
+#
+#   2. Redistributions in binary form must reproduce the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer in the documentation and/or other materials
+#      provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
+# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# The views and conclusions contained in the software and
+# documentation are those of the authors and should not be
+# interpreted as representing official policies, either expressed
+# or implied, of GRNET S.A.
+
+from optparse import make_option
+from django.db import transaction
+
+from astakos.im.models import AstakosUser
+from astakos.im.quotas import list_user_quotas
+from snf_django.management.commands import SynnefoCommand
+from snf_django.management import utils
+from astakos.im.management.commands import _common as common
+
+import logging
+logger = logging.getLogger(__name__)
+
+
+class Command(SynnefoCommand):
+    help = "List user quota"
+
+    option_list = SynnefoCommand.option_list + (
+        make_option('--unit-style',
+                    default='mb',
+                    help=("Specify display unit for resource values "
+                          "(one of %s); defaults to mb") %
+                    common.style_options),
+        make_option('--user',
+                    metavar='<uuid or email>',
+                    dest='user',
+                    help="List quota for a specified user"),
+    )
+
+    @transaction.commit_on_success
+    def handle(self, *args, **options):
+        output_format = options["output_format"]
+        user_ident = options['user']
+        unit_style = options["unit_style"]
+        common.check_style(unit_style)
+
+        if user_ident is not None:
+            users = [common.get_accepted_user(user_ident)]
+        else:
+            users = AstakosUser.objects.accepted()
+
+        qh_quotas, astakos_i = list_user_quotas(users)
+
+        info = {}
+        for user in users:
+            info[user.uuid] = user.email
+
+        print_data, labels = common.show_quotas(
+            qh_quotas, astakos_i, info, style=unit_style)
+        utils.pprint_table(self.stdout, print_data, labels, output_format)

snf-astakos-app/astakos/im/management/commands/quota.py → snf-astakos-app/astakos/im/management/commands/quota-verify.py

@@ -32,40 +32,23 @@
 # or implied, of GRNET S.A.
 
 from optparse import make_option
-from django.core.management.base import CommandError
 from django.db import transaction
 
 from astakos.im.models import AstakosUser
 from astakos.im.quotas import (
-    qh_sync_users_diffs, list_user_quotas, add_base_quota)
+    qh_sync_users_diffs,)
 from astakos.im.functions import get_user_by_uuid
-from astakos.im.management.commands._common import is_uuid, is_email
 from snf_django.management.commands import SynnefoCommand
-from snf_django.management import utils
-from ._common import show_quotas, style_options, check_style, units
+from astakos.im.management.commands import _common as common
 
 import logging
 logger = logging.getLogger(__name__)
 
 
 class Command(SynnefoCommand):
-    help = "List and check the integrity of user quota"
+    help = "Check the integrity of user quota"
 
     option_list = SynnefoCommand.option_list + (
-        make_option('--list',
-                    action='store_true',
-                    dest='list',
-                    default=False,
-                    help="List all quota (default)"),
-        make_option('--unit-style',
-                    default='mb',
-                    help=("Specify display unit for resource values "
-                          "(one of %s); defaults to mb") % style_options),
-        make_option('--verify',
-                    action='store_true',
-                    dest='verify',
-                    default=False,
-                    help="Check if quotaholder is in sync with astakos"),
         make_option('--sync',
                     action='store_true',
                     dest='sync',
@@ -74,86 +57,24 @@ class Command(SynnefoCommand):
         make_option('--user',
                     metavar='<uuid or email>',
                     dest='user',
-                    help="List quota for a specified user"),
-        make_option('--import-base-quota',
-                    dest='import_base_quota',
-                    metavar='<exported-quota.txt>',
-                    help=("Import base quota from file. "
-                          "The file must contain non-empty lines, and each "
-                          "line must contain a single-space-separated list "
-                          "of values: <user> <resource name> <capacity>. "
-                          "Capacity can be followed by a unit with no "
-                          "separating space (e.g 10GB).")
-                    ),
+                    help="Check for a specified user"),
     )
 
     @transaction.commit_on_success
     def handle(self, *args, **options):
         sync = options['sync']
-        verify = options['verify']
         user_ident = options['user']
-        list_ = options['list']
-        import_base_quota = options['import_base_quota']
-
-        if import_base_quota:
-            if any([sync, verify, list_]):
-                m = "--from-file cannot be combined with other options."
-                raise CommandError(m)
-            self.import_from_file(import_base_quota)
-        else:
-            unit_style = options["unit_style"]
-            check_style(unit_style)
-
-            self.quotas(sync, verify, user_ident, options["output_format"],
-                        unit_style)
-
-    def quotas(self, sync, verify, user_ident, output_format, style):
-        list_only = not sync and not verify
 
         if user_ident is not None:
-            users = [self.get_user(user_ident)]
+            users = [common.get_accepted_user(user_ident)]
         else:
             users = AstakosUser.objects.accepted()
 
-        if list_only:
-            qh_quotas, astakos_i = list_user_quotas(users)
-
-            info = {}
-            for user in users:
-                info[user.uuid] = user.email
-
-            print_data, labels = show_quotas(qh_quotas, astakos_i, info,
-                                             style=style)
-            utils.pprint_table(self.stdout, print_data, labels,
-                               output_format)
-
-        elif verify or sync:
-            qh_limits, diff_q = qh_sync_users_diffs(users, sync=sync)
-            if verify:
-                self.print_verify(qh_limits, diff_q)
-            if sync:
-                self.print_sync(diff_q)
-
-    def get_user(self, user_ident):
-        if is_uuid(user_ident):
-            try:
-                user = AstakosUser.objects.get(uuid=user_ident)
-            except AstakosUser.DoesNotExist:
-                raise CommandError('There is no user with uuid: %s' %
-                                   user_ident)
-        elif is_email(user_ident):
-            try:
-                user = AstakosUser.objects.get(username=user_ident)
-            except AstakosUser.DoesNotExist:
-                raise CommandError('There is no user with email: %s' %
-                                   user_ident)
+        qh_limits, diff_q = qh_sync_users_diffs(users, sync=sync)
+        if sync:
+            self.print_sync(diff_q)
         else:
-            raise CommandError('Please specify user by uuid or email')
-
-        if not user.is_accepted():
-            raise CommandError('%s is not an accepted user.' % user.uuid)
-
-        return user
+            self.print_verify(qh_limits, diff_q)
 
     def print_sync(self, diff_quotas):
         size = len(diff_quotas)
@@ -166,57 +87,22 @@ class Command(SynnefoCommand):
             for user in users:
                 self.stdout.write("%s (%s)\n" % (user.uuid, user.username))
 
-    def print_verify(self,
-                     qh_limits,
-                     diff_quotas):
-
-            for holder, local in diff_quotas.iteritems():
-                registered = qh_limits.pop(holder, None)
-                user = get_user_by_uuid(holder)
-                if registered is None:
-                    self.stdout.write(
-                        "No quota for %s (%s) in quotaholder.\n" %
-                        (holder, user.username))
-                else:
-                    self.stdout.write("Quota differ for %s (%s):\n" %
-                                      (holder, user.username))
-                    self.stdout.write("Quota according to quotaholder:\n")
-                    self.stdout.write("%s\n" % (registered))
-                    self.stdout.write("Quota according to astakos:\n")
-                    self.stdout.write("%s\n\n" % (local))
-
-            diffs = len(diff_quotas)
-            if diffs:
-                self.stdout.write("Quota differ for %d users.\n" % (diffs))
-
-    def import_from_file(self, location):
-        users = set()
-        with open(location) as f:
-            for line in f.readlines():
-                try:
-                    t = line.rstrip('\n').split(' ')
-                    user = t[0]
-                    resource = t[1]
-                    capacity = t[2]
-                    try:
-                        capacity = units.parse(capacity)
-                    except units.ParseError:
-                        m = ("Capacity should be an integer, optionally "
-                             "followed by a unit.")
-                        raise CommandError(m)
-                except(IndexError, TypeError):
-                    self.stdout.write('Invalid line format: %s:\n' % t)
-                    continue
-                else:
-                    try:
-                        user = self.get_user(user)
-                        users.add(user.id)
-                    except CommandError:
-                        self.stdout.write('Not found user: %s\n' % user)
-                        continue
-                    else:
-                        try:
-                            add_base_quota(user, resource, capacity)
-                        except Exception, e:
-                            self.stdout.write('Failed to add quota: %s\n' % e)
-                            continue
+    def print_verify(self, qh_limits, diff_quotas):
+        for holder, local in diff_quotas.iteritems():
+            registered = qh_limits.pop(holder, None)
+            user = get_user_by_uuid(holder)
+            if registered is None:
+                self.stdout.write(
+                    "No quota for %s (%s) in quotaholder.\n" %
+                    (holder, user.username))
+            else:
+                self.stdout.write("Quota differ for %s (%s):\n" %
+                                  (holder, user.username))
+                self.stdout.write("Quota according to quotaholder:\n")
+                self.stdout.write("%s\n" % (registered))
+                self.stdout.write("Quota according to astakos:\n")
+                self.stdout.write("%s\n\n" % (local))
+
+        diffs = len(diff_quotas)
+        if diffs:
+            self.stdout.write("Quota differ for %d users.\n" % (diffs))