Merge pull request #480 from Webperf-se/url-unavailable

Change so tests return -1 in rating if Tests are unable to connect

Author: 7h3Rabbit

helpers/sitespeed_helper.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 import json
+import os
 import urllib
 import urllib.parse
 
@@ -37,6 +38,9 @@ def get_data_from_sitespeed(filename, org_domain):
     if filename == '':
         return result
 
+    if not os.path.exists(filename):
+        return result
+
     # Fix for content having unallowed chars
     with open(filename, encoding='utf-8') as json_input_file:
         har_data = json.load(json_input_file)

locales/en/LC_MESSAGES/webperf-core.mo

@@ -21,56 +21,48 @@ msgstr "website with url: {0} has been added\n"
 msgid "TEXT_WEBSITE_URL_DELETED"
 msgstr "website with url: {0} has been deleted\n"
 
-#: default.py:24
 msgid "TEXT_TEST_START_HEADER"
 msgstr "###############################################"
 
-#: default.py:28
 msgid "TEXT_TESTING_NUMBER_OF_SITES"
 msgstr "Number of websites being tested {0}"
 
-#: default.py:33
 msgid "TEXT_TESTING_SITE"
 msgstr "# Testing website {0}\n"
 
 msgid "TEXT_WEBSITE_X_OF_Y"
 msgstr "Website {0} of {1}.\n"
 
-#: default.py:61
 msgid "TEXT_SITE_RATING"
 msgstr "### Rating:"
 
-#: default.py:63
 msgid "TEXT_SITE_REVIEW"
 msgstr "### Review:\n"
 
-#: default.py:81
 msgid "TEXT_EXCEPTION"
 msgstr "Exception, someone should look at this!"
 
+msgid "TEXT_SITE_UNAVAILABLE"
+msgstr "Error, was unable to load the page you requested."
+
 msgid "TEXT_TEST_START"
 msgstr "Started: {0}"
 
 msgid "TEXT_TEST_END"
 msgstr "Finished: {0}\n"
 
-#: default.py:127
 msgid "TEXT_TEST_VALID_ARGUMENTS"
 msgstr "Valid arguments for option -t/--test:"
 
-#: default.py:128
 msgid "TEXT_TEST_VALID_ARGUMENTS_GOOGLE_LIGHTHOUSE"
 msgstr "-t 1\t: Performance (Google Lighthouse)"
 
-#: default.py:129
 msgid "TEXT_TEST_VALID_ARGUMENTS_GOOGLE_LIGHTHOUSE_SEO"
 msgstr "-t 4\t: SEO (Google Lighthouse)"
 
-#: default.py:130
 msgid "TEXT_TEST_VALID_ARGUMENTS_GOOGLE_LIGHTHOUSE_A11Y"
 msgstr "-t 10\t: Accessibility (Google Lighthouse)"
 
-#: default.py:132
 msgid "TEXT_TEST_VALID_ARGUMENTS_GOOGLE_LIGHTHOUSE_BEST_PRACTICE"
 msgstr "-t 5\t: Best Practice (Google Lighthouse)"
 
@@ -80,26 +72,21 @@ msgstr "-t 17\t: Quality on frontend (Yellow Lab Tools)"
 msgid "TEXT_TEST_VALID_ARGUMENTS_PA11Y"
 msgstr "-t 18\t: Accessibility (Pa11y)"
 
-#: default.py:133
 msgid "TEXT_TEST_VALID_ARGUMENTS_PAGE_NOT_FOUND"
 msgstr "-t 2\t: 404 (Page not Found)"
 
-#: default.py:134
 msgid "TEXT_TEST_VALID_ARGUMENTS_HTML"
 msgstr "-t 6\t: HTML Validation"
 
-#: default.py:135
 msgid "TEXT_TEST_VALID_ARGUMENTS_CSS"
 msgstr "-t 7\t: CSS Validation"
 
 msgid "TEXT_TEST_VALID_ARGUMENTS_SITESPEED"
 msgstr "-t 15\t: Performance (Sitespeed.io)"
 
