utplsql mit gradle

In diesem Artikel stelle ich vor, wie utplsql mit dem Build-Automatisierungstool gradle integriert wird. Dazu verwende ich das utplsql-Plugin für gradle.

Die Aufgabe ist, die Tests für die Funktion btwnstr aus der utplsql-Dokumentation im Package ut_btwnstr über das Plugin in gradle auszuführen und die Testergebnisse darzustellen.

Vorgehen wie folgt:

Neuen Ordner anlegen

mkdir utplsql01
cd utplsql01

Gradle projekt initialisieren

gradle init

Die build.gradle-Datei wie folgt anpassen

buildscript {
  repositories {
    maven {
  url 'http://dl.bintray.com/iwarapter/gradle-plugins/' 
    }
  }
  dependencies {
    classpath 'com.iadams:gradle-utplsql-plugin:0.1.3'
    }
  }

apply plugin: 'com.iadams.utplsql'

repositories {
  mavenCentral()
}
dependencies {
  junitreport 'org.apache.ant:ant-unit:1.9.4'
}

task loadDriver {
  URLClassLoader loader = GroovyObject.class.classLoader
  loader.addURL (file ('lib/ojdbc6.jar').toURL())
  java.sql.DriverManager.registerDriver(loader.loadClass ('oracle.jdbc.OracleDriver').newInstance())
}
utDeploy.dependsOn loadDriver
utRun.dependsOn loadDriver

utplsql {
  url = 'jdbc:oracle:thin:@entw01:1521/orcl'
  username = 'hr'
  password = 'oracle'
  sourceDir = 'src/tests'
  includes = '**/*.pks, **/*.pkb'
  excludes = ''
  outputDir = 'build/utplsql'
  testMethod = 'run'
  setupMethod = true
  failOnNoTests = true
}

Nun einen src/tests Ordner anlegen

mkdir -p src/tests
cd src/tests

und darin die Source des Test-Packages ut_btnwstr kopieren.

Nun muss man noch einen lib-Order anlegen, in den der jdbc-Treiber kopiert werden muss.

mkdir lib
cd lib
cp /oracle-lib-folder/ojdbc6.jar .

Nun kann man mit

gradle utDeploy utRun

die Tests einspielen und ausführen.

Im nächsten Post zeige ich, wie ich dies für Continuous Integrations optimiere und erweitere indem flywaydb integriert wird.

utplsql – Unit-Testing für Oracle

Unit-Testing ist in vielen Programmiersprachen und -umgebungen ein etablierter Standard zur Qualitätssicherung in der Software-Entwicklung, nicht jedoch unter PL/SQL.

Über die Gründe dafür kann ich nur spekulieren. Vielleicht liegt es daran, dass der Entwickler die Technik (Abfragen, schreibende Zugriffe) nur sehr schwer von der Geschäftslogik trennen kann.

Letztlich gibt es m.E. keinen wirklichen Grund, Unitests unter PL/SQL zu unterlassen.

Im folgenden möchte ich die Technik und Tools vorstellen und einen Working-Prototype für einen einfachen PL/SQL-Unit vorstellen.

Dazu verwende ich utplsql, welches schon seit vielen Jahren Unit-Tests unter Oracle ermöglicht. In einem ersten Schritt starte ich den Unit-Test per Shell-Script.

In einem weiteren Schritt stelle ich ein Plugin für das Build-Tool gradle vor, mit dem der Test angestossen wird.

Installation von utplsql

utplsql wird nach Dokumentation installiert und kann anschliessend von allen Usern der Datenbank-Instanz verwendet werden.

Zum Test, ob utplsql richtig funktioniert, folgen wir dem Beispiel auf der utplsql-Homepage und definieren die Funktion

create or replace FUNCTION betwnStr (
 string_in IN VARCHAR2,
 start_in IN INTEGER,
 end_in IN INTEGER
 )
 RETURN VARCHAR2
IS
BEGIN
 RETURN  SUBSTR ( string_in,start_in,end_in - start_in + 1);
END;

Als Test-Package verwende ich ebenfalls das Beispiel von der utplsql-Seite. Das Testpackage hat den Namen ut_btwnstr und definiert einen Test:

create or replace PACKAGE ut_betwnstr
IS
 PROCEDURE ut_setup;
 PROCEDURE ut_teardown;
 PROCEDURE ut_BETWNSTR;
END ut_betwnstr;

Der Body mit der Test-Implementierung lautet:

create or replace PACKAGE BODY ut_betwnstr
IS
 PROCEDURE ut_setup IS
 BEGIN
   NULL;
 END;

PROCEDURE ut_teardown
 IS
 BEGIN
   NULL;
 END;

