Hosting request for CloudAEye Plugin

[bhavyalatha26]

Repository URL

https://github.com/CloudAEye/cloudaeye-plugin

New Repository Name

cloudaeye-plugin

Description

The CloudAEye Plugin is designed to enhance CI/CD pipelines by seamlessly exporting job details and build logs from Jenkins to the CloudAEye platform. CloudAEye analyzes test failure logs to identify root causes and suggests actionable code fixes, helping developers resolve issues more efficiently. By providing real-time insights into build failures, the plugin enables faster troubleshooting and minimizes downtime in software delivery pipelines.

Key Features:

• Exports detailed logs and job metadata for comprehensive analysis.
• Automates root cause analysis and propose fix suggestions for test failures.
• Integrates effortlessly into existing Jenkins pipelines.

GitHub users to have commit permission

@bhavyalatha26

Jenkins project users to have release permission

cloudaeye

Issue tracker

GitHub issues

[jenkins-cert-app]

Security audit, information and commands

The security team is auditing all the hosting requests, to ensure a better security by default.

This message informs you that a Jenkins Security Scan was triggered on your repository.
It takes ~10 minutes to complete.

Commands

The bot will parse all comments, and it will check if any line start with a command.

Security team only:

• /audit-ok => the audit is complete, the hosting can continue 🎉.
• /audit-skip => the audit is not necessary, the hosting can continue 🎉.
• /audit-findings => the audit reveals some issues that require corrections ✏️.

Anyone:

• /request-security-scan => the findings from the Jenkins Security Scan were corrected, this command will re-scan your repository 🔍.
• /audit-review => the findings from the audit were corrected, this command will ping the security team to review the findings 👀. It's only applicable when the previous audit required changes.

Only one command can be requested per comment.

(automatically generated message, version: 1.29.20)

[github-actions]

Hello from your friendly Jenkins Hosting Checker

It appears you have some issues with your hosting request. Please see the list below and correct all issues marked Required. Your hosting request will not be approved until these issues are corrected. Issues marked with Warning or Info are just recommendations and will not stall the hosting process.

• ⛔ Required: The following usernames in 'Jenkins project users to have release permission' need to log into Jira: cloudaeye (reports are re-synced hourly, wait to re-check for a bit after logging in)
• ⛔ Required: The following usernames in 'Jenkins project users to have release permission' need to log into Artifactory: cloudaeye (reports are re-synced hourly, wait to re-check for a bit after logging in)
• ⛔ Required: The <groupId> from the pom.xml should be io.jenkins.plugins instead of com.cloudaeye.jenkins

You can re-trigger a check by editing your hosting request or by commenting /hosting re-check

[jenkins-cert-app]

The Jenkins Security Scan discovered 5 finding(s) 🔍.

For every identified issue, please do one of the following:

• Implement the recommended fix to address the issue.
• If you think it's a false positive, suppress the warning directly within the code.
• Alternative, you write an explanation here about why you think it's irrelevant. That will require a manual review, leading to a slower process.

After addressing the findings through one of the above methods:

• If all modifications have been made to the code, please initiate a new security scan by triggering the /request-security-scan command.
• If there are any unresolved findings (those not corrected or suppressed), request a review from the Jenkins security team by using the /audit-review command.

---

Stapler: Missing permission check

You can find detailed information about this finding here.

GlobalKeyConfiguration.java#91

Potential missing permission check in GlobalKeyConfiguration#doTestConnection

Jenkins: Plaintext password storage

You can find detailed information about this finding here.

CloudAEyeNotifications.java#36

Field should be reviewed whether it stores a password and is serialized to disk: token

CloudAEyeNotifications.java#34

Field should be reviewed whether it stores a password and is serialized to disk: tenantKey

GlobalKeyConfiguration.java#35

Field should be reviewed whether it stores a password and is serialized to disk: token

GlobalKeyConfiguration.java#34

Field should be reviewed whether it stores a password and is serialized to disk: tenantKey

[bhavyalatha26]

/hosting re-check

[github-actions]

Hello from your friendly Jenkins Hosting Checker

It appears you have some issues with your hosting request. Please see the list below and correct all issues marked Required. Your hosting request will not be approved until these issues are corrected. Issues marked with Warning or Info are just recommendations and will not stall the hosting process.

