Struct k8s_test_framework::framework::Framework

pub struct Framework { /* private fields */ }

Framework wraps the interface to the system with an easy-to-use rust API optimized for implementing test cases.

Implementations

impl Framework

pub fn new(interface: Interface) -> Self

Create a new Framework powered by the passed interface.

pub async fn helm_chart( &self, namespace: &str, helm_chart: &str, release_name: &str, helm_repo: &str, config: Config<'_>, ) -> Result<Manager<CommandBuilder>, Box<dyn Error>>

Deploy a Helm chart into a cluster.

pub async fn namespace( &self, config: Config, ) -> Result<Manager<CommandBuilder>, Box<dyn Error>>

Create a new namespace.

pub async fn test_pod( &self, config: Config, ) -> Result<Manager<CommandBuilder>, Box<dyn Error>>

Create a new test Pod.

pub fn logs( &self, namespace: &str, resource: &str, ) -> Result<Reader, Box<dyn Error>>

Initialize log lookup for a particular resource in a particular namespace.

pub fn exec_tail( &self, namespace: &str, resource: &str, file: &str, ) -> Result<Reader, Box<dyn Error>>

Exec a tail -f command reading the specified file within a Container in a Pod of a specified resource at the specified namespace.

pub fn port_forward( &self, namespace: &str, resource: &str, local_port: u16, resource_port: u16, ) -> Result<PortForwarder, Box<dyn Error>>

Initialize port forward for a particular resource in a particular namespace with a particular pair of local/resource ports.

pub async fn kubernetes_version(&self) -> Result<K8sVersion, Box<dyn Error>>

Exect a kubectl --versioncommand returning a K8sVersion Struct containing all version information of the running Kubernetes test cluster.

pub async fn wait<'a>( &self, namespace: &str, resources: impl IntoIterator<Item = &'a str>, wait_for: WaitFor<&str>, extra: impl IntoIterator<Item = &'a str>, ) -> Result<(), Box<dyn Error>>

Wait for a set of resources in a specified namespace to achieve wait_for state. Use extra to pass additional arguments to kubectl.

pub async fn wait_all_namespaces<'a>( &self, resources: impl IntoIterator<Item = &'a str>, wait_for: WaitFor<&str>, extra: impl IntoIterator<Item = &'a str>, ) -> Result<(), Box<dyn Error>>

Wait for a set of resources in any namespace to achieve wait_for state. Use extra to pass additional arguments to kubectl.

pub async fn wait_for_rollout<'a>( &self, namespace: &str, resource: &str, extra: impl IntoIterator<Item = &'a str>, ) -> Result<(), Box<dyn Error>>

Wait for a rollout of a resource to complete. Use extra to pass additional arguments to kubectl.

pub async fn restart_rollout<'a>( &self, namespace: &str, resources: &str, extra: impl IntoIterator<Item = &'a str>, ) -> Result<(), Box<dyn Error>>

Trigger a restart for a rollout of a resource. Use `extr

pub async fn label_nodes(&self, label: &str) -> Result<String, Box<dyn Error>>

Sets a label on all nodes.

pub async fn get_vector_pod_with_pod( &self, pod_namespace: &str, pod_name: &str, vector_pod_namespace: &str, vector_pod_name: &str, ) -> Result<String, Box<dyn Error>>

Return the Vector pod that is deployed on the same node as the given pod. We want to make sure we are scanning the Vector instance that is deployed with the test pod.

Trait Implementations

impl Debug for Framework

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.