mirror of
https://github.com/codeigniter4/CodeIgniter4.git
synced 2025-02-20 11:44:28 +08:00
650 lines
45 KiB
HTML
650 lines
45 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>Testing Controllers — CodeIgniter 4.0.4 documentation</title>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
|
||
|
||
|
||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||
|
||
|
||
|
||
|
||
|
||
<!--[if lt IE 9]>
|
||
<script src="../_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/underscore.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<script src="../_static/language_data.js"></script>
|
||
<script src="../_static/js/citheme.js"></script>
|
||
<script src="../_static/js/carbon.js"></script>
|
||
|
||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||
|
||
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="HTTP Feature Testing" href="feature.html" />
|
||
<link rel="prev" title="Generating Test Data" href="fabricator.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" style="background: #DD4814" >
|
||
|
||
|
||
|
||
<a href="../index.html">
|
||
|
||
|
||
|
||
|
||
<img src="../_static/ci-logo-text.png" class="logo" alt="Logo"/>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../intro/index.html">Welcome to CodeIgniter4</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../intro/index.html">Welcome to CodeIgniter4</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../intro/requirements.html">Server Requirements</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../intro/credits.html">Credits</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../intro/psr.html">PSR Compliance</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/installing_composer.html">Composer Installation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/installing_manual.html">Manual Installation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/running.html">Running Your App</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../installation/repositories.html">CodeIgniter Repositories</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Build Your First Application</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../concepts/index.html">CodeIgniter4 Overview</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/structure.html">Application Structure</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/mvc.html">Models, Views, and Controllers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/autoloader.html">Autoloading Files</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/services.html">Services</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/factories.html">Factories</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/http.html">Working With HTTP Requests</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../concepts/security.html">Security Guidelines</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/configuration.html">Configuration</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helper Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Global Functions and Constants</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/logging.html">Logging Information</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Web Page Caching</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/ajax.html">AJAX Requests</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/modules.html">Code Modules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../incoming/index.html">Controllers and Routing</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/controllers.html">Controllers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/routing.html">URI Routing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/filters.html">Controller Filters</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/message.html">HTTP Messages</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/request.html">Request Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/incomingrequest.html">IncomingRequest Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/content_negotiation.html">Content Negotiation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/methodspoofing.html">HTTP Method Spoofing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../incoming/restful.html">RESTful Resource Handling</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../outgoing/index.html">Building Responses</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/views.html">Views</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_cells.html">View Cells</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_renderer.html">View Renderer</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_layouts.html">View Layouts</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/view_parser.html">View Parser</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/table.html">HTML Table Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/response.html">HTTP Responses</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/api_responses.html">API Response Trait</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/localization.html">Localization</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../outgoing/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Working With Databases</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/events.html">Database Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../models/index.html">Modeling Data</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../models/model.html">Using CodeIgniter's Model</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../models/entities.html">Using Entity Classes</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../dbmgmt/index.html">Managing Databases</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../dbmgmt/forge.html">Database Manipulation with Database Forge</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../dbmgmt/migration.html">Database Migrations</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../dbmgmt/seeds.html">Database Seeding</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Library Reference</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/curlrequest.html">CURLRequest Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Service</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/files.html">Working with Files</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/honeypot.html">Honeypot Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/images.html">Image Manipulation Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/throttler.html">Throttler</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/time.html">Dates and Times</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/uploaded_files.html">Working with Uploaded Files</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">Working with URIs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../libraries/validation.html">Validation</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/filesystem_helper.html">Filesystem Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/test_helper.html">Test Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Testing</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="overview.html">Getting Started</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="database.html">Database</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="fabricator.html">Generating Data</a></li>
|
||
<li class="toctree-l2 current"><a class="current reference internal" href="#">Controller Testing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="feature.html">HTTP Testing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="benchmark.html">Benchmarking</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="debugging.html">Debugging Your Application</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../cli/index.html">Command Line Usage</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli.html">Running via the Command Line</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_commands.html">Custom CLI Commands</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_generators.html">CLI Generators</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_library.html">CLI Library</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../cli/cli_request.html">CLIRequest Class</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../extending/index.html">Extending CodeIgniter</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../extending/core_classes.html">Creating Core System Classes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../extending/common.html">Replacing Common Functions</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../extending/events.html">Events</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../extending/basecontroller.html">Extending the Controller</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../extending/authentication.html">Authentication</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../extending/contributing.html">Contributing to CodeIgniter</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../index.html">CodeIgniter</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="../index.html" class="icon icon-home"></a> »</li>
|
||
|
||
<li><a href="index.html">Testing</a> »</li>
|
||
|
||
<li>Testing Controllers</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<div class="section" id="testing-controllers">
|
||
<h1>Testing Controllers<a class="headerlink" href="#testing-controllers" title="Permalink to this headline">¶</a></h1>
|
||
<p>Testing your controllers is made convenient with a couple of new helper classes and traits. When testing controllers,
|
||
you can execute the code within a controller, without first running through the entire application bootstrap process.
|
||
Often times, using the <a class="reference external" href="feature.html">Feature Testing tools</a> will be simpler, but this functionality is here in
|
||
case you need it.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>Because the entire framework has not been bootstrapped, there will be times when you cannot test a controller
|
||
this way.</p>
|
||
</div>
|
||
<div class="section" id="the-helper-trait">
|
||
<h2>The Helper Trait<a class="headerlink" href="#the-helper-trait" title="Permalink to this headline">¶</a></h2>
|
||
<p>You can use either of the base test classes, but you do need to use the <code class="docutils literal notranslate"><span class="pre">ControllerTester</span></code> trait
|
||
within your tests:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span> <span class="k">namespace</span> <span class="nx">CodeIgniter</span><span class="p">;</span>
|
||
|
||
<span class="k">use</span> <span class="nx">CodeIgniter\Test\ControllerTester</span><span class="p">;</span>
|
||
|
||
<span class="k">class</span> <span class="nc">TestControllerA</span> <span class="k">extends</span> <span class="nx">\CIDatabaseTestCase</span>
|
||
<span class="p">{</span>
|
||
<span class="k">use</span> <span class="nx">ControllerTester</span><span class="p">;</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Once the trait has been included, you can start setting up the environment, including the request and response classes,
|
||
the request body, URI, and more. You specify the controller to use with the <code class="docutils literal notranslate"><span class="pre">controller()</span></code> method, passing in the
|
||
fully qualified class name of your controller. Finally, call the <code class="docutils literal notranslate"><span class="pre">execute()</span></code> method with the name of the method
|
||
to run as the parameter:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="o"><?</span><span class="nx">php</span> <span class="k">namespace</span> <span class="nx">CodeIgniter</span><span class="p">;</span>
|
||
|
||
<span class="k">use</span> <span class="nx">CodeIgniter\Test\ControllerTester</span><span class="p">;</span>
|
||
|
||
<span class="k">class</span> <span class="nc">TestControllerA</span> <span class="k">extends</span> <span class="nx">\CIDatabaseTestCase</span>
|
||
<span class="p">{</span>
|
||
<span class="k">use</span> <span class="nx">ControllerTester</span><span class="p">;</span>
|
||
|
||
<span class="k">public</span> <span class="k">function</span> <span class="nf">testShowCategories</span><span class="p">()</span>
|
||
<span class="p">{</span>
|
||
<span class="nv">$result</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">withURI</span><span class="p">(</span><span class="s1">'http://example.com/categories'</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">controller</span><span class="p">(</span><span class="nx">\App\Controllers\ForumController</span><span class="o">::</span><span class="na">class</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">execute</span><span class="p">(</span><span class="s1">'showCategories'</span><span class="p">);</span>
|
||
|
||
<span class="nv">$this</span><span class="o">-></span><span class="na">assertTrue</span><span class="p">(</span><span class="nv">$result</span><span class="o">-></span><span class="na">isOK</span><span class="p">());</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="helper-methods">
|
||
<h2>Helper Methods<a class="headerlink" href="#helper-methods" title="Permalink to this headline">¶</a></h2>
|
||
<p><strong>controller($class)</strong></p>
|
||
<p>Specifies the class name of the controller to test. The first parameter must be a fully qualified class name
|
||
(i.e. include the namespace):</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-></span><span class="na">controller</span><span class="p">(</span><span class="nx">\App\Controllers\ForumController</span><span class="o">::</span><span class="na">class</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>execute($method)</strong></p>
|
||
<p>Executes the specified method within the controller. The only parameter is the name of the method to run:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$results</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">controller</span><span class="p">(</span><span class="nx">\App\Controllers\ForumController</span><span class="o">::</span><span class="na">class</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">execute</span><span class="p">(</span><span class="s1">'showCategories'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>This returns a new helper class that provides a number of routines for checking the response itself. See below
|
||
for details.</p>
|
||
<p><strong>withConfig($config)</strong></p>
|
||
<p>Allows you to pass in a modified version of <strong>ConfigApp.php</strong> to test with different settings:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$config</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Config\App</span><span class="p">();</span>
|
||
<span class="nv">$config</span><span class="o">-></span><span class="na">appTimezone</span> <span class="o">=</span> <span class="s1">'America/Chicago'</span><span class="p">;</span>
|
||
|
||
<span class="nv">$results</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">withConfig</span><span class="p">(</span><span class="nv">$config</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">controller</span><span class="p">(</span><span class="nx">\App\Controllers\ForumController</span><span class="o">::</span><span class="na">class</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">execute</span><span class="p">(</span><span class="s1">'showCategories'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>If you do not provide one, the application’s App config file will be used.</p>
|
||
<p><strong>withRequest($request)</strong></p>
|
||
<p>Allows you to provide an <strong>IncomingRequest</strong> instance tailored to your testing needs:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$request</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">CodeIgniter\HTTP\IncomingRequest</span><span class="p">(</span><span class="k">new</span> <span class="nx">Config\App</span><span class="p">(),</span> <span class="k">new</span> <span class="nx">URI</span><span class="p">(</span><span class="s1">'http://example.com'</span><span class="p">));</span>
|
||
<span class="nv">$request</span><span class="o">-></span><span class="na">setLocale</span><span class="p">(</span><span class="nv">$locale</span><span class="p">);</span>
|
||
|
||
<span class="nv">$results</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">withRequest</span><span class="p">(</span><span class="nv">$request</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">controller</span><span class="p">(</span><span class="nx">\App\Controllers\ForumController</span><span class="o">::</span><span class="na">class</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">execute</span><span class="p">(</span><span class="s1">'showCategories'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>If you do not provide one, a new IncomingRequest instance with the default application values will be passed
|
||
into your controller.</p>
|
||
<p><strong>withResponse($response)</strong></p>
|
||
<p>Allows you to provide a <strong>Response</strong> instance:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$response</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">CodeIgniter\HTTP\Response</span><span class="p">(</span><span class="k">new</span> <span class="nx">Config\App</span><span class="p">());</span>
|
||
|
||
<span class="nv">$results</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">withResponse</span><span class="p">(</span><span class="nv">$response</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">controller</span><span class="p">(</span><span class="nx">\App\Controllers\ForumController</span><span class="o">::</span><span class="na">class</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">execute</span><span class="p">(</span><span class="s1">'showCategories'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>If you do not provide one, a new Response instance with the default application values will be passed
|
||
into your controller.</p>
|
||
<p><strong>withLogger($logger)</strong></p>
|
||
<p>Allows you to provide a <strong>Logger</strong> instance:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$logger</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">CodeIgniter\Log\Handlers\FileHandler</span><span class="p">();</span>
|
||
|
||
<span class="nv">$results</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">withResponse</span><span class="p">(</span><span class="nv">$response</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">withLogger</span><span class="p">(</span><span class="nv">$logger</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">controller</span><span class="p">(</span><span class="nx">\App\Controllers\ForumController</span><span class="o">::</span><span class="na">class</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">execute</span><span class="p">(</span><span class="s1">'showCategories'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>If you do not provide one, a new Logger instance with the default configuration values will be passed
|
||
into your controller.</p>
|
||
<p><strong>withURI($uri)</strong></p>
|
||
<p>Allows you to provide a new URI that simulates the URL the client was visiting when this controller was run.
|
||
This is helpful if you need to check URI segments within your controller. The only parameter is a string
|
||
representing a valid URI:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$results</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">withURI</span><span class="p">(</span><span class="s1">'http://example.com/forums/categories'</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">controller</span><span class="p">(</span><span class="nx">\App\Controllers\ForumController</span><span class="o">::</span><span class="na">class</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">execute</span><span class="p">(</span><span class="s1">'showCategories'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>It is a good practice to always provide the URI during testing to avoid surprises.</p>
|
||
<p><strong>withBody($body)</strong></p>
|
||
<p>Allows you to provide a custom body for the request. This can be helpful when testing API controllers where
|
||
you need to set a JSON value as the body. The only parameter is a string that represents the body of the request:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$body</span> <span class="o">=</span> <span class="nb">json_encode</span><span class="p">([</span><span class="s1">'foo'</span> <span class="o">=></span> <span class="s1">'bar'</span><span class="p">]);</span>
|
||
|
||
<span class="nv">$results</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">withBody</span><span class="p">(</span><span class="nv">$body</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">controller</span><span class="p">(</span><span class="nx">\App\Controllers\ForumController</span><span class="o">::</span><span class="na">class</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">execute</span><span class="p">(</span><span class="s1">'showCategories'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="checking-the-response">
|
||
<h2>Checking the Response<a class="headerlink" href="#checking-the-response" title="Permalink to this headline">¶</a></h2>
|
||
<p>When the controller is executed, a new <strong>ControllerResponse</strong> instance will be returned that provides a number
|
||
of helpful methods, as well as direct access to the Request and Response that were generated.</p>
|
||
<p><strong>isOK()</strong></p>
|
||
<p>This provides a simple check that the response would be considered a “successful” response. This primarily checks that
|
||
the HTTP status code is within the 200 or 300 ranges:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$results</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">withBody</span><span class="p">(</span><span class="nv">$body</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">controller</span><span class="p">(</span><span class="nx">\App\Controllers\ForumController</span><span class="o">::</span><span class="na">class</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">execute</span><span class="p">(</span><span class="s1">'showCategories'</span><span class="p">);</span>
|
||
|
||
<span class="k">if</span> <span class="p">(</span><span class="nv">$results</span><span class="o">-></span><span class="na">isOK</span><span class="p">())</span>
|
||
<span class="p">{</span>
|
||
<span class="o">.</span> <span class="o">.</span> <span class="o">.</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>isRedirect()</strong></p>
|
||
<p>Checks to see if the final response was a redirection of some sort:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$results</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">withBody</span><span class="p">(</span><span class="nv">$body</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">controller</span><span class="p">(</span><span class="nx">\App\Controllers\ForumController</span><span class="o">::</span><span class="na">class</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">execute</span><span class="p">(</span><span class="s1">'showCategories'</span><span class="p">);</span>
|
||
|
||
<span class="k">if</span> <span class="p">(</span><span class="nv">$results</span><span class="o">-></span><span class="na">isRedirect</span><span class="p">())</span>
|
||
<span class="p">{</span>
|
||
<span class="o">.</span> <span class="o">.</span> <span class="o">.</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>request()</strong></p>
|
||
<p>You can access the Request object that was generated with this method:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$results</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">withBody</span><span class="p">(</span><span class="nv">$body</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">controller</span><span class="p">(</span><span class="nx">\App\Controllers\ForumController</span><span class="o">::</span><span class="na">class</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">execute</span><span class="p">(</span><span class="s1">'showCategories'</span><span class="p">);</span>
|
||
|
||
<span class="nv">$request</span> <span class="o">=</span> <span class="nv">$results</span><span class="o">-></span><span class="na">request</span><span class="p">();</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>response()</strong></p>
|
||
<p>This allows you access to the response object that was generated, if any:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$results</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">withBody</span><span class="p">(</span><span class="nv">$body</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">controller</span><span class="p">(</span><span class="nx">\App\Controllers\ForumController</span><span class="o">::</span><span class="na">class</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">execute</span><span class="p">(</span><span class="s1">'showCategories'</span><span class="p">);</span>
|
||
|
||
<span class="nv">$response</span> <span class="o">=</span> <span class="nv">$results</span><span class="o">-></span><span class="na">response</span><span class="p">();</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>getBody()</strong></p>
|
||
<p>You can access the body of the response that would have been sent to the client with the <strong>getBody()</strong> method. This could
|
||
be generated HTML, or a JSON response, etc.:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="nv">$results</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">withBody</span><span class="p">(</span><span class="nv">$body</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">controller</span><span class="p">(</span><span class="nx">\App\Controllers\ForumController</span><span class="o">::</span><span class="na">class</span><span class="p">)</span>
|
||
<span class="o">-></span><span class="na">execute</span><span class="p">(</span><span class="s1">'showCategories'</span><span class="p">);</span>
|
||
|
||
<span class="nv">$body</span> <span class="o">=</span> <span class="nv">$results</span><span class="o">-></span><span class="na">getBody</span><span class="p">();</span>
|
||
</pre></div>
|
||
</div>
|
||
<div class="section" id="response-helper-methods">
|
||
<h3>Response Helper methods<a class="headerlink" href="#response-helper-methods" title="Permalink to this headline">¶</a></h3>
|
||
<p>The response you get back contains a number of helper methods to inspect the HTML output within the response. These
|
||
are useful for using within assertions in your tests.</p>
|
||
<p>The <strong>see()</strong> method checks the text on the page to see if it exists either by itself, or more specifically within
|
||
a tag, as specified by type, class, or id:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="c1">// Check that "Hello World" is on the page</span>
|
||
<span class="nv">$results</span><span class="o">-></span><span class="na">see</span><span class="p">(</span><span class="s1">'Hello World'</span><span class="p">);</span>
|
||
<span class="c1">// Check that "Hello World" is within an h1 tag</span>
|
||
<span class="nv">$results</span><span class="o">-></span><span class="na">see</span><span class="p">(</span><span class="s1">'Hello World'</span><span class="p">,</span> <span class="s1">'h1'</span><span class="p">);</span>
|
||
<span class="c1">// Check that "Hello World" is within an element with the "notice" class</span>
|
||
<span class="nv">$results</span><span class="o">-></span><span class="na">see</span><span class="p">(</span><span class="s1">'Hello World'</span><span class="p">,</span> <span class="s1">'.notice'</span><span class="p">);</span>
|
||
<span class="c1">// Check that "Hello World" is within an element with id of "title"</span>
|
||
<span class="nv">$results</span><span class="o">-></span><span class="na">see</span><span class="p">(</span><span class="s1">'Hellow World'</span><span class="p">,</span> <span class="s1">'#title'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The <strong>dontSee()</strong> method is the exact opposite:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="c1">// Checks that "Hello World" does NOT exist on the page</span>
|
||
<span class="nv">$results</span><span class="o">-></span><span class="na">dontSee</span><span class="p">(</span><span class="s1">'Hello World'</span><span class="p">);</span>
|
||
<span class="c1">// Checks that "Hellow World" does NOT exist within any h1 tag</span>
|
||
<span class="nv">$results</span><span class="o">-></span><span class="na">dontSee</span><span class="p">(</span><span class="s1">'Hello World'</span><span class="p">,</span> <span class="s1">'h1'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The <strong>seeElement()</strong> and <strong>dontSeeElement()</strong> are very similar to the previous methods, but do not look at the
|
||
values of the elements. Instead, they simply check that the elements exist on the page:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="c1">// Check that an element with class 'notice' exists</span>
|
||
<span class="nv">$results</span><span class="o">-></span><span class="na">seeElement</span><span class="p">(</span><span class="s1">'.notice'</span><span class="p">);</span>
|
||
<span class="c1">// Check that an element with id 'title' exists</span>
|
||
<span class="nv">$results</span><span class="o">-></span><span class="na">seeElement</span><span class="p">(</span><span class="s1">'#title'</span><span class="p">)</span>
|
||
<span class="c1">// Verify that an element with id 'title' does NOT exist</span>
|
||
<span class="nv">$results</span><span class="o">-></span><span class="na">dontSeeElement</span><span class="p">(</span><span class="s1">'#title'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>You can use <strong>seeLink()</strong> to ensure that a link appears on the page with the specified text:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="c1">// Check that a link exists with 'Upgrade Account' as the text::</span>
|
||
<span class="nv">$results</span><span class="o">-></span><span class="na">seeLink</span><span class="p">(</span><span class="s1">'Upgrade Account'</span><span class="p">);</span>
|
||
<span class="c1">// Check that a link exists with 'Upgrade Account' as the text, AND a class of 'upsell'</span>
|
||
<span class="nv">$results</span><span class="o">-></span><span class="na">seeLink</span><span class="p">(</span><span class="s1">'Upgrade Account'</span><span class="p">,</span> <span class="s1">'.upsell'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The <strong>seeInField()</strong> method checks for any input tags exist with the name and value:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="c1">// Check that an input exists named 'user' with the value 'John Snow'</span>
|
||
<span class="nv">$results</span><span class="o">-></span><span class="na">seeInField</span><span class="p">(</span><span class="s1">'user'</span><span class="p">,</span> <span class="s1">'John Snow'</span><span class="p">);</span>
|
||
<span class="c1">// Check a multi-dimensional input</span>
|
||
<span class="nv">$results</span><span class="o">-></span><span class="na">seeInField</span><span class="p">(</span><span class="s1">'user[name]'</span><span class="p">,</span> <span class="s1">'John Snow'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Finally, you can check if a checkbox exists and is checked with the <strong>seeCheckboxIsChecked()</strong> method:</p>
|
||
<div class="highlight-html+php notranslate"><div class="highlight"><pre><span></span><span class="c1">// Check if checkbox is checked with class of 'foo'</span>
|
||
<span class="nv">$results</span><span class="o">-></span><span class="na">seeCheckboxIsChecked</span><span class="p">(</span><span class="s1">'.foo'</span><span class="p">);</span>
|
||
<span class="c1">// Check if checkbox with id of 'bar' is checked</span>
|
||
<span class="nv">$results</span><span class="o">-></span><span class="na">seeCheckboxIsChecked</span><span class="p">(</span><span class="s1">'#bar'</span><span class="p">);</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="feature.html" class="btn btn-neutral float-right" title="HTTP Feature Testing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="fabricator.html" class="btn btn-neutral float-left" title="Generating Test Data" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
|
||
© Copyright 2019-2020 CodeIgniter Foundation
|
||
<span class="lastupdated">
|
||
Last updated on Oct 11, 2020.
|
||
</span>
|
||
|
||
</p>
|
||
</div>
|
||
|
||
|
||
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
|
||
|
||
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
|
||
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(false);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |