From 15b3136d55f08a702e8109278b0ec1111b9934d0 Mon Sep 17 00:00:00 2001 From: Martin Gencur Date: Mon, 16 Oct 2023 10:44:09 +0200 Subject: [PATCH 1/5] Shell executor logs through testing.T in upgrade tests Update deps on knative.dev/pkg --- test/upgrade/installation/latest.go | 2 +- test/upgrade/installation/shell.go | 10 +- .../knative.dev/hack/shell/LICENSE | 201 ------------------ .../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 | 2 +- 9 files changed, 63 insertions(+), 246 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/test/upgrade/installation/latest.go b/test/upgrade/installation/latest.go index d94ddc079c1..6ab9c042150 100644 --- a/test/upgrade/installation/latest.go +++ b/test/upgrade/installation/latest.go @@ -24,7 +24,7 @@ func LatestStable() pkgupgrade.Operation { return pkgupgrade.NewOperation("EventingLatestRelease", func(c pkgupgrade.Context) { shellfunc := "install_latest_release" c.Log.Info("Running shell function: ", shellfunc) - err := callShellFunction(shellfunc) + err := callShellFunction(shellfunc, c.T) if err != nil { c.T.Error(err) return diff --git a/test/upgrade/installation/shell.go b/test/upgrade/installation/shell.go index e51ca41d418..6fe54687e9e 100644 --- a/test/upgrade/installation/shell.go +++ b/test/upgrade/installation/shell.go @@ -17,17 +17,17 @@ limitations under the License. package installation import ( - "knative.dev/hack/shell" + "testing" + + "knative.dev/pkg/test/upgrade/shell" ) -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 261eeb9e9f8..00000000000 --- 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/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 059631dd579..d41ccc765a7 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 551ce662a34..4815aef9de1 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 273ee1cc4ff..f267c1e3b42 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 a6df6c4a665..c58bc713c3c 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 8e34515206d..14bbbac05a8 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 1c173644d42..a740950ba34 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -1202,7 +1202,6 @@ k8s.io/utils/trace # knative.dev/hack v0.0.0-20231016131700-2c938d4918da ## explicit; go 1.18 knative.dev/hack -knative.dev/hack/shell # knative.dev/hack/schema v0.0.0-20231016131700-2c938d4918da ## explicit; go 1.18 knative.dev/hack/schema/commands @@ -1328,6 +1327,7 @@ knative.dev/pkg/test/security knative.dev/pkg/test/slackutil knative.dev/pkg/test/spoof knative.dev/pkg/test/upgrade +knative.dev/pkg/test/upgrade/shell knative.dev/pkg/test/zipkin knative.dev/pkg/third_party/mako/proto/quickstore_go_proto knative.dev/pkg/tracing From 27f1db6d97cee780c8231ee0ff8ebf75a6e78301 Mon Sep 17 00:00:00 2001 From: Martin Gencur Date: Mon, 16 Oct 2023 10:45:13 +0200 Subject: [PATCH 2/5] TMP: Induce error --- test/e2e-common.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/e2e-common.sh b/test/e2e-common.sh index 477a6741e5e..ab33f6a3b53 100755 --- a/test/e2e-common.sh +++ b/test/e2e-common.sh @@ -212,7 +212,7 @@ function install_head { function install_latest_release() { header ">> Installing Knative Eventing latest public release" - install_knative_eventing \ + install_knative_eventing_nonexistent \ "latest-release" || \ fail_test "Knative latest release installation failed" } From baca67235aa88fe473442b8cb11afead1e04e6af Mon Sep 17 00:00:00 2001 From: Martin Gencur Date: Mon, 16 Oct 2023 10:57:12 +0200 Subject: [PATCH 3/5] Fix --- test/upgrade/installation/git_head.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/upgrade/installation/git_head.go b/test/upgrade/installation/git_head.go index 5311962834e..f3378e0ff93 100644 --- a/test/upgrade/installation/git_head.go +++ b/test/upgrade/installation/git_head.go @@ -30,7 +30,7 @@ func GitHead() pkgupgrade.Operation { } for _, shellfunc := range ops { c.Log.Info("Running shell function: ", shellfunc) - err := callShellFunction(shellfunc) + err := callShellFunction(shellfunc, c.T) if err != nil { c.T.Error(err) return From 772e0f5d650bc6c2d58487854e326c4acee39c6d Mon Sep 17 00:00:00 2001 From: Martin Gencur Date: Mon, 16 Oct 2023 11:16:24 +0200 Subject: [PATCH 4/5] Revert "TMP: Induce error" This reverts commit 65c557df0632d0198612a51ae15b0dfa7b39912f. --- test/e2e-common.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/e2e-common.sh b/test/e2e-common.sh index ab33f6a3b53..477a6741e5e 100755 --- a/test/e2e-common.sh +++ b/test/e2e-common.sh @@ -212,7 +212,7 @@ function install_head { function install_latest_release() { header ">> Installing Knative Eventing latest public release" - install_knative_eventing_nonexistent \ + install_knative_eventing \ "latest-release" || \ fail_test "Knative latest release installation failed" } From a0505b4141c6be21a283e02e32a5364b7daccea5 Mon Sep 17 00:00:00 2001 From: Martin Gencur Date: Tue, 17 Oct 2023 09:02:53 +0200 Subject: [PATCH 5/5] Update codegen --- vendor/knative.dev/pkg/test/upgrade/shell/executor.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/vendor/knative.dev/pkg/test/upgrade/shell/executor.go b/vendor/knative.dev/pkg/test/upgrade/shell/executor.go index d41ccc765a7..020f0d3eddf 100644 --- a/vendor/knative.dev/pkg/test/upgrade/shell/executor.go +++ b/vendor/knative.dev/pkg/test/upgrade/shell/executor.go @@ -185,7 +185,9 @@ func (w testingWriter) Write(p []byte) (n int, err error) { // Strip trailing newline because t.Log always adds one. p = bytes.TrimRight(p, "\n") - w.t.Logf("%s", p) + for _, line := range strings.Split(string(p), "\n") { + w.t.Logf(line) + } return n, nil }