-#: default.py:136
 msgid "TEXT_TEST_VALID_ARGUMENTS_WEBBKOLL"
 msgstr "-t 20\t: Integrity & Security (Webbkoll)"
 
-#: default.py:137
 msgid "TEXT_TEST_VALID_ARGUMENTS_STANDARD_FILES"
 msgstr "-t 9\t: Standard files"
 
@@ -121,7 +108,6 @@ msgstr "-t 25\t: Software (Alpha)"
 msgid "TEXT_TEST_VALID_ARGUMENTS_A11Y_STATEMENT"
 msgstr "-t 26\t: Accessibility Statement (Alfa)"
 
-#: default.py:137 default.py:141 default.py:146 default.py:213
 msgid "TEXT_COMMAND_USAGE"
 msgstr "\n\tWebPerf Core\n\n\tUsage:\ndefault.py -u https://webperf.se\n\n\tOptions and arguments:\n\t-h/--help\t\t\t: Help information on how to use script\n\t-u/--url <site url>\t\t: website url to test against\n\t-t/--test <test number>\t\t: run ONE test (use ? to list available tests)\n\t-r/--review\t\t\t: show reviews in terminal\n\t-i/--input <file path>\t\t: input file path (.json/.sqlite/.sitemap/<category name>.webprf)\n\t-i/--input-skip <number>\t: number of items to skip\n\t-i/--input-take <number>\t: number of items to take\n\t-o/--output <file path>\t\t: output file path (.json/.csv/.sql/.sqlite/.md)\n\t-A/--addUrl <site url>\t\t: website url (required in compination with -i/--input)\n\t-D/--deleteUrl <site url>\t: website url (required in compination with -i/--input)\n\t-L/--language <lang code>\t: language used for output(en = default/sv)"
 

locales/en/LC_MESSAGES/webperf-core.po

@@ -48,6 +48,9 @@ msgstr "### Review:\n"
 msgid "TEXT_EXCEPTION"
 msgstr "Exception, someone should look at this!"
 
+msgid "TEXT_SITE_UNAVAILABLE"
+msgstr "Error, was unable to load the page you requested."
+
 msgid "TEXT_TEST_START"
 msgstr "Started: {0}"
 

locales/gov/LC_MESSAGES/webperf-core.mo

@@ -42,6 +42,9 @@ msgstr "### Omdöme:\n"
 msgid "TEXT_EXCEPTION"
 msgstr "Fel, någon behöver ta en titt på detta."
 
+msgid "TEXT_SITE_UNAVAILABLE"
+msgstr "Fel, det gick inte att läsa in den begärda sidan."
+
 msgid "TEXT_TEST_START"
 msgstr "Startad: {0}"
 

locales/gov/LC_MESSAGES/webperf-core.po

@@ -34,6 +34,12 @@ def run_test(global_translation, lang_code, url):
 
     use_axe = False
     json_result = get_pa11y_errors(url, use_axe)
+    # If we fail to connect to website the result_dict will be None and we should end test
+    if json_result is None:
+        error_rating = Rating(global_translation, REVIEW_SHOW_IMPROVEMENTS_ONLY)
+        error_rating.overall_review = global_translation('TEXT_SITE_UNAVAILABLE')
+        return (error_rating, {'failed': True })
+
     num_errors = len(json_result)
     if num_errors == 0:
         use_axe = True
@@ -42,16 +48,10 @@ def run_test(global_translation, lang_code, url):
 
     num_errors = len(json_result)
 
-    unique_errors = set()
     return_dict = json_result
     errors = json_result
 
