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

Break vipgoci_run() into multiple functions #207

Merged
merged 222 commits into from
Feb 9, 2022
Merged

Break vipgoci_run() into multiple functions #207

merged 222 commits into from
Feb 9, 2022

Conversation

gudmdharalds
Copy link
Contributor

@gudmdharalds gudmdharalds commented Sep 7, 2021 •
edited
Loading

The vipgoci_run() function is getting long and difficult to understand. It needs to be broken into multiple functions.

This pull request will move the various configuration of options, sanity checking and eventual scanning performed in vipgoci_run() into multiple functions. Each newly created function will have specific focus; for example, PHP Linting functionality will be configured and run from two different functions.

This has already been done in the vip-go-compatibility-scanner project, see here -- a similar solution is being implemented here.

This resolves #192.

TODO:

  • Break vipgoci_run() into multiple functions grouped by functionality.
  • Use declare(strict_types=1); for vip-go-ci.php, main.php, latest-release.php, github-commit-status.php [ Define variable types, declare strict types, WordPress coding standard #157 ]
  • Add unit-tests as needed
  • Add or update PHPDoc comments for new or updated functions (main code only).
  • Ensure all variables have types defined (added or changed code only)
  • Changelog entry [ Changelog for version 1.2.0 #243 ]
  • Check automated unit-tests
  • Consistent test names
  • Test major components manually (PHP linting, PHPCS).
  • Verify that results is filtered and posted.
  • Verify that options are parsed and used.
  • Manual testing
    • Pull request with PHP linting issues
    • Pull request with PHPCS issues
    • Pull request without PHPCS issues, not auto-approved
    • Pull request without PHPCS issues, is auto-approved
    • Pull request with SVG issues
    • Pull request with large file to be skipped

@gudmdharalds gudmdharalds self-assigned this Sep 7, 2021
@gudmdharalds gudmdharalds marked this pull request as draft September 7, 2021 16:58
@gudmdharalds
Comment on PHP 8.0
d8f678b
@gudmdharalds
Updating PHP 8
f9c7e96
@gudmdharalds
Fixing whitespacing.
ea64ede
@gudmdharalds
New exit code (220) and updated --max-exec-time docs.
94b880c
@gudmdharalds
New exit code (220) and minimum PHP version defined.
f55617a
@gudmdharalds
Breaking vipgoci_run() into multiple functions.
d8f84af
@gudmdharalds
Updated auto-approvals after restructure.
7cf2989
@gudmdharalds
Move functionality to auto-approval.php
5449700
@gudmdharalds
Updating PHPDoc
72502b5
@gudmdharalds
Whitespacing
0e3cb77
@gudmdharalds
PHPDoc update, defining variable types.
0e97ce6
@gudmdharalds
Adding 'lint' option.
e0047e0
@gudmdharalds
Adding 'phpcs' option.
6f4f7ca
@gudmdharalds
Adding 'phpcs' option.
2f6f490
@gudmdharalds
Removing @codeCoverageIgnore for two functions
1a0799f
@gudmdharalds
Unit test for vipgoci_help_print()
4673acc
@gudmdharalds
Unit test for vipgoci_options_recognized()
dea9e1a
@gudmdharalds
Unit test for vipgoci_run_cleanup_phpcs()
e46c671
@gudmdharalds
Unit test for vipgoci_run_env_options_handle()
e1bd744
@gudmdharalds
Unit test for vipgoci_run_init_options_max_exec_time()
735c162
@gudmdharalds
Unit test for vipgoci_run_init_options_phpcs()
65498f0
@gudmdharalds
Set --phpcs to false by default, remove whitespace.
39591d3
@gudmdharalds
Add vipgoci_unittests_options_test()
a7491ce
@gudmdharalds
Adding @codeCoverageIgnore for vipgoci_run_init_options_autoapprove()
2bea0a0
@gudmdharalds
@codeCoverageIgnore in a few places, rewrote vipgoci_run_init_options…
d38de9d 
…_repo_options()
wpcomvip-vipgoci-bot
wpcomvip-vipgoci-bot reviewed Feb 8, 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 warning

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

main.php Show resolved Hide resolved
wpcomvip-vipgoci-bot
wpcomvip-vipgoci-bot previously requested changes Feb 8, 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.

results.php Outdated Show resolved Hide resolved
wpcomvip-vipgoci-bot
wpcomvip-vipgoci-bot previously requested changes Feb 8, 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.

tests/integration/Skeleton.php Show resolved Hide resolved
@wpcomvip-vipgoci-bot wpcomvip-vipgoci-bot dismissed their stale review February 8, 2022 21:41

Dismissing review as all inline comments are obsolete by now

wpcomvip-vipgoci-bot
wpcomvip-vipgoci-bot reviewed Feb 9, 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 warning

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

tests/integration/PhpcsScanPossiblyUseNewStandardFileTest.php Outdated Show resolved Hide resolved
wpcomvip-vipgoci-bot
wpcomvip-vipgoci-bot requested changes Feb 9, 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

⚠️ 1 warning

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

github-api.php Show resolved Hide resolved
github-api.php Show resolved Hide resolved
@gudmdharalds gudmdharalds merged commit ae597e0 into main Feb 9, 2022
@gudmdharalds gudmdharalds deleted the update-main-run-multiple-functions branch February 9, 2022 00:50
This was referenced Feb 14, 2022
Closed
Closed
@gudmdharalds gudmdharalds mentioned this pull request Jun 13, 2022
Open
54 tasks
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 requested changes

Assignees

@gudmdharalds gudmdharalds

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

Successfully merging this pull request may close these issues.

Break vipgoci_run() into multiple functions
2 participants
@gudmdharalds @wpcomvip-vipgoci-bot