feat(cli): Add Plugin Support to the Argo CD CLI #20074

nitishfy · 2024-09-24T10:48:13Z

Ref: #19624
Checklist:

bunnyshell · 2024-09-24T10:48:17Z

🔴 Preview Environment stopped on Bunnyshell

See: Environment Details | Pipeline Logs

Available commands (reply to this comment):

🔵 /bns:start to start the environment
🚀 /bns:deploy to redeploy the environment
❌ /bns:delete to remove the environment

bunnyshell · 2024-09-24T10:48:18Z

✅ Preview Environment created on Bunnyshell but will not be auto-deployed

See: Environment Details

Available commands (reply to this comment):

🚀 /bns:deploy to deploy the environment

codecov · 2024-09-24T11:43:17Z

Codecov Report

Attention: Patch coverage is 80.76923% with 25 lines in your changes missing coverage. Please review.

Please upload report for BASE (master@e66068c). Learn more about missing BASE report.
Report is 14 commits behind head on master.

Files with missing lines	Patch %	Lines
cmd/argocd/commands/plugin.go	85.71%	12 Missing and 3 partials ⚠️
cmd/main.go	60.00%	9 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##             master   #20074   +/-   ##
=========================================
  Coverage          ?   59.07%           
=========================================
  Files             ?      338           
  Lines             ?    57159           
  Branches          ?        0           
=========================================
  Hits              ?    33768           
  Misses            ?    20579           
  Partials          ?     2812

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

leoluz

Please consider adding a new documentation page explaining how to write plugins and how to install and consume them.

cmd/argocd/commands/root.go

nitishfy

plugin_test.go is kept in separate package because keeping it in the util will create circular dependency.

Update: Resolved

leoluz

@nitishfy Great progress. I think this PR needs to be reviewed by someone from the security sig as I see some potential risks in the code. I added comments to the security issues that I identified at first but a more security driven review would be important in this case.
cc @jannfis @crenshaw-dev

leoluz · 2024-10-08T13:34:22Z

cmd/argocd/commands/plugin.go

