Tweak terminology: stop -> finish

Author: xrchz

TODO

@@ -1,5 +1,3 @@
-TODO: Rename "stop" terminology to "finish".
-
 TODO: Wait after the refresh API is hit before querying for changes on GitHub.
   It seems like it takes a while (probably ~1min is fine) for mergable pull
   requests to show up. (Or investigate why this is happening.) Note: the API

apiLib.sml

@@ -46,29 +46,29 @@ Reference:
       returns "Uploaded"
       fails (409) if a file called <name> already exists for <id>
 
-    stop id:
-      mark job <id> as stopped
-      returns "Stopped"
+    finish id:
+      mark job <id> as finished
+      returns "Finished"
       sends email with output
       fails (409) if <id> is not currently running
 
     abort id:
       mark job <id> as aborted
       returns "Aborted"
-      fails (409) if <id> is not currently stopped
+      fails (409) if <id> is not currently finished
 
   all failures return text starting with "Error:"
 
 Jobs move (right only) between these states:
 
-  waiting, running, stopped, aborted
+  waiting, running, finished, aborted
 
 waiting = ready to be run, waiting for a worker
 running = claimed to be running by a worker
-stopped = finished either with success or failure
+finished = finished either with success or failure
 aborted = the worker did not finish properly
 
-When the waiting queue is refreshed, the commits of running or stopped jobs are
+When the waiting queue is refreshed, the commits of running or finished jobs are
 not considered to need running again, whereas the commits of aborted jobs are
 (as long as they are still the latest commits).
 
@@ -101,14 +101,14 @@ datatype post_api =
   | Append of id * line (* not including newline *)
   | Log of id * string * int
   | Upload of id * string * int
-  | Stop of id
+  | Finish of id
   | Abort of id
 datatype api = G of get_api | P of post_api
 
 fun post_response Refresh = "Refreshed\n"
   | post_response (Claim _) = "Claimed\n"
   | post_response (Append _) = "Appended\n"
-  | post_response (Stop _) = "Stopped\n"
+  | post_response (Finish _) = "Finished\n"
   | post_response (Abort _) = "Aborted\n"
   | post_response (Log _) = "Logged\n"
   | post_response (Upload _) = "Uploaded\n"
@@ -142,14 +142,14 @@ fun api_to_string (G Waiting) = "/waiting"
   | api_to_string (G (Job id)) = String.concat["/job/",Int.toString id]
   | api_to_string (P (Claim (id,_))) = String.concat["/claim/",Int.toString id]
   | api_to_string (P (Append (id,_))) = String.concat["/append/",Int.toString id]
