scala:cctest

Full name:

org.scala-tools:maven-scala-plugin:2.15.1:cctest

Description:

Compile the main and test scala source directory then run unit test cases in continuous (infinite loop). This is an util goal for commandline usage only (Do not use or call it in a pom) !!!

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: test.

Required Parameters

Name Type Since Description
displayCmd boolean - Display the command line called ? (property 'maven.scala.displayCmd' replaced by 'displayCmd')
Default value is: false.
scalaClassName String - className (FQN) of the scala tool to provide as
Default value is: scala.tools.nsc.Main.

Optional Parameters

Name Type Since Description
args String[] - compiler additionnals arguments
ccTestGoals String - A space-separated list of the goals to execute as part of running the tests. You can use this setting to run different testing tools other than just JUnit. For example, to run the ScalaTest (with the maven-scalatest-plugin): 
  mvn -Dcctest.goals=scalatest:test scala:cctest
To run both ScalaTest and JUnit tests: 
  mvn -Dcctest.goals="surefire:test scalatest:test" scala:cctest
If you need to specify the goal every time you run scala:cctest, you can configure the setting in the pom.xml: 
   <plugin>
      <groupId>org.scala-tools</groupId>
      <artifactId>maven-scala-plugin</artifactId>
      <version>2.15.1-SNAPSHOT</version>
      <configuration>
         <ccTestGoals>scalatest:test</ccTestGoals>
      </configuration>
      <!-- normal executions here -->
   </plugin>

Default value is: surefire:test.
checkMultipleScalaVersions boolean - Check if every dependencies use the same version of scala-library.
Default value is: true.
compilerPlugins BasicArtifact[] - Compiler plugin dependencies to use when compiling. ex:
dependencies BasicArtifact[] - Additional dependencies/jar to add to classpath to run "scalaClassName" (scope and optional field not supported) ex : 
   <dependencies>
     <dependency>
       <groupId>org.scala-tools</groupId>
       <artifactId>scala-compiler-addon</artifactId>
       <version>1.0-SNAPSHOT</version>
     </dependency>
   </dependencies>

excludes Set - A list of exclusion filters for the compiler. ex : 
   <excludes>
     <exclude>SomeBadFile.scala</exclude>
   </excludes>

failOnMultipleScalaVersions boolean - Determines if a detection of multiple scala versions in the dependencies will cause the build to fail.
Default value is: false.
forceUseArgFile boolean - Force the use of an external ArgFile to run any forked process.
Default value is: false.
fork boolean - Forks the execution of scalac into a separate process.
Default value is: true.
includes Set - A list of inclusion filters for the compiler. ex : 
   <includes>
     <include>SomeFile.scala</include>
   </includes>

jvmArgs String[] - Jvm Arguments.
localRepositoryPath File - The local repository for caching artifacts. It is strongly recommended to specify a path to an isolated repository like ${project.build.directory}/it-repo. Otherwise, your ordinary local repository will be used, potentially soiling it with broken artifacts.
Default value is: ${settings.localRepository}.
mainOutputDir File - The output directory for compilation.
mainSourceDir File - The main directory containing scala source for compilation
notifyCompilation boolean - notifyCompilation if true then print a message "path: compiling" for each root directory or files that will be compiled. Usefull for debug, and for integration with Editor/IDE to reset markers only for compiled files.
Default value is: true.
once boolean - Define if cc should run once or in infinite loop. (useful for test or working with editor)
Default value is: false.
recompileMode String - compilation-mode to use when sources was previously compiled and there is at least one change: "modified-only" => only modified source was recompiled (pre 2.13 behavior), "all" => every source are recompiled
Default value is: all.
scalaVersion String - Scala 's version to use. (property 'maven.scala.version' replaced by 'scala.version')
sendJavaToScalac boolean - Enables/Disables sending java source to the scala compiler.
Default value is: true.
test String - Specify this parameter to run individual tests by file name, overriding the includes/excludes parameters. Each pattern you specify here will be used to create an include pattern formatted like **/${test}.java, so you can just type "-Dtest=MyTest" to run a single test called "foo/MyTest.java". This parameter will override the TestNG suiteXmlFiles parameter.
testOutputDir File - The directory to place test compilation output in
testSourceDir File - The directory containing test source for compilation
useFsc boolean - Define if fsc should be used, else scalac is used. fsc => scala.tools.nsc.CompileClient, scalac => scala.tools.nsc.Main.
Default value is: true.
verbose boolean - Turns verbose output on.
Default value is: false.

Parameter Details

args:

compiler additionnals arguments
  • Type: java.lang.String[]
  • Required: No

ccTestGoals:

A space-separated list of the goals to execute as part of running the tests. You can use this setting to run different testing tools other than just JUnit. For example, to run the ScalaTest (with the maven-scalatest-plugin): 
  mvn -Dcctest.goals=scalatest:test scala:cctest
To run both ScalaTest and JUnit tests: 
  mvn -Dcctest.goals="surefire:test scalatest:test" scala:cctest
