resolve CR comments add unittests

Author: mkovalua

admin_tests/maintenance/test_views.py

@@ -8,7 +8,7 @@
 from django.core.exceptions import PermissionDenied
 
 import website.maintenance as maintenance
-from osf.models import MaintenanceState
+from osf.models import MaintenanceState, MaintenanceMode
 from osf_tests.factories import AuthUserFactory
 
 from admin_tests.utilities import setup_view
@@ -105,3 +105,59 @@ def test_correct_view_permissions(self, req, user, plain_view):
 
         res = plain_view.as_view()(req)
         assert res.status_code == 200
+
+
+@pytest.mark.urls('admin.base.urls')
+class TestMaintenanceMode:
+
+    @pytest.fixture()
+    def user(self):
+        user = AuthUserFactory()
+        view_permission = Permission.objects.get(codename='change_maintenancestate')
+        user.user_permissions.add(view_permission)
+        user.save()
+        return user
+
+    @pytest.fixture()
+    def plain_view(self):
+        return views.MaintenanceDisplay
+
+    @pytest.fixture()
+    def view(self, user, plain_view):
+        req = RequestFactory().get('/fake_path')
+        req.user = user
+        view = plain_view()
+        setup_view(view, req)
+        return view
+
+    def test_get_context_data_includes_maintenance_mode(self, view):
+        MaintenanceMode(maintenance_mode=True).save()
+        context = view.get_context_data()
+        assert context['maintenance_mode'] is True
+        MaintenanceMode(maintenance_mode=False).save()
+        context = view.get_context_data()
+        assert context['maintenance_mode'] is False
+
+    def test_post_toggles_maintenance_mode_on(self, user, plain_view):
+        MaintenanceMode(maintenance_mode=False).save()
+        req = RequestFactory().post('/fake_path', data={'maintenance_mode': 'False'})
+        req.user = user
+        view = plain_view()
+        setup_view(view, req)
+        response = view.post(req)
+        # It should redirect back to the display page
+        assert response.status_code == 302
+        # The database state should now be True
+        assert MaintenanceMode.is_under_maintenance() is True
+
+    def test_post_toggles_maintenance_mode_off(self, user, plain_view):
+        MaintenanceMode(maintenance_mode=True).save()
+        req = RequestFactory().post('/fake_path', data={'maintenance_mode': 'True'})
+        req.user = user
+        view = plain_view()
+        setup_view(view, req)
+        response = view.post(req)
+        # It should redirect back to the display page
+        assert response.status_code == 302
+        # The database state should now be False
+        assert MaintenanceMode.is_under_maintenance() is False

api/base/middleware.py

@@ -141,14 +141,14 @@ def __init__(self, get_response):
         self.get_response = get_response
 
     def __call__(self, request):
-        if request.path.endswith(('/v2', '/v2/')):
+        if request.path.endswith('/v2'):
             return self.get_response(request)
         if MaintenanceMode.is_under_maintenance():
             return JsonResponse(
                 {
                     'meta': {
                         'maintenance_mode': True,
-                        'status_page': 'status',
+                        'status_page': 'https://status.cos.io',
                     },
                 }, status=503,
             )

osf_tests/test_middleware.py

@@ -0,0 +1,28 @@
+import json
+import pytest
+from unittest import mock
+
+class TestMaintenanceModeMiddlewareIntegration:
+
+    MAINTENANCE_MOCK_PATH = 'api.base.middleware.MaintenanceMode.is_under_maintenance'
+
+    @mock.patch(MAINTENANCE_MOCK_PATH, return_value=True)
+    def test_bypasses_v2_root_if_maintenance_mode_on(self, mock_maintenance, client):
+        response = client.get('/v2')
+        assert response.status_code != 503
+        mock_maintenance.assert_not_called()
+
+    @pytest.mark.parametrize('method', ['post', 'patch', 'put', 'delete'])
+    @mock.patch(MAINTENANCE_MOCK_PATH, return_value=True)
+    def test_middleware_blocks_different_requests_if_maintenance_mode_on(self, mock_maintenance, client, method):
+        client_method = getattr(client, method)
+        response = client_method('/v2/nodes/', data={}, content_type='application/json')
+        assert response.status_code == 503
+        data = json.loads(response.content)
+        assert data['meta']['maintenance_mode'] is True
+        assert data['meta']['status_page'] == 'https://status.cos.io'
+
+    @mock.patch(MAINTENANCE_MOCK_PATH, return_value=False)
+    def test_passes_through_when_maintenance_mode_off(self, mock_maintenance, client):
+        response = client.get('/v2/nodes/')
+        assert response.status_code != 503