Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "OSEE/Developer Setup"

Line 12: Line 12:
 
## Bookmark and log into: [https://git.eclipse.org/r/#/q/project:osee/org.eclipse.osee Gerrit at Eclipse.org] using eclipse.org un/pw.
 
## Bookmark and log into: [https://git.eclipse.org/r/#/q/project:osee/org.eclipse.osee Gerrit at Eclipse.org] using eclipse.org un/pw.
 
## When reviewing code, use the [http://wiki.eclipse.org/OSEE/Software_Development_Process/Peer_Review_Checklist Developer Peer Review Checklist]
 
## When reviewing code, use the [http://wiki.eclipse.org/OSEE/Software_Development_Process/Peer_Review_Checklist Developer Peer Review Checklist]
−
# Install OSEE/Eclipse (TBD - replace with how to create OSEE dev workbench that compiles)
 
 
# Email (Donald Dunne) donald.g.dunne@boeing.com to add you as an OSEE Admin
 
# Email (Donald Dunne) donald.g.dunne@boeing.com to add you as an OSEE Admin
 
# Log into [https://bugs.eclipse.org/bugs/ Bugzilla] using Eclipse username/password
 
# Log into [https://bugs.eclipse.org/bugs/ Bugzilla] using Eclipse username/password
Line 18: Line 17:
  
 
== Git Setup ==
 
== Git Setup ==
−
# Install [https://git-scm.com/downloads Git] using the following settings (TBD - No instructions how to do steps)
+
# Install [https://git-scm.com/downloads Git] using the following installation settings
 
#*  Adjusting your PATH environment
 
#*  Adjusting your PATH environment
 
#** Use git from the windows command prompt
 
#** Use git from the windows command prompt
Line 48: Line 47:
  
 
== OSEE Workspace Setup ==
 
== OSEE Workspace Setup ==
 +
'''OSEE Setup'''
 +
# Install OSEE/Eclipse (TBD - replace with how to create OSEE dev workbench that compiles)
 
'''Importing Git Projects'''
 
'''Importing Git Projects'''
 
# Start an OSEE version that matches the code you want to develop (e.g. dev alpha to develop in dev)
 
# Start an OSEE version that matches the code you want to develop (e.g. dev alpha to develop in dev)
Line 55: Line 56:
 
# Click the first "GIT" icon labeled, Add an existing local Git Repository
 
# 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
 
# 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 available repos, TBD)
+
# In the Search and select Git repositories on your local file system dialog, choose org.eclipse.osee
 
# Click the Finish button
 
# 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...
 
#* For each of the repositories, Right-Click on the repository now showing in the Git Repositories view and select Import Projects...
Line 81: Line 82:
 
#* Choose New under Configurations
 
#* Choose New under Configurations
 
#* Deselect All Errors, then make sure New Configuration is both selected and highlighted
 
#* Deselect All Errors, then make sure New Configuration is both selected and highlighted
−
#* In the Types box on the bottom right, de-select Xtext checks, Xtend Problems, DisplayLogic DSL problems, and MWE2 Problem (TBD - change to delselect all and select java, javascript and plugin items)
+
#* 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
 
# Remove Null Analysis Errors
 
#* Choose Window->Preferences->Java->Compiler->Errors/Warnings
 
#* Choose Window->Preferences->Java->Compiler->Errors/Warnings
Line 94: Line 96:
 
* Package Explorer > White Pull down Arrow > Package Presentation > Change to Hierarchical from Flat (if preferred)
 
* Package Explorer > White Pull down Arrow > Package Presentation > Change to Hierarchical from Flat (if preferred)
 
'''OSEE Setup Checks'''
 
'''OSEE Setup Checks'''
−
# Ensure that engineer's name shows in OSEE Navigator when they launch (TBD - remove)
+
# Run Test Suites / DB Init
−
# User added as assignee in Backlog (TBD - Email don to add user in OSEE)
+
−
# User understands the Backlog, My World, New Actions, Actionable Items, Target Definitions, Versions (TBD - remove)
+
−
# Run Test Suites / DB Init (TBD - Make top level section since above 3 are removed)
+
 
## Under Debug Configurations, OSGi Framework, run "OSEE_Application_Server[HSQLDB]"
 
## 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 server is loaded, go to Debug Configurations, JUnit Plug-in Test, run "AtsIde_Integration_TestSuite"
Line 107: Line 106:
 
