Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cwingrav/CIModelTester

A CodeIgniter interactive model tester web interface. Directly call your model functionality for testing and debugging.
https://github.com/cwingrav/CIModelTester

Last synced: 3 days ago
JSON representation

A CodeIgniter interactive model tester web interface. Directly call your model functionality for testing and debugging.

Awesome Lists containing this project

README 

        
# CIModelTester

A CodeIgniter interactive model tester web interface. Directly call your model functionality for testing and debugging.



## Usage

Load in your browser: `http:///index.php/CIModelTester`. You'll see the main CIModelTester page.






Then, click on a model to see the model page. 






From here, type parameters into the fields to pass data to a method.  In the image below, the model `RecData_model` has method `getUserInterests` with one parameter `uid`. When I enter `2`, it returns the one interest of that user and displays the return value of the method as JSON (i.e. CIModelTester uses ajax to call your method and passes the data as JSON). Note: methods that take arrays can be called with brackets. i.e. [1,2,3] would be equivalent to php's `array(1,2,3)`.






NOTE: If you use proper code documentation, it even prints the comments! You can toggle the comments on, as they are off by default. 

NOTE2: The `toggle` button collapses the returned data after a query. Sometimes the return is long so I added this in. 

NOTE3: The `unit test` button goes directly to the unit test case for that method. If it does not exist, it will tell you.



## Installation



### Quick Install

* Put `modeltester.php` into your controllers directory.



### For Tailored Use

* Put `modeltester.php` into your CodeIgnite 'libraries' folder. 

* Create a new controller `MyModelTester.php` in your 'controllers' folder, passing in an array of the models you wish to test. ex "`array('model1_model','model2_model')`".

```



```

* That's it! Load it up at http:///index.php/MyModelTester



## Unit Testing Models



You can write CodeIngniter unit tests for your models and run them via this interface. Open the model and click 'run unit tests'. It will load the APPDATA/models/tests/test_[modelname].php file and execute the tests. If this file does not exist, it gives you sample data to get started writing one and tells you the directory location to put it. (NOTE: For models in subdirectories, create your 'tests' directory in those subdirectories. Nifty huh...)



### Testing Methods Run

This runs a generic test and searches for method-specific tests.

* test()   - always called.

* onExit() - called at the end of running your model. 

* test_\[method\]() - the test method for you to implement. Returned values are displayed after the CodeIgniter unit test information. Use the pack_ret function to format any data in this method for return.



### Default Unit Test

Here's what the suggested unit test is for my 'content_model.php' file, where I wrote one empty test for the method test_getUnderReviewStats.






## How it works?



It sends an Ajax call to CIModelTester->model_test and returns the results in JSON to your page. Nifty.



## Security Concerns



!GOOD HEAVENS YES! This is like handing the keys to your application to anyone that finds this controller. DON'T PUT INTO PRODUCTION CODE! To mitigate this risk, it does not function if you set your CodeIgniter project state to anything other than 'development' or 'testing' and you can turn it off by setting the second parameter to CIModelTester to be false.



Also, for unit tests, only runs in 'testing' environment.