#396 - Fixed some tests and code enhancement. Need add tests.

Author: chinyeungli

src/attributecode/gen.py

@@ -217,6 +217,7 @@ def generate(location, base_dir, android=None, reference_dir=None, fetch_license
     base_dir. Return errors and about objects.
     """
     not_exist_errors = []
+    notice_dict = {}
     api_url = ''
     api_key = ''
     gen_license = False
@@ -311,7 +312,22 @@ def generate(location, base_dir, android=None, reference_dir=None, fetch_license
                         if about.license_name.value:
                             about.license_name.present = True
 
-            about.dump(dump_loc, android)
+            about.dump(dump_loc)
+
+            if android:
+                """
+                Create MODULE_LICENSE_XXX and get context to create NOTICE file
+                follow the standard from Android Open Source Project
+                """
+                import os
+                parent_path = os.path.dirname(util.to_posix(dump_loc))
+
+                about.android_module_license(parent_path)
+                notice_path, notice_context = about.android_notice(parent_path)
+                if notice_path in notice_dict.keys():
+                    notice_dict[notice_path] += '\n\n' + notice_context
+                else:
+                    notice_dict[notice_path] = notice_context
 
             for e in not_exist_errors:
                 errors.append(Error(INFO, e))
@@ -324,4 +340,14 @@ def generate(location, base_dir, android=None, reference_dir=None, fetch_license
                    u'%(dump_loc)s '
                    u'with error: %(emsg)s' % locals())
             errors.append(Error(ERROR, msg))
+
+    if android:
+        # Check if there is already a NOTICE file present
+        for path in notice_dict.keys():
+            if os.path.exists(path):
+                msg = (u'NOTICE file already exist at: %s' % path)
+                errors.append(Error(ERROR, msg))
+            else:
+                about.dump_android_notice(path, notice_dict[path])
+
     return unique(errors), abouts

src/attributecode/model.py

@@ -1066,7 +1066,7 @@ def dumps(self):
 
         return saneyaml.dump(data)
 
-    def dump(self, location, android):
+    def dump(self, location):
         """
         Write formatted ABOUT representation of self to location.
         """
@@ -1087,37 +1087,54 @@ def dump(self, location, android):
         if on_windows:
             about_file_path = add_unc(about_file_path)
 
-        if android:
-            for lic_key in self.license_key.value:
+        with io.open(about_file_path, mode='w', encoding='utf-8') as dumped:
+            dumped.write(genereated_tk_version)
+            dumped.write(self.dumps())
+
+    def dump_android_notice(self, path, context):
+        """
+        Write the NOITCE file consist of copyright, notice and license
+        """
+        if on_windows:
+            path = add_unc(path)
+
+        with io.open(path, mode='w', encoding='utf-8') as dumped:
+            dumped.write(context)
+
+    def android_module_license(self, about_parent_path):
+        """
+        Create MODULE_LICENSE_XXX which the XXX is the value of license key.
+        """
+        for lic_key in self.license_key.value:
                 # Make uppercase and with dash and spaces and dots replaced by underscore
                 # just to look similar and consistent.
                 name = 'MODULE_LICENSE_' + lic_key.replace('.', '_').replace('-', '_').replace(' ', '_').upper()
-                module_lic_path = os.path.join(os.path.dirname(about_file_path), name)
+                module_lic_path = os.path.join(about_parent_path, name)
                 # Create an empty MODULE_LICESE_XXX file
                 open(module_lic_path, 'a').close()
 
-            # Create NOTICE file with the combination context of copyright,
-            # notice_file and license_file
-            notice_path = os.path.join(os.path.dirname(about_file_path), 'NOTICE')
-            notice_context = ''
-            if self.copyright.value:
-                notice_context += self.copyright.value
-            if self.notice_file.value:
-                notice_file_dict = self.notice_file.value
-                notice_file_key = notice_file_dict.keys()
-                for key in notice_file_key:
-                    notice_context += '\n\n' + notice_file_dict[key]
-            if self.license_file.value:
-                lic_file_dict = self.license_file.value
-                lic_file_key = lic_file_dict.keys()
-                for key in lic_file_key:
-                    notice_context += '\n\n' + lic_file_dict[key]
-            with io.open(notice_path, mode='w', encoding='utf-8') as dumped:
-                dumped.write(notice_context)
-
-        with io.open(about_file_path, mode='w', encoding='utf-8') as dumped:
-            dumped.write(genereated_tk_version)
-            dumped.write(self.dumps())
+    def android_notice(self, about_parent_path):
+        """
+        Return a notice dictionary which the path of the notice file going
+        to create will be the key and its context will be the value of the dict.
+        """
+        # Create NOTICE file with the combination context of copyright,
+        # notice_file and license_file
+        notice_path = posixpath.join(about_parent_path, 'NOTICE')
+        notice_context = ''
+        if self.copyright.value:
+            notice_context += self.copyright.value
+        if self.notice_file.value:
+            notice_file_dict = self.notice_file.value
+            notice_file_key = notice_file_dict.keys()
+            for key in notice_file_key:
+                notice_context += '\n' + notice_file_dict[key] + '\n'
+        if self.license_file.value:
+            lic_file_dict = self.license_file.value
+            lic_file_key = lic_file_dict.keys()
+            for key in lic_file_key:
+                notice_context += '\n\n' + lic_file_dict[key] + '\n\n'
+        return notice_path, notice_context
 
     def dump_lic(self, location, license_dict):
         """

tests/test_model.py

@@ -582,7 +582,7 @@ def test_About_rejects_non_ascii_names_and_accepts_unicode_values(self):
         test_file = get_test_loc('test_model/parse/non_ascii_field_name_value.about')
         a = model.About(test_file)
         expected = [
-            Error(CRITICAL, "Field name: 'mat\xedas' contains illegal name characters: 0 to 9, a to z, A to Z and _.")
+            Error(CRITICAL, "Field name: 'mat\xedas' contains illegal name characters: 0 to 9, a to z, A to Z and _. (or empty spaces)")
         ]
         assert expected == a.errors
 

tests/testdata/test_cmd/help/about_gen_help.txt

@@ -8,6 +8,9 @@ Usage: about gen [OPTIONS] LOCATION OUTPUT
   OUTPUT: Path to a directory where ABOUT files are generated.
 
 Options:
+  --android                Generate MODULE_LICENSE_XXX (XXX will be replaced by
+                           license key) and NOTICE as the same design as from
+                           Android.
   --fetch-license URL KEY  Fetch license data and text files from a DejaCode
                            License Library API URL using the API KEY.
   --reference DIR          Path to a directory with reference license data and