wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW

Version 40 (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 can 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:

Every machine should have

Visit PLATFORM_NFR_COMPATIBILITY to see hardware, software and platform requirements and the supported OSes.

Trac

For documentation and bug tracking system we use Trac - build-in wiki engine.

You can open Trac

More info about working with Trac and some document templates: TracWiki
You can visit the PROCESS page, there are some rules about using our Trac.
More info about bug and task tracking: SCS_ISSUE_TRACKER_SETUP_R0
Here is our workflow using Trac tickets: SCS_ISSUE_TRACKER_SETUP_R1

Subversion Client

  • more info: Subversion is version control system for various kinds of files. It is widely used as source control for teamwork and is newer than CVS, which is old version control system.
  • example: on Windows we use 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

See PLATFORM_DEPLOYMENT_BUILD_ECLIPSE

  • 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://asteasolutions.net:7369/sophie2.
      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.
    • Method B: For Mac/Linux:
      1. Open Terminal
      2. use the command svn checkout ​SVN://asteasolutions.net:7369/sophie2 sophie2

  • Basic Functionality of Sublipse
    • After you eventually import the project into Eclipse (see PLATFORM_DEPLOYMENT_BUILD_ECLIPSE), you can use Subclipse 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.

  • "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. Revert is used to revert the changes you have made on your local to the current version in the repository.
      4. 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 See Maven Integration for installation guide and the Comments section.

PyDev

PyDev is Eclipse plug-in for Python development.

info: ​http://pydev.sourceforge.net/index.html[[BR]]

download: ​http://pydev.sourceforge.net/download.html

Maven Integration

We use Maven for managing the project's builds, reporting, documentation and other information about the progress.

  • download: ​http://maven.apache.org/download.html - version 2.0.9
  • Installation for Windows and Linux OSes: ​http://maven.apache.org/download.html - below the download packages
    • Note: Be careful with the PATH variable under Windows, you have to write the whole path to the bin directory not using M2_HOME variable to set the new path
  • Integration with Eclipse
    • (for Eclipse 3.4 Classic version)update your Eclipse platform so there is Equinox Provisioning Platform in Installed Software (Help->Software Updates)
    • download the M2 Eclipse Plug-in: ​http://m2eclipse.sonatype.org/update/
      • minimal package requirements for running the project - Maven Integration for Eclipse, Maven Embedder, Maven POM XML Editor
      • Note: make sure that Eclipse runs with JDK not JRE (see Window-Preferences-Java-Installed JREs, edit eclipse.ini with -vm <path to javaw executable file> or set correct PATH and JAVA_HOME variables)
    • See trunk/sophie2-platform/old/lib/readme.txt . In the bottom of the file are three mvc commands you have to execute to set the needed libraries which are not found in the Maven repository.
    • once you have integrate Maven with your Eclipse, in the Package Explorer appears a new "Maven" menu. From there you can:
      • Update Dependencies: you can force a refresh of the Maven Dependencies container and force downloading of artifact snapshots (regardless of the Maven repository refresh policy) by using the "Update Dependencies"
      • Update Project Configuration: can be used to refresh or recreate the Eclipse project configuration based on the content of the Maven pom.xml, for example, when changes in pom.xml affect the project structure (folders settings, plugins that dynamically add folders or have other configuration).
    • right-click on the project in Eclipse, and click Maven/Update Dependencies to finish integration

Optional accounts and tools

Accounts:

Tools:

Comments

  • When installing M2 Eclipse Plug-in remove the "Maven Integration for AJDT", otherwise there are missing dependencies and the instalation can not continue. (pac)
  • To work with Subclipse under Linux platforms you should install SVNKit package. Here is the plugin Eclipse edition: ​http://eclipse.svnkit.com/1.2.x/ . (pav)

Extras

Properties

  • For understanding what properties are and looking at some examples of how to use them, read this manual: PRO_LIB_CORE_TUTORIAL.
    • the examples are located in "Code Examples with different Properties Kinds" section.
  • In order to see different properties templates for eclipse, look at PRO_LIB_CORE_CODE_TEMPLATES.

NetBeans

In order to import Sophie project in NetBeans, you must first have NetBeans installed. After that, follow these steps:

Testing

In order to read about rules for writing good tests, and some information about unit/integration/system tests, visit TESTING?.