diff --git a/cmd/config/internal/commands/e2e/e2e_test.go b/cmd/config/internal/commands/e2e/e2e_test.go index 93a39427d..a324eea87 100644 --- a/cmd/config/internal/commands/e2e/e2e_test.go +++ b/cmd/config/internal/commands/e2e/e2e_test.go @@ -638,14 +638,6 @@ func build(t *testing.T, binDir string) { if !assert.NoError(t, build.Run()) { t.FailNow() } - build = exec.Command("go", "build", "-o", - filepath.Join(binDir, "e2econtainerflags")) - build.Dir = "e2econtainerflags" - build.Stdout = os.Stdout - build.Stderr = os.Stderr - if !assert.NoError(t, build.Run()) { - t.FailNow() - } build = exec.Command("go", "build", "-o", filepath.Join(binDir, "kyaml")) build.Dir = filepath.Join("..", "..", "..") @@ -666,12 +658,4 @@ func build(t *testing.T, binDir string) { if !assert.NoError(t, build.Run()) { t.FailNow() } - build = exec.Command( - "docker", "build", ".", "-t", "gcr.io/kustomize-functions/e2econtainerflags") - build.Dir = "e2econtainerflags" - build.Stdout = os.Stdout - build.Stderr = os.Stderr - if !assert.NoError(t, build.Run()) { - t.FailNow() - } } diff --git a/cmd/config/internal/commands/e2e/e2econtainerconfig/doc.go b/cmd/config/internal/commands/e2e/e2econtainerconfig/doc.go new file mode 100644 index 000000000..610a6b9b6 --- /dev/null +++ b/cmd/config/internal/commands/e2e/e2econtainerconfig/doc.go @@ -0,0 +1,9 @@ +// Package main contains a function to be used for e2e testing. +// +// The function is written using the framework, and parses the ResourceList.functionConfig +// into a go struct. +// +// The function will set 3 annotations on each resource. +// +// See https://github.com/kubernetes-sigs/kustomize/blob/master/cmd/config/docs/api-conventions/functions-spec.md +package main diff --git a/cmd/config/internal/commands/e2e/e2econtainerconfig/main.go b/cmd/config/internal/commands/e2e/e2econtainerconfig/main.go index fb0d940f4..0e7fe0994 100644 --- a/cmd/config/internal/commands/e2e/e2econtainerconfig/main.go +++ b/cmd/config/internal/commands/e2e/e2econtainerconfig/main.go @@ -11,18 +11,25 @@ import ( "sigs.k8s.io/kustomize/kyaml/yaml" ) +// Data contains the items +type Data struct { + StringValue string `yaml:"stringValue,omitempty"` + + IntValue int `yaml:"intValue,omitempty"` + + BoolValue bool `yaml:"boolValue,omitempty"` +} + +// Example defines the ResourceList.functionConfig schema. +type Example struct { + // Data contains configuration data for the Example + // Nest values under Data so that the function can accept a ConfigMap as its + // functionConfig (`run` generates a ConfigMap for the functionConfig when run with --) + Data Data `yaml:"data,omitempty"` +} + func main() { - type Data struct { - StringValue string `yaml:"stringValue,omitempty"` - - IntValue int `yaml:"intValue,omitempty"` - - BoolValue bool `yaml:"boolValue,omitempty"` - } - type ExampleServiceGenerator struct { - Data Data `yaml:"data,omitempty"` - } - functionConfig := &ExampleServiceGenerator{} + functionConfig := &Example{} cmd := framework.Command(functionConfig, func(items []*yaml.RNode) ([]*yaml.RNode, error) { for i := range items { diff --git a/cmd/config/internal/commands/e2e/e2econtainerflags/Dockerfile b/cmd/config/internal/commands/e2e/e2econtainerflags/Dockerfile deleted file mode 100644 index d177d7df1..000000000 --- a/cmd/config/internal/commands/e2e/e2econtainerflags/Dockerfile +++ /dev/null @@ -1,12 +0,0 @@ -# Copyright 2019 The Kubernetes Authors. -# SPDX-License-Identifier: Apache-2.0 - -FROM golang:1.13-stretch -ENV CGO_ENABLED=0 -WORKDIR /go/src/ -COPY . . -RUN go build -v -o /usr/local/bin/function ./ - -FROM alpine:latest -COPY --from=0 /usr/local/bin/function /usr/local/bin/function -CMD ["function"] diff --git a/cmd/config/internal/commands/e2e/e2econtainerflags/Makefile b/cmd/config/internal/commands/e2e/e2econtainerflags/Makefile deleted file mode 100644 index 1facfd568..000000000 --- a/cmd/config/internal/commands/e2e/e2econtainerflags/Makefile +++ /dev/null @@ -1,13 +0,0 @@ -# Copyright 2019 The Kubernetes Authors. -# SPDX-License-Identifier: Apache-2.0 - -.PHONY: generate license fix vet fmt test build tidy - -GOBIN := $(shell go env GOPATH)/bin - -test: - go test - -image: - docker build . -t gcr.io/kustomize-functions/e2econtainerflags - docker push gcr.io/kustomize-functions/e2econtainerflags diff --git a/cmd/config/internal/commands/e2e/e2econtainerflags/go.mod b/cmd/config/internal/commands/e2e/e2econtainerflags/go.mod deleted file mode 100644 index 31918cfff..000000000 --- a/cmd/config/internal/commands/e2e/e2econtainerflags/go.mod +++ /dev/null @@ -1,5 +0,0 @@ -module sigs.k8s.io/kustomize/cmd/config/internal/commands/e2e/e2econtainerflags - -go 1.14 - -require sigs.k8s.io/kustomize/kyaml v0.1.9-0.20200501190629-f7909fad7167 diff --git a/cmd/config/internal/commands/e2e/e2econtainerflags/go.sum b/cmd/config/internal/commands/e2e/e2econtainerflags/go.sum deleted file mode 100644 index 9b24e7434..000000000 --- a/cmd/config/internal/commands/e2e/e2econtainerflags/go.sum +++ /dev/null @@ -1,186 +0,0 @@ -cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= -github.com/360EntSecGroup-Skylar/excelize v1.4.1/go.mod h1:vnax29X2usfl7HHkBrX5EvSCJcmH3dT9luvxzu8iGAE= -github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= -github.com/OneOfOne/xxhash v1.2.2/go.mod h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAElWljhcU= -github.com/PuerkitoBio/goquery v1.5.0/go.mod h1:qD2PgZ9lccMbQlc7eEOjaeRlFQON7xY8kdmcsrnKqMg= -github.com/PuerkitoBio/purell v1.1.1 h1:WEQqlqaGbrPkxLJWfBwQmfEAE1Z7ONdDLqrN38tNFfI= -github.com/PuerkitoBio/purell v1.1.1/go.mod h1:c11w/QuzBsJSee3cPx9rAFu61PvFxuPbtSwDGJws/X0= -github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 h1:d+Bc7a5rLufV/sSk/8dngufqelfh6jnri85riMAaF/M= -github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578/go.mod h1:uGdkoq3SwY9Y+13GIhn11/XLaGBb4BfwItxLd5jeuXE= -github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= -github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= -github.com/andybalholm/cascadia v1.0.0/go.mod h1:GsXiBklL0woXo1j/WYWtSYYC4ouU9PqHO0sqidkEA4Y= -github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8= -github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q= -github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8= -github.com/cespare/xxhash v1.1.0/go.mod h1:XrSqR1VqqWfGrhpAt58auRo0WTKS1nRRg3ghfAqPWnc= -github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI= -github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI= -github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU= -github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw= -github.com/coreos/bbolt v1.3.2/go.mod h1:iRUV2dpdMOn7Bo10OQBFzIJO9kkE559Wcmn+qkEiiKk= -github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE= -github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk= -github.com/coreos/go-systemd v0.0.0-20190321100706-95778dfbb74e/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4= -github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA= -github.com/cpuguy83/go-md2man/v2 v2.0.0/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= -github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= -github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= -github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= -github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ= -github.com/dgryski/go-sip13 v0.0.0-20181026042036-e10d5fee7954/go.mod h1:vAd38F8PWV+bWy6jNmig1y/TA+kYO4g3RSRF0IAv0no= -github.com/dustmop/soup v1.1.2-0.20190516214245-38228baa104e/go.mod h1:CgNC6SGbT+Xb8wGGvzilttZL1mc5sQ/5KkcxsZttMIk= -github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= -github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04= -github.com/go-errors/errors v1.0.1 h1:LUHzmkK3GUKUrL/1gfBUxAHzcev3apQlezX/+O7ma6w= -github.com/go-errors/errors v1.0.1/go.mod h1:f4zRHt4oKfwPJE5k8C9vpYG+aDHdBFUsgrm6/TyX73Q= -github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as= -github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE= -github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk= -github.com/go-openapi/jsonpointer v0.19.2/go.mod h1:3akKfEdA7DF1sugOqz1dVQHBcuDBPKZGEoHC/NkiQRg= -github.com/go-openapi/jsonpointer v0.19.3 h1:gihV7YNZK1iK6Tgwwsxo2rJbD1GTbdm72325Bq8FI3w= -github.com/go-openapi/jsonpointer v0.19.3/go.mod h1:Pl9vOtqEWErmShwVjC8pYs9cog34VGT37dQOVbmoatg= -github.com/go-openapi/jsonreference v0.19.2 h1:o20suLFB4Ri0tuzpWtyHlh7E7HnkqTNLq6aR6WVNS1w= -github.com/go-openapi/jsonreference v0.19.2/go.mod h1:jMjeRr2HHw6nAVajTXJ4eiUwohSTlpa0o73RUL1owJc= -github.com/go-openapi/spec v0.19.5 h1:Xm0Ao53uqnk9QE/LlYV5DEU09UAgpliA85QoT9LzqPw= -github.com/go-openapi/spec v0.19.5/go.mod h1:Hm2Jr4jv8G1ciIAo+frC/Ft+rR2kQDh8JHKHb3gWUSk= -github.com/go-openapi/swag v0.19.2/go.mod h1:POnQmlKehdgb5mhVOsnJFsivZCEZ/vjK9gh66Z9tfKk= -github.com/go-openapi/swag v0.19.5 h1:lTz6Ys4CmqqCQmZPBlbQENR1/GucA2bzYTE12Pw4tFY= -github.com/go-openapi/swag v0.19.5/go.mod h1:POnQmlKehdgb5mhVOsnJFsivZCEZ/vjK9gh66Z9tfKk= -github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= -github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= -github.com/gogo/protobuf v1.2.1/go.mod h1:hp+jE20tsWTFYpLwKvXlhS1hjn+gTNwPg2I6zVXpSg4= -github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= -github.com/golang/groupcache v0.0.0-20190129154638-5b532d6fd5ef/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= -github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= -github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= -github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= -github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ= -github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= -github.com/gorilla/websocket v1.4.0/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ= -github.com/grpc-ecosystem/go-grpc-middleware v1.0.0/go.mod h1:FiyG127CGDf3tlThmgyCl78X/SZQqEOJBCDaAfeWzPs= -github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0/go.mod h1:8NvIoxWQoOIhqOTXgfV/d3M/q6VIi02HzZEHgUlZvzk= -github.com/grpc-ecosystem/grpc-gateway v1.9.0/go.mod h1:vNeuVxBJEsws4ogUvrchl83t/GYV9WGTSLVdBhOQFDY= -github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ= -github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8= -github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo= -github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w= -github.com/kisielk/errcheck v1.1.0/go.mod h1:EZBBE59ingxPouuu3KfxchcWSUPOHkagtvWXihfKN4Q= -github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= -github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= -github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc= -github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= -github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= -github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= -github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ= -github.com/mailru/easyjson v0.0.0-20190614124828-94de47d64c63/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= -github.com/mailru/easyjson v0.0.0-20190626092158-b2ccc519800e h1:hB2xlXdHp/pmPZq0y3QnmWAArdw9PqbmotexnWx/FU8= -github.com/mailru/easyjson v0.0.0-20190626092158-b2ccc519800e/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= -github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0= -github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0= -github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y= -github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826/go.mod h1:TaXosZuwdSHYgviHp1DAtfrULt5eUgsSMsZf+YrPgl8= -github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= -github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U= -github.com/paulmach/orb v0.1.3/go.mod h1:VFlX/8C+IQ1p6FTRRKzKoOPJnvEtA5G0Veuqwbu//Vk= -github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic= -github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= -github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= -github.com/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw= -github.com/prometheus/client_golang v0.9.3/go.mod h1:/TN21ttK/J9q6uSwhBd54HahCDft0ttaMvbicHlPoso= -github.com/prometheus/client_model v0.0.0-20180712105110-5c3871d89910/go.mod h1:MbSGuTsp3dbXC40dX6PRTWyKYBIrTGTE9sqQNg2J8bo= -github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= -github.com/prometheus/common v0.0.0-20181113130724-41aa239b4cce/go.mod h1:daVV7qP5qjZbuso7PdcryaAu0sAZbrN9i7WWcTMWvro= -github.com/prometheus/common v0.4.0/go.mod h1:TNfzLD0ON7rHzMJeJkieUDPYmFC7Snx/y86RQel1bk4= -github.com/prometheus/procfs v0.0.0-20181005140218-185b4288413d/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk= -github.com/prometheus/procfs v0.0.0-20190507164030-5867b95ac084/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA= -github.com/prometheus/tsdb v0.7.1/go.mod h1:qhTCs0VvXwvX/y3TZrWD7rabWM+ijKTux40TwIPHuXU= -github.com/qri-io/starlib v0.4.2-0.20200213133954-ff2e8cd5ef8d/go.mod h1:7DPO4domFU579Ga6E61sB9VFNaniPVwJP5C4bBCu3wA= -github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg= -github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= -github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= -github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= -github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= -github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4kGIyLM= -github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA= -github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ= -github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE= -github.com/spf13/cobra v1.0.0 h1:6m/oheQuQ13N9ks4hubMG6BnvwOeaJrqSPLahSnczz8= -github.com/spf13/cobra v1.0.0/go.mod h1:/6GTrnGXV9HjY+aR4k0oJ5tcvakLuG6EuKReYlHNrgE= -github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo= -github.com/spf13/pflag v1.0.3 h1:zPAT6CGy6wXeQ7NtTnaTerfKOsV6V6F8agHXFiazDkg= -github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= -github.com/spf13/viper v1.4.0/go.mod h1:PTJ7Z/lr49W6bUbkmS1V3by4uWynFiR9p7+dSq/yZzE= -github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= -github.com/stretchr/testify v1.2.3-0.20181224173747-660f15d67dbb/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= -github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= -github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= -github.com/tmc/grpc-websocket-proxy v0.0.0-20190109142713-0ad062ec5ee5/go.mod h1:ncp9v5uamzpCO7NfCPTXjqaC+bZgJeR0sMTm6dMHP7U= -github.com/ugorji/go v1.1.4/go.mod h1:uQMGLiO92mf5W77hV/PUCpI3pbzQx3CRekS0kk+RGrc= -github.com/xiang90/probing v0.0.0-20190116061207-43a291ad63a2/go.mod h1:UETIi67q53MR2AWcXfiuqkDkRtnGDLqkBTpCHuJHxtU= -github.com/xlab/treeprint v0.0.0-20181112141820-a009c3971eca h1:1CFlNzQhALwjS9mBAUkycX616GzgsuYUOCHA5+HSlXI= -github.com/xlab/treeprint v0.0.0-20181112141820-a009c3971eca/go.mod h1:ce1O1j6UtZfjr22oyGxGLbauSBp2YVXpARAosm7dHBg= -github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q= -go.etcd.io/bbolt v1.3.2/go.mod h1:IbVyRI1SCnLcuJnV2u8VeU0CEYM7e686BmAb1XKL+uU= -go.starlark.net v0.0.0-20190528202925-30ae18b8564f/go.mod h1:c1/X6cHgvdXj6pUlmWKMkuqRnW4K8x2vwt6JAaaircg= -go.starlark.net v0.0.0-20200306205701-8dd3e2ee1dd5/go.mod h1:nmDLcffg48OtT/PSW0Hg7FvpRQsQh5OSqIylirxKC7o= -go.uber.org/atomic v1.4.0/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE= -go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0= -go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q= -golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= -golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= -golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= -golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= -golang.org/x/net v0.0.0-20180218175443-cbe0f9307d01/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= -golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= -golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= -golang.org/x/net v0.0.0-20181220203305-927f97764cc3/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= -golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= -golang.org/x/net v0.0.0-20190522155817-f3200d17e092/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= -golang.org/x/net v0.0.0-20190613194153-d28f0bde5980/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= -golang.org/x/net v0.0.0-20190827160401-ba9fcec4b297/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= -golang.org/x/net v0.0.0-20191004110552-13f9640d40b9/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= -golang.org/x/net v0.0.0-20200226121028-0de0cce0169b h1:0mm1VjtFUOIlE1SbDlwjYaDxZVDP2S5ou6y0gSgXHu8= -golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= -golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= -golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= -golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= -golang.org/x/sys v0.0.0-20181107165924-66b7b1311ac8/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= -golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= -golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= -golang.org/x/sys v0.0.0-20191002063906-3421d5a6bb1c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= -golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs= -golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= -golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= -golang.org/x/tools v0.0.0-20180221164845-07fd8470d635/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= -golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= -golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= -golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= -google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= -google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc= -google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c= -google.golang.org/grpc v1.21.0/go.mod h1:oYelfM1adQP15Ek0mdvEgi9Df8B9CZIaU1084ijfRaM= -gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw= -gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= -gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= -gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= -gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo= -gopkg.in/yaml.v2 v2.0.0-20170812160011-eb3733d160e7/go.mod h1:JAlM8MvJe8wmxCU4Bli9HhUf9+ttbYbLASfIpnQbh74= -gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= -gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= -gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= -gopkg.in/yaml.v2 v2.2.7 h1:VUgggvou5XRW9mHwD/yXxIYSMtY0zoKQf/v226p2nyo= -gopkg.in/yaml.v2 v2.2.7/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= -gopkg.in/yaml.v3 v3.0.0-20191120175047-4206685974f2 h1:XZx7nhd5GMaZpmDaEHFVafUZC7ya0fuo7cSJ3UCKYmM= -gopkg.in/yaml.v3 v3.0.0-20191120175047-4206685974f2/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= -honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= -sigs.k8s.io/kustomize/kyaml v0.1.8 h1:s8OZ9Ds5ALjnEldFMEPoOuUxhEPhhdbIg/ExwikxtoM= -sigs.k8s.io/kustomize/kyaml v0.1.8/go.mod h1:461i94nj0h0ylJ6w83jLkR4SqqVhn1iY6fjD0JSTQeE= -sigs.k8s.io/kustomize/kyaml v0.1.9-0.20200501190629-f7909fad7167 h1:138Q3rZVU5mLBF6dFekNuP6D4ZeF4mndI54RBJ8kK8c= -sigs.k8s.io/kustomize/kyaml v0.1.9-0.20200501190629-f7909fad7167/go.mod h1:I4OFZ1vTPdteiqqCBwW3DI0swPzxBpd99y9CHN5IMUU= diff --git a/cmd/config/internal/commands/e2e/e2econtainerflags/main.go b/cmd/config/internal/commands/e2e/e2econtainerflags/main.go deleted file mode 100644 index 0a1213b8c..000000000 --- a/cmd/config/internal/commands/e2e/e2econtainerflags/main.go +++ /dev/null @@ -1,42 +0,0 @@ -// Copyright 2019 The Kubernetes Authors. -// SPDX-License-Identifier: Apache-2.0 - -package main - -import ( - "fmt" - "os" - - "sigs.k8s.io/kustomize/kyaml/fn/framework" - "sigs.k8s.io/kustomize/kyaml/yaml" -) - -func main() { - var stringValue string - var intValue int - var boolValue bool - cmd := framework.Command(nil, func(items []*yaml.RNode) ([]*yaml.RNode, error) { - for i := range items { - // set the annotation on each resource item - if err := items[i].PipeE(yaml.SetAnnotation("b-string-value", stringValue)); err != nil { - return nil, err - } - - if err := items[i].PipeE(yaml.SetAnnotation("b-int-value", fmt.Sprintf("%v", intValue))); err != nil { - return nil, err - } - - if err := items[i].PipeE(yaml.SetAnnotation("b-bool-value", fmt.Sprintf("%v", boolValue))); err != nil { - return nil, err - } - } - return items, nil - }) - cmd.Flags().StringVar(&stringValue, "string-value", "", "annotation value") - cmd.Flags().IntVar(&intValue, "int-value", 0, "annotation value") - cmd.Flags().BoolVar(&boolValue, "bool-value", false, "annotation value") - - if err := cmd.Execute(); err != nil { - os.Exit(1) - } -} diff --git a/cmd/config/internal/commands/run-fns.go b/cmd/config/internal/commands/run-fns.go index 9337c8c96..0a2734e55 100644 --- a/cmd/config/internal/commands/run-fns.go +++ b/cmd/config/internal/commands/run-fns.go @@ -46,8 +46,6 @@ func GetRunFnRunner(name string) *RunFnRunner { &r.EnableExec, "enable-exec", false /*do not change!*/, "enable support for exec functions -- note: exec functions run arbitrary code -- do not use for untrusted configs!!! (Alpha)") r.Command.Flags().StringVar( &r.ExecPath, "exec-path", "", "run an executable as a function. (Alpha)") - r.Command.Flags().StringArrayVar( - &r.ExecArgs, "exec-arg", nil, "arg for executable function. (Alpha)") r.Command.Flags().BoolVar( &r.EnableStar, "enable-star", false, "enable support for starlark functions. (Alpha)") r.Command.Flags().StringVar( @@ -85,7 +83,6 @@ type RunFnRunner struct { StarName string EnableExec bool ExecPath string - ExecArgs []string RunFns runfn.RunFns ResultsDir string Network bool @@ -162,16 +159,6 @@ func (r *RunFnRunner) getContainerFunctions(c *cobra.Command, args, dataItems [] if err != nil { return nil, err } - - // add the arguments - for _, a := range r.ExecArgs { - err = fn.PipeE( - yaml.LookupCreate(yaml.SequenceNode, "exec", "args"), - yaml.Append(yaml.NewScalarRNode(a).YNode())) - if err != nil { - return nil, err - } - } } // create the function config diff --git a/kyaml/fn/framework/doc.go b/kyaml/fn/framework/doc.go index adf83047f..f5b82fd18 100644 --- a/kyaml/fn/framework/doc.go +++ b/kyaml/fn/framework/doc.go @@ -1,54 +1,120 @@ // Copyright 2019 The Kubernetes Authors. // SPDX-License-Identifier: Apache-2.0 -// Package framework contains a framework for writing functions in go. +// Package framework contains a framework for writing functions in go. The function spec +// is defined at: https://github.com/kubernetes-sigs/kustomize/blob/master/cmd/config/docs/api-conventions/functions-spec.md // -// Example +// Examples // -// Example function implementation to set an annotation on each resource. +// Example function implementation using framework.ResourceList with functionConfig // +// type Spec struct { +// Value string `yaml:"value,omitempty"` +// } +// type Example struct { +// Spec Spec `yaml:"spec,omitempty"` +// } +// functionConfig := &Example{} +// +// rl := framework.ResourceList{FunctionConfig: functionConfig} +// if err := rl.Read(); err != nil { return err } +// +// for i := range rl.Items { +// // modify the items... +// } +// if err := rl.Write(); err != nil { return err } +// +// Example function implementation using framework.Command with flags +// +// var value string // cmd := framework.Command(nil, func(items []*yaml.RNode) ([]*yaml.RNode, error) { // for i := range items { -// if err := items[i].PipeE(yaml.SetAnnotation("value", value)); err != nil { -// return nil, err -// } +// // modify the items... // } // return items, nil // }) // cmd.Flags().StringVar(&value, "value", "", "annotation value") -// if err := cmd.Execute(); err != nil { -// panic(err) -// } +// if err := cmd.Execute(); err != nil { return err } // // Architecture // -// Functions are implemented as a go function which accept a slice of resources (items) -// and returns a modified slice of resources (items). +// Functions modify a slice of resources (ResourceList.items) which are read as input and written +// as output. The function itself may be configured through a functionConfig +// (ResourceList.functionConfig). +// +// Example Function Input: +// +// kind: ResourceList +// items: +// - kind: Deployment +// ... +// - kind: Service +// .... +// functionConfig: +// kind: Example +// spec: +// value: foo +// +// The functionConfig may be specified declaratively and run with +// +// config run DIR/ +// +// Declarative function declaration: +// +// kind: Example +// metadata: +// annotations: +// # run the function by creating this container and providing this +// # Example as the functionConfig +// config.kubernetes.io/function: | +// image: image/containing/fuction:impl +// spec: +// value: foo +// +// The framework takes care of serializing and deserializing the ResourceList. +// +// Generated ResourceList.functionConfig -- ConfigMaps +// +// Functions may also be specified imperatively and run using: +// +// config run DIR/ --image image/containing/fuction:impl -- value=foo +// +// When run imperatively, a ConfigMap is generated for the functionConfig, and the command +// arguments are set as ConfigMap data entries. +// +// kind: ConfigMap +// data: +// value: foo +// +// To write a function that can be run imperatively on the commandline, have it take a +// ConfigMap as its functionConfig. // // Mutator and Generator Functions // -// Functions may add, delete or modify resources for the returned slice. +// Functions may add, delete or modify resources by modifying the items slice. +// When using framework.Command this is done through returning the new items slice. +// When using framework.ResourceList this is done through modifying ResourceList.Items in place. // // Validator Functions // -// Functions may validate resources, returning results as go errors. results may contain -// different items for different validation failures. +// A function may validate resources by providing a Result. +// When using framework.Command this is done through returning a framework.Result as an error. +// WHen using framework.ResourceList this is done through setting ResourceList.Result. // // Configuring Functions // // Functions may be configured through a functionConfig (i.e. a client side custom resource), // or through flags (which the framework parses from a ConfigMap provided as input). -// Any flags registered on the cobra.Command will be parsed from the functionConfig input -// if they are defined as functionConfig.data entries. +// +// When using framework.Command, any flags registered on the cobra.Command will be parsed +// from the functionConfig input if they are defined as functionConfig.data entries. +// +// When using framework.ResourceList, any flags set on the ResourceList.Flags will be +// parsed from the functionConfig input if they are defined as functionConfig.data entries. // // Functions may also access environment variables set by the caller. // -// Function Input -// -// The framework parses the function ResourceList.items into a slice of yaml.RNodes, and -// parses the ResourceList.functionConfig into a passed in struct (optional). -// -// Building the Container +// Building a container image for the function // // The go program must be built into a container to be run as a function. The framework // can be used to generate a Dockerfile to build the function container. diff --git a/kyaml/fn/framework/example_test.go b/kyaml/fn/framework/example_test.go index 10f96e1d7..d791eae67 100644 --- a/kyaml/fn/framework/example_test.go +++ b/kyaml/fn/framework/example_test.go @@ -7,10 +7,82 @@ import ( "bytes" "fmt" + "github.com/spf13/pflag" "sigs.k8s.io/kustomize/kyaml/fn/framework" "sigs.k8s.io/kustomize/kyaml/yaml" ) +const service = "Service" + +// ExampleResourceList_modify implements a function that sets an annotation on each resource. +// The annotation value is configured via a flag value parsed from ResourceList.functionConfig.data +func ExampleResourceList_modify() { + // for testing purposes only -- normally read from stdin when Executing + input := bytes.NewBufferString(` +apiVersion: config.kubernetes.io/v1alpha1 +kind: ResourceList +# items are provided as nodes +items: +- apiVersion: apps/v1 + kind: Deployment + metadata: + name: foo +- apiVersion: v1 + kind: Service + metadata: + name: foo +# functionConfig is parsed into flags by framework.Command +functionConfig: + apiVersion: v1 + kind: ConfigMap + data: + value: baz +`) + + // configure the annotation value using a flag parsed from + // ResourceList.functionConfig.data.value + fs := pflag.NewFlagSet("tests", pflag.ContinueOnError) + value := fs.String("value", "", "annotation value") + rl := framework.ResourceList{ + Flags: fs, + Reader: input, // for testing only + } + if err := rl.Read(); err != nil { + panic(err) + } + for i := range rl.Items { + // set the annotation on each resource item + if err := rl.Items[i].PipeE(yaml.SetAnnotation("value", *value)); err != nil { + panic(err) + } + } + if err := rl.Write(); err != nil { + panic(err) + } + + // Output: + // apiVersion: config.kubernetes.io/v1alpha1 + // kind: ResourceList + // items: + // - apiVersion: apps/v1 + // kind: Deployment + // metadata: + // name: foo + // annotations: + // value: 'baz' + // - apiVersion: v1 + // kind: Service + // metadata: + // name: foo + // annotations: + // value: 'baz' + // functionConfig: + // apiVersion: v1 + // kind: ConfigMap + // data: + // value: baz +} + // ExampleCommand_modify implements a function that sets an annotation on each resource. // The annotation value is configured via a flag value parsed from // ResourceList.functionConfig.data @@ -102,7 +174,7 @@ func ExampleCommand_generateReplace() { // something we already generated, remove it from the list so we regenerate it if meta.Name == functionConfig.Spec.Name && - meta.Kind == "Service" && + meta.Kind == service && meta.APIVersion == "v1" { continue } @@ -163,6 +235,95 @@ functionConfig: // name: bar } +// ExampleResourceList_generateReplace generates a resource from a functionConfig. +// If the resource already exist s, it replaces the resource with a new copy. +func ExampleResourceList_generateReplace() { + input := bytes.NewBufferString(` +apiVersion: config.kubernetes.io/v1alpha1 +kind: ResourceList +# items are provided as nodes +items: +- apiVersion: apps/v1 + kind: Deployment + metadata: + name: foo +# functionConfig is parsed into flags by framework.Command +functionConfig: + apiVersion: example.com/v1alpha1 + kind: ExampleServiceGenerator + spec: + name: bar +`) + + // function API definition which will be parsed from the ResourceList.functionConfig + // read from stdin + type Spec struct { + Name string `yaml:"name,omitempty"` + } + type ExampleServiceGenerator struct { + Spec Spec `yaml:"spec,omitempty"` + } + functionConfig := &ExampleServiceGenerator{} + + rl := framework.ResourceList{ + FunctionConfig: functionConfig, + Reader: input, // for testing only + } + if err := rl.Read(); err != nil { + panic(err) + } + + // remove the last generated resource + var newNodes []*yaml.RNode + for i := range rl.Items { + meta, err := rl.Items[i].GetMeta() + if err != nil { + panic(err) + } + // something we already generated, remove it from the list so we regenerate it + if meta.Name == functionConfig.Spec.Name && + meta.Kind == service && + meta.APIVersion == "v1" { + continue + } + newNodes = append(newNodes, rl.Items[i]) + } + rl.Items = newNodes + + // generate the resource again + n, err := yaml.Parse(fmt.Sprintf(`apiVersion: v1 +kind: Service +metadata: + name: %s +`, functionConfig.Spec.Name)) + if err != nil { + panic(err) + } + rl.Items = append(rl.Items, n) + + if err := rl.Write(); err != nil { + panic(err) + } + + // Output: + // apiVersion: config.kubernetes.io/v1alpha1 + // kind: ResourceList + // items: + // - apiVersion: apps/v1 + // kind: Deployment + // metadata: + // name: foo + // - apiVersion: v1 + // kind: Service + // metadata: + // name: bar + // functionConfig: + // apiVersion: example.com/v1alpha1 + // kind: ExampleServiceGenerator + // spec: + // name: bar +} + // ExampleCommand_generateUpdate generates a resource, updating the previously generated // copy rather than replacing it. // @@ -191,7 +352,7 @@ func ExampleCommand_generateUpdate() { // something we already generated, reconcile it to make sure it matches what // is specified by the functionConfig if meta.Name == functionConfig.Spec.Name && - meta.Kind == "Service" && + meta.Kind == service && meta.APIVersion == "v1" { // set some values for k, v := range functionConfig.Spec.Annotations { diff --git a/kyaml/fn/framework/framework.go b/kyaml/fn/framework/framework.go index 6d58401f1..c89246cec 100644 --- a/kyaml/fn/framework/framework.go +++ b/kyaml/fn/framework/framework.go @@ -5,22 +5,176 @@ package framework import ( "fmt" + "io" "io/ioutil" + "os" "path/filepath" "github.com/spf13/cobra" + "github.com/spf13/pflag" "sigs.k8s.io/kustomize/kyaml/errors" "sigs.k8s.io/kustomize/kyaml/kio" "sigs.k8s.io/kustomize/kyaml/yaml" ) -// Command provides a cobra.Command for running the function. +// ResourceList reads the function input and writes the function output. // -// If functionConfig is nil, the function may be configured with flags parsed from -// the ResourceList.functionConfig by creating flags on the returned command. +// Adheres to the spec: https://github.com/kubernetes-sigs/kustomize/blob/master/cmd/config/docs/api-conventions/functions-spec.md +type ResourceList struct { + // FunctionConfig is the ResourceList.functionConfig input value. If FunctionConfig + // is set to a value such as a struct or map[string]interface{} before ResourceList.Read() + // is called, then the functionConfig will be parsed into that value. + // If it is nil, the functionConfig will be set to a map[string]interface{} + // before it is parsed. + // + // e.g. given the function input: + // + // kind: ResourceList + // functionConfig: + // kind: Example + // spec: + // foo: var + // + // FunctionConfig will contain the Example unmarshalled into its value. + FunctionConfig interface{} + + // Items is the ResourceList.items input and output value. Items will be set by + // ResourceList.Read() and written by ResourceList.Write(). + // + // e.g. given the function input: + // + // kind: ResourceList + // items: + // - kind: Deployment + // ... + // - kind: Service + // ... + // + // Items will be a slice containing the Deployment and Service resources + Items []*yaml.RNode + + // Result is ResourceList.result output value. Result will be written by + // ResourceList.Write() + Result *Result + + // Flags are an optional set of flags to parse the ResourceList.functionConfig.data. + // If non-nil, ResourceList.Read() will set the flag value for each flag name matching + // a ResourceList.functionConfig.data map entry. + // + // e.g. given the function input: + // + // kind: ResourceList + // functionConfig: + // data: + // foo: bar + // a: b + // + // The flags --a=b and --foo=bar will be set in Flags. + Flags *pflag.FlagSet + + // Reader is used to read the function input (ResourceList). + // Defaults to os.Stdin. + Reader io.Reader + + // Writer is used to write the function output (ResourceList) + // Defaults to os.Stdout. + Writer io.Writer + + // rw reads function input and writes function output + rw *kio.ByteReadWriter +} + +// Read reads the ResourceList +func (r *ResourceList) Read() error { + if r.Reader == nil { + r.Reader = os.Stdin + } + if r.Writer == nil { + r.Writer = os.Stdout + } + r.rw = &kio.ByteReadWriter{ + Reader: r.Reader, + Writer: r.Writer, + KeepReaderAnnotations: true, + } + + var err error + r.Items, err = r.rw.Read() + if err != nil { + return errors.Wrap(err) + } + + // parse the functionConfig + return func() error { + if r.rw.FunctionConfig == nil { + // no function config exists + return nil + } + if r.FunctionConfig == nil { + // set directly from r.rw + r.FunctionConfig = r.rw.FunctionConfig + } else { + // unmarshal the functionConfig into the provided value + err := yaml.Unmarshal([]byte(r.rw.FunctionConfig.MustString()), r.FunctionConfig) + if err != nil { + return errors.Wrap(err) + } + } + + // set the functionConfig values as flags so they are easy to access + if r.Flags == nil || !r.Flags.HasFlags() { + return nil + } + // flags are always set from the "data" field + data, err := r.rw.FunctionConfig.Pipe(yaml.Lookup("data")) + if err != nil || data == nil { + return err + } + return data.VisitFields(func(node *yaml.MapNode) error { + f := r.Flags.Lookup(node.Key.YNode().Value) + if f == nil { + return nil + } + return f.Value.Set(node.Value.YNode().Value) + }) + }() +} + +// Write writes the ResourceList +func (r *ResourceList) Write() error { + // set the ResourceList.results for validating functions + if r.Result != nil { + if len(r.Result.Items) > 0 { + b, err := yaml.Marshal(r.Result) + if err != nil { + return errors.Wrap(err) + } + y, err := yaml.Parse(string(b)) + if err != nil { + return errors.Wrap(err) + } + r.rw.Results = y + } + } + + // write the results + return r.rw.Write(r.Items) +} + +// Command returns a cobra.Command to run a function. +// +// The cobra.Command will use a ResourceList to Read() the input, run the provided function, +// and Write() the output. +// +// If functionConfig is non-nil, the ResourceList.functionConfig will be unmarshalled into it. +// +// The returned cobra.Command will have a "gen" subcommand which can be used to generate +// a Dockerfile to build the function into a container image +// +// go run main.go gen DIR/ func Command(functionConfig interface{}, function Function) cobra.Command { cmd := cobra.Command{} - addGenerate(&cmd) + AddGenerateDockerfile(&cmd) cmd.RunE = func(cmd *cobra.Command, args []string) error { err := execute(function, functionConfig, cmd) if err != nil { @@ -33,7 +187,9 @@ func Command(functionConfig interface{}, function Function) cobra.Command { return cmd } -func addGenerate(cmd *cobra.Command) { +// AddGenerateDockerfile adds a "gen" subcommand to create a Dockerfile for building +// the function as a container. +func AddGenerateDockerfile(cmd *cobra.Command) { gen := &cobra.Command{ Use: "gen", Args: cobra.ExactArgs(1), @@ -54,89 +210,33 @@ CMD ["function"] } func execute(function Function, functionConfig interface{}, cmd *cobra.Command) error { - rw := &kio.ByteReadWriter{ - Reader: cmd.InOrStdin(), - Writer: cmd.OutOrStdout(), - KeepReaderAnnotations: true, - } - nodes, err := rw.Read() - if err != nil { - return errors.Wrap(err) + rl := ResourceList{ + FunctionConfig: functionConfig, + Flags: cmd.Flags(), + Writer: cmd.OutOrStdout(), + Reader: cmd.InOrStdin(), } - // parse the functionConfig - if rw.FunctionConfig != nil { - if functionConfig == nil { - functionConfig = map[string]interface{}{} - } - - // unmarshal into the provided structure - err := yaml.Unmarshal([]byte(rw.FunctionConfig.MustString()), functionConfig) - if err != nil { - return errors.Wrap(err) - } - - // set the functionConfig values as flags so they are easy to access - err = func() error { - if !cmd.HasFlags() { - return nil - } - // kpt serializes function arguments as a ConfigMap, read them from - // the data field. - fc, ok := functionConfig.(map[string]interface{}) - if !ok { - // serialized as something else - return nil - } - if fc["data"] == nil { - return nil - } - data := fc["data"].(map[string]interface{}) - // set the value of each flag from the ResourceList.function config input - // values - for k, v := range data { - s, ok := v.(string) - if !ok { - continue - } - if err = cmd.Flag(k).Value.Set(s); err != nil { - return errors.Wrap(err) - } - } - return nil - }() - if err != nil { - return err - } + if err := rl.Read(); err != nil { + return err } // run the function implementation - nodes, err = function(nodes) + var err error + rl.Items, err = function(rl.Items) // set the ResourceList.results for validating functions var result *Result if err != nil { if val, ok := err.(Result); ok { - if len(val.Items) > 0 { - result = &val - b, err := yaml.Marshal(val) - if err != nil { - return errors.Wrap(err) - } - y, err := yaml.Parse(string(b)) - if err != nil { - return errors.Wrap(err) - } - rw.Results = y - } + rl.Result = &val } else { return errors.Wrap(err) } } - // write the results - if err := rw.Write(nodes); err != nil { - return errors.Wrap(err) + if err := rl.Write(); err != nil { + return err } if result != nil && result.ExitCode() != 0 { diff --git a/kyaml/fn/runtime/runtimeutil/functiontypes.go b/kyaml/fn/runtime/runtimeutil/functiontypes.go index 634adaec5..a5a0887ee 100644 --- a/kyaml/fn/runtime/runtimeutil/functiontypes.go +++ b/kyaml/fn/runtime/runtimeutil/functiontypes.go @@ -39,8 +39,6 @@ type FunctionSpec struct { type ExecSpec struct { Path string `json:"path,omitempty" yaml:"path,omitempty"` - - Args []string `json:"args,omitempty" yaml:"args,omitempty"` } // ContainerSpec defines a spec for running a function as a container diff --git a/kyaml/go.mod b/kyaml/go.mod index 1ff78e7fe..5f8bfc392 100644 --- a/kyaml/go.mod +++ b/kyaml/go.mod @@ -9,6 +9,7 @@ require ( github.com/qri-io/starlib v0.4.2-0.20200213133954-ff2e8cd5ef8d github.com/sergi/go-diff v1.1.0 github.com/spf13/cobra v1.0.0 + github.com/spf13/pflag v1.0.3 github.com/stretchr/testify v1.4.0 github.com/xlab/treeprint v0.0.0-20181112141820-a009c3971eca go.starlark.net v0.0.0-20200306205701-8dd3e2ee1dd5 diff --git a/kyaml/runfn/runfn.go b/kyaml/runfn/runfn.go index d5f27faed..5043b37c6 100644 --- a/kyaml/runfn/runfn.go +++ b/kyaml/runfn/runfn.go @@ -384,7 +384,7 @@ func (r *RunFns) ffp(spec runtimeutil.FunctionSpec, api *yaml.RNode) (kio.Filter } if r.EnableExec && spec.Exec.Path != "" { - ef := &exec.Filter{Path: spec.Exec.Path, Args: spec.Exec.Args} + ef := &exec.Filter{Path: spec.Exec.Path} ef.FunctionConfig = api ef.GlobalScope = r.GlobalScope