🍀 Proposal: new command: dtm develop validate-plugin --all

[daniel-hutao]

Description

Background

DevStream CLI dtm has a developer command dtm develop create-plugin to help contributors generate boilerplate code for a new plugin.

Usage: dtm develop create-plugin --name=xxx.

Then we added another command (thanks to @summingyu) dtm develop validate-plugin to further help developers to "validate" the code they wrote. For example, this command will validate if necessary source code files exist or not.

The thing is, we had created many plugins before the creation of the validate command, and that's why if we use the "validate" command against existing plugins, not all plugins could pass the validation.

Proposal

Refactor existing plugins (mainly rename/restructure, etc.) so that:

dtm develop validate-plugin --all

can pass.

[xavier-hou]

I wanna try

[daniel-hutao]

/assign @HXCGIT

[daniel-hutao]

Happy coding with your first pr! Feel free to call me anytime if you need any help. @HXCGIT

[xavier-hou]

Happy coding with your first pr! Feel free to call me anytime if you need any help. @HXCGIT

I have a problem here. In dtm cli, develop act as a sub-command and valicate-plugin act as a argument. I'am not clear whether we can add a flag to arguments. If we add --all flag to develop command, then create-plugin will also have this flag. Does this make sense?
@daniel-hutao @summingyu

[daniel-hutao]

@HXCGIT First of all, sorry for not replying to your comment in time, I've been a little busy lately with too much chores in my hands. Anyway I am so sorry about it.

You are very thoughtful, the behavior you mentioned is really not the best practice. Both validate-plugin and create-plugin should be sub-commands.

Although not it is currently functional, but it is indeed not optimal. And other commands also have a similar "flag is not accurate enough" problem.

Maybe after completing the functional development with validate-plugin, we can do some refactoring work to make this piece of logic better.

If you are interested in it, you are also very very welcome to submit a PR to complete this refactoring.

[xavier-hou]

@daniel-hutao Thank you for your reply! I am more than happy to address the issue. I will do my best to complete this refactoring with your help!

[daniel-hutao]

@HXCGIT The validation rules need some improvement. So let's wait for @summingyu do some work about it. See #453 for more info.

[daniel-hutao]

I've test the --all flag and it does well.

• ./dtm develop validate-plugin -a or
• ./dtm develop validate-plugin --all

2022-05-19 22:27:19 ℹ [INFO]  Start validating all plugins.

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <argocd> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <argocd> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <argocd> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <argocdapp> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <argocdapp> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <argocdapp> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <devlake> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <devlake> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <devlake> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <github-repo-scaffolding-golang> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <github-repo-scaffolding-golang> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <github-repo-scaffolding-golang> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <githubactions-golang> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <githubactions-golang> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <githubactions-golang> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <githubactions-nodejs> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <githubactions-nodejs> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <githubactions-nodejs> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <githubactions-python> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <githubactions-python> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <githubactions-python> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <gitlab-repo-scaffolding-golang> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <gitlab-repo-scaffolding-golang> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <gitlab-repo-scaffolding-golang> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <gitlabci-generic> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <gitlabci-generic> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <gitlabci-generic> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <gitlabci-golang> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <gitlabci-golang> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <gitlabci-golang> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <hashicorp-vault> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <hashicorp-vault> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <hashicorp-vault> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <helm-generic> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <helm-generic> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <helm-generic> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <jenkins> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <jenkins> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <jenkins> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <jira-github-integ> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <jira-github-integ> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <jira-github-integ> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <kube-prometheus> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <kube-prometheus> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <kube-prometheus> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <openldap> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <openldap> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <openldap> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <trello> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <trello> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <trello> =====

2022-05-19 22:27:19 ℹ [INFO]  ===== start validating <trello-github-integ> =====
2022-05-19 22:27:19 ✔ [SUCCESS]  Plugin <trello-github-integ> passed validation.
2022-05-19 22:27:19 ℹ [INFO]  ===== Finished validate <trello-github-integ> =====
``

[daniel-hutao]

/close #551