pulumi/pkg/resource/config/key.go
Matt Ellis 731463c282 Have MakeKey fail if namespace contains a colon
This helper method is only really used for testing, but we should not
allow it to create a Key who's namespace has a colon (as ParseKey
would not build something like this).
2018-03-08 11:52:48 -08:00

118 lines
2.4 KiB
Go

// Copyright 2016-2018, Pulumi Corporation. All rights reserved.
package config
import (
"encoding/json"
"strings"
"github.com/pkg/errors"
"github.com/pulumi/pulumi/pkg/tokens"
"github.com/pulumi/pulumi/pkg/util/contract"
)
type Key struct {
namespace string
name string
}
// MustMakeKey constructs a config.Key for a given namespace and name. The namespace may not contain a `:`
func MustMakeKey(namespace string, name string) Key {
contract.Requiref(!strings.Contains(":", namespace), "namespace", "may not contain a colon")
return Key{namespace: namespace, name: name}
}
func ParseKey(s string) (Key, error) {
mm, err := tokens.ParseModuleMember(s)
if err == nil {
return fromModuleMember(mm)
}
if idx := strings.Index(s, ":"); idx > -1 {
return Key{namespace: s[:idx], name: s[idx+1:]}, nil
}
return Key{}, errors.Errorf("could not parse %s as a configuration key", s)
}
func fromModuleMember(m tokens.ModuleMember) (Key, error) {
if m.Module().Name() != tokens.ModuleName("config") {
return Key{}, errors.Errorf("%s is not in config module", m)
}
return Key{
namespace: m.Module().Package().String(),
name: m.Name().String(),
}, nil
}
func (k Key) Namespace() string {
return k.namespace
}
func (k Key) Name() string {
return k.name
}
func (k Key) MarshalJSON() ([]byte, error) {
return json.Marshal(k.String())
}
func (k *Key) UnmarshalJSON(b []byte) error {
var s string
if err := json.Unmarshal(b, &s); err != nil {
return errors.Wrap(err, "could not unmarshal key")
}
pk, err := ParseKey(s)
if err != nil {
return err
}
k.namespace = pk.namespace
k.name = pk.name
return nil
}
func (k Key) MarshalYAML() (interface{}, error) {
return k.String(), nil
}
func (k *Key) UnmarshalYAML(unmarshal func(interface{}) error) error {
var s string
if err := unmarshal(&s); err != nil {
return errors.Wrap(err, "could not unmarshal key")
}
pk, err := ParseKey(s)
if err != nil {
return err
}
k.namespace = pk.namespace
k.name = pk.name
return nil
}
func (k Key) String() string {
return k.namespace + ":" + k.name
}
type KeyArray []Key
func (k KeyArray) Len() int {
return len(k)
}
func (k KeyArray) Less(i int, j int) bool {
if k[i].namespace != k[j].namespace {
return strings.Compare(k[i].namespace, k[j].namespace) == -1
}
return strings.Compare(k[i].name, k[j].name) == -1
}
func (k KeyArray) Swap(i int, j int) {
k[i], k[j] = k[j], k[i]
}