Merge pull request #719 from utPLSQL/feature/warning_on_unknown_annotation

jgebal · web-flow · commit 28f05e193f25 · 2018-07-17T08:03:09.000+01:00
Added reporting of warnings for unknown annotations.
diff --git a/source/core/ut_suite_builder.pkb b/source/core/ut_suite_builder.pkb
@@ -37,6 +37,27 @@ create or replace package body ut_suite_builder is
   gc_context                     constant t_annotation_name := 'context';
   gc_endcontext                  constant t_annotation_name := 'endcontext';
 
+  type tt_annotations is table of t_annotation_name;
+
+  gc_supported_annotations       constant tt_annotations
+    := tt_annotations(
+      gc_suite,
+      gc_suitepath,
+      gc_test,
+      gc_disabled,
+      gc_displayname,
+      gc_beforeall,
+      gc_beforeeach,
+      gc_beforetest,
+      gc_afterall,
+      gc_aftereach,
+      gc_aftertest,
+      gc_throws,
+      gc_rollback,
+      gc_context,
+      gc_endcontext
+  );
+
   gc_placeholder                 constant varchar2(3) := '\\%';
   
   gc_integer_exception           constant varchar2(1) := 'I';
@@ -757,7 +778,27 @@ create or replace package body ut_suite_builder is
       end loop;
     end if;
   end;
-  
+
+  procedure warning_on_unknown_annotations(
+    a_suite in out nocopy ut_suite_item,
+    a_annotations tt_annotations_by_line
+  ) is
+    l_line_no t_annotation_position :=  a_annotations.first;
+  begin
+    while l_line_no is not null loop
+      if a_annotations(l_line_no).name not member of (gc_supported_annotations) then
+        add_annotation_ignored_warning(
+            a_suite,
+            a_annotations(l_line_no).name,
+            'Unsupported annotation %%%.',
+            l_line_no,
+            a_annotations(l_line_no).procedure_name
+        );
+      end if;
+      l_line_no := a_annotations.next(l_line_no);
+    end loop;
+  end;
+
   function create_suite(
     a_annotations t_annotations_info
   ) return ut_logical_suite is
@@ -771,6 +812,7 @@ create or replace package body ut_suite_builder is
       l_suite := ut_suite(l_annotations.owner, l_annotations.name);
       l_annotation_pos := l_annotations.by_name( gc_suite).first;
       l_suite.description := l_annotations.by_name( gc_suite)( l_annotation_pos);
+      warning_on_unknown_annotations(l_suite, l_annotations.by_line);
 
       warning_on_duplicate_annot( l_suite, l_annotations.by_name, gc_suite );
 
diff --git a/test/core/test_suite_builder.pkb b/test/core/test_suite_builder.pkb
@@ -1020,5 +1020,37 @@ create or replace package body test_suite_builder is
     );
   end;
 
-end;
+  procedure test_bad_procedure_annotation is
+    l_actual      clob;
+    l_annotations ut3.ut_annotations;
+  begin
+    --Arrange
+    l_annotations := ut3.ut_annotations(
+        ut3.ut_annotation(1, 'suite','Cool', null),
+        ut3.ut_annotation(2, 'bad_procedure_annotation',null, 'some_procedure'),
+        ut3.ut_annotation(6, 'test','A test', 'do_stuff')
+    );
+    --Act
+    l_actual := invoke_builder_for_annotations(l_annotations, 'SOME_PACKAGE');
+    --Assert
+    ut.expect(l_actual).to_be_like('%<WARNINGS><VARCHAR2>Unsupported annotation &quot;--\%bad_procedure_annotation&quot;. Annotation ignored.% line 2</VARCHAR2></WARNINGS>%', '\');
+  end;
+
+  procedure test_bad_package_annotation is
+    l_actual      clob;
+    l_annotations ut3.ut_annotations;
+    begin
+      --Arrange
+      l_annotations := ut3.ut_annotations(
+          ut3.ut_annotation(1, 'suite','Cool', null),
+          ut3.ut_annotation(17, 'bad_package_annotation',null, null),
+          ut3.ut_annotation(24, 'test','A test', 'do_stuff')
+      );
+      --Act
+      l_actual := invoke_builder_for_annotations(l_annotations, 'SOME_PACKAGE');
+      --Assert
+      ut.expect(l_actual).to_be_like('%<WARNINGS><VARCHAR2>Unsupported annotation &quot;--\%bad_package_annotation&quot;. Annotation ignored.% line 17</VARCHAR2></WARNINGS>%', '\');
+  end;
+
+end test_suite_builder;
 /
diff --git a/test/core/test_suite_builder.pks b/test/core/test_suite_builder.pks
@@ -163,5 +163,16 @@ create or replace package test_suite_builder is
 
   --%endcontext
 
-end;
+  --%context(unknown_annotation)
+  --%displayname(--%bad_annotation)
+
+  --%test(Gives warning when unknown procedure level annotation passed)
+  procedure test_bad_procedure_annotation;
+
+  --%test(Gives warning when unknown package level annotation passed)
+  procedure test_bad_package_annotation;
+
+  --%endcontext
+
+end test_suite_builder;
 /
