Updating code for pci-anr optimization calls

Include pci-anr minizinc model
Refactor the code to handle pci & pci-anr optimizations
Fix pytest unit test cases

Change-Id: I59eba39850a90e5aaf45f0e2de1881ebb5a9d5d8
Signed-off-by: vrvarma <vv8305@att.com>
Issue-ID: OPTFRA-416
Signed-off-by: vrvarma <vv8305@att.com>

12 files changed, 376 insertions, 20 deletions

diff --git a/osdf/optimizers/pciopt/pci_opt_processor.py b/osdf/optimizers/pciopt/pci_opt_processor.py
index da87b83..7a640aa 100644
--- a/osdf/optimizers/pciopt/pci_opt_processor.py
+++ b/osdf/optimizers/pciopt/pci_opt_processor.py
@@ -67,7 +67,7 @@ def process_pci_optimation(request_json, osdf_config, flat_policies):
 
 
 def get_solutions(cell_info_list, network_cell_info, request_json):
-    status, solutions = build_solution_list(cell_info_list, network_cell_info, request_json)
+    status, pci_solutions, anr_solutions = build_solution_list(cell_info_list, network_cell_info, request_json)
     return {
         "transactionId": request_json['requestInfo']['transactionId'],
         "requestId": request_json["requestInfo"]["requestId"],
@@ -76,28 +76,45 @@ def get_solutions(cell_info_list, network_cell_info, request_json):
         "solutions": [
             {
                 'networkId': request_json['cellInfo']['networkId'],
-                'pciSolutions': solutions
+                'pciSolutions': pci_solutions,
+                'anrSolutions': anr_solutions
             }
         ]
     }
 
 
 def build_solution_list(cell_info_list, network_cell_info, request_json):
-    solution_list = []
     status = "success"
     req_id = request_json["requestInfo"]["requestId"]
     try:
-        opt_solution = optimize(network_cell_info, cell_info_list)
-        sol = opt_solution[0]['pci']
-        for k, v in sol.items():
-            old_pci = get_pci_value(network_cell_info, k)
-            if old_pci != v:
-                response = {
-                    'cellId': get_cell_id(network_cell_info, k),
-                    'pci': v
-                }
-                solution_list.append(response)
+        opt_solution = optimize(network_cell_info, cell_info_list, request_json)
+        pci_solutions = build_pci_solution(network_cell_info, opt_solution['pci'])
+        anr_solutions = build_anr_solution(network_cell_info, opt_solution.get('removables', {}))
     except RuntimeError:
         error_log.error("Failed finding solution for {} {}".format(req_id, traceback.format_exc()))
         status = "failed"
