Finished networks and hosts

Author: Faustas

docs/host-mixin.md

@@ -0,0 +1,40 @@
+## About
+```python
+class HostManager():
+	"""
+	Functions for managing hosts. Intended to be used as a mixin for CloudManager.
+	"""
+```
+`HostManager` is a mixed into `CloudManager` and the following methods are available by
+
+```python
+manager = CloudManager("api-username", "password")
+manager.method()
+```
+
+## Methods
+
+```python
+def get_hosts(self):
+	"""
+	Returns a list of available hosts, along with basic statistics of them when available.
+	Returns a list of Host objects.
+	"""
+```
+
+```python
+def get_host(self, id):
+	"""
+	Returns detailed information about a specific host in a Host object.
+	Id argument must be passed (can be the id of a host or a Host object).
+	"""
+```
+
+```python
+def modify_host(self, host, description='new description'):
+	"""
+	Modifies description of a specific host.
+	Host argument must be provided (can be an id or a Host object).
+	Returns a Host object.
+	"""
+```

docs/network-mixin.md

@@ -0,0 +1,175 @@
+## About
+```python
+class NetworkManager():
+	"""
+	Functions for managing networks. Intended to be used as a mixin for CloudManager.
+	"""
+```
+`NetworkManager` is a mixed into `CloudManager` and the following methods are available by
+
+```python
+manager = CloudManager("api-username", "password")
+manager.method()
+```
+
+## Methods
+
+```python
+def get_networks(self, zone="fi-hel1"):
+	"""
+  Get a list of all networks.
+  Zone can be passed to return networks in a specific zone but is not mandatory.
+	"""
+```
+
+```python
+def get_network(self, uuid):
+	"""
+	Retrieves the details of a specific network.
+	"""
+```
+
+```python
+def create_network(
+        name='test network',
+        zone='fi-hel1',
+        address='172.16.0.0/22',
+        dhcp='yes',
+        family='IPv4',
+    ):
+	"""
+	Creates a new SDN private network that cloud servers from the same zone can be attached to.
+  Name, zone, address, dhcp and family arguments are required.
+  Router, dhcp_default_route, dhcp_dns, dhcp_bootfile_url and gateway arguments are optional.
+  Dhcp and dhcp_default_route accept yes or no (string) as a value.
+  Dhcp_dns accepts an array of addresses.
+  Returns a Network object.
+	"""
+```
+
+```python
+def modify_network(
+        network='036df3d0-8629-4549-984e-dc86fc3fa1b0',
+        dhcp='yes',
+        family='IPv4',
+        router='04b65749-61e2-4f08-a259-c75afbe81abf',
+    ):
+	"""
+	Modifies the details of a specific SDN private network. The Utility and public networks cannot be modified.
+  Network, dhcp, family and router arguments are required (router can be an id of a router or a router object, same goes for network).
+  Name, router, dhcp_default_route, dhcp_dns, dhcp_bootfile_url and gateway arguments are optional.
+  Dhcp and dhcp_default_route accept yes or no (string) as a value.
+  Dhcp_dns accepts an array of addresses.
+  Returns a Network object.
+	"""
+```
+
+```python
+def delete_network(self, network):
+	"""
+	Deletes an SDN private network. All attached cloud servers must first be detached before SDN private networks can be deleted.
+  Network argument must be provided (can be an id or a Network object).
+  Returns an empty response.
+	"""
+```
+
+```python
+def get_server_networks(self, server):
+	"""
+	List all networks the specific cloud server is connected to.
+  Server argument must be passed (can be an id or a Server object).
+  Returns a list of Interface objects.
+
+	"""
+```
+
+```python
+def create_network_interface(
+        server='0082c083-9847-4f9f-ae04-811251309b35',
+        network='036df3d0-8629-4549-984e-dc86fc3fa1b0',
+        type='private',
+        ip_addresses=[{'family': 'IPv4', 'address': '172.16.1.10'}]
+    ):
+	"""
+	Creates a new network interface on the specific cloud server and attaches the specified SDN private network to the new interface.
+  Server, network, type and ip_addresses arguments must be passed.
+  Index, source_ip_filtering and bootable arguments are optional.
+  Server and network arguments can be ids or objects.
+  Ip_addresses argument must be a list of dicts which contain family and address.
+  Index must be an integer.
+  Source_ip_filtering and bootable arguments accept a yes or a no string.
+  Returns an Interface object.
+	"""
+```
+
+```python
+def modify_network_interface(
+        server='0082c083-9847-4f9f-ae04-811251309b35',
+        index_in_path=7
+    ):
+	"""
+	Modifies the network interface at the selected index on the specific cloud server.
+  Server and index_in_path arguments are mandatory.
+  Index_in_body, ip_addresses, source_ip_filtering and bootable arguments are optional.
+  Server argument can be an id or an object.
+  Index arguments must be integers.
+  Ip_addresses argument must be a list of dicts which contain family and address.
+  Source_ip_filtering and bootable arguments accept a yes or a no string.
+  Returns an Interface object.
+	"""
+```
+
+```python
+def delete_network_interface(self, server, index):
+	"""
+  Detaches an SDN private network from a cloud server by deleting the network interface at the selected index on the specific cloud server.
+  Server and index arguments are mandatory.
+  Server argument can be an id or an object.
+  Index argument must be an integer.
+  Returns an empty response
+	"""
+```
+
+```python
+def get_routers(self):
+	"""
+  Returns a list of all available routers associated with the current account (list of Router objects).
+	"""
+```
+
+```python
+def get_router(self, uuid):
+	"""
+  Returns detailed information about a specific router (router object).
+  UUID argument is mandatory
+	"""
+```
+
+```python
+def create_router(self, name):
+	"""
+  Creates a new router.
+  Name is a mandatory argument.
+  Returns a Router object.
+	"""
+```
+
+```python
+def modify_router(self, router, name):
+	"""
+	Modify an existing router.
+	Router and name arguments are mandatory.
+  Router can be an id or a Router object.
+  Returns a Router object.
+	"""
+```
+
+```python
+def delete_router(self, router):
+	"""
+	Delete an existing router.
+  Router argument is mandatory.
+  Router can be an id or a Router object.
+  Returns a Router object.
+	"""
+```

test/json_data/server_0082c083-9847-4f9f-ae04-811251309b35_networking.json

@@ -0,0 +1,47 @@
+{
+  "networking":
+  {
+    "interfaces":
+    {
+      "interface":
+      [
+        {
+          "bootable": "no",
+          "index": 1,
+          "ip_addresses": {"ip_address": [{"address": "185.20.136.92", "family": "IPv4", "floating": "no"}]},
+          "mac": "da:4e:74:bd:2b:29",
+          "network": "03000000-0000-4000-8002-000000000000",
+          "source_ip_filtering": "yes",
+          "type": "public"
+        },
+        {
+          "bootable": "no",
+          "index": 2,
+          "ip_addresses": {"ip_address": [{"address": "10.1.6.245", "family": "IPv4", "floating": "no"}]},
+          "mac": "da:4e:74:bd:90:93",
+          "network": "03b34bc2-5adf-4fc4-8c44-83f869058f5a",
+          "source_ip_filtering": "yes",
+          "type": "utility"
+        },
+        {
+          "bootable": "no",
+          "index": 3,
+          "ip_addresses": {"ip_address": [{"address": "2a04:3540:1000:310:d84e:74ff:febd:0760", "family": "IPv6", "floating": "no"}]},
+          "mac": "da:4e:74:bd:07:60",
+          "network": "03000000-0000-4000-8015-000000000000",
+          "source_ip_filtering": "yes",
+          "type": "public"
+        },
+        {
+          "bootable": "yes",
+          "index": 7,
+          "ip_addresses": {"ip_address": [{"address": "172.16.1.10", "family": "IPv4", "floating": "no"}]},
+          "mac": "da:4e:74:bd:ce:18",
+          "network": "036df3d0-8629-4549-984e-dc86fc3fa1b0",
+          "source_ip_filtering": "yes",
+          "type": "private"
+        }
+      ]
+    }
+  }
+}

test/json_data/server_0082c083-9847-4f9f-ae04-811251309b35_networking_interface_7.json

@@ -0,0 +1,12 @@
+{
+  "interface":
+  {
+    "bootable": "no",
+    "index": 8,
+    "ip_addresses": {"ip_address": [{"address": "172.16.1.10", "family": "IPv4", "floating": "no"}]},
+    "mac": "da:4e:74:bd:ce:18",
+    "network": "036df3d0-8629-4549-984e-dc86fc3fa1b0",
+    "source_ip_filtering": "no",
+     "type": "private"
+   }
+ }

test/json_data/server_0082c083-9847-4f9f-ae04-811251309b35_networking_interface_post.json

