Add plugin for Nimble package manager by electrocally · Pull Request #255 · 1Password/shell-plugins

electrocally · 2023-05-01T09:50:13Z

Overview

This plugin adds support for https://nimble.directory, the package manager for https://nim-lang.org

Type of change

Created a new plugin

How To Test

Install Nim, this will also install nimble
Install this plugin using these instructions with make nimble/build & op plugin init nimble. This may prompt for your PAT, explained in step 4
Run nimble init to create a new Nim package (additional docs here)
When executing nimble publish, 1Password will prompt for your GitHub Personal Access Token. This will need public_repo permissions.

Changelog

Authenticate the publishing Nim (Nimble) packages using Touch ID and other unlock options with 1Password Shell Plugins.

AndyTitu

Thanks for the contribution! Left a few comments. Let me know if you need additional guidance!

AndyTitu · 2023-05-01T11:24:10Z

+}
+
+func TryNimbleConfigFile() sdk.Importer {
+	// TODO: Try importing from ~/.nimble/github_api_token file


is this TODO a change to be carried on in this PR? If not, I would suggest adding an importer for a potentially already existing NIMBLE_GITHUB_API_TOKEN as a quick win, just so not to ship this with absolutely no importers.

importer.TryEnvVarPair(defaultEnvVarMapping),

Thanks so much for the feedback & suggestions, @AndyTitu !
I'll add in the env var importer this evening.

For the file importer, this is similar to the HashiCorp Vault plugin. I wasn't able to create a working version as the ~/.nimble/github_api_token file doesn't have any formatting/extension type, just the token in plaintext.
I was hoping to ask for suggestions - I read through the other plugins to compare, but as far as I can see, the package seems to expect a key/value.

I've pushed TryEnvVarPair to the top of the TryAll in importers. Cheers!

Something like this should do the trick for the file importer, provided the file only contains the token:

func TryNimbleConfigFile(path string) sdk.Importer { return importer.TryFile(path, func(ctx context.Context, contents importer.FileContents, in sdk.ImportInput, out *sdk.ImportAttempt) { credential := contents.ToString() fields := make(map[sdk.FieldName]string) if len(credential) != 0 { fields[fieldname.Token] = credential } out.AddCandidate(sdk.ImportCandidate{ Fields: fields, }) }) }

I didn't test this code, let us know in case this doesn't work and we can look deeper into it 😄

Hey @hculea, thank you so much for your help on this! That seems to be working well & I've just tested that it can now import from that config file

AndyTitu · 2023-05-01T11:33:39Z

+		),
+		Uses: []schema.CredentialUsage{
+			{
+				Name: credname.PersonalAccessToken,


If we go on the route mentioned in the other comment, here we could just specify Plugin: github, Name: credname.PersonalAccessToken and Provisioner: the provisioner you created.

I'm all for using the standardised plugin! The schema suggests this needs to be a string for the plugin, e.g. Plugin: "github"?
I can't seem to see other plugins using it for an example, so any help would be massively appreciated.

As I've not added a custom provisioner, would something along the lines of this be close?

... Uses: []schema.CredentialUsage{ { Plugin: "github", Name: credname.PersonalAccessToken, }, },

Thanks in advance

@electrocally Yes, this is right!

The only extra thing is that you need to define a custom provisioner for this credential usage, as you noted in this other thread's reply.

So this should work:

Uses: []schema.CredentialUsage{ { Plugin: "github", Name: credname.PersonalAccessToken, Provisioner: provision.EnvVars(nimbleDefaultEnvVarMapping), }, }, ... var nimbleDefaultEnvVarMapping = map[string]sdk.FieldName{ "NIMBLE_GITHUB_API_TOKEN": fieldname.Token, }

while everything else in nimble/personal_access_token.go can be safely removed.

You could then remove the provisioner test case entirely or modify it to test this custom provisioner provision.EnvVars(nimbleDefaultEnvVarMapping)

Let's add the provisioner here in the credential usage, as we discussed before

hculea

Thanks for the contribution! ❤️ I've only left a few comments, looks great for the most part.

hculea · 2023-05-05T11:38:56Z

+		Runs:    []string{"nimble"},
+		DocsURL: sdk.URL("https://github.com/nim-lang/nimble"),
+		NeedsAuth: needsauth.IfAll(
+			needsauth.IfAny(


No need for IfAny in this situation, since it only contains one rule.

This has yet to be resolved

hculea · 2023-05-05T11:56:41Z

+}
+
+func TryNimbleConfigFile() sdk.Importer {
+	// TODO: Try importing from ~/.nimble/github_api_token file


Something like this should do the trick for the file importer, provided the file only contains the token:

func TryNimbleConfigFile(path string) sdk.Importer { return importer.TryFile(path, func(ctx context.Context, contents importer.FileContents, in sdk.ImportInput, out *sdk.ImportAttempt) { credential := contents.ToString() fields := make(map[sdk.FieldName]string) if len(credential) != 0 { fields[fieldname.Token] = credential } out.AddCandidate(sdk.ImportCandidate{ Fields: fields, }) }) }

I didn't test this code, let us know in case this doesn't work and we can look deeper into it 😄

hculea · 2023-05-05T11:57:38Z

+type Config struct {
+	Token string `ini:"token"`
+}


We can get rid of this, I think.

hculea · 2023-05-05T11:58:08Z

+func TestPersonalAccessTokenImporter(t *testing.T) {
+	plugintest.TestImporter(t, PersonalAccessToken().Importer, map[string]plugintest.ImportCase{
+		"environment": {
+			Environment: map[string]string{
+				"NIMBLE_GITHUB_API_TOKEN": "ghp_ahhfw82h48fh72nfn29fn291nwidhf8EXAMPLE",
+			},
+			ExpectedCandidates: []sdk.ImportCandidate{
+				{
+					Fields: map[sdk.FieldName]string{
+						fieldname.Token: "ghp_ahhfw82h48fh72nfn29fn291nwidhf8EXAMPLE",
+					},


Let's make sure we also add a test for the file importer, once that's sorted out.

AndyTitu · 2023-05-19T11:41:04Z

@electrocally Are there any further blockers you would need some help with, following our developer Slack conversation? Let me know 😄 !

electrocally · 2023-05-22T08:20:56Z

@electrocally Are there any further blockers you would need some help with, following our developer Slack conversation? Let me know 😄 !

Thanks for checking in @AndyTitu! I've not had a lot of time for my projects lately. Hoping to do a bit more on this over the coming evenings 😁

hculea · 2023-05-30T08:30:54Z

@electrocally Do let us know if there is anything that we can help with, to keep this moving 😄

electrocally · 2023-06-06T22:20:13Z

Hi guys! Thanks so much for the continued encouragement the last few weeks. It's been really great to contribute to this project 😀

I've just pushed up some changes - there's good and bad news.
The good: it works! I've tidied up some of the code but as always would love to hear any further suggestions/optimisations.

The not so good: I love the concept of using the Plugin: github setup & I've really appreciated all your help with it. It works brilliantly to provision credentials and can be reused across all sorts of apps that rely on GitHub.
That said, as we discussed on Slack, until we can add in an Importer argument to the CredentialUsage type, I can't seem to find a way to get that configuration working with importer(s).
For now I'd like to prioritise the onboarding process of the plugin to anyone using the default Nimble setup & would be more than happy to contribute to adding that functionality to the type definition

AndyTitu · 2023-08-30T10:57:46Z

@@ -0,0 +1 @@
+ghp_ahhfw82h48fh72nfn29fn291nwidhf8EXAMPLE


nit: add an extra line

AndyTitu · 2023-08-30T10:59:20Z

@electrocally I'm fine with not attempting to change the schema to adhere to the importing scenario in this MR. Let's make sure we create a separate issue for that though, if one doesn't exist already.

But there are still a few open discussions to be resolved before we could merge this PR

Add plugin for Nimble package manager

acb8ae0

AndyTitu reviewed May 1, 2023

View reviewed changes

AndyTitu added the in-progress this PR is being worked on/comments are in the process of being addressed by the contributor label May 1, 2023

prioritise TryEnvVarPair in importers

a98ed23

AndyTitu added waiting-on-reviewer signals that a certain PR is waiting for a review from a 1Password team member and removed in-progress this PR is being worked on/comments are in the process of being addressed by the contributor labels May 4, 2023

hculea reviewed May 5, 2023

View reviewed changes

Add config file importer

f46c2ef

AndyTitu added in-progress this PR is being worked on/comments are in the process of being addressed by the contributor and removed waiting-on-reviewer signals that a certain PR is waiting for a review from a 1Password team member labels May 8, 2023

tidy: use clearer variable definitions

b5c4476

AndyTitu reviewed Aug 30, 2023

View reviewed changes

rr3khan closed this Oct 12, 2026

rr3khan reopened this Oct 12, 2026

		@@ -0,0 +1 @@
		ghp_ahhfw82h48fh72nfn29fn291nwidhf8EXAMPLE No newline at end of file

Conversation

electrocally commented May 1, 2023

Overview

Type of change

How To Test

Changelog

Uh oh!

AndyTitu left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AndyTitu May 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AndyTitu May 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hculea left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AndyTitu commented May 19, 2023

Uh oh!

electrocally commented May 22, 2023

Uh oh!

hculea commented May 30, 2023

Uh oh!

electrocally commented Jun 6, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AndyTitu commented Aug 30, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

AndyTitu May 1, 2023 •

edited

Loading

AndyTitu May 8, 2023 •

edited

Loading