This site is the archived OWASP Foundation Wiki and is no longer accepting Account Requests.
To view the new OWASP Foundation website, please visit https://owasp.org

Difference between revisions of "ESAPI-Building"

From OWASP
Jump to: navigation, search
(→‎Subversion Setup)
m (Change references from using svn and Google Code to git and GitHub.)
 
(81 intermediate revisions by 8 users not shown)
Line 1: Line 1:
−
==Eclipse Setup==
+
ESAPI is easy to build yourself using [https://git-scm.com/ Git] and [http://maven.apache.org/ Maven]. Ensure that you are using UTF-8 for all source code.
  
−
* Get [http://www.eclipse.org/europa/ Europa]
+
  $ git clone https://github.com/ESAPI/esapi-java-legacy.git    # This will clone the 'develop' branch.
−
* Get [http://subclipse.tigris.org/download.html SVN plugin]
+
  $ cd esapi-java-legacy
−
* Get other plugins
+
  $ mvn -Dmaven.test.skip=true package  # Build ESAPI
  
−
==Subversion Setup==
+
Maven will generate a "target" directory that contains the ESAPI jar file.
  
−
Follow the instructions [http://code.google.com/p/owasp-esapi-java/source/checkout here].  Unless you have been added to the ESAPI project as a contributor, please use the bottom SVN checkout link on the Google Code page(non-SSL).
+
To generate project reports use:
  
−
If you are using subclipse, as recommended, open Eclipse and:
+
  $ mvn site
−
* Click ''File'' -> ''New'' -> ''Other....''.
 
−
* From the ''SVN Folder'' select '"Checkout Projects from SVN'' (this option will only be available if you have a SVN plugin installed) and hit ''Next >''.
 
−
* Click the ''Create a new repository location'' radio button.
 
−
* If you are not listed as a project contributor, insert ''http://owasp-esapi-java.googlecode.com/svn/trunk/'' as the URL.  If you are listed as a project contributor, check the Google Code page for the URL to use.
 
−
* Once the directory structure appears in the window, click the URL at the top to download everything.  Then hit ''Next >''
 
−
* Select your desired project options.  For most people, the default options should be fine. When finished, click ''Next >''.
 
−
* Select your desired workspace options, then click ''Finish''.  The latest ESAPI source files will then be downloaded to your workspace.  This may take a few minutes.
 
  
−
==Project Setup==
+
To generate documentation use:
  
−
* Preferences -> Compiler
+
  $ mvn javadoc:jar
−
* Add JDK 1.4 as an installed JRE
 
−
* Set Java 1.4 compliance in project
 
  
−
==Building==
 
−
 
−
* TODO
 
−
 
−
==Running Test Cases==
 
−
 
−
* Select test/org/owasp/esapi/AllTests.java
 
−
* Right click and Run As... Open Run Dialog
 
−
* Choose JUnit
 
−
* Select Arguments and enter a VM argument
 
−
** -Dorg.owasp.esapi.resources="<path to your esapi project>/test/testresources"
 
−
* run tests and verify that they all pass
 
−
 
−
 
−
 
−
==Running Test App==
 
−
 
−
TODO
 
  
 
__NOTOC__
 
__NOTOC__
  
 
[[Category:OWASP Enterprise Security API]]
 
[[Category:OWASP Enterprise Security API]]

Latest revision as of 05:30, 9 February 2016

ESAPI is easy to build yourself using Git and Maven. Ensure that you are using UTF-8 for all source code. 

 $ git clone https://github.com/ESAPI/esapi-java-legacy.git    # This will clone the 'develop' branch.
 $ cd esapi-java-legacy
 $ mvn -Dmaven.test.skip=true package  # Build ESAPI

Maven will generate a "target" directory that contains the ESAPI jar file.

To generate project reports use: 

 $ mvn site

To generate documentation use: 

 $ mvn javadoc:jar
Retrieved from "https://wiki.owasp.org/index.php?title=ESAPI-Building&oldid=208376"