Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

A CLI tool that allows for local testing of Argo Events sensors #3339

Open
wetcod opened this issue Oct 23, 2024 · 2 comments
Open

A CLI tool that allows for local testing of Argo Events sensors #3339

wetcod opened this issue Oct 23, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@wetcod
Copy link

wetcod commented Oct 23, 2024

Is your feature request related to a problem? Please describe.
When working with Argo Events sensors, it’s frustrating that there’s no easy way to test sensor configurations in a local environment without deploying to a live environment.
This makes development slower and introduces more risk when deploying changes.

Describe the solution you'd like

A CLI tool that allows for local testing of Argo Events sensors. The tool should enable:

  1. Filter Testing: Verifying that events are correctly filtered based on filter criteria.
  2. Parameters Testing: Checking that the values specified in dataKey are correctly mapped to the desired parameters.

Advantages

  • Enables quick, iterative development and testing of sensor configurations locally.
  • Increases maintainability of sensor files by allowing frequent testing.
  • Can be integrated into CI pipelines for automated testing of sensor configurations.

[CMD Examples]
Filter Test Example

echo test_webhook.json | argo-events-test filter
> True

Parameters Test Example

echo test_webhook.json | argo-events-test parameter
> [ 
  { 
    "name": "template1", 
    "parameters": [ 
      "param1": "value1", 
      "param2": "value2", 
      "param3": "value3" 
    ] 
  } 
]

Describe alternatives you've considered

Additional context


Message from the maintainers:

If you wish to see this enhancement implemented please add a 👍 reaction to this issue! We often sort issues this way to know what to prioritize.

@wetcod wetcod added the enhancement New feature or request label Oct 23, 2024
@OneCricketeer
Copy link

OneCricketeer commented Oct 27, 2024

What kind of eventsource are you using? NATS, HTTP, Kafka, etc all do have CLI tools that can be used.

@wetcod
Copy link
Author

wetcod commented Oct 28, 2024

@OneCricketeer
I'm using Github EventSource. What I want is a tool to verify if the values of EventSource and Sensor k8s manifestsz are correct without deploying Argo Event and Argo Workflow. I'm writing the specifications for EventSource and Sensor in a Github repository, and I'd like to validate these specs as a PR check whenever there's a change.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants