Add the capability to download a pull secret associated with a topic

Change-Id: I7bffac7277737cc85fc30bec08f7c08e8d609515

Author: rh-gvincent

.gitignore

@@ -13,3 +13,5 @@ AUTHORS
 ChangeLog
 password
 current
+venv
+.venv

dciclient/v1/shell_commands/cli.py

@@ -778,6 +778,15 @@ def parse_arguments(args, environment={}):
     p.add_argument("--offset", default=0)
     p.set_defaults(command="pipeline-show-jobs")
 
+    p = subparsers.add_parser(
+        "download-pull-secret",
+        help="Download pull secret associated with a topic.",
+        parents=[base_parser],
+    )
+    p.add_argument("--topic", required=True)
+    p.add_argument("--destination", required=True)
+    p.set_defaults(command="download-pull-secret")
+
     args = parser.parse_args(args)
 
     if "command" not in args:

dciclient/v1/shell_commands/runner.py

@@ -59,6 +59,7 @@
     "topic-show": topic.show,
     "topic-update": topic.update,
     "topic-delete": topic.delete,
+    "download-pull-secret": topic.download_pull_secret,
     "component-list": component.list,
     "component-create": component.create,
     "component-show": component.show,

dciclient/v1/shell_commands/topic.py

@@ -14,6 +14,8 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+import json
+import sys
 from dciclient.v1.api import topic
 from dciclient.v1.utils import active_string, get_search_params
 
@@ -73,3 +75,19 @@ def delete(context, args):
 
 def show(context, args):
     return topic.get(context, args.id)
+
+
+def download_pull_secret(context, args):
+    topic_name = args.topic
+    get_topics = topic.list(context, where=f"name:{topic_name}")
+    topics = get_topics.json()["topics"]
+    if len(topics) == 0:
+        print(f"Topic {topic_name} does not exist.")
+        sys.exit(1)
+    topic_data = topics[0]["data"]
+    if "pull_secret" not in topic_data:
+        print(f"Topic {topic_name} doesn't have a pull secret.")
+        sys.exit(1)
+    with open(args.destination, "w") as f:
+        pull_secret = topic_data["pull_secret"]
+        json.dump(pull_secret, f)

tests/conftest.py

@@ -480,3 +480,19 @@ def feeder(dci_context, team_id):
     kwargs = {"name": "feeder", "team_id": team_id, "state": "active"}
     feeder = api_base.create(dci_context, "feeders", **kwargs).json()
     return feeder["feeder"]
+
+
+@pytest.fixture
+def rhel10_topic(dci_context, product_id):
+    kwargs = {
+        "name": "RHEL-10.0",
+        "component_types": ["container"],
+        "product_id": product_id,
+        "export_control": True,
+        "data": {
+            "pull_secret": {
+                "auths": {"registry.distributed-ci.io": {"auth": "ZGNpOmRjaQ=="}}
+            }
+        },
+    }
+    return api_topic.create(dci_context, **kwargs).json()["topic"]

tests/shell_commands/test_cli.py

@@ -285,3 +285,18 @@ def test_csv():
         ]
     )
     assert args.tags == []
+
+
+def test_parse_download_authfile():
+    args = parse_arguments(
+        [
+            "download-pull-secret",
+            "--topic",
+            "RHEL-10.0",
+            "--destination",
+            "/tmp/auth.json",
+        ]
+    )
+    assert args.command == "download-pull-secret"
+    assert args.topic == "RHEL-10.0"
+    assert args.destination == "/tmp/auth.json"

tests/shell_commands/test_pull_secret.py

@@ -0,0 +1,61 @@
+# -*- encoding: utf-8 -*-
+#
+# Copyright 2024 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, 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.
+
+import json
+import pytest
+
+
+def test_download_pull_secret(tmp_path, runner, rhel10_topic):
+    pull_secret = rhel10_topic["data"]["pull_secret"]
+    destination_file = tmp_path / "auth.json"
+    destination_file_path = str(destination_file)
+    runner.invoke_raw(
+        [
+            "download-pull-secret",
+            "--topic",
+            rhel10_topic["name"],
+            "--destination",
+            destination_file_path,
+        ]
+    )
+    with open(destination_file_path) as f:
+        assert f.read() == json.dumps(pull_secret)
+
+
+def test_download_pull_secret_without_a_pull_secret_in_topic_data(runner, topic):
+    with pytest.raises(SystemExit):
+        runner.invoke_raw(
+            [
+                "download-pull-secret",
+                "--topic",
+                topic,
+                "--destination",
+                "/tmp/auth.json",
+            ]
+        )
+
+
+def test_download_pull_secret_without_specified_topic(runner):
+    with pytest.raises(SystemExit):
+        runner.invoke_raw(
+            [
+                "download-pull-secret",
+                "--topic",
+                "unknown-topic",
+                "--destination",
+                "/tmp/auth.json",
+            ]
+        )