Fix token refresh for AAP 2.6

Signed-off-by: Justin Cinkelj <[email protected]>

Author: justinc1

src/backend/apps/clusters/connector.py

@@ -7,6 +7,7 @@
 import requests
 from django.db import transaction
 import urllib3
+import json
 
 from backend.apps.clusters.encryption import decrypt_value, encrypt_value
 from backend.apps.clusters.models import (
@@ -85,7 +86,7 @@ def headers(self):
         }
 
     def _reauth(self, timeout=None):
-        url = f'{self.cluster.base_url}/api/o/token/'  # TODO AAP version
+        url = f'{self.cluster.base_url}{self.cluster.oauth_token_url}'
         refresh_token = decrypt_value(self.cluster.refresh_token)
         client_id = self.cluster.client_id
         client_secret = decrypt_value(self.cluster.client_secret)
@@ -270,39 +271,48 @@ def sync_common(self, sync_type):
     def ping(self, ping_url):
         logger.info(f'Pinging api {self.cluster.base_url}{ping_url}')
         url = f'{self.cluster.base_url}{ping_url}'
-        return self.execute_get_one(url=url, timeout=5)
+        # Do same as execute_get_one(), but without authentication.
+        # ping is used to check version before token refresh, so we might not have a valid access token yet.
+        # ping endpoint does not required authentication, but (AAP 2.6 at least):
+        #   - request is rejected if invalid HTTP basic auth is provided.
+        #   - request is accepted if invalid 'Authorization: Bearer ...' is provided.
+        timeout = 5
+        response = requests.get(
+            url=url,
+            verify=self.cluster.verify_ssl,
+            timeout=timeout,
+            headers=self.headers)
+        if response is None or not response.ok:
+            return None
+        response = response.json()
+        return response
 
-    @property
-    def is_aap25_instance(self):
-        logger.info(f'Checking if is AAP 2.5 at {self.cluster.base_url}')
-        response = self.ping("/api/gateway/v1/ping/")
-        return True if response is not None else False
+    def detect_aap_version(self):
+        logger.info(f'Checking if is AAP 2.5 ... 2.6 at {self.cluster.base_url}')
+        response25 = self.ping("/api/gateway/v1/ping/")
+        if response25:
+            if response25["version"] == "2.6":
+                return ClusterVersionChoices.AAP26
+            elif response25["version"] == "2.5":
+                return ClusterVersionChoices.AAP25
+            else:
+                raise Exception(f'Not valid version {response25["version"]} for cluster {self.cluster.base_url}.')
 
-    @property
-    def is_aap24_instance(self):
         logger.info(f'Checking if is AAP 2.4 at {self.cluster.base_url}')
-        response = self.ping("/api/v2/ping/")
-        return True if response is not None else False
+        response24 = self.ping("/api/v2/ping/")
+        if response24:
+            return ClusterVersionChoices.AAP24
 
-    def check_aap_version(self):
-        logger.info(f'Checking AAP version at {self.cluster.base_url}')
-        is_aap25_instance = self.is_aap25_instance
-        if is_aap25_instance:
-            if self.cluster.aap_version != ClusterVersionChoices.AAP25:
-                self.cluster.aap_version = ClusterVersionChoices.AAP25
-                self.cluster.save()
-            logger.info(f'Detected AAP version 2.5 at {self.cluster.base_url}')
-            return True
-
-        is_aap24_instance = self.is_aap24_instance
-        if is_aap24_instance:
-            if self.cluster.aap_version != ClusterVersionChoices.AAP24:
-                self.cluster.aap_version = ClusterVersionChoices.AAP24
-                self.cluster.save()
-            logger.info(f'Detected AAP version 2.4 at {self.cluster.base_url}')
-            return True
         raise Exception(f'Not valid version for cluster {self.cluster.base_url}.')
 
+    def check_aap_version(self):
+        aap_version = self.detect_aap_version()
+        if self.cluster.aap_version != aap_version:
+            self.cluster.aap_version = aap_version
+            self.cluster.save()
+        logger.info(f'Detected AAP version {aap_version} at {self.cluster.base_url}')
+        return True
+
     def sync_jobs(self):
         for job in self.jobs:
             logger.info("Checking status of job %s", job)

src/backend/apps/clusters/migrations/0016_alter_cluster_aap_version.py

@@ -0,0 +1,26 @@
+# Generated by Django 4.2.17 on 2025-10-23 12:13
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("clusters", "0015_cluster_client_id_cluster_client_secret_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="cluster",
+            name="aap_version",
+            field=models.CharField(
+                choices=[
+                    ("AAP 2.6", "AAP 2.6"),
+                    ("AAP 2.5", "AAP 2.5"),
+                    ("AAP 2.4", "AAP 2.4"),
+                ],
+                default="AAP 2.4",
+                max_length=15,
+            ),
+        ),
+    ]

src/backend/apps/clusters/models.py

@@ -36,6 +36,7 @@ class Meta:
 
 
 class ClusterVersionChoices(models.TextChoices):
+    AAP26 = "AAP 2.6", "AAP 2.6"
     AAP25 = "AAP 2.5", "AAP 2.5"
     AAP24 = "AAP 2.4", "AAP 2.4"
 
@@ -60,7 +61,7 @@ def base_url(self):
 
     @property
     def api_url(self):
