APIv3 endpoint to manage Environment Variables #5913
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2 underscsores is weird here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree. This is because we are using
_selfas our attribute since it's kind of a "special name". Then, we needget_and the attribute...