Skip to content

Conversation

pranjalg1331
Copy link
Contributor

Checklist

  • The pull request is for the branch main
  • If I added new documentation related to a new Pull Request that I created, I have added a reference to the related Pull Request
    • If the new documentation will be added in a future release, please add a reference like _Available from version > x.x.x_ where x.x.x is the current version number
  • If the additional documentation is a fix, you should directly push to the main branch and do not open this PR.

Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
Copy link
Member

@mlodic mlodic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good! :)
can you also please modify this section too?

Also the PR template (https://github.com/intelowlproject/IntelOwl/blob/master/.github/pull_request_template.md) in the main repo needs an update regarding the monkeypatch.

Thanks!

@fgibertoni
Copy link
Contributor

Good!
I would add some more examples on how to create different types of tests. I'm thinking about how to write tests for Docker-based analyzers maybe. Since are a bit different conceptually from other analyzer I would like an example on them.
Also, I'd like to have in the docs a brief explanation on what each new method does, so new users can understand faster where things need to go and how they've been created. I'm thinking from the perspective of a new contributor to the project, I would appreciate a more guided approach in writing my first test.
Lmk what you think! 😃 Thanks!

Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
@pranjalg1331
Copy link
Contributor Author

I have updated the details that you asked for to make it smoother for new contributors. I have also added a note referencing to specific test class for Docker-based analyzers.

@mlodic
Copy link
Member

mlodic commented Aug 18, 2025

thanks!

Can you also address my request please?
See:

can you also please modify this section too?
Also the PR template (https://github.com/intelowlproject/IntelOwl/blob/master/.github/pull_request_template.md) in the main repo needs an update regarding the monkeypatch.

Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
@pranjalg1331
Copy link
Contributor Author

Updated both the sections.

@@ -711,6 +711,17 @@ To test a plugin in real environment, i.e. without mocked data, we suggest that
Meaning that you have your plugin configured, you have selected a correct observable/file to analyze,
and the final report shown in the GUI of IntelOwl is exactly what you wanted.

### Running Tests for a Specific Analyzer
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please use 5 hashtags to get the title size consistent. Otherwise good, thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated.

Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants