Add phpypam.api as fixture for most tests

Move api connection to function definition in `conftest.py` to provide
it as a fixture for most tests. The fixture is module scoped.

Author: cmeissner

tests/conftest.py

@@ -1,12 +1,41 @@
 """Provide some base configurations for tests."""
 import inspect
+import phpypam
 import pytest
 import py.path
 import re
+import yaml
+
 from urllib.parse import urlparse, urlunparse
 
 TEST_CASES_PATH = py.path.local(__file__).realpath() / '..' / 'test_cases'
 
+with open('tests/vars/server.yml') as c:
+    server = yaml.safe_load(c)
+
+
+@pytest.fixture(scope='module')
+def pi(*arg, **kwargs):
+    """Create a phpypam.api object and return it.
+
+    :return: object phpypam
+    :rtype: phpypam.api
+    """
+    url = kwargs.pop('url', server['url'])
+    app_id = kwargs.pop('app_id', server['app_id'])
+    username = kwargs.pop('username', server['username'])
+    password = kwargs.pop('password', server['password'])
+    ssl_verify = kwargs.pop('ssl_verify', True)
+
+    return phpypam.api(
+        url=url,
+        app_id=app_id,
+        username=username,
+        password=password,
+        ssl_verify=ssl_verify,
+        **kwargs
+    )
+
 
 def find_all_test_cases():
     """Generate list of test cases.

tests/test_cases/controllers.py

@@ -1,30 +1,16 @@
 """Test controller method."""
-import phpypam
 import pytest
 import vcr
-import yaml
 
 from tests.conftest import filter_request_uri, filter_response, cassette_name, FILTER_REQUEST_HEADERS, FILTER_RESPONSE_HEADERS
 
 
-with open('tests/vars/server.yml') as c:
-    server = yaml.safe_load(c)
-
-
 @vcr.use_cassette(cassette_name('test_controllers'),
                   filter_headers=FILTER_REQUEST_HEADERS,
                   before_record_request=filter_request_uri,
                   before_recorde_response=filter_response
                   )
-def test_controllers():
+def test_controllers(pi):
     """Test if controllers method returns correct datatype."""
-    pi = phpypam.api(
-        url=server['url'],
-        app_id=server['app_id'],
-        username=server['username'],
-        password=server['password'],
-        ssl_verify=True
-    )
-
     controllers = pi.controllers()
     assert isinstance(controllers, set)

tests/test_cases/ensure_nameserver.py

@@ -11,14 +11,6 @@
 from phpypam import PHPyPAMEntityNotFoundException
 
 
-pi = phpypam.api(
-    url=server['url'],
-    app_id=server['app_id'],
-    username=server['username'],
-    password=server['password'],
-    ssl_verify=True
-)
-
 my_nameserver = dict(
     name='my dns',
     namesrv1='127.0.01',
@@ -31,7 +23,7 @@
                   before_record_request=filter_request_uri,
                   before_recorde_response=filter_response
                   )
-def test_create_nameserver():
+def test_create_nameserver(pi):
     """Test to create a new nameserver.
 
     Create a nameserver if it doesn't exists
@@ -50,7 +42,7 @@ def test_create_nameserver():
                   before_record_request=filter_request_uri,
                   before_recorde_response=filter_response
                   )
-def test_update_nameserver():
+def test_update_nameserver(pi):
     """Test to update an existing nameserver.
 
     Update one field of an existing nameserver
@@ -70,7 +62,7 @@ def test_update_nameserver():
                   before_record_request=filter_request_uri,
                   before_recorde_response=filter_response
                   )
-def test_delete_nameserver():
+def test_delete_nameserver(pi):
     """Test to delete an existing nameserver.
 
     Delete the nameserver which we created before

tests/test_cases/ensure_section.py

@@ -11,14 +11,6 @@
 with open('tests/vars/server.yml') as c:
     server = yaml.safe_load(c)
 
-pi = phpypam.api(
-    url=server['url'],
-    app_id=server['app_id'],
-    username=server['username'],
-    password=server['password'],
-    ssl_verify=True
-)
-
 my_section = dict(
     name='foobar',
     description='new section',
@@ -31,7 +23,7 @@
                   before_record_request=filter_request_uri,
                   before_recorde_response=filter_response
                   )
-def test_create_section():
+def test_create_section(pi):
     """Test to create a new section.
 
     Create a section if it doesn't exists
@@ -51,7 +43,7 @@ def test_create_section():
                   before_record_request=filter_request_uri,
                   before_recorde_response=filter_response
                   )
-def test_update_section():
+def test_update_section(pi):
     """Test to update an existing section.
 
     Update one field of an existing section.
@@ -70,7 +62,7 @@ def test_update_section():
                   before_record_request=filter_request_uri,
                   before_recorde_response=filter_response
                   )
-def test_delete_section():
+def test_delete_section(pi):
     """Test to delete an existing section.
 
     Delete one field of an existing section.

tests/test_cases/ensure_vlan.py

@@ -11,14 +11,6 @@
 with open('tests/vars/server.yml') as c:
     server = yaml.safe_load(c)
 
-pi = phpypam.api(
-    url=server['url'],
-    app_id=server['app_id'],
-    username=server['username'],
-    password=server['password'],
-    ssl_verify=True
-)
-
 my_vlan = dict(
     name='my vlan',
     number='1337',
@@ -30,7 +22,7 @@
                   before_record_request=filter_request_uri,
                   before_recorde_response=filter_response
                   )
-def test_create_vlan():
+def test_create_vlan(pi):
     """Test to create a new vlan.
 
     Create a vlan if it doesn't exists
@@ -49,7 +41,7 @@ def test_create_vlan():
                   before_record_request=filter_request_uri,
                   before_recorde_response=filter_response
                   )
-def test_update_vlan():
+def test_update_vlan(pi):
     """Test to update an existing vlan.
 
     Update one field of an existing vlan
@@ -72,7 +64,7 @@ def test_update_vlan():
                   before_record_request=filter_request_uri,
                   before_recorde_response=filter_response
                   )
-def test_delete_vlan():
+def test_delete_vlan(pi):
     """Test to delete an existing vlan.
 
     Delete vlan which we created before

tests/test_cases/search_address.py

@@ -17,18 +17,9 @@
                   before_record_request=filter_request_uri,
                   before_recorde_response=filter_response
                   )
-def test_address_not_found():
+def test_address_not_found(pi):
     """Test address not found execption."""
-    pi = phpypam.api(
-        url=server['url'],
-        app_id=server['app_id'],
-        username=server['username'],
-        password=server['password'],
-        ssl_verify=True
-    )
-
     addr = '10.10.0.4'
-
     search_kwargs = dict(controller='addresses', controller_path='search/' + addr)
 
     pytest.raises(PHPyPAMEntityNotFoundException, pi.get_entity, **search_kwargs)

tests/test_cases/search_section_by_name.py

@@ -11,21 +11,13 @@
 with open('tests/vars/server.yml') as c:
     server = yaml.safe_load(c)
 
-pi = phpypam.api(
-    url=server['url'],
-    app_id=server['app_id'],
-    username=server['username'],
-    password=server['password'],
-    ssl_verify=True
-)
-
 
 @vcr.use_cassette(cassette_name('test_search_not_existing_section'),
                   filter_headers=FILTER_REQUEST_HEADERS,
                   before_record_request=filter_request_uri,
                   before_recorde_response=filter_response
                   )
-def test_search_not_existing_section():
+def test_search_not_existing_section(pi):
     """Search for non existing section.
 
     Search for a non existign section and get NotFound exception
@@ -40,7 +32,7 @@ def test_search_not_existing_section():
                   before_record_request=filter_request_uri,
                   before_recorde_response=filter_response
                   )
-def test_search_existing_section():
+def test_search_existing_section(pi):
     """Search for existing section.
 
     Search for an existing section

tests/test_cases/search_subnet.py

@@ -17,18 +17,9 @@
                   before_record_request=filter_request_uri,
                   before_recorde_response=filter_response
                   )
-def test_subnet_not_found():
+def test_subnet_not_found(pi):
     """Test subnet not found exeption."""
-    pi = phpypam.api(
-        url=server['url'],
-        app_id=server['app_id'],
-        username=server['username'],
-        password=server['password'],
-        ssl_verify=True
-    )
-
     cidr = '10.0.0.0/24'
-
     search_kwargs = dict(controller='subnets', controller_path='cidr/' + cidr)
 
     pytest.raises(PHPyPAMEntityNotFoundException, pi.get_entity, **search_kwargs)