mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
3c405da087
Store service credentials securely in the stores supported by docker: - https://github.com/docker/docker-credential-helpers#available-programs Introduces a top-level config property, "secretStore" and additional command line arguments to manage the stored secrets. The value of secretStore is used to find a helper command, `docker-credential-<secretStore>`. The docker project currently provides 4 store helpers: - "osxkeychain" (OS X only) - "secretservice" (Linux only) - "wincred" (Windows only) - "pass" (any OS supporting pass, which uses gpg2) Docker-for-desktop installs the credential helpers above, as well as "desktop" (docker-credential-desktop). Generic installation instructions for the helpers: - https://github.com/docker/docker-credential-helpers#installation Users could provide additional helpers, the only requirement is that the helper implements the credential store protocol: - https://github.com/docker/docker-credential-helpers#development The credential protocol is open, and new credential stores can be implemented by any CLI satisfying the protocol: - https://github.com/docker/docker-credential-helpers#development The modifications to existing modules is not tested due to lack of API keys, but demonstrates the unobtrusive changes required to use the secret store.
79 lines
2.8 KiB
Go
79 lines
2.8 KiB
Go
package github
|
||
|
||
import (
|
||
"os"
|
||
|
||
"github.com/olebedev/config"
|
||
"github.com/wtfutil/wtf/cfg"
|
||
)
|
||
|
||
const (
|
||
defaultFocusable = true
|
||
defaultTitle = "GitHub"
|
||
)
|
||
|
||
// Settings defines the configuration properties for this module
|
||
type Settings struct {
|
||
common *cfg.Common
|
||
|
||
apiKey string `help:"Your GitHub API token."`
|
||
baseURL string `help:"Your GitHub Enterprise API URL." optional:"true"`
|
||
customQueries []customQuery `help:"Custom queries allow you to filter pull requests and issues however you like. Give the query a title and a filter. Filters can be copied directly from GitHub’s UI." optional:"true"`
|
||
enableStatus bool `help:"Display pull request mergeability status (‘dirty’, ‘clean’, ‘unstable’, ‘blocked’)." optional:"true"`
|
||
repositories []string `help:"A list of github repositories." values:"Example: wtfutil/wtf"`
|
||
uploadURL string `help:"Your GitHub Enterprise upload URL (often the same as API URL)." optional:"true"`
|
||
username string `help:"Your GitHub username. Used to figure out which review requests you’ve been added to."`
|
||
}
|
||
|
||
type customQuery struct {
|
||
title string `help:"Display title for this query"`
|
||
filter string `help:"Github query filter"`
|
||
perPage int `help:"Number of issues to show"`
|
||
}
|
||
|
||
// NewSettingsFromYAML creates a new settings instance from a YAML config block
|
||
func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings {
|
||
settings := Settings{
|
||
common: cfg.NewCommonSettingsFromModule(name, defaultTitle, defaultFocusable, ymlConfig, globalConfig),
|
||
|
||
apiKey: ymlConfig.UString("apiKey", ymlConfig.UString("apikey", os.Getenv("WTF_GITHUB_TOKEN"))),
|
||
baseURL: ymlConfig.UString("baseURL", os.Getenv("WTF_GITHUB_BASE_URL")),
|
||
enableStatus: ymlConfig.UBool("enableStatus", false),
|
||
uploadURL: ymlConfig.UString("uploadURL", os.Getenv("WTF_GITHUB_UPLOAD_URL")),
|
||
username: ymlConfig.UString("username"),
|
||
}
|
||
settings.repositories = cfg.ParseAsMapOrList(ymlConfig, "repositories")
|
||
settings.customQueries = parseCustomQueries(ymlConfig)
|
||
|
||
cfg.ModuleSecret(name, globalConfig, &settings.apiKey).
|
||
Service(settings.baseURL).Load()
|
||
|
||
return &settings
|
||
}
|
||
|
||
/* -------------------- Unexported Functions -------------------- */
|
||
|
||
func parseCustomQueries(ymlConfig *config.Config) []customQuery {
|
||
result := []customQuery{}
|
||
if customQueries, err := ymlConfig.Map("customQueries"); err == nil {
|
||
for _, query := range customQueries {
|
||
c := customQuery{}
|
||
for key, value := range query.(map[string]interface{}) {
|
||
switch key {
|
||
case "title":
|
||
c.title = value.(string)
|
||
case "filter":
|
||
c.filter = value.(string)
|
||
case "perPage":
|
||
c.perPage = value.(int)
|
||
}
|
||
}
|
||
|
||
if c.title != "" && c.filter != "" {
|
||
result = append(result, c)
|
||
}
|
||
}
|
||
}
|
||
return result
|
||
}
|