You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tests/e2e/CODE_STYLE.md
+9-20Lines changed: 9 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,35 +6,24 @@
6
6
7
7
Coding standards offer several advantages, including:
8
8
9
-
1. Increase Code Quality: By adhering to coding standards, developers can create code that is more secure, efficient,
10
-
maintainable, and uniform. This, in turn, can result in fewer errors and improved overall performance.
9
+
1. Increase Code Quality: By adhering to coding standards, developers can create code that is more secure, efficient, maintainable, and uniform. This, in turn, can result in fewer errors and improved overall performance.
11
10
12
-
2. Improved Readability and Maintainability: Coding standards contribute to code that is more comprehensible and easier
13
-
to maintain. Consistently formatted code aids other developers in comprehending and modifying it, saving time and
14
-
reducing the likelihood of introducing errors.
11
+
2. Improved Readability and Maintainability: Coding standards contribute to code that is more comprehensible and easier to maintain. Consistently formatted code aids other developers in comprehending and modifying it, saving time and reducing the likelihood of introducing errors.
15
12
16
-
3. Accelerated Development: The adherence to coding standards can expedite the development process. When developers
17
-
adhere to a predefined set of guidelines, they can produce code more swiftly and with fewer mistakes. Additionally,
18
-
uniform code formatting facilitates the identification and resolution of issues.
13
+
3. Accelerated Development: The adherence to coding standards can expedite the development process. When developers adhere to a predefined set of guidelines, they can produce code more swiftly and with fewer mistakes. Additionally, uniform code formatting facilitates the identification and resolution of issues.
19
14
20
-
4. Better Scalability: Coding standards facilitate the creation of scalable code, simplifying the incorporation of new
21
-
features or updates. Consistent coding practices also streamline code maintenance as the codebase expands.
15
+
4. Better Scalability: Coding standards facilitate the creation of scalable code, simplifying the incorporation of new features or updates. Consistent coding practices also streamline code maintenance as the codebase expands.
22
16
23
-
5. Elevated Collaboration and Communication: Uniform guidelines encourage better understanding and manipulation of code
24
-
written by fellow developers. This fosters smoother teamwork and facilitates the sharing of code.
17
+
5. Elevated Collaboration and Communication: Uniform guidelines encourage better understanding and manipulation of code written by fellow developers. This fosters smoother teamwork and facilitates the sharing of code.
25
18
26
-
6. Consistency Across Projects: The adoption of coding standards guarantees a consistent coding approach across various
27
-
projects. This simplifies the task of upholding code quality, transitioning between tasks, and fostering
28
-
collaborative work.
19
+
6. Consistency Across Projects: The adoption of coding standards guarantees a consistent coding approach across various projects. This simplifies the task of upholding code quality, transitioning between tasks, and fostering collaborative work.
29
20
30
21
### Automated tools
31
22
32
-
Automated lint checking and code format performs with ESLint and Prettier tools before every commit using Husky
33
-
pre-commit hook.
34
-
Full set of rules can be found:
23
+
Automated lint checking and code format performs with ESLint and Prettier tools before every commit using Husky pre-commit hook. Full set of rules can be found:
Copy file name to clipboardExpand all lines: tests/e2e/README.md
+37-39Lines changed: 37 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,33 +2,33 @@
2
2
3
3
## Requirements
4
4
5
-
-node 16.x
6
-
-"Chrome" browser 114.x or later
7
-
-deployed Che 7 with accessible URL
5
+
- node 16.x
6
+
- "Chrome" browser 114.x or later
7
+
- deployed Che 7 with accessible URL
8
8
9
9
## Before launch
10
10
11
11
**Perform commands:**
12
12
13
-
-`export TS_SELENIUM_BASE_URL=<Che7 URL>`
14
-
-`npm ci`
13
+
-`export TS_SELENIUM_BASE_URL=<Che7 URL>`
14
+
-`npm ci`
15
15
16
16
Note: If there is any modifications in package.json, manually execute the `npm install` to update the package-lock.json. So that errors can be avoided while executing npm ci
17
17
18
18
## Default launch
19
19
20
-
-Provide connection credentials:
21
-
-`export TS_SELENIUM_OCP_USERNAME=<username>`
22
-
-`export TS_SELENIUM_OCP_PASSWORD=<password>`
23
-
-`npm run test`
20
+
- Provide connection credentials:
21
+
-`export TS_SELENIUM_OCP_USERNAME=<username>`
22
+
-`export TS_SELENIUM_OCP_PASSWORD=<password>`
23
+
-`npm run test`
24
24
25
25
## Custom launch
26
26
27
-
-Use environment variables which described in the "constants" folder
28
-
-Use environment variables for setting timeouts if needed. You can see the list in **`'TimeoutConstants.ts'`**. You can see the list of those variables and their value if you set the `'TS_SELENIUM_PRINT_TIMEOUT_VARIABLES = true'`
29
-
-To test one specification export file name as `export USERSTORY=<spec-file-name-without-extension> && npm run test` (example: `-e USERSTORY=Quarkus`)
30
-
-To run test without Selenium WebDriver (API tests etc.) use `export USERSTORY=<spec-file-name-without-extension> && npm run driver-less-test` (example: `-e USERSTORY=CloneGitRepoAPI`)
31
-
-This project support application testing deployed on Kubernetes or Openshift platform. Openshift is default value. To switch into Kubernetes, please, use `TS_PLATFORM=kubernetes` environmental variable and `TS_SELENIUM_K8S_PASSWORD`, `TS_SELENIUM_K8S_USERNAME` to provide credentials. The sample of test command in this case:
27
+
- Use environment variables which described in the "constants" folder
28
+
- Use environment variables for setting timeouts if needed. You can see the list in **`'TimeoutConstants.ts'`**. You can see the list of those variables and their value if you set the `'TS_SELENIUM_PRINT_TIMEOUT_VARIABLES = true'`
29
+
- To test one specification export file name as `export USERSTORY=<spec-file-name-without-extension> && npm run test` (example: `-e USERSTORY=Quarkus`)
30
+
- To run test without Selenium WebDriver (API tests etc.) use `export USERSTORY=<spec-file-name-without-extension> && npm run driver-less-test` (example: `-e USERSTORY=CloneGitRepoAPI`)
31
+
- This project support application testing deployed on Kubernetes or Openshift platform. Openshift is default value. To switch into Kubernetes, please, use `TS_PLATFORM=kubernetes` environmental variable and `TS_SELENIUM_K8S_PASSWORD`, `TS_SELENIUM_K8S_USERNAME` to provide credentials. The sample of test command in this case:
32
32
```
33
33
export TS_PLATFORM=kubernetes && \
34
34
export TS_SELENIUM_K8S_USERNAME=<username> && \
@@ -37,52 +37,50 @@ Note: If there is any modifications in package.json, manually execute the `npm i
37
37
npm run test
38
38
```
39
39
Also, environmental variables can be set in files in "constants" folder.
40
-
- Local test results can be represented with Allure reporter `npm run open-allure-dasboard`
40
+
- Local test results can be represented with Allure reporter `npm run open-allure-dasboard`
41
41
42
42
## Docker launch
43
43
44
-
- open terminal and go to the "e2e" directory
45
-
- export the `"TS_SELENIUM_BASE_URL"` variable with "Che" url
46
-
- run command `"npm run test-docker"`
44
+
- open terminal and go to the "e2e" directory
45
+
- export the `"TS_SELENIUM_BASE_URL"` variable with "Che" url
46
+
- run command `"npm run test-docker"`
47
47
48
48
## Docker launch with changed tests
49
49
50
50
**For launching tests with local changes perform next steps:**
51
51
52
-
- open terminal and go to the "e2e" directory
53
-
- export the `"TS_SELENIUM_BASE_URL"` variable with "Che" url
54
-
- run command `"npm run test-docker-mount-e2e"`
52
+
- open terminal and go to the "e2e" directory
53
+
- export the `"TS_SELENIUM_BASE_URL"` variable with "Che" url
54
+
- run command `"npm run test-docker-mount-e2e"`
55
55
56
56
## Debug docker launch
57
57
58
58
The `'eclipse/che-e2e'` docker image has VNC server installed inside. For connecting use `'0.0.0.0:5920'` address.
59
59
60
60
## The "Happy Path" scenario launching
61
61
62
-
**The easiest way to do that is to perform steps which are described in the "Docker launch" paragraph.
63
-
For running tests without docker, please perform next steps:**
62
+
**The easiest way to do that is to perform steps which are described in the "Docker launch" paragraph. For running tests without docker, please perform next steps:**
64
63
65
-
- Deploy Che on Kubernetes infrastructure by using 'Minikube' and 'Chectl' <https://github.com/eclipse-che/che-server/blob/HEAD/deploy/kubernetes/README.md>
66
-
- Create workspace by using 'Chectl' and devfile
67
-
- link to 'Chectl' manual <https://github.com/che-incubator/chectl#chectl-workspacestart>
68
-
- link to devfile ( **`For successfull test passing, exactly provided devfile should be used`** )
- Provide the **`'TS_SELENIUM_BASE_URL'`** environment variable as described above
71
-
- export TS_SELENIUM_HAPPY_PATH_WORKSPACE_NAME=EmptyWorkspace (default value, see BASE_TEST_CONSTANTS.ts)
72
-
- perform command **`export USERSTORY=$TS_SELENIUM_HAPPY_PATH_WORKSPACE_NAME && npm run test-all-devfiles`**
64
+
- Deploy Che on Kubernetes infrastructure by using 'Minikube' and 'Chectl' <https://github.com/eclipse-che/che-server/blob/HEAD/deploy/kubernetes/README.md>
65
+
- Create workspace by using 'Chectl' and devfile
66
+
- link to 'Chectl' manual <https://github.com/che-incubator/chectl#chectl-workspacestart>
67
+
- link to devfile ( **`For successfull test passing, exactly provided devfile should be used`** ) <https://gist.githubusercontent.com/Ohrimenko1988/93f5426f4ebc1705c55feb8ff0396a49/raw/cbea89ad145ba33ed34a151a12c50f045f9f3b78/yaml-ls-bug.yaml>
68
+
- Provide the **`'TS_SELENIUM_BASE_URL'`** environment variable as described above
69
+
- export TS_SELENIUM_HAPPY_PATH_WORKSPACE_NAME=EmptyWorkspace (default value, see BASE_TEST_CONSTANTS.ts)
70
+
- perform command **`export USERSTORY=$TS_SELENIUM_HAPPY_PATH_WORKSPACE_NAME && npm run test-all-devfiles`**
73
71
74
72
## Launching the DevWorkspaceHappyPath spec file using Che with oauth authentication
0 commit comments