Add client configuration api endpoint

fixes #740

CHANGES/740.feature

@@ -0,0 +1,2 @@
+Implement v3/plugin/client-configuration/ endpoint to communicate to the ansible galaxy client
+which distribution to use.

pulp_ansible/app/galaxy/v3/serializers.py

@@ -327,3 +327,9 @@ class RepoMetadataSerializer(serializers.ModelSerializer):
     class Meta:
         fields = ("published",)
         model = RepositoryVersion
+
+
+class ClientConfigurationSerializer(serializers.Serializer):
+    """Configuration settings for the ansible-galaxy client."""
+
+    default_distribution_path = serializers.CharField(allow_null=True)

pulp_ansible/app/galaxy/v3/views.py

@@ -40,6 +40,7 @@
     CollectionVersionListSerializer,
     RepoMetadataSerializer,
     UnpaginatedCollectionVersionSerializer,
+    ClientConfigurationSerializer,
 )
 from pulp_ansible.app.models import (
     AnsibleCollectionDeprecated,
@@ -981,3 +982,23 @@ def update(self, request, *args, **kwargs):
             return self._get(request, *args, **kwargs)
 
     return GeneratedRedirectView.as_view(actions, url=url)
+
+
+class ClientConfigurationView(views.APIView):
+    """Return configurations for the ansible-galaxy client."""
+
+    DEFAULT_ACCESS_POLICY = _PERMISSIVE_ACCESS_POLICY
+
+    @extend_schema(responses=ClientConfigurationSerializer)
+    def get(self, request, *args, **kwargs):
+        """Get the client configs."""
+
+        data = ClientConfigurationSerializer(
+            {
+                "default_distribution_path": self.kwargs.get(
+                    "path", settings.ANSIBLE_DEFAULT_DISTRIBUTION_PATH
+                )
+            }
+        )
+
+        return Response(data.data)

pulp_ansible/app/urls.py

@@ -198,6 +198,11 @@
         views_v3.CollectionImportViewSet.as_view({"get": "retrieve"}),
         name="collection-imports-detail",
     ),
+    path(
+        "client-configuration/",
+        views_v3.ClientConfigurationView.as_view(),
+        name="client-configuration-viewset",
+    ),
 ]
 
 v3_urls = [

pulp_ansible/tests/functional/api/collection/v3/test_client_configuration.py

@@ -0,0 +1,13 @@
+def test_client_config_distro(
+    ansible_repo, ansible_distribution_factory, ansible_client_configuration_api_client
+):
+    distro = ansible_distribution_factory(ansible_repo)
+    res = ansible_client_configuration_api_client.get(path=distro.base_path)
+    assert res.default_distribution_path == distro.base_path
+
+
+def test_client_config_default_distro(
+    ansible_repo, ansible_distribution_factory, ansible_client_default_configuration_api_client
+):
+    res = ansible_client_default_configuration_api_client.get()
+    assert res.default_distribution_path is None

pulp_ansible/tests/functional/conftest.py

@@ -19,6 +19,8 @@
     RemotesCollectionApi,
     RemotesGitApi,
     RemotesRoleApi,
+    PulpAnsibleApiV3PluginAnsibleClientConfigurationApi,
+    PulpAnsibleDefaultApiV3PluginAnsibleClientConfigurationApi,
 )
 
 
@@ -39,6 +41,18 @@ def ansible_collections_api_client(ansible_bindings_client):
     return AnsibleCollectionsApi(ansible_bindings_client)
 
 
+@pytest.fixture
+def ansible_client_configuration_api_client(ansible_bindings_client):
+    """Provides the Ansible Collections API client object."""
+    return PulpAnsibleApiV3PluginAnsibleClientConfigurationApi(ansible_bindings_client)
+
+
+@pytest.fixture
+def ansible_client_default_configuration_api_client(ansible_bindings_client):
+    """Provides the Ansible Collections API client object."""
+    return PulpAnsibleDefaultApiV3PluginAnsibleClientConfigurationApi(ansible_bindings_client)
+
+
 @pytest.fixture
 def ansible_collection_signatures_client(ansible_bindings_client):
     """Provides the Ansible Collection Signatures API client object."""