-  | api_to_string (P (Stop id)) = String.concat["/stop/",Int.toString id]
+  | api_to_string (P (Finish id)) = String.concat["/finish/",Int.toString id]
   | api_to_string (P (Abort id)) = String.concat["/abort/",Int.toString id]
 
 fun post_curl_args (Append (_,line)) = ["--data-urlencode",String.concat["line=",line]]
   | post_curl_args (Claim  (_,name)) = ["--data-urlencode",String.concat["name=",name]]
   | post_curl_args (Log    (_,file,_)) = ["--data-binary",String.concat["@",file]]
   | post_curl_args (Upload (_,file,_)) = ["--data",String.concat["name=",List.last(#arcs(OS.Path.fromString file))],"--data-binary",String.concat["@",file]]
-  | post_curl_args (Stop  _) = ["--data",""]
+  | post_curl_args (Finish _) = ["--data",""]
   | post_curl_args (Abort _) = ["--data",""]
   | post_curl_args (Refresh) = ["--data",""]
 
@@ -209,7 +209,7 @@ fun post_from_string s len =
                     (fn id => Option.map (fn (name,l) => Upload(id,name,l))
                                          (Option.mapPartial read_name len))
                     (id_from_string n)
-  | ["stop",n] => Option.map Stop (id_from_string n)
+  | ["finish",n] => Option.map Finish (id_from_string n)
   | ["abort",n] => Option.map Abort (id_from_string n)
   | _ => NONE)
 

server.sml

@@ -6,7 +6,7 @@ It also provides a hook for refreshing the queues:
   If there are new jobs on GitHub, they will be added as waiting.
   If there are stale jobs, they will be removed.
 
-Each job is on exactly one list: waiting, running, stopped, aborted.
+Each job is on exactly one list: waiting, running, finished, aborted.
 If a job changes list, it can only move to the right.
 
 The waiting queue is refreshed as follows:
@@ -15,7 +15,7 @@ The waiting queue is refreshed as follows:
   2. Get the current snapshots from GitHub (see below)
   3. Filter out from the snapshots:
     - any with the same CakeML head commit as a running job
-    - any with the same snapshot (head+base+HOL commits) as a stopped job
+    - any with the same snapshot (head+base+HOL commits) as a finished job
   4. Add the remaining snapshots to the waiting jobs list
 
 The running queue may be refreshed by removing timed out jobs. (Not implemented yet.)
@@ -105,18 +105,18 @@ fun upload (id,name,len) =
     (* TODO: update link on downloads page on CakeML main site? *)
   end
 
-fun stop id =
+fun finish id =
   let
     val f = Int.toString id
     val old = OS.Path.concat("running",f)
-    val new = OS.Path.concat("stopped",f)
+    val new = OS.Path.concat("finished",f)
     val fd = acquire_lock ()
     val () =
       if OS.FileSys.access(old,[OS.FileSys.A_READ]) then
         if OS.FileSys.access(new,[OS.FileSys.A_READ]) then
-          cgi_die 500 ["job ",f, " is both running and stopped"]
+          cgi_die 500 ["job ",f, " is both running and finished"]
         else OS.FileSys.rename{old = old, new = new}
-      else cgi_die 409 ["job ",f," is not running: cannot stop"]
+      else cgi_die 409 ["job ",f," is not running: cannot finish"]
     val inp = TextIO.openIn new
     val sha = get_head_sha (read_bare_snapshot inp)
     val status = read_status inp
@@ -134,15 +134,15 @@ fun stop id =
 fun abort id =
   let
     val f = Int.toString id
-    val old = OS.Path.concat("stopped",f)
+    val old = OS.Path.concat("finished",f)
     val new = OS.Path.concat("aborted",f)
     val fd = acquire_lock ()
   in
     if OS.FileSys.access(old,[OS.FileSys.A_READ]) then
       if OS.FileSys.access(new,[OS.FileSys.A_READ]) then
-        cgi_die 500 ["job ",f, " is both stopped and aborted"]
+        cgi_die 500 ["job ",f, " is both finished and aborted"]
       else (OS.FileSys.rename{old = old, new = new}; Posix.IO.close fd)
-    else cgi_die 409 ["job ",f," is not stopped: cannot abort"]
+    else cgi_die 409 ["job ",f," is not finished: cannot abort"]
   end
 
 fun refresh () =
@@ -152,10 +152,10 @@ fun refresh () =
     val () = clear_list "waiting"
     (* TODO: stop timed out jobs *)
     val running_ids = running()
-    val stopped_ids = stopped()
+    val finished_ids = finished()
     val snapshots = filter_out (same_head "running") running_ids snapshots
-    val snapshots = filter_out (same_snapshot "stopped") stopped_ids snapshots
-    val avoid_ids = running_ids @ stopped_ids @ aborted()
+    val snapshots = filter_out (same_snapshot "finished") finished_ids snapshots
+    val avoid_ids = running_ids @ finished_ids @ aborted()
     val () = if List.null snapshots then ()
              else ignore (List.foldl (add_waiting avoid_ids) 1 snapshots)
   in Posix.IO.close fd end
@@ -210,7 +210,7 @@ in
         | (P (Append x)) => append x
         | (P (Log x)) => log x
         | (P (Upload x)) => upload x
-        | (P (Stop x)) => stop x
+        | (P (Finish x)) => finish x
         | (P (Abort x)) => abort x
     in
       write_text_response 200 response

serverLib.sml

@@ -10,7 +10,7 @@
   to ensure this.
 
   Job lists are implemented as directories:
-    waiting, running, stopped, aborted
+    waiting, running, finished, aborted
 
   Jobs are implemented as files with their id as filename.
 
@@ -165,7 +165,7 @@ fun print_job out (j:job) =
   in () end
 
 val artefacts_dir = "artefacts"
-val queue_dirs = ["waiting","running","stopped","aborted"]
+val queue_dirs = ["waiting","running","finished","aborted"]
 
 local
   open OS.FileSys
@@ -228,10 +228,10 @@ end
 
 val waiting = List.rev o read_list "waiting"
 val running = read_list "running"
-val stopped = read_list "stopped"
+val finished = read_list "finished"
 val aborted = read_list "aborted"
 
-val queue_funs = [waiting,running,stopped,aborted]
+val queue_funs = [waiting,running,finished,aborted]
 
 fun queue_of_job f =
   let
@@ -636,7 +636,7 @@ in
       val typ = read_job_type inp
                 handle IO.Io _ => cgi_die 500 ["cannot open ",f]
                      | Option => cgi_die 500 [f," has invalid file format"]
-      val format_type = if q = "stopped" then span (status_attrs (read_status inp)) else String.concat
+      val format_type = if q = "finished" then span (status_attrs (read_status inp)) else String.concat
       val last_date = if q = "running" then read_last_date inp else NONE
       val () = TextIO.closeIn inp
       val ago_string =
@@ -788,7 +788,7 @@ in
             val (l,r) = Substring.splitAt (Substring.full time_part,6)
             val files =
               List.map (fn id => OS.Path.concat("running",Int.toString id)) (running()) @
-              List.map (fn id => OS.Path.concat("stopped",Int.toString id)) (stopped())
+              List.map (fn id => OS.Path.concat("finished",Int.toString id)) (finished())
             val (t,fs) = timings_of_dir dir files
             val average = if List.null fs then [] else [" ",duration(Int.quot(t,List.length fs))]
             val line = String.concat [

worker.sml

@@ -29,8 +29,8 @@ fun usage_string name = String.concat[
   "                exit (even without --no-loop).\n",
   "  --upload id : Assume this worker has just finished job <id> and upload its build\n",
   "                artefacts (usually automatic after master succeeds), then exit.\n",
-  "  --stop id   : Stop job <id>, then exit.\n",
-  "  --abort id  : Mark job <id> as having aborted, i.e., stopped without a proper\n",
+  "  --finish id : Mark job <id> as finished, then exit.\n",
+  "  --abort id  : Mark job <id> as having aborted, i.e., finished without a proper\n",
   "                success or failure, then exit.\n",
   "  --refresh   : Refresh the server's waiting queue from GitHub then exit.\n"];
 
@@ -63,7 +63,7 @@ fun usage_string name = String.concat[
        On failure:
          1. Append "FAILED: building HOL"
          2. Log the captured output
-         3. Stop the job
+         3. Finish the job
     5. Set up cakeml working directory according to the job snapshot
     6. For each directory in the CakeML build sequence
        1. Append "Starting <dir>"
@@ -73,10 +73,10 @@ fun usage_string name = String.concat[
           On failure:
             1. Append "FAILED: <dir>"
             2. Log the captured output
-            3. Stop the job
+            3. Finish the job
        3. Append "Finished <dir>: <time> <memory>"
     7. Append "SUCCESS"
-    8. Stop the job
+    8. Finish the job
 *)
 
 fun warn ls = (
@@ -282,7 +282,7 @@ in
       val () = if built then () else
                (API.post (Append (id, "FAILED: building HOL"));
                 API.post (Log(id,capture_file,0));
-                API.post (Stop id))
+                API.post (Finish id))
     in
       built
     end
@@ -361,7 +361,7 @@ in
             else
               (API.post (Append(id,String.concat["FAILED: ",dir]));
                API.post (Log(id,capture_file,0));
-               API.post (Stop id);
+               API.post (Finish id);
                false)
           end
       val success = loop skip
@@ -370,7 +370,7 @@ in
         if success then
           let in
             API.post (Append(id,"SUCCESS"));
-            API.post (Stop id)
+            API.post (Finish id)
           end
         else ()
     in
@@ -488,9 +488,9 @@ fun main () =
     val () = arg_job_action "--abort" args (fn jid => fn id => (
                diag ["Marking job ", jid, " as aborted."];
                API.post (Abort id)))
-    val () = arg_job_action "--stop" args (fn jid => fn id => (
-               diag ["Marking job ", jid, " as stopped."];
-               API.post (Stop id)))
+    val () = arg_job_action "--finish" args (fn jid => fn id => (
+               diag ["Marking job ", jid, " as finished."];
+               API.post (Finish id)))
     val () = arg_job_action "--upload" args (fn jid => fn id => (
                  diag ["Uploading artefacts for job ",jid,"."];
                  upload_artefacts (mk_CAKEMLDIR jid) id))