+	}
+	if filepath.Base(name) == name {
+		lp, err := exec.LookPath(name)
+		if lp != "" && !shouldSkipOnLookPathErr(err) {


This may lead to security implications. For example: if someone has their PATH configured as PATH=.:/usr/bin, the first . makes the current directory available in the PATH which enables different types of exploits. Go 1.19+ will return ErrDot to notify us that the return value from LookPath() is a relative path. We shouldn't ignore this error. Instead, we should fail and return an error stating that the executable wasn't found. Also, we must state in the docs that the plugin executable must be in the path and should not be provided as relative path.

cmd/argocd/commands/plugin_test.go

cmd/argocd/commands/root.go

cmd/main.go

cmd/argocd/commands/root.go

cmd/main.go

nitishfy

We are not using the cmd.Find() anymore.

leoluz

Please check my comments

cmd/main.go

nitishfy

PTAL.

nitishfy · 2024-10-15T12:06:31Z

Also, I think I'll have to restructure the entire tests for plugin_test.go once the change is accepted.

leoluz

Great progress. Tks @nitishfy!
There are a few more open items to be addressed in this PR before we merge.
Please take a look.

cmd/argocd/commands/root.go

cmd/main.go

blakepettersson · 2024-10-21T20:34:34Z

go.mod

@@ -83,6 +83,7 @@ require (
 	go.opentelemetry.io/otel v1.30.0
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.30.0
 	go.opentelemetry.io/otel/sdk v1.30.0
+	go.uber.org/automaxprocs v1.6.0


I think you should probably revert the changes in go.mod in order for there not to be any conflicts with master.

this will lead to dependency issues, resulting in failure of CI checks.

@nitishfy You probably need to run go mod tidy and push the changes.

Can you run

git checkout origin/master -- go.mod

?

I think this needs to be done again once you sync your hook with argocd/master and then pulling in the latest changes from your hook on the master branch.

nitishfy

Few suggestions needed and once done, I'll start with improving the comments and add the docs. Thanks!

cmd/argocd/commands/root.go

blakepettersson

Added a few pointers which I think would be good to do before proceeding further.

cmd/main.go

cmd/argocd/commands/root.go

cmd/argocd/commands/plugin.go

nitishfy · 2024-12-26T13:12:20Z

@leoluz I'm personally in the opinion of searching for a plugin, starting with the longest prefix. Why would you want to follow another approach?

blakepettersson

I think there's a lot of room to simplify this further - there's also a bunch of test code existing which does not exercise a lot of the actual code (as well as there being a lot of test code which seems redundant?).

By abstracting away exec.LookPath and cmd.Run tests can be written which exercises the actual implementation of DefaultPluginHandler (just create custom functions for lookPath and run in your tests)

cmd/argocd/commands/plugin.go

cmd/main.go

blakepettersson · 2024-12-28T19:46:47Z

go.mod

@@ -83,6 +83,7 @@ require (
 	go.opentelemetry.io/otel v1.30.0
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.30.0
 	go.opentelemetry.io/otel/sdk v1.30.0
+	go.uber.org/automaxprocs v1.6.0


Can you run

git checkout origin/master -- go.mod

?

cmd/argocd/commands/root.go

nitishfy

@blakebarnett PTAL

cmd/argocd/commands/plugin.go

cmd/argocd/commands/root.go

cmd/argocd/commands/plugin.go

cmd/argocd/commands/root.go

cmd/argocd/commands/plugin_test.go

nitishfy · 2025-01-03T09:11:37Z

@leoluz @blakepettersson I'd need your feedback on this PR. Having said that, there are a few things I'd like to mention:

We need to decide if we would like to follow the longest executable search performed or not.
I can see a lot of code optimization and few testcases can be added. I'm thinking if it would be okay to add them as some separate PR.
I'll start working on writing the docs as soon as I get confirmation about if we'd like to have longest executable search operation in code or not.

blakepettersson · 2025-01-04T09:02:37Z

I can see a lot of code optimization and few testcases can be added. I'm thinking if it would be okay to add them as some separate PR.

What kind of code optimizations and test cases can be done? Why can't they be done in this PR?

cmd/main.go

blakepettersson · 2025-01-04T14:20:03Z

go.mod

@@ -83,6 +83,7 @@ require (
 	go.opentelemetry.io/otel v1.30.0
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.30.0
 	go.opentelemetry.io/otel/sdk v1.30.0
+	go.uber.org/automaxprocs v1.6.0


I think this needs to be done again once you sync your hook with argocd/master and then pulling in the latest changes from your hook on the master branch.

cmd/argocd/commands/plugin.go

Signed-off-by: nitishfy <[email protected]>

cmd/argocd/commands/plugin_test.go

cmd/argocd/commands/plugin.go

cmd/argocd/commands/plugin_test.go

Signed-off-by: nitishfy <[email protected]>

leoluz · 2025-01-07T16:14:37Z

cmd/argocd/commands/plugin.go

+		// TODO: verify how errors should be handled
+		path, err := h.lookPath(pluginName)
+		if err != nil || len(path) == 0 {
+			continue


shouldn't this error be logged so users know why their plugins are not being registered?

we are not logging the error here because we try to search for another plugin name based on the longest prefix match. For eg. If a plugin argocd demo plugin is not found, the err will be non-nil and we then search for a plugin named argocd demo. This is getting done by ranging over the valid prefixes.

leoluz · 2025-01-07T16:16:24Z

cmd/argocd/commands/plugin.go

+// Unexpected errors (e.g., permission issues) are logged for debugging but do not stop the search.
+// This doesn't care about the plugin execution errors since those errors are handled separately by
+// the execute function. Only those binaries are considered as argocd plugins if they start with
+// argocd and have executable permisssions. If they don't have executable permissions inspite of being


If they don't have executable permissions

I don't see the executable validation logic as part of this function. Please just document the function specific behaviour and move this doc to where the validation is actually implemented.

leoluz · 2025-01-07T16:17:44Z

cmd/argocd/commands/plugin.go

+func (h *DefaultPluginHandler) lookForPlugin(filename string) (string, bool) {
+	for _, prefix := range h.ValidPrefixes {
+		pluginName := fmt.Sprintf("%s-%s", prefix, filename) // Combine prefix and filename
+		// TODO: verify how errors should be handled


We should define how this error should be handled as part of this PR.

leoluz requested changes Sep 24, 2024

View reviewed changes

cmd/argocd/commands/root.go Outdated Show resolved Hide resolved

cmd/argocd/commands/root.go Outdated Show resolved Hide resolved

leoluz requested changes Sep 24, 2024

View reviewed changes

cmd/argocd/commands/root.go Outdated Show resolved Hide resolved

leoluz self-assigned this Sep 24, 2024

nitishfy force-pushed the nitish/argocd-plugin-support branch 2 times, most recently from 92967cd to 4a260dd Compare October 1, 2024 11:40

nitishfy commented Oct 1, 2024

View reviewed changes

nitishfy force-pushed the nitish/argocd-plugin-support branch 2 times, most recently from 0e8f338 to c314e43 Compare October 8, 2024 11:35

nitishfy changed the title ~~WIP: Add Plugin Support to the Argo CD CLI~~ feat: Add Plugin Support to the Argo CD CLI Oct 8, 2024

nitishfy requested a review from leoluz October 8, 2024 11:57

leoluz requested changes Oct 8, 2024

View reviewed changes

cmd/argocd/commands/root.go Outdated Show resolved Hide resolved

blakepettersson reviewed Oct 9, 2024

View reviewed changes

cmd/main.go Outdated Show resolved Hide resolved

blakepettersson changed the title ~~feat: Add Plugin Support to the Argo CD CLI~~ feat(cli): Add Plugin Support to the Argo CD CLI Oct 10, 2024

nitishfy force-pushed the nitish/argocd-plugin-support branch from 652887c to fea85cd Compare October 11, 2024 09:46

nitishfy commented Oct 11, 2024

View reviewed changes

nitishfy requested a review from leoluz October 11, 2024 11:58

leoluz requested changes Oct 11, 2024

View reviewed changes

cmd/main.go Outdated Show resolved Hide resolved

cmd/main.go Outdated Show resolved Hide resolved

cmd/main.go Outdated Show resolved Hide resolved

cmd/main.go Outdated Show resolved Hide resolved

cmd/main.go Outdated Show resolved Hide resolved

blakepettersson requested changes Oct 14, 2024

View reviewed changes

cmd/main.go Outdated Show resolved Hide resolved

cmd/main.go Outdated Show resolved Hide resolved

nitishfy commented Oct 15, 2024

View reviewed changes

cmd/main.go Outdated Show resolved Hide resolved

nitishfy commented Oct 15, 2024

View reviewed changes

nitishfy requested review from leoluz and blakepettersson October 15, 2024 12:06

nitishfy mentioned this pull request Oct 16, 2024

docs: Adding Argo CD CLI plugin support proposal #19624

Open

14 tasks

leoluz reviewed Oct 17, 2024

View reviewed changes

cmd/argocd/commands/root.go Outdated Show resolved Hide resolved

cmd/main.go Outdated Show resolved Hide resolved

blakepettersson reviewed Oct 21, 2024

View reviewed changes

nitishfy commented Nov 26, 2024

View reviewed changes

hiddeco reviewed Nov 26, 2024

View reviewed changes

cmd/argocd/commands/root.go Outdated Show resolved Hide resolved

blakepettersson requested changes Nov 28, 2024

View reviewed changes

cmd/main.go Outdated Show resolved Hide resolved

cmd/argocd/commands/root.go Outdated Show resolved Hide resolved

cmd/argocd/commands/plugin.go Outdated Show resolved Hide resolved

cmd/argocd/commands/plugin.go Outdated Show resolved Hide resolved

nitishfy force-pushed the nitish/argocd-plugin-support branch 2 times, most recently from 319184f to fde718d Compare December 26, 2024 13:19

nitishfy requested review from blakepettersson and hiddeco December 27, 2024 06:43

blakepettersson requested changes Dec 28, 2024

View reviewed changes

nitishfy force-pushed the nitish/argocd-plugin-support branch from f0fe0f0 to a1e9407 Compare December 29, 2024 10:58

nitishfy commented Dec 29, 2024

View reviewed changes

nitishfy requested a review from blakepettersson December 29, 2024 11:01

nitishfy force-pushed the nitish/argocd-plugin-support branch from 6139175 to 7ccd4a7 Compare January 3, 2025 09:07

nitishfy force-pushed the nitish/argocd-plugin-support branch from d8723ca to d0ba8ce Compare January 3, 2025 09:15

blakepettersson requested changes Jan 4, 2025

View reviewed changes

nitishfy requested a review from blakepettersson January 6, 2025 10:58

nitishfy added 4 commits January 6, 2025 16:28

add plugin test cases

57ea2bd

Signed-off-by: nitishfy <[email protected]>

fix lint issues

ef2445f

Signed-off-by: nitishfy <[email protected]>

fix failing test case

744341a

Signed-off-by: nitishfy <[email protected]>

fix go.mod

0cd9b74

Signed-off-by: nitishfy <[email protected]>

nitishfy force-pushed the nitish/argocd-plugin-support branch from fbe994f to 0cd9b74 Compare January 6, 2025 10:59

fix go.mod

5605bc3

Signed-off-by: nitishfy <[email protected]>

nitishfy commented Jan 6, 2025

View reviewed changes

cmd/argocd/commands/plugin_test.go Show resolved Hide resolved

blakepettersson requested changes Jan 6, 2025

View reviewed changes

cmd/argocd/commands/plugin.go Outdated Show resolved Hide resolved

cmd/argocd/commands/plugin.go Outdated Show resolved Hide resolved

cmd/argocd/commands/plugin.go Outdated Show resolved Hide resolved

cmd/argocd/commands/plugin_test.go Outdated Show resolved Hide resolved

fix failing tests

3fc1732

Signed-off-by: nitishfy <[email protected]>

nitishfy requested a review from blakepettersson January 7, 2025 05:21

leoluz requested changes Jan 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli): Add Plugin Support to the Argo CD CLI #20074

feat(cli): Add Plugin Support to the Argo CD CLI #20074

nitishfy commented Sep 24, 2024 •

edited

Loading

bunnyshell bot commented Sep 24, 2024 •

edited

Loading

bunnyshell bot commented Sep 24, 2024

codecov bot commented Sep 24, 2024 •

edited

Loading

leoluz left a comment

nitishfy left a comment •

edited

Loading

leoluz left a comment

leoluz Oct 8, 2024 •

edited

Loading

nitishfy left a comment

leoluz left a comment

nitishfy left a comment

nitishfy commented Oct 15, 2024

leoluz left a comment

blakepettersson Oct 21, 2024

nitishfy Oct 28, 2024

leoluz Oct 28, 2024

blakepettersson Dec 28, 2024

blakepettersson Jan 4, 2025

nitishfy left a comment

blakepettersson left a comment

nitishfy commented Dec 26, 2024

blakepettersson left a comment

blakepettersson Dec 28, 2024

nitishfy left a comment

nitishfy commented Jan 3, 2025 •

edited

Loading

blakepettersson commented Jan 4, 2025

blakepettersson Jan 4, 2025

leoluz Jan 7, 2025

nitishfy Jan 8, 2025

leoluz Jan 7, 2025

leoluz Jan 7, 2025

feat(cli): Add Plugin Support to the Argo CD CLI #20074

Are you sure you want to change the base?

feat(cli): Add Plugin Support to the Argo CD CLI #20074

Conversation

nitishfy commented Sep 24, 2024 • edited Loading

bunnyshell bot commented Sep 24, 2024 • edited Loading

🔴 Preview Environment stopped on Bunnyshell

bunnyshell bot commented Sep 24, 2024

✅ Preview Environment created on Bunnyshell but will not be auto-deployed

codecov bot commented Sep 24, 2024 • edited Loading

Codecov Report

leoluz left a comment

Choose a reason for hiding this comment

nitishfy left a comment • edited Loading

Choose a reason for hiding this comment

leoluz left a comment

Choose a reason for hiding this comment

leoluz Oct 8, 2024 • edited Loading

Choose a reason for hiding this comment

nitishfy left a comment

Choose a reason for hiding this comment

leoluz left a comment

Choose a reason for hiding this comment

nitishfy left a comment

Choose a reason for hiding this comment

nitishfy commented Oct 15, 2024

leoluz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nitishfy left a comment

Choose a reason for hiding this comment

blakepettersson left a comment

Choose a reason for hiding this comment

nitishfy commented Dec 26, 2024

blakepettersson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nitishfy left a comment

Choose a reason for hiding this comment

nitishfy commented Jan 3, 2025 • edited Loading

blakepettersson commented Jan 4, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nitishfy commented Sep 24, 2024 •

edited

Loading

bunnyshell bot commented Sep 24, 2024 •

edited

Loading

codecov bot commented Sep 24, 2024 •

edited

Loading

nitishfy left a comment •

edited

Loading

leoluz Oct 8, 2024 •

edited

Loading

nitishfy commented Jan 3, 2025 •

edited

Loading