method to delete webapp log files

Author: filiplajszczak

pythonanywhere/api.py

@@ -174,3 +174,32 @@ def get_ssl_info(self):
         result = response.json()
         result["not_after"] = datetime.strptime(result["not_after"], "%Y%m%dT%H%M%SZ")
         return result
+
+    def delete_log(self, log_type, index=0):
+        if index:
+            print(snakesay(
+                'Deleting old (archive number {index}) {type} log file for {domain} via API'.format(index=index,
+                                                                                                    type=log_type,
+                                                                                                    domain=self.domain)))
+        else:
+            print(snakesay(
+                'Deleting current {type} log file for {domain} via API'.format(type=log_type, domain=self.domain)))
+
+        if index == 1:
+            url = get_api_endpoint("files").format(username=getpass.getuser()) + "path/var/log/{domain}.{type}.log.1/".format(
+                domain=self.domain, type=log_type)
+        elif index > 1:
+            url = get_api_endpoint("files").format(
+                username=getpass.getuser()) + "path/var/log/{domain}.{type}.log.{index}.gz/".format(
+                domain=self.domain, type=log_type, index=index)
+        else:
+            url = get_api_endpoint("files").format(username=getpass.getuser()) + "path/var/log/{domain}.{type}.log/".format(
+                domain=self.domain, type=log_type)
+        response = call_api(url, "delete")
+        if not response.ok:
+            raise Exception(
+                "DELETE log file via API failed, got {response}:{response_text}".format(
+                    response=response,
+                    response_text=response.text,
+                )
+            )

tests/test_api.py

@@ -328,3 +328,41 @@ def test_raises_if_get_does_not_return_200(self, api_responses, api_token):
 
         assert 'GET SSL details via API failed, got' in str(e.value)
         assert 'nope' in str(e.value)
+
+
+class TestDeleteWebappLog:
+
+    def test_delete_current_access_log(self, api_responses, api_token):
+        expected_url = get_api_endpoint(flavour="files").format(
+            username=getpass.getuser()) + "path/var/log/mydomain.com.access.log/"
+        api_responses.add(responses.DELETE, expected_url, status=200)
+
+        Webapp("mydomain.com").delete_log(log_type="access")
+
+        post = api_responses.calls[0]
+        assert post.request.url == expected_url
+        assert post.request.body is None
+        assert post.request.headers['Authorization'] == 'Token {api_token}'.format(api_token=api_token)
+
+    def test_delete_old_access_log(self, api_responses, api_token):
+        expected_url = get_api_endpoint(flavour="files").format(
+            username=getpass.getuser()) + "path/var/log/mydomain.com.access.log.1/"
+        api_responses.add(responses.DELETE, expected_url, status=200)
+
+        Webapp("mydomain.com").delete_log(log_type="access", index=1)
+
+        post = api_responses.calls[0]
+        assert post.request.url == expected_url
+        assert post.request.body is None
+        assert post.request.headers['Authorization'] == 'Token {api_token}'.format(api_token=api_token)
+
+    def test_raises_if_post_does_not_20x(self, api_responses, api_token):
+        expected_url = get_api_endpoint(flavour="files").format(
+            username=getpass.getuser()) + "path/var/log/mydomain.com.access.log/"
+        api_responses.add(responses.DELETE, expected_url, status=404, body="nope")
+
+        with pytest.raises(Exception) as e:
+            Webapp("mydomain.com").delete_log(log_type="access")
+
+        assert "DELETE log file via API failed" in str(e.value)
+        assert "nope" in str(e.value)