Virtual Machine Setup

The OpenESPI Development Virtual Machine is a Linux Ubuntu desktop environment that may be used to jumpstart your OpenESPI development efforts. Further background on the VM may be found HERE.

The following instructions should be followed to configure the ECLIPSE development IDE, the GIT respository management, and to clone the initial development code to your VM environment.

VM Configuration Instructions

1. Download VM
1. NOTE: The Virtual Machine is downloaded as a compressed file. On Windows 7, we have noticed that WinZip is required to de-compress the VM folder!
2. Run VM (instructions on the download page) on your local machne:
3. When asked if VM was "copied" or "moved", select "copied"
4. login as user1 (the default but will say "Authorized User" in menu) with password: password

   ---

5. Simple Path to the Code: If you wish to simply download the current OpenESPI javaSpring codebase, you may:
1. start the Spring Tool Suite by double clicking on the STS shortcut icon on the Ubuntu desktop
2. Select the default workspace
3. Click on Open Desktop
4. within the project browser window, right click
5. select Import/Team/Team Project Set
6. Browse to find the ~/Desktop/projectSet.psf file
7. Click on Finish
8. The OpenESPI javaSpring code base will be imported into the STS
9. Upon Completion, select a Project/Clean from the STS menu bar
10. Upon Completion, select the DataCustodian package, right click, and select Run As/Run On Server
11. Select the default vFabric server, click Next
12. Add the ThirdParty package, and select Finish
13. You will be presented with the current management page for the DataCustodian

---

6. The path to code development: Do develop the code base, you must first make your own repository on Github by Forking the EnergyOS/OpenESPI respository, you must then edit the ~/Desktop/projectSet.psf file to request your forked respository and follow the directions of the "Simple Path to Code" above. Additionally you may:
7. setup github keys
1. If you have already configured your keys:
1. from a local VM terminal:
1. copy your keys to the /home/user1/.ssh
2. sudo chmod 600 id_rsa (assumes private key is id_rsa) to set permissions on private key
3. ssh –T git@github.com (to test keys and verify you connect to git securely)
2. If you have not made keys, Follow procedure defined at Github (start at step Next: Set Up SSH Keys)
3. Note: You might want to save these keys for use on other computers/platforms if desired
8. Make a fork of the https://github.com/energyos/OpenESPI repository on GitHub.com
1. Use firefox and go to: https://github.com/
2. login to GitHub using your github.com credentials {gitUserName : pw}
3. navigate to the https://github.com/energyos/OpenESPI repository
4. On GitHub, fork the master branch of the OpenESPI repository
9. Now Configure your local git repository: from a local VM Terminal, do git commands to configure the git workspace
1. git config --global user.name "Firstname Lastname"
2. git config --global user.email "your_email@youremail.com"
3. git config --global github.user {gitUserName}
4. git remote add upstream https://github.com/energyos/OpenESPI.git
5. cd ~
6. cd workspace
10. Finally, we must configure Eclipse by importing the projects from the Git repository:
1. Using your favorite Editor (vi and emacs are in the VM),create or edit the file projectSet.psf. Note that {gitUserName} is case sensitive!

     <?xml version="1.0" encoding="UTF-8"?>
     <psf version="2.0">
     <provider id="org.eclipse.egit.core.GitProvider">
     <project reference="1.0,https://github.com/{gitUserName}/OpenESPI.git,master,javaspring/DataCustodian"/>
     <project reference="1.0,https://github.com/{gitUserName}/OpenESPI.git,master,javaspring/ThirdParty"/>
     </provider>
     </psf>


2. Start and configure Eclipse
1. Run eclipse from VM shortcut in home/desktop folder (choose Workspace /home/user1/workspace)
2. Import the OpenESPI java projectSet you created above:
   1. File/Import
   2. select Team -> Team Project Set
   3. select Next
   4. select Browse and select projectSet.psf
   5. select Finish
3. Eclipse will now access Github and clone the repository to your local workspace
4. Allow time for workspace files to download and for indexes to be built -- watch bottom right status of Eclipse window
3. You will find, during the import of the project set, that ** compile errors** will be found. Following the completion of the Import, you should do a Project/Clean. This will rebuild the projects in the correct order and context!

---

You are now ready to go. Use the normal Eclipse commands on the relevant projects to begin your OpenESPI development experience. You will find further instruction about using the Eclipse IDE to build and run the OpenESPI JavaSpringsource implementation.

Further instructions on getting started may be found here.