ccl-testing

Contents

Introduction
Component Versions
Quick Start Guide
Recommendations
Troubleshooting
Release Schedule
Contributing
License

Introduction

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

The ccl-testing repository houses maven plugins to perform CCL Unit tests and analyses, to generate reports from the results, to perform static analyses, and to generate code documentation. It also houses some dependencies for those maven plugins.
See Component Versions for a list of the components.

Component Versions

The latest released versions of the ccl-testing components are listed below.
Visit individuals components for details and usage instructions.
Visit the change log for version details.

• ccl-maven-plugin (3.4) - Maven plugin for transferring resources, compiling CCL code and tests, executing the tests, and retrieving the test and coverage results.
• cerreal-maven-plugin (2.3) - Maven reporting plugin to report test and coverage results.
• whitenoise-maven-plugin (2.7) - Maven reporting plugin that identifies common CCL coding errors.
• cdoc-maven-plugin (1.4) - Maven reporting plugin that generates code documentation from code comments.
• ecosystem - Eclipse preferences to ensure consistent formating and compiler settings. Import with Workspace Mechanic.
• ftp-util (2.2) - ccl-maven-plugin dependency used to ftp resource to/from the Cerner Millennium back end.
• j4ccl (3.3) - ccl-maven-plugin dependency defining classes and interfaces for accessing a Cerner Millennium back end.
• j4ccl-ssh (4.4) - ccl-maven-plugin dependency leveraging JCraft SSH to implement the j4ccl interfaces.
• jsch-util (2.2) - ccl-maven-plugin dependency leveraging JCraft to provide back-end connections for j4ccl-ssh.
• cclunit-archetype (1.6) - archetype to generate a skeleton CCL project using the latest plugins.
• cclunit-maven-settings-check-archetype (1.3) - archetype to generate a CCL project to check maven settings.

Quick Start Guide

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

Install and configure Apache Maven as described here.
Use the maven archetype to generate a new mavenized CCL project.

Recommendations

Configure the system so your password will not show up in log files. Look here for details.
Use the maven archetype to generate new projects.
      If you really want to do it manually, here is a sample pom (the same one the archetype creates).
Become familiar with the usage instructions and configuration options for the unit testing plugin.

Troubleshooting

Having 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.

Contributing

You are welcomed to contribute enhancements or fixes to the documention or code. 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.