Working mock using patch

howdoi/howdoi.py

@@ -591,8 +591,8 @@ def howdoi(raw_query):
     else:
         args = raw_query
 
-    os.environ['HOWDOI_SEARCH_ENGINE'] = args['search_engine'] or os.getenv('HOWDOI_SEARCH_ENGINE') or 'google'
-    search_engine = os.getenv('HOWDOI_SEARCH_ENGINE')
+    search_engine = args['search_engine'] or os.getenv('HOWDOI_SEARCH_ENGINE') or 'google'
+    os.environ['HOWDOI_SEARCH_ENGINE'] = search_engine
     if search_engine not in SUPPORTED_SEARCH_ENGINES:
         supported_search_engines = ', '.join(SUPPORTED_SEARCH_ENGINES)
         message = f'Unsupported engine {search_engine}. The supported engines are: {supported_search_engines}'
@@ -622,9 +622,9 @@ def howdoi(raw_query):
             res = {'error': message}
         cache.set(cache_key, res)
     except (RequestsConnectionError, SSLError):
-        res = {'error': f'Unable to reach {args["search_engine"]}. Do you need to use a proxy?\n'}
+        res = {'error': f'Unable to reach {search_engine}. Do you need to use a proxy?\n'}
     except BlockError:
-        BLOCKED_ENGINES.append(args['search_engine'])
+        BLOCKED_ENGINES.append(search_engine)
         next_engine = next((engine for engine in SUPPORTED_SEARCH_ENGINES if engine not in BLOCKED_ENGINES), None)
         if next_engine is None:
             res = {'error': 'Unable to get a response from any search engine\n'}

test_howdoi.py

@@ -6,7 +6,12 @@ import json
 import os
 import re
 import unittest
+
+import requests
+
 from pathlib import Path
+from unittest.mock import patch
+
 from cachelib import NullCache
 from pyquery import PyQuery as pq
 
@@ -15,46 +20,33 @@ from howdoi import howdoi
 
 
 # pylint: disable=protected-access
-class HowdoiTestCase(unittest.TestCase):  # pylint: disable=too-many-public-methods
-    def _get_result_mock(self, url):
-        file_name = howdoi._format_url_to_filename(url, 'html.gz')
-        # pylint: disable=no-member
-        file_path = Path.joinpath(Path(howdoi.HTML_CACHE_PATH), Path(file_name)).resolve()
-        try:
-            with gzip.open(file_path, 'rb') as f:
-                cached_page_content = str(f.read(), encoding='utf-8')
-                return cached_page_content
-
-        except FileNotFoundError:
-            page_content = self.original_get_result(url)
-            with gzip.open(file_path, 'wb') as f:
-                f.write(bytes(page_content, encoding='utf-8'))
-                return page_content
+original_get_result = howdoi._get_result
 
-    def _negative_number_query(self):
-        query = self.queries[0]
-        howdoi.howdoi(query + ' -n -1')
 
-    def _high_positive_number_query(self):
-        query = self.queries[0]
-        howdoi.howdoi(query + ' -n 21')
+def _get_result_mock(url):
+    # pylint: disable=protected-access
+    file_name = howdoi._format_url_to_filename(url, 'html.gz')
+    # pylint: disable=no-member
+    file_path = Path.joinpath(Path(howdoi.HTML_CACHE_PATH), Path(file_name)).resolve()
+    try:
+        with gzip.open(file_path, 'rb') as f:
+            cached_page_content = str(f.read(), encoding='utf-8')
+            return cached_page_content
 
-    def _negative_position_query(self):
-        query = self.queries[0]
-        howdoi.howdoi(query + ' -p -2')
+    except FileNotFoundError:
+        page_content = original_get_result(url)
+        with gzip.open(file_path, 'wb') as f:
+            f.write(bytes(page_content, encoding='utf-8'))
+            return page_content
 
-    def _high_positive_position_query(self):
-        query = self.queries[0]
-        howdoi.howdoi(query + ' -p 40')
 
-    @classmethod
-    def _get_links_blockerror(cls, query):
-        raise howdoi.BlockError
+# pylint: disable=protected-access
+class HowdoiTestCase(unittest.TestCase):  # pylint: disable=too-many-public-methods
 
     def setUp(self):
-        self.original_get_result = howdoi._get_result
-        howdoi._get_result = self._get_result_mock
-
+        self.patcher_get_result = patch.object(howdoi, '_get_result')
+        self.mock_get_result = self.patcher_get_result.start()
+        self.mock_get_result.side_effect = _get_result_mock
         # ensure no cache is used during testing.
         howdoi.cache = NullCache()
 
@@ -71,14 +63,32 @@ class HowdoiTestCase(unittest.TestCase):  # pylint: disable=too-many-public-meth
                             'mel']
         self.query_without_code_or_pre_block = 'Difference between element node and Text Node'
 
-    def assertValidResponse(self, res):  # pylint: disable=invalid-name
-        self.assertTrue(len(res) > 0)
-
     def tearDown(self):
-        keys_to_remove = ['HOWDOI_URL', 'HOWDO_SEARCH_ENGINE']
+        self.patcher_get_result.stop()
+        keys_to_remove = ['HOWDOI_URL', 'HOWDOI_SEARCH_ENGINE']
         for key in keys_to_remove:
             if key in os.environ:
                 del os.environ[key]
+        howdoi.BLOCKED_ENGINES = []
+
+    def _negative_number_query(self):
+        query = self.queries[0]
+        howdoi.howdoi(query + ' -n -1')
+
+    def _high_positive_number_query(self):
+        query = self.queries[0]
+        howdoi.howdoi(query + ' -n 21')
+
+    def _negative_position_query(self):
+        query = self.queries[0]
+        howdoi.howdoi(query + ' -p -2')
+
+    def _high_positive_position_query(self):
+        query = self.queries[0]
+        howdoi.howdoi(query + ' -p 40')
+
+    def assertValidResponse(self, res):  # pylint: disable=invalid-name
+        self.assertTrue(len(res) > 0)
 
     def test_get_link_at_pos(self):
         self.assertEqual(howdoi.get_link_at_pos(['/questions/42/'], 1),
@@ -92,6 +102,13 @@ class HowdoiTestCase(unittest.TestCase):  # pylint: disable=too-many-public-meth
         self.assertEqual(howdoi.get_link_at_pos(['/questions/42/', '/questions/142/'], 1),
                          '/questions/42/')
 
+    @patch.object(howdoi, '_get_result')
+    def test_blockerror(self, mock_get_links):
+        mock_get_links.side_effect = requests.HTTPError
+        query = self.queries[0]
+        response = howdoi.howdoi(query)
+        self.assertEqual(response, "ERROR: \x1b[91mUnable to get a response from any search engine\n\x1b[0m")
+
     def test_answers(self):
         for query in self.queries:
             self.assertValidResponse(howdoi.howdoi(query))
@@ -283,12 +300,6 @@ class HowdoiTestCase(unittest.TestCase):  # pylint: disable=too-many-public-meth
         with self.assertRaises(SystemExit):
             self._high_positive_number_query()
 
-    def test_sample(self):
-        query = self.queries[0]
-        howdoi._get_links = self._get_links_blockerror
-        response = howdoi.howdoi(query)
-        self.assertEqual(response, "ERROR: \x1b[91mUnable to get a response from any search engine\n\x1b[0m")
-
 
 class HowdoiTestCaseEnvProxies(unittest.TestCase):