chrishas35/ccl-testing

A collection of maven plugins and their dependencies to perform CCL Unit tests and static analyses and to generate reports from the results.

CCL Unit

Cerner Command Language (CCL), aka Discern Explorer, is a database query and scripting language used with Cerner Millennium databases. CCL Unit is a unit test framework for CCL.

ccl-testing houses maven plugins to perform CCL Unit tests and analyses and generate reports from the results, to perform static analyses, and to generate code documentation. It also houses some dependencies for those maven plugins. Specifically, ccl-testing houses the components listed below. Please visit individual components for details and usage instructions.

• ccl-maven-plugin (3.2) - Maven plugin for transferring resources, compiling CCL code and tests, executing the tests, and retrieving the test and coverage results.
• cerreal-maven-plugin (2.1) - Maven reporting plugin to report test and coverage results.
• whitenoise-maven-plugin (2.5) - Maven reporting plugin that identifies common CCL coding errors.
• cdoc-maven-plugin (1.2) - Maven reporting plugin that generates code documentation from code comments.
• ecosystem - Eclipse preferences to ensure consistent formating and compiler settings. Imported using Workspace Mechanic.
• ftp-util (2.0) - ccl-maven-plugin dependency used to ftp resource to/from the Cerner Millennium back end.
• j4ccl (3.1) - ccl-maven-plugin dependency defining common classes and interfaces for accessing a Cerner Millennium back end.
• j4ccl-ssh (4.2) - ccl-maven-plugin dependency leveraging JCraft SSH to implement the j4ccl interfaces.
• jsch-util (2.0.0) - ccl-maven-plugin dependency leveraging JCraft to provide back-end connections for j4ccl-ssh.
• cclunit-archetype (1.5) - archetype to generate a skeleton CCL project using the latest plugins.
• cclunit-maven-settings-check-archetype (1.2) - archetype to generate a CCL project to check maven settings.

Some significant differences from legacy versions to note:

• The artifactId for plugins is now X-maven-plugin rather than maven-X-plugin to satisfy maven3 restrictions on plugin naming.
• Several groupId values changed. All components now live below com.cerner.ccl or com.cerner.ftp. In particular use com.cerner.ccl.testing not com.cerner.ccltesting.
• The specifyDebugCcl flag in the ccl-maven-plugin.

Quick Start Guide

If you are new to CCL Unit testing and want to get started quickly, look here.

For recommendations on setting up maven, look here.

Take a look at the sample pom configuration and configuration options for the unit testing plugin.

Don't want your password showing up in log files? Look here.

Having build issues? Look here for some common problems and troubleshooting tips.

Release Schedule

The release schedule will be driven by requests for and contributions of enhancements and corrections.
See the change log for the contents of previous releases.

Contribute

You are welcomed to Contribute. Please read our Contribution Guidelines.

Committers should follow the Release Guidelines.

License

Copyright 2017 Cerner Innovation, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.