Merge pull request #282 from j3-signalroom/281-bump-the-cc-clients-python_lib-version

281 bump the cc clients python lib version

Author: j3-signalroom

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is base on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [0.12.04.000] - 2025-10-14
+### Changed
+- Issue [#281](https://github.com/j3-signalroom/kafka_cluster-topics-partition_count_recommender-tool/issues/281)
+
 ## [0.12.03.000] - 2025-10-07
 ### Changed
 - Issue [#278](https://github.com/j3-signalroom/kafka_cluster-topics-partition_count_recommender-tool/issues/278)

CHANGELOG.pdf

@@ -627,9 +627,9 @@ sequenceDiagram
 
     alt Use Confluent Cloud API Key
         Main->>EC: Create EnvironmentClient
-        Main->>EC: get_environment_list()
+        Main->>EC: get_environments()
         EC-->>Main: Return environments
-        Main->>EC: get_kafka_cluster_list(env_id)
+        Main->>EC: get_kafka_clusters(env_id)
         EC-->>Main: Return kafka clusters
         loop For each cluster
             Main->>EC: create_api_key(kafka_cluster_id, principal_id)

README.md

@@ -1,14 +1,14 @@
 [project]
 name = "kafka_cluster-topics-partition_count_recommender-tool"
-version = "0.12.00.000"
+version = "0.12.04.000"
 description = "Kafka Cluster Topics Partition Count Recommender Tool"
 readme = "README.md"
 requires-python = ">=3.13"
 dependencies = [
     "authlib>=1.6.5",
     "aws-clients-python-lib>=0.10.0.0",
     "cachetools>=6.2.0",
-    "cc-clients-python-lib==0.30.1.0",
+    "cc-clients-python-lib==0.30.3.0",
     "confluent-kafka>=2.11.1",
     "dotenv>=0.9.9",
     "jsonschema>=4.25.1",

README.pdf

@@ -72,7 +72,7 @@ def fetch_kafka_credentials_via_confluent_cloud_api_key(principal_id: str,
     environment_client = EnvironmentClient(environment_config=environment_config)
     iam_client = IamClient(iam_config=environment_config)
 
-    http_status_code, error_message, environments = environment_client.get_environment_list()
+    http_status_code, error_message, environments = environment_client.get_environments()
 
     if http_status_code != HttpStatus.OK:
         logger.error("FAILED TO RETRIEVE KAFKA CREDENTIALS FROM CONFLUENT CLOUD BECAUSE THE FOLLOWING ERROR OCCURRED: %s.", error_message)
@@ -84,8 +84,8 @@ def fetch_kafka_credentials_via_confluent_cloud_api_key(principal_id: str,
             environments = [environment for environment in environments if environment.get("id") in environment_ids]
 
         # Retrieve Kafka cluster credentials for each environment
-        for environment in environments:
-            http_status_code, error_message, kafka_clusters = environment_client.get_kafka_cluster_list(environment_id=environment.get("id"))
+        for environment in environments.values():
+            http_status_code, error_message, kafka_clusters = environment_client.get_kafka_clusters(environment_id=environment.get("id"))
 
             if http_status_code != HttpStatus.OK:
                 logger.error("FAILED TO RETRIEVE KAFKA CLUSTER LIST FOR ENVIRONMENT %s FROM CONFLUENT CLOUD BECAUSE THE FOLLOWING ERROR OCCURRED: %s.", environment.get('id'), error_message)
@@ -98,7 +98,7 @@ def fetch_kafka_credentials_via_confluent_cloud_api_key(principal_id: str,
                     kafka_clusters = [kafka_cluster for kafka_cluster in kafka_clusters if kafka_cluster.get("id") in kafka_cluster_ids]
 
                 # Retrieve API key pair for each Kafka cluster
-                for kafka_cluster in kafka_clusters:
+                for kafka_cluster in kafka_clusters.values():
                     http_status_code, error_message, api_key_pair = iam_client.create_api_key(resource_id=kafka_cluster.get("id"), 
                                                                                               principal_id=principal_id,
                                                                                               display_name=f"Temporary API Key for Kafka Cluster {kafka_cluster.get('display_name')} ({kafka_cluster.get('id')}) in Environment {environment.get('display_name')} for Principal {principal_id}",
@@ -158,7 +158,7 @@ def fetch_schema_registry_via_confluent_cloud_api_key(principal_id: str,
     iam_client = IamClient(iam_config=resource_config)
 
     # Retrieve the list of environments
-    http_status_code, error_message, environments = environment_client.get_environment_list()
+    http_status_code, error_message, environments = environment_client.get_environments()
     if http_status_code != HttpStatus.OK:
         logger.error("FAILED TO RETRIEVE SCHEMA REGISTRY CREDENTIALS FROM CONFLUENT CLOUD BECAUSE THE FOLLOWING ERROR OCCURRED: %s.", error_message)
         return {}
@@ -175,7 +175,7 @@ def fetch_schema_registry_via_confluent_cloud_api_key(principal_id: str,
         sr_client = SchemaRegistryClient(resource_config)
 
         # Retrieve Kafka cluster credentials for each environment
-        for environment in environments:
+        for environment in environments.values():
             http_status_code, error_message, sr_clusters = sr_client.get_schema_registry_cluster_list(environment_id=environment["id"])
 
             if http_status_code != HttpStatus.OK:

pyproject.toml

@@ -32,22 +32,22 @@ class TestEnvironmentClient:
     """Test Suite for the EnvironmentClient class."""
 
     def test_get_all_environments_with_kafka_clusters(self, environment_client):
-        """Test the get_environment_list() and get_kafka_cluster_list() functions."""
+        """Test the get_environments() and get_kafka_clusters() functions."""
 
-        http_status_code, error_message, environments = environment_client.get_environment_list()
+        http_status_code, error_message, environments = environment_client.get_environments()
         try:
             assert http_status_code == HttpStatus.OK, f"HTTP Status Code: {http_status_code}"
 
-            for environment_index, environment in enumerate(environments):
+            for environment_index, environment in enumerate(environments.values()):
                 beautified = json.dumps(environment, indent=4, sort_keys=True)
                 logger.info("%d of %d Environment: %s", environment_index + 1, len(environments), beautified)
 
-                http_status_code, error_message, kafka_clusters = environment_client.get_kafka_cluster_list(environment_id=environment["id"])
+                http_status_code, error_message, kafka_clusters = environment_client.get_kafka_clusters(environment_id=environment["id"])
 
                 try:
                     assert http_status_code == HttpStatus.OK, f"HTTP Status Code: {http_status_code}"
 
-                    for kafka_cluster_index, kafka_cluster in enumerate(kafka_clusters):
+                    for kafka_cluster_index, kafka_cluster in enumerate(kafka_clusters.values()):
                         beautified = json.dumps(kafka_cluster, indent=4, sort_keys=True)
                         logger.info("Environment '%s' %d of %d Kafka Cluster: %s", environment["display_name"], kafka_cluster_index + 1, len(kafka_clusters), beautified)
                 except AssertionError as e:

src/confluent_credentials.py

@@ -114,10 +114,10 @@ def test_successful_fetch_all_environments(
         mock_iam_client.return_value = mock_iam_client_instance
 
 
-        mock_client_instance.get_environment_list.return_value = (
+        mock_client_instance.get_environments.return_value = (
             HttpStatus.OK, None, mock_environments
         )
-        mock_client_instance.get_kafka_cluster_list.return_value = (
+        mock_client_instance.get_kafka_clusters.return_value = (
             HttpStatus.OK, None, [mock_kafka_clusters[0]]
         )
         mock_iam_client_instance.create_api_key.return_value = (
@@ -149,7 +149,7 @@ def test_environment_list_failure(
         mock_client_instance = Mock()
         mock_environment_client.return_value = mock_client_instance
 
-        mock_client_instance.get_environment_list.return_value = (
+        mock_client_instance.get_environments.return_value = (
             HttpStatus.INTERNAL_SERVER_ERROR, "API Error", []
         )
 
@@ -172,10 +172,10 @@ def test_kafka_cluster_list_failure(
         mock_client_instance = Mock()
         mock_environment_client.return_value = mock_client_instance
 
-        mock_client_instance.get_environment_list.return_value = (
+        mock_client_instance.get_environments.return_value = (
             HttpStatus.OK, None, mock_environments
         )
-        mock_client_instance.get_kafka_cluster_list.return_value = (
+        mock_client_instance.get_kafka_clusters.return_value = (
             HttpStatus.INTERNAL_SERVER_ERROR, "Cluster API Error", []
         )
 
@@ -204,10 +204,10 @@ def test_environment_filter(
         mock_iam_client_instance = Mock()
         mock_iam_client.return_value = mock_iam_client_instance
 
-        mock_client_instance.get_environment_list.return_value = (
+        mock_client_instance.get_environments.return_value = (
             HttpStatus.OK, None, mock_environments
         )
-        mock_client_instance.get_kafka_cluster_list.return_value = (
+        mock_client_instance.get_kafka_clusters.return_value = (
             HttpStatus.OK, None, [mock_kafka_clusters[0]]
         )
         mock_iam_client_instance.create_api_key.return_value = (
@@ -223,7 +223,7 @@ def test_environment_filter(
 
         # Assert - only one environment should be processed
         assert len(result) == 1
-        mock_client_instance.get_kafka_cluster_list.assert_called_once_with(
+        mock_client_instance.get_kafka_clusters.assert_called_once_with(
             environment_id="env-1"
         )
 
@@ -244,10 +244,10 @@ def test_kafka_cluster_filter(
         mock_iam_client_instance = Mock()
         mock_iam_client.return_value = mock_iam_client_instance
 
-        mock_client_instance.get_environment_list.return_value = (
+        mock_client_instance.get_environments.return_value = (
             HttpStatus.OK, None, [mock_environments[0]]
         )
-        mock_client_instance.get_kafka_cluster_list.return_value = (
+        mock_client_instance.get_kafka_clusters.return_value = (
             HttpStatus.OK, None, mock_kafka_clusters
         )
         mock_iam_client_instance.create_api_key.return_value = (
@@ -281,10 +281,10 @@ def test_forbidden_access(
         mock_iam_client_instance = Mock()
         mock_iam_client.return_value = mock_iam_client_instance
 
-        mock_client_instance.get_environment_list.return_value = (
+        mock_client_instance.get_environments.return_value = (
             HttpStatus.OK, None, [mock_environments[0]]
         )
-        mock_client_instance.get_kafka_cluster_list.return_value = (
+        mock_client_instance.get_kafka_clusters.return_value = (
             HttpStatus.OK, None, [mock_kafka_clusters[0]]
         )
         mock_iam_client_instance.create_api_key.return_value = (
@@ -315,10 +315,10 @@ def test_api_key_creation_failure_returns_empty(
         mock_iam_client_instance = Mock()
         mock_iam_client.return_value = mock_iam_client_instance
 
-        mock_client_instance.get_environment_list.return_value = (
+        mock_client_instance.get_environments.return_value = (
             HttpStatus.OK, None, [mock_environments[0]]
         )
-        mock_client_instance.get_kafka_cluster_list.return_value = (
+        mock_client_instance.get_kafka_clusters.return_value = (
             HttpStatus.OK, None, mock_kafka_clusters
         )
 
@@ -360,10 +360,10 @@ def test_cleanup_deletion_failure(
         mock_iam_client_instance = Mock()
         mock_iam_client.return_value = mock_iam_client_instance
 
-        mock_client_instance.get_environment_list.return_value = (
+        mock_client_instance.get_environments.return_value = (
             HttpStatus.OK, None, [mock_environments[0]]
         )
-        mock_client_instance.get_kafka_cluster_list.return_value = (
+        mock_client_instance.get_kafka_clusters.return_value = (
             HttpStatus.OK, None, mock_kafka_clusters
         )
 
@@ -402,10 +402,10 @@ def test_multiple_environment_ids_filter(
         mock_iam_client_instance = Mock()
         mock_iam_client.return_value = mock_iam_client_instance
 
-        mock_client_instance.get_environment_list.return_value = (
+        mock_client_instance.get_environments.return_value = (
             HttpStatus.OK, None, mock_environments
         )
-        mock_client_instance.get_kafka_cluster_list.return_value = (
+        mock_client_instance.get_kafka_clusters.return_value = (
             HttpStatus.OK, None, [mock_kafka_clusters[0]]
         )
         mock_iam_client_instance.create_api_key.return_value = (
@@ -433,11 +433,11 @@ def test_no_kafka_credentials_found(
         mock_client_instance = Mock()
         mock_environment_client.return_value = mock_client_instance
 
-        mock_client_instance.get_environment_list.return_value = (
+        mock_client_instance.get_environments.return_value = (
             HttpStatus.OK, None, mock_environments
         )
         # No Kafka clusters in environments
-        mock_client_instance.get_kafka_cluster_list.return_value = (
+        mock_client_instance.get_kafka_clusters.return_value = (
             HttpStatus.OK, None, []
         )
 

tests/test_environment_client.py

@@ -51,14 +51,14 @@ def test_creating_and_deleting_kafka_api_keys(self, iam_client, environment_clie
 
         environments_with_kafka_clusters = {}
 
-        http_status_code, error_message, environments = environment_client.get_environment_list()
+        http_status_code, error_message, environments = environment_client.get_environments()
         try:
             assert http_status_code == HttpStatus.OK, f"HTTP Status Code: {http_status_code}"
 
             logger.info("Environments: %d", len(environments))
 
-            for environment in environments:
-                http_status_code, error_message, kafka_clusters = environment_client.get_kafka_cluster_list(environment_id=environment["id"])
+            for environment in environments.values():
+                http_status_code, error_message, kafka_clusters = environment_client.get_kafka_clusters(environment_id=environment["id"])
 
                 try:
                     assert http_status_code == HttpStatus.OK, f"HTTP Status Code: {http_status_code}"
@@ -77,7 +77,7 @@ def test_creating_and_deleting_kafka_api_keys(self, iam_client, environment_clie
 
         for _, kafka_clusters in environments_with_kafka_clusters.items():
             kafka_cluster_count = len(kafka_clusters)
-            for index, kafka_cluster in enumerate(kafka_clusters):
+            for index, kafka_cluster in enumerate(kafka_clusters.values()):
                 http_status_code, error_message, api_key_pair = iam_client.create_api_key(resource_id=kafka_cluster["id"], 
                                                                                           principal_id=principal_id,
                                                                                           display_name=f"Test {environment['display_name']} Kafka API Key",

tests/test_fetch_kafka_credentials_via_confluent_cloud_api_key.py

@@ -45,7 +45,7 @@ class TestSchemaRegistryClient:
     def test_getting_all_schema_registry_clusters(self, sr_client, environment_client):
         """Test the get_schema_registry_cluster_list() function."""
 
-        http_status_code, error_message, environments = environment_client.get_environment_list()
+        http_status_code, error_message, environments = environment_client.get_environments()
         try:
             assert http_status_code == HttpStatus.OK, f"HTTP Status Code: {http_status_code}"