Skip to content

Commit

Permalink
Merge pull request #141 from arunsathiya/add/flyctl
Browse files Browse the repository at this point in the history
Add support for flyctl
  • Loading branch information
SimonBarendse committed May 30, 2023
2 parents 080c5cc + 01c6f85 commit 5ff6634
Show file tree
Hide file tree
Showing 6 changed files with 190 additions and 0 deletions.
68 changes: 68 additions & 0 deletions plugins/flyctl/access_token.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
package flyctl

import (
"context"

"github.com/1Password/shell-plugins/sdk"
"github.com/1Password/shell-plugins/sdk/importer"
"github.com/1Password/shell-plugins/sdk/provision"
"github.com/1Password/shell-plugins/sdk/schema"
"github.com/1Password/shell-plugins/sdk/schema/credname"
"github.com/1Password/shell-plugins/sdk/schema/fieldname"
)

func AccessToken() schema.CredentialType {
return schema.CredentialType{
Name: credname.AccessToken,
DocsURL: sdk.URL("https://fly.io/docs/flyctl/auth-login/"),
ManagementURL: sdk.URL("https://fly.io/user/personal_access_tokens"),
Fields: []schema.CredentialField{
{
Name: fieldname.Token,
MarkdownDescription: "Token used to authenticate to Fly.io.",
Secret: true,
Composition: &schema.ValueComposition{
Length: 43,
Charset: schema.Charset{
Uppercase: true,
Lowercase: true,
Digits: true,
Symbols: true,
},
},
},
},
DefaultProvisioner: provision.EnvVars(defaultEnvVarMapping),
Importer: importer.TryAll(
importer.TryEnvVarPair(defaultEnvVarMapping),
TryFlyctlConfigFile(),
)}
}

var defaultEnvVarMapping = map[string]sdk.FieldName{
"FLY_ACCESS_TOKEN": fieldname.Token,
}

func TryFlyctlConfigFile() sdk.Importer {
return importer.TryFile("~/.fly/config.yml", func(ctx context.Context, contents importer.FileContents, in sdk.ImportInput, out *sdk.ImportAttempt) {
var config Config
if err := contents.ToYAML(&config); err != nil {
out.AddError(err)
return
}

if config.Token == "" {
return
}

out.AddCandidate(sdk.ImportCandidate{
Fields: map[sdk.FieldName]string{
fieldname.Token: config.Token,
},
})
})
}

type Config struct {
Token string `yaml:"access_token"`
}
53 changes: 53 additions & 0 deletions plugins/flyctl/access_token_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
package flyctl

import (
"testing"

"github.com/1Password/shell-plugins/sdk"
"github.com/1Password/shell-plugins/sdk/plugintest"
"github.com/1Password/shell-plugins/sdk/schema/fieldname"
)

func TestAccessTokenProvisioner(t *testing.T) {
plugintest.TestProvisioner(t, AccessToken().DefaultProvisioner, map[string]plugintest.ProvisionCase{
"default": {
ItemFields: map[sdk.FieldName]string{
fieldname.Token: "DtP7HoOPOBHMP6bE5tx3nguB5r2zPpSbg9hlEXAMPLE",
},
ExpectedOutput: sdk.ProvisionOutput{
Environment: map[string]string{
"FLY_ACCESS_TOKEN": "DtP7HoOPOBHMP6bE5tx3nguB5r2zPpSbg9hlEXAMPLE",
},
},
},
})
}

func TestAccessTokenImporter(t *testing.T) {
plugintest.TestImporter(t, AccessToken().Importer, map[string]plugintest.ImportCase{
"environment": {
Environment: map[string]string{
"FLY_ACCESS_TOKEN": "DtP7HoOPOBHMP6bE5tx3nguB5r2zPpSbg9hlEXAMPLE",
},
ExpectedCandidates: []sdk.ImportCandidate{
{
Fields: map[sdk.FieldName]string{
fieldname.Token: "DtP7HoOPOBHMP6bE5tx3nguB5r2zPpSbg9hlEXAMPLE",
},
},
},
},
"config file": {
Files: map[string]string{
"~/.fly/config.yml": plugintest.LoadFixture(t, "config.yml"),
},
ExpectedCandidates: []sdk.ImportCandidate{
{
Fields: map[sdk.FieldName]string{
fieldname.Token: "DtP7HoOPOBHMP6bE5tx3nguB5r2zPpSbg9hlEXAMPLE",
},
},
},
},
})
}
22 changes: 22 additions & 0 deletions plugins/flyctl/fly.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package flyctl

import (
"github.com/1Password/shell-plugins/sdk"
"github.com/1Password/shell-plugins/sdk/needsauth"
"github.com/1Password/shell-plugins/sdk/schema"
"github.com/1Password/shell-plugins/sdk/schema/credname"
)

func FlyCLI() schema.Executable {
return schema.Executable{
Name: "Fly",
Runs: []string{"fly"},
DocsURL: sdk.URL("https://fly.io/docs/flyctl/"),
NeedsAuth: needsauth.NotForHelpOrVersion(),
Uses: []schema.CredentialUsage{
{
Name: credname.AccessToken,
},
},
}
}
22 changes: 22 additions & 0 deletions plugins/flyctl/flyctl.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package flyctl

import (
"github.com/1Password/shell-plugins/sdk"
"github.com/1Password/shell-plugins/sdk/needsauth"
"github.com/1Password/shell-plugins/sdk/schema"
"github.com/1Password/shell-plugins/sdk/schema/credname"
)

func FlyctlCLI() schema.Executable {
return schema.Executable{
Name: "Flyctl",
Runs: []string{"flyctl"},
DocsURL: sdk.URL("https://fly.io/docs/flyctl/"),
NeedsAuth: needsauth.NotForHelpOrVersion(),
Uses: []schema.CredentialUsage{
{
Name: credname.AccessToken,
},
},
}
}
23 changes: 23 additions & 0 deletions plugins/flyctl/plugin.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
package flyctl

import (
"github.com/1Password/shell-plugins/sdk"
"github.com/1Password/shell-plugins/sdk/schema"
)

func New() schema.Plugin {
return schema.Plugin{
Name: "flyctl",
Platform: schema.PlatformInfo{
Name: "Fly.io",
Homepage: sdk.URL("https://fly.io"),
},
Credentials: []schema.CredentialType{
AccessToken(),
},
Executables: []schema.Executable{
FlyctlCLI(),
FlyCLI(),
},
}
}
2 changes: 2 additions & 0 deletions plugins/flyctl/test-fixtures/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
access_token: DtP7HoOPOBHMP6bE5tx3nguB5r2zPpSbg9hlEXAMPLE
wire_guard_state: {}

0 comments on commit 5ff6634

Please sign in to comment.