PROCEDURE ut_betwnstr IS
BEGIN
 utAssert.eq ('Typical valid usage',
    BETWNSTR(  STRING_IN => 'abcdefg',
               START_IN => 3,
               END_IN => 5),
    'cde');
 END;
END;

Somit haben wir einen Test definiert, den wir aus sqlplus aufrufen:

Begin
 utplsql.test (
     samepackage_in => false,
     package_in => 'betwnstr',
     prefix_in => 'UT_',
     recompile_in => false);
End;

Wichtig ist hierbei, dass utplsql eigentlich immer als Aufrufparameter den Namen des zu testenden Objekts fordert – also nicht den Namen des Testpackages!

Es gibt sicher noch andere Möglichkeiten, diesen Aufruf zu formulieren, die Ausgabe ist immer:

SQL*Plus: Release 11.2.0.3.0 Production on Thu Mar 17 18:15:43 2016
Copyright (c) 1982, 2012, Oracle.  All rights reserved.
Connected to:
Oracle Database 12c Enterprise Edition Release 12.1.0.2.0 - 64bit Production
With the Partitioning, OLAP, Advanced Analytics and Real Application Testing options
.
>    SSSS   U   U   CCC     CCC   EEEEEEE   SSSS     SSSS
>   S S  U   U  C C   C C  E     S   S   S    S
>  S     U   U C   C C   C E     S     S
>   S     U   U C     C     E     S       S
>    SSSS   U   U C     C     EEEE      SSSS     SSSS
> S  U   U C     C     E   S   S
>   S U   U C   C C   C E   S     S
>   S S   U U   C C   C C  E     S   S   S    S
>    SSSS     UUU     CCC     CCC   EEEEEEE   SSSS     SSSS
.
SUCCESS: ".betwnstr"
.
> Individual Test Case Results:
>
SUCCESS - betwnstr.UT_BETWNSTR: EQ "Typical valid usage" Expected "cde" and got
"cde"
>
> Errors recorded in utPLSQL Error Log:
>
> NONE FOUND
PL/SQL procedure successfully completed.
Disconnected from Oracle Database 12c Enterprise Edition Release 12.1.0.2.0 - 64bit Production
With the Partitioning, OLAP, Advanced Analytics and Real Application Testing options

Die Testausführung hat geklappt, die Tests waren erfolgreich.

Im nächsten Artikel geht es dann um die Integration von utplsql in das Build-Tool Gradle.

Oracle unter Apple OS X

Von Oracle wird eine Prebuild VM mit Oracle 12c für VirtualBox angeboten.

Will man vom Mac aus auf den Oracle 12c Server unter Oracle Enterprise Linux zugreifen, so ist es notwendig, dass

  • die Firewall in der Virtuellen Maschine  ausgeschaltet ist,
  • ein zweites Netzwerkinterface „Host-Only“ aktiviert ist,
  • die SID ist ORCL
  • sqlplus hr/oracle@entw01:1521/orcl

Gibt es hierbei Probleme, so kann das daran liegen, dass der Account hr inaktiv ist. Dann hilft ein Anmelden als sys mit

sqlplus sys/oracle@localhost:1521/orcl as sysdba

und dann (in sqlplus)

alter user hr identified by oracle account unlock;

Um von OSX auf den Oracle Server in der virtuellen Maschine zugreifen zu können, müssen mehrere Dinge konfiguriert und eingerichtet werden:

Um den Server zuverlässig über eine eigene IP-Adresse ansprechen zu können, wird in Virtualbox ein Host-Only-Netz angelegt. Um immer die gleiche IP-Adresse für diese Maschine zu erhalten, stelle ich in den Einstellungen der virtuellen Netzwerkkarte die kleinste Adresse und grösste Adresse des DHCP-Servers auf den gleichen Wert. Ich merke mir diese Wert und trage ihn in die etc/hosts meines Macs als Namen ein:

# Host Database
#
# localhost is used to configure the loopback interface
# when the system is booting. Do not change this entry.
##
127.0.0.1 localhost
255.255.255.255 broadcasthost
192.168.56.101 entw01
::1 localhost

Anschliessend boote ich die virtuelle Maschine und versuche, sie mittels PING vom Mac aus zu erreichen.

ping entw01

Instantclient und sqlplus

Nun folgt die Installation des instantclients für den Mac. Dazu die gewünschten Pakete von Oracle runterlasen und WICHTIG! die Installationsanleitung am Ende der Download-Seite beachten.

Ein Aufruf von sqlplus muss dann erfolgreich sein:

sqlplus hr/oracle@entw01/orcl

Falls nicht, dann bitte noch mal die Installationsanleitung von Oracle nachvollziehen.

sqlplus++

sqlcl ist der Nachfolger von sqlplus. Download von Oracle. Aufruf geschieht wie für sqlplus:

sql hr/oracle@entw01/orcl

 

 

dbFit, Fitnesse und Oracle

der einfachste Test, den man mit dbFit gegen eine Oracle-Datenbank ausführen kann, sieht so aus:

!path lib/*.jar
!|dbfit.OracleTest|
!|Connect|entw01:1521/orcl|scott|tiger|
!|Query| select 'test' as x from dual|
|x|
|test|

Dieser Test lädt den notwendigen JDBC-Treiber,  initialisiert Fitnesse für den Oracle-Test, Initialisiert die Verbindung zum Oracle-Server und führt die triviale Query aus sowie prüft das Ergebnis.

Password expiration abschalten

Immer wieder nervig: Die Oracle-VM ist eingerichtet, alles funktioniert. Nach einiger Zeit laufen dann die Passworte ab!  Das läßt sich vermeiden, wenn man bei Einrichten direkt dran denkt, das Default-Profil entsprechend anzupassen:  Dazu einfach als SYSDBA folgendes Statement ausführen:

Alter Profile default Limit password_life_time unlimited

 

 

Oracle PL/SQL: Rekursive Bestimmung von Abhängigkeiten

Mit folgendem Statement läßt sich ein Baum von Abhängigkeiten eines PL/SQL-Packages bestimmen.

SELECT lpad(' '2 * (LEVEL - 1)) || to_char(LEVEL'999'AS c1,
       owner || '.' || NAME || ' (' || TYPE || ')' AS c2,
       referenced_owner || '.' || referenced_name || ' (' || referenced_type || ')' AS c3
FROM dba_dependencies 
 START WITH owner = USER AND NAME = '&NAME'
CONNECT BY PRIOR referenced_owner = owner
       AND PRIOR referenced_name = NAME
       AND PRIOR referenced_type = TYPE
       AND TYPE = 'PACKAGE';

 

Conditional compilation mit Oracle 10 und jünger

Bedingte Compilierung ist ein nettes Feature, um z.B. Debug- oder Test-Code aus einer Produktionsumgebung rauszuhalten, ohne den Quelltest zu duplizieren.

Oracle unterstützt dies seit der Version 10.2.

So gehts:

Die Befehle für Conditional Defines sind $IF, $THEN, $ELSE und $END. Die Variablen werden mittels $$ angesprochen, also z.B.

Create or replace Function foobar (v_para1 integer, 
                                   v_para2 integer) return integer 
is 
Begin
  $IF $$debug_flag $THEN
   dbms_output.put_line ('Calling foobar with ' || v_para1 || ', ' || v_para2);
  $END
  return v_para1 * v_para2;
End;

Spielt man diese Funktion ein und ruft sie anschliessend auf, so wird keine Ausgabe im Server-Output erscheinen.

Dies muss man durch

ALTER FUNCTION foobar COMPILE PLSQL_CCFLAGS = 'debug_flag:TRUE' REUSE SETTINGS;

aktivieren.

Dann gibt es beim Aufruf die erwartete Ausgabe.

Natürlich kann man den Conditional Define auch wieder zurücksetzen, so dass man keine Ausgabe mehr erhält.

ALTER FUNCTION foobar COMPILE PLSQL_CCFLAGS = 'debug_flag:FALSE' REUSE SETTINGS;

Xcode 5.0.2 und svn 1.8

Will man Xcode in der Version 5.0 mit SVN 1.8 zusammen verwenden, erhält man seltsame Fehlermeldungen. Etwas Recherche im Internet liefert den sehr hilfreichen Hinweis, dass die SVN-Server-Version nicht zur Clientversion von SVN in Xcode passen könnte. Ich verwende die aktuelle Version 1.8 von svn als Server, die Client-Version erfährt man durch direkten Aufruf von svn in Xcode durch:

/Applications/Xcode.app/Contents/Developer/usr/bin/svn --version

und das liefert

svn, version 1.7.10 (r1485443)

Die Kombination Server-Version 1.8 und Client-Version 1.7 habe ich  nicht ans Laufen gebracht. In diesem Post auf stackoverflow.com wird eine Lösung erläutert, die abgewandelt auf Xcode 5 ebenfalls passt :

Vorhandenen svn-binaries verschieben in ein Sicherungsverzeichnis

cd /Applications/Xcode.app/Contents/Developer/usr/bin
sudo mkdir svn_V17
sudo mv svn* svn_V17/

und dann die Links auf die richtigen Programme in opt/local/bin anlegen

cd /Applications/Xcode.app/Contents/Developer/usr
sudo ln -s /opt/local/bin/svn* bin/

Danach funktionierte svn auch in Xcode.
Das muss man dann mit jeder Aktualisierung von Xcode wiederholen.

 

nichts weiter