Merge branch 'develop' into feature/cleanup_code_and_tests_a_bit

jgebal · web-flow · commit 60c0097d4e38 · 2018-07-17T20:28:36.000+01:00
diff --git a/docs/userguide/annotations.md b/docs/userguide/annotations.md
@@ -21,7 +21,7 @@ We strongly recommend putting package level annotations at the very top of packa
 | `--%suitepath(<path>)` | Package | Similar to java package. The annotation allows logical grouping of suites into hierarchies. |
 | `--%displayname(<description>)` | Package/procedure | Human-readable and meaningful description of a suite/test. `%displayname(Name of the suite/test)`. The annotation is provided for flexibility and convenience only. It has exactly the same meaning as `<description>` in `test` and `suite` annotations. If description is provided using both `suite`/`test` and `displayname`, then the one defined as last takes precedence. |
 | `--%test(<description>)` | Procedure | Denotes that the annotated procedure is a unit test procedure.  Optional test description can by provided (see `displayname`). |
-| `--%throws(<exception_number>[,<exception_number>[,...]])`| Procedure | Denotes that the annotated procedure must throw one of the exception numbers provided. If no valid numbers were provided as annotation parameters the annotation is ignored. Applicable to test procedures only. |
+| `--%throws(<exception|>[,...])`| Procedure | Denotes that the annotated test procedure must throw one of the exceptions provided. Supported forms of exceptions are: numeric literals, numeric contant names, exception constant names, predefined Oracle exception names. |
 | `--%beforeall` | Procedure | Denotes that the annotated procedure should be executed once before all elements of the suite. |
 | `--%beforeall([[<owner>.]<package>.]<procedure>[,...])` | Package | Denotes that the mentioned procedure(s) should be executed once before all elements of the suite. |
 | `--%afterall` | Procedure | Denotes that the annotated procedure should be executed once after all elements of the suite. |
@@ -1081,6 +1081,7 @@ Below test suite defines:
 ```sql
 create or replace package test_rooms_management is
 
+  gc_null_value_exception constant integer := -1400;
   --%suite(Rooms management)
   
   --%beforeall
@@ -1104,11 +1105,11 @@ create or replace package test_rooms_management is
   --%description(Add content to a room)
 
     --%test(Fails when room name is not valid)
-    --%throws(-1403)
+    --%throws(no_data_found)
     procedure fails_on_room_name_invalid;
 
     --%test(Fails when content name is null)
-    --%throws(-1400)
+    --%throws(gc_null_value_exception)
     procedure fails_on_content_null;
 
     --%test(Adds a content to existing room)
@@ -1170,7 +1171,7 @@ create or replace package body test_rooms_management is
   begin
     --Act
     add_rooms_content('Dining Room',null);
-    --Assert by --%throws annotation
+    --Assert done by --%throws annotation
   end;
 
   procedure add_content_success is
diff --git a/source/check_object_grants.sql b/source/check_object_grants.sql
@@ -2,6 +2,8 @@ declare
   c_expected_grants constant dbmsoutput_linesarray := dbmsoutput_linesarray('DBMS_LOCK','DBMS_CRYPTO');
 
   l_missing_grants varchar2(4000);
+  l_target_table   varchar2(128);
+  l_owner_column   varchar2(128);
 
   function get_view(a_dba_view_name varchar2) return varchar2 is
       l_invalid_object_name exception;
@@ -16,16 +18,18 @@ declare
     end;
 
 begin
+  l_target_table := get_view('dba_tab_privs');
+  l_owner_column := case when l_target_table like 'dba%' then 'owner' else 'table_schema' end;
   execute immediate q'[
   select listagg(' -  '||object_name,CHR(10)) within group(order by object_name)
     from (
   select column_value as object_name
     from table(:l_expected_grants)
    minus
   select table_name as object_name
-    from ]'||get_view('dba_tab_privs')||q'[
+    from ]'||l_target_table||q'[
    where grantee = SYS_CONTEXT('userenv','current_schema')
-     and owner = 'SYS')]'
+     and ]'||l_owner_column||q'[ = 'SYS')]'
   into l_missing_grants using c_expected_grants;
   if l_missing_grants is not null then
     raise_application_error(
@@ -37,4 +41,3 @@ begin
   end if;
 end;
 /
-
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';
@@ -742,7 +763,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
@@ -756,6 +797,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/source/core/ut_utils.pks b/source/core/ut_utils.pks
@@ -21,7 +21,7 @@ create or replace package ut_utils authid definer is
    *
    */
 
-  gc_version                 constant varchar2(50) := 'v3.1.2.2059-develop';
+  gc_version                 constant varchar2(50) := 'v3.1.2.2101-develop';
 
   /* Constants: Event names */
   subtype t_event_name           is varchar2(30);
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;
 /

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ create or replace package ut_utils authid definer is`
`21`	`21`	`*`
`22`	`22`	`*/`
`23`	`23`
`24`		`- gc_version constant varchar2(50) := 'v3.1.2.2059-develop';`
	`24`	`+ gc_version constant varchar2(50) := 'v3.1.2.2101-develop';`
`25`	`25`
`26`	`26`	`/* Constants: Event names */`
`27`	`27`	`subtype t_event_name is varchar2(30);`