• ⛔ Required: The following usernames in 'Jenkins project users to have release permission' need to log into Jira: cloudaeye (reports are re-synced hourly, wait to re-check for a bit after logging in)
• ⛔ Required: The following usernames in 'Jenkins project users to have release permission' need to log into Artifactory: cloudaeye (reports are re-synced hourly, wait to re-check for a bit after logging in)

You can re-trigger a check by editing your hosting request or by commenting /hosting re-check

[bhavyalatha26]

/request-security-scan

[jenkins-cert-app]

The Jenkins Security Scan did not find anything dangerous with your plugin, congratulations! 🎉

---

💡 The Security team recommends that you are setting up the scan in your repository by following our guide.

[bhavyalatha26]

/hosting re-check

[github-actions]

Hello from your friendly Jenkins Hosting Checker

It looks like you have everything in order for your hosting request. A member of the Jenkins hosting team will check over things that I am not able to check(code review, README content, etc) and process the request as quickly as possible. Thank you for your patience.

Hosting team members can host this request with /hosting host

[mawinter69]

• https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L37 do not suppress the security warrning. As you wrote in the comment in the line above, this is a secret and it should be treated like that. So please use a Secret to store the value
• Same here: https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/GlobalKeyConfiguration.java#L35
• Please check the defined dependencies. It seems none of them are really used. What you need are dependencies to https://plugins.jenkins.io/apache-httpcomponents-client-4-api/ and https://plugins.jenkins.io/gson-api/
• https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/pom.xml#L53-L77 Remove the dependecies in the dependencyManagement part, you don't need them with the bom

[mawinter69]

• https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L327 Seems your plugin is restricted to job type AbstractProject, means you don't support pipeline jobs. Nowadays pipeline jobs are the de facto standard, and without supporting them you will not find many people that will make use of your plugin.

[mawinter69]

Please provide a meaningful description here: https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/resources/index.jelly#L3
This is what is shown to users in the Jenkins UI when they look at the pluginmanager.

[bhavyalatha26]

• https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L327 Seems your plugin is restricted to job type AbstractProject, means you don't support pipeline jobs. Nowadays pipeline jobs are the de facto standard, and without supporting them you will not find many people that will make use of your plugin.

No our plugin for both free-style and pipeline, you can find it in implementation ( https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L198) and also in README instructions on how to use it pipeline

[bhavyalatha26]

Please provide a meaningful description here: https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/resources/index.jelly#L3 This is what is shown to users in the Jenkins UI when they look at the pluginmanager.

Sure will update it.

[bhavyalatha26]

@mawinter69 are there any other suggestions that we need to improve on so that we can finish all of them together at once and resubmit for review ?

[mawinter69]

• https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L327 Seems your plugin is restricted to job type AbstractProject, means you don't support pipeline jobs. Nowadays pipeline jobs are the de facto standard, and without supporting them you will not find many people that will make use of your plugin.

No our plugin for both free-style and pipeline, you can find it in implementation ( https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L198) and also in README instructions on how to use it pipeline

If you support pipeline you should annotate the descriptor with @Symbol('cloudAEyeNotification') (singular as you send only one request) at https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L321
This allows you to write in a pipeline
cloudAEyeNotification() instead of step([$class: 'CloudAEyeNotifications'])
Also change line 327 so that it works with Job instead of AbstractProject. Otherwise I think the step will not appear in the Snippet Generator.

• https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L40 the enableExport field seems unnecessary. It should be sufficient to just add the step. If the step would have complex configuration it might be justified to have such an explicit disable feature. Also the default for this field is false, also confusing
• https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L35 tenantKey and token have no fields in the config.jelly. So they are never set via the constructor.
• https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L49 I think the config will never be null
• https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L99 is there a missing return statement?
• https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L132 same here missing return?
• https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L41 I think the notificatiobnSender should not be stored in a field here. It is used in one place only so it is sufficient to instantiate the class directly before usage in line 245
• https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/GlobalKeyConfiguration.java#L26 see comment above
• https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L155 Are you sure you want to use run.getLogText() this will return annotated text with html. It is meant for use in the UI. You might want to use run.getLog which already returns an array with lines and has annotations removed.

The plugin seems to be focused on git especially github. There are many other SCMs around like gerrit, gitlab, bitbucket, perforce and many more

[bhavyalatha26]

