Add code for error handling for --extract_license.

Handling includes:
 - invalid api_username
 - invalid api_key
 - invalid api_url
 - no internet connection

All the above will skip the LICENSE generation, but it'll not skip the ABOUT generation.

Author: chinyeungli

about_code_tool/genabout.py

@@ -64,12 +64,23 @@ def request_license_data(url, username, api_key, license_key):
         url if url.endswith('/') else url + '/',
         license_key, urllib.urlencode(payload))
 
-    request = urllib2.Request(full_url)
+    #request = urllib2.Request(full_url)
     try:
+        request = urllib2.Request(full_url)
         response = urllib2.urlopen(request)
         response_content = response.read()
         data = json.loads(response_content)
-    except (urllib2.HTTPError, ValueError):
+    except urllib2.HTTPError as http_e:
+        # the code 401 represents authorization problem
+        if http_e.code == 401:
+            return 'authorization denied'
+        else:
+            return {}
+    except urllib2.URLError as url_e:
+        if about.check_network_connection():
+            return 'URL not reachable'
+        return 'No network'
+    except ValueError as value_e:
         return {}
     else:
         return data
@@ -220,6 +231,18 @@ def extract_dje_license(self, project_path, license_list, url, username, key):
             gen_license_path = join(project_path, gen_path, license_key) + '.LICENSE'
             if not _exists(gen_license_path):
                 context = self.get_license_text_from_api(url, username, key, license_key)
+                if context == 'authorization denied':
+                    print("Authorization denied. Invalid '--api_username' or '--api_key'.")
+                    print("LICENSE generation is skipped.")
+                    sys.exit(errno.EINVAL)
+                if context == 'URL not reachable':
+                    print("URL not reachable. Invalid '--api_url'.")
+                    print("LICENSE generation is skipped.")
+                    sys.exit(errno.EINVAL)
+                if context == 'No network':
+                    print("Network problem. Please check the Internet connection.")
+                    print("LICENSE generation is skipped.")
+                    sys.exit(errno.EINVAL)
                 if not context:
                     self.errors.append(Error('dje_license_key', license_key,
                                              "Invalid 'dje_license_key'"))
@@ -238,6 +261,8 @@ def get_license_text_from_api(url, username, api_key, license_key):
         Returns an empty string if the text is not available.
         """
         data = request_license_data(url, username, api_key, license_key)
+        if data == 'authorization denied' or data == 'URL not reachable' or data == 'No network':
+            return data
         license_text = data.get('full_text', '')
         return license_text
 
@@ -455,7 +480,7 @@ def option_usage():
         <--api_url='URL'> - URL to the DJE License Library
         <--api_username='user_api'> - The regular DJE username
         <--api_key='user_api_key'> - Hash attached to your username which is used 
-                                     to Authenticate yourself in the API. Contact
+                                     to authenticate yourself in the API. Contact
                                      us to get the hash key. 
         Example syntax:
             genabout.py --extract_license --api_url='https://enterprise.dejacode.com/api/v1/license_text/' --api_username='<user_api>' --api_key='<user_api_key>'

about_code_tool/tests/test_genabout.py

@@ -80,7 +80,7 @@ def test_pre_generation_about_exists_action_0(self):
         input_list = [[{'about_file': 'about.py.ABOUT', 'version': '0.8.1',
                         'about_resource': '.', 'name': 'ABOUT tool'}]]
         expected_output_list = []
-        output_list = gen.pre_generation(gen_location, input_list, action_num, False)
+        output_list, lic_output_list = gen.pre_generation(gen_location, input_list, action_num, False, False)
         self.assertTrue(expected_output_list == output_list, "This output_list should be empty.")
         self.assertTrue(len(gen.warnings) == 1, "Should return 1 warnings.")
         self.assertFalse(gen.errors, "No errors should be returned.")
@@ -93,7 +93,7 @@ def test_pre_generation_about_exists_action_1(self):
         expected_output_list = [[join(TESTDATA_PATH, 'test_files_for_genabout/about.py.ABOUT'),
                                  {'about_file': 'about.py.ABOUT', 'version': '0.8.2',
                                   'about_resource': '.', 'name': 'ABOUT tool'}]]
-        output_list = gen.pre_generation(GEN_LOCATION, input_list, action_num, False)
+        output_list, lic_output_list = gen.pre_generation(GEN_LOCATION, input_list, action_num, False, False)
         self.assertTrue(expected_output_list == output_list)
         self.assertFalse(gen.warnings, "No warnings should be returned.")
         self.assertFalse(gen.errors, "No errors should be returned.")
@@ -107,7 +107,7 @@ def test_pre_generation_about_exists_action_2(self):
                                   {'test': 'test sample', 'about_file': 'about.py.ABOUT',
                                     'version': '0.8.1', 'about_resource': '.',
                                      'name': 'ABOUT tool'}]]
-        output_list = gen.pre_generation(GEN_LOCATION, input_list, action_num, False)
+        output_list, lic_output_list = gen.pre_generation(GEN_LOCATION, input_list, action_num, False, False)
         self.assertTrue(expected_output_list == output_list)
         self.assertFalse(gen.warnings, "No warnings should be returned.")
         self.assertFalse(gen.errors, "No errors should be returned.")
@@ -120,7 +120,7 @@ def test_pre_generation_about_exists_action_3(self):
         expected_output_list = [[join(TESTDATA_PATH, 'test_files_for_genabout/about.py.ABOUT'),
                                   {'about_file': 'about.py.ABOUT', 'version': '0.8.2',
                                     'about_resource': '.', 'name': '', 'test': 'test sample'}]]
-        output_list = gen.pre_generation(GEN_LOCATION, input_list, action_num, False)
+        output_list, lic_output_list = gen.pre_generation(GEN_LOCATION, input_list, action_num, False, False)
         self.assertTrue(expected_output_list == output_list)
         self.assertFalse(gen.warnings, "No warnings should be returned.")
         self.assertFalse(gen.errors, "No errors should be returned.")
@@ -133,7 +133,7 @@ def test_pre_generation_all_in_one(self):
                          'about_resource': 'elasticsearch-0.19.8.zip',
                          'name': 'ElasticSearch'}]]
         expected_output_list = []
-        output_list = gen.pre_generation(GEN_LOCATION, input_list, action_num, True)
+        output_list, lic_output_list = gen.pre_generation(GEN_LOCATION, input_list, action_num, True, False)
         self.assertFalse(os.path.exists('testdata/test_files_for_genabout/test_generation'),
                           "This directory shouldn't be generaetd as the all_in_one is set to True.")
         self.assertTrue(expected_output_list == output_list, "This output_list should be empty.")
@@ -176,4 +176,4 @@ def test_verify_license_files_not_exist(self):
         output = gen.verify_license_files(input_list, path)
         self.assertTrue(expected_list == output)
         self.assertTrue(len(gen.warnings) == 1, "Should return 1 warning.")
-        self.assertFalse(gen.errors, "No errors should be returned.")
+        self.assertFalse(gen.errors, "No errors should be returned.")

about_code_tool/tests/testdata/test_files_for_genabout/about-mapping-sample.csv

@@ -1,2 +1,2 @@
-Resource,file_name,Component,Confirmed Version
+Directory/Filename,file_name,Component,Confirmed Version
 about.py.ABOUT,about.py,ABOUT tool,0.8.1