Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Filter IRC log messages, removing strings to ignore #268

Merged
merged 24 commits into from
Apr 4, 2022
Merged

Filter IRC log messages, removing strings to ignore #268

merged 24 commits into from
Apr 4, 2022

Conversation

gudmdharalds
Copy link
Contributor

@gudmdharalds gudmdharalds commented Apr 4, 2022 •
edited
Loading

Filter IRC log messages before submitting to IRC API, remove any strings that should not be logged to the API. Uses constants to indicate which sections should be removed.

TODO:

  • Add constants to defines.php (VIPGOCI_IRC_IGNORE_STRING_START, VIPGOCI_IRC_IGNORE_STRING_END).
  • Apply constants to vipgoci_report_create_scan_details() and to informational message in main.php.
  • Filter IRC log messages before submitting to IRC API.
  • Clean strings before submitting to GitHub API, removing the constants if found.
  • Add/update tests:
    • for function to filter IRC log messages.
    • for function to clean messages before submitting to GitHub API.
    • for informational-messages processing in main.php
  • Update README
  • Changelog entry [ Changelog for version 1.2.3 #262 ]
  • Check automated unit-tests

@gudmdharalds
Adding define for ignoring IRC log messages.
5b8bf55
@gudmdharalds
Apply IRC ignore define.
0c39209
@gudmdharalds
Add IRC ignore indicators to --informational-msg if not empty; update…
0ba51fb 
… test.
@gudmdharalds
Remove IRC constants from postfields body before submitting
9afda66
@gudmdharalds
Ensure to remove IRC ignore constants before submitting to GitHub API.
5c9fe0d
@gudmdharalds
Add functions to manage IRC ignore strings.
ea29b18
@gudmdharalds
Move PHP_EOL into defines for clarity.
613131f
@gudmdharalds
Clarify comment.
172a8f7
@gudmdharalds
Start with a new string instead of concaternating.
c34d878
@gudmdharalds
Add indication for test-class OtherWebServicesIrcApiFilterIgnorableSt…
52a51f6 
…ringsTest
@gudmdharalds
Better detection of invalid usage of IRC ignore constants.
ff05666
@gudmdharalds
Adding test for vipgoci_irc_api_filter_ignorable_strings()
15793e4
@gudmdharalds
Adding test for vipgoci_irc_api_clean_ignorable_constants()
1494bcc
@gudmdharalds
Update test to match function.
4a23b94
@gudmdharalds gudmdharalds added this to the 1.2.3 milestone Apr 4, 2022
@gudmdharalds gudmdharalds self-assigned this Apr 4, 2022
@gudmdharalds gudmdharalds changed the title Filter IRC log messages Filter IRC log messages, removing strings to ignore Apr 4, 2022
wpcomvip-vipgoci-bot
wpcomvip-vipgoci-bot previously requested changes Apr 4, 2022
View reviewed changes
Copy link
Collaborator

@wpcomvip-vipgoci-bot wpcomvip-vipgoci-bot left a comment

Choose a reason for hiding this comment

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

phpcs scanning turned up:

🚫 1 error

This bot provides automated PHP linting and PHPCS scanning. For more information about the bot and available customizations, see our documentation.

Scan run detail

Software versions

  • vip-go-ci version: 1.2.2
  • PHP runtime version for vip-go-ci: 8.1.4
  • PHP runtime for linting:
    • PHP 8.1: 8.1.4
  • PHP runtime version for PHPCS: 7.4.28
  • PHPCS version: 3.6.2
  • PHP runtime version for SVG scanner: 7.4.28

Options file (.vipgoci_options)

Options file enabled: true

Configurable options:

  • skip-execution
  • skip-draft-prs
  • lint-modified-files-only
  • phpcs
  • phpcs-severity
  • phpcs-sniffs-include
  • phpcs-sniffs-exclude
  • report-no-issues-found
  • review-comments-sort
  • review-comments-include-severity
  • post-generic-pr-support-comments
  • review-comments-sort
  • scan-details-msg-include
  • svg-checks
  • autoapprove
  • autoapprove-php-nonfunctional-changes
  • hashes-api

Options altered:

  • phpcs-severityset to1
  • phpcs-sniffs-includeset toGeneric.PHP.DisallowShortOpenTag, Squiz.PHP.CommentedOutCode
  • phpcs-sniffs-excludeset toWordPress.Security.EscapeOutput, WordPress.PHP.DevelopmentFunctions, WordPress.WP.AlternativeFunctions, WordPress.PHP.DiscouragedPHPFunctions, WordPress.Files.FileName, Squiz.Commenting.FileComment, Generic.PHP.Syntax
  • skip-draft-prsset to

PHP lint options

PHP lint files enabled: true

Lint modified files only: true

Directories not PHP linted:

  • None

SVG configuration

SVG scanning enabled: true

Auto-approval configuration

Auto-approvals enabled: true

Non-functional changes auto-approved: true

Auto-approval DB enabled: true

Auto-approved file-types:

  • css
  • csv
  • eot
  • gif
  • gz
  • ico
  • ini
  • jpeg
  • jpg
  • json
  • less
  • map
  • md
  • mdown
  • mo
  • mp4
  • otf
  • pcss
  • pdf
  • po
  • pot
  • png
  • sass
  • scss
  • styl
  • ttf
  • txt
  • woff
  • woff2
  • yml

PHPCS configuration

PHPCS scanning enabled: true

PHPCS severity level: 1

Standard(s) used:

  • PHPCompatibility
  • PHPCompatibilityParagonieRandomCompat
  • PHPCompatibilityParagonieSodiumCompat
  • VariableAnalysis
  • WordPress

Runtime set:

  • testVersion 8.1-

Custom sniffs included:

  • Generic.PHP.DisallowShortOpenTag
  • Squiz.PHP.CommentedOutCode

Custom sniffs excluded:

  • WordPress.Security.EscapeOutput
  • WordPress.PHP.DevelopmentFunctions
  • WordPress.WP.AlternativeFunctions
  • WordPress.PHP.DiscouragedPHPFunctions
  • WordPress.Files.FileName
  • Squiz.Commenting.FileComment
  • Generic.PHP.Syntax

Directories not PHPCS scanned:

  • tests/unit

tests/integration/MainRunInitOptionsReviewsTest.php Outdated
'dismissed-reviews-repost-comments' => false,
'informational-msg' => PHP_EOL . VIPGOCI_IRC_IGNORE_STRING_START . PHP_EOL. 'message-string-123' . PHP_EOL . VIPGOCI_IRC_IGNORE_STRING_END . PHP_EOL,
Copy link
Collaborator

Choose a reason for hiding this comment

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

🚫 Error( severity 5 ): Concat operator must be surrounded by a single space (Squiz.Strings.ConcatenationSpacing.PaddingFound).

@wpcomvip-vipgoci-bot wpcomvip-vipgoci-bot dismissed their stale review April 4, 2022 15:32

Dismissing review as all inline comments are obsolete by now

@wpcomvip-vipgoci-bot
Copy link
Collaborator

Scanning latest commit did not yield any new issues. Please have a look at older feedback still existing (commit-ID: fde43e4)

This bot provides automated PHP linting and PHPCS scanning. For more information about the bot and available customizations, see our documentation.

Scan run detail

Software versions

  • vip-go-ci version: 1.2.2
  • PHP runtime version for vip-go-ci: 8.1.4
  • PHP runtime for linting:
    • PHP 8.1: 8.1.4
  • PHP runtime version for PHPCS: 7.4.28
  • PHPCS version: 3.6.2
  • PHP runtime version for SVG scanner: 7.4.28

Options file (.vipgoci_options)

Options file enabled: true

Configurable options:

  • skip-execution
  • skip-draft-prs
  • lint-modified-files-only
  • phpcs
  • phpcs-severity
  • phpcs-sniffs-include
  • phpcs-sniffs-exclude
  • report-no-issues-found
  • review-comments-sort
  • review-comments-include-severity
  • post-generic-pr-support-comments
  • review-comments-sort
  • scan-details-msg-include
  • svg-checks
  • autoapprove
  • autoapprove-php-nonfunctional-changes
  • hashes-api

Options altered:

  • phpcs-severityset to1
  • phpcs-sniffs-includeset toGeneric.PHP.DisallowShortOpenTag, Squiz.PHP.CommentedOutCode
  • phpcs-sniffs-excludeset toWordPress.Security.EscapeOutput, WordPress.PHP.DevelopmentFunctions, WordPress.WP.AlternativeFunctions, WordPress.PHP.DiscouragedPHPFunctions, WordPress.Files.FileName, Squiz.Commenting.FileComment, Generic.PHP.Syntax
  • skip-draft-prsset to

PHP lint options

PHP lint files enabled: true

Lint modified files only: true

Directories not PHP linted:

  • None

SVG configuration

SVG scanning enabled: true

Auto-approval configuration

Auto-approvals enabled: true

Non-functional changes auto-approved: true

Auto-approval DB enabled: true

Auto-approved file-types:

  • css
  • csv
  • eot
  • gif
  • gz
  • ico
  • ini
  • jpeg
  • jpg
  • json
  • less
  • map
  • md
  • mdown
  • mo
  • mp4
  • otf
  • pcss
  • pdf
  • po
  • pot
  • png
  • sass
  • scss
  • styl
  • ttf
  • txt
  • woff
  • woff2
  • yml

PHPCS configuration

PHPCS scanning enabled: true

PHPCS severity level: 1

Standard(s) used:

  • PHPCompatibility
  • PHPCompatibilityParagonieRandomCompat
  • PHPCompatibilityParagonieSodiumCompat
  • VariableAnalysis
  • WordPress

Runtime set:

  • testVersion 8.1-

Custom sniffs included:

  • Generic.PHP.DisallowShortOpenTag
  • Squiz.PHP.CommentedOutCode

Custom sniffs excluded:

  • WordPress.Security.EscapeOutput
  • WordPress.PHP.DevelopmentFunctions
  • WordPress.WP.AlternativeFunctions
  • WordPress.PHP.DiscouragedPHPFunctions
  • WordPress.Files.FileName
  • Squiz.Commenting.FileComment
  • Generic.PHP.Syntax

Directories not PHPCS scanned:

  • tests/unit

@gudmdharalds gudmdharalds merged commit 83535a9 into main Apr 4, 2022
@gudmdharalds gudmdharalds deleted the add-irc-log-filtering branch April 4, 2022 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wpcomvip-vipgoci-bot wpcomvip-vipgoci-bot wpcomvip-vipgoci-bot left review comments

Assignees

@gudmdharalds gudmdharalds

Labels
[Pri] Normal [Type] Enhancement
Projects
None yet
Milestone
1.2.3
Development

Successfully merging this pull request may close these issues.
2 participants
@gudmdharalds @wpcomvip-vipgoci-bot