From 9e96fb9f7e38260e644ea006791748087377aa63 Mon Sep 17 00:00:00 2001
From: Yuriy Zveryanskyy <yzveryanskyy@mirantis.com>
Date: Fri, 25 Mar 2016 11:25:19 +0200
Subject: [PATCH] Fix boot policy for Intel Node Manager driver

Correction time parameter does not apply to boot time policy and
should be set to zero.

Change-Id: I342c576508a2c65d3022d0f6e27ad5454178cf6b
---
 ironic_staging_drivers/intel_nm/nm_commands.py         |  2 ++
 ironic_staging_drivers/intel_nm/nm_vendor.py           |  3 +++
 ironic_staging_drivers/intel_nm/policy_schema.json     |  2 +-
 .../tests/unit/intel_nm/test_commands.py               |  5 ++---
 .../tests/unit/intel_nm/test_vendor.py                 | 10 ++++++++++
 .../intel-nm-boot-policy-fix-1d75c1b684ba5cda.yaml     |  4 ++++
 6 files changed, 22 insertions(+), 4 deletions(-)
 create mode 100644 releasenotes/notes/intel-nm-boot-policy-fix-1d75c1b684ba5cda.yaml

diff --git a/ironic_staging_drivers/intel_nm/nm_commands.py b/ironic_staging_drivers/intel_nm/nm_commands.py
index a1e4bd9..08cd0dd 100644
--- a/ironic_staging_drivers/intel_nm/nm_commands.py
+++ b/ironic_staging_drivers/intel_nm/nm_commands.py
@@ -262,6 +262,8 @@ def set_policy(policy):
         mode = 0x00 if policy['target_limit']['boot_mode'] == 'power' else 0x01
         cores_disabled = policy['target_limit']['cores_disabled'] << 1
         limit = mode | cores_disabled
+        # correction time does not apply to boot time policy
+        policy['correction_time'] = 0
 
     policy_values = struct.pack('<HIHH', limit, policy['correction_time'],
                                 policy['trigger_limit'],
diff --git a/ironic_staging_drivers/intel_nm/nm_vendor.py b/ironic_staging_drivers/intel_nm/nm_vendor.py
index a027d4f..22235d2 100644
--- a/ironic_staging_drivers/intel_nm/nm_vendor.py
+++ b/ironic_staging_drivers/intel_nm/nm_vendor.py
@@ -162,6 +162,9 @@ class IntelNMVendorPassthru(base.VendorInterface):
                 if not isinstance(kwargs['target_limit'], dict):
                     raise exception.InvalidParameterValue(_('Invalid boot '
                                                             'policy'))
+            elif 'correction_time' not in kwargs:
+                raise exception.MissingParameterValue(
+                    _('Missing "correction_time" for no-boot policy'))
 
         elif method == 'set_nm_policy_suspend':
             jsonschema.validate(kwargs, self.suspend_schema)
diff --git a/ironic_staging_drivers/intel_nm/policy_schema.json b/ironic_staging_drivers/intel_nm/policy_schema.json
index 3c683e5..e2f3dfa 100644
--- a/ironic_staging_drivers/intel_nm/policy_schema.json
+++ b/ironic_staging_drivers/intel_nm/policy_schema.json
@@ -73,7 +73,7 @@
             "maximum": 65535
         }
     },
-    "required": ["domain_id", "enable", "policy_id", "policy_trigger", "action", "power_domain", "target_limit", "correction_time", "reporting_period" ],
+    "required": ["domain_id", "enable", "policy_id", "policy_trigger", "action", "power_domain", "target_limit", "reporting_period" ],
     "additionalProperties": false
 }
 
diff --git a/ironic_staging_drivers/tests/unit/intel_nm/test_commands.py b/ironic_staging_drivers/tests/unit/intel_nm/test_commands.py
index 9a12a68..c19ddfd 100644
--- a/ironic_staging_drivers/tests/unit/intel_nm/test_commands.py
+++ b/ironic_staging_drivers/tests/unit/intel_nm/test_commands.py
@@ -73,10 +73,9 @@ class IntelNMPoliciesCommandTestCase(base.TestCase):
                   'storage': 'persistent', 'action': 'alert',
                   'power_domain': 'primary',
                   'target_limit': {'boot_mode': 'power', 'cores_disabled': 2},
-                  'correction_time': 2000, 'trigger_limit': 100,
-                  'reporting_period': 600}
+                  'trigger_limit': 100, 'reporting_period': 600}
         expected = ['0x2E', '0xC1', '0x57', '0x01', '0x00', '0x10', '0x7B',
-                    '0x14', '0x00', '0x04', '0x00', '0xd0', '0x07', '0x00',
+                    '0x14', '0x00', '0x04', '0x00', '0x00', '0x00', '0x00',
                     '0x00', '0x00', '0x00', '0x58', '0x02']
         result = commands.set_policy(policy)
         self.assertEqual(expected, result)
diff --git a/ironic_staging_drivers/tests/unit/intel_nm/test_vendor.py b/ironic_staging_drivers/tests/unit/intel_nm/test_vendor.py
index d58079c..f021098 100644
--- a/ironic_staging_drivers/tests/unit/intel_nm/test_vendor.py
+++ b/ironic_staging_drivers/tests/unit/intel_nm/test_vendor.py
@@ -257,6 +257,7 @@ class IntelNMPassthruTestCase(db_base.DbTestCase):
 
     def test_validate_policy_boot(self):
         data = _POLICY.copy()
+        del data['correction_time']
         data['policy_trigger'] = 'boot'
         data['target_limit'] = {'boot_mode': 'power', 'cores_disabled': 2}
         with task_manager.acquire(self.context, self.node.uuid,
@@ -272,6 +273,15 @@ class IntelNMPassthruTestCase(db_base.DbTestCase):
                               task.driver.vendor.validate, task,
                               'set_nm_policy', 'fake', **data)
 
+    def test_validate_policy_no_correction_time(self):
+        data = _POLICY.copy()
+        del data['correction_time']
+        with task_manager.acquire(self.context, self.node.uuid,
+                                  shared=False) as task:
+            self.assertRaises(exception.MissingParameterValue,
+                              task.driver.vendor.validate, task,
+                              'set_nm_policy', 'fake', **data)
+
     def test_validate_statistics_no_policy(self):
         data = {'scope': 'policy', 'domain_id': 'platform'}
         with task_manager.acquire(self.context, self.node.uuid,
diff --git a/releasenotes/notes/intel-nm-boot-policy-fix-1d75c1b684ba5cda.yaml b/releasenotes/notes/intel-nm-boot-policy-fix-1d75c1b684ba5cda.yaml
new file mode 100644
index 0000000..3650924
--- /dev/null
+++ b/releasenotes/notes/intel-nm-boot-policy-fix-1d75c1b684ba5cda.yaml
@@ -0,0 +1,4 @@
+---
+fixes:
+  - Set boot policy for Intel Node Manager fixed, boot policy does not require
+    "correction_time" parameter and it always should be set to zero.