26 |
29 |
30 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2017 Eric Peterson
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/tests/specs/integration/IncompleteRequestsSpec.cfc:
--------------------------------------------------------------------------------
1 | component extends="tests.resources.ModuleIntegrationSpec" appMapping="/app" {
2 |
3 | variables.localEndpoint = "http://#CGI[ "server_name" ]#:#CGI[ "server_port" ]#/tests/resources/app/index.cfm/api";
4 |
5 | function run() {
6 | describe( "incomplete requests", function() {
7 | beforeEach( function() {
8 | variables.hyper = getInstance( "HyperBuilder@Hyper" );
9 | } );
10 |
11 | afterEach( function() {
12 | if ( structKeyExists( variables, "hyper" ) ) {
13 | structDelete( variables, "hyper" );
14 | }
15 | } );
16 |
17 | it( "returns a 502 status code for any request that cannot be completed", function() {
18 | var res = hyper.get( "https://does-not-exist.also-does-not-exist" );
19 | expect( res.getStatusCode() ).toBe( 502 );
20 | expect( res.getStatusText() ).toBe( "Bad Gateway" );
21 | } );
22 |
23 | it( "returns a 408 status code for any request that times out", function() {
24 | var res = hyper.setTimeout( 1 ).get( "#localEndpoint#/sleep/delay/5" );
25 | expect( res.getStatusCode() ).toBe( 408 );
26 | expect( res.getStatusText() ).toBe( "Request Timeout" );
27 | } );
28 | } );
29 | }
30 |
31 | }
32 |
--------------------------------------------------------------------------------
/tests/Application.cfc:
--------------------------------------------------------------------------------
1 | component {
2 |
3 | this.name = "ColdBoxTestingSuite" & hash(getCurrentTemplatePath());
4 | this.sessionManagement = true;
5 | this.setClientCookies = true;
6 | this.sessionTimeout = createTimeSpan( 0, 0, 15, 0 );
7 | this.applicationTimeout = createTimeSpan( 0, 0, 15, 0 );
8 |
9 | testsPath = getDirectoryFromPath( getCurrentTemplatePath() );
10 | this.mappings[ "/tests" ] = testsPath;
11 | rootPath = REReplaceNoCase( this.mappings[ "/tests" ], "tests(\\|/)", "" );
12 | this.mappings[ "/root" ] = rootPath;
13 | this.mappings[ "/hyper" ] = rootPath;
14 | this.mappings[ "/globber" ] = rootPath & "modules/globber";
15 | testingModuleRootMapping = listDeleteAt( rootPath, listLen( rootPath, '\/' ), "\/" );
16 | if ( left( testingModuleRootMapping, 1 ) != "/" ) {
17 | testingModuleRootMapping = "/" & testingModuleRootMapping;
18 | }
19 | this.mappings[ "/testingModuleRoot" ] = testingModuleRootMapping;
20 | this.mappings[ "/app" ] = testsPath & "resources/app";
21 | this.mappings[ "/coldbox" ] = testsPath & "resources/app/coldbox";
22 | this.mappings[ "/testbox" ] = rootPath & "/testbox";
23 |
24 | // function onRequestStart() {
25 | // applicationStop();
26 | // abort;
27 | // }
28 |
29 | }
30 |
--------------------------------------------------------------------------------
/tests/resources/app/config/WireBox.cfc:
--------------------------------------------------------------------------------
1 | component extends="coldbox.system.ioc.config.Binder" {
2 |
3 | /**
4 | * Configure WireBox, that's it!
5 | */
6 | function configure() {
7 | // The WireBox configuration structure DSL
8 | wireBox = {
9 | // Scope registration, automatically register a wirebox injector instance on any CF scope
10 | // By default it registeres itself on application scope
11 | "scopeRegistration" : {
12 | "enabled" : true,
13 | "scope" : "application", // server, cluster, session, application
14 | "key" : "wireBox"
15 | },
16 | // DSL Namespace registrations
17 | "customDSL" : {},
18 | // Custom Storage Scopes
19 | "customScopes" : {},
20 | // Package scan locations
21 | "scanLocations" : [],
22 | // Stop Recursions
23 | "stopRecursions" : [],
24 | // Parent Injector to assign to the configured injector, this must be an object reference
25 | "parentInjector" : "",
26 | // Register all event listeners here, they are created in the specified order
27 | "listeners" : []
28 | };
29 |
30 | // Map Bindings below
31 | map( "SWAPIClient" )
32 | .to( "hyper.models.HyperBuilder" )
33 | .asSingleton()
34 | .initWith( baseUrl = "https://swapi.dev/api" );
35 |
36 | map( "JSONPlaceholderClient" )
37 | .to( "hyper.models.HyperBuilder" )
38 | .asSingleton()
39 | .initWith( baseUrl = "https://jsonplaceholder.typicode.com" );
40 | }
41 |
42 | }
43 |
--------------------------------------------------------------------------------
/tests/specs/integration/BuilderPassThroughSpec.cfc:
--------------------------------------------------------------------------------
1 | component extends="tests.resources.ModuleIntegrationSpec" appMapping="/app" {
2 |
3 | function run() {
4 | describe( "Builder pass through requests", function() {
5 | beforeEach( function() {
6 | variables.hyper = getInstance( "HyperBuilder@Hyper" );
7 | } );
8 |
9 | afterEach( function() {
10 | if ( structKeyExists( variables, "hyper" ) ) {
11 | structDelete( variables, "hyper" );
12 | }
13 | } );
14 |
15 | it( "passes through all other methods to the HyperRequest", function() {
16 | var res = hyper.setUrl( "https://jsonplaceholder.typicode.com/posts/1" ).get();
17 | expect( res ).toBeInstanceOf( "HyperResponse", "A HyperResponse object should have been returned." );
18 | var data = res.json();
19 | expect( data ).toBeStruct( "Expected to deserialize JSON data from the response." );
20 | expect( data ).toBe(
21 | deserializeJSON(
22 | "{
23 | ""userId"": 1,
24 | ""id"": 1,
25 | ""title"": ""sunt aut facere repellat provident occaecati excepturi optio reprehenderit"",
26 | ""body"": ""quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto""
27 | }"
28 | )
29 | );
30 | } );
31 | } );
32 | }
33 |
34 | }
35 |
--------------------------------------------------------------------------------
/tests/specs/integration/FileUploadsSpec.cfc:
--------------------------------------------------------------------------------
1 | component extends="tests.resources.ModuleIntegrationSpec" appMapping="/app" {
2 |
3 | variables.localEndpoint = "http://#CGI[ "server_name" ]#:#CGI[ "server_port" ]#/tests/resources/app/index.cfm/api";
4 |
5 | function run() {
6 | describe( "File Uploads requests", function() {
7 | beforeEach( function() {
8 | variables.hyper = getInstance( "HyperBuilder@Hyper" );
9 | } );
10 |
11 | afterEach( function() {
12 | if ( structKeyExists( variables, "hyper" ) ) {
13 | structDelete( variables, "hyper" );
14 | }
15 | } );
16 |
17 | it( "can attach files", function() {
18 | if ( isBoxLang() ) {
19 | return skip( "File uploads work but have a bug that prevents it from passing on the first time." );
20 | }
21 |
22 | var res = hyper
23 | .attach(
24 | "smallPhoto",
25 | expandPath( "/tests/resources/chuck_norris.jpg" ),
26 | "image/jpeg"
27 | )
28 | .attach( "largePhoto", expandPath( "/tests/resources/chuck_norris.jpg" ) )
29 | .post(
30 | "#localEndpoint#/photos",
31 | { "description" : "Chuck Norris doesn't need two different photos." }
32 | );
33 | expect( res.getStatusCode() ).toBe( 201, res.getData() );
34 | var json = res.json();
35 | expect( json.smallPhoto ).toBe( "chuck_norris.jpg" );
36 | expect( json.largePhoto ).toBe( "chuck_norris.jpg" );
37 | expect( json.description ).toBe( "Chuck Norris doesn't need two different photos." );
38 | } );
39 | } );
40 | }
41 |
42 | }
43 |
--------------------------------------------------------------------------------
/tests/resources/app/handlers/Main.cfc:
--------------------------------------------------------------------------------
1 | component extends="coldbox.system.EventHandler" {
2 |
3 | /**
4 | * Default Action
5 | */
6 | function index( event, rc, prc ) {
7 | prc.welcomeMessage = "Welcome to ColdBox!";
8 | event.setView( "main/index" );
9 | }
10 |
11 | /**
12 | * Produce some restfulf data
13 | */
14 | function data( event, rc, prc ) {
15 | return [
16 | { "id" : createUUID(), name : "Luis" },
17 | { "id" : createUUID(), name : "JOe" },
18 | { "id" : createUUID(), name : "Bob" },
19 | { "id" : createUUID(), name : "Darth" }
20 | ];
21 | }
22 |
23 | /**
24 | * Relocation example
25 | */
26 | function doSomething( event, rc, prc ) {
27 | relocate( "main.index" );
28 | }
29 |
30 | /************************************** IMPLICIT ACTIONS *********************************************/
31 |
32 | function onAppInit( event, rc, prc ) {
33 | }
34 |
35 | function onRequestStart( event, rc, prc ) {
36 | }
37 |
38 | function onRequestEnd( event, rc, prc ) {
39 | }
40 |
41 | function onSessionStart( event, rc, prc ) {
42 | }
43 |
44 | function onSessionEnd( event, rc, prc ) {
45 | var sessionScope = event.getValue( "sessionReference" );
46 | var applicationScope = event.getValue( "applicationReference" );
47 | }
48 |
49 | function onException( event, rc, prc ) {
50 | event.setHTTPHeader( statusCode = 500 );
51 | // Grab Exception From private request collection, placed by ColdBox Exception Handling
52 | var exception = prc.exception;
53 | // Place exception handler below:
54 | }
55 |
56 | }
57 |
--------------------------------------------------------------------------------
/tests/resources/app/views/_templates/generic_error.cfm:
--------------------------------------------------------------------------------
1 | The page you requested does not exist.
27 |You may have mistyped the address or the page may have moved. Please check your address again.
28 |An Unhandled Exception Occurred
3 || An unhandled exception has occurred. Please look at the diagnostic information below: | 7 ||
| Type | 10 |#exception.getType()# | 11 |
| Message | 14 |#exception.getMessage()# | 15 |
| Detail | 18 |#exception.getDetail()# | 19 |
| Extended Info | 22 |#exception.getExtendedInfo()# | 23 |
| Message | 26 |#exception.getMessage()# | 27 |
| Tag Context | 30 |
31 | 35 | |
37 |
| Stack Trace | 40 |#exception.getStackTrace()# | 41 |
hyper
2 |
3 | 
4 | 
5 |
#renderView()#
79 |
80 |
93 |
94 |
102 |
103 |
104 | Invalid incoming directory: #rootMapping & url.path#
69 | Invalid incoming directory: #rootMapping & url.path#
147 |
189 |
190 |
191 |
192 |
193 |
194 |
195 |
196 |
3 |
23 |
24 |
4 |
22 |
5 | 
6 |
12 |
13 |
6 | 7 | 8 | Read ColdBox Manual 9 | 10 |
11 |
14 |
21 | #prc.welcomeMessage#
15 |16 | You are now running #getSetting("codename",1)# #getSetting("version",1)# (#getsetting("suffix",1)#). 17 | Welcome to the next generation of ColdFusion (CFML) applications. You can now start building your application with ease, we already did the hard work 18 | for you. 19 |
20 |
25 |
242 |
26 |
27 |
28 |
43 |
44 |
45 |
57 |
59 |
60 |
61 |
62 |
71 |
72 |
116 |
117 |
118 |
119 |
124 |
125 |
142 |
143 |
144 |
145 |
190 |
191 |
192 |
193 |
29 |
33 | 30 | Registered Event Handlers 31 |
32 |34 | You can click on the following event handlers to execute their default action 35 | index() 36 |
37 |-
38 |
- #handler# 40 |
46 |
50 | 47 | Registered Modules 48 |
49 |Below are your application's loaded modules, click on them to visit them.
51 |-
52 |
- #thisModule# 54 |
There are no modules in your application
58 |
63 |
67 | 64 | Application Test Harness 65 |
66 |
68 | You can find your entire test harness in the following location: #getSetting("ApplicationPath")#tests
69 |
| File/Folder | 73 |Description | 74 | 75 | 76 |
|---|---|
| 78 | specs 79 | | 80 |Where all your bdd, module, unit and integration tests go | 81 |
| 84 | results 85 | | 86 |Where automated test results go | 87 |
| 90 | resources 91 | | 92 |93 | Test resources like fixtures, itegrations, etc. 94 | | 95 |
| 98 | Application.cfc 99 | | 100 |A unique Application.cfc for your testing harness, please spice up as needed. | 101 |
| 104 | test.xml 105 | | 106 |A script for executing all application tests via TestBox ANT | 107 |
| 110 | runner.cfm 111 | | 112 |A TestBox runner so you can execute your tests. | 113 |
120 |
122 | ColdBox URL Actions
121 |ColdBox can use some very important URL actions to interact with your application. You can try them out below:
123 || URL Action | 126 |Description | 127 |Execute | 128 | 129 | 130 |
|---|---|---|
|
132 | ?fwreinit=1 133 | ?fwreinit={ReinitPassword} 134 | |
135 | Reinitialize the Application | 136 |137 | Execute 138 | | 139 |
146 |
148 | Customizing your Application
147 |149 | You can now start editing your application and building great ColdBox enabled apps. Important files & locations: 150 |
151 |-
152 |
-
153 |
/config/ColdBox.cfc: Your application configuration file 154 |
155 | -
156 |
/config/Routes.cfm: Your URL Mappings 157 |
158 | -
159 |
/config/WireBox.cfc: Your WireBox Binder 160 |
161 | -
162 |
/handlers: Your application event handlers 163 |
164 | -
165 |
/interceptors: System interceptors 166 |
167 | -
168 |
/includes: Assets, Helpers, i18n, templates and more. 169 |
170 | -
171 |
/layouts:Your application skin layouts 172 |
173 | -
174 |
/lib: Where Jar files can be integrated 175 |
176 | -
177 |
/models: Your model layer 178 |
179 | -
180 |
/modules: Your application modules 181 |
182 | -
183 |
/tests: Your BDD testing harness (Just DO IT!!) 184 |
185 | -
186 |
/views: Your application views 187 |
188 |
194 |
241 |
195 |
239 |
240 |