Request hosting for Testkube CLI plugin

devcatalin commented 8 months ago

Repository URL

https://github.com/kubeshop/testkube-jenkins-plugin

New Repository Name

testkube-cli-plugin

Description

This plugin provides pipeline scripts for initializing and configuring the Testkube CLI in a pipeline. Allowing users to trigger test runs from Jenkins. It also provides the same logic for Build Steps in the UI for freestyle projects.

GitHub users to have commit permission

@devcatalin @olensmar

Jenkins project users to have release permission

testkube

Issue tracker

GitHub issues

jenkins-cert-app commented 8 months ago

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 :tada:.
/audit-skip => the audit is not necessary, the hosting can continue :tada:.
/audit-findings => the audit reveals some issues that require corrections :pencil2:.

Anyone:

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

Only one command can be requested per comment.

(automatically generated message, version: 1.26.28)

github-actions[bot] commented 8 months ago

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.

:no_entry: Required: The parent pom version '4.75' should be at least '4.76' or higher.
:no_entry: Required: The following usernames in 'Jenkins project users to have release permission' need to log into Jira: testkube (reports are re-synced hourly, wait to re-check for a bit after logging in)
:no_entry: Required: The following usernames in 'Jenkins project users to have release permission' need to log into Artifactory: testkube (reports are re-synced hourly, wait to re-check for a bit after logging in)
:no_entry: Required: The 'artifactId' from the pom.xml (testkube-cli-setup) is incorrect, it should be testkube-cli ('New Repository Name' field with "-plugin" removed)

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

devcatalin commented 8 months ago

/hosting re-check

github-actions[bot] commented 8 months ago

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.

:no_entry: Required: The following usernames in 'Jenkins project users to have release permission' need to log into Jira: testkube (reports are re-synced hourly, wait to re-check for a bit after logging in)
:no_entry: Required: The following usernames in 'Jenkins project users to have release permission' need to log into Artifactory: testkube (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

jenkins-cert-app commented 8 months ago

The Jenkins Security Scan discovered 1 finding(s) :mag:. For each of them, either apply the recommended correction, suppress the warning or provide a justification.

Once you're done, either re-run the scan with /request-security-scan or request the Security team to review your justifications with /audit-review.

Jenkins: Plaintext password storage

You can find detailed information about this finding here.

TestkubeCLI.java#41

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

devcatalin commented 7 months ago

/hosting re-check

devcatalin commented 7 months ago

/request-security-scan

github-actions[bot] commented 7 months ago

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

jenkins-cert-app commented 7 months ago

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

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

alecharp commented 7 months ago

Hello,

in your pom.xml, please:

use https://github.com/jenkinsci/apache-httpcomponents-client-4-api-plugin in place of https://github.com/kubeshop/testkube-jenkins-plugin/blob/a4b1f7ed8fe3906c858e3560bb159dbff4ea71cc/pom.xml#L58-L62
use https://github.com/jenkinsci/json-api-plugin in place of https://github.com/kubeshop/testkube-jenkins-plugin/blob/a4b1f7ed8fe3906c858e3560bb159dbff4ea71cc/pom.xml#L68-L72
for other plugin dependency, as you are referencing the BOM, I suggest that you let that BOM control the versions. If for any reason you still need to control the plugin versions directly, please open a ticket on the BOM repository to express the problem you are facing.

Rather than having your own CD process (.github/workflows/build-and-release.yml), may I suggest that you use the community designed one: https://www.jenkins.io/doc/developer/publishing/releasing-cd/

Please fix the team name in .github/CODEOWNERS to be @jenkinsci/testkube-cli-plugin-developers (based on requested repository name and artifactId)

devcatalin commented 7 months ago

thanks @alecharp , I just made the updates you requested, let me know if there's anything else I should do

alecharp commented 7 months ago

And about the release workflow?

devcatalin commented 7 months ago

I've done the following:

removed old CD processes
created the .github/workflows/cd.yaml based on the provided example
updated dependabot.yml
updated .mvn/maven.config
updated pom
ran mvn validate commands with success

Is there anything else that I should do?

alecharp commented 7 months ago

You should be able to get rid of the version for the json-api plugin but that's a detail. Is the account testkube a technical account used within your company? With the setup of cd.yml, the release will be done when a pull request is merged with an "interesting" label.

The labels are listed here. The labels are used to create categories in the release note draft and those are prefixed with a emoji. The emoji is parsed by the "interesting" action here which determines if a release should occur.

I have looked at the plugin code. To my knowledge there is no other plugin providing what you developed the plugin for.

I would like to give 24-48hrs for other on the hosting team to be able to review your request before finalizing it.

NotMyFault commented 7 months ago

The path should match your GAV: https://github.com/kubeshop/testkube-jenkins-plugin/tree/main/src/main/java/io/testkube In this case, move to io.jenkins.plugins.testkube.cli
You forgot to run mvn clean verify package, because I can spot various spotbugs violations left to fix

devcatalin commented 7 months ago

@alecharp yes, the account testkube is a technical support account used within my company. Thanks for the information about labels, will keep that in mind for releases.

@NotMyFault I fixed the path and all the violations from running mvn clean verify package

Thank you for your reviews! Let me know if there's anything else to do

NotMyFault commented 7 months ago

/hosting host

jenkins-infra-bot commented 7 months ago

Hosting request complete, the code has been forked into the jenkinsci project on GitHub as https://github.com/jenkinsci/testkube-cli-plugin

GitHub issues has been selected for issue tracking and was enabled for the forked repo.

A pull request has been created against the repository permissions updater to setup release permissions. Additional users can be added by modifying the created file.

Please delete your original repository (if there are no other forks), under 'Danger Zone', so that the jenkinsci organization repository is the definitive source for the code. If there are other forks, please contact GitHub support to make the jenkinsci repo the root of the fork network (mention that Jenkins approval was given in support request 569994). Also, please make sure you properly follow the documentation on documenting your plugin so that your plugin is correctly documented.

You will also need to do the following in order to push changes and release your plugin:

In order for your plugin to be built by the Jenkins CI Infrastructure and check pull requests, please add a Jenkinsfile to the root of your repository with the following content: https://github.com/jenkinsci/archetypes/blob/master/common-files/Jenkinsfile

Welcome aboard!

jenkins-infra / repository-permissions-updater