Merge pull request #2641 from NikhilSharmaWe/retErr

🐛(Kubebuilder lib) : Function InsertCode should return error when target string is not found in content

Author: k8s-ci-robot

pkg/plugin/util/testdata/exampleFile.txt

@@ -0,0 +1 @@
+exampleTarget

pkg/plugin/util/util.go

@@ -72,6 +72,9 @@ func InsertCode(filename, target, code string) error {
 		return err
 	}
 	idx := strings.Index(string(contents), target)
+	if idx == -1 {
+		return fmt.Errorf("string %s not found in %s", target, string(contents))
+	}
 	out := string(contents[:idx+len(target)]) + code + string(contents[idx+len(target):])
 	// false positive
 	// nolint:gosec

pkg/plugin/util/util_test.go

@@ -0,0 +1,39 @@
+/*
+Copyright 2022 The Kubernetes Authors.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package util
+
+import (
+	"path/filepath"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/ginkgo/extensions/table"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("InsertCode", func() {
+	path := filepath.Join("testdata", "exampleFile.txt")
+	DescribeTable("should not succeed",
+		func(target string) {
+			Expect(InsertCode(path, target, "exampleCode")).ShouldNot(Succeed())
+		},
+		Entry("target given is not present in file", "randomTarget"),
+	)
+
+	DescribeTable("should succeed",
+		func(target string) {
+			Expect(InsertCode(path, target, "exampleCode")).Should(Succeed())
+		},
+		Entry("target given is present in file", "exampleTarget"),
+	)
+})