Merge pull request #398 from linien-org/release/v2.0.2

Release v2.0.2

.github/workflows/mypy.yml

@@ -20,7 +20,7 @@ jobs:
 
     steps:
       - name: Check out repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Linien
         uses: ./.github/actions/install-linien

.github/workflows/publish-pypi.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           lfs: "true"
 

.github/workflows/publish-test-pypi.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           lfs: "true"
 

.github/workflows/pyinstaller-linux.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -41,7 +41,7 @@ jobs:
       - run: pyinstaller pyinstaller.spec
         working-directory: linien-gui
 
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: linien-gui-linux
           path: linien-gui/dist/*

.github/workflows/pyinstaller-windows.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: windows-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -28,7 +28,7 @@ jobs:
       - run: pyinstaller pyinstaller.spec
         working-directory: linien-gui
 
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: linien-gui-windows
           path: linien-gui/dist/*

.github/workflows/pytest.yml

@@ -20,7 +20,7 @@ jobs:
 
     steps:
       - name: Check out repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Linien
         uses: ./.github/actions/install-linien

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 24.3.0
+    rev: 24.4.2
     hooks:
       - id: black
         exclude: ^(gateware/logic/|gateware/lowlevel/|gateware/linien_module.py|linien-server/linien_server/csrmap.py)
@@ -12,7 +12,7 @@ repos:
         name: isort (python)
 
   - repo: https://github.com/pycqa/flake8
-    rev: 6.1.0
+    rev: 7.0.0
     hooks:
       - id: flake8
         exclude: linien-server/linien_server/csrmap.py

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.2] - 2024-05-14
+
+### Fixed
+* Improved performance of server CLI by @bleykauf in https://github.com/linien-org/linien/pull/396
+* API token for InfluxDB is now checked by @bleykauf in https://github.com/linien-org/linien/pull/397
+
 ## [2.0.1] - 2024-05-13
 
 ### Fixed
@@ -210,7 +216,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * **Bug fixes and performance improvements**
 
-
+[Unreleased]: https://github.com/linien-org/linien/compare/v2.0.1...v2.0.2
 [2.0.1]: https://github.com/linien-org/linien/compare/v2.0.0...v2.0.1
 [2.0.0]: https://github.com/linien-org/linien/compare/v1.0.2...v2.0.0
 [1.0.2]: https://github.com/linien-org/linien/compare/v1.0.1...v1.0.2

linien-client/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "linien-client"
-version = "2.0.1"
+version = "2.0.2"
 authors = [
     { name = "Benjamin Wiegand", email = "[email protected]" },
     { name = "Bastian Leykauf", email = "[email protected]" },
@@ -25,7 +25,7 @@ requires-python = ">=3.8"
 dependencies = [
     "fabric>=2.7.0,<3.0",
     "typing_extensions>=4.5.0,<5.0",
-    "linien-common==2.0.1",
+    "linien-common==2.0.2",
 ]
 
 [project.readme]

linien-common/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "linien-common"
-version = "2.0.1"
+version = "2.0.2"
 authors = [
     { name = "Benjamin Wiegand", email = "[email protected]" },
     { name = "Bastian Leykauf", email = "[email protected]" },

linien-gui/linien_gui/ui/logging_panel.py

@@ -33,7 +33,7 @@
 
 class LoggingPanel(QtWidgets.QWidget):
     set_parameter_log = pyqtSignal(str, bool)
-    influx_credentials_update = pyqtSignal(bool, int, str)
+    influx_credentials_update = pyqtSignal(bool, str)
 
     logParametersToolButton: "LoggedParametersToolButton"
     lineEditURL: QtWidgets.QLineEdit
@@ -78,6 +78,10 @@ def on_connection_established(self) -> None:
         self.lineEditBucket.setText(credentials.bucket)
         self.lineEditMeas.setText(credentials.measurement)
 
+        # hide test indicator that might be set from previous connection to a different
+        # device
+        self.influxTestIndicator.setText("")
+
         # getting the logging status from the remote
         log_status = self.control.exposed_get_logging_status()
         button_text = STOP_LOG_BUTTON_TEXT if log_status else START_LOG_BUTTON_TEXT
@@ -106,28 +110,20 @@ def on_influx_update_button_clicked(self) -> None:
             bucket=self.lineEditBucket.text(),
             measurement=self.lineEditMeas.text(),
         )
-        (
-            success,
-            status_code,
-            message,
-        ) = self.control.exposed_update_influxdb_credentials(credentials)
-        update_msg = f"Update of InfluxDB credentials successful: {success}"
-        if not success:
-            update_msg += f" (Status {status_code}): {message}"
+        (success, message) = self.control.exposed_update_influxdb_credentials(
+            credentials
+        )
+        update_msg = f"Update of InfluxDB credentials successful: {success}: {message}"
         logger.info(update_msg)
-        self.influx_credentials_update.emit(success, status_code, message)
+        self.influx_credentials_update.emit(success, message)
 
-    def on_influxdb_credentials_updated(
-        self, success: bool, status_code: int, message: str
-    ) -> None:
+    def on_influxdb_credentials_updated(self, success: bool, message: str) -> None:
         if success:
             self.influxTestIndicator.setText("✅")
-            self.influxTestIndicator.setToolTip("Connection successful")
+            self.influxTestIndicator.setToolTip(f"Connection successful: {message}")
         else:
             self.influxTestIndicator.setText("❌")
-            self.influxTestIndicator.setToolTip(
-                f"Connection failed: {message} (Status {status_code})"
-            )
+            self.influxTestIndicator.setToolTip(f"Connection failed: {message}.")
 
 
 # checkable menu for logged parameters, inspired by

linien-gui/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "linien-gui"
-version = "2.0.1"
+version = "2.0.2"
 authors = [
     { name = "Benjamin Wiegand", email = "[email protected]" },
     { name = "Bastian Leykauf", email = "[email protected]" },
@@ -28,7 +28,7 @@ dependencies = [
     "PyQt5>=5.12.0,<6.0",
     "requests>=2.31.0,<3.0",
     "superqt>=0.2.3",
-    "linien_client==2.0.1",
+    "linien_client==2.0.2",
 ]
 
 [project.readme]

linien-server/linien_server/cli.py

@@ -23,16 +23,6 @@
 from typing import Optional
 
 import fire
-from linien_common.communication import (
-    no_authenticator,
-    username_and_password_authenticator,
-)
-from linien_server import __version__, mdio_tool
-from linien_server.server import (
-    FakeRedPitayaControlService,
-    RedPitayaControlService,
-    run_threaded_server,
-)
 
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.DEBUG)
@@ -49,6 +39,8 @@ def copy_systemd_service_file() -> None:
 class LinienServerCLI:
     def version(self) -> str:
         """Return the version of the Linien server."""
+        from linien_server import __version__
+
         return __version__
 
     def start(self) -> None:
@@ -76,6 +68,17 @@ def run(self, fake: bool = False, host: Optional[str] = None) -> None:
             fake: Whether to run a fake server.
             host: The hostname of the Red Pitaya.
         """
+        from linien_common.communication import (
+            no_authenticator,
+            username_and_password_authenticator,
+        )
+        from linien_server import mdio_tool
+        from linien_server.server import (
+            FakeRedPitayaControlService,
+            RedPitayaControlService,
+            run_threaded_server,
+        )
+
         if fake:
             control = FakeRedPitayaControlService()
         else:

linien-server/linien_server/influxdb.py

@@ -20,6 +20,7 @@
 
 from influxdb_client import InfluxDBClient
 from influxdb_client.client.write_api import SYNCHRONOUS
+from influxdb_client.rest import ApiException
 from linien_common.communication import ParameterValues
 from linien_common.influxdb import InfluxDBCredentials, save_credentials
 from linien_server.parameters import Parameters
@@ -29,7 +30,7 @@ class InfluxDBLogger:
     def __init__(
         self, credentials: InfluxDBCredentials, parameters: Parameters
     ) -> None:
-        self.credentials: InfluxDBClient = credentials
+        self.credentials: InfluxDBCredentials = credentials
         self.parameters: Parameters = parameters
         self.stop_event = Event()
         self.stop_event.set()
@@ -53,7 +54,7 @@ def update_connection(self) -> InfluxDBClient:
         self.write_api = client.write_api(write_options=SYNCHRONOUS)
 
     def start_logging(self, interval: float) -> None:
-        conn_success, status_code, message = self.test_connection(self.credentials)
+        conn_success, message = self.test_connection(self.credentials)
         self.thread = Thread(
             target=self._logging_loop,
             args=(interval,),
@@ -63,10 +64,7 @@ def start_logging(self, interval: float) -> None:
             self.stop_event.clear()
             self.thread.start()
         else:
-            raise ConnectionError(
-                "Failed to connect to InfluxDB database: "
-                f" {message} (Status code: {status_code})"
-            )
+            raise ConnectionError(f"Failed to connect to InfluxDB database: {message}")
 
     def stop_logging(self) -> None:
         self.stop_event.set()
@@ -85,21 +83,35 @@ def _logging_loop(self, interval: float) -> None:
             self.write_data(self.credentials, data)
             sleep(interval)
 
-    def test_connection(
-        self, credentials: InfluxDBCredentials
-    ) -> tuple[bool, int, str]:
+    def test_connection(self, credentials: InfluxDBCredentials) -> tuple[bool, str]:
         """Write empty data to the server to test the connection"""
         client = InfluxDBClient(
             url=credentials.url,
             token=credentials.token,
             org=credentials.org,
         )
 
-        # FIXME: This does not test the credentials, yet.
-        status_code = 0
-        message = ""
-        success = client.ping()
-        return success, status_code, message
+        health = client.health()
+        message = health.message
+        success = health.status == "pass"
+        if success:
+            try:
+                client.write_api(write_options=SYNCHRONOUS).write(
+                    bucket=credentials.bucket,
+                    org=credentials.org,
+                    record={
+                        "measurement": credentials.measurement,
+                        "fields": {},
+                    },
+                )
+            except ApiException as e:
+                success = False
+                message = e.message
+            except Exception:
+                success = False
+                message = "Exception occurred. Check server log file for details."
+
+        return success, message
 
     def write_data(
         self, credentials: InfluxDBCredentials, fields: dict[str, ParameterValues]

linien-server/linien_server/server.py

@@ -118,22 +118,18 @@ def exposed_get_parameter_log(self, param_name: str) -> bool:
 
     def exposed_update_influxdb_credentials(
         self, credentials: InfluxDBCredentials
-    ) -> tuple[bool, int, str]:
+    ) -> tuple[bool, str]:
         credentials = copy(credentials)
         (
             connection_succesful,
-            status_code,
             message,
         ) = self.influxdb_logger.test_connection(credentials)
         if connection_succesful:
             self.influxdb_logger.credentials = credentials
             logger.info("InfluxDB credentials updated successfully")
         else:
-            logger.info(
-                "InfluxDB credentials update failed. Error message: "
-                f" {message} (Status Code {status_code})"
-            )
-        return connection_succesful, status_code, message
+            logger.info(f"InfluxDB credentials update failed. Error message: {message}")
+        return connection_succesful, message
 
     def exposed_get_influxdb_credentials(self) -> InfluxDBCredentials:
         return self.influxdb_logger.credentials

linien-server/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "linien-server"
-version = "2.0.1"
+version = "2.0.2"
 authors = [
     { name = "Benjamin Wiegand", email = "[email protected]" },
     { name = "Bastian Leykauf", email = "[email protected]" },
@@ -28,7 +28,7 @@ dependencies = [
     "influxdb-client[ciso]>=1.9,<2.0",
     "pylpsd>=0.1.4",
     "pyrp3>=2.0.1,<3.0;platform_machine=='armv7l'",
-    "linien-common==2.0.1",
+    "linien-common==2.0.2",
 ]
 
 [project.readme]