Skip to content

Commit 49414c9

Browse files
authored
update docs link (Codeception#575)
1 parent 7d2e608 commit 49414c9

28 files changed

+154
-154
lines changed

docs/01-Introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ You can't predict all possible scenarios and exceptional situations for complex
1414
but with tests you can cover the most important parts of your app and at least be sure they work as predicted.
1515

1616
There are plenty of ways to test your application.
17-
The most popular paradigm is [Unit Testing](http://en.wikipedia.org/wiki/Unit_testing).
17+
The most popular paradigm is [Unit Testing](https://en.wikipedia.org/wiki/Unit_testing).
1818
For web applications, testing just the controller and/or the model doesn't prove that your application is working.
1919
To test the behavior of your application as a whole, you should write functional or acceptance tests.
2020

@@ -93,7 +93,7 @@ Testing pieces of code before coupling them together is highly important as well
9393
you can be sure that some deeply hidden feature still works, even if it was not covered by functional or acceptance tests.
9494
This also shows care in producing stable and testable code.
9595

96-
Codeception is created on top of [PHPUnit](http://www.phpunit.de/). If you have experience writing unit tests with PHPUnit
96+
Codeception is created on top of [PHPUnit](https://www.phpunit.de/). If you have experience writing unit tests with PHPUnit
9797
you can continue doing so. Codeception has no problem executing standard PHPUnit tests,
9898
but, additionally, Codeception provides some well-built tools to make your unit tests simpler and cleaner.
9999

docs/02-GettingStarted.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ title: 02-GettingStarted - Codeception - Documentation
55

66
# Getting Started
77

8-
Let's take a look at Codeception's architecture. We'll assume that you have already [installed](http://codeception.com/install) it
8+
Let's take a look at Codeception's architecture. We'll assume that you have already [installed](https://codeception.com/install) it
99
and bootstrapped your first test suites. Codeception has generated three of them: unit, functional, and acceptance.
10-
They are well described in the [previous chapter](http://codeception.com/docs/01-Introduction). Inside your __/tests__ folder you will have three `.yml` config files and three directories
10+
They are well described in the [previous chapter](https://codeception.com/docs/01-Introduction). Inside your __/tests__ folder you will have three `.yml` config files and three directories
1111
with names corresponding to these suites: `unit`, `functional`, `acceptance`. Suites are independent groups of tests with a common purpose.
1212

1313
## The Codeception Syntax
@@ -49,7 +49,7 @@ One of the main concepts of Codeception is representation of tests as actions of
4949
who tests the application as a whole, with knowledge of its internals. Lastly we have an AcceptanceTester, a user who works with our application
5050
through an interface that we provide.
5151

52-
Methods of actor classes are generally taken from [Codeception Modules](http://codeception.com/docs/06-ModulesAndHelpers). Each module provides predefined actions for different testing purposes, and they can be combined to fit the testing environment.
52+
Methods of actor classes are generally taken from [Codeception Modules](https://codeception.com/docs/06-ModulesAndHelpers). Each module provides predefined actions for different testing purposes, and they can be combined to fit the testing environment.
5353
Codeception tries to solve 90% of possible testing issues in its modules, so you don't have to reinvent the wheel.
5454
We think that you can spend more time on writing tests and less on writing support code to make those tests run.
5555
By default, AcceptanceTester relies on PhpBrowser module, which is set in the `tests/acceptance.suite.yml` configuration file:
@@ -263,7 +263,7 @@ class TaskCrudCest
263263

264264
{% endhighlight %}
265265

266-
Learn more about the [Cest format](http://codeception.com/docs/07-AdvancedUsage#Cest-Classes) in the Advanced Testing section.
266+
Learn more about the [Cest format](https://codeception.com/docs/07-AdvancedUsage#Cest-Classes) in the Advanced Testing section.
267267

268268
## Interactive Pause
269269

@@ -325,7 +325,7 @@ Now you can execute all the commands of a corresponding Actor class and see the
325325
## BDD
326326

327327
Codeception allows execution of user stories in Gherkin format in a similar manner as is done in Cucumber or Behat.
328-
Please refer to [the BDD chapter](http://codeception.com/docs/07-BDD) to learn more.
328+
Please refer to [the BDD chapter](https://codeception.com/docs/07-BDD) to learn more.
329329

330330
## Configuration
331331

@@ -392,7 +392,7 @@ php vendor/bin/codecept run tests/acceptance/backend:^login
392392

393393
{% endhighlight %}
394394

395-
To execute a group of tests that are not stored in the same directory, you can organize them in [groups](http://codeception.com/docs/07-AdvancedUsage#Groups).
395+
To execute a group of tests that are not stored in the same directory, you can organize them in [groups](https://codeception.com/docs/07-AdvancedUsage#Groups).
396396

397397
### Reports
398398

docs/03-AcceptanceTests.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ $I->see('Welcome, Davert!');
3939
| JavaScript | No | Yes |
4040
| `see`/`seeElement` checks if… | …text is present in the HTML source | …text is actually visible to the user |
4141
| Access to HTTP response headers and status codes | Yes | No |
42-
| System requirements | PHP with [ext-curl](http://php.net/manual/book.curl.php) | Chrome or Firefox; optionally with Selenium Standalone Server |
42+
| System requirements | PHP with [ext-curl](https://php.net/manual/book.curl.php) | Chrome or Firefox; optionally with Selenium Standalone Server |
4343
| Speed | Fast | Slow |
4444

4545
We will start writing our first acceptance tests with PhpBrowser.
@@ -48,7 +48,7 @@ We will start writing our first acceptance tests with PhpBrowser.
4848

4949
This is the fastest way to run acceptance tests since it doesn't require running an actual browser.
5050
We use a PHP web scraper, which acts like a browser: It sends a request, then receives and parses the response.
51-
Codeception uses [Guzzle](http://guzzlephp.org) and [Symfony BrowserKit](http://symfony.com/doc/current/components/browser_kit.html) to interact with HTML web pages.
51+
Codeception uses [Guzzle](https://guzzlephp.org) and [Symfony BrowserKit](https://symfony.com/doc/current/components/browser_kit.html) to interact with HTML web pages.
5252

5353
Common PhpBrowser drawbacks:
5454

@@ -91,7 +91,7 @@ class SigninCest
9191
{% endhighlight %}
9292
9393
The `$I` object is used to write all interactions.
94-
The methods of the `$I` object are taken from the [PhpBrowser Module](http://codeception.com/docs/modules/PhpBrowser). We will briefly describe them here:
94+
The methods of the `$I` object are taken from the [PhpBrowser Module](https://codeception.com/docs/modules/PhpBrowser). We will briefly describe them here:
9595
9696
{% highlight php %}
9797
@@ -143,7 +143,7 @@ $I->click(['class' => 'btn']);
143143

144144
{% endhighlight %}
145145

146-
There is a special class [`Codeception\Util\Locator`](http://codeception.com/docs/reference/Locator)
146+
There is a special class [`Codeception\Util\Locator`](https://codeception.com/docs/reference/Locator)
147147
which may help you to generate complex XPath locators.
148148
For instance, it can easily allow you to click an element on the last row of a table:
149149

@@ -447,8 +447,8 @@ Now, you are ready to run WebDriver tests using Codeception.
447447

448448
> Alternatively, Selenium Server can be installed manually. [Download it](https://www.selenium.dev/downloads/) from the official site and launch a server with Java: `java -jar selenium-server-....jar`. In this case ChromeDriver and GeckoDriver must be installed separately.
449449

450-
* For more information refer to [Installation Instructions](http://codeception.com/docs/modules/WebDriver#Selenium)
451-
* Enable [RunProcess](http://codeception.com/extensions#RunProcess) extension to start/stop Selenium automatically *(optional)*.
450+
* For more information refer to [Installation Instructions](https://codeception.com/docs/modules/WebDriver#Selenium)
451+
* Enable [RunProcess](https://codeception.com/extensions#RunProcess) extension to start/stop Selenium automatically *(optional)*.
452452

453453

454454
### Configuration
@@ -469,7 +469,7 @@ modules:
469469

470470
{% endhighlight %}
471471

472-
See [WebDriver Module](http://codeception.com/docs/modules/WebDriver) for details.
472+
See [WebDriver Module](https://codeception.com/docs/modules/WebDriver) for details.
473473

474474
Please note that actions executed in a browser will behave differently. For instance, `seeElement` won't just check that the element exists on a page,
475475
but it will also check that element is actually visible to the user:
@@ -501,8 +501,8 @@ $I->click('#agree_button');
501501
{% endhighlight %}
502502

503503
In this case, we are waiting for the 'agree' button to appear and then click it. If it didn't appear after 30 seconds,
504-
the test will fail. There are other `wait` methods you may use, like [waitForText](http://codeception.com/docs/modules/WebDriver#waitForText),
505-
[waitForElementVisible](http://codeception.com/docs/modules/WebDriver#waitForElementVisible) and others.
504+
the test will fail. There are other `wait` methods you may use, like [waitForText](https://codeception.com/docs/modules/WebDriver#waitForText),
505+
[waitForElementVisible](https://codeception.com/docs/modules/WebDriver#waitForElementVisible) and others.
506506

507507
If you don't know what exact element you need to wait for, you can simply pause execution with using `$I->wait()`
508508

@@ -517,7 +517,7 @@ $I->wait(3); // wait for 3 secs
517517

518518
It is possible to wait for elements pragmatically.
519519
If a test uses element which is not on a page yet, Codeception will wait for few extra seconds before failing.
520-
This feature is based on [Implicit Wait](http://www.seleniumhq.org/docs/04_webdriver_advanced.jsp#implicit-waits) of Selenium.
520+
This feature is based on [Implicit Wait](https://www.seleniumhq.org/docs/04_webdriver_advanced.jsp#implicit-waits) of Selenium.
521521
Codeception enables implicit wait only when searching for a specific element and disables in all other cases. Thus, the performance of a test is not affected.
522522

523523
SmartWait can be enabled by setting `wait` option in WebDriver config. It expects the number of seconds to wait. Example:
@@ -624,7 +624,7 @@ Keep in mind, that you can change retry policy dynamically for each test.
624624
625625
#### Wait and Act
626626
627-
To combine `waitForElement` with actions inside that element you can use the [performOn](http://codeception.com/docs/modules/WebDriver#performOn) method.
627+
To combine `waitForElement` with actions inside that element you can use the [performOn](https://codeception.com/docs/modules/WebDriver#performOn) method.
628628
Let's see how you can perform some actions inside an HTML popup:
629629
630630
{% highlight php %}
@@ -650,7 +650,7 @@ $I->performOn('.confirm', function(\Codeception\Module\WebDriver $I) {
650650

651651
{% endhighlight %}
652652

653-
For more options see [`performOn()` reference](http://codeception.com/docs/modules/WebDriver#performOn).
653+
For more options see [`performOn()` reference](https://codeception.com/docs/modules/WebDriver#performOn).
654654

655655
#### A/B Testing
656656

@@ -756,20 +756,20 @@ class AcceptanceTester extends \Codeception\Actor
756756
Some environments are hard to be reproduced manually, testing Internet Explorer 6-8 on Windows XP may be a hard thing,
757757
especially if you don't have Windows XP installed. This is where Cloud Testing services come to help you.
758758
Services such as [SauceLabs](https://saucelabs.com), [BrowserStack](https://www.browserstack.com/)
759-
and [others](http://codeception.com/docs/modules/WebDriver#Cloud-Testing) can create virtual machines on demand
759+
and [others](https://codeception.com/docs/modules/WebDriver#Cloud-Testing) can create virtual machines on demand
760760
and set up Selenium Server and the desired browser. Tests are executed on a remote machine in a cloud,
761761
to access local files cloud testing services provide a special application called **Tunnel**.
762762
Tunnel operates on a secured protocol and allows browsers executed in a cloud to connect to a local web server.
763763
764764
Cloud Testing services work with the standard WebDriver protocol. This makes setting up cloud testing really easy.
765-
You just need to set the [WebDriver configuration](http://codeception.com/docs/modules/WebDriver#Cloud-Testing) to:
765+
You just need to set the [WebDriver configuration](https://codeception.com/docs/modules/WebDriver#Cloud-Testing) to:
766766
767767
* specify the host to connect to (depends on the cloud provider)
768768
* authentication details (to use your account)
769769
* browser
770770
* OS
771771
772-
We recommend using [params](http://codeception.com/docs/06-ModulesAndHelpers#Dynamic-Configuration-With-Params)
772+
We recommend using [params](https://codeception.com/docs/06-ModulesAndHelpers#Dynamic-Configuration-With-Params)
773773
to provide authorization credentials.
774774
775775
It should be mentioned that Cloud Testing services are not free. You should investigate their pricing models
@@ -793,8 +793,8 @@ PhpBrowser will store the HTML code and WebDriver will save a screenshot of the
793793

794794
Additional debugging features by Codeception:
795795

796-
* [Interactive Pause](http://codeception.com/docs/02-GettingStarted#Interactive-Pause) is a REPL that allows to type and check commands for instant feedback.
797-
* [Recorder Extension](http://codeception.com/addons#CodeceptionExtensionRecorder) allows to record tests step-by-steps and show them in slideshow
796+
* [Interactive Pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) is a REPL that allows to type and check commands for instant feedback.
797+
* [Recorder Extension](https://codeception.com/addons#CodeceptionExtensionRecorder) allows to record tests step-by-steps and show them in slideshow
798798

799799
### Common Cases
800800

@@ -838,7 +838,7 @@ $I->login('miles', '123456');
838838
{% endhighlight %}
839839

840840
However, implementing all actions for reuse in a single actor class may lead to
841-
breaking the [Single Responsibility Principle](http://en.wikipedia.org/wiki/Single_responsibility_principle).
841+
breaking the [Single Responsibility Principle](https://en.wikipedia.org/wiki/Single_responsibility_principle).
842842

843843
#### Single Login
844844

@@ -882,16 +882,16 @@ Note that session restoration only works for `WebDriver` modules
882882

883883
By default, WebDriver module is configured to automatically start browser before the test and stop afterward.
884884
However, this can be switched off with `start: false` module configuration.
885-
To start a browser you will need to write corresponding methods in Acceptance [Helper](http://codeception.com/docs/06-ModulesAndHelpers#Helpers).
885+
To start a browser you will need to write corresponding methods in Acceptance [Helper](https://codeception.com/docs/06-ModulesAndHelpers#Helpers).
886886

887887
WebDriver module provides advanced methods for the browser session, however, they can only be used from Helpers.
888888

889-
* [_initializeSession](http://codeception.com/docs/modules/WebDriver#_initializeSession) - starts a new browser session
890-
* [_closeSession](http://codeception.com/docs/modules/WebDriver#_closeSession) - stops the browser session
891-
* [_restart](http://codeception.com/docs/modules/WebDriver#_restart) - updates configuration and restarts browser
892-
* [_capabilities](http://codeception.com/docs/modules/WebDriver#_capabilities) - set [desired capabilities](https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities) programmatically.
889+
* [_initializeSession](https://codeception.com/docs/modules/WebDriver#_initializeSession) - starts a new browser session
890+
* [_closeSession](https://codeception.com/docs/modules/WebDriver#_closeSession) - stops the browser session
891+
* [_restart](https://codeception.com/docs/modules/WebDriver#_restart) - updates configuration and restarts browser
892+
* [_capabilities](https://codeception.com/docs/modules/WebDriver#_capabilities) - set [desired capabilities](https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities) programmatically.
893893

894-
Those methods can be used to create custom commands like `$I->startBrowser()` or used in [before/after](http://codeception.com/docs/06-ModulesAndHelpers#Hooks) hooks.
894+
Those methods can be used to create custom commands like `$I->startBrowser()` or used in [before/after](https://codeception.com/docs/06-ModulesAndHelpers#Hooks) hooks.
895895

896896
## Error Reporting
897897

@@ -914,7 +914,7 @@ error_level: E_ALL & ~E_STRICT & ~E_DEPRECATED
914914
Writing acceptance tests with Codeception and PhpBrowser is a good start.
915915
You can easily test your Joomla, Drupal, WordPress sites, as well as those made with frameworks.
916916
Writing acceptance tests is like describing a tester's actions in PHP. They are quite readable and very easy to write.
917-
If you need to access the database, you can use the [Db Module](http://codeception.com/docs/modules/Db).
917+
If you need to access the database, you can use the [Db Module](https://codeception.com/docs/modules/Db).
918918

919919

920920

docs/04-FunctionalTests.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,11 @@ By default this module will search for AppKernel in the `app` directory.
9393

9494
The module uses the Symfony Profiler to provide additional information and assertions.
9595

96-
[See the full reference](http://codeception.com/docs/modules/Symfony)
96+
[See the full reference](https://codeception.com/docs/modules/Symfony)
9797

9898
### Laravel5
9999

100-
The [Laravel5](http://codeception.com/docs/modules/Laravel5) module is included and requires no configuration:
100+
The [Laravel5](https://codeception.com/docs/modules/Laravel5) module is included and requires no configuration:
101101

102102
{% highlight yaml %}
103103

@@ -117,7 +117,7 @@ and [Advanced](https://github.com/yiisoft/yii2-app-advanced) application templat
117117

118118
### Zend Framework 2
119119

120-
Use [the ZF2 module](http://codeception.com/docs/modules/ZF2) to run functional tests inside Zend Framework 2:
120+
Use [the ZF2 module](https://codeception.com/docs/modules/ZF2) to run functional tests inside Zend Framework 2:
121121

122122
{% highlight yaml %}
123123

@@ -132,7 +132,7 @@ modules:
132132

133133
### Zend Expressive
134134

135-
[Zend Expressive](http://codeception.com/docs/modules/ZendExpressive) tests can be executed with enabling a corresponding module.
135+
[Zend Expressive](https://codeception.com/docs/modules/ZendExpressive) tests can be executed with enabling a corresponding module.
136136

137137
{% highlight yaml %}
138138

@@ -167,11 +167,11 @@ modules:
167167

168168
{% endhighlight %}
169169

170-
[See the full reference](http://codeception.com/docs/modules/Phalcon4)
170+
[See the full reference](https://codeception.com/docs/modules/Phalcon4)
171171

172172
## Writing Functional Tests
173173

174-
Functional tests are written in the same manner as [Acceptance Tests](http://codeception.com/docs/03-AcceptanceTests)
174+
Functional tests are written in the same manner as [Acceptance Tests](https://codeception.com/docs/03-AcceptanceTests)
175175
with the `PhpBrowser` module enabled. All framework modules and the `PhpBrowser` module share the same methods
176176
and the same engine.
177177

0 commit comments

Comments
 (0)