Page History

Help is available by sending an email to csf-support@mit.edu
Have any suggestion on how improve this wiki?  Please give us your feedback at csf-support@mit.edu

The instruction contain on this page are designed to be implemented on a Educational Systems supplied VM.  All the software components that are needed have been preconfigured on the VM.

If you are using a workstation which is not a pre-configured Educational Systems VM, then you will probably need to install additional software on your workstation.

OVERVIEW

To setup the development environment for working with the mit-release-plugin for MOVES, there are 3 steps that must be completed.  These 3 steps are:

• Section 1 - Step 1: The mit-release-plugin-parent Maven Project Reconfiguration
  Reconfigure the POM.XML for the mit-release-plugin-parent and it's children.
  There is nothing new here and you should know how to do the above relative to the IDE that you are using.
• Section 1 - Step 2: The sais-moves-web Maven Project Reconfiguration
  Reconfigure the POM.XML for the sais-moves-web Maven project.
  Again, there is nothing new here and you should know how to do the above relative to the IDE that you are using.
• Section 1 - Step 3: The Moves Development Environment Setup
  This step explains how to setup the MOVES Development Environment.
  It explains how to obtain and configure the Moves properties files as well as how to construct and configure the directory structure that is used by Moves.

It should take you approximately 15 - 20 minutes to complete the 3 above steps.

• Section 2: Setting mit-release-plugin debugging break points
  This section is designed to assist the first time user in setting debugging break points.
• Section 3: Debugging the mit-release-plugin
  This section is designed to assist the first time user in debugging the mit-release-plugin.

Section 1 - Step 1: The mit-release-plugin-parent Maven Project Reconfiguration

1. Check-out the maven project for the mit-release-plugin.  The SVN repository is:

   Code Block
   svn+ssh://svn.mit.edu/sais-sis-common/maven/plugins/mit-release-plugin/trunk

2. Open the mit-release-plugin maven project in your IDE.
   
   1. Open the pom.xml's for each of the following projects:
      • mit-release-plugin-parent
      • mit-release-plugin
      • mit-release-plugin-common
      • mit-release-plugin-integration-tests
   2. In each of the pom.xml's for the above, remove all occurances of -SNAPSHOT from the <version> tags.
      There are a total of 7 occurances that have to be changed.
      
      • EXAMPLE: <version>2.0.21-SNAPSHOT</version> becomes <version>2.0.21</version>

When you are satisfied that everything is correct, save the changes that you made to the pom.xml's.

The mit-release-plugin-parent Maven Project Reconfiguration is now complete.

Section 1 - Step 2: The sais-moves-web Maven Project Reconfiguration

1. Check-out the maven project for the sais-moves-web.  The SVN repository is:

   Code Block
   svn+ssh://svn.mit.edu/sais-sis-common/sais-moves-web/trunk

2. Open the sais-moves-web maven project in your IDE.
   1. Open the sais-moves-web project pom.xml for editing.
   2. In the <dependencies> section, add the following dependency:

      Code Block
      <dependency> <groupId>edu.mit.maven.plugins</groupId> <artifactId>mit-release-plugin</artifactId> <version>2.0.21</version> </dependency>

      Change the <version>, in the above, to the mit-release-plugin version that you selected in Section 1.
      The above dependency makes the source code for the mit-release-plugin available to the IDE's debugger.
   3. In the <dependencies> section, find the following dependency:

      Code Block
      <dependency> <groupId>edu.mit.maven.plugins</groupId> <artifactId>mit-release-plugin-common</artifactId> <version>[0.0.0,999.999.999)</version> </dependency>

      Change the <version>, in the above, to the mit-release-plugin version that you selected in Section 1.
   4. In the <plugins> section of the pom.xml, find the following plugin with the following groupId and artifactId:
      NOTE  The version number may be differ from 2.0.21.

      Code Block
      <plugin> <groupId>edu.mit.maven.plugins</groupId> <artifactId>mit-release-plugin</artifactId> <version>2.0.21</version> . . </plugin>

      Change the <version> for the above plugin to the mit-release-plugin version that you selected in Section 1.
   5. Open the log4j.xml (located in the resources folder) for editing and add the following <logger>:

      Code Block
      <logger name="edu.mit.moves.shell.logging"> <level value="INFO" /> </logger>

      Tip
      title OPTIONAL
      If you are only interested in debugging the mit-release-plugin, you might want to changed the <level> of all the other <logger>s to FATAL.  If you do this, all output to the system console will be surpress except for the output from the mit-release-plugin.

When you are satisfied that everything is correct, save the changes that you made.

The sais-moves-web Maven Project Reconfiguration is now complete.

Section 1 - Step 3: The Moves Development Environment Setup

1. Download the following files:

   Warning
   The following 2 properties files are the be used solely and exclusively in the software development environment on an Educational Systems VM.  They are NOT to be deployed to the development, test or production servers.

   1. Download and install the sais-moves-web.properties file (right click on this link then select Save target/link as....  Navigate to the ${user.home} directory and click Save)
   2. Download and install the sais-moves-web-build.properties file (right click on this link then select Save target/link as....  Navigate to the ${user.home} directory and click Save)
      
   3. Open the sais-moves-web-build.properties file for editing and change the following properties:
      
      • mit.maven.release.plugin.version=2.0.21  Change the version number (2.0.21) to the mit-release-plugin version number that you selected in section 1.
      • maven.system.property.cargo.hostname=esvm-1xx.mit.edu  Change the hostname (esvm-1xx.mit.edu) to your vm's hostname.
        
        
2. Configure your moves build directories
   
   1. Create the following directories:
      
      • C:\tmp\movesbuild\build\sais-common-conf\.m2\repository
      • C:\tmp\movesbuild\build\sais-common-conf\servers\oc4j

        Note
        Please note that the .m2 directory cannot be created using Windows Explorer.  To create the .m2 directory, you must open a cmd window, cd to the sais-common-conf directory and use mkdir to create the .m2 directory.

   2. Open a cmd window and cd to the C:\tmp\movesbuild\build\sais-common-conf\.m2 directory.  Execute the following command:

      Code Block
      linkd repository c:\Users\esuser\.m2\repository

      The above command will link your local maven repository to the directory C:\tmp\movesbuild\build\sais-common-conf\.m2\repository.

      Warning
      Do not delete or rename the repository directory.  Deleting or Renaming the repository directory will delete your local maven repository.  Unlink the repository directory before you delete or rename.

      Tip
      You can unlink the repostory directory with the following command: Code Block linkd repository /D You must be in the .m2 directory when you execute the above command.

   3. Download and install the settings.xml (right click on this link then select Save target/link as....  Navigate to the .m2 directory you've just created and click Save)
      
      Open the settings.xml for editing and change the following:
      
      
      • Change the property value for <oc4j.j2eeHome> to:

        Code Block
        /oracle-oc4j-10.1.3.5.0-server/j2ee/home

      • Change the property value for <oc4j.password> to:

        Code Block
        oc4jadmin

   4. In a cmd window, cd to the C:\tmp\movesbuild\build\sais-common-conf\servers directory.  Execute the following command:

      Code Block
      linkd oc4j c:\oracle-oc4j-10.1.3.5.0-server

      The above command will link your local oracle server to the directory C:\tmp\movesbuild\build\sais-common-conf\servers\oc4j.

      Warning
      Do not delete or rename the oc4j directory.  Deleting or Renaming the oc4j directory will delete your local oracle server.  Unlink the oc4j directory before you delete or rename.

      Tip
      You can unlink the oc4j directory with the following command: Code Block linkd oc4j /D You must be in the servers directory when you execute the above command.

3. Configure your moves ui directories
   
   1. Create the following directories:
      
      • C:\tmp\movesbuild\ui\sais-common-conf\.m2\repository
      • C:\tmp\movesbuild\ui\sais-common-conf\servers\oc4j

        Note
        Please note that the .m2 directory cannot be created using Windows Explorer.  To create the .m2 directory, you must open a cmd window, cd to the sais-common-conf directory and use mkdir to create the .m2 directory.

   2. Open a cmd window and cd to the C:\tmp\movesbuild\ui\sais-common-conf\.m2 directory.  Execute the following command:

      Code Block
      linkd repository c:\Users\esuser\.m2\repository

      The above command will link your local maven repository to the directory C:\tmp\movesbuild\ui\sais-common-conf\.m2\repository.

      Warning
      Do not delete or rename the repository directory.  Deleting or Renaming the repository directory will delete your local maven repository.  Unlink the repository directory before you delete or rename.

      Tip
      You can unlink the repostory directory with the following command: Code Block linkd repository /D You must be in the .m2 directory when you execute the above command.

   3. Download and install the settings.xml (right click on this link then select Save target/link as....  Navigate to the .m2 directory you've just created and click Save)
      
      Open the settings.xml for editing and change the following:
      
      
      • Change the property value for <oc4j.j2eeHome> to:

        Code Block
        /oracle-oc4j-10.1.3.5.0-server/j2ee/home

      • Change the property value for <oc4j.password> to:

        Code Block
        oc4jadmin

   4. In a cmd window, cd to the C:\tmp\movesbuild\ui\sais-common-conf\servers directory.  Execute the following command:

      Code Block
      linkd oc4j c:\oracle-oc4j-10.1.3.5.0-server

      The above command will link your local oracle server to the directory C:\tmp\movesbuild\ui\sais-common-conf\servers\oc4j.

      Warning
      Do not delete or rename the oc4j directory.  Deleting or Renaming the oc4j directory will delete your local oracle server.  Unlink the oc4j directory before you delete or rename.

      Tip
      You can unlink the oc4j directory with the following command: Code Block linkd oc4j /D You must be in the servers directory when you execute the above command.

The Moves Development Environment Setup is now complete.

Section 1 is now complete.

Section 2: Setting mit-release-plugin debugging break points

1. Build and install mit-release-plugin-parent.
2. Build, install and deploy sais-moves-web to your oracle server.
3. Setting break points.
4. Attaching the IDE's debugger.

Section 3: Debugging the mit-release-plugin

1. Build and install mit-release-plugin-parent.
2. Build, install and deploy sais-moves-web to your oracle server.
3. Setting break points.
4. Attaching the IDE's debugger.