fixup let's roll with wrap_read_cache() for now

Author: zstyblik

gh2slack.py

@@ -22,7 +22,6 @@
 from lib import cli_args
 from lib import config_options
 from lib import utils
-from lib.exceptions import CacheReadError
 from lib.exceptions import SlackTokenError
 
 ALIASES = {
@@ -164,21 +163,23 @@ def main():
     logger = logging.getLogger("gh2slack")
     logger.setLevel(args.log_level)
 
-    cache = None
     retcode = 0
+    cache = rss2irc.wrap_read_cache(logger, args.cache_file)
+    if cache is None:
+        retcode = utils.mask_retcode(1, args.mask_errors)
+        sys.exit(retcode)
+
     try:
         slack_token = rss2slack.get_slack_token()
         url = get_gh_api_url(args.gh_owner, args.gh_repo, args.gh_section)
         pages = gh_request(logger, url)
-
         logger.debug("Got %i pages from GH.", len(pages))
         if not pages:
             logger.info(
                 "No %s for %s/%s.", args.gh_section, args.gh_owner, args.gh_repo
             )
             sys.exit(0)
 
-        cache = rss2irc.read_cache(logger, args.cache_file)
         scrub_items(logger, cache)
         # NOTE(zstyblik): I have failed to find web link to repo in GH response.
         # Therefore, let's create one.
@@ -211,15 +212,6 @@ def main():
         logger.exception("Environment variable SLACK_TOKEN must be set.")
         retcode = utils.mask_retcode(1, args.mask_errors)
         sys.exit(retcode)
-    except CacheReadError:
-        logger.exception(
-            "Error while reading cache file '%s'.",
-            args.cache_file,
-        )
-        retcode = utils.mask_retcode(1, args.mask_errors)
-        # NOTE(zstyblik): since cache file couldn't be opened, it doesn't make
-        # sense writing it. Therefore, call sys.exit().
-        sys.exit(retcode)
     except Exception:
         logger.exception("Unexpected exception has occurred.")
         retcode = 1

phpbb2slack.py

@@ -18,7 +18,6 @@
 from lib import cli_args
 from lib import config_options
 from lib import utils
-from lib.exceptions import CacheReadError
 from lib.exceptions import EmptyResponseError
 from lib.exceptions import NoNewsError
 from lib.exceptions import NotModifiedError
@@ -81,13 +80,16 @@ def main():
     logger = logging.getLogger("phpbb2slack")
     logger.setLevel(args.log_level)
 
-    cache = None
     retcode = 0
+    cache = rss2irc.wrap_read_cache(logger, args.cache_file)
+    if cache is None:
+        retcode = utils.mask_retcode(1, args.mask_errors)
+        sys.exit(retcode)
+
+    source = cache.get_source_by_url(args.rss_url)
     try:
         slack_token = rss2slack.get_slack_token()
         authors = get_authors_from_file(logger, args.authors_file)
-        cache = rss2irc.read_cache(logger, args.cache_file)
-        source = cache.get_source_by_url(args.rss_url)
 
         rsp = rss2irc.get_rss(
             logger,
@@ -124,15 +126,6 @@ def main():
         logger.exception("Environment variable SLACK_TOKEN must be set.")
         retcode = utils.mask_retcode(1, args.mask_errors)
         sys.exit(retcode)
-    except CacheReadError:
-        logger.exception(
-            "Error while reading cache file '%s'.",
-            args.cache_file,
-        )
-        retcode = utils.mask_retcode(1, args.mask_errors)
-        # NOTE(zstyblik): since cache file couldn't be opened, it doesn't make
-        # sense writing it. Therefore, call sys.exit().
-        sys.exit(retcode)
     except NotModifiedError:
         logger.debug("No new RSS data since the last run.")
         rss2irc.update_items_expiration(
@@ -155,10 +148,7 @@ def main():
         retcode = 0
     except Exception:
         logger.exception("Unexpected exception has occurred.")
-        if cache:
-            source = cache.get_source_by_url(args.rss_url)
-            source.http_error_count += 1
-
+        source.http_error_count += 1
         retcode = 1
 
     write_retcode = rss2irc.wrap_write_cache(logger, cache, args.cache_file)

rss2irc.py

@@ -94,12 +94,14 @@ def main():
         logger.error("Ouput '%s' doesn't exist.", args.output)
         sys.exit(1)
 
-    cache = None
     retcode = 0
-    try:
-        cache = read_cache(logger, args.cache_file)
-        source = cache.get_source_by_url(args.rss_url)
+    cache = wrap_read_cache(logger, args.cache_file)
+    if cache is None:
+        retcode = utils.mask_retcode(1, args.mask_errors)
+        sys.exit(retcode)
 
+    source = cache.get_source_by_url(args.rss_url)
+    try:
         rsp = get_rss(
             logger,
             args.rss_url,
@@ -122,15 +124,6 @@ def main():
         cache.scrub_data_sources()
         source.http_error_count = 0
         retcode = 0
-    except CacheReadError:
-        logger.exception(
-            "Error while reading cache file '%s'.",
-            args.cache_file,
-        )
-        retcode = utils.mask_retcode(1, args.mask_errors)
-        # NOTE(zstyblik): since cache file couldn't be opened, it doesn't make
-        # sense writing it. Therefore, call sys.exit().
-        sys.exit(retcode)
     except NotModifiedError:
         logger.debug("No new RSS data since the last run.")
         update_items_expiration(cache, cache.items, args.cache_expiration)
@@ -149,10 +142,7 @@ def main():
         retcode = 0
     except Exception:
         logger.exception("Unexpected exception has occurred.")
-        if cache:
-            source = cache.get_source_by_url(args.rss_url)
-            source.http_error_count += 1
-
+        source.http_error_count += 1
         retcode = 1
 
     write_retcode = wrap_write_cache(logger, cache, args.cache_file)
@@ -271,6 +261,18 @@ def update_items_expiration(
         cache.items[key] = item_expiration
 
 
+def wrap_read_cache(logger: logging.Logger, cache_file: str):
+    """Call read_cache() and return cached data or log error and return None."""
+    cache = None
+    try:
+        cache = read_cache(logger, cache_file)
+    except CacheReadError:
+        logger.exception("Error while reading cache file '%s'.", cache_file)
+        cache = None
+
+    return cache
+
+
 def wrap_write_cache(
     logger: logging.Logger,
     cache: CachedData,

rss2slack.py

@@ -18,7 +18,6 @@
 import rss2irc
 from lib import cli_args
 from lib import utils
-from lib.exceptions import CacheReadError
 from lib.exceptions import EmptyResponseError
 from lib.exceptions import NoNewsError
 from lib.exceptions import NotModifiedError
@@ -78,12 +77,15 @@ def main():
     logger = logging.getLogger("rss2slack")
     logger.setLevel(args.log_level)
 
-    cache = None
     retcode = 0
+    cache = rss2irc.wrap_read_cache(logger, args.cache_file)
+    if cache is None:
+        retcode = utils.mask_retcode(1, args.mask_errors)
+        sys.exit(retcode)
+
+    source = cache.get_source_by_url(args.rss_url)
     try:
         slack_token = get_slack_token()
-        cache = rss2irc.read_cache(logger, args.cache_file)
-        source = cache.get_source_by_url(args.rss_url)
 
         rsp = rss2irc.get_rss(
             logger,
@@ -122,15 +124,6 @@ def main():
         logger.exception("Environment variable SLACK_TOKEN must be set.")
         retcode = utils.mask_retcode(1, args.mask_errors)
         sys.exit(retcode)
-    except CacheReadError:
-        logger.exception(
-            "Error while reading cache file '%s'.",
-            args.cache_file,
-        )
-        retcode = utils.mask_retcode(1, args.mask_errors)
-        # NOTE(zstyblik): since cache file couldn't be opened, it doesn't make
-        # sense writing it. Therefore, call sys.exit().
-        sys.exit(retcode)
     except NotModifiedError:
         logger.debug("No new RSS data since the last run.")
         rss2irc.update_items_expiration(
@@ -153,10 +146,7 @@ def main():
         retcode = 0
     except Exception:
         logger.exception("Unexpected exception has occurred.")
-        if cache:
-            source = cache.get_source_by_url(args.rss_url)
-            source.http_error_count += 1
-
+        source.http_error_count += 1
         retcode = 1
 
     write_retcode = rss2irc.wrap_write_cache(logger, cache, args.cache_file)

tests/test_rss2slack.py

@@ -246,7 +246,9 @@ def test_main_ideal(
     ],
 )
 @patch("rss2slack.rss2irc.wrap_write_cache")
+@patch("rss2slack.rss2irc.read_cache")
 def test_main_slack_token_error(
+    mock_read_cache,
     mock_wrap_write_cache,
     extra_args,
     expected_retcode,
@@ -267,6 +269,8 @@ def test_main_slack_token_error(
     expected_slack_channel = "test"
     fixture_cache_file = "/path/not/exist/cache.file"
 
+    mock_read_cache.return_value = CachedData()
+
     exception = None
     args = [
         "./rss2slack.py",