splunk / splunk/contentctl

Consider reusing instances of CorrelationSearch across multiple tests for the same detection

Open
#228 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
139
Forks
52
Avg merge
1h 16m
Merged PRs (30d)
3

Description

  • Right now, we are creating one CorrelationSearch instance for each case
  • Typically, there is only one unit test, and thus one integration test, per detection, so this is not an issue.
  • However, if we start having many test cases per detection, we will be duplicating some effort & network calls that we don't need to.
  • Consider refactoring in order to re-use CorrelationSearch objects across tests in such a case

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating where CorrelationSearch instances are created across the unit and integration tests, then compare setup for tests covering the same detection. The refactor is done when applicable tests reuse a CorrelationSearch instance and avoid duplicate effort and network calls without changing test coverage.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.