Merge lp:~diegosarmentero/ubuntuone-control-panel/quota-warning into lp:ubuntuone-control-panel

[Diego Sarmentero]

- Control Panel shows quota in red with more accuracy depending on the free space (LP: #901314).

Change the actual implementation to not be based in percentage, but instead in some fix sizes.

For Free accounts:
- Show warning when the available quota is 500mb or less

For Pay accounts:
- Show warning when the available quota is 3gb or less

[Roberto Alsina (ralsina)]

I like this better.

review: Approve

[lp:~diegosarmentero/ubuntuone-control-panel/quota-warning]

256. By Manuel de la Peña on 2012-02-01

Forward extra params to u1trial.

[Natalia Bidart (nataliabidart)]

Branch looks great.

Can you please do the whole quota-highlight calculation using bytes, to ease the understanding of the code?

Thanks!

review: Needs Fixing

[Diego Sarmentero (diegosarmentero)]

> Branch looks great.
>
> Can you please do the whole quota-highlight calculation using bytes, to ease
> the understanding of the code?
>
> Thanks!

Done!

[lp:~diegosarmentero/ubuntuone-control-panel/quota-warning]

257. By Natalia Bidart on 2012-02-07

- Avoid TypeError when fetching credentials in the Gtk OverviewPanel
   (LP: #927743).
- Run the whole test suite with a single command (LP: #927770).
- Do proper cleanup when dealing with UIs (LP: #925617).

258. By Natalia Bidart on 2012-02-08

 - Replaced custom webclient with the one from ubuntu-sso-client
   (LP: #926311).
- Removed the dependency on qt4reactor for Linux implementation.

259. By Natalia Bidart on 2012-02-10

- Install the uniqueapp module (LP: #930269).

260. By Diego Sarmentero on 2012-02-17

Conflict resolved

[Natalia Bidart (nataliabidart)]

The following method does not indent the multiline guard properly. I would advice something like:

def show_quota_warning(int_bytes_used, int_bytes_total):
    """Return True if the user should be warn about the remaining quota."""
    available = (int_bytes_total - int_bytes_used)
    free_threshold = (int_bytes_total == FREE_ACCOUNT_SIZE and
                      available <= QUOTA_THRESHOLD_ACCOUNTS['free'])
    payed_threshold = (int_bytes_total > FREE_ACCOUNT_SIZE and
                       available <= QUOTA_THRESHOLD_ACCOUNTS['pay'])
    return free_threshold or payed_threshold

For the constants about quota, I would change these:

1 +FREE_ACCOUNT_SIZE = 5368709120
27 +QUOTA_THRESHOLD_ACCOUNTS = {'free': 536870912, 'pay': 3221225472}

to be:

        FREE_ACCOUNT_SIZE = (BYTES**3) * 5 # 5 gigs
        QUOTA_THRESHOLD_ACCOUNTS = {'free': FREE_ACCOUNT_SIZE * 0.1, # 10% of the free account size
                                    'pay': (BYTES**3) * 3} # 3 gigs

The rest looks good!

review: Needs Fixing

[lp:~diegosarmentero/ubuntuone-control-panel/quota-warning]

261. By Diego Sarmentero on 2012-02-17

reverting red constant to unicode

262. By Diego Sarmentero on 2012-02-17

Improving quota sizes readability

263. By Diego Sarmentero on 2012-02-17

Changes in the way the boolean value is calculated in show_quota_warning.

264. By Diego Sarmentero on 2012-02-17

Removing duplicated quota_threshold

[Natalia Bidart (nataliabidart)]

Looks great!

review: Approve

=== modified file 'ubuntuone/controlpanel/gui/__init__.py'
--- ubuntuone/controlpanel/gui/__init__.py	2012-02-17 12:01:56 +0000
+++ ubuntuone/controlpanel/gui/__init__.py	2012-02-17 14:55:36 +0000
@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Authors: Natalia B Bidart <[e-mail]>
-# Authors: Alejandro J. Cura <[e-mail]>
-#
-# Copyright 2011 Canonical Ltd.
+# Copyright 2011-2012 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
@@ -29,10 +26,14 @@
 
 ERROR_COLOR = u'red'
 KILOBYTES = 1024
+FREE_ACCOUNT_SIZE = (KILOBYTES ** 3) * 5  # 5 gigs
 NO_OP = lambda *a, **kw: None
 # http://design.canonical.com/the-toolkit/ubuntu-logo-and-circle-of-friends/
 ORANGE = u'#DD4814'
 QUOTA_THRESHOLD = 0.95
+QUOTA_THRESHOLD_ACCOUNTS = {
+    'free': FREE_ACCOUNT_SIZE * 0.1,  # 10% of the free account size
+    'pay': (KILOBYTES ** 3) * 3}  # 3 gigs
 SHARES_MIN_SIZE_FULL = 1048576
 SUCCESS_COLOR = u'green'
 
@@ -185,3 +186,14 @@
     str_bytes = str_bytes.rstrip('0')
     str_bytes = str_bytes.rstrip('.')
     return '%s %s' % (str_bytes, units[unit])
+
+
+def show_quota_warning(int_bytes_used, int_bytes_total):
+    """Return True if the user should be warn about the remaining quota."""
+    available = (int_bytes_total - int_bytes_used)
+    free_threshold = (int_bytes_total == FREE_ACCOUNT_SIZE and
+                      available <= QUOTA_THRESHOLD_ACCOUNTS['free'])
+    payed_threshold = (int_bytes_total > FREE_ACCOUNT_SIZE and
+                       available <= QUOTA_THRESHOLD_ACCOUNTS['pay'])
+
+    return free_threshold or payed_threshold

=== modified file 'ubuntuone/controlpanel/gui/qt/controlpanel.py'
--- ubuntuone/controlpanel/gui/qt/controlpanel.py	2011-09-23 15:05:27 +0000
+++ ubuntuone/controlpanel/gui/qt/controlpanel.py	2012-02-17 14:55:36 +0000
@@ -1,9 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Authors: Alejandro J. Cura <[e-mail]>
-# Authors: Natalia B Bidart <[e-mail]>
-#
-# Copyright 2011 Canonical Ltd.
+# Copyright 2012 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
@@ -28,12 +25,12 @@
 from ubuntuone.controlpanel.logger import setup_logging, log_call
 from ubuntuone.controlpanel.gui import (
     humanize,
+    show_quota_warning,
     EDIT_SERVICES_LINK,
     FACEBOOK_LINK,
     GET_SUPPORT_LINK,
     GREETING,
     PERCENTAGE_LABEL,
-    QUOTA_THRESHOLD,
     TWITTER_LINK,
     USAGE_LABEL,
 )
@@ -105,27 +102,19 @@
         total = int(info['quota_total'])
         percentage_value = ((used / total) * 100)
         percentage = {'percentage': PERCENTAGE_STYLE % percentage_value}
+        show_warning = show_quota_warning(used, total)
         data = {'used': humanize(used), 'total': humanize(total)}
         self.ui.percentage_usage_label.setText(PERCENTAGE_LABEL % percentage)
         self.ui.quota_usage_label.setText(USAGE_LABEL % data)
-        self._update_quota({'percentage': percentage_value})
+        self._update_quota(show_warning)
 
     @log_call(logger.debug)
-    def _update_quota(self, data=None):
+    def _update_quota(self, show_warning=False):
         """Update the quota info."""
-        fraction = 0.0
-        if data is not None:
-            fraction = data.get('percentage', 0.0) / 100
-            if fraction > 0 and fraction < 0.05:
-                fraction = 0.05
-            else:
-                fraction = round(fraction, 2)
-
-        logger.debug('ManagementPanel: updating quota to %r.', fraction)
-        self.ui.percentage_usage_label.setProperty("OverQuota",
-            fraction >= QUOTA_THRESHOLD)
-        self.ui.quota_usage_label.setProperty("OverQuota",
-            fraction >= QUOTA_THRESHOLD)
+        logger.debug('ManagementPanel: show warning in quota %r.',
+            show_warning)
+        self.ui.percentage_usage_label.setProperty("OverQuota", show_warning)
+        self.ui.quota_usage_label.setProperty("OverQuota", show_warning)
         self.ui.percentage_usage_label.style().unpolish(
             self.ui.percentage_usage_label)
         self.ui.percentage_usage_label.style().polish(

=== modified file 'ubuntuone/controlpanel/gui/qt/tests/test_controlpanel.py'
--- ubuntuone/controlpanel/gui/qt/tests/test_controlpanel.py	2011-09-12 20:17:37 +0000
+++ ubuntuone/controlpanel/gui/qt/tests/test_controlpanel.py	2012-02-17 14:55:36 +0000
@@ -126,9 +126,8 @@
 
     def test_update_over_quota(self):
         """Check the labels state when the user exceed the quota."""
-        percentage_value = 100
         # pylint: disable=W0212
-        self.ui._update_quota({'percentage': percentage_value})
+        self.ui._update_quota(True)
         # pylint: enable=W0212
 
         self.assertTrue(
@@ -138,9 +137,8 @@
 
     def test_update_quota_in_range(self):
         """Check the labels state when the quota is under the threshold."""
-        percentage_value = 50
         # pylint: disable=W0212
-        self.ui._update_quota({'percentage': percentage_value})
+        self.ui._update_quota(False)
         # pylint: enable=W0212
 
         self.assertFalse(

=== added file 'ubuntuone/controlpanel/gui/tests/test_show_quota_warning.py'
--- ubuntuone/controlpanel/gui/tests/test_show_quota_warning.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/controlpanel/gui/tests/test_show_quota_warning.py	2012-02-17 14:55:36 +0000
@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Tests for the show_quota_warning function."""
+
+from ubuntuone.controlpanel.tests import TestCase
+from ubuntuone.controlpanel.gui import show_quota_warning
+
+
+GB5 = 5368709120  # 5 Gb
+GB25 = 26843545600  # 25 Gb
+
+
+class QuotaWarningTestCase(TestCase):
+
+    """Test cases for the humanize function."""
+
+    def test_quota_warning_with_used_0_free_account(self):
+        """Check the return value for show_quota_warning with 0 bytes used."""
+        self.assertFalse(show_quota_warning(0, GB5))
+
+    def test_quota_warning_with_free_account_used_medium(self):
+        """Check the return value for show_quota_warning with 2.5 gb used."""
+        used = 2.5 * (1024 ** 3)  # 2.5 Gb
+        self.assertFalse(show_quota_warning(used, GB5))
+
+    def test_quota_warning_with_free_account_used_almost_full(self):
+        """Check the return value for show_quota_warning with 4.5 gb used."""
+        # For free accounts the warning should be activate when the user
+        # has equal or less than 500 mb remaining
+        used = 4.5 * (1024 ** 3)  # 4.5 Gb
+        self.assertTrue(show_quota_warning(used, GB5))
+
+    def test_quota_warning_with_free_account_used_full(self):
+        """Check the return value for show_quota_warning with 5 gb used."""
+        # For free accounts the warning should be activate when the user
+        # has equal or less than 500 mb remaining
+        used = 5.0 * (1024 ** 3)  # 5.0 Gb
+        self.assertTrue(show_quota_warning(used, GB5))
+
+    def test_quota_warning_with_used_0_pay_account(self):
+        """Check the return value for show_quota_warning with 0 bytes used."""
+        self.assertFalse(show_quota_warning(0, GB25))
+
+    def test_quota_warning_with_pay_account_used_medium(self):
+        """Check the return value for show_quota_warning with 12.5 gb used."""
+        used = 12.5 * (1024 ** 3)  # 12.5 Gb
+        self.assertFalse(show_quota_warning(used, GB25))
+
+    def test_quota_warning_with_pay_account_used_almost_full(self):
+        """Check the return value for show_quota_warning with 22 gb used."""
+        # For pay accounts the warning should be activate when the user
+        # has equal or less than 3 Gb remaining
+        used = 22 * (1024 ** 3)  # 22 Gb
+        self.assertTrue(show_quota_warning(used, GB25))
+
+    def test_quota_warning_with_pay_account_used_full(self):
+        """Check the return value for show_quota_warning with 25 gb used."""
+        # For free accounts the warning should be activate when the user
+        # has equal or less than 3 gb remaining
+        used = 25 * (1024 ** 3)  # 25 Gb
+        self.assertTrue(show_quota_warning(used, GB25))