[IMP] sale_clouder: Finish module

* Fix docstrings
* Implement unimplemented methods
* Add tests for metrics
* Add tests for contracts

Author: Ted Salmon

clouder_metric/__init__.py

@@ -52,9 +52,8 @@ class ClouderMetricInterface(models.Model):
     interval_type = fields.Selection(
         related='cron_id.interval_type',
     )
-    query_code = fields.Text(
-        # default=lambda s: s._default_query_code()
-    )
+    query_code = fields.Text()
+
 
     @property
     @api.multi
@@ -67,5 +66,5 @@ def metric_id(self):
     @api.multi
     def name_get(self):
         return [
-            (r.id, '%s - %s' % (r.type_id.name, r.metric_id)) for r in self
+            (r.id, '%s - %s' % (r.type_id.name, r.metric_ref)) for r in self
         ]

clouder_metric/__manifest__.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+from . import test_clouder_metric_interface
+from . import test_clouder_metric_type

clouder_metric/models/__init__.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+from odoo.tests.common import TransactionCase
+
+
+class TestCommon(TransactionCase):
+
+    def setUp(self):
+        super(self, TestCommon).__init__()
+        self.metric_type = self.env['clouder.metric.type'].create({
+            'name': 'Test Metric',
+            'code': 'TEST',
+            'metric_model': 'base',
+            'uom_id': self.env.ref('product.uom_categ_wtime'),
+        })
+        self.metric_interface = self.env['clouder.metric.interface'].create({
+            'type_id': self.metric_type.id,
+            'metric_ref': 7,
+            'source_id': None # @TODO
+        })

clouder_metric/models/clouder_metric_interface.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+from .common import TestCommon
+
+
+class TestClouderMetricInterface(TestCommon):
+
+    def test_metric_id(self):
+        """ It should test to see that at least one metric_id is returned """
+        self.assertTrue(len(self.metric_interface.metric_id) == 1)
+
+    def test_name_get(self):
+        """ It should return the right name """
+        exp = [
+            (self.metric_interface.id, 'Test Metric - 7')
+        ]
+        self.assertEqual(exp, self.metric_interface.name_get())

clouder_metric/models/clouder_metric_type.py

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+from .common import TestCommon
+
+
+class TestClouderMetricType(TestCommon):
+
+    def test_get_metric_models(self):
+        """ It should have the correct metric model types """
+        exp = [
+            ('clouder.base', 'Base'),
+            ('clouder.service', 'Service'),
+        ]
+        self.assertEquals(exp, self.metric_type._get_metric_models())
+

clouder_metric/models/clouder_metric_value.py

@@ -4,7 +4,7 @@
 {
     "name": "Sale - Clouder",
     "summary": "Provides the ability to sell Clouder instances.",
-    "version": "9.0.1.0.0",
+    "version": "10.0.1.0.0",
     "category": "Clouder",
     "website": "https://github.com/clouder-community/clouder",
     "author": "LasLabs",

clouder_metric/tests/__init__.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright 2016 LasLabs Inc.
+# Copyright 2016-2017 LasLabs Inc.
 # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
 
 import logging
@@ -23,6 +23,11 @@ class ClouderContract(models.Model):
         require=True,
         ondelete='restrict',
     )
