Skip to content

Commit a1693d4

Browse files
Manuraj-7Ishavyas9
authored andcommitted
Audit Logs + Custom Status + Assertions Doc
1 parent 6bd3472 commit a1693d4

File tree

9 files changed

+167
-17
lines changed

9 files changed

+167
-17
lines changed
38.4 KB
Loading
89.4 KB
Loading
98.1 KB
Loading
65.1 KB
Loading

docs/kane-ai-command-guide.md

Lines changed: 82 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -133,14 +133,90 @@ You can add maximum of 300 seconds timeout for an operation.
133133

134134
If your element is not visible in the viewport, you can use the `scroll until` command to go to that particular element if that is present currently in the DOM. This can be used in vertical scrollable pages & even on the scrollable sub-sections.
135135

136-
## Assertions and Queries
137-
### Assert Element Text
138-
- `assert if red button text is "subscribe"`
136+
## Assertions
137+
KaneAI supports a range of assertions to make test validations more seamless and effective. Here are the types of assertions currently supported:
139138

140-
### Assert Element Presence
141-
- `assert if KaneAI is present on the "viewport"`
139+
### Driver Assertions
140+
Driver assertions rely on the web driver to validate browser url, page & window properties and dimensions.
142141

143-
### Query Information
142+
**Examples:**
143+
- Assert if the current browser URL is "https://example.com".
144+
- Validate if the client height and width match the expected values.
145+
146+
### Text Assertions
147+
Text assertions validate the presence or absence of specific text on the screen.
148+
149+
**Examples:**
150+
- Assert if the text "Welcome Back!" is visible.
151+
- Check if the error message "Invalid password" appears on failed login.
152+
153+
### Visual Assertions
154+
Visual assertions ensure the visibility of images on the screen.
155+
156+
**Examples:**
157+
- Assert if the company logo is displayed in the header.
158+
- Verify the visibility of a product image on the product page.
159+
160+
### Relative Assertions
161+
Relative assertions check the visibility of one element in relation to another.
162+
163+
**Examples:**
164+
- Assert if the login button is in same column as the username field.
165+
- Check if the submit button and cancel button are in the same row.
166+
167+
### Mathematical Assertions
168+
Mathematical assertions verify numerical operations or calculations.
169+
170+
**Examples:**
171+
- Verify if the sum of 3 and 4 equals 7.
172+
173+
## Unsupported Assertions
174+
There are some assertions that KaneAI does not support at this moment. However the support for these kind of assertions is currently under development.
175+
Below are examples of unsupported assertions along with examples.
176+
177+
### Element State Assertions (To be available soon)
178+
These assertions check for state of elements like being disabled or enabled.
179+
180+
**Examples:**
181+
- Assert if the submit button is disabled.
182+
- Assert if text input field is enabled.
183+
- Assert if a dropdown is expanded.
184+
185+
### Element Property Assertions (To be available soon)
186+
Property assertions involve checking styles or attributes of an element.
187+
188+
**Examples:**
189+
- Assert if the font size of a header is "16px".
190+
- Assert if the padding of a button is "10px".
191+
192+
### Spatial Assertions (To be available soon)
193+
Spatial assertions validate the position or arrangement of elements.
194+
195+
**Examples:**
196+
- Assert that the 5th column of a table contains "Jordan.Mathews".
197+
198+
### Logical Assertions (To be available soon)
199+
Logical assertions are used to combine multiple conditions.
200+
201+
**Examples:**
202+
- Assert if the user is an admin **and** is logged in.
203+
- Assert if either username or email is filled.
204+
205+
### Assertions for Actions Being Performed (To be available soon)
206+
These assertions aim to check the state after an action, which is not supported directly.
207+
208+
**Examples:**
209+
- Assert if the page is scrolled to the bottom.
210+
- Assert if a tooltip appears after hovering over an info icon.
211+
- Currently, you can break this into two steps: Hover on the info icon, then assert if the tooltip is visible.
212+
213+
### Nested Assertions (To be available soon)
214+
Nested assertions involve multiple layers of validation within a single assertion.
215+
216+
**Examples:**
217+
- Assert if both the login button is enabled and the welcome message is visible.
218+
219+
## Query Information
144220
- `query the current url`
145221
- `query the time mentioned in the poster`
146222

