Merge "Begin low-level API for Network v2"

3 files changed, 259 insertions, 84 deletions

diff --git a/openstackclient/tests/api/test_network_v2.py b/openstackclient/tests/api/test_network_v2.py
new file mode 100644
index 00000000..13c5d6ea
--- /dev/null
+++ b/openstackclient/tests/api/test_network_v2.py
@@ -0,0 +1,52 @@
+#   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.
+#
+
+"""Network v2 API Library Tests"""
+
+from requests_mock.contrib import fixture
+
+from keystoneclient import session
+from openstackclient.api import network_v2 as network
+from openstackclient.tests import utils
+
+
+FAKE_PROJECT = 'xyzpdq'
+FAKE_URL = 'http://gopher.com/v2/' + FAKE_PROJECT
+
+
+class TestNetworkAPIv2(utils.TestCase):
+
+    def setUp(self):
+        super(TestNetworkAPIv2, self).setUp()
+        sess = session.Session()
+        self.api = network.APIv2(session=sess, endpoint=FAKE_URL)
+        self.requests_mock = self.useFixture(fixture.Fixture())
+
+
+class TestNetwork(TestNetworkAPIv2):
+
+    LIST_NETWORK_RESP = [
+        {'id': '1', 'name': 'p1', 'description': 'none', 'enabled': True},
+        {'id': '2', 'name': 'p2', 'description': 'none', 'enabled': False},
+        {'id': '3', 'name': 'p3', 'description': 'none', 'enabled': True},
+    ]
+
+    def test_network_list_no_options(self):
+        self.requests_mock.register_uri(
+            'GET',
+            FAKE_URL + '/networks',
+            json={'networks': self.LIST_NETWORK_RESP},
+            status_code=200,
+        )
+        ret = self.api.network_list()
+        self.assertEqual(self.LIST_NETWORK_RESP, ret)
diff --git a/openstackclient/tests/network/common.py b/openstackclient/tests/network/common.py
index 9c5a5ce9..7162f97b 100644
--- a/openstackclient/tests/network/common.py
+++ b/openstackclient/tests/network/common.py
@@ -14,16 +14,26 @@
 import argparse
 import mock
 
+from openstackclient.api import network_v2
 from openstackclient.tests import utils
 
 
+class FakeNetworkClient(object):
+    pass
+
+
 class TestNetworkBase(utils.TestCommand):
     def setUp(self):
         super(TestNetworkBase, self).setUp()
-        self.app = mock.Mock(name='app')
-        self.app.client_manager = mock.Mock(name='client_manager')
         self.namespace = argparse.Namespace()
 
