joao/cmd/get.go

// Copyright © 2022 Roberto Hidalgo <joao@un.rob.mx>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cmd

import (
	"encoding/json"
	"fmt"
	"io/ioutil"
	"strings"

	"git.rob.mx/nidito/joao/internal/command"
	"git.rob.mx/nidito/joao/internal/registry"
	"git.rob.mx/nidito/joao/pkg/config"
	"github.com/spf13/cobra"
	"gopkg.in/yaml.v3"
)

func init() {
	registry.Register(gCommand)
}

func keyFinder(cmd *command.Command, currentValue string) ([]string, cobra.ShellCompDirective, error) {
	flag := cobra.ShellCompDirectiveError
	file := cmd.Arguments[0].ToString()
	buf, err := ioutil.ReadFile(file)
	if err != nil {
		return nil, flag, fmt.Errorf("could not read file %s", file)
	}

	keys, err := config.KeysFromYAML(buf)
	if err != nil {
		return nil, flag, err
	}

	return keys, cobra.ShellCompDirectiveDefault, nil
}

var gCommand = (&command.Command{
	Path:    []string{"get"},
	Summary: "retrieves configuration",
	Description: `
looks at the filesystem or remotely, using 1password (over the CLI if available, or 1password-connect, if configured).

## output formats

- **raw**:
  - when querying for scalar values this will return a non-quoted version of the values
  - when querying for trees or lists, this will output JSON
- **yaml**: formats the value at the given path as YAML
- **json**: formats the value at the given path as JSON
- **op**: formats the whole configuration as a 1Password item`,
	Arguments: command.Arguments{
		{
			Name:        "config",
			Description: "The configuration to get from",
			Required:    true,
			Values: &command.ValueSource{
				Files: &[]string{"yaml", "yml"},
			},
		},
		{
			Name:        "path",
			Default:     ".",
			Description: "A dot-delimited path to extract from CONFIG",
			Values: &command.ValueSource{
				Func: func(cmd *command.Command, currentValue string) (values []string, flag cobra.ShellCompDirective, err error) {
					opts := map[string]bool{".": true}
					options, flag, err := keyFinder(cmd, currentValue)
					for _, opt := range options {
						parts := strings.Split(opt, ".")
						sub := []string{parts[0]}
						for idx, p := range parts {
							key := strings.Join(sub, ".")
							opts[key] = true

							if idx > 0 && idx < len(parts)-1 {
								sub = append(sub, p)
							}
						}
					}

					for k := range opts {
						options = append(options, k)
					}
					return options, flag, err
				},
			},
		},
	},
	Options: command.Options{
		"output": {
			ShortName:   "o",
			Description: "the format to use for rendering output",
			Default:     "raw",
			Values: &command.ValueSource{
				Static: &[]string{"raw", "json", "yaml", "op"},
			},
		},
		"redacted": {
			Description: "Do not print secret values",
			Type:        "bool",
		},
		"remote": {
			Description: "Get values from 1password",
			Type:        "bool",
		},
	},
	Action: func(cmd *command.Command) error {
		path := cmd.Arguments[0].ToValue().(string)
		query := cmd.Arguments[1].ToValue().(string)

		remote := cmd.Options["remote"].ToValue().(bool)
		format := cmd.Options["output"].ToValue().(string)
		redacted := cmd.Options["redacted"].ToValue().(bool)

		cfg, err := config.Load(path, remote)
		if err != nil {
			return err
		}

		if query == "" || query == "." {
			switch format {
			case "yaml", "raw":
				bytes, err := cfg.AsYAML(redacted)
				if err != nil {
					return err
				}
				_, err = cmd.Cobra.OutOrStdout().Write(bytes)
				return err
			case "json", "op":
				bytes, err := cfg.AsJSON(redacted, format == "op")
				if err != nil {
					return err
				}
				_, err = cmd.Cobra.OutOrStdout().Write(bytes)
				return err
			}
			return fmt.Errorf("unknown format %s", format)
		}

		parts := strings.Split(query, ".")

		entry := cfg.Tree
		for _, part := range parts {
			entry = entry.ChildNamed(part)
			if entry == nil {
				return fmt.Errorf("value not found at %s of %s", part, query)
			}
		}

		var bytes []byte
		if len(entry.Content) > 0 {
			val := entry.AsMap()
			if format == "yaml" {
				enc := yaml.NewEncoder(cmd.Cobra.OutOrStdout())
				enc.SetIndent(2)
				return enc.Encode(val)
			}

			bytes, err = json.Marshal(val)
			if err != nil {
				return err
			}
		} else {
			bytes = []byte(entry.String())
		}

		_, err = cmd.Cobra.OutOrStdout().Write(bytes)
		return err
	},
}).SetBindings()