CFML Feature Audit

Discover if your application is compatible with BoxLang.

the The BoxLang CFML Feature audit tool is a CLI tool that will scan your source code and give you a compatibility report. This will allow you to see if your CFML code will run natively in BoxLang or if any BIFs or Components are required. Like the other tools, this is based on our BL AST (BoxLang Abstract Syntax Tree), so it should be accurate and not require anything like regex. It’s using the actual BL ANTLR parsers.

Install the Compatibility Modules

Before you run the tool, install the appropriate BoxLang modules so our tell can also account for those module collaborations. We recommend the following to simulate a CFML server:

# Install the modules to simulate a CFML server (Adobe, Lucee)
install-bx-modules bx-compat-cfml bx-password-encrypt bx-esapi bx-image bx-ini bx-mail bx-pdf bx-unsafe-evaluate bx-wddx bx-web-server

Remember, as you read below, tags are now called “components” in BoxLang. This tool will parse tag-based and script-based code alike.

Features

This CLI tool will scan

• a single file

• or a folder of files recursively (in parallel)

and will track:

• what BIFs you are using

• What Components (Tags) you are using

including the

• file name where it is used

• line number it was used on

• The module that BIF/component is from

• Whether or not that feature is missing from BoxLang currently (true/false)

Data tracked can be

• Every occurrence of a component or BIF

• aggregate of what BIFs/components were used per file

• aggregate summary of what BIFs/components were used across all files

and can be

• printed to console

• and/or written to CSV report file

Usage

Make sure you have installed the OS version of BoxLang so you get all the tools installed as well. Please note that the action command funnels through the boxlang binary, so you can use all the CLI arguments for boxlang runner.

You can call the tool using our script or the full path to the jar.

// Using the script
boxlang featureAudit <options here>

// Using the full path to the jar
java -cp boxlang-1.0.0-all.jar ortus.boxlang.compiler.FeatureAudit  <options here>

CLI Options

• --source - Defaults to working directory. If supplied, it must be followed by an absolute path or a path relative to the working directory.

• --missing - Filter results to only show BIFs and Components which are missing from BoxLang

• --aggregate - Instead of showing every usage instance, roll-up counts at the file level by default.

• --aggregate summary - If the arg “summary” is passed after the aggregate flag, we will roll the results up even further to include all files processed. In “summary” mode, the total number of files processed will also be output to the console, along with a breakdown of the number of file extensions encountered.

• --quiet - Do not output the details of what was found on the console. Use in conjunction with the report path arg if you want to write out a report file. Even in quiet mode, each file processed will be output.

• --reportFile - An absolute or relative (to the working dir) file path to write the data matching your filters and aggregate settings in a CSV format. Intermediate folders will be created. If the filename does not end with .csv, it will be appended.

  • The CSV columns, when not aggregating the data, will be File,Name,Type,Module,Missing,Line

  • The CSV columns, when aggregating data at a per-file level, will be: File,Name,Type,Module,Missing,Count

  • The CSV columns, when aggregating data at a summary level, will be: Name,Type,Module,Missing,Count

Examples

Get a full report of all BIFs and Components used in a file

// Using the script
boxlang featureAudit --source includes/myFile.cfm

// Using the full path
java -cp boxlang-1.0.0-all.jar ortus.boxlang.compiler.FeatureAudit --source includes/myFile.cfm

Scan all your models for missing BIFs and Components

// Using the script
boxlang featureAudit --source ./models/ --missing

// Using the full path
java -cp boxlang-1.0.0-all.jar ortus.boxlang.compiler.FeatureAudit --source ./models/ --missing

Same as above, but aggregate results per file and write results to a CSV report

// Using the script
boxlang featureAudit --source ./models/ --missing --aggregate --quiet --reportFile /path/to/models-missing-features.csv

// Uisng the Full path
java -cp boxlang-1.0.0-all.jar ortus.boxlang.compiler.FeatureAudit --source ./models/ --missing --aggregate --quiet --reportFile /path/to/models-missing-features.csv

Get a summary level aggregate report of all missing features in ColdBox output to the console

// Using the script
boxlang featureAudit --source ./coldbox/ --missing --aggregate summary 

// Using the full path
java -cp boxlang-1.0.0-all.jar ortus.boxlang.compiler.FeatureAudit --source ./coldbox/ --missing --aggregate summary