db-jdo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Jdo Wiki] Trivial Update of "TestingAndBuilding" by RichardSchilling
Date Fri, 12 Sep 2008 17:52:35 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Jdo Wiki" for change notification.

The following page has been changed by RichardSchilling:
http://wiki.apache.org/jdo/TestingAndBuilding

------------------------------------------------------------------------------
  
  == Assumptions ==
  
- I make a few assumptions that you should know about: 
+ I make a few assumptions that you should know about:
  
-  1. You've already checked out or downloaded the JDO source code.  Get it at [http://db.apache.org/jdo/svn.html].

+  1. You've already checked out or downloaded the JDO source code.  Get it at [http://db.apache.org/jdo/svn.html].
   2. You have your build tools installed.  You'll need Ant (the latest version is fine),
and Maven 1.1 (and '''NOT''' Maven 2).  [http://ant.apache.org/ get Ant Here].  [http://archive.apache.org/dist/maven/binaries/maven-1.1.exe
get Maven 1.1 here].
   3. You have successfully built the JDO code without your modifications first, and then
with your modifications.
   2. You have built a JUnit test before.  So, get used to JUnit if you haven't already. 
See [http://www.junit.org/ The JUnit Website] for more download.
@@ -17, +17 @@

  
  == Steps In Adding A New Test To the JDO Source Tree ==
  
- You've checked out the latest version of the JDO source code from the SVN repository (or
downloaded it), and have made modifications which you have successfully built using Maven
command line tools.  Your work isn't done yet!  Now you need to build a test to be certain
your change works.  This is as important as making the change itself, and a requirement of
the JDO project to get your changes accepted.  
+ You've checked out the latest version of the JDO source code from the SVN repository (or
downloaded it), and have made modifications which you have successfully built using Maven
command line tools.  Your work isn't done yet!  Now you need to build a test to be certain
your change works.  This is as important as making the change itself, and a requirement of
the JDO project to get your changes accepted.
  
  The following steps, which are discussed below, are what you'll be doing to set up and execute
a successful JDO test:
  
   1. Familiarize yourself with the test environment
   2. Write your test code.
   3. Set up configuration files.
-  4. Run your test. 
+  4. Run your test.
-  5. Examine the output of your test. 
+  5. Examine the output of your test.
  
  
  === 1. Familiarize yourself with the test environment ===
  
  
- You're going to save yourself a lot of time if you take a few moments to examine the directory
structure associated with the test code.  Actually, I just lied.  You're going to take more
than a few moments - you going take as much time as you need to visit each directory in the
test environment and get familiar with the files and their reasons for being there.  Give
yourself a day or two to go through all that.  And, as much as it sounds like you're getting
lazy, don't just rely on your command line tools and text editors to explore the JDO code
base.  You should use your favorite IDE just to cruise around the directory tree and familiarize
yourself with what you see.  
+ You're going to save yourself a lot of time if you take a few moments to examine the directory
structure associated with the test code.  Actually, I just lied.  You're going to take more
than a few moments - you going take as much time as you need to visit each directory in the
test environment and get familiar with the files and their reasons for being there.  Give
yourself a day or two to go through all that.  And, as much as it sounds like you're getting
lazy, don't just rely on your command line tools and text editors to explore the JDO code
base.  You should use your favorite IDE just to cruise around the directory tree and familiarize
yourself with what you see.
  
  
- My preferred way of working code on a project is to just use the lowest common denominator
of tools to get the job done.  This usually means the VI editor for writing code, and build
tools (e.g. compilers and repository management tools) that can be run from a simple UNIX
command line.  Keeping things simple like this means you don't need more than that to get
your work done, and quite frankly, it's a much more efficient way to work because you don't
have to mess around with windowing GUIs, IDEs and the like.  And, you get the added benefit
of having your working build environment be identical to the production build environment
(which runs nightly in batch on a different box).
+ My preferred way of working code on a project is to just use the lowest common denominator
of tools to get the job done.  This usually means the VI editor for writing code, and build
tools (e.g. compilers and repository management tools) that can be run from a simple UNIX
command line.  Keeping things simple like this means you don't need more than that to get
your work done, and quite frankly, it's a much more efficient way to work because you don't
have to mess around with windowing GUIs, IDEs and the like.  And, you get the added benefit
of having your working build environment be identical to the production build environment
(which runs nightly in batch on a different box).  But, there are exceptions where using an
IDE can help you learn what you need to learn about a project as quickly as possible.  Working
the JDO code is one such exception.  There are a lot of files in the JDO code base, and it's
helpful to have the IDE interpret the project's files so it can lay thi
 ngs out graphically.
- 
- 
- But, there are exceptions where using an IDE can help you learn what you need to learn about
a project as quickly as possible.  Working the JDO code is one such exception.  There are
a lot of files in the JDO code base, and it's helpful to have the IDE interpret the project
files and build scripts for you so it can lay things out graphically.  
  
  
  So, that's what we'll do in the first step.  I'll walk you through the code base as it can
be seen from the Netbeans IDE.
@@ -56, +53 @@

  === 3. Set up configuration files. ===
  
  More coming soon ...
-     
+ 
  === 4. Run your test. ===
  
  More coming soon ...

Mime
View raw message