firecrawl/apps/test-suite
Gergő Móricz f4466f6bb0 fix(test-suite): add artillery 2024-08-14 19:33:09 +02:00
..
data dependabot for security checks, fixed crawl test 2024-07-05 14:49:03 -03:00
load-test-results Delete test-run-report.json 2024-06-17 09:25:29 -03:00
tests dependabot for security checks, fixed crawl test 2024-07-05 14:49:03 -03:00
utils Merge branch 'main' of https://github.com/mendableai/firecrawl 2024-07-25 17:48:43 -03:00
.env.example Ni 2024-05-08 12:18:53 -07:00
README.md Added load testing using artillery 2024-05-17 18:32:44 -03:00
jest.config.js [Test] Added integration tests suite 2024-05-03 17:23:25 -03:00
jest.setup.js [Test] Added integration tests suite 2024-05-03 17:23:25 -03:00
load-test.yml crawl load tests 7 and 8 2024-05-23 16:36:05 -03:00
package.json fix(test-suite): add artillery 2024-08-14 19:33:09 +02:00
pnpm-lock.yaml fix(test-suite): add artillery 2024-08-14 19:33:09 +02:00
tsconfig.json added crawl test suite 2024-05-15 15:50:50 -03:00

README.md

Test Suite for Firecrawl

This document provides an overview of the test suite for the Firecrawl project. It includes instructions on how to run the tests and interpret the results.

Overview

The test suite is designed to ensure the reliability and performance of the Firecrawl system. It includes a series of automated tests that check various functionalities and performance metrics.

Running the Tests

To run the tests, navigate to the test-suite directory and execute the following command:

npm install
npx playwright install
npm run test

Running Load Tests with Artillery

To run load tests using Artillery, follow these steps:

  1. Install Artillery globally if you haven't already:
npm install -g artillery
  1. Run the load test:
artillery run load-test.yml

Test Results

The tests are designed to cover various aspects of the system, including:

  • Crawling accuracy
  • Response time
  • Error handling

Example Test Case

  • Test Name: Accuracy Test
  • Description: This test checks the accuracy of the scraping mechanism with 100 pages and a fuzzy threshold of 0.8.
  • Expected Result: Accuracy >= 0.9
  • Received Result: Accuracy between 0.2 and 0.3

Troubleshooting

If you encounter any failures or unexpected results, please check the following:

  • Ensure your network connection is stable.
  • Verify that all dependencies are correctly installed.
  • Review the error logs for any specific error messages.

Contributing

Contributions to the test suite are welcome. Please refer to the project's main CONTRIBUTING.md file for guidelines on how to contribute.