Merge pull request #464 from utPLSQL/feature/add_version_check

jgebal · web-flow · commit 312fb95fe09b · 2017-08-28T08:35:15.000+01:00
Added `version_compatibility_check` function to ut_runner
diff --git a/.travis.yml b/.travis.yml
@@ -33,7 +33,7 @@ env:
     - CURRENT_BRANCH=${TRAVIS_BRANCH}
     - UTPLSQL_REPO="utPLSQL/utPLSQL"
     - UTPLSQL_BUILD_NO="${TRAVIS_BUILD_NUMBER:-0}"
-    - UTPLSQL_VERSION_PLACEHOLDER='utPLSQL - Version'
+    - UTPLSQL_VERSION_PATTERN='v?([0-9X]+\.){3}[0-9X]+'
     - UTPLSQL_VERSION=$(. .travis/get_project_version.sh)
     - UTPLSQL_BUILD_VERSION=$(. .travis/get_project_build_version.sh)
     - UTPLSQL_SOURCES_DIR='source'
diff --git a/.travis/update_project_version.sh b/.travis/update_project_version.sh
@@ -3,7 +3,7 @@
 echo Current branch is "${CURRENT_BRANCH}"
 
 echo Update version in project source files
-find ${UTPLSQL_SOURCES_DIR} -type f -name '*' -exec sed -i -r "s/(${UTPLSQL_VERSION_PLACEHOLDER} )[^']*(')?/\1${UTPLSQL_BUILD_VERSION}\2/" {} \;
+find ${UTPLSQL_SOURCES_DIR} -type f -name '*' -exec sed -i -r "s/${UTPLSQL_VERSION_PATTERN}/${UTPLSQL_BUILD_VERSION}/" {} \;
 echo Source files updated with version tag: ${UTPLSQL_BUILD_VERSION}
 
 echo Update of sonar-project.properties sonar.projectVersion
diff --git a/old_tests/ut/ut.version.sql b/old_tests/ut/ut.version.sql
@@ -1,8 +1,8 @@
 declare
-  l_expected varchar2(100) := 'utPLSQL - Version %.%.%';
+  l_expected varchar2(100) := '%.%.%.%';
 begin
 --Assert
