mirror of
https://github.com/k3s-io/kubernetes.git
synced 2026-01-04 23:17:50 +00:00
kubectl: Move utility functions to util package
`parseFileSource()` and `parseLiteralSource()` are utility functions. We have a package already for utility functions, `kubectl/util/`. Move utility functions to `kubectl/util`, capitalize function names to export from package.
This commit is contained in:
tcharding
@@ -1,6 +1,7 @@
|
||||
load(
|
||||
"@io_bazel_rules_go//go:def.bzl",
|
||||
"go_library",
|
||||
"go_test",
|
||||
)
|
||||
|
||||
go_library(
|
||||
@@ -43,3 +44,9 @@ filegroup(
|
||||
tags = ["automanaged"],
|
||||
visibility = ["//build/visible_to:pkg_kubectl_util_CONSUMERS"],
|
||||
)
|
||||
|
||||
go_test(
|
||||
name = "go_default_test",
|
||||
srcs = ["util_test.go"],
|
||||
library = ":go_default_library",
|
||||
)
|
||||
|
||||
@@ -18,7 +18,10 @@ package util
|
||||
|
||||
import (
|
||||
"crypto/md5"
|
||||
"errors"
|
||||
"fmt"
|
||||
"path"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
@@ -44,3 +47,45 @@ func HashObject(obj runtime.Object, codec runtime.Codec) (string, error) {
|
||||
}
|
||||
return fmt.Sprintf("%x", md5.Sum(data)), nil
|
||||
}
|
||||
|
||||
// ParseFileSource parses the source given.
|
||||
//
|
||||
// Acceptable formats include:
|
||||
// 1. source-path: the basename will become the key name
|
||||
// 2. source-name=source-path: the source-name will become the key name and
|
||||
// source-path is the path to the key file.
|
||||
//
|
||||
// Key names cannot include '='.
|
||||
func ParseFileSource(source string) (keyName, filePath string, err error) {
|
||||
numSeparators := strings.Count(source, "=")
|
||||
switch {
|
||||
case numSeparators == 0:
|
||||
return path.Base(source), source, nil
|
||||
case numSeparators == 1 && strings.HasPrefix(source, "="):
|
||||
return "", "", fmt.Errorf("key name for file path %v missing.", strings.TrimPrefix(source, "="))
|
||||
case numSeparators == 1 && strings.HasSuffix(source, "="):
|
||||
return "", "", fmt.Errorf("file path for key name %v missing.", strings.TrimSuffix(source, "="))
|
||||
case numSeparators > 1:
|
||||
return "", "", errors.New("Key names or file paths cannot contain '='.")
|
||||
default:
|
||||
components := strings.Split(source, "=")
|
||||
return components[0], components[1], nil
|
||||
}
|
||||
}
|
||||
|
||||
// ParseLiteralSource parses the source key=val pair into its component pieces.
|
||||
// This functionality is distinguished from strings.SplitN(source, "=", 2) since
|
||||
// it returns an error in the case of empty keys, values, or a missing equals sign.
|
||||
func ParseLiteralSource(source string) (keyName, value string, err error) {
|
||||
// leading equal is invalid
|
||||
if strings.Index(source, "=") == 0 {
|
||||
return "", "", fmt.Errorf("invalid literal source %v, expected key=value", source)
|
||||
}
|
||||
// split after the first equal (so values can have the = character)
|
||||
items := strings.SplitN(source, "=", 2)
|
||||
if len(items) != 2 {
|
||||
return "", "", fmt.Errorf("invalid literal source %v, expected key=value", source)
|
||||
}
|
||||
|
||||
return items[0], items[1], nil
|
||||
}
|
||||
|
||||
198
pkg/kubectl/util/util_test.go
Normal file
198
pkg/kubectl/util/util_test.go
Normal file
@@ -0,0 +1,198 @@
|
||||
/*
|
||||
Copyright 2016 The Kubernetes Authors.
|
||||
|
||||
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 util
|
||||
|
||||
import "testing"
|
||||
|
||||
func TestParseFileSource(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
input string
|
||||
key string
|
||||
filepath string
|
||||
err bool
|
||||
}{
|
||||
{
|
||||
name: "success 1",
|
||||
input: "boo=zoo",
|
||||
key: "boo",
|
||||
filepath: "zoo",
|
||||
err: false,
|
||||
},
|
||||
{
|
||||
name: "success 2",
|
||||
input: "boo=/path/to/zoo",
|
||||
key: "boo",
|
||||
filepath: "/path/to/zoo",
|
||||
err: false,
|
||||
},
|
||||
{
|
||||
name: "success 3",
|
||||
input: "boo-2=/1/2/3/4/5/zab.txt",
|
||||
key: "boo-2",
|
||||
filepath: "/1/2/3/4/5/zab.txt",
|
||||
err: false,
|
||||
},
|
||||
{
|
||||
name: "success 4",
|
||||
input: "boo-=this/seems/weird.txt",
|
||||
key: "boo-",
|
||||
filepath: "this/seems/weird.txt",
|
||||
err: false,
|
||||
},
|
||||
{
|
||||
name: "success 5",
|
||||
input: "-key=some/path",
|
||||
key: "-key",
|
||||
filepath: "some/path",
|
||||
err: false,
|
||||
},
|
||||
{
|
||||
name: "invalid 1",
|
||||
input: "key==some/path",
|
||||
err: true,
|
||||
},
|
||||
{
|
||||
name: "invalid 2",
|
||||
input: "=key=some/path",
|
||||
err: true,
|
||||
},
|
||||
{
|
||||
name: "invalid 3",
|
||||
input: "==key=/some/other/path",
|
||||
err: true,
|
||||
},
|
||||
{
|
||||
name: "invalid 4",
|
||||
input: "=key",
|
||||
err: true,
|
||||
},
|
||||
{
|
||||
name: "invalid 5",
|
||||
input: "key=",
|
||||
err: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
key, filepath, err := ParseFileSource(tc.input)
|
||||
if err != nil {
|
||||
if tc.err {
|
||||
continue
|
||||
}
|
||||
|
||||
t.Errorf("%v: unexpected error: %v", tc.name, err)
|
||||
continue
|
||||
}
|
||||
|
||||
if tc.err {
|
||||
t.Errorf("%v: unexpected success", tc.name)
|
||||
continue
|
||||
}
|
||||
|
||||
if e, a := tc.key, key; e != a {
|
||||
t.Errorf("%v: expected key %v; got %v", tc.name, e, a)
|
||||
continue
|
||||
}
|
||||
|
||||
if e, a := tc.filepath, filepath; e != a {
|
||||
t.Errorf("%v: expected filepath %v; got %v", tc.name, e, a)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseLiteralSource(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
input string
|
||||
key string
|
||||
value string
|
||||
err bool
|
||||
}{
|
||||
{
|
||||
name: "success 1",
|
||||
input: "key=value",
|
||||
key: "key",
|
||||
value: "value",
|
||||
err: false,
|
||||
},
|
||||
{
|
||||
name: "success 2",
|
||||
input: "key=value/with/slashes",
|
||||
key: "key",
|
||||
value: "value/with/slashes",
|
||||
err: false,
|
||||
},
|
||||
{
|
||||
name: "err 1",
|
||||
input: "key==value",
|
||||
key: "key",
|
||||
value: "=value",
|
||||
err: false,
|
||||
},
|
||||
{
|
||||
name: "err 2",
|
||||
input: "key=value=",
|
||||
key: "key",
|
||||
value: "value=",
|
||||
err: false,
|
||||
},
|
||||
{
|
||||
name: "err 3",
|
||||
input: "key2=value==",
|
||||
key: "key2",
|
||||
value: "value==",
|
||||
err: false,
|
||||
},
|
||||
{
|
||||
name: "err 4",
|
||||
input: "==key",
|
||||
err: true,
|
||||
},
|
||||
{
|
||||
name: "err 5",
|
||||
input: "=key=",
|
||||
err: true,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
key, value, err := ParseLiteralSource(tc.input)
|
||||
if err != nil {
|
||||
if tc.err {
|
||||
continue
|
||||
}
|
||||
|
||||
t.Errorf("%v: unexpected error: %v", tc.name, err)
|
||||
continue
|
||||
}
|
||||
|
||||
if tc.err {
|
||||
t.Errorf("%v: unexpected success", tc.name)
|
||||
continue
|
||||
}
|
||||
|
||||
if e, a := tc.key, key; e != a {
|
||||
t.Errorf("%v: expected key %v; got %v", tc.name, e, a)
|
||||
continue
|
||||
}
|
||||
|
||||
if e, a := tc.value, value; e != a {
|
||||
t.Errorf("%v: expected value %v; got %v", tc.name, e, a)
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user