splunk / splunk/pytest-splunk-addon

Requirement test samples should be accepted as *.xml files rather than *.log

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

Nobody has claimed this yet.

enhancement major
Dominant language
Python
Stars
66
Forks
21
Avg merge
4d 13h
Merged PRs (30d)
2

Description

The files content has to be XML formatted
Beside making sure this is true once tests are run (there is separate issue raised for that https://github.com/splunk/pytest-splunk-addon/issues/548), the test should accept *.xml files, so that anyone can easily validate them - eg. by opening in web browser.

This enhancement can be implemented in two or three stages:

  1. accept both formats: *.log and *.xml, that would require non-breaking change
  2. WARN is *.log is used with information that expected is *.xml and *.log will be depreciated
  3. accept only *.xml

Contributor guide

Open the contributing guide

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

The issue names no file, test, or entry point. Start by locating where requirement-test samples select or validate file extensions, then determine how the proposed compatibility stages fit the project. Done should include accepting *.xml files, with the warning or removal of *.log handled according to the chosen stage.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.