Skip to content

Commit 25e46af

Browse files
authored
docs: update test documentation (#346)
1 parent d819e89 commit 25e46af

File tree

6 files changed

+19
-12
lines changed

6 files changed

+19
-12
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,11 @@ TIME_VALUE_29
7171

7272
### 🚀 Workflows
7373

74-
Currently configured workflows (see [ECH](https://github.com/elastic/oblt-playwright/blob/main/.github/workflows/ech.yml) | [Serverless ](https://github.com/elastic/oblt-playwright/blob/main/.github/workflows/serverless.yml)) execute each of the test suites ([APM](https://github.com/elastic/oblt-playwright/blob/main/docs/test_apm.md), [Infrastructure](https://github.com/elastic/oblt-playwright/blob/main/docs/test_infra.md), [Logs](https://github.com/elastic/oblt-playwright/blob/main/docs/test_logs.md)) on an hourly basis with 20-minute intervals between them.
74+
Currently configured workflows (see [ECH](https://github.com/elastic/oblt-playwright/blob/main/.github/workflows/ech.yml) | [Serverless ](https://github.com/elastic/oblt-playwright/blob/main/.github/workflows/serverless.yml)) execute each of the test suites ([APM](https://github.com/elastic/oblt-playwright/blob/main/docs/test_apm.md), [Dataset Quality](https://github.com/elastic/oblt-playwright/blob/main/docs/test_datasets.md), [Infrastructure](https://github.com/elastic/oblt-playwright/blob/main/docs/test_infra.md), [Logs](https://github.com/elastic/oblt-playwright/blob/main/docs/test_logs.md)) on an hourly basis with 15 minute intervals between them.
7575
- APM test suite executes at the top of each hour.
76-
- Infrastructure test suite executes 20 minutes past the hour.
77-
- Logs test suite executes 40 minutes past the hour.
76+
- Dataset Quality executes 15 minutes past the hour.
77+
- Infrastructure test suite executes 30 minutes past the hour.
78+
- Logs test suite executes 45 minutes past the hour.
7879

7980
Tests are executed sequentially, with only one Kibana user at a given time.
8081

docs/data_mapping.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
| Scenario | Required data |
44
| :------------ | :------------ |
55
| [apm.kibana.spec.ts](https://github.com/elastic/oblt-playwright/blob/main/tests/kibana/apm.kibana.spec.ts)<br><br>Services, Traces and Dependencies sections walkthroughs. Tracking the duration it takes for page elements and visualizations to render and appear on screen within the allocated timeframe, reflecting the anticipated test data volume. | APM traces;<br>Host logs;<br>Trace logs. |
6-
| [datasets.kibana.spec.ts](https://github.com/elastic/oblt-playwright/blob/main/tests/kibana/datasets.kibana.spec.ts)<br><br>Measuring the loading time of elements within "Data Set Quality" page. | Log data. |
6+
| [datasets.kibana.spec.ts](https://github.com/elastic/oblt-playwright/blob/main/tests/kibana/datasets.kibana.spec.ts)<br><br>Measuring the loading time of elements within "Data Set Quality" page. | Logs, metrics, synthetics, APM traces. |
77
| [hosts.kibana.spec.ts](https://github.com/elastic/oblt-playwright/blob/main/tests/kibana/hosts.kibana.spec.ts)<br><br>Measuring the loading time of elements within "Hosts" landing page. | Host logs and metrics. |
88
| [infra.kibana.spec.ts](https://github.com/elastic/oblt-playwright/blob/main/tests/kibana/infra.kibana.spec.ts)<br><br>Capturing Kubernetes metrics visualizations' request/query time in "Cluster Overview" dashboard. Tracking the duration it takes for "Inventory" page elements and visualizations to render and appear on screen within the allocated timeframe, reflecting the anticipated test data volume. | Kubernetes metrics from:<br>- Kubelet API,<br>- kube-state-metrics,<br>- Kubernetes API Server,<br>- Kubernetes Proxy. |
99
| [k8s_aggs.kibana.spec.ts](https://github.com/elastic/oblt-playwright/blob/main/tests/kibana/k8s_aggs.kibana.spec.ts)<br><br>Tracking the duration it takes for custom visualizations aggregating k8s metrics to render and appear on screen within the allocated timeframe, reflecting the anticipated test data volume. | Kubernetes metrics from:<br>- Kubelet API,<br>- kube-state-metrics,<br>- Kubernetes API Server,<br>- Kubernetes Proxy. |

docs/test_apm.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
---
33
| **Test** | **Steps** |
44
| :------------ | :------------ |
5-
| **Services** | **Step 01** - Setting search period, then selecting `opbeans-go` and asserting transaction tab visibility<br><br>_⌛Spend 30 seconds reviewing the page_<br><br>**Step 02** - Navigating to the "Transactions" tab, clicking on the most impactful transaction and asserting visualization visibility<br><br>_⌛Spend 30 seconds reviewing the page_ <br><br>**Step 03** - Clicking on the "Failed transaction correlations" tab, asserting visualization visibility, then filtering the result by a certain field value<br><br>_⌛Spend 30 seconds reviewing the page_<br><br>**Step 04** - Navigating to "Host logs", asserting canvas visibility<br><br> |
6-
| **Traces** | **Step 01** - Setting search period and waiting for top traces table to load<br><br>_⌛Spend 10 seconds reviewing the page_<br><br>**Step 02** - Navigating to the "Explorer" tab, filtering data by `http.response.status_code : 502`<br><br>_⌛Spend 30 seconds reviewing the page_<br><br>**Step 03** - Clicking on the "View related error" in the timeline. Asserting related errors<br><br> |
7-
| **Dependencies** | **Step 01** - Navigating to the Dependencies section, asserting dependencies table<br><br>_⌛Spend 10 seconds reviewing the page_<br><br>**Step 02** - Setting search period, selecting the dependency, navigating to the "Operations" tab and asserting table visibility<br><br>_⌛Spend 10 seconds reviewing the page_<br><br>**Step 03** - Clicking on the most impactful operation and asserting timeline visibility<br><br>_⌛Spend 30 seconds reviewing the page_<br><br>**Step 04** - Clicking on the transaction in the timeline and asserting tab panel visibility<br><br>_⌛Spend 30 seconds reviewing the page_<br><br> **Step 05** - Selecting "Trace logs", asserting data grid row |
5+
| **Services** | **Step 01** - Set the search interval via the date picker, then select `opbeans-go` and assert the transaction tab is visible<br><br>_⌛Spend 30 seconds reviewing the page_<br><br>**Step 02** - Navigate to the "Transactions" tab, click on the most impactful transaction and assert the visualization is loaded<br><br>_⌛Spend 30 seconds reviewing the page_ <br><br>**Step 03** - Click on the "Failed transaction correlations" tab, wait for the data to load and assert the visualization is loaded, then filter the result by a certain field value<br><br>_⌛Spend 30 seconds reviewing the page_<br><br>**Step 04** - Navigate to "Host logs" and assert the canvas is loaded<br><br> |
6+
| **Traces** | **Step 01** - Set the search interval via the date picker and wait for the top traces table to load<br><br>_⌛Spend 10 seconds reviewing the page_<br><br>**Step 02** - Navigate to the "Explorer" tab and filter data by `http.response.status_code : 502`<br><br>_⌛Spend 30 seconds reviewing the page_<br><br>**Step 03** - Click on "View related error" in the timeline and assert the related errors are visible<br><br> |
7+
| **Dependencies** | **Step 01** - Navigate to the Dependencies section and assert the dependencies table is loaded<br><br>_⌛Spend 10 seconds reviewing the page_<br><br>**Step 02** - Set the search interval via the date picker, select the dependency, navigate to the "Operations" tab and assert the table is loaded<br><br>_⌛Spend 10 seconds reviewing the page_<br><br>**Step 03** - Click on the most impactful operation and assert the timeline is loaded<br><br>_⌛Spend 30 seconds reviewing the page_<br><br>**Step 04** - Click on the transaction in the timeline and assert the tab panel is visible<br><br>_⌛Spend 30 seconds reviewing the page_<br><br> **Step 05** - Select "Trace logs" and assert the data grid row is visible |

docs/test_datasets.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[🔗 Test code](https://github.com/elastic/oblt-playwright/blob/main/tests/kibana/datasets.kibana.spec.ts)
2+
---
3+
| **Test** | **Steps** |
4+
| :------------ | :------------ |
5+
| **Dataset Quality** | **Step 01** - Navigate to the "Dataset Quality" page and assert that quality statistics are loaded<br><br>_⌛Spend 15 seconds reviewing the page_<br><br>**Step 02** - Set the search interval via the date picker and assert that the quality statistics have updated<br><br> |

docs/test_infra.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
---
33
| **Test** | **Steps** |
44
| :------------ | :------------ |
5-
| **Cluster Overview dashboard** | **Step 01** - Navigating to the "Cluster Overview" dashboard<br><br>_⌛Spend 10 seconds reviewing the page_<br><br>**Step 02** - Setting the search period and asserting visibility of the "Cores used vs total cores" and "Top Memory intensive pods per Node" visualizations'<br><br> |
6-
| **Infrastructure Inventory** | **Step 01** - Navigating to Infrastructure inventory, asserting waffle map, sorting by metric value and selecting a host<br><br>_⌛Spend 20 seconds reviewing the page_<br><br>**Step 02** - Setting search period, asserting "Host CPU Usage" & "Host Memory Usage" visualizations visibility<br><br>_⌛Spend 20 seconds reviewing the page_<br><br>**Step 03** - Selecting "Pods" as "Show" option, asserting waffle map, then navigating to the Kubernetes Pod metrics<br><br>_⌛Spend 10 seconds reviewing the page_<br><br>**Step 04** - Setting search period, asserting "Pod CPU Usage" & "Pod Memory Usage" visualization visibility |
5+
| **Cluster Overview dashboard** | **Step 01** - Navigate to the "Cluster Overview" dashboard<br><br>_⌛Spend 10 seconds reviewing the page_<br><br>**Step 02** - Set the search interval via the date picker and assert that the "Cores used vs total cores" and "Top Memory intensive pods per Node" visualizations are loaded<br><br> |
6+
| **K8S Aggregations dashboard** | **Step 01** - Navigate to a custom "K8S Aggregations" dashboard<br><br>**Step 02** - Set the search interval via the date picker and assert that a visualization is updated<br><br> |
7+
| **Infrastructure Inventory** | **Step 01** - Navigate to the Infrastructure Inventory, assert the waffle map is visible, sort by metric value, and select a host<br><br>_⌛Spend 20 seconds reviewing the page_<br><br>**Step 02** - Set the search interval via the date picker and assert that the "Host CPU Usage" & "Host Memory Usage" visualizations are updated<br><br>_⌛Spend 20 seconds reviewing the page_<br><br>**Step 03** - Select "Pods" from the "Show" dropdown, assert the waffle map is visible, then navigate to the Kubernetes Pod metrics<br><br>_⌛Spend 10 seconds reviewing the page_<br><br>**Step 04** - Set the search interval via the date picker and assert that the "Pod CPU Usage" & "Pod Memory Usage" visualizations are updated |

docs/test_logs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
---
33
| **Test** | **Steps** |
44
| :------------ | :------------ |
5-
| **All logs** | **Step 01** - Selecting `*logs` data view, setting search period and asserting canvas visibility<br><br> |
6-
| **Field Statistics** | **Step 01** - Selecting `*logs` data view, setting search period and asserting canvas visibility<br><br>_⌛Spend 30 seconds reviewing the page_<br><br>**Step 02** - Navigating to the "Field Statistics" tab and asserting doc count<br><br> |
7-
| **Patterns** | **Step 01** - Selecting `*logs` data view, setting search period and asserting canvas visibility<br><br>_⌛Spend 30 seconds reviewing the page_<br><br>**Step 02** - Navigating to the "Patterns" tab and asserting patterns row visibility |
5+
| **Discover - All logs** | **Step 01** - Select the `*logs` data view, set the search interval via the date picker, and assert the canvas is loaded<br><br> |
6+
| **Discover - Field Statistics** | **Step 01** - Select the `*logs` data view, set the search interval via the date picker and assert the canvas is loaded<br><br>_⌛Spend 30 seconds reviewing the page_<br><br>**Step 02** - Navigate to the "Field Statistics" tab, wait for the data to load and assert the doc count is visible<br><br> |
7+
| **Discover - Patterns** | **Step 01** - Select the `*logs` data view, set the search interval via the date picker and assert the canvas is visible<br><br>_⌛Spend 30 seconds reviewing the page_<br><br>**Step 02** - Navigate to the "Patterns" tab, wait for the data to load and assert the patterns row is visible |

0 commit comments

Comments
 (0)