diff --git a/go.mod b/go.mod index 95d59eefa..011cc1a5b 100644 --- a/go.mod +++ b/go.mod @@ -14,6 +14,7 @@ require ( github.com/pkg/errors v0.9.1 github.com/sirupsen/logrus v1.9.0 github.com/test-network-function/l2discovery v0.0.0-20220817163120-5aa77e3c1d0c + github.com/test-network-function/privileged-daemonset v0.0.0-20220826123400-aaf1694908af github.com/yourbasic/graph v0.0.0-20210606180040-8ecfec1c2869 k8s.io/api v0.25.0 k8s.io/apiextensions-apiserver v0.25.0 diff --git a/go.sum b/go.sum index 0627d4360..f152eee01 100644 --- a/go.sum +++ b/go.sum @@ -399,6 +399,8 @@ github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5Cc github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/test-network-function/l2discovery v0.0.0-20220817163120-5aa77e3c1d0c h1:Jzc6aQ/FI63ec410oiT35WG3ciyJ4b13GYoXpo3lr9A= github.com/test-network-function/l2discovery v0.0.0-20220817163120-5aa77e3c1d0c/go.mod h1:fRZ3dlxBG5bwgVIaMhCKBv3431r9X40C2lYM3r4iwHE= +github.com/test-network-function/privileged-daemonset v0.0.0-20220826123400-aaf1694908af h1:hz/L249lHk6QBaO723lbIRgz/VHVnbaMBoMhxwark80= +github.com/test-network-function/privileged-daemonset v0.0.0-20220826123400-aaf1694908af/go.mod h1:psbuW1xPzS2+9x+lXtL0HrlEJtBEHrD8cZ2X6mbnyOU= github.com/yourbasic/graph v0.0.0-20210606180040-8ecfec1c2869 h1:7v7L5lsfw4w8iqBBXETukHo4IPltmD+mWoLRYUmeGN8= github.com/yourbasic/graph v0.0.0-20210606180040-8ecfec1c2869/go.mod h1:Rfzr+sqaDreiCaoQbFCu3sTXxeFq/9kXRuyOoSlGQHE= github.com/yuin/goldmark v1.1.25/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= diff --git a/test/conformance/ptp/ptp.go b/test/conformance/ptp/ptp.go index 93af2171e..ed5ec38e9 100644 --- a/test/conformance/ptp/ptp.go +++ b/test/conformance/ptp/ptp.go @@ -16,7 +16,6 @@ import ( . "github.com/onsi/ginkgo" . "github.com/onsi/gomega" "github.com/openshift/ptp-operator/test/utils" - "github.com/openshift/ptp-operator/test/utils/daemonsets" "github.com/openshift/ptp-operator/test/utils/event" "github.com/openshift/ptp-operator/test/utils/l2discovery" @@ -34,6 +33,8 @@ import ( "github.com/openshift/ptp-operator/test/utils/nodes" "github.com/openshift/ptp-operator/test/utils/pods" "github.com/openshift/ptp-operator/test/utils/testconfig" + + k8sPriviledgedDs "github.com/test-network-function/privileged-daemonset" ) type TestCase string @@ -1030,8 +1031,10 @@ func rebootSlaveNode(fullConfig testconfig.TestConfig) { imageWithVersion = "quay.io/testnetworkfunction/debug-partner:latest" ) + // Create the client of Priviledged Daemonset + k8sPriviledgedDs.SetDaemonSetClient(client.Client.Interface) // 1. create a daemon set for the node reboot - rebootDaemonSetRunningPods, err := daemonsets.CreateDaemonSet(rebootDaemonSetName, rebootDaemonSetNamespace, rebootDaemonSetContainerName, imageWithVersion, timeoutIn5Minutes) + rebootDaemonSetRunningPods, err := k8sPriviledgedDs.CreateDaemonSet(rebootDaemonSetName, rebootDaemonSetNamespace, rebootDaemonSetContainerName, imageWithVersion, timeoutIn5Minutes) if err != nil { logrus.Errorf("error : +%v\n", err.Error()) } diff --git a/test/utils/l2discovery/l2discovery.go b/test/utils/l2discovery/l2discovery.go index 4e472bae2..99b7dea44 100644 --- a/test/utils/l2discovery/l2discovery.go +++ b/test/utils/l2discovery/l2discovery.go @@ -15,12 +15,13 @@ import ( "github.com/openshift/ptp-operator/test/utils/nodes" "github.com/openshift/ptp-operator/test/utils/pods" - "github.com/openshift/ptp-operator/test/utils/daemonsets" l2 "github.com/test-network-function/l2discovery/export" "github.com/sirupsen/logrus" "github.com/yourbasic/graph" v1core "k8s.io/api/core/v1" + + k8sPriviledgedDs "github.com/test-network-function/privileged-daemonset" ) func init() { @@ -350,10 +351,12 @@ func (config *L2DiscoveryConfig) DiscoverL2Connectivity(client *client.ClientSet logrus.Errorf("could not retrieve ptp interface list") } + // Create the client of Priviledged Daemonset + k8sPriviledgedDs.SetDaemonSetClient(client.Interface) // Create L2 discovery daemonset config.L2DsMode = StringToL2Mode(os.Getenv("L2_DAEMONSET")) if config.L2DsMode == Managed { - _, err = daemonsets.CreateDaemonSet(L2DiscoveryDsName, L2DiscoveryNsName, L2DiscoveryContainerName, l2DiscoveryImage, timeoutDaemon) + _, err = k8sPriviledgedDs.CreateDaemonSet(L2DiscoveryDsName, L2DiscoveryNsName, L2DiscoveryContainerName, l2DiscoveryImage, timeoutDaemon) if err != nil { logrus.Errorf("error creating l2 discovery daemonset, err=%s", err) } @@ -385,7 +388,7 @@ func (config *L2DiscoveryConfig) DiscoverL2Connectivity(client *client.ClientSet // Delete L2 discovery daemonset if config.L2DsMode == Managed { - err = daemonsets.DeleteDaemonSet(L2DiscoveryDsName, L2DiscoveryNsName) + err = k8sPriviledgedDs.DeleteDaemonSet(L2DiscoveryDsName, L2DiscoveryNsName) if err != nil { logrus.Errorf("error deleting l2 discovery daemonset, err=%s", err) } diff --git a/vendor/github.com/test-network-function/privileged-daemonset/.gitignore b/vendor/github.com/test-network-function/privileged-daemonset/.gitignore new file mode 100644 index 000000000..a4971ff14 --- /dev/null +++ b/vendor/github.com/test-network-function/privileged-daemonset/.gitignore @@ -0,0 +1,22 @@ +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Dependency directories +vendor/ + +# Go workspace file +go.work + +# Extras +.vscode +bin/ diff --git a/vendor/github.com/test-network-function/privileged-daemonset/LICENSE b/vendor/github.com/test-network-function/privileged-daemonset/LICENSE new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/vendor/github.com/test-network-function/privileged-daemonset/LICENSE @@ -0,0 +1,201 @@ + 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/github.com/test-network-function/privileged-daemonset/Makefile b/vendor/github.com/test-network-function/privileged-daemonset/Makefile new file mode 100644 index 000000000..a6d80fe30 --- /dev/null +++ b/vendor/github.com/test-network-function/privileged-daemonset/Makefile @@ -0,0 +1,27 @@ +GO_PACKAGES=$(shell go list ./... | grep -v vendor) + +.PHONY: install-lint \ + lint \ + vet + +# Get default value of $GOBIN if not explicitly set +GO_PATH=$(shell go env GOPATH) +ifeq (,$(shell go env GOBIN)) + GOBIN=${GO_PATH}/bin +else + GOBIN=$(shell go env GOBIN) +endif + +# Variables +GOLANGCI_VERSION=v1.49.0 + +vet: + go vet ${GO_PACKAGES} + +# Install golangci-lint +install-lint: + curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b ${GO_PATH}/bin ${GOLANGCI_VERSION} + +# Run configured linters +lint: + golangci-lint run --timeout 10m0s diff --git a/vendor/github.com/test-network-function/privileged-daemonset/README.md b/vendor/github.com/test-network-function/privileged-daemonset/README.md new file mode 100644 index 000000000..384567141 --- /dev/null +++ b/vendor/github.com/test-network-function/privileged-daemonset/README.md @@ -0,0 +1,42 @@ +# K8s Daemonset in privilege mode + +## Functions + +- Creation of the daemonset in priviledge mode +- Deletion of a daemonset in a specified namespace +- Check if a daemonset is ready within a specified time + + +## Usage + +1. Import the library + +``` +import k8sPriviledgedDs "github.com/test-network-function/privileged-daemonset" +``` + +2. Set the K8s client to act on `Daemonset` object + +``` +k8sPriviledgedDs.SetDaemonSetClient(myK8sInterface) // myK8sInterface is of type kubernetes.Interface +``` + +3. Invoke the exported functions in a specified namespace with a specified imagename + +**To create** + +``` +daemonSetRunningPods, err := k8sPriviledgedDs.CreateDaemonSet(myDaemonSetName, myNameSpace, daemonSetContainerName, imageWithVersion, timeOut) +``` + +**To delete** + +``` +err := k8sPriviledgedDs.DeleteDaemonSet(myDaemonSetName, myNameSpace) +``` + +**To check if the daemonset is ready** + +``` +err := k8sPriviledgedDs.WaitDaemonsetReady(myDaemonSetName, myNameSpace) +``` diff --git a/test/utils/daemonsets/daemonsets.go b/vendor/github.com/test-network-function/privileged-daemonset/main.go similarity index 80% rename from test/utils/daemonsets/daemonsets.go rename to vendor/github.com/test-network-function/privileged-daemonset/main.go index 8e855a227..9d0b43be8 100644 --- a/test/utils/daemonsets/daemonsets.go +++ b/vendor/github.com/test-network-function/privileged-daemonset/main.go @@ -1,4 +1,4 @@ -package daemonsets +package privilegeddaemonset import ( "context" @@ -6,14 +6,24 @@ import ( "fmt" "time" - "github.com/openshift/ptp-operator/test/utils/client" "github.com/sirupsen/logrus" appsv1 "k8s.io/api/apps/v1" v1 "k8s.io/api/apps/v1" v1core "k8s.io/api/core/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + "k8s.io/client-go/kubernetes" ) +type DaemonSetClient struct { + K8sClient kubernetes.Interface +} + +var daemonsetClient = DaemonSetClient{} + +func SetDaemonSetClient(k8sClient kubernetes.Interface) { + daemonsetClient.K8sClient = k8sClient +} + const waitingTime = 5 * time.Second func createDaemonSetsTemplate(dsName, namespace, containerName, imageWithVersion string) *v1.DaemonSet { @@ -115,22 +125,20 @@ func DeleteDaemonSet(daemonSetName, namespace string) error { logrus.Infof("Deleting daemonset %s", daemonSetName) deletePolicy := metav1.DeletePropagationForeground - if err := client.Client.AppsV1Interface.DaemonSets(namespace).Delete(context.TODO(), daemonSetName, metav1.DeleteOptions{ + if err := daemonsetClient.K8sClient.AppsV1().DaemonSets(namespace).Delete(context.TODO(), daemonSetName, metav1.DeleteOptions{ PropagationPolicy: &deletePolicy, }); err != nil { - logrus.Infof("The daemonset (%d) deletion is unsuccessful due to %+v", daemonSetName, err.Error()) + logrus.Infof("The daemonset (%s) deletion is unsuccessful due to %+v", daemonSetName, err.Error()) } - doneCleanUp := false - for start := time.Now(); !doneCleanUp && time.Since(start) < Timeout; { + for start := time.Now(); time.Since(start) < Timeout; { - pods, err := client.Client.CoreV1().Pods(namespace).List(context.TODO(), metav1.ListOptions{LabelSelector: "name=" + daemonSetName}) + pods, err := daemonsetClient.K8sClient.CoreV1().Pods(namespace).List(context.TODO(), metav1.ListOptions{LabelSelector: "name=" + daemonSetName}) if err != nil { return fmt.Errorf("failed to get pods, err: %s", err) } if len(pods.Items) == 0 { - doneCleanUp = true break } time.Sleep(waitingTime) @@ -143,7 +151,7 @@ func DeleteDaemonSet(daemonSetName, namespace string) error { // Check if the daemonset exists func doesDaemonSetExist(daemonSetName, namespace string) bool { logrus.Infof("Checking if the daemonset exists") - _, err := client.Client.DaemonSets(namespace).Get(context.TODO(), daemonSetName, metav1.GetOptions{}) + _, err := daemonsetClient.K8sClient.AppsV1().DaemonSets(namespace).Get(context.TODO(), daemonSetName, metav1.GetOptions{}) if err != nil { logrus.Infof("daemonset %s does not exist, err=%s", daemonSetName, err.Error()) } @@ -165,16 +173,20 @@ func CreateDaemonSet(daemonSetName, namespace, containerName, imageWithVersion s } logrus.Infof("Creating daemonset %s", daemonSetName) - _, err := client.Client.DaemonSets(namespace).Create(context.TODO(), rebootDaemonSet, metav1.CreateOptions{}) + _, err := daemonsetClient.K8sClient.AppsV1().DaemonSets(namespace).Create(context.TODO(), rebootDaemonSet, metav1.CreateOptions{}) + if err != nil { + return nil, err + } + + err = WaitDaemonsetReady(namespace, daemonSetName, timeout) if err != nil { return nil, err } - WaitDaemonsetReady(namespace, daemonSetName, timeout) logrus.Infof("Deamonset is ready") var ptpPods *v1core.PodList - ptpPods, err = client.Client.CoreV1().Pods(namespace).List(context.TODO(), metav1.ListOptions{LabelSelector: "name=" + daemonSetName}) + ptpPods, err = daemonsetClient.K8sClient.CoreV1().Pods(namespace).List(context.TODO(), metav1.ListOptions{LabelSelector: "name=" + daemonSetName}) if err != nil { return ptpPods, err } @@ -185,8 +197,7 @@ func CreateDaemonSet(daemonSetName, namespace, containerName, imageWithVersion s // This function is used to wait until daemonset is ready func WaitDaemonsetReady(namespace, name string, timeout time.Duration) error { - oc := client.Client - nodes, err := oc.CoreV1().Nodes().List(context.TODO(), metav1.ListOptions{}) + nodes, err := daemonsetClient.K8sClient.CoreV1().Nodes().List(context.TODO(), metav1.ListOptions{}) if err != nil { return fmt.Errorf("failed to get node list, err:%s", err) } @@ -194,7 +205,7 @@ func WaitDaemonsetReady(namespace, name string, timeout time.Duration) error { nodesCount := int32(len(nodes.Items)) isReady := false for start := time.Now(); !isReady && time.Since(start) < timeout; { - daemonSet, err := oc.AppsV1().DaemonSets(namespace).Get(context.Background(), name, metav1.GetOptions{}) + daemonSet, err := daemonsetClient.K8sClient.AppsV1().DaemonSets(namespace).Get(context.Background(), name, metav1.GetOptions{}) if err != nil { return fmt.Errorf("failed to get daemonset, err: %s", err) diff --git a/vendor/modules.txt b/vendor/modules.txt index 686d084a7..b7853678d 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -231,6 +231,9 @@ github.com/spf13/pflag # github.com/test-network-function/l2discovery v0.0.0-20220817163120-5aa77e3c1d0c ## explicit; go 1.18 github.com/test-network-function/l2discovery/export +# github.com/test-network-function/privileged-daemonset v0.0.0-20220826123400-aaf1694908af +## explicit; go 1.18 +github.com/test-network-function/privileged-daemonset # github.com/yourbasic/graph v0.0.0-20210606180040-8ecfec1c2869 ## explicit github.com/yourbasic/graph