Please provide a meaningful description here: https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/resources/index.jelly#L3 This is what is shown to users in the Jenkins UI when they look at the pluginmanager.

Sure will update it.

Done

[bhavyalatha26]

Committed most of the suggested changes. Here are few that we did not / failed to:

1. [In Progress] Migrating to secrets for token

2. Remove redundant check box: We want to keep this because in upcoming updates, we need this feature to help user select some preferences based on this

3. Also change line 327 so that it works with Job instead of AbstractProject. Otherwise I think the step will not appear in the Snippet Generator.

   Changing it to Job was throwing error:

   Class 'DescriptorImpl' must either be declared abstract or implement abstract method 'isApplicable(Class<? extends AbstractProject>)' in 'BuildStepDescriptor'
   

4. https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L99 is there a missing return statement?
   https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L132 same here missing return?

   Since it is a void function, we are returning nothing here.

5. https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L155 Are you sure you want to use run.getLogText() this will return annotated text with html. It is meant for use in the UI. You might want to use run.getLog which already returns an array with lines and has annotations removed.

   Actually we did not want to use getLogText(), but getLog(int n) always asks for number of lines as input which we are not sure how to get the total lines. Is there a way to know and pass number of lines to that function or a way to tell just give all lines generated ?

6. The plugin seems to be focused on git especially github. There are many other SCMs around like gerrit, gitlab, bitbucket, perforce and many more

   Yes this was intentional because on CloudAEye we right now support only github but not other providers

Regards,
Bhavya

[mawinter69]

4. https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L99 is there a missing return statement?

but you don't want to execute anything afterwards so if you don't add a return statement the rest of the method will still be executed so it should look like this I think

        if(!this.getEnableExport()){
            LOGGER.info(MessageFormat.format("[#{0}] Exporting to CloudAEye is not enabled. Skipping export", run.getNumber()));
            return;
        }

5. https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L155 Are you sure you want to use run.getLogText() this will return annotated text with html. It is meant for use in the UI. You might want to use run.getLog which already returns an array with lines and has annotations removed.

Actually we did not want to use getLogText(), but getLog(int n) always asks for number of lines as input which we are not sure how to get the total lines. Is there a way to know and pass number of lines to that function or a way to tell just give all lines generated ?

You could use run.getLog(Integer.MAX_VALUE), so you get the complete log, if there are less lines than you requested it will not fail. Beware that logs can be huge (I have builds that produce logs that are several hundred MiB). You might want to make this configurable, I could imagine that for build error analysis you usually don't need the complete log but only the last few lines.

[bhavyalatha26]

4. https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L99 is there a missing return statement?

but you don't want to execute anything afterwards so if you don't add a return statement the rest of the method will still be executed so it should look like this I think

        if(!this.getEnableExport()){
            LOGGER.info(MessageFormat.format("[#{0}] Exporting to CloudAEye is not enabled. Skipping export", run.getNumber()));
            return;
        }

5. > https://github.com/CloudAEye/cloudaeye-plugin/blob/a26b6638f8375a81ab4a6d12dbe46b77c302f92b/src/main/java/io/jenkins/plugins/cloudaeye/CloudAEyeNotifications.java#L155 Are you sure you want to use run.getLogText() this will return annotated text with html. It is meant for use in the UI. You might want to use run.getLog which already returns an array with lines and has annotations removed.

Actually we did not want to use getLogText(), but getLog(int n) always asks for number of lines as input which we are not sure how to get the total lines. Is there a way to know and pass number of lines to that function or a way to tell just give all lines generated ?

You could use run.getLog(Integer.MAX_VALUE), so you get the complete log, if there are less lines than you requested it will not fail. Beware that logs can be huge (I have builds that produce logs that are several hundred MiB). You might want to make this configurable, I could imagine that for build error analysis you usually don't need the complete log but only the last few lines.

Yes thanks for pointing it out, I also was thinking in same lines that the logs can be huge, is there a way to identify the failed step and only extract logs of that failed step ? I could achieve this with github workflows and AWS codebuild, not sure how to do it with jenkins

[bhavyalatha26]

New updates:

• Replaced string with secrets wherever necessary
• Shifted to using getLogs(Integer.MAX_VALUE) to get all logs instead of annotated logs

[bhavyalatha26]

@mawinter69 Can you please review the updated code and let us know any changes required