tests: functional: Merge into main source hierarchy

- Add pytest hooks to ignore all functional tests if pytest_bdd is not
installed.

- Update pytest hooks to skip tests in file named 'test_functional.py' if
--include-functional argument is not provided.

- Move functional_tests/install.py into plinth/tests/functional and update
reference in Vagrantfile.

- Move scenario files into individual app folders. Rename them after the app
they are testing. Merge TODO items listed in todo.org into corresponding feature
files.

- Add test_functional.py in each app to build tests from the features file using
pytest_bdd.

- Move all step_definitions, support and data into plinth/tests/functional/.
Include all step_definitions from conftest.py. Update to relative imports
instead of absolute imports.

Tests performed:

- Run py.test-3 --collect-only shows all functional tests and lists 574 tests.
No errors show that name of feature files are correct. The number says that all
functional test features are included.

- Remove pytest_bdd (or modify the import name) and run py.test-3 --collect-only
skips collecting all functional tests and shows only 300+ tests.

- Run functional tests for a few apps with py.test-3 --include-functional -m
app. For storage, deluge.

- Run unit tests with py.test-3. Functional tests are listed by skipped.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Joseph Nuthalapati <njoseph@riseup.net>

Vagrantfile

@@ -38,7 +38,7 @@ Vagrant.configure(2) do |config|
     DEBIAN_FRONTEND=noninteractive apt-get install -y ncurses-term
     echo 'alias run-develop="sudo -u plinth /vagrant/run --develop"' >> /home/vagrant/.bashrc
   SHELL
-  config.vm.provision "tests", run: "never", type: "shell", path: "functional_tests/install.sh"
+  config.vm.provision "tests", run: "never", type: "shell", path: "plinth/tests/functional/install.sh"
   config.vm.post_up_message = "FreedomBox virtual machine is ready
 for development. You can run the development version of Plinth using
 the following command.

conftest.py

