diff --git a/tests/samples/paranoid.cfg b/tests/samples/paranoid.cfg new file mode 100644 index 0000000..85b783f --- /dev/null +++ b/tests/samples/paranoid.cfg @@ -0,0 +1,15 @@ +[settings] +debug = false +api_key = 1234 +api_url = https://api.wakatime.com/api/v1/heartbeats +ignore = + COMMIT_EDITMSG$ + TAG_EDITMSG$ +exclude = + excludeme + \(invalid regex) +include = + \(invalid regex) + includeme +offline = true +hidefilenames = true diff --git a/tests/samples/sample.cfg b/tests/samples/sample.cfg index 6a38f3a..dfb7bcc 100644 --- a/tests/samples/sample.cfg +++ b/tests/samples/sample.cfg @@ -1,7 +1,6 @@ [settings] -debug = true +debug = false api_key = 1234 -api_url = https://api.wakatime.com/api/v1/heartbeats ignore = COMMIT_EDITMSG$ TAG_EDITMSG$ @@ -12,4 +11,4 @@ include = \(invalid regex) includeme offline = true -hidefilenames = true +hidefilenames = false diff --git a/tests/test_wakatime_base.py b/tests/test_wakatime_base.py index d8aa572..d440aac 100644 --- a/tests/test_wakatime_base.py +++ b/tests/test_wakatime_base.py @@ -1,23 +1,33 @@ # -*- coding: utf-8 -*- +from wakatime.base import main +from wakatime.packages import requests + +import os +import time import sys from wakatime.compat import u from wakatime.packages.requests.models import Response from . import utils try: - from mock import patch + from mock import ANY except ImportError: - from unittest.mock import patch - -from wakatime.base import main + from unittest.mock import ANY -@patch('wakatime.packages.requests.adapters.HTTPAdapter.send') class BaseTestCase(utils.TestCase): + patch_these = [ + 'wakatime.packages.requests.adapters.HTTPAdapter.send', + 'wakatime.offlinequeue.Queue.push', + ['wakatime.offlinequeue.Queue.pop', None], + 'wakatime.session_cache.SessionCache.save', + 'wakatime.session_cache.SessionCache.delete', + ['wakatime.session_cache.SessionCache.get', requests.session], + ] - def test_help_contents(self, mock_requests): + def test_help_contents(self): args = ['--help'] with self.assertRaises(SystemExit): main(args) @@ -25,18 +35,29 @@ class BaseTestCase(utils.TestCase): self.assertEquals(sys.stdout.getvalue(), expected_stdout) self.assertEquals(sys.stderr.getvalue(), '') - def test_argument_parsing(self, mock_requests): + self.patched['wakatime.offlinequeue.Queue.push'].assert_not_called() + self.patched['wakatime.offlinequeue.Queue.pop'].assert_not_called() + + def test_argument_parsing(self): response = Response() response.status_code = 201 - mock_requests.return_value = response - args = ['--file', 'tests/samples/twolinefile.txt', '--key', '123', '--config', 'foo'] + self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response + + args = ['--file', 'tests/samples/twolinefile.txt', '--key', '123', '--config', 'tests/samples/sample.cfg'] + retval = main(args) self.assertEquals(retval, 0) - expected_stdout = u("Error: Could not read from config file foo\n") - self.assertEquals(sys.stdout.getvalue(), expected_stdout) + self.assertEquals(sys.stdout.getvalue(), '') self.assertEquals(sys.stderr.getvalue(), '') - def test_missing_config_file(self, mock_requests): + self.patched['wakatime.session_cache.SessionCache.get'].assert_called_once_with() + self.patched['wakatime.session_cache.SessionCache.delete'].assert_not_called() + self.patched['wakatime.session_cache.SessionCache.save'].assert_called_once_with(ANY) + + self.patched['wakatime.offlinequeue.Queue.push'].assert_not_called() + self.patched['wakatime.offlinequeue.Queue.pop'].assert_called_once_with() + + def test_missing_config_file(self): args = ['--file', 'tests/samples/emptyfile.txt', '--config', 'foo'] with self.assertRaises(SystemExit): main(args) @@ -45,19 +66,158 @@ class BaseTestCase(utils.TestCase): self.assertEquals(sys.stdout.getvalue(), expected_stdout) self.assertEquals(sys.stderr.getvalue(), expected_stderr) - def test_config_file(self, mock_requests): + self.patched['wakatime.session_cache.SessionCache.get'].assert_not_called() + + def test_config_file(self): response = Response() response.status_code = 201 - mock_requests.return_value = response + self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response + args = ['--file', 'tests/samples/emptyfile.txt', '--config', 'tests/samples/sample.cfg'] retval = main(args) self.assertEquals(retval, 0) self.assertEquals(sys.stdout.getvalue(), '') self.assertEquals(sys.stderr.getvalue(), '') - def test_bad_config_file(self, mock_requests): + self.patched['wakatime.session_cache.SessionCache.get'].assert_called_once_with() + self.patched['wakatime.session_cache.SessionCache.delete'].assert_not_called() + self.patched['wakatime.session_cache.SessionCache.save'].assert_called_once_with(ANY) + + self.patched['wakatime.offlinequeue.Queue.push'].assert_not_called() + self.patched['wakatime.offlinequeue.Queue.pop'].assert_called_once_with() + + def test_bad_config_file(self): args = ['--file', 'tests/samples/emptyfile.txt', '--config', 'tests/samples/bad_config.cfg'] retval = main(args) self.assertEquals(retval, 103) self.assertIn('ParsingError', sys.stdout.getvalue()) self.assertEquals(sys.stderr.getvalue(), '') + self.patched['wakatime.offlinequeue.Queue.push'].assert_not_called() + self.patched['wakatime.session_cache.SessionCache.get'].assert_not_called() + self.patched['wakatime.session_cache.SessionCache.delete'].assert_not_called() + self.patched['wakatime.session_cache.SessionCache.save'].assert_not_called() + + def test_non_hidden_filename(self): + response = Response() + response.status_code = 0 + self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response + + now = u(int(time.time())) + entity = 'tests/samples/twolinefile.txt' + config = 'tests/samples/sample.cfg' + + args = ['--file', entity, '--key', '123', '--config', config, '--time', now] + + retval = main(args) + self.assertEquals(retval, 102) + self.assertEquals(sys.stdout.getvalue(), '') + self.assertEquals(sys.stderr.getvalue(), '') + + self.patched['wakatime.session_cache.SessionCache.get'].assert_called_once_with() + self.patched['wakatime.session_cache.SessionCache.delete'].assert_called_once_with() + self.patched['wakatime.session_cache.SessionCache.save'].assert_not_called() + + heartbeat = { + 'language': 'Text only', + 'lines': 2, + 'entity': os.path.abspath(entity), + 'project': 'wakatime-cli', + 'branch': 'master', + 'time': float(now), + 'type': 'file', + } + stats = '{"cursorpos": null, "dependencies": [], "lines": 2, "lineno": null, "language": "Text only"}' + + self.patched['wakatime.offlinequeue.Queue.push'].assert_called_once_with(heartbeat, stats, None) + self.patched['wakatime.offlinequeue.Queue.pop'].assert_not_called() + + def test_hidden_filename(self): + response = Response() + response.status_code = 0 + self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response + + now = u(int(time.time())) + entity = 'tests/samples/twolinefile.txt' + config = 'tests/samples/paranoid.cfg' + + args = ['--file', entity, '--key', '123', '--config', config, '--time', now] + + retval = main(args) + self.assertEquals(retval, 102) + self.assertEquals(sys.stdout.getvalue(), '') + self.assertEquals(sys.stderr.getvalue(), '') + + self.patched['wakatime.session_cache.SessionCache.get'].assert_called_once_with() + self.patched['wakatime.session_cache.SessionCache.delete'].assert_called_once_with() + self.patched['wakatime.session_cache.SessionCache.save'].assert_not_called() + + heartbeat = { + 'language': 'Text only', + 'lines': 2, + 'entity': 'HIDDEN.txt', + 'project': 'wakatime-cli', + 'branch': 'master', + 'time': float(now), + 'type': 'file', + } + stats = '{"cursorpos": null, "dependencies": [], "lines": 2, "lineno": null, "language": "Text only"}' + + self.patched['wakatime.offlinequeue.Queue.push'].assert_called_once_with(heartbeat, stats, None) + self.patched['wakatime.offlinequeue.Queue.pop'].assert_not_called() + + def test_500_response(self): + response = Response() + response.status_code = 500 + self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response + + now = u(int(time.time())) + + args = ['--file', 'tests/samples/twolinefile.txt', '--key', '123', + '--config', 'tests/samples/paranoid.cfg', '--time', now] + + + retval = main(args) + self.assertEquals(retval, 102) + self.assertEquals(sys.stdout.getvalue(), '') + self.assertEquals(sys.stderr.getvalue(), '') + + self.patched['wakatime.session_cache.SessionCache.delete'].assert_called_once_with() + self.patched['wakatime.session_cache.SessionCache.get'].assert_called_once_with() + self.patched['wakatime.session_cache.SessionCache.save'].assert_not_called() + + heartbeat = { + 'language': 'Text only', + 'lines': 2, + 'entity': 'HIDDEN.txt', + 'project': 'wakatime-cli', + 'branch': 'master', + 'time': float(now), + 'type': 'file', + } + stats = '{"cursorpos": null, "dependencies": [], "lines": 2, "lineno": null, "language": "Text only"}' + + self.patched['wakatime.offlinequeue.Queue.push'].assert_called_once_with(heartbeat, stats, None) + self.patched['wakatime.offlinequeue.Queue.pop'].assert_not_called() + + def test_400_response(self): + response = Response() + response.status_code = 400 + self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response + + now = u(int(time.time())) + + args = ['--file', 'tests/samples/twolinefile.txt', '--key', '123', + '--config', 'tests/samples/paranoid.cfg', '--time', now] + + + retval = main(args) + self.assertEquals(retval, 102) + self.assertEquals(sys.stdout.getvalue(), '') + self.assertEquals(sys.stderr.getvalue(), '') + + self.patched['wakatime.session_cache.SessionCache.delete'].assert_called_once_with() + self.patched['wakatime.session_cache.SessionCache.get'].assert_called_once_with() + self.patched['wakatime.session_cache.SessionCache.save'].assert_not_called() + + self.patched['wakatime.offlinequeue.Queue.push'].assert_not_called() + self.patched['wakatime.offlinequeue.Queue.pop'].assert_not_called() diff --git a/tests/utils.py b/tests/utils.py index cd73e21..9b8142e 100644 --- a/tests/utils.py +++ b/tests/utils.py @@ -2,6 +2,10 @@ import logging +try: + from mock import patch +except ImportError: + from unittest.mock import patch try: # Python 2.6 import unittest2 as unittest @@ -10,7 +14,26 @@ except ImportError: import unittest class TestCase(unittest.TestCase): + patch_these = [] def setUp(self): # disable logging while testing logging.disable(logging.CRITICAL) + + self.patched = {} + if hasattr(self, 'patch_these'): + for patch_this in self.patch_these: + namespace = patch_this[0] if isinstance(patch_this, (list, set)) else patch_this + + patcher = patch(namespace) + mocked = patcher.start() + self.patched[namespace] = mocked + + if isinstance(patch_this, (list, set)) and len(patch_this) > 0: + retval = patch_this[1] + if callable(retval): + retval = retval() + mocked.return_value = retval + + def tearDown(self): + patch.stopall()