-        if self.aap_version == ClusterVersionChoices.AAP25:
+        if self.aap_version in [ClusterVersionChoices.AAP25, ClusterVersionChoices.AAP26]:
             return f'/api/controller/v2'
         elif self.aap_version == ClusterVersionChoices.AAP24:
             return f'/api/v2'
@@ -69,13 +70,22 @@ def api_url(self):
 
     @property
     def gui_base_url(self):
-        if self.aap_version == ClusterVersionChoices.AAP25:
+        if self.aap_version in [ClusterVersionChoices.AAP25, ClusterVersionChoices.AAP26]:
             return f'{self.base_url}/execution/'
         elif self.aap_version == ClusterVersionChoices.AAP24:
             return f'{self.base_url}/#/'
         else:
             raise NotImplementedError
 
+    @property
+    def oauth_token_url(self):
+        if self.aap_version == ClusterVersionChoices.AAP26:
+            return '/o/token/'
+        elif self.aap_version in [ClusterVersionChoices.AAP24, ClusterVersionChoices.AAP25]:
+            return '/api/o/token/'
+        else:
+            raise NotImplementedError
+
     @property
     def cache_timeout_blocked(self):
         from backend.apps.scheduler.models import SyncJob, JobTypeChoices as SyncJobTypeChoices

src/backend/apps/clusters/schemas.py

@@ -28,7 +28,7 @@ class ClusterSettings(FrozenModel):
 
 
 class ClusterSchema(ClusterSettings):
-    aap_version: Literal["AAP 2.5", "AAP 2.4"] | None = None
+    aap_version: Literal["AAP 2.6", "AAP 2.5", "AAP 2.4"] | None = None
     api_url: str
     base_url: str
 

src/backend/tests/unit/test_connector.py

@@ -137,19 +137,19 @@ def mocked_requests_get(*args, **kwargs):
         response = connector.ping(url)
         assert response == {'version': '4.4.2'}
 
-    def test_is_aap25_instance(self, mocker, cluster):
+    def test_detect_aap_version_25(self, mocker, cluster):
         def mocked_requests_get(*args, **kwargs):
             headers = {
                 'Content-Type': 'application/json',
                 'X-Api-Product-Name': 'Red Hat Ansible Automation Platform',
             }
-            return get_response(**{'headers': headers})
+            return get_response(**{'headers': headers, 'data': dict(version="2.5")})
 
         connector = ApiConnector(cluster)
         mocker.patch('requests.get', new=mocked_requests_get)
-        assert connector.is_aap25_instance is True
+        assert connector.detect_aap_version() == ClusterVersionChoices.AAP25
 
-    def test_is_aap24_instance(self, mocker, cluster):
+    def test_detect_aap_version_24(self, mocker, cluster):
         def mocked_requests_get(*args, **kwargs):
             headers = {
                 'Content-Type': 'application/json',
@@ -158,26 +158,23 @@ def mocked_requests_get(*args, **kwargs):
             return get_response(**{'headers': headers})
 
         connector = ApiConnector(cluster)
-        mocker.patch('requests.get', new=mocked_requests_get)
-        assert connector.is_aap24_instance is True
+        mocker.patch('requests.get', side_effect=[None, mocked_requests_get()])
+        assert connector.detect_aap_version() == ClusterVersionChoices.AAP24
 
     def test_check_aap_version_24(self, mocker, cluster):
-        mocker.patch('backend.apps.clusters.connector.ApiConnector.is_aap25_instance', return_value=False, new_callable=mocker.PropertyMock)
-        mocker.patch('backend.apps.clusters.connector.ApiConnector.is_aap24_instance', return_value=True, new_callable=mocker.PropertyMock)
+        mocker.patch('backend.apps.clusters.connector.ApiConnector.detect_aap_version', return_value="AAP 2.4")
         connector = ApiConnector(cluster)
         connector.check_aap_version()
         assert Cluster.objects.first().aap_version == ClusterVersionChoices.AAP24
 
     def test_check_aap_version_25(self, mocker, cluster):
-        mocker.patch('backend.apps.clusters.connector.ApiConnector.is_aap25_instance', return_value=True, new_callable=mocker.PropertyMock)
-        mocker.patch('backend.apps.clusters.connector.ApiConnector.is_aap24_instance', return_value=False, new_callable=mocker.PropertyMock)
+        mocker.patch('backend.apps.clusters.connector.ApiConnector.detect_aap_version', return_value="AAP 2.5")
         connector = ApiConnector(cluster)
         connector.check_aap_version()
         assert Cluster.objects.first().aap_version == ClusterVersionChoices.AAP25
 
     def test_check_aap_version_fail(self, mocker, cluster):
-        mocker.patch('backend.apps.clusters.connector.ApiConnector.is_aap25_instance', return_value=False, new_callable=mocker.PropertyMock)
-        mocker.patch('backend.apps.clusters.connector.ApiConnector.is_aap24_instance', return_value=False, new_callable=mocker.PropertyMock)
+        mocker.patch('backend.apps.clusters.connector.ApiConnector.detect_aap_version', side_effect=Exception('Not valid version for cluster https://localhost:8000.'), new_callable=mocker.PropertyMock)
         connector = ApiConnector(cluster)
         with pytest.raises(Exception) as e:
             connector.check_aap_version()