Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
Holger Hans Peter Freyther | eb0acb6 | 2013-06-24 15:47:34 +0200 | [diff] [blame] | 2 | |
| 3 | # (C) 2013 by Katerina Barone-Adesi <kat.obsc@gmail.com> |
| 4 | # (C) 2013 by Holger Hans Peter Freyther |
| 5 | # This program is free software: you can redistribute it and/or modify |
| 6 | # it under the terms of the GNU General Public License as published by |
| 7 | # the Free Software Foundation, either version 3 of the License, or |
| 8 | # (at your option) any later version. |
| 9 | |
| 10 | # This program is distributed in the hope that it will be useful, |
| 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | # GNU General Public License for more details. |
| 14 | |
| 15 | # You should have received a copy of the GNU General Public License |
| 16 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 17 | |
Max | 3e67689 | 2016-11-16 14:55:21 +0100 | [diff] [blame] | 18 | import os, sys |
Holger Hans Peter Freyther | eb0acb6 | 2013-06-24 15:47:34 +0200 | [diff] [blame] | 19 | import time |
| 20 | import unittest |
Jacob Erlbeck | 6cb2ccc | 2013-08-14 11:10:34 +0200 | [diff] [blame] | 21 | import socket |
Neels Hofmeyr | bcfee2a | 2017-02-03 16:09:17 +0100 | [diff] [blame] | 22 | import subprocess |
Holger Hans Peter Freyther | eb0acb6 | 2013-06-24 15:47:34 +0200 | [diff] [blame] | 23 | |
| 24 | import osmopy.obscvty as obscvty |
| 25 | import osmopy.osmoutil as osmoutil |
Max | f8dc526 | 2017-12-19 18:04:18 +0100 | [diff] [blame] | 26 | from osmopy.osmo_ipa import IPA |
Max | 3e67689 | 2016-11-16 14:55:21 +0100 | [diff] [blame] | 27 | |
Neels Hofmeyr | 476c4bb | 2017-02-24 17:55:11 +0100 | [diff] [blame] | 28 | # to be able to find $top_srcdir/doc/... |
| 29 | confpath = os.path.join(sys.path[0], '..') |
Holger Hans Peter Freyther | eb0acb6 | 2013-06-24 15:47:34 +0200 | [diff] [blame] | 30 | |
| 31 | class TestVTYBase(unittest.TestCase): |
| 32 | |
Neels Hofmeyr | c29505e | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 33 | def checkForEndAndExit(self): |
| 34 | res = self.vty.command("list") |
| 35 | #print ('looking for "exit"\n') |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 36 | self.assertTrue(res.find(' exit\r') > 0) |
Neels Hofmeyr | c29505e | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 37 | #print 'found "exit"\nlooking for "end"\n' |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 38 | self.assertTrue(res.find(' end\r') > 0) |
Neels Hofmeyr | c29505e | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 39 | #print 'found "end"\n' |
| 40 | |
Holger Hans Peter Freyther | eb0acb6 | 2013-06-24 15:47:34 +0200 | [diff] [blame] | 41 | def vty_command(self): |
| 42 | raise Exception("Needs to be implemented by a subclass") |
| 43 | |
| 44 | def vty_app(self): |
| 45 | raise Exception("Needs to be implemented by a subclass") |
| 46 | |
| 47 | def setUp(self): |
| 48 | osmo_vty_cmd = self.vty_command()[:] |
| 49 | config_index = osmo_vty_cmd.index('-c') |
| 50 | if config_index: |
| 51 | cfi = config_index + 1 |
| 52 | osmo_vty_cmd[cfi] = os.path.join(confpath, osmo_vty_cmd[cfi]) |
| 53 | |
| 54 | try: |
Holger Hans Peter Freyther | eb0acb6 | 2013-06-24 15:47:34 +0200 | [diff] [blame] | 55 | self.proc = osmoutil.popen_devnull(osmo_vty_cmd) |
| 56 | except OSError: |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 57 | print("Current directory: %s" % os.getcwd(), file=sys.stderr) |
| 58 | print("Consider setting -b", file=sys.stderr) |
Holger Hans Peter Freyther | eb0acb6 | 2013-06-24 15:47:34 +0200 | [diff] [blame] | 59 | |
| 60 | appstring = self.vty_app()[2] |
| 61 | appport = self.vty_app()[0] |
| 62 | self.vty = obscvty.VTYInteract(appstring, "127.0.0.1", appport) |
| 63 | |
| 64 | def tearDown(self): |
Neels Hofmeyr | 40a91b3 | 2017-02-24 17:54:22 +0100 | [diff] [blame] | 65 | if self.vty: |
| 66 | self.vty._close_socket() |
Holger Hans Peter Freyther | eb0acb6 | 2013-06-24 15:47:34 +0200 | [diff] [blame] | 67 | self.vty = None |
| 68 | osmoutil.end_proc(self.proc) |
| 69 | |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 70 | |
| 71 | class TestVTYGenericBSC(TestVTYBase): |
| 72 | |
Neels Hofmeyr | c29505e | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 73 | def _testConfigNetworkTree(self, include_bsc_items=True): |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 74 | self.vty.enable() |
| 75 | self.assertTrue(self.vty.verify("configure terminal",[''])) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 76 | self.assertEqual(self.vty.node(), 'config') |
Jacob Erlbeck | 6e919db | 2013-10-29 09:30:31 +0100 | [diff] [blame] | 77 | self.checkForEndAndExit() |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 78 | self.assertTrue(self.vty.verify("network",[''])) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 79 | self.assertEqual(self.vty.node(), 'config-net') |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 80 | self.checkForEndAndExit() |
| 81 | self.assertTrue(self.vty.verify("bts 0",[''])) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 82 | self.assertEqual(self.vty.node(), 'config-net-bts') |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 83 | self.checkForEndAndExit() |
| 84 | self.assertTrue(self.vty.verify("trx 0",[''])) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 85 | self.assertEqual(self.vty.node(), 'config-net-bts-trx') |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 86 | self.checkForEndAndExit() |
Jacob Erlbeck | 733bec8 | 2013-09-11 10:46:56 +0200 | [diff] [blame] | 87 | self.vty.command("write terminal") |
| 88 | self.assertTrue(self.vty.verify("exit",[''])) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 89 | self.assertEqual(self.vty.node(), 'config-net-bts') |
Jacob Erlbeck | 733bec8 | 2013-09-11 10:46:56 +0200 | [diff] [blame] | 90 | self.assertTrue(self.vty.verify("exit",[''])) |
| 91 | self.assertTrue(self.vty.verify("bts 1",[''])) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 92 | self.assertEqual(self.vty.node(), 'config-net-bts') |
Jacob Erlbeck | 733bec8 | 2013-09-11 10:46:56 +0200 | [diff] [blame] | 93 | self.checkForEndAndExit() |
| 94 | self.assertTrue(self.vty.verify("trx 1",[''])) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 95 | self.assertEqual(self.vty.node(), 'config-net-bts-trx') |
Jacob Erlbeck | 733bec8 | 2013-09-11 10:46:56 +0200 | [diff] [blame] | 96 | self.checkForEndAndExit() |
| 97 | self.vty.command("write terminal") |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 98 | self.assertTrue(self.vty.verify("exit",[''])) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 99 | self.assertEqual(self.vty.node(), 'config-net-bts') |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 100 | self.assertTrue(self.vty.verify("exit",[''])) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 101 | self.assertEqual(self.vty.node(), 'config-net') |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 102 | self.assertTrue(self.vty.verify("exit",[''])) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 103 | self.assertEqual(self.vty.node(), 'config') |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 104 | self.assertTrue(self.vty.verify("exit",[''])) |
| 105 | self.assertTrue(self.vty.node() is None) |
| 106 | |
Holger Hans Peter Freyther | 8657326 | 2015-01-31 09:47:37 +0100 | [diff] [blame] | 107 | |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 108 | class TestVTYBSC(TestVTYGenericBSC): |
Jacob Erlbeck | 1b89402 | 2013-08-28 10:16:54 +0200 | [diff] [blame] | 109 | |
| 110 | def vty_command(self): |
| 111 | return ["./src/osmo-bsc/osmo-bsc", "-c", |
| 112 | "doc/examples/osmo-bsc/osmo-bsc.cfg"] |
| 113 | |
| 114 | def vty_app(self): |
| 115 | return (4242, "./src/osmo-bsc/osmo-bsc", "OsmoBSC", "bsc") |
| 116 | |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 117 | def testConfigNetworkTree(self): |
Jacob Erlbeck | 7587727 | 2013-10-23 11:24:14 +0200 | [diff] [blame] | 118 | self._testConfigNetworkTree() |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 119 | |
| 120 | def testVtyTree(self): |
| 121 | self.vty.enable() |
| 122 | self.assertTrue(self.vty.verify("configure terminal", [''])) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 123 | self.assertEqual(self.vty.node(), 'config') |
Jacob Erlbeck | 6e919db | 2013-10-29 09:30:31 +0100 | [diff] [blame] | 124 | self.checkForEndAndExit() |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 125 | self.assertTrue(self.vty.verify("msc 0", [''])) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 126 | self.assertEqual(self.vty.node(), 'config-msc') |
Jacob Erlbeck | 0ae92a9 | 2013-09-02 13:17:16 +0200 | [diff] [blame] | 127 | self.checkForEndAndExit() |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 128 | self.assertTrue(self.vty.verify("exit", [''])) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 129 | self.assertEqual(self.vty.node(), 'config') |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 130 | self.assertTrue(self.vty.verify("bsc", [''])) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 131 | self.assertEqual(self.vty.node(), 'config-bsc') |
Jacob Erlbeck | 0ae92a9 | 2013-09-02 13:17:16 +0200 | [diff] [blame] | 132 | self.checkForEndAndExit() |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 133 | self.assertTrue(self.vty.verify("exit", [''])) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 134 | self.assertEqual(self.vty.node(), 'config') |
Jacob Erlbeck | 96903c4 | 2013-09-02 13:17:14 +0200 | [diff] [blame] | 135 | self.assertTrue(self.vty.verify("exit", [''])) |
| 136 | self.assertTrue(self.vty.node() is None) |
| 137 | |
Jacob Erlbeck | 946d141 | 2013-09-17 13:59:29 +0200 | [diff] [blame] | 138 | def testNetworkTimezone(self): |
| 139 | self.vty.enable() |
| 140 | self.vty.verify("configure terminal", ['']) |
| 141 | self.vty.verify("network", ['']) |
Jacob Erlbeck | 946d141 | 2013-09-17 13:59:29 +0200 | [diff] [blame] | 142 | |
| 143 | # Test invalid input |
| 144 | self.vty.verify("timezone", ['% Command incomplete.']) |
| 145 | self.vty.verify("timezone 20 0", ['% Unknown command.']) |
| 146 | self.vty.verify("timezone 0 11", ['% Unknown command.']) |
| 147 | self.vty.verify("timezone 0 0 99", ['% Unknown command.']) |
| 148 | |
| 149 | # Set time zone without DST |
| 150 | self.vty.verify("timezone 2 30", ['']) |
| 151 | |
| 152 | # Verify settings |
| 153 | res = self.vty.command("write terminal") |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 154 | self.assertTrue(res.find('timezone 2 30') > 0) |
| 155 | self.assertEqual(res.find('timezone 2 30 '), -1) |
Jacob Erlbeck | 946d141 | 2013-09-17 13:59:29 +0200 | [diff] [blame] | 156 | |
| 157 | # Set time zone with DST |
| 158 | self.vty.verify("timezone 2 30 1", ['']) |
| 159 | |
| 160 | # Verify settings |
| 161 | res = self.vty.command("write terminal") |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 162 | self.assertTrue(res.find('timezone 2 30 1') > 0) |
Jacob Erlbeck | 946d141 | 2013-09-17 13:59:29 +0200 | [diff] [blame] | 163 | |
| 164 | # Now disable it.. |
| 165 | self.vty.verify("no timezone", ['']) |
| 166 | |
| 167 | # Verify settings |
| 168 | res = self.vty.command("write terminal") |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 169 | self.assertEqual(res.find(' timezone'), -1) |
Jacob Erlbeck | 946d141 | 2013-09-17 13:59:29 +0200 | [diff] [blame] | 170 | |
Ciaby | ec6e4f8 | 2014-03-06 17:20:55 +0100 | [diff] [blame] | 171 | def testShowNetwork(self): |
| 172 | res = self.vty.command("show network") |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 173 | self.assertTrue(res.startswith('BSC is on Country Code') >= 0) |
Ciaby | ec6e4f8 | 2014-03-06 17:20:55 +0100 | [diff] [blame] | 174 | |
Max | 4936448 | 2016-04-13 11:36:39 +0200 | [diff] [blame] | 175 | |
Jacob Erlbeck | 1b89402 | 2013-08-28 10:16:54 +0200 | [diff] [blame] | 176 | def add_bsc_test(suite, workdir): |
| 177 | if not os.path.isfile(os.path.join(workdir, "src/osmo-bsc/osmo-bsc")): |
| 178 | print("Skipping the BSC test") |
| 179 | return |
| 180 | test = unittest.TestLoader().loadTestsFromTestCase(TestVTYBSC) |
| 181 | suite.addTest(test) |
| 182 | |
Holger Hans Peter Freyther | eb0acb6 | 2013-06-24 15:47:34 +0200 | [diff] [blame] | 183 | if __name__ == '__main__': |
| 184 | import argparse |
| 185 | import sys |
| 186 | |
| 187 | workdir = '.' |
| 188 | |
| 189 | parser = argparse.ArgumentParser() |
| 190 | parser.add_argument("-v", "--verbose", dest="verbose", |
| 191 | action="store_true", help="verbose mode") |
| 192 | parser.add_argument("-p", "--pythonconfpath", dest="p", |
| 193 | help="searchpath for config") |
| 194 | parser.add_argument("-w", "--workdir", dest="w", |
| 195 | help="Working directory") |
Neels Hofmeyr | 3f8a8f7 | 2017-02-28 02:43:29 +0100 | [diff] [blame] | 196 | parser.add_argument("test_name", nargs="*", help="(parts of) test names to run, case-insensitive") |
Holger Hans Peter Freyther | eb0acb6 | 2013-06-24 15:47:34 +0200 | [diff] [blame] | 197 | args = parser.parse_args() |
| 198 | |
| 199 | verbose_level = 1 |
| 200 | if args.verbose: |
| 201 | verbose_level = 2 |
| 202 | |
| 203 | if args.w: |
| 204 | workdir = args.w |
| 205 | |
| 206 | if args.p: |
| 207 | confpath = args.p |
| 208 | |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 209 | print("confpath %s, workdir %s" % (confpath, workdir)) |
Holger Hans Peter Freyther | eb0acb6 | 2013-06-24 15:47:34 +0200 | [diff] [blame] | 210 | os.chdir(workdir) |
Oliver Smith | e1f0844 | 2019-12-09 15:13:44 +0100 | [diff] [blame] | 211 | print("Running tests for specific VTY commands") |
Holger Hans Peter Freyther | eb0acb6 | 2013-06-24 15:47:34 +0200 | [diff] [blame] | 212 | suite = unittest.TestSuite() |
Jacob Erlbeck | 1b89402 | 2013-08-28 10:16:54 +0200 | [diff] [blame] | 213 | add_bsc_test(suite, workdir) |
Neels Hofmeyr | 3f8a8f7 | 2017-02-28 02:43:29 +0100 | [diff] [blame] | 214 | |
| 215 | if args.test_name: |
| 216 | osmoutil.pick_tests(suite, *args.test_name) |
| 217 | |
Neels Hofmeyr | 0a45c1e | 2016-09-28 23:48:02 +0200 | [diff] [blame] | 218 | res = unittest.TextTestRunner(verbosity=verbose_level, stream=sys.stdout).run(suite) |
Holger Hans Peter Freyther | eb0acb6 | 2013-06-24 15:47:34 +0200 | [diff] [blame] | 219 | sys.exit(len(res.errors) + len(res.failures)) |
Neels Hofmeyr | 23d37c9 | 2016-09-26 03:18:32 +0200 | [diff] [blame] | 220 | |
Neels Hofmeyr | 0867b72 | 2016-09-28 23:28:06 +0200 | [diff] [blame] | 221 | # vim: shiftwidth=4 expandtab nocin ai |