Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
OSEE/Developer Setup
Contents
Initial Setup
- Create a UserData Folder on your C: Drive - C:\UserData
- Install Programs
- Create an Eclipse account using your email address
- Sign Eclipse Contributor Agreement by going to View Profile then under Status select Eclipse Contributor Agreement
- Code Reviews - the following links provide access to review code, add links to your browser favorites
- Read Gerrit Tutorial
- Bookmark and log into: Gerrit at Eclipse.org using eclipse.org un/pw.
- When reviewing code, use the Developer Peer Review Checklist
- Email (Donald Dunne) donald.g.dunne@boeing.com to add you as an OSEE Admin
- Log into Bugzilla using Eclipse username/password
- Sign-up to osee-developers mailing list
Git Setup
- Install Git using the following installation settings
- Adjusting your PATH environment
- Use git from the windows command prompt
- Choosing HTTPS transport backend
- Use the OpenSSL library
- Configuring the line ending conversions
- Check as-is, commit as-is
- Configuring the terminal emulator to use with Git Bash
- Use MinTTY
- Leave the rest of the settings as default
- Adjusting your PATH environment
- Create a folder in UserData called git_main so the path is C:/UserData/git_main
- Open the following link and download the zip file File:Gitconfig global.zip
- Open the zip file and copy the gitconfig_global file into the UserData Folder
- Execute the following command, replacing <user> with your user directory
- cp C:/UserData/gitconfig_global C:/Users/<user>/.gitconfig
- You can now delete the file C:/UserData/gitconfig_global
- Open Git Bash from the Start Menu
- Execute the following commands
- cd C:/UserData/git_main
- git clone https://<your_gerrit_username>@git.eclipse.org/r/p/osee/org.eclipse.osee.git
- cd org.eclipse.osee
- git checkout dev
- Setup Local_hooks by downloading File:Local hooks.zip
- Open the zip file and copy the local_hooks folder to C:/UserData
- Execute the following command
- cp C:/UserData/local_hooks/* C:/UserData/git_main/org.eclipse.osee/.git/hooks/
- You can now delete the folder C:/UserData/local_hooks
- Add your name to usersList.txt in C:/UserData/git_main/org.eclipse.osee/.git/hooks/usersList.txt
OSEE Workspace Setup
OSEE Setup
- Install OSEE/Eclipse (TBD - replace with how to create OSEE dev workbench that compiles)
Importing Git Projects
- Start an OSEE version that matches the code you want to develop (e.g. dev alpha to develop in dev)
- Create a workspace
- In OSEE, follow the menu Project->Build Automatically, and uncheck this option
- Open the Git Perspective by following the menu Window->Perspective->Open Perspective
- Click the first "GIT" icon labeled, Add an existing local Git Repository
- Browse to select the git directory (created in a previous section above, e.g. C:\UserData\git_main), then click Search
- In the Search and select Git repositories on your local file system dialog, choose org.eclipse.osee
- Click the Finish button
- For each of the repositories, Right-Click on the repository now showing in the Git Repositories view and select Import Projects...
- In the dialog that pops up, take the default Import existing Eclipse projects, select the Next button
- After the import take a quick look to make sure all projects are selected, then choose Finish
- Don't forget to complete these steps for all repositories
Configure Workspace
- Double check to make sure the OSEE environment you are pulling code into matches the code you have.
- e.g. if you are developing for the dev line, make sure your osee is a dev version.
- Import OSEE Team Preferences
- Switch back to the Java Perspective, then File->Import, in the import wizard, select General->Preferences
- In the From preference file: input box, enter the path to the preferences (substitute your directory for <git dir>) in the From preference file:
- Browse to <git dir>\org.eclipse.osee\plugins\org.eclipse.osee.support.config then select the preference file: osee_team_preferences.epf
- Choose Finish
- Set Target Platform
- Select Window -> Preferences
- Expand Plug-in Development -> Target Platform
- Check OSEE Client Server Target Platform
- Click Apply then Ok
- Turn Project->Build Automatically back on
- Remove errors that we do not care about
- In the Problems tab at the bottom of OSEE, select the white triangle icon on the right side
- Choose Configure Contents
- Uncheck Show all items
- Choose New under Configurations
- Deselect All Errors, then make sure New Configuration is both selected and highlighted
- Under Types, click Deselect All for the errors
- Go through the list of types selecting all Java, Javascript, and Plug-in Problems
- Remove Null Analysis Errors
- Choose Window->Preferences->Java->Compiler->Errors/Warnings
- Expand Null Analysis and set the following to Warning instead of Error
- Null pointer access
- Potential null pointer access
- Redundant null check
- Uncheck Enable annotation-based null analysis
- Click Apply then Ok
- There should no longer be any errors, otherwise ask Mentor
Other OSEE Settings
- Package Explorer > White Pull down Arrow > Package Presentation > Change to Hierarchical from Flat (if preferred)
OSEE Setup Checks
- Run Test Suites / DB Init
- Under Debug Configurations, OSGi Framework, run "OSEE_Application_Server[HSQLDB]"
- Once server is loaded, go to Debug Configurations, JUnit Plug-in Test, run "AtsIde_Integration_TestSuite"
- Once ~100 tests have loaded and passed in JUnit, stop the tests, terminate and relaunch the Application Server
- Run "OSEE_IDE_[localhost]" under Eclipse Application in Debug Configurations
- OSEE IDE should load without issue
Other Programs & System Configuration
- Wiki for Documentation
- Bookmark and log into Eclipse.org Wiki
- Log in and bookmark Jenkins Build Page
Reading & Training Material
- Read important Eclipse training at Eclipse Help
- Read "Workbench User Guide" sections
- Getting Started
- Tips and Tricks
- Read "Java development user guide" sections:
- Getting Started
- Read "Platform Plug-in Developers Guide" sections:
- Welcome to Eclipse
- Simple plug-in example
- Runtime overview
- Read "Plug-in Development Environment Guide" sections:
- PDE Overview
- Concepts
- Read "Workbench User Guide" sections
- Watch videos on How Do I Author CM Managed Changes
- Read Agile Tutorial
- Read REST Tutorial
- Read OSEE Software Development Process
- Read OSEE Developer Guidelines
- Read OSEE Acronyms
- Read OSEE Architecture
- Bookmark and browse User Training
- Watch short User Training videos
- Bookmark and watch all (TBD) Developer Videos