Skip to content

Commit 6bead14

Browse files
solveratsolverat
committed
add docs
1 parent fc70277 commit 6bead14

File tree

4 files changed

+121
-6
lines changed

4 files changed

+121
-6
lines changed

‎README.md

+92-1
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,95 @@ This Framework allows you to use multiple (bundle) configuration setups.
5151
TBD
5252
5353
## Classes
54-
If you want to provide some classes to install, all the definitions needs to stored at `/tests/_etc/classes`.
54+
If you want to provide some classes to install, all the definitions needs to stored at `/tests/_etc/classes`.
55+
56+
***
57+
58+
## Actors
59+
60+
### [MODULE] PimcoreAdminCsv
61+
| Name | Description |
62+
|---------------------------------------|--------------------|
63+
| `seeResponseCsvHeaderHasValues(array $headerValues)` | |
64+
| `seeResponseCsvRowValues(int $index, array $values)` | |
65+
| `seeResponseCsvLength(int $length)` | |
66+
| `seeResponseIsCsv()` | |
67+
68+
69+
### [MODULE] PimcoreAdminJson
70+
| Name | Description |
71+
|---------------------------------------|--------------------|
72+
| `seeResponseContainsJson(array $json = [])` | |
73+
| `seeResponseIsJson()` | |
74+
75+
76+
### [MODULE] PimcoreBackend
77+
| Name | Description |
78+
|---------------------------------------|--------------------|
79+
| `haveAPageDocument($key = 'bundle-page-test', array $params = [], $locale = null)` | |
80+
| `haveASubPageDocument(Document $parent, $key = 'bundle-sub-page-test', array $params = [], $locale = null)` | |
81+
| `haveASnippet($key = 'bundle-snippet-test', $params = [], $locale = null)` | |
82+
| `haveAEmail($key = 'bundle-email-test', array $params = [], $locale = null)` | |
83+
| `haveALink(Document\Page $source, $key = 'bundle-link-test', array $params = [], $locale = null)` | |
84+
| `haveASubLink(Document $parent, Document\Page $source, $key = 'bundle-sub-link-test', array $params = [], $locale = null)` | |
85+
| `haveAHardLink(Document\Page $source, $key = 'bundle-hardlink-test', array $params = [], $locale = null)` | |
86+
| `haveASubHardLink(Document $parent, Document\Page $source, $key = 'bundle-sub-hardlink-test', array $params = [], $locale = null)` | |
87+
| `haveAPimcoreObject(string $objectType, $key = 'bundle-object-test', array $params = [])` | |
88+
| `haveAPimcoreAsset($key = 'bundle-asset-test', array $params = [])` | |
89+
| `haveADummyFile($fileName, $fileSizeInMb = 1)` | |
90+
| `haveASite($siteKey, array $params = [], $locale = null, $add3w = false, $additionalDomains = [])` | |
91+
| `haveAPageDocumentForSite(Site $site, $key = 'document-test', array $params = [], $locale = null)` | |
92+
| `haveAHardlinkForSite(Site $site, Document\Page $document, $key = 'hardlink-test', array $params = [], $locale = null)` | |
93+
| `seeDownload($fileName)` | |
94+
| `seeEditablesPlacedOnDocument(Document $document, array $editables)` | |
95+
| `seeAnAreaElementPlacedOnDocument(Document $document, string $areaName, array $editables = [])` | |
96+
| `haveTwoConnectedDocuments(Document\Page $sourceDocument, Document\Page $targetDocument)` | |
97+
| `haveAUnPublishedDocument(Document $document)` | |
98+
| `seeEmailIsSent(Document\Email $email)` | |
99+
| `seeEmailIsNotSent(Document\Email $email)` | |
100+
| `seePropertiesInEmail(Document\Email $mail, array $properties)` | |
101+
| `seePropertyKeysInEmail(Document\Email $mail, array $properties)` | |
102+
| `cantSeePropertyKeysInEmail(Document\Email $mail, array $properties)` | |
103+
| `seeInRenderedEmailBody(Document\Email $mail, string $string)` | |
104+
| `seeKeyInFrontendTranslations(string $key)` | |
105+
| `haveAFrontendTranslatedKey(string $key, string $translation, string $language)` | |
106+
| `haveAStaticRoute(string $name = 'test_route', array $params = [])` | |
107+
| `haveAPimcoreRedirect(array $data)` | |
108+
| `haveAPimcoreClass(string $name = 'TestClass')` | |
109+
| `submitDocumentToXliffExporter(Document $document)` | |
110+
111+
112+
### [MODULE] PimcoreBundleCore
113+
| Name | Description |
114+
|---------------------------------------|--------------------|
115+
| This module installs a bundle if `run_installer` option is set to `true` | |
116+
117+
118+
### [MODULE] PimcoreCore
119+
| Name | Description |
120+
|---------------------------------------|--------------------|
121+
| `haveABootedSymfonyConfiguration(string $configuration)` | |
122+
123+
124+
### [MODULE] PimcoreRest
125+
| Name | Description |
126+
|---------------------------------------|--------------------|
127+
| -- | |
128+
129+
130+
### [MODULE] PimcoreUser
131+
| Name | Description |
132+
|---------------------------------------|--------------------|
133+
| `haveAUser($username)` | |
134+
| `haveAUserWithAdminRights($username)` | |
135+
136+
137+
### [MODULE] Unit
138+
| Name | Description |
139+
|---------------------------------------|--------------------|
140+
| -- | |
141+
142+
143+
## API
144+
145+
TBD