+        self.app.client_manager.network = FakeNetworkClient()
+        self.app.client_manager.network.api = network_v2.APIv2(
+            session=mock.Mock(),
+            service_type="network",
+        )
+        self.api = self.app.client_manager.network.api
+
     given_show_options = [
         '-f',
         'shell',
diff --git a/openstackclient/tests/network/v2/test_network.py b/openstackclient/tests/network/v2/test_network.py
index b893229f..e14dd88b 100644
--- a/openstackclient/tests/network/v2/test_network.py
+++ b/openstackclient/tests/network/v2/test_network.py
@@ -22,16 +22,38 @@ RESOURCE = 'network'
 RESOURCES = 'networks'
 FAKE_ID = 'iditty'
 FAKE_NAME = 'noo'
+FAKE_PROJECT = 'yaa'
 RECORD = {
     'id': FAKE_ID,
     'name': FAKE_NAME,
+    'admin_state_up': True,
     'router:external': True,
+    'status': 'ACTIVE',
     'subnets': ['a', 'b'],
+    'tenant_id': FAKE_PROJECT,
 }
-COLUMNS = ['id', 'name', 'subnets']
-RESPONSE = {RESOURCE: RECORD}
-FILTERED = [('id', 'name', 'router:external', 'subnets'),
-            (FAKE_ID, FAKE_NAME, True, 'a, b')]
+COLUMNS = ['ID', 'Name', 'Subnets']
+RESPONSE = {RESOURCE: copy.deepcopy(RECORD)}
+FILTERED = [
+    (
+        'id',
+        'name',
+        'project_id',
+        'router_type',
+        'state',
+        'status',
+        'subnets',
+    ),
+    (
+        FAKE_ID,
+        FAKE_NAME,
+        FAKE_PROJECT,
+        'External',
+        'UP',
+        'ACTIVE',
+        'a, b',
+    ),
+]
 
 
 class TestCreateNetwork(common.TestNetworkBase):
@@ -122,7 +144,7 @@ class TestDeleteNetwork(common.TestNetworkBase):
         verifylist = [
             ('networks', [FAKE_NAME]),
         ]
-        lister = mock.Mock(return_value={RESOURCES: [RECORD]})
+        lister = mock.Mock(return_value={RESOURCES: [copy.deepcopy(RECORD)]})
         self.app.client_manager.network.list_networks = lister
         mocker = mock.Mock(return_value=None)
         self.app.client_manager.network.delete_network = mocker
@@ -135,85 +157,170 @@ class TestDeleteNetwork(common.TestNetworkBase):
         self.assertEqual(None, result)
 
 
+@mock.patch(
+    'openstackclient.api.network_v2.APIv2.network_list'
+)
 class TestListNetwork(common.TestNetworkBase):
-    def test_list_no_options(self):
+
+    def setUp(self):
+        super(TestListNetwork, self).setUp()
+
+        # Get the command object to test
+        self.cmd = network.ListNetwork(self.app, self.namespace)
+
+        self.NETWORK_LIST = [
+            copy.deepcopy(RECORD),
+            copy.deepcopy(RECORD),
+        ]
+
+    def test_network_list_no_options(self, n_mock):
+        n_mock.return_value = self.NETWORK_LIST
+
         arglist = []
         verifylist = [
+            ('external', False),
+            ('dhcp', None),
             ('long', False),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        # DisplayCommandBase.take_action() returns two tuples
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Set expected values
+        n_mock.assert_called_with(
+            external=False,
+        )
+
+        self.assertEqual(tuple(COLUMNS), columns)
+        datalist = [
+            (FAKE_ID, FAKE_NAME, 'a, b'),
+            (FAKE_ID, FAKE_NAME, 'a, b'),
+        ]
+        self.assertEqual(datalist, list(data))
+
+    def test_list_external(self, n_mock):
+        n_mock.return_value = self.NETWORK_LIST
+
+        arglist = [
+            '--external',
+        ]
+        verifylist = [
+            ('external', True),
             ('dhcp', None),
-            ('external', False),
+            ('long', False),
         ]
-        lister = mock.Mock(return_value={RESOURCES: [RECORD]})
-        self.app.client_manager.network.list_networks = lister
-        cmd = network.ListNetwork(self.app, self.namespace)
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
-        parsed_args = self.check_parser(cmd, arglist, verifylist)
-        result = cmd.take_action(parsed_args)
+        # DisplayCommandBase.take_action() returns two tuples
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Set expected values
+        n_mock.assert_called_with(
+            external=True,
+        )
 
-        lister.assert_called_with()
-        self.assertEqual(COLUMNS, result[0])
-        self.assertEqual((FAKE_ID, FAKE_NAME, 'a, b'), next(result[1]))
-        self.assertRaises(StopIteration, next, result[1])
+        self.assertEqual(tuple(COLUMNS), columns)
+        datalist = [
+            (FAKE_ID, FAKE_NAME, 'a, b'),
+            (FAKE_ID, FAKE_NAME, 'a, b'),
+        ]
+        self.assertEqual(datalist, list(data))
+
+    def test_network_list_long(self, n_mock):
+        n_mock.return_value = self.NETWORK_LIST
 
-    def test_list_long(self):
-        arglist = ['--long']
+        arglist = [
+            '--long',
+        ]
         verifylist = [
             ('long', True),
             ('dhcp', None),
             ('external', False),
         ]
-        lister = mock.Mock(return_value={RESOURCES: [RECORD]})
-        self.app.client_manager.network.list_networks = lister
-        cmd = network.ListNetwork(self.app, self.namespace)
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        # DisplayCommandBase.take_action() returns two tuples
+        columns, data = self.cmd.take_action(parsed_args)
+
+        # Set expected values
+        n_mock.assert_called_with(
+            external=False,
+        )
+
+        collist = (
+            'ID',
+            'Name',
+            'Status',
+            'Project',
+            'State',
+            'Shared',
+            'Subnets',
+            'Network Type',
+            'Router Type',
+        )
+        self.assertEqual(columns, collist)
+        dataitem = (
+            FAKE_ID,
+            FAKE_NAME,
+            'ACTIVE',
+            FAKE_PROJECT,
+            'UP',
+            '',
+            'a, b',
+            '',
+            'External',
+        )
+        datalist = [
+            dataitem,
+            dataitem,
+        ]
+        self.assertEqual(list(data), datalist)
 
-        parsed_args = self.check_parser(cmd, arglist, verifylist)
-        result = cmd.take_action(parsed_args)
 
-        lister.assert_called_with()
-        headings = ['id', 'name', 'router:external', 'subnets']
-        self.assertEqual(headings, result[0])
-        data = (FAKE_ID, FAKE_NAME, True, 'a, b')
-        self.assertEqual(data, next(result[1]))
-        self.assertRaises(StopIteration, next, result[1])
+@mock.patch(
+    'openstackclient.api.network_v2.APIv2.dhcp_agent_list'
+)
+class TestListDhcpAgent(common.TestNetworkBase):
+
+    def setUp(self):
+        super(TestListDhcpAgent, self).setUp()
+
+        # Get the command object to test
+        self.cmd = network.ListNetwork(self.app, self.namespace)
+
+        self.DHCP_LIST = [
+            {'id': '1'},
+            {'id': '2'},
+        ]
+
+    def test_list_dhcp(self, n_mock):
+        n_mock.return_value = self.DHCP_LIST
 
-    def test_list_dhcp(self):
         arglist = [
-            '--dhcp',
-            'dhcpid',
-        ] + self.given_list_options
+            '--dhcp', 'dhcpid',
+        ]
         verifylist = [
+            ('external', False),
             ('dhcp', 'dhcpid'),
-        ] + self.then_list_options
-        fake_dhcp_data = [{'id': '1'}, {'id': '2'}]
-        fake_dhcp_response = {'networks_on_dhcp_agent': fake_dhcp_data}
-        lister = mock.Mock(return_value=fake_dhcp_response)
-        netty = self.app.client_manager.network
-        netty.list_networks_on_dhcp_agent = lister
-        cmd = network.ListNetwork(self.app, self.namespace)
-
-        parsed_args = self.check_parser(cmd, arglist, verifylist)
-        result = cmd.take_action(parsed_args)
-
-        lister.assert_called_with(dhcp_agent='dhcpid')
-        self.assertEqual(['id'], result[0])
-        self.assertEqual(('1',), next(result[1]))
-        self.assertEqual(('2',), next(result[1]))
-        self.assertRaises(StopIteration, next, result[1])
+            ('long', False),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
-    def test_list_external(self):
-        arglist = ['--external', '-c', 'id']
-        verifylist = [('external', True)]
-        lister = mock.Mock(return_value={RESOURCES: [RECORD]})
-        self.app.client_manager.network.list_networks = lister
-        cmd = network.ListNetwork(self.app, self.namespace)
+        # DisplayCommandBase.take_action() returns two tuples
+        columns, data = self.cmd.take_action(parsed_args)
 
-        parsed_args = self.check_parser(cmd, arglist, verifylist)
-        result = cmd.take_action(parsed_args)
+        # Set expected values
+        n_mock.assert_called_with(
+            dhcp_id='dhcpid',
+        )
 
-        lister.assert_called_with(**{'router:external': True})
-        self.assertEqual(['id'], result[0])
-        self.assertEqual((FAKE_ID,), next(result[1]))
-        self.assertRaises(StopIteration, next, result[1])
+        self.assertEqual(('ID',), columns)
+        datalist = [
+            ('1',),
+            ('2',),
+        ]
+        self.assertEqual(datalist, list(data))
 
 
 class TestSetNetwork(common.TestNetworkBase):
@@ -230,7 +337,7 @@ class TestSetNetwork(common.TestNetworkBase):
             ('name', 'noob'),
             ('shared', True),
         ]
