Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents


Requirements

To get a clean working Ariane development environment on IntelliJ IDEA you need first to activate several plugins and check some configuration.

Plugins

Here's the minimal plugin list you need to run on IntelliJ IDEA Ultimate Edition. To check and install plugins go to Settings > Plugins.

CSS supportDatabase supportGit integrationGroovy
HTML toolsInspection-JSJava EE integration plugin(s)Java Server Pages Integration
JavaScript pluginsJSF supportJUnitMaven plugins
Persistence Frameworks SupportProperties supportPythonScala
SQL support   

Configuration

Java SDK

You need to set up a Java 1.7 SDK at least. On IntelliJ you can check your SDK via Project Default > Project Structure > SDKs.

You are then able to see the SDKs list known by IntelliJ :

You can add any SDK you need through that window :

 

Python

You also need to install a Python 3 SDK at least...

Scala

Check the Scala JVM SDK is correctly defined in Setting > Scala. You should define a Java 1.7 SDK at least.


Project definition on IntelliJ IDEA

Ariane project is composed of severals modules (maven modules or python). To setup Ariane Project in IntelliJ you need to import these modules. If you didn't clone the Ariane git repository you need to follow the previous paper.

Once all Ariane repositories are cloned then you can then create the Ariane project on IntelliJ and import them into that project.

Create Ariane Community Project

Let's begin to create the Ariane Community project into IntelliJ : click "Create New Project" on the IntelliJ IDEA welcome window.   

On the next window select Python Module on the left panel of the window and set up your python 3 SDK as project SDK and click next.

On the next window ignore template and click next.

On the next window define your project as follow :

  • set Project Name as "ariane.community"
  • set the Project Location as root path of all Ariane repositories cloned by the Ariane distribution tool ($ARIANE_GIT_ROOT).
  • extend "More Setting" on the bottom of the window
    • set Module Name as "ariane.community.distrib"
    • set Content Root as $ARIANE_GIT_ROOT/ariane.community.distrib
    • set Module File Location as $ARIANE_GIT_ROOT/.idea

Click Finish (wink)

The new project should be loaded correctly into the main IntelliJ window.

Type F12 (or F4 on OS X) on your keyboard to open the Project Structure window. Select "Modules" on the left panel of the window. Then select ariane.community.distrib module on the module panel. Finally set the module directory as a source directory and resource directory as a resource directory.

Your Ariane Project is now defined with your first Ariane module. (smile) 

Import Ariane Core maven modules

To import the Ariane Core maven modules you will use the global pom generated by the Ariane distribution tool. In IntellijIDEA click File > Import Module and then choose the $ARIANE_GIT_ROOT path as a directory to import. Click then OK.

In the Import Module window select "Import module from external model" and select Maven. Click Next !

Then define the import settings as follow :

  • Root directory = $ARIANE_GIT_ROOT
  • Select "Keep project files in :" and define $ARIANE_GIT_ROOT/.idea
  • Select "Import Maven projects automatically"
  • Select "Create IDEA module for aggregator projects"
  • Select "Keep source and test folder on reimport"
  • Select "Exclude build directory"
  • Select "Use maven output directories"

Then click next

 

Then select Maven project to import as "net.echinopsii:net.echinopsii.ariane:0.6.2-SNAPSHOT" and click next

Then select a JDK 7 SDK as project SDK and click finish 

Ariane maven modules are now imported in the IntelliJ main window. Type F12 (or F4 on OS X) to check state of your project and set the global project SDK to the JDK 1.7 :

Then define Scala source directories under ariane.community.core.mapping.ds.dsl submodule :

You should now have a clean project. Click apply.

Finally you can configure your git setting from the IntellijIDEA settings :

 

Your Ariane Core modules are now configured correctly into IntelliJ.

Setup Python modules for Ariane Installer

Ariane framework offers some python tooling to install easily Ariane in the target environment. So on each Ariane modules (i.e. : a git repository) you will find maven project but also a python directory which is dedicated to these convenient tooling. We will know define python modules for each of these directories.

Main installer python module

Type F12 to get the Project Structure window. On Module panel extend the + menu and choose new module.

Then define the new module as follow :

  • select Python module on the left
  • select Python 3 as SDK
  • Ignore python framework
  • Click Next.

Then define module settings as follow : 

  • set module name as : "ariane.community.installer"
  • set content root as : $ARIANE_GIT_ROOT/ariane.community.installer/distrib
  • set module file location as : $ARIANE_GIT_ROOT/.idea

Finally set the installer directory as a source directory and installer/resources directory as a resource directory and click Apply.

Ariane core components

We will now create a new python module for each of the Ariane core components. Still on the Project Structure window let's go to create a new python modules. Procedure is almost same as for the main installer python module

ariane.community.core.idm

Define the new module as follow :

  • select Python module on the left
  • select Python 3 as SDK
  • Ignore python framework
  • Click Next.

Then define module settings as follow : 

  • set module name as : "ariane.community.installer-idm"
  • set content root as : $ARIANE_GIT_ROOT/ariane.community.core.idm/distrib
  • set module file location as : $ARIANE_GIT_ROOT/.idea

Set the installer directory as a source directory.

Add a dependency for ariane.community.installer-idm to ariane.community.installer

And add a dependency for ariane.community.installer to ariane.community.installer-idm (yep there is circular dependency to remove here but you can ignore the error raised by IntelliJ).

ariane.community.core.portal

replay same procedure as ariane.community.core.idm but ignore the source directory and dependencies links part.

ariane.community.core.mapping

replay same procedure as ariane.community.core.idm

ariane.community.core.directory

replay same procedure as ariane.community.core.idm

ariane.community.core.injector

replay same procedure as ariane.community.core.idm

 

Import Ariane Plugins 

Ariane plugins are generally structured with a Maven project module and a python project module for Ariane installer. Bellow the way to define Ariane RabbitMQ plugin into IntellijIDEA. 

Import the maven project module

Repeat Ariane core maven module import procedure

    Image Removed Image Removed Image Removed

Import the python project module

Repeat Ariane python module setup.Image Removed

 

Image Removed Image Removed Image Removed Image Removed

 

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.