fix(git_utils): get_git_token format adjustment

This commit fixes a bug on `get_git_token` as the
`iib_index_configs_gitlab_tokens_map` will always be a `dict[str, str]`
from HashiVault, never being able to be a Tuple.

In order to return a Tuple we need to split the token-name from
token-value. For that, we're stablishing the standard as a column `:` to
separate such values.

Refers to CLOUDDST-29117

Signed-off-by: Jonathan Gangi <jgangi@redhat.com>

Author: JAVGan

README.md

@@ -340,6 +340,7 @@ The custom configuration options for the Celery workers are listed below:
   `{registry}/iib-build:{request_id}`.
 * `iib_index_configs_gitlab_tokens_map` - A map of index image addresses to GitLab tokens.
   These Gitlab repositories are intended to store image `/configs` directories.
+  Its format should be the full repository URL as keys and `token-name:token-value` as value.
 * `iib_log_level` - the Python log level for `iib.workers` logger. This defaults to `INFO`.
 * `iib_max_recursive_related_bundles` - the maximum number of recursive related bundles IIB will
   recurse through. This is to avoid DOS attacks.

iib/workers/tasks/git_utils.py

@@ -185,7 +185,15 @@ def get_git_token(git_repo) -> Tuple[str, str]:
     git_token_map = get_worker_config()['iib_index_configs_gitlab_tokens_map']
     if git_repo not in git_token_map:
         raise IIBError(f"Missing key '{git_repo}' in 'iib_index_configs_gitlab_tokens_map'")
-    return git_token_map[git_repo]
+    str_token_name_value = git_token_map[git_repo]
+    splitted_token = str_token_name_value.split(":")
+    if ":" not in str_token_name_value or '' in splitted_token[:2]:
+        raise IIBError(
+            f"Invalid token format for '{git_repo}' in 'iib_index_configs_gitlab_tokens_map'. "
+            "Expected 'token_name:token_value'."
+        )
+    token_name, token_value = splitted_token[:2]
+    return token_name, token_value
 
 
 def clone_git_repo(

tests/test_workers/test_tasks/test_git_utils.py

@@ -27,15 +27,18 @@
 PUB_PENDING_GIT_REPO = f"{GIT_BASE_URL}/iib-pub-pending-index-configs.git"
 PUB_PENDING_TOKEN_NAME = "iibpubpendingtoken"
 PUB_PENDING_TOKEN_VALUE = "iibpubpendingabc123"
+TESTING_REPO = f"{GIT_BASE_URL}/testing.git"
+TESTING_TOKEN_VALUE = "abcdef"
 
 
 @pytest.fixture()
 def mock_gwc():
     with mock.patch('iib.workers.tasks.git_utils.get_worker_config') as mc:
         mc.return_value = {
             "iib_index_configs_gitlab_tokens_map": {
-                PUB_GIT_REPO: (PUB_TOKEN_NAME, PUB_TOKEN_VALUE),
-                PUB_PENDING_GIT_REPO: (PUB_PENDING_TOKEN_NAME, PUB_PENDING_TOKEN_VALUE),
+                PUB_GIT_REPO: f"{PUB_TOKEN_NAME}:{PUB_TOKEN_VALUE}",
+                PUB_PENDING_GIT_REPO: f"{PUB_PENDING_TOKEN_NAME}:{PUB_PENDING_TOKEN_VALUE}",
+                TESTING_REPO: f"{TESTING_TOKEN_VALUE}:{TESTING_TOKEN_VALUE}:",
             },
         }
         yield mc
@@ -73,6 +76,7 @@ def test_unmapped_git_token(mock_gwc):
     [
         (PUB_GIT_REPO, PUB_TOKEN_NAME, PUB_TOKEN_VALUE),
         (PUB_PENDING_GIT_REPO, PUB_PENDING_TOKEN_NAME, PUB_PENDING_TOKEN_VALUE),
+        (TESTING_REPO, TESTING_TOKEN_VALUE, TESTING_TOKEN_VALUE),
     ],
 )
 def test_get_git_token(repo_url, expected_token_name, expected_token_value, mock_gwc):
@@ -81,6 +85,38 @@ def test_get_git_token(repo_url, expected_token_name, expected_token_value, mock
     assert git_token_value == expected_token_value
 
 
+@pytest.mark.parametrize(
+    "repo_url, token_value, expected_err",
+    [
+        (
+            TESTING_REPO,
+            TESTING_TOKEN_VALUE,
+            f"Invalid token format for '{TESTING_REPO}' in 'iib_index_configs_gitlab_tokens_map'. Expected 'token_name:token_value'.",  # noqa: E501
+        ),
+        (
+            TESTING_REPO,
+            "",
+            f"Invalid token format for '{TESTING_REPO}' in 'iib_index_configs_gitlab_tokens_map'. Expected 'token_name:token_value'.",  # noqa: E501
+        ),
+        (
+            TESTING_REPO,
+            ":some_value",
+            f"Invalid token format for '{TESTING_REPO}' in 'iib_index_configs_gitlab_tokens_map'. Expected 'token_name:token_value'.",  # noqa: E501
+        ),
+        (
+            TESTING_REPO,
+            "some_name:",
+            f"Invalid token format for '{TESTING_REPO}' in 'iib_index_configs_gitlab_tokens_map'. Expected 'token_name:token_value'.",  # noqa: E501
+        ),
+    ],
+)
+def test_get_git_token_missing_name_value(repo_url, token_value, expected_err, mock_gwc):
+    with mock.patch('iib.workers.tasks.git_utils.get_worker_config') as mc:
+        mc.return_value = {"iib_index_configs_gitlab_tokens_map": {repo_url: token_value}}
+        with pytest.raises(IIBError, match=expected_err):
+            git_utils.get_git_token(repo_url)
+
+
 def test_unmapped_git_url(mock_gwc, gitlab_url_mapping, caplog):
     # Setting the logging level via caplog.set_level is not sufficient. The flask
     # related settings from previous tests interfere with this.