/*******************************************************************************
* Copyright (c) 2011, 2015 Oracle and/or its affiliates. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
* which accompanies this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* Contributors:
* David McCann - July 2013 - Initial Implementation
******************************************************************************/
package org.eclipse.persistence.tools.metadata.generation.test.cursortype;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.DATABASE_DDL_CREATE_KEY;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.DATABASE_DDL_DEBUG_KEY;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.DATABASE_DDL_DROP_KEY;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.DATABASE_USERNAME_KEY;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.DEFAULT_DATABASE_DDL_CREATE;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.DEFAULT_DATABASE_DDL_DEBUG;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.DEFAULT_DATABASE_DDL_DROP;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.DEFAULT_DATABASE_USERNAME;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.DEFAULT_PACKAGE_NAME;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.comparer;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.conn;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.databasePlatform;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.documentToString;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.removeEmptyTextNodes;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.runDdl;
import static org.eclipse.persistence.tools.metadata.generation.test.AllTests.xmlParser;
//javase imports
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.ByteArrayOutputStream;
import java.io.StringReader;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings;
import org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappingsWriter;
import org.eclipse.persistence.tools.metadata.generation.JPAMetadataGenerator;
import org.eclipse.persistence.tools.metadata.generation.test.AllTests;
import org.eclipse.persistence.tools.oracleddl.metadata.PLSQLPackageType;
import org.eclipse.persistence.tools.oracleddl.metadata.ProcedureType;
import org.eclipse.persistence.tools.oracleddl.parser.ParseException;
import org.eclipse.persistence.tools.oracleddl.util.DatabaseTypeBuilder;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;
import org.w3c.dom.Document;
/**
* Tests metadata generation from a PLSQLCollectionType.
*
*/
public class CursorTypeTestSuite {
static final String CREATE_EMPTABLE =
"CREATE TABLE EMPTABLE (" +
"\nEMPNO DECIMAL(4,0) NOT NULL," +
"\nENAME VARCHAR(10)," +
"\nHIREDATE DATE," +
"\nPRIMARY KEY (EMPNO)" +
"\n)";
static final String CREATE_CURSORTYPE_PACKAGE =
"CREATE OR REPLACE PACKAGE CURSORTYPE AS" +
"\nTYPE WEAKLY_TYPED_REF_CURSOR IS REF CURSOR;" +
"\nPROCEDURE GET_EMP(EMP_NAME EMPTABLE.ENAME%TYPE, EMP OUT WEAKLY_TYPED_REF_CURSOR);" +
"\nFUNCTION GET_EMP_FUNC(EMP_NAME VARCHAR) RETURN WEAKLY_TYPED_REF_CURSOR;" +
"\nEND CURSORTYPE;";
static final String DROP_CURSORTYPE_PACKAGE = "DROP PACKAGE CURSORTYPE";
static final String DROP_EMPTABLE = "DROP TABLE EMPTABLE";
static boolean ddlCreate = false;
static boolean ddlDrop = false;
static boolean ddlDebug = false;
@SuppressWarnings("rawtypes")
static List dbProcedures;
static DatabaseTypeBuilder dbTypeBuilder;
@SuppressWarnings({ "rawtypes", "unchecked" })
@BeforeClass
public static void setUp() throws ClassNotFoundException, SQLException {
AllTests.setUp();
String ddlCreateProp = System.getProperty(DATABASE_DDL_CREATE_KEY, DEFAULT_DATABASE_DDL_CREATE);
if ("true".equalsIgnoreCase(ddlCreateProp)) {
ddlCreate = true;
}
String ddlDropProp = System.getProperty(DATABASE_DDL_DROP_KEY, DEFAULT_DATABASE_DDL_DROP);
if ("true".equalsIgnoreCase(ddlDropProp)) {
ddlDrop = true;
}
String ddlDebugProp = System.getProperty(DATABASE_DDL_DEBUG_KEY, DEFAULT_DATABASE_DDL_DEBUG);
if ("true".equalsIgnoreCase(ddlDebugProp)) {
ddlDebug = true;
}
if (ddlCreate) {
runDdl(conn, CREATE_EMPTABLE, ddlDebug);
runDdl(conn, CREATE_CURSORTYPE_PACKAGE, ddlDebug);
}
String schema = System.getProperty(DATABASE_USERNAME_KEY, DEFAULT_DATABASE_USERNAME);
List<String> procedurePatterns = new ArrayList<String>();
procedurePatterns.add("GET_EMP");
procedurePatterns.add("GET_EMP_FUNC");
// use DatabaseTypeBuilder to generate a list of PackageTypes
dbTypeBuilder = new DatabaseTypeBuilder();
dbProcedures = new ArrayList();
try {
// process the package
List<PLSQLPackageType> packages = dbTypeBuilder.buildPackages(conn, schema, "CURSORTYPE");
for (PLSQLPackageType pkgType : packages) {
// now get the desired procedures/functions from the processed package
for (ProcedureType procType : pkgType.getProcedures()) {
if (procedurePatterns.contains(procType.getProcedureName())) {
dbProcedures.add(procType);
}
}
}
} catch (ParseException e) {
e.printStackTrace();
}
}
@AfterClass
public static void tearDown() {
if (ddlDrop) {
runDdl(conn, DROP_CURSORTYPE_PACKAGE, ddlDebug);
runDdl(conn, DROP_EMPTABLE, ddlDebug);
}
}
@Test
@SuppressWarnings({ "unchecked" })
public void testJPACursorMetadata() {
if (dbProcedures == null || dbProcedures.isEmpty()) {
fail("No types were generated.");
}
XMLEntityMappings mappings = null;
try {
JPAMetadataGenerator gen = new JPAMetadataGenerator(DEFAULT_PACKAGE_NAME, databasePlatform);
mappings = gen.generateXmlEntityMappings(dbProcedures);
} catch (Exception x) {
fail("An unexpected exception occurred: " + x.getMessage());
}
if (mappings == null) {
fail("No JPA metadata was generated");
}
ByteArrayOutputStream metadata = new ByteArrayOutputStream();
XMLEntityMappingsWriter.write(mappings, metadata);
Document testDoc = xmlParser.parse(new StringReader(metadata.toString()));
removeEmptyTextNodes(testDoc);
Document controlDoc = xmlParser.parse(new StringReader(cursortypemetadata));
removeEmptyTextNodes(controlDoc);
assertTrue("Metadata comparison failed. Expected:\n" + documentToString(controlDoc) + "\nActual\n" + documentToString(testDoc), comparer.isNodeEqual(controlDoc, testDoc));
}
static final String cursortypemetadata =
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
"<orm:entity-mappings xsi:schemaLocation=\"http://www.eclipse.org/eclipselink/xsds/persistence/orm org/eclipse/persistence/jpa/eclipselink_orm_2_5.xsd\"" +
" xmlns:orm=\"http://www.eclipse.org/eclipselink/xsds/persistence/orm\" " +
" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n" +
" <orm:named-plsql-stored-procedure-query name=\"GET_EMP\" procedure-name=\"CURSORTYPE.GET_EMP\">\n" +
" <orm:parameter direction=\"IN\" name=\"EMP_NAME\" database-type=\"VARCHAR_TYPE\"/>\n" +
" <orm:parameter direction=\"OUT_CURSOR\" name=\"EMP\" database-type=\"CURSORTYPE.WEAKLY_TYPED_REF_CURSOR\"/>\n" +
" </orm:named-plsql-stored-procedure-query>\n" +
" <orm:named-plsql-stored-function-query name=\"GET_EMP_FUNC\" function-name=\"CURSORTYPE.GET_EMP_FUNC\">\n" +
" <orm:parameter direction=\"IN\" name=\"EMP_NAME\" database-type=\"VARCHAR_TYPE\"/>\n" +
" <orm:return-parameter direction=\"OUT_CURSOR\" name=\"CURSOR\" database-type=\"CURSORTYPE.WEAKLY_TYPED_REF_CURSOR\"/>\n" +
" </orm:named-plsql-stored-function-query>\n" +
"</orm:entity-mappings>";
}