experimental intergration of SQL Developer's PL/SQL parser

PhilippSalvisberg · PhilippSalvisberg · commit 77a84bae931b · 2019-06-19T18:51:53.000+02:00
It does not work from a 3rt party extension since
Oracle does not expose this feature via their OSGi bundle.

It's possible to include the relevant JAR file directly,
but this would violate the license agreement. Hence,
the utPLSQL's parser is still used.
diff --git a/sqldev/src/main/java/org/utplsql/sqldev/parser/SqlDevParser.xtend b/sqldev/src/main/java/org/utplsql/sqldev/parser/SqlDevParser.xtend
@@ -0,0 +1,60 @@
+/* Copyright 2018 Philipp Salvisberg <philipp.salvisberg@trivadis.com>
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.utplsql.sqldev.parser
+
+import oracle.dbtools.parser.LexerToken
+import oracle.dbtools.raptor.navigator.plsql.PlSqlArguments
+import oracle.dbtools.raptor.navigator.plsql.PlsqlStructureParser
+
+/*
+ * Cannot use this class within SQL Developer because the
+ * package oracle.dbtools.parser is not exported in sqldeveloper OSGI bundle (extension)
+ * (throws ClassNotFoundException at runtime).
+ * 
+ * The dbtools-common.jar contains the necessary packages, 
+ * but it cannot be distributed with the utPLSQL extension 
+ * without violating the Oracle license agreement.
+ */
+class SqlDevParser {
+	def getMembers(String plsql) {
+		val tokens = LexerToken.parse(plsql)
+		val parser = new PlsqlStructureParser
+		parser.parse(tokens, PlSqlArguments.sort)
+		return parser.children
+	}
+	
+	private def getStartLine(String plsql, int offset) {
+		var int line = 1
+		for (var i = 0; i < plsql.length; i++) {
+			val c = plsql.substring(i, i+1)
+			if (i > offset) {
+				return line
+			} else if (c == '\n') {
+				line = line + 1
+			}
+		}
+		return line
+	}
+	
+	def getMemberStartLine(String plsql, String memberName) {
+		val members = plsql.members
+		val member = members.findFirst[it.name.equalsIgnoreCase(memberName)]
+		if (member !== null) {
+			return getStartLine(plsql, member.codeOffset)
+		} else {
+			1
+		}
+	}
+}
diff --git a/sqldev/src/test/java/org/utplsql/sqldev/test/parser/SqlDevParserTest.xtend b/sqldev/src/test/java/org/utplsql/sqldev/test/parser/SqlDevParserTest.xtend
@@ -0,0 +1,123 @@
+package org.utplsql.sqldev.test.parser
+
+import org.junit.Assert
+import org.junit.Test
+import org.utplsql.sqldev.parser.SqlDevParser
+
+class SqlDevParserTest {
+	val packageSpec = '''
+		CREATE OR REPLACE PACKAGE junit_utplsql_test1_pkg is
+		   --%suite(JUnit testing)
+		   --%suitepath(a)
+		
+		   --%context(test context)
+		
+		   --%test(test 1 - OK) 
+		   PRoCeDURE test_1_ok;
+
+		   --%test(test 2 - NOK)
+		   PROCEDURE test_2_nok;
+		
+		   --%test(test 3 - disabled)
+		   --%disabled
+		   PROCEDURE test_3_disabled;
+
+		   --%test(test 4 - errored)
+		   PROCEDURE test_4_errored;
+		   
+		   --%test(test 5 - warnings)
+		   PROCEDURE test_5_warnings;
+		   --%endcontext
+
+		   function my_Func (p IN number) RETURN BOOLEAN;
+		END;
+	'''
+
+	val packageBody = '''
+		CREATE OR REPLACE PACKAGE BODY junit_utplsql_test1_pkg IS
+		   PROCEDURE test_1_ok IS
+		   BEGIN
+		      dbms_output.put_line('start test 1');
+		      dbms_session.sleep(1);
+		      ut.expect(1).to_equal(1);
+		      dbms_output.put_line('end test 1');
+		   END;
+		
+		   PROCEDURE test_2_nok IS
+		   BEGIN
+		      dbms_output.put_line('start test 2');
+		      dbms_session.sleep(2);
+		      ut.expect(1, 'first assert.').to_equal(2);
+		      ut.expect(1, 'second assert.').to_equal(2);
+		      dbms_output.put_line('end test 2');
+		   END;
+		   
+		   PROCEDURE test_3_disabled IS
+		   BEGIN
+		      NULL;
+		   END;
+
+		   PROCEDURE test_4_errored IS
+		   BEGIN
+		      EXECUTE IMMEDIATE 'bla bla';
+		   END;
+
+		   PROCEDURE test_5_warnings IS
+		   BEGIN
+		      COMMIT; -- will raise a warning
+			  ut.expect(1).to_equal(1);
+		   END;
+
+		   FUNCTION my_Func (p IN number) RETURN BOOLEAN IS
+		      RETURN TRUE;
+		   END;
+		END;
+	'''
+	
+	@Test
+	def void packageSpecMembers() {
+		val parser = new SqlDevParser
+		val actual = parser.getMembers(packageSpec)
+		Assert.assertEquals(6, actual.length)
+		val first = actual.get(0)
+		Assert.assertEquals("PROCEDURE", first.type)
+		Assert.assertEquals("test_1_ok", first.name)
+		val last = actual.get(5)
+		Assert.assertEquals("FUNCTION", last.type)
+		Assert.assertEquals("my_Func", last.name)
+	}
+
+	@Test
+	def void packageBodyMembers() {
+		val parser = new SqlDevParser
+		val actual = parser.getMembers(packageBody)
+		Assert.assertEquals(6, actual.length)
+		val first = actual.get(0)
+		Assert.assertEquals("PROCEDURE", first.type)
+		Assert.assertEquals("test_1_ok", first.name)
+		val last = actual.get(5)
+		Assert.assertEquals("FUNCTION", last.type)
+		Assert.assertEquals("my_Func", last.name)
+	}
+
+	@Test
+	def void StartLineSpec() {
+		val parser = new SqlDevParser
+		val first = parser.getMemberStartLine(packageSpec, 'test_1_ok')
+		Assert.assertEquals(8, first)
+		val last = parser.getMemberStartLine(packageSpec, 'my_func')
+		Assert.assertEquals(24, last)
+	}
+
+	@Test
+	def void StartLineBody() {
+		val parser = new SqlDevParser
+		val first = parser.getMemberStartLine(packageBody, 'test_1_ok')
+		Assert.assertEquals(2, first)
+		val last = parser.getMemberStartLine(packageBody, 'my_func')
+		Assert.assertEquals(35, last)
+	}
+
+
+
+}
