|
| 1 | +/* |
| 2 | +Copyright 2025 The Kubernetes Authors. |
| 3 | +
|
| 4 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +you may not use this file except in compliance with the License. |
| 6 | +You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | +Unless required by applicable law or agreed to in writing, software |
| 11 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +See the License for the specific language governing permissions and |
| 14 | +limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +package envtest |
| 18 | + |
| 19 | +import ( |
| 20 | + "archive/tar" |
| 21 | + "bytes" |
| 22 | + "compress/gzip" |
| 23 | + "context" |
| 24 | + "crypto/rand" |
| 25 | + "crypto/sha512" |
| 26 | + "encoding/hex" |
| 27 | + "fmt" |
| 28 | + "net/http" |
| 29 | + "os" |
| 30 | + "path" |
| 31 | + "runtime" |
| 32 | + |
| 33 | + . "github.com/onsi/ginkgo/v2" |
| 34 | + . "github.com/onsi/gomega" |
| 35 | + "github.com/onsi/gomega/ghttp" |
| 36 | + "sigs.k8s.io/yaml" |
| 37 | +) |
| 38 | + |
| 39 | +var _ = Describe("Test download binaries", func() { |
| 40 | + var downloadDirectory string |
| 41 | + var server *ghttp.Server |
| 42 | + |
| 43 | + BeforeEach(func() { |
| 44 | + downloadDirectory = GinkgoT().TempDir() |
| 45 | + |
| 46 | + server = ghttp.NewServer() |
| 47 | + DeferCleanup(func() { |
| 48 | + server.Close() |
| 49 | + }) |
| 50 | + setupServer(server) |
| 51 | + }) |
| 52 | + |
| 53 | + It("should download binaries of latest stable version", func() { |
| 54 | + apiServerPath, etcdPath, kubectlPath, err := downloadBinaryAssets(context.Background(), downloadDirectory, "", fmt.Sprintf("http://%s/%s", server.Addr(), "envtest-releases.yaml")) |
| 55 | + Expect(err).ToNot(HaveOccurred()) |
| 56 | + |
| 57 | + // Verify latest stable version (v1.32.0) was downloaded |
| 58 | + versionDownloadDirectory := path.Join(downloadDirectory, fmt.Sprintf("1.32.0-%s-%s", runtime.GOOS, runtime.GOARCH)) |
| 59 | + Expect(apiServerPath).To(Equal(path.Join(versionDownloadDirectory, "kube-apiserver"))) |
| 60 | + Expect(etcdPath).To(Equal(path.Join(versionDownloadDirectory, "etcd"))) |
| 61 | + Expect(kubectlPath).To(Equal(path.Join(versionDownloadDirectory, "kubectl"))) |
| 62 | + |
| 63 | + dirEntries, err := os.ReadDir(versionDownloadDirectory) |
| 64 | + Expect(err).ToNot(HaveOccurred()) |
| 65 | + var actualFiles []string |
| 66 | + for _, e := range dirEntries { |
| 67 | + actualFiles = append(actualFiles, e.Name()) |
| 68 | + } |
| 69 | + Expect(actualFiles).To(ConsistOf("some-file")) |
| 70 | + }) |
| 71 | + |
| 72 | + It("should download v1.32.0 binaries", func() { |
| 73 | + apiServerPath, etcdPath, kubectlPath, err := downloadBinaryAssets(context.Background(), downloadDirectory, "v1.31.0", fmt.Sprintf("http://%s/%s", server.Addr(), "envtest-releases.yaml")) |
| 74 | + Expect(err).ToNot(HaveOccurred()) |
| 75 | + |
| 76 | + // Verify latest stable version (v1.32.0) was downloaded |
| 77 | + versionDownloadDirectory := path.Join(downloadDirectory, fmt.Sprintf("1.31.0-%s-%s", runtime.GOOS, runtime.GOARCH)) |
| 78 | + Expect(apiServerPath).To(Equal(path.Join(versionDownloadDirectory, "kube-apiserver"))) |
| 79 | + Expect(etcdPath).To(Equal(path.Join(versionDownloadDirectory, "etcd"))) |
| 80 | + Expect(kubectlPath).To(Equal(path.Join(versionDownloadDirectory, "kubectl"))) |
| 81 | + |
| 82 | + dirEntries, err := os.ReadDir(versionDownloadDirectory) |
| 83 | + Expect(err).ToNot(HaveOccurred()) |
| 84 | + var actualFiles []string |
| 85 | + for _, e := range dirEntries { |
| 86 | + actualFiles = append(actualFiles, e.Name()) |
| 87 | + } |
| 88 | + Expect(actualFiles).To(ConsistOf("some-file")) |
| 89 | + }) |
| 90 | +}) |
| 91 | + |
| 92 | +var ( |
| 93 | + envtestBinaryArchives = index{ |
| 94 | + Releases: map[string]release{ |
| 95 | + "v1.32.0": map[string]archive{ |
| 96 | + "envtest-v1.32.0-darwin-amd64.tar.gz": {}, |
| 97 | + "envtest-v1.32.0-darwin-arm64.tar.gz": {}, |
| 98 | + "envtest-v1.32.0-linux-amd64.tar.gz": {}, |
| 99 | + "envtest-v1.32.0-linux-arm64.tar.gz": {}, |
| 100 | + "envtest-v1.32.0-linux-ppc64le.tar.gz": {}, |
| 101 | + "envtest-v1.32.0-linux-s390x.tar.gz": {}, |
| 102 | + "envtest-v1.32.0-windows-amd64.tar.gz": {}, |
| 103 | + }, |
| 104 | + "v1.31.0": map[string]archive{ |
| 105 | + "envtest-v1.31.0-darwin-amd64.tar.gz": {}, |
| 106 | + "envtest-v1.31.0-darwin-arm64.tar.gz": {}, |
| 107 | + "envtest-v1.31.0-linux-amd64.tar.gz": {}, |
| 108 | + "envtest-v1.31.0-linux-arm64.tar.gz": {}, |
| 109 | + "envtest-v1.31.0-linux-ppc64le.tar.gz": {}, |
| 110 | + "envtest-v1.31.0-linux-s390x.tar.gz": {}, |
| 111 | + "envtest-v1.31.0-windows-amd64.tar.gz": {}, |
| 112 | + }, |
| 113 | + }, |
| 114 | + } |
| 115 | +) |
| 116 | + |
| 117 | +func setupServer(server *ghttp.Server) { |
| 118 | + itemsHTTP := makeArchives(envtestBinaryArchives) |
| 119 | + |
| 120 | + // The index from itemsHTTP contains only relative SelfLinks. |
| 121 | + // finalIndex will contain the full links based on server.Addr(). |
| 122 | + finalIndex := index{ |
| 123 | + Releases: map[string]release{}, |
| 124 | + } |
| 125 | + |
| 126 | + for releaseVersion, releases := range itemsHTTP.index.Releases { |
| 127 | + finalIndex.Releases[releaseVersion] = release{} |
| 128 | + |
| 129 | + for archiveName, a := range releases { |
| 130 | + finalIndex.Releases[releaseVersion][archiveName] = archive{ |
| 131 | + Hash: a.Hash, |
| 132 | + SelfLink: fmt.Sprintf("http://%s/%s", server.Addr(), a.SelfLink), |
| 133 | + } |
| 134 | + content := itemsHTTP.contents[archiveName] |
| 135 | + |
| 136 | + // Note: Using the relative path from archive here instead of the full path. |
| 137 | + server.RouteToHandler("GET", "/"+a.SelfLink, func(resp http.ResponseWriter, req *http.Request) { |
| 138 | + resp.WriteHeader(http.StatusOK) |
| 139 | + Expect(resp.Write(content)).To(Equal(len(content))) |
| 140 | + }) |
| 141 | + } |
| 142 | + } |
| 143 | + |
| 144 | + indexYAML, err := yaml.Marshal(finalIndex) |
| 145 | + Expect(err).ToNot(HaveOccurred()) |
| 146 | + |
| 147 | + server.RouteToHandler("GET", "/envtest-releases.yaml", ghttp.RespondWith( |
| 148 | + http.StatusOK, |
| 149 | + indexYAML, |
| 150 | + )) |
| 151 | +} |
| 152 | + |
| 153 | +type itemsHTTP struct { |
| 154 | + index index |
| 155 | + contents map[string][]byte |
| 156 | +} |
| 157 | + |
| 158 | +func makeArchives(i index) itemsHTTP { |
| 159 | + // This creates a new copy of the index so modifying the index |
| 160 | + // in some tests doesn't affect others. |
| 161 | + res := itemsHTTP{ |
| 162 | + index: index{ |
| 163 | + Releases: map[string]release{}, |
| 164 | + }, |
| 165 | + contents: map[string][]byte{}, |
| 166 | + } |
| 167 | + |
| 168 | + for releaseVersion, releases := range i.Releases { |
| 169 | + res.index.Releases[releaseVersion] = release{} |
| 170 | + for archiveName := range releases { |
| 171 | + var chunk [1024 * 48]byte // 1.5 times our chunk read size in GetVersion |
| 172 | + copy(chunk[:], archiveName) |
| 173 | + if _, err := rand.Read(chunk[len(archiveName):]); err != nil { |
| 174 | + panic(err) |
| 175 | + } |
| 176 | + content, hash := makeArchive(chunk[:]) |
| 177 | + |
| 178 | + res.index.Releases[releaseVersion][archiveName] = archive{ |
| 179 | + Hash: hash, |
| 180 | + // Note: Only storing the name of the archive for now. |
| 181 | + // This will be expanded later to a full URL once the server is running. |
| 182 | + SelfLink: archiveName, |
| 183 | + } |
| 184 | + res.contents[archiveName] = content |
| 185 | + } |
| 186 | + } |
| 187 | + return res |
| 188 | +} |
| 189 | + |
| 190 | +func makeArchive(contents []byte) ([]byte, string) { |
| 191 | + out := new(bytes.Buffer) |
| 192 | + gzipWriter := gzip.NewWriter(out) |
| 193 | + tarWriter := tar.NewWriter(gzipWriter) |
| 194 | + err := tarWriter.WriteHeader(&tar.Header{ |
| 195 | + Name: "controller-tools/envtest/some-file", |
| 196 | + Size: int64(len(contents)), |
| 197 | + Mode: 0777, // so we can check that we fix this later |
| 198 | + }) |
| 199 | + if err != nil { |
| 200 | + panic(err) |
| 201 | + } |
| 202 | + _, err = tarWriter.Write(contents) |
| 203 | + if err != nil { |
| 204 | + panic(err) |
| 205 | + } |
| 206 | + tarWriter.Close() |
| 207 | + gzipWriter.Close() |
| 208 | + content := out.Bytes() |
| 209 | + // controller-tools is using sha512 |
| 210 | + hash := sha512.Sum512(content) |
| 211 | + hashEncoded := hex.EncodeToString(hash[:]) |
| 212 | + return content, hashEncoded |
| 213 | +} |
0 commit comments