-    return status, solution_list
+    return status, pci_solutions, anr_solutions
+
+
+def build_pci_solution(network_cell_info, pci_solution):
+    pci_solutions = []
+    for k, v in pci_solution.items():
+        old_pci = get_pci_value(network_cell_info, k)
+        if old_pci != v:
+            response = {
+                'cellId': get_cell_id(network_cell_info, k),
+                'pci': v
+            }
+            pci_solutions.append(response)
+    return pci_solutions
+
+
+def build_anr_solution(network_cell_info, removables):
+    anr_solutions = []
+    for k, v in removables.items():
+        response = {
+            'cellId': get_cell_id(network_cell_info, k),
+            'removeableNeighbors': list(map(lambda x: get_cell_id(network_cell_info, x), v))
+        }
+        anr_solutions.append(response)
+    return anr_solutions
diff --git a/osdf/optimizers/pciopt/solver/min_confusion_inl.mzn b/osdf/optimizers/pciopt/solver/min_confusion_inl.mzn
new file mode 100644
index 0000000..0f0fc91
--- /dev/null
+++ b/osdf/optimizers/pciopt/solver/min_confusion_inl.mzn
@@ -0,0 +1,140 @@
+% -------------------------------------------------------------------------
+%   Copyright (c) 2018 AT&T Intellectual Property
+%
+%   Licensed under the Apache License, Version 2.0 (the "License");
+%   you may not use this file except in compliance with the License.
+%   You may obtain a copy of the License at
+%
+%       http://www.apache.org/licenses/LICENSE-2.0
+%
+%   Unless required by applicable law or agreed to in writing, software
+%   distributed under the License is distributed on an "AS IS" BASIS,
+%   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%   See the License for the specific language governing permissions and
+%   limitations under the License.
+%
+% -------------------------------------------------------------------------
+%
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% Parameters and its assertions
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+% Number of cells/radios.
+int: NUM_NODES;
+
+% Maximum number of Physical Cell Identifiers to be assigned to the nodes.
+int: NUM_PCIS;
+
+% Number of edges between neighbor nodes. There is a edge (i,j) if and only
+% if nodes i and j are neighbors, i.e., an user equipment (UE) can make
+% handoff between i and j. Such edges are used to avoid **COLLISION**, i.e.,
+% to guarantee that nodes i and j have different PCIs.
+int: NUM_NEIGHBORS;
+
+% Each line represents an edge between direct neighbors as defined before.
+array[1..NUM_NEIGHBORS, 1..2] of int: NEIGHBORS;
+
+% Number of undirect neighbor pairs (j, k) such that both j and k are direct
+% neighbors of node i, i.e., (j, k) exits if and only if exists (i, j) and
+% (i, k). Nodes (i, k) can generate "confunsions" in the network if they have
+% the same PCI. Such edges are used to avoid/minimize **CONFUSIONS**.
+int: NUM_SECOND_LEVEL_NEIGHBORS;
+
+% Each line represents an edge between undirect neighbors as defined before.
+array[1..NUM_SECOND_LEVEL_NEIGHBORS, 1..2] of int: SECOND_LEVEL_NEIGHBORS;
+
+% Number of ignorable neighbor links. Such links can be ignored during
+% optimization if needed.
+int: NUM_IGNORABLE_NEIGHBOR_LINKS;
+
+% The links that can be ignored if needed. Each line represents the two ends
+% of the links, like the previous structures.
+array[1..NUM_IGNORABLE_NEIGHBOR_LINKS, 1..2] of int: IGNORABLE_NEIGHBOR_LINKS;
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% Decision variables
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+% Defines the PCI for each node.
+array[0..NUM_NODES-1] of var 0..NUM_PCIS-1: pci;
+
+array[1..NUM_IGNORABLE_NEIGHBOR_LINKS] of var 0..1: used_ignorables;
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% Constraints
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+% Direct neighbors must have different PCIs for avoid **COLLISION**.
+% Forced links.
+constraint
+forall(i in 1..NUM_NEIGHBORS, j in 1..NUM_IGNORABLE_NEIGHBOR_LINKS
+    where
+        NEIGHBORS[i, 1] != IGNORABLE_NEIGHBOR_LINKS[j, 1] \/
+        NEIGHBORS[i, 2] != IGNORABLE_NEIGHBOR_LINKS[j, 2]
+)(
+    pci[NEIGHBORS[i, 1]] != pci[NEIGHBORS[i, 2]]
+);
+
+
+% Ignorable links.
+constraint
+forall(i in 1..NUM_NEIGHBORS, j in 1..NUM_IGNORABLE_NEIGHBOR_LINKS
+    where
+        NEIGHBORS[i, 1] == IGNORABLE_NEIGHBOR_LINKS[j, 1] /\
+        NEIGHBORS[i, 2] == IGNORABLE_NEIGHBOR_LINKS[j, 2]
+)(
+    used_ignorables[j] >= bool2int(pci[NEIGHBORS[i, 1]] == pci[NEIGHBORS[i, 2]])
+);
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% Objective function
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+% Total number of confusions.
+var int: total_confusions =
+    sum([bool2int(pci[SECOND_LEVEL_NEIGHBORS[i, 1]] ==
+                  pci[SECOND_LEVEL_NEIGHBORS[i, 2]])
+         | i in 1..NUM_SECOND_LEVEL_NEIGHBORS]);
+
+% Total number of used ignorables links.
+var int: total_used_ignorables = sum(used_ignorables);
+
+solve :: int_search(pci, smallest, indomain_min, complete)
+
+% Minimize the total number of confusions.
+%minimize total_confusions;
+
+% Minimize the total number of confusions first,
+% then the number of used ignorables links.
+minimize (2 * NUM_IGNORABLE_NEIGHBOR_LINKS * total_confusions) +
+         total_used_ignorables;
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% Output
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+output
+["PCI assigment"] ++
+["\nnode,pci"] ++
+[
+    "\n" ++ show(node) ++ "," ++ show(pci[node])
+| node in 0..NUM_NODES-1
+] ++
+["\n\nTotal used ignorables links: " ++ show(total_used_ignorables)] ++
+["\nUsed ignorables links: "] ++
+[
+    "\n" ++ show(IGNORABLE_NEIGHBOR_LINKS[i, 1]) ++
+    ","  ++ show(IGNORABLE_NEIGHBOR_LINKS[i, 2])
+    | i in 1..NUM_IGNORABLE_NEIGHBOR_LINKS where fix(used_ignorables[i] > 0)
+] ++
+["\n\nConfusions"] ++
+["\nTotal confusions: " ++ show(total_confusions)] ++
+["\nConfusion pairs"] ++
+[
+    "\n" ++ show(SECOND_LEVEL_NEIGHBORS[i, 1]) ++ "," ++
+    show(SECOND_LEVEL_NEIGHBORS[i, 2])
+    | i in 1..NUM_SECOND_LEVEL_NEIGHBORS where
+      fix(pci[SECOND_LEVEL_NEIGHBORS[i, 1]] == pci[SECOND_LEVEL_NEIGHBORS[i, 2]])
+]
+
diff --git a/osdf/optimizers/pciopt/solver/optimizer.py b/osdf/optimizers/pciopt/solver/optimizer.py
index 2825536..9b2e9d9 100644
--- a/osdf/optimizers/pciopt/solver/optimizer.py
+++ b/osdf/optimizers/pciopt/solver/optimizer.py
@@ -18,18 +18,44 @@
 
 import itertools
 import os
