Prevents the use of actions/setup-java@v1 and adopt /adopt-hotspot (openjdk) distributions. #82

jmj0502 · 2022-09-29T14:10:35Z

Solves #26

Adds the prevent-action-setup-java-v1 rule. It prevents the use of the action setup-java@v1, since it doesn't allow uses to specify the distribution they'll use.
Adds the prevent-adopt-distributions-on-setup-java rule. It prevents the use of adopt/adopt-hotspot distributions since such distributions won't be supported anymore.

…on/setup-java@v1 since it doesn't support eclipse temurin distributions.

…opt-hotspot distributions on the actions/setup-java@v2+, since such distributions won't be supported anymore.

jmj0502 · 2022-09-29T14:13:40Z

@OriYosef Is there a way to test the new rules? The contribution section doesn't contain info on how to perform tests on rules.

pkg/rulesConfig/defaultRules/github/12-prevent-action-setup-java-v1.json

OriYosef · 2022-09-30T07:00:22Z

pkg/rulesConfig/defaultRules/gitlab/12-prevent-action-setup-java-v1.json

@@ -0,0 +1,7 @@
+{
+	"description": "Prevent use of action/setup-java@v1.",
+	"failureMessage": "action/setup-java@v1 is used on the workflow.",


Please change the failureMessage here as well

pkg/rulesConfig/defaultRules/gitlab/13-prevent-adopt-distributions-on-setup-java.json

pkg/rulesConfig/defaultRules/github/13-prevent-adopt-distributions-on-setup-java.json

OriYosef · 2022-09-30T07:17:29Z

Hey @jmj0502 . Thank you again for your contribution!
I have left some comments on your rules.
About testing methods for new rules, this is definitely needed. Please see the opened issue about it.
Currently, you can use a Json Schema Validator platform. Add only your schema content against data-schema-example.json. For testing different scenarios edit the content of the data-schema-example and make sure the rule is correct.

dolby360 · 2022-09-30T12:24:32Z

@OriYosef Is there a way to test the new rules? The contribution section doesn't contain info on how to perform tests on rules.

I'm working on it 😬

jmj0502 · 2022-09-30T12:56:14Z

@OriYosef Excellent! I'll be working on the changes. Ok, no problem. I'll use the JSON schema validator as you said! Glad somebody is working on the testing feature c: that will help a lot in the future!

…ng if the action/setup-java@v2+ is used before checking for the use of adopt/adopt-hotspot distributions.

jmj0502 · 2022-10-01T14:31:16Z

@OriYosef I've already made changes. Now the failureMessage of both rules provide more context about the error and how to solve it and the prevent-adopt-distributions rule now checks if actions/setup-java@v2+ is being used.

When you have some time, would you please take a look at the if condition? I still have some doubts when it comes to its use, and I would like to know if I need to make changes on that part of the rule.

OriYosef · 2022-10-02T16:51:47Z

pkg/rulesConfig/defaultRules/github/12-prevent-action-setup-java-v1.json

+	"description": "Prevent use of action/setup-java@v1.",
+	"failureMessage": "action/setup-java@v1 is used on the workflow. action/setup-java@v1 uses a java distribution that is out of support (AdoptOpenJDK) by default, please use action/setup-java@v2+ and avoid the use of adopt/adopt-host distributions.",
+	"uniqueId": 12,
+	"enableByDefault": true,


typo:
enabledByDefault

please fix in all files

OriYosef · 2022-10-02T17:08:31Z

pkg/rulesConfig/defaultRules/github/13-prevent-adopt-distributions-on-setup-java.json

+																	},
+																	"then": {
+																		"properties": {
+																			"uses": {


The format of the if condition looks good. The only thing is that the distribution key is given in the with section. please see this example.

Okok! I'll work on the change. Should I access the contents of with using properties or additionalProperties?

checkout this example.

OriYosef · 2022-10-02T17:11:11Z

@jmj0502
The failureMessage looks great!
I have tested your rules and we need to make very small changes. I think we are almost done here... Kudos!

… reference to the distribution property on the rule allero-io#13.

jmj0502 · 2022-10-02T21:16:11Z

@OriYosef I already worked on the review comments! When it comes to the with clause, I supposed it would look like this:

Is that alright? I'm up to make any change if needed 👍

OriYosef · 2022-10-03T12:27:12Z

Yes, You can see the link I sent before.

jmj0502 · 2022-10-03T13:03:36Z

@OriYosef Cool! I reviewed the content of the link, but I wasn't sure if the with clause will translate to JSON structure similar to the one on the screen cap. I think we're done, then 🥳

Thanks for all the guidance! Definitely looking forward to keeping on making contributions.

OriYosef · 2022-10-03T20:19:12Z

@jmj0502
Yes indeed. The json file that represents the pipelines keeps the same structure.
All looks good now. I think we are done here.
Thank you for your contribution!

jmj0502 added 2 commits September 29, 2022 09:17

Improvements: Adding a new default rule that prevents the use of acti…

0445d1f

…on/setup-java@v1 since it doesn't support eclipse temurin distributions.

Improvements: Adding an additional rule to prevent the use of adop/ad…

8341780

…opt-hotspot distributions on the actions/setup-java@v2+, since such distributions won't be supported anymore.

OriYosef reviewed Sep 30, 2022

View reviewed changes

Improvements: Adding a better error message for the new rules. Checki…

47f7090

…ng if the action/setup-java@v2+ is used before checking for the use of adopt/adopt-hotspot distributions.

dimabru assigned OriYosef Oct 2, 2022

OriYosef reviewed Oct 2, 2022

View reviewed changes

Improvements: Fixing typo on the 'enabledByDefault' field. Fixing the…

1bcd978

… reference to the distribution property on the rule allero-io#13.

jmj0502 marked this pull request as ready for review October 3, 2022 13:03

OriYosef approved these changes Oct 3, 2022

View reviewed changes

idanshahar merged commit 5f43bff into allero-io:main Oct 4, 2022

dimabru mentioned this pull request Oct 6, 2022

Prevent using actions/setup-java@v3 with adopt distribution #26

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prevents the use of actions/setup-java@v1 and adopt /adopt-hotspot (openjdk) distributions. #82

Prevents the use of actions/setup-java@v1 and adopt /adopt-hotspot (openjdk) distributions. #82

jmj0502 commented Sep 29, 2022

jmj0502 commented Sep 29, 2022

OriYosef Sep 30, 2022

OriYosef commented Sep 30, 2022 •

edited

Loading

dolby360 commented Sep 30, 2022

jmj0502 commented Sep 30, 2022

jmj0502 commented Oct 1, 2022 •

edited

Loading

OriYosef Oct 2, 2022

jmj0502 Oct 2, 2022

OriYosef Oct 2, 2022

jmj0502 Oct 2, 2022

OriYosef Oct 3, 2022

OriYosef commented Oct 2, 2022 •

edited

Loading

jmj0502 commented Oct 2, 2022

OriYosef commented Oct 3, 2022

jmj0502 commented Oct 3, 2022

OriYosef commented Oct 3, 2022

Prevents the use of actions/setup-java@v1 and adopt /adopt-hotspot (openjdk) distributions. #82

Prevents the use of actions/setup-java@v1 and adopt /adopt-hotspot (openjdk) distributions. #82

Conversation

jmj0502 commented Sep 29, 2022

Solves #26

jmj0502 commented Sep 29, 2022

OriYosef Sep 30, 2022

Choose a reason for hiding this comment

OriYosef commented Sep 30, 2022 • edited Loading

dolby360 commented Sep 30, 2022

jmj0502 commented Sep 30, 2022

jmj0502 commented Oct 1, 2022 • edited Loading

OriYosef Oct 2, 2022

Choose a reason for hiding this comment

jmj0502 Oct 2, 2022

Choose a reason for hiding this comment

OriYosef Oct 2, 2022

Choose a reason for hiding this comment

jmj0502 Oct 2, 2022

Choose a reason for hiding this comment

OriYosef Oct 3, 2022

Choose a reason for hiding this comment

OriYosef commented Oct 2, 2022 • edited Loading

jmj0502 commented Oct 2, 2022

OriYosef commented Oct 3, 2022

jmj0502 commented Oct 3, 2022

OriYosef commented Oct 3, 2022

OriYosef commented Sep 30, 2022 •

edited

Loading

jmj0502 commented Oct 1, 2022 •

edited

Loading

OriYosef commented Oct 2, 2022 •

edited

Loading