ortoni-report 2.0.4 → 2.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/changelog.md +11 -0
  2. package/dist/ortoni-report.d.ts +27 -47
  3. package/dist/ortoni-report.js +23151 -268
  4. package/dist/ortoni-report.mjs +23146 -269
  5. package/dist/style/main.css +40 -1
  6. package/dist/utils/expressServer.js +33 -0
  7. package/dist/utils/utils.js +17 -1
  8. package/dist/utils/webSocketHelper.js +93 -0
  9. package/dist/views/main.hbs +168 -113
  10. package/dist/views/testPanel.hbs +0 -1
  11. package/dist/views/userInfo.hbs +10 -9
  12. package/package.json +3 -1
  13. package/readme.md +110 -67
package/readme.md CHANGED
@@ -1,128 +1,171 @@
1
1
  # Ortoni Report by Koushik (LetCode with Koushik)
2
2
 
3
- Welcome to **Ortoni Report**, a robust HTML report generator tailored for Playwright tests. Ortoni Report introduces powerful features to enhance test reporting, making it easier to visualize and manage test results.
3
+ Welcome to **Ortoni Report**, a comprehensive and visually appealing HTML report generator tailored for Playwright tests. Designed with powerful features and customizable options, Ortoni Report simplifies the process of reviewing and managing test results, making test reporting more intuitive and accessible.
4
4
 
