Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.
OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR
A White Paper prepared by Raastech
Author
Ahmed Aboulnaga
Copyright...
OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR
Raastech White Paper  2 / 9
OVERVIEW OF THE PIP AUDITOR
This paper...
OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR
Raastech White Paper  3 / 9
What kind of reports does the PIP Audi...
OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR
Raastech White Paper  4 / 9
to provide different breakdowns of the...
OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR
Raastech White Paper  5 / 9
The next figure is by project/process....
OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR
Raastech White Paper  6 / 9
Where can you get the PIP Auditor?
For...
OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR
Raastech White Paper  7 / 9
/u01/aia/http-2.2.14/htdocs. This way,...
OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR
Raastech White Paper  8 / 9
--------------------
./pipaudit.sh -in...
OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR
Raastech White Paper  9 / 9
About Raastech:
Raastech specializes i...
Upcoming SlideShare
Loading in …5
×

Overview of the Oracle AIA Foundation Pack PIP Auditor (whitepaper)

89 views

Published on

September 2010

Published in: Technology
  • Be the first to comment

  • Be the first to like this

Overview of the Oracle AIA Foundation Pack PIP Auditor (whitepaper)

  1. 1. OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR A White Paper prepared by Raastech Author Ahmed Aboulnaga Copyright Raastech 2010
  2. 2. OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR Raastech White Paper  2 / 9 OVERVIEW OF THE PIP AUDITOR This paper provides an overview of the Oracle Application Integration Architecture (AIA) Process Integration Pack (PIP) Auditor, simply referred to as the AIA PIP Auditor. We describe what it is, how to use it, and whether this is something you should consider. This white paper assumes familiarity with AIA and PIPs. What development tools are delivered with the AIA Foundation Pack? The AIA Foundation Pack delivers several developer tools. The newest versions can always be downloaded from Metalink. These tools include:  PIP Auditor - Used to check if given BPEL and ESB projects follow the AIA methodology for coding conventions  PIP Diff - Used to determine the difference between one PIP audit report and another  PIP Shared Artifact Analyzer - Creates a list of artifacts that are shared between PIPs  Xman - XSL mapping analyzer  XSD Flattener - Used to flatten XML elements into a CSV format. Used primarily for documentation What is the PIP Auditor? The PIP Auditor is run against your BPEL and ESB code to check whether they follow the AIA methodology for coding conventions. The output is a static HTML report. Therefore, the results are a single snapshot of your code at the time it was run. The PIP Auditor can be run against Oracle out-of-the-box PIPs, against PIPs that you have customized, or against your custom code that follows AIA design and development guidelines. Thus, in some cases, you may want to run the report weekly to continously monitor your progress (or lack thereof) of coding compliancy. The PIP Auditor reports on compliancy to coding standards. The PIP Auditor also provides suggestions for fixes for each of the identified violations.
  3. 3. OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR Raastech White Paper  3 / 9 What kind of reports does the PIP Auditor generate? The PIP Auditor generates what is called a “Technical Compliance Report”, reporting code violations based on rules, priority, category, project, and test suite. This is a series of static HTML pages and a single XML file. The index.html page is the main page of the report, which all further pages can be accessed. This main page provides a summary of the final report, as shown in the figure below. The CodeBase_Audit.xml is a 5 to 10 MB XML file that contains the raw data that the HTML reports are based on. The output also includes numerous other HTML pages which exist under various subdirectories (e.g., Reports/Rules.html, Reports/TestResultCategory.html), all designed
  4. 4. OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR Raastech White Paper  4 / 9 to provide different breakdowns of the data. These subpages are all accessible from the main index.html page. By clicking on “Priority 1”, you can see a further breakdown. Here, 4 specific test cases were failed across several of the projects. By clicking on the test case, a detailed description of the test case is provided. For example, in the figure below, the EBFTargetNameSpacesCheck test checks that all target namespaces for EBF processes follow the standard pattern defined in the AIA naming standards guide. This is categorized as a Priority 1 violation.
  5. 5. OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR Raastech White Paper  5 / 9 The next figure is by project/process. As you can see here, the OrderCompletionNotificationOSMReqABCSImpl BPEL process has a total of 474 violations. If you click on the violation name, it will link you to the actual test case similar to the image immediately above.
  6. 6. OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR Raastech White Paper  6 / 9 Where can you get the PIP Auditor? For Oracle AIA Foundation Pack 2.4 or higher, it is located under $AIA_HOMEDeveloperToolsPIPAuditor, or you can download the AIA Developer Tools from Metalink. How do you set up your environment to run the PIP Auditor? Setting up the environment involves the following:  Download the AIA Developer Tools from Metalink  Install Java JDK/JRE 1.5.0_06 or higher  Extract DeveloperTools to some directory (e.g., /u01/aia/pipaudit)  Download XMLUnit 1.2 (http://sourceforge.net/projects/xmlunit/xmlunit-1.2-bin.zip) and extract xmlunit-1.2.jar to /u01/aia/pipaudit/DeveloperTools/lib Our directory structure was as follows: Here, the main directories include my source code (~/svn/code), the PIP Auditor files (~/pipaudit), and a local Apache server to host the final report (~/http-2.2.14). How do you run the PIP Auditor? Our code is maintained within multiple subdirectories under /u01/aia/svn/codebase. Per the command below, the PIP Auditor will parse all subdirectories and place the results under
  7. 7. OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR Raastech White Paper  7 / 9 /u01/aia/http-2.2.14/htdocs. This way, the HTML reports are easily accessible remotely via a web browser. export JAVA_HOME=<your Java home> export PATH=$JAVA_HOME/bin:$PATH export PIPAUDIT_HOME=/u01/aia/pipaudit/DeveloperTools cd $PIPAUDIT_HOME ./pipaudit.sh -inputDir /u01/aia/svn/codebase -outputDir /u01/aia/http-2.2.14/htdocs The pipaudit.sh generates a pipaudit.log file with standard logging. What other parameters can be used with pipaudit.sh? The syntax is as follows: ----------------------------------------------------------------------- Syntax for invoking the PIPAuditor Tool is : ------------------------------------------- Usage: -inputDir {PIPS_DIR} -outputDir {OUTPUT_DIR} -testSuite {TEST_SUITE_NAME} -------------------- Parameters : -------------------- -inputDir [REQUIRED] The directory which contains source of the PIP or ABCS, EBS,EBF, etc to be validated. -outputDir [REQUIRED] The directory where output files need to be generated. -testSuite [OPTIONAL] If not provided default testsuite name will taken from testsuite.xml. -testName [OPTIONAL] This will execute only the specified test. -inputMetaFile [OPTIONAL] The MetaFile which lists all the services used for the PIP. Same as the GenerateScriptInput.xml used in BIG tool. -inputMetaFile ALL would iterate through the inputDir and generate reports for all PIPS where GenerateScriptInput.xml is found. -version [OPTIONAL] Displays the version of the tool. -------------------- Example:
  8. 8. OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR Raastech White Paper  8 / 9 -------------------- ./pipaudit.sh -inputDir /home/demo -outputDir /home/pipaudit -testSuite ManualAudit Please note that if you use the -testSuite ManualAudit parameter, Xman (another AIA Developer Tool) will be run. Does the PIP Auditor provide any true value? If you are extending or customizing PIPs, then you probably want to run the PIP Auditor and address all Priority 1 violations. If you are developing custom code following the AIA development standards, then in my opinion, running the PIP Auditor is optional, as it is rare that you'll be following the coding standards 100%. If you are not running the AIA Foundation Pack or not developing code that follows the AIA development methodology, then the PIP Auditor does not benefit you.
  9. 9. OVERVIEW OF THE ORACLE AIA FOUNDATION PACK PIP AUDITOR Raastech White Paper  9 / 9 About Raastech: Raastech specializes in information technology development and systems integration. Founded in 2009, Raastech provides management consulting, systems development, and integration to both federal agencies and commercial organizations. We provide value to our clients by being innovative and dependable partners in achieving their objectives. For more information, please visit http://www.raastech.com. About the Author: Ahmed Aboulnaga is a Technical Director at Raastech and has extensive experience in Oracle Fusion Middleware. He has been involved in the architecting and implementation of large scale systems involving middleware technologies such as Oracle SOA Suite, Oracle Application Integration Architecture, Oracle Data Integrator, Oracle Integration B2B, Oracle Identity Management, and numerous other Oracle middleware technologies. Raastech White Paper: Overview of the Oracle AIA Foundation Pack PIP Auditor September 2010 Raastech Headquarters: 2201 Cooperative Way, Suite 600 Herndon, VA 20171 www.raastech.com Copyright © 2010 Raastech, Inc. All rights reserved.

×