Installation Guide

How to setup Vascan from source

Project dependencies

Some dependencies of Vascan still need to be solved manually.

• A canadensys-data-access library in your local maven repository
• git clone [email protected]:Canadensys/canadensys-data-access.git
• mvn install
• A Vascan database, see scripts here
• A Vascan ElasticSearch index, see scripts here

Clone the VASCAN project

git clone git://github.com/Canadensys/vascan.git

Configuration

You need to provide Vascan your configuration file named vascan-config.properties in the config/local folder. To enable the logging of API calls you also need to provide a log4j.xml file in the src/main/resources/ folder.

Gradle

VASCAN uses Gradle as build management tool. The build has been tested with Gradle 2.1 but we are using the Gradle Wrapper (gradlew) to ensure stability in build process.

Unit tests

./gradlew clean test

NOTE: In case of test failure pointing to canadensys-data-access library, VASCAN may required a different version than the latest that was checkout by default. You can have a look at the Travis CI file for more informations.

Integration and functional tests

This will run some integration tests and some functional tests with an embedded Tomcat and a Firefox instance.

./gradlew –daemon clean runIntegrationTest

Run Vascan locally

./gradlew –daemon clean runLocal