fix: update LG_RESERVATION_ID to LG_RESERVATION

Author: asher-pem-arm

doc/man/client.rst

@@ -25,8 +25,8 @@ LG_PLACE
 ~~~~~~~~
 This variable can be used to specify a place without using the ``-p`` option, the ``-p`` option overrides it.
 
-LG_RESERVATION_ID (previously LG_TOKEN)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+LG_RESERVATION (previously LG_TOKEN)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 This variable can be used to specify a reservation for the ``wait`` command and
 for the ``+`` place expansion.
 

doc/usage.rst

@@ -117,16 +117,27 @@ can lock that place.
     timeout: 2019-08-06 12:59:11.840780
   $ labgrid-client -p +SP37P5OQRU console
 
+
+.. note::
+
+   Reservation tokens are now called reservation IDs.
+   As part of this terminology change, ``LG_TOKEN`` has been renamed to
+   ``LG_RESERVATION``, and ``labgrid-client reserve --shell`` now exports
+   ``LG_RESERVATION``.
+   Command output now uses ``id`` instead of ``token``.
+   The legacy ``LG_TOKEN`` variable remains accepted as input for backwards
+   compatibility, but scripts should migrate to ``LG_RESERVATION``.
+
 When using reservation in a CI job or to save some typing, the ``labgrid-client
 reserve`` command supports a ``--shell`` command to print code for evaluating
 in the shell.
-This sets the ``LG_RESERVATION_ID`` environment variable, which is then automatically
+This sets the ``LG_RESERVATION`` environment variable, which is then automatically
 used by ``wait`` and expanded via ``-p +``.
 
 .. code-block:: bash
 
   $ eval `labgrid-client reserve --shell board=imx6-foo`
-  $ echo $LG_RESERVATION_ID
+  $ echo $LG_RESERVATION
   ZDMZJZNLBF
   $ labgrid-client wait
   owner: rettich/jlu

labgrid/remote/client.py

@@ -443,7 +443,7 @@ def _match_places(self, pattern):
         if pattern.startswith("+"):
             reservation_id = pattern[1:]
             if not reservation_id:
-                reservation_id = os.environ.get("LG_RESERVATION_ID", None)
+                reservation_id = os.environ.get("LG_RESERVATION", None)
             if not reservation_id:
                 reservation_id = os.environ.get("LG_TOKEN", None)  # For backwards compatibility
             if not reservation_id:
@@ -1574,7 +1574,7 @@ async def create_reservation(self):
 
         res = Reservation.from_pb2(response.reservation)
         if self.args.shell:
-            print(f"export LG_RESERVATION_ID={res.id}")
+            print(f"export LG_RESERVATION={res.id}")
         else:
             print(f"Reservation '{res.id}':")
             res.show(level=1)
@@ -2259,7 +2259,7 @@ def main():
     state = os.environ.get("STATE", None)
     state = os.environ.get("LG_STATE", state)
     initial_state = os.environ.get("LG_INITIAL_STATE", None)
-    reservation_id = os.environ.get("LG_RESERVATION_ID", None)
+    reservation_id = os.environ.get("LG_RESERVATION", None)
     if reservation_id is None:
         reservation_id = os.environ.get("LG_TOKEN", None)  # For backwards compatibility
 

man/labgrid-client.1

@@ -1127,7 +1127,7 @@ Various labgrid\-client commands use the following environment variable:
 .SS LG_PLACE
 .sp
 This variable can be used to specify a place without using the \fB\-p\fP option, the \fB\-p\fP option overrides it.
-.SS LG_RESERVATION_ID (previously LG_TOKEN)
+.SS LG_RESERVATION (previously LG_TOKEN)
 .sp
 This variable can be used to specify a reservation for the \fBwait\fP command and
 for the \fB+\fP place expansion.

tests/test_client.py

@@ -361,12 +361,12 @@ def test_reservation(place_acquire, tmpdir):
         spawn.expect(pexpect.EOF)
         spawn.close()
         assert spawn.exitstatus == 0, spawn.before.strip()
-        m = re.search(rb"^export LG_RESERVATION_ID=(\S+)$", spawn.before.replace(b'\r\n', b'\n'), re.MULTILINE)
+        m = re.search(rb"^export LG_RESERVATION=(\S+)$", spawn.before.replace(b'\r\n', b'\n'), re.MULTILINE)
         assert m is not None, spawn.before.strip()
         reservation_id = m.group(1)
 
     env = os.environ.copy()
-    # Use LG_TOKEN in this test to validate backwards compatibility. Other tests use LG_RESERVATION_ID.
+    # Use LG_TOKEN in this test to validate backwards compatibility. Other tests use LG_RESERVATION.
     env['LG_TOKEN'] = reservation_id.decode('ASCII')
 
     with pexpect.spawn('python -m labgrid.remote.client reservations') as spawn:
@@ -569,14 +569,14 @@ def test_reservation_custom_config(place, exporter, tmpdir):
         spawn.expect(pexpect.EOF)
         spawn.close()
         assert spawn.exitstatus == 0, spawn.before.strip()
-        m = re.search(rb"^export LG_RESERVATION_ID=(\S+)$", spawn.before.replace(b'\r\n', b'\n'), re.MULTILINE)
+        m = re.search(rb"^export LG_RESERVATION=(\S+)$", spawn.before.replace(b'\r\n', b'\n'), re.MULTILINE)
         s = re.search(rb"^Selected role$", spawn.before.replace(b'\r\n', b'\n'), re.MULTILINE)
         assert m is not None, spawn.before.strip()
         assert s is None, spawn.before.strip()
         reservation_id = m.group(1)
 
     env = os.environ.copy()
-    env['LG_RESERVATION_ID'] = reservation_id.decode('ASCII')
+    env['LG_RESERVATION'] = reservation_id.decode('ASCII')
 
     with pexpect.spawn(f'python -m labgrid.remote.client -c {p} -p + lock', env=env) as spawn:
         spawn.expect("acquired place test")