feat(charmlibs): warn of deprecation on all charmlibs commands (#2691)

Warns about the deprecation of charmhub-hosted charmlibs in all charmlibs-related commands.

---------

Signed-off-by: Alex Lowe <alex.lowe@canonical.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: James Garner <james.garner@canonical.com>
Co-authored-by: Imani Pelton <imani.pelton@canonical.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

Author: 5 people

charmcraft/application/commands/store.py

@@ -76,6 +76,14 @@ class _ResourceType(typing.NamedTuple):
     getattr(attenuations, x) for x in dir(attenuations) if x.isupper()
 }
 BUNDLE_REGISTRATION_REMOVAL_URL = "https://discourse.charmhub.io/t/15344"
+CHARMLIBS_DEPRECATION_WARNING = (
+    "WARNING: Charmhub-hosted charm libraries are deprecated. "
+    "Go to https://ubu.link/charmhub-libraries-deprecation for more information."
+)
+
+
+def _emit_charmlibs_deprecation_warning() -> None:
+    emit.progress(CHARMLIBS_DEPRECATION_WARNING, permanent=True)
 
 
 class LoginCommand(CharmcraftCommand):
@@ -1255,6 +1263,7 @@ def fill_parser(self, parser):
 
     def run(self, parsed_args):
         """Run the command."""
+        _emit_charmlibs_deprecation_warning()
         lib_name = parsed_args.name
         valid_all_chars = set(string.ascii_lowercase + string.digits + "_")
         valid_first_char = string.ascii_lowercase
@@ -1349,6 +1358,7 @@ def fill_parser(self, parser):
 
     def run(self, parsed_args):
         """Run the command."""
+        _emit_charmlibs_deprecation_warning()
         charm_name = (
             self._services.get("project").get().name or utils.get_name_from_yaml()
         )
@@ -1515,6 +1525,7 @@ def fill_parser(self, parser):
 
     def run(self, parsed_args: argparse.Namespace) -> None:
         """Run the command."""
+        _emit_charmlibs_deprecation_warning()
         if parsed_args.library:
             local_libs_data = [utils.get_lib_info(full_name=parsed_args.library)]
         else:
@@ -1666,6 +1677,7 @@ class FetchLibs(CharmcraftCommand):
 
     def run(self, parsed_args: argparse.Namespace) -> None:
         """Fetch libraries."""
+        _emit_charmlibs_deprecation_warning()
         store = cast("StoreService", self._services.get("store"))
         project = cast("CharmcraftProject", self._services.get("project").get())
         charm_libs = project.charm_libs
@@ -1774,6 +1786,7 @@ def fill_parser(self, parser):
 
     def run(self, parsed_args):
         """Run the command."""
+        _emit_charmlibs_deprecation_warning()
         if parsed_args.name:
             charm_name = parsed_args.name
         else:

tests/integration/commands/test_store_commands.py

@@ -28,7 +28,10 @@
 
 from charmcraft import errors, utils
 from charmcraft.application.commands import FetchLibCommand
-from charmcraft.application.commands.store import CreateTrack
+from charmcraft.application.commands.store import (
+    CHARMLIBS_DEPRECATION_WARNING,
+    CreateTrack,
+)
 from tests import factory
 
 OPERATOR_LIBS_LINUX_APT_ID = "7c3dbc9c2ad44a47bd6fcb25caa270e5"
@@ -52,6 +55,7 @@ def test_fetchlib_simple_downloaded(
     )
     FetchLibCommand(config).run(args)
 
+    emitter.assert_progress(CHARMLIBS_DEPRECATION_WARNING, permanent=True)
     assert saved_file.exists()
 
     message = emitter.interactions[-1].args[1]

tests/unit/commands/test_store.py

@@ -35,7 +35,10 @@
 from charmcraft.application.commands import SetResourceArchitecturesCommand
 from charmcraft.application.commands import store as store_commands
 from charmcraft.application.commands.store import (
+    CHARMLIBS_DEPRECATION_WARNING,
+    CreateLibCommand,
     FetchLibs,
+    ListLibCommand,
     LoginCommand,
     PublishLibCommand,
 )
@@ -162,7 +165,7 @@ def test_publish_lib_error(monkeypatch, new_path: pathlib.Path) -> None:
     )
 
 
-def test_publish_lib_same_is_noop(monkeypatch, new_path: pathlib.Path) -> None:
+def test_publish_lib_same_is_noop(monkeypatch, new_path: pathlib.Path, emitter) -> None:
     # Publishing the same version of a library with the same hash should not result
     # in an error return.
     mock_service_factory = mock.Mock(spec=craft_application.ServiceFactory)
@@ -197,6 +200,44 @@ def test_publish_lib_same_is_noop(monkeypatch, new_path: pathlib.Path) -> None:
         == 0
     )
 
+    emitter.assert_progress(CHARMLIBS_DEPRECATION_WARNING, permanent=True)
+
+
+def test_create_lib_warns_deprecation(
+    monkeypatch, new_path: pathlib.Path, emitter, service_factory
+) -> None:
+    mock_store = mock.Mock()
+    mock_store.return_value.create_library_id.return_value = "lib-id"
+    monkeypatch.setattr(store_commands, "Store", mock_store)
+    mock_template = mock.Mock()
+    mock_template.render.return_value = "LIBAPI = 0\nLIBID = 'lib-id'\nLIBPATCH = 1\n"
+    mock_environment = mock.Mock()
+    mock_environment.get_template.return_value = mock_template
+    monkeypatch.setattr(
+        store_commands.utils,
+        "get_templates_environment",
+        mock.Mock(return_value=mock_environment),
+    )
+
+    cmd = CreateLibCommand({"app": APP_METADATA, "services": service_factory})
+
+    cmd.run(argparse.Namespace(name="my_lib", format=False))
+
+    emitter.assert_progress(CHARMLIBS_DEPRECATION_WARNING, permanent=True)
+
+
+def test_list_lib_warns_deprecation(monkeypatch, emitter, service_factory) -> None:
+    mock_store = mock.Mock()
+    mock_store.return_value.get_libraries_tips.return_value = {}
+    monkeypatch.setattr(store_commands, "Store", mock_store)
+
+    cmd = ListLibCommand({"app": APP_METADATA, "services": service_factory})
+
+    cmd.run(argparse.Namespace(name="test-charm", format=False))
+
+    emitter.assert_progress(CHARMLIBS_DEPRECATION_WARNING, permanent=True)
+    emitter.assert_message("No libraries found for charm test-charm.")
+
 
 @pytest.mark.parametrize(
     ("updates", "expected"),
@@ -233,6 +274,7 @@ def test_fetch_libs_no_charm_libs(
     with pytest.raises(errors.LibraryError) as exc_info:
         fetch_libs.run(argparse.Namespace())
 
+    emitter.assert_progress(CHARMLIBS_DEPRECATION_WARNING, permanent=True)
     assert exc_info.value.resolution == "Add a 'charm-libs' section to charmcraft.yaml."
 
 
@@ -366,6 +408,7 @@ def test_fetch_libs_success(
 
     fetch_libs.run(argparse.Namespace())
 
+    emitter.assert_progress(CHARMLIBS_DEPRECATION_WARNING, permanent=True)
     emitter.assert_progress("Getting library metadata from charmhub")
     emitter.assert_message("Downloaded 1 charm libraries.")