use derivative::Derivative;
use k8s_openapi::{api::core::v1::ObjectReference, apimachinery::pkg::apis::meta::v1::OwnerReference};
#[cfg(doc)] use kube_client::core::ObjectMeta;
use kube_client::{
api::{DynamicObject, Resource},
core::api_version_from_group_version,
};
use std::{
borrow::Cow,
fmt::{Debug, Display},
hash::Hash,
};
pub trait Lookup {
type DynamicType;
fn kind(dyntype: &Self::DynamicType) -> Cow<'_, str>;
fn group(dyntype: &Self::DynamicType) -> Cow<'_, str>;
fn version(dyntype: &Self::DynamicType) -> Cow<'_, str>;
fn api_version(dyntype: &Self::DynamicType) -> Cow<'_, str> {
api_version_from_group_version(Self::group(dyntype), Self::version(dyntype))
}
fn plural(dyntype: &Self::DynamicType) -> Cow<'_, str>;
fn name(&self) -> Option<Cow<'_, str>>;
fn namespace(&self) -> Option<Cow<'_, str>>;
fn resource_version(&self) -> Option<Cow<'_, str>>;
fn uid(&self) -> Option<Cow<'_, str>>;
fn to_object_ref(&self, dyntype: Self::DynamicType) -> ObjectRef<Self> {
ObjectRef {
dyntype,
name: self.name().expect(".metadata.name missing").into_owned(),
namespace: self.namespace().map(Cow::into_owned),
extra: Extra {
resource_version: self.resource_version().map(Cow::into_owned),
uid: self.uid().map(Cow::into_owned),
},
}
}
}
impl<K: Resource> Lookup for K {
type DynamicType = K::DynamicType;
fn kind(dyntype: &Self::DynamicType) -> Cow<'_, str> {
K::kind(dyntype)
}
fn version(dyntype: &Self::DynamicType) -> Cow<'_, str> {
K::version(dyntype)
}
fn group(dyntype: &Self::DynamicType) -> Cow<'_, str> {
K::group(dyntype)
}
fn plural(dyntype: &Self::DynamicType) -> Cow<'_, str> {
K::plural(dyntype)
}
fn name(&self) -> Option<Cow<'_, str>> {
self.meta().name.as_deref().map(Cow::Borrowed)
}
fn namespace(&self) -> Option<Cow<'_, str>> {
self.meta().namespace.as_deref().map(Cow::Borrowed)
}
fn resource_version(&self) -> Option<Cow<'_, str>> {
self.meta().resource_version.as_deref().map(Cow::Borrowed)
}
fn uid(&self) -> Option<Cow<'_, str>> {
self.meta().uid.as_deref().map(Cow::Borrowed)
}
}
#[derive(Derivative)]
#[derivative(
Debug(bound = "K::DynamicType: Debug"),
PartialEq(bound = "K::DynamicType: PartialEq"),
Eq(bound = "K::DynamicType: Eq"),
Hash(bound = "K::DynamicType: Hash"),
Clone(bound = "K::DynamicType: Clone")
)]
#[non_exhaustive]
pub struct ObjectRef<K: Lookup + ?Sized> {
pub dyntype: K::DynamicType,
pub name: String,
pub namespace: Option<String>,
#[derivative(Hash = "ignore", PartialEq = "ignore")]
pub extra: Extra,
}
#[derive(Default, Debug, Clone)]
#[non_exhaustive]
pub struct Extra {
pub resource_version: Option<String>,
pub uid: Option<String>,
}
impl<K: Lookup> ObjectRef<K>
where
K::DynamicType: Default,
{
#[must_use]
pub fn new(name: &str) -> Self {
Self::new_with(name, Default::default())
}
#[must_use]
pub fn from_obj(obj: &K) -> Self
where
K: Lookup,
{
obj.to_object_ref(Default::default())
}
}
impl<K: Lookup> ObjectRef<K> {
#[must_use]
pub fn new_with(name: &str, dyntype: K::DynamicType) -> Self {
Self {
dyntype,
name: name.into(),
namespace: None,
extra: Extra::default(),
}
}
#[must_use]
pub fn within(mut self, namespace: &str) -> Self {
self.namespace = Some(namespace.to_string());
self
}
#[must_use]
pub fn from_obj_with(obj: &K, dyntype: K::DynamicType) -> Self
where
K: Lookup,
{
obj.to_object_ref(dyntype)
}
#[must_use]
pub fn from_owner_ref(
namespace: Option<&str>,
owner: &OwnerReference,
dyntype: K::DynamicType,
) -> Option<Self> {
if owner.api_version == K::api_version(&dyntype) && owner.kind == K::kind(&dyntype) {
Some(Self {
dyntype,
name: owner.name.clone(),
namespace: namespace.map(String::from),
extra: Extra {
resource_version: None,
uid: Some(owner.uid.clone()),
},
})
} else {
None
}
}
#[must_use]
pub fn into_kind_unchecked<K2: Lookup>(self, dt2: K2::DynamicType) -> ObjectRef<K2> {
ObjectRef {
dyntype: dt2,
name: self.name,
namespace: self.namespace,
extra: self.extra,
}
}
pub fn erase(self) -> ObjectRef<DynamicObject> {
ObjectRef {
dyntype: kube_client::api::ApiResource {
group: K::group(&self.dyntype).to_string(),
version: K::version(&self.dyntype).to_string(),
api_version: K::api_version(&self.dyntype).to_string(),
kind: K::kind(&self.dyntype).to_string(),
plural: K::plural(&self.dyntype).to_string(),
},
name: self.name,
namespace: self.namespace,
extra: self.extra,
}
}
}
impl<K: Lookup> From<ObjectRef<K>> for ObjectReference {
fn from(val: ObjectRef<K>) -> Self {
let ObjectRef {
dyntype: dt,
name,
namespace,
extra: Extra {
resource_version,
uid,
},
} = val;
ObjectReference {
api_version: Some(K::api_version(&dt).into_owned()),
kind: Some(K::kind(&dt).into_owned()),
field_path: None,
name: Some(name),
namespace,
resource_version,
uid,
}
}
}
impl<K: Lookup> Display for ObjectRef<K> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{}.{}.{}/{}",
K::kind(&self.dyntype),
K::version(&self.dyntype),
K::group(&self.dyntype),
self.name
)?;
if let Some(namespace) = &self.namespace {
write!(f, ".{namespace}")?;
}
Ok(())
}
}
#[cfg(test)]
mod tests {
use std::{
collections::hash_map::DefaultHasher,
hash::{Hash, Hasher},
};
use super::{Extra, ObjectRef};
use k8s_openapi::api::{
apps::v1::Deployment,
core::v1::{Node, Pod},
};
#[test]
fn display_should_follow_expected_format() {
assert_eq!(
format!("{}", ObjectRef::<Pod>::new("my-pod").within("my-namespace")),
"Pod.v1./my-pod.my-namespace"
);
assert_eq!(
format!(
"{}",
ObjectRef::<Deployment>::new("my-deploy").within("my-namespace")
),
"Deployment.v1.apps/my-deploy.my-namespace"
);
assert_eq!(
format!("{}", ObjectRef::<Node>::new("my-node")),
"Node.v1./my-node"
);
}
#[test]
fn display_should_be_transparent_to_representation() {
let pod_ref = ObjectRef::<Pod>::new("my-pod").within("my-namespace");
assert_eq!(format!("{pod_ref}"), format!("{}", pod_ref.erase()));
let deploy_ref = ObjectRef::<Deployment>::new("my-deploy").within("my-namespace");
assert_eq!(format!("{deploy_ref}"), format!("{}", deploy_ref.erase()));
let node_ref = ObjectRef::<Node>::new("my-node");
assert_eq!(format!("{node_ref}"), format!("{}", node_ref.erase()));
}
#[test]
fn comparison_should_ignore_extra() {
let minimal = ObjectRef::<Pod>::new("my-pod").within("my-namespace");
let with_extra = ObjectRef {
extra: Extra {
resource_version: Some("123".to_string()),
uid: Some("638ffacd-f666-4402-ba10-7848c66ef576".to_string()),
},
..minimal.clone()
};
assert_eq!(minimal, with_extra);
let hash_value = |value: &ObjectRef<Pod>| {
let mut hasher = DefaultHasher::new();
value.hash(&mut hasher);
hasher.finish()
};
assert_eq!(hash_value(&minimal), hash_value(&with_extra));
}
}