Fixed #166 Filter for the inventory output

 * Add the `--filter` option for the `inventory`

Signed-off-by: Chin Yeung Li <[email protected]>

Author: chinyeungli

USAGE.rst

@@ -262,6 +262,7 @@ inventory
 
 ::
 
+    --filter TEXT               Filter for the output inventory.
     -f, --format [json|csv]     Set OUTPUT file format.  [default: csv]
     --mapping                   Use file mapping.config to collect the defined not supported fields in ABOUT files.
     --mapping-file              Use a custom mapping file with mapping between input
@@ -279,6 +280,14 @@ Options
 
 ::
 
+    -filter TEXT
+ 
+        Filter for the output inventory.
+
+    $ about inventory --filter "license_expression=gpl-2.0" LOCATION OUTPUT
+
+    The above command will only inventory the ABOUT files which have the "license_expression: gpl-2.0"
+
     -f, --format [json|csv]
  
         Set OUTPUT file format.  [default: csv]

docs/CHANGELOG.rst

@@ -2,11 +2,12 @@
 
     Release 3.1.2
 
-    * New `--vartext` option
+    * New `--vartext` option for `attrib`
     * Add support for `checksum_sha256`
     * `check` command will not counted INFO message as error when `--verbose` is set
     * Update `track_change` to `track_changes`
-    * Support `author_file`
+    * Add support for `author_file`
+    * New `--filter` option for `inventory`
 
 2018-6-25
 

src/attributecode/cmd.py

@@ -37,6 +37,7 @@
 from attributecode.util import extract_zip
 from attributecode.util import update_severity_level_about_resource_path_not_exist_error
 from attributecode.util import to_posix
+from attributecode.util import inventory_filter
 
 
 __copyright__ = """
@@ -108,6 +109,9 @@ def cli():
 @click.argument('output', nargs=1, required=True,
     type=click.Path(exists=False, dir_okay=False, resolve_path=True))
 
+@click.option('--filter', nargs=1, multiple=True, 
+    help='Filter for the output inventory.')
+
 @click.option('-f', '--format', is_flag=False, default='csv', show_default=True,
     type=click.Choice(['json', 'csv']),
     help='Set OUTPUT inventory file format.')
@@ -132,7 +136,7 @@ def cli():
 
 @click.help_option('-h', '--help')
 
-def inventory(location, output, mapping, mapping_file, quiet, format, verbose):
+def inventory(location, output, mapping, mapping_file, filter, quiet, format, verbose):
     """
 Collect a JSON or CSV inventory of components from .ABOUT files.
 
@@ -157,6 +161,22 @@ def inventory(location, output, mapping, mapping_file, quiet, format, verbose):
 
     errors, abouts = model.collect_inventory(location, use_mapping=mapping, mapping_file=mapping_file)
 
+    updated_abouts = []
+    if filter:
+        filter_dict = {}
+        # Parse the filter and save to the filter dictionary with a list of value
+        for element in filter:
+            key = element.partition('=')[0]
+            value = element.partition('=')[2]
+            if key in filter_dict:
+                filter_dict[key].append(value)
+            else:
+                value_list = [value]
+                filter_dict[key] = value_list
+        updated_abouts = inventory_filter(abouts, filter_dict)
+    else:
+        updated_abouts = abouts
+
     # Do not write the output if one of the ABOUT files has duplicated key names
     dup_error_msg = u'Duplicated key name(s)'
     halt_output = False
@@ -166,7 +186,7 @@ def inventory(location, output, mapping, mapping_file, quiet, format, verbose):
             break
 
     if not halt_output:
-        write_errors = model.write_output(abouts, output, format)
+        write_errors = model.write_output(updated_abouts, output, format)
         for err in write_errors:
             errors.append(err)
     else:

src/attributecode/util.py

@@ -560,4 +560,21 @@ def update_severity_level_about_resource_path_not_exist_error(errors):
             #continue
         else:
             updated_errors.append(err)
-    return updated_errors
+    return updated_errors
+
+
+def inventory_filter(abouts, filter_dict):
+    updated_abouts = []
+    for key in filter_dict:
+        for about in abouts:
+            try:
+                # Check if the about object has the filtered attribute and if the
+                # attributed value is the same as the defined in the filter
+                for value in filter_dict[key]:
+                    if vars(about)[key].value == value:
+                        if not about in updated_abouts:
+                            updated_abouts.append(about)
+            except:
+                # The current about object does not have the defined attribute
+                continue
+    return updated_abouts

tests/test_util.py

@@ -31,6 +31,7 @@
 from attributecode import CRITICAL
 from attributecode import ERROR, INFO
 from attributecode import Error
+from attributecode import model
 from attributecode import util
 
 
@@ -471,3 +472,13 @@ def test_check_duplicate_keys_about_file_with_multiline(self):
         expected = ['owner', 'notes']
         assert expected == util.check_duplicate_keys_about_file(test)
 
+    def test_inventory_filter(self):
+        test_loc = get_test_loc('basic')
+        _errors, abouts = model.collect_inventory(test_loc)
+
+        filter_dict = {'name': ['simple']}
+        # The test loc has 2 .about files, only the simple.about is taken after
+        # the filtering
+        updated_abouts = util.inventory_filter(abouts, filter_dict)
+        for about in updated_abouts:
+            assert about.name.value == 'simple'