Skip to contentSkip to conversation

prserv: add --status to list running servers

PATCH In review Babanpreet Singh 2 participants 4 messages Aug 24 – Sep 15

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 prserv: add --status to list running servers

bitbake-prserv could start and stop a server but not say what is running. Add --status: it reads every /tmp/PRServer_<ip>_<port>.pid, reports each server as running (with its pid) or as a stale pidfile, and exits 0 if at least one server is alive, 1 otherwise.

Extend the ScriptTests start/stop lifecycle with status checks in both states.

[YOCTO #10865]

---
 bin/bitbake-prserv  |  7 +++++++
 lib/prserv/serv.py  | 23 +++++++++++++++++++++++
 lib/prserv/tests.py | 16 +++++++++++++++-
 3 files changed, 45 insertions(+), 1 deletion(-)
bin/bitbake-prserv +7 -0
index c26362b2e..8413c585f 100755
@@ -64,6 +64,11 @@ def main():
         action="store_true",
         help="stop daemon",
     )
+    parser.add_argument(
+        "--status",
+        action="store_true",
+        help="list PR servers running on this machine",
+    )
     parser.add_argument(
         "--host",
         help="ip address to bind",
@@ -102,6 +107,8 @@ def main():
         )
     elif args.stop:
         ret=prserv.serv.stop_daemon(args.host, args.port)
+    elif args.status:
+        ret=prserv.serv.status_daemon()
     else:
         ret=parser.print_help()
     return ret
lib/prserv/serv.py +23 -0
index e17588630..322c22a0f 100644
@@ -388,6 +388,29 @@ def stop_daemon(host, port):
 
     return 0
 
+def status_daemon():
+    import glob
+    running = 0
+    for pidfile in sorted(glob.glob(PIDPREFIX % ("*", "*"))):
+        root, _ = os.path.splitext(os.path.basename(pidfile))
+        parts = root.split("_")
+        ip, port = "_".join(parts[1:-1]), parts[-1]
+        try:
+            with open(pidfile) as pf:
+                pid = int(pf.readline().strip())
+        except (IOError, ValueError):
+            sys.stderr.write("Ignoring unreadable pidfile %s\n" % pidfile)
+            continue
+        if is_running(pid):
+            print("PRServer running at %s:%s (pid %s)" % (ip, port, pid))
+            running += 1
+        else:
+            print("Stale pidfile %s (pid %s not running)" % (pidfile, pid))
+    if not running:
+        print("No PRServer running.")
+        return 1
+    return 0
+
 def is_running(pid):
     try:
         os.kill(pid, 0)
lib/prserv/tests.py +15 -1
index df0c00300..518d5c441 100644
@@ -381,8 +381,22 @@ class ScriptTests(unittest.TestCase):
         except subprocess.CalledProcessError as e:
             self.fail("Failed to start bitbake-prserv: %s" % e.returncode)
 
-    def test_2_stop_bitbake_prserv(self):
+    def test_2_status_bitbake_prserv(self):
+        result = subprocess.run([BIN_DIR / "bitbake-prserv", "--status"],
+                                capture_output=True, text=True)
+        self.assertEqual(result.returncode, 0,
+                         "Expected a running PRServer: %s" % result.stdout)
+        self.assertIn(":8585 (pid ", result.stdout)
+
+    def test_3_stop_bitbake_prserv(self):
         try:
             subprocess.check_call([BIN_DIR / "bitbake-prserv", "--stop"])
         except subprocess.CalledProcessError as e:
             self.fail("Failed to stop bitbake-prserv: %s" % e.returncode)
+
+    def test_4_status_stopped_bitbake_prserv(self):
+        result = subprocess.run([BIN_DIR / "bitbake-prserv", "--status"],
+                                capture_output=True, text=True)
+        self.assertEqual(result.returncode, 1,
+                         "Expected no running PRServer: %s" % result.stdout)
+        self.assertNotIn(":8585 (pid ", result.stdout)
Signature · 1 line
2.43.0
#1 lore raw

Hi,

A gentle ping on this one. bitbake master has moved since the send (now 18cca50ba); I've checked the patch still applies cleanly, so no rebase is needed. Happy to rebase and resend if that's more convenient.

Thanks,
Baban

#2 lore raw
In reply to Babanpreet Singh
Quoted 8 lines · Baban via lists.openembedded.org

bitbake-prserv could start and stop a server but not say what is running. Add --status: it reads every /tmp/PRServer_<ip>_<port>.pid, reports each server as running (with its pid) or as a stale pidfile, and exits 0 if at least one server is alive, 1 otherwise.

Extend the ScriptTests start/stop lifecycle with status checks in both states.

Quoted 8 lines

[YOCTO #10865]

---
 bin/bitbake-prserv  |  7 +++++++
 lib/prserv/serv.py  | 23 +++++++++++++++++++++++
 lib/prserv/tests.py | 16 +++++++++++++++-

 3 files changed, 45 insertions(+), 1 deletion(-)

Thanks for this, I've been meaning to do this for a long time!

Unfortunately this patch does seem to be causing failures in our automated testing:

https://autobuilder.yoctoproject.org/valkyrie/#/builders/48/builds/4607

I did wonder if the code needs to cope with the port already being in use too?

Cheers,

Richard

#3 lore raw
Quoted 7 lines · Richard Purdie

Unfortunately this patch does seem to be causing failures in our automated testing:

https://autobuilder.yoctoproject.org/valkyrie/#/builders/48/builds/4607

I did wonder if the code needs to cope with the port already being in use too?

Thanks, and sorry for the noise. The server dies right after writing its pidfile there. The old stop test didn't catch that either, since --stop is happy with a stale pidfile. I can't tell from the logs what kills it on the workers, but a busy port gives me the same failure locally. I'll send a v2 that makes --start wait for the server and fail with its error and puts --status on top of that.

Thanks,
Baban