nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-01-28 08:03:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactored actions to use exceptions instead of return-values

Browse Source
This commit is contained in:
fonfon 2014-07-10 18:27:49 +03:00
parent a40d42eb60
commit 0d5636a900
12 changed files with 62 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
actions.py
View File

@ -77,6 +77,7 @@ import pipes
import subprocess
import cfg
from errors import ActionError
def run(action, options=None, async=False):
@ -106,6 +107,7 @@ def _run(action, options=None, async=False, run_as_root=False):
# contract 3A and 3B: don't call anything outside of the actions directory.
if os.sep in action:
# TODO: perhaps we should raise an ActionError instead of ValueError
raise ValueError("Action can't contain:" + os.sep)
cmd = cfg.actions_dir + os.sep + action
@ -139,4 +141,6 @@ def _run(action, options=None, async=False, run_as_root=False):
if not async:
output, error = proc.communicate()
return output, error
if proc.returncode != 0:
raise ActionError('Running action %s failed: %s' % (action, error))
return output

10
errors.py Normal file
View File

@ -0,0 +1,10 @@
""" Plinth project specific errors """
class PlinthError(Exception):
pass
class ActionError(PlinthError):
""" Use this error for exceptions when executing an action """
pass

25
modules/config/config.py
View File

@ -32,6 +32,7 @@ import socket
import actions
import cfg
import util
from errors import ActionError
LOGGER = logging.getLogger(__name__)
@ -133,20 +134,22 @@ def get_status():
def _apply_changes(request, old_status, new_status):
"""Apply the form changes"""
if old_status['hostname'] != new_status['hostname']:
if not set_hostname(new_status['hostname']):
messages.error(request, _('Setting hostname failed'))
try:
set_hostname(new_status['hostname'])
except (ActionError, ValueError) as err:
messages.error(request, _('Error setting hostname: %s') %
err.message)
else:
messages.success(request, _('Hostname set'))
else:
messages.info(request, _('Hostname is unchanged'))
if old_status['time_zone'] != new_status['time_zone']:
output, error = actions.superuser_run('timezone-change',
[new_status['time_zone']])
del output # Unused
if error:
messages.error(request,
_('Error setting time zone - %s') % error)
try:
actions.superuser_run('timezone-change', [new_status['time_zone']])
except (ActionError, ValueError) as err:
messages.error(request, _('Error setting time zone: %s') %
err.message)
else:
messages.success(request, _('Time zone set'))
else:
@ -164,7 +167,5 @@ def set_hostname(hostname):
actions.superuser_run('xmpp-pre-hostname-change')
actions.superuser_run('hostname-change', hostname)
actions.superuser_run('xmpp-hostname-change', hostname, async=True)
except OSError:
return False
return True
except OSError as err:
raise ActionError(err.message)

8
modules/diagnostics/diagnostics.py
View File

