Getting Started
To begin, ensure that you have the prerequisite software installed as enumerated below. You will
need internet access to pull down the project dependencies from a public Maven repository.
Use git to clone the repository
Prerequisites
You will need an internet connection (at least for the first build) for the dependencies to be downloaded into your local maven repository.
To build this repository, you will need the following installed on your machine:
- git 2.14+
- Java 8 JDK
- Maven 3.0+
Note that Plastic has not been ported yet past Java 8
Pulling The Code
For read-only access, you can do this
git clone https://git.opendaylight.org/gerrit/plastic
For a committer, you can do this
git clone ssh://{username}@git.opendaylight.org:29418/plastic.git
Installing
Once you have the prerequisites and have cloned the repo, you can issue a build at the
top level of your local copy of the repo
cd plastic mvn clean install
The build should complete normally. You can look in the target directory for artifacts.
There should be a plastic-*.jar and a directory called runner. If you change your current
working directory to the runner directory, you can issue the following command to see
things work (this uses examples from the tutorial)
./plastic_runner runnerroot.properties
You should see log output that shows a successful translation from "abcd" to "ABCD".
Running the tests
Most of the testing is done using unit tests that are written using Spock (a highly recommended
alternative to JUnit). These tests are run as part of every single build and a failure of
a unit test breaks the build.
Manual tutorial examples
There is a set of tutorials in the target/runner directory. You can find them as *.RST files. You
can install rst2pdf and convert them to PDF if you'd like.
From the target/runner directory, you can execute any of the tutorial examples
using a command like
<pre>
./runner <name>.properties
</pre>