Merge pull request #5913 from readthedocs/humitos/apiv3-environmentvariables

APIv3 endpoint to manage Environment Variables

Author: humitos

readthedocs/api/v3/serializers.py

@@ -10,7 +10,7 @@
 
 from readthedocs.builds.models import Build, Version
 from readthedocs.projects.constants import LANGUAGES, PROGRAMMING_LANGUAGES, REPO_CHOICES
-from readthedocs.projects.models import Project
+from readthedocs.projects.models import Project, EnvironmentVariable
 from readthedocs.redirects.models import Redirect, TYPE_CHOICES as REDIRECT_TYPE_CHOICES
 
 
@@ -325,6 +325,7 @@ class ProjectLinksSerializer(BaseLinksSerializer):
 
     versions = serializers.SerializerMethodField()
     builds = serializers.SerializerMethodField()
+    environmentvariables = serializers.SerializerMethodField()
     redirects = serializers.SerializerMethodField()
     subprojects = serializers.SerializerMethodField()
     superproject = serializers.SerializerMethodField()
@@ -343,6 +344,15 @@ def get_versions(self, obj):
         )
         return self._absolute_url(path)
 
+    def get_environmentvariables(self, obj):
+        path = reverse(
+            'projects-environmentvariables-list',
+            kwargs={
+                'parent_lookup_project__slug': obj.slug,
+            },
+        )
+        return self._absolute_url(path)
+
     def get_redirects(self, obj):
         path = reverse(
             'projects-redirects-list',
@@ -550,3 +560,46 @@ def get_from_url(self, obj):
     def get_to_url(self, obj):
         # Overridden only to return ``None`` when the description is ``''``
         return obj.to_url or None
+
+
+class EnvironmentVariableLinksSerializer(BaseLinksSerializer):
+    _self = serializers.SerializerMethodField()
+    project = serializers.SerializerMethodField()
+
+    def get__self(self, obj):
+        path = reverse(
+            'projects-environmentvariables-detail',
+            kwargs={
+                'parent_lookup_project__slug': obj.project.slug,
+                'environmentvariable_pk': obj.pk,
+            },
+        )
+        return self._absolute_url(path)
+
+    def get_project(self, obj):
+        path = reverse(
+            'projects-detail',
+            kwargs={
+                'project_slug': obj.project.slug,
+            },
+        )
+        return self._absolute_url(path)
+
+
+class EnvironmentVariableSerializer(serializers.ModelSerializer):
+
+    value = serializers.CharField(write_only=True)
+    project = serializers.SlugRelatedField(slug_field='slug', read_only=True)
+    _links = EnvironmentVariableLinksSerializer(source='*', read_only=True)
+
+    class Meta:
+        model = EnvironmentVariable
+        fields = [
+            'pk',
+            'created',
+            'modified',
+            'name',
+            'value',
+            'project',
+            '_links',
+        ]

readthedocs/api/v3/tests/mixins.py

@@ -20,12 +20,12 @@ class APIEndpointMixin(TestCase):
     fixtures = []
 
     def setUp(self):
-        created = make_aware(datetime.datetime(2019, 4, 29, 10, 0, 0))
-        modified = make_aware(datetime.datetime(2019, 4, 29, 12, 0, 0))
+        self.created = make_aware(datetime.datetime(2019, 4, 29, 10, 0, 0))
+        self.modified = make_aware(datetime.datetime(2019, 4, 29, 12, 0, 0))
 
         self.me = fixture.get(
             User,
-            date_joined=created,
+            date_joined=self.created,
             username='testuser',
             projects=[],
         )
@@ -34,8 +34,8 @@ def setUp(self):
         # objects (like a Project for translations/subprojects)
         self.project = fixture.get(
             Project,
-            pub_date=created,
-            modified_date=modified,
+            pub_date=self.created,
+            modified_date=self.modified,
             description='Project description',
             repo='https://github.com/rtfd/project',
             project_url='http://project.com',
@@ -51,8 +51,8 @@ def setUp(self):
 
         self.redirect = fixture.get(
             Redirect,
-            create_dt=created,
-            update_dt=modified,
+            create_dt=self.created,
+            update_dt=self.modified,
             from_url='/docs/',
             to_url='/documentation/',
             redirect_type='page',
@@ -61,8 +61,8 @@ def setUp(self):
 
         self.subproject = fixture.get(
             Project,
-            pub_date=created,
-            modified_date=modified,
+            pub_date=self.created,
+            modified_date=self.modified,
             description='SubProject description',
             repo='https://github.com/rtfd/subproject',
             project_url='http://subproject.com',
@@ -91,7 +91,7 @@ def setUp(self):
 
         self.build = fixture.get(
             Build,
-            date=created,
+            date=self.created,
             type='html',
             state='finished',
             error='',

readthedocs/api/v3/tests/responses/projects-detail.json

@@ -60,6 +60,7 @@
     "_links": {
         "_self": "https://readthedocs.org/api/v3/projects/project/",
         "builds": "https://readthedocs.org/api/v3/projects/project/builds/",
+        "environmentvariables": "https://readthedocs.org/api/v3/projects/project/environmentvariables/",
         "redirects": "https://readthedocs.org/api/v3/projects/project/redirects/",
         "subprojects": "https://readthedocs.org/api/v3/projects/project/subprojects/",
         "superproject": "https://readthedocs.org/api/v3/projects/project/superproject/",

readthedocs/api/v3/tests/responses/projects-environmentvariables-detail.json

@@ -0,0 +1,11 @@
+{
+    "_links": {
+        "_self": "https://readthedocs.org/api/v3/projects/project/environmentvariables/1/",
+        "project": "https://readthedocs.org/api/v3/projects/project/"
+    },
+    "created": "2019-04-29T10:00:00Z",
+    "modified": "2019-04-29T12:00:00Z",
+    "pk": 1,
+    "project": "project",
+    "name": "ENVVAR"
+}

readthedocs/api/v3/tests/responses/projects-environmentvariables-list.json

@@ -0,0 +1,18 @@
+{
+    "count": 1,
+    "next": null,
+    "previous": null,
+    "results": [
+        {
+            "_links": {
+                "_self": "https://readthedocs.org/api/v3/projects/project/environmentvariables/1/",
+                "project": "https://readthedocs.org/api/v3/projects/project/"
+            },
+            "created": "2019-04-29T10:00:00Z",
+            "modified": "2019-04-29T12:00:00Z",
+            "pk": 1,
+            "project": "project",
+            "name": "ENVVAR"
+        }
+    ]
+}

readthedocs/api/v3/tests/responses/projects-environmentvariables-list_POST.json

@@ -0,0 +1,11 @@
+{
+    "_links": {
+        "_self": "https://readthedocs.org/api/v3/projects/project/environmentvariables/2/",
+        "project": "https://readthedocs.org/api/v3/projects/project/"
+    },
+    "created": "2019-04-29T10:00:00Z",
+    "modified": "2019-04-29T12:00:00Z",
+    "pk": 2,
+    "project": "project",
+    "name": "NEWENVVAR"
+}

readthedocs/api/v3/tests/responses/projects-list.json

@@ -49,6 +49,7 @@
                 "_self": "https://readthedocs.org/api/v3/projects/project/",
                 "versions": "https://readthedocs.org/api/v3/projects/project/versions/",
                 "builds": "https://readthedocs.org/api/v3/projects/project/builds/",
+                "environmentvariables": "https://readthedocs.org/api/v3/projects/project/environmentvariables/",
                 "redirects": "https://readthedocs.org/api/v3/projects/project/redirects/",
                 "subprojects": "https://readthedocs.org/api/v3/projects/project/subprojects/",
                 "superproject": "https://readthedocs.org/api/v3/projects/project/superproject/",

readthedocs/api/v3/tests/responses/projects-list_POST.json

@@ -2,6 +2,7 @@
     "_links": {
         "_self": "https://readthedocs.org/api/v3/projects/test-project/",
         "builds": "https://readthedocs.org/api/v3/projects/test-project/builds/",
+        "environmentvariables": "https://readthedocs.org/api/v3/projects/test-project/environmentvariables/",
         "redirects": "https://readthedocs.org/api/v3/projects/test-project/redirects/",
         "subprojects": "https://readthedocs.org/api/v3/projects/test-project/subprojects/",
         "superproject": "https://readthedocs.org/api/v3/projects/test-project/superproject/",

readthedocs/api/v3/tests/responses/projects-subprojects-list.json

@@ -68,6 +68,7 @@
                     "_self": "https://readthedocs.org/api/v3/projects/project/",
                     "versions": "https://readthedocs.org/api/v3/projects/project/versions/",
                     "builds": "https://readthedocs.org/api/v3/projects/project/builds/",
+                    "environmentvariables": "https://readthedocs.org/api/v3/projects/project/environmentvariables/",
                     "redirects": "https://readthedocs.org/api/v3/projects/project/redirects/",
                     "subprojects": "https://readthedocs.org/api/v3/projects/project/subprojects/",
                     "superproject": "https://readthedocs.org/api/v3/projects/project/superproject/",
@@ -91,6 +92,7 @@
                 "_self": "https://readthedocs.org/api/v3/projects/subproject/",
                 "versions": "https://readthedocs.org/api/v3/projects/subproject/versions/",
                 "builds": "https://readthedocs.org/api/v3/projects/subproject/builds/",
+                "environmentvariables": "https://readthedocs.org/api/v3/projects/subproject/environmentvariables/",
                 "redirects": "https://readthedocs.org/api/v3/projects/subproject/redirects/",
                 "subprojects": "https://readthedocs.org/api/v3/projects/subproject/subprojects/",
                 "superproject": "https://readthedocs.org/api/v3/projects/subproject/superproject/",

readthedocs/api/v3/tests/responses/projects-superproject.json

@@ -11,6 +11,7 @@
     "_links": {
         "_self": "https://readthedocs.org/api/v3/projects/project/",
         "builds": "https://readthedocs.org/api/v3/projects/project/builds/",
+        "environmentvariables": "https://readthedocs.org/api/v3/projects/project/environmentvariables/",
         "redirects": "https://readthedocs.org/api/v3/projects/project/redirects/",
         "subprojects": "https://readthedocs.org/api/v3/projects/project/subprojects/",
         "superproject": "https://readthedocs.org/api/v3/projects/project/superproject/",

readthedocs/api/v3/tests/responses/projects-versions-builds-list_POST.json

@@ -32,6 +32,7 @@
         "_links": {
             "_self": "https://readthedocs.org/api/v3/projects/project/",
             "builds": "https://readthedocs.org/api/v3/projects/project/builds/",
+            "environmentvariables": "https://readthedocs.org/api/v3/projects/project/environmentvariables/",
             "redirects": "https://readthedocs.org/api/v3/projects/project/redirects/",
             "subprojects": "https://readthedocs.org/api/v3/projects/project/subprojects/",
             "superproject": "https://readthedocs.org/api/v3/projects/project/superproject/",

readthedocs/api/v3/tests/test_environmentvariables.py

@@ -0,0 +1,144 @@
+from .mixins import APIEndpointMixin
+from django.urls import reverse
+
+import django_dynamic_fixture as fixture
+from readthedocs.projects.models import EnvironmentVariable
+
+
+class EnvironmentVariablessEndpointTests(APIEndpointMixin):
+
+    def setUp(self):
+        super().setUp()
+
+        self.environmentvariable = fixture.get(
+            EnvironmentVariable,
+            created=self.created,
+            modified=self.modified,
+            project=self.project,
+            name='ENVVAR',
+            value='a1b2c3',
+        )
+
+    def test_unauthed_projects_environmentvariables_list(self):
+        response = self.client.get(
+            reverse(
+                'projects-environmentvariables-list',
+                kwargs={
+                    'parent_lookup_project__slug': self.project.slug,
+                }),
+        )
+        self.assertEqual(response.status_code, 401)
+
+    def test_projects_environmentvariables_list(self):
+        self.client.credentials(HTTP_AUTHORIZATION=f'Token {self.token.key}')
+        response = self.client.get(
+            reverse(
+                'projects-environmentvariables-list',
+                kwargs={
+                    'parent_lookup_project__slug': self.project.slug,
+                }),
+        )
+        self.assertEqual(response.status_code, 200)
+
+        response_json = response.json()
+        self.assertDictEqual(
+            response_json,
+            self._get_response_dict('projects-environmentvariables-list'),
+        )
+
+    def test_unauthed_projects_environmentvariables_detail(self):
+        response = self.client.get(
+            reverse(
+                'projects-environmentvariables-detail',
+                kwargs={
+                    'parent_lookup_project__slug': self.project.slug,
+                    'environmentvariable_pk': self.environmentvariable.pk,
+                }),
+        )
+        self.assertEqual(response.status_code, 401)
+
+    def test_projects_environmentvariables_detail(self):
+        self.client.credentials(HTTP_AUTHORIZATION=f'Token {self.token.key}')
+        response = self.client.get(
+            reverse(
+                'projects-environmentvariables-detail',
+                kwargs={
+                    'parent_lookup_project__slug': self.project.slug,
+                    'environmentvariable_pk': self.environmentvariable.pk,
+                }),
+        )
+        self.assertEqual(response.status_code, 200)
+
+        response_json = response.json()
+        self.assertDictEqual(
+            response_json,
+            self._get_response_dict('projects-environmentvariables-detail'),
+        )
+
+    def test_unauthed_projects_environmentvariables_list_post(self):
+        data = {}
+
+        response = self.client.post(
+            reverse(
+                'projects-environmentvariables-list',
+                kwargs={
+                    'parent_lookup_project__slug': self.others_project.slug,
+                }),
+            data,
+        )
+        self.assertEqual(response.status_code, 401)
+
+        self.client.credentials(HTTP_AUTHORIZATION=f'Token {self.token.key}')
+        response = self.client.post(
+            reverse(
+                'projects-environmentvariables-list',
+                kwargs={
+                    'parent_lookup_project__slug': self.others_project.slug,
+                }),
+            data,
+        )
+        self.assertEqual(response.status_code, 403)
+
+    def test_projects_environmentvariables_list_post(self):
+        self.assertEqual(self.project.environmentvariable_set.count(), 1)
+        data = {
+            'name': 'NEWENVVAR',
+            'value': 'c3b2a1',
+        }
+
+        self.client.credentials(HTTP_AUTHORIZATION=f'Token {self.token.key}')
+        response = self.client.post(
+            reverse(
+                'projects-environmentvariables-list',
+                kwargs={
+                    'parent_lookup_project__slug': self.project.slug,
+                }),
+            data,
+        )
+        self.assertEqual(self.project.environmentvariable_set.count(), 2)
+        self.assertEqual(response.status_code, 201)
+
+        environmentvariable = self.project.environmentvariable_set.get(name='NEWENVVAR')
+        self.assertEqual(environmentvariable.value, 'c3b2a1')
+
+        response_json = response.json()
+        response_json['created'] = '2019-04-29T10:00:00Z'
+        response_json['modified'] = '2019-04-29T12:00:00Z'
+        self.assertDictEqual(
+            response_json,
+            self._get_response_dict('projects-environmentvariables-list_POST'),
+        )
+
+    def test_projects_environmentvariables_detail_delete(self):
+        self.assertEqual(self.project.environmentvariable_set.count(), 1)
+        self.client.credentials(HTTP_AUTHORIZATION=f'Token {self.token.key}')
+        response = self.client.delete(
+            reverse(
+                'projects-environmentvariables-detail',
+                kwargs={
+                    'parent_lookup_project__slug': self.project.slug,
+                    'environmentvariable_pk': self.environmentvariable.pk,
+                }),
+        )
+        self.assertEqual(response.status_code, 204)
+        self.assertEqual(self.project.environmentvariable_set.count(), 0)