Skip to content

Commit 23d0720

Browse files
committed
docs: splitted out Testing manual
1 parent 6e73aec commit 23d0720

File tree

5 files changed

+44
-39
lines changed

5 files changed

+44
-39
lines changed

README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,11 @@ This package is the core of the system.
1717

1818
Please see package with example setup [hiqdev/hipanel].
1919

20-
Also see [documentation] and [Tests README].
20+
Also see [documentation].
2121

2222
[HiPanel]: https://hipanel.com
2323
[hiqdev/hipanel]: https://github.com/hiqdev/hipanel
2424
[documentation]: docs
25-
[Tests README]: tests/README.md
2625

2726
## Installation
2827

docs/Development.md

+11-35
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,20 @@
1-
# [WIP] This guide is being developed.
1+
# [WIP] This guide is under development
22

3+
Also see [Testing] manual.
34

5+
[Testing]: Testing.md
46

57
## Overview
68

79
### Test frameworks we use and their purpose
810

911
// Codeception, PHPunit. Structure of tests
1012

11-
## Running tests locally
12-
13-
1. Install JDK
14-
15-
2. Install Selenium Web Driver by executing `download.sh` which is located in your hipanel dir in `tests/software/`
16-
17-
3. Execute `run.sh` (in same folder) to run on background
18-
19-
4. To run tests locally use `codecept` which is located in your hipanel dir in `vendor/bin/`
20-
21-
More info about how to run tests with codecept [Here](https://codeception.com/docs/02-GettingStarted#Running-Tests)
22-
23-
### Running tests inside Docker
24-
25-
// How to?
26-
27-
2813
## Contributing
2914

30-
>Before contributing make sure you have last update of your repositories.
15+
> Before contributing make sure you have last update of your repositories.
3116
>
32-
>(use `composer update` on whole project or `git pull` in specific module)
17+
> (use `composer update` on whole project or `git pull` in specific module)
3318
3419
To contribute follow this steps:
3520

@@ -41,7 +26,7 @@ To contribute follow this steps:
4126

4227
2. Type `git remote add [remote name] [url]` inside your module dir
4328

44-
`[remote name]` is name of your remote branch (for example `forked`)
29+
`[remote name]` is name of your remote branch (for example `forked`)
4530

4631
`[url]` is your forked url
4732

@@ -52,7 +37,6 @@ To contribute follow this steps:
5237
4. After `git add` when you make `git commit -m [message]` follow this simple rules:
5338

5439
1. Your `[message]` must start with __one__ word like `Added`, `Changed`, `Fixed`, `Removed`
55-
5640
2. Next will follow the description of what exactly was added, changed or removed.
5741

5842
5. Next you `git push [remote name] [branch name]`
@@ -62,17 +46,17 @@ To contribute follow this steps:
6246
6. After that you need to create a __pull request__.
6347

6448
You can do it at github website:
65-
49+
6650
1. Open repository (for example [hipnel](https://github.com/hiqdev/hipanel))
67-
51+
6852
2. Click __New pull request__
69-
53+
7054
(or click green __Compare & pull request__ and skip __iii__ step)
7155

7256
3. Click __compare across forks__ and on the right choose __your forked repository__ -> __brach name__
73-
57+
7458
4. Click green __Create pull request__
75-
59+
7660
7. After your pull request was reviewed and you have to make some changes,
7761
all you need to do is just make that changes and `push` to the same `[remote name] [branch name]`.
7862

@@ -115,11 +99,3 @@ To make xDebug work in PHPStorm you need:
11599
// - debug session does not get started;
116100
// - debug can not locate files;
117101

118-
#### Contributing to Codeception tests
119-
120-
// How to run tests and enhance them?
121-
122-
To limit tests execution scope to a single cest, run codecept
123-
`./vendor/bin/codecept` with arguments `run` and `path to file`
124-
[Examples](https://codeception.com/docs/02-GettingStarted#Running-Tests)
125-

docs/Installation.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Installation
2+
13
## Prerequisites
24

35
__1.__ __PHP 7.1__. (ondrej)

docs/Testing.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Testing
2+
3+
## Running tests locally
4+
5+
1. Install JDK
6+
2. Install Selenium Web Driver by executing `download.sh` which is located in your hipanel dir in `tests/software/`
7+
3. Execute `run.sh` (in same folder) to run on background
8+
4. To run tests locally use `codecept` which is located in your hipanel dir in `vendor/bin/`
9+
10+
For more info about how to run tests see [codeception manual].
11+
12+
## Running tests inside Docker
13+
14+
// How to?
15+
16+
## Contributing to Codeception tests
17+
18+
// How to run tests and enhance them?
19+
20+
To limit tests execution scope to a single cest, use path to file like this:
21+
22+
```sh
23+
./vendor/bin/codecept run <path to file>
24+
```
25+
26+
Also see [codeception manual].
27+
28+
[codeception manual]: https://codeception.com/docs/02-GettingStarted#Running-Tests
29+

hidev.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,8 @@ package:
1616
1717
Please see package with example setup [hiqdev/hipanel].
1818
19-
Also see [documentation] and [Tests README].
19+
Also see [documentation].
2020
2121
[HiPanel]: https://hipanel.com
2222
[hiqdev/hipanel]: https://github.com/hiqdev/hipanel
2323
[documentation]: docs
24-
[Tests README]: tests/README.md

0 commit comments

Comments
 (0)