Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Panel

Anchor
overview
overview

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:

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

{anchor:The

Panel

Anchor
The mit-release-plugin-parent Maven Project Reconfiguration
The

Wiki Markup
mit-release-plugin-parent

Maven

Project

Reconfiguration

} h3.

Section

1

-

Step

1:

The

mit-release-plugin-parent

Maven

Project

Reconfiguration

#

  1. Check-out
  1. the
  1. maven
  1. project
  1. for
  1. the
  1. mit-release-plugin.
  The SVN repository is: {code}
  1.   The SVN repository is:
    Code Block
    
    svn+ssh://svn.mit.edu/sais-sis-common/maven/plugins/mit-release-plugin/trunk
    
{code} # Open the
  1. Open the mit-release-plugin
  1. maven
  1. project
  1. in
  1. your
  1. IDE.
\\ ## Open the

    1. Open the pom.xml's
    1. for
    1. each
    1. of
    1. the
    1. following
    1. projects:
##*
      • mit-release-plugin-parent
##*
      • mit-release-plugin
##*
      • mit-release-plugin-common
##*
      • mit-release-plugin-integration-tests
##
    1. In
    1. each
    1. of
    1. the
    1. pom.xml's
    1. for
    1. the
    1. above,
    1. remove
    1. all
    1. occurances
    1. of
*
    1. -SNAPSHOT
*
    1. from
    1. the
    1. <version>
    1. tags.

    1. There
    1. are
    1. a
    1. total
    1. of
    1. 7
    1. occurances
    1. that
    1. have
    1. to
    1. be
    1. 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.

h4. {color:green}The

The mit-release-plugin-parent

Maven

Project

Reconfiguration

is

now

complete.

{color}

{anchor:The

Panel

Anchor
The sais-moves-web Maven Project Reconfiguration
The

Wiki Markup
sais-moves-web

Maven

Project

Reconfiguration

} h3.

Section

1

-

Step

2:

The

sais-moves-web

Maven

Project

Reconfiguration

#

  1. Check-out
  1. the
  1. maven
  1. project
  1. for
  1. the
  1. sais-moves-web.
&nbsp;&nbsp;The SVN repository is: {code}
  1.   The SVN repository is:
    Code Block
    
    svn+ssh://svn.mit.edu/sais-sis-common/sais-moves-web/trunk
    
{code} # Open the
  1. Open the sais-moves-web
  1. maven
  1. project
  1. in
  1. your
  1. IDE.
##
    1. Open
    1. the
    1. sais-moves-web
    1. project
    1. pom.xml
    1. for
    1. editing.
##
    1. In
    1. the
    1. <dependencies>
    1. section,
    1. add
    1. the
    1. following
    1. dependency:
{
    1. Code Block
}
    1. 
      <dependency>
          <groupId>edu.mit.maven.plugins</groupId>
          <artifactId>mit-release-plugin</artifactId>
          <version>2.0.21</version>
      </dependency>
      
{code} {color:red}Change the
    1. Change the <version>,
    1. in
    1. the
    1. above,
    1. to
    1. the
    1. mit-release-plugin
    1. version
    1. that
    1. you
    1. selected
    1. in
    1. Section
    1. 1.
{color} {color:green}The above dependency makes the source code for the

    1. The above dependency makes the source code for the mit-release-plugin
    1. available
    1. to
    1. the
    1. IDE's
    1. debugger.
{color} ## In the <dependencies>
    1. In the <dependencies> section,
    1. find
    1. the
    1. following
    1. dependency:
{
    1. Code Block
}
    1. 
      <dependency>
          <groupId>edu.mit.maven.plugins</groupId>
          <artifactId>mit-release-plugin-common</artifactId>
          <version>[0.0.0,999.999.999)</version>
      </dependency>
      
