codeception.github.com/quickstart.html at master · nathanmac/codeception.github.com · GitHub

History

263 lines (198 loc) · 7.14 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

---

layout: bootstrap

title: Quick Start Codeception

---

</div></div>

<h1>Codeception<br> Quickstart Guide</h1>

</div>

<a href="/install" style="float: right">Alternative Installations »</a>

<h4 class="panel-title">1. Install</h4></div>

<p class="lead">Install via Composer</p>

<pre>composer require "codeception/codeception" --dev</pre>

</div>

<p>

Execute it as

<code>./vendor/bin/codecept</code></p>

</div>

<hr>

{% include phar.html %}

</a>

</div>

</div>

</div>

<h3>Quick Start For</h3>

{% include for.html %}

</div>

<div class="panel-heading"><h4 class="panel-title">2. Setup</h4></div>

<p>Execute:</p>

<p>

<pre>codecept bootstrap</pre>

</p>

</div>

<p class="text-muted">This creates configuration file

<b>codeception.yml</b> and <b>tests</b> directory and default test suites.

Acceptance, functional, unit test suites are created as well.

</p>

See Demo

</a>

</div>

</div>

<div class="panel-heading"><h4 class="panel-title">3. Create Test</h4></div>

<p>Generate your first acceptance test. Acceptance tests emulate behavior

of a real user visiting your site.</p>

<p>

<pre>codecept generate:cest acceptance First</pre>

</p>

</div>

<p class="text-muted">Codeception scenario tests are called Cepts.</p>

</div>

</div>

<div class="panel-heading"><h4 class="panel-title">4. Configure Acceptance Tests</h4></div>

<p>Please make sure your local

<b>development server</b> is running.  Put application URL into: 

<b>tests/acceptance.suite.yml</b> </p>

<pre>

actor: AcceptanceTester

modules:

enabled:

- PhpBrowser:

url: {YOUR APP'S URL}

- \Helper\Acceptance

</pre>

</div>

</div>

</div>

<h4 class="panel-title">5. Write a Basic Test</h4>

</div>

<p>It's now time to write your first test. Edit the file we've just created

<b>tests/acceptance/FirstCest.php</b>

</p>

<div>

{% highlight php %}

<?php

class FirstCest

{

public function frontpageWorks(AcceptanceTester $I)

{

$I->amOnPage('/');

$I->see('Home');

}

{% endhighlight %}

</div>

<p class="text-muted">It will check that your frontpage contains the word <b>Home</b> in it.</p>

</div>

</div>

<p>Tests are executed with 'run' command</p>

<p>

<pre>codecept run --steps</pre>

</p>

</div>

<p class="text-muted">This will execute our Welcome test with

<b>PhpBrowser</b>. It's PHP script that can check HTML page contents, click

links, fill forms, and submit POST and GET requests. For more complex tests

that require a browser use Selenium with

<b>WebDriver</b> module.</p>

</div>

</div>

</div>

<h3>Simplified Setup</h3>

<p>Use predefined installation templates for common use cases.

Run them instead of <code>bootstrap</code> command.

</p>

<h4>Acceptance Testing (only)</h4>

<pre>codecept init acceptance</pre>

</div>

See Demo

</a> <a href="/docs/03-AcceptanceTests" class="btn btn-secondary">Acceptance Testing Guide »</a>

<hr>

<h4>REST API Testing (only)</h4>

<pre>codecept init api</pre>

</div>

See Demo

</a>

<a href="/docs/10-WebServices#REST" class="btn btn-secondary">REST API Testing Guide »</a>

<hr>

<h4>Unit Testing (only)</h4>

<pre>codecept init unit</pre>

</div>

See Demo

</a>

<a href="/docs/05-UnitTests" class="btn btn-secondary">Unit Testing Guide »</a>

</div>

</div>

<p>Read Codeception Guides to learn how to use it.</p>

<a class="list-group-item active" href="/docs/02-GettingStarted">A Complete Getting Started Guide</a>

<a class="list-group-item" href="/docs/03-AcceptanceTests">Continue with Acceptance Tests</a>

<a class="list-group-item" href="/docs/01-Introduction">The difference  between Acceptance Tests and Unit Tests</a>

</div>

codeception.github.com/quickstart.html at master · nathanmac/codeception.github.com · GitHub

Expand file tree

Breadcrumbs

quickstart.html

Latest commit

History

Breadcrumbs

quickstart.html

File metadata and controls