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

feat: enable lj-releng tool to lint lua code. #5672

Merged
merged 1 commit into from
Jun 9, 2020
Merged

feat: enable lj-releng tool to lint lua code. #5672

merged 1 commit into from
Jun 9, 2020

Conversation

agile6v
Copy link
Contributor

@agile6v agile6v commented Jun 6, 2020

What this PR does / why we need it:

see #5577

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Which issue/s this PR fixes

fixes #5577

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 6, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @agile6v. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 6, 2020
@aledbf
Copy link
Member

aledbf commented Jun 6, 2020

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 6, 2020
@aledbf
Copy link
Member

aledbf commented Jun 6, 2020

/assign @ElvinEfendi

ElvinEfendi
ElvinEfendi reviewed Jun 8, 2020
View reviewed changes
rootfs/etc/nginx/lua/balancer.lua
sync_backend = sync_backend,
route_to_alternative_balancer = route_to_alternative_balancer,
get_balancer = get_balancer,
}})
Copy link
Member

Choose a reason for hiding this comment

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

These are meant to be exported only for testing though. An ideal solution would be to refactor the code and tests so that we do not have to test private functions.

ElvinEfendi
ElvinEfendi reviewed Jun 8, 2020
View reviewed changes
rootfs/etc/nginx/lua/balancer/chashsubset.lua
local tostring = tostring
local math = math
local table = table
local pairs = pairs
Copy link
Member

Choose a reason for hiding this comment

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

I know that localizing globals are more performant with Lua interpreter, but does it really make any difference with Luajit? Luajit seems to optimize that automatically. Do you have any benchmark for this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll test it ASAP.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @ElvinEfendi I did the test. The performance difference can be ingored. But it is recommended to use local variable to avoid race conditions. WDYT?

Copy link
Member

Choose a reason for hiding this comment

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

Thanks for testing. Yeah, that sounds good!

ElvinEfendi
ElvinEfendi reviewed Jun 8, 2020
View reviewed changes
hack/verify-lualint.sh
@@ -19,3 +19,5 @@ set -o nounset
set -o pipefail

luacheck --codes -q rootfs/etc/nginx/lua/

find rootfs/etc/nginx/lua/ -name "*.lua" -not -path "*/test/*" -exec lj-releng -L -s {} + && echo "lj-releng validation is success!"
Copy link
Member

Choose a reason for hiding this comment

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

Does this also enforce a constraint on the line length?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ElvinEfendi How about using the luacheck tool for restrictions? Limited to 100 characters.

Copy link
Member

Choose a reason for hiding this comment

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

thanks 👍

@ElvinEfendi
Copy link
Member

@agile6v this is amazing 👏 I have been thinking of doing this for a long time.

@aledbf
Copy link
Member

aledbf commented Jun 9, 2020

/retest

@ElvinEfendi
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 9, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: agile6v, ElvinEfendi

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 9, 2020
@aledbf
Copy link
Member

aledbf commented Jun 9, 2020

/retest

1 similar comment
@aledbf
Copy link
Member

aledbf commented Jun 9, 2020

/retest

@aledbf
Copy link
Member

aledbf commented Jun 9, 2020

/test pull-ingress-nginx-e2e-1-16

@aledbf
Copy link
Member

aledbf commented Jun 9, 2020

/retest

1 similar comment
@aledbf
Copy link
Member

aledbf commented Jun 9, 2020

/retest

@k8s-ci-robot k8s-ci-robot merged commit 0549d9b into kubernetes:master Jun 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ElvinEfendi ElvinEfendi ElvinEfendi left review comments

@cmluciano cmluciano Awaiting requested review from cmluciano

Assignees

@ElvinEfendi ElvinEfendi

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Introduce lj-releng tool to check the Lua code.
4 participants
@agile6v @k8s-ci-robot @aledbf @ElvinEfendi