{code} {color:red}Change the
    1. Change the <version>,
    1. in
    1. the
    1. above,
    1. to
    1. the
    1. mit-release-plugin
    1. version
    1. that
    1. you
    1. selected
    1. in
    1. Section
    1. 1.
{color} ## In the <plugins> section of the
    1. In the <plugins> section of the pom.xml,
    1. find
    1. the
    1. following
    1. plugin
    1. with
    1. the
    1. following
    1. groupId
    1. and
    1. artifactId:
{color:green}NOTE&nbsp;&nbsp;The version number may be differ from

    1. NOTE  The version number may be differ from 2.0.21.
{color} {code}
    1. Code Block
      
      <plugin>
          <groupId>edu.mit.maven.plugins</groupId>
          <artifactId>mit-release-plugin</artifactId>
          <version>2.0.21</version>
          .
          .
      </plugin>
      
{code} {color:red}Change the <version> for the above plugin to the
    1. Change the <version> for the above plugin to the mit-release-plugin
    1. version
    1. that
    1. you
    1. selected
    1. in
    1. Section
    1. 1.
{color} ## Open the
    1. Open the log4j.xml
    1. (located
    1. in
    1. the
    1. resources
    1. folder)
    1. for
    1. editing
    1. and
    1. add
    1. the
    1. following
    1. <logger>:
{
    1. Code Block
}
    1. 
      <logger name="edu.mit.moves.shell.logging">
          <level value="INFO" />
      </logger>
      
{code} {tip:title=OPTIONAL} If you are only interested in debugging the
    1. Tip
      titleOPTIONAL

      If you are only interested in debugging the mit-release-plugin,

    1. you

    1. might

    1. want

    1. to

    1. changed

    1. the

    1. <level>

    1. of

    1. all

    1. the

    1. other

    1. <logger>s

    1. to

    1. FATAL.

&nbsp;&nbsp;If you do
    1.   If you do this,

    1. all

    1. output

    1. to

    1. the

    1. system

    1. console

    1. will

    1. be

    1. surpress

    1. except

    1. for

    1. the

    1. output

    1. from

    1. the

    1. mit-release-plugin.

{tip} When you are satisfied that everything is correct, save the changes that you made. h4. {color:green}The sais

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

The sais-moves-web

Maven

Project

Reconfiguration

is

now

complete.

{color}

{anchor:The Moves Development Environment Setup} h3. Section 1 - Step 3: The Moves Development Environment Setup # 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.&nbsp;&nbsp;They are *NOT* to be deployed to the development, test or production servers. {warning} ## Download and install the *
  1. Download the following files:
Panel

Anchor
The Moves Development Environment Setup
The Moves Development Environment Setup

Section 1 - Step 3: The Moves Development Environment Setup

Wiki Markup
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
    1. sais-moves-web.properties
*
    1. file
    1. (
[
    1. right
    1. click
    1. on
    1. this
    1. link
| ^sais-moves-web.properties]
    1. then
    1. select
*
    1. Save
    1. target/link
    1. as...
*.&nbsp;&nbsp;Navigate to the *$\
    1. .  Navigate to the ${user.home}
*
    1. directory
    1. and
    1. click
*
    1. Save
*
    1. )
##
    1. Download
    1. and
    1. install
    1. the
*
    1. sais-moves-web-build.properties
*
    1. file
    1. (
[
    1. right
    1. click
    1. on
    1. this
    1. link
| ^sais-moves-web-build.properties]
    1. then
    1. select
*
    1. Save
    1. target/link
    1. as...
*.&nbsp;&nbsp;Navigate to the *$\
    1. .  Navigate to the ${user.home}
*
    1. directory
    1. and
    1. click
*
    1. Save
*) \\ ## Open the
    1. )
    2. Open the sais-moves-web-build.properties
    1. file
    1. for
    1. editing
    1. and
    1. change
    1. the
    1. following
    1. properties:
\\ ##* *

      • mit.maven.release.plugin.version=2.0.21
*&nbsp;&nbsp;Change the version number
      •   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
