remote/client: make acquire/release operate on all RemotePlaces in env

If an environment config with multiple RemotePlaces is given via
`-c`/`--config`, only the first RemotePlace is used on acquire/lock and
release/unlock.

Having multiple RemotePlaces is meant for multi place testing, so all
RemotePlaces need to be acquired/released.

This is implemented in a best effort way: If an error occurs, the
remaining places are still tried to be acquired/released. A combined
error message is shown if the operation failed on multiple places.
When called with `-d`, tracebacks of all errors are shown. If any of the
operations failed, the process exits with 1.

CI pipelines should use this pattern:

```shell
export LG_ENV=env.yaml
labgrid-client unlock || true
labgrid-client lock
```

Signed-off-by: Bastian Krause <bst@pengutronix.de>

Author: Bastian-Krause

labgrid/remote/client.py

@@ -489,6 +489,17 @@ def get_place(self, place=None):
             raise UserError(f"pattern {pattern} matches multiple places ({', '.join(places)})")
         return self.places[places[0]]
 
+    def get_place_names_from_env(self):
+        """Returns a list of RemotePlace names found in the environment config."""
+        places = []
+        for role_config in self.env.config.get_targets().values():
+            resources, _ = target_factory.normalize_config(role_config)
+            remote_places = resources.get("RemotePlace", [])
+            for place in remote_places:
+                places.append(place)
+
+        return places
+
     def get_idle_place(self, place=None):
         place = self.get_place(place)
         if place.acquired:
@@ -692,8 +703,22 @@ def check_matches(self, place):
             raise UserError(f"Match {match} has no matching remote resource")
 
     async def acquire(self):
+        errors = []
+        places = self.get_place_names_from_env() if self.env else [self.args.place]
+        for place in places:
+            try:
+                await self._acquire_place(place)
+            except Error as e:
+                errors.append(e)
+
+        if errors:
+            if len(errors) == 1:
+                raise errors[0]
+            raise ErrorGroup("Multiple errors occurred during acquire", errors)
+
+    async def _acquire_place(self, place):
         """Acquire a place, marking it unavailable for other clients"""
-        place = self.get_place()
+        place = self.get_place(place)
         if place.acquired:
             host, user = place.acquired.split("/")
             allowhelp = f"'labgrid-client -p {place.name} allow {self.gethostname()}/{self.getuser()}' on {host}."
@@ -738,8 +763,22 @@ async def acquire(self):
             raise ServerError(e.details())
 
     async def release(self):
+        errors = []
+        places = self.get_place_names_from_env() if self.env else [self.args.place]
+        for place in places:
+            try:
+                await self._release_place(place)
+            except Error as e:
+                errors.append(e)
+
+        if errors:
+            if len(errors) == 1:
+                raise errors[0]
+            raise ErrorGroup("Multiple errors occurred during release", errors)
+
+    async def _release_place(self, place):
         """Release a previously acquired place"""
-        place = self.get_place()
+        place = self.get_place(place)
         if not place.acquired:
             raise UserError(f"place {place.name} is not acquired")
         _, user = place.acquired.split("/")

tests/test_client.py

@@ -162,6 +162,49 @@ def test_place_acquire(place):
         spawn.close()
         assert spawn.exitstatus == 0, spawn.before.strip()
 
+def test_place_acquire_multiple(create_place, tmpdir):
+    # create multiple places
+    place_names = ['test1', 'test2']
+    for place_name in place_names:
+        create_place(place_name)
+
+    # create env config with multiple RemotePlaces
+    p = tmpdir.join('config.yaml')
+    p.write('targets:')
+    for place_name in place_names:
+        p.write(
+            f"""
+        {place_name}:
+          resources:
+            RemotePlace:
+              name: {place_name}
+        """,
+            mode='a',
+        )
+
+    # acquire all places in env config
+    with pexpect.spawn(f'python -m labgrid.remote.client -c {p} acquire') as spawn:
+        spawn.expect(pexpect.EOF)
+    assert spawn.exitstatus == 0, spawn.before.strip()
+
+    # check 'who'
+    with pexpect.spawn('python -m labgrid.remote.client who') as spawn:
+        spawn.expect(pexpect.EOF)
+        for place_name in place_names:
+            assert place_name.encode('utf-8') in spawn.before
+
+    assert spawn.exitstatus == 0, spawn.before.strip()
+
+    # release all places in env config
+    with pexpect.spawn(f'python -m labgrid.remote.client -c {p} release') as spawn:
+        spawn.expect(pexpect.EOF)
+    assert spawn.exitstatus == 0, spawn.before.strip()
+
+    # check 'who' again
+    with pexpect.spawn('python -m labgrid.remote.client who') as spawn:
+        spawn.expect('User.*Host.*Place.*Changed\r\n')
+    assert not spawn.before, spawn.before
+
 def test_place_acquire_enforce(place):
     with pexpect.spawn('python -m labgrid.remote.client -p test add-match does/not/exist') as spawn:
         spawn.expect(pexpect.EOF)