apache/gravitino

[Improvement] clarify docker test failure messages

Open

#4,170 opened on Jul 16, 2024

View on GitHub
 (4 comments) (0 reactions) (2 assignees)Java (887 forks)auto 404
good first issueimprovement

Repository metrics

Stars
 (3,058 stars)
PR merge metrics
 (PR metrics pending)

Description

What would you like to be improved?

Since the default value of skipDockerTests is true. When user runs the docker tests task without setting skipDockerTests=false, the test will be failed but the error message is confused:

  • What went wrong: Execution failed for task ':integration-test:test'.

No tests found for given includes: [org.apache.gravitino.integration.test.client.AuditIT](--tests filter)

note: use ./gradlew :integration-test:test --tests "org.apache.gravitino.integration.test.client.AuditIT" to reproduce

How should we improve?

We should add configuration modification instructions in the error message to help users locate the cause of the error more easily.

Contributor guide

Research direction
Look at the Gradle task for Docker tests and modify the error message to include a note about setting skipDockerTests=false.
Tech stack
java
Domain
testing
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GradleDocker
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90