Merge pull request #124 from macbre/tables-skip-tables-cli-options

Process only selected tables when --tables / --skip-tables option is provided

Author: macbre

Makefile

@@ -20,7 +20,7 @@ lint:
 	pylint $(project_name)/ --ignore=test
 
 demo:
-	index_digest mysql://index_digest:qwerty@127.0.0.1/index_digest --sql-log sql/0002-not-used-indices-log --analyze-data --skip-checks=non_utf_columns
+	index_digest mysql://index_digest:qwerty@127.0.0.1/index_digest --sql-log sql/0002-not-used-indices-log --analyze-data --skip-checks=non_utf_columns --skip-tables=0028_no_time
 
 sql-console:
 	mysql --protocol=tcp -uindex_digest -pqwerty index_digest

README.md

@@ -50,7 +50,7 @@ index_digest
 Analyses your database queries and schema and suggests indices improvements.
 
 Usage:
-  index_digest DSN [--sql-log=<file>] [--format=<formatter>] [--analyze-data] [--checks=<checks> | --skip-checks=<skip-checks>]
+  index_digest DSN [--sql-log=<file>] [--format=<formatter>] [--analyze-data] [--checks=<checks> | --skip-checks=<skip-checks>] [--tables=<tables> | --skip-tables=<skip-tables>]
   index_digest (-h | --help)
   index_digest --version
 
@@ -61,6 +61,8 @@ Options:
   --analyze-data    Run additional checks that will query table data (can be slow!)
   --checks=<list>   Comma-separated lists of checks to report
   --skip-checks=<list> Comma-separated lists of checks to skip from report
+  --tables=<list>   Comma-separated lists of tables to report
+  --skip-tables=<list> Comma-separated lists of tables to skip from report
   -h --help         Show this screen.
   --version         Show version.
 
@@ -69,6 +71,7 @@ Examples:
   index_digest mysql://index_digest:qwerty@localhost/index_digest --sql-log=sql.log
   index_digest mysql://index_digest:qwerty@localhost/index_digest --skip-checks=non_utf_columns
   index_digest mysql://index_digest:qwerty@localhost/index_digest --analyze-data --checks=data_too_old,data_not_updated_recently
