apache/shenyu

[Task] Add end-to-end (E2E) testing for logging plugins.

Open

#5,529 opened on Apr 2, 2024

View on GitHub
 (12 comments) (0 reactions) (0 assignees)Java (8,196 stars) (2,899 forks)batch import
good first issuestatus: volunteer wanted

Description

Description

Currently, there are many logging plugins in Shenyu that lack end-to-end (E2E) testing. It is necessary to improve the E2E testing for these logging plugins now. You can refer to the E2E testing of the RocketMQ logging plugin: https://github.com/apache/shenyu/pull/5439

Task List

  • 1. Logging-ElasticSearch Plugin
  • 2. Logging-RabbitMq Plugin
  • 3. Logging-Kafka Plugin @RayayChung @zzzk1
  • 4 .Logging-Pulsar Plugin
  • 5. Logging-Clickhouse Plugin
  • 6. Logging-RocketMq Plugin (Finished) @xcsnx

Contributor guide

Tech stack
javadocker
Domain
testingbackend
Issue type
test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
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
Java programmingE2E testing basicsFamiliarity with Apache Shenyu
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Start by examining the reference PR for RocketMQ logging plugin E2E tests (https://github.com/apache/shenyu/pull/5439) to understand the test structure and setup. Then implement similar tests for the remaining logging plugins: ElasticSearch, RabbitMQ, Kafka, Pulsar, and Clickhouse. Focus on the shenyu integrated test module where existing E2E tests reside. Each plugin test should cover sending logs through the plugin and verifying they are correctly stored in the respective logging system.