‎src/_support/Helper/PimcoreAdminCsv.php

+14-5
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
namespace Dachcom\Codeception\Helper;
44

5+
use Codeception\Exception\ModuleException;
56
use Codeception\Lib\InnerBrowser;
67
use Codeception\Lib\Interfaces\DependsOnModule;
78
use Codeception\Module;
@@ -30,9 +31,11 @@ public function _inject(InnerBrowser $connection)
3031
}
3132

3233
/**
34+
* Actor Function to see values in csv response
35+
*
3336
* @param array $headerValues
3437
*
35-
* @throws \Codeception\Exception\ModuleException
38+
* @throws ModuleException
3639
*/
3740
public function seeResponseCsvHeaderHasValues(array $headerValues)
3841
{
@@ -49,10 +52,12 @@ public function seeResponseCsvHeaderHasValues(array $headerValues)
4952
}
5053

5154
/**
55+
* Actor Function to see values in specific csv row of csv response
56+
*
5257
* @param int $index
5358
* @param array $values
5459
*
55-
* @throws \Codeception\Exception\ModuleException
60+
* @throws ModuleException
5661
*/
5762
public function seeResponseCsvRowValues(int $index, array $values)
5863
{
@@ -79,9 +84,11 @@ public function seeResponseCsvRowValues(int $index, array $values)
7984
}
8085

8186
/**
87+
* Actor Function to see response csv length
88+
*
8289
* @param int $length
8390
*
84-
* @throws \Codeception\Exception\ModuleException
91+
* @throws ModuleException
8592
*/
8693
public function seeResponseCsvLength(int $length)
8794
{
@@ -95,8 +102,10 @@ public function seeResponseCsvLength(int $length)
95102
\PHPUnit_Framework_Assert::assertCount($length, $rows);
96103
}
97104

98-
/***
99-
* @throws \Codeception\Exception\ModuleException
105+
/**
106+
* Actor Function to see response is csv
107+
*
108+
* @throws ModuleException
100109
*/
101110
public function seeResponseIsCsv()
102111
{

‎src/_support/Helper/PimcoreAdminJson.php

+13
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
namespace Dachcom\Codeception\Helper;
44

5+
use Codeception\Exception\ModuleException;
56
use Codeception\Lib\InnerBrowser;
67
use Codeception\Lib\Interfaces\DependsOnModule;
78
use Codeception\Module;
@@ -30,6 +31,13 @@ public function _inject(InnerBrowser $connection)
3031
$this->connectionModule = $connection;
3132
}
3233

34+
/**
35+
* Actor Function to see response contains csv
36+
*
37+
* @param array $json
38+
*
39+
* @throws ModuleException
40+
*/
3341
public function seeResponseContainsJson($json = [])
3442
{
3543
\PHPUnit_Framework_Assert::assertThat(
@@ -38,6 +46,11 @@ public function seeResponseContainsJson($json = [])
3846
);
3947
}
4048

49+
/**
50+
* Actor Function to see response is json
51+
*
52+
* @throws ModuleException
53+
*/
4154
public function seeResponseIsJson()
4255
{
4356
$responseContent = $this->connectionModule->_getResponseContent();

‎src/_support/Helper/PimcoreBackend.php

+2
Original file line numberDiff line numberDiff line change
@@ -776,6 +776,8 @@ public function haveAPimcoreClass(string $name = 'TestClass')
776776
}
777777

778778
/**
779+
* Actor Function to submit document to xliff exporter
780+
*
779781
* @param Document $document
780782
*
781783
* @throws ModuleException

0 commit comments

Comments
 (0)