+  index_digest mysql://index_digest:qwerty@localhost/index_digest --analyze-data --skip-tables=DATABASECHANGELOG,DATABASECHANGELOGLOCK
 
 Visit <https://github.com/macbre/index-digest>
 ```

indexdigest/cli/script.py

@@ -4,7 +4,7 @@
 Analyses your database queries and schema and suggests indices improvements.
 
 Usage:
-  index_digest DSN [--sql-log=<file>] [--format=<formatter>] [--analyze-data] [--checks=<checks> | --skip-checks=<skip-checks>]
+  index_digest DSN [--sql-log=<file>] [--format=<formatter>] [--analyze-data] [--checks=<checks> | --skip-checks=<skip-checks>] [--tables=<tables> | --skip-tables=<skip-tables>]
   index_digest (-h | --help)
   index_digest --version
 
@@ -15,6 +15,8 @@
   --analyze-data    Run additional checks that will query table data (can be slow!)
   --checks=<list>   Comma-separated lists of checks to report
   --skip-checks=<list> Comma-separated lists of checks to skip from report
+  --tables=<list>   Comma-separated lists of tables to report
+  --skip-tables=<list> Comma-separated lists of tables to skip from report
   -h --help         Show this screen.
   --version         Show version.
 
@@ -23,6 +25,7 @@
   index_digest mysql://index_digest:qwerty@localhost/index_digest --sql-log=sql.log
   index_digest mysql://index_digest:qwerty@localhost/index_digest --skip-checks=non_utf_columns
   index_digest mysql://index_digest:qwerty@localhost/index_digest --analyze-data --checks=data_too_old,data_not_updated_recently
+  index_digest mysql://index_digest:qwerty@localhost/index_digest --analyze-data --skip-tables=DATABASECHANGELOG,DATABASECHANGELOGLOCK
 
 Visit <https://github.com/macbre/index-digest>
 """
@@ -122,7 +125,7 @@ def get_reports(database, sql_log=None, analyze_data=False):
     return reports
 
 
-def filter_reports(reports, checks=None, skip_checks=None):
+def filter_reports_by_type(reports, checks=None, skip_checks=None):
     """
     :type reports list[indexdigest.utils.LinterEntry]
     :type checks str
@@ -144,6 +147,28 @@ def filter_reports(reports, checks=None, skip_checks=None):
     return reports
 
 
+def filter_reports_by_table(reports, tables=None, skip_tables=None):
+    """
+    :type reports list[indexdigest.utils.LinterEntry]
+    :type tables str
+    :type skip_tables str
+    :rtype: list[indexdigest.utils.LinterEntry]
+    """
+    if tables:
+        return [
+            report for report in reports
+            if report.table_name in tables.split(',')
+        ]
+
+    if skip_tables:
+        return [
+            report for report in reports
+            if report.table_name not in skip_tables.split(',')
+        ]
+
+    return reports
+
+
 def main():
     """ Main entry point for CLI"""
     logger = logging.getLogger(__name__)
@@ -165,12 +190,19 @@ def main():
     )
 
     # handle --checks / --skip-checks
-    reports = filter_reports(
+    reports = filter_reports_by_type(
         reports,
         checks=arguments.get('--checks'),
         skip_checks=arguments.get('--skip-checks')
     )
 
+    # handle --tables / --skip-tables
+    reports = filter_reports_by_table(
+        reports,
+        tables=arguments.get('--tables'),
+        skip_tables=arguments.get('--skip-tables')
+    )
+
     # handle --format
     formatter = arguments.get('--format') or 'plain'
     logger.info("Using formatter: %s", formatter)

indexdigest/test/test_script.py

@@ -1,10 +1,10 @@
 from unittest import TestCase
 
-from indexdigest.cli.script import filter_reports
+from indexdigest.cli.script import filter_reports_by_type, filter_reports_by_table
 from indexdigest.utils import LinterEntry
 
 
-class TestFormatterIntegrationTest(TestCase):
+class FilterReportsByTypeTest(TestCase):
 
     REPORT_TYPES = [
         'foo',
@@ -28,15 +28,15 @@ def get_reports_mock(linter_types):
     def test_noop(self):
         reports = self.get_reports_mock(self.REPORT_TYPES)
 
-        filtered = filter_reports(reports)
+        filtered = filter_reports_by_type(reports)
         print(filtered)
 
         assert len(filtered) == len(self.REPORT_TYPES)
 
     def test_checks_switch(self):
         reports = self.get_reports_mock(self.REPORT_TYPES)
 
-        filtered = filter_reports(reports, checks='foo,test')
+        filtered = filter_reports_by_type(reports, checks='foo,test')
         print(filtered)
 
         assert len(filtered) == 3
@@ -47,7 +47,7 @@ def test_checks_switch(self):
     def test_checks_switch_single(self):
         reports = self.get_reports_mock(self.REPORT_TYPES)
 
-        filtered = filter_reports(reports, checks='test')
+        filtered = filter_reports_by_type(reports, checks='test')
         print(filtered)
 
         assert len(filtered) == 2
@@ -57,9 +57,70 @@ def test_checks_switch_single(self):
     def test_skip_checks_switch(self):
         reports = self.get_reports_mock(self.REPORT_TYPES)
 
-        filtered = filter_reports(reports, skip_checks='foo,test')
+        filtered = filter_reports_by_type(reports, skip_checks='foo,test')
         print(filtered)
 
         assert len(filtered) == 2
         assert filtered[0].linter_type == 'bar'
         assert filtered[1].linter_type == 'foobar'
+
+
+class FilterReportsByTableTest(TestCase):
+
+    REPORT_TABLES = [
+        'foo',
+        'bar',
+        'test',
+        'test',
+        'foobar',
+    ]
+
+    @staticmethod
+    def get_reports_mock(tables):
+        """
+        :type tables list[str]
+        :rtype: list[LinterEntry]
+        """
+        return [
+            LinterEntry(linter_type='foo', table_name=table, message='message')
+            for table in tables
+        ]
+
+    def test_noop(self):
+        reports = self.get_reports_mock(self.REPORT_TABLES)
+
+        filtered = filter_reports_by_table(reports)
+        print(filtered)
+
+        assert len(filtered) == len(self.REPORT_TABLES)
+
+    def test_tables_switch(self):
+        reports = self.get_reports_mock(self.REPORT_TABLES)
+
+        filtered = filter_reports_by_table(reports, tables='foo,test')
+        print(filtered)
+
+        assert len(filtered) == 3
+        assert filtered[0].table_name == 'foo'
+        assert filtered[1].table_name == 'test'
+        assert filtered[2].table_name == 'test'
+
+    def test_tables_switch_single(self):
+        reports = self.get_reports_mock(self.REPORT_TABLES)
+
+        filtered = filter_reports_by_table(reports, tables='test')
+        print(filtered)
+
+        assert len(filtered) == 2
+        assert filtered[0].table_name == 'test'
+        assert filtered[1].table_name == 'test'
+
+    def test_skip_tables_switch(self):
+        reports = self.get_reports_mock(self.REPORT_TABLES)
+
+        filtered = filter_reports_by_table(reports, skip_tables='foo,test')
+        print(filtered)
+
+        assert len(filtered) == 2
+        assert filtered[0].table_name == 'bar'
+        assert filtered[1].table_name == 'foobar'