Skip to content

slapos
slapos
Commit dc62d8e4 authored by Jérome Perrin's avatar Jérome Perrin
Browse files
Options

test/*/utils.py: use same code everywhere 

In preparation for moving this to a better place, use the same code in
all the places where this code was duplicated.

Reconcile all implementations, document a little bit more the methods
and the future plans.
parent 90b10c1b
Hide whitespace changes
Inline Side-by-side
Showing with 525 additions and 223 deletions
software/caddy-frontend/test/utils.py
View file @ dc62d8e4
...@@ -28,35 +28,17 @@ ...@@ -28,35 +28,17 @@
import unittest import unittest
import os import os
import socket import socket
import subprocess
from contextlib import closing from contextlib import closing
import logging import logging
import StringIO import StringIO
import json
from BaseHTTPServer import HTTPServer
from BaseHTTPServer import BaseHTTPRequestHandler
import xmlrpclib import xmlrpclib
import supervisor.xmlrpc
import supervisor.xmlrpc
from erp5.util.testnode.SlapOSControler import SlapOSControler from erp5.util.testnode.SlapOSControler import SlapOSControler
from erp5.util.testnode.ProcessManager import ProcessManager from erp5.util.testnode.ProcessManager import ProcessManager
LOCAL_IPV4 = os.environ['LOCAL_IPV4'] # Utility functions
GLOBAL_IPV6 = os.environ['GLOBAL_IPV6']
def der2pem(der):
certificate, error = subprocess.Popen(
'openssl x509 -inform der'.split(), stdin=subprocess.PIPE,
stdout=subprocess.PIPE, stderr=subprocess.PIPE
).communicate(der)
if error:
raise ValueError(error)
return certificate
def findFreeTCPPort(ip=''): def findFreeTCPPort(ip=''):
"""Find a free TCP port to listen to. """Find a free TCP port to listen to.
""" """
...@@ -66,7 +48,57 @@ def findFreeTCPPort(ip=''): ...@@ -66,7 +48,57 @@ def findFreeTCPPort(ip=''):
return s.getsockname()[1] return s.getsockname()[1]
# TODO:
# - allow requesting multiple instances ?
class SlapOSInstanceTestCase(unittest.TestCase): class SlapOSInstanceTestCase(unittest.TestCase):
"""Install one slapos instance.
This test case install software(s) and request one instance during `setUpClass`
and destroy the instance during `tearDownClass`.
Software Release URL, Instance Software Type and Instance Parameters can be defined
on the class.
All tests from the test class will run with the same instance.
The following class attributes are available:
* `computer_partition`: the computer partition instance, implementing
`slapos.slap.interface.slap.IComputerPartition`.
* `computer_partition_root_path`: the path of the instance root directory.
"""
# Methods to be defined by subclasses.
@classmethod
def getSoftwareURLList(cls):
"""Return URL of software releases to install.
To be defined by subclasses.
"""
raise NotImplementedError()
@classmethod
def getInstanceParameterDict(cls):
"""Return instance parameters
To be defined by subclasses if they need to request instance with specific
parameters.
"""
return {}
@classmethod
def getInstanceSoftwareType(cls):
"""Return software type for instance, default "default"
To be defined by subclasses if they need to request instance with specific
software type.
"""
return "default"
# Utility methods.
def getSupervisorRPCServer(self): def getSupervisorRPCServer(self):
"""Returns a XML-RPC connection to the supervisor used by slapos node """Returns a XML-RPC connection to the supervisor used by slapos node
...@@ -79,30 +111,52 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -79,30 +111,52 @@ class SlapOSInstanceTestCase(unittest.TestCase):
None, None,
None, None,
# XXX hardcoded socket path # XXX hardcoded socket path
serverurl="unix://{working_directory}/inst/supervisord.socket" serverurl="unix://{working_directory}/inst/supervisord.socket".format(
.format(**self.config))) **self.config)))
# Unittest methods
@classmethod @classmethod
def getSoftwareURLList(cls): def setUpClass(cls):
"""Return URL of software releases to install. """Setup the class, build software and request an instance.
To be defined by subclasses. If you have to override this method, do not forget to call this method on
parent class.
""" """
return [os.path.realpath(os.environ['TEST_SR'])] try:
cls.setUpWorkingDirectory()
cls.setUpConfig()
cls.setUpSlapOSController()
@classmethod cls.runSoftwareRelease()
def getInstanceParameterDict(cls): # XXX instead of "runSoftwareRelease", it would be better to be closer to slapos usage:
"""Return instance parameters # cls.supplySoftwares()
# cls.installSoftwares()
To be defined by subclasses if they need to request instance with specific cls.runComputerPartition()
parameters. # XXX instead of "runComputerPartition", it would be better to be closer to slapos usage:
# cls.requestInstances()
# cls.createInstances()
# cls.requestInstances()
except Exception:
cls.stopSlapOSProcesses()
raise
@classmethod
def tearDownClass(cls):
"""Tear down class, stop the processes and destroy instance.
""" """
return {} cls.stopSlapOSProcesses()
# TODO: allow subclasses to request a specific software type ? # Implementation
@classmethod
def stopSlapOSProcesses(cls):
if hasattr(cls, '_process_manager'):
cls._process_manager.killPreviousRun()
@classmethod @classmethod
def setUpWorkingDirectory(cls): def setUpWorkingDirectory(cls):
"""Initialise the directories"""
cls.working_directory = os.environ.get( cls.working_directory = os.environ.get(
'SLAPOS_TEST_WORKING_DIR', 'SLAPOS_TEST_WORKING_DIR',
os.path.join(os.path.dirname(__file__), '.slapos')) os.path.join(os.path.dirname(__file__), '.slapos'))
...@@ -110,16 +164,18 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -110,16 +164,18 @@ class SlapOSInstanceTestCase(unittest.TestCase):
# AF_UNIX path too long This `working_directory` should not be too deep. # AF_UNIX path too long This `working_directory` should not be too deep.
# Socket path is 108 char max on linux # Socket path is 108 char max on linux
# https://github.com/torvalds/linux/blob/3848ec5/net/unix/af_unix.c#L234-L238 # https://github.com/torvalds/linux/blob/3848ec5/net/unix/af_unix.c#L234-L238
# Supervisord socket name contains the pid number, which is why we add
# .xxxxxxx in this check.
if len(cls.working_directory + '/inst/supervisord.socket.xxxxxxx') > 108: if len(cls.working_directory + '/inst/supervisord.socket.xxxxxxx') > 108:
raise RuntimeError( raise RuntimeError('working directory ( {} ) is too deep, try setting '
'working directory ( {} ) is too deep, try setting ' 'SLAPOS_TEST_WORKING_DIR'.format(cls.working_directory))
'SLAPOS_TEST_WORKING_DIR'.format(cls.working_directory))
if not os.path.exists(cls.working_directory): if not os.path.exists(cls.working_directory):
os.mkdir(cls.working_directory) os.mkdir(cls.working_directory)
@classmethod @classmethod
def setUpConfig(cls): def setUpConfig(cls):
"""Create slapos configuration"""
cls.config = { cls.config = {
"working_directory": cls.working_directory, "working_directory": cls.working_directory,
"slapos_directory": cls.working_directory, "slapos_directory": cls.working_directory,
...@@ -130,7 +186,8 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -130,7 +186,8 @@ class SlapOSInstanceTestCase(unittest.TestCase):
# "proper" slapos command must be in $PATH # "proper" slapos command must be in $PATH
'slapos_binary': 'slapos', 'slapos_binary': 'slapos',
} }
ipv4_address = LOCAL_IPV4 # Some tests are expecting that local IP is not set to 127.0.0.1
ipv4_address = os.environ.get('LOCAL_IPV4', '127.0.1.1')
ipv6_address = os.environ['GLOBAL_IPV6'] ipv6_address = os.environ['GLOBAL_IPV6']
cls.config['proxy_host'] = cls.config['ipv4_address'] = ipv4_address cls.config['proxy_host'] = cls.config['ipv4_address'] = ipv4_address
...@@ -141,6 +198,15 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -141,6 +198,15 @@ class SlapOSInstanceTestCase(unittest.TestCase):
@classmethod @classmethod
def setUpSlapOSController(cls): def setUpSlapOSController(cls):
"""Create the a "slapos controller" and supply softwares from `getSoftwareURLList`.
This is equivalent to:
slapos proxy start
for sr in getSoftwareURLList; do
slapos supply $SR $COMP
done
"""
cls._process_manager = ProcessManager() cls._process_manager = ProcessManager()
# XXX this code is copied from testnode code # XXX this code is copied from testnode code
...@@ -160,12 +226,21 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -160,12 +226,21 @@ class SlapOSInstanceTestCase(unittest.TestCase):
reset_software=False, reset_software=False,
software_path_list=cls.software_url_list) software_path_list=cls.software_url_list)
# XXX we should check *earlier* if that pidfile exist and if supervisord
# process still running, because if developer started supervisord (or bugs?)
# then another supervisord will start and starting services a second time
# will fail.
cls._process_manager.supervisord_pid_file = os.path.join( cls._process_manager.supervisord_pid_file = os.path.join(
cls.slapos_controler.instance_root, 'var', 'run', 'supervisord.pid') cls.slapos_controler.instance_root, 'var', 'run', 'supervisord.pid')
@classmethod @classmethod
def runSoftwareRelease(cls): def runSoftwareRelease(cls):
"""Run all the software releases that were supplied before.
This is the equivalent of `slapos node software`.
The tests will be marked file if software building fail.
"""
logger = logging.getLogger() logger = logging.getLogger()
logger.level = logging.DEBUG logger.level = logging.DEBUG
stream = StringIO.StringIO() stream = StringIO.StringIO()
...@@ -183,14 +258,29 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -183,14 +258,29 @@ class SlapOSInstanceTestCase(unittest.TestCase):
logger.removeHandler(stream_handler) logger.removeHandler(stream_handler)
del stream del stream
@classmethod @classmethod
def runComputerPartition(cls): def runComputerPartition(cls):
"""Instanciate the software.
This is the equivalent of doing:
slapos request --type=getInstanceSoftwareType --parameters=getInstanceParameterDict
slapos node instance
and return the slapos request instance parameters.
This can be called by tests to simulate re-request with different parameters.
"""
logger = logging.getLogger() logger = logging.getLogger()
logger.level = logging.DEBUG logger.level = logging.DEBUG
stream = StringIO.StringIO() stream = StringIO.StringIO()
stream_handler = logging.StreamHandler(stream) stream_handler = logging.StreamHandler(stream)
logger.addHandler(stream_handler) logger.addHandler(stream_handler)
if cls.getInstanceSoftwareType() != 'default':
raise NotImplementedError
instance_parameter_dict = cls.getInstanceParameterDict() instance_parameter_dict = cls.getInstanceParameterDict()
try: try:
cls.instance_status_dict = cls.slapos_controler.runComputerPartition( cls.instance_status_dict = cls.slapos_controler.runComputerPartition(
...@@ -221,53 +311,11 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -221,53 +311,11 @@ class SlapOSInstanceTestCase(unittest.TestCase):
# the ComputerPartition instances, to getInstanceParameterDict # the ComputerPartition instances, to getInstanceParameterDict
cls.computer_partition = computer_partition_list[0] cls.computer_partition = computer_partition_list[0]
# expose instance directory
cls.instance_path = os.path.join(
cls.config['working_directory'],
'inst')
# the path of the instance on the filesystem, for low level inspection # the path of the instance on the filesystem, for low level inspection
cls.computer_partition_root_path = os.path.join( cls.computer_partition_root_path = os.path.join(
cls.instance_path, cls.config['working_directory'],
'inst',
cls.computer_partition.getId()) cls.computer_partition.getId())
# expose software directory, extract from found computer partition
cls.software_path = os.path.realpath(os.path.join(
cls.computer_partition_root_path, 'software_release'))
@classmethod
def setUpClass(cls):
try:
cls.setUpWorkingDirectory()
cls.setUpConfig()
cls.setUpSlapOSController()
cls.runSoftwareRelease()
cls.runComputerPartition()
except Exception:
cls.tearDownClass()
raise
@classmethod
def tearDownClass(cls):
if getattr(cls, '_process_manager', None) is not None:
cls._process_manager.killPreviousRun()
class TestHandler(BaseHTTPRequestHandler):
def do_GET(self):
self.send_response(200)
self.send_header("Content-type", "application/json")
self.send_header('Set-Cookie', 'secured=value;secure')
self.send_header('Set-Cookie', 'nonsecured=value')
self.end_headers()
response = {
'Path': self.path,
'Incoming Headers': self.headers.dict
}
self.wfile.write(json.dumps(response, indent=2))
if __name__ == '__main__':
ip = LOCAL_IPV4
port = 8888
server = HTTPServer((ip, port), TestHandler)
print 'http://%s:%s' % server.server_address
server.serve_forever()
software/proftpd/test/utils.py
View file @ dc62d8e4
...@@ -30,14 +30,15 @@ import os ...@@ -30,14 +30,15 @@ import os
import socket import socket
from contextlib import closing from contextlib import closing
import logging import logging
import StringIO
import xmlrpclib import xmlrpclib
import supervisor.xmlrpc import supervisor.xmlrpc
from erp5.util.testnode.SlapOSControler import SlapOSControler from erp5.util.testnode.SlapOSControler import SlapOSControler
from erp5.util.testnode.ProcessManager import ProcessManager from erp5.util.testnode.ProcessManager import ProcessManager
import slapos
# Utility functions
def findFreeTCPPort(ip=''): def findFreeTCPPort(ip=''):
"""Find a free TCP port to listen to. """Find a free TCP port to listen to.
""" """
...@@ -47,7 +48,30 @@ def findFreeTCPPort(ip=''): ...@@ -47,7 +48,30 @@ def findFreeTCPPort(ip=''):
return s.getsockname()[1] return s.getsockname()[1]
# TODO:
# - allow requesting multiple instances ?
class SlapOSInstanceTestCase(unittest.TestCase): class SlapOSInstanceTestCase(unittest.TestCase):
"""Install one slapos instance.
This test case install software(s) and request one instance during `setUpClass`
and destroy the instance during `tearDownClass`.
Software Release URL, Instance Software Type and Instance Parameters can be defined
on the class.
All tests from the test class will run with the same instance.
The following class attributes are available:
* `computer_partition`: the computer partition instance, implementing
`slapos.slap.interface.slap.IComputerPartition`.
* `computer_partition_root_path`: the path of the instance root directory.
"""
# Methods to be defined by subclasses.
@classmethod @classmethod
def getSoftwareURLList(cls): def getSoftwareURLList(cls):
"""Return URL of software releases to install. """Return URL of software releases to install.
...@@ -65,20 +89,75 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -65,20 +89,75 @@ class SlapOSInstanceTestCase(unittest.TestCase):
""" """
return {} return {}
# TODO: allow subclasses to request a specific software type ? @classmethod
def getInstanceSoftwareType(cls):
"""Return software type for instance, default "default"
To be defined by subclasses if they need to request instance with specific
software type.
"""
return "default"
# Utility methods.
def getSupervisorRPCServer(self):
"""Returns a XML-RPC connection to the supervisor used by slapos node
Refer to http://supervisord.org/api.html for details of available methods.
"""
# xmlrpc over unix socket https://stackoverflow.com/a/11746051/7294664
return xmlrpclib.ServerProxy(
'http://slapos-supervisor',
transport=supervisor.xmlrpc.SupervisorTransport(
None,
None,
# XXX hardcoded socket path
serverurl="unix://{working_directory}/inst/supervisord.socket".format(
**self.config)))
# Unittest methods
@classmethod @classmethod
def setUpClass(cls): def setUpClass(cls):
"""Setup the class, build software and request an instance.
If you have to override this method, do not forget to call this method on
parent class.
"""
try: try:
cls._setUpClass() cls.setUpWorkingDirectory()
except: cls.setUpConfig()
cls.setUpSlapOSController()
cls.runSoftwareRelease()
# XXX instead of "runSoftwareRelease", it would be better to be closer to slapos usage:
# cls.supplySoftwares()
# cls.installSoftwares()
cls.runComputerPartition()
# XXX instead of "runComputerPartition", it would be better to be closer to slapos usage:
# cls.requestInstances()
# cls.createInstances()
# cls.requestInstances()
except Exception:
cls.stopSlapOSProcesses() cls.stopSlapOSProcesses()
raise raise
@classmethod @classmethod
def _setUpClass(cls): def tearDownClass(cls):
working_directory = os.environ.get( """Tear down class, stop the processes and destroy instance.
"""
cls.stopSlapOSProcesses()
# Implementation
@classmethod
def stopSlapOSProcesses(cls):
if hasattr(cls, '_process_manager'):
cls._process_manager.killPreviousRun()
@classmethod
def setUpWorkingDirectory(cls):
"""Initialise the directories"""
cls.working_directory = os.environ.get(
'SLAPOS_TEST_WORKING_DIR', 'SLAPOS_TEST_WORKING_DIR',
os.path.join(os.path.dirname(__file__), '.slapos')) os.path.join(os.path.dirname(__file__), '.slapos'))
# To prevent error: Cannot open an HTTP server: socket.error reported # To prevent error: Cannot open an HTTP server: socket.error reported
...@@ -87,76 +166,146 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -87,76 +166,146 @@ class SlapOSInstanceTestCase(unittest.TestCase):
# https://github.com/torvalds/linux/blob/3848ec5/net/unix/af_unix.c#L234-L238 # https://github.com/torvalds/linux/blob/3848ec5/net/unix/af_unix.c#L234-L238
# Supervisord socket name contains the pid number, which is why we add # Supervisord socket name contains the pid number, which is why we add
# .xxxxxxx in this check. # .xxxxxxx in this check.
if len(working_directory + '/inst/supervisord.socket.xxxxxxx') > 108: if len(cls.working_directory + '/inst/supervisord.socket.xxxxxxx') > 108:
raise RuntimeError('working directory ( {} ) is too deep, try setting ' raise RuntimeError('working directory ( {} ) is too deep, try setting '
'SLAPOS_TEST_WORKING_DIR'.format(working_directory)) 'SLAPOS_TEST_WORKING_DIR'.format(cls.working_directory))
if not os.path.exists(working_directory): if not os.path.exists(cls.working_directory):
os.mkdir(working_directory) os.mkdir(cls.working_directory)
cls.config = config = { @classmethod
"working_directory": working_directory, def setUpConfig(cls):
"slapos_directory": working_directory, """Create slapos configuration"""
"log_directory": working_directory, cls.config = {
"computer_id": 'slapos.test', # XXX "working_directory": cls.working_directory,
'proxy_database': os.path.join(working_directory, 'proxy.db'), "slapos_directory": cls.working_directory,
"log_directory": cls.working_directory,
"computer_id": 'slapos.test', # XXX
'proxy_database': os.path.join(cls.working_directory, 'proxy.db'),
'partition_reference': cls.__name__, 'partition_reference': cls.__name__,
# "proper" slapos command must be in $PATH # "proper" slapos command must be in $PATH
'slapos_binary': 'slapos', 'slapos_binary': 'slapos',
} }
# Some tests are expecting that local IP is not set to 127.0.0.1 # Some tests are expecting that local IP is not set to 127.0.0.1
ipv4_address = os.environ.get('LOCAL_IPV4', '127.0.1.1') ipv4_address = os.environ.get('LOCAL_IPV4', '127.0.1.1')
ipv6_address = os.environ['GLOBAL_IPV6'] ipv6_address = os.environ['GLOBAL_IPV6']
config['proxy_host'] = config['ipv4_address'] = ipv4_address cls.config['proxy_host'] = cls.config['ipv4_address'] = ipv4_address
config['ipv6_address'] = ipv6_address cls.config['ipv6_address'] = ipv6_address
config['proxy_port'] = findFreeTCPPort(ipv4_address) cls.config['proxy_port'] = findFreeTCPPort(ipv4_address)
config['master_url'] = 'http://{proxy_host}:{proxy_port}'.format(**config) cls.config['master_url'] = 'http://{proxy_host}:{proxy_port}'.format(
**cls.config)
cls._process_manager = process_manager = ProcessManager() @classmethod
def setUpSlapOSController(cls):
"""Create the a "slapos controller" and supply softwares from `getSoftwareURLList`.
This is equivalent to:
slapos proxy start
for sr in getSoftwareURLList; do
slapos supply $SR $COMP
done
"""
cls._process_manager = ProcessManager()
# XXX this code is copied from testnode code # XXX this code is copied from testnode code
slapos_controler = SlapOSControler( cls.slapos_controler = SlapOSControler(
working_directory, cls.working_directory,
config cls.config
) )
slapproxy_log = os.path.join(config['log_directory'], 'slapproxy.log') slapproxy_log = os.path.join(cls.config['log_directory'], 'slapproxy.log')
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
logger.debug('Configured slapproxy log to %r', slapproxy_log) logger.debug('Configured slapproxy log to %r', slapproxy_log)
software_url_list = cls.getSoftwareURLList() cls.software_url_list = cls.getSoftwareURLList()
slapos_controler.initializeSlapOSControler( cls.slapos_controler.initializeSlapOSControler(
slapproxy_log=slapproxy_log, slapproxy_log=slapproxy_log,
process_manager=process_manager, process_manager=cls._process_manager,
reset_software=False, reset_software=False,
software_path_list=software_url_list) software_path_list=cls.software_url_list)
# XXX we should check *earlier* if that pidfile exist and if supervisord
# process still running, because if developer started supervisord (or bugs?)
# then another supervisord will start and starting services a second time
# will fail.
cls._process_manager.supervisord_pid_file = os.path.join(
cls.slapos_controler.instance_root, 'var', 'run', 'supervisord.pid')
process_manager.supervisord_pid_file = os.path.join( @classmethod
slapos_controler.instance_root, 'var', 'run', 'supervisord.pid') def runSoftwareRelease(cls):
"""Run all the software releases that were supplied before.
This is the equivalent of `slapos node software`.
The tests will be marked file if software building fail.
"""
logger = logging.getLogger()
logger.level = logging.DEBUG
stream = StringIO.StringIO()
stream_handler = logging.StreamHandler(stream)
logger.addHandler(stream_handler)
try:
cls.software_status_dict = cls.slapos_controler.runSoftwareRelease(
cls.config, environment=os.environ)
stream.seek(0)
stream.flush()
message = ''.join(stream.readlines()[-100:])
assert cls.software_status_dict['status_code'] == 0, message
finally:
logger.removeHandler(stream_handler)
del stream
software_status_dict = slapos_controler.runSoftwareRelease(config, environment=os.environ)
# TODO: log more details in this case @classmethod
assert software_status_dict['status_code'] == 0 def runComputerPartition(cls):
"""Instanciate the software.
This is the equivalent of doing:
slapos request --type=getInstanceSoftwareType --parameters=getInstanceParameterDict
slapos node instance
and return the slapos request instance parameters.
This can be called by tests to simulate re-request with different parameters.
"""
logger = logging.getLogger()
logger.level = logging.DEBUG
stream = StringIO.StringIO()
stream_handler = logging.StreamHandler(stream)
logger.addHandler(stream_handler)
if cls.getInstanceSoftwareType() != 'default':
raise NotImplementedError
instance_parameter_dict = cls.getInstanceParameterDict() instance_parameter_dict = cls.getInstanceParameterDict()
instance_status_dict = slapos_controler.runComputerPartition( try:
config, cls.instance_status_dict = cls.slapos_controler.runComputerPartition(
cls.config,
cluster_configuration=instance_parameter_dict, cluster_configuration=instance_parameter_dict,
environment=os.environ) environment=os.environ)
# TODO: log more details in this case stream.seek(0)
assert instance_status_dict['status_code'] == 0 stream.flush()
message = ''.join(stream.readlines()[-100:])
# FIXME: similar to test node, only one (root) partition is really supported for now. assert cls.instance_status_dict['status_code'] == 0, message
finally:
logger.removeHandler(stream_handler)
del stream
# FIXME: similar to test node, only one (root) partition is really
# supported for now.
computer_partition_list = [] computer_partition_list = []
for i in range(len(software_url_list)): for i in range(len(cls.software_url_list)):
computer_partition_list.append( computer_partition_list.append(
slapos_controler.slap.registerOpenOrder().request( cls.slapos_controler.slap.registerOpenOrder().request(
software_url_list[i], cls.software_url_list[i],
# This is how testnode's SlapOSControler name created partitions # This is how testnode's SlapOSControler name created partitions
partition_reference='testing partition {i}'.format(i=i, **config), partition_reference='testing partition {i}'.format(
partition_parameter_kw=instance_parameter_dict)) i=i, **cls.config),
partition_parameter_kw=instance_parameter_dict))
# expose some class attributes so that tests can use them: # expose some class attributes so that tests can use them:
# the ComputerPartition instances, to getInstanceParameterDict # the ComputerPartition instances, to getInstanceParameterDict
...@@ -164,31 +313,9 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -164,31 +313,9 @@ class SlapOSInstanceTestCase(unittest.TestCase):
# the path of the instance on the filesystem, for low level inspection # the path of the instance on the filesystem, for low level inspection
cls.computer_partition_root_path = os.path.join( cls.computer_partition_root_path = os.path.join(
config['working_directory'], cls.config['working_directory'],
'inst', 'inst',
cls.computer_partition.getId()) cls.computer_partition.getId())
@classmethod
def stopSlapOSProcesses(cls):
if hasattr(cls, '_process_manager'):
cls._process_manager.killPreviousRun()
@classmethod
def tearDownClass(cls):
cls.stopSlapOSProcesses()
# utility methods
def getSupervisorRPCServer(self):
"""Returns a XML-RPC connection to the supervisor used by slapos node
Refer to http://supervisord.org/api.html for details of available methods.
"""
# xmlrpc over unix socket https://stackoverflow.com/a/11746051/7294664
return xmlrpclib.ServerProxy(
'http://slapos-supervisor',
transport=supervisor.xmlrpc.SupervisorTransport(
None,
None,
# XXX hardcoded socket path
serverurl="unix://{working_directory}/inst/supervisord.socket".format(**self.config)))
software/re6stnet/test/utils.py
View file @ dc62d8e4
...@@ -30,14 +30,15 @@ import os ...@@ -30,14 +30,15 @@ import os
import socket import socket
from contextlib import closing from contextlib import closing
import logging import logging
import StringIO
import xmlrpclib import xmlrpclib
import supervisor.xmlrpc import supervisor.xmlrpc
from erp5.util.testnode.SlapOSControler import SlapOSControler from erp5.util.testnode.SlapOSControler import SlapOSControler
from erp5.util.testnode.ProcessManager import ProcessManager from erp5.util.testnode.ProcessManager import ProcessManager
import slapos
# Utility functions
def findFreeTCPPort(ip=''): def findFreeTCPPort(ip=''):
"""Find a free TCP port to listen to. """Find a free TCP port to listen to.
""" """
...@@ -47,7 +48,30 @@ def findFreeTCPPort(ip=''): ...@@ -47,7 +48,30 @@ def findFreeTCPPort(ip=''):
return s.getsockname()[1] return s.getsockname()[1]
# TODO:
# - allow requesting multiple instances ?
class SlapOSInstanceTestCase(unittest.TestCase): class SlapOSInstanceTestCase(unittest.TestCase):
"""Install one slapos instance.
This test case install software(s) and request one instance during `setUpClass`
and destroy the instance during `tearDownClass`.
Software Release URL, Instance Software Type and Instance Parameters can be defined
on the class.
All tests from the test class will run with the same instance.
The following class attributes are available:
* `computer_partition`: the computer partition instance, implementing
`slapos.slap.interface.slap.IComputerPartition`.
* `computer_partition_root_path`: the path of the instance root directory.
"""
# Methods to be defined by subclasses.
@classmethod @classmethod
def getSoftwareURLList(cls): def getSoftwareURLList(cls):
"""Return URL of software releases to install. """Return URL of software releases to install.
...@@ -65,20 +89,75 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -65,20 +89,75 @@ class SlapOSInstanceTestCase(unittest.TestCase):
""" """
return {} return {}
# TODO: allow subclasses to request a specific software type ? @classmethod
def getInstanceSoftwareType(cls):
"""Return software type for instance, default "default"
To be defined by subclasses if they need to request instance with specific
software type.
"""
return "default"
# Utility methods.
def getSupervisorRPCServer(self):
"""Returns a XML-RPC connection to the supervisor used by slapos node
Refer to http://supervisord.org/api.html for details of available methods.
"""
# xmlrpc over unix socket https://stackoverflow.com/a/11746051/7294664
return xmlrpclib.ServerProxy(
'http://slapos-supervisor',
transport=supervisor.xmlrpc.SupervisorTransport(
None,
None,
# XXX hardcoded socket path
serverurl="unix://{working_directory}/inst/supervisord.socket".format(
**self.config)))
# Unittest methods
@classmethod @classmethod
def setUpClass(cls): def setUpClass(cls):
"""Setup the class, build software and request an instance.
If you have to override this method, do not forget to call this method on
parent class.
"""
try: try:
cls._setUpClass() cls.setUpWorkingDirectory()
except: cls.setUpConfig()
cls.setUpSlapOSController()
cls.runSoftwareRelease()
# XXX instead of "runSoftwareRelease", it would be better to be closer to slapos usage:
# cls.supplySoftwares()
# cls.installSoftwares()
cls.runComputerPartition()
# XXX instead of "runComputerPartition", it would be better to be closer to slapos usage:
# cls.requestInstances()
# cls.createInstances()
# cls.requestInstances()
except Exception:
cls.stopSlapOSProcesses() cls.stopSlapOSProcesses()
raise raise
@classmethod @classmethod
def _setUpClass(cls): def tearDownClass(cls):
working_directory = os.environ.get( """Tear down class, stop the processes and destroy instance.
"""
cls.stopSlapOSProcesses()
# Implementation
@classmethod
def stopSlapOSProcesses(cls):
if hasattr(cls, '_process_manager'):
cls._process_manager.killPreviousRun()
@classmethod
def setUpWorkingDirectory(cls):
"""Initialise the directories"""
cls.working_directory = os.environ.get(
'SLAPOS_TEST_WORKING_DIR', 'SLAPOS_TEST_WORKING_DIR',
os.path.join(os.path.dirname(__file__), '.slapos')) os.path.join(os.path.dirname(__file__), '.slapos'))
# To prevent error: Cannot open an HTTP server: socket.error reported # To prevent error: Cannot open an HTTP server: socket.error reported
...@@ -87,76 +166,146 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -87,76 +166,146 @@ class SlapOSInstanceTestCase(unittest.TestCase):
# https://github.com/torvalds/linux/blob/3848ec5/net/unix/af_unix.c#L234-L238 # https://github.com/torvalds/linux/blob/3848ec5/net/unix/af_unix.c#L234-L238
# Supervisord socket name contains the pid number, which is why we add # Supervisord socket name contains the pid number, which is why we add
# .xxxxxxx in this check. # .xxxxxxx in this check.
if len(working_directory + '/inst/supervisord.socket.xxxxxxx') > 108: if len(cls.working_directory + '/inst/supervisord.socket.xxxxxxx') > 108:
raise RuntimeError('working directory ( {} ) is too deep, try setting ' raise RuntimeError('working directory ( {} ) is too deep, try setting '
'SLAPOS_TEST_WORKING_DIR'.format(working_directory)) 'SLAPOS_TEST_WORKING_DIR'.format(cls.working_directory))
if not os.path.exists(working_directory): if not os.path.exists(cls.working_directory):
os.mkdir(working_directory) os.mkdir(cls.working_directory)
cls.config = config = { @classmethod
"working_directory": working_directory, def setUpConfig(cls):
"slapos_directory": working_directory, """Create slapos configuration"""
"log_directory": working_directory, cls.config = {
"computer_id": 'slapos.test', # XXX "working_directory": cls.working_directory,
'proxy_database': os.path.join(working_directory, 'proxy.db'), "slapos_directory": cls.working_directory,
"log_directory": cls.working_directory,
"computer_id": 'slapos.test', # XXX
'proxy_database': os.path.join(cls.working_directory, 'proxy.db'),
'partition_reference': cls.__name__, 'partition_reference': cls.__name__,
# "proper" slapos command must be in $PATH # "proper" slapos command must be in $PATH
'slapos_binary': 'slapos', 'slapos_binary': 'slapos',
} }
# Some tests are expecting that local IP is not set to 127.0.0.1 # Some tests are expecting that local IP is not set to 127.0.0.1
ipv4_address = os.environ.get('LOCAL_IPV4', '127.0.1.1') ipv4_address = os.environ.get('LOCAL_IPV4', '127.0.1.1')
ipv6_address = os.environ['GLOBAL_IPV6'] ipv6_address = os.environ['GLOBAL_IPV6']
config['proxy_host'] = config['ipv4_address'] = ipv4_address cls.config['proxy_host'] = cls.config['ipv4_address'] = ipv4_address
config['ipv6_address'] = ipv6_address cls.config['ipv6_address'] = ipv6_address
config['proxy_port'] = findFreeTCPPort(ipv4_address) cls.config['proxy_port'] = findFreeTCPPort(ipv4_address)
config['master_url'] = 'http://{proxy_host}:{proxy_port}'.format(**config) cls.config['master_url'] = 'http://{proxy_host}:{proxy_port}'.format(
**cls.config)
cls._process_manager = process_manager = ProcessManager() @classmethod
def setUpSlapOSController(cls):
"""Create the a "slapos controller" and supply softwares from `getSoftwareURLList`.
This is equivalent to:
slapos proxy start
for sr in getSoftwareURLList; do
slapos supply $SR $COMP
done
"""
cls._process_manager = ProcessManager()
# XXX this code is copied from testnode code # XXX this code is copied from testnode code
slapos_controler = SlapOSControler( cls.slapos_controler = SlapOSControler(
working_directory, cls.working_directory,
config cls.config
) )
slapproxy_log = os.path.join(config['log_directory'], 'slapproxy.log') slapproxy_log = os.path.join(cls.config['log_directory'], 'slapproxy.log')
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
logger.debug('Configured slapproxy log to %r', slapproxy_log) logger.debug('Configured slapproxy log to %r', slapproxy_log)
software_url_list = cls.getSoftwareURLList() cls.software_url_list = cls.getSoftwareURLList()
slapos_controler.initializeSlapOSControler( cls.slapos_controler.initializeSlapOSControler(
slapproxy_log=slapproxy_log, slapproxy_log=slapproxy_log,
process_manager=process_manager, process_manager=cls._process_manager,
reset_software=False, reset_software=False,
software_path_list=software_url_list) software_path_list=cls.software_url_list)
# XXX we should check *earlier* if that pidfile exist and if supervisord
# process still running, because if developer started supervisord (or bugs?)
# then another supervisord will start and starting services a second time
# will fail.
cls._process_manager.supervisord_pid_file = os.path.join(
cls.slapos_controler.instance_root, 'var', 'run', 'supervisord.pid')
process_manager.supervisord_pid_file = os.path.join( @classmethod
slapos_controler.instance_root, 'var', 'run', 'supervisord.pid') def runSoftwareRelease(cls):
"""Run all the software releases that were supplied before.
This is the equivalent of `slapos node software`.
The tests will be marked file if software building fail.
"""
logger = logging.getLogger()
logger.level = logging.DEBUG
stream = StringIO.StringIO()
stream_handler = logging.StreamHandler(stream)
logger.addHandler(stream_handler)
try:
cls.software_status_dict = cls.slapos_controler.runSoftwareRelease(
cls.config, environment=os.environ)
stream.seek(0)
stream.flush()
message = ''.join(stream.readlines()[-100:])
assert cls.software_status_dict['status_code'] == 0, message
finally:
logger.removeHandler(stream_handler)
del stream
software_status_dict = slapos_controler.runSoftwareRelease(config, environment=os.environ)
# TODO: log more details in this case @classmethod
assert software_status_dict['status_code'] == 0 def runComputerPartition(cls):
"""Instanciate the software.
This is the equivalent of doing:
slapos request --type=getInstanceSoftwareType --parameters=getInstanceParameterDict
slapos node instance
and return the slapos request instance parameters.
This can be called by tests to simulate re-request with different parameters.
"""
logger = logging.getLogger()
logger.level = logging.DEBUG
stream = StringIO.StringIO()
stream_handler = logging.StreamHandler(stream)
logger.addHandler(stream_handler)
if cls.getInstanceSoftwareType() != 'default':
raise NotImplementedError
instance_parameter_dict = cls.getInstanceParameterDict() instance_parameter_dict = cls.getInstanceParameterDict()
instance_status_dict = slapos_controler.runComputerPartition( try:
config, cls.instance_status_dict = cls.slapos_controler.runComputerPartition(
cls.config,
cluster_configuration=instance_parameter_dict, cluster_configuration=instance_parameter_dict,
environment=os.environ) environment=os.environ)
# TODO: log more details in this case stream.seek(0)
assert instance_status_dict['status_code'] == 0 stream.flush()
message = ''.join(stream.readlines()[-100:])
# FIXME: similar to test node, only one (root) partition is really supported for now. assert cls.instance_status_dict['status_code'] == 0, message
finally:
logger.removeHandler(stream_handler)
del stream
# FIXME: similar to test node, only one (root) partition is really
# supported for now.
computer_partition_list = [] computer_partition_list = []
for i in range(len(software_url_list)): for i in range(len(cls.software_url_list)):
computer_partition_list.append( computer_partition_list.append(
slapos_controler.slap.registerOpenOrder().request( cls.slapos_controler.slap.registerOpenOrder().request(
software_url_list[i], cls.software_url_list[i],
# This is how testnode's SlapOSControler name created partitions # This is how testnode's SlapOSControler name created partitions
partition_reference='testing partition {i}'.format(i=i, **config), partition_reference='testing partition {i}'.format(
partition_parameter_kw=instance_parameter_dict)) i=i, **cls.config),
partition_parameter_kw=instance_parameter_dict))
# expose some class attributes so that tests can use them: # expose some class attributes so that tests can use them:
# the ComputerPartition instances, to getInstanceParameterDict # the ComputerPartition instances, to getInstanceParameterDict
...@@ -164,31 +313,9 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -164,31 +313,9 @@ class SlapOSInstanceTestCase(unittest.TestCase):
# the path of the instance on the filesystem, for low level inspection # the path of the instance on the filesystem, for low level inspection
cls.computer_partition_root_path = os.path.join( cls.computer_partition_root_path = os.path.join(
config['working_directory'], cls.config['working_directory'],
'inst', 'inst',
cls.computer_partition.getId()) cls.computer_partition.getId())
@classmethod
def stopSlapOSProcesses(cls):
if hasattr(cls, '_process_manager'):
cls._process_manager.killPreviousRun()
@classmethod
def tearDownClass(cls):
cls.stopSlapOSProcesses()
# utility methods
def getSupervisorRPCServer(self):
"""Returns a XML-RPC connection to the supervisor used by slapos node
Refer to http://supervisord.org/api.html for details of available methods.
"""
# xmlrpc over unix socket https://stackoverflow.com/a/11746051/7294664
return xmlrpclib.ServerProxy(
'http://slapos-supervisor',
transport=supervisor.xmlrpc.SupervisorTransport(
None,
None,
# XXX hardcoded socket path
serverurl="unix://{working_directory}/inst/supervisord.socket".format(**self.config)))
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7