+from collections import defaultdict
 
 import pymzn
 
 from .pci_utils import get_id
 
 BASE_DIR = os.path.dirname(__file__)
-MZN_FILE_NAME = os.path.join(BASE_DIR, 'no_conflicts_no_confusion.mzn')
 
 
-def pci_optimize(network_cell_info, cell_info_list):
+def pci_optimize(network_cell_info, cell_info_list, request_json):
     neighbor_edges = get_neighbor_list(network_cell_info)
     second_level_edges = get_second_level_neighbor(network_cell_info)
+    ignorable_links = get_ignorable_links(network_cell_info, request_json)
+    anr_flag = is_anr(request_json)
+
+    dzn_data = build_dzn_data(cell_info_list, ignorable_links, neighbor_edges, second_level_edges, anr_flag)
+
+    return build_pci_solution(dzn_data, ignorable_links, anr_flag)
+
+
+def build_pci_solution(dzn_data, ignorable_links, anr_flag):
+    mzn_solution = solve(get_mzn_model(anr_flag), dzn_data)
+
+    solution = {'pci': mzn_solution[0]['pci']}
+
+    if anr_flag:
+        removables = defaultdict(list)
+        used_ignorables = mzn_solution[0]['used_ignorables']
+        index = 0
+        for i in ignorable_links:
+            if used_ignorables[index] > 0:
+                removables[i[0]].append(i[1])
+            index += 1
+        solution['removables'] = removables
+    return solution
+
+
+def build_dzn_data(cell_info_list, ignorable_links, neighbor_edges, second_level_edges, anr_flag):
     dzn_data = {
         'NUM_NODES': len(cell_info_list),
         'NUM_PCIS': len(cell_info_list),
@@ -38,8 +64,22 @@ def pci_optimize(network_cell_info, cell_info_list):
         'NUM_SECOND_LEVEL_NEIGHBORS': len(second_level_edges),
         'SECOND_LEVEL_NEIGHBORS': get_list(second_level_edges)
     }
+    if anr_flag:
+        dzn_data['NUM_IGNORABLE_NEIGHBOR_LINKS'] = len(ignorable_links)
+        dzn_data['IGNORABLE_NEIGHBOR_LINKS'] = get_list(ignorable_links)
+    return dzn_data
+
+
+def get_mzn_model(anr_flag):
+    if anr_flag:
+        mzn_model = os.path.join(BASE_DIR, 'min_confusion_inl.mzn')
+    else:
+        mzn_model = os.path.join(BASE_DIR, 'no_conflicts_no_confusion.mzn')
+    return mzn_model
 
-    return solve(dzn_data)
+
+def is_anr(request_json):
+    return 'pci-anr' in request_json["requestInfo"]["optimizers"]
 
 
 def get_list(edge_list):
@@ -49,8 +89,8 @@ def get_list(edge_list):
     return sorted(array_list)
 
 
-def solve(dzn_data):
-    return pymzn.minizinc(MZN_FILE_NAME, data=dzn_data)
+def solve(mzn_model, dzn_data):
+    return pymzn.minizinc(mzn=mzn_model, data=dzn_data)
 
 
 def get_neighbor_list(network_cell_info):