-        lister = mock.Mock(return_value={RESOURCES: [RECORD]})
+        lister = mock.Mock(return_value={RESOURCES: [copy.deepcopy(RECORD)]})
         self.app.client_manager.network.list_networks = lister
         mocker = mock.Mock(return_value=None)
         self.app.client_manager.network.update_network = mocker
@@ -255,7 +362,7 @@ class TestSetNetwork(common.TestNetworkBase):
             ('admin_state', False),
             ('shared', False),
         ]
-        lister = mock.Mock(return_value={RESOURCES: [RECORD]})
+        lister = mock.Mock(return_value={RESOURCES: [copy.deepcopy(RECORD)]})
         self.app.client_manager.network.list_networks = lister
         mocker = mock.Mock(return_value=None)
         self.app.client_manager.network.update_network = mocker
@@ -272,7 +379,7 @@ class TestSetNetwork(common.TestNetworkBase):
     def test_set_nothing(self):
         arglist = [FAKE_NAME, ]
         verifylist = [('identifier', FAKE_NAME), ]
-        lister = mock.Mock(return_value={RESOURCES: [RECORD]})
+        lister = mock.Mock(return_value={RESOURCES: [copy.deepcopy(RECORD)]})
         self.app.client_manager.network.list_networks = lister
         mocker = mock.Mock(return_value=None)
         self.app.client_manager.network.update_network = mocker