docs/system-and-custom-fields.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,29 +43,37 @@ slug: system-and-custom-fields/
4343

4444
Explore the structured organization of your test projects through the use of Fields and Values, accessible via the Project's dashboard. Dive into System Fields for essential categorizations or enhance your project's flexibility with Custom Fields to improve your testing workflows.
4545

46-
1. In the Project's dashboard, click on **Settings** in the top right hand side.
46+
To access the System & Custom Fields settings, click on **Settings** in the top right hand side in the Project's dashboard.
4747

4848
<img loading="lazy" src={require('../assets/images/mobile-app-testing/project-dashboard.webp').default} alt="Real " className="doc_img" width="1366" height="629"/>
4949

50-
2. You will be able to view the **System Fields** and **Custom Fields**.
50+
You can manage your **System** and **Custom Fields** in this Fields page.
5151

52-
- System Fields is a default feature provided by LambdaTest that includes standard fields like **Priority**, **Status**, and **Type**. These fields help organize and track your test cases. They can be seamlessly integrated into your test management process and customized by adding values. To do so, simply click on any field and select **Add Value**.
52+
### System Fields
53+
Is a default feature provided by LambdaTest that includes standard fields like **Priority**, **Status**, and **Type**. These fields help organize and track your test cases, test runs or instances. They can be seamlessly integrated into your test management process and customized by adding values. To do so, simply click on any field and select **Add Value**.
5354

54-
<img loading="lazy" src={require('../assets/images/mobile-app-testing/system-fields.webp').default} alt="Real " className="doc_img" width="1366" height="629"/>
55+
:::note
56+
Custom field values can be set for System Field but for Test Runs this customization is only applicatble for the `Status` field.
57+
:::
5558

56-
- Custom Fields allow you to store additional information beyond what System Fields offer. To create a new field, enter the required details and choose the appropriate data type from the **Type** function. Available types include String, Textarea, Number, Dropdown (Single Select), Dropdown (Multi Select), Boolean (Checkbox), Date, User, and URL.
59+
<img loading="lazy" src={require('../assets/images/mobile-app-testing/system-fields.png').default} alt="Real " className="doc_img" width="1366" height="629"/>
60+
61+
<img loading="lazy" src={require('../assets/images/mobile-app-testing/edit-system-fields.webp').default} alt="Real " className="doc_img" width="1366" height="629"/>
62+
63+
### Custom Fields
64+
Allow you to store additional information beyond what System Fields offer. To create a new field, enter the required details and choose the appropriate data type from the **Type** function. Available types include String, Textarea, Number, Dropdown (Single Select), Dropdown (Multi Select), Boolean (Checkbox), Date, User, and URL.
5765

5866
<img loading="lazy" src={require('../assets/images/mobile-app-testing/create-new-fields.webp').default} alt="Real " className="doc_img" width="1366" height="629"/>
5967

60-
- For Dropdown types (Single Select and Multi Select), you also have the option to add values.
68+
For Dropdown types (Single Select and Multi Select), you also have the option to add values.
6169

6270
<img loading="lazy" src={require('../assets/images/mobile-app-testing/dropdown-types.webp').default} alt="Real " className="doc_img" width="1366" height="629"/>
6371

64-
- Enter the name, placeholder, mark the field, apply it to all future projects if required and click create.
72+
Enter the name, placeholder, mark the field, apply it to all future projects if required and click create.
6573

6674
<img loading="lazy" src={require('../assets/images/mobile-app-testing/custom-fields.webp').default} alt="Real " className="doc_img" width="1366" height="629"/>
6775

