shadowsocks: Enable backup/restore

Reviewed-by: James Valleroy <jvalleroy@mailbox.org>

functional_tests/features/shadowsocks.feature

@@ -34,3 +34,12 @@ Scenario: Disable shadowsocks application
   When I disable the shadowsocks application
   Then the shadowsocks service should not be running
 
+Scenario: Backup and restore shadowsocks
+  Given the shadowsocks application is enabled
+  When I configure shadowsocks with server beforebackup.example.com and password beforebackup123
+  And I create a backup of the shadowsocks app data
+  And I configure shadowsocks with server afterbackup.example.com and password afterbackup123
+  And I export the shadowsocks app data backup
+  And I restore the shadowsocks app data backup
+  Then the shadowsocks service should be running
+  And shadowsocks should be configured with server beforebackup.example.com and password beforebackup123

functional_tests/step_definitions/application.py

@@ -96,7 +96,25 @@ def select_domain_name(browser, app_name, domain_name):
 
 @given('the shadowsocks application is configured')
 def configure_shadowsocks(browser):
-    application.configure_shadowsocks(browser)
+    application.configure_shadowsocks(browser, 'some.shadow.tunnel',
+                                      'fakepassword')
+
+
+@when(
+    parsers.parse(
+        'I configure shadowsocks with server {server:S} and password {password:w}'
+    ))
+def configure_shadowsocks_with_details(browser, server, password):
+    application.configure_shadowsocks(browser, server, password)
+
+
+@then(
+    parsers.parse(
+        'shadowsocks should be configured with server {server:S} and password {password:w}'
+    ))
+def assert_shadowsocks_configuration(browser, server, password):
+    assert (server,
+            password) == application.shadowsocks_get_configuration(browser)
 
 
 @when(

functional_tests/support/application.py

@@ -116,14 +116,22 @@ def select_domain_name(browser, app_name, domain_name):
     interface.submit(browser, form_class='form-configuration')
 
 
-def configure_shadowsocks(browser):
-    """Configure shadowsocks client with some fake server details"""
+def configure_shadowsocks(browser, server, password):
+    """Configure shadowsocks client with given server details."""
     browser.visit('{}/plinth/apps/shadowsocks/'.format(default_url))
-    browser.find_by_id('id_server').fill('some.shadow.tunnel')
-    browser.find_by_id('id_password').fill('fakepassword')
+    browser.find_by_id('id_server').fill(server)
+    browser.find_by_id('id_password').fill(password)
     interface.submit(browser, form_class='form-configuration')
 
 
+def shadowsocks_get_configuration(browser):
+    """Return the server and password currently configured in shadowsocks."""
+    browser.visit('{}/plinth/apps/shadowsocks/'.format(default_url))
+    server = browser.find_by_id('id_server').value
+    password = browser.find_by_id('id_password').value
+    return server, password
+
+
 def modify_max_file_size(browser, size):
     """Change the maximum file size of coquelicot to the given value"""
     browser.visit('{}/plinth/apps/coquelicot/'.format(default_url))

plinth/modules/shadowsocks/__init__.py

@@ -26,6 +26,8 @@ from plinth import action_utils, actions, cfg, frontpage
 from plinth.menu import main_menu
 from plinth.utils import format_lazy
 
+from .manifest import backup
+
 version = 1
 
 name = _('Shadowsocks')

plinth/modules/shadowsocks/manifest.py

@@ -0,0 +1,28 @@
+#
+# This file is part of FreedomBox.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+"""
+Application manifest for shadowsocks.
+"""
+
+from plinth.modules.backups.api import validate as validate_backup
+
+backup = validate_backup({
+    'secrets': {
+        'files': ['/etc/shadowsocks-libev/freedombox.json']
+    },
+    'services': ['shadowsocks-libev-local@freedombox']
+})