Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions plugins/travis/access_token.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
package travis

import (
"context"
"net/url"

"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://developer.travis-ci.com/authentication"),
ManagementURL: sdk.URL("https://app.travis-ci.com/account/preferences"),
Fields: []schema.CredentialField{
{
Name: fieldname.Token,
MarkdownDescription: "Token used to authenticate to Travis CI.",
Secret: true,
Composition: &schema.ValueComposition{
Length: 22,
Charset: schema.Charset{
Uppercase: true,
Lowercase: true,
Digits: true,
},
},
},
},
DefaultProvisioner: provision.EnvVars(defaultEnvVarMapping),
Importer: importer.TryAll(
importer.TryEnvVarPair(defaultEnvVarMapping),
TryTravisCIConfigFile(),
)}
}

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

func TryTravisCIConfigFile() sdk.Importer {
return importer.TryFile("~/.travis/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
}

for endpoint, endpointConfig := range config.Endpoints {
if endpointConfig.AccessToken == "" {
continue
}

nameHint := endpoint
if parsed, err := url.Parse(endpoint); err == nil && parsed.Host != "" {
nameHint = parsed.Host
}

out.AddCandidate(sdk.ImportCandidate{
Fields: map[sdk.FieldName]string{
fieldname.Token: endpointConfig.AccessToken,
},
NameHint: importer.SanitizeNameHint(nameHint),
})
}
})
}

type Config struct {
Endpoints map[string]Endpoint `yaml:"endpoints"`
}

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

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: "qxNQCrHk8EyjsK5EXAMPLE",
},
ExpectedOutput: sdk.ProvisionOutput{
Environment: map[string]string{
"TRAVIS_TOKEN": "qxNQCrHk8EyjsK5EXAMPLE",
},
},
},
})
}

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

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

func New() schema.Plugin {
return schema.Plugin{
Name: "travis",
Platform: schema.PlatformInfo{
Name: "Travis CI",
Homepage: sdk.URL("https://www.travis-ci.com"),
},
Credentials: []schema.CredentialType{
AccessToken(),
},
Executables: []schema.Executable{
TravisCICLI(),
},
}
}
3 changes: 3 additions & 0 deletions plugins/travis/test-fixtures/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
endpoints:
https://api.travis-ci.com/:
access_token: qxNQCrHk8EyjsK5EXAMPLE
25 changes: 25 additions & 0 deletions plugins/travis/travis.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package travis

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 TravisCICLI() schema.Executable {
return schema.Executable{
Name: "Travis CI CLI",
Runs: []string{"travis"},
DocsURL: sdk.URL("https://github.com/travis-ci/travis.rb"),
NeedsAuth: needsauth.IfAll(
needsauth.NotForHelpOrVersion(),
needsauth.NotWithoutArgs(),
),
Uses: []schema.CredentialUsage{
{
Name: credname.AccessToken,
},
},
}
}