-  if ut.version() like l_expected  then
+  if ut.version() like l_expected then
     :test_result := ut_utils.tr_success;
   else
     dbms_output.put_line('expected version like '''||l_expected ||''' got: '''||ut.version()||'''' );
diff --git a/source/api/ut.pkb b/source/api/ut.pkb
@@ -21,7 +21,7 @@ create or replace package body ut is
 
   function version return varchar2 is
   begin
-    return ut_utils.gc_version;
+    return ut_runner.version();
   end;
 
   function expect(a_actual in anydata, a_message varchar2 := null) return ut_expectation_anydata is
diff --git a/source/api/ut_runner.pkb b/source/api/ut_runner.pkb
@@ -43,6 +43,19 @@ create or replace package body ut_runner is
     return ut_utils.gc_version;
   end;
 
+  function version_compatibility_check( a_requested varchar2, a_current varchar2 := null ) return integer is
+    l_result boolean := false;
+    l_requested ut_utils.t_version := ut_utils.to_version(a_requested);
+    l_current ut_utils.t_version := ut_utils.to_version(coalesce(a_current,version()));
+  begin
+    if l_requested.major = l_current.major
+       and (l_requested.minor < l_current.minor
+            or l_requested.minor = l_current.minor and l_requested.bugfix <= l_current.bugfix) then
+      l_result := true;
+    end if;
+    return ut_utils.boolean_to_int(l_result);
+  end;
+
   procedure run(
     a_paths ut_varchar2_list, a_reporters ut_reporters, a_color_console boolean := false,
     a_coverage_schemes ut_varchar2_list := null, a_source_file_mappings ut_file_mappings := null, a_test_file_mappings ut_file_mappings := null,
diff --git a/source/api/ut_runner.pks b/source/api/ut_runner.pks
@@ -19,6 +19,19 @@ create or replace package ut_runner authid current_user is
 
   function version return varchar2;
 
+  /**
+  * Check if version is compatible with another version (by default the current framework version)
+  * Version is compatible if:
+  *   a_current.major = a_requested.major
+  *   a_requested.minor < a_current.minor or a_requested.minor = a_current.minor and a_requested.bugfix <= a_current.bugfix
+  *
+  * @param     a_requested requested utPLSQL version string
+  * @param     a_current   current   utPLSQL version string, if null is passed, defaults to current framework version
+  * @return    1/0         1-true, 0-false
+  * @exception 20214       if passed version string is not matching version pattern
+  */
+  function version_compatibility_check( a_requested varchar2, a_current varchar2 := null ) return integer;
+
   /**
   * Run suites/tests by path
   * Accepts value of the following formats:
diff --git a/source/core/ut_utils.pkb b/source/core/ut_utils.pkb
@@ -382,5 +382,20 @@ create or replace package body ut_utils is
     execute immediate 'delete from ut_cursor_data';
   end;
 
+  function to_version(a_version_no varchar2) return t_version is
+    l_result t_version;
+    c_version_part_regex varchar2(20) := '[0-9]+';
+  begin
+
+    if regexp_like(a_version_no,'v?([0-9]+(\.|$)){1,4}') then
+      l_result.major  := regexp_substr(a_version_no, c_version_part_regex, 1, 1);
+      l_result.minor  := regexp_substr(a_version_no, c_version_part_regex, 1, 2);
+      l_result.bugfix := regexp_substr(a_version_no, c_version_part_regex, 1, 3);
+      l_result.build  := regexp_substr(a_version_no, c_version_part_regex, 1, 4);
+    else
+      raise_application_error(gc_invalid_version_no, 'Version string "'||a_version_no||'" is not a valid version');
+    end if;
+    return l_result;
+  end;
 end ut_utils;
 /
diff --git a/source/core/ut_utils.pks b/source/core/ut_utils.pks
@@ -22,7 +22,7 @@ create or replace package ut_utils authid definer is
 
   */
 
-  gc_version                 constant varchar2(50) := 'utPLSQL - Version X.X.X.X';
+  gc_version                 constant varchar2(50) := 'X.X.X.X';
 
   /* Constants: Event names */
   gc_run                     constant varchar2(12) := 'run';
@@ -85,6 +85,10 @@ create or replace package ut_utils authid definer is
   gc_some_tests_failed constant pls_integer := -20213;
   pragma exception_init(ex_some_tests_failed, -20213);
 
+  -- Any of tests failed
+  ex_invalid_version_no exception;
+  gc_invalid_version_no constant pls_integer := -20214;
+  pragma exception_init(ex_invalid_version_no, -20214);
 
   gc_max_storage_varchar2_len constant integer := 4000;
   gc_max_output_string_length constant integer := 4000;
@@ -96,6 +100,15 @@ create or replace package ut_utils authid definer is
   gc_timestamp_format         constant varchar2(100) := 'yyyy-mm-dd"T"hh24:mi:ssxff';
   gc_timestamp_tz_format      constant varchar2(100) := 'yyyy-mm-dd"T"hh24:mi:ssxff tzh:tzm';
   gc_null_string              constant varchar2(4) := 'NULL';
+
+  type t_version is record(
+    major  natural,
+    minor  natural,
+    bugfix natural,
+    build  natural
+  );
+
+
   /*
      Function: test_result_to_char
         returns a string representation of a test_result.
@@ -218,12 +231,12 @@ create or replace package ut_utils authid definer is
   procedure append_to_clob(a_src_clob in out nocopy clob, a_new_data varchar2);
 
   function convert_collection(a_collection ut_varchar2_list) return ut_varchar2_rows;
-  
+
   /**
   * Set session's action and module using dbms_application_info
   */
   procedure set_action(a_text in varchar2);
-  
+
   /**
   * Set session's client info using dbms_application_info
   */
@@ -235,5 +248,14 @@ create or replace package ut_utils authid definer is
 
   procedure cleanup_temp_tables;
 
+  /**
+  * Converts version string into version record
+  *
+  * @param    a_version_no string representation of version in format vX.X.X.X where X is a positive integer
+  * @return   t_version    record with up to four positive numbers containing version
+  * @throws   20214        if passed version string is not matching version pattern
+  */
+  function to_version(a_version_no varchar2) return t_version;
+
 end ut_utils;
 /
diff --git a/source/reporters/ut_coverage_report_html_helper.pkb b/source/reporters/ut_coverage_report_html_helper.pkb
@@ -236,7 +236,7 @@ create or replace package body ut_coverage_report_html_helper is
     l_file_part :=
      chr(10)||
      '</div><div id="footer">' ||
-     'Generated by <a href="http://github.com/utPLSQL/utPLSQL">'||ut_utils.gc_version||'</a><br/>' ||
+     'Generated by <a href="http://github.com/utPLSQL/utPLSQL">utPLSQL '||ut_utils.gc_version||'</a><br/>' ||
      'Based on <a href="http://github.com/colszowka/simplecov-html">simplecov-html</a> v0.10.0 '||l_using||'' ||
      '</div><div class="source_files">';
     ut_utils.append_to_clob(l_result, l_file_part);
diff --git a/test/install_and_run_tests.sh b/test/install_and_run_tests.sh
@@ -14,7 +14,7 @@ utPLSQL-cli/bin/utplsql run ${UT3_TESTER}/${UT3_TESTER_PASSWORD}@${CONNECTION_ST
 -test_path=test -c \
 -f=ut_documentation_reporter  -o=test_results.log -s \
 -f=ut_coverage_sonar_reporter -o=coverage.xml \
--f=ut_coverage_html_reporter -o=coverage.html \
+-f=ut_coverage_html_reporter  -o=coverage.html \
 -f=ut_coveralls_reporter      -o=coverage.json \
 -f=ut_sonar_test_reporter     -o=test_results.xml
 
diff --git a/test/install_tests.sql b/test/install_tests.sql
@@ -9,6 +9,7 @@
 @@ut_reporters/test_coverage_sonar_reporter.pks
 @@ut_reporters/test_coveralls_reporter.pks
 @ut_expectations/test_expectations_cursor.pks
+@@ut_runner/test_ut_runner.pks
 
 @core.pkb
 @ut_utils/test_ut_utils.pkb
@@ -20,6 +21,7 @@
 @@ut_reporters/test_coverage_sonar_reporter.pkb
 @@ut_reporters/test_coveralls_reporter.pkb
 @ut_expectations/test_expectations_cursor.pkb
+@@ut_runner/test_ut_runner.pkb
 
 show errors
 
diff --git a/test/ut_runner/test_ut_runner.pkb b/test/ut_runner/test_ut_runner.pkb
@@ -0,0 +1,45 @@
+create or replace package body test_ut_runner is
+
+  procedure version_comp_check_compare is
+  begin
+    ut.expect( ut3.ut_runner.version_compatibility_check('v3.0.0.0','v3.0.0.0') ).to_equal(1);
+    ut.expect( ut3.ut_runner.version_compatibility_check('v3.0.0.0','v3.0.123.0') ).to_equal(1);
+    ut.expect( ut3.ut_runner.version_compatibility_check('v3.0.0.0','v3.123.0.0') ).to_equal(1);
+    ut.expect( ut3.ut_runner.version_compatibility_check('v3.0.0.0','v3.13.31.0') ).to_equal(1);
+    ut.expect( ut3.ut_runner.version_compatibility_check('v3.0.1.0','v3.0.0.0') ).to_equal(0);
+    ut.expect( ut3.ut_runner.version_compatibility_check('v3.1.0.0','v3.0.0.0') ).to_equal(0);
+    ut.expect( ut3.ut_runner.version_compatibility_check('v3.0.0.0','v2.0.0.0') ).to_equal(0);
+    ut.expect( ut3.ut_runner.version_compatibility_check('v3.0.0.0','v4.0.0.0') ).to_equal(0);
+  end;
+
+  procedure version_comp_check_ignore is
+  begin
+    ut.expect( ut3.ut_runner.version_compatibility_check('v3.0.0.123','v3.0.0.0') ).to_equal(1);
+    ut.expect( ut3.ut_runner.version_compatibility_check('v3.0.0.0','v3.0.0.123') ).to_equal(1);
+    ut.expect( ut3.ut_runner.version_compatibility_check('v3.0.0','v3.0.0.0') ).to_equal(1);
+  end;
+
+  procedure version_comp_check_short is
+  begin
+    ut.expect( ut3.ut_runner.version_compatibility_check('v3.0.0','v3.0.0.0') ).to_equal(1);
+    ut.expect( ut3.ut_runner.version_compatibility_check('v3.0','v3.0.123.0') ).to_equal(1);
+    ut.expect( ut3.ut_runner.version_compatibility_check('v3','v3.123.0.0') ).to_equal(1);
+  end;
+
+  procedure version_comp_check_exception is
+    procedure throws(a_requested varchar2, a_current varchar2) is
+      l_compatible integer;
+    begin
+      l_compatible := ut3.ut_runner.version_compatibility_check(a_requested,a_current);
+      ut.fail('Expected exception but nothing was raised');
+    exception
+      when others then
+        ut.expect(sqlcode).to_equal(-20214);
+    end;
+  begin
+    throws('bad_ver','v3.0.0.0');
+    throws('v3.0.0.0','bad_ver');
+  end;
+
+end;
+/
diff --git a/test/ut_runner/test_ut_runner.pks b/test/ut_runner/test_ut_runner.pks
@@ -0,0 +1,22 @@
+create or replace package test_ut_runner is
+
+  --%suite(ut_runner)
+  --%suitepath(utplsql.core)
+
+  --%test(version_compatibility_check compares major, minor and bugfix number)
+  procedure version_comp_check_compare;
+
+  --%test(version_compatibility_check ignores build number)
+  procedure version_comp_check_ignore;
+
+  --%test(version_compatibility_check compares short version to a full version)
+  procedure version_comp_check_short;
+
+  --%test(version_compatibility_check raises exception when invalid version passed)
+  procedure version_comp_check_exception;
+
+  --%test(version_compatibility_check raises exception when invalid version passed)
+  procedure version_comp_check_exception;
+
+end;
+/
diff --git a/test/ut_utils/test_ut_utils.pkb b/test/ut_utils/test_ut_utils.pkb
@@ -283,5 +283,16 @@ end;';
     ut.expect(l_result(1)).to_equal(l_expected(1));
   end;
 
+  procedure test_to_version_split is
+    l_version ut3.ut_utils.t_version;
+  begin
+    l_version := ut3.ut_utils.to_version('v034.0.0456.0333');
+    ut.expect(l_version.major).to_equal(34);
+    ut.expect(l_version.minor).to_equal(0);
+    ut.expect(l_version.bugfix).to_equal(456);
+    ut.expect(l_version.build).to_equal(333);
+  end;
+
+
 end test_ut_utils;
 /
diff --git a/test/ut_utils/test_ut_utils.pks b/test/ut_utils/test_ut_utils.pks
@@ -53,6 +53,9 @@ create or replace package test_ut_utils is
   --%disabled(We cannot run this test successfully on 12.1 until we change NLSCHARACTERSET from US7ASCII to AL32UTF8)
   procedure test_clob_to_table_multibyte;
 
+  --%test(to_version splits version string into individual version components)
+  procedure test_to_version_split;
+
 
 end test_ut_utils;
 /
