Skip to content

Conversation

pranjalg1331
Copy link
Contributor

@pranjalg1331 pranjalg1331 commented Feb 26, 2025

(Please add to the PR name the issue/s that this PR would close if merged by using a Github keyword. Example: <feature name>. Closes #999. If your PR is made by a single commit, please add that clause in the commit too. This is all required to automate the closure of related issues.)

Description

Please include a summary of the change and link to the related issue.
Closes #2731

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue).
  • [x ] New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).

Checklist

  • [ x] I have read and understood the rules about how to Contribute to this project
  • [x ] The pull request is for the branch develop
  • A new plugin (analyzer, connector, visualizer, playbook, pivot or ingestor) was added or changed, in which case:
    • I strictly followed the documentation "How to create a Plugin"
    • Usage file was updated. A link to the PR to the docs repo has been added as a comment here.
    • Advanced-Usage was updated (in case the plugin provides additional optional configuration). A link to the PR to the docs repo has been added as a comment here.
    • I have dumped the configuration from Django Admin using the dumpplugin command and added it in the project as a data migration. ("How to share a plugin with the community")
    • If a File analyzer was added and it supports a mimetype which is not already supported, you added a sample of that type inside the archive test_files.zip and you added the default tests for that mimetype in test_classes.py.
    • If you created a new analyzer and it is free (does not require any API key), please add it in the FREE_TO_USE_ANALYZERS playbook by following this guide.
    • Check if it could make sense to add that analyzer/connector to other freely available playbooks.
    • I have provided the resulting raw JSON of a finished analysis and a screenshot of the results.
    • If the plugin interacts with an external service, I have created an attribute called precisely url that contains this information. This is required for Health Checks.
    • If the plugin requires mocked testing, _monkeypatch() was used in its class to apply the necessary decorators.
    • I have added that raw JSON sample to the MockUpResponse of the _monkeypatch() method. This serves us to provide a valid sample for testing.
  • I have inserted the copyright banner at the start of the file: # This file is a part of IntelOwl https://github.com/intelowlproject/IntelOwl # See the file 'LICENSE' for copying permission.
  • If external libraries/packages with restrictive licenses were used, they were added in the Legal Notice section.
  • Linters (Black, Flake, Isort) gave 0 errors. If you have correctly installed pre-commit, it does these checks and adjustments on your behalf.
  • I have added tests for the feature/bug I solved (see tests folder). All the tests (new and old ones) gave 0 errors.
  • If the GUI has been modified:
    • I have a provided a screenshot of the result in the PR.
    • I have created new frontend tests for the new component or updated existing ones.
  • [ x] After you had submitted the PR, if DeepSource, Django Doctors or other third-party linters have triggered any alerts during the CI checks, I have solved those alerts.

Important Rules

  • If you miss to compile the Checklist properly, your PR won't be reviewed by the maintainers.
  • Everytime you make changes to the PR and you think the work is done, you should explicitly ask for a review by using GitHub's reviewing system detailed here.

pranjalg1331 and others added 11 commits February 24, 2025 19:19
Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
@pranjalg1331
Copy link
Contributor Author

pranjalg1331 commented Feb 27, 2025

I have integrated CICDTookbox/shellcheck . It performs static code analysis on shell scripts using ShellCheck. It also includes customizations of include_files, exclude files, and a summary of report in the end.
image

@pranjalg1331 pranjalg1331 marked this pull request as ready for review February 27, 2025 06:12
@fgibertoni
Copy link
Contributor

Nice! Any particular reason on why you didn't choose the linter that you mentioned in the Medium article ?
Also, we can try adding it to pre-commit: https://github.com/koalaman/shellcheck?tab=readme-ov-file#pre-commit

@pranjalg1331
Copy link
Contributor Author

Reason for using CICDTookbox/shellcheck: The one by CICDToolbox had all the customizations like the one in the medium article and more like reports.

I had concerns regarding adding it to pre-commit - Would it be wise to put so many restrictions on commits since it can slow down the development?

@fgibertoni
Copy link
Contributor

I was thinking about pre-commit hook because I thought it would have been easier that push the code, wait for CI to run to get errors, fix them and push again. But if it takes more than 10 seconds like in CI it would consistently slow down development as you said. Can you do some test on how much time it takes to run in pre-commit please ?

pranjalg1331 and others added 5 commits March 4, 2025 11:28
Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
Signed-off-by: pranjalg1331 <pranjaloff13@gmail.com>
@pranjalg1331
Copy link
Contributor Author

image
I have added the pre-commit hook for shellcheck.

@fgibertoni
Copy link
Contributor

Looks really good! How much does it take for it to run ? Also, it is run only when detects changes to script files ?

@pranjalg1331
Copy link
Contributor Author

pranjalg1331 commented Mar 4, 2025

How long does it take to run?

It takes some time on the first run. After that, the execution time is minimal and depends on the size of the scripts.

Does it only run when changes are detected in script files?

It runs only if the modified files include a script; otherwise, it is skipped.
image

Copy link
Contributor

@fgibertoni fgibertoni left a comment

Choose a reason for hiding this comment

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

When these are fixed I will test also other script, thank you

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

@fgibertoni fgibertoni left a comment

Choose a reason for hiding this comment

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

Just a couple minor things and we can merge, thanks!

pranjalg1331 and others added 3 commits March 14, 2025 18:20
Co-authored-by: Federico Gibertoni <152909479+fgibertoni@users.noreply.github.com>
Co-authored-by: Federico Gibertoni <152909479+fgibertoni@users.noreply.github.com>
Co-authored-by: Federico Gibertoni <152909479+fgibertoni@users.noreply.github.com>
@fgibertoni fgibertoni merged commit c59b8dd into intelowlproject:develop Mar 14, 2025
10 checks passed
@fgibertoni
Copy link
Contributor

Nice work! Thanks 😄

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.

2 participants