Merge pull request #2 from dmgav/ci-config

CI configuration

Author: dmgav

.github/workflows/ci.yml_

@@ -19,7 +19,7 @@ jobs:
         shell: bash -l {0}
 
     steps:
-      - name: Checkout the branch
+      - name: Checkout
         uses: actions/checkout@v3
 
       - name: Set up Python

.github/workflows/pre-commit.yml

@@ -0,0 +1,38 @@
+name: Unit Tests
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+      fail-fast: false
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        pip install .[dev]
+        pip list
+
+    - name: Start save-and-restore service
+      run: |
+        pushd container
+        ./start-save-and-restore.sh
+        popd
+
+    - name: Test with pytest
+      run: |
+        # pytest -k test_ip_kernel_func -vvv
+        coverage run -m pytest -vv
+        coverage report -m

.github/workflows/testing.yml

@@ -0,0 +1,10 @@
+import socket
+
+if __name__ == "__main__":
+    # Get the local IP address
+    s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+    s.connect(("8.8.8.8", 80))
+    ip = s.getsockname()[0]
+
+    with open(".env", "w") as f:
+        f.write(f"HOST_EXTERNAL_IP_ADDRESS={ip}")

container/create_env_file.py

@@ -0,0 +1,47 @@
+# Running elasticsearch in docker
+#   sudo docker compose -f save-and-restore.yml up -d
+# Test:
+#   curl -X GET "http://localhost:9200/"
+
+# .env file:
+#
+# HOST_EXTERNAL_IP_ADDRESS=192.168.50.49
+
+services:
+  saveandrestore:
+    image: ghcr.io/controlsystemstudio/phoebus/service-save-and-restore:master
+    ports:
+      - "8080:8080"
+    depends_on:
+      - elasticsearch
+    environment:
+      ELASTICSEARCH_NETWORK_HOST: ${HOST_EXTERNAL_IP_ADDRESS}
+      EPICS_PVA_ADDR_LIST: ${HOST_EXTERNAL_IP_ADDRESS}
+      EPICS_PVA_AUTO_ADDR_LIST: "NO"
+      EPICS_PVA_ENABLE_IPV6: "false"
+    command: >
+      /bin/bash -c "
+        until curl --fail --silent http://${HOST_EXTERNAL_IP_ADDRESS}:9200/_cluster/health; do
+            echo 'Waiting for Elasticsearch'
+          sleep 1
+        done
+        java -DdefaultProtocol=pva -Dauthorization.permitall=false -Dauth.impl=demo -jar /saveandrestore/service-save-and-restore-*.jar"
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+
+  elasticsearch:
+    image: docker.elastic.co/elasticsearch/elasticsearch:8.11.2
+    ports:
+      - "9200:9200"
+    environment:
+      discovery.type: single-node
+      bootstrap.memory_lock: "true"
+      xpack.security.enabled: "false"
+    volumes:
+      - saveandrestore-es-data:/usr/share/elasticsearch/data
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+
+volumes:
+  saveandrestore-es-data:
+    driver: local

container/save-and-restore.yml

@@ -0,0 +1,8 @@
+set -x
+
+python create_env_file.py
+sudo docker compose -f save-and-restore.yml up -d
+python wait_for_startup.py
+
+# Wait until the service is started.
+#sleep 30

container/start-save-and-restore.sh

@@ -0,0 +1,23 @@
+import time
+
+import httpx
+
+t_wait = 120
+BASE_URL = "http://localhost:8080/save-restore"
+root_node_uid = "44bef5de-e8e6-4014-af37-b8f6c8a939a2"
+
+if __name__ == "__main__":
+    t_start = time.time()
+    url = f"/node/{root_node_uid}"
+    with httpx.Client(base_url=BASE_URL, timeout=1) as client:
+        while time.time() - t_start < t_wait:
+            try:
+                response = client.request("GET", url)
+                if response.status_code == 200:
+                    print("Success: save-and-restore server is up")
+                    exit(0)
+            except Exception:
+                pass
+
+    print(f"TIMEOUT: save-and-restore server failed to start in {t_wait} seconds")
+    exit(1)

container/wait_for_startup.py

@@ -110,6 +110,7 @@ extend-select = [
     "I",   # isort - https://docs.astral.sh/ruff/rules/#isort-i
     "UP",  # pyupgrade - https://docs.astral.sh/ruff/rules/#pyupgrade-up
 ]
+unfixable = ["F401"]
 ignore = [
 ]
 isort.required-imports = [

pyproject.toml

@@ -29,7 +29,7 @@ def ROOT_NODE_UID(self):
 
     def open(self):
         auth = httpx.BasicAuth(username=self._username, password=self._password)
-        self._client = httpx.Client(base_url=BASE_URL, timeout=timeout, auth=auth)
+        self._client = httpx.Client(base_url=self._base_url, timeout=timeout, auth=auth)
 
     def close(self):
         self._client.close()

src/save_and_restore_api/tools/upload.py

@@ -3,7 +3,23 @@
 import importlib.metadata
 
 import save_and_restore_api as m
+from save_and_restore_api.tools.upload import SaveRestoreAPI
 
 
 def test_version():
     assert importlib.metadata.version("save_and_restore_api") == m.__version__
+
+
+def test_import():
+    from save_and_restore_api.tools.upload import SaveRestoreAPI  # noqa: F401
+
+
+def test_comm():
+    SR = SaveRestoreAPI(base_url="http://localhost:8080/save-restore", timeout=2)
+    # SR.set_username_password(username="johndoe", password="1234")
+    SR.set_username_password(username="user", password="userPass")
+    # SR.set_username_password(username="admin", password="adminPass")
+    SR.open()
+    SR.login()
+    SR.get_node(SR.ROOT_NODE_UID)
+    SR.close()