mirror of https://github.com/openobserve/openobserve.git synced 2026-11-04 16:09:05 +00:00

Files

T

ktx-akshay b88b7573b0 test: add pytest for dashboard (#8698 )

### **PR Type**
Tests


___

### **Description**
- Add end-to-end dashboard API tests

- Cover CRUD flows and edge cases

- Validate SSE search stream responses

- Include auth, pagination, and folders


___

### Diagram Walkthrough


```mermaid
flowchart LR
  list["List dashboards"] -- "200 with/without auth" --> validateList["Validate structure"]
  create["Create dashboard"] -- "returns v1.dashboardId" --> read["Get by ID"]
  read -- "assert fields" --> delete["Delete dashboard"]
  updateNE["Update nonexistent"] -- "expect 400/404" --> done1["Handled"]
  missingReq["Missing required fields"] -- "expect 400/422" --> done2["Handled"]
  dupTitle["Duplicate title create"] -- "allowed" --> cleanup["Cleanup created dashboards"]
  pagination["List with limit"] -- "verify dashboards key" --> cleanup2["Cleanup"]
  sse["Search stream (SSE)"] -- "parse events/data" --> validateSSE["Validate results/hits"]
```



<details> <summary><h3> File Walkthrough</h3></summary>

<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Tests</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>test_dashboards.py</strong><dd><code>End-to-end pytest
for dashboard APIs</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

tests/api-testing/tests/test_dashboards.py

<ul><li>Add pytest suite for dashboard APIs<br> <li> Test list, create,
get, delete flows<br> <li> Validate SSE search stream parsing<br> <li>
Cover pagination, auth, errors, duplicate titles</ul>


</details>


  </td>
<td><a
href="https://github.com/openobserve/openobserve/pull/8698/files#diff-936c6e8532b2f4ad8ebd0d5d2bd43638e278ce0880498ccf0c446f9e01a20901">+404/-0</a>&nbsp;
</td>

</tr>
</table></td></tr></tr></tbody></table>

</details>

___

2025-10-01 15:04:40 +05:30

src

feat: integrate API integration testing using pytest (#2250 )

2023-12-27 16:59:41 +01:00

tests

test: add pytest for dashboard (#8698 )

2025-10-01 15:04:40 +05:30

.gitignore

feat: integrate API integration testing using pytest (#2250 )

2023-12-27 16:59:41 +01:00

.python-version

refactor: API Integration Tests workflow (#2324 )

2023-12-29 07:39:09 +01:00

Makefile

feat: integrate API integration testing using pytest (#2250 )

2023-12-27 16:59:41 +01:00

pyproject.toml

perf: pushdown plan (#7778 )

2025-07-31 14:31:33 +08:00

README.md

feat: integrate API integration testing using pytest (#2250 )

2023-12-27 16:59:41 +01:00

requirements-dev.lock

perf: pushdown plan (#7778 )

2025-07-31 14:31:33 +08:00

requirements.lock

perf: pushdown plan (#7778 )

2025-07-31 14:31:33 +08:00

README.md

pytest-openobserve

This is a repo to test openobserve API endpoints.

Introduction:

The tests are running using pytest against alpha1 for now. Idea is to parametrize it for the other endpoints like production as well.

Getting Started

We use rye to manage the python version and environment - https://github.com/mitsuhiko/rye
Once installed, simply run the following steps:
- rye sync
- rye run pytest

TODOS:

Parametrize tests to run against different environments
Run the tests as cron-job every few hours or daily etc. for different environments
Send slack-notification ( use github-actions ) in case something fails on alpha1 or production endpoints.