Added Shell Plugin for Yugabyte

[parthiv11]

Overview

Added Yugabyte Shell Plugin Similar to Postgres

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

Related Issue(s)

How To Test

Changelog

Additional information

• Check this box if this is a Hashnode Hackathon submission

[AndyTitu]

@parthiv11 This PR looks really good! I just have a couple of questions

[parthiv11]

@AndyTitu can i use both file and env provisioners?

if yes then how?

[hculea]

@parthiv11 You can do this by using a custom provisioner (have a look at ngrok for an example). To add an envvar to the provisioned output, you should be able to call out.AddEnvVar.

[arunsathiya]

This looks like a generally good start, thank you for your contribution @parthiv11. I noticed that YugabyteDB can be connect using ycqlsh too:

https://docs.yugabyte.com/preview/admin/

Could we build support for it too, since both of these executables seem to offer connectivity to YugabyteDB clusters. If you need examples of multi-executable shell plugins, OpenAI is a good example that supports the openai executable, and oaieval and oaievalset too.

I am also leaning towards building support for connectivity to the Yugabyte platform itself, which seems to be yb-admin here:

https://docs.yugabyte.com/preview/admin/

Not sure if any of the other CLI programs are related to Yugabyte platform connectivity.

Example of us supporting both the database connectivity and platform connectivity are redis and mongoDB:

• new(redis-cli): Add support for Redis CLI with password as environment variable and command-line flags #276
• new(mongosh): Support mongosh executable for connecting to a MongoDB database #283

I understand this is all increasing the complexity, but don't hesitate to ping us if you are unclear on anything. We are happy to help.

[arunsathiya]

I should also note that I have NOT functionally tested this because I am on a Apple Silicon MacBook and I am having troubles getting ysqlsh working. It doesn't seem to be available for ARM actually, so I tried with Rosetta enabled, but that has another problem that Homebrew should be installed at another path:

Receiving objects: 100% (1539888/1539888), 403.54 MiB | 35.25 MiB/s, done.
Resolving deltas: 100% (1082554/1082554), done.
Tapped 3 commands and 6742 formulae (7,110 files, 467.8MB).
Error: Cannot install under Rosetta 2 in ARM default prefix (/opt/homebrew)!
To rerun under ARM use:
    arch -arm64 brew install ...
To install under x86_64, install Homebrew into /usr/local.
zsh: command not found: ysqlsh

@parthiv11 could you help us with some screenshots, videos or textual output of the shell plugin in action? That'd tremendously help us review faster.

[arunsathiya]

Hi again @parthiv11, I am wondering if we could help you with anything in getting this PR over to the finish line? Let us know and we can help you!

[parthiv11]

I will try to make it as fast as possible

[parthiv11]

Is there any way to change permission for file generated by op cli ?

[arunsathiya]

Is there any way to change permission for file generated by op cli ?

Could you elaborate a bit more on this part? Are you referring to the temp file provisioner and what's happening at the moment?

[parthiv11]

When I generate a .pgpass file , i need to set permission 600 to it ,for it to work

How can I do it?

[parthiv11]

Getting this warning: WARNING: password file "/home/kali/.pgpass" is not a plain file
And asking for password in prompt as .pgpass needs to have 600 permission

[parthiv11]

simplescreenrecorder-2023-07-15_11.44.15.mp4

[AndyTitu]

In the end this seems to be working nicely with just the env vars. I'm approving for that functionality

[SimonBarendse]

Hi @parthiv11, appreciate your contribution! 🙌 The code is almost ready to be merged. All you need to do is sign your commits. You can follow the instructions below to sign your commits.

---

⚠️ This PR contains unsigned commits. To get your PR merged, please sign those commits (git commit -S --amend --no-edit) and force push them to this branch (git push --force-with-lease).

If you're new to commit signing, there are different ways to set it up:

Sign commits with gpg

Follow the steps below to set up commit signing with gpg:

1. Generate a GPG key
2. Add the GPG key to your GitHub account
3. Configure git to use your GPG key for commit signing

Sign commits with ssh-agent

Follow the steps below to set up commit signing with ssh-agent:

1. Generate an SSH key and add it to ssh-agent
2. Add the SSH key to your GitHub account
3. Configure git to use your SSH key for commit signing

Sign commits with 1Password

You can also sign commits using 1Password, which lets you sign commits with biometrics without the signing key leaving the local 1Password process.

Learn how to use 1Password to sign your commits.

---

Let us know if you have any questions or run into issues signing your commits. We're here to help.

[parthiv11]

@SimonBarendse Done