If you need to specify the goal every time you run scala:cctest, you can configure the setting in the pom.xml: 
   <plugin>
      <groupId>org.scala-tools</groupId>
      <artifactId>maven-scala-plugin</artifactId>
      <version>2.15.1-SNAPSHOT</version>
      <configuration>
         <ccTestGoals>scalatest:test</ccTestGoals>
      </configuration>
      <!-- normal executions here -->
   </plugin>
  • Type: java.lang.String
  • Required: No
  • Expression: ${cctest.goals}
  • Default: surefire:test

checkMultipleScalaVersions:

Check if every dependencies use the same version of scala-library.
  • Type: boolean
  • Required: No
  • Expression: ${maven.scala.checkConsistency}
  • Default: true

compilerPlugins:

Compiler plugin dependencies to use when compiling. ex:
  • Type: org_scala_tools_maven.BasicArtifact[]
  • Required: No

dependencies:

Additional dependencies/jar to add to classpath to run "scalaClassName" (scope and optional field not supported) ex : 
   <dependencies>
     <dependency>
       <groupId>org.scala-tools</groupId>
       <artifactId>scala-compiler-addon</artifactId>
       <version>1.0-SNAPSHOT</version>
     </dependency>
   </dependencies>
  • Type: org_scala_tools_maven.BasicArtifact[]
  • Required: No

displayCmd:

Display the command line called ? (property 'maven.scala.displayCmd' replaced by 'displayCmd')
  • Type: boolean
  • Required: Yes
  • Expression: ${displayCmd}
  • Default: false

excludes:

A list of exclusion filters for the compiler. ex : 
   <excludes>
     <exclude>SomeBadFile.scala</exclude>
   </excludes>
  • Type: java.util.Set
  • Required: No

failOnMultipleScalaVersions:

Determines if a detection of multiple scala versions in the dependencies will cause the build to fail.
  • Type: boolean
  • Required: No
  • Default: false

forceUseArgFile:

Force the use of an external ArgFile to run any forked process.
  • Type: boolean
  • Required: No
  • Default: false

fork:

Forks the execution of scalac into a separate process.
  • Type: boolean
  • Required: No
  • Default: true

includes:

A list of inclusion filters for the compiler. ex : 
   <includes>
     <include>SomeFile.scala</include>
   </includes>
  • Type: java.util.Set
  • Required: No

jvmArgs:

Jvm Arguments.
  • Type: java.lang.String[]
  • Required: No

localRepositoryPath:

The local repository for caching artifacts. It is strongly recommended to specify a path to an isolated repository like ${project.build.directory}/it-repo. Otherwise, your ordinary local repository will be used, potentially soiling it with broken artifacts.
  • Type: java.io.File
  • Required: No
  • Expression: ${invoker.localRepositoryPath}
  • Default: ${settings.localRepository}

mainOutputDir:

The output directory for compilation.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.outputDirectory}

mainSourceDir:

The main directory containing scala source for compilation
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.sourceDirectory}/../scala

notifyCompilation:

notifyCompilation if true then print a message "path: compiling" for each root directory or files that will be compiled. Usefull for debug, and for integration with Editor/IDE to reset markers only for compiled files.
  • Type: boolean
  • Required: No
  • Expression: ${notifyCompilation}
  • Default: true

once:

Define if cc should run once or in infinite loop. (useful for test or working with editor)
  • Type: boolean
  • Required: No
  • Expression: ${once}
  • Default: false

recompileMode:

compilation-mode to use when sources was previously compiled and there is at least one change: "modified-only" => only modified source was recompiled (pre 2.13 behavior), "all" => every source are recompiled
  • Type: java.lang.String
  • Required: No
  • Expression: ${recompilation-mode}
  • Default: all

scalaClassName:

className (FQN) of the scala tool to provide as
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${maven.scala.className}
  • Default: scala.tools.nsc.Main

scalaVersion:

Scala 's version to use. (property 'maven.scala.version' replaced by 'scala.version')
  • Type: java.lang.String
  • Required: No
  • Expression: ${scala.version}

sendJavaToScalac:

Enables/Disables sending java source to the scala compiler.
  • Type: boolean
  • Required: No
  • Default: true

test:

Specify this parameter to run individual tests by file name, overriding the includes/excludes parameters. Each pattern you specify here will be used to create an include pattern formatted like **/${test}.java, so you can just type "-Dtest=MyTest" to run a single test called "foo/MyTest.java". This parameter will override the TestNG suiteXmlFiles parameter.
  • Type: java.lang.String
  • Required: No
  • Expression: ${test}

testOutputDir:

The directory to place test compilation output in
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.testOutputDirectory}

testSourceDir:

The directory containing test source for compilation
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.testSourceDirectory}/../scala

useFsc:

Define if fsc should be used, else scalac is used. fsc => scala.tools.nsc.CompileClient, scalac => scala.tools.nsc.Main.
  • Type: boolean
  • Required: No
  • Expression: ${fsc}
  • Default: true

verbose:

Turns verbose output on.
  • Type: boolean
  • Required: No
  • Expression: ${verbose}
  • Default: false