@@ -3,11 +3,30 @@
 pytest configuration for all tests.
 """
 
+import importlib
 import os
 import pathlib
 
 import pytest
 
+try:
+    importlib.import_module('pytest_bdd')
+    _bdd_available = True
+except ImportError:
+    _bdd_available = False
+else:
+    from plinth.tests.functional.step_definitions.application import *
+    from plinth.tests.functional.step_definitions.interface import *
+    from plinth.tests.functional.step_definitions.service import *
+    from plinth.tests.functional.step_definitions.site import *
+    from plinth.tests.functional.step_definitions.system import *
+
+
+def pytest_ignore_collect(path, config):
+    """Return True to ignore functional tests."""
+    if path.basename == 'test_functional.py':
+        return not _bdd_available
+
 
 def pytest_addoption(parser):
     """Add a command line option to run functional tests."""
@@ -16,7 +35,7 @@ def pytest_addoption(parser):
 
 
 def pytest_collection_modifyitems(config, items):
-    """Filter out functional tests unless --include-functional arg is passed."""
+    """Filter out functional tests unless --include-functional is passed."""
     if config.getoption('--include-functional'):
         # Option provided on command line, no filtering
         return
@@ -24,7 +43,9 @@ def pytest_collection_modifyitems(config, items):
     skip_functional = pytest.mark.skip(
         reason='--include-functional not provided')
     for item in items:
-        if 'functional' in item.keywords:
+        if 'functional' in item.keywords or (
+                item.parent.fspath.basename
+                and item.parent.fspath.basename == 'test_functional.py'):
             item.add_marker(skip_functional)
 
 

functional_tests/test_plinth.py

@@ -1,19 +0,0 @@
-# SPDX-License-Identifier: AGPL-3.0-or-later
-
-import pytest
-
-try:
-    from pytest_bdd import scenarios
-except ImportError:
-    pytestmark = pytest.mark.skip(reason='pytest_bdd is not installed')
-else:
-    from step_definitions.application import *
-    from step_definitions.interface import *
-    from step_definitions.service import *
-    from step_definitions.site import *
-    from step_definitions.system import *
-
-    # Mark all tests are functional
-    pytestmark = pytest.mark.functional
-
-    scenarios('features')

functional_tests/todo.org

@@ -1,35 +0,0 @@
-* Feature: Users and Groups
-** TODO Scenario: Add user to wiki group
-** TODO Scenario: Remove user from wiki group
-** TODO Scenario: Set user SSH key
-** TODO Scenario: Clear user SSH key
-** TODO Scenario: Make user inactive
-** TODO Scenario: Make user active
-** TODO Scenario: Change user password
-
-* Feature: Help
-** TODO Scenario: Visit the wiki
-** TODO Scenario: Visit the mailing list
-** TODO Scenario: Visit the IRC channel
-** TODO Scenario: View the manual
-** TODO Scenario: View the about page
-
-* Feature: Bookmarks
-** TODO Enable/Disable
-
-* Feature: Chat Server
-** TODO Check service
-** TODO Check domain name display
-
-* Feature: Dynamic DNS Client
-** TODO Scenario: Configure GnuDIP service
-** TODO Scenario: Configure noip.com service
-** TODO Scenario: Configure selfhost.bz service
-** TODO Scenario: Configure freedns.afraid.org service
-** TODO Scenario: Configure other update URL service
-
-* Feature: Public Visibility
-** TODO Scenario: Enable standard services
-** TODO Scenario: Disable standard services
-** TODO Scenario: Add custom service
-** TODO Scenario: Delete custom service

plinth/modules/avahi/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for avahi app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('avahi.feature')

plinth/modules/backups/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for backups app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('backups.feature')

plinth/modules/bind/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for bind app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('bind.feature')

plinth/modules/cockpit/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for cockpit app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('cockpit.feature')

plinth/modules/config/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for config app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('config.feature')

plinth/modules/coquelicot/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for coquelicot app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('coquelicot.feature')

plinth/modules/coturn/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for coturn app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('coturn.feature')

plinth/modules/datetime/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for datetime app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('datetime.feature')

plinth/modules/deluge/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for deluge app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('deluge.feature')

plinth/modules/dynamicdns/tests/dynamicdns.feature

@@ -1,5 +1,11 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
+# TODO Scenario: Configure GnuDIP service
+# TODO Scenario: Configure noip.com service
+# TODO Scenario: Configure selfhost.bz service
+# TODO Scenario: Configure freedns.afraid.org service
+# TODO Scenario: Configure other update URL service
+
 @apps @dynamicdns
 Feature: Dynamic DNS Client
   Update public IP to a GnuDIP server.

plinth/modules/dynamicdns/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for dynamicdns app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('dynamicdns.feature')

plinth/modules/ejabberd/tests/ejabberd.feature

@@ -1,5 +1,8 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
+# TODO Check service
+# TODO Check domain name display
+
 @apps @ejabberd
 Feature: Ejabberd Chat Server
   Run ejabberd chat server.

plinth/modules/ejabberd/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for ejabberd app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('ejabberd.feature')

plinth/modules/gitweb/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for gitweb app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('gitweb.feature')

plinth/modules/help/tests/help.feature

@@ -1,5 +1,11 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
+# TODO Scenario: Visit the wiki
+# TODO Scenario: Visit the mailing list
+# TODO Scenario: Visit the IRC channel
+# TODO Scenario: View the manual
+# TODO Scenario: View the about page
+
 @help @system @essential
 Feature: Help module
   Show various information about the system.

plinth/modules/help/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for help app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('help.feature')

plinth/modules/i2p/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for i2p app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('i2p.feature')

plinth/modules/ikiwiki/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for ikiwiki app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('ikiwiki.feature')

plinth/modules/infinoted/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for infinoted app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('infinoted.feature')

plinth/modules/jsxc/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for jsxc app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('jsxc.feature')

plinth/modules/matrixsynapse/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for matrixsynapse app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('matrixsynapse.feature')

plinth/modules/mediawiki/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for mediawiki app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('mediawiki.feature')

plinth/modules/minetest/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for minetest app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('minetest.feature')

plinth/modules/minidlna/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for minidlna app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('minidlna.feature')

plinth/modules/mldonkey/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for mldonkey app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('mldonkey.feature')

plinth/modules/monkeysphere/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for monkeysphere app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('monkeysphere.feature')

plinth/modules/mumble/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for mumble app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('mumble.feature')

plinth/modules/openvpn/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for openvpn app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('openvpn.feature')

plinth/modules/pagekite/tests/pagekite.feature

@@ -1,5 +1,10 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
+# TODO Scenario: Enable standard services
+# TODO Scenario: Disable standard services
+# TODO Scenario: Add custom service
+# TODO Scenario: Delete custom service
+
 @apps @pagekite
 Feature: Pagekite Public Visibility
   Configure Pagekite public visitbility server.

plinth/modules/pagekite/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for pagekite app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('pagekite.feature')

plinth/modules/performance/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for performance app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('performance.feature')

plinth/modules/privoxy/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for privoxy app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('privoxy.feature')

plinth/modules/quassel/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for quassel app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('quassel.feature')

plinth/modules/radicale/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for radicale app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('radicale.feature')

plinth/modules/roundcube/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for roundcube app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('roundcube.feature')

plinth/modules/samba/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for samba app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('samba.feature')

plinth/modules/searx/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for searx app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('searx.feature')

plinth/modules/security/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for security app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('security.feature')

plinth/modules/shadowsocks/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for shadowsocks app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('shadowsocks.feature')

plinth/modules/sharing/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for sharing app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('sharing.feature')

plinth/modules/snapshot/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for snapshot app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('snapshot.feature')

plinth/modules/ssh/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for ssh app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('ssh.feature')

plinth/modules/sso/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for sso app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('sso.feature')

plinth/modules/storage/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for storage app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('storage.feature')

plinth/modules/syncthing/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for syncthing app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('syncthing.feature')

plinth/modules/tahoe/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for tahoe app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('tahoe.feature')

plinth/modules/tor/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for tor app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('tor.feature')

plinth/modules/transmission/tests/test_functional.py

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: AGPL-3.0-or-later
+"""
+Functional, browser based tests for transmission app.
+"""
+
+from pytest_bdd import scenarios
+
+scenarios('transmission.feature')