* Wiki for Documentation
 
* Wiki for Documentation
 
** Bookmark and log into Eclipse.org Wiki
 
** Bookmark and log into Eclipse.org Wiki
−
** Bookmark and log into MSA Wiki (TBD - Remove)
 
 
* Log in and bookmark [https://ci.eclipse.org/osee/ Jenkins Build Page]
 
* Log in and bookmark [https://ci.eclipse.org/osee/ Jenkins Build Page]
  

Revision as of 14:07, 4 April 2019

Initial Setup

  1. Create a UserData Folder on your C: Drive - C:\UserData
  2. Install Programs
    1. Google Chrome
    2. Java JDK
    3. DBeaver
    4. Notepad++
  3. Create an Eclipse account using your email address
    1. Sign Eclipse Contributor Agreement by going to View Profile then under Status select Eclipse Contributor Agreement
  4. Code Reviews - the following links provide access to review code, add links to your browser favorites
    1. Read Gerrit Tutorial
    2. Bookmark and log into: Gerrit at Eclipse.org using eclipse.org un/pw.
    3. When reviewing code, use the Developer Peer Review Checklist
  5. Email (Donald Dunne) donald.g.dunne@boeing.com to add you as an OSEE Admin
  6. Log into Bugzilla using Eclipse username/password
  7. Sign-up to osee-developers mailing list

Git Setup

  1. 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
  2. Create a folder in UserData called git_main so the path is C:/UserData/git_main
  3. Open the following link and download the zip file File:Gitconfig global.zip
    1. Open the zip file and copy the gitconfig_global file into the UserData Folder
    2. 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
  4. Open Git Bash from the Start Menu
  5. Execute the following commands
    1. cd C:/UserData/git_main
    2. git clone https://<your_gerrit_username>@git.eclipse.org/r/p/osee/org.eclipse.osee.git
    3. cd org.eclipse.osee
    4. git checkout dev
  6. Setup Local_hooks by downloading File:Local hooks.zip
    1. Open the zip file and copy the local_hooks folder to C:/UserData
    2. 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
    3. Add your name to usersList.txt in C:/UserData/git_main/org.eclipse.osee/.git/hooks/usersList.txt

OSEE Workspace Setup

OSEE Setup

  1. Install OSEE/Eclipse (TBD - replace with how to create OSEE dev workbench that compiles)

Importing Git Projects

  1. Start an OSEE version that matches the code you want to develop (e.g. dev alpha to develop in dev)
  2. Create a workspace
  3. In OSEE, follow the menu Project->Build Automatically, and uncheck this option
  4. Open the Git Perspective by following the menu Window->Perspective->Open Perspective
  5. Click the first "GIT" icon labeled, Add an existing local Git Repository
  6. Browse to select the git directory (created in a previous section above, e.g. C:\UserData\git_main), then click Search
  7. In the Search and select Git repositories on your local file system dialog, choose org.eclipse.osee
  8. 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

  1. 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.
  2. 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
  3. Set Target Platform
    1. Select Window -> Preferences
    2. Expand Plug-in Development -> Target Platform
    3. Check OSEE Client Server Target Platform
    4. Click Apply then Ok
  4. Turn Project->Build Automatically back on
  5. 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
  6. 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

  1. Run Test Suites / DB Init
    1. Under Debug Configurations, OSGi Framework, run "OSEE_Application_Server[HSQLDB]"
    2. Once server is loaded, go to Debug Configurations, JUnit Plug-in Test, run "AtsIde_Integration_TestSuite"
    3. Once ~100 tests have loaded and passed in JUnit, stop the tests, terminate and relaunch the Application Server
    4. Run "OSEE_IDE_[localhost]" under Eclipse Application in Debug Configurations
    5. 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

  1. 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
  2. Watch videos on How Do I Author CM Managed Changes
  3. Read Agile Tutorial
  4. Read REST Tutorial
  5. Read OSEE Software Development Process
  6. Read OSEE Developer Guidelines
  7. Read OSEE Acronyms
  8. Read OSEE Architecture
  9. Bookmark and browse User Training
  10. Watch short User Training videos
  11. Bookmark and watch all (TBD) Developer Videos
Retrieved from "https://wiki.eclipse.org/index.php?title=OSEE/Developer_Setup&oldid=431511"

Back to the top