Getting Started

In this tutorial, you’ll see how to create a Scala/Java project using a giter8 template for CSW (csw.g8) which contains sample handlers for creating HCD and Assembly. It also contains a deploy project which is responsible for starting multiple components or containers. You can use this as a starting point for your own projects for writing component. We’ll use the sbt build tool which compiles, runs, and tests your projects among other related tasks.

Installation

Supported Operating Systems are: CentOS and MacOS

1. Make sure you have the Java 8 JDK (also known as 1.8)
   • Run javac -version in the command line and make sure you see javac 1.8.___
   • If you don’t have version 1.8 or higher, install the JDK
2. Install sbt
   • Mac
   • Linux
3. Install IntelliJ
   • MAC
   • Linux
4. Install following IntelliJ Plugins
   • Scala
   • Scalafmt
5. Recommended testing frameworks/tools:
   • ScalaTest
   • JUnit, JUnit Interface
   • Note: These frameworks are typically downloaded and made available by the sbt tool by specifying them as dependencies. If you are using the giter8 template (see below), these dependencies are specified by default, and the sbt will resolve them when it runs.

Create project

1. cd to an empty folder.
2. Run the following command sbt new tmtsoftware/csw.g8. This pulls the ‘csw’ template from GitHub. If above command fails to pull template, then try running with full path sbt new https://github.com/tmtsoftware/csw.g8
3. Provide input details when prompted. Follow the template readme.md for detailed information about input parameters.

To open the project in IntelliJ, start IntelliJ and click on Import Project in the Intro dialog. If you have a project already open, click on File -> New -> Project from Existing Sources…

Then select the directory created by the template and click Open.

You will then see a dialog asking how to import the project.

Be sure the Import project from external model radio button and sbt options are selected and click Next. Then click Finish on the next dialog to accept the defaults.

Let’s take a look at what just got generated:

In this example, a project was created with default parameters. The complete project structure looks like this:

1. As you can see in below snapshot, template will create three projects:
   • sample-assembly
   • sample-hcd
   • sample-deploy

1. sample-deploy project is used to create a concrete implementation. This allows for the construction of a complete binary package bundled with all dependencies, and a launching application.

3. Template comes with csw and other useful library dependencies. It also includes bunch of plugins as explained in below snapshot

Add new sbt project module

If you want to add another component to the project, for example, with the name sample-io, you have to create a new sbt module:

1. Add external library dependencies required by sample-io in Libs.scala file, if it does not exist.

   val `akka-actor` = "com.typesafe.akka" %% "akka-actor" % "2.5.11"
   

2. Map new/existing library dependencies in Dependencies.scala file against new project.

   val SampleIO = Seq( Libs.`akka-actor` )
   

3. Include below snippet in build.sbt file, this will create new sbt project module.

   lazy val `sample-io` = project
     .settings( libraryDependencies ++= Dependencies.SampleIO )
   

4. If your new module depends on code from other modules within this project, use .dependsOn in your build.sbt file:

   lazy val `sample-io` = project
     .settings( libraryDependencies ++= Dependencies.SampleIO )
     .dependsOn(
   `sample-assembly`,
   `sample-hcd`
     )
   

5. Update the deployment dependencies:

   lazy val `sample-deploy` = project
     .dependsOn(
   `sample-assembly`,
   `sample-hcd`,
   `sample-io`
     )