@@ -83,3 +123,15 @@ def build_second_level_list(network_cell_info, cell):
     for nbr in cell.get('nbr_list', []):
         second_nbr_list.append(get_id(network_cell_info, nbr['cellId']))
     return [list(elem) for elem in list(itertools.combinations(second_nbr_list, 2))]
+
+
+def get_ignorable_links(network_cell_info, request_json):
+    ignorable_list = set()
+    anr_input_list = request_json["cellInfo"].get('anrInputList', [])
+    if anr_input_list:
+        for anr_info in anr_input_list:
+            cell_id = get_id(network_cell_info, anr_info['cellId'])
+            anr_removable = anr_info.get('removeableNeighbors', [])
+            for anr in anr_removable:
+                ignorable_list.add((cell_id, get_id(network_cell_info, anr)))
+    return ignorable_list
diff --git a/test/functest/simulators/configdb/response-payloads/getCellList-2000.json b/test/functest/simulators/configdb/response-payloads/getCellList-2000.json
new file mode 100644
index 0000000..77cf7db
--- /dev/null
+++ b/test/functest/simulators/configdb/response-payloads/getCellList-2000.json
@@ -0,0 +1 @@
+["cell20","cell21","cell22","cell23","cell24"]
\ No newline at end of file
diff --git a/test/functest/simulators/configdb/response-payloads/getNbrList-cell20.json b/test/functest/simulators/configdb/response-payloads/getNbrList-cell20.json
new file mode 100644
index 0000000..86c7d2c
--- /dev/null
+++ b/test/functest/simulators/configdb/response-payloads/getNbrList-cell20.json
@@ -0,0 +1,14 @@
+[
+  {
+    "cellId": "cell21",
+    "pciValue": 0
+  },
+  {
+    "cellId": "cell22",
+    "pciValue": 1
+  },
+  {
+    "cellId": "cell23",
+    "pciValue": 2
+  }
+]
\ No newline at end of file
diff --git a/test/functest/simulators/configdb/response-payloads/getNbrList-cell21.json b/test/functest/simulators/configdb/response-payloads/getNbrList-cell21.json
new file mode 100644
index 0000000..490c15f
--- /dev/null
+++ b/test/functest/simulators/configdb/response-payloads/getNbrList-cell21.json
@@ -0,0 +1,6 @@
+[
+  {
+    "cellId": "cell20",
+    "pciValue":0
+  }
+]
\ No newline at end of file
diff --git a/test/functest/simulators/configdb/response-payloads/getNbrList-cell22.json b/test/functest/simulators/configdb/response-payloads/getNbrList-cell22.json
new file mode 100644
index 0000000..426e13b
--- /dev/null
+++ b/test/functest/simulators/configdb/response-payloads/getNbrList-cell22.json
@@ -0,0 +1,6 @@
+[
+  {
+    "cellId": "cell20",
+    "pciValue": 0
+  }
+]
\ No newline at end of file
diff --git a/test/functest/simulators/configdb/response-payloads/getNbrList-cell23.json b/test/functest/simulators/configdb/response-payloads/getNbrList-cell23.json
new file mode 100644
index 0000000..de582eb
--- /dev/null
+++ b/test/functest/simulators/configdb/response-payloads/getNbrList-cell23.json
@@ -0,0 +1,6 @@
+[
+  {
+    "cellId": "cell24",
+    "pciValue": 0
+  }
+]
\ No newline at end of file
diff --git a/test/functest/simulators/configdb/response-payloads/getNbrList-cell24.json b/test/functest/simulators/configdb/response-payloads/getNbrList-cell24.json
new file mode 100644
index 0000000..8d8d3fb
--- /dev/null
+++ b/test/functest/simulators/configdb/response-payloads/getNbrList-cell24.json
@@ -0,0 +1,6 @@
+[
+  {
+    "cellId": "cell23",
+    "pciValue": 2
+  }
+]
\ No newline at end of file
diff --git a/test/pci-optimization-tests/pci_anr_request.json b/test/pci-optimization-tests/pci_anr_request.json
new file mode 100644
index 0000000..e8947b1
--- /dev/null
+++ b/test/pci-optimization-tests/pci_anr_request.json
@@ -0,0 +1,29 @@
+{
+  "requestInfo": {
+    "transactionId": "xxx-xxx-xxxx",
+    "requestId": "yyy-yyy-yyyy",
+    "callbackUrl": "https://wiki.onap.org:5000/callbackUrl/",
+    "sourceId": "SO",
+    "requestType": "create",
+    "numSolutions": 1,
+    "optimizers": [
+      "pci-anr"
+    ],
+    "timeout": 600
+  },
+  "cellInfo": {
+    "networkId": "2000",
+    "cellIdList": [
+      "cell20"
+    ]
+  },
+  "anrInputList": [
+    {
+      "cellId": "cell20",
+      "removeableNeighbors": [
+        "cell23"
+      ]
+    }
+  ],
+  "trigger": "NbrListChange"
+}
\ No newline at end of file
diff --git a/test/pci-optimization-tests/request.json b/test/pci-optimization-tests/request.json
index 7ec9ab5..517ee10 100644
--- a/test/pci-optimization-tests/request.json
+++ b/test/pci-optimization-tests/request.json
@@ -7,7 +7,7 @@
     "requestType": "create",
     "numSolutions": 1,
     "optimizers": [
-      "placement"
+      "pci"
     ],
     "timeout": 600
   },
