consume csgrep changes to support a new option: limit-msg-len (OSH-67)

[lbossis]

First cut

[kdudka]

@lbossis Thanks! I have not tried it myself but the code change looks good. Some minor remarks:

• The option needs to start with the gitleaks prefix because it is specific the the gitleaks plug-in: --gitleaks-limit-msg-len
• I would use a higher default value (say 512) for the new option.
• The commit summary should describe the changes from csmock perspective, something like:

gitleaks: implement --gitleaks-limit-msg-len defaulting to 512

Implementation details can go to commit description in needed.

• We need to make csmock-plugin-gitleaks depend on the updated version of csdiff:

--- a/make-srpm.sh
+++ b/make-srpm.sh
@@ -175,6 +175,7 @@ This package contains the divine plug-in for csmock.
 %package -n csmock-plugin-gitleaks
 Summary: experimental csmock plug-in
 Requires: csmock-common
+Requires: csdiff > 3.0.3

 %description -n csmock-plugin-gitleaks
 This package contains the gitleaks plug-in for csmock.

Without the dependency, the scans would fail on the missing csgrep option if someone forgot to update the csdiff package.

[lbossis]

Removed prefix gitleaks- from FILTER_CMD which calls csgrep. Looks like it works! I executed the following command
csmock -t cppcheck,clang,gitleaks --gitleaks-limit-msg-len=24 nss-util-3.90.0-1.el7_9.src.rpm
the tail of output is found at http://pastebin.test.redhat.com/1106663
Please, do your testing and let's merge this branch limit-amount-of-results-produced-by-single-scan--OSH-67 to main.

[kdudka]

@lbossis Thanks for the update! Now you need to squash all the fix-up commits and rewrite the commit message as described in #114 (comment). This way we end up with a clean git history where each snapshot can be built and tested. This is crucial for using git bisect later on.

[kdudka]

This is in fact a dependency of csmock-plugin-gitleaks but bumping the csmock-common requirement should be harmless, too.

[lbossis]

Hi Lukas, Currently this piece of code looks like: GITLEAKS_LOG = "/builddir/gitleaks-capture.log" FILTER_CMD = "csgrep '%s' --mode=json --warning-rate-limit=%i --limit-msg-len=%i > '%s'" class PluginProps: ... Do we need *two empty lines* between FILTER_CMD and class PluginsProps? Thanks, Leo

…

On Tue, Aug 15, 2023 at 12:55 PM Lukáš Zaoral ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In py/plugins/gitleaks.py <#114 (comment)>: > @@ -34,8 +34,7 @@ GITLEAKS_LOG = "/builddir/gitleaks-capture.log" -FILTER_CMD = "csgrep '%s' --mode=json --warning-rate-limit=%i > '%s'" - Please, don't delete this empty line. — Reply to this email directly, view it on GitHub <#114 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ASCNA7MLNK7CLZETWBDYIH3XVOSY3ANCNFSM6AAAAAA2ZNAYYE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[lzaoral]

Thanks for the question, @lbossis! Yes, we need two empty lines to stay conformant to the official Python Style Guide (PEP8). The section about blank lines explicitly says:

Blank Lines
Surround top-level function and class definitions with two blank lines.
...

which is exactly our case!

edit: typos

[kdudka]

@lbossis Thanks for the update! Could you please update the commit message summary as requested at #114 (comment) ?

The gitleaks: prefix is crucial here because the changes are specific to a single plug-in of csmock.

[kdudka]

@lbossis Thanks for the update! Unfortunately the commit message needs to be reformatted like this:

gitleaks: implement --gitleaks-limit-msg-len defaulting to 512

This package contains an extension of gitleaks plug-in to support a new
command line option for controlling event message length from csmock.
csmock-plugin-gitleaks is dependent on the updated version of csdiff

Fixes: https://github.com/csutils/csdiff/issues/114
Related: https://issues.redhat.com/browse/OSH-67

The git commit summary is the first line of the commit message, delimited by a blank line from the description. The commit message summary has a special semantics in git. See the git-commit(1) man page:

Though not required, it’s a good idea to begin the commit message with a single short (less than 50 character) line summarizing the change, followed by a blank line and then a more thorough description. The text up to the first blank line in a commit message is treated as the commit title, and that title is used throughout Git. For example, git-format-patch(1) turns a commit into email, and it uses the title on the Subject line and the rest of the commit in the body.

You can easily update the commit message with: git commit --amend && git push --force

[lbossis]

Commit message has been updated according to the recommended format.

…

On Thu, Aug 17, 2023 at 7:51 AM Kamil Dudka ***@***.***> wrote: @lbossis <https://github.com/lbossis> Thanks for the update! Unfortunately the commit message needs to be reformatted like this: gitleaks: implement --gitleaks-limit-msg-len defaulting to 512 This package contains an extension of gitleaks plug-in to support a new command line option for controlling event message length from csmock. csmock-plugin-gitleaks is dependent on the updated version of csdiff Fixes: csutils/csdiff#114 Related: https://issues.redhat.com/browse/OSH-67 The git commit summary is the first line of the commit message, delimited by a blank line from the description. The commit message summary has a special semantics in git. See the git-commit(1) man page: Though not required, it’s a good idea to begin the commit message with a single short (less than 50 character) line summarizing the change, followed by a blank line and then a more thorough description. The text up to the first blank line in a commit message is treated as the commit title, and that title is used throughout Git. For example, git-format-patch(1) turns a commit into email, and it uses the title on the Subject line and the rest of the commit in the body. You can easily update the commit message with: git commit --amend && git push --force — Reply to this email directly, view it on GitHub <#114 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ASCNA7KIBSRAOD5CZPGAPQLXVYAS3ANCNFSM6AAAAAA2ZNAYYE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[kdudka]

The original commit message referenced an unrelated csdiff issue by mistake (csutils/csdiff#114) so I have fixed it to make it reference this pull request instead. Merging...