*&nbsp;&nbsp;Change the hostname
      •   Change the hostname (esvm-1xx.mit.edu)
      • to
      • your
      • vm's
      • hostname.
\\ \\ # Configure your moves build directories \\ ## Create the following directories: \\ ##* *


  1. 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 {color:red}cannot{color} be created using Windows Explorer.&nbsp;&nbsp;To create the .m2 directory, you must open a cmd window, cd to the
      • 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.

{note} ## Open a *cmd window* and *cd* to the *
    1. Open a cmd window and cd to the C:\tmp\movesbuild\build\sais-common-conf\.m2
*
    1. directory.
&nbsp;&nbsp;Execute the following command: {code}
    1.   Execute the following command:
      Code Block
      
      linkd repository c:\Users\esuser\.m2\repository
      
{code}
    1. The
    1. above
    1. command
    1. will
    1. link
    1. your
    1. local
    1. maven
    1. repository
    1. to
    1. the
    1. directory
    1. C:\tmp\movesbuild\build\sais-common-conf\.m2\repository.
{
    1. Warning
}
    1. Do

    1. not

    1. delete

    1. or

    1. rename

    1. the

    1. repository

    1. directory.

&nbsp;&nbsp;Deleting or Renaming the repository directory will delete your local maven repository.&nbsp;&nbsp;Unlink the repository directory before you delete or rename. {warning} {tip} You can unlink the repostory directory with the following command: {code}
    1.   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
      
{code}
    1. You

    1. must

    1. be

    1. in

    1. the

*
    1. .m2

    1. directory

*
    1. when

    1. you

    1. execute

    1. the

    1. above

    1. command.

{tip} ## Download and install the *
    1. Download and install the settings.xml
*
    1. (
[
    1. right
    1. click
    1. on
    1. this
    1. link
| Install Maven^settings.xml]
    1. then
    1. select
*
    1. Save
    1. target/link
    1. as...
*.&nbsp;&nbsp;Navigate to the *.m2* directory
    1. .  Navigate to the .m2 directory you've
    1. just
    1. created
    1. and
    1. click
*
    1. Save
*) \\ \\ Open the *
    1. )

      Open the settings.xml
*
    1. for
    1. editing
    1. and
    1. change
    1. the
    1. following:
\\ \\ ##* Change the property value for *


      • Change the property value for <oc4j.j2eeHome>
*
      • to:
{
      • Code Block
}
      • 
        /oracle-oc4j-10.1.3.5.0-server/j2ee/home
        
{code} ##* Change the property value for *
      • Change the property value for <oc4j.password>
*
      • to:
{
      • Code Block
}
      • 
        oc4jadmin
        
{code} ## In a cmd window, *cd* to the *
    1. In a cmd window, cd to the C:\tmp\movesbuild\build\sais-common-conf\servers
*
    1. directory.
&nbsp;&nbsp;Execute the following command: {code}
    1.   Execute the following command:
      Code Block
      
      linkd oc4j c:\oracle-oc4j-10.1.3.5.0-server
      
{code}
    1. The
    1. above
    1. command
    1. will
    1. link
    1. your
    1. local
    1. oracle
    1. server
    1. to
    1. the
    1. directory
    1. C:\tmp\movesbuild\build\sais-common-conf\servers\oc4j.
{
    1. Warning
}
    1. Do

    1. not

    1. delete

    1. or

    1. rename

    1. the

    1. oc4j

    1. directory.

&nbsp;&nbsp;Deleting or Renaming the oc4j directory will delete your local oracle server.&nbsp;&nbsp;Unlink the oc4j directory before you delete or rename. {warning} {tip} You can unlink the oc4j directory with the following command: {code}
    1.   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
      
{code}
    1. You

    1. must

    1. be

    1. in

    1. the

*
    1. servers

    1. directory

*
    1. when

    1. you

    1. execute

    1. the

    1. above

    1. command.

{tip} # Configure your moves ui directories \\ ## Create the following directories: \\ ##* *
  1. 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 {color:red}cannot{color} be created using Windows Explorer.&nbsp;&nbsp;To create the .m2 directory, you must open a cmd window, cd to the
      • 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.

