Skip to content

Commit 145bfc7

Browse files
docs,test: fix kubeconfig typo and clarify env var overrides (#558)
* docs: fix typo and clarify kubeconfig deserialization issue - Corrected 'applicaiton/yaml' to 'application/yaml' - Reworded paragraph for clarity and consistency - Updated variable name from 'clust_id' to 'cluster_id' to match usage elsewhere in README * test: add inline comments for env var overrides in defaults.py - Documented each overrideable default using consistent, concise comments - Improved onboarding clarity for contributors customizing integration tests --------- Co-authored-by: DO-rrao <[email protected]>
1 parent 125d037 commit 145bfc7

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ docker run -it --rm --name pydo -v $PWD/tests:/tests pydo:dev pytest tests/mocke
217217
218218
#### `kubernetes.get_kubeconfig` Does not serialize response content
219219

220-
In the generated python client, when calling client.kubernetes.get_kubeconfig(clust_id), the deserialization logic raises an error when the response content-type is applicaiton/yaml. We need to determine if the spec/schema can be configured such that the generator results in functions that properly handle the content. We will likely need to report the issue upstream to request support for the content-type.
220+
In the generated Python client, calling client.kubernetes.get_kubeconfig(cluster_id) raises a deserialization error when the response content-type is application/yaml. This occurs because the generator does not correctly handle YAML responses. We should investigate whether the OpenAPI spec or generator configuration can be adjusted to support this content-type. If not, the issue should be reported upstream to improve YAML support in client generation.
221221

222222
Workaround (with std lib httplib):
223223

tests/integration/defaults.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,23 @@
55

66
from os import environ
77

8+
# Prefix used for naming test resources
89
PREFIX = "cgtest"
910

10-
# CUSTOMIZABLE
11+
# Default droplet size slug. Override with DO_DROPLET_SIZE.
1112
DROPLET_SIZE = environ.get("DO_DROPLET_SIZE") or "s-1vcpu-1gb"
13+
14+
# Default droplet image slug. Override with DO_DROPLET_IMAGE.
1215
DROPLET_IMAGE = environ.get("DO_DROPLET_IMAGE") or "ubuntu-22-04-x64"
1316

17+
# Default Kubernetes version. Override with DO_K8S_VERSION.
1418
K8S_VERSION = environ.get("DO_K8S_VERSION") or "latest"
19+
20+
# Default size slug for Kubernetes nodes. Override with DO_K8S_NODE_SIZE.
1521
K8S_NODE_SIZE = environ.get("DO_K8S_NODE_SIZE") or "s-1vcpu-2gb"
1622

23+
# Default region for resource creation. Override with DO_REGION.
1724
REGION = environ.get("DO_REGION") or "nyc3"
1825

26+
# UUID used for invoice PDF tests. Override with DO_INVOICE_UUID.
1927
INVOICE_UUID_PARM = environ.get("DO_INVOICE_UUID") or "something"

0 commit comments

Comments
 (0)