use Kivy settings for %here server

Author: b3b

pythonhere/enum_here.py

@@ -0,0 +1,24 @@
+"""Enums."""
+from enum import Enum
+
+
+class StrEnum(str, Enum):
+    """Base class for str enums."""
+
+    def __str__(self):
+        return str(self.value)
+
+
+class ScreenName(StrEnum):
+    """Enum for root screen names."""
+
+    here = "here"
+    settings = "settings"
+
+
+class ServerState(StrEnum):
+    """Enum for %here server state (screen name)."""
+
+    not_configured = "not_configured"
+    starting_server = "starting_server"
+    ready = "ready"

pythonhere/main.py

@@ -3,8 +3,8 @@
 
 from kivy.app import App
 from kivy.logger import Logger
-from kivy.uix.settings import Settings
 
+from enum_here import ScreenName
 from herethere.here import ServerConfig, start_server
 from patches_here import monkeypatch_kivy
 
@@ -13,13 +13,17 @@
 
 async def run_ssh_server(app):
     """Start and run SSH server."""
+    Logger.debug("Python Here: wait for %here settings")
+    try:
+        await app.ssh_server_config_ready.wait()
+    except asyncio.CancelledError:
+        return
+
     config = ServerConfig(
         host="",
-        port=8022,
-        username="here",
-        password="there",
         chroot=app.user_data_dir or "",
         key_path="./key.rsa",
+        **app.get_pythonhere_config(),
     )
 
     try:
@@ -48,15 +52,16 @@ class PythonHereApp(App):
     def __init__(self):
         super().__init__()
         self.server_task = None
+        self.settings = None
+        self.ssh_server_config_ready = asyncio.Event()
         self.ssh_server_started = asyncio.Event()
         self.ssh_server_namespace = {}
 
     def build(self):
         """Initialize application UI."""
-        self.settings_cls = Settings
-
         super().build()
-        self.root.switch_screen("here")
+
+        self.settings = self.root.ids.settings
 
         self.ssh_server_namespace.update(
             {
@@ -65,6 +70,10 @@ def build(self):
             }
         )
 
+        self.settings.bind(on_config_change=self.handle_config_change)
+        self.update_server_config_status()
+        self.root.switch_screen(ScreenName.here)
+
     def run_app(self):
         """Run application and SSH server tasks."""
         self.ssh_server_started = asyncio.Event()
@@ -84,6 +93,22 @@ async def async_run_app(self):
         if self.server_task:
             self.server_task.cancel()
 
+    def update_server_config_status(self):
+        """Check and update value of the `ssh_server_config_ready`."""
+        if all(self.get_pythonhere_config().values()):
+            self.ssh_server_config_ready.set()
+
+    def get_pythonhere_config(self):
+        """Return user settings for SSH server."""
+        return self.settings.get_pythonhere_config()
+
+    def handle_config_change(
+        self, settings, config, section, key, value
+    ):  # pylint: disable=too-many-arguments, unused-argument
+        """Config change handler."""
+        if section == "pythonhere":
+            self.update_server_config_status()
+
     def on_start(self):
         """App start handler."""
         Logger.info("Python Here: app started")

pythonhere/pythonhere.kv

@@ -1,7 +1,11 @@
 #:kivy 1.0
 #:import RootLayout ui_here.layout_here.RootLayout
+#:import ScreenName enum_here.ScreenName
+#:import ServerState enum_here.ServerState
+#:import ServerScreenManager ui_here.server_screen_here.ServerScreenManager
 #:include ui_here/common_here.kv
 #:include ui_here/connection_address_here.kv
+#:include ui_here/server_screen_here.kv
 #:include ui_here/settings_here.kv
 
 RootLayout:
@@ -18,11 +22,11 @@ RootLayout:
             ScreenActionButton:
                 id: open_here_action
                 text: f"%{tc('H', 3)}ere"
-                screen: "here"
+                screen: ScreenName.here
             ScreenActionButton:
                 id: open_settings_action
                 text: f"{tc('S', 3)}ettings"
-                screen: "settings"
+                screen: ScreenName.settings
 
             ActionButton:
                 text: f"{tc('Q', 3)}uit"
@@ -33,10 +37,11 @@ RootLayout:
         Screen:
         Screen:
             id: here_screen
-            name: "here"
-            ConnectionAddressInfoBox:
-                id: address_info
+            name: ScreenName.here
+            ServerScreenManager:
+                id: here_screen_manager
         Screen:
             id: settings_screen
-            name: "settings"
+            name: ScreenName.settings
             SettingsHere:
+                id: settings

pythonhere/ui_here/connection_address_here.kv

@@ -17,10 +17,10 @@
     padding: '20sp', 0, 0, 0
 
     Label:
-        text: f"Connect {tc('here', 3)} via"
+        text: f"Server is running.\nConnect {tc('here', 3)} via"
         size_hint: 1, None
         text_size: self.size
-        height: self.texture_size[1]
+        height: "80sp"
         font_size: "30sp"
 
     ScrollView:
@@ -32,4 +32,3 @@
             orientation: "vertical"
             size_hint: 1, None
             height: self.minimum_size[1]
-

pythonhere/ui_here/server_screen_here.kv

@@ -0,0 +1,59 @@
+#:import FallOutTransition kivy.uix.screenmanager.FallOutTransition
+#:import App kivy.app.App
+
+<LoadingImage@Image>:
+    source: "data/images/image-loading.zip"
+    allow_stretch: True
+    pos_hint: {'center_x': 0.5, 'center_y': 0.4}
+    size_hint: None, None
+    size: sp(100), sp(100)
+
+<StackLabel@Label>:
+    size_hint: None, None
+    font_size: "20sp"
+    size: self.texture_size
+
+<ServerNotConfigured@Screen>:
+    name: "not_configured"
+    StackLayout:
+        orientation: "lr-tb"
+        padding: sp(20), 0, 0, 0
+        StackLabel:
+            text: "To start the "
+        StackLabel:
+            text: f"{tc('Python', 1)}{tc('here', 3)}, "
+        StackLabel:
+            text: "you "
+        StackLabel:
+            text: "need to "
+        StackLabel:
+            text: "edit the "
+        Button:
+            text: "Settings"
+            font_size: "20sp"
+            size_hint: None, None
+            width: self.texture_size[0] + sp(20)
+            height: sp(30)
+            on_release: App.get_running_app().root.switch_screen(ScreenName.settings)
+        StackLabel:
+            text: " section."
+
+<StartingServerScreen@Screen>:
+    Label:
+        text: f"Waiting {tc('Python', 1)}{tc('here', 3)} to start"
+        font_size: "30sp"
+    LoadingImage:
+
+<ServerScreenManager>:
+    app: app
+    transition: FallOutTransition()
+    Screen:
+        LoadingImage:
+    ServerNotConfigured:
+    Screen:
+        name: ServerState.not_configured
+    StartingServerScreen:
+        name: ServerState.starting_server
+    Screen:
+        name: ServerState.ready
+        ConnectionAddressInfoBox:

pythonhere/ui_here/server_screen_here.py

@@ -0,0 +1,24 @@
+"""%here server screen."""
+from kivy.clock import Clock
+from kivy.uix.screenmanager import ScreenManager
+
+from enum_here import ServerState
+
+
+class ServerScreenManager(ScreenManager):
+    """Screen manager for server %here section."""
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.update_event = Clock.schedule_interval(self.update, 0.5)
+
+    def update(self, _=None):
+        """Determines server state, and switch to appropriate screen."""
+        if self.app.ssh_server_config_ready.is_set():
+            if self.app.ssh_server_started.is_set():
+                self.current = ServerState.ready
+                Clock.unschedule(self.update_event)
+            else:
+                self.current = ServerState.starting_server
+        else:
+            self.current = ServerState.not_configured

pythonhere/ui_here/settings_here.kv

@@ -1,12 +1,13 @@
 #:kivy 1.0
 
 #:import SettingPassword ui_here.settings_here.SettingPassword
+#:import App kivy.app.App
 
 <ScreenActionButton@ActionToggleButton>:
     group: "screen"
     screen: ""
     allow_no_selection: False
-    on_release: app.root.switch_screen(self.screen)
+    on_release: App.get_running_app().root.switch_screen(self.screen)
 
 
 <SettingPassword>:

pythonhere/ui_here/settings_here.py

@@ -1,4 +1,6 @@
 """Settings panel widgets."""
+from typing import Any, Dict
+
 from kivy.config import Config
 from kivy.properties import ObjectProperty  # pylint: disable=no-name-in-module
 from kivy.uix.label import Label
@@ -9,26 +11,26 @@
 [
     {
         "type": "title",
-        "title": "SSH server"
+        "title": "%here server"
     },
     {
         "type": "string",
-        "title": "Login",
-        "desc": "SSH login",
+        "title": "Username",
+        "desc": "Username to ask (THERE_USERNAME)",
         "section": "pythonhere",
-        "key": "login"
+        "key": "username"
     },
     {
         "type": "password",
         "title": "Password",
-        "desc": "SSH password",
+        "desc": "Password to ask (THERE_PASSWORD)",
         "section": "pythonhere",
         "key": "password"
     },
     {
         "type": "numeric",
         "title": "Port",
-        "desc": "SSH server port number",
+        "desc": "Server port number, to start on this device (THERE_PORT)",
         "section": "pythonhere",
         "key": "port"
     }
@@ -74,7 +76,15 @@ def __init__(self, *args, **kargs):
         self.register_type("password", SettingPassword)
 
         Config.setdefaults(
-            "pythonhere", {"login": "here", "password": "", "port": 8022}
+            "pythonhere", {"username": "here", "password": "", "port": 8022}
         )
         self.add_json_panel("Python Here", Config, data=SETTINGS_HERE)
         self.add_kivy_panel()
+
+    def get_pythonhere_config(self) -> Dict[str, Any]:
+        """Extract server parts of the config."""
+        return {
+            "username": Config.get("pythonhere", "username"),
+            "password": Config.get("pythonhere", "password"),
+            "port": Config.getint("pythonhere", "port"),
+        }

tests/config.ini

@@ -0,0 +1,4 @@
+[pythonhere]
+username = here
+password = there
+port = 8022

tests/conftest.py

@@ -2,6 +2,8 @@
 
 import nest_asyncio
 import pytest
+from kivy.config import Config
+from kivy.core.window import Window
 
 from herethere.everywhere import ConnectionConfig
 from herethere.there.client import Client
@@ -10,7 +12,6 @@
 from main import PythonHereApp, run_ssh_server
 
 
-
 @pytest.fixture
 def connection_config():
     return ConnectionConfig(
@@ -22,7 +23,12 @@ def connection_config():
 
 
 @pytest.fixture
-async def app_instance():
+def app_config():
+    Config.read("../tests/config.ini")
+
+
+@pytest.fixture
+async def app_instance(capfd, app_config):
     app = PythonHereApp()
     app_task = asyncio.ensure_future(app.async_run_app())
     server_task = asyncio.ensure_future(run_ssh_server(app))
@@ -31,6 +37,8 @@ async def app_instance():
     server_task.cancel()
     app_task.cancel()
     await asyncio.gather(app_task, server_task)
+    app.root.clear_widgets()
+    Window.children.clear()
 
 
 @pytest.fixture