-    for error in errors:
-        if 'message' in error:
-            err_mess = error['message'].replace('This', 'A')
-            error_review = f'- {err_mess}\n'
-            unique_errors.add(error_review)
-
+    unique_errors = get_unique_errors(errors)
     num_unique_errors = len(unique_errors)
 
     rating = rate_errors(global_translation,
@@ -62,6 +62,21 @@ def run_test(global_translation, lang_code, url):
 
     return (rating, return_dict)
 
+def get_unique_errors(errors):
+    """
+    Gets unique errors from a list of many errors
+
+    Parameters:
+    errors (list): The list of errors.
+    """
+    unique_errors = set()
+    for error in errors:
+        if 'message' in error:
+            err_mess = error['message'].replace('This', 'A')
+            error_review = f'- {err_mess}\n'
+            unique_errors.add(error_review)
+    return unique_errors
+
 def rate_errors(
         global_translation,
         local_translation,
@@ -183,5 +198,9 @@ def get_pa11y_errors(url, use_axe):
                    f"--ignore color-contrast --reporter json {additional_args}{url}")
     with subprocess.Popen(command.split(), stdout=subprocess.PIPE) as process:
         output, _ = process.communicate(timeout=REQUEST_TIMEOUT * 10)
+
+        # If we fail to connect to website the result_dict should be None and we should end test
+        if output is None or len(output) == 0:
+            return None
         json_result = json.loads(output)
         return json_result

locales/sv/LC_MESSAGES/webperf-core.mo

@@ -60,11 +60,46 @@ def run_test(global_translation, lang_code, url):
         info = {'called_url': url}
         rating += rate_statement(info, global_translation, local_translation)
 
+    if not rating.isused():
+        rating += get_rating_not_set_rating(url, return_dict, local_translation, global_translation)
+
     print(global_translation('TEXT_TEST_END').format(
         datetime.now().strftime('%Y-%m-%d %H:%M:%S')))
 
     return (rating, return_dict)
 
+def get_rating_not_set_rating(url, return_dict, local_translation, global_translation):
+    """
+    This function checks the availability of a URL and sets the rating based on its availability.
+    
+    Args:
+        url (str): The URL to be checked.
+        return_dict (dict): A dictionary to store the failure status if the URL is not available.
+        local_translation (function): A function to translate text to local language.
+        global_translation (function): A function to translate text to global language.
+
+    Returns:
+        Rating: An instance of the Rating class with the
+                overall review set based on the URL's availability.
+    """
+    rating = Rating(global_translation, REVIEW_SHOW_IMPROVEMENTS_ONLY)
+    url_is_available = False
+    for _, url_content in checked_urls.items():
+        if url_content != '' and url_content is not None:
+            url_is_available = True
+            break
+
+    if not url_is_available:
+        rating.overall_review = global_translation('TEXT_SITE_UNAVAILABLE')
+        return_dict['failed'] = True
+        return rating
+
+    rating.set_overall(1.0, local_translation(
+        'TEXT_REVIEW_NO_ACCESSIBILITY_STATEMENT'))
+    rating.overall_review = local_translation('TEXT_REVIEW_CALLED_URL').format(
+        url, rating.overall_review)
+    return rating
+
 
 def get_digg_report_canonical():
     """

locales/sv/LC_MESSAGES/webperf-core.po

@@ -30,6 +30,17 @@ def run_test(global_translation, lang_code, url):
     print(global_translation('TEXT_TEST_START').format(
         datetime.now().strftime('%Y-%m-%d %H:%M:%S')))
 
+    rating = Rating(global_translation, REVIEW_SHOW_IMPROVEMENTS_ONLY)
+    data = get_data_for_url(url)
+    if data is None:
+        rating.overall_review = global_translation('TEXT_SITE_UNAVAILABLE')
+        return (rating, {'failed': True })
+
+
+    # 2. FIND ALL INLE CSS (AND CALCULTE)
+    # 2.1 FINS ALL <STYLE>
+    all_link_resources = []
+
     result_dict = {
         'has_style_elements': False,
         'has_style_attributes': False,
@@ -42,14 +53,6 @@ def run_test(global_translation, lang_code, url):
         }
     }
 
-    # We don't need extra iterations for what we are using it for
-    data = get_data_for_url(url)
-    # 2. FIND ALL INLE CSS (AND CALCULTE)
-    # 2.1 FINS ALL <STYLE>
-    all_link_resources = []
-
-    rating = Rating(global_translation, REVIEW_SHOW_IMPROVEMENTS_ONLY)
-
     for html_entry in data['htmls']:
         tmp_all_link_resources, tmp_rating = handle_html_markup_entry(
             html_entry,