From 116d43149681a935ef1efb059ba3d1241ccd3015 Mon Sep 17 00:00:00 2001
From: jason yang <jasonyangshadow@gmail.com>
Date: Fri, 18 Oct 2024 21:40:25 +0000
Subject: [PATCH] update DMTCP checkpoint demo code

Signed-off-by: jason yang <jasonyangshadow@gmail.com>
Signed-off-by: Dave Dykstra <2129743+DrDaveD@users.noreply.github.com>
---
 .github/workflows/pull_request.yml |  5 +-
 apptainer_source                   |  2 +-
 checkpoint.rst                     | 87 +++++++++++++++---------------
 3 files changed, 50 insertions(+), 44 deletions(-)

diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
index cb995b45..a401946b 100644
--- a/.github/workflows/pull_request.yml
+++ b/.github/workflows/pull_request.yml
@@ -34,7 +34,10 @@ jobs:
 
       - name: Install Sphinx
         run: |
-          pip install --user --upgrade --upgrade-strategy eager setuptools sphinx sphinx-rtd-theme restructuredtext_lint rstcheck pygments m2r2
+          # docutils==0.16 is a temporary downgrade to fix a compiling issue
+          # see https://github.com/CrossNox/m2r2/issues/68
+          # requiring docutils version <0.21
+          pip install --user --upgrade --upgrade-strategy eager docutils==0.16 setuptools sphinx sphinx-rtd-theme restructuredtext_lint rstcheck pygments m2r2
 
       - name: Lint rst
         run: |
diff --git a/apptainer_source b/apptainer_source
index c9a8d47c..35d693d6 160000
--- a/apptainer_source
+++ b/apptainer_source
@@ -1 +1 @@
-Subproject commit c9a8d47ccbc2ac91ee134e5f682dc92fc3d98152
+Subproject commit 35d693d63ac960a558ef686753dacdf4767c10fa
diff --git a/checkpoint.rst b/checkpoint.rst
index faff560d..ad73ae8c 100644
--- a/checkpoint.rst
+++ b/checkpoint.rst
@@ -99,45 +99,36 @@ state has been successfully restored upon restart.
 .. code::
 
     Bootstrap: docker
-    From: python:3.10-buster
-
+    From: python:3.10-bookworm
+    
     %post
         mkdir /app
         cat > /app/server.py <<EOF
+    import socketserver
     import argparse
-    from http.server import BaseHTTPRequestHandler, HTTPServer
-
-    state = "0"
-
+    
+    count = 0
+    
     parser = argparse.ArgumentParser(description='Optional app description')
     parser.add_argument('port', type=int, help='A required integer port argument')
     args = parser.parse_args()
-
-    class handler(BaseHTTPRequestHandler):
-        def do_GET(self):
-            self.send_response(200)
-            self.send_header('Content-type','text/plain')
-            self.end_headers()
-
-            self.wfile.write(bytes(state, "utf8"))
-        def do_POST(self):
-            self.send_response(200)
-            self.send_header('Content-type','text/plain')
-            self.end_headers()
-
-            global state
-            state = self.rfile.read(1).decode("utf8")
-            self.wfile.write(bytes(state, "utf8"))
-
-
-    with HTTPServer(('', args.port), handler) as server:
-        server.serve_forever()
+    
+    class Handler(socketserver.BaseRequestHandler):
+        def handle(self):
+            global count
+            count += 1
+            response = bytes("request:{}\n".format(count), "ascii")
+            self.request.sendall(response)
+    
+    if __name__ == "__main__":
+        with socketserver.TCPServer(('', args.port), Handler) as server:
+            server.allow_reuse_address = True
+            server.serve_forever()
     EOF
-
+    
     %startscript
         python3 /app/server.py $@
 
-
 We can build this container using:
 
 .. code::
@@ -168,21 +159,19 @@ the state of a variable on the server.
 
 .. code::
 
-    $ curl localhost:8888; echo
-    0
+    $ curl --http0.9 localhost:8888
+    request:1
 
-We can see that it is set to ``0`` by default when this application is started
-normally. We can now update the state of the server from ``0`` to ``1`` with
-the following ``POST`` request:
+We can see that the request count value is ``1`` when this application is started
+and accessed via curl. After making another call to the application, we can see that the request
+count is ``2`` as expected.
 
 .. code::
 
-    $ curl -X POST localhost:8888 -d '1'; echo
-    1
-    $ curl localhost:8888; echo
-    1
+    $ curl --http0.9 localhost:8888
+    request:2
 
-Now that variable on our server is in a new state, ``1``, we can use the
+Now that the request count variable on our server is in a new state, ``2``, we can use the
 ``checkpoint instance`` command and reference the instance via the
 ``instance://`` URI format:
 
@@ -210,14 +199,28 @@ our application's state:
     INFO:    instance started successfully
 
 
-And now we can verify the variable on the server has been properly restored to
-a value of ``1``, instead of the default of ``0``:
+And now when we get access to the application again, the request count value is ``3`` as expected,
+meaning that the previous request count value was ``2``.
 
 .. code::
 
-    $ curl localhost:8888; echo
-    1
+    $ curl --http0.9 localhost:8888
+    $ request:3
+
+We can repeat the previous two steps, i.e. stop the server instance and restart it via dmtcp to verify the restoration
+of the value of the request count.
+
+.. code::
+
+    $ {command} instance stop server
+    $ {command} instance start --dmtcp-restart example-checkpoint server.sif restarted-server 8888
+
+Then access the application and see that the request count value is restored as expected. 
+
+.. code::
 
+    $ curl --http0.9 localhost:8888
+    $ request:3
 
 Finally, we can stop our instance running our restored application and delete our
 checkpoint if we no longer need it to restart our application from this state: