bundles. Example: directory=tests.specs
+ * @recurse Recurse the directory mapping or not. Defaults to true.
+ * @reporter The type of reporter to use for the results, by default is uses our 'json' reporter. You can pass in a core reporter string type or a class path to the reporter to use.
* @labels The list of labels that a suite or spec must have in order to execute.
* @excludes The list of labels that a suite or spec must not have in order to execute.
* @options Add adhoc URL options to the runner as options:name=value options:name2=value2
- * @testBundles A list or array of bundle names that are the ones that will be executed ONLY!
- * @testSuites A list of suite names that are the ones that will be executed ONLY!
- * @testSpecs A list of test names that are the ones that will be executed ONLY!
+ * @testBundles A list or array of bundle names that are the ones that will be focused on for execution based on the bundles or directory arguments.
+ * @testSuites A list of suite names that are the ones that will be focused on for execution based on the bundles or directory arguments.
+ * @testSpecs A list of test names that are the ones that will be focused on for execution based on the bundles or directory arguments.
* @outputFile We will store the results in this output file as well as presenting it to you.
* @outputFormats A list of output reporter to produce using the runner's JSON results only. Available formats are: json,xml,junit,antjunit,simple,dot,doc,min,mintext,doc,text,tap,codexwiki
* @verbose Display extra details including passing and skipped tests.
@@ -240,9 +237,20 @@ component {
/**
* Add runner options to URL
*
+ * We pass in ALL the arguments from the run method and we will build out the URL from the options.
+ *
* @return The incorporated options and testing URL to hit
*/
private function addRunnerOptions(){
+ // Mutex options: If we have a directory, we can't have bundles
+ if ( len( arguments.directory ) ) {
+ arguments[ "bundles" ] = "";
+ }
+ // Mutex options: If we have bundles, we can't have directory
+ if ( len( arguments.bundles ) ) {
+ arguments[ "directory" ] = "";
+ }
+
// Get testbox options from package descriptor
var boxOptions = packageService.readPackageDescriptor( getCWD() ).testbox;
@@ -272,6 +280,7 @@ component {
var extraOptions = boxOptions.options ?: {};
// Add in command-specific options
extraOptions.append( arguments.options );
+
// Append to URL.
for ( var opt in extraOptions ) {
arguments.testboxURL &= "&#encodeForURL( opt )#=#encodeForURL( extraOptions[ opt ] )#";
@@ -360,95 +369,4 @@ component {
}
}
- /**
- * Discover the testbox runner URL from
- * 1) Passed argument
- * 2) box.json descriptor
- * 3) Current server descriptor
- *
- * @runner The runner argument
- */
- private function discoverRunnerUrl( runner ){
- // If a URL is passed, used it as an override
- if ( left( arguments.runner, 4 ) == "http" || left( arguments.runner, 1 ) == "/" ) {
- if ( !find( "?", arguments.runner ) ) {
- arguments.runner &= "?";
- }
- return arguments.runner;
- }
-
- // Get Runner from the box.json
- var runnerUrl = variables.testingService.getTestBoxRunner( getCWD(), arguments.runner );
-
- // Validate runner
- if ( !len( runnerUrl ) ) {
- var boxJSON = variables.packageService.readPackageDescriptor( getCWD() );
- var boxJSONRunner = boxJSON.testbox.runner ?: "";
- return error(
- "[#arguments.runner#] it not a valid runner in your box.json. Runners found are: #boxJSONRunner.toString()#"
- );
- }
-
- // Resolve relative URI, and match to the server defined in this package
- if ( left( runnerUrl, 1 ) == "/" ) {
- var serverDetails = variables.serverService.resolveServerDetails( {} );
- var serverInfo = serverDetails.serverInfo;
-
- if ( serverDetails.serverIsNew ) {
- error(
- "The test runner we found [#runnerUrl#] looks like partial URI, but we can't find any servers in this directory. Please give us a full URL."
- );
- } else {
- runnerUrl = ( serverInfo.SSLEnable ? "https://" : "http://" ) & "#serverInfo.host#:#serverInfo.port##runnerUrl#";
- }
- }
-
- // If we failed to find a URL, throw an error
- if ( left( runnerUrl, 4 ) != "http" ) {
- return error( "[#runnerUrl#] it not a valid URL, or does not match a runner slug in your box.json." );
- }
-
- if ( !find( "?", runnerUrl ) ) {
- runnerUrl &= "?";
- }
-
- return runnerUrl;
- }
-
- /**
- * Ensure that TestBox is installed
- *
- * @testboxUseLocal Use a local version of TestBox or in the execution path. Defaults to true, else it tries to download it
- */
- private function ensureTestBox( boolean testboxUseLocal = true ){
- // Where it should go in module
- var testBoxPath = variables.moduleConfig.path & "/testbox";
- var modulePath = variables.moduleConfig.path;
-
- // Check if installed locally
- if ( arguments.testboxUseLocal ) {
- testBoxPath = resolvePath( "testbox" );
- }
-
- if ( !directoryExists( testBoxPath ) ) {
- variables.print
- .blackOnWheat1( " WARN " )
- .line( " Uh-oh, TestBox could not be found locally [#testBoxPath#] or in the CLI path." )
- .green1onDodgerBlue2( " INFO " )
- .line( " We will install a local version in the CLI path [#modulePath#] for you." )
- .line()
- .toConsole();
-
- command( "install" ).params( "testbox", modulePath ).run();
- testBoxPath = modulePath & "/testbox"
- }
-
- // Add our mapping
- variables.fileSystemUtil.createMapping( "/testbox", testBoxPath );
- // variables.print
- // .green1onDodgerBlue2( " INFO " )
- // .line( " Created [/testbox] mapping at [#testBoxPath#]" )
- // .toConsole();
- }
-
}
diff --git a/commands/testbox/watch.cfc b/commands/testbox/watch.cfc
index a5aea22..1efa58d 100644
--- a/commands/testbox/watch.cfc
+++ b/commands/testbox/watch.cfc
@@ -28,10 +28,7 @@
* This command will run in the foreground until you stop it. When you are ready to shut down the watcher, press Ctrl+C.
*
**/
-component {
-
- // DI
- property name="packageService" inject="PackageService";
+component extends="testboxCLI.models.BaseCommand" {
variables.WATCH_DELAY = 500;
variables.PATHS = "**.cfc";
@@ -65,7 +62,7 @@ component {
string testSpecs
){
// Get testbox options from package descriptor
- var boxOptions = variables.packageService.readPackageDescriptor( getCWD() ).testbox;
+ var boxOptions = getTestBoxDescriptor( getCWD() );
var getOptionsWatchers = function(){
// Return to List
diff --git a/models/BaseCommand.cfc b/models/BaseCommand.cfc
new file mode 100644
index 0000000..490c714
--- /dev/null
+++ b/models/BaseCommand.cfc
@@ -0,0 +1,150 @@
+component {
+
+ // Global Injections
+ property name="settings" inject="box:modulesettings:testbox-cli";
+ property name="moduleConfig" inject="box:moduleConfig:testbox-cli";
+ property name="serverService" inject="serverService";
+ property name="packageService" inject="PackageService";
+
+ /**
+ * Ensure that TestBox is installed
+ *
+ * @testboxUseLocal Use a local version of TestBox or in the execution path. Defaults to true, else it tries to download it
+ */
+ private function ensureTestBox( boolean testboxUseLocal = true ){
+ // Where it should go in the module installed locally
+ var testBoxPath = variables.moduleConfig.path & "/testbox";
+ var modulePath = variables.moduleConfig.path;
+ var serverDetails = variables.serverService.resolveServerDetails( {} );
+ var serverInfo = serverDetails.serverInfo;
+
+ // If using local, check if we have a local version first
+ if ( arguments.testboxUseLocal ) {
+ // Check if we have a local version
+ var localTestBoxPath = resolvePath( "testbox", serverInfo.webroot );
+ if ( directoryExists( localTestBoxPath ) ) {
+ testBoxPath = localTestBoxPath;
+ }
+ }
+
+ // If we don't have one by here, then download it
+ if ( !directoryExists( testBoxPath ) ) {
+ variables.print
+ .blackOnWheat1( " WARN " )
+ .line( " Uh-oh, TestBox could not be found locally [#testBoxPath#] or in the CLI path." )
+ .green1onDodgerBlue2( " INFO " )
+ .line( " We will install a local version in the CLI path [#modulePath#] for you." )
+ .line()
+ .toConsole();
+
+ command( "install" ).params( "testbox", modulePath ).run();
+ testBoxPath = modulePath & "/testbox"
+ }
+
+ // Add our mapping
+ variables.fileSystemUtil.createMapping( "/testbox", testBoxPath );
+ // variables.print
+ // .green1onDodgerBlue2( " INFO " )
+ // .line( " Created [/testbox] mapping at [#testBoxPath#]" )
+ // .toConsole();
+ }
+
+ /**
+ * Discover the testbox runner URL from
+ * 1) Passed argument
+ * 2) box.json descriptor
+ * 3) Current server descriptor
+ *
+ * @runner The runner argument
+ */
+ private function discoverRunnerUrl( runner ){
+ // If a URL is passed, used it as an override
+ if ( left( arguments.runner, 4 ) == "http" || left( arguments.runner, 1 ) == "/" ) {
+ if ( !find( "?", arguments.runner ) ) {
+ arguments.runner &= "?";
+ }
+ return arguments.runner;
+ }
+
+ // Get Runner from the box.json
+ var runnerUrl = variables.testingService.getTestBoxRunner( getCWD(), arguments.runner );
+
+ // Validate runner
+ if ( !len( runnerUrl ) ) {
+ var boxJSON = variables.packageService.readPackageDescriptor( getCWD() );
+ var boxJSONRunner = boxJSON.testbox.runner ?: "";
+ return error(
+ "[#arguments.runner#] it not a valid runner in your box.json. Runners found are: #boxJSONRunner.toString()#"
+ );
+ }
+
+ // Resolve relative URI, and match to the server defined in this package
+ if ( left( runnerUrl, 1 ) == "/" ) {
+ var serverDetails = variables.serverService.resolveServerDetails( {} );
+ var serverInfo = serverDetails.serverInfo;
+
+ if ( serverDetails.serverIsNew ) {
+ error(
+ "The test runner we found [#runnerUrl#] looks like partial URI, but we can't find any servers in this directory. Please give us a full URL."
+ );
+ } else {
+ runnerUrl = ( serverInfo.SSLEnable ? "https://" : "http://" ) & "#serverInfo.host#:#serverInfo.port##runnerUrl#";
+ }
+ }
+
+ // If we failed to find a URL, throw an error
+ if ( left( runnerUrl, 4 ) != "http" ) {
+ return error( "[#runnerUrl#] it not a valid URL, or does not match a runner slug in your box.json." );
+ }
+
+ if ( !find( "?", runnerUrl ) ) {
+ runnerUrl &= "?";
+ }
+
+ return runnerUrl;
+ }
+
+ /**
+ * Get the testbox descriptor from the package descriptor
+ *
+ * @cwd The current working directory
+ */
+ private function getTestBoxDescriptor( required cwd ){
+ return variables.packageService.readPackageDescriptor( getCWD() ).testbox;
+ }
+
+ /**
+ * Determines if we are running on a BoxLang server
+ * or using the BoxLang runner.
+ *
+ * @cwd The current working directory
+ *
+ * @return boolean
+ */
+ private function isBoxLangProject( required cwd ){
+ // Detect if it's a BoxLang server first.
+ var serverInfo = variables.serverService.resolveServerDetails( {} ).serverInfo;
+ if ( serverInfo.cfengine.findNoCase( "boxlang" ) ) {
+ return true;
+ }
+
+ // Detect if you have the BoxLang runner set.
+ var boxOptions = variables.packageService.readPackageDescriptor( arguments.cwd );
+ if (
+ boxOptions.testbox.keyExists( "runner" )
+ && isSimpleValue( boxOptions.testbox.runner )
+ && boxOptions.testbox.runner == "boxlang"
+ ) {
+ return true;
+ }
+
+ // Language mode
+ if ( boxOptions.keyExists( "language" ) && boxOptions.language == "boxlang" ) {
+ return true;
+ }
+
+ // We don't know.
+ return false;
+ }
+
+}
diff --git a/models/CLIRenderer.cfc b/models/CLIRenderer.cfc
index b8cd486..ca0f2c5 100644
--- a/models/CLIRenderer.cfc
+++ b/models/CLIRenderer.cfc
@@ -9,6 +9,9 @@
*/
component {
+ property name="JSONPrettyPrint" inject="provider:JSONPrettyPrint";
+ property name="JSONService" inject="JSONService";
+
processingdirective pageEncoding="UTF-8";
variables.HEADER_CELL_CHARS = 7;
@@ -54,7 +57,7 @@ component {
arguments.print
.line()
.line(
- "#getIndicator( thisStatus )##thisBundle.path# (#thisBundle.totalDuration# ms)",
+ "#getIndicator( thisStatus )##thisBundle.name# (#thisBundle.totalDuration# ms)",
thisColor
)
.line(
@@ -296,6 +299,23 @@ component {
"#repeatString( " ", arguments.level + 2 )#-> Failure: #local.thisSpec.failMessage##chr( 13 )#",
COLOR.FAIL
);
+
+ param local.thisSpec.debugBuffer = [];
+ if ( verbose && !local.thisSpec.debugBuffer.isEmpty() ) {
+ print.text( repeatString( " ", level + 2 ) ).boldWhiteOnGreenLine( "Debug Buffer:" );
+ print
+ .line(
+ JSONPrettyPrint
+ .formatJSON(
+ json = local.thisSpec.debugBuffer,
+ ansiColors = JSONService.getANSIColors()
+ )
+ .listToArray( chr( 10 ) )
+ .map( ( line ) => "#repeatString( " ", level + 2 )##line#" )
+ .toList( chr( 10 ) )
+ )
+ .line();
+ }
}
if ( local.thisSpec.status == "error" ) {
@@ -340,6 +360,23 @@ component {
}
}
} );
+
+ param local.thisSpec.debugBuffer = [];
+ if ( verbose && !local.thisSpec.debugBuffer.isEmpty() ) {
+ print.text( repeatString( " ", level + 2 ) ).boldWhiteOnGreenLine( "Debug Buffer:" );
+ print
+ .line(
+ JSONPrettyPrint
+ .formatJSON(
+ json = local.thisSpec.debugBuffer,
+ ansiColors = JSONService.getANSIColors()
+ )
+ .listToArray( chr( 10 ) )
+ .map( ( line ) => "#repeatString( " ", level + 2 )##line#" )
+ .toList( chr( 10 ) )
+ )
+ .line();
+ }
}
}
diff --git a/templates/testbox/test-visualizer/bdd.txt b/templates/bx/bdd.txt
similarity index 55%
rename from templates/testbox/test-visualizer/bdd.txt
rename to templates/bx/bdd.txt
index 66a1a5d..8a76466 100644
--- a/templates/testbox/test-visualizer/bdd.txt
+++ b/templates/bx/bdd.txt
@@ -1,34 +1,30 @@
/**
* My BDD Test
*/
-component extends="testbox.system.BaseSpec"{
+class extends="testbox.system.BaseSpec"{
/*********************************** LIFE CYCLE Methods ***********************************/
// executes before all suites+specs in the run() method
function beforeAll(){
+
}
// executes after all suites+specs in the run() method
function afterAll(){
+
}
/*********************************** BDD SUITES ***********************************/
- function run(){
-
- describe( "My test Suite", function(){
-
- it( "should do something", function(){
- expect( false ).toBeTrue();
- });
-
- it( "should do something else", function(){
- expect( false ).toBeTrue();
- });
+ function run( testResults, testBox ){
+ describe( "My First Suite", () => {
- });
+ it( "A Spec", () => {
+ fail( 'implement' );
+ })
+ })
}
-}
\ No newline at end of file
+}
diff --git a/templates/bx/browser/Application.bx b/templates/bx/browser/Application.bx
new file mode 100644
index 0000000..98a12e9
--- /dev/null
+++ b/templates/bx/browser/Application.bx
@@ -0,0 +1,29 @@
+/**
+ * Copyright Since 2005 Ortus Solutions, Corp
+ * www.ortussolutions.com
+ * *************************************************************************************
+ */
+class {
+ this.name = "Test Browser";
+
+ // The mapping to easily access the tests
+ this.mappings[ "/tests" ] = getDirectoryFromPath( getCurrentTemplatePath() );
+ // The mapping to easily access the root application usually the parent folder
+ this.mappings[ "/root" ] = expandPath( "/../" );
+
+ // Any application settings go here
+
+ /**
+ * Executes BEFORE any runner or test requested.
+ */
+ boolean function onRequestStart( String targetPage ){
+ return true;
+ }
+
+ /**
+ * Executes AFTER any runner or test requested.
+ */
+ void function onRequestEnd( String targetPage ){
+ }
+
+}
diff --git a/templates/bx/browser/index.bxm b/templates/bx/browser/index.bxm
new file mode 100644
index 0000000..77d6df2
--- /dev/null
+++ b/templates/bx/browser/index.bxm
@@ -0,0 +1,187 @@
++ Below is a listing of the runners matching the "runner*.(cfm|bxm)" pattern. +
+ +
+ + Below is a listing of the runners matching the "runner*.(cfm|bxm)" pattern. +
+ +
+ - Below is a listing of the runners matching the "runner*.cfm" pattern. -
- -
- v@build.version@+@build.number@
- 
+