Client: Add command to route to list_datasets_per_rse rucio#7801

Author: voetberg

bin/rucio

@@ -54,6 +54,7 @@ def map_legacy_command() -> Optional[list[str]]:
         command_map = {
             "list-file-replicas": ["replica", "list", "file"],
             "list-dataset-replicas": ["replica", "list", "dataset"],
+            "list-datasets-rse": ["replica", "list", "dataset", "--rse"],
             "add-dataset": ["did", "add", "--type dataset"],
             "add-container": ["did", "add", "--type container"],
             "attach": ["did", "content", "add"],

lib/rucio/cli/replica.py

@@ -11,12 +11,17 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+from typing import TYPE_CHECKING, Optional
+
 import click
 
-from rucio.cli.bin_legacy.rucio import list_dataset_replicas, list_file_replicas, list_suspicious_replicas
+from rucio.cli.bin_legacy.rucio import list_dataset_replicas, list_datasets_rse, list_file_replicas, list_suspicious_replicas
 from rucio.cli.bin_legacy.rucio_admin import declare_bad_file_replicas, declare_temporary_unavailable_replicas, quarantine_replicas, set_tombstone
 from rucio.cli.utils import Arguments
 
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
 
 @click.group()
 def replica():
@@ -60,13 +65,18 @@ def list_(ctx, dids, protocols, all_states, pfns, domain, link, missing, metalin
 
 @replica_list.command("dataset")
 @click.argument("dids", nargs=-1)
+@click.option("--rse", default=None, help="RSE name to use a filter")
 @click.option("--deep", default=False, is_flag=True, help="Make a deep check, checking the contents of datasets in datasets")
 @click.option("--csv", help="Write output to comma separated values", is_flag=True, default=False)
 @click.pass_context
-def list_dataset(ctx, dids, deep, csv):
-    """List dataset replicas"""
-    args = Arguments({"no_pager": ctx.obj.no_pager, "dids": dids, "deep": deep, "csv": csv})
-    list_dataset_replicas(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+def list_dataset(ctx, dids: Optional["Sequence[str]"], rse: Optional[str], deep: bool, csv: bool):
+    """List dataset replicas, or view all datasets at a RSE"""
+    if rse is None:
+        args = Arguments({"no_pager": ctx.obj.no_pager, "dids": dids, "deep": deep, "csv": csv})
+        list_dataset_replicas(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
+    else:
+        args = Arguments({"no_pager": ctx.obj.no_pager, "rse": rse})
+        list_datasets_rse(args, ctx.obj.client, ctx.obj.logger, ctx.obj.console, ctx.obj.spinner)
 
 
 @replica.command("remove")

tests/test_cli_client_structure.py

@@ -437,9 +437,9 @@ def test_lifetime_exception(rucio_client, mock_scope):
 
 
 @pytest.mark.dirty
-def test_replica(mock_scope, rucio_client):
+def test_replica(mock_scope, rucio_client, did_factory, rse_factory):
     mock_did = tempfile.NamedTemporaryFile()
-    mock_rse = "MOCK-POSIX"
+    mock_rse, _ = rse_factory.make_posix_rse()
 
     scope = mock_scope.external
     name = mock_did.name.split("/")[-1]
@@ -471,6 +471,23 @@ def test_replica(mock_scope, rucio_client):
     assert exitcode == 0
     assert "ERROR" not in err
 
+    # Check the dataset commands
+
+    dids = did_factory.upload_test_dataset(rse_name=mock_rse, scope=scope, size=1, nb_files=1)
+    dataset_name = dids[0]['dataset_name']
+
+    cmd = f"rucio replica list dataset {scope}:{dataset_name} --deep"
+    exitcode, out, err = execute(cmd)
+    assert exitcode == 0
+    assert "ERROR" not in err
+    assert dataset_name in out
+
+    cmd = f"rucio replica list dataset --rse {mock_rse}"
+    exitcode, out, err = execute(cmd)
+    assert exitcode == 0
+    assert "ERROR" not in err
+    assert all([dataset in out for dataset in rucio_client.list_datasets_per_rse(mock_rse)])
+
 
 @pytest.mark.dirty
 def test_replica_state(mock_scope, rucio_client):