# -*- coding: utf-8 -*- from wakatime.main import execute from wakatime.offlinequeue import Queue from wakatime.packages import requests import logging import os import sqlite3 import shutil import time import uuid from testfixtures import log_capture from wakatime.compat import u from wakatime.constants import API_ERROR, AUTH_ERROR, SUCCESS from wakatime.packages.requests.models import Response from . import utils from .utils import ANY, json, CustomResponse class OfflineQueueTestCase(utils.TestCase): patch_these = [ 'wakatime.packages.requests.adapters.HTTPAdapter.send', 'wakatime.session_cache.SessionCache.save', 'wakatime.session_cache.SessionCache.delete', ['wakatime.session_cache.SessionCache.get', requests.session], ['wakatime.session_cache.SessionCache.connect', None], ] def test_heartbeat_saved_from_error_response(self): with utils.NamedTemporaryFile() as fh: with utils.mock.patch('wakatime.offlinequeue.Queue._get_db_file') as mock_db_file: mock_db_file.return_value = fh.name response = Response() response.status_code = 500 self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response now = u(int(time.time())) entity = 'tests/samples/codefiles/twolinefile.txt' config = 'tests/samples/configs/good_config.cfg' args = ['--file', entity, '--config', config, '--time', now] execute(args) queue = Queue(None, None) saved_heartbeat = queue.pop() self.assertEquals(os.path.realpath(entity), saved_heartbeat['entity']) def test_heartbeat_discarded_from_400_response(self): with utils.NamedTemporaryFile() as fh: with utils.mock.patch('wakatime.offlinequeue.Queue._get_db_file') as mock_db_file: mock_db_file.return_value = fh.name response = Response() response.status_code = 400 self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response now = u(int(time.time())) entity = 'tests/samples/codefiles/twolinefile.txt' config = 'tests/samples/configs/good_config.cfg' args = ['--file', entity, '--config', config, '--time', now] execute(args) queue = Queue(None, None) saved_heartbeat = queue.pop() self.assertEquals(None, saved_heartbeat) def test_offline_heartbeat_sent_after_success_response(self): with utils.NamedTemporaryFile() as fh: with utils.mock.patch('wakatime.offlinequeue.Queue._get_db_file') as mock_db_file: mock_db_file.return_value = fh.name response = Response() response.status_code = 500 self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response now = u(int(time.time())) entity = 'tests/samples/codefiles/twolinefile.txt' config = 'tests/samples/configs/good_config.cfg' args = ['--file', entity, '--config', config, '--time', now] execute(args) response = CustomResponse() response.response_text = '[[{"id":1},201], [{"id":1},201], [{"id":1},201]]' self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response execute(args) queue = Queue(None, None) saved_heartbeat = queue.pop() self.assertEquals(None, saved_heartbeat) def test_all_offline_heartbeats_sent_after_success_response(self): with utils.NamedTemporaryFile() as fh: with utils.mock.patch('wakatime.offlinequeue.Queue._get_db_file') as mock_db_file: mock_db_file.return_value = fh.name response = Response() response.status_code = 500 self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response config = 'tests/samples/configs/good_config.cfg' now1 = u(int(time.time())) entity1 = 'tests/samples/codefiles/emptyfile.txt' project1 = 'proj1' args = ['--file', entity1, '--config', config, '--time', now1, '--project', project1] execute(args) now2 = u(int(time.time())) entity2 = 'tests/samples/codefiles/twolinefile.txt' project2 = 'proj2' args = ['--file', entity2, '--config', config, '--time', now2, '--project', project2] execute(args) # send heartbeats from offline queue after 201 response now3 = u(int(time.time())) entity3 = 'tests/samples/codefiles/python.py' project3 = 'proj3' args = ['--file', entity3, '--config', config, '--time', now3, '--project', project3] response = CustomResponse() response.response_text = '[[{"id":1},201], [{"id":1},201], [{"id":1},201]]' self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response execute(args) # offline queue should be empty queue = Queue(None, None) saved_heartbeat = queue.pop() self.assertEquals(None, saved_heartbeat) calls = self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].call_args_list body = calls[0][0][0].body data = json.loads(body)[0] self.assertEquals(data.get('entity'), os.path.abspath(entity1)) self.assertEquals(data.get('project'), project1) self.assertEquals(u(int(data.get('time'))), now1) body = calls[1][0][0].body data = json.loads(body)[0] self.assertEquals(data.get('entity'), os.path.abspath(entity2)) self.assertEquals(data.get('project'), project2) self.assertEquals(u(int(data.get('time'))), now2) body = calls[2][0][0].body data = json.loads(body)[0] self.assertEquals(data.get('entity'), os.path.abspath(entity3)) self.assertEquals(data.get('project'), project3) self.assertEquals(u(int(data.get('time'))), now3) body = calls[3][0][0].body data = json.loads(body)[0] self.assertEquals(data.get('entity'), os.path.abspath(entity1)) self.assertEquals(data.get('project'), project1) self.assertEquals(u(int(data.get('time'))), now1) body = calls[3][0][0].body data = json.loads(body)[1] self.assertEquals(data.get('entity'), os.path.abspath(entity2)) self.assertEquals(data.get('project'), project2) self.assertEquals(u(int(data.get('time'))), now2) @log_capture() def test_heartbeats_sent_not_saved_from_bulk_response(self, logs): logging.disable(logging.NOTSET) with utils.NamedTemporaryFile() as fh: with utils.mock.patch('wakatime.offlinequeue.Queue._get_db_file') as mock_db_file: mock_db_file.return_value = fh.name entities = [ 'emptyfile.txt', 'twolinefile.txt', 'python.py', 'go.go', ] with utils.TemporaryDirectory() as tempdir: for entity in entities: shutil.copy(os.path.join('tests/samples/codefiles', entity), os.path.join(tempdir, entity)) now = u(int(time.time())) key = str(uuid.uuid4()) args = ['--file', os.path.join(tempdir, entities[0]), '--key', key, '--config', 'tests/samples/configs/good_config.cfg', '--time', now, '--extra-heartbeats'] response = CustomResponse() response.response_code = 202 response.response_text = '[[{"id":1},201], [{"error":"error 2"},500], [{"id":3},201], [{"error":4},500]]' self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response with utils.mock.patch('wakatime.main.sys.stdin') as mock_stdin: heartbeats = json.dumps([{ 'timestamp': now, 'entity': os.path.join(tempdir, entity), 'entity_type': 'file', 'is_write': False, } for entity in entities[1:]]) mock_stdin.readline.return_value = heartbeats with utils.mock.patch('wakatime.offlinequeue.Queue.pop') as mock_pop: mock_pop.return_value = None retval = execute(args) self.assertEquals(retval, SUCCESS) self.assertNothingPrinted() heartbeat = { 'entity': os.path.realpath(os.path.join(tempdir, entities[0])), 'language': ANY, 'lines': ANY, 'project': ANY, 'time': ANY, 'type': 'file', 'is_write': ANY, 'user_agent': ANY, 'dependencies': ANY, } extra_heartbeats = [{ 'entity': os.path.realpath(os.path.join(tempdir, entity)), 'language': ANY, 'lines': ANY, 'project': ANY, 'branch': ANY, 'time': ANY, 'is_write': ANY, 'type': 'file', 'dependencies': ANY, 'user_agent': ANY, } for entity in entities[1:]] self.assertHeartbeatSent(heartbeat, extra_heartbeats=extra_heartbeats) self.assertSessionCacheSaved() queue = Queue(None, None) self.assertEquals(queue._get_db_file(), fh.name) saved_heartbeats = queue.pop_many() self.assertNothingPrinted() self.assertNothingLogged(logs) # make sure only heartbeats with error code responses were saved self.assertEquals(len(saved_heartbeats), 2) self.assertEquals(saved_heartbeats[0].entity, os.path.realpath(os.path.join(tempdir, entities[1]))) self.assertEquals(saved_heartbeats[1].entity, os.path.realpath(os.path.join(tempdir, entities[3]))) @log_capture() def test_offline_heartbeats_sent_after_partial_success_from_bulk_response(self, logs): logging.disable(logging.NOTSET) with utils.NamedTemporaryFile() as fh: with utils.mock.patch('wakatime.offlinequeue.Queue._get_db_file') as mock_db_file: mock_db_file.return_value = fh.name entities = [ 'emptyfile.txt', 'twolinefile.txt', 'python.py', 'go.go', ] with utils.TemporaryDirectory() as tempdir: for entity in entities: shutil.copy(os.path.join('tests/samples/codefiles', entity), os.path.join(tempdir, entity)) now = u(int(time.time())) key = str(uuid.uuid4()) args = ['--file', os.path.join(tempdir, entities[0]), '--key', key, '--config', 'tests/samples/configs/good_config.cfg', '--time', now, '--extra-heartbeats'] response = CustomResponse() response.response_code = 202 response.response_text = '[[{"id":1},201], [{"error":"error 2"},500], [{"id":3},201], [{"error":4},500]]' self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response with utils.mock.patch('wakatime.main.sys.stdin') as mock_stdin: heartbeats = json.dumps([{ 'timestamp': now, 'entity': os.path.join(tempdir, entity), 'entity_type': 'file', 'is_write': False, } for entity in entities[1:]]) mock_stdin.readline.return_value = heartbeats retval = execute(args) self.assertEquals(retval, SUCCESS) self.assertNothingPrinted() expected = 'WakaTime WARNING Results from api not matching heartbeats sent.' actual = self.getLogOutput(logs) self.assertEquals(actual, expected) queue = Queue(None, None) self.assertEquals(queue._get_db_file(), fh.name) saved_heartbeats = queue.pop_many() self.assertNothingPrinted() # make sure all offline heartbeats were sent, so queue should only have 1 heartbeat left from the second 500 response self.assertEquals(len(saved_heartbeats), 1) @log_capture() def test_leftover_heartbeats_saved_when_bulk_response_not_matching_length(self, logs): logging.disable(logging.NOTSET) with utils.NamedTemporaryFile() as fh: with utils.mock.patch('wakatime.offlinequeue.Queue._get_db_file') as mock_db_file: mock_db_file.return_value = fh.name entities = [ 'emptyfile.txt', 'twolinefile.txt', 'python.py', 'go.go', 'java.java', 'php.php', ] with utils.TemporaryDirectory() as tempdir: for entity in entities: shutil.copy(os.path.join('tests/samples/codefiles', entity), os.path.join(tempdir, entity)) now = u(int(time.time())) key = str(uuid.uuid4()) args = ['--file', os.path.join(tempdir, entities[0]), '--key', key, '--config', 'tests/samples/configs/good_config.cfg', '--time', now, '--extra-heartbeats'] response = CustomResponse() response.response_code = 202 response.response_text = '[[{"id":1},201], [{"id":3},201]]' self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response with utils.mock.patch('wakatime.main.sys.stdin') as mock_stdin: heartbeats = json.dumps([{ 'timestamp': now, 'entity': os.path.join(tempdir, entity), 'entity_type': 'file', 'is_write': False, } for entity in entities[1:]]) mock_stdin.readline.return_value = heartbeats retval = execute(args) self.assertEquals(retval, SUCCESS) self.assertNothingPrinted() queue = Queue(None, None) self.assertEquals(queue._get_db_file(), fh.name) saved_heartbeats = queue.pop_many() self.assertNothingPrinted() expected = "WakaTime WARNING Missing 4 results from api.\nWakaTime WARNING Missing 2 results from api." actual = self.getLogOutput(logs) self.assertEquals(actual, expected) # make sure extra heartbeats not matching server response were saved self.assertEquals(len(saved_heartbeats), 2) def test_auth_error_when_sending_offline_heartbeats(self): with utils.NamedTemporaryFile() as fh: with utils.mock.patch('wakatime.offlinequeue.Queue._get_db_file') as mock_db_file: mock_db_file.return_value = fh.name response = Response() response.status_code = 500 self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response config = 'tests/samples/configs/good_config.cfg' now1 = u(int(time.time())) entity1 = 'tests/samples/codefiles/emptyfile.txt' project1 = 'proj1' args = ['--file', entity1, '--config', config, '--time', now1, '--project', project1] execute(args) now2 = u(int(time.time())) entity2 = 'tests/samples/codefiles/twolinefile.txt' project2 = 'proj2' args = ['--file', entity2, '--config', config, '--time', now2, '--project', project2] execute(args) # send heartbeats from offline queue after 201 response now3 = u(int(time.time())) entity3 = 'tests/samples/codefiles/python.py' project3 = 'proj3' args = ['--file', entity3, '--config', config, '--time', now3, '--project', project3] response = CustomResponse() response.second_response_code = 401 response.limit = 2 response.response_text = '[[{"id":1},201], [{"id":1},201], [{"id":1},201]]' self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response retval = execute(args) self.assertEquals(retval, AUTH_ERROR) # offline queue should still have saved heartbeats queue = Queue(None, None) saved_heartbeats = queue.pop_many() self.assertNothingPrinted() self.assertEquals(len(saved_heartbeats), 2) def test_500_error_when_sending_offline_heartbeats(self): with utils.NamedTemporaryFile() as fh: with utils.mock.patch('wakatime.offlinequeue.Queue._get_db_file') as mock_db_file: mock_db_file.return_value = fh.name response = Response() response.status_code = 500 self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response config = 'tests/samples/configs/good_config.cfg' now1 = u(int(time.time())) entity1 = 'tests/samples/codefiles/emptyfile.txt' project1 = 'proj1' args = ['--file', entity1, '--config', config, '--time', now1, '--project', project1] execute(args) now2 = u(int(time.time())) entity2 = 'tests/samples/codefiles/twolinefile.txt' project2 = 'proj2' args = ['--file', entity2, '--config', config, '--time', now2, '--project', project2] execute(args) # send heartbeats from offline queue after 201 response now3 = u(int(time.time())) entity3 = 'tests/samples/codefiles/python.py' project3 = 'proj3' args = ['--file', entity3, '--config', config, '--time', now3, '--project', project3] response = CustomResponse() response.second_response_code = 500 response.limit = 2 response.response_text = '[[{"id":1},201], [{"id":1},201], [{"id":1},201]]' self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response retval = execute(args) self.assertEquals(retval, API_ERROR) # offline queue should still have saved heartbeats queue = Queue(None, None) saved_heartbeats = queue.pop_many() self.assertNothingPrinted() self.assertEquals(len(saved_heartbeats), 2) def test_empty_project_can_be_saved(self): with utils.NamedTemporaryFile() as fh: with utils.mock.patch('wakatime.offlinequeue.Queue._get_db_file') as mock_db_file: mock_db_file.return_value = fh.name response = Response() response.status_code = 500 self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response now = u(int(time.time())) entity = 'tests/samples/codefiles/emptyfile.txt' config = 'tests/samples/configs/good_config.cfg' args = ['--file', entity, '--config', config, '--time', now] execute(args) queue = Queue(None, None) saved_heartbeat = queue.pop() self.assertNothingPrinted() self.assertEquals(os.path.realpath(entity), saved_heartbeat['entity']) def test_get_handles_connection_exception(self): with utils.NamedTemporaryFile() as fh: with utils.mock.patch('wakatime.offlinequeue.Queue._get_db_file') as mock_db_file: mock_db_file.return_value = fh.name response = Response() response.status_code = 500 self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response now = u(int(time.time())) entity = 'tests/samples/codefiles/twolinefile.txt' config = 'tests/samples/configs/good_config.cfg' args = ['--file', entity, '--config', config, '--time', now] execute(args) with utils.mock.patch('wakatime.offlinequeue.Queue.connect') as mock_connect: mock_connect.side_effect = sqlite3.Error('') response.status_code = 201 execute(args) queue = Queue(None, None) saved_heartbeat = queue.pop() self.assertEquals(None, saved_heartbeat) queue = Queue(None, None) saved_heartbeat = queue.pop() self.assertEquals(os.path.realpath(entity), saved_heartbeat['entity']) def test_push_handles_connection_exception(self): with utils.NamedTemporaryFile() as fh: with utils.mock.patch('wakatime.offlinequeue.Queue._get_db_file') as mock_db_file: mock_db_file.return_value = fh.name response = Response() response.status_code = 500 self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response now = u(int(time.time())) entity = 'tests/samples/codefiles/twolinefile.txt' config = 'tests/samples/configs/good_config.cfg' with utils.mock.patch('wakatime.offlinequeue.Queue.connect') as mock_connect: mock_connect.side_effect = sqlite3.Error('') args = ['--file', entity, '--config', config, '--time', now] execute(args) response.status_code = 201 execute(args) queue = Queue(None, None) saved_heartbeat = queue.pop() self.assertEquals(None, saved_heartbeat) def test_uses_home_folder_by_default(self): queue = Queue(None, None) db_file = queue._get_db_file() expected = os.path.join(os.path.expanduser('~'), '.wakatime.db') self.assertEquals(db_file, expected) def test_uses_wakatime_home_env_variable(self): queue = Queue(None, None) with utils.TemporaryDirectory() as tempdir: expected = os.path.realpath(os.path.join(tempdir, '.wakatime.db')) with utils.mock.patch('os.environ.get') as mock_env: mock_env.return_value = os.path.realpath(tempdir) actual = queue._get_db_file() self.assertEquals(actual, expected) @log_capture() def test_heartbeat_saved_when_requests_raises_exception(self, logs): logging.disable(logging.NOTSET) with utils.NamedTemporaryFile() as fh: with utils.mock.patch('wakatime.offlinequeue.Queue._get_db_file') as mock_db_file: mock_db_file.return_value = fh.name exception_msg = u("Oops, requests raised an exception. This is a test.") self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].side_effect = AttributeError(exception_msg) now = u(int(time.time())) entity = 'tests/samples/codefiles/twolinefile.txt' config = 'tests/samples/configs/good_config.cfg' args = ['--file', entity, '--config', config, '--time', now] execute(args) queue = Queue(None, None) saved_heartbeat = queue.pop() self.assertEquals(os.path.realpath(entity), saved_heartbeat['entity']) self.assertNothingPrinted() output = [u(' ').join(x) for x in logs.actual()] self.assertIn(exception_msg, output[0]) 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() @log_capture() def test_nonascii_heartbeat_saved(self, logs): logging.disable(logging.NOTSET) with utils.NamedTemporaryFile() as fh: with utils.mock.patch('wakatime.offlinequeue.Queue._get_db_file') as mock_db_file: mock_db_file.return_value = fh.name response = Response() response.status_code = 500 self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response with utils.TemporaryDirectory() as tempdir: filename = list(filter(lambda x: x.endswith('.txt'), os.listdir(u('tests/samples/codefiles/unicode'))))[0] entity = os.path.join('tests/samples/codefiles/unicode', filename) shutil.copy(entity, os.path.join(tempdir, filename)) entity = os.path.realpath(os.path.join(tempdir, filename)) now = u(int(time.time())) config = 'tests/samples/configs/good_config.cfg' key = str(uuid.uuid4()) language = 'lang汉语' if self.isPy35OrNewer else 'lang\xe6\xb1\x89\xe8\xaf\xad' project = 'proj汉语' if self.isPy35OrNewer else 'proj\xe6\xb1\x89\xe8\xaf\xad' branch = 'branch汉语' if self.isPy35OrNewer else 'branch\xe6\xb1\x89\xe8\xaf\xad' heartbeat = { 'language': u(language), 'lines': 0, 'entity': os.path.realpath(entity), 'project': u(project), 'branch': u(branch), 'time': float(now), 'type': 'file', 'is_write': False, 'user_agent': ANY, 'dependencies': [], } args = ['--file', entity, '--key', key, '--config', config, '--time', now] with utils.mock.patch('wakatime.stats.standardize_language') as mock_language: mock_language.return_value = (language, None) with utils.mock.patch('wakatime.heartbeat.get_project_info') as mock_project: mock_project.return_value = (project, branch) execute(args) self.assertNothingPrinted() self.assertNothingLogged(logs) self.assertHeartbeatSent(heartbeat) queue = Queue(None, None) saved_heartbeat = queue.pop() self.assertEquals(os.path.realpath(entity), saved_heartbeat['entity']) self.assertEquals(u(language), saved_heartbeat['language']) self.assertEquals(u(project), saved_heartbeat['project']) self.assertEquals(u(branch), saved_heartbeat['branch'])