From 77c6d7dd630b80e72ad3d51e6d0938a9bd071e26 Mon Sep 17 00:00:00 2001
From: Lucas Alvares Gomes <lucasagomes@gmail.com>
Date: Mon, 7 Mar 2022 08:51:28 +0000
Subject: [PATCH] Add unittests to privileged/ovs_vsctl

What first line says...

Signed-off-by: Lucas Alvares Gomes <lucasagomes@gmail.com>
Change-Id: I86d953e77de5dc3a23149a99260fd62b7e58582f
---
 .../tests/unit/privileged/test_ovs_vsctl.py   | 84 +++++++++++++++++++
 .../tests/unit/privileged/test_vtysh.py       |  2 +-
 2 files changed, 85 insertions(+), 1 deletion(-)
 create mode 100644 ovn_bgp_agent/tests/unit/privileged/test_ovs_vsctl.py

diff --git a/ovn_bgp_agent/tests/unit/privileged/test_ovs_vsctl.py b/ovn_bgp_agent/tests/unit/privileged/test_ovs_vsctl.py
new file mode 100644
index 00000000..c810dbf5
--- /dev/null
+++ b/ovn_bgp_agent/tests/unit/privileged/test_ovs_vsctl.py
@@ -0,0 +1,84 @@
+# Copyright 2022 Red Hat, Inc.
+# All Rights Reserved.
+#
+#    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 imp
+from unittest import mock
+
+from oslo_concurrency import processutils
+
+from ovn_bgp_agent.privileged import ovs_vsctl
+from ovn_bgp_agent.tests import base as test_base
+
+# Mock the privsep decorator and reload the module
+mock.patch('ovn_bgp_agent.privileged.ovs_vsctl_cmd.entrypoint',
+           lambda x: x).start()
+imp.reload(ovs_vsctl)
+
+
+class FakeException(Exception):
+    stderr = ''
+
+
+class TestPrivilegedOvsVsctl(test_base.TestCase):
+
+    def setUp(self):
+        super(TestPrivilegedOvsVsctl, self).setUp()
+        # Mock processutils.execute()
+        self.mock_exc = mock.patch.object(processutils, 'execute').start()
+
+    def test_ovs_cmd(self):
+        ovs_vsctl.ovs_cmd(
+            'ovs-vsctl', ['--if-exists', 'del-port', 'fake-port'])
+        self.mock_exc.assert_called_once_with(
+            'ovs-vsctl', '--if-exists', 'del-port', 'fake-port')
+
+    def test_ovs_cmd_timeout(self):
+        ovs_vsctl.ovs_cmd(
+            'ovs-vsctl', ['--if-exists', 'del-port', 'fake-port'], timeout=10)
+        self.mock_exc.assert_called_once_with(
+            'ovs-vsctl', '--timeout=10', '--if-exists', 'del-port',
+            'fake-port')
+
+    def test_ovs_cmd_fallback_OF_version(self):
+        self.mock_exc.side_effect = (
+            processutils.ProcessExecutionError(), None)
+        ovs_vsctl.ovs_cmd(
+            'ovs-vsctl', ['--if-exists', 'del-port', 'fake-port'])
+
+        calls = [mock.call('ovs-vsctl', '--if-exists', 'del-port',
+                           'fake-port'),
+                 mock.call('ovs-vsctl', '--if-exists', 'del-port',
+                           'fake-port', '-O', 'OpenFlow13')]
+        self.mock_exc.assert_has_calls(calls)
+
+    def test_ovs_cmd_exception(self):
+        self.mock_exc.side_effect = FakeException()
+        self.assertRaises(
+            FakeException, ovs_vsctl.ovs_cmd, 'ovs-vsctl',
+            ['--if-exists', 'del-port', 'fake-port'])
+        self.mock_exc.assert_called_once_with(
+            'ovs-vsctl', '--if-exists', 'del-port', 'fake-port')
+
+    def test_ovs_cmd_fallback_exception(self):
+        self.mock_exc.side_effect = (
+            processutils.ProcessExecutionError(), FakeException())
+        self.assertRaises(
+            FakeException, ovs_vsctl.ovs_cmd, 'ovs-vsctl',
+            ['--if-exists', 'del-port', 'fake-port'])
+        calls = [mock.call('ovs-vsctl', '--if-exists', 'del-port',
+                           'fake-port'),
+                 mock.call('ovs-vsctl', '--if-exists', 'del-port',
+                           'fake-port', '-O', 'OpenFlow13')]
+        self.mock_exc.assert_has_calls(calls)
diff --git a/ovn_bgp_agent/tests/unit/privileged/test_vtysh.py b/ovn_bgp_agent/tests/unit/privileged/test_vtysh.py
index e1066b6f..a9be235c 100644
--- a/ovn_bgp_agent/tests/unit/privileged/test_vtysh.py
+++ b/ovn_bgp_agent/tests/unit/privileged/test_vtysh.py
@@ -36,7 +36,7 @@ class TestPrivilegedVtysh(test_base.TestCase):
 
     def setUp(self):
         super(TestPrivilegedVtysh, self).setUp()
-        # Mock pyroute2.NDB context manager object
+        # Mock processutils.execute()
         self.mock_exc = mock.patch.object(processutils, 'execute').start()
 
     def test_run_vtysh_config(self):