Merge pull request #211 from cloudblue/LITE-27699-add-six-year-commitment-connect-cli

LITE-27699 Add 6 years label

Author: ffaraone

connect/cli/plugins/product/constants.py

@@ -20,7 +20,7 @@
 
 
 PRECISIONS = ('integer', 'decimal(1)', 'decimal(2)', 'decimal(4)', 'decimal(8)')
-COMMITMENT = ('-', '1 year', '2 years', '3 years', '4 years', '5 years')
+COMMITMENT = ('-', '1 year', '2 years', '3 years', '4 years', '5 years', '6 years')
 BILLING_PERIOD = (
     'onetime',
     'monthly',
@@ -29,8 +29,22 @@
     '3 years',
     '4 years',
     '5 years',
+    '6 years',
 )
 
+
+ALLOWED_COMMITMENTS = {
+    'monthly': COMMITMENT,
+    'yearly': COMMITMENT,
+    '2 years': ('-', '4 years', '6 years'),
+    '3 years': ('-', '6 years'),
+    '4 years': ('-',),
+    '5 years': ('-',),
+    '6 years': ('-',),
+    'onetime': ('-',),
+}
+
+
 CAPABILITIES = (
     'Pay-as-you-go support and schema',
     'Pay-as-you-go dynamic items support',

connect/cli/plugins/product/export.py

@@ -20,7 +20,12 @@
 
 from connect.cli.core.http import format_http_status, handle_http_error
 from connect.cli.core.utils import validate_output_options
-from connect.cli.plugins.product.constants import PARAM_TYPES
+from connect.cli.plugins.product.constants import (
+    BILLING_PERIOD,
+    COMMITMENT,
+    PARAM_TYPES,
+    PRECISIONS,
+)
 from connect.cli.plugins.product.utils import get_json_object_for_param
 from connect.cli.plugins.shared.export import alter_attributes_sheet, get_translation_workbook
 from connect.cli.plugins.shared.utils import (
@@ -42,6 +47,10 @@ def _setup_locales_list(ws, client):
         ws[f'AB{idx}'].value = loc
 
 
+def _build_f1_options(option_list):
+    return '"{options}"'.format(options=','.join(option_list))
+
+
 def _setup_cover_sheet(ws, product, location, client, media_path):
     ws.title = 'General Information'
     ws.column_dimensions['A'].width = 50
@@ -486,9 +495,7 @@ def _dump_parameters(ws, client, product_id, param_type, progress):
     )
     type_validation = DataValidation(
         type='list',
-        formula1='"{params}"'.format(
-            params=','.join(PARAM_TYPES),
-        ),
+        formula1=_build_f1_options(PARAM_TYPES),
         allow_blank=False,
     )
     ordering_fulfillment_scope_validation = DataValidation(
@@ -818,19 +825,19 @@ def _dump_items(ws, client, product_id, progress):
     )
     period_validation = DataValidation(
         type='list',
-        formula1='"onetime,monthly,yearly,2 years,3 years,4 years,5 years"',
+        formula1=_build_f1_options(BILLING_PERIOD),
         allow_blank=False,
     )
 
     precision_validation = DataValidation(
         type='list',
-        formula1='"integer,decimal(1),decimal(2),decimal(4),decimal(8)"',
+        formula1=_build_f1_options(PRECISIONS),
         allow_blank=False,
     )
 
     commitment_validation = DataValidation(
         type='list',
-        formula1='"-,1 year,2 years,3 years,4 years,5 years"',
+        formula1=_build_f1_options(COMMITMENT),
         allow_blank=False,
     )
 

connect/cli/plugins/product/sync/items.py

@@ -15,7 +15,12 @@
     get_item_by_mpn,
     update_item,
 )
-from connect.cli.plugins.product.constants import BILLING_PERIOD, COMMITMENT, PRECISIONS
+from connect.cli.plugins.product.constants import (
+    ALLOWED_COMMITMENTS,
+    BILLING_PERIOD,
+    COMMITMENT,
+    PRECISIONS,
+)
 from connect.cli.plugins.shared.base import ProductSynchronizer
 from connect.cli.plugins.shared.constants import ITEMS_COLS_HEADERS
 
@@ -163,26 +168,13 @@ def _validate_commitment(row):
                 'is invalid for `ppu` items.',
             ]
 
-        if row.billing_period == 'onetime' and row.commitment != '-':
-            return [
-                f'the commitment `{row.commitment}` '
-                'is invalid for `onetime` items.',
-            ]
+        allowed_commitments = ALLOWED_COMMITMENTS.get(row.billing_period, [])
 
-        if row.billing_period == '2 years' and row.commitment not in ('-', '4 years'):
-            return [
-                f'for a billing period of `2 years` the commitment '
-                'must be one between `-`, `4 years`, '
-                f' not {row.commitment}.',
-            ]
-        if row.billing_period in (
-            '3 years',
-            '4 years',
-            '5 years',
-        ) and row.commitment != '-':
+        if allowed_commitments and row.commitment not in allowed_commitments:
+            valid_commitment = ', '.join([f'`{name}`' for name in allowed_commitments])
             return [
-                f'for a billing period of `{row.billing_period}` the commitment '
-                f'must be `-`, not {row.commitment}.',
+                f'for a `{row.billing_period}` billing period the commitment '
+                f'must be one of {valid_commitment}, not `{row.commitment}`.',
             ]
 
         return []

tests/plugins/product/sync/test_items.py

@@ -356,7 +356,7 @@ def test_validate_wrong_period_reservation(mocker, fs, get_sync_items_env):
     }
     assert stats['Items']._row_errors == {
         2: ['the item `Billing period` must be one between `onetime`, `monthly`, `yearly`, '
-            '`2 years`, `3 years`, `4 years`, `5 years`, not `century`.'],
+            '`2 years`, `3 years`, `4 years`, `5 years`, `6 years`, not `century`.'],
     }
 
 
@@ -662,7 +662,7 @@ def test_create_item_validate_commitment(
     }
     assert stats['Items']._row_errors == {
         2: ['the item `Commitment` must be one between `-`, `1 year`, `2 years`, `3 years`, '
-            '`4 years`, `5 years`, not `commitment`.'],
+            '`4 years`, `5 years`, `6 years`, not `commitment`.'],
     }
 
 
@@ -738,7 +738,7 @@ def test_create_item_validate_commitment_onetime(
         'deleted': 0, 'skipped': 0, 'errors': 1,
     }
     assert stats['Items']._row_errors == {
-        2: ['the commitment `1 year` is invalid for `onetime` items.'],
+        2: ['for a `onetime` billing period the commitment must be one of `-`, not `1 year`.'],
     }
 
 
@@ -776,8 +776,8 @@ def test_create_item_validate_commitment_wrong_multiyear(
         'deleted': 0, 'skipped': 0, 'errors': 1,
     }
     assert stats['Items']._row_errors == {
-        2: ['for a billing period of `2 years` the commitment must be one between `-`, `4 years`, '
-            ' not 3 years.'],
+        2: ['for a `2 years` billing period the commitment must be one of `-`, `4 years`'
+            ', `6 years`, not `3 years`.'],
     }
 
 
@@ -815,7 +815,7 @@ def test_create_item_validate_commitment_wrong_multiyear_vs_commitment(
         'deleted': 0, 'skipped': 0, 'errors': 1,
     }
     assert stats['Items']._row_errors == {
-        2: ['for a billing period of `3 years` the commitment must be `-`, not 5 years.'],
+        2: ['for a `3 years` billing period the commitment must be one of `-`, `6 years`, not `5 years`.'],
     }