|
| 1 | +// This Source Code Form is subject to the terms of the Mozilla Public |
| 2 | +// License, v. 2.0. If a copy of the MPL was not distributed with this |
| 3 | +// file, You can obtain one at https://mozilla.org/MPL/2.0/. |
| 4 | + |
| 5 | +//go:build ignore |
| 6 | + |
| 7 | +// This script records real API responses for use in golden file tests. |
| 8 | +// Run with: go run ./oxide/testdata/main.go [-api-version VERSION] |
| 9 | +// |
| 10 | +// Requires OXIDE_HOST, OXIDE_TOKEN, and OXIDE_PROJECT environment variables. |
| 11 | +// Optionally pass -api-version to set the API-Version header on requests. |
| 12 | +package main |
| 13 | + |
| 14 | +import ( |
| 15 | + "bytes" |
| 16 | + "crypto/tls" |
| 17 | + "encoding/json" |
| 18 | + "flag" |
| 19 | + "fmt" |
| 20 | + "io" |
| 21 | + "log" |
| 22 | + "net/http" |
| 23 | + "os" |
| 24 | + "path/filepath" |
| 25 | +) |
| 26 | + |
| 27 | +var ( |
| 28 | + apiVersion = flag.String("api-version", "", "API version to send in requests (optional)") |
| 29 | + |
| 30 | + client = &http.Client{ |
| 31 | + Transport: &http.Transport{ |
| 32 | + TLSClientConfig: &tls.Config{InsecureSkipVerify: true}, |
| 33 | + }, |
| 34 | + } |
| 35 | +) |
| 36 | + |
| 37 | +func main() { |
| 38 | + flag.Parse() |
| 39 | + |
| 40 | + host := os.Getenv("OXIDE_HOST") |
| 41 | + token := os.Getenv("OXIDE_TOKEN") |
| 42 | + project := os.Getenv("OXIDE_PROJECT") |
| 43 | + |
| 44 | + if host == "" || token == "" || project == "" { |
| 45 | + log.Fatalf("OXIDE_HOST, OXIDE_TOKEN, and OXIDE_PROJECT environment variables must be set") |
| 46 | + } |
| 47 | + |
| 48 | + if *apiVersion != "" { |
| 49 | + fmt.Printf("Using API-Version: %s\n", *apiVersion) |
| 50 | + } |
| 51 | + |
| 52 | + testdataDir := "./oxide/testdata/recordings" |
| 53 | + |
| 54 | + recordTimeseriesQuery(host, token, testdataDir) |
| 55 | + recordDiskList(host, token, project, testdataDir) |
| 56 | + recordLoopbackAddresses(host, token, testdataDir) |
| 57 | +} |
| 58 | + |
| 59 | +func recordTimeseriesQuery(host, token, testdataDir string) { |
| 60 | + fmt.Println("Recording timeseries query response...") |
| 61 | + |
| 62 | + body := `{"query": "get hardware_component:voltage | filter slot == 0 && sensor == \"V1P0_MGMT\" | filter timestamp > @now() - 5m | last 5"}` |
| 63 | + data, err := doRequest("POST", host+"/v1/system/timeseries/query", token, body) |
| 64 | + if err != nil { |
| 65 | + log.Printf("Warning: timeseries query failed: %v", err) |
| 66 | + return |
| 67 | + } |
| 68 | + |
| 69 | + normalized, err := normalizeJSON(data) |
| 70 | + if err != nil { |
| 71 | + log.Printf("Warning: failed to normalize JSON: %v", err) |
| 72 | + return |
| 73 | + } |
| 74 | + if err := saveFixture(testdataDir, "timeseries_query_response.json", normalized); err != nil { |
| 75 | + log.Printf("Warning: %v", err) |
| 76 | + return |
| 77 | + } |
| 78 | +} |
| 79 | + |
| 80 | +func recordDiskList(host, token, project, testdataDir string) { |
| 81 | + fmt.Println("Recording disk list response...") |
| 82 | + |
| 83 | + url := fmt.Sprintf("%s/v1/disks?project=%s&limit=5", host, project) |
| 84 | + data, err := doRequest("GET", url, token, "") |
| 85 | + if err != nil { |
| 86 | + log.Printf("Warning: disk list failed: %v", err) |
| 87 | + return |
| 88 | + } |
| 89 | + |
| 90 | + normalized, err := normalizeJSON(data) |
| 91 | + if err != nil { |
| 92 | + log.Printf("Warning: failed to normalize JSON: %v", err) |
| 93 | + return |
| 94 | + } |
| 95 | + if err := saveFixture(testdataDir, "disk_list_response.json", normalized); err != nil { |
| 96 | + log.Printf("Warning: %v", err) |
| 97 | + return |
| 98 | + } |
| 99 | +} |
| 100 | + |
| 101 | +func recordLoopbackAddresses(host, token, testdataDir string) { |
| 102 | + fmt.Println("Recording loopback addresses response...") |
| 103 | + |
| 104 | + url := fmt.Sprintf("%s/v1/system/networking/loopback-address?limit=5", host) |
| 105 | + data, err := doRequest("GET", url, token, "") |
| 106 | + if err != nil { |
| 107 | + log.Printf("Warning: loopback addresses failed: %v", err) |
| 108 | + return |
| 109 | + } |
| 110 | + |
| 111 | + normalized, err := normalizeJSON(data) |
| 112 | + if err != nil { |
| 113 | + log.Printf("Warning: failed to normalize JSON: %v", err) |
| 114 | + return |
| 115 | + } |
| 116 | + if err := saveFixture(testdataDir, "loopback_addresses_response.json", normalized); err != nil { |
| 117 | + log.Printf("Warning: %v", err) |
| 118 | + return |
| 119 | + } |
| 120 | +} |
| 121 | + |
| 122 | +// doRequest makes a request to the configured nexus instance. We use the standard library here |
| 123 | +// and not our own sdk because we're generating test files to verify the generated code. |
| 124 | +func doRequest(method, url, token, body string) ([]byte, error) { |
| 125 | + var reqBody io.Reader |
| 126 | + if body != "" { |
| 127 | + reqBody = bytes.NewBufferString(body) |
| 128 | + } |
| 129 | + |
| 130 | + req, err := http.NewRequest(method, url, reqBody) |
| 131 | + if err != nil { |
| 132 | + return nil, fmt.Errorf("failed to create request: %w", err) |
| 133 | + } |
| 134 | + req.Header.Set("Authorization", "Bearer "+token) |
| 135 | + if *apiVersion != "" { |
| 136 | + req.Header.Set("API-Version", *apiVersion) |
| 137 | + } |
| 138 | + if body != "" { |
| 139 | + req.Header.Set("Content-Type", "application/json") |
| 140 | + } |
| 141 | + |
| 142 | + resp, err := client.Do(req) |
| 143 | + if err != nil { |
| 144 | + return nil, fmt.Errorf("failed to send request: %w", err) |
| 145 | + } |
| 146 | + defer resp.Body.Close() |
| 147 | + |
| 148 | + if resp.StatusCode != http.StatusOK { |
| 149 | + respBody, _ := io.ReadAll(resp.Body) |
| 150 | + return nil, fmt.Errorf("API returned status %d: %s", resp.StatusCode, respBody) |
| 151 | + } |
| 152 | + |
| 153 | + return io.ReadAll(resp.Body) |
| 154 | +} |
| 155 | + |
| 156 | +func saveFixture(testdataDir, filename string, data []byte) error { |
| 157 | + path := filepath.Join(testdataDir, filename) |
| 158 | + if err := os.WriteFile(path, data, 0644); err != nil { |
| 159 | + return fmt.Errorf("failed to write %s: %w", path, err) |
| 160 | + } |
| 161 | + return nil |
| 162 | +} |
| 163 | + |
| 164 | +// normalizeJSON strips undocumented fields from API responses. |
| 165 | +func normalizeJSON(data []byte) ([]byte, error) { |
| 166 | + var v any |
| 167 | + if err := json.Unmarshal(data, &v); err != nil { |
| 168 | + return nil, err |
| 169 | + } |
| 170 | + |
| 171 | + // Nexus returns an undocumented `query_summaries` field that's not in the OpenAPI spec. Ignore it for now. |
| 172 | + // |
| 173 | + // TODO: fully drop `query_summaries` from nexus unless requested. |
| 174 | + if m, ok := v.(map[string]any); ok { |
| 175 | + delete(m, "query_summaries") |
| 176 | + } |
| 177 | + |
| 178 | + return json.Marshal(v) |
| 179 | +} |
0 commit comments