{note} ## Open a *cmd window* and *cd* to the *
    1. Open a cmd window and cd to the C:\tmp\movesbuild\ui\sais-common-conf\.m2
*
    1. directory.
&nbsp;&nbsp;Execute the following command: {code}
    1.   Execute the following command:
      Code Block
      
      linkd repository c:\Users\esuser\.m2\repository
      
{code}
    1. The
    1. above
    1. command
    1. will
    1. link
    1. your
    1. local
    1. maven
    1. repository
    1. to
    1. the
    1. directory
    1. C:\tmp\movesbuild\ui\sais-common-conf\.m2\repository.
{
    1. Warning
}
    1. Do

    1. not

    1. delete

    1. or

    1. rename

    1. the

    1. repository

    1. directory.

&nbsp;&nbsp;Deleting or Renaming the repository directory will delete your local maven repository.&nbsp;&nbsp;Unlink the repository directory before you delete or rename. {warning} {tip} You can unlink the repostory directory with the following command: {code}
    1.   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
      
{code}
    1. You

    1. must

    1. be

    1. in

    1. the

*
    1. .m2

    1. directory

*
    1. when

    1. you

    1. execute

    1. the

    1. above

    1. command.

{tip} ## Download and install the *
    1. Download and install the settings.xml
*
    1. (
[
    1. right
    1. click
    1. on
    1. this
    1. link
| Install Maven^settings.xml]
    1. then
    1. select
*
    1. Save
    1. target/link
    1. as...
*.&nbsp;&nbsp;Navigate to the *.m2* directory
    1. .  Navigate to the .m2 directory you've
    1. just
    1. created
    1. and
    1. click
*
    1. Save
*) \\ \\ Open the *
    1. )

      Open the settings.xml
*
    1. for
    1. editing
    1. and
    1. change
    1. the
    1. following:
\\ \\ ##* Change the property value for *


      • Change the property value for <oc4j.j2eeHome>
*
      • to:
{
      • Code Block
}
      • 
        /oracle-oc4j-10.1.3.5.0-server/j2ee/home
        
{code} ##* Change the property value for *<oc4j.password>* to: {code} oc4jadmin {code} ## In a cmd window, *cd* to the *
      • Change the property value for <oc4j.password> to:
        Code Block
        
        oc4jadmin
        
    1. In a cmd window, cd to the C:\tmp\movesbuild\ui\sais-common-conf\servers
*
    1. directory.
&nbsp;&nbsp;Execute the following command: {code}
    1.   Execute the following command:
      Code Block
      
      linkd oc4j c:\oracle-oc4j-10.1.3.5.0-server
      
{code}
    1. The
    1. above
    1. command
    1. will
    1. link
    1. your
    1. local
    1. oracle
    1. server
    1. to
    1. the
    1. directory
    1. C:\tmp\movesbuild\ui\sais-common-conf\servers\oc4j.
{
    1. Warning
}
    1. Do

    1. not

    1. delete

    1. or

    1. rename

    1. the

    1. oc4j

    1. directory.

&nbsp;&nbsp;Deleting or Renaming the oc4j directory will delete your local oracle server.&nbsp;&nbsp;Unlink the oc4j directory before you delete or rename. {warning} {tip} You can unlink the oc4j directory with the following command: {code}
    1.   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
      
{code}
    1. You

    1. must

    1. be

    1. in

    1. the

*
    1. servers

    1. directory

*
    1. when

    1. you

    1. execute

    1. the

    1. above

    1. command.

{tip} h4. {color:green}The Moves Development Environment Setup is now complete.{color} h4. {color:green}Section 1 is now complete.{color}

The Moves Development Environment Setup is now complete.

Section 1 is now complete.

Panel

Anchor
Setting mit-release-plugin debugging break points
Setting mit-release-plugin debugging break points

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.

...