From b7ccc907ffec7eca980f89fa9812b818825497d7 Mon Sep 17 00:00:00 2001 From: Martin Gencur Date: Mon, 16 Oct 2023 11:23:23 +0200 Subject: [PATCH] Shell executor logs through testing.T in upgrade tests --- go.mod | 6 +- go.sum | 12 +- test/upgrade/installation/shell.go | 12 +- .../knative.dev/hack/shell/LICENSE | 201 ------------------ vendor/golang.org/x/tools/imports/forward.go | 4 +- .../internal/fastwalk/fastwalk_portable.go | 11 +- .../x/tools/internal/imports/fix.go | 7 +- .../x/tools/internal/imports/mod.go | 5 +- .../test/upgrade}/shell/executor.go | 63 +++--- .../test/upgrade}/shell/fail-example.sh | 2 +- .../test/upgrade}/shell/prefixer.go | 2 +- .../test/upgrade}/shell/project.go | 6 +- .../{hack => pkg/test/upgrade}/shell/types.go | 21 +- vendor/modules.txt | 10 +- 14 files changed, 91 insertions(+), 271 deletions(-) delete mode 100644 third_party/VENDOR-LICENSE/knative.dev/hack/shell/LICENSE rename vendor/knative.dev/{hack => pkg/test/upgrade}/shell/executor.go (83%) rename vendor/knative.dev/{hack => pkg/test/upgrade}/shell/fail-example.sh (91%) rename vendor/knative.dev/{hack => pkg/test/upgrade}/shell/prefixer.go (97%) rename vendor/knative.dev/{hack => pkg/test/upgrade}/shell/project.go (91%) rename vendor/knative.dev/{hack => pkg/test/upgrade}/shell/types.go (81%) diff --git a/go.mod b/go.mod index b6fa398c7b..b39b573faf 100644 --- a/go.mod +++ b/go.mod @@ -11,7 +11,7 @@ require ( github.com/manifestival/manifestival v0.7.2 go.uber.org/zap v1.26.0 gocloud.dev v0.22.0 - golang.org/x/mod v0.12.0 + golang.org/x/mod v0.13.0 golang.org/x/oauth2 v0.13.0 google.golang.org/api v0.145.0 istio.io/api v0.0.0-20220420164308-b6a03a9e477e @@ -24,7 +24,7 @@ require ( knative.dev/caching v0.0.0-20231011063744-ceca0ce6cd18 knative.dev/eventing v0.38.1-0.20231011142145-da0fba3c161a knative.dev/hack v0.0.0-20231010131532-fc76874b28c6 - knative.dev/pkg v0.0.0-20231011202506-948f5f57818a + knative.dev/pkg v0.0.0-20231016085036-3262b2bd73ed knative.dev/serving v0.38.1-0.20231011210335-6703812f1314 sigs.k8s.io/yaml v1.3.0 ) @@ -122,7 +122,7 @@ require ( golang.org/x/term v0.13.0 // indirect golang.org/x/text v0.13.0 // indirect golang.org/x/time v0.3.0 // indirect - golang.org/x/tools v0.13.0 // indirect + golang.org/x/tools v0.14.0 // indirect golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect google.golang.org/appengine v1.6.7 // indirect diff --git a/go.sum b/go.sum index a16ecb500a..a72a5c84f2 100644 --- a/go.sum +++ b/go.sum @@ -861,8 +861,8 @@ golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.4.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.4.1/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= -golang.org/x/mod v0.12.0 h1:rmsUpXtvNzj340zd98LZ4KntptpfRHwpFOHG188oHXc= -golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.13.0 h1:I/DsJXRlw/8l/0c24sM9yb0T4z9liZTduXvdAWYiysY= +golang.org/x/mod v0.13.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/net v0.0.0-20170114055629-f2499483f923/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= @@ -1128,8 +1128,8 @@ golang.org/x/tools v0.0.0-20210105154028-b0ab187a4818/go.mod h1:emZCQorbCU4vsT4f golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= -golang.org/x/tools v0.13.0 h1:Iey4qkscZuv0VvIt8E0neZjtPVQFSc870HQ448QgEmQ= -golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58= +golang.org/x/tools v0.14.0 h1:jvNa2pY0M4r62jkRQ6RwEZZyPcymeL9XZMLBbV7U2nc= +golang.org/x/tools v0.14.0/go.mod h1:uYBEerGOWcJyEORxN+Ek8+TT266gXkNlHdJBwexUsBg= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= @@ -1397,8 +1397,8 @@ knative.dev/hack v0.0.0-20231010131532-fc76874b28c6 h1:K9saPnpWTK1xH/Dpx1aE4CA+4 knative.dev/hack v0.0.0-20231010131532-fc76874b28c6/go.mod h1:yk2OjGDsbEnQjfxdm0/HJKS2WqTLEFg/N6nUs6Rqx3Q= knative.dev/networking v0.0.0-20231010132642-13dbe2012208 h1:kmaGnpE58Fu+M9sxF+qxifEG+lzBeM/9cBvuXLWGtOY= knative.dev/networking v0.0.0-20231010132642-13dbe2012208/go.mod h1:LAT8cu/PGOtik5ABZhhl6h45QrNRXj0uqlpIP0dmLnU= -knative.dev/pkg v0.0.0-20231011202506-948f5f57818a h1:/Ia2DN9jWwz0CSLXFq0iwvMK4Tx4Iy9WoMvoPn1ri98= -knative.dev/pkg v0.0.0-20231011202506-948f5f57818a/go.mod h1:0HqD8pZppFF34znDJnN6fGzuFq9ulJnelX64ciHD+PE= +knative.dev/pkg v0.0.0-20231016085036-3262b2bd73ed h1:r9Dq3WejOMRhWnNzMpz8QCw8sl+9HiCFDsyQ1oCWQ+U= +knative.dev/pkg v0.0.0-20231016085036-3262b2bd73ed/go.mod h1:zmZN3DKn7ns0lKMPPAhoApZqZatWvfcKcr0yptdLSPw= knative.dev/serving v0.38.1-0.20231011210335-6703812f1314 h1:w1F7bA1+DEJBxaJrOhmKCasqYJ/uEcVOJpmHHEGuiug= knative.dev/serving v0.38.1-0.20231011210335-6703812f1314/go.mod h1:wnuCaMuLfBdOHgs1OfYPvEFN4xqH3GL6aTBv+xqdgKQ= nhooyr.io/websocket v1.8.6/go.mod h1:B70DZP8IakI65RVQ51MsWP/8jndNma26DVA/nFSCgW0= diff --git a/test/upgrade/installation/shell.go b/test/upgrade/installation/shell.go index 45950fc3a2..bd19dd67de 100644 --- a/test/upgrade/installation/shell.go +++ b/test/upgrade/installation/shell.go @@ -17,8 +17,10 @@ limitations under the License. package installation import ( - "knative.dev/hack/shell" + "testing" + pkgupgrade "knative.dev/pkg/test/upgrade" + "knative.dev/pkg/test/upgrade/shell" ) // Base installs Operator with Knative Serving and Eventing from the previous stable release. @@ -39,20 +41,18 @@ func PreviousRelease() pkgupgrade.Operation { func install(installName, shellFunc string) pkgupgrade.Operation { return pkgupgrade.NewOperation(installName, func(c pkgupgrade.Context) { c.Log.Info("Running shell function: ", shellFunc) - if err := callShellFunction(shellFunc); err != nil { + if err := callShellFunction(shellFunc, c.T); err != nil { c.T.Error(err) } }) } -func callShellFunction(funcName string) error { +func callShellFunction(funcName string, t *testing.T) error { loc, err := shell.NewProjectLocation("../../..") if err != nil { return err } - exec := shell.NewExecutor(shell.ExecutorConfig{ - ProjectLocation: loc, - }) + exec := shell.NewExecutor(t, loc) fn := shell.Function{ Script: shell.Script{ Label: funcName, diff --git a/third_party/VENDOR-LICENSE/knative.dev/hack/shell/LICENSE b/third_party/VENDOR-LICENSE/knative.dev/hack/shell/LICENSE deleted file mode 100644 index 261eeb9e9f..0000000000 --- a/third_party/VENDOR-LICENSE/knative.dev/hack/shell/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - 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. diff --git a/vendor/golang.org/x/tools/imports/forward.go b/vendor/golang.org/x/tools/imports/forward.go index d2547c7433..cb6db8893f 100644 --- a/vendor/golang.org/x/tools/imports/forward.go +++ b/vendor/golang.org/x/tools/imports/forward.go @@ -7,8 +7,8 @@ package imports // import "golang.org/x/tools/imports" import ( - "io/ioutil" "log" + "os" "golang.org/x/tools/internal/gocommand" intimp "golang.org/x/tools/internal/imports" @@ -44,7 +44,7 @@ var LocalPrefix string func Process(filename string, src []byte, opt *Options) ([]byte, error) { var err error if src == nil { - src, err = ioutil.ReadFile(filename) + src, err = os.ReadFile(filename) if err != nil { return nil, err } diff --git a/vendor/golang.org/x/tools/internal/fastwalk/fastwalk_portable.go b/vendor/golang.org/x/tools/internal/fastwalk/fastwalk_portable.go index 085d311600..27e860243e 100644 --- a/vendor/golang.org/x/tools/internal/fastwalk/fastwalk_portable.go +++ b/vendor/golang.org/x/tools/internal/fastwalk/fastwalk_portable.go @@ -8,7 +8,6 @@ package fastwalk import ( - "io/ioutil" "os" ) @@ -17,16 +16,20 @@ import ( // If fn returns a non-nil error, readDir returns with that error // immediately. func readDir(dirName string, fn func(dirName, entName string, typ os.FileMode) error) error { - fis, err := ioutil.ReadDir(dirName) + fis, err := os.ReadDir(dirName) if err != nil { return err } skipFiles := false for _, fi := range fis { - if fi.Mode().IsRegular() && skipFiles { + info, err := fi.Info() + if err != nil { + return err + } + if info.Mode().IsRegular() && skipFiles { continue } - if err := fn(dirName, fi.Name(), fi.Mode()&os.ModeType); err != nil { + if err := fn(dirName, fi.Name(), info.Mode()&os.ModeType); err != nil { if err == ErrSkipFiles { skipFiles = true continue diff --git a/vendor/golang.org/x/tools/internal/imports/fix.go b/vendor/golang.org/x/tools/internal/imports/fix.go index d4f1b4e8a0..01e8ba5fa2 100644 --- a/vendor/golang.org/x/tools/internal/imports/fix.go +++ b/vendor/golang.org/x/tools/internal/imports/fix.go @@ -13,6 +13,7 @@ import ( "go/build" "go/parser" "go/token" + "io/fs" "io/ioutil" "os" "path" @@ -107,7 +108,7 @@ func parseOtherFiles(fset *token.FileSet, srcDir, filename string) []*ast.File { considerTests := strings.HasSuffix(filename, "_test.go") fileBase := filepath.Base(filename) - packageFileInfos, err := ioutil.ReadDir(srcDir) + packageFileInfos, err := os.ReadDir(srcDir) if err != nil { return nil } @@ -1469,11 +1470,11 @@ func VendorlessPath(ipath string) string { func loadExportsFromFiles(ctx context.Context, env *ProcessEnv, dir string, includeTest bool) (string, []string, error) { // Look for non-test, buildable .go files which could provide exports. - all, err := ioutil.ReadDir(dir) + all, err := os.ReadDir(dir) if err != nil { return "", nil, err } - var files []os.FileInfo + var files []fs.DirEntry for _, fi := range all { name := fi.Name() if !strings.HasSuffix(name, ".go") || (!includeTest && strings.HasSuffix(name, "_test.go")) { diff --git a/vendor/golang.org/x/tools/internal/imports/mod.go b/vendor/golang.org/x/tools/internal/imports/mod.go index 977d2389da..5f4d435d3c 100644 --- a/vendor/golang.org/x/tools/internal/imports/mod.go +++ b/vendor/golang.org/x/tools/internal/imports/mod.go @@ -9,7 +9,6 @@ import ( "context" "encoding/json" "fmt" - "io/ioutil" "os" "path" "path/filepath" @@ -265,7 +264,7 @@ func (r *ModuleResolver) findPackage(importPath string) (*gocommand.ModuleJSON, } // Not cached. Read the filesystem. - pkgFiles, err := ioutil.ReadDir(pkgDir) + pkgFiles, err := os.ReadDir(pkgDir) if err != nil { continue } @@ -370,7 +369,7 @@ func (r *ModuleResolver) dirIsNestedModule(dir string, mod *gocommand.ModuleJSON func (r *ModuleResolver) modInfo(dir string) (modDir string, modName string) { readModName := func(modFile string) string { - modBytes, err := ioutil.ReadFile(modFile) + modBytes, err := os.ReadFile(modFile) if err != nil { return "" } diff --git a/vendor/knative.dev/hack/shell/executor.go b/vendor/knative.dev/pkg/test/upgrade/shell/executor.go similarity index 83% rename from vendor/knative.dev/hack/shell/executor.go rename to vendor/knative.dev/pkg/test/upgrade/shell/executor.go index 059631dd57..d41ccc765a 100644 --- a/vendor/knative.dev/hack/shell/executor.go +++ b/vendor/knative.dev/pkg/test/upgrade/shell/executor.go @@ -5,7 +5,7 @@ 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 - https://www.apache.org/licenses/LICENSE-2.0 + 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, @@ -17,7 +17,7 @@ limitations under the License. package shell import ( - "errors" + "bytes" "fmt" "os" "os/exec" @@ -31,23 +31,32 @@ const ( executeMode = 0700 ) -// ErrNoProjectLocation is returned if user didnt provided the project location. -var ErrNoProjectLocation = errors.New("project location isn't provided") - -// NewExecutor creates a new executor from given config. -func NewExecutor(config ExecutorConfig) Executor { - configureDefaultValues(&config) +// NewExecutor creates a new executor. +func NewExecutor(t TestingT, loc ProjectLocation, opts ...Option) Executor { + config := &ExecutorConfig{ + ProjectLocation: loc, + Streams: testingTStreams(t), + } + for _, opt := range opts { + opt(config) + } + configureDefaultValues(config) return &streamingExecutor{ - ExecutorConfig: config, + ExecutorConfig: *config, + } +} + +// testingTStreams returns Streams which writes to test log. +func testingTStreams(t TestingT) Streams { + tWriter := testingWriter{t: t} + return Streams{ + Out: tWriter, + Err: tWriter, } } // RunScript executes a shell script with args. func (s *streamingExecutor) RunScript(script Script, args ...string) error { - err := validate(s.ExecutorConfig) - if err != nil { - return err - } cnt := script.scriptContent(s.ProjectLocation, args) return withTempScript(cnt, func(bin string) error { return stream(bin, s.ExecutorConfig, script.Label) @@ -56,10 +65,6 @@ func (s *streamingExecutor) RunScript(script Script, args ...string) error { // RunFunction executes a shell function with args. func (s *streamingExecutor) RunFunction(fn Function, args ...string) error { - err := validate(s.ExecutorConfig) - if err != nil { - return err - } cnt := fn.scriptContent(s.ProjectLocation, args) return withTempScript(cnt, func(bin string) error { return stream(bin, s.ExecutorConfig, fn.Label) @@ -70,20 +75,7 @@ type streamingExecutor struct { ExecutorConfig } -func validate(config ExecutorConfig) error { - if config.ProjectLocation == nil { - return ErrNoProjectLocation - } - return nil -} - func configureDefaultValues(config *ExecutorConfig) { - if config.Out == nil { - config.Out = os.Stdout - } - if config.Err == nil { - config.Err = os.Stderr - } if config.LabelOut == "" { config.LabelOut = defaultLabelOut } @@ -186,3 +178,14 @@ func quoteArgs(args []string) string { } return strings.Join(quoted, " ") } + +func (w testingWriter) Write(p []byte) (n int, err error) { + n = len(p) + + // Strip trailing newline because t.Log always adds one. + p = bytes.TrimRight(p, "\n") + + w.t.Logf("%s", p) + + return n, nil +} diff --git a/vendor/knative.dev/hack/shell/fail-example.sh b/vendor/knative.dev/pkg/test/upgrade/shell/fail-example.sh similarity index 91% rename from vendor/knative.dev/hack/shell/fail-example.sh rename to vendor/knative.dev/pkg/test/upgrade/shell/fail-example.sh index 551ce662a3..4815aef9de 100644 --- a/vendor/knative.dev/hack/shell/fail-example.sh +++ b/vendor/knative.dev/pkg/test/upgrade/shell/fail-example.sh @@ -6,7 +6,7 @@ # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # -# https://www.apache.org/licenses/LICENSE-2.0 +# 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, diff --git a/vendor/knative.dev/hack/shell/prefixer.go b/vendor/knative.dev/pkg/test/upgrade/shell/prefixer.go similarity index 97% rename from vendor/knative.dev/hack/shell/prefixer.go rename to vendor/knative.dev/pkg/test/upgrade/shell/prefixer.go index 273ee1cc4f..f267c1e3b4 100644 --- a/vendor/knative.dev/hack/shell/prefixer.go +++ b/vendor/knative.dev/pkg/test/upgrade/shell/prefixer.go @@ -5,7 +5,7 @@ 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 - https://www.apache.org/licenses/LICENSE-2.0 + 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, diff --git a/vendor/knative.dev/hack/shell/project.go b/vendor/knative.dev/pkg/test/upgrade/shell/project.go similarity index 91% rename from vendor/knative.dev/hack/shell/project.go rename to vendor/knative.dev/pkg/test/upgrade/shell/project.go index a6df6c4a66..c58bc713c3 100644 --- a/vendor/knative.dev/hack/shell/project.go +++ b/vendor/knative.dev/pkg/test/upgrade/shell/project.go @@ -5,7 +5,7 @@ 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 - https://www.apache.org/licenses/LICENSE-2.0 + 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, @@ -31,7 +31,7 @@ var ( // ErrCallerNotAllowed is raised when user tries to use this shell-out package // outside of allowed places. This package is deprecated from start and was // introduced to allow rewriting of shell code to Golang in small chunks. - ErrCallerNotAllowed = errors.New("don't try use knative.dev/hack/shell package outside of allowed places") + ErrCallerNotAllowed = errors.New("don't try use knative.dev/pkg/test/upgrade/shell package outside of allowed places") ) // NewProjectLocation creates a ProjectLocation that is used to calculate @@ -68,7 +68,7 @@ type callerLocation struct { func isCallsiteAllowed(funcName string) error { validPaths := []string{ "knative.+/test/upgrade", - "knative(:?\\.dev/|-)hack/shell", + "knative(:?\\.dev/|-)pkg/test/upgrade/shell", } for _, validPath := range validPaths { r := regexp.MustCompile(validPath) diff --git a/vendor/knative.dev/hack/shell/types.go b/vendor/knative.dev/pkg/test/upgrade/shell/types.go similarity index 81% rename from vendor/knative.dev/hack/shell/types.go rename to vendor/knative.dev/pkg/test/upgrade/shell/types.go index 8e34515206..14bbbac05a 100644 --- a/vendor/knative.dev/hack/shell/types.go +++ b/vendor/knative.dev/pkg/test/upgrade/shell/types.go @@ -5,7 +5,7 @@ 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 - https://www.apache.org/licenses/LICENSE-2.0 + 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, @@ -16,7 +16,12 @@ limitations under the License. package shell -import "io" +import ( + "io" +) + +// Option overrides configuration options in ExecutorConfig. +type Option func(*ExecutorConfig) // ProjectLocation represents a project location on a file system. type ProjectLocation interface { @@ -36,7 +41,7 @@ type Function struct { FunctionName string } -// ExecutorConfig holds a executor configuration options. +// ExecutorConfig holds executor configuration options. type ExecutorConfig struct { ProjectLocation Streams @@ -44,6 +49,16 @@ type ExecutorConfig struct { Environ []string } +// TestingT is used by testingWriter and allows passing testing.T. +type TestingT interface { + Logf(format string, args ...any) +} + +// testingWriter implements io.Writer and writes to given testing.T log. +type testingWriter struct { + t TestingT +} + // StreamType represets either output or error stream. type StreamType int diff --git a/vendor/modules.txt b/vendor/modules.txt index fc6fa59e85..98324ce50e 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -494,8 +494,8 @@ golang.org/x/crypto/openpgp/packet golang.org/x/crypto/openpgp/s2k golang.org/x/crypto/pkcs12 golang.org/x/crypto/pkcs12/internal/rc2 -# golang.org/x/mod v0.12.0 -## explicit; go 1.17 +# golang.org/x/mod v0.13.0 +## explicit; go 1.18 golang.org/x/mod/internal/lazyregexp golang.org/x/mod/module golang.org/x/mod/semver @@ -546,7 +546,7 @@ golang.org/x/text/unicode/norm # golang.org/x/time v0.3.0 ## explicit golang.org/x/time/rate -# golang.org/x/tools v0.13.0 +# golang.org/x/tools v0.14.0 ## explicit; go 1.18 golang.org/x/tools/go/ast/astutil golang.org/x/tools/imports @@ -1363,7 +1363,6 @@ knative.dev/eventing/test/upgrade/prober/wathola/sender # knative.dev/hack v0.0.0-20231010131532-fc76874b28c6 ## explicit; go 1.18 knative.dev/hack -knative.dev/hack/shell # knative.dev/networking v0.0.0-20231010132642-13dbe2012208 ## explicit; go 1.18 knative.dev/networking/pkg @@ -1379,7 +1378,7 @@ knative.dev/networking/pkg/http/probe knative.dev/networking/pkg/http/proxy knative.dev/networking/pkg/http/stats knative.dev/networking/pkg/k8s -# knative.dev/pkg v0.0.0-20231011202506-948f5f57818a +# knative.dev/pkg v0.0.0-20231016085036-3262b2bd73ed ## explicit; go 1.18 knative.dev/pkg/apiextensions/storageversion knative.dev/pkg/apiextensions/storageversion/cmd/migrate @@ -1448,6 +1447,7 @@ knative.dev/pkg/test/prow knative.dev/pkg/test/security knative.dev/pkg/test/spoof knative.dev/pkg/test/upgrade +knative.dev/pkg/test/upgrade/shell knative.dev/pkg/test/zipkin knative.dev/pkg/tracing knative.dev/pkg/tracing/config