+    contract_line_ids = fields.One2many(
+        string='Contract Lines',
+        comodel_name='clouder.contract.line',
+        inverse_name='contract_line_id'
+    )
 
     _sql_constraints = [
         ('ref_contract_id_unique', 'UNIQUE(ref_contract_id)',
@@ -64,11 +69,11 @@ def get_invoice_line_quantity(self, account, account_line, invoice):
         )
 
         Args:
-            account: (account.analytic.account) Contract that recurring
+            account (account.analytic.account): Contract that recurring
                 invoice line belongs to. This is called 
-            account_line: (account.analytic.invoice.line) Recurring invoice
+            account_line (account.analytic.invoice.line): Recurring invoice
                 line being referenced.
-            invoice: (account.invoice) Invoice that is being created.
+            invoice (account.invoice): Invoice that is being created.
         Returns:
             (int) Quantity to use on invoice line in the UOM defined on the
                 ``contract_line``.
@@ -77,7 +82,6 @@ def get_invoice_line_quantity(self, account, account_line, invoice):
         invoice_policy = account_line.product_id.invoice_policy
         invoice_policy_map = self.invoice_policy_map
         try:
-            invoice
             method = invoice_policy_map[invoice_policy]
         except KeyError:
             _logger.info(_(
@@ -94,7 +98,7 @@ def _create_default_vals(self, account):
         """ It returns default values to create and link new ClouderContracts.
 
         Args:
-            account: (account.analytic.account) Account that ClouderContract
+            account (account.analytic.account): Account that ClouderContract
                 will reference.
         Returns:
             (dict) Values fed to ``create`` in ``_get_contract_by_account``.
@@ -121,25 +125,52 @@ def _get_contract_by_account(self, account, create=False):
 
     @api.multi
     def _get_quantity_flat(self, account_line, invoice):
-        """ It returns the base quantity with no calculations """
+        """ It returns the base quantity with no calculations
+        Args:
+            account_line (account.analytic.invoice.line): Recurring invoice
+                line being referenced.
+            invoice (account.invoice): Invoice that is being created.
+        Returns:
+            (float) Quantity with no calculations performed
+        """
         return account_line.quantity
 
     @api.multi
     def _get_quantity_threshold(self, account_line, invoice):
         """ It functions like flat rate for the most part
 
         Args:
-            account_line: (account.analytic.invoice.line) Recurring invoice
+            account_line (account.analytic.invoice.line): Recurring invoice
                 line being referenced.
-            invoice: (account.invoice) Invoice that is being created.
+            invoice (account.invoice): Invoice that is being created.
         Returns:
-            (int) Quantity to use on invoice line in the UOM defined on the
+            (float) Quantity to use on invoice line in the UOM defined on the
                 ``contract_line``.
         """
-        raise NotImplementedError
-        self.get_quantity_flat(account_line, invoice)
+        return account_line.quantity
 
     @api.multi
     def _get_quantity_usage(self, account_line, invoice):
-        """ It provides a quantity based on unbilled and used metrics """
-        raise NotImplementedError
+        """ It provides a quantity based on unbilled and used metrics
+        Args:
+            account_line (account.analytic.invoice.line): Recurring invoice
+                line being referenced.
+            invoice (account.invoice): Invoice that is being created.
+        Returns:
+            (float) Quantity to use on invoice line in the UOM defined on the
+                ``contract_line``.
+            """
+        usage = 0
+        vals = account_line.metric_interface_id.metric_value_ids
+        inv_date = invoice.date_invoice
+        inv_delta = self.get_relative_delta(
+            self.recurring_rule_type, self.recurring_interval
+        )
+        start_date = inv_date - inv_delta
+        # Filter out metrics that fall within the billing period
+        usage_values = vals.filtered(
+            lambda x: x.date_start >= start_date and  x.date_end <= inv_date
+        )
+        for val in usage_values:
+            usage += val.value
+        return usage

clouder_metric/tests/common.py

@@ -11,6 +11,13 @@ class ClouderContractLine(models.Model):
     _name = 'clouder.contract.line'
     _inherits = {'account.analytic.invoice.line': 'contract_line_id'}
 
+    contact_id = fields.Many2one(
+        string='Contract',
+        comodel_name='clouder.contract',
+        index=True,
+        required=True,
+        ondelete='restrict',
+    )
     contract_line_id = fields.Many2one(
         string='Recurring Line',
         comodel_name='account.analytic.invoice.line',

clouder_metric/tests/test_clouder_metric_interface.py

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+from . import test_clouder_contract
+from . import test_product_template

clouder_metric/tests/test_clouder_metric_type.py

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+from odoo.tests.common import TransactionCase
+
+
+class TestClouderContract(TransactionCase):
+
+    def setUp(self):
+        super(self, TestClouderContract).__init__()
+        self.contract = self.env['clouder.contract']
+
+    def test(self):
+        pass

sale_clouder/__init__.py

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+from odoo.tests.common import TransactionCase
+
+
+class TestProductTemplate(TransactionCase):
+
+    def test_invoice_policy(self):
+        """ It should ensure the right options exist for invoice policy """
+        policy = self.env['product.template']._fields['invoice_policy']
+        exp = ('usage', 'threshold')
+        res = []
+        for item in policy.selection:
+            res.append(item[0])
+        for e in exp:
+            self.assertTrue(e in res)