68-
3. You can also link a single or multiple projects of your choice to the custom fields and click on **Save changes**.
76+
You can also link a single or multiple projects of your choice to the custom fields and click on **Save changes**.
6977

7078
<img loading="lazy" src={require('../assets/images/mobile-app-testing/link-projects.webp').default} alt="Real " className="doc_img" width="1366" height="629"/>
7179

docs/test-instance-audit-logs.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
id: test-instance-audit-logs
3+
title: Test Instance Audit Logs
4+
hide_title: false
5+
sidebar_label: Test Instance Audit Logs
6+
description: See every thing you update in a test instance through Audit Logs.
7+
keywords:
8+
- audit log
9+
- test instance logs
10+
- execution history
11+
url: https://www.lambdatest.com/support/docs/test-instance-audit-logs/
12+
site_name: LambdaTest
13+
slug: test-instance-audit-logs/
14+
---
15+
16+
<script type="application/ld+json"
17+
dangerouslySetInnerHTML={{ __html: JSON.stringify({
18+
"@context": "https://schema.org",
19+
"@type": "BreadcrumbList",
20+
"itemListElement": [{
21+
"@type": "ListItem",
22+
"position": 1,
23+
"name": "LambdaTest",
24+
"item": "https://www.lambdatest.com"
25+
},{
26+
"@type": "ListItem",
27+
"position": 2,
28+
"name": "Support",
29+
"item": "https://www.lambdatest.com/support/docs/"
30+
},{
31+
"@type": "ListItem",
32+
"position": 3,
33+
"name": "Test Run Creation",
34+
"item": "https://www.lambdatest.com/support/docs/test-instance-audit-logs/"
35+
}]
36+
})
37+
}}
38+
></script>
39+
Test Manager now provides Audit Logs for test instance execution. Audit Logs bring visibility into the **who, what, and when** for every test execution. This is critical for teams working in regulated environments, or those needing high accountability in their QA processes.
40+
41+
With Audit logs you can store the execution history of your tests and even run parallel execution sessions without losing the context on individual executions as every action will be logged with clear indication of time stamps & executor.
42+
43+
## Details captured in Audit Logs
44+
45+
- Test Instance & Steps `Status` changes.
46+
- Test Instance & Steps `Remarks or attachment` changes.
47+
- Test Instance Assignee changes.
48+
49+
You can view the Audit Logs by clicking on the `View Execution Log`.
50+
51+
<img loading="lazy" src={require('../assets/images/mobile-app-testing/test-runs/view_execution_logs.png').default} alt="Real " className="doc_img"/>
52+
53+
<img loading="lazy" src={require('../assets/images/mobile-app-testing/test-runs/audit_logs.png').default} alt="Real " className="doc_img"/>
54+
55+
For the Steps level execution logs, you can preview the step with respect to which the log was created.
56+
57+
:::note
58+
As step level Audit logs are with respect to that specific steps in case the step changes the old logs will still show the preview of the older step.
59+
:::
60+
61+
<img loading="lazy" src={require('../assets/images/mobile-app-testing/test-runs/audit_logs_step_preview.png').default} alt="Real " className="doc_img"/>
62+
63+
:::note
64+
When you delete a configuration or a test case, all associated audit logs are removed. This is because the action deletes the entire instance. If you then add the same test case and configuration again, it creates a brand new instance with no prior audit history.
65+
:::

sidebars.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2007,9 +2007,10 @@ module.exports = {
20072007
],
20082008
},
20092009
{
2010-
type: "doc",
2011-
label: "Test Run",
2012-
id: "test-run-creation-and-management",
2010+
type: "category",
2011+
collapsed: true,
2012+
label: "Test Run & Instances",
2013+
items: ["test-run-creation-and-management", "test-instance-audit-logs"],
20132014
},
20142015
{
20152016
type: "doc",

0 commit comments

Comments
 (0)