diff --git a/test/test_process_pci_anr_opt.py b/test/test_process_pci_anr_opt.py
new file mode 100644
index 0000000..8c6a34c
--- /dev/null
+++ b/test/test_process_pci_anr_opt.py
@@ -0,0 +1,79 @@
+# -------------------------------------------------------------------------
+#   Copyright (c) 2018 AT&T Intellectual Property
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+# -------------------------------------------------------------------------
+#
+import mock
+import unittest
+
+from flask import Response
+from mock import patch
+from osdf.adapters.local_data import local_policies
+from osdf.optimizers.pciopt.pci_opt_processor import process_pci_optimation
+import osdf.config.loader as config_loader
+from osdf.utils.interfaces import json_from_file
+from osdf.utils.programming_utils import DotDict
+
+
+class TestProcessPlacementOpt(unittest.TestCase):
+
+    def setUp(self):
+        mock_req_accept_message = Response("Accepted Request", content_type='application/json; charset=utf-8')
+        self.patcher_req = patch('osdf.optimizers.pciopt.configdb.request',
+                                 return_value={"solutionInfo": {"placementInfo": "dummy"}})
+        self.patcher_req_accept = patch('osdf.operation.responses.osdf_response_for_request_accept',
+                                        return_value=mock_req_accept_message)
+        self.patcher_callback = patch(
+            'osdf.optimizers.pciopt.pci_opt_processor.process_pci_optimation',
+            return_value=mock_req_accept_message)
+
+        mock_mzn_response = [{'pci': {0: 0, 1: 1, 2: 2, 3: 3, 4: 0}, 'used_ignorables': [0]}]
+
+        self.patcher_minizinc_callback = patch(
+            'osdf.optimizers.pciopt.solver.optimizer.solve',
+            return_value=mock_mzn_response )
+        self.patcher_RestClient = patch(
+            'osdf.utils.interfaces.RestClient', return_value=mock.MagicMock())
+        self.Mock_req = self.patcher_req.start()
+        self.Mock_req_accept = self.patcher_req_accept.start()
+        self.Mock_callback = self.patcher_callback.start()
+        self.Mock_RestClient = self.patcher_RestClient.start()
+        self.Mock_mzn_callback = self.patcher_minizinc_callback.start()
+
+    def tearDown(self):
+        patch.stopall()
+
+    def test_process_pci_anr_opt_solutions(self):
+        main_dir = ""
+        parameter_data_file = main_dir + "test/pci-optimization-tests/pci_anr_request.json"
+        policy_data_path = main_dir + "test/policy-local-files/"
+        self.config_spec = {
+            "deployment": "test/functest/simulators/simulated-config/osdf_config.yaml",
+            "core": "test/functest/simulators/simulated-config/common_config.yaml"
+        }
+        self.osdf_config = DotDict(config_loader.all_configs(**self.config_spec))
+
+        valid_policies_list_file = policy_data_path + '/' + 'meta-valid-policies.txt'
+        valid_policies_files = local_policies.get_policy_names_from_file(valid_policies_list_file)
+
+        request_json = json_from_file(parameter_data_file)
+        policies = [json_from_file(policy_data_path + '/' + name) for name in valid_policies_files]
+
+        templ_string = process_pci_optimation(request_json, self.osdf_config,policies)
+
+
+if __name__ == "__main__":
+    unittest.main()
+