Skip to content

Documentation needed: How to properly execute 'cargo test' and handle test dependencies #6

Description

@MathieuSoysal

Description:

The current README.md provides excellent information about building the WebAssembly package and project architecture, but lacks crucial documentation about running tests with cargo test.

Current Issue:

When running cargo test, 104 out of 189 tests fail with network connection errors (404 Not Found), indicating they're trying to connect to live Proton Wallet backend services.

Example Error:

MuonError(Error { kind: Send, src: Some(StatusErr(StatusErr(404, HttpRes { res: Response { status: 404, version: HTTP/1.1, headers: {"content-length": "0", "date": "Thu, 31 Jul 2025 18:00:27 GMT"}, body: [] } }))), retryable: false })

What's Missing:

  1. Instructions on setting up test environment
  2. Information about required environment variables for testing
  3. Whether tests need mock servers or test credentials
  4. How to run only unit tests vs integration tests
  5. Test-specific dependencies or setup requirements

Suggested Documentation Additions:

  • Add a "Testing" section to README.md
  • Include information about test categories (unit, integration, ignored)
  • Provide setup instructions for different test scenarios
  • Document any required environment configuration
  • Add examples of running specific test subsets

Would it be possible to add comprehensive testing documentation to help developers understand how to properly run and configure tests for this project?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions