wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW

Version 2 (modified by pavlina, 17 years ago) (diff)

--

Platform Infrastructure Overview

The infrastructure is all the development tools and communication channels for teamwork, which we use to synchronize and do our work, so we make it fast and easy. Below are the things you should have and which you should know for starting work on Sophie 2.0.

Accounts

You must have and give to us:

  • google mail (sign in our googlegroups sophie2-devs and sophie2-users)
  • skype account
  • ICQ account (optional)
  • Phone number
  • server account (ask Milo)

Every machine should have

Subversion Client

  • more info: Subversion ? version control system for various kinds of files. It is massivly used as source control for teamwork and is newer than CVS, which is old version control program.
  • example: we use on Windows TortoiseSVN
  • useful URLs:

Development Tools

On every machine for developing these programs must be set up:

Java 6

Eclipse 3.4

Eclipse Plug-ins

Subclipse

  • Subclipse is plug-in for SVN integration with the Eclipse IDE. It allows users to deploy Subversion in their projects. You can use source control directly from the Package Browser from the Eclipse IDE.

  • Installing Subclipse
    • Go to ​http://subclipse.tigris.org/install.html. Follow the installation instructions up to step 11. Pay special attention on step 6 - be sure to check out only the Sublicpse Update site and the Subclipse box below it (no other components are needed).

  • Deploying a project in a repository
    1. From the SVN repository browser create a directory for the project in the trunk folder.
    2. Right click/import/choose import directory/choose the files that should be imported (only the source files, no project settings).
    3. The Sophie2 project is already imported, so this is only for reference.

  • Checkout the project repository
    • From your OS:
      1. In a new empty folder choose "Create repository here" option
      2. Choose "SVN Checkout...". Enter the URL of the repository of the Sophie2 project. (the URL is ​SVN://TODO/sophie2 (the public IP if you intend to work from home) or ​SVN://asteasolutions.net:7369/sophie2 if you prefer the local IP address, best for the office computers).
      3. Choose your checkout directory(sophie2-repo). It is set by default to be the empty folder in which you choose "SVN Checkout...".
      4. Write your username and password for the repo(take them from Milo). Now you have local project repository.

  • Importing a project under source control(SVN):
    • In Eclipse:
      1. Check out as a project configured using the New Project Wizard. (This way you can customize some project settings.) Finish.
      2. Choose Java/Java Project/Next
      3. Choose "Create project from existing source" button and browse to the trunk directory in repository with the project you want to open.
      4. Next are the settings we have chosen for creating the project. We strongly recommend you use the same settings so that we could have same names while working and not commit anything else except sources in the repository.

Project name: Sophie2 Use default JRE Create separate folders for sources and classes files. Finish.

  • Basic Functionality of Sublipse
  • Once you have created a project you can use Sublipse from the package explorer of your IDE. The files and directories that are under source control are noted with a symbol in the bottom right corner of the icon. Star(asterix) is used if the file is not synchronized with the repository and a yellow cylinder is used if the files match the repository structure. In the bottom left corner of the icon appears a red "x" if there are compilation errors in the code and a yellow "!" if there are warnings.
  • We must not commit source that has errors, so that all users can always build and run the current version of the project.
  • We must not commit other files except source code.
  • We must not commit or update the Sophie-JR folder, only the src folder. That, for example, will allow all users to make their own modifications to the workspace settings.
  • "Team" menu
    • Once you have imported a project from a repository, in the Package Explorer appears a new "Team" menu.
      1. Update is used to get the latest version from the repository.
      2. Commit is used to commit the changes that you have made on your local copy.
      3. Synchronize with repository makes both update and commit at the same time.
      4. Revert is used to revert the changes you have made on your local to the current version in the repository.
      5. You can revert to previous versions. Just uncheck Switch to HEAD revision and choose the revision to which you want to switch
  • Conflicts
    • When two users (usr1 and usr2) edit the same file, usr1 commits the changes and then usr2 tries to commit a conflict occurs. Usr2 cannot commit, because usr1 has already made changes. Then merging should be done. As the merging tool of the Eclipse IDE is very poor, I suggest we use TortoiseMerge. Download TortoiseSVN from ​http://tortoisesvn.net/downloads. Install it. From the Eclipse IDE choose Window/Preferences/Team/SVN/DiffMerge/. Choose External editor and choose the TortoiseMerge.exe. In the "Variables" line add the following options:

/theirs:"${theirs}" /base:"${base}" /mine:"${yours}" /merged:"${merged}" Now you have integrated TortoiseMerge in Sublcipse. Whenever you get a conflict while trying to commit, choose /Team/Update. If the conflict can be automatically merged, it is done. Otherwise files with differences are created. Choose /Team/Edit Conflicts. TortoiseMerge opens and you can merge the files. On the left is the repository version, on the right your version, bellow are the results from the merge(you can edit this version). When you synchronize the files (no conflicts are left) save and from the Eclipse IDE choose /Team/Mark Resolved. You can commit now without conflicts for errors. Do visit ​http://tortoisesvn.tigris.org/TortoiseMerge.html for an intuitive five minutes tutorial on TortoiseMerge.

M2 Eclipse

info: ​http://m2eclipse.codehaus.org/Maven_2.0_Plugin_for_Eclipse.html download:

Visual Paradigm

Visual Paradigm for UML is a UML CASE Tool supporting UML 2.1. We use Community Edition - it is free. More info: ​http://www.visual-paradigm.com/product/vpuml/communityedition.jsp You have to register to download it: ​http://www.visual-paradigm.com/product/vpuml/vpumldownload.jsp?edition=ce