5
- Experience the live report: [Ortoni Report](https://ortoni.netlify.app/)
5
+ ### Live Demo: [Ortoni Report](https://ortoni.netlify.app/)
6
6
 
7
- ![Ortoni Report Preview](https://raw.githubusercontent.com/ortoniKC/ortoni-report/refs/heads/V2.0.4/Ortoni-report.png)
7
+ ![Ortoni Report Preview](https://raw.githubusercontent.com/ortoniKC/ortoni-report/refs/heads/V2.0.5/assets/images/Ortoni-report.png)
8
+
9
+ ---
8
10
 
9
11
  ## Key Features
10
12
 
11
13
  1. **Hierarchical Grouping**
12
- - Tests are grouped hierarchically by file name, suite, and project, offering a structured view of test execution.
14
+ - Tests are structured and grouped by filename, suite, and project, providing a clear and organized view of the entire test execution.
13
15
 
14
16
  2. **Detailed Breakdown**
15
- - Each suite includes categorized tests under respective projects, providing clear organization.
17
+ - Each suite displays tests categorized by project, with organized test results for better navigation.
16
18
 
17
19
  3. **Comprehensive Test Details**
18
- - Display test status (passed, failed, skipped), duration, tags, errors, logs, and screenshots.
19
- - Sort and filter tests by suite, project, and script for detailed insights.
20
+ - Rich details include test status (passed, failed, skipped), duration, tags, errors, logs, annotations, screenshots, videos, and trace data.
21
+ - Users can sort and filter tests by suite, project, or script for more focused insights.
20
22
 
21
23
  4. **Summary Statistics**
22
- - Overview of total tests, passed, failed, skipped, and flaky tests.
23
- - Success rate calculation for test suites.
24
+ - Overview displays total tests, passed, failed, skipped, and flaky tests, with a success rate calculation for each suite.
24
25
 
25
- 5. **Chart Visualization**
26
- - Doughnut chart representation for visualizing test result distribution (passed, failed, skipped, flaky).
26
+ 5. **Chart Visualizations**
27
+ - Visualize test result distributions using:
28
+ - **Doughnut Chart**: Illustrates overall test result status (passed, failed, skipped, flaky).
29
+ - **Doughnut & Bar Charts**: Breakdown of results per project (Chromium, Firefox, etc.) for easy comparison.
27
30
 
28
- 6. **Search and Reset**
29
- - Search functionality to filter tests based on user input.
30
- - Reset option to clear filters and display all tests.
31
+ 6. **Advanced Search and Reset**
32
+ - Search and filter tests quickly using specific keywords or criteria. Easily reset filters to display all tests again.
31
33
 
32
- 7. **Customization and Themes**
33
- - Customize project details, author name, test types, and toggle between dark/light themes.
34
- - Option to choose between Base64 images or file paths for screenshots.
35
- - Users can set the report file name.
34
+ 7. **Customization & Themes**
35
+ - Personalize reports with project details, author name, test type, and toggle between light and dark themes.
36
+ - Flexibility to choose between Base64 images or file paths for screenshots.
37
+ - Customize report filenames and folder paths.
36
38
 
37
- 8. **Responsive Design**
38
- - Optimized layout that adapts seamlessly to different screen sizes for accessibility.
39
+ 8. **Test Attachments**
40
+ - Screenshots
41
+ - Videos
42
+ - Trace viewer
43
+ - Steps
44
+ - Error stack trace
45
+ - Console logs
39
46
 
40
47
  9. **Integration and Configuration**
41
- - Easily integrate with Playwright configurations using TypeScript/JavaScript.
42
- - Configure reporting preferences within your Playwright setup.
48
+ - Easily configure and integrate with Playwright using TypeScript/JavaScript.
49
+ - Configure reporting preferences within the Playwright setup for quick customization.
43
50
 
44
- 10. **Add Logo to the Report**
45
- - Add a relative or absolute path of the image to the config.
51
+ 10. **Add Your Logo**
52
+ - Include your branding by adding a relative or absolute path to the config for a custom logo in the report.
46
53
 
47
- 11. **Share Report**
48
- - Once report is generated it is ready to share
54
+ 11. **Share Reports**
55
+ - Generated reports are self-contained and ready to share right away, making it easier to distribute and review.
49
56
 
50
57
  12. **Advanced Filtering**
51
- - Filter tests by project, tags, and status simultaneously, with the ability to display only those tests matching the selected criteria.
58
+ - Apply filters based on project, tags, and test status simultaneously for precise reporting. See only the relevant tests.
52
59
 
53
- 13. **Colorful Dashboard**
54
- - Enhanced the visual appeal of the dashboard with vibrant and intuitive colors.
60
+ 13. **Colorful and Intuitive Dashboard**
61
+ - Vibrant, intuitive color schemes enhance the dashboard’s visual appeal, improving clarity for quick test status assessment.
55
62
 
56
- 14. **Display Selected Status on UI**
57
- - The selected status filter is now visible on the UI, making it easier to track the current filter settings.
63
+ 14. **Selected Status Display**
64
+ - The UI now clearly displays the selected status filter, helping users keep track of the current filter criteria.
58
65
 
59
66
  15. **Hide Skipped Tests by Default**
60
- - Skipped tests are now hidden by default when using the "All Tests" filter, providing a cleaner and more focused view of relevant tests.
67
+ - By default, skipped tests are hidden when using the "All Tests" filter, allowing for a more focused review of relevant test cases.
68
+
69
+ ---
61
70
 
62
- ### How to Use Ortoni Report
71
+ ## Installation & Setup
63
72
 
64
- #### Installation
73
+ ### Step 1: Install Ortoni Report
65
74
 
66
- 1. **Install the ortoni-report package**:
75
+ Run the following command to install the **ortoni-report** package globally:
67
76
 
68
- ```sh
69
- npm install -g ortoni-report
70
- ```
77
+ ```bash
78
+ npm install -g ortoni-report
79
+ ```
71
80
 
72
- ### Configurable Report Generation
81
+ ### Step 2: Configure in `playwright.config.ts`
73
82
 
74
- Configure OrtoniReport in your `playwright.config.ts`:
83
+ Set up **Ortoni Report** in your Playwright configuration file with the following example:
75
84
 
76
85
  ```typescript
77
- import { defineConfig } from '@playwright/test';
86
+ import { defineConfig } from "@playwright/test";
78
87
  import { OrtoniReportConfig } from "ortoni-report";
79
88
 
80
89
  const reportConfig: OrtoniReportConfig = {
81
- preferredTheme: "light",
82
- filename: "index",
83
- authorName: "Koushik (LetCode with Koushik)",
84
- projectName: "Ortoni Report V2.0.3",
85
- testType: "Release",
86
- title: "Ortoni Report By LetCode Koushik",
90
+ port: 1994,
91
+ open: "on-failure",
92
+ folderPath: "report",
93
+ filename: "index.html",
87
94
  logo: "logo.png",
95
+ title: "Ortoni Test Report",
96
+ showProject: false,
97
+ projectName: "Ortoni-Report",
98
+ testType: "Release - Oct 21, 2024",
99
+ authorName: "Koushik (LetCode with Koushik)",
100
+ preferredTheme: "light",
88
101
  base64Image: true,
102
+ };
103
+
104
+ export default defineConfig({
105
+ reporter: [["ortoni-report", reportConfig], ["dot"]],
106
+ // Other Playwright configurations
107
+ });
108
+ ```
109
+ ### Configure in `playwright.config.js`
110
+ ```javascript
111
+ import { defineConfig } from "@playwright/test";
112
+
113
+ const reportConfig = {
114
+ port: 1994,
115
+ open: "on-failure",
89
116
  folderPath: "report",
90
- showProject: false
91
- }
117
+ filename: "index.html",
118
+ logo: "logo.png",
119
+ title: "Ortoni Test Report",
120
+ showProject: false,
121
+ projectName: "Ortoni-Report",
122
+ testType: "Release - Oct 21, 2024",
123
+ authorName: "Koushik (LetCode with Koushik)",
124
+ preferredTheme: "light",
125
+ base64Image: true,
126
+ };
92
127
 
93
128
  export default defineConfig({
94
- reporter: [['ortoni-report', reportConfig], ['dot']],
95
- // Other Playwright configurations
129
+ reporter: [["ortoni-report", reportConfig], ["dot"]],
130
+ // Other Playwright configurations
96
131
  });
97
132
  ```
98
- ### Comprehensive Test Details
99
133
 
100
- - **Rich Test Information**: Each test includes details like title, status, duration, tags, errors, steps, logs, video, and screenshot.
101
- - **Color-coded Status**: Status indicators (green for passed, red for failed, yellow for skipped) for quick identification.
102
- - **Static HTML Report**: Single file can be shared easily
134
+ ## Detailed Test Information
135
+
136
+ - **Rich Test Data**: Each test includes details such as title, status, duration, tags, errors, steps, logs, video, and screenshots.
137
+ - **Color-Coded Status**: Green for passed, red for failed, yellow for skipped—offering a quick overview of test outcomes.
138
+ - **Static HTML Report**: Self-contained, standalone HTML files make sharing and storing reports convenient.
139
+
140
+ ---
141
+
142
+ ## Changelog
103
143
 
104
- ### Future Plans
144
+ Stay up-to-date with the latest features, improvements, and bug fixes by reviewing the [Changelog](https://github.com/ortoniKC/ortoni-report/blob/main/changelog.md).
105
145
 
106
- - **Enhanced Customization**: Additional options for customizing report appearance and structure.
107
- - **CI/CD Integration**: Improved support for CI/CD environments.
146
+ ---
108
147
 
109
- ### Change Logs
148
+ ## License
110
149
 
111
- Explore the latest updates and changes in our [Changelog](https://github.com/ortoniKC/ortoni-report/blob/main/changelog.md).
150
+ This project is licensed under the terms of the [LICENSE](https://github.com/ortoniKC/ortoni-report/blob/main/LICENSE.md).
112
151
 
113
- ### License
152
+ ---
114
153
 
115
- View the [LICENSE](https://github.com/ortoniKC/ortoni-report/blob/main/LICENSE.md) for licensing details.
154
+ ## Feedback and Contributions
116
155
 
117
- ### Feedback and Contributions
156
+ We encourage you to share feedback and contribute to improving Ortoni Report! For issues, suggestions, or contributions, please visit our [GitHub repository](https://github.com/ortoniKC/ortoni-report).
118
157
 
119
- We value your feedback and contributions! For issues, suggestions, or contributions, visit our [GitHub repository](https://github.com/ortoniKC/ortoni-report).
158
+ ---
120
159
 
121
- Thank you for choosing Ortoni Report. We're committed to enhancing your Playwright testing experience.
160
+ ## Support
122
161
 
123
- ### Support
124
- UPI: ortoni@axl (Koushik Chatterjee)
162
+ If you'd like to support this project, you can donate via UPI:
163
+
164
+ **UPI**: ortoni@axl (Koushik Chatterjee)
165
+
166
+ ---
125
167
 
168
+ Thank you for using **Ortoni Report**! We’re committed to providing you with a superior Playwright testing experience.
126
169
 
127
170
  ---
128
171