feat(rules): add information context (#30)

Author: everleene

dblinter.cfg

@@ -14,7 +14,7 @@ def test_how_many_table_without_primary_key(postgres_instance_args) -> None:
     param = [{"warning": "50%"}]
     context = Context(
         desc="Count number of tables without primary key.",
-        message="{0} table without primary key exceed the warning threshold: {1}%. Table list [{2}]",
+        message="{0} table without primary key exceed the warning threshold: {1}%. Object list [{2}]",
         fixes=[
             "create a index on foreign key or change warning/error threshold.",
         ],

dblinter/default_config.yaml

@@ -44,7 +44,7 @@ def test_how_many_redundant_index(postgres_instance_args) -> None:
     context = Context(
         desc="Count number of tables without index on foreign key.",
         fixes=["create a index on foreign key or change warning/error threshold."],
-        message="{0} redundant(s) index exceed the warning threshold: {1}%. Index list [{2}]",
+        message="{0} redundant(s) index exceed the warning threshold: {1}%. Object list [{2}]",
     )
 
     sarif_document = SarifDocument()

tests/data/good_config.yaml

@@ -8,7 +8,7 @@ def test_table_with_fk_mismatch_integer(postgres_instance_args) -> None:
     args = postgres_instance_args
     context = Context(
         desc="Count number of tables without index on foreign key.",
-        fixes=["consider rewrite your model.", "ask a dba."],
+        fixes=["Consider rewrite your model, ask a DBA"],
         message="Type constraint mismatch: {0} on {1} column {2} (type {3}/{4}) ref {5} column {6} type ({7}/{8})",
     )
     param = [{"size_mo": 1}]

tests/rules/B001/test_HowManyTableWithoutPrimaryKey.py

@@ -398,7 +398,7 @@ def test_main_with_schema_and_role_without_default_role_nok(
         schema="schema1",
     )
     assert (
-        "No default role grantee on schema postgres.schema1. It means that each time a table is created, you must grant it to roles."
+        "No default role granted on schema postgres.schema1. It means that each time a table is created, you must grant it to roles."
         in sarif_document.sarif_doc.runs[0].results[0].message.text
     )
 
@@ -476,7 +476,7 @@ def test_main_with_schema_and_role_not_exist_nok(postgres_instance_args) -> None
     )
 
     assert (
-        "No role grantee on table postgres.schema1.e_table1. It means that except owner."
+        "No role granted on table postgres.schema1.e_table1."
         in sarif_document.sarif_doc.runs[0].results[1].message.text
     )