feat: Add plugin for prefect

[avinash-santhanagopalan]

Overview

Adds a plugin for prefect cli

Type of change

• Created a new plugin
• Improved an existing plugin
• Fixed a bug in an existing plugin
• Improved contributor utilities or experience

Related Issue(s)

• Resolves: #
• Relates: #

How To Test

Install prefect:

pip install prefect

Test the plugin:

op plugin init prefect      
####################################################################################
# WARNING: 'prefect' is not from the official registry.                            #
# Only proceed if you are the developer of 'prefect'.                              #
# Otherwise, delete the file at /Users/1password/.config/op/plugins/local/prefect. #
####################################################################################

Prefect [test build]
Authenticate with Prefect Access Key.

? Locate your Prefect Access Key: Search in 1Password...

? Locate your Prefect Access Key: <Prefect credentials>

? Configure when the chosen credential(s) will be used to authenticate: Prompt me for each new terminal session

The last step is to set up an alias for prefect.
You can do so by running the following command:

  echo "source /Users/1password/.config/op/plugins.sh" >> ~/.zshrc && source ~/.zshrc

Afterwards, run any prefect command to see it in action!
                                                                                                                                                   
29.395s 1password ❯ echo "source /Users/1password/.config/op/plugins.sh" >> ~/.zshrc && source ~/.zshrc
                                                                                                                                                  
154ms 1password ❯ prefect deployment ls
####################################################################################
# WARNING: 'prefect' is not from the official registry.                            #
# Only proceed if you are the developer of 'prefect'.                              #
# Otherwise, delete the file at /Users/1password/.config/op/plugins/local/prefect. #
####################################################################################
                                                   Deployments                                                    
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Name                                                                    ┃ ID                                   ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ The list of deployments
└─────────────────────────────────────────────────────────────────────────┴──────────────────────────────────────┘

Changelog

Authenticate Prefect using 1Password Shell Plugin

[AndyTitu]

@avinash-santhanagopalan There are some commits you should sign, otherwise this cannot be merged

[AndyTitu]

Ping me after TODOs around config file importing are removed, and all commits are signed. I think this PR would be getting close to the finish line, after those are resolved.

[avinash-santhanagopalan]

@AndyTitu I've signed previous commits and removed the file importer portions. Let me know if there are further changes required.

[jpcoenen]

Hey Avinash! Thanks for building this plugin 🙌 Overall it looks good. I've left a few comments to increase the test coverage and make some things a bit more future compatible.

Once these points are addressed, this is good to go in my opinion 🚀

[jpcoenen]

It looks like Prefect also supports custom deployments. In that case, the API URL will be completely unpredictable. So I'd suggest we remove this composition field to assure maximum compatibility.

Suggested change

	Composition: &schema.ValueComposition{
	Length: 124,
	Prefix: "https://api.prefect.cloud/api/accounts/",
	Charset: schema.Charset{
	Uppercase: false,
	Lowercase: true,
	Digits: true,
	},
	},

[avinash-santhanagopalan]

Ah I wasn't aware the API URL can change completely. One minor point is that the format of the URL will definitely have an account UUID and a workspace UUID following uuid4 format. Not sure if there is a way to specifically check that. I've had trouble in the past where I missed a single character while initiating and prefect's failure to authenticate messages were less than helpful.

[arunsathiya]

@avinash-santhanagopalan Shell Plugins' importer SDK handles the importing of the API URL (which has the UUID segments) seamlessly. I think your overall concern is how to create/use UUID only in the tests. You can use a random UUID from https://uuid.rocks/ for that purpose.

[jpcoenen]

One minor point is that the format of the URL will definitely have an account UUID and a workspace UUID following uuid4 format. Not sure if there is a way to specifically check that. I've had trouble in the past where I missed a single character while initiating and prefect's failure to authenticate messages were less than helpful.

Hmm. That's a good point. However, I don't think we have a good way to check for that right now. I can imagine us introducing more flexible validators for credentials at some point, which could help here. However, such a thing is not currently planned. So I think the best we can do for now, is rely on Prefect's error messaging here.

[AndyTitu]

@avinash-santhanagopalan We are less interested in determining composition for an URL-type field. Also there's no way currently to define an exact structure the field could take. So I agree with Joris that specifying this value composition could do more harm than good in this case, so we can just remove it altogether.

[AndyTitu]

@avinash-santhanagopalan is there anything we can do to help move this forward?

[hculea]

@avinash-santhanagopalan Let us know if there's anything that we can do to help move this forward!

[avinash-santhanagopalan]

@hculea @AndyTitu Thank you for reaching out. I am not too familiar with Go test cases and I'm having some trouble getting them to pass. If you can help out that would be great!