@ -25,6 +25,7 @@ from gettext import gettext as _
import actions
import cfg
from errors import ActionError
def init():
@ -43,7 +44,12 @@ def index(request):
@login_required
def test(request):
"""Run diagnostics and the output page"""
output, error = actions.superuser_run("diagnostic-test")
output = ""
error = ""
try:
output = actions.superuser_run("diagnostic-test")
except ActionError as err:
error = err.message
return TemplateResponse(request, 'diagnostics_test.html',
{'title': _('Diagnostic Test'),
'diagnostics_output': output,

9
modules/firewall/firewall.py
View File

@ -140,16 +140,11 @@ def on_service_enabled(sender, service_id, enabled, **kwargs):
def _run(arguments, superuser=False):
"""Run an given command and raise exception if there was an error"""
command = 'firewall'
LOGGER.info('Running command - %s, %s, %s', command, arguments, superuser)
if superuser:
output, error = actions.superuser_run(command, arguments)
output = actions.superuser_run(command, arguments)
else:
output, error = actions.run(command, arguments)
if error:
raise Exception('Error setting/getting firewalld confguration - %s'
% error)
output = actions.run(command, arguments)
return output

5
modules/owncloud/owncloud.py
View File

@ -53,10 +53,7 @@ def index(request):
def get_status():
"""Return the current status"""
output, error = actions.run('owncloud-setup', 'status')
if error:
raise Exception('Error getting ownCloud status: %s' % error)
output = actions.run('owncloud-setup', 'status')
return {'enabled': 'enable' in output.split()}

37
modules/packages/packages.py
View File

@ -6,23 +6,18 @@ from gettext import gettext as _
import actions
import cfg
from errors import ActionError
def get_modules_available():
"""Return list of all modules"""
output, error = actions.run('module-manager', ['list-available'])
if error:
raise Exception('Error getting modules: %s' % error)
output = actions.run('module-manager', ['list-available'])
return output.split()
def get_modules_enabled():
"""Return list of all modules"""
output, error = actions.run('module-manager', ['list-enabled'])
if error:
raise Exception('Error getting enabled modules - %s' % error)
output = actions.run('module-manager', ['list-enabled'])
return output.split()
@ -88,13 +83,12 @@ def _apply_changes(request, old_status, new_status):
module = field.split('_enabled')[0]
if enabled:
output, error = actions.superuser_run(
'module-manager', ['enable', cfg.python_root, module])
del output # Unused
# TODO: need to get plinth to load the module we just
# enabled
if error:
try:
actions.superuser_run(
'module-manager', ['enable', cfg.python_root, module])
except ActionError:
# TODO: need to get plinth to load the module we just
# enabled
messages.error(
request, _('Error enabling module - {module}').format(
module=module))
@ -103,13 +97,12 @@ def _apply_changes(request, old_status, new_status):
request, _('Module enabled - {module}').format(
module=module))
else:
output, error = actions.superuser_run(
'module-manager', ['disable', cfg.python_root, module])
del output # Unused
# TODO: need a smoother way for plinth to unload the
# module
if error:
try:
actions.superuser_run(
'module-manager', ['disable', cfg.python_root, module])
except ActionError:
# TODO: need a smoother way for plinth to unload the
# module
messages.error(
request, _('Error disabling module - {module}').format(
module=module))

10
modules/pagekite/pagekite.py
View File

@ -196,16 +196,10 @@ def _apply_changes(request, old_status, new_status):
def _run(arguments, superuser=True):
"""Run an given command and raise exception if there was an error"""
command = 'pagekite-configure'
LOGGER.info('Running command - %s, %s, %s', command, arguments, superuser)
if superuser:
output, error = actions.superuser_run(command, arguments)
output = actions.superuser_run(command, arguments)
else:
output, error = actions.run(command, arguments)
if error:
raise Exception('Error setting/getting PageKite confguration - %s'
% error)
output = actions.run(command, arguments)
return output

3
modules/tor/tor.py
View File

@ -36,8 +36,7 @@ def init():
@login_required
def index(request):
"""Service the index page"""
output, error = actions.superuser_run("tor-get-ports")
del error # Unused
output = actions.superuser_run("tor-get-ports")
port_info = output.split("\n")
tor_ports = {}

15
modules/xmpp/xmpp.py
View File

@ -88,10 +88,7 @@ def configure(request):
def get_status():
"""Return the current status"""
output, error = actions.run('xmpp-setup', 'status')
if error:
raise Exception('Error getting status: %s' % error)
output = actions.run('xmpp-setup', 'status')
return {'inband_enabled': 'inband_enable' in output.split()}
@ -111,11 +108,7 @@ def _apply_changes(request, old_status, new_status):
option = 'noinband_enable'
LOGGER.info('Option - %s', option)
_output, error = actions.superuser_run('xmpp-setup', [option])
del _output # Unused
if error:
raise Exception('Error running command - %s' % error)
actions.superuser_run('xmpp-setup', [option])
class RegisterForm(forms.Form): # pylint: disable-msg=W0232
@ -151,10 +144,8 @@ def register(request):
def _register_user(request, data):
"""Register a new XMPP user"""
output, error = actions.superuser_run(
output = actions.superuser_run(
'xmpp-register', [data['username'], data['password']])
if error:
raise Exception('Error registering user - %s' % error)
if 'successfully registered' in output:
messages.success(request, _('Registered account for %s') %

4
tests/actions_test.py
View File

@ -90,7 +90,7 @@ class TestPrivileged(unittest.TestCase):
# counting is safer than actual badness.
options = "good; echo $((1+1))"
output, error = run(action, options)
output = run(action, options)
self.assertFalse("2" in output)
@ -105,7 +105,7 @@ class TestPrivileged(unittest.TestCase):
# counting is safer than actual badness.
options = ["good", ";", "echo $((1+1))"]
output, error = run(action, options)
output = run(action, options)
# we'd better not evaluate the data.
self.assertFalse("2" in output)

2
views.py
View File

@ -48,4 +48,4 @@ def index(request):
if request.user.is_authenticated():
return HttpResponseRedirect(reverse('apps:index'))
return HttpResponseRedirect(reverse('apps:about'))
return HttpResponseRedirect(reverse('help:about'))