@@ -283,37 +390,43 @@ class TestSetNetwork(common.TestNetworkBase):
                           parsed_args)
 
 
+@mock.patch(
+    'openstackclient.api.network_v2.APIv2.find_attr'
+)
 class TestShowNetwork(common.TestNetworkBase):
-    def test_show_no_options(self):
+
+    def setUp(self):
+        super(TestShowNetwork, self).setUp()
+
+        # Get the command object to test
+        self.cmd = network.ShowNetwork(self.app, self.namespace)
+
+        self.NETWORK_ITEM = copy.deepcopy(RECORD)
+
+    def test_show_no_options(self, n_mock):
         arglist = [
             FAKE_NAME,
         ]
         verifylist = [
             ('identifier', FAKE_NAME),
         ]
-        lister = mock.Mock(return_value={RESOURCES: [RECORD]})
-        self.app.client_manager.network.list_networks = lister
-        mocker = mock.Mock(return_value=copy.deepcopy(RESPONSE))
-        self.app.client_manager.network.show_network = mocker
-        cmd = network.ShowNetwork(self.app, self.namespace)
+        n_mock.return_value = copy.deepcopy(RECORD)
+        self.cmd = network.ShowNetwork(self.app, self.namespace)
 
-        parsed_args = self.check_parser(cmd, arglist, verifylist)
-        result = list(cmd.take_action(parsed_args))
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        result = list(self.cmd.take_action(parsed_args))
 
-        mocker.assert_called_with(FAKE_ID)
+        n_mock.assert_called_with('networks', FAKE_NAME)
         self.assertEqual(FILTERED, result)
 
-    def test_show_all_options(self):
+    def test_show_all_options(self, n_mock):
         arglist = [FAKE_NAME] + self.given_show_options
         verifylist = [('identifier', FAKE_NAME)] + self.then_show_options
-        lister = mock.Mock(return_value={RESOURCES: [RECORD]})
-        self.app.client_manager.network.list_networks = lister
-        mocker = mock.Mock(return_value=copy.deepcopy(RESPONSE))
-        self.app.client_manager.network.show_network = mocker
-        cmd = network.ShowNetwork(self.app, self.namespace)
+        n_mock.return_value = copy.deepcopy(RECORD)
+        self.cmd = network.ShowNetwork(self.app, self.namespace)
 
-        parsed_args = self.check_parser(cmd, arglist, verifylist)
-        result = list(cmd.take_action(parsed_args))
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        result = list(self.cmd.take_action(parsed_args))
 
-        mocker.assert_called_with(FAKE_ID)
+        n_mock.assert_called_with('networks', FAKE_NAME)
         self.assertEqual(FILTERED, result)