@@ -0,0 +1,19 @@
+{
+  "interface":
+  {
+    "bootable": "yes",
+    "index": 7,
+    "ip_addresses":
+    {
+      "ip_address":
+      [
+        {
+          "address": "172.16.1.10",
+          "family": "IPv4",
+          "floating": "no"}]},
+          "mac": "da:4e:74:bd:ce:18",
+          "network": "036df3d0-8629-4549-984e-dc86fc3fa1b0",
+          "source_ip_filtering": "yes",
+          "type": "private"
+    }
+  }

test/test_network.py

@@ -28,7 +28,7 @@ def test_get_network(self, manager):
 
     @responses.activate
     def test_create_network(self, manager):
-        data = Mock.mock_post('network')
+        data = Mock.mock_post('network', ignore_data_field=True)
         network = manager.create_network(
             name='test network',
             zone='fi-hel1',
@@ -49,9 +49,9 @@ def test_create_network(self, manager):
 
     @responses.activate
     def test_modify_network(self, manager):
-        data = Mock.mock_put('network/036df3d0-8629-4549-984e-dc86fc3fa1b0')
+        data = Mock.mock_put('network/036df3d0-8629-4549-984e-dc86fc3fa1b0', ignore_data_field=True)
         network = manager.modify_network(
-            uuid='036df3d0-8629-4549-984e-dc86fc3fa1b0',
+            network='036df3d0-8629-4549-984e-dc86fc3fa1b0',
             dhcp='yes',
             family='IPv4',
             router='04b65749-61e2-4f08-a259-c75afbe81abf',
@@ -62,11 +62,54 @@ def test_modify_network(self, manager):
             gateway='172.16.0.1'
         )
 
-        assert type(network).__name__ == "test network modify"
+        assert type(network).__name__ == "Network"
+        assert network.name == 'test network modify'
         assert network.uuid == '036df3d0-8629-4549-984e-dc86fc3fa1b0'
         assert network.type == 'private'
         assert network.zone == 'fi-hel1'
 
+    @responses.activate
+    def test_get_server_networks(self, manager):
+        data = Mock.mock_get('server/0082c083-9847-4f9f-ae04-811251309b35/networking')
+        networks = manager.get_server_networks('0082c083-9847-4f9f-ae04-811251309b35')
+
+        for network in networks:
+            assert type(network).__name__ == "Interface"
+
+    @responses.activate
+    def test_create_network_interface(self, manager):
+        data = Mock.mock_post('server/0082c083-9847-4f9f-ae04-811251309b35/networking/interface', ignore_data_field=True)
+        network_interface = manager.create_network_interface(
+            server='0082c083-9847-4f9f-ae04-811251309b35',
+            network='036df3d0-8629-4549-984e-dc86fc3fa1b0',
+            type='private',
+            ip_addresses=[{'family': 'IPv4', 'address': '172.16.1.10'}],
+            index=7,
+            source_ip_filtering='yes',
+            bootable='yes'
+        )
+        assert type(network_interface).__name__=="Interface"
+
+    @responses.activate
+    def test_modify_network_interface(self, manager):
+        data = Mock.mock_put('server/0082c083-9847-4f9f-ae04-811251309b35/networking/interface/7', ignore_data_field=True)
+        network_interface = manager.modify_network_interface(
+            server='0082c083-9847-4f9f-ae04-811251309b35',
+            index_in_path=7,
+            index_in_body=8,
+            ip_addresses=[{'family': 'IPv4', 'address': '172.16.1.10'}],
+            source_ip_filtering='no',
+            bootable='no'
+        )
+        assert type(network_interface).__name__=="Interface"
+
+    @responses.activate
+    def test_delete_network_interface(self, manager):
+        data = Mock.mock_delete('server/0082c083-9847-4f9f-ae04-811251309b35/networking/interface/8')
+        res = manager.delete_network_interface('0082c083-9847-4f9f-ae04-811251309b35', 8)
+
+        assert res == {}
+
     @responses.activate
     def test_delete_network(sekf, manager):
         data = Mock.mock_delete('network/03000000-0000-4000-8001-000000000000')

upcloud_api/cloud_manager/host_mixin.py

@@ -21,17 +21,17 @@ def get_hosts(self):
 
     def get_host(self, id):
         """
-        Returns a list of available hosts, along with basic statistics of them when available.
+        Returns detailed information about a specific host.
         """
         url = '/host/{0}'.format(id)
         res = self.get_request(url)
         return Host(**res['host'])
 
-    def modify_host(self, id, description):
+    def modify_host(self, host, description):
         """
         Modifies description of a specific host.
         """
-        url = '/host/{0}'.format(id)
+        url = '/host/{0}'.format(host)
         body = {'host': {'description': description}}